Annotation of loncom/interface/loncommon.pm, revision 1.1136
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1136 ! raeburn 4: # $Id: loncommon.pm,v 1.1135 2013/07/03 05:03:12 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.685 tempelho 64: use Apache::lonnet();
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.479 albertel 72: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 73: use DateTime::TimeZone;
1.687 raeburn 74: use DateTime::Locale::Catalog;
1.1091 foxr 75: use Text::Aspell;
1.1094 raeburn 76: use Authen::Captcha;
77: use Captcha::reCAPTCHA;
1.117 www 78:
1.517 raeburn 79: # ---------------------------------------------- Designs
80: use vars qw(%defaultdesign);
81:
1.22 www 82: my $readit;
83:
1.517 raeburn 84:
1.157 matthew 85: ##
86: ## Global Variables
87: ##
1.46 matthew 88:
1.643 foxr 89:
90: # ----------------------------------------------- SSI with retries:
91: #
92:
93: =pod
94:
1.648 raeburn 95: =head1 Server Side include with retries:
1.643 foxr 96:
97: =over 4
98:
1.648 raeburn 99: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 100:
101: Performs an ssi with some number of retries. Retries continue either
102: until the result is ok or until the retry count supplied by the
103: caller is exhausted.
104:
105: Inputs:
1.648 raeburn 106:
107: =over 4
108:
1.643 foxr 109: resource - Identifies the resource to insert.
1.648 raeburn 110:
1.643 foxr 111: retries - Count of the number of retries allowed.
1.648 raeburn 112:
1.643 foxr 113: form - Hash that identifies the rendering options.
114:
1.648 raeburn 115: =back
116:
117: Returns:
118:
119: =over 4
120:
1.643 foxr 121: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 122:
1.643 foxr 123: response - The response from the last attempt (which may or may not have been successful.
124:
1.648 raeburn 125: =back
126:
127: =back
128:
1.643 foxr 129: =cut
130:
131: sub ssi_with_retries {
132: my ($resource, $retries, %form) = @_;
133:
134:
135: my $ok = 0; # True if we got a good response.
136: my $content;
137: my $response;
138:
139: # Try to get the ssi done. within the retries count:
140:
141: do {
142: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
143: $ok = $response->is_success;
1.650 www 144: if (!$ok) {
145: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
146: }
1.643 foxr 147: $retries--;
148: } while (!$ok && ($retries > 0));
149:
150: if (!$ok) {
151: $content = ''; # On error return an empty content.
152: }
153: return ($content, $response);
154:
155: }
156:
157:
158:
1.20 www 159: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 160: my %language;
1.124 www 161: my %supported_language;
1.1088 foxr 162: my %supported_codes;
1.1048 foxr 163: my %latex_language; # For choosing hyphenation in <transl..>
164: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 165: my %cprtag;
1.192 taceyjo1 166: my %scprtag;
1.351 www 167: my %fe; my %fd; my %fm;
1.41 ng 168: my %category_extensions;
1.12 harris41 169:
1.46 matthew 170: # ---------------------------------------------- Thesaurus variables
1.144 matthew 171: #
172: # %Keywords:
173: # A hash used by &keyword to determine if a word is considered a keyword.
174: # $thesaurus_db_file
175: # Scalar containing the full path to the thesaurus database.
1.46 matthew 176:
177: my %Keywords;
178: my $thesaurus_db_file;
179:
1.144 matthew 180: #
181: # Initialize values from language.tab, copyright.tab, filetypes.tab,
182: # thesaurus.tab, and filecategories.tab.
183: #
1.18 www 184: BEGIN {
1.46 matthew 185: # Variable initialization
186: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
187: #
1.22 www 188: unless ($readit) {
1.12 harris41 189: # ------------------------------------------------------------------- languages
190: {
1.158 raeburn 191: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
192: '/language.tab';
193: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 194: while (my $line = <$fh>) {
195: next if ($line=~/^\#/);
196: chomp($line);
1.1088 foxr 197: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 198: $language{$key}=$val.' - '.$enc;
199: if ($sup) {
200: $supported_language{$key}=$sup;
1.1088 foxr 201: $supported_codes{$key} = $code;
1.158 raeburn 202: }
1.1048 foxr 203: if ($latex) {
204: $latex_language_bykey{$key} = $latex;
1.1088 foxr 205: $latex_language{$code} = $latex;
1.1048 foxr 206: }
1.158 raeburn 207: }
208: close($fh);
209: }
1.12 harris41 210: }
211: # ------------------------------------------------------------------ copyrights
212: {
1.158 raeburn 213: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
214: '/copyright.tab';
215: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 216: while (my $line = <$fh>) {
217: next if ($line=~/^\#/);
218: chomp($line);
219: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 220: $cprtag{$key}=$val;
221: }
222: close($fh);
223: }
1.12 harris41 224: }
1.351 www 225: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 226: {
227: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
228: '/source_copyright.tab';
229: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 230: while (my $line = <$fh>) {
231: next if ($line =~ /^\#/);
232: chomp($line);
233: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 234: $scprtag{$key}=$val;
235: }
236: close($fh);
237: }
238: }
1.63 www 239:
1.517 raeburn 240: # -------------------------------------------------------------- default domain designs
1.63 www 241: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 242: my $designfile = $designdir.'/default.tab';
243: if ( open (my $fh,"<$designfile") ) {
244: while (my $line = <$fh>) {
245: next if ($line =~ /^\#/);
246: chomp($line);
247: my ($key,$val)=(split(/\=/,$line));
248: if ($val) { $defaultdesign{$key}=$val; }
249: }
250: close($fh);
1.63 www 251: }
252:
1.15 harris41 253: # ------------------------------------------------------------- file categories
254: {
1.158 raeburn 255: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
256: '/filecategories.tab';
257: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 258: while (my $line = <$fh>) {
259: next if ($line =~ /^\#/);
260: chomp($line);
261: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 262: push @{$category_extensions{lc($category)}},$extension;
263: }
264: close($fh);
265: }
266:
1.15 harris41 267: }
1.12 harris41 268: # ------------------------------------------------------------------ file types
269: {
1.158 raeburn 270: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filetypes.tab';
272: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 277: if ($descr ne '') {
278: $fe{$ending}=lc($emb);
279: $fd{$ending}=$descr;
1.351 www 280: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 281: }
282: }
283: close($fh);
284: }
1.12 harris41 285: }
1.22 www 286: &Apache::lonnet::logthis(
1.705 tempelho 287: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 288: $readit=1;
1.46 matthew 289: } # end of unless($readit)
1.32 matthew 290:
291: }
1.112 bowersj2 292:
1.42 matthew 293: ###############################################################
294: ## HTML and Javascript Helper Functions ##
295: ###############################################################
296:
297: =pod
298:
1.112 bowersj2 299: =head1 HTML and Javascript Functions
1.42 matthew 300:
1.112 bowersj2 301: =over 4
302:
1.648 raeburn 303: =item * &browser_and_searcher_javascript()
1.112 bowersj2 304:
305: X<browsing, javascript>X<searching, javascript>Returns a string
306: containing javascript with two functions, C<openbrowser> and
307: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
308: tags.
1.42 matthew 309:
1.648 raeburn 310: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 311:
312: inputs: formname, elementname, only, omit
313:
314: formname and elementname indicate the name of the html form and name of
315: the element that the results of the browsing selection are to be placed in.
316:
317: Specifying 'only' will restrict the browser to displaying only files
1.185 www 318: with the given extension. Can be a comma separated list.
1.42 matthew 319:
320: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 321: with the given extension. Can be a comma separated list.
1.42 matthew 322:
1.648 raeburn 323: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 324:
325: Inputs: formname, elementname
326:
327: formname and elementname specify the name of the html form and the name
328: of the element the selection from the search results will be placed in.
1.542 raeburn 329:
1.42 matthew 330: =cut
331:
332: sub browser_and_searcher_javascript {
1.199 albertel 333: my ($mode)=@_;
334: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 335: my $resurl=&escape_single(&lastresurl());
1.42 matthew 336: return <<END;
1.219 albertel 337: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 338: var editbrowser = null;
1.135 albertel 339: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 340: var url = '$resurl/?';
1.42 matthew 341: if (editbrowser == null) {
342: url += 'launch=1&';
343: }
344: url += 'catalogmode=interactive&';
1.199 albertel 345: url += 'mode=$mode&';
1.611 albertel 346: url += 'inhibitmenu=yes&';
1.42 matthew 347: url += 'form=' + formname + '&';
348: if (only != null) {
349: url += 'only=' + only + '&';
1.217 albertel 350: } else {
351: url += 'only=&';
352: }
1.42 matthew 353: if (omit != null) {
354: url += 'omit=' + omit + '&';
1.217 albertel 355: } else {
356: url += 'omit=&';
357: }
1.135 albertel 358: if (titleelement != null) {
359: url += 'titleelement=' + titleelement + '&';
1.217 albertel 360: } else {
361: url += 'titleelement=&';
362: }
1.42 matthew 363: url += 'element=' + elementname + '';
364: var title = 'Browser';
1.435 albertel 365: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 366: options += ',width=700,height=600';
367: editbrowser = open(url,title,options,'1');
368: editbrowser.focus();
369: }
370: var editsearcher;
1.135 albertel 371: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 372: var url = '/adm/searchcat?';
373: if (editsearcher == null) {
374: url += 'launch=1&';
375: }
376: url += 'catalogmode=interactive&';
1.199 albertel 377: url += 'mode=$mode&';
1.42 matthew 378: url += 'form=' + formname + '&';
1.135 albertel 379: if (titleelement != null) {
380: url += 'titleelement=' + titleelement + '&';
1.217 albertel 381: } else {
382: url += 'titleelement=&';
383: }
1.42 matthew 384: url += 'element=' + elementname + '';
385: var title = 'Search';
1.435 albertel 386: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 387: options += ',width=700,height=600';
388: editsearcher = open(url,title,options,'1');
389: editsearcher.focus();
390: }
1.219 albertel 391: // END LON-CAPA Internal -->
1.42 matthew 392: END
1.170 www 393: }
394:
395: sub lastresurl {
1.258 albertel 396: if ($env{'environment.lastresurl'}) {
397: return $env{'environment.lastresurl'}
1.170 www 398: } else {
399: return '/res';
400: }
401: }
402:
403: sub storeresurl {
404: my $resurl=&Apache::lonnet::clutter(shift);
405: unless ($resurl=~/^\/res/) { return 0; }
406: $resurl=~s/\/$//;
407: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 408: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 409: return 1;
1.42 matthew 410: }
411:
1.74 www 412: sub studentbrowser_javascript {
1.111 www 413: unless (
1.258 albertel 414: (($env{'request.course.id'}) &&
1.302 albertel 415: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
416: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
417: '/'.$env{'request.course.sec'})
418: ))
1.258 albertel 419: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 420: ) { return ''; }
1.74 www 421: return (<<'ENDSTDBRW');
1.776 bisitz 422: <script type="text/javascript" language="Javascript">
1.824 bisitz 423: // <![CDATA[
1.74 www 424: var stdeditbrowser;
1.999 www 425: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 426: var url = '/adm/pickstudent?';
427: var filter;
1.558 albertel 428: if (!ignorefilter) {
429: eval('filter=document.'+formname+'.'+uname+'.value;');
430: }
1.74 www 431: if (filter != null) {
432: if (filter != '') {
433: url += 'filter='+filter+'&';
434: }
435: }
436: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 437: '&udomelement='+udom+
438: '&clicker='+clicker;
1.111 www 439: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 440: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 441: var title = 'Student_Browser';
1.74 www 442: var options = 'scrollbars=1,resizable=1,menubar=0';
443: options += ',width=700,height=600';
444: stdeditbrowser = open(url,title,options,'1');
445: stdeditbrowser.focus();
446: }
1.824 bisitz 447: // ]]>
1.74 www 448: </script>
449: ENDSTDBRW
450: }
1.42 matthew 451:
1.1003 www 452: sub resourcebrowser_javascript {
453: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 454: return (<<'ENDRESBRW');
1.1003 www 455: <script type="text/javascript" language="Javascript">
456: // <![CDATA[
457: var reseditbrowser;
1.1004 www 458: function openresbrowser(formname,reslink) {
1.1005 www 459: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 460: var title = 'Resource_Browser';
461: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 462: options += ',width=700,height=500';
1.1004 www 463: reseditbrowser = open(url,title,options,'1');
464: reseditbrowser.focus();
1.1003 www 465: }
466: // ]]>
467: </script>
1.1004 www 468: ENDRESBRW
1.1003 www 469: }
470:
1.74 www 471: sub selectstudent_link {
1.999 www 472: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
473: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
474: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
475: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 476: if ($env{'request.course.id'}) {
1.302 albertel 477: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
478: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
479: '/'.$env{'request.course.sec'})) {
1.111 www 480: return '';
481: }
1.999 www 482: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 483: if ($courseadvonly) {
484: $callargs .= ",'',1,1";
485: }
486: return '<span class="LC_nobreak">'.
487: '<a href="javascript:openstdbrowser('.$callargs.');">'.
488: &mt('Select User').'</a></span>';
1.74 www 489: }
1.258 albertel 490: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 491: $callargs .= ",'',1";
1.793 raeburn 492: return '<span class="LC_nobreak">'.
493: '<a href="javascript:openstdbrowser('.$callargs.');">'.
494: &mt('Select User').'</a></span>';
1.111 www 495: }
496: return '';
1.91 www 497: }
498:
1.1004 www 499: sub selectresource_link {
500: my ($form,$reslink,$arg)=@_;
501:
502: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
503: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
504: unless ($env{'request.course.id'}) { return $arg; }
505: return '<span class="LC_nobreak">'.
506: '<a href="javascript:openresbrowser('.$callargs.');">'.
507: $arg.'</a></span>';
508: }
509:
510:
511:
1.653 raeburn 512: sub authorbrowser_javascript {
513: return <<"ENDAUTHORBRW";
1.776 bisitz 514: <script type="text/javascript" language="JavaScript">
1.824 bisitz 515: // <![CDATA[
1.653 raeburn 516: var stdeditbrowser;
517:
518: function openauthorbrowser(formname,udom) {
519: var url = '/adm/pickauthor?';
520: url += 'form='+formname+'&roledom='+udom;
521: var title = 'Author_Browser';
522: var options = 'scrollbars=1,resizable=1,menubar=0';
523: options += ',width=700,height=600';
524: stdeditbrowser = open(url,title,options,'1');
525: stdeditbrowser.focus();
526: }
527:
1.824 bisitz 528: // ]]>
1.653 raeburn 529: </script>
530: ENDAUTHORBRW
531: }
532:
1.91 www 533: sub coursebrowser_javascript {
1.1116 raeburn 534: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
535: $credits_element) = @_;
1.932 raeburn 536: my $wintitle = 'Course_Browser';
1.931 raeburn 537: if ($crstype eq 'Community') {
1.932 raeburn 538: $wintitle = 'Community_Browser';
1.909 raeburn 539: }
1.876 raeburn 540: my $id_functions = &javascript_index_functions();
541: my $output = '
1.776 bisitz 542: <script type="text/javascript" language="JavaScript">
1.824 bisitz 543: // <![CDATA[
1.468 raeburn 544: var stdeditbrowser;'."\n";
1.876 raeburn 545:
546: $output .= <<"ENDSTDBRW";
1.909 raeburn 547: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 548: var url = '/adm/pickcourse?';
1.895 raeburn 549: var formid = getFormIdByName(formname);
1.876 raeburn 550: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 551: if (domainfilter != null) {
552: if (domainfilter != '') {
553: url += 'domainfilter='+domainfilter+'&';
554: }
555: }
1.91 www 556: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 557: '&cdomelement='+udom+
558: '&cnameelement='+desc;
1.468 raeburn 559: if (extra_element !=null && extra_element != '') {
1.594 raeburn 560: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 561: url += '&roleelement='+extra_element;
562: if (domainfilter == null || domainfilter == '') {
563: url += '&domainfilter='+extra_element;
564: }
1.234 raeburn 565: }
1.468 raeburn 566: else {
567: if (formname == 'portform') {
568: url += '&setroles='+extra_element;
1.800 raeburn 569: } else {
570: if (formname == 'rules') {
571: url += '&fixeddom='+extra_element;
572: }
1.468 raeburn 573: }
574: }
1.230 raeburn 575: }
1.909 raeburn 576: if (type != null && type != '') {
577: url += '&type='+type;
578: }
579: if (type_elem != null && type_elem != '') {
580: url += '&typeelement='+type_elem;
581: }
1.872 raeburn 582: if (formname == 'ccrs') {
583: var ownername = document.forms[formid].ccuname.value;
584: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
585: url += '&cloner='+ownername+':'+ownerdom;
586: }
1.293 raeburn 587: if (multflag !=null && multflag != '') {
588: url += '&multiple='+multflag;
589: }
1.909 raeburn 590: var title = '$wintitle';
1.91 www 591: var options = 'scrollbars=1,resizable=1,menubar=0';
592: options += ',width=700,height=600';
593: stdeditbrowser = open(url,title,options,'1');
594: stdeditbrowser.focus();
595: }
1.876 raeburn 596: $id_functions
597: ENDSTDBRW
1.1116 raeburn 598: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
599: $output .= &setsec_javascript($sec_element,$formname,$role_element,
600: $credits_element);
1.876 raeburn 601: }
602: $output .= '
603: // ]]>
604: </script>';
605: return $output;
606: }
607:
608: sub javascript_index_functions {
609: return <<"ENDJS";
610:
611: function getFormIdByName(formname) {
612: for (var i=0;i<document.forms.length;i++) {
613: if (document.forms[i].name == formname) {
614: return i;
615: }
616: }
617: return -1;
618: }
619:
620: function getIndexByName(formid,item) {
621: for (var i=0;i<document.forms[formid].elements.length;i++) {
622: if (document.forms[formid].elements[i].name == item) {
623: return i;
624: }
625: }
626: return -1;
627: }
1.468 raeburn 628:
1.876 raeburn 629: function getDomainFromSelectbox(formname,udom) {
630: var userdom;
631: var formid = getFormIdByName(formname);
632: if (formid > -1) {
633: var domid = getIndexByName(formid,udom);
634: if (domid > -1) {
635: if (document.forms[formid].elements[domid].type == 'select-one') {
636: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
637: }
638: if (document.forms[formid].elements[domid].type == 'hidden') {
639: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 640: }
641: }
642: }
1.876 raeburn 643: return userdom;
644: }
645:
646: ENDJS
1.468 raeburn 647:
1.876 raeburn 648: }
649:
1.1017 raeburn 650: sub javascript_array_indexof {
1.1018 raeburn 651: return <<ENDJS;
1.1017 raeburn 652: <script type="text/javascript" language="JavaScript">
653: // <![CDATA[
654:
655: if (!Array.prototype.indexOf) {
656: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
657: "use strict";
658: if (this === void 0 || this === null) {
659: throw new TypeError();
660: }
661: var t = Object(this);
662: var len = t.length >>> 0;
663: if (len === 0) {
664: return -1;
665: }
666: var n = 0;
667: if (arguments.length > 0) {
668: n = Number(arguments[1]);
1.1088 foxr 669: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 670: n = 0;
671: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
672: n = (n > 0 || -1) * Math.floor(Math.abs(n));
673: }
674: }
675: if (n >= len) {
676: return -1;
677: }
678: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
679: for (; k < len; k++) {
680: if (k in t && t[k] === searchElement) {
681: return k;
682: }
683: }
684: return -1;
685: }
686: }
687:
688: // ]]>
689: </script>
690:
691: ENDJS
692:
693: }
694:
1.876 raeburn 695: sub userbrowser_javascript {
696: my $id_functions = &javascript_index_functions();
697: return <<"ENDUSERBRW";
698:
1.888 raeburn 699: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 700: var url = '/adm/pickuser?';
701: var userdom = getDomainFromSelectbox(formname,udom);
702: if (userdom != null) {
703: if (userdom != '') {
704: url += 'srchdom='+userdom+'&';
705: }
706: }
707: url += 'form=' + formname + '&unameelement='+uname+
708: '&udomelement='+udom+
709: '&ulastelement='+ulast+
710: '&ufirstelement='+ufirst+
711: '&uemailelement='+uemail+
1.881 raeburn 712: '&hideudomelement='+hideudom+
713: '&coursedom='+crsdom;
1.888 raeburn 714: if ((caller != null) && (caller != undefined)) {
715: url += '&caller='+caller;
716: }
1.876 raeburn 717: var title = 'User_Browser';
718: var options = 'scrollbars=1,resizable=1,menubar=0';
719: options += ',width=700,height=600';
720: var stdeditbrowser = open(url,title,options,'1');
721: stdeditbrowser.focus();
722: }
723:
1.888 raeburn 724: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 725: var formid = getFormIdByName(formname);
726: if (formid > -1) {
1.888 raeburn 727: var unameid = getIndexByName(formid,uname);
1.876 raeburn 728: var domid = getIndexByName(formid,udom);
729: var hidedomid = getIndexByName(formid,origdom);
730: if (hidedomid > -1) {
731: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 732: var unameval = document.forms[formid].elements[unameid].value;
733: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
734: if (domid > -1) {
735: var slct = document.forms[formid].elements[domid];
736: if (slct.type == 'select-one') {
737: var i;
738: for (i=0;i<slct.length;i++) {
739: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
740: }
741: }
742: if (slct.type == 'hidden') {
743: slct.value = fixeddom;
1.876 raeburn 744: }
745: }
1.468 raeburn 746: }
747: }
748: }
1.876 raeburn 749: return;
750: }
751:
752: $id_functions
753: ENDUSERBRW
1.468 raeburn 754: }
755:
756: sub setsec_javascript {
1.1116 raeburn 757: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 758: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
759: $communityrolestr);
760: if ($role_element ne '') {
761: my @allroles = ('st','ta','ep','in','ad');
762: foreach my $crstype ('Course','Community') {
763: if ($crstype eq 'Community') {
764: foreach my $role (@allroles) {
765: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
766: }
767: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
768: } else {
769: foreach my $role (@allroles) {
770: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
771: }
772: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
773: }
774: }
775: $rolestr = '"'.join('","',@allroles).'"';
776: $courserolestr = '"'.join('","',@courserolenames).'"';
777: $communityrolestr = '"'.join('","',@communityrolenames).'"';
778: }
1.468 raeburn 779: my $setsections = qq|
780: function setSect(sectionlist) {
1.629 raeburn 781: var sectionsArray = new Array();
782: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
783: sectionsArray = sectionlist.split(",");
784: }
1.468 raeburn 785: var numSections = sectionsArray.length;
786: document.$formname.$sec_element.length = 0;
787: if (numSections == 0) {
788: document.$formname.$sec_element.multiple=false;
789: document.$formname.$sec_element.size=1;
790: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
791: } else {
792: if (numSections == 1) {
793: document.$formname.$sec_element.multiple=false;
794: document.$formname.$sec_element.size=1;
795: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
796: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
797: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
798: } else {
799: for (var i=0; i<numSections; i++) {
800: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
801: }
802: document.$formname.$sec_element.multiple=true
803: if (numSections < 3) {
804: document.$formname.$sec_element.size=numSections;
805: } else {
806: document.$formname.$sec_element.size=3;
807: }
808: document.$formname.$sec_element.options[0].selected = false
809: }
810: }
1.91 www 811: }
1.905 raeburn 812:
813: function setRole(crstype) {
1.468 raeburn 814: |;
1.905 raeburn 815: if ($role_element eq '') {
816: $setsections .= ' return;
817: }
818: ';
819: } else {
820: $setsections .= qq|
821: var elementLength = document.$formname.$role_element.length;
822: var allroles = Array($rolestr);
823: var courserolenames = Array($courserolestr);
824: var communityrolenames = Array($communityrolestr);
825: if (elementLength != undefined) {
826: if (document.$formname.$role_element.options[5].value == 'cc') {
827: if (crstype == 'Course') {
828: return;
829: } else {
830: allroles[5] = 'co';
831: for (var i=0; i<6; i++) {
832: document.$formname.$role_element.options[i].value = allroles[i];
833: document.$formname.$role_element.options[i].text = communityrolenames[i];
834: }
835: }
836: } else {
837: if (crstype == 'Community') {
838: return;
839: } else {
840: allroles[5] = 'cc';
841: for (var i=0; i<6; i++) {
842: document.$formname.$role_element.options[i].value = allroles[i];
843: document.$formname.$role_element.options[i].text = courserolenames[i];
844: }
845: }
846: }
847: }
848: return;
849: }
850: |;
851: }
1.1116 raeburn 852: if ($credits_element) {
853: $setsections .= qq|
854: function setCredits(defaultcredits) {
855: document.$formname.$credits_element.value = defaultcredits;
856: return;
857: }
858: |;
859: }
1.468 raeburn 860: return $setsections;
861: }
862:
1.91 www 863: sub selectcourse_link {
1.909 raeburn 864: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
865: $typeelement) = @_;
866: my $type = $selecttype;
1.871 raeburn 867: my $linktext = &mt('Select Course');
868: if ($selecttype eq 'Community') {
1.909 raeburn 869: $linktext = &mt('Select Community');
1.906 raeburn 870: } elsif ($selecttype eq 'Course/Community') {
871: $linktext = &mt('Select Course/Community');
1.909 raeburn 872: $type = '';
1.1019 raeburn 873: } elsif ($selecttype eq 'Select') {
874: $linktext = &mt('Select');
875: $type = '';
1.871 raeburn 876: }
1.787 bisitz 877: return '<span class="LC_nobreak">'
878: ."<a href='"
879: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
880: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 881: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 882: ."'>".$linktext.'</a>'
1.787 bisitz 883: .'</span>';
1.74 www 884: }
1.42 matthew 885:
1.653 raeburn 886: sub selectauthor_link {
887: my ($form,$udom)=@_;
888: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
889: &mt('Select Author').'</a>';
890: }
891:
1.876 raeburn 892: sub selectuser_link {
1.881 raeburn 893: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 894: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 895: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 896: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 897: ');">'.$linktext.'</a>';
1.876 raeburn 898: }
899:
1.273 raeburn 900: sub check_uncheck_jscript {
901: my $jscript = <<"ENDSCRT";
902: function checkAll(field) {
903: if (field.length > 0) {
904: for (i = 0; i < field.length; i++) {
1.1093 raeburn 905: if (!field[i].disabled) {
906: field[i].checked = true;
907: }
1.273 raeburn 908: }
909: } else {
1.1093 raeburn 910: if (!field.disabled) {
911: field.checked = true;
912: }
1.273 raeburn 913: }
914: }
915:
916: function uncheckAll(field) {
917: if (field.length > 0) {
918: for (i = 0; i < field.length; i++) {
919: field[i].checked = false ;
1.543 albertel 920: }
921: } else {
1.273 raeburn 922: field.checked = false ;
923: }
924: }
925: ENDSCRT
926: return $jscript;
927: }
928:
1.656 www 929: sub select_timezone {
1.659 raeburn 930: my ($name,$selected,$onchange,$includeempty)=@_;
931: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
932: if ($includeempty) {
933: $output .= '<option value=""';
934: if (($selected eq '') || ($selected eq 'local')) {
935: $output .= ' selected="selected" ';
936: }
937: $output .= '> </option>';
938: }
1.657 raeburn 939: my @timezones = DateTime::TimeZone->all_names;
940: foreach my $tzone (@timezones) {
941: $output.= '<option value="'.$tzone.'"';
942: if ($tzone eq $selected) {
943: $output.=' selected="selected"';
944: }
945: $output.=">$tzone</option>\n";
1.656 www 946: }
947: $output.="</select>";
948: return $output;
949: }
1.273 raeburn 950:
1.687 raeburn 951: sub select_datelocale {
952: my ($name,$selected,$onchange,$includeempty)=@_;
953: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
954: if ($includeempty) {
955: $output .= '<option value=""';
956: if ($selected eq '') {
957: $output .= ' selected="selected" ';
958: }
959: $output .= '> </option>';
960: }
961: my (@possibles,%locale_names);
962: my @locales = DateTime::Locale::Catalog::Locales;
963: foreach my $locale (@locales) {
964: if (ref($locale) eq 'HASH') {
965: my $id = $locale->{'id'};
966: if ($id ne '') {
967: my $en_terr = $locale->{'en_territory'};
968: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 969: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 970: if (grep(/^en$/,@languages) || !@languages) {
971: if ($en_terr ne '') {
972: $locale_names{$id} = '('.$en_terr.')';
973: } elsif ($native_terr ne '') {
974: $locale_names{$id} = $native_terr;
975: }
976: } else {
977: if ($native_terr ne '') {
978: $locale_names{$id} = $native_terr.' ';
979: } elsif ($en_terr ne '') {
980: $locale_names{$id} = '('.$en_terr.')';
981: }
982: }
983: push (@possibles,$id);
984: }
985: }
986: }
987: foreach my $item (sort(@possibles)) {
988: $output.= '<option value="'.$item.'"';
989: if ($item eq $selected) {
990: $output.=' selected="selected"';
991: }
992: $output.=">$item";
993: if ($locale_names{$item} ne '') {
994: $output.=" $locale_names{$item}</option>\n";
995: }
996: $output.="</option>\n";
997: }
998: $output.="</select>";
999: return $output;
1000: }
1001:
1.792 raeburn 1002: sub select_language {
1003: my ($name,$selected,$includeempty) = @_;
1004: my %langchoices;
1005: if ($includeempty) {
1.1117 raeburn 1006: %langchoices = ('' => 'No language preference');
1.792 raeburn 1007: }
1008: foreach my $id (&languageids()) {
1009: my $code = &supportedlanguagecode($id);
1010: if ($code) {
1011: $langchoices{$code} = &plainlanguagedescription($id);
1012: }
1013: }
1.1117 raeburn 1014: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970 raeburn 1015: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 1016: }
1017:
1.42 matthew 1018: =pod
1.36 matthew 1019:
1.1088 foxr 1020:
1021: =item * &list_languages()
1022:
1023: Returns an array reference that is suitable for use in language prompters.
1024: Each array element is itself a two element array. The first element
1025: is the language code. The second element a descsriptiuon of the
1026: language itself. This is suitable for use in e.g.
1027: &Apache::edit::select_arg (once dereferenced that is).
1028:
1029: =cut
1030:
1031: sub list_languages {
1032: my @lang_choices;
1033:
1034: foreach my $id (&languageids()) {
1035: my $code = &supportedlanguagecode($id);
1036: if ($code) {
1037: my $selector = $supported_codes{$id};
1038: my $description = &plainlanguagedescription($id);
1039: push (@lang_choices, [$selector, $description]);
1040: }
1041: }
1042: return \@lang_choices;
1043: }
1044:
1045: =pod
1046:
1.648 raeburn 1047: =item * &linked_select_forms(...)
1.36 matthew 1048:
1049: linked_select_forms returns a string containing a <script></script> block
1050: and html for two <select> menus. The select menus will be linked in that
1051: changing the value of the first menu will result in new values being placed
1052: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1053: order unless a defined order is provided.
1.36 matthew 1054:
1055: linked_select_forms takes the following ordered inputs:
1056:
1057: =over 4
1058:
1.112 bowersj2 1059: =item * $formname, the name of the <form> tag
1.36 matthew 1060:
1.112 bowersj2 1061: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1062:
1.112 bowersj2 1063: =item * $firstdefault, the default value for the first menu
1.36 matthew 1064:
1.112 bowersj2 1065: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1066:
1.112 bowersj2 1067: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1068:
1.112 bowersj2 1069: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1070:
1.609 raeburn 1071: =item * $menuorder, the order of values in the first menu
1072:
1.1115 raeburn 1073: =item * $onchangefirst, additional javascript call to execute for an onchange
1074: event for the first <select> tag
1075:
1076: =item * $onchangesecond, additional javascript call to execute for an onchange
1077: event for the second <select> tag
1078:
1.41 ng 1079: =back
1080:
1.36 matthew 1081: Below is an example of such a hash. Only the 'text', 'default', and
1082: 'select2' keys must appear as stated. keys(%menu) are the possible
1083: values for the first select menu. The text that coincides with the
1.41 ng 1084: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1085: and text for the second menu are given in the hash pointed to by
1086: $menu{$choice1}->{'select2'}.
1087:
1.112 bowersj2 1088: my %menu = ( A1 => { text =>"Choice A1" ,
1089: default => "B3",
1090: select2 => {
1091: B1 => "Choice B1",
1092: B2 => "Choice B2",
1093: B3 => "Choice B3",
1094: B4 => "Choice B4"
1.609 raeburn 1095: },
1096: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1097: },
1098: A2 => { text =>"Choice A2" ,
1099: default => "C2",
1100: select2 => {
1101: C1 => "Choice C1",
1102: C2 => "Choice C2",
1103: C3 => "Choice C3"
1.609 raeburn 1104: },
1105: order => ['C2','C1','C3'],
1.112 bowersj2 1106: },
1107: A3 => { text =>"Choice A3" ,
1108: default => "D6",
1109: select2 => {
1110: D1 => "Choice D1",
1111: D2 => "Choice D2",
1112: D3 => "Choice D3",
1113: D4 => "Choice D4",
1114: D5 => "Choice D5",
1115: D6 => "Choice D6",
1116: D7 => "Choice D7"
1.609 raeburn 1117: },
1118: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1119: }
1120: );
1.36 matthew 1121:
1122: =cut
1123:
1124: sub linked_select_forms {
1125: my ($formname,
1126: $middletext,
1127: $firstdefault,
1128: $firstselectname,
1129: $secondselectname,
1.609 raeburn 1130: $hashref,
1131: $menuorder,
1.1115 raeburn 1132: $onchangefirst,
1133: $onchangesecond
1.36 matthew 1134: ) = @_;
1135: my $second = "document.$formname.$secondselectname";
1136: my $first = "document.$formname.$firstselectname";
1137: # output the javascript to do the changing
1138: my $result = '';
1.776 bisitz 1139: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1140: $result.="// <![CDATA[\n";
1.36 matthew 1141: $result.="var select2data = new Object();\n";
1142: $" = '","';
1143: my $debug = '';
1144: foreach my $s1 (sort(keys(%$hashref))) {
1145: $result.="select2data.d_$s1 = new Object();\n";
1146: $result.="select2data.d_$s1.def = new String('".
1147: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1148: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1149: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1150: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1151: @s2values = @{$hashref->{$s1}->{'order'}};
1152: }
1.36 matthew 1153: $result.="\"@s2values\");\n";
1154: $result.="select2data.d_$s1.texts = new Array(";
1155: my @s2texts;
1156: foreach my $value (@s2values) {
1157: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1158: }
1159: $result.="\"@s2texts\");\n";
1160: }
1161: $"=' ';
1162: $result.= <<"END";
1163:
1164: function select1_changed() {
1165: // Determine new choice
1166: var newvalue = "d_" + $first.value;
1167: // update select2
1168: var values = select2data[newvalue].values;
1169: var texts = select2data[newvalue].texts;
1170: var select2def = select2data[newvalue].def;
1171: var i;
1172: // out with the old
1173: for (i = 0; i < $second.options.length; i++) {
1174: $second.options[i] = null;
1175: }
1176: // in with the nuclear
1177: for (i=0;i<values.length; i++) {
1178: $second.options[i] = new Option(values[i]);
1.143 matthew 1179: $second.options[i].value = values[i];
1.36 matthew 1180: $second.options[i].text = texts[i];
1181: if (values[i] == select2def) {
1182: $second.options[i].selected = true;
1183: }
1184: }
1185: }
1.824 bisitz 1186: // ]]>
1.36 matthew 1187: </script>
1188: END
1189: # output the initial values for the selection lists
1.1115 raeburn 1190: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1191: my @order = sort(keys(%{$hashref}));
1192: if (ref($menuorder) eq 'ARRAY') {
1193: @order = @{$menuorder};
1194: }
1195: foreach my $value (@order) {
1.36 matthew 1196: $result.=" <option value=\"$value\" ";
1.253 albertel 1197: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1198: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1199: }
1200: $result .= "</select>\n";
1201: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1202: $result .= $middletext;
1.1115 raeburn 1203: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1204: if ($onchangesecond) {
1205: $result .= ' onchange="'.$onchangesecond.'"';
1206: }
1207: $result .= ">\n";
1.36 matthew 1208: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1209:
1210: my @secondorder = sort(keys(%select2));
1211: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1212: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1213: }
1214: foreach my $value (@secondorder) {
1.36 matthew 1215: $result.=" <option value=\"$value\" ";
1.253 albertel 1216: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1217: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1218: }
1219: $result .= "</select>\n";
1220: # return $debug;
1221: return $result;
1222: } # end of sub linked_select_forms {
1223:
1.45 matthew 1224: =pod
1.44 bowersj2 1225:
1.973 raeburn 1226: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1227:
1.112 bowersj2 1228: Returns a string corresponding to an HTML link to the given help
1229: $topic, where $topic corresponds to the name of a .tex file in
1230: /home/httpd/html/adm/help/tex, with underscores replaced by
1231: spaces.
1232:
1233: $text will optionally be linked to the same topic, allowing you to
1234: link text in addition to the graphic. If you do not want to link
1235: text, but wish to specify one of the later parameters, pass an
1236: empty string.
1237:
1238: $stayOnPage is a value that will be interpreted as a boolean. If true,
1239: the link will not open a new window. If false, the link will open
1240: a new window using Javascript. (Default is false.)
1241:
1242: $width and $height are optional numerical parameters that will
1243: override the width and height of the popped up window, which may
1.973 raeburn 1244: be useful for certain help topics with big pictures included.
1245:
1246: $imgid is the id of the img tag used for the help icon. This may be
1247: used in a javascript call to switch the image src. See
1248: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1249:
1250: =cut
1251:
1252: sub help_open_topic {
1.973 raeburn 1253: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1254: $text = "" if (not defined $text);
1.44 bowersj2 1255: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1256: $width = 500 if (not defined $width);
1.44 bowersj2 1257: $height = 400 if (not defined $height);
1258: my $filename = $topic;
1259: $filename =~ s/ /_/g;
1260:
1.48 bowersj2 1261: my $template = "";
1262: my $link;
1.572 banghart 1263:
1.159 www 1264: $topic=~s/\W/\_/g;
1.44 bowersj2 1265:
1.572 banghart 1266: if (!$stayOnPage) {
1.1033 www 1267: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1268: } elsif ($stayOnPage eq 'popup') {
1269: $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 1270: } else {
1.48 bowersj2 1271: $link = "/adm/help/${filename}.hlp";
1272: }
1273:
1274: # Add the text
1.755 neumanie 1275: if ($text ne "") {
1.763 bisitz 1276: $template.='<span class="LC_help_open_topic">'
1277: .'<a target="_top" href="'.$link.'">'
1278: .$text.'</a>';
1.48 bowersj2 1279: }
1280:
1.763 bisitz 1281: # (Always) Add the graphic
1.179 matthew 1282: my $title = &mt('Online Help');
1.667 raeburn 1283: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1284: if ($imgid ne '') {
1285: $imgid = ' id="'.$imgid.'"';
1286: }
1.763 bisitz 1287: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1288: .'<img src="'.$helpicon.'" border="0"'
1289: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1290: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1291: .' /></a>';
1292: if ($text ne "") {
1293: $template.='</span>';
1294: }
1.44 bowersj2 1295: return $template;
1296:
1.106 bowersj2 1297: }
1298:
1299: # This is a quicky function for Latex cheatsheet editing, since it
1300: # appears in at least four places
1301: sub helpLatexCheatsheet {
1.1037 www 1302: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1303: my $out;
1.106 bowersj2 1304: my $addOther = '';
1.732 raeburn 1305: if ($topic) {
1.1037 www 1306: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1307: }
1308: $out = '<span>' # Start cheatsheet
1309: .$addOther
1310: .'<span>'
1.1037 www 1311: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1312: .'</span> <span>'
1.1037 www 1313: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1314: .'</span>';
1.732 raeburn 1315: unless ($not_author) {
1.763 bisitz 1316: $out .= ' <span>'
1.1037 www 1317: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1318: .'</span>';
1.732 raeburn 1319: }
1.763 bisitz 1320: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1321: return $out;
1.172 www 1322: }
1323:
1.430 albertel 1324: sub general_help {
1325: my $helptopic='Student_Intro';
1326: if ($env{'request.role'}=~/^(ca|au)/) {
1327: $helptopic='Authoring_Intro';
1.907 raeburn 1328: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1329: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1330: } elsif ($env{'request.role'}=~/^dc/) {
1331: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1332: }
1333: return $helptopic;
1334: }
1335:
1336: sub update_help_link {
1337: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1338: my $origurl = $ENV{'REQUEST_URI'};
1339: $origurl=~s|^/~|/priv/|;
1340: my $timestamp = time;
1341: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1342: $$datum = &escape($$datum);
1343: }
1344:
1345: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1346: my $output .= <<"ENDOUTPUT";
1347: <script type="text/javascript">
1.824 bisitz 1348: // <![CDATA[
1.430 albertel 1349: banner_link = '$banner_link';
1.824 bisitz 1350: // ]]>
1.430 albertel 1351: </script>
1352: ENDOUTPUT
1353: return $output;
1354: }
1355:
1356: # now just updates the help link and generates a blue icon
1.193 raeburn 1357: sub help_open_menu {
1.430 albertel 1358: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1359: = @_;
1.949 droeschl 1360: $stayOnPage = 1;
1.430 albertel 1361: my $output;
1362: if ($component_help) {
1363: if (!$text) {
1364: $output=&help_open_topic($component_help,undef,$stayOnPage,
1365: $width,$height);
1366: } else {
1367: my $help_text;
1368: $help_text=&unescape($topic);
1369: $output='<table><tr><td>'.
1370: &help_open_topic($component_help,$help_text,$stayOnPage,
1371: $width,$height).'</td></tr></table>';
1372: }
1373: }
1374: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1375: return $output.$banner_link;
1376: }
1377:
1378: sub top_nav_help {
1379: my ($text) = @_;
1.436 albertel 1380: $text = &mt($text);
1.949 droeschl 1381: my $stay_on_page = 1;
1382:
1.572 banghart 1383: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1384: : "javascript:helpMenu('open')";
1.572 banghart 1385: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1386:
1.201 raeburn 1387: my $title = &mt('Get help');
1.436 albertel 1388:
1389: return <<"END";
1390: $banner_link
1391: <a href="$link" title="$title">$text</a>
1392: END
1393: }
1394:
1395: sub help_menu_js {
1396: my ($text) = @_;
1.949 droeschl 1397: my $stayOnPage = 1;
1.436 albertel 1398: my $width = 620;
1399: my $height = 600;
1.430 albertel 1400: my $helptopic=&general_help();
1401: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1402: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1403: my $start_page =
1404: &Apache::loncommon::start_page('Help Menu', undef,
1405: {'frameset' => 1,
1406: 'js_ready' => 1,
1407: 'add_entries' => {
1408: 'border' => '0',
1.579 raeburn 1409: 'rows' => "110,*",},});
1.331 albertel 1410: my $end_page =
1411: &Apache::loncommon::end_page({'frameset' => 1,
1412: 'js_ready' => 1,});
1413:
1.436 albertel 1414: my $template .= <<"ENDTEMPLATE";
1415: <script type="text/javascript">
1.877 bisitz 1416: // <![CDATA[
1.253 albertel 1417: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1418: var banner_link = '';
1.243 raeburn 1419: function helpMenu(target) {
1420: var caller = this;
1421: if (target == 'open') {
1422: var newWindow = null;
1423: try {
1.262 albertel 1424: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1425: }
1426: catch(error) {
1427: writeHelp(caller);
1428: return;
1429: }
1430: if (newWindow) {
1431: caller = newWindow;
1432: }
1.193 raeburn 1433: }
1.243 raeburn 1434: writeHelp(caller);
1435: return;
1436: }
1437: function writeHelp(caller) {
1.1072 raeburn 1438: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" />\\n<frame name="bodyframe" src="$details_link" />\\n$end_page')
1.243 raeburn 1439: caller.document.close()
1440: caller.focus()
1.193 raeburn 1441: }
1.877 bisitz 1442: // END LON-CAPA Internal -->
1.253 albertel 1443: // ]]>
1.436 albertel 1444: </script>
1.193 raeburn 1445: ENDTEMPLATE
1446: return $template;
1447: }
1448:
1.172 www 1449: sub help_open_bug {
1450: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1451: unless ($env{'user.adv'}) { return ''; }
1.172 www 1452: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1453: $text = "" if (not defined $text);
1454: $stayOnPage=1;
1.184 albertel 1455: $width = 600 if (not defined $width);
1456: $height = 600 if (not defined $height);
1.172 www 1457:
1458: $topic=~s/\W+/\+/g;
1459: my $link='';
1460: my $template='';
1.379 albertel 1461: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1462: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1463: if (!$stayOnPage)
1464: {
1465: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1466: }
1467: else
1468: {
1469: $link = $url;
1470: }
1471: # Add the text
1472: if ($text ne "")
1473: {
1474: $template .=
1475: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1476: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1477: }
1478:
1479: # Add the graphic
1.179 matthew 1480: my $title = &mt('Report a Bug');
1.215 albertel 1481: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1482: $template .= <<"ENDTEMPLATE";
1.436 albertel 1483: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1484: ENDTEMPLATE
1485: if ($text ne '') { $template.='</td></tr></table>' };
1486: return $template;
1487:
1488: }
1489:
1490: sub help_open_faq {
1491: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1492: unless ($env{'user.adv'}) { return ''; }
1.172 www 1493: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1494: $text = "" if (not defined $text);
1495: $stayOnPage=1;
1496: $width = 350 if (not defined $width);
1497: $height = 400 if (not defined $height);
1498:
1499: $topic=~s/\W+/\+/g;
1500: my $link='';
1501: my $template='';
1502: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1503: if (!$stayOnPage)
1504: {
1505: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1506: }
1507: else
1508: {
1509: $link = $url;
1510: }
1511:
1512: # Add the text
1513: if ($text ne "")
1514: {
1515: $template .=
1.173 www 1516: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1517: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1518: }
1519:
1520: # Add the graphic
1.179 matthew 1521: my $title = &mt('View the FAQ');
1.215 albertel 1522: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1523: $template .= <<"ENDTEMPLATE";
1.436 albertel 1524: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1525: ENDTEMPLATE
1526: if ($text ne '') { $template.='</td></tr></table>' };
1527: return $template;
1528:
1.44 bowersj2 1529: }
1.37 matthew 1530:
1.180 matthew 1531: ###############################################################
1532: ###############################################################
1533:
1.45 matthew 1534: =pod
1535:
1.648 raeburn 1536: =item * &change_content_javascript():
1.256 matthew 1537:
1538: This and the next function allow you to create small sections of an
1539: otherwise static HTML page that you can update on the fly with
1540: Javascript, even in Netscape 4.
1541:
1542: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1543: must be written to the HTML page once. It will prove the Javascript
1544: function "change(name, content)". Calling the change function with the
1545: name of the section
1546: you want to update, matching the name passed to C<changable_area>, and
1547: the new content you want to put in there, will put the content into
1548: that area.
1549:
1550: B<Note>: Netscape 4 only reserves enough space for the changable area
1551: to contain room for the original contents. You need to "make space"
1552: for whatever changes you wish to make, and be B<sure> to check your
1553: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1554: it's adequate for updating a one-line status display, but little more.
1555: This script will set the space to 100% width, so you only need to
1556: worry about height in Netscape 4.
1557:
1558: Modern browsers are much less limiting, and if you can commit to the
1559: user not using Netscape 4, this feature may be used freely with
1560: pretty much any HTML.
1561:
1562: =cut
1563:
1564: sub change_content_javascript {
1565: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1566: if ($env{'browser.type'} eq 'netscape' &&
1567: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1568: return (<<NETSCAPE4);
1569: function change(name, content) {
1570: doc = document.layers[name+"___escape"].layers[0].document;
1571: doc.open();
1572: doc.write(content);
1573: doc.close();
1574: }
1575: NETSCAPE4
1576: } else {
1577: # Otherwise, we need to use semi-standards-compliant code
1578: # (technically, "innerHTML" isn't standard but the equivalent
1579: # is really scary, and every useful browser supports it
1580: return (<<DOMBASED);
1581: function change(name, content) {
1582: element = document.getElementById(name);
1583: element.innerHTML = content;
1584: }
1585: DOMBASED
1586: }
1587: }
1588:
1589: =pod
1590:
1.648 raeburn 1591: =item * &changable_area($name,$origContent):
1.256 matthew 1592:
1593: This provides a "changable area" that can be modified on the fly via
1594: the Javascript code provided in C<change_content_javascript>. $name is
1595: the name you will use to reference the area later; do not repeat the
1596: same name on a given HTML page more then once. $origContent is what
1597: the area will originally contain, which can be left blank.
1598:
1599: =cut
1600:
1601: sub changable_area {
1602: my ($name, $origContent) = @_;
1603:
1.258 albertel 1604: if ($env{'browser.type'} eq 'netscape' &&
1605: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1606: # If this is netscape 4, we need to use the Layer tag
1607: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1608: } else {
1609: return "<span id='$name'>$origContent</span>";
1610: }
1611: }
1612:
1613: =pod
1614:
1.648 raeburn 1615: =item * &viewport_geometry_js
1.590 raeburn 1616:
1617: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1618:
1619: =cut
1620:
1621:
1622: sub viewport_geometry_js {
1623: return <<"GEOMETRY";
1624: var Geometry = {};
1625: function init_geometry() {
1626: if (Geometry.init) { return };
1627: Geometry.init=1;
1628: if (window.innerHeight) {
1629: Geometry.getViewportHeight = function() { return window.innerHeight; };
1630: Geometry.getViewportWidth = function() { return window.innerWidth; };
1631: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1632: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1633: }
1634: else if (document.documentElement && document.documentElement.clientHeight) {
1635: Geometry.getViewportHeight =
1636: function() { return document.documentElement.clientHeight; };
1637: Geometry.getViewportWidth =
1638: function() { return document.documentElement.clientWidth; };
1639:
1640: Geometry.getHorizontalScroll =
1641: function() { return document.documentElement.scrollLeft; };
1642: Geometry.getVerticalScroll =
1643: function() { return document.documentElement.scrollTop; };
1644: }
1645: else if (document.body.clientHeight) {
1646: Geometry.getViewportHeight =
1647: function() { return document.body.clientHeight; };
1648: Geometry.getViewportWidth =
1649: function() { return document.body.clientWidth; };
1650: Geometry.getHorizontalScroll =
1651: function() { return document.body.scrollLeft; };
1652: Geometry.getVerticalScroll =
1653: function() { return document.body.scrollTop; };
1654: }
1655: }
1656:
1657: GEOMETRY
1658: }
1659:
1660: =pod
1661:
1.648 raeburn 1662: =item * &viewport_size_js()
1.590 raeburn 1663:
1664: 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.
1665:
1666: =cut
1667:
1668: sub viewport_size_js {
1669: my $geometry = &viewport_geometry_js();
1670: return <<"DIMS";
1671:
1672: $geometry
1673:
1674: function getViewportDims(width,height) {
1675: init_geometry();
1676: width.value = Geometry.getViewportWidth();
1677: height.value = Geometry.getViewportHeight();
1678: return;
1679: }
1680:
1681: DIMS
1682: }
1683:
1684: =pod
1685:
1.648 raeburn 1686: =item * &resize_textarea_js()
1.565 albertel 1687:
1688: emits the needed javascript to resize a textarea to be as big as possible
1689:
1690: creates a function resize_textrea that takes two IDs first should be
1691: the id of the element to resize, second should be the id of a div that
1692: surrounds everything that comes after the textarea, this routine needs
1693: to be attached to the <body> for the onload and onresize events.
1694:
1.648 raeburn 1695: =back
1.565 albertel 1696:
1697: =cut
1698:
1699: sub resize_textarea_js {
1.590 raeburn 1700: my $geometry = &viewport_geometry_js();
1.565 albertel 1701: return <<"RESIZE";
1702: <script type="text/javascript">
1.824 bisitz 1703: // <![CDATA[
1.590 raeburn 1704: $geometry
1.565 albertel 1705:
1.588 albertel 1706: function getX(element) {
1707: var x = 0;
1708: while (element) {
1709: x += element.offsetLeft;
1710: element = element.offsetParent;
1711: }
1712: return x;
1713: }
1714: function getY(element) {
1715: var y = 0;
1716: while (element) {
1717: y += element.offsetTop;
1718: element = element.offsetParent;
1719: }
1720: return y;
1721: }
1722:
1723:
1.565 albertel 1724: function resize_textarea(textarea_id,bottom_id) {
1725: init_geometry();
1726: var textarea = document.getElementById(textarea_id);
1727: //alert(textarea);
1728:
1.588 albertel 1729: var textarea_top = getY(textarea);
1.565 albertel 1730: var textarea_height = textarea.offsetHeight;
1731: var bottom = document.getElementById(bottom_id);
1.588 albertel 1732: var bottom_top = getY(bottom);
1.565 albertel 1733: var bottom_height = bottom.offsetHeight;
1734: var window_height = Geometry.getViewportHeight();
1.588 albertel 1735: var fudge = 23;
1.565 albertel 1736: var new_height = window_height-fudge-textarea_top-bottom_height;
1737: if (new_height < 300) {
1738: new_height = 300;
1739: }
1740: textarea.style.height=new_height+'px';
1741: }
1.824 bisitz 1742: // ]]>
1.565 albertel 1743: </script>
1744: RESIZE
1745:
1746: }
1747:
1748: =pod
1749:
1.256 matthew 1750: =head1 Excel and CSV file utility routines
1751:
1752: =over 4
1753:
1754: =cut
1755:
1756: ###############################################################
1757: ###############################################################
1758:
1759: =pod
1760:
1.648 raeburn 1761: =item * &csv_translate($text)
1.37 matthew 1762:
1.185 www 1763: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1764: format.
1765:
1766: =cut
1767:
1.180 matthew 1768: ###############################################################
1769: ###############################################################
1.37 matthew 1770: sub csv_translate {
1771: my $text = shift;
1772: $text =~ s/\"/\"\"/g;
1.209 albertel 1773: $text =~ s/\n/ /g;
1.37 matthew 1774: return $text;
1775: }
1.180 matthew 1776:
1777: ###############################################################
1778: ###############################################################
1779:
1780: =pod
1781:
1.648 raeburn 1782: =item * &define_excel_formats()
1.180 matthew 1783:
1784: Define some commonly used Excel cell formats.
1785:
1786: Currently supported formats:
1787:
1788: =over 4
1789:
1790: =item header
1791:
1792: =item bold
1793:
1794: =item h1
1795:
1796: =item h2
1797:
1798: =item h3
1799:
1.256 matthew 1800: =item h4
1801:
1802: =item i
1803:
1.180 matthew 1804: =item date
1805:
1806: =back
1807:
1808: Inputs: $workbook
1809:
1810: Returns: $format, a hash reference.
1811:
1.1057 foxr 1812:
1.180 matthew 1813: =cut
1814:
1815: ###############################################################
1816: ###############################################################
1817: sub define_excel_formats {
1818: my ($workbook) = @_;
1819: my $format;
1820: $format->{'header'} = $workbook->add_format(bold => 1,
1821: bottom => 1,
1822: align => 'center');
1823: $format->{'bold'} = $workbook->add_format(bold=>1);
1824: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1825: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1826: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1827: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1828: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1829: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1830: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1831: return $format;
1832: }
1833:
1834: ###############################################################
1835: ###############################################################
1.113 bowersj2 1836:
1837: =pod
1838:
1.648 raeburn 1839: =item * &create_workbook()
1.255 matthew 1840:
1841: Create an Excel worksheet. If it fails, output message on the
1842: request object and return undefs.
1843:
1844: Inputs: Apache request object
1845:
1846: Returns (undef) on failure,
1847: Excel worksheet object, scalar with filename, and formats
1848: from &Apache::loncommon::define_excel_formats on success
1849:
1850: =cut
1851:
1852: ###############################################################
1853: ###############################################################
1854: sub create_workbook {
1855: my ($r) = @_;
1856: #
1857: # Create the excel spreadsheet
1858: my $filename = '/prtspool/'.
1.258 albertel 1859: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1860: time.'_'.rand(1000000000).'.xls';
1861: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1862: if (! defined($workbook)) {
1863: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1864: $r->print(
1865: '<p class="LC_error">'
1866: .&mt('Problems occurred in creating the new Excel file.')
1867: .' '.&mt('This error has been logged.')
1868: .' '.&mt('Please alert your LON-CAPA administrator.')
1869: .'</p>'
1870: );
1.255 matthew 1871: return (undef);
1872: }
1873: #
1.1014 foxr 1874: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1875: #
1876: my $format = &Apache::loncommon::define_excel_formats($workbook);
1877: return ($workbook,$filename,$format);
1878: }
1879:
1880: ###############################################################
1881: ###############################################################
1882:
1883: =pod
1884:
1.648 raeburn 1885: =item * &create_text_file()
1.113 bowersj2 1886:
1.542 raeburn 1887: Create a file to write to and eventually make available to the user.
1.256 matthew 1888: If file creation fails, outputs an error message on the request object and
1889: return undefs.
1.113 bowersj2 1890:
1.256 matthew 1891: Inputs: Apache request object, and file suffix
1.113 bowersj2 1892:
1.256 matthew 1893: Returns (undef) on failure,
1894: Filehandle and filename on success.
1.113 bowersj2 1895:
1896: =cut
1897:
1.256 matthew 1898: ###############################################################
1899: ###############################################################
1900: sub create_text_file {
1901: my ($r,$suffix) = @_;
1902: if (! defined($suffix)) { $suffix = 'txt'; };
1903: my $fh;
1904: my $filename = '/prtspool/'.
1.258 albertel 1905: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1906: time.'_'.rand(1000000000).'.'.$suffix;
1907: $fh = Apache::File->new('>/home/httpd'.$filename);
1908: if (! defined($fh)) {
1909: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1910: $r->print(
1911: '<p class="LC_error">'
1912: .&mt('Problems occurred in creating the output file.')
1913: .' '.&mt('This error has been logged.')
1914: .' '.&mt('Please alert your LON-CAPA administrator.')
1915: .'</p>'
1916: );
1.113 bowersj2 1917: }
1.256 matthew 1918: return ($fh,$filename)
1.113 bowersj2 1919: }
1920:
1921:
1.256 matthew 1922: =pod
1.113 bowersj2 1923:
1924: =back
1925:
1926: =cut
1.37 matthew 1927:
1928: ###############################################################
1.33 matthew 1929: ## Home server <option> list generating code ##
1930: ###############################################################
1.35 matthew 1931:
1.169 www 1932: # ------------------------------------------
1933:
1934: sub domain_select {
1935: my ($name,$value,$multiple)=@_;
1936: my %domains=map {
1.514 albertel 1937: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1938: } &Apache::lonnet::all_domains();
1.169 www 1939: if ($multiple) {
1940: $domains{''}=&mt('Any domain');
1.550 albertel 1941: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1942: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1943: } else {
1.550 albertel 1944: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1945: return &select_form($name,$value,\%domains);
1.169 www 1946: }
1947: }
1948:
1.282 albertel 1949: #-------------------------------------------
1950:
1951: =pod
1952:
1.519 raeburn 1953: =head1 Routines for form select boxes
1954:
1955: =over 4
1956:
1.648 raeburn 1957: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1958:
1959: Returns a string containing a <select> element int multiple mode
1960:
1961:
1962: Args:
1963: $name - name of the <select> element
1.506 raeburn 1964: $value - scalar or array ref of values that should already be selected
1.282 albertel 1965: $size - number of rows long the select element is
1.283 albertel 1966: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1967: (shown text should already have been &mt())
1.506 raeburn 1968: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1969:
1.282 albertel 1970: =cut
1971:
1972: #-------------------------------------------
1.169 www 1973: sub multiple_select_form {
1.284 albertel 1974: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1975: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1976: my $output='';
1.191 matthew 1977: if (! defined($size)) {
1978: $size = 4;
1.283 albertel 1979: if (scalar(keys(%$hash))<4) {
1980: $size = scalar(keys(%$hash));
1.191 matthew 1981: }
1982: }
1.734 bisitz 1983: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1984: my @order;
1.506 raeburn 1985: if (ref($order) eq 'ARRAY') {
1986: @order = @{$order};
1987: } else {
1988: @order = sort(keys(%$hash));
1.501 banghart 1989: }
1990: if (exists($$hash{'select_form_order'})) {
1991: @order = @{$$hash{'select_form_order'}};
1992: }
1993:
1.284 albertel 1994: foreach my $key (@order) {
1.356 albertel 1995: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1996: $output.='selected="selected" ' if ($selected{$key});
1997: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1998: }
1999: $output.="</select>\n";
2000: return $output;
2001: }
2002:
1.88 www 2003: #-------------------------------------------
2004:
2005: =pod
2006:
1.970 raeburn 2007: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 2008:
2009: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2010: allow a user to select options from a ref to a hash containing:
2011: option_name => displayed text. An optional $onchange can include
2012: a javascript onchange item, e.g., onchange="this.form.submit();"
2013:
1.88 www 2014: See lonrights.pm for an example invocation and use.
2015:
2016: =cut
2017:
2018: #-------------------------------------------
2019: sub select_form {
1.970 raeburn 2020: my ($def,$name,$hashref,$onchange) = @_;
2021: return unless (ref($hashref) eq 'HASH');
2022: if ($onchange) {
2023: $onchange = ' onchange="'.$onchange.'"';
2024: }
2025: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 2026: my @keys;
1.970 raeburn 2027: if (exists($hashref->{'select_form_order'})) {
2028: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2029: } else {
1.970 raeburn 2030: @keys=sort(keys(%{$hashref}));
1.128 albertel 2031: }
1.356 albertel 2032: foreach my $key (@keys) {
2033: $selectform.=
2034: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2035: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2036: ">".$hashref->{$key}."</option>\n";
1.88 www 2037: }
2038: $selectform.="</select>";
2039: return $selectform;
2040: }
2041:
1.475 www 2042: # For display filters
2043:
2044: sub display_filter {
1.1074 raeburn 2045: my ($context) = @_;
1.475 www 2046: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2047: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2048: my $phraseinput = 'hidden';
2049: my $includeinput = 'hidden';
2050: my ($checked,$includetypestext);
2051: if ($env{'form.displayfilter'} eq 'containing') {
2052: $phraseinput = 'text';
2053: if ($context eq 'parmslog') {
2054: $includeinput = 'checkbox';
2055: if ($env{'form.includetypes'}) {
2056: $checked = ' checked="checked"';
2057: }
2058: $includetypestext = &mt('Include parameter types');
2059: }
2060: } else {
2061: $includetypestext = ' ';
2062: }
2063: my ($additional,$secondid,$thirdid);
2064: if ($context eq 'parmslog') {
2065: $additional =
2066: '<label><input type="'.$includeinput.'" name="includetypes"'.
2067: $checked.' name="includetypes" value="1" id="includetypes" />'.
2068: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2069: '</label>';
2070: $secondid = 'includetypes';
2071: $thirdid = 'includetypestext';
2072: }
2073: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2074: '$secondid','$thirdid')";
2075: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2076: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2077: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2078: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2079: &mt('Filter: [_1]',
1.477 www 2080: &select_form($env{'form.displayfilter'},
2081: 'displayfilter',
1.970 raeburn 2082: {'currentfolder' => 'Current folder/page',
1.477 www 2083: 'containing' => 'Containing phrase',
1.1074 raeburn 2084: 'none' => 'None'},$onchange)).' '.
2085: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2086: &HTML::Entities::encode($env{'form.containingphrase'}).
2087: '" />'.$additional;
2088: }
2089:
2090: sub display_filter_js {
2091: my $includetext = &mt('Include parameter types');
2092: return <<"ENDJS";
2093:
2094: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2095: var firstType = 'hidden';
2096: if (setter.options[setter.selectedIndex].value == 'containing') {
2097: firstType = 'text';
2098: }
2099: firstObject = document.getElementById(firstid);
2100: if (typeof(firstObject) == 'object') {
2101: if (firstObject.type != firstType) {
2102: changeInputType(firstObject,firstType);
2103: }
2104: }
2105: if (context == 'parmslog') {
2106: var secondType = 'hidden';
2107: if (firstType == 'text') {
2108: secondType = 'checkbox';
2109: }
2110: secondObject = document.getElementById(secondid);
2111: if (typeof(secondObject) == 'object') {
2112: if (secondObject.type != secondType) {
2113: changeInputType(secondObject,secondType);
2114: }
2115: }
2116: var textItem = document.getElementById(thirdid);
2117: var currtext = textItem.innerHTML;
2118: var newtext;
2119: if (firstType == 'text') {
2120: newtext = '$includetext';
2121: } else {
2122: newtext = ' ';
2123: }
2124: if (currtext != newtext) {
2125: textItem.innerHTML = newtext;
2126: }
2127: }
2128: return;
2129: }
2130:
2131: function changeInputType(oldObject,newType) {
2132: var newObject = document.createElement('input');
2133: newObject.type = newType;
2134: if (oldObject.size) {
2135: newObject.size = oldObject.size;
2136: }
2137: if (oldObject.value) {
2138: newObject.value = oldObject.value;
2139: }
2140: if (oldObject.name) {
2141: newObject.name = oldObject.name;
2142: }
2143: if (oldObject.id) {
2144: newObject.id = oldObject.id;
2145: }
2146: oldObject.parentNode.replaceChild(newObject,oldObject);
2147: return;
2148: }
2149:
2150: ENDJS
1.475 www 2151: }
2152:
1.167 www 2153: sub gradeleveldescription {
2154: my $gradelevel=shift;
2155: my %gradelevels=(0 => 'Not specified',
2156: 1 => 'Grade 1',
2157: 2 => 'Grade 2',
2158: 3 => 'Grade 3',
2159: 4 => 'Grade 4',
2160: 5 => 'Grade 5',
2161: 6 => 'Grade 6',
2162: 7 => 'Grade 7',
2163: 8 => 'Grade 8',
2164: 9 => 'Grade 9',
2165: 10 => 'Grade 10',
2166: 11 => 'Grade 11',
2167: 12 => 'Grade 12',
2168: 13 => 'Grade 13',
2169: 14 => '100 Level',
2170: 15 => '200 Level',
2171: 16 => '300 Level',
2172: 17 => '400 Level',
2173: 18 => 'Graduate Level');
2174: return &mt($gradelevels{$gradelevel});
2175: }
2176:
1.163 www 2177: sub select_level_form {
2178: my ($deflevel,$name)=@_;
2179: unless ($deflevel) { $deflevel=0; }
1.167 www 2180: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2181: for (my $i=0; $i<=18; $i++) {
2182: $selectform.="<option value=\"$i\" ".
1.253 albertel 2183: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2184: ">".&gradeleveldescription($i)."</option>\n";
2185: }
2186: $selectform.="</select>";
2187: return $selectform;
1.163 www 2188: }
1.167 www 2189:
1.35 matthew 2190: #-------------------------------------------
2191:
1.45 matthew 2192: =pod
2193:
1.1121 raeburn 2194: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms)
1.35 matthew 2195:
2196: Returns a string containing a <select name='$name' size='1'> form to
2197: allow a user to select the domain to preform an operation in.
2198: See loncreateuser.pm for an example invocation and use.
2199:
1.90 www 2200: If the $includeempty flag is set, it also includes an empty choice ("no domain
2201: selected");
2202:
1.743 raeburn 2203: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2204:
1.910 raeburn 2205: 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.
2206:
1.1121 raeburn 2207: The optional $incdoms is a reference to an array of domains which will be the only available options.
2208:
2209: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2210:
1.35 matthew 2211: =cut
2212:
2213: #-------------------------------------------
1.34 matthew 2214: sub select_dom_form {
1.1121 raeburn 2215: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872 raeburn 2216: if ($onchange) {
1.874 raeburn 2217: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2218: }
1.1121 raeburn 2219: my (@domains,%exclude);
1.910 raeburn 2220: if (ref($incdoms) eq 'ARRAY') {
2221: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2222: } else {
2223: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2224: }
1.90 www 2225: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2226: if (ref($excdoms) eq 'ARRAY') {
2227: map { $exclude{$_} = 1; } @{$excdoms};
2228: }
1.743 raeburn 2229: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2230: foreach my $dom (@domains) {
1.1121 raeburn 2231: next if ($exclude{$dom});
1.356 albertel 2232: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2233: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2234: if ($showdomdesc) {
2235: if ($dom ne '') {
2236: my $domdesc = &Apache::lonnet::domain($dom,'description');
2237: if ($domdesc ne '') {
2238: $selectdomain .= ' ('.$domdesc.')';
2239: }
2240: }
2241: }
2242: $selectdomain .= "</option>\n";
1.34 matthew 2243: }
2244: $selectdomain.="</select>";
2245: return $selectdomain;
2246: }
2247:
1.35 matthew 2248: #-------------------------------------------
2249:
1.45 matthew 2250: =pod
2251:
1.648 raeburn 2252: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2253:
1.586 raeburn 2254: input: 4 arguments (two required, two optional) -
2255: $domain - domain of new user
2256: $name - name of form element
2257: $default - Value of 'default' causes a default item to be first
2258: option, and selected by default.
2259: $hide - Value of 'hide' causes hiding of the name of the server,
2260: if 1 server found, or default, if 0 found.
1.594 raeburn 2261: output: returns 2 items:
1.586 raeburn 2262: (a) form element which contains either:
2263: (i) <select name="$name">
2264: <option value="$hostid1">$hostid $servers{$hostid}</option>
2265: <option value="$hostid2">$hostid $servers{$hostid}</option>
2266: </select>
2267: form item if there are multiple library servers in $domain, or
2268: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2269: if there is only one library server in $domain.
2270:
2271: (b) number of library servers found.
2272:
2273: See loncreateuser.pm for example of use.
1.35 matthew 2274:
2275: =cut
2276:
2277: #-------------------------------------------
1.586 raeburn 2278: sub home_server_form_item {
2279: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2280: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2281: my $result;
2282: my $numlib = keys(%servers);
2283: if ($numlib > 1) {
2284: $result .= '<select name="'.$name.'" />'."\n";
2285: if ($default) {
1.804 bisitz 2286: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2287: '</option>'."\n";
2288: }
2289: foreach my $hostid (sort(keys(%servers))) {
2290: $result.= '<option value="'.$hostid.'">'.
2291: $hostid.' '.$servers{$hostid}."</option>\n";
2292: }
2293: $result .= '</select>'."\n";
2294: } elsif ($numlib == 1) {
2295: my $hostid;
2296: foreach my $item (keys(%servers)) {
2297: $hostid = $item;
2298: }
2299: $result .= '<input type="hidden" name="'.$name.'" value="'.
2300: $hostid.'" />';
2301: if (!$hide) {
2302: $result .= $hostid.' '.$servers{$hostid};
2303: }
2304: $result .= "\n";
2305: } elsif ($default) {
2306: $result .= '<input type="hidden" name="'.$name.
2307: '" value="default" />';
2308: if (!$hide) {
2309: $result .= &mt('default');
2310: }
2311: $result .= "\n";
1.33 matthew 2312: }
1.586 raeburn 2313: return ($result,$numlib);
1.33 matthew 2314: }
1.112 bowersj2 2315:
2316: =pod
2317:
1.534 albertel 2318: =back
2319:
1.112 bowersj2 2320: =cut
1.87 matthew 2321:
2322: ###############################################################
1.112 bowersj2 2323: ## Decoding User Agent ##
1.87 matthew 2324: ###############################################################
2325:
2326: =pod
2327:
1.112 bowersj2 2328: =head1 Decoding the User Agent
2329:
2330: =over 4
2331:
2332: =item * &decode_user_agent()
1.87 matthew 2333:
2334: Inputs: $r
2335:
2336: Outputs:
2337:
2338: =over 4
2339:
1.112 bowersj2 2340: =item * $httpbrowser
1.87 matthew 2341:
1.112 bowersj2 2342: =item * $clientbrowser
1.87 matthew 2343:
1.112 bowersj2 2344: =item * $clientversion
1.87 matthew 2345:
1.112 bowersj2 2346: =item * $clientmathml
1.87 matthew 2347:
1.112 bowersj2 2348: =item * $clientunicode
1.87 matthew 2349:
1.112 bowersj2 2350: =item * $clientos
1.87 matthew 2351:
2352: =back
2353:
1.157 matthew 2354: =back
2355:
1.87 matthew 2356: =cut
2357:
2358: ###############################################################
2359: ###############################################################
2360: sub decode_user_agent {
1.247 albertel 2361: my ($r)=@_;
1.87 matthew 2362: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2363: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2364: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2365: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2366: my $clientbrowser='unknown';
2367: my $clientversion='0';
2368: my $clientmathml='';
2369: my $clientunicode='0';
2370: for (my $i=0;$i<=$#browsertype;$i++) {
2371: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2372: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2373: $clientbrowser=$bname;
2374: $httpbrowser=~/$vreg/i;
2375: $clientversion=$1;
2376: $clientmathml=($clientversion>=$minv);
2377: $clientunicode=($clientversion>=$univ);
2378: }
2379: }
2380: my $clientos='unknown';
2381: if (($httpbrowser=~/linux/i) ||
2382: ($httpbrowser=~/unix/i) ||
2383: ($httpbrowser=~/ux/i) ||
2384: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2385: if (($httpbrowser=~/vax/i) ||
2386: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2387: if ($httpbrowser=~/next/i) { $clientos='next'; }
2388: if (($httpbrowser=~/mac/i) ||
2389: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2390: if ($httpbrowser=~/win/i) { $clientos='win'; }
2391: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2392: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2393: $clientunicode,$clientos,);
2394: }
2395:
1.32 matthew 2396: ###############################################################
2397: ## Authentication changing form generation subroutines ##
2398: ###############################################################
2399: ##
2400: ## All of the authform_xxxxxxx subroutines take their inputs in a
2401: ## hash, and have reasonable default values.
2402: ##
2403: ## formname = the name given in the <form> tag.
1.35 matthew 2404: #-------------------------------------------
2405:
1.45 matthew 2406: =pod
2407:
1.112 bowersj2 2408: =head1 Authentication Routines
2409:
2410: =over 4
2411:
1.648 raeburn 2412: =item * &authform_xxxxxx()
1.35 matthew 2413:
2414: The authform_xxxxxx subroutines provide javascript and html forms which
2415: handle some of the conveniences required for authentication forms.
2416: This is not an optimal method, but it works.
2417:
2418: =over 4
2419:
1.112 bowersj2 2420: =item * authform_header
1.35 matthew 2421:
1.112 bowersj2 2422: =item * authform_authorwarning
1.35 matthew 2423:
1.112 bowersj2 2424: =item * authform_nochange
1.35 matthew 2425:
1.112 bowersj2 2426: =item * authform_kerberos
1.35 matthew 2427:
1.112 bowersj2 2428: =item * authform_internal
1.35 matthew 2429:
1.112 bowersj2 2430: =item * authform_filesystem
1.35 matthew 2431:
2432: =back
2433:
1.648 raeburn 2434: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2435:
1.35 matthew 2436: =cut
2437:
2438: #-------------------------------------------
1.32 matthew 2439: sub authform_header{
2440: my %in = (
2441: formname => 'cu',
1.80 albertel 2442: kerb_def_dom => '',
1.32 matthew 2443: @_,
2444: );
2445: $in{'formname'} = 'document.' . $in{'formname'};
2446: my $result='';
1.80 albertel 2447:
2448: #---------------------------------------------- Code for upper case translation
2449: my $Javascript_toUpperCase;
2450: unless ($in{kerb_def_dom}) {
2451: $Javascript_toUpperCase =<<"END";
2452: switch (choice) {
2453: case 'krb': currentform.elements[choicearg].value =
2454: currentform.elements[choicearg].value.toUpperCase();
2455: break;
2456: default:
2457: }
2458: END
2459: } else {
2460: $Javascript_toUpperCase = "";
2461: }
2462:
1.165 raeburn 2463: my $radioval = "'nochange'";
1.591 raeburn 2464: if (defined($in{'curr_authtype'})) {
2465: if ($in{'curr_authtype'} ne '') {
2466: $radioval = "'".$in{'curr_authtype'}."arg'";
2467: }
1.174 matthew 2468: }
1.165 raeburn 2469: my $argfield = 'null';
1.591 raeburn 2470: if (defined($in{'mode'})) {
1.165 raeburn 2471: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2472: if (defined($in{'curr_autharg'})) {
2473: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2474: $argfield = "'$in{'curr_autharg'}'";
2475: }
2476: }
2477: }
2478: }
2479:
1.32 matthew 2480: $result.=<<"END";
2481: var current = new Object();
1.165 raeburn 2482: current.radiovalue = $radioval;
2483: current.argfield = $argfield;
1.32 matthew 2484:
2485: function changed_radio(choice,currentform) {
2486: var choicearg = choice + 'arg';
2487: // If a radio button in changed, we need to change the argfield
2488: if (current.radiovalue != choice) {
2489: current.radiovalue = choice;
2490: if (current.argfield != null) {
2491: currentform.elements[current.argfield].value = '';
2492: }
2493: if (choice == 'nochange') {
2494: current.argfield = null;
2495: } else {
2496: current.argfield = choicearg;
2497: switch(choice) {
2498: case 'krb':
2499: currentform.elements[current.argfield].value =
2500: "$in{'kerb_def_dom'}";
2501: break;
2502: default:
2503: break;
2504: }
2505: }
2506: }
2507: return;
2508: }
1.22 www 2509:
1.32 matthew 2510: function changed_text(choice,currentform) {
2511: var choicearg = choice + 'arg';
2512: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2513: $Javascript_toUpperCase
1.32 matthew 2514: // clear old field
2515: if ((current.argfield != choicearg) && (current.argfield != null)) {
2516: currentform.elements[current.argfield].value = '';
2517: }
2518: current.argfield = choicearg;
2519: }
2520: set_auth_radio_buttons(choice,currentform);
2521: return;
1.20 www 2522: }
1.32 matthew 2523:
2524: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2525: var numauthchoices = currentform.login.length;
2526: if (typeof numauthchoices == "undefined") {
2527: return;
2528: }
1.32 matthew 2529: var i=0;
1.986 raeburn 2530: while (i < numauthchoices) {
1.32 matthew 2531: if (currentform.login[i].value == newvalue) { break; }
2532: i++;
2533: }
1.986 raeburn 2534: if (i == numauthchoices) {
1.32 matthew 2535: return;
2536: }
2537: current.radiovalue = newvalue;
2538: currentform.login[i].checked = true;
2539: return;
2540: }
2541: END
2542: return $result;
2543: }
2544:
1.1106 raeburn 2545: sub authform_authorwarning {
1.32 matthew 2546: my $result='';
1.144 matthew 2547: $result='<i>'.
2548: &mt('As a general rule, only authors or co-authors should be '.
2549: 'filesystem authenticated '.
2550: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2551: return $result;
2552: }
2553:
1.1106 raeburn 2554: sub authform_nochange {
1.32 matthew 2555: my %in = (
2556: formname => 'document.cu',
2557: kerb_def_dom => 'MSU.EDU',
2558: @_,
2559: );
1.1106 raeburn 2560: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2561: my $result;
1.1104 raeburn 2562: if (!$authnum) {
1.1105 raeburn 2563: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2564: } else {
2565: $result = '<label>'.&mt('[_1] Do not change login data',
2566: '<input type="radio" name="login" value="nochange" '.
2567: 'checked="checked" onclick="'.
1.281 albertel 2568: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2569: '</label>';
1.586 raeburn 2570: }
1.32 matthew 2571: return $result;
2572: }
2573:
1.591 raeburn 2574: sub authform_kerberos {
1.32 matthew 2575: my %in = (
2576: formname => 'document.cu',
2577: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2578: kerb_def_auth => 'krb4',
1.32 matthew 2579: @_,
2580: );
1.586 raeburn 2581: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2582: $autharg,$jscall);
1.1106 raeburn 2583: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2584: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2585: $check5 = ' checked="checked"';
1.80 albertel 2586: } else {
1.772 bisitz 2587: $check4 = ' checked="checked"';
1.80 albertel 2588: }
1.165 raeburn 2589: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2590: if (defined($in{'curr_authtype'})) {
2591: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2592: $krbcheck = ' checked="checked"';
1.623 raeburn 2593: if (defined($in{'mode'})) {
2594: if ($in{'mode'} eq 'modifyuser') {
2595: $krbcheck = '';
2596: }
2597: }
1.591 raeburn 2598: if (defined($in{'curr_kerb_ver'})) {
2599: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2600: $check5 = ' checked="checked"';
1.591 raeburn 2601: $check4 = '';
2602: } else {
1.772 bisitz 2603: $check4 = ' checked="checked"';
1.591 raeburn 2604: $check5 = '';
2605: }
1.586 raeburn 2606: }
1.591 raeburn 2607: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2608: $krbarg = $in{'curr_autharg'};
2609: }
1.586 raeburn 2610: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2611: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2612: $result =
2613: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2614: $in{'curr_autharg'},$krbver);
2615: } else {
2616: $result =
2617: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2618: }
2619: return $result;
2620: }
2621: }
2622: } else {
2623: if ($authnum == 1) {
1.784 bisitz 2624: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2625: }
2626: }
1.586 raeburn 2627: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2628: return;
1.587 raeburn 2629: } elsif ($authtype eq '') {
1.591 raeburn 2630: if (defined($in{'mode'})) {
1.587 raeburn 2631: if ($in{'mode'} eq 'modifycourse') {
2632: if ($authnum == 1) {
1.1104 raeburn 2633: $authtype = '<input type="radio" name="login" value="krb" />';
1.587 raeburn 2634: }
2635: }
2636: }
1.586 raeburn 2637: }
2638: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2639: if ($authtype eq '') {
2640: $authtype = '<input type="radio" name="login" value="krb" '.
2641: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2642: $krbcheck.' />';
2643: }
2644: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 2645: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2646: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 2647: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2648: $in{'curr_authtype'} eq 'krb4')) {
2649: $result .= &mt
1.144 matthew 2650: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2651: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2652: '<label>'.$authtype,
1.281 albertel 2653: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2654: 'value="'.$krbarg.'" '.
1.144 matthew 2655: 'onchange="'.$jscall.'" />',
1.281 albertel 2656: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2657: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2658: '</label>');
1.586 raeburn 2659: } elsif ($can_assign{'krb4'}) {
2660: $result .= &mt
2661: ('[_1] Kerberos authenticated with domain [_2] '.
2662: '[_3] Version 4 [_4]',
2663: '<label>'.$authtype,
2664: '</label><input type="text" size="10" name="krbarg" '.
2665: 'value="'.$krbarg.'" '.
2666: 'onchange="'.$jscall.'" />',
2667: '<label><input type="hidden" name="krbver" value="4" />',
2668: '</label>');
2669: } elsif ($can_assign{'krb5'}) {
2670: $result .= &mt
2671: ('[_1] Kerberos authenticated with domain [_2] '.
2672: '[_3] Version 5 [_4]',
2673: '<label>'.$authtype,
2674: '</label><input type="text" size="10" name="krbarg" '.
2675: 'value="'.$krbarg.'" '.
2676: 'onchange="'.$jscall.'" />',
2677: '<label><input type="hidden" name="krbver" value="5" />',
2678: '</label>');
2679: }
1.32 matthew 2680: return $result;
2681: }
2682:
1.1106 raeburn 2683: sub authform_internal {
1.586 raeburn 2684: my %in = (
1.32 matthew 2685: formname => 'document.cu',
2686: kerb_def_dom => 'MSU.EDU',
2687: @_,
2688: );
1.586 raeburn 2689: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2690: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2691: if (defined($in{'curr_authtype'})) {
2692: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2693: if ($can_assign{'int'}) {
1.772 bisitz 2694: $intcheck = 'checked="checked" ';
1.623 raeburn 2695: if (defined($in{'mode'})) {
2696: if ($in{'mode'} eq 'modifyuser') {
2697: $intcheck = '';
2698: }
2699: }
1.591 raeburn 2700: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2701: $intarg = $in{'curr_autharg'};
2702: }
2703: } else {
2704: $result = &mt('Currently internally authenticated.');
2705: return $result;
1.165 raeburn 2706: }
2707: }
1.586 raeburn 2708: } else {
2709: if ($authnum == 1) {
1.784 bisitz 2710: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2711: }
2712: }
2713: if (!$can_assign{'int'}) {
2714: return;
1.587 raeburn 2715: } elsif ($authtype eq '') {
1.591 raeburn 2716: if (defined($in{'mode'})) {
1.587 raeburn 2717: if ($in{'mode'} eq 'modifycourse') {
2718: if ($authnum == 1) {
1.1104 raeburn 2719: $authtype = '<input type="radio" name="login" value="int" />';
1.587 raeburn 2720: }
2721: }
2722: }
1.165 raeburn 2723: }
1.586 raeburn 2724: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2725: if ($authtype eq '') {
2726: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2727: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2728: }
1.605 bisitz 2729: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2730: $intarg.'" onchange="'.$jscall.'" />';
2731: $result = &mt
1.144 matthew 2732: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2733: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2734: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2735: return $result;
2736: }
2737:
1.1104 raeburn 2738: sub authform_local {
1.32 matthew 2739: my %in = (
2740: formname => 'document.cu',
2741: kerb_def_dom => 'MSU.EDU',
2742: @_,
2743: );
1.586 raeburn 2744: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2745: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2746: if (defined($in{'curr_authtype'})) {
2747: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2748: if ($can_assign{'loc'}) {
1.772 bisitz 2749: $loccheck = 'checked="checked" ';
1.623 raeburn 2750: if (defined($in{'mode'})) {
2751: if ($in{'mode'} eq 'modifyuser') {
2752: $loccheck = '';
2753: }
2754: }
1.591 raeburn 2755: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2756: $locarg = $in{'curr_autharg'};
2757: }
2758: } else {
2759: $result = &mt('Currently using local (institutional) authentication.');
2760: return $result;
1.165 raeburn 2761: }
2762: }
1.586 raeburn 2763: } else {
2764: if ($authnum == 1) {
1.784 bisitz 2765: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2766: }
2767: }
2768: if (!$can_assign{'loc'}) {
2769: return;
1.587 raeburn 2770: } elsif ($authtype eq '') {
1.591 raeburn 2771: if (defined($in{'mode'})) {
1.587 raeburn 2772: if ($in{'mode'} eq 'modifycourse') {
2773: if ($authnum == 1) {
1.1104 raeburn 2774: $authtype = '<input type="radio" name="login" value="loc" />';
1.587 raeburn 2775: }
2776: }
2777: }
1.165 raeburn 2778: }
1.586 raeburn 2779: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2780: if ($authtype eq '') {
2781: $authtype = '<input type="radio" name="login" value="loc" '.
2782: $loccheck.' onchange="'.$jscall.'" onclick="'.
2783: $jscall.'" />';
2784: }
2785: $autharg = '<input type="text" size="10" name="locarg" value="'.
2786: $locarg.'" onchange="'.$jscall.'" />';
2787: $result = &mt('[_1] Local Authentication with argument [_2]',
2788: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2789: return $result;
2790: }
2791:
1.1106 raeburn 2792: sub authform_filesystem {
1.32 matthew 2793: my %in = (
2794: formname => 'document.cu',
2795: kerb_def_dom => 'MSU.EDU',
2796: @_,
2797: );
1.586 raeburn 2798: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2799: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2800: if (defined($in{'curr_authtype'})) {
2801: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2802: if ($can_assign{'fsys'}) {
1.772 bisitz 2803: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2804: if (defined($in{'mode'})) {
2805: if ($in{'mode'} eq 'modifyuser') {
2806: $fsyscheck = '';
2807: }
2808: }
1.586 raeburn 2809: } else {
2810: $result = &mt('Currently Filesystem Authenticated.');
2811: return $result;
2812: }
2813: }
2814: } else {
2815: if ($authnum == 1) {
1.784 bisitz 2816: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2817: }
2818: }
2819: if (!$can_assign{'fsys'}) {
2820: return;
1.587 raeburn 2821: } elsif ($authtype eq '') {
1.591 raeburn 2822: if (defined($in{'mode'})) {
1.587 raeburn 2823: if ($in{'mode'} eq 'modifycourse') {
2824: if ($authnum == 1) {
1.1104 raeburn 2825: $authtype = '<input type="radio" name="login" value="fsys" />';
1.587 raeburn 2826: }
2827: }
2828: }
1.586 raeburn 2829: }
2830: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2831: if ($authtype eq '') {
2832: $authtype = '<input type="radio" name="login" value="fsys" '.
2833: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2834: $jscall.'" />';
2835: }
2836: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2837: ' onchange="'.$jscall.'" />';
2838: $result = &mt
1.144 matthew 2839: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2840: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2841: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2842: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2843: 'onchange="'.$jscall.'" />');
1.32 matthew 2844: return $result;
2845: }
2846:
1.586 raeburn 2847: sub get_assignable_auth {
2848: my ($dom) = @_;
2849: if ($dom eq '') {
2850: $dom = $env{'request.role.domain'};
2851: }
2852: my %can_assign = (
2853: krb4 => 1,
2854: krb5 => 1,
2855: int => 1,
2856: loc => 1,
2857: );
2858: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2859: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2860: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2861: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2862: my $context;
2863: if ($env{'request.role'} =~ /^au/) {
2864: $context = 'author';
2865: } elsif ($env{'request.role'} =~ /^dc/) {
2866: $context = 'domain';
2867: } elsif ($env{'request.course.id'}) {
2868: $context = 'course';
2869: }
2870: if ($context) {
2871: if (ref($authhash->{$context}) eq 'HASH') {
2872: %can_assign = %{$authhash->{$context}};
2873: }
2874: }
2875: }
2876: }
2877: my $authnum = 0;
2878: foreach my $key (keys(%can_assign)) {
2879: if ($can_assign{$key}) {
2880: $authnum ++;
2881: }
2882: }
2883: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2884: $authnum --;
2885: }
2886: return ($authnum,%can_assign);
2887: }
2888:
1.80 albertel 2889: ###############################################################
2890: ## Get Kerberos Defaults for Domain ##
2891: ###############################################################
2892: ##
2893: ## Returns default kerberos version and an associated argument
2894: ## as listed in file domain.tab. If not listed, provides
2895: ## appropriate default domain and kerberos version.
2896: ##
2897: #-------------------------------------------
2898:
2899: =pod
2900:
1.648 raeburn 2901: =item * &get_kerberos_defaults()
1.80 albertel 2902:
2903: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2904: version and domain. If not found, it defaults to version 4 and the
2905: domain of the server.
1.80 albertel 2906:
1.648 raeburn 2907: =over 4
2908:
1.80 albertel 2909: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2910:
1.648 raeburn 2911: =back
2912:
2913: =back
2914:
1.80 albertel 2915: =cut
2916:
2917: #-------------------------------------------
2918: sub get_kerberos_defaults {
2919: my $domain=shift;
1.641 raeburn 2920: my ($krbdef,$krbdefdom);
2921: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2922: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2923: $krbdef = $domdefaults{'auth_def'};
2924: $krbdefdom = $domdefaults{'auth_arg_def'};
2925: } else {
1.80 albertel 2926: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2927: my $krbdefdom=$1;
2928: $krbdefdom=~tr/a-z/A-Z/;
2929: $krbdef = "krb4";
2930: }
2931: return ($krbdef,$krbdefdom);
2932: }
1.112 bowersj2 2933:
1.32 matthew 2934:
1.46 matthew 2935: ###############################################################
2936: ## Thesaurus Functions ##
2937: ###############################################################
1.20 www 2938:
1.46 matthew 2939: =pod
1.20 www 2940:
1.112 bowersj2 2941: =head1 Thesaurus Functions
2942:
2943: =over 4
2944:
1.648 raeburn 2945: =item * &initialize_keywords()
1.46 matthew 2946:
2947: Initializes the package variable %Keywords if it is empty. Uses the
2948: package variable $thesaurus_db_file.
2949:
2950: =cut
2951:
2952: ###################################################
2953:
2954: sub initialize_keywords {
2955: return 1 if (scalar keys(%Keywords));
2956: # If we are here, %Keywords is empty, so fill it up
2957: # Make sure the file we need exists...
2958: if (! -e $thesaurus_db_file) {
2959: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2960: " failed because it does not exist");
2961: return 0;
2962: }
2963: # Set up the hash as a database
2964: my %thesaurus_db;
2965: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2966: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2967: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2968: $thesaurus_db_file);
2969: return 0;
2970: }
2971: # Get the average number of appearances of a word.
2972: my $avecount = $thesaurus_db{'average.count'};
2973: # Put keywords (those that appear > average) into %Keywords
2974: while (my ($word,$data)=each (%thesaurus_db)) {
2975: my ($count,undef) = split /:/,$data;
2976: $Keywords{$word}++ if ($count > $avecount);
2977: }
2978: untie %thesaurus_db;
2979: # Remove special values from %Keywords.
1.356 albertel 2980: foreach my $value ('total.count','average.count') {
2981: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2982: }
1.46 matthew 2983: return 1;
2984: }
2985:
2986: ###################################################
2987:
2988: =pod
2989:
1.648 raeburn 2990: =item * &keyword($word)
1.46 matthew 2991:
2992: Returns true if $word is a keyword. A keyword is a word that appears more
2993: than the average number of times in the thesaurus database. Calls
2994: &initialize_keywords
2995:
2996: =cut
2997:
2998: ###################################################
1.20 www 2999:
3000: sub keyword {
1.46 matthew 3001: return if (!&initialize_keywords());
3002: my $word=lc(shift());
3003: $word=~s/\W//g;
3004: return exists($Keywords{$word});
1.20 www 3005: }
1.46 matthew 3006:
3007: ###############################################################
3008:
3009: =pod
1.20 www 3010:
1.648 raeburn 3011: =item * &get_related_words()
1.46 matthew 3012:
1.160 matthew 3013: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3014: an array of words. If the keyword is not in the thesaurus, an empty array
3015: will be returned. The order of the words returned is determined by the
3016: database which holds them.
3017:
3018: Uses global $thesaurus_db_file.
3019:
1.1057 foxr 3020:
1.46 matthew 3021: =cut
3022:
3023: ###############################################################
3024: sub get_related_words {
3025: my $keyword = shift;
3026: my %thesaurus_db;
3027: if (! -e $thesaurus_db_file) {
3028: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3029: "failed because the file does not exist");
3030: return ();
3031: }
3032: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3033: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3034: return ();
3035: }
3036: my @Words=();
1.429 www 3037: my $count=0;
1.46 matthew 3038: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3039: # The first element is the number of times
3040: # the word appears. We do not need it now.
1.429 www 3041: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3042: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3043: my $threshold=$mostfrequentcount/10;
3044: foreach my $possibleword (@RelatedWords) {
3045: my ($word,$wordcount)=split(/\,/,$possibleword);
3046: if ($wordcount>$threshold) {
3047: push(@Words,$word);
3048: $count++;
3049: if ($count>10) { last; }
3050: }
1.20 www 3051: }
3052: }
1.46 matthew 3053: untie %thesaurus_db;
3054: return @Words;
1.14 harris41 3055: }
1.1090 foxr 3056: ###############################################################
3057: #
3058: # Spell checking
3059: #
3060:
3061: =pod
3062:
3063: =head1 Spell checking
3064:
3065: =over 4
3066:
3067: =item * &check_spelling($wordlist $language)
3068:
3069: Takes a string containing words and feeds it to an external
3070: spellcheck program via a pipeline. Returns a string containing
3071: them mis-spelled words.
3072:
3073: Parameters:
3074:
3075: =over 4
3076:
3077: =item - $wordlist
3078:
3079: String that will be fed into the spellcheck program.
3080:
3081: =item - $language
3082:
3083: Language string that specifies the language for which the spell
3084: check will be performed.
3085:
3086: =back
3087:
3088: =back
3089:
3090: Note: This sub assumes that aspell is installed.
3091:
3092:
3093: =cut
3094:
1.46 matthew 3095:
1.112 bowersj2 3096: =pod
3097:
3098: =back
3099:
3100: =cut
1.61 www 3101:
1.1090 foxr 3102: sub check_spelling {
3103: my ($wordlist, $language) = @_;
1.1091 foxr 3104: my @misspellings;
3105:
3106: # Generate the speller and set the langauge.
3107: # if explicitly selected:
1.1090 foxr 3108:
1.1091 foxr 3109: my $speller = Text::Aspell->new;
1.1090 foxr 3110: if ($language) {
1.1091 foxr 3111: $speller->set_option('lang', $language);
1.1090 foxr 3112: }
3113:
1.1091 foxr 3114: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3115:
1.1091 foxr 3116: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3117:
1.1091 foxr 3118: foreach my $word (@words) {
3119: if(! $speller->check($word)) {
3120: push(@misspellings, $word);
1.1090 foxr 3121: }
3122: }
1.1091 foxr 3123: return join(' ', @misspellings);
3124:
1.1090 foxr 3125: }
3126:
1.61 www 3127: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3128: =pod
3129:
1.112 bowersj2 3130: =head1 User Name Functions
3131:
3132: =over 4
3133:
1.648 raeburn 3134: =item * &plainname($uname,$udom,$first)
1.81 albertel 3135:
1.112 bowersj2 3136: Takes a users logon name and returns it as a string in
1.226 albertel 3137: "first middle last generation" form
3138: if $first is set to 'lastname' then it returns it as
3139: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3140:
3141: =cut
1.61 www 3142:
1.295 www 3143:
1.81 albertel 3144: ###############################################################
1.61 www 3145: sub plainname {
1.226 albertel 3146: my ($uname,$udom,$first)=@_;
1.537 albertel 3147: return if (!defined($uname) || !defined($udom));
1.295 www 3148: my %names=&getnames($uname,$udom);
1.226 albertel 3149: my $name=&Apache::lonnet::format_name($names{'firstname'},
3150: $names{'middlename'},
3151: $names{'lastname'},
3152: $names{'generation'},$first);
3153: $name=~s/^\s+//;
1.62 www 3154: $name=~s/\s+$//;
3155: $name=~s/\s+/ /g;
1.353 albertel 3156: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3157: return $name;
1.61 www 3158: }
1.66 www 3159:
3160: # -------------------------------------------------------------------- Nickname
1.81 albertel 3161: =pod
3162:
1.648 raeburn 3163: =item * &nickname($uname,$udom)
1.81 albertel 3164:
3165: Gets a users name and returns it as a string as
3166:
3167: ""nickname""
1.66 www 3168:
1.81 albertel 3169: if the user has a nickname or
3170:
3171: "first middle last generation"
3172:
3173: if the user does not
3174:
3175: =cut
1.66 www 3176:
3177: sub nickname {
3178: my ($uname,$udom)=@_;
1.537 albertel 3179: return if (!defined($uname) || !defined($udom));
1.295 www 3180: my %names=&getnames($uname,$udom);
1.68 albertel 3181: my $name=$names{'nickname'};
1.66 www 3182: if ($name) {
3183: $name='"'.$name.'"';
3184: } else {
3185: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3186: $names{'lastname'}.' '.$names{'generation'};
3187: $name=~s/\s+$//;
3188: $name=~s/\s+/ /g;
3189: }
3190: return $name;
3191: }
3192:
1.295 www 3193: sub getnames {
3194: my ($uname,$udom)=@_;
1.537 albertel 3195: return if (!defined($uname) || !defined($udom));
1.433 albertel 3196: if ($udom eq 'public' && $uname eq 'public') {
3197: return ('lastname' => &mt('Public'));
3198: }
1.295 www 3199: my $id=$uname.':'.$udom;
3200: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3201: if ($cached) {
3202: return %{$names};
3203: } else {
3204: my %loadnames=&Apache::lonnet::get('environment',
3205: ['firstname','middlename','lastname','generation','nickname'],
3206: $udom,$uname);
3207: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3208: return %loadnames;
3209: }
3210: }
1.61 www 3211:
1.542 raeburn 3212: # -------------------------------------------------------------------- getemails
1.648 raeburn 3213:
1.542 raeburn 3214: =pod
3215:
1.648 raeburn 3216: =item * &getemails($uname,$udom)
1.542 raeburn 3217:
3218: Gets a user's email information and returns it as a hash with keys:
3219: notification, critnotification, permanentemail
3220:
3221: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3222: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3223:
1.648 raeburn 3224:
1.542 raeburn 3225: =cut
3226:
1.648 raeburn 3227:
1.466 albertel 3228: sub getemails {
3229: my ($uname,$udom)=@_;
3230: if ($udom eq 'public' && $uname eq 'public') {
3231: return;
3232: }
1.467 www 3233: if (!$udom) { $udom=$env{'user.domain'}; }
3234: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3235: my $id=$uname.':'.$udom;
3236: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3237: if ($cached) {
3238: return %{$names};
3239: } else {
3240: my %loadnames=&Apache::lonnet::get('environment',
3241: ['notification','critnotification',
3242: 'permanentemail'],
3243: $udom,$uname);
3244: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3245: return %loadnames;
3246: }
3247: }
3248:
1.551 albertel 3249: sub flush_email_cache {
3250: my ($uname,$udom)=@_;
3251: if (!$udom) { $udom =$env{'user.domain'}; }
3252: if (!$uname) { $uname=$env{'user.name'}; }
3253: return if ($udom eq 'public' && $uname eq 'public');
3254: my $id=$uname.':'.$udom;
3255: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3256: }
3257:
1.728 raeburn 3258: # -------------------------------------------------------------------- getlangs
3259:
3260: =pod
3261:
3262: =item * &getlangs($uname,$udom)
3263:
3264: Gets a user's language preference and returns it as a hash with key:
3265: language.
3266:
3267: =cut
3268:
3269:
3270: sub getlangs {
3271: my ($uname,$udom) = @_;
3272: if (!$udom) { $udom =$env{'user.domain'}; }
3273: if (!$uname) { $uname=$env{'user.name'}; }
3274: my $id=$uname.':'.$udom;
3275: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3276: if ($cached) {
3277: return %{$langs};
3278: } else {
3279: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3280: $udom,$uname);
3281: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3282: return %loadlangs;
3283: }
3284: }
3285:
3286: sub flush_langs_cache {
3287: my ($uname,$udom)=@_;
3288: if (!$udom) { $udom =$env{'user.domain'}; }
3289: if (!$uname) { $uname=$env{'user.name'}; }
3290: return if ($udom eq 'public' && $uname eq 'public');
3291: my $id=$uname.':'.$udom;
3292: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3293: }
3294:
1.61 www 3295: # ------------------------------------------------------------------ Screenname
1.81 albertel 3296:
3297: =pod
3298:
1.648 raeburn 3299: =item * &screenname($uname,$udom)
1.81 albertel 3300:
3301: Gets a users screenname and returns it as a string
3302:
3303: =cut
1.61 www 3304:
3305: sub screenname {
3306: my ($uname,$udom)=@_;
1.258 albertel 3307: if ($uname eq $env{'user.name'} &&
3308: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3309: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3310: return $names{'screenname'};
1.62 www 3311: }
3312:
1.212 albertel 3313:
1.802 bisitz 3314: # ------------------------------------------------------------- Confirm Wrapper
3315: =pod
3316:
3317: =item confirmwrapper
3318:
3319: Wrap messages about completion of operation in box
3320:
3321: =cut
3322:
3323: sub confirmwrapper {
3324: my ($message)=@_;
3325: if ($message) {
3326: return "\n".'<div class="LC_confirm_box">'."\n"
3327: .$message."\n"
3328: .'</div>'."\n";
3329: } else {
3330: return $message;
3331: }
3332: }
3333:
1.62 www 3334: # ------------------------------------------------------------- Message Wrapper
3335:
3336: sub messagewrapper {
1.369 www 3337: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3338: return
1.441 albertel 3339: '<a href="/adm/email?compose=individual&'.
3340: 'recname='.$username.'&recdom='.$domain.
3341: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3342: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3343: }
1.802 bisitz 3344:
1.74 www 3345: # --------------------------------------------------------------- Notes Wrapper
3346:
3347: sub noteswrapper {
3348: my ($link,$un,$do)=@_;
3349: return
1.896 amueller 3350: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3351: }
1.802 bisitz 3352:
1.62 www 3353: # ------------------------------------------------------------- Aboutme Wrapper
3354:
3355: sub aboutmewrapper {
1.1070 raeburn 3356: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3357: if (!defined($username) && !defined($domain)) {
3358: return;
3359: }
1.1096 raeburn 3360: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3361: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3362: }
3363:
3364: # ------------------------------------------------------------ Syllabus Wrapper
3365:
3366: sub syllabuswrapper {
1.707 bisitz 3367: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3368: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3369: }
1.14 harris41 3370:
1.802 bisitz 3371: # -----------------------------------------------------------------------------
3372:
1.208 matthew 3373: sub track_student_link {
1.887 raeburn 3374: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3375: my $link ="/adm/trackstudent?";
1.208 matthew 3376: my $title = 'View recent activity';
3377: if (defined($sname) && $sname !~ /^\s*$/ &&
3378: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3379: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3380: $title .= ' of this student';
1.268 albertel 3381: }
1.208 matthew 3382: if (defined($target) && $target !~ /^\s*$/) {
3383: $target = qq{target="$target"};
3384: } else {
3385: $target = '';
3386: }
1.268 albertel 3387: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3388: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3389: $title = &mt($title);
3390: $linktext = &mt($linktext);
1.448 albertel 3391: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3392: &help_open_topic('View_recent_activity');
1.208 matthew 3393: }
3394:
1.781 raeburn 3395: sub slot_reservations_link {
3396: my ($linktext,$sname,$sdom,$target) = @_;
3397: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3398: my $title = 'View slot reservation history';
3399: if (defined($sname) && $sname !~ /^\s*$/ &&
3400: defined($sdom) && $sdom !~ /^\s*$/) {
3401: $link .= "&uname=$sname&udom=$sdom";
3402: $title .= ' of this student';
3403: }
3404: if (defined($target) && $target !~ /^\s*$/) {
3405: $target = qq{target="$target"};
3406: } else {
3407: $target = '';
3408: }
3409: $title = &mt($title);
3410: $linktext = &mt($linktext);
3411: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3412: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3413:
3414: }
3415:
1.508 www 3416: # ===================================================== Display a student photo
3417:
3418:
1.509 albertel 3419: sub student_image_tag {
1.508 www 3420: my ($domain,$user)=@_;
3421: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3422: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3423: return '<img src="'.$imgsrc.'" align="right" />';
3424: } else {
3425: return '';
3426: }
3427: }
3428:
1.112 bowersj2 3429: =pod
3430:
3431: =back
3432:
3433: =head1 Access .tab File Data
3434:
3435: =over 4
3436:
1.648 raeburn 3437: =item * &languageids()
1.112 bowersj2 3438:
3439: returns list of all language ids
3440:
3441: =cut
3442:
1.14 harris41 3443: sub languageids {
1.16 harris41 3444: return sort(keys(%language));
1.14 harris41 3445: }
3446:
1.112 bowersj2 3447: =pod
3448:
1.648 raeburn 3449: =item * &languagedescription()
1.112 bowersj2 3450:
3451: returns description of a specified language id
3452:
3453: =cut
3454:
1.14 harris41 3455: sub languagedescription {
1.125 www 3456: my $code=shift;
3457: return ($supported_language{$code}?'* ':'').
3458: $language{$code}.
1.126 www 3459: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3460: }
3461:
1.1048 foxr 3462: =pod
3463:
3464: =item * &plainlanguagedescription
3465:
3466: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3467: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3468:
3469: =cut
3470:
1.145 www 3471: sub plainlanguagedescription {
3472: my $code=shift;
3473: return $language{$code};
3474: }
3475:
1.1048 foxr 3476: =pod
3477:
3478: =item * &supportedlanguagecode
3479:
3480: Returns the supported language code (e.g. sptutf maps to pt) given a language
3481: code.
3482:
3483: =cut
3484:
1.145 www 3485: sub supportedlanguagecode {
3486: my $code=shift;
3487: return $supported_language{$code};
1.97 www 3488: }
3489:
1.112 bowersj2 3490: =pod
3491:
1.1048 foxr 3492: =item * &latexlanguage()
3493:
3494: Given a language key code returns the correspondnig language to use
3495: to select the correct hyphenation on LaTeX printouts. This is undef if there
3496: is no supported hyphenation for the language code.
3497:
3498: =cut
3499:
3500: sub latexlanguage {
3501: my $code = shift;
3502: return $latex_language{$code};
3503: }
3504:
3505: =pod
3506:
3507: =item * &latexhyphenation()
3508:
3509: Same as above but what's supplied is the language as it might be stored
3510: in the metadata.
3511:
3512: =cut
3513:
3514: sub latexhyphenation {
3515: my $key = shift;
3516: return $latex_language_bykey{$key};
3517: }
3518:
3519: =pod
3520:
1.648 raeburn 3521: =item * ©rightids()
1.112 bowersj2 3522:
3523: returns list of all copyrights
3524:
3525: =cut
3526:
3527: sub copyrightids {
3528: return sort(keys(%cprtag));
3529: }
3530:
3531: =pod
3532:
1.648 raeburn 3533: =item * ©rightdescription()
1.112 bowersj2 3534:
3535: returns description of a specified copyright id
3536:
3537: =cut
3538:
3539: sub copyrightdescription {
1.166 www 3540: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3541: }
1.197 matthew 3542:
3543: =pod
3544:
1.648 raeburn 3545: =item * &source_copyrightids()
1.192 taceyjo1 3546:
3547: returns list of all source copyrights
3548:
3549: =cut
3550:
3551: sub source_copyrightids {
3552: return sort(keys(%scprtag));
3553: }
3554:
3555: =pod
3556:
1.648 raeburn 3557: =item * &source_copyrightdescription()
1.192 taceyjo1 3558:
3559: returns description of a specified source copyright id
3560:
3561: =cut
3562:
3563: sub source_copyrightdescription {
3564: return &mt($scprtag{shift(@_)});
3565: }
1.112 bowersj2 3566:
3567: =pod
3568:
1.648 raeburn 3569: =item * &filecategories()
1.112 bowersj2 3570:
3571: returns list of all file categories
3572:
3573: =cut
3574:
3575: sub filecategories {
3576: return sort(keys(%category_extensions));
3577: }
3578:
3579: =pod
3580:
1.648 raeburn 3581: =item * &filecategorytypes()
1.112 bowersj2 3582:
3583: returns list of file types belonging to a given file
3584: category
3585:
3586: =cut
3587:
3588: sub filecategorytypes {
1.356 albertel 3589: my ($cat) = @_;
3590: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3591: }
3592:
3593: =pod
3594:
1.648 raeburn 3595: =item * &fileembstyle()
1.112 bowersj2 3596:
3597: returns embedding style for a specified file type
3598:
3599: =cut
3600:
3601: sub fileembstyle {
3602: return $fe{lc(shift(@_))};
1.169 www 3603: }
3604:
1.351 www 3605: sub filemimetype {
3606: return $fm{lc(shift(@_))};
3607: }
3608:
1.169 www 3609:
3610: sub filecategoryselect {
3611: my ($name,$value)=@_;
1.189 matthew 3612: return &select_form($value,$name,
1.970 raeburn 3613: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3614: }
3615:
3616: =pod
3617:
1.648 raeburn 3618: =item * &filedescription()
1.112 bowersj2 3619:
3620: returns description for a specified file type
3621:
3622: =cut
3623:
3624: sub filedescription {
1.188 matthew 3625: my $file_description = $fd{lc(shift())};
3626: $file_description =~ s:([\[\]]):~$1:g;
3627: return &mt($file_description);
1.112 bowersj2 3628: }
3629:
3630: =pod
3631:
1.648 raeburn 3632: =item * &filedescriptionex()
1.112 bowersj2 3633:
3634: returns description for a specified file type with
3635: extra formatting
3636:
3637: =cut
3638:
3639: sub filedescriptionex {
3640: my $ex=shift;
1.188 matthew 3641: my $file_description = $fd{lc($ex)};
3642: $file_description =~ s:([\[\]]):~$1:g;
3643: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3644: }
3645:
3646: # End of .tab access
3647: =pod
3648:
3649: =back
3650:
3651: =cut
3652:
3653: # ------------------------------------------------------------------ File Types
3654: sub fileextensions {
3655: return sort(keys(%fe));
3656: }
3657:
1.97 www 3658: # ----------------------------------------------------------- Display Languages
3659: # returns a hash with all desired display languages
3660: #
3661:
3662: sub display_languages {
3663: my %languages=();
1.695 raeburn 3664: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3665: $languages{$lang}=1;
1.97 www 3666: }
3667: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3668: if ($env{'form.displaylanguage'}) {
1.356 albertel 3669: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3670: $languages{$lang}=1;
1.97 www 3671: }
3672: }
3673: return %languages;
1.14 harris41 3674: }
3675:
1.582 albertel 3676: sub languages {
3677: my ($possible_langs) = @_;
1.695 raeburn 3678: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3679: if (!ref($possible_langs)) {
3680: if( wantarray ) {
3681: return @preferred_langs;
3682: } else {
3683: return $preferred_langs[0];
3684: }
3685: }
3686: my %possibilities = map { $_ => 1 } (@$possible_langs);
3687: my @preferred_possibilities;
3688: foreach my $preferred_lang (@preferred_langs) {
3689: if (exists($possibilities{$preferred_lang})) {
3690: push(@preferred_possibilities, $preferred_lang);
3691: }
3692: }
3693: if( wantarray ) {
3694: return @preferred_possibilities;
3695: }
3696: return $preferred_possibilities[0];
3697: }
3698:
1.742 raeburn 3699: sub user_lang {
3700: my ($touname,$toudom,$fromcid) = @_;
3701: my @userlangs;
3702: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3703: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3704: $env{'course.'.$fromcid.'.languages'}));
3705: } else {
3706: my %langhash = &getlangs($touname,$toudom);
3707: if ($langhash{'languages'} ne '') {
3708: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3709: } else {
3710: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3711: if ($domdefs{'lang_def'} ne '') {
3712: @userlangs = ($domdefs{'lang_def'});
3713: }
3714: }
3715: }
3716: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3717: my $user_lh = Apache::localize->get_handle(@languages);
3718: return $user_lh;
3719: }
3720:
3721:
1.112 bowersj2 3722: ###############################################################
3723: ## Student Answer Attempts ##
3724: ###############################################################
3725:
3726: =pod
3727:
3728: =head1 Alternate Problem Views
3729:
3730: =over 4
3731:
1.648 raeburn 3732: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3733: $getattempt, $regexp, $gradesub)
3734:
3735: Return string with previous attempt on problem. Arguments:
3736:
3737: =over 4
3738:
3739: =item * $symb: Problem, including path
3740:
3741: =item * $username: username of the desired student
3742:
3743: =item * $domain: domain of the desired student
1.14 harris41 3744:
1.112 bowersj2 3745: =item * $course: Course ID
1.14 harris41 3746:
1.112 bowersj2 3747: =item * $getattempt: Leave blank for all attempts, otherwise put
3748: something
1.14 harris41 3749:
1.112 bowersj2 3750: =item * $regexp: if string matches this regexp, the string will be
3751: sent to $gradesub
1.14 harris41 3752:
1.112 bowersj2 3753: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3754:
1.112 bowersj2 3755: =back
1.14 harris41 3756:
1.112 bowersj2 3757: The output string is a table containing all desired attempts, if any.
1.16 harris41 3758:
1.112 bowersj2 3759: =cut
1.1 albertel 3760:
3761: sub get_previous_attempt {
1.43 ng 3762: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3763: my $prevattempts='';
1.43 ng 3764: no strict 'refs';
1.1 albertel 3765: if ($symb) {
1.3 albertel 3766: my (%returnhash)=
3767: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3768: if ($returnhash{'version'}) {
3769: my %lasthash=();
3770: my $version;
3771: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3772: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3773: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3774: }
1.1 albertel 3775: }
1.596 albertel 3776: $prevattempts=&start_data_table().&start_data_table_header_row();
3777: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3778: my (%typeparts,%lasthidden);
1.945 raeburn 3779: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3780: foreach my $key (sort(keys(%lasthash))) {
3781: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3782: if ($#parts > 0) {
1.31 albertel 3783: my $data=$parts[-1];
1.989 raeburn 3784: next if ($data eq 'foilorder');
1.31 albertel 3785: pop(@parts);
1.1010 www 3786: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3787: if ($data eq 'type') {
3788: unless ($showsurv) {
3789: my $id = join(',',@parts);
3790: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3791: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3792: $lasthidden{$ign.'.'.$id} = 1;
3793: }
1.945 raeburn 3794: }
1.1010 www 3795: }
1.31 albertel 3796: } else {
1.41 ng 3797: if ($#parts == 0) {
3798: $prevattempts.='<th>'.$parts[0].'</th>';
3799: } else {
3800: $prevattempts.='<th>'.$ign.'</th>';
3801: }
1.31 albertel 3802: }
1.16 harris41 3803: }
1.596 albertel 3804: $prevattempts.=&end_data_table_header_row();
1.40 ng 3805: if ($getattempt eq '') {
3806: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3807: my @hidden;
3808: if (%typeparts) {
3809: foreach my $id (keys(%typeparts)) {
3810: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3811: push(@hidden,$id);
3812: }
3813: }
3814: }
3815: $prevattempts.=&start_data_table_row().
3816: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3817: if (@hidden) {
3818: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3819: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3820: my $hide;
3821: foreach my $id (@hidden) {
3822: if ($key =~ /^\Q$id\E/) {
3823: $hide = 1;
3824: last;
3825: }
3826: }
3827: if ($hide) {
3828: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3829: if (($data eq 'award') || ($data eq 'awarddetail')) {
3830: my $value = &format_previous_attempt_value($key,
3831: $returnhash{$version.':'.$key});
3832: $prevattempts.='<td>'.$value.' </td>';
3833: } else {
3834: $prevattempts.='<td> </td>';
3835: }
3836: } else {
3837: if ($key =~ /\./) {
3838: my $value = &format_previous_attempt_value($key,
3839: $returnhash{$version.':'.$key});
3840: $prevattempts.='<td>'.$value.' </td>';
3841: } else {
3842: $prevattempts.='<td> </td>';
3843: }
3844: }
3845: }
3846: } else {
3847: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3848: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3849: my $value = &format_previous_attempt_value($key,
3850: $returnhash{$version.':'.$key});
3851: $prevattempts.='<td>'.$value.' </td>';
3852: }
3853: }
3854: $prevattempts.=&end_data_table_row();
1.40 ng 3855: }
1.1 albertel 3856: }
1.945 raeburn 3857: my @currhidden = keys(%lasthidden);
1.596 albertel 3858: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3859: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3860: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3861: if (%typeparts) {
3862: my $hidden;
3863: foreach my $id (@currhidden) {
3864: if ($key =~ /^\Q$id\E/) {
3865: $hidden = 1;
3866: last;
3867: }
3868: }
3869: if ($hidden) {
3870: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3871: if (($data eq 'award') || ($data eq 'awarddetail')) {
3872: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3873: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3874: $value = &$gradesub($value);
3875: }
3876: $prevattempts.='<td>'.$value.' </td>';
3877: } else {
3878: $prevattempts.='<td> </td>';
3879: }
3880: } else {
3881: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3882: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3883: $value = &$gradesub($value);
3884: }
3885: $prevattempts.='<td>'.$value.' </td>';
3886: }
3887: } else {
3888: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3889: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3890: $value = &$gradesub($value);
3891: }
3892: $prevattempts.='<td>'.$value.' </td>';
3893: }
1.16 harris41 3894: }
1.596 albertel 3895: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3896: } else {
1.596 albertel 3897: $prevattempts=
3898: &start_data_table().&start_data_table_row().
3899: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3900: &end_data_table_row().&end_data_table();
1.1 albertel 3901: }
3902: } else {
1.596 albertel 3903: $prevattempts=
3904: &start_data_table().&start_data_table_row().
3905: '<td>'.&mt('No data.').'</td>'.
3906: &end_data_table_row().&end_data_table();
1.1 albertel 3907: }
1.10 albertel 3908: }
3909:
1.581 albertel 3910: sub format_previous_attempt_value {
3911: my ($key,$value) = @_;
1.1011 www 3912: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3913: $value = &Apache::lonlocal::locallocaltime($value);
3914: } elsif (ref($value) eq 'ARRAY') {
3915: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3916: } elsif ($key =~ /answerstring$/) {
3917: my %answers = &Apache::lonnet::str2hash($value);
3918: my @anskeys = sort(keys(%answers));
3919: if (@anskeys == 1) {
3920: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3921: if ($answer =~ m{\0}) {
3922: $answer =~ s{\0}{,}g;
1.988 raeburn 3923: }
3924: my $tag_internal_answer_name = 'INTERNAL';
3925: if ($anskeys[0] eq $tag_internal_answer_name) {
3926: $value = $answer;
3927: } else {
3928: $value = $anskeys[0].'='.$answer;
3929: }
3930: } else {
3931: foreach my $ans (@anskeys) {
3932: my $answer = $answers{$ans};
1.1001 raeburn 3933: if ($answer =~ m{\0}) {
3934: $answer =~ s{\0}{,}g;
1.988 raeburn 3935: }
3936: $value .= $ans.'='.$answer.'<br />';;
3937: }
3938: }
1.581 albertel 3939: } else {
3940: $value = &unescape($value);
3941: }
3942: return $value;
3943: }
3944:
3945:
1.107 albertel 3946: sub relative_to_absolute {
3947: my ($url,$output)=@_;
3948: my $parser=HTML::TokeParser->new(\$output);
3949: my $token;
3950: my $thisdir=$url;
3951: my @rlinks=();
3952: while ($token=$parser->get_token) {
3953: if ($token->[0] eq 'S') {
3954: if ($token->[1] eq 'a') {
3955: if ($token->[2]->{'href'}) {
3956: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3957: }
3958: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3959: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3960: } elsif ($token->[1] eq 'base') {
3961: $thisdir=$token->[2]->{'href'};
3962: }
3963: }
3964: }
3965: $thisdir=~s-/[^/]*$--;
1.356 albertel 3966: foreach my $link (@rlinks) {
1.726 raeburn 3967: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3968: ($link=~/^\//) ||
3969: ($link=~/^javascript:/i) ||
3970: ($link=~/^mailto:/i) ||
3971: ($link=~/^\#/)) {
3972: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3973: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3974: }
3975: }
3976: # -------------------------------------------------- Deal with Applet codebases
3977: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3978: return $output;
3979: }
3980:
1.112 bowersj2 3981: =pod
3982:
1.648 raeburn 3983: =item * &get_student_view()
1.112 bowersj2 3984:
3985: show a snapshot of what student was looking at
3986:
3987: =cut
3988:
1.10 albertel 3989: sub get_student_view {
1.186 albertel 3990: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3991: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3992: my (%form);
1.10 albertel 3993: my @elements=('symb','courseid','domain','username');
3994: foreach my $element (@elements) {
1.186 albertel 3995: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3996: }
1.186 albertel 3997: if (defined($moreenv)) {
3998: %form=(%form,%{$moreenv});
3999: }
1.236 albertel 4000: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4001: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4002: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4003: $userview=~s/\<body[^\>]*\>//gi;
4004: $userview=~s/\<\/body\>//gi;
4005: $userview=~s/\<html\>//gi;
4006: $userview=~s/\<\/html\>//gi;
4007: $userview=~s/\<head\>//gi;
4008: $userview=~s/\<\/head\>//gi;
4009: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4010: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4011: if (wantarray) {
4012: return ($userview,$response);
4013: } else {
4014: return $userview;
4015: }
4016: }
4017:
4018: sub get_student_view_with_retries {
4019: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4020:
4021: my $ok = 0; # True if we got a good response.
4022: my $content;
4023: my $response;
4024:
4025: # Try to get the student_view done. within the retries count:
4026:
4027: do {
4028: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4029: $ok = $response->is_success;
4030: if (!$ok) {
4031: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4032: }
4033: $retries--;
4034: } while (!$ok && ($retries > 0));
4035:
4036: if (!$ok) {
4037: $content = ''; # On error return an empty content.
4038: }
1.651 www 4039: if (wantarray) {
4040: return ($content, $response);
4041: } else {
4042: return $content;
4043: }
1.11 albertel 4044: }
4045:
1.112 bowersj2 4046: =pod
4047:
1.648 raeburn 4048: =item * &get_student_answers()
1.112 bowersj2 4049:
4050: show a snapshot of how student was answering problem
4051:
4052: =cut
4053:
1.11 albertel 4054: sub get_student_answers {
1.100 sakharuk 4055: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4056: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4057: my (%moreenv);
1.11 albertel 4058: my @elements=('symb','courseid','domain','username');
4059: foreach my $element (@elements) {
1.186 albertel 4060: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4061: }
1.186 albertel 4062: $moreenv{'grade_target'}='answer';
4063: %moreenv=(%form,%moreenv);
1.497 raeburn 4064: $feedurl = &Apache::lonnet::clutter($feedurl);
4065: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4066: return $userview;
1.1 albertel 4067: }
1.116 albertel 4068:
4069: =pod
4070:
4071: =item * &submlink()
4072:
1.242 albertel 4073: Inputs: $text $uname $udom $symb $target
1.116 albertel 4074:
4075: Returns: A link to grades.pm such as to see the SUBM view of a student
4076:
4077: =cut
4078:
4079: ###############################################
4080: sub submlink {
1.242 albertel 4081: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4082: if (!($uname && $udom)) {
4083: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4084: &Apache::lonnet::whichuser($symb);
1.116 albertel 4085: if (!$symb) { $symb=$cursymb; }
4086: }
1.254 matthew 4087: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4088: $symb=&escape($symb);
1.960 bisitz 4089: if ($target) { $target=" target=\"$target\""; }
4090: return
4091: '<a href="/adm/grades?command=submission'.
4092: '&symb='.$symb.
4093: '&student='.$uname.
4094: '&userdom='.$udom.'"'.
4095: $target.'>'.$text.'</a>';
1.242 albertel 4096: }
4097: ##############################################
4098:
4099: =pod
4100:
4101: =item * &pgrdlink()
4102:
4103: Inputs: $text $uname $udom $symb $target
4104:
4105: Returns: A link to grades.pm such as to see the PGRD view of a student
4106:
4107: =cut
4108:
4109: ###############################################
4110: sub pgrdlink {
4111: my $link=&submlink(@_);
4112: $link=~s/(&command=submission)/$1&showgrading=yes/;
4113: return $link;
4114: }
4115: ##############################################
4116:
4117: =pod
4118:
4119: =item * &pprmlink()
4120:
4121: Inputs: $text $uname $udom $symb $target
4122:
4123: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4124: student and a specific resource
1.242 albertel 4125:
4126: =cut
4127:
4128: ###############################################
4129: sub pprmlink {
4130: my ($text,$uname,$udom,$symb,$target)=@_;
4131: if (!($uname && $udom)) {
4132: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4133: &Apache::lonnet::whichuser($symb);
1.242 albertel 4134: if (!$symb) { $symb=$cursymb; }
4135: }
1.254 matthew 4136: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4137: $symb=&escape($symb);
1.242 albertel 4138: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4139: return '<a href="/adm/parmset?command=set&'.
4140: 'symb='.$symb.'&uname='.$uname.
4141: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4142: }
4143: ##############################################
1.37 matthew 4144:
1.112 bowersj2 4145: =pod
4146:
4147: =back
4148:
4149: =cut
4150:
1.37 matthew 4151: ###############################################
1.51 www 4152:
4153:
4154: sub timehash {
1.687 raeburn 4155: my ($thistime) = @_;
4156: my $timezone = &Apache::lonlocal::gettimezone();
4157: my $dt = DateTime->from_epoch(epoch => $thistime)
4158: ->set_time_zone($timezone);
4159: my $wday = $dt->day_of_week();
4160: if ($wday == 7) { $wday = 0; }
4161: return ( 'second' => $dt->second(),
4162: 'minute' => $dt->minute(),
4163: 'hour' => $dt->hour(),
4164: 'day' => $dt->day_of_month(),
4165: 'month' => $dt->month(),
4166: 'year' => $dt->year(),
4167: 'weekday' => $wday,
4168: 'dayyear' => $dt->day_of_year(),
4169: 'dlsav' => $dt->is_dst() );
1.51 www 4170: }
4171:
1.370 www 4172: sub utc_string {
4173: my ($date)=@_;
1.371 www 4174: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4175: }
4176:
1.51 www 4177: sub maketime {
4178: my %th=@_;
1.687 raeburn 4179: my ($epoch_time,$timezone,$dt);
4180: $timezone = &Apache::lonlocal::gettimezone();
4181: eval {
4182: $dt = DateTime->new( year => $th{'year'},
4183: month => $th{'month'},
4184: day => $th{'day'},
4185: hour => $th{'hour'},
4186: minute => $th{'minute'},
4187: second => $th{'second'},
4188: time_zone => $timezone,
4189: );
4190: };
4191: if (!$@) {
4192: $epoch_time = $dt->epoch;
4193: if ($epoch_time) {
4194: return $epoch_time;
4195: }
4196: }
1.51 www 4197: return POSIX::mktime(
4198: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4199: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4200: }
4201:
4202: #########################################
1.51 www 4203:
4204: sub findallcourses {
1.482 raeburn 4205: my ($roles,$uname,$udom) = @_;
1.355 albertel 4206: my %roles;
4207: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4208: my %courses;
1.51 www 4209: my $now=time;
1.482 raeburn 4210: if (!defined($uname)) {
4211: $uname = $env{'user.name'};
4212: }
4213: if (!defined($udom)) {
4214: $udom = $env{'user.domain'};
4215: }
4216: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4217: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4218: if (!%roles) {
4219: %roles = (
4220: cc => 1,
1.907 raeburn 4221: co => 1,
1.482 raeburn 4222: in => 1,
4223: ep => 1,
4224: ta => 1,
4225: cr => 1,
4226: st => 1,
4227: );
4228: }
4229: foreach my $entry (keys(%roleshash)) {
4230: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4231: if ($trole =~ /^cr/) {
4232: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4233: } else {
4234: next if (!exists($roles{$trole}));
4235: }
4236: if ($tend) {
4237: next if ($tend < $now);
4238: }
4239: if ($tstart) {
4240: next if ($tstart > $now);
4241: }
1.1058 raeburn 4242: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4243: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4244: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4245: if ($secpart eq '') {
4246: ($cnum,$role) = split(/_/,$cnumpart);
4247: $sec = 'none';
1.1058 raeburn 4248: $value .= $cnum.'/';
1.482 raeburn 4249: } else {
4250: $cnum = $cnumpart;
4251: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4252: $value .= $cnum.'/'.$sec;
4253: }
4254: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4255: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4256: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4257: }
4258: } else {
4259: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4260: }
1.482 raeburn 4261: }
4262: } else {
4263: foreach my $key (keys(%env)) {
1.483 albertel 4264: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4265: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4266: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4267: next if ($role eq 'ca' || $role eq 'aa');
4268: next if (%roles && !exists($roles{$role}));
4269: my ($starttime,$endtime)=split(/\./,$env{$key});
4270: my $active=1;
4271: if ($starttime) {
4272: if ($now<$starttime) { $active=0; }
4273: }
4274: if ($endtime) {
4275: if ($now>$endtime) { $active=0; }
4276: }
4277: if ($active) {
1.1058 raeburn 4278: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4279: if ($sec eq '') {
4280: $sec = 'none';
1.1058 raeburn 4281: } else {
4282: $value .= $sec;
4283: }
4284: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4285: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4286: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4287: }
4288: } else {
4289: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4290: }
1.474 raeburn 4291: }
4292: }
1.51 www 4293: }
4294: }
1.474 raeburn 4295: return %courses;
1.51 www 4296: }
1.37 matthew 4297:
1.54 www 4298: ###############################################
1.474 raeburn 4299:
4300: sub blockcheck {
1.1062 raeburn 4301: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4302:
4303: if (!defined($udom)) {
4304: $udom = $env{'user.domain'};
4305: }
4306: if (!defined($uname)) {
4307: $uname = $env{'user.name'};
4308: }
4309:
4310: # If uname and udom are for a course, check for blocks in the course.
4311:
4312: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4313: my ($startblock,$endblock,$triggerblock) =
4314: &get_blocks($setters,$activity,$udom,$uname,$url);
4315: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4316: }
1.474 raeburn 4317:
1.502 raeburn 4318: my $startblock = 0;
4319: my $endblock = 0;
1.1062 raeburn 4320: my $triggerblock = '';
1.482 raeburn 4321: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4322:
1.490 raeburn 4323: # If uname is for a user, and activity is course-specific, i.e.,
4324: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4325:
1.490 raeburn 4326: if (($activity eq 'boards' || $activity eq 'chat' ||
4327: $activity eq 'groups') && ($env{'request.course.id'})) {
4328: foreach my $key (keys(%live_courses)) {
4329: if ($key ne $env{'request.course.id'}) {
4330: delete($live_courses{$key});
4331: }
4332: }
4333: }
4334:
4335: my $otheruser = 0;
4336: my %own_courses;
4337: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4338: # Resource belongs to user other than current user.
4339: $otheruser = 1;
4340: # Gather courses for current user
4341: %own_courses =
4342: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4343: }
4344:
4345: # Gather active course roles - course coordinator, instructor,
4346: # exam proctor, ta, student, or custom role.
1.474 raeburn 4347:
4348: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4349: my ($cdom,$cnum);
4350: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4351: $cdom = $env{'course.'.$course.'.domain'};
4352: $cnum = $env{'course.'.$course.'.num'};
4353: } else {
1.490 raeburn 4354: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4355: }
4356: my $no_ownblock = 0;
4357: my $no_userblock = 0;
1.533 raeburn 4358: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4359: # Check if current user has 'evb' priv for this
4360: if (defined($own_courses{$course})) {
4361: foreach my $sec (keys(%{$own_courses{$course}})) {
4362: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4363: if ($sec ne 'none') {
4364: $checkrole .= '/'.$sec;
4365: }
4366: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4367: $no_ownblock = 1;
4368: last;
4369: }
4370: }
4371: }
4372: # if they have 'evb' priv and are currently not playing student
4373: next if (($no_ownblock) &&
4374: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4375: }
1.474 raeburn 4376: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4377: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4378: if ($sec ne 'none') {
1.482 raeburn 4379: $checkrole .= '/'.$sec;
1.474 raeburn 4380: }
1.490 raeburn 4381: if ($otheruser) {
4382: # Resource belongs to user other than current user.
4383: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4384: my (%allroles,%userroles);
4385: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4386: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4387: my ($trole,$tdom,$tnum,$tsec);
4388: if ($entry =~ /^cr/) {
4389: ($trole,$tdom,$tnum,$tsec) =
4390: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4391: } else {
4392: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4393: }
4394: my ($spec,$area,$trest);
4395: $area = '/'.$tdom.'/'.$tnum;
4396: $trest = $tnum;
4397: if ($tsec ne '') {
4398: $area .= '/'.$tsec;
4399: $trest .= '/'.$tsec;
4400: }
4401: $spec = $trole.'.'.$area;
4402: if ($trole =~ /^cr/) {
4403: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4404: $tdom,$spec,$trest,$area);
4405: } else {
4406: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4407: $tdom,$spec,$trest,$area);
4408: }
4409: }
4410: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4411: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4412: if ($1) {
4413: $no_userblock = 1;
4414: last;
4415: }
1.486 raeburn 4416: }
4417: }
1.490 raeburn 4418: } else {
4419: # Resource belongs to current user
4420: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4421: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4422: $no_ownblock = 1;
4423: last;
4424: }
1.474 raeburn 4425: }
4426: }
4427: # if they have the evb priv and are currently not playing student
1.482 raeburn 4428: next if (($no_ownblock) &&
1.491 albertel 4429: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4430: next if ($no_userblock);
1.474 raeburn 4431:
1.866 kalberla 4432: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4433: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4434:
1.1062 raeburn 4435: my ($start,$end,$trigger) =
4436: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4437: if (($start != 0) &&
4438: (($startblock == 0) || ($startblock > $start))) {
4439: $startblock = $start;
1.1062 raeburn 4440: if ($trigger ne '') {
4441: $triggerblock = $trigger;
4442: }
1.502 raeburn 4443: }
4444: if (($end != 0) &&
4445: (($endblock == 0) || ($endblock < $end))) {
4446: $endblock = $end;
1.1062 raeburn 4447: if ($trigger ne '') {
4448: $triggerblock = $trigger;
4449: }
1.502 raeburn 4450: }
1.490 raeburn 4451: }
1.1062 raeburn 4452: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4453: }
4454:
4455: sub get_blocks {
1.1062 raeburn 4456: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4457: my $startblock = 0;
4458: my $endblock = 0;
1.1062 raeburn 4459: my $triggerblock = '';
1.490 raeburn 4460: my $course = $cdom.'_'.$cnum;
4461: $setters->{$course} = {};
4462: $setters->{$course}{'staff'} = [];
4463: $setters->{$course}{'times'} = [];
1.1062 raeburn 4464: $setters->{$course}{'triggers'} = [];
4465: my (@blockers,%triggered);
4466: my $now = time;
4467: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4468: if ($activity eq 'docs') {
4469: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4470: foreach my $block (@blockers) {
4471: if ($block =~ /^firstaccess____(.+)$/) {
4472: my $item = $1;
4473: my $type = 'map';
4474: my $timersymb = $item;
4475: if ($item eq 'course') {
4476: $type = 'course';
4477: } elsif ($item =~ /___\d+___/) {
4478: $type = 'resource';
4479: } else {
4480: $timersymb = &Apache::lonnet::symbread($item);
4481: }
4482: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4483: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4484: $triggered{$block} = {
4485: start => $start,
4486: end => $end,
4487: type => $type,
4488: };
4489: }
4490: }
4491: } else {
4492: foreach my $block (keys(%commblocks)) {
4493: if ($block =~ m/^(\d+)____(\d+)$/) {
4494: my ($start,$end) = ($1,$2);
4495: if ($start <= time && $end >= time) {
4496: if (ref($commblocks{$block}) eq 'HASH') {
4497: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4498: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4499: unless(grep(/^\Q$block\E$/,@blockers)) {
4500: push(@blockers,$block);
4501: }
4502: }
4503: }
4504: }
4505: }
4506: } elsif ($block =~ /^firstaccess____(.+)$/) {
4507: my $item = $1;
4508: my $timersymb = $item;
4509: my $type = 'map';
4510: if ($item eq 'course') {
4511: $type = 'course';
4512: } elsif ($item =~ /___\d+___/) {
4513: $type = 'resource';
4514: } else {
4515: $timersymb = &Apache::lonnet::symbread($item);
4516: }
4517: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4518: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4519: if ($start && $end) {
4520: if (($start <= time) && ($end >= time)) {
4521: unless (grep(/^\Q$block\E$/,@blockers)) {
4522: push(@blockers,$block);
4523: $triggered{$block} = {
4524: start => $start,
4525: end => $end,
4526: type => $type,
4527: };
4528: }
4529: }
1.490 raeburn 4530: }
1.1062 raeburn 4531: }
4532: }
4533: }
4534: foreach my $blocker (@blockers) {
4535: my ($staff_name,$staff_dom,$title,$blocks) =
4536: &parse_block_record($commblocks{$blocker});
4537: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4538: my ($start,$end,$triggertype);
4539: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4540: ($start,$end) = ($1,$2);
4541: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4542: $start = $triggered{$blocker}{'start'};
4543: $end = $triggered{$blocker}{'end'};
4544: $triggertype = $triggered{$blocker}{'type'};
4545: }
4546: if ($start) {
4547: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4548: if ($triggertype) {
4549: push(@{$$setters{$course}{'triggers'}},$triggertype);
4550: } else {
4551: push(@{$$setters{$course}{'triggers'}},0);
4552: }
4553: if ( ($startblock == 0) || ($startblock > $start) ) {
4554: $startblock = $start;
4555: if ($triggertype) {
4556: $triggerblock = $blocker;
1.474 raeburn 4557: }
4558: }
1.1062 raeburn 4559: if ( ($endblock == 0) || ($endblock < $end) ) {
4560: $endblock = $end;
4561: if ($triggertype) {
4562: $triggerblock = $blocker;
4563: }
4564: }
1.474 raeburn 4565: }
4566: }
1.1062 raeburn 4567: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4568: }
4569:
4570: sub parse_block_record {
4571: my ($record) = @_;
4572: my ($setuname,$setudom,$title,$blocks);
4573: if (ref($record) eq 'HASH') {
4574: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4575: $title = &unescape($record->{'event'});
4576: $blocks = $record->{'blocks'};
4577: } else {
4578: my @data = split(/:/,$record,3);
4579: if (scalar(@data) eq 2) {
4580: $title = $data[1];
4581: ($setuname,$setudom) = split(/@/,$data[0]);
4582: } else {
4583: ($setuname,$setudom,$title) = @data;
4584: }
4585: $blocks = { 'com' => 'on' };
4586: }
4587: return ($setuname,$setudom,$title,$blocks);
4588: }
4589:
1.854 kalberla 4590: sub blocking_status {
1.1062 raeburn 4591: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4592: my %setters;
1.890 droeschl 4593:
1.1061 raeburn 4594: # check for active blocking
1.1062 raeburn 4595: my ($startblock,$endblock,$triggerblock) =
4596: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4597: my $blocked = 0;
4598: if ($startblock && $endblock) {
4599: $blocked = 1;
4600: }
1.890 droeschl 4601:
1.1061 raeburn 4602: # caller just wants to know whether a block is active
4603: if (!wantarray) { return $blocked; }
4604:
4605: # build a link to a popup window containing the details
4606: my $querystring = "?activity=$activity";
4607: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4608: if ($activity eq 'port') {
4609: $querystring .= "&udom=$udom" if $udom;
4610: $querystring .= "&uname=$uname" if $uname;
4611: } elsif ($activity eq 'docs') {
4612: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4613: }
1.1061 raeburn 4614:
4615: my $output .= <<'END_MYBLOCK';
4616: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4617: var options = "width=" + w + ",height=" + h + ",";
4618: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4619: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4620: var newWin = window.open(url, wdwName, options);
4621: newWin.focus();
4622: }
1.890 droeschl 4623: END_MYBLOCK
1.854 kalberla 4624:
1.1061 raeburn 4625: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4626:
1.1061 raeburn 4627: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4628: my $text = &mt('Communication Blocked');
4629: if ($activity eq 'docs') {
4630: $text = &mt('Content Access Blocked');
1.1063 raeburn 4631: } elsif ($activity eq 'printout') {
4632: $text = &mt('Printing Blocked');
1.1062 raeburn 4633: }
1.1061 raeburn 4634: $output .= <<"END_BLOCK";
1.867 kalberla 4635: <div class='LC_comblock'>
1.869 kalberla 4636: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4637: title='$text'>
4638: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4639: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4640: title='$text'>$text</a>
1.867 kalberla 4641: </div>
4642:
4643: END_BLOCK
1.474 raeburn 4644:
1.1061 raeburn 4645: return ($blocked, $output);
1.854 kalberla 4646: }
1.490 raeburn 4647:
1.60 matthew 4648: ###############################################
4649:
1.682 raeburn 4650: sub check_ip_acc {
4651: my ($acc)=@_;
4652: &Apache::lonxml::debug("acc is $acc");
4653: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4654: return 1;
4655: }
4656: my $allowed=0;
4657: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4658:
4659: my $name;
4660: foreach my $pattern (split(',',$acc)) {
4661: $pattern =~ s/^\s*//;
4662: $pattern =~ s/\s*$//;
4663: if ($pattern =~ /\*$/) {
4664: #35.8.*
4665: $pattern=~s/\*//;
4666: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4667: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4668: #35.8.3.[34-56]
4669: my $low=$2;
4670: my $high=$3;
4671: $pattern=$1;
4672: if ($ip =~ /^\Q$pattern\E/) {
4673: my $last=(split(/\./,$ip))[3];
4674: if ($last <=$high && $last >=$low) { $allowed=1; }
4675: }
4676: } elsif ($pattern =~ /^\*/) {
4677: #*.msu.edu
4678: $pattern=~s/\*//;
4679: if (!defined($name)) {
4680: use Socket;
4681: my $netaddr=inet_aton($ip);
4682: ($name)=gethostbyaddr($netaddr,AF_INET);
4683: }
4684: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4685: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4686: #127.0.0.1
4687: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4688: } else {
4689: #some.name.com
4690: if (!defined($name)) {
4691: use Socket;
4692: my $netaddr=inet_aton($ip);
4693: ($name)=gethostbyaddr($netaddr,AF_INET);
4694: }
4695: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4696: }
4697: if ($allowed) { last; }
4698: }
4699: return $allowed;
4700: }
4701:
4702: ###############################################
4703:
1.60 matthew 4704: =pod
4705:
1.112 bowersj2 4706: =head1 Domain Template Functions
4707:
4708: =over 4
4709:
4710: =item * &determinedomain()
1.60 matthew 4711:
4712: Inputs: $domain (usually will be undef)
4713:
1.63 www 4714: Returns: Determines which domain should be used for designs
1.60 matthew 4715:
4716: =cut
1.54 www 4717:
1.60 matthew 4718: ###############################################
1.63 www 4719: sub determinedomain {
4720: my $domain=shift;
1.531 albertel 4721: if (! $domain) {
1.60 matthew 4722: # Determine domain if we have not been given one
1.893 raeburn 4723: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4724: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4725: if ($env{'request.role.domain'}) {
4726: $domain=$env{'request.role.domain'};
1.60 matthew 4727: }
4728: }
1.63 www 4729: return $domain;
4730: }
4731: ###############################################
1.517 raeburn 4732:
1.518 albertel 4733: sub devalidate_domconfig_cache {
4734: my ($udom)=@_;
4735: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4736: }
4737:
4738: # ---------------------- Get domain configuration for a domain
4739: sub get_domainconf {
4740: my ($udom) = @_;
4741: my $cachetime=1800;
4742: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4743: if (defined($cached)) { return %{$result}; }
4744:
4745: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4746: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4747: my (%designhash,%legacy);
1.518 albertel 4748: if (keys(%domconfig) > 0) {
4749: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4750: if (keys(%{$domconfig{'login'}})) {
4751: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4752: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4753: if ($key eq 'loginvia') {
4754: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4755: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4756: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4757: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4758: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4759: $designhash{$udom.'.login.loginvia'} = $server;
4760: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4761:
4762: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4763: } else {
1.1013 raeburn 4764: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4765: }
4766: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4767: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4768: }
1.946 raeburn 4769: }
4770: }
4771: }
4772: }
4773: } else {
4774: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4775: $designhash{$udom.'.login.'.$key.'_'.$img} =
4776: $domconfig{'login'}{$key}{$img};
4777: }
1.699 raeburn 4778: }
4779: } else {
4780: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4781: }
1.632 raeburn 4782: }
4783: } else {
4784: $legacy{'login'} = 1;
1.518 albertel 4785: }
1.632 raeburn 4786: } else {
4787: $legacy{'login'} = 1;
1.518 albertel 4788: }
4789: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4790: if (keys(%{$domconfig{'rolecolors'}})) {
4791: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4792: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4793: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4794: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4795: }
1.518 albertel 4796: }
4797: }
1.632 raeburn 4798: } else {
4799: $legacy{'rolecolors'} = 1;
1.518 albertel 4800: }
1.632 raeburn 4801: } else {
4802: $legacy{'rolecolors'} = 1;
1.518 albertel 4803: }
1.948 raeburn 4804: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4805: if ($domconfig{'autoenroll'}{'co-owners'}) {
4806: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4807: }
4808: }
1.632 raeburn 4809: if (keys(%legacy) > 0) {
4810: my %legacyhash = &get_legacy_domconf($udom);
4811: foreach my $item (keys(%legacyhash)) {
4812: if ($item =~ /^\Q$udom\E\.login/) {
4813: if ($legacy{'login'}) {
4814: $designhash{$item} = $legacyhash{$item};
4815: }
4816: } else {
4817: if ($legacy{'rolecolors'}) {
4818: $designhash{$item} = $legacyhash{$item};
4819: }
1.518 albertel 4820: }
4821: }
4822: }
1.632 raeburn 4823: } else {
4824: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4825: }
4826: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4827: $cachetime);
4828: return %designhash;
4829: }
4830:
1.632 raeburn 4831: sub get_legacy_domconf {
4832: my ($udom) = @_;
4833: my %legacyhash;
4834: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4835: my $designfile = $designdir.'/'.$udom.'.tab';
4836: if (-e $designfile) {
4837: if ( open (my $fh,"<$designfile") ) {
4838: while (my $line = <$fh>) {
4839: next if ($line =~ /^\#/);
4840: chomp($line);
4841: my ($key,$val)=(split(/\=/,$line));
4842: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4843: }
4844: close($fh);
4845: }
4846: }
1.1026 raeburn 4847: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4848: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4849: }
4850: return %legacyhash;
4851: }
4852:
1.63 www 4853: =pod
4854:
1.112 bowersj2 4855: =item * &domainlogo()
1.63 www 4856:
4857: Inputs: $domain (usually will be undef)
4858:
4859: Returns: A link to a domain logo, if the domain logo exists.
4860: If the domain logo does not exist, a description of the domain.
4861:
4862: =cut
1.112 bowersj2 4863:
1.63 www 4864: ###############################################
4865: sub domainlogo {
1.517 raeburn 4866: my $domain = &determinedomain(shift);
1.518 albertel 4867: my %designhash = &get_domainconf($domain);
1.517 raeburn 4868: # See if there is a logo
4869: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4870: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4871: if ($imgsrc =~ m{^/(adm|res)/}) {
4872: if ($imgsrc =~ m{^/res/}) {
4873: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4874: &Apache::lonnet::repcopy($local_name);
4875: }
4876: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4877: }
4878: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4879: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4880: return &Apache::lonnet::domain($domain,'description');
1.59 www 4881: } else {
1.60 matthew 4882: return '';
1.59 www 4883: }
4884: }
1.63 www 4885: ##############################################
4886:
4887: =pod
4888:
1.112 bowersj2 4889: =item * &designparm()
1.63 www 4890:
4891: Inputs: $which parameter; $domain (usually will be undef)
4892:
4893: Returns: value of designparamter $which
4894:
4895: =cut
1.112 bowersj2 4896:
1.397 albertel 4897:
1.400 albertel 4898: ##############################################
1.397 albertel 4899: sub designparm {
4900: my ($which,$domain)=@_;
4901: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4902: return $env{'environment.color.'.$which};
1.96 www 4903: }
1.63 www 4904: $domain=&determinedomain($domain);
1.1016 raeburn 4905: my %domdesign;
4906: unless ($domain eq 'public') {
4907: %domdesign = &get_domainconf($domain);
4908: }
1.520 raeburn 4909: my $output;
1.517 raeburn 4910: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4911: $output = $domdesign{$domain.'.'.$which};
1.63 www 4912: } else {
1.520 raeburn 4913: $output = $defaultdesign{$which};
4914: }
4915: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4916: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4917: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4918: if ($output =~ m{^/res/}) {
4919: my $local_name = &Apache::lonnet::filelocation('',$output);
4920: &Apache::lonnet::repcopy($local_name);
4921: }
1.520 raeburn 4922: $output = &lonhttpdurl($output);
4923: }
1.63 www 4924: }
1.520 raeburn 4925: return $output;
1.63 www 4926: }
1.59 www 4927:
1.822 bisitz 4928: ##############################################
4929: =pod
4930:
1.832 bisitz 4931: =item * &authorspace()
4932:
1.1028 raeburn 4933: Inputs: $url (usually will be undef).
1.832 bisitz 4934:
1.1132 raeburn 4935: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 4936: directory being viewed (or for which action is being taken).
4937: If $url is provided, and begins /priv/<domain>/<uname>
4938: the path will be that portion of the $context argument.
4939: Otherwise the path will be for the author space of the current
4940: user when the current role is author, or for that of the
4941: co-author/assistant co-author space when the current role
4942: is co-author or assistant co-author.
1.832 bisitz 4943:
4944: =cut
4945:
4946: sub authorspace {
1.1028 raeburn 4947: my ($url) = @_;
4948: if ($url ne '') {
4949: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4950: return $1;
4951: }
4952: }
1.832 bisitz 4953: my $caname = '';
1.1024 www 4954: my $cadom = '';
1.1028 raeburn 4955: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4956: ($cadom,$caname) =
1.832 bisitz 4957: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4958: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4959: $caname = $env{'user.name'};
1.1024 www 4960: $cadom = $env{'user.domain'};
1.832 bisitz 4961: }
1.1028 raeburn 4962: if (($caname ne '') && ($cadom ne '')) {
4963: return "/priv/$cadom/$caname/";
4964: }
4965: return;
1.832 bisitz 4966: }
4967:
4968: ##############################################
4969: =pod
4970:
1.822 bisitz 4971: =item * &head_subbox()
4972:
4973: Inputs: $content (contains HTML code with page functions, etc.)
4974:
4975: Returns: HTML div with $content
4976: To be included in page header
4977:
4978: =cut
4979:
4980: sub head_subbox {
4981: my ($content)=@_;
4982: my $output =
1.993 raeburn 4983: '<div class="LC_head_subbox">'
1.822 bisitz 4984: .$content
4985: .'</div>'
4986: }
4987:
4988: ##############################################
4989: =pod
4990:
4991: =item * &CSTR_pageheader()
4992:
1.1026 raeburn 4993: Input: (optional) filename from which breadcrumb trail is built.
4994: In most cases no input as needed, as $env{'request.filename'}
4995: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4996:
4997: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 4998: To be included on Authoring Space pages
1.822 bisitz 4999:
5000: =cut
5001:
5002: sub CSTR_pageheader {
1.1026 raeburn 5003: my ($trailfile) = @_;
5004: if ($trailfile eq '') {
5005: $trailfile = $env{'request.filename'};
5006: }
5007:
5008: # this is for resources; directories have customtitle, and crumbs
5009: # and select recent are created in lonpubdir.pm
5010:
5011: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5012: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5013: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5014: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5015: $formaction =~ s{/+}{/}g;
1.822 bisitz 5016:
5017: my $parentpath = '';
5018: my $lastitem = '';
5019: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5020: $parentpath = $1;
5021: $lastitem = $2;
5022: } else {
5023: $lastitem = $thisdisfn;
5024: }
1.921 bisitz 5025:
5026: my $output =
1.822 bisitz 5027: '<div>'
5028: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1132 raeburn 5029: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5030: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5031: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5032: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5033:
5034: if ($lastitem) {
5035: $output .=
5036: '<span class="LC_filename">'
5037: .$lastitem
5038: .'</span>';
5039: }
5040: $output .=
5041: '<br />'
1.822 bisitz 5042: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5043: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5044: .'</form>'
5045: .&Apache::lonmenu::constspaceform()
5046: .'</div>';
1.921 bisitz 5047:
5048: return $output;
1.822 bisitz 5049: }
5050:
1.60 matthew 5051: ###############################################
5052: ###############################################
5053:
5054: =pod
5055:
1.112 bowersj2 5056: =back
5057:
1.549 albertel 5058: =head1 HTML Helpers
1.112 bowersj2 5059:
5060: =over 4
5061:
5062: =item * &bodytag()
1.60 matthew 5063:
5064: Returns a uniform header for LON-CAPA web pages.
5065:
5066: Inputs:
5067:
1.112 bowersj2 5068: =over 4
5069:
5070: =item * $title, A title to be displayed on the page.
5071:
5072: =item * $function, the current role (can be undef).
5073:
5074: =item * $addentries, extra parameters for the <body> tag.
5075:
5076: =item * $bodyonly, if defined, only return the <body> tag.
5077:
5078: =item * $domain, if defined, force a given domain.
5079:
5080: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5081: text interface only)
1.60 matthew 5082:
1.814 bisitz 5083: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5084: navigational links
1.317 albertel 5085:
1.338 albertel 5086: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5087:
1.460 albertel 5088: =item * $args, optional argument valid values are
5089: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5090: inherit_jsmath -> when creating popup window in a page,
5091: should it have jsmath forced on by the
5092: current page
1.460 albertel 5093:
1.1096 raeburn 5094: =item * $advtoolsref, optional argument, ref to an array containing
5095: inlineremote items to be added in "Functions" menu below
5096: breadcrumbs.
5097:
1.112 bowersj2 5098: =back
5099:
1.60 matthew 5100: Returns: A uniform header for LON-CAPA web pages.
5101: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5102: If $bodyonly is undef or zero, an html string containing a <body> tag and
5103: other decorations will be returned.
5104:
5105: =cut
5106:
1.54 www 5107: sub bodytag {
1.831 bisitz 5108: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 raeburn 5109: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5110:
1.954 raeburn 5111: my $public;
5112: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5113: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5114: $public = 1;
5115: }
1.460 albertel 5116: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 5117:
1.183 matthew 5118: $function = &get_users_function() if (!$function);
1.339 albertel 5119: my $img = &designparm($function.'.img',$domain);
5120: my $font = &designparm($function.'.font',$domain);
5121: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5122:
1.803 bisitz 5123: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5124: 'bgcolor' => $pgbg,
1.339 albertel 5125: 'text' => $font,
5126: 'alink' => &designparm($function.'.alink',$domain),
5127: 'vlink' => &designparm($function.'.vlink',$domain),
5128: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5129: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5130:
1.63 www 5131: # role and realm
1.378 raeburn 5132: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5133: if ($role eq 'ca') {
1.479 albertel 5134: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5135: $realm = &plainname($rname,$rdom);
1.378 raeburn 5136: }
1.55 www 5137: # realm
1.258 albertel 5138: if ($env{'request.course.id'}) {
1.378 raeburn 5139: if ($env{'request.role'} !~ /^cr/) {
5140: $role = &Apache::lonnet::plaintext($role,&course_type());
5141: }
1.898 raeburn 5142: if ($env{'request.course.sec'}) {
5143: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5144: }
1.359 albertel 5145: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5146: } else {
5147: $role = &Apache::lonnet::plaintext($role);
1.54 www 5148: }
1.433 albertel 5149:
1.359 albertel 5150: if (!$realm) { $realm=' '; }
1.330 albertel 5151:
1.438 albertel 5152: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5153:
1.101 www 5154: # construct main body tag
1.359 albertel 5155: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5156: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5157:
1.1131 raeburn 5158: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5159:
1.1130 raeburn 5160: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5161: return $bodytag;
1.1130 raeburn 5162: }
1.359 albertel 5163:
1.954 raeburn 5164: if ($public) {
1.433 albertel 5165: undef($role);
5166: }
1.359 albertel 5167:
1.762 bisitz 5168: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5169: #
5170: # Extra info if you are the DC
5171: my $dc_info = '';
5172: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5173: $env{'course.'.$env{'request.course.id'}.
5174: '.domain'}.'/'})) {
5175: my $cid = $env{'request.course.id'};
1.917 raeburn 5176: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5177: $dc_info =~ s/\s+$//;
1.359 albertel 5178: }
5179:
1.898 raeburn 5180: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5181:
1.903 droeschl 5182: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5183:
5184: # if ($env{'request.state'} eq 'construct') {
5185: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5186: # }
5187:
1.1130 raeburn 5188: $bodytag .= Apache::lonhtmlcommon::scripttag(
5189: Apache::lonmenu::utilityfunctions(), 'start');
1.359 albertel 5190:
1.1130 raeburn 5191: my ($left,$right) = Apache::lonmenu::primary_menu();
1.359 albertel 5192:
1.916 droeschl 5193: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5194: if ($dc_info) {
5195: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5196: }
1.1130 raeburn 5197: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916 droeschl 5198: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5199: return $bodytag;
5200: }
1.894 droeschl 5201:
1.927 raeburn 5202: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130 raeburn 5203: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5204: }
1.916 droeschl 5205:
1.1130 raeburn 5206: $bodytag .= $right;
1.852 droeschl 5207:
1.917 raeburn 5208: if ($dc_info) {
5209: $dc_info = &dc_courseid_toggle($dc_info);
5210: }
5211: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5212:
1.903 droeschl 5213: #don't show menus for public users
1.954 raeburn 5214: if (!$public){
1.903 droeschl 5215: $bodytag .= Apache::lonmenu::secondary_menu();
5216: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5217: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5218: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5219: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5220: $args->{'bread_crumbs'});
1.1096 raeburn 5221: } elsif ($forcereg) {
5222: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5223: $args->{'group'});
5224: } else {
5225: $bodytag .=
5226: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5227: $forcereg,$args->{'group'},
5228: $args->{'bread_crumbs'},
5229: $advtoolsref);
1.920 raeburn 5230: }
1.903 droeschl 5231: }else{
5232: # this is to seperate menu from content when there's no secondary
5233: # menu. Especially needed for public accessible ressources.
5234: $bodytag .= '<hr style="clear:both" />';
5235: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5236: }
1.903 droeschl 5237:
1.235 raeburn 5238: return $bodytag;
1.182 matthew 5239: }
5240:
1.917 raeburn 5241: sub dc_courseid_toggle {
5242: my ($dc_info) = @_;
1.980 raeburn 5243: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5244: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5245: &mt('(More ...)').'</a></span>'.
5246: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5247: }
5248:
1.330 albertel 5249: sub make_attr_string {
5250: my ($register,$attr_ref) = @_;
5251:
5252: if ($attr_ref && !ref($attr_ref)) {
5253: die("addentries Must be a hash ref ".
5254: join(':',caller(1))." ".
5255: join(':',caller(0))." ");
5256: }
5257:
5258: if ($register) {
1.339 albertel 5259: my ($on_load,$on_unload);
5260: foreach my $key (keys(%{$attr_ref})) {
5261: if (lc($key) eq 'onload') {
5262: $on_load.=$attr_ref->{$key}.';';
5263: delete($attr_ref->{$key});
5264:
5265: } elsif (lc($key) eq 'onunload') {
5266: $on_unload.=$attr_ref->{$key}.';';
5267: delete($attr_ref->{$key});
5268: }
5269: }
1.953 droeschl 5270: $attr_ref->{'onload'} = $on_load;
5271: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5272: }
1.339 albertel 5273:
1.330 albertel 5274: my $attr_string;
5275: foreach my $attr (keys(%$attr_ref)) {
5276: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5277: }
5278: return $attr_string;
5279: }
5280:
5281:
1.182 matthew 5282: ###############################################
1.251 albertel 5283: ###############################################
5284:
5285: =pod
5286:
5287: =item * &endbodytag()
5288:
5289: Returns a uniform footer for LON-CAPA web pages.
5290:
1.635 raeburn 5291: Inputs: 1 - optional reference to an args hash
5292: If in the hash, key for noredirectlink has a value which evaluates to true,
5293: a 'Continue' link is not displayed if the page contains an
5294: internal redirect in the <head></head> section,
5295: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5296:
5297: =cut
5298:
5299: sub endbodytag {
1.635 raeburn 5300: my ($args) = @_;
1.1080 raeburn 5301: my $endbodytag;
5302: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5303: $endbodytag='</body>';
5304: }
1.269 albertel 5305: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5306: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5307: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5308: $endbodytag=
5309: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5310: &mt('Continue').'</a>'.
5311: $endbodytag;
5312: }
1.315 albertel 5313: }
1.251 albertel 5314: return $endbodytag;
5315: }
5316:
1.352 albertel 5317: =pod
5318:
5319: =item * &standard_css()
5320:
5321: Returns a style sheet
5322:
5323: Inputs: (all optional)
5324: domain -> force to color decorate a page for a specific
5325: domain
5326: function -> force usage of a specific rolish color scheme
5327: bgcolor -> override the default page bgcolor
5328:
5329: =cut
5330:
1.343 albertel 5331: sub standard_css {
1.345 albertel 5332: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5333: $function = &get_users_function() if (!$function);
5334: my $img = &designparm($function.'.img', $domain);
5335: my $tabbg = &designparm($function.'.tabbg', $domain);
5336: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5337: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5338: #second colour for later usage
1.345 albertel 5339: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5340: my $pgbg_or_bgcolor =
5341: $bgcolor ||
1.352 albertel 5342: &designparm($function.'.pgbg', $domain);
1.382 albertel 5343: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5344: my $alink = &designparm($function.'.alink', $domain);
5345: my $vlink = &designparm($function.'.vlink', $domain);
5346: my $link = &designparm($function.'.link', $domain);
5347:
1.602 albertel 5348: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5349: my $mono = 'monospace';
1.850 bisitz 5350: my $data_table_head = $sidebg;
5351: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5352: my $data_table_dark = '#E0E0E0';
1.470 banghart 5353: my $data_table_darker = '#CCCCCC';
1.349 albertel 5354: my $data_table_highlight = '#FFFF00';
1.352 albertel 5355: my $mail_new = '#FFBB77';
5356: my $mail_new_hover = '#DD9955';
5357: my $mail_read = '#BBBB77';
5358: my $mail_read_hover = '#999944';
5359: my $mail_replied = '#AAAA88';
5360: my $mail_replied_hover = '#888855';
5361: my $mail_other = '#99BBBB';
5362: my $mail_other_hover = '#669999';
1.391 albertel 5363: my $table_header = '#DDDDDD';
1.489 raeburn 5364: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5365: my $lg_border_color = '#C8C8C8';
1.952 onken 5366: my $button_hover = '#BF2317';
1.392 albertel 5367:
1.608 albertel 5368: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5369: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5370: : '0 3px 0 4px';
1.448 albertel 5371:
1.523 albertel 5372:
1.343 albertel 5373: return <<END;
1.947 droeschl 5374:
5375: /* needed for iframe to allow 100% height in FF */
5376: body, html {
5377: margin: 0;
5378: padding: 0 0.5%;
5379: height: 99%; /* to avoid scrollbars */
5380: }
5381:
1.795 www 5382: body {
1.911 bisitz 5383: font-family: $sans;
5384: line-height:130%;
5385: font-size:0.83em;
5386: color:$font;
1.795 www 5387: }
5388:
1.959 onken 5389: a:focus,
5390: a:focus img {
1.795 www 5391: color: red;
5392: }
1.698 harmsja 5393:
1.911 bisitz 5394: form, .inline {
5395: display: inline;
1.795 www 5396: }
1.721 harmsja 5397:
1.795 www 5398: .LC_right {
1.911 bisitz 5399: text-align:right;
1.795 www 5400: }
5401:
5402: .LC_middle {
1.911 bisitz 5403: vertical-align:middle;
1.795 www 5404: }
1.721 harmsja 5405:
1.1130 raeburn 5406: .LC_floatleft {
5407: float: left;
5408: }
5409:
5410: .LC_floatright {
5411: float: right;
5412: }
5413:
1.911 bisitz 5414: .LC_400Box {
5415: width:400px;
5416: }
1.721 harmsja 5417:
1.947 droeschl 5418: .LC_iframecontainer {
5419: width: 98%;
5420: margin: 0;
5421: position: fixed;
5422: top: 8.5em;
5423: bottom: 0;
5424: }
5425:
5426: .LC_iframecontainer iframe{
5427: border: none;
5428: width: 100%;
5429: height: 100%;
5430: }
5431:
1.778 bisitz 5432: .LC_filename {
5433: font-family: $mono;
5434: white-space:pre;
1.921 bisitz 5435: font-size: 120%;
1.778 bisitz 5436: }
5437:
5438: .LC_fileicon {
5439: border: none;
5440: height: 1.3em;
5441: vertical-align: text-bottom;
5442: margin-right: 0.3em;
5443: text-decoration:none;
5444: }
5445:
1.1008 www 5446: .LC_setting {
5447: text-decoration:underline;
5448: }
5449:
1.350 albertel 5450: .LC_error {
5451: color: red;
5452: }
1.795 www 5453:
1.1097 bisitz 5454: .LC_warning {
5455: color: darkorange;
5456: }
5457:
1.457 albertel 5458: .LC_diff_removed {
1.733 bisitz 5459: color: red;
1.394 albertel 5460: }
1.532 albertel 5461:
5462: .LC_info,
1.457 albertel 5463: .LC_success,
5464: .LC_diff_added {
1.350 albertel 5465: color: green;
5466: }
1.795 www 5467:
1.802 bisitz 5468: div.LC_confirm_box {
5469: background-color: #FAFAFA;
5470: border: 1px solid $lg_border_color;
5471: margin-right: 0;
5472: padding: 5px;
5473: }
5474:
5475: div.LC_confirm_box .LC_error img,
5476: div.LC_confirm_box .LC_success img {
5477: vertical-align: middle;
5478: }
5479:
1.440 albertel 5480: .LC_icon {
1.771 droeschl 5481: border: none;
1.790 droeschl 5482: vertical-align: middle;
1.771 droeschl 5483: }
5484:
1.543 albertel 5485: .LC_docs_spacer {
5486: width: 25px;
5487: height: 1px;
1.771 droeschl 5488: border: none;
1.543 albertel 5489: }
1.346 albertel 5490:
1.532 albertel 5491: .LC_internal_info {
1.735 bisitz 5492: color: #999999;
1.532 albertel 5493: }
5494:
1.794 www 5495: .LC_discussion {
1.1050 www 5496: background: $data_table_dark;
1.911 bisitz 5497: border: 1px solid black;
5498: margin: 2px;
1.794 www 5499: }
5500:
5501: .LC_disc_action_left {
1.1050 www 5502: background: $sidebg;
1.911 bisitz 5503: text-align: left;
1.1050 www 5504: padding: 4px;
5505: margin: 2px;
1.794 www 5506: }
5507:
5508: .LC_disc_action_right {
1.1050 www 5509: background: $sidebg;
1.911 bisitz 5510: text-align: right;
1.1050 www 5511: padding: 4px;
5512: margin: 2px;
1.794 www 5513: }
5514:
5515: .LC_disc_new_item {
1.911 bisitz 5516: background: white;
5517: border: 2px solid red;
1.1050 www 5518: margin: 4px;
5519: padding: 4px;
1.794 www 5520: }
5521:
5522: .LC_disc_old_item {
1.911 bisitz 5523: background: white;
1.1050 www 5524: margin: 4px;
5525: padding: 4px;
1.794 www 5526: }
5527:
1.458 albertel 5528: table.LC_pastsubmission {
5529: border: 1px solid black;
5530: margin: 2px;
5531: }
5532:
1.924 bisitz 5533: table#LC_menubuttons {
1.345 albertel 5534: width: 100%;
5535: background: $pgbg;
1.392 albertel 5536: border: 2px;
1.402 albertel 5537: border-collapse: separate;
1.803 bisitz 5538: padding: 0;
1.345 albertel 5539: }
1.392 albertel 5540:
1.801 tempelho 5541: table#LC_title_bar a {
5542: color: $fontmenu;
5543: }
1.836 bisitz 5544:
1.807 droeschl 5545: table#LC_title_bar {
1.819 tempelho 5546: clear: both;
1.836 bisitz 5547: display: none;
1.807 droeschl 5548: }
5549:
1.795 www 5550: table#LC_title_bar,
1.933 droeschl 5551: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5552: table#LC_title_bar.LC_with_remote {
1.359 albertel 5553: width: 100%;
1.392 albertel 5554: border-color: $pgbg;
5555: border-style: solid;
5556: border-width: $border;
1.379 albertel 5557: background: $pgbg;
1.801 tempelho 5558: color: $fontmenu;
1.392 albertel 5559: border-collapse: collapse;
1.803 bisitz 5560: padding: 0;
1.819 tempelho 5561: margin: 0;
1.359 albertel 5562: }
1.795 www 5563:
1.933 droeschl 5564: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5565: margin: 0;
5566: padding: 0;
1.933 droeschl 5567: position: relative;
5568: list-style: none;
1.913 droeschl 5569: }
1.933 droeschl 5570: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5571: display: inline;
5572: }
1.933 droeschl 5573:
5574: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5575: padding: 0;
1.933 droeschl 5576: margin: 0;
5577: float: left;
1.913 droeschl 5578: }
1.933 droeschl 5579: .LC_breadcrumb_tools_tools {
5580: padding: 0;
5581: margin: 0;
1.913 droeschl 5582: float: right;
5583: }
5584:
1.359 albertel 5585: table#LC_title_bar td {
5586: background: $tabbg;
5587: }
1.795 www 5588:
1.911 bisitz 5589: table#LC_menubuttons img {
1.803 bisitz 5590: border: none;
1.346 albertel 5591: }
1.795 www 5592:
1.842 droeschl 5593: .LC_breadcrumbs_component {
1.911 bisitz 5594: float: right;
5595: margin: 0 1em;
1.357 albertel 5596: }
1.842 droeschl 5597: .LC_breadcrumbs_component img {
1.911 bisitz 5598: vertical-align: middle;
1.777 tempelho 5599: }
1.795 www 5600:
1.383 albertel 5601: td.LC_table_cell_checkbox {
5602: text-align: center;
5603: }
1.795 www 5604:
5605: .LC_fontsize_small {
1.911 bisitz 5606: font-size: 70%;
1.705 tempelho 5607: }
5608:
1.844 bisitz 5609: #LC_breadcrumbs {
1.911 bisitz 5610: clear:both;
5611: background: $sidebg;
5612: border-bottom: 1px solid $lg_border_color;
5613: line-height: 2.5em;
1.933 droeschl 5614: overflow: hidden;
1.911 bisitz 5615: margin: 0;
5616: padding: 0;
1.995 raeburn 5617: text-align: left;
1.819 tempelho 5618: }
1.862 bisitz 5619:
1.1098 bisitz 5620: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5621: clear:both;
5622: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5623: border: 1px solid $sidebg;
1.1098 bisitz 5624: margin: 0 0 10px 0;
1.966 bisitz 5625: padding: 3px;
1.995 raeburn 5626: text-align: left;
1.822 bisitz 5627: }
5628:
1.795 www 5629: .LC_fontsize_medium {
1.911 bisitz 5630: font-size: 85%;
1.705 tempelho 5631: }
5632:
1.795 www 5633: .LC_fontsize_large {
1.911 bisitz 5634: font-size: 120%;
1.705 tempelho 5635: }
5636:
1.346 albertel 5637: .LC_menubuttons_inline_text {
5638: color: $font;
1.698 harmsja 5639: font-size: 90%;
1.701 harmsja 5640: padding-left:3px;
1.346 albertel 5641: }
5642:
1.934 droeschl 5643: .LC_menubuttons_inline_text img{
5644: vertical-align: middle;
5645: }
5646:
1.1051 www 5647: li.LC_menubuttons_inline_text img {
1.951 onken 5648: cursor:pointer;
1.1002 droeschl 5649: text-decoration: none;
1.951 onken 5650: }
5651:
1.526 www 5652: .LC_menubuttons_link {
5653: text-decoration: none;
5654: }
1.795 www 5655:
1.522 albertel 5656: .LC_menubuttons_category {
1.521 www 5657: color: $font;
1.526 www 5658: background: $pgbg;
1.521 www 5659: font-size: larger;
5660: font-weight: bold;
5661: }
5662:
1.346 albertel 5663: td.LC_menubuttons_text {
1.911 bisitz 5664: color: $font;
1.346 albertel 5665: }
1.706 harmsja 5666:
1.346 albertel 5667: .LC_current_location {
5668: background: $tabbg;
5669: }
1.795 www 5670:
1.938 bisitz 5671: table.LC_data_table {
1.347 albertel 5672: border: 1px solid #000000;
1.402 albertel 5673: border-collapse: separate;
1.426 albertel 5674: border-spacing: 1px;
1.610 albertel 5675: background: $pgbg;
1.347 albertel 5676: }
1.795 www 5677:
1.422 albertel 5678: .LC_data_table_dense {
5679: font-size: small;
5680: }
1.795 www 5681:
1.507 raeburn 5682: table.LC_nested_outer {
5683: border: 1px solid #000000;
1.589 raeburn 5684: border-collapse: collapse;
1.803 bisitz 5685: border-spacing: 0;
1.507 raeburn 5686: width: 100%;
5687: }
1.795 www 5688:
1.879 raeburn 5689: table.LC_innerpickbox,
1.507 raeburn 5690: table.LC_nested {
1.803 bisitz 5691: border: none;
1.589 raeburn 5692: border-collapse: collapse;
1.803 bisitz 5693: border-spacing: 0;
1.507 raeburn 5694: width: 100%;
5695: }
1.795 www 5696:
1.911 bisitz 5697: table.LC_data_table tr th,
5698: table.LC_calendar tr th,
1.879 raeburn 5699: table.LC_prior_tries tr th,
5700: table.LC_innerpickbox tr th {
1.349 albertel 5701: font-weight: bold;
5702: background-color: $data_table_head;
1.801 tempelho 5703: color:$fontmenu;
1.701 harmsja 5704: font-size:90%;
1.347 albertel 5705: }
1.795 www 5706:
1.879 raeburn 5707: table.LC_innerpickbox tr th,
5708: table.LC_innerpickbox tr td {
5709: vertical-align: top;
5710: }
5711:
1.711 raeburn 5712: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5713: background-color: #CCCCCC;
1.711 raeburn 5714: font-weight: bold;
5715: text-align: left;
5716: }
1.795 www 5717:
1.912 bisitz 5718: table.LC_data_table tr.LC_odd_row > td {
5719: background-color: $data_table_light;
5720: padding: 2px;
5721: vertical-align: top;
5722: }
5723:
1.809 bisitz 5724: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5725: background-color: $data_table_light;
1.912 bisitz 5726: vertical-align: top;
5727: }
5728:
5729: table.LC_data_table tr.LC_even_row > td {
5730: background-color: $data_table_dark;
1.425 albertel 5731: padding: 2px;
1.900 bisitz 5732: vertical-align: top;
1.347 albertel 5733: }
1.795 www 5734:
1.809 bisitz 5735: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5736: background-color: $data_table_dark;
1.900 bisitz 5737: vertical-align: top;
1.347 albertel 5738: }
1.795 www 5739:
1.425 albertel 5740: table.LC_data_table tr.LC_data_table_highlight td {
5741: background-color: $data_table_darker;
5742: }
1.795 www 5743:
1.639 raeburn 5744: table.LC_data_table tr td.LC_leftcol_header {
5745: background-color: $data_table_head;
5746: font-weight: bold;
5747: }
1.795 www 5748:
1.451 albertel 5749: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5750: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5751: font-weight: bold;
5752: font-style: italic;
5753: text-align: center;
5754: padding: 8px;
1.347 albertel 5755: }
1.795 www 5756:
1.1114 raeburn 5757: table.LC_data_table tr.LC_empty_row td,
5758: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 5759: background-color: $sidebg;
5760: }
5761:
5762: table.LC_nested tr.LC_empty_row td {
5763: background-color: #FFFFFF;
5764: }
5765:
1.890 droeschl 5766: table.LC_caption {
5767: }
5768:
1.507 raeburn 5769: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5770: padding: 4ex
5771: }
1.795 www 5772:
1.507 raeburn 5773: table.LC_nested_outer tr th {
5774: font-weight: bold;
1.801 tempelho 5775: color:$fontmenu;
1.507 raeburn 5776: background-color: $data_table_head;
1.701 harmsja 5777: font-size: small;
1.507 raeburn 5778: border-bottom: 1px solid #000000;
5779: }
1.795 www 5780:
1.507 raeburn 5781: table.LC_nested_outer tr td.LC_subheader {
5782: background-color: $data_table_head;
5783: font-weight: bold;
5784: font-size: small;
5785: border-bottom: 1px solid #000000;
5786: text-align: right;
1.451 albertel 5787: }
1.795 www 5788:
1.507 raeburn 5789: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5790: background-color: #CCCCCC;
1.451 albertel 5791: font-weight: bold;
5792: font-size: small;
1.507 raeburn 5793: text-align: center;
5794: }
1.795 www 5795:
1.589 raeburn 5796: table.LC_nested tr.LC_info_row td.LC_left_item,
5797: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5798: text-align: left;
1.451 albertel 5799: }
1.795 www 5800:
1.507 raeburn 5801: table.LC_nested td {
1.735 bisitz 5802: background-color: #FFFFFF;
1.451 albertel 5803: font-size: small;
1.507 raeburn 5804: }
1.795 www 5805:
1.507 raeburn 5806: table.LC_nested_outer tr th.LC_right_item,
5807: table.LC_nested tr.LC_info_row td.LC_right_item,
5808: table.LC_nested tr.LC_odd_row td.LC_right_item,
5809: table.LC_nested tr td.LC_right_item {
1.451 albertel 5810: text-align: right;
5811: }
5812:
1.507 raeburn 5813: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5814: background-color: #EEEEEE;
1.451 albertel 5815: }
5816:
1.473 raeburn 5817: table.LC_createuser {
5818: }
5819:
5820: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5821: font-size: small;
1.473 raeburn 5822: }
5823:
5824: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5825: background-color: #CCCCCC;
1.473 raeburn 5826: font-weight: bold;
5827: text-align: center;
5828: }
5829:
1.349 albertel 5830: table.LC_calendar {
5831: border: 1px solid #000000;
5832: border-collapse: collapse;
1.917 raeburn 5833: width: 98%;
1.349 albertel 5834: }
1.795 www 5835:
1.349 albertel 5836: table.LC_calendar_pickdate {
5837: font-size: xx-small;
5838: }
1.795 www 5839:
1.349 albertel 5840: table.LC_calendar tr td {
5841: border: 1px solid #000000;
5842: vertical-align: top;
1.917 raeburn 5843: width: 14%;
1.349 albertel 5844: }
1.795 www 5845:
1.349 albertel 5846: table.LC_calendar tr td.LC_calendar_day_empty {
5847: background-color: $data_table_dark;
5848: }
1.795 www 5849:
1.779 bisitz 5850: table.LC_calendar tr td.LC_calendar_day_current {
5851: background-color: $data_table_highlight;
1.777 tempelho 5852: }
1.795 www 5853:
1.938 bisitz 5854: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5855: background-color: $mail_new;
5856: }
1.795 www 5857:
1.938 bisitz 5858: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5859: background-color: $mail_new_hover;
5860: }
1.795 www 5861:
1.938 bisitz 5862: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5863: background-color: $mail_read;
5864: }
1.795 www 5865:
1.938 bisitz 5866: /*
5867: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5868: background-color: $mail_read_hover;
5869: }
1.938 bisitz 5870: */
1.795 www 5871:
1.938 bisitz 5872: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5873: background-color: $mail_replied;
5874: }
1.795 www 5875:
1.938 bisitz 5876: /*
5877: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5878: background-color: $mail_replied_hover;
5879: }
1.938 bisitz 5880: */
1.795 www 5881:
1.938 bisitz 5882: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5883: background-color: $mail_other;
5884: }
1.795 www 5885:
1.938 bisitz 5886: /*
5887: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5888: background-color: $mail_other_hover;
5889: }
1.938 bisitz 5890: */
1.494 raeburn 5891:
1.777 tempelho 5892: table.LC_data_table tr > td.LC_browser_file,
5893: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5894: background: #AAEE77;
1.389 albertel 5895: }
1.795 www 5896:
1.777 tempelho 5897: table.LC_data_table tr > td.LC_browser_file_locked,
5898: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5899: background: #FFAA99;
1.387 albertel 5900: }
1.795 www 5901:
1.777 tempelho 5902: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5903: background: #888888;
1.779 bisitz 5904: }
1.795 www 5905:
1.777 tempelho 5906: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5907: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5908: background: #F8F866;
1.777 tempelho 5909: }
1.795 www 5910:
1.696 bisitz 5911: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5912: background: #E0E8FF;
1.387 albertel 5913: }
1.696 bisitz 5914:
1.707 bisitz 5915: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5916: /* background: #77FF77; */
1.707 bisitz 5917: }
1.795 www 5918:
1.707 bisitz 5919: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5920: border-right: 8px solid #FFFF77;
1.707 bisitz 5921: }
1.795 www 5922:
1.707 bisitz 5923: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5924: border-right: 8px solid #FFAA77;
1.707 bisitz 5925: }
1.795 www 5926:
1.707 bisitz 5927: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5928: border-right: 8px solid #FF7777;
1.707 bisitz 5929: }
1.795 www 5930:
1.707 bisitz 5931: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5932: border-right: 8px solid #AAFF77;
1.707 bisitz 5933: }
1.795 www 5934:
1.707 bisitz 5935: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5936: border-right: 8px solid #11CC55;
1.707 bisitz 5937: }
5938:
1.388 albertel 5939: span.LC_current_location {
1.701 harmsja 5940: font-size:larger;
1.388 albertel 5941: background: $pgbg;
5942: }
1.387 albertel 5943:
1.1029 www 5944: span.LC_current_nav_location {
5945: font-weight:bold;
5946: background: $sidebg;
5947: }
5948:
1.395 albertel 5949: span.LC_parm_menu_item {
5950: font-size: larger;
5951: }
1.795 www 5952:
1.395 albertel 5953: span.LC_parm_scope_all {
5954: color: red;
5955: }
1.795 www 5956:
1.395 albertel 5957: span.LC_parm_scope_folder {
5958: color: green;
5959: }
1.795 www 5960:
1.395 albertel 5961: span.LC_parm_scope_resource {
5962: color: orange;
5963: }
1.795 www 5964:
1.395 albertel 5965: span.LC_parm_part {
5966: color: blue;
5967: }
1.795 www 5968:
1.911 bisitz 5969: span.LC_parm_folder,
5970: span.LC_parm_symb {
1.395 albertel 5971: font-size: x-small;
5972: font-family: $mono;
5973: color: #AAAAAA;
5974: }
5975:
1.977 bisitz 5976: ul.LC_parm_parmlist li {
5977: display: inline-block;
5978: padding: 0.3em 0.8em;
5979: vertical-align: top;
5980: width: 150px;
5981: border-top:1px solid $lg_border_color;
5982: }
5983:
1.795 www 5984: td.LC_parm_overview_level_menu,
5985: td.LC_parm_overview_map_menu,
5986: td.LC_parm_overview_parm_selectors,
5987: td.LC_parm_overview_restrictions {
1.396 albertel 5988: border: 1px solid black;
5989: border-collapse: collapse;
5990: }
1.795 www 5991:
1.396 albertel 5992: table.LC_parm_overview_restrictions td {
5993: border-width: 1px 4px 1px 4px;
5994: border-style: solid;
5995: border-color: $pgbg;
5996: text-align: center;
5997: }
1.795 www 5998:
1.396 albertel 5999: table.LC_parm_overview_restrictions th {
6000: background: $tabbg;
6001: border-width: 1px 4px 1px 4px;
6002: border-style: solid;
6003: border-color: $pgbg;
6004: }
1.795 www 6005:
1.398 albertel 6006: table#LC_helpmenu {
1.803 bisitz 6007: border: none;
1.398 albertel 6008: height: 55px;
1.803 bisitz 6009: border-spacing: 0;
1.398 albertel 6010: }
6011:
6012: table#LC_helpmenu fieldset legend {
6013: font-size: larger;
6014: }
1.795 www 6015:
1.397 albertel 6016: table#LC_helpmenu_links {
6017: width: 100%;
6018: border: 1px solid black;
6019: background: $pgbg;
1.803 bisitz 6020: padding: 0;
1.397 albertel 6021: border-spacing: 1px;
6022: }
1.795 www 6023:
1.397 albertel 6024: table#LC_helpmenu_links tr td {
6025: padding: 1px;
6026: background: $tabbg;
1.399 albertel 6027: text-align: center;
6028: font-weight: bold;
1.397 albertel 6029: }
1.396 albertel 6030:
1.795 www 6031: table#LC_helpmenu_links a:link,
6032: table#LC_helpmenu_links a:visited,
1.397 albertel 6033: table#LC_helpmenu_links a:active {
6034: text-decoration: none;
6035: color: $font;
6036: }
1.795 www 6037:
1.397 albertel 6038: table#LC_helpmenu_links a:hover {
6039: text-decoration: underline;
6040: color: $vlink;
6041: }
1.396 albertel 6042:
1.417 albertel 6043: .LC_chrt_popup_exists {
6044: border: 1px solid #339933;
6045: margin: -1px;
6046: }
1.795 www 6047:
1.417 albertel 6048: .LC_chrt_popup_up {
6049: border: 1px solid yellow;
6050: margin: -1px;
6051: }
1.795 www 6052:
1.417 albertel 6053: .LC_chrt_popup {
6054: border: 1px solid #8888FF;
6055: background: #CCCCFF;
6056: }
1.795 www 6057:
1.421 albertel 6058: table.LC_pick_box {
6059: border-collapse: separate;
6060: background: white;
6061: border: 1px solid black;
6062: border-spacing: 1px;
6063: }
1.795 www 6064:
1.421 albertel 6065: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6066: background: $sidebg;
1.421 albertel 6067: font-weight: bold;
1.900 bisitz 6068: text-align: left;
1.740 bisitz 6069: vertical-align: top;
1.421 albertel 6070: width: 184px;
6071: padding: 8px;
6072: }
1.795 www 6073:
1.579 raeburn 6074: table.LC_pick_box td.LC_pick_box_value {
6075: text-align: left;
6076: padding: 8px;
6077: }
1.795 www 6078:
1.579 raeburn 6079: table.LC_pick_box td.LC_pick_box_select {
6080: text-align: left;
6081: padding: 8px;
6082: }
1.795 www 6083:
1.424 albertel 6084: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6085: padding: 0;
1.421 albertel 6086: height: 1px;
6087: background: black;
6088: }
1.795 www 6089:
1.421 albertel 6090: table.LC_pick_box td.LC_pick_box_submit {
6091: text-align: right;
6092: }
1.795 www 6093:
1.579 raeburn 6094: table.LC_pick_box td.LC_evenrow_value {
6095: text-align: left;
6096: padding: 8px;
6097: background-color: $data_table_light;
6098: }
1.795 www 6099:
1.579 raeburn 6100: table.LC_pick_box td.LC_oddrow_value {
6101: text-align: left;
6102: padding: 8px;
6103: background-color: $data_table_light;
6104: }
1.795 www 6105:
1.579 raeburn 6106: span.LC_helpform_receipt_cat {
6107: font-weight: bold;
6108: }
1.795 www 6109:
1.424 albertel 6110: table.LC_group_priv_box {
6111: background: white;
6112: border: 1px solid black;
6113: border-spacing: 1px;
6114: }
1.795 www 6115:
1.424 albertel 6116: table.LC_group_priv_box td.LC_pick_box_title {
6117: background: $tabbg;
6118: font-weight: bold;
6119: text-align: right;
6120: width: 184px;
6121: }
1.795 www 6122:
1.424 albertel 6123: table.LC_group_priv_box td.LC_groups_fixed {
6124: background: $data_table_light;
6125: text-align: center;
6126: }
1.795 www 6127:
1.424 albertel 6128: table.LC_group_priv_box td.LC_groups_optional {
6129: background: $data_table_dark;
6130: text-align: center;
6131: }
1.795 www 6132:
1.424 albertel 6133: table.LC_group_priv_box td.LC_groups_functionality {
6134: background: $data_table_darker;
6135: text-align: center;
6136: font-weight: bold;
6137: }
1.795 www 6138:
1.424 albertel 6139: table.LC_group_priv td {
6140: text-align: left;
1.803 bisitz 6141: padding: 0;
1.424 albertel 6142: }
6143:
6144: .LC_navbuttons {
6145: margin: 2ex 0ex 2ex 0ex;
6146: }
1.795 www 6147:
1.423 albertel 6148: .LC_topic_bar {
6149: font-weight: bold;
6150: background: $tabbg;
1.918 wenzelju 6151: margin: 1em 0em 1em 2em;
1.805 bisitz 6152: padding: 3px;
1.918 wenzelju 6153: font-size: 1.2em;
1.423 albertel 6154: }
1.795 www 6155:
1.423 albertel 6156: .LC_topic_bar span {
1.918 wenzelju 6157: left: 0.5em;
6158: position: absolute;
1.423 albertel 6159: vertical-align: middle;
1.918 wenzelju 6160: font-size: 1.2em;
1.423 albertel 6161: }
1.795 www 6162:
1.423 albertel 6163: table.LC_course_group_status {
6164: margin: 20px;
6165: }
1.795 www 6166:
1.423 albertel 6167: table.LC_status_selector td {
6168: vertical-align: top;
6169: text-align: center;
1.424 albertel 6170: padding: 4px;
6171: }
1.795 www 6172:
1.599 albertel 6173: div.LC_feedback_link {
1.616 albertel 6174: clear: both;
1.829 kalberla 6175: background: $sidebg;
1.779 bisitz 6176: width: 100%;
1.829 kalberla 6177: padding-bottom: 10px;
6178: border: 1px $tabbg solid;
1.833 kalberla 6179: height: 22px;
6180: line-height: 22px;
6181: padding-top: 5px;
6182: }
6183:
6184: div.LC_feedback_link img {
6185: height: 22px;
1.867 kalberla 6186: vertical-align:middle;
1.829 kalberla 6187: }
6188:
1.911 bisitz 6189: div.LC_feedback_link a {
1.829 kalberla 6190: text-decoration: none;
1.489 raeburn 6191: }
1.795 www 6192:
1.867 kalberla 6193: div.LC_comblock {
1.911 bisitz 6194: display:inline;
1.867 kalberla 6195: color:$font;
6196: font-size:90%;
6197: }
6198:
6199: div.LC_feedback_link div.LC_comblock {
6200: padding-left:5px;
6201: }
6202:
6203: div.LC_feedback_link div.LC_comblock a {
6204: color:$font;
6205: }
6206:
1.489 raeburn 6207: span.LC_feedback_link {
1.858 bisitz 6208: /* background: $feedback_link_bg; */
1.599 albertel 6209: font-size: larger;
6210: }
1.795 www 6211:
1.599 albertel 6212: span.LC_message_link {
1.858 bisitz 6213: /* background: $feedback_link_bg; */
1.599 albertel 6214: font-size: larger;
6215: position: absolute;
6216: right: 1em;
1.489 raeburn 6217: }
1.421 albertel 6218:
1.515 albertel 6219: table.LC_prior_tries {
1.524 albertel 6220: border: 1px solid #000000;
6221: border-collapse: separate;
6222: border-spacing: 1px;
1.515 albertel 6223: }
1.523 albertel 6224:
1.515 albertel 6225: table.LC_prior_tries td {
1.524 albertel 6226: padding: 2px;
1.515 albertel 6227: }
1.523 albertel 6228:
6229: .LC_answer_correct {
1.795 www 6230: background: lightgreen;
6231: color: darkgreen;
6232: padding: 6px;
1.523 albertel 6233: }
1.795 www 6234:
1.523 albertel 6235: .LC_answer_charged_try {
1.797 www 6236: background: #FFAAAA;
1.795 www 6237: color: darkred;
6238: padding: 6px;
1.523 albertel 6239: }
1.795 www 6240:
1.779 bisitz 6241: .LC_answer_not_charged_try,
1.523 albertel 6242: .LC_answer_no_grade,
6243: .LC_answer_late {
1.795 www 6244: background: lightyellow;
1.523 albertel 6245: color: black;
1.795 www 6246: padding: 6px;
1.523 albertel 6247: }
1.795 www 6248:
1.523 albertel 6249: .LC_answer_previous {
1.795 www 6250: background: lightblue;
6251: color: darkblue;
6252: padding: 6px;
1.523 albertel 6253: }
1.795 www 6254:
1.779 bisitz 6255: .LC_answer_no_message {
1.777 tempelho 6256: background: #FFFFFF;
6257: color: black;
1.795 www 6258: padding: 6px;
1.779 bisitz 6259: }
1.795 www 6260:
1.779 bisitz 6261: .LC_answer_unknown {
6262: background: orange;
6263: color: black;
1.795 www 6264: padding: 6px;
1.777 tempelho 6265: }
1.795 www 6266:
1.529 albertel 6267: span.LC_prior_numerical,
6268: span.LC_prior_string,
6269: span.LC_prior_custom,
6270: span.LC_prior_reaction,
6271: span.LC_prior_math {
1.925 bisitz 6272: font-family: $mono;
1.523 albertel 6273: white-space: pre;
6274: }
6275:
1.525 albertel 6276: span.LC_prior_string {
1.925 bisitz 6277: font-family: $mono;
1.525 albertel 6278: white-space: pre;
6279: }
6280:
1.523 albertel 6281: table.LC_prior_option {
6282: width: 100%;
6283: border-collapse: collapse;
6284: }
1.795 www 6285:
1.911 bisitz 6286: table.LC_prior_rank,
1.795 www 6287: table.LC_prior_match {
1.528 albertel 6288: border-collapse: collapse;
6289: }
1.795 www 6290:
1.528 albertel 6291: table.LC_prior_option tr td,
6292: table.LC_prior_rank tr td,
6293: table.LC_prior_match tr td {
1.524 albertel 6294: border: 1px solid #000000;
1.515 albertel 6295: }
6296:
1.855 bisitz 6297: .LC_nobreak {
1.544 albertel 6298: white-space: nowrap;
1.519 raeburn 6299: }
6300:
1.576 raeburn 6301: span.LC_cusr_emph {
6302: font-style: italic;
6303: }
6304:
1.633 raeburn 6305: span.LC_cusr_subheading {
6306: font-weight: normal;
6307: font-size: 85%;
6308: }
6309:
1.861 bisitz 6310: div.LC_docs_entry_move {
1.859 bisitz 6311: border: 1px solid #BBBBBB;
1.545 albertel 6312: background: #DDDDDD;
1.861 bisitz 6313: width: 22px;
1.859 bisitz 6314: padding: 1px;
6315: margin: 0;
1.545 albertel 6316: }
6317:
1.861 bisitz 6318: table.LC_data_table tr > td.LC_docs_entry_commands,
6319: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6320: font-size: x-small;
6321: }
1.795 www 6322:
1.861 bisitz 6323: .LC_docs_entry_parameter {
6324: white-space: nowrap;
6325: }
6326:
1.544 albertel 6327: .LC_docs_copy {
1.545 albertel 6328: color: #000099;
1.544 albertel 6329: }
1.795 www 6330:
1.544 albertel 6331: .LC_docs_cut {
1.545 albertel 6332: color: #550044;
1.544 albertel 6333: }
1.795 www 6334:
1.544 albertel 6335: .LC_docs_rename {
1.545 albertel 6336: color: #009900;
1.544 albertel 6337: }
1.795 www 6338:
1.544 albertel 6339: .LC_docs_remove {
1.545 albertel 6340: color: #990000;
6341: }
6342:
1.547 albertel 6343: .LC_docs_reinit_warn,
6344: .LC_docs_ext_edit {
6345: font-size: x-small;
6346: }
6347:
1.545 albertel 6348: table.LC_docs_adddocs td,
6349: table.LC_docs_adddocs th {
6350: border: 1px solid #BBBBBB;
6351: padding: 4px;
6352: background: #DDDDDD;
1.543 albertel 6353: }
6354:
1.584 albertel 6355: table.LC_sty_begin {
6356: background: #BBFFBB;
6357: }
1.795 www 6358:
1.584 albertel 6359: table.LC_sty_end {
6360: background: #FFBBBB;
6361: }
6362:
1.589 raeburn 6363: table.LC_double_column {
1.803 bisitz 6364: border-width: 0;
1.589 raeburn 6365: border-collapse: collapse;
6366: width: 100%;
6367: padding: 2px;
6368: }
6369:
6370: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6371: top: 2px;
1.589 raeburn 6372: left: 2px;
6373: width: 47%;
6374: vertical-align: top;
6375: }
6376:
6377: table.LC_double_column tr td.LC_right_col {
6378: top: 2px;
1.779 bisitz 6379: right: 2px;
1.589 raeburn 6380: width: 47%;
6381: vertical-align: top;
6382: }
6383:
1.591 raeburn 6384: div.LC_left_float {
6385: float: left;
6386: padding-right: 5%;
1.597 albertel 6387: padding-bottom: 4px;
1.591 raeburn 6388: }
6389:
6390: div.LC_clear_float_header {
1.597 albertel 6391: padding-bottom: 2px;
1.591 raeburn 6392: }
6393:
6394: div.LC_clear_float_footer {
1.597 albertel 6395: padding-top: 10px;
1.591 raeburn 6396: clear: both;
6397: }
6398:
1.597 albertel 6399: div.LC_grade_show_user {
1.941 bisitz 6400: /* border-left: 5px solid $sidebg; */
6401: border-top: 5px solid #000000;
6402: margin: 50px 0 0 0;
1.936 bisitz 6403: padding: 15px 0 5px 10px;
1.597 albertel 6404: }
1.795 www 6405:
1.936 bisitz 6406: div.LC_grade_show_user_odd_row {
1.941 bisitz 6407: /* border-left: 5px solid #000000; */
6408: }
6409:
6410: div.LC_grade_show_user div.LC_Box {
6411: margin-right: 50px;
1.597 albertel 6412: }
6413:
6414: div.LC_grade_submissions,
6415: div.LC_grade_message_center,
1.936 bisitz 6416: div.LC_grade_info_links {
1.597 albertel 6417: margin: 5px;
6418: width: 99%;
6419: background: #FFFFFF;
6420: }
1.795 www 6421:
1.597 albertel 6422: div.LC_grade_submissions_header,
1.936 bisitz 6423: div.LC_grade_message_center_header {
1.705 tempelho 6424: font-weight: bold;
6425: font-size: large;
1.597 albertel 6426: }
1.795 www 6427:
1.597 albertel 6428: div.LC_grade_submissions_body,
1.936 bisitz 6429: div.LC_grade_message_center_body {
1.597 albertel 6430: border: 1px solid black;
6431: width: 99%;
6432: background: #FFFFFF;
6433: }
1.795 www 6434:
1.613 albertel 6435: table.LC_scantron_action {
6436: width: 100%;
6437: }
1.795 www 6438:
1.613 albertel 6439: table.LC_scantron_action tr th {
1.698 harmsja 6440: font-weight:bold;
6441: font-style:normal;
1.613 albertel 6442: }
1.795 www 6443:
1.779 bisitz 6444: .LC_edit_problem_header,
1.614 albertel 6445: div.LC_edit_problem_footer {
1.705 tempelho 6446: font-weight: normal;
6447: font-size: medium;
1.602 albertel 6448: margin: 2px;
1.1060 bisitz 6449: background-color: $sidebg;
1.600 albertel 6450: }
1.795 www 6451:
1.600 albertel 6452: div.LC_edit_problem_header,
1.602 albertel 6453: div.LC_edit_problem_header div,
1.614 albertel 6454: div.LC_edit_problem_footer,
6455: div.LC_edit_problem_footer div,
1.602 albertel 6456: div.LC_edit_problem_editxml_header,
6457: div.LC_edit_problem_editxml_header div {
1.600 albertel 6458: margin-top: 5px;
6459: }
1.795 www 6460:
1.600 albertel 6461: div.LC_edit_problem_header_title {
1.705 tempelho 6462: font-weight: bold;
6463: font-size: larger;
1.602 albertel 6464: background: $tabbg;
6465: padding: 3px;
1.1060 bisitz 6466: margin: 0 0 5px 0;
1.602 albertel 6467: }
1.795 www 6468:
1.602 albertel 6469: table.LC_edit_problem_header_title {
6470: width: 100%;
1.600 albertel 6471: background: $tabbg;
1.602 albertel 6472: }
6473:
6474: div.LC_edit_problem_discards {
6475: float: left;
6476: padding-bottom: 5px;
6477: }
1.795 www 6478:
1.602 albertel 6479: div.LC_edit_problem_saves {
6480: float: right;
6481: padding-bottom: 5px;
1.600 albertel 6482: }
1.795 www 6483:
1.1124 bisitz 6484: .LC_edit_opt {
6485: padding-left: 1em;
6486: white-space: nowrap;
6487: }
6488:
1.911 bisitz 6489: img.stift {
1.803 bisitz 6490: border-width: 0;
6491: vertical-align: middle;
1.677 riegler 6492: }
1.680 riegler 6493:
1.923 bisitz 6494: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6495: vertical-align: top;
1.777 tempelho 6496: }
1.795 www 6497:
1.716 raeburn 6498: div.LC_createcourse {
1.911 bisitz 6499: margin: 10px 10px 10px 10px;
1.716 raeburn 6500: }
6501:
1.917 raeburn 6502: .LC_dccid {
1.1130 raeburn 6503: float: right;
1.917 raeburn 6504: margin: 0.2em 0 0 0;
6505: padding: 0;
6506: font-size: 90%;
6507: display:none;
6508: }
6509:
1.897 wenzelju 6510: ol.LC_primary_menu a:hover,
1.721 harmsja 6511: ol#LC_MenuBreadcrumbs a:hover,
6512: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6513: ul#LC_secondary_menu a:hover,
1.721 harmsja 6514: .LC_FormSectionClearButton input:hover
1.795 www 6515: ul.LC_TabContent li:hover a {
1.952 onken 6516: color:$button_hover;
1.911 bisitz 6517: text-decoration:none;
1.693 droeschl 6518: }
6519:
1.779 bisitz 6520: h1 {
1.911 bisitz 6521: padding: 0;
6522: line-height:130%;
1.693 droeschl 6523: }
1.698 harmsja 6524:
1.911 bisitz 6525: h2,
6526: h3,
6527: h4,
6528: h5,
6529: h6 {
6530: margin: 5px 0 5px 0;
6531: padding: 0;
6532: line-height:130%;
1.693 droeschl 6533: }
1.795 www 6534:
6535: .LC_hcell {
1.911 bisitz 6536: padding:3px 15px 3px 15px;
6537: margin: 0;
6538: background-color:$tabbg;
6539: color:$fontmenu;
6540: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6541: }
1.795 www 6542:
1.840 bisitz 6543: .LC_Box > .LC_hcell {
1.911 bisitz 6544: margin: 0 -10px 10px -10px;
1.835 bisitz 6545: }
6546:
1.721 harmsja 6547: .LC_noBorder {
1.911 bisitz 6548: border: 0;
1.698 harmsja 6549: }
1.693 droeschl 6550:
1.721 harmsja 6551: .LC_FormSectionClearButton input {
1.911 bisitz 6552: background-color:transparent;
6553: border: none;
6554: cursor:pointer;
6555: text-decoration:underline;
1.693 droeschl 6556: }
1.763 bisitz 6557:
6558: .LC_help_open_topic {
1.911 bisitz 6559: color: #FFFFFF;
6560: background-color: #EEEEFF;
6561: margin: 1px;
6562: padding: 4px;
6563: border: 1px solid #000033;
6564: white-space: nowrap;
6565: /* vertical-align: middle; */
1.759 neumanie 6566: }
1.693 droeschl 6567:
1.911 bisitz 6568: dl,
6569: ul,
6570: div,
6571: fieldset {
6572: margin: 10px 10px 10px 0;
6573: /* overflow: hidden; */
1.693 droeschl 6574: }
1.795 www 6575:
1.838 bisitz 6576: fieldset > legend {
1.911 bisitz 6577: font-weight: bold;
6578: padding: 0 5px 0 5px;
1.838 bisitz 6579: }
6580:
1.813 bisitz 6581: #LC_nav_bar {
1.911 bisitz 6582: float: left;
1.995 raeburn 6583: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6584: margin: 0 0 2px 0;
1.807 droeschl 6585: }
6586:
1.916 droeschl 6587: #LC_realm {
6588: margin: 0.2em 0 0 0;
6589: padding: 0;
6590: font-weight: bold;
6591: text-align: center;
1.995 raeburn 6592: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6593: }
6594:
1.911 bisitz 6595: #LC_nav_bar em {
6596: font-weight: bold;
6597: font-style: normal;
1.807 droeschl 6598: }
6599:
1.897 wenzelju 6600: ol.LC_primary_menu {
1.934 droeschl 6601: margin: 0;
1.1076 raeburn 6602: padding: 0;
1.995 raeburn 6603: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6604: }
6605:
1.852 droeschl 6606: ol#LC_PathBreadcrumbs {
1.911 bisitz 6607: margin: 0;
1.693 droeschl 6608: }
6609:
1.897 wenzelju 6610: ol.LC_primary_menu li {
1.1076 raeburn 6611: color: RGB(80, 80, 80);
6612: vertical-align: middle;
6613: text-align: left;
6614: list-style: none;
6615: float: left;
6616: }
6617:
6618: ol.LC_primary_menu li a {
6619: display: block;
6620: margin: 0;
6621: padding: 0 5px 0 10px;
6622: text-decoration: none;
6623: }
6624:
6625: ol.LC_primary_menu li ul {
6626: display: none;
6627: width: 10em;
6628: background-color: $data_table_light;
6629: }
6630:
6631: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6632: display: block;
6633: position: absolute;
6634: margin: 0;
6635: padding: 0;
1.1078 raeburn 6636: z-index: 2;
1.1076 raeburn 6637: }
6638:
6639: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6640: font-size: 90%;
1.911 bisitz 6641: vertical-align: top;
1.1076 raeburn 6642: float: none;
1.1079 raeburn 6643: border-left: 1px solid black;
6644: border-right: 1px solid black;
1.1076 raeburn 6645: }
6646:
6647: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6648: background-color:$data_table_light;
1.1076 raeburn 6649: }
6650:
6651: ol.LC_primary_menu li li a:hover {
6652: color:$button_hover;
6653: background-color:$data_table_dark;
1.693 droeschl 6654: }
6655:
1.897 wenzelju 6656: ol.LC_primary_menu li img {
1.911 bisitz 6657: vertical-align: bottom;
1.934 droeschl 6658: height: 1.1em;
1.1077 raeburn 6659: margin: 0.2em 0 0 0;
1.693 droeschl 6660: }
6661:
1.897 wenzelju 6662: ol.LC_primary_menu a {
1.911 bisitz 6663: color: RGB(80, 80, 80);
6664: text-decoration: none;
1.693 droeschl 6665: }
1.795 www 6666:
1.949 droeschl 6667: ol.LC_primary_menu a.LC_new_message {
6668: font-weight:bold;
6669: color: darkred;
6670: }
6671:
1.975 raeburn 6672: ol.LC_docs_parameters {
6673: margin-left: 0;
6674: padding: 0;
6675: list-style: none;
6676: }
6677:
6678: ol.LC_docs_parameters li {
6679: margin: 0;
6680: padding-right: 20px;
6681: display: inline;
6682: }
6683:
1.976 raeburn 6684: ol.LC_docs_parameters li:before {
6685: content: "\\002022 \\0020";
6686: }
6687:
6688: li.LC_docs_parameters_title {
6689: font-weight: bold;
6690: }
6691:
6692: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6693: content: "";
6694: }
6695:
1.897 wenzelju 6696: ul#LC_secondary_menu {
1.1107 raeburn 6697: clear: right;
1.911 bisitz 6698: color: $fontmenu;
6699: background: $tabbg;
6700: list-style: none;
6701: padding: 0;
6702: margin: 0;
6703: width: 100%;
1.995 raeburn 6704: text-align: left;
1.1107 raeburn 6705: float: left;
1.808 droeschl 6706: }
6707:
1.897 wenzelju 6708: ul#LC_secondary_menu li {
1.911 bisitz 6709: font-weight: bold;
6710: line-height: 1.8em;
1.1107 raeburn 6711: border-right: 1px solid black;
6712: float: left;
6713: }
6714:
6715: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
6716: background-color: $data_table_light;
6717: }
6718:
6719: ul#LC_secondary_menu li a {
1.911 bisitz 6720: padding: 0 0.8em;
1.1107 raeburn 6721: }
6722:
6723: ul#LC_secondary_menu li ul {
6724: display: none;
6725: }
6726:
6727: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
6728: display: block;
6729: position: absolute;
6730: margin: 0;
6731: padding: 0;
6732: list-style:none;
6733: float: none;
6734: background-color: $data_table_light;
6735: z-index: 2;
6736: margin-left: -1px;
6737: }
6738:
6739: ul#LC_secondary_menu li ul li {
6740: font-size: 90%;
6741: vertical-align: top;
6742: border-left: 1px solid black;
1.911 bisitz 6743: border-right: 1px solid black;
1.1119 raeburn 6744: background-color: $data_table_light;
1.1107 raeburn 6745: list-style:none;
6746: float: none;
6747: }
6748:
6749: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
6750: background-color: $data_table_dark;
1.807 droeschl 6751: }
6752:
1.847 tempelho 6753: ul.LC_TabContent {
1.911 bisitz 6754: display:block;
6755: background: $sidebg;
6756: border-bottom: solid 1px $lg_border_color;
6757: list-style:none;
1.1020 raeburn 6758: margin: -1px -10px 0 -10px;
1.911 bisitz 6759: padding: 0;
1.693 droeschl 6760: }
6761:
1.795 www 6762: ul.LC_TabContent li,
6763: ul.LC_TabContentBigger li {
1.911 bisitz 6764: float:left;
1.741 harmsja 6765: }
1.795 www 6766:
1.897 wenzelju 6767: ul#LC_secondary_menu li a {
1.911 bisitz 6768: color: $fontmenu;
6769: text-decoration: none;
1.693 droeschl 6770: }
1.795 www 6771:
1.721 harmsja 6772: ul.LC_TabContent {
1.952 onken 6773: min-height:20px;
1.721 harmsja 6774: }
1.795 www 6775:
6776: ul.LC_TabContent li {
1.911 bisitz 6777: vertical-align:middle;
1.959 onken 6778: padding: 0 16px 0 10px;
1.911 bisitz 6779: background-color:$tabbg;
6780: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6781: border-left: solid 1px $font;
1.721 harmsja 6782: }
1.795 www 6783:
1.847 tempelho 6784: ul.LC_TabContent .right {
1.911 bisitz 6785: float:right;
1.847 tempelho 6786: }
6787:
1.911 bisitz 6788: ul.LC_TabContent li a,
6789: ul.LC_TabContent li {
6790: color:rgb(47,47,47);
6791: text-decoration:none;
6792: font-size:95%;
6793: font-weight:bold;
1.952 onken 6794: min-height:20px;
6795: }
6796:
1.959 onken 6797: ul.LC_TabContent li a:hover,
6798: ul.LC_TabContent li a:focus {
1.952 onken 6799: color: $button_hover;
1.959 onken 6800: background:none;
6801: outline:none;
1.952 onken 6802: }
6803:
6804: ul.LC_TabContent li:hover {
6805: color: $button_hover;
6806: cursor:pointer;
1.721 harmsja 6807: }
1.795 www 6808:
1.911 bisitz 6809: ul.LC_TabContent li.active {
1.952 onken 6810: color: $font;
1.911 bisitz 6811: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6812: border-bottom:solid 1px #FFFFFF;
6813: cursor: default;
1.744 ehlerst 6814: }
1.795 www 6815:
1.959 onken 6816: ul.LC_TabContent li.active a {
6817: color:$font;
6818: background:#FFFFFF;
6819: outline: none;
6820: }
1.1047 raeburn 6821:
6822: ul.LC_TabContent li.goback {
6823: float: left;
6824: border-left: none;
6825: }
6826:
1.870 tempelho 6827: #maincoursedoc {
1.911 bisitz 6828: clear:both;
1.870 tempelho 6829: }
6830:
6831: ul.LC_TabContentBigger {
1.911 bisitz 6832: display:block;
6833: list-style:none;
6834: padding: 0;
1.870 tempelho 6835: }
6836:
1.795 www 6837: ul.LC_TabContentBigger li {
1.911 bisitz 6838: vertical-align:bottom;
6839: height: 30px;
6840: font-size:110%;
6841: font-weight:bold;
6842: color: #737373;
1.841 tempelho 6843: }
6844:
1.957 onken 6845: ul.LC_TabContentBigger li.active {
6846: position: relative;
6847: top: 1px;
6848: }
6849:
1.870 tempelho 6850: ul.LC_TabContentBigger li a {
1.911 bisitz 6851: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6852: height: 30px;
6853: line-height: 30px;
6854: text-align: center;
6855: display: block;
6856: text-decoration: none;
1.958 onken 6857: outline: none;
1.741 harmsja 6858: }
1.795 www 6859:
1.870 tempelho 6860: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6861: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6862: color:$font;
1.744 ehlerst 6863: }
1.795 www 6864:
1.870 tempelho 6865: ul.LC_TabContentBigger li b {
1.911 bisitz 6866: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6867: display: block;
6868: float: left;
6869: padding: 0 30px;
1.957 onken 6870: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6871: }
6872:
1.956 onken 6873: ul.LC_TabContentBigger li:hover b {
6874: color:$button_hover;
6875: }
6876:
1.870 tempelho 6877: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6878: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6879: color:$font;
1.957 onken 6880: border: 0;
1.741 harmsja 6881: }
1.693 droeschl 6882:
1.870 tempelho 6883:
1.862 bisitz 6884: ul.LC_CourseBreadcrumbs {
6885: background: $sidebg;
1.1020 raeburn 6886: height: 2em;
1.862 bisitz 6887: padding-left: 10px;
1.1020 raeburn 6888: margin: 0;
1.862 bisitz 6889: list-style-position: inside;
6890: }
6891:
1.911 bisitz 6892: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6893: ol#LC_PathBreadcrumbs {
1.911 bisitz 6894: padding-left: 10px;
6895: margin: 0;
1.933 droeschl 6896: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6897: }
6898:
1.911 bisitz 6899: ol#LC_MenuBreadcrumbs li,
6900: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6901: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6902: display: inline;
1.933 droeschl 6903: white-space: normal;
1.693 droeschl 6904: }
6905:
1.823 bisitz 6906: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6907: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6908: text-decoration: none;
6909: font-size:90%;
1.693 droeschl 6910: }
1.795 www 6911:
1.969 droeschl 6912: ol#LC_MenuBreadcrumbs h1 {
6913: display: inline;
6914: font-size: 90%;
6915: line-height: 2.5em;
6916: margin: 0;
6917: padding: 0;
6918: }
6919:
1.795 www 6920: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6921: text-decoration:none;
6922: font-size:100%;
6923: font-weight:bold;
1.693 droeschl 6924: }
1.795 www 6925:
1.840 bisitz 6926: .LC_Box {
1.911 bisitz 6927: border: solid 1px $lg_border_color;
6928: padding: 0 10px 10px 10px;
1.746 neumanie 6929: }
1.795 www 6930:
1.1020 raeburn 6931: .LC_DocsBox {
6932: border: solid 1px $lg_border_color;
6933: padding: 0 0 10px 10px;
6934: }
6935:
1.795 www 6936: .LC_AboutMe_Image {
1.911 bisitz 6937: float:left;
6938: margin-right:10px;
1.747 neumanie 6939: }
1.795 www 6940:
6941: .LC_Clear_AboutMe_Image {
1.911 bisitz 6942: clear:left;
1.747 neumanie 6943: }
1.795 www 6944:
1.721 harmsja 6945: dl.LC_ListStyleClean dt {
1.911 bisitz 6946: padding-right: 5px;
6947: display: table-header-group;
1.693 droeschl 6948: }
6949:
1.721 harmsja 6950: dl.LC_ListStyleClean dd {
1.911 bisitz 6951: display: table-row;
1.693 droeschl 6952: }
6953:
1.721 harmsja 6954: .LC_ListStyleClean,
6955: .LC_ListStyleSimple,
6956: .LC_ListStyleNormal,
1.795 www 6957: .LC_ListStyleSpecial {
1.911 bisitz 6958: /* display:block; */
6959: list-style-position: inside;
6960: list-style-type: none;
6961: overflow: hidden;
6962: padding: 0;
1.693 droeschl 6963: }
6964:
1.721 harmsja 6965: .LC_ListStyleSimple li,
6966: .LC_ListStyleSimple dd,
6967: .LC_ListStyleNormal li,
6968: .LC_ListStyleNormal dd,
6969: .LC_ListStyleSpecial li,
1.795 www 6970: .LC_ListStyleSpecial dd {
1.911 bisitz 6971: margin: 0;
6972: padding: 5px 5px 5px 10px;
6973: clear: both;
1.693 droeschl 6974: }
6975:
1.721 harmsja 6976: .LC_ListStyleClean li,
6977: .LC_ListStyleClean dd {
1.911 bisitz 6978: padding-top: 0;
6979: padding-bottom: 0;
1.693 droeschl 6980: }
6981:
1.721 harmsja 6982: .LC_ListStyleSimple dd,
1.795 www 6983: .LC_ListStyleSimple li {
1.911 bisitz 6984: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6985: }
6986:
1.721 harmsja 6987: .LC_ListStyleSpecial li,
6988: .LC_ListStyleSpecial dd {
1.911 bisitz 6989: list-style-type: none;
6990: background-color: RGB(220, 220, 220);
6991: margin-bottom: 4px;
1.693 droeschl 6992: }
6993:
1.721 harmsja 6994: table.LC_SimpleTable {
1.911 bisitz 6995: margin:5px;
6996: border:solid 1px $lg_border_color;
1.795 www 6997: }
1.693 droeschl 6998:
1.721 harmsja 6999: table.LC_SimpleTable tr {
1.911 bisitz 7000: padding: 0;
7001: border:solid 1px $lg_border_color;
1.693 droeschl 7002: }
1.795 www 7003:
7004: table.LC_SimpleTable thead {
1.911 bisitz 7005: background:rgb(220,220,220);
1.693 droeschl 7006: }
7007:
1.721 harmsja 7008: div.LC_columnSection {
1.911 bisitz 7009: display: block;
7010: clear: both;
7011: overflow: hidden;
7012: margin: 0;
1.693 droeschl 7013: }
7014:
1.721 harmsja 7015: div.LC_columnSection>* {
1.911 bisitz 7016: float: left;
7017: margin: 10px 20px 10px 0;
7018: overflow:hidden;
1.693 droeschl 7019: }
1.721 harmsja 7020:
1.795 www 7021: table em {
1.911 bisitz 7022: font-weight: bold;
7023: font-style: normal;
1.748 schulted 7024: }
1.795 www 7025:
1.779 bisitz 7026: table.LC_tableBrowseRes,
1.795 www 7027: table.LC_tableOfContent {
1.911 bisitz 7028: border:none;
7029: border-spacing: 1px;
7030: padding: 3px;
7031: background-color: #FFFFFF;
7032: font-size: 90%;
1.753 droeschl 7033: }
1.789 droeschl 7034:
1.911 bisitz 7035: table.LC_tableOfContent {
7036: border-collapse: collapse;
1.789 droeschl 7037: }
7038:
1.771 droeschl 7039: table.LC_tableBrowseRes a,
1.768 schulted 7040: table.LC_tableOfContent a {
1.911 bisitz 7041: background-color: transparent;
7042: text-decoration: none;
1.753 droeschl 7043: }
7044:
1.795 www 7045: table.LC_tableOfContent img {
1.911 bisitz 7046: border: none;
7047: height: 1.3em;
7048: vertical-align: text-bottom;
7049: margin-right: 0.3em;
1.753 droeschl 7050: }
1.757 schulted 7051:
1.795 www 7052: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7053: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7054: }
7055:
1.795 www 7056: a#LC_content_toolbar_everything {
1.911 bisitz 7057: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7058: }
7059:
1.795 www 7060: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7061: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7062: }
7063:
1.795 www 7064: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7065: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7066: }
7067:
1.795 www 7068: a#LC_content_toolbar_changefolder {
1.911 bisitz 7069: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7070: }
7071:
1.795 www 7072: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7073: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7074: }
7075:
1.1043 raeburn 7076: a#LC_content_toolbar_edittoplevel {
7077: background-image:url(/res/adm/pages/edittoplevel.gif);
7078: }
7079:
1.795 www 7080: ul#LC_toolbar li a:hover {
1.911 bisitz 7081: background-position: bottom center;
1.757 schulted 7082: }
7083:
1.795 www 7084: ul#LC_toolbar {
1.911 bisitz 7085: padding: 0;
7086: margin: 2px;
7087: list-style:none;
7088: position:relative;
7089: background-color:white;
1.1082 raeburn 7090: overflow: auto;
1.757 schulted 7091: }
7092:
1.795 www 7093: ul#LC_toolbar li {
1.911 bisitz 7094: border:1px solid white;
7095: padding: 0;
7096: margin: 0;
7097: float: left;
7098: display:inline;
7099: vertical-align:middle;
1.1082 raeburn 7100: white-space: nowrap;
1.911 bisitz 7101: }
1.757 schulted 7102:
1.783 amueller 7103:
1.795 www 7104: a.LC_toolbarItem {
1.911 bisitz 7105: display:block;
7106: padding: 0;
7107: margin: 0;
7108: height: 32px;
7109: width: 32px;
7110: color:white;
7111: border: none;
7112: background-repeat:no-repeat;
7113: background-color:transparent;
1.757 schulted 7114: }
7115:
1.915 droeschl 7116: ul.LC_funclist {
7117: margin: 0;
7118: padding: 0.5em 1em 0.5em 0;
7119: }
7120:
1.933 droeschl 7121: ul.LC_funclist > li:first-child {
7122: font-weight:bold;
7123: margin-left:0.8em;
7124: }
7125:
1.915 droeschl 7126: ul.LC_funclist + ul.LC_funclist {
7127: /*
7128: left border as a seperator if we have more than
7129: one list
7130: */
7131: border-left: 1px solid $sidebg;
7132: /*
7133: this hides the left border behind the border of the
7134: outer box if element is wrapped to the next 'line'
7135: */
7136: margin-left: -1px;
7137: }
7138:
1.843 bisitz 7139: ul.LC_funclist li {
1.915 droeschl 7140: display: inline;
1.782 bisitz 7141: white-space: nowrap;
1.915 droeschl 7142: margin: 0 0 0 25px;
7143: line-height: 150%;
1.782 bisitz 7144: }
7145:
1.974 wenzelju 7146: .LC_hidden {
7147: display: none;
7148: }
7149:
1.1030 www 7150: .LCmodal-overlay {
7151: position:fixed;
7152: top:0;
7153: right:0;
7154: bottom:0;
7155: left:0;
7156: height:100%;
7157: width:100%;
7158: margin:0;
7159: padding:0;
7160: background:#999;
7161: opacity:.75;
7162: filter: alpha(opacity=75);
7163: -moz-opacity: 0.75;
7164: z-index:101;
7165: }
7166:
7167: * html .LCmodal-overlay {
7168: position: absolute;
7169: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7170: }
7171:
7172: .LCmodal-window {
7173: position:fixed;
7174: top:50%;
7175: left:50%;
7176: margin:0;
7177: padding:0;
7178: z-index:102;
7179: }
7180:
7181: * html .LCmodal-window {
7182: position:absolute;
7183: }
7184:
7185: .LCclose-window {
7186: position:absolute;
7187: width:32px;
7188: height:32px;
7189: right:8px;
7190: top:8px;
7191: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7192: text-indent:-99999px;
7193: overflow:hidden;
7194: cursor:pointer;
7195: }
7196:
1.1100 raeburn 7197: /*
7198: styles used by TTH when "Default set of options to pass to tth/m
7199: when converting TeX" in course settings has been set
7200:
7201: option passed: -t
7202:
7203: */
7204:
7205: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7206: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7207: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7208: td div.norm {line-height:normal;}
7209:
7210: /*
7211: option passed -y3
7212: */
7213:
7214: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7215: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7216: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7217:
1.343 albertel 7218: END
7219: }
7220:
1.306 albertel 7221: =pod
7222:
7223: =item * &headtag()
7224:
7225: Returns a uniform footer for LON-CAPA web pages.
7226:
1.307 albertel 7227: Inputs: $title - optional title for the head
7228: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7229: $args - optional arguments
1.319 albertel 7230: force_register - if is true call registerurl so the remote is
7231: informed
1.415 albertel 7232: redirect -> array ref of
7233: 1- seconds before redirect occurs
7234: 2- url to redirect to
7235: 3- whether the side effect should occur
1.315 albertel 7236: (side effect of setting
7237: $env{'internal.head.redirect'} to the url
7238: redirected too)
1.352 albertel 7239: domain -> force to color decorate a page for a specific
7240: domain
7241: function -> force usage of a specific rolish color scheme
7242: bgcolor -> override the default page bgcolor
1.460 albertel 7243: no_auto_mt_title
7244: -> prevent &mt()ing the title arg
1.464 albertel 7245:
1.306 albertel 7246: =cut
7247:
7248: sub headtag {
1.313 albertel 7249: my ($title,$head_extra,$args) = @_;
1.306 albertel 7250:
1.363 albertel 7251: my $function = $args->{'function'} || &get_users_function();
7252: my $domain = $args->{'domain'} || &determinedomain();
7253: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7254: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7255: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7256: #time(),
1.418 albertel 7257: $env{'environment.color.timestamp'},
1.363 albertel 7258: $function,$domain,$bgcolor);
7259:
1.369 www 7260: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7261:
1.308 albertel 7262: my $result =
7263: '<head>'.
1.461 albertel 7264: &font_settings();
1.319 albertel 7265:
1.1064 raeburn 7266: my $inhibitprint = &print_suppression();
7267:
1.461 albertel 7268: if (!$args->{'frameset'}) {
7269: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7270: }
1.962 droeschl 7271: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7272: $result .= Apache::lonxml::display_title();
1.319 albertel 7273: }
1.436 albertel 7274: if (!$args->{'no_nav_bar'}
7275: && !$args->{'only_body'}
7276: && !$args->{'frameset'}) {
7277: $result .= &help_menu_js();
1.1032 www 7278: $result.=&modal_window();
1.1038 www 7279: $result.=&togglebox_script();
1.1034 www 7280: $result.=&wishlist_window();
1.1041 www 7281: $result.=&LCprogressbarUpdate_script();
1.1034 www 7282: } else {
7283: if ($args->{'add_modal'}) {
7284: $result.=&modal_window();
7285: }
7286: if ($args->{'add_wishlist'}) {
7287: $result.=&wishlist_window();
7288: }
1.1038 www 7289: if ($args->{'add_togglebox'}) {
7290: $result.=&togglebox_script();
7291: }
1.1041 www 7292: if ($args->{'add_progressbar'}) {
7293: $result.=&LCprogressbarUpdate_script();
7294: }
1.436 albertel 7295: }
1.314 albertel 7296: if (ref($args->{'redirect'})) {
1.414 albertel 7297: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7298: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7299: if (!$inhibit_continue) {
7300: $env{'internal.head.redirect'} = $url;
7301: }
1.313 albertel 7302: $result.=<<ADDMETA
7303: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7304: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7305: ADDMETA
7306: }
1.306 albertel 7307: if (!defined($title)) {
7308: $title = 'The LearningOnline Network with CAPA';
7309: }
1.460 albertel 7310: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7311: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7312: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7313: .$inhibitprint
1.414 albertel 7314: .$head_extra;
1.962 droeschl 7315: return $result.'</head>';
1.306 albertel 7316: }
7317:
7318: =pod
7319:
1.340 albertel 7320: =item * &font_settings()
7321:
7322: Returns neccessary <meta> to set the proper encoding
7323:
7324: Inputs: none
7325:
7326: =cut
7327:
7328: sub font_settings {
7329: my $headerstring='';
1.647 www 7330: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7331: $headerstring.=
7332: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7333: }
7334: return $headerstring;
7335: }
7336:
1.341 albertel 7337: =pod
7338:
1.1064 raeburn 7339: =item * &print_suppression()
7340:
7341: In course context returns css which causes the body to be blank when media="print",
7342: if printout generation is unavailable for the current resource.
7343:
7344: This could be because:
7345:
7346: (a) printstartdate is in the future
7347:
7348: (b) printenddate is in the past
7349:
7350: (c) there is an active exam block with "printout"
7351: functionality blocked
7352:
7353: Users with pav, pfo or evb privileges are exempt.
7354:
7355: Inputs: none
7356:
7357: =cut
7358:
7359:
7360: sub print_suppression {
7361: my $noprint;
7362: if ($env{'request.course.id'}) {
7363: my $scope = $env{'request.course.id'};
7364: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7365: (&Apache::lonnet::allowed('pfo',$scope))) {
7366: return;
7367: }
7368: if ($env{'request.course.sec'} ne '') {
7369: $scope .= "/$env{'request.course.sec'}";
7370: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7371: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7372: return;
1.1064 raeburn 7373: }
7374: }
7375: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7376: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7377: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7378: if ($blocked) {
7379: my $checkrole = "cm./$cdom/$cnum";
7380: if ($env{'request.course.sec'} ne '') {
7381: $checkrole .= "/$env{'request.course.sec'}";
7382: }
7383: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7384: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7385: $noprint = 1;
7386: }
7387: }
7388: unless ($noprint) {
7389: my $symb = &Apache::lonnet::symbread();
7390: if ($symb ne '') {
7391: my $navmap = Apache::lonnavmaps::navmap->new();
7392: if (ref($navmap)) {
7393: my $res = $navmap->getBySymb($symb);
7394: if (ref($res)) {
7395: if (!$res->resprintable()) {
7396: $noprint = 1;
7397: }
7398: }
7399: }
7400: }
7401: }
7402: if ($noprint) {
7403: return <<"ENDSTYLE";
7404: <style type="text/css" media="print">
7405: body { display:none }
7406: </style>
7407: ENDSTYLE
7408: }
7409: }
7410: return;
7411: }
7412:
7413: =pod
7414:
1.341 albertel 7415: =item * &xml_begin()
7416:
7417: Returns the needed doctype and <html>
7418:
7419: Inputs: none
7420:
7421: =cut
7422:
7423: sub xml_begin {
7424: my $output='';
7425:
7426: if ($env{'browser.mathml'}) {
7427: $output='<?xml version="1.0"?>'
7428: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7429: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7430:
7431: # .'<!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">] >'
7432: .'<!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">'
7433: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7434: .'xmlns="http://www.w3.org/1999/xhtml">';
7435: } else {
1.849 bisitz 7436: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7437: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7438: }
7439: return $output;
7440: }
1.340 albertel 7441:
7442: =pod
7443:
1.306 albertel 7444: =item * &start_page()
7445:
7446: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7447:
1.648 raeburn 7448: Inputs:
7449:
7450: =over 4
7451:
7452: $title - optional title for the page
7453:
7454: $head_extra - optional extra HTML to incude inside the <head>
7455:
7456: $args - additional optional args supported are:
7457:
7458: =over 8
7459:
7460: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7461: arg on
1.814 bisitz 7462: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7463: add_entries -> additional attributes to add to the <body>
7464: domain -> force to color decorate a page for a
1.317 albertel 7465: specific domain
1.648 raeburn 7466: function -> force usage of a specific rolish color
1.317 albertel 7467: scheme
1.648 raeburn 7468: redirect -> see &headtag()
7469: bgcolor -> override the default page bg color
7470: js_ready -> return a string ready for being used in
1.317 albertel 7471: a javascript writeln
1.648 raeburn 7472: html_encode -> return a string ready for being used in
1.320 albertel 7473: a html attribute
1.648 raeburn 7474: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7475: $forcereg arg
1.648 raeburn 7476: frameset -> if true will start with a <frameset>
1.330 albertel 7477: rather than <body>
1.648 raeburn 7478: skip_phases -> hash ref of
1.338 albertel 7479: head -> skip the <html><head> generation
7480: body -> skip all <body> generation
1.648 raeburn 7481: no_auto_mt_title -> prevent &mt()ing the title arg
7482: inherit_jsmath -> when creating popup window in a page,
7483: should it have jsmath forced on by the
7484: current page
1.867 kalberla 7485: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7486: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 raeburn 7487: group -> includes the current group, if page is for a
7488: specific group
1.361 albertel 7489:
1.648 raeburn 7490: =back
1.460 albertel 7491:
1.648 raeburn 7492: =back
1.562 albertel 7493:
1.306 albertel 7494: =cut
7495:
7496: sub start_page {
1.309 albertel 7497: my ($title,$head_extra,$args) = @_;
1.318 albertel 7498: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7499:
1.315 albertel 7500: $env{'internal.start_page'}++;
1.1096 raeburn 7501: my ($result,@advtools);
1.964 droeschl 7502:
1.338 albertel 7503: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7504: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7505: }
7506:
7507: if (! exists($args->{'skip_phases'}{'body'}) ) {
7508: if ($args->{'frameset'}) {
7509: my $attr_string = &make_attr_string($args->{'force_register'},
7510: $args->{'add_entries'});
7511: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7512: } else {
7513: $result .=
7514: &bodytag($title,
7515: $args->{'function'}, $args->{'add_entries'},
7516: $args->{'only_body'}, $args->{'domain'},
7517: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 7518: $args->{'bgcolor'}, $args,
7519: \@advtools);
1.831 bisitz 7520: }
1.330 albertel 7521: }
1.338 albertel 7522:
1.315 albertel 7523: if ($args->{'js_ready'}) {
1.713 kaisler 7524: $result = &js_ready($result);
1.315 albertel 7525: }
1.320 albertel 7526: if ($args->{'html_encode'}) {
1.713 kaisler 7527: $result = &html_encode($result);
7528: }
7529:
1.813 bisitz 7530: # Preparation for new and consistent functionlist at top of screen
7531: # if ($args->{'functionlist'}) {
7532: # $result .= &build_functionlist();
7533: #}
7534:
1.964 droeschl 7535: # Don't add anything more if only_body wanted or in const space
7536: return $result if $args->{'only_body'}
7537: || $env{'request.state'} eq 'construct';
1.813 bisitz 7538:
7539: #Breadcrumbs
1.758 kaisler 7540: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7541: &Apache::lonhtmlcommon::clear_breadcrumbs();
7542: #if any br links exists, add them to the breadcrumbs
7543: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7544: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7545: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7546: }
7547: }
1.1096 raeburn 7548: # if @advtools array contains items add then to the breadcrumbs
7549: if (@advtools > 0) {
7550: &Apache::lonmenu::advtools_crumbs(@advtools);
7551: }
1.758 kaisler 7552:
7553: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7554: if(exists($args->{'bread_crumbs_component'})){
7555: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7556: }else{
7557: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7558: }
1.320 albertel 7559: }
1.315 albertel 7560: return $result;
1.306 albertel 7561: }
7562:
7563: sub end_page {
1.315 albertel 7564: my ($args) = @_;
7565: $env{'internal.end_page'}++;
1.330 albertel 7566: my $result;
1.335 albertel 7567: if ($args->{'discussion'}) {
7568: my ($target,$parser);
7569: if (ref($args->{'discussion'})) {
7570: ($target,$parser) =($args->{'discussion'}{'target'},
7571: $args->{'discussion'}{'parser'});
7572: }
7573: $result .= &Apache::lonxml::xmlend($target,$parser);
7574: }
1.330 albertel 7575: if ($args->{'frameset'}) {
7576: $result .= '</frameset>';
7577: } else {
1.635 raeburn 7578: $result .= &endbodytag($args);
1.330 albertel 7579: }
1.1080 raeburn 7580: unless ($args->{'notbody'}) {
7581: $result .= "\n</html>";
7582: }
1.330 albertel 7583:
1.315 albertel 7584: if ($args->{'js_ready'}) {
1.317 albertel 7585: $result = &js_ready($result);
1.315 albertel 7586: }
1.335 albertel 7587:
1.320 albertel 7588: if ($args->{'html_encode'}) {
7589: $result = &html_encode($result);
7590: }
1.335 albertel 7591:
1.315 albertel 7592: return $result;
7593: }
7594:
1.1034 www 7595: sub wishlist_window {
7596: return(<<'ENDWISHLIST');
1.1046 raeburn 7597: <script type="text/javascript">
1.1034 www 7598: // <![CDATA[
7599: // <!-- BEGIN LON-CAPA Internal
7600: function set_wishlistlink(title, path) {
7601: if (!title) {
7602: title = document.title;
7603: title = title.replace(/^LON-CAPA /,'');
7604: }
7605: if (!path) {
7606: path = location.pathname;
7607: }
7608: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7609: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7610: }
7611: // END LON-CAPA Internal -->
7612: // ]]>
7613: </script>
7614: ENDWISHLIST
7615: }
7616:
1.1030 www 7617: sub modal_window {
7618: return(<<'ENDMODAL');
1.1046 raeburn 7619: <script type="text/javascript">
1.1030 www 7620: // <![CDATA[
7621: // <!-- BEGIN LON-CAPA Internal
7622: var modalWindow = {
7623: parent:"body",
7624: windowId:null,
7625: content:null,
7626: width:null,
7627: height:null,
7628: close:function()
7629: {
7630: $(".LCmodal-window").remove();
7631: $(".LCmodal-overlay").remove();
7632: },
7633: open:function()
7634: {
7635: var modal = "";
7636: modal += "<div class=\"LCmodal-overlay\"></div>";
7637: 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;\">";
7638: modal += this.content;
7639: modal += "</div>";
7640:
7641: $(this.parent).append(modal);
7642:
7643: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7644: $(".LCclose-window").click(function(){modalWindow.close();});
7645: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7646: }
7647: };
1.1031 www 7648: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7649: {
7650: modalWindow.windowId = "myModal";
7651: modalWindow.width = width;
7652: modalWindow.height = height;
1.1031 www 7653: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7654: modalWindow.open();
7655: };
7656: // END LON-CAPA Internal -->
7657: // ]]>
7658: </script>
7659: ENDMODAL
7660: }
7661:
7662: sub modal_link {
1.1052 www 7663: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7664: unless ($width) { $width=480; }
7665: unless ($height) { $height=400; }
1.1031 www 7666: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7667: my $target_attr;
7668: if (defined($target)) {
7669: $target_attr = 'target="'.$target.'"';
7670: }
7671: return <<"ENDLINK";
7672: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7673: $linktext</a>
7674: ENDLINK
1.1030 www 7675: }
7676:
1.1032 www 7677: sub modal_adhoc_script {
7678: my ($funcname,$width,$height,$content)=@_;
7679: return (<<ENDADHOC);
1.1046 raeburn 7680: <script type="text/javascript">
1.1032 www 7681: // <![CDATA[
7682: var $funcname = function()
7683: {
7684: modalWindow.windowId = "myModal";
7685: modalWindow.width = $width;
7686: modalWindow.height = $height;
7687: modalWindow.content = '$content';
7688: modalWindow.open();
7689: };
7690: // ]]>
7691: </script>
7692: ENDADHOC
7693: }
7694:
1.1041 www 7695: sub modal_adhoc_inner {
7696: my ($funcname,$width,$height,$content)=@_;
7697: my $innerwidth=$width-20;
7698: $content=&js_ready(
1.1042 www 7699: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7700: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7701: $content.
7702: &end_scrollbox().
7703: &end_page()
7704: );
7705: return &modal_adhoc_script($funcname,$width,$height,$content);
7706: }
7707:
7708: sub modal_adhoc_window {
7709: my ($funcname,$width,$height,$content,$linktext)=@_;
7710: return &modal_adhoc_inner($funcname,$width,$height,$content).
7711: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7712: }
7713:
7714: sub modal_adhoc_launch {
7715: my ($funcname,$width,$height,$content)=@_;
7716: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7717: <script type="text/javascript">
7718: // <![CDATA[
7719: $funcname();
7720: // ]]>
7721: </script>
7722: ENDLAUNCH
7723: }
7724:
7725: sub modal_adhoc_close {
7726: return (<<ENDCLOSE);
7727: <script type="text/javascript">
7728: // <![CDATA[
7729: modalWindow.close();
7730: // ]]>
7731: </script>
7732: ENDCLOSE
7733: }
7734:
1.1038 www 7735: sub togglebox_script {
7736: return(<<ENDTOGGLE);
7737: <script type="text/javascript">
7738: // <![CDATA[
7739: function LCtoggleDisplay(id,hidetext,showtext) {
7740: link = document.getElementById(id + "link").childNodes[0];
7741: with (document.getElementById(id).style) {
7742: if (display == "none" ) {
7743: display = "inline";
7744: link.nodeValue = hidetext;
7745: } else {
7746: display = "none";
7747: link.nodeValue = showtext;
7748: }
7749: }
7750: }
7751: // ]]>
7752: </script>
7753: ENDTOGGLE
7754: }
7755:
1.1039 www 7756: sub start_togglebox {
7757: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7758: unless ($heading) { $heading=''; } else { $heading.=' '; }
7759: unless ($showtext) { $showtext=&mt('show'); }
7760: unless ($hidetext) { $hidetext=&mt('hide'); }
7761: unless ($headerbg) { $headerbg='#FFFFFF'; }
7762: return &start_data_table().
7763: &start_data_table_header_row().
7764: '<td bgcolor="'.$headerbg.'">'.$heading.
7765: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7766: $showtext.'\')">'.$showtext.'</a>]</td>'.
7767: &end_data_table_header_row().
7768: '<tr id="'.$id.'" style="display:none""><td>';
7769: }
7770:
7771: sub end_togglebox {
7772: return '</td></tr>'.&end_data_table();
7773: }
7774:
1.1041 www 7775: sub LCprogressbar_script {
1.1045 www 7776: my ($id)=@_;
1.1041 www 7777: return(<<ENDPROGRESS);
7778: <script type="text/javascript">
7779: // <![CDATA[
1.1045 www 7780: \$('#progressbar$id').progressbar({
1.1041 www 7781: value: 0,
7782: change: function(event, ui) {
7783: var newVal = \$(this).progressbar('option', 'value');
7784: \$('.pblabel', this).text(LCprogressTxt);
7785: }
7786: });
7787: // ]]>
7788: </script>
7789: ENDPROGRESS
7790: }
7791:
7792: sub LCprogressbarUpdate_script {
7793: return(<<ENDPROGRESSUPDATE);
7794: <style type="text/css">
7795: .ui-progressbar { position:relative; }
7796: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7797: </style>
7798: <script type="text/javascript">
7799: // <![CDATA[
1.1045 www 7800: var LCprogressTxt='---';
7801:
7802: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7803: LCprogressTxt=progresstext;
1.1045 www 7804: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7805: }
7806: // ]]>
7807: </script>
7808: ENDPROGRESSUPDATE
7809: }
7810:
1.1042 www 7811: my $LClastpercent;
1.1045 www 7812: my $LCidcnt;
7813: my $LCcurrentid;
1.1042 www 7814:
1.1041 www 7815: sub LCprogressbar {
1.1042 www 7816: my ($r)=(@_);
7817: $LClastpercent=0;
1.1045 www 7818: $LCidcnt++;
7819: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7820: my $starting=&mt('Starting');
7821: my $content=(<<ENDPROGBAR);
1.1045 www 7822: <div id="progressbar$LCcurrentid">
1.1041 www 7823: <span class="pblabel">$starting</span>
7824: </div>
7825: ENDPROGBAR
1.1045 www 7826: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7827: }
7828:
7829: sub LCprogressbarUpdate {
1.1042 www 7830: my ($r,$val,$text)=@_;
7831: unless ($val) {
7832: if ($LClastpercent) {
7833: $val=$LClastpercent;
7834: } else {
7835: $val=0;
7836: }
7837: }
1.1041 www 7838: if ($val<0) { $val=0; }
7839: if ($val>100) { $val=0; }
1.1042 www 7840: $LClastpercent=$val;
1.1041 www 7841: unless ($text) { $text=$val.'%'; }
7842: $text=&js_ready($text);
1.1044 www 7843: &r_print($r,<<ENDUPDATE);
1.1041 www 7844: <script type="text/javascript">
7845: // <![CDATA[
1.1045 www 7846: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7847: // ]]>
7848: </script>
7849: ENDUPDATE
1.1035 www 7850: }
7851:
1.1042 www 7852: sub LCprogressbarClose {
7853: my ($r)=@_;
7854: $LClastpercent=0;
1.1044 www 7855: &r_print($r,<<ENDCLOSE);
1.1042 www 7856: <script type="text/javascript">
7857: // <![CDATA[
1.1045 www 7858: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7859: // ]]>
7860: </script>
7861: ENDCLOSE
1.1044 www 7862: }
7863:
7864: sub r_print {
7865: my ($r,$to_print)=@_;
7866: if ($r) {
7867: $r->print($to_print);
7868: $r->rflush();
7869: } else {
7870: print($to_print);
7871: }
1.1042 www 7872: }
7873:
1.320 albertel 7874: sub html_encode {
7875: my ($result) = @_;
7876:
1.322 albertel 7877: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7878:
7879: return $result;
7880: }
1.1044 www 7881:
1.317 albertel 7882: sub js_ready {
7883: my ($result) = @_;
7884:
1.323 albertel 7885: $result =~ s/[\n\r]/ /xmsg;
7886: $result =~ s/\\/\\\\/xmsg;
7887: $result =~ s/'/\\'/xmsg;
1.372 albertel 7888: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7889:
7890: return $result;
7891: }
7892:
1.315 albertel 7893: sub validate_page {
7894: if ( exists($env{'internal.start_page'})
1.316 albertel 7895: && $env{'internal.start_page'} > 1) {
7896: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7897: $env{'internal.start_page'}.' '.
1.316 albertel 7898: $ENV{'request.filename'});
1.315 albertel 7899: }
7900: if ( exists($env{'internal.end_page'})
1.316 albertel 7901: && $env{'internal.end_page'} > 1) {
7902: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7903: $env{'internal.end_page'}.' '.
1.316 albertel 7904: $env{'request.filename'});
1.315 albertel 7905: }
7906: if ( exists($env{'internal.start_page'})
7907: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7908: &Apache::lonnet::logthis('start_page called without end_page '.
7909: $env{'request.filename'});
1.315 albertel 7910: }
7911: if ( ! exists($env{'internal.start_page'})
7912: && exists($env{'internal.end_page'})) {
1.316 albertel 7913: &Apache::lonnet::logthis('end_page called without start_page'.
7914: $env{'request.filename'});
1.315 albertel 7915: }
1.306 albertel 7916: }
1.315 albertel 7917:
1.996 www 7918:
7919: sub start_scrollbox {
1.1075 raeburn 7920: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7921: unless ($outerwidth) { $outerwidth='520px'; }
7922: unless ($width) { $width='500px'; }
7923: unless ($height) { $height='200px'; }
1.1075 raeburn 7924: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7925: if ($id ne '') {
1.1020 raeburn 7926: $table_id = " id='table_$id'";
7927: $div_id = " id='div_$id'";
1.1018 raeburn 7928: }
1.1075 raeburn 7929: if ($bgcolor ne '') {
7930: $tdcol = "background-color: $bgcolor;";
7931: }
7932: return <<"END";
7933: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol"><div style="overflow:auto; width:$width; height: $height;"$div_id>
7934: END
1.996 www 7935: }
7936:
7937: sub end_scrollbox {
1.1036 www 7938: return '</div></td></tr></table>';
1.996 www 7939: }
7940:
1.318 albertel 7941: sub simple_error_page {
7942: my ($r,$title,$msg) = @_;
7943: my $page =
7944: &Apache::loncommon::start_page($title).
1.1097 bisitz 7945: '<p class="LC_error">'.&mt($msg).'</p>'.
1.318 albertel 7946: &Apache::loncommon::end_page();
7947: if (ref($r)) {
7948: $r->print($page);
1.327 albertel 7949: return;
1.318 albertel 7950: }
7951: return $page;
7952: }
1.347 albertel 7953:
7954: {
1.610 albertel 7955: my @row_count;
1.961 onken 7956:
7957: sub start_data_table_count {
7958: unshift(@row_count, 0);
7959: return;
7960: }
7961:
7962: sub end_data_table_count {
7963: shift(@row_count);
7964: return;
7965: }
7966:
1.347 albertel 7967: sub start_data_table {
1.1018 raeburn 7968: my ($add_class,$id) = @_;
1.422 albertel 7969: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7970: my $table_id;
7971: if (defined($id)) {
7972: $table_id = ' id="'.$id.'"';
7973: }
1.961 onken 7974: &start_data_table_count();
1.1018 raeburn 7975: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7976: }
7977:
7978: sub end_data_table {
1.961 onken 7979: &end_data_table_count();
1.389 albertel 7980: return '</table>'."\n";;
1.347 albertel 7981: }
7982:
7983: sub start_data_table_row {
1.974 wenzelju 7984: my ($add_class, $id) = @_;
1.610 albertel 7985: $row_count[0]++;
7986: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7987: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7988: $id = (' id="'.$id.'"') unless ($id eq '');
7989: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7990: }
1.471 banghart 7991:
7992: sub continue_data_table_row {
1.974 wenzelju 7993: my ($add_class, $id) = @_;
1.610 albertel 7994: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7995: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7996: $id = (' id="'.$id.'"') unless ($id eq '');
7997: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7998: }
1.347 albertel 7999:
8000: sub end_data_table_row {
1.389 albertel 8001: return '</tr>'."\n";;
1.347 albertel 8002: }
1.367 www 8003:
1.421 albertel 8004: sub start_data_table_empty_row {
1.707 bisitz 8005: # $row_count[0]++;
1.421 albertel 8006: return '<tr class="LC_empty_row" >'."\n";;
8007: }
8008:
8009: sub end_data_table_empty_row {
8010: return '</tr>'."\n";;
8011: }
8012:
1.367 www 8013: sub start_data_table_header_row {
1.389 albertel 8014: return '<tr class="LC_header_row">'."\n";;
1.367 www 8015: }
8016:
8017: sub end_data_table_header_row {
1.389 albertel 8018: return '</tr>'."\n";;
1.367 www 8019: }
1.890 droeschl 8020:
8021: sub data_table_caption {
8022: my $caption = shift;
8023: return "<caption class=\"LC_caption\">$caption</caption>";
8024: }
1.347 albertel 8025: }
8026:
1.548 albertel 8027: =pod
8028:
8029: =item * &inhibit_menu_check($arg)
8030:
8031: Checks for a inhibitmenu state and generates output to preserve it
8032:
8033: Inputs: $arg - can be any of
8034: - undef - in which case the return value is a string
8035: to add into arguments list of a uri
8036: - 'input' - in which case the return value is a HTML
8037: <form> <input> field of type hidden to
8038: preserve the value
8039: - a url - in which case the return value is the url with
8040: the neccesary cgi args added to preserve the
8041: inhibitmenu state
8042: - a ref to a url - no return value, but the string is
8043: updated to include the neccessary cgi
8044: args to preserve the inhibitmenu state
8045:
8046: =cut
8047:
8048: sub inhibit_menu_check {
8049: my ($arg) = @_;
8050: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8051: if ($arg eq 'input') {
8052: if ($env{'form.inhibitmenu'}) {
8053: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8054: } else {
8055: return
8056: }
8057: }
8058: if ($env{'form.inhibitmenu'}) {
8059: if (ref($arg)) {
8060: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8061: } elsif ($arg eq '') {
8062: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8063: } else {
8064: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8065: }
8066: }
8067: if (!ref($arg)) {
8068: return $arg;
8069: }
8070: }
8071:
1.251 albertel 8072: ###############################################
1.182 matthew 8073:
8074: =pod
8075:
1.549 albertel 8076: =back
8077:
8078: =head1 User Information Routines
8079:
8080: =over 4
8081:
1.405 albertel 8082: =item * &get_users_function()
1.182 matthew 8083:
8084: Used by &bodytag to determine the current users primary role.
8085: Returns either 'student','coordinator','admin', or 'author'.
8086:
8087: =cut
8088:
8089: ###############################################
8090: sub get_users_function {
1.815 tempelho 8091: my $function = 'norole';
1.818 tempelho 8092: if ($env{'request.role'}=~/^(st)/) {
8093: $function='student';
8094: }
1.907 raeburn 8095: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8096: $function='coordinator';
8097: }
1.258 albertel 8098: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8099: $function='admin';
8100: }
1.826 bisitz 8101: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8102: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8103: $function='author';
8104: }
8105: return $function;
1.54 www 8106: }
1.99 www 8107:
8108: ###############################################
8109:
1.233 raeburn 8110: =pod
8111:
1.821 raeburn 8112: =item * &show_course()
8113:
8114: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8115: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8116:
8117: Inputs:
8118: None
8119:
8120: Outputs:
8121: Scalar: 1 if 'Course' to be used, 0 otherwise.
8122:
8123: =cut
8124:
8125: ###############################################
8126: sub show_course {
8127: my $course = !$env{'user.adv'};
8128: if (!$env{'user.adv'}) {
8129: foreach my $env (keys(%env)) {
8130: next if ($env !~ m/^user\.priv\./);
8131: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8132: $course = 0;
8133: last;
8134: }
8135: }
8136: }
8137: return $course;
8138: }
8139:
8140: ###############################################
8141:
8142: =pod
8143:
1.542 raeburn 8144: =item * &check_user_status()
1.274 raeburn 8145:
8146: Determines current status of supplied role for a
8147: specific user. Roles can be active, previous or future.
8148:
8149: Inputs:
8150: user's domain, user's username, course's domain,
1.375 raeburn 8151: course's number, optional section ID.
1.274 raeburn 8152:
8153: Outputs:
8154: role status: active, previous or future.
8155:
8156: =cut
8157:
8158: sub check_user_status {
1.412 raeburn 8159: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8160: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8161: my @uroles = keys %userinfo;
8162: my $srchstr;
8163: my $active_chk = 'none';
1.412 raeburn 8164: my $now = time;
1.274 raeburn 8165: if (@uroles > 0) {
1.908 raeburn 8166: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8167: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8168: } else {
1.412 raeburn 8169: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8170: }
8171: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8172: my $role_end = 0;
8173: my $role_start = 0;
8174: $active_chk = 'active';
1.412 raeburn 8175: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8176: $role_end = $1;
8177: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8178: $role_start = $1;
1.274 raeburn 8179: }
8180: }
8181: if ($role_start > 0) {
1.412 raeburn 8182: if ($now < $role_start) {
1.274 raeburn 8183: $active_chk = 'future';
8184: }
8185: }
8186: if ($role_end > 0) {
1.412 raeburn 8187: if ($now > $role_end) {
1.274 raeburn 8188: $active_chk = 'previous';
8189: }
8190: }
8191: }
8192: }
8193: return $active_chk;
8194: }
8195:
8196: ###############################################
8197:
8198: =pod
8199:
1.405 albertel 8200: =item * &get_sections()
1.233 raeburn 8201:
8202: Determines all the sections for a course including
8203: sections with students and sections containing other roles.
1.419 raeburn 8204: Incoming parameters:
8205:
8206: 1. domain
8207: 2. course number
8208: 3. reference to array containing roles for which sections should
8209: be gathered (optional).
8210: 4. reference to array containing status types for which sections
8211: should be gathered (optional).
8212:
8213: If the third argument is undefined, sections are gathered for any role.
8214: If the fourth argument is undefined, sections are gathered for any status.
8215: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8216:
1.374 raeburn 8217: Returns section hash (keys are section IDs, values are
8218: number of users in each section), subject to the
1.419 raeburn 8219: optional roles filter, optional status filter
1.233 raeburn 8220:
8221: =cut
8222:
8223: ###############################################
8224: sub get_sections {
1.419 raeburn 8225: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8226: if (!defined($cdom) || !defined($cnum)) {
8227: my $cid = $env{'request.course.id'};
8228:
8229: return if (!defined($cid));
8230:
8231: $cdom = $env{'course.'.$cid.'.domain'};
8232: $cnum = $env{'course.'.$cid.'.num'};
8233: }
8234:
8235: my %sectioncount;
1.419 raeburn 8236: my $now = time;
1.240 albertel 8237:
1.1118 raeburn 8238: my $check_students = 1;
8239: my $only_students = 0;
8240: if (ref($possible_roles) eq 'ARRAY') {
8241: if (grep(/^st$/,@{$possible_roles})) {
8242: if (@{$possible_roles} == 1) {
8243: $only_students = 1;
8244: }
8245: } else {
8246: $check_students = 0;
8247: }
8248: }
8249:
8250: if ($check_students) {
1.276 albertel 8251: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8252: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8253: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8254: my $start_index = &Apache::loncoursedata::CL_START();
8255: my $end_index = &Apache::loncoursedata::CL_END();
8256: my $status;
1.366 albertel 8257: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8258: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8259: $data->[$status_index],
8260: $data->[$start_index],
8261: $data->[$end_index]);
8262: if ($stu_status eq 'Active') {
8263: $status = 'active';
8264: } elsif ($end < $now) {
8265: $status = 'previous';
8266: } elsif ($start > $now) {
8267: $status = 'future';
8268: }
8269: if ($section ne '-1' && $section !~ /^\s*$/) {
8270: if ((!defined($possible_status)) || (($status ne '') &&
8271: (grep/^\Q$status\E$/,@{$possible_status}))) {
8272: $sectioncount{$section}++;
8273: }
1.240 albertel 8274: }
8275: }
8276: }
1.1118 raeburn 8277: if ($only_students) {
8278: return %sectioncount;
8279: }
1.240 albertel 8280: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8281: foreach my $user (sort(keys(%courseroles))) {
8282: if ($user !~ /^(\w{2})/) { next; }
8283: my ($role) = ($user =~ /^(\w{2})/);
8284: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8285: my ($section,$status);
1.240 albertel 8286: if ($role eq 'cr' &&
8287: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8288: $section=$1;
8289: }
8290: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8291: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8292: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8293: if ($end == -1 && $start == -1) {
8294: next; #deleted role
8295: }
8296: if (!defined($possible_status)) {
8297: $sectioncount{$section}++;
8298: } else {
8299: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8300: $status = 'active';
8301: } elsif ($end < $now) {
8302: $status = 'future';
8303: } elsif ($start > $now) {
8304: $status = 'previous';
8305: }
8306: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8307: $sectioncount{$section}++;
8308: }
8309: }
1.233 raeburn 8310: }
1.366 albertel 8311: return %sectioncount;
1.233 raeburn 8312: }
8313:
1.274 raeburn 8314: ###############################################
1.294 raeburn 8315:
8316: =pod
1.405 albertel 8317:
8318: =item * &get_course_users()
8319:
1.275 raeburn 8320: Retrieves usernames:domains for users in the specified course
8321: with specific role(s), and access status.
8322:
8323: Incoming parameters:
1.277 albertel 8324: 1. course domain
8325: 2. course number
8326: 3. access status: users must have - either active,
1.275 raeburn 8327: previous, future, or all.
1.277 albertel 8328: 4. reference to array of permissible roles
1.288 raeburn 8329: 5. reference to array of section restrictions (optional)
8330: 6. reference to results object (hash of hashes).
8331: 7. reference to optional userdata hash
1.609 raeburn 8332: 8. reference to optional statushash
1.630 raeburn 8333: 9. flag if privileged users (except those set to unhide in
8334: course settings) should be excluded
1.609 raeburn 8335: Keys of top level results hash are roles.
1.275 raeburn 8336: Keys of inner hashes are username:domain, with
8337: values set to access type.
1.288 raeburn 8338: Optional userdata hash returns an array with arguments in the
8339: same order as loncoursedata::get_classlist() for student data.
8340:
1.609 raeburn 8341: Optional statushash returns
8342:
1.288 raeburn 8343: Entries for end, start, section and status are blank because
8344: of the possibility of multiple values for non-student roles.
8345:
1.275 raeburn 8346: =cut
1.405 albertel 8347:
1.275 raeburn 8348: ###############################################
1.405 albertel 8349:
1.275 raeburn 8350: sub get_course_users {
1.630 raeburn 8351: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8352: my %idx = ();
1.419 raeburn 8353: my %seclists;
1.288 raeburn 8354:
8355: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8356: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8357: $idx{end} = &Apache::loncoursedata::CL_END();
8358: $idx{start} = &Apache::loncoursedata::CL_START();
8359: $idx{id} = &Apache::loncoursedata::CL_ID();
8360: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8361: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8362: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8363:
1.290 albertel 8364: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8365: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8366: my $now = time;
1.277 albertel 8367: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8368: my $match = 0;
1.412 raeburn 8369: my $secmatch = 0;
1.419 raeburn 8370: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8371: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8372: if ($section eq '') {
8373: $section = 'none';
8374: }
1.291 albertel 8375: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8376: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8377: $secmatch = 1;
8378: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8379: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8380: $secmatch = 1;
8381: }
8382: } else {
1.419 raeburn 8383: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8384: $secmatch = 1;
8385: }
1.290 albertel 8386: }
1.412 raeburn 8387: if (!$secmatch) {
8388: next;
8389: }
1.419 raeburn 8390: }
1.275 raeburn 8391: if (defined($$types{'active'})) {
1.288 raeburn 8392: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8393: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8394: $match = 1;
1.275 raeburn 8395: }
8396: }
8397: if (defined($$types{'previous'})) {
1.609 raeburn 8398: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8399: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8400: $match = 1;
1.275 raeburn 8401: }
8402: }
8403: if (defined($$types{'future'})) {
1.609 raeburn 8404: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8405: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8406: $match = 1;
1.275 raeburn 8407: }
8408: }
1.609 raeburn 8409: if ($match) {
8410: push(@{$seclists{$student}},$section);
8411: if (ref($userdata) eq 'HASH') {
8412: $$userdata{$student} = $$classlist{$student};
8413: }
8414: if (ref($statushash) eq 'HASH') {
8415: $statushash->{$student}{'st'}{$section} = $status;
8416: }
1.288 raeburn 8417: }
1.275 raeburn 8418: }
8419: }
1.412 raeburn 8420: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8421: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8422: my $now = time;
1.609 raeburn 8423: my %displaystatus = ( previous => 'Expired',
8424: active => 'Active',
8425: future => 'Future',
8426: );
1.1121 raeburn 8427: my (%nothide,@possdoms);
1.630 raeburn 8428: if ($hidepriv) {
8429: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8430: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8431: if ($user !~ /:/) {
8432: $nothide{join(':',split(/[\@]/,$user))}=1;
8433: } else {
8434: $nothide{$user} = 1;
8435: }
8436: }
1.1121 raeburn 8437: my @possdoms = ($cdom);
8438: if ($coursehash{'checkforpriv'}) {
8439: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8440: }
1.630 raeburn 8441: }
1.439 raeburn 8442: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8443: my $match = 0;
1.412 raeburn 8444: my $secmatch = 0;
1.439 raeburn 8445: my $status;
1.412 raeburn 8446: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8447: $user =~ s/:$//;
1.439 raeburn 8448: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8449: if ($end == -1 || $start == -1) {
8450: next;
8451: }
8452: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8453: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8454: my ($uname,$udom) = split(/:/,$user);
8455: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8456: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8457: $secmatch = 1;
8458: } elsif ($usec eq '') {
1.420 albertel 8459: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8460: $secmatch = 1;
8461: }
8462: } else {
8463: if (grep(/^\Q$usec\E$/,@{$sections})) {
8464: $secmatch = 1;
8465: }
8466: }
8467: if (!$secmatch) {
8468: next;
8469: }
1.288 raeburn 8470: }
1.419 raeburn 8471: if ($usec eq '') {
8472: $usec = 'none';
8473: }
1.275 raeburn 8474: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8475: if ($hidepriv) {
1.1121 raeburn 8476: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8477: (!$nothide{$uname.':'.$udom})) {
8478: next;
8479: }
8480: }
1.503 raeburn 8481: if ($end > 0 && $end < $now) {
1.439 raeburn 8482: $status = 'previous';
8483: } elsif ($start > $now) {
8484: $status = 'future';
8485: } else {
8486: $status = 'active';
8487: }
1.277 albertel 8488: foreach my $type (keys(%{$types})) {
1.275 raeburn 8489: if ($status eq $type) {
1.420 albertel 8490: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8491: push(@{$$users{$role}{$user}},$type);
8492: }
1.288 raeburn 8493: $match = 1;
8494: }
8495: }
1.419 raeburn 8496: if (($match) && (ref($userdata) eq 'HASH')) {
8497: if (!exists($$userdata{$uname.':'.$udom})) {
8498: &get_user_info($udom,$uname,\%idx,$userdata);
8499: }
1.420 albertel 8500: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8501: push(@{$seclists{$uname.':'.$udom}},$usec);
8502: }
1.609 raeburn 8503: if (ref($statushash) eq 'HASH') {
8504: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8505: }
1.275 raeburn 8506: }
8507: }
8508: }
8509: }
1.290 albertel 8510: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8511: if ((defined($cdom)) && (defined($cnum))) {
8512: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8513: if ( defined($csettings{'internal.courseowner'}) ) {
8514: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8515: next if ($owner eq '');
8516: my ($ownername,$ownerdom);
8517: if ($owner =~ /^([^:]+):([^:]+)$/) {
8518: $ownername = $1;
8519: $ownerdom = $2;
8520: } else {
8521: $ownername = $owner;
8522: $ownerdom = $cdom;
8523: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8524: }
8525: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8526: if (defined($userdata) &&
1.609 raeburn 8527: !exists($$userdata{$owner})) {
8528: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8529: if (!grep(/^none$/,@{$seclists{$owner}})) {
8530: push(@{$seclists{$owner}},'none');
8531: }
8532: if (ref($statushash) eq 'HASH') {
8533: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8534: }
1.290 albertel 8535: }
1.279 raeburn 8536: }
8537: }
8538: }
1.419 raeburn 8539: foreach my $user (keys(%seclists)) {
8540: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8541: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8542: }
1.275 raeburn 8543: }
8544: return;
8545: }
8546:
1.288 raeburn 8547: sub get_user_info {
8548: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8549: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8550: &plainname($uname,$udom,'lastname');
1.291 albertel 8551: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8552: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8553: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8554: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8555: return;
8556: }
1.275 raeburn 8557:
1.472 raeburn 8558: ###############################################
8559:
8560: =pod
8561:
8562: =item * &get_user_quota()
8563:
1.1134 raeburn 8564: Retrieves quota assigned for storage of user files.
8565: Default is to report quota for portfolio files.
1.472 raeburn 8566:
8567: Incoming parameters:
8568: 1. user's username
8569: 2. user's domain
1.1134 raeburn 8570: 3. quota name - portfolio, author, or course
1.1136 ! raeburn 8571: (if no quota name provided, defaults to portfolio).
! 8572: 4. crstype - official, unofficial or community, if quota name is
! 8573: course
1.472 raeburn 8574:
8575: Returns:
1.536 raeburn 8576: 1. Disk quota (in Mb) assigned to student.
8577: 2. (Optional) Type of setting: custom or default
8578: (individually assigned or default for user's
8579: institutional status).
8580: 3. (Optional) - User's institutional status (e.g., faculty, staff
8581: or student - types as defined in localenroll::inst_usertypes
8582: for user's domain, which determines default quota for user.
8583: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8584:
8585: If a value has been stored in the user's environment,
1.536 raeburn 8586: it will return that, otherwise it returns the maximal default
1.1134 raeburn 8587: defined for the user's institutional status(es) in the domain.
1.472 raeburn 8588:
8589: =cut
8590:
8591: ###############################################
8592:
8593:
8594: sub get_user_quota {
1.1136 ! raeburn 8595: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 8596: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8597: if (!defined($udom)) {
8598: $udom = $env{'user.domain'};
8599: }
8600: if (!defined($uname)) {
8601: $uname = $env{'user.name'};
8602: }
8603: if (($udom eq '' || $uname eq '') ||
8604: ($udom eq 'public') && ($uname eq 'public')) {
8605: $quota = 0;
1.536 raeburn 8606: $quotatype = 'default';
8607: $defquota = 0;
1.472 raeburn 8608: } else {
1.536 raeburn 8609: my $inststatus;
1.1134 raeburn 8610: if ($quotaname eq 'course') {
8611: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
8612: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
8613: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
8614: } else {
8615: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
8616: $quota = $cenv{'internal.uploadquota'};
8617: }
1.536 raeburn 8618: } else {
1.1134 raeburn 8619: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8620: if ($quotaname eq 'author') {
8621: $quota = $env{'environment.authorquota'};
8622: } else {
8623: $quota = $env{'environment.portfolioquota'};
8624: }
8625: $inststatus = $env{'environment.inststatus'};
8626: } else {
8627: my %userenv =
8628: &Apache::lonnet::get('environment',['portfolioquota',
8629: 'authorquota','inststatus'],$udom,$uname);
8630: my ($tmp) = keys(%userenv);
8631: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8632: if ($quotaname eq 'author') {
8633: $quota = $userenv{'authorquota'};
8634: } else {
8635: $quota = $userenv{'portfolioquota'};
8636: }
8637: $inststatus = $userenv{'inststatus'};
8638: } else {
8639: undef(%userenv);
8640: }
8641: }
8642: }
8643: if ($quota eq '' || wantarray) {
8644: if ($quotaname eq 'course') {
8645: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1136 ! raeburn 8646: if (($crstype eq 'official') || ($crstype eq 'unofficial') || ($crstype eq 'community')) {
! 8647: $defquota = $domdefs{$crstype.'quota'};
! 8648: }
! 8649: if ($defquota eq '') {
! 8650: $defquota = 500;
! 8651: }
1.1134 raeburn 8652: } else {
8653: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
8654: }
8655: if ($quota eq '') {
8656: $quota = $defquota;
8657: $quotatype = 'default';
8658: } else {
8659: $quotatype = 'custom';
8660: }
1.472 raeburn 8661: }
8662: }
1.536 raeburn 8663: if (wantarray) {
8664: return ($quota,$quotatype,$settingstatus,$defquota);
8665: } else {
8666: return $quota;
8667: }
1.472 raeburn 8668: }
8669:
8670: ###############################################
8671:
8672: =pod
8673:
8674: =item * &default_quota()
8675:
1.536 raeburn 8676: Retrieves default quota assigned for storage of user portfolio files,
8677: given an (optional) user's institutional status.
1.472 raeburn 8678:
8679: Incoming parameters:
8680: 1. domain
1.536 raeburn 8681: 2. (Optional) institutional status(es). This is a : separated list of
8682: status types (e.g., faculty, staff, student etc.)
8683: which apply to the user for whom the default is being retrieved.
8684: If the institutional status string in undefined, the domain
1.1134 raeburn 8685: default quota will be returned.
8686: 3. quota name - portfolio, author, or course
8687: (if no quota name provided, defaults to portfolio).
1.472 raeburn 8688:
8689: Returns:
8690: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8691: 2. (Optional) institutional type which determined the value of the
8692: default quota.
1.472 raeburn 8693:
8694: If a value has been stored in the domain's configuration db,
8695: it will return that, otherwise it returns 20 (for backwards
8696: compatibility with domains which have not set up a configuration
8697: db file; the original statically defined portfolio quota was 20 Mb).
8698:
1.536 raeburn 8699: If the user's status includes multiple types (e.g., staff and student),
8700: the largest default quota which applies to the user determines the
8701: default quota returned.
8702:
1.780 raeburn 8703: =back
8704:
1.472 raeburn 8705: =cut
8706:
8707: ###############################################
8708:
8709:
8710: sub default_quota {
1.1134 raeburn 8711: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 8712: my ($defquota,$settingstatus);
8713: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8714: ['quotas'],$udom);
1.1134 raeburn 8715: my $key = 'defaultquota';
8716: if ($quotaname eq 'author') {
8717: $key = 'authorquota';
8718: }
1.622 raeburn 8719: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8720: if ($inststatus ne '') {
1.765 raeburn 8721: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8722: foreach my $item (@statuses) {
1.1134 raeburn 8723: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
8724: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 8725: if ($defquota eq '') {
1.1134 raeburn 8726: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 8727: $settingstatus = $item;
1.1134 raeburn 8728: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
8729: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 8730: $settingstatus = $item;
8731: }
8732: }
1.1134 raeburn 8733: } elsif ($key eq 'defaultquota') {
1.711 raeburn 8734: if ($quotahash{'quotas'}{$item} ne '') {
8735: if ($defquota eq '') {
8736: $defquota = $quotahash{'quotas'}{$item};
8737: $settingstatus = $item;
8738: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8739: $defquota = $quotahash{'quotas'}{$item};
8740: $settingstatus = $item;
8741: }
1.536 raeburn 8742: }
8743: }
8744: }
8745: }
8746: if ($defquota eq '') {
1.1134 raeburn 8747: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
8748: $defquota = $quotahash{'quotas'}{$key}{'default'};
8749: } elsif ($key eq 'defaultquota') {
1.711 raeburn 8750: $defquota = $quotahash{'quotas'}{'default'};
8751: }
1.536 raeburn 8752: $settingstatus = 'default';
8753: }
8754: } else {
8755: $settingstatus = 'default';
1.1134 raeburn 8756: if ($quotaname eq 'author') {
8757: $defquota = 500;
8758: } else {
8759: $defquota = 20;
8760: }
1.536 raeburn 8761: }
8762: if (wantarray) {
8763: return ($defquota,$settingstatus);
1.472 raeburn 8764: } else {
1.536 raeburn 8765: return $defquota;
1.472 raeburn 8766: }
8767: }
8768:
1.1135 raeburn 8769: ###############################################
8770:
8771: =pod
8772:
1.1136 ! raeburn 8773: =item * &excess_filesize_warning()
1.1135 raeburn 8774:
8775: Returns warning message if upload of file to authoring space, or copying
1.1136 ! raeburn 8776: of existing file within authoring space will cause quota for the authoring
! 8777: space to be exceeded,
! 8778:
! 8779: Same, if upload of a file directly to a course/community via Course Editor
! 8780: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 8781:
8782: Inputs: 6
1.1136 ! raeburn 8783: 1. username or coursenum
1.1135 raeburn 8784: 2. domain
1.1136 ! raeburn 8785: 3. context ('author' or 'course')
1.1135 raeburn 8786: 4. filename of file for which action is being requested
8787: 5. filesize (kB) of file
8788: 6. action being taken: copy or upload.
8789:
8790: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
8791: otherwise return null.
8792:
8793: =cut
8794:
1.1136 ! raeburn 8795: sub excess_filesize_warning {
! 8796: my ($uname,$udom,$context,$filename,$filesize,$action) = @_;
! 8797: my $current_disk_usage = 0;
! 8798: my $disk_quota = &get_user_quota($uname,$udom,$context); #expressed in MB
! 8799: if ($context eq 'author') {
! 8800: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
! 8801: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
! 8802: } else {
! 8803: foreach my $subdir ('docs','supplemental') {
! 8804: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
! 8805: }
! 8806: }
1.1135 raeburn 8807: $disk_quota = int($disk_quota * 1000);
8808: if (($current_disk_usage + $filesize) > $disk_quota) {
8809: return '<p><span class="LC_warning">'.
8810: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
8811: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</span>'.
8812: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
8813: $disk_quota,$current_disk_usage).
8814: '</p>';
8815: }
8816: return;
8817: }
8818:
8819: ###############################################
8820:
8821:
1.1136 ! raeburn 8822:
! 8823:
1.384 raeburn 8824: sub get_secgrprole_info {
8825: my ($cdom,$cnum,$needroles,$type) = @_;
8826: my %sections_count = &get_sections($cdom,$cnum);
8827: my @sections = (sort {$a <=> $b} keys(%sections_count));
8828: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8829: my @groups = sort(keys(%curr_groups));
8830: my $allroles = [];
8831: my $rolehash;
8832: my $accesshash = {
8833: active => 'Currently has access',
8834: future => 'Will have future access',
8835: previous => 'Previously had access',
8836: };
8837: if ($needroles) {
8838: $rolehash = {'all' => 'all'};
1.385 albertel 8839: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8840: if (&Apache::lonnet::error(%user_roles)) {
8841: undef(%user_roles);
8842: }
8843: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8844: my ($role)=split(/\:/,$item,2);
8845: if ($role eq 'cr') { next; }
8846: if ($role =~ /^cr/) {
8847: $$rolehash{$role} = (split('/',$role))[3];
8848: } else {
8849: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8850: }
8851: }
8852: foreach my $key (sort(keys(%{$rolehash}))) {
8853: push(@{$allroles},$key);
8854: }
8855: push (@{$allroles},'st');
8856: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8857: }
8858: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8859: }
8860:
1.555 raeburn 8861: sub user_picker {
1.994 raeburn 8862: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8863: my $currdom = $dom;
8864: my %curr_selected = (
8865: srchin => 'dom',
1.580 raeburn 8866: srchby => 'lastname',
1.555 raeburn 8867: );
8868: my $srchterm;
1.625 raeburn 8869: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8870: if ($srch->{'srchby'} ne '') {
8871: $curr_selected{'srchby'} = $srch->{'srchby'};
8872: }
8873: if ($srch->{'srchin'} ne '') {
8874: $curr_selected{'srchin'} = $srch->{'srchin'};
8875: }
8876: if ($srch->{'srchtype'} ne '') {
8877: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8878: }
8879: if ($srch->{'srchdomain'} ne '') {
8880: $currdom = $srch->{'srchdomain'};
8881: }
8882: $srchterm = $srch->{'srchterm'};
8883: }
8884: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8885: 'usr' => 'Search criteria',
1.563 raeburn 8886: 'doma' => 'Domain/institution to search',
1.558 albertel 8887: 'uname' => 'username',
8888: 'lastname' => 'last name',
1.555 raeburn 8889: 'lastfirst' => 'last name, first name',
1.558 albertel 8890: 'crs' => 'in this course',
1.576 raeburn 8891: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8892: 'alc' => 'all LON-CAPA',
1.573 raeburn 8893: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8894: 'exact' => 'is',
8895: 'contains' => 'contains',
1.569 raeburn 8896: 'begins' => 'begins with',
1.571 raeburn 8897: 'youm' => "You must include some text to search for.",
8898: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8899: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8900: 'yomc' => "You must choose a domain when using an institutional directory search.",
8901: 'ymcd' => "You must choose a domain when using a domain search.",
8902: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8903: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8904: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8905: );
1.563 raeburn 8906: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8907: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8908:
8909: my @srchins = ('crs','dom','alc','instd');
8910:
8911: foreach my $option (@srchins) {
8912: # FIXME 'alc' option unavailable until
8913: # loncreateuser::print_user_query_page()
8914: # has been completed.
8915: next if ($option eq 'alc');
1.880 raeburn 8916: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8917: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8918: if ($curr_selected{'srchin'} eq $option) {
8919: $srchinsel .= '
8920: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8921: } else {
8922: $srchinsel .= '
8923: <option value="'.$option.'">'.$lt{$option}.'</option>';
8924: }
1.555 raeburn 8925: }
1.563 raeburn 8926: $srchinsel .= "\n </select>\n";
1.555 raeburn 8927:
8928: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8929: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8930: if ($curr_selected{'srchby'} eq $option) {
8931: $srchbysel .= '
8932: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8933: } else {
8934: $srchbysel .= '
8935: <option value="'.$option.'">'.$lt{$option}.'</option>';
8936: }
8937: }
8938: $srchbysel .= "\n </select>\n";
8939:
8940: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8941: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8942: if ($curr_selected{'srchtype'} eq $option) {
8943: $srchtypesel .= '
8944: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8945: } else {
8946: $srchtypesel .= '
8947: <option value="'.$option.'">'.$lt{$option}.'</option>';
8948: }
8949: }
8950: $srchtypesel .= "\n </select>\n";
8951:
1.558 albertel 8952: my ($newuserscript,$new_user_create);
1.994 raeburn 8953: my $context_dom = $env{'request.role.domain'};
8954: if ($context eq 'requestcrs') {
8955: if ($env{'form.coursedom'} ne '') {
8956: $context_dom = $env{'form.coursedom'};
8957: }
8958: }
1.556 raeburn 8959: if ($forcenewuser) {
1.576 raeburn 8960: if (ref($srch) eq 'HASH') {
1.994 raeburn 8961: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8962: if ($cancreate) {
8963: $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>';
8964: } else {
1.799 bisitz 8965: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8966: my %usertypetext = (
8967: official => 'institutional',
8968: unofficial => 'non-institutional',
8969: );
1.799 bisitz 8970: $new_user_create = '<p class="LC_warning">'
8971: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8972: .' '
8973: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8974: ,'<a href="'.$helplink.'">','</a>')
8975: .'</p><br />';
1.627 raeburn 8976: }
1.576 raeburn 8977: }
8978: }
8979:
1.556 raeburn 8980: $newuserscript = <<"ENDSCRIPT";
8981:
1.570 raeburn 8982: function setSearch(createnew,callingForm) {
1.556 raeburn 8983: if (createnew == 1) {
1.570 raeburn 8984: for (var i=0; i<callingForm.srchby.length; i++) {
8985: if (callingForm.srchby.options[i].value == 'uname') {
8986: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8987: }
8988: }
1.570 raeburn 8989: for (var i=0; i<callingForm.srchin.length; i++) {
8990: if ( callingForm.srchin.options[i].value == 'dom') {
8991: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8992: }
8993: }
1.570 raeburn 8994: for (var i=0; i<callingForm.srchtype.length; i++) {
8995: if (callingForm.srchtype.options[i].value == 'exact') {
8996: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8997: }
8998: }
1.570 raeburn 8999: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 9000: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 9001: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 9002: }
9003: }
9004: }
9005: }
9006: ENDSCRIPT
1.558 albertel 9007:
1.556 raeburn 9008: }
9009:
1.555 raeburn 9010: my $output = <<"END_BLOCK";
1.556 raeburn 9011: <script type="text/javascript">
1.824 bisitz 9012: // <![CDATA[
1.570 raeburn 9013: function validateEntry(callingForm) {
1.558 albertel 9014:
1.556 raeburn 9015: var checkok = 1;
1.558 albertel 9016: var srchin;
1.570 raeburn 9017: for (var i=0; i<callingForm.srchin.length; i++) {
9018: if ( callingForm.srchin[i].checked ) {
9019: srchin = callingForm.srchin[i].value;
1.558 albertel 9020: }
9021: }
9022:
1.570 raeburn 9023: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
9024: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
9025: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
9026: var srchterm = callingForm.srchterm.value;
9027: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 9028: var msg = "";
9029:
9030: if (srchterm == "") {
9031: checkok = 0;
1.571 raeburn 9032: msg += "$lt{'youm'}\\n";
1.556 raeburn 9033: }
9034:
1.569 raeburn 9035: if (srchtype== 'begins') {
9036: if (srchterm.length < 2) {
9037: checkok = 0;
1.571 raeburn 9038: msg += "$lt{'thte'}\\n";
1.569 raeburn 9039: }
9040: }
9041:
1.556 raeburn 9042: if (srchtype== 'contains') {
9043: if (srchterm.length < 3) {
9044: checkok = 0;
1.571 raeburn 9045: msg += "$lt{'thet'}\\n";
1.556 raeburn 9046: }
9047: }
9048: if (srchin == 'instd') {
9049: if (srchdomain == '') {
9050: checkok = 0;
1.571 raeburn 9051: msg += "$lt{'yomc'}\\n";
1.556 raeburn 9052: }
9053: }
9054: if (srchin == 'dom') {
9055: if (srchdomain == '') {
9056: checkok = 0;
1.571 raeburn 9057: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 9058: }
9059: }
9060: if (srchby == 'lastfirst') {
9061: if (srchterm.indexOf(",") == -1) {
9062: checkok = 0;
1.571 raeburn 9063: msg += "$lt{'whus'}\\n";
1.556 raeburn 9064: }
9065: if (srchterm.indexOf(",") == srchterm.length -1) {
9066: checkok = 0;
1.571 raeburn 9067: msg += "$lt{'whse'}\\n";
1.556 raeburn 9068: }
9069: }
9070: if (checkok == 0) {
1.571 raeburn 9071: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 9072: return;
9073: }
9074: if (checkok == 1) {
1.570 raeburn 9075: callingForm.submit();
1.556 raeburn 9076: }
9077: }
9078:
9079: $newuserscript
9080:
1.824 bisitz 9081: // ]]>
1.556 raeburn 9082: </script>
1.558 albertel 9083:
9084: $new_user_create
9085:
1.555 raeburn 9086: END_BLOCK
1.558 albertel 9087:
1.876 raeburn 9088: $output .= &Apache::lonhtmlcommon::start_pick_box().
9089: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
9090: $domform.
9091: &Apache::lonhtmlcommon::row_closure().
9092: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
9093: $srchbysel.
9094: $srchtypesel.
9095: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
9096: $srchinsel.
9097: &Apache::lonhtmlcommon::row_closure(1).
9098: &Apache::lonhtmlcommon::end_pick_box().
9099: '<br />';
1.555 raeburn 9100: return $output;
9101: }
9102:
1.612 raeburn 9103: sub user_rule_check {
1.615 raeburn 9104: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 9105: my $response;
9106: if (ref($usershash) eq 'HASH') {
9107: foreach my $user (keys(%{$usershash})) {
9108: my ($uname,$udom) = split(/:/,$user);
9109: next if ($udom eq '' || $uname eq '');
1.615 raeburn 9110: my ($id,$newuser);
1.612 raeburn 9111: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 9112: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 9113: $id = $usershash->{$user}->{'id'};
9114: }
9115: my $inst_response;
9116: if (ref($checks) eq 'HASH') {
9117: if (defined($checks->{'username'})) {
1.615 raeburn 9118: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9119: &Apache::lonnet::get_instuser($udom,$uname);
9120: } elsif (defined($checks->{'id'})) {
1.615 raeburn 9121: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9122: &Apache::lonnet::get_instuser($udom,undef,$id);
9123: }
1.615 raeburn 9124: } else {
9125: ($inst_response,%{$inst_results->{$user}}) =
9126: &Apache::lonnet::get_instuser($udom,$uname);
9127: return;
1.612 raeburn 9128: }
1.615 raeburn 9129: if (!$got_rules->{$udom}) {
1.612 raeburn 9130: my %domconfig = &Apache::lonnet::get_dom('configuration',
9131: ['usercreation'],$udom);
9132: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9133: foreach my $item ('username','id') {
1.612 raeburn 9134: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9135: $$curr_rules{$udom}{$item} =
9136: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9137: }
9138: }
9139: }
1.615 raeburn 9140: $got_rules->{$udom} = 1;
1.585 raeburn 9141: }
1.612 raeburn 9142: foreach my $item (keys(%{$checks})) {
9143: if (ref($$curr_rules{$udom}) eq 'HASH') {
9144: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9145: if (@{$$curr_rules{$udom}{$item}} > 0) {
9146: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9147: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9148: if ($rule_check{$rule}) {
9149: $$rulematch{$user}{$item} = $rule;
9150: if ($inst_response eq 'ok') {
1.615 raeburn 9151: if (ref($inst_results) eq 'HASH') {
9152: if (ref($inst_results->{$user}) eq 'HASH') {
9153: if (keys(%{$inst_results->{$user}}) == 0) {
9154: $$alerts{$item}{$udom}{$uname} = 1;
9155: }
1.612 raeburn 9156: }
9157: }
1.615 raeburn 9158: }
9159: last;
1.585 raeburn 9160: }
9161: }
9162: }
9163: }
9164: }
9165: }
9166: }
9167: }
1.612 raeburn 9168: return;
9169: }
9170:
9171: sub user_rule_formats {
9172: my ($domain,$domdesc,$curr_rules,$check) = @_;
9173: my %text = (
9174: 'username' => 'Usernames',
9175: 'id' => 'IDs',
9176: );
9177: my $output;
9178: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9179: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9180: if (@{$ruleorder} > 0) {
1.1102 raeburn 9181: $output = '<br />'.
9182: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9183: '<span class="LC_cusr_emph">','</span>',$domdesc).
9184: ' <ul>';
1.612 raeburn 9185: foreach my $rule (@{$ruleorder}) {
9186: if (ref($curr_rules) eq 'ARRAY') {
9187: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9188: if (ref($rules->{$rule}) eq 'HASH') {
9189: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9190: $rules->{$rule}{'desc'}.'</li>';
9191: }
9192: }
9193: }
9194: }
9195: $output .= '</ul>';
9196: }
9197: }
9198: return $output;
9199: }
9200:
9201: sub instrule_disallow_msg {
1.615 raeburn 9202: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9203: my $response;
9204: my %text = (
9205: item => 'username',
9206: items => 'usernames',
9207: match => 'matches',
9208: do => 'does',
9209: action => 'a username',
9210: one => 'one',
9211: );
9212: if ($count > 1) {
9213: $text{'item'} = 'usernames';
9214: $text{'match'} ='match';
9215: $text{'do'} = 'do';
9216: $text{'action'} = 'usernames',
9217: $text{'one'} = 'ones';
9218: }
9219: if ($checkitem eq 'id') {
9220: $text{'items'} = 'IDs';
9221: $text{'item'} = 'ID';
9222: $text{'action'} = 'an ID';
1.615 raeburn 9223: if ($count > 1) {
9224: $text{'item'} = 'IDs';
9225: $text{'action'} = 'IDs';
9226: }
1.612 raeburn 9227: }
1.674 bisitz 9228: $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 9229: if ($mode eq 'upload') {
9230: if ($checkitem eq 'username') {
9231: $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'}.");
9232: } elsif ($checkitem eq 'id') {
1.674 bisitz 9233: $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 9234: }
1.669 raeburn 9235: } elsif ($mode eq 'selfcreate') {
9236: if ($checkitem eq 'id') {
9237: $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.");
9238: }
1.615 raeburn 9239: } else {
9240: if ($checkitem eq 'username') {
9241: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9242: } elsif ($checkitem eq 'id') {
9243: $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.");
9244: }
1.612 raeburn 9245: }
9246: return $response;
1.585 raeburn 9247: }
9248:
1.624 raeburn 9249: sub personal_data_fieldtitles {
9250: my %fieldtitles = &Apache::lonlocal::texthash (
9251: id => 'Student/Employee ID',
9252: permanentemail => 'E-mail address',
9253: lastname => 'Last Name',
9254: firstname => 'First Name',
9255: middlename => 'Middle Name',
9256: generation => 'Generation',
9257: gen => 'Generation',
1.765 raeburn 9258: inststatus => 'Affiliation',
1.624 raeburn 9259: );
9260: return %fieldtitles;
9261: }
9262:
1.642 raeburn 9263: sub sorted_inst_types {
9264: my ($dom) = @_;
9265: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9266: my $othertitle = &mt('All users');
9267: if ($env{'request.course.id'}) {
1.668 raeburn 9268: $othertitle = &mt('Any users');
1.642 raeburn 9269: }
9270: my @types;
9271: if (ref($order) eq 'ARRAY') {
9272: @types = @{$order};
9273: }
9274: if (@types == 0) {
9275: if (ref($usertypes) eq 'HASH') {
9276: @types = sort(keys(%{$usertypes}));
9277: }
9278: }
9279: if (keys(%{$usertypes}) > 0) {
9280: $othertitle = &mt('Other users');
9281: }
9282: return ($othertitle,$usertypes,\@types);
9283: }
9284:
1.645 raeburn 9285: sub get_institutional_codes {
9286: my ($settings,$allcourses,$LC_code) = @_;
9287: # Get complete list of course sections to update
9288: my @currsections = ();
9289: my @currxlists = ();
9290: my $coursecode = $$settings{'internal.coursecode'};
9291:
9292: if ($$settings{'internal.sectionnums'} ne '') {
9293: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9294: }
9295:
9296: if ($$settings{'internal.crosslistings'} ne '') {
9297: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9298: }
9299:
9300: if (@currxlists > 0) {
9301: foreach (@currxlists) {
9302: if (m/^([^:]+):(\w*)$/) {
9303: unless (grep/^$1$/,@{$allcourses}) {
9304: push @{$allcourses},$1;
9305: $$LC_code{$1} = $2;
9306: }
9307: }
9308: }
9309: }
9310:
9311: if (@currsections > 0) {
9312: foreach (@currsections) {
9313: if (m/^(\w+):(\w*)$/) {
9314: my $sec = $coursecode.$1;
9315: my $lc_sec = $2;
9316: unless (grep/^$sec$/,@{$allcourses}) {
9317: push @{$allcourses},$sec;
9318: $$LC_code{$sec} = $lc_sec;
9319: }
9320: }
9321: }
9322: }
9323: return;
9324: }
9325:
1.971 raeburn 9326: sub get_standard_codeitems {
9327: return ('Year','Semester','Department','Number','Section');
9328: }
9329:
1.112 bowersj2 9330: =pod
9331:
1.780 raeburn 9332: =head1 Slot Helpers
9333:
9334: =over 4
9335:
9336: =item * sorted_slots()
9337:
1.1040 raeburn 9338: Sorts an array of slot names in order of an optional sort key,
9339: default sort is by slot start time (earliest first).
1.780 raeburn 9340:
9341: Inputs:
9342:
9343: =over 4
9344:
9345: slotsarr - Reference to array of unsorted slot names.
9346:
9347: slots - Reference to hash of hash, where outer hash keys are slot names.
9348:
1.1040 raeburn 9349: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9350:
1.549 albertel 9351: =back
9352:
1.780 raeburn 9353: Returns:
9354:
9355: =over 4
9356:
1.1040 raeburn 9357: sorted - An array of slot names sorted by a specified sort key
9358: (default sort key is start time of the slot).
1.780 raeburn 9359:
9360: =back
9361:
9362: =cut
9363:
9364:
9365: sub sorted_slots {
1.1040 raeburn 9366: my ($slotsarr,$slots,$sortkey) = @_;
9367: if ($sortkey eq '') {
9368: $sortkey = 'starttime';
9369: }
1.780 raeburn 9370: my @sorted;
9371: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9372: @sorted =
9373: sort {
9374: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9375: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9376: }
9377: if (ref($slots->{$a})) { return -1;}
9378: if (ref($slots->{$b})) { return 1;}
9379: return 0;
9380: } @{$slotsarr};
9381: }
9382: return @sorted;
9383: }
9384:
1.1040 raeburn 9385: =pod
9386:
9387: =item * get_future_slots()
9388:
9389: Inputs:
9390:
9391: =over 4
9392:
9393: cnum - course number
9394:
9395: cdom - course domain
9396:
9397: now - current UNIX time
9398:
9399: symb - optional symb
9400:
9401: =back
9402:
9403: Returns:
9404:
9405: =over 4
9406:
9407: sorted_reservable - ref to array of student_schedulable slots currently
9408: reservable, ordered by end date of reservation period.
9409:
9410: reservable_now - ref to hash of student_schedulable slots currently
9411: reservable.
9412:
9413: Keys in inner hash are:
9414: (a) symb: either blank or symb to which slot use is restricted.
9415: (b) endreserve: end date of reservation period.
9416:
9417: sorted_future - ref to array of student_schedulable slots reservable in
9418: the future, ordered by start date of reservation period.
9419:
9420: future_reservable - ref to hash of student_schedulable slots reservable
9421: in the future.
9422:
9423: Keys in inner hash are:
9424: (a) symb: either blank or symb to which slot use is restricted.
9425: (b) startreserve: start date of reservation period.
9426:
9427: =back
9428:
9429: =cut
9430:
9431: sub get_future_slots {
9432: my ($cnum,$cdom,$now,$symb) = @_;
9433: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9434: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9435: foreach my $slot (keys(%slots)) {
9436: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9437: if ($symb) {
9438: next if (($slots{$slot}->{'symb'} ne '') &&
9439: ($slots{$slot}->{'symb'} ne $symb));
9440: }
9441: if (($slots{$slot}->{'starttime'} > $now) &&
9442: ($slots{$slot}->{'endtime'} > $now)) {
9443: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9444: my $userallowed = 0;
9445: if ($slots{$slot}->{'allowedsections'}) {
9446: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9447: if (!defined($env{'request.role.sec'})
9448: && grep(/^No section assigned$/,@allowed_sec)) {
9449: $userallowed=1;
9450: } else {
9451: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9452: $userallowed=1;
9453: }
9454: }
9455: unless ($userallowed) {
9456: if (defined($env{'request.course.groups'})) {
9457: my @groups = split(/:/,$env{'request.course.groups'});
9458: foreach my $group (@groups) {
9459: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9460: $userallowed=1;
9461: last;
9462: }
9463: }
9464: }
9465: }
9466: }
9467: if ($slots{$slot}->{'allowedusers'}) {
9468: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9469: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9470: if (grep(/^\Q$user\E$/,@allowed_users)) {
9471: $userallowed = 1;
9472: }
9473: }
9474: next unless($userallowed);
9475: }
9476: my $startreserve = $slots{$slot}->{'startreserve'};
9477: my $endreserve = $slots{$slot}->{'endreserve'};
9478: my $symb = $slots{$slot}->{'symb'};
9479: if (($startreserve < $now) &&
9480: (!$endreserve || $endreserve > $now)) {
9481: my $lastres = $endreserve;
9482: if (!$lastres) {
9483: $lastres = $slots{$slot}->{'starttime'};
9484: }
9485: $reservable_now{$slot} = {
9486: symb => $symb,
9487: endreserve => $lastres
9488: };
9489: } elsif (($startreserve > $now) &&
9490: (!$endreserve || $endreserve > $startreserve)) {
9491: $future_reservable{$slot} = {
9492: symb => $symb,
9493: startreserve => $startreserve
9494: };
9495: }
9496: }
9497: }
9498: my @unsorted_reservable = keys(%reservable_now);
9499: if (@unsorted_reservable > 0) {
9500: @sorted_reservable =
9501: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9502: }
9503: my @unsorted_future = keys(%future_reservable);
9504: if (@unsorted_future > 0) {
9505: @sorted_future =
9506: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9507: }
9508: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9509: }
1.780 raeburn 9510:
9511: =pod
9512:
1.1057 foxr 9513: =back
9514:
1.549 albertel 9515: =head1 HTTP Helpers
9516:
9517: =over 4
9518:
1.648 raeburn 9519: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9520:
1.258 albertel 9521: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9522: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9523: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9524:
9525: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9526: $possible_names is an ref to an array of form element names. As an example:
9527: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9528: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9529:
9530: =cut
1.1 albertel 9531:
1.6 albertel 9532: sub get_unprocessed_cgi {
1.25 albertel 9533: my ($query,$possible_names)= @_;
1.26 matthew 9534: # $Apache::lonxml::debug=1;
1.356 albertel 9535: foreach my $pair (split(/&/,$query)) {
9536: my ($name, $value) = split(/=/,$pair);
1.369 www 9537: $name = &unescape($name);
1.25 albertel 9538: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9539: $value =~ tr/+/ /;
9540: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9541: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9542: }
1.16 harris41 9543: }
1.6 albertel 9544: }
9545:
1.112 bowersj2 9546: =pod
9547:
1.648 raeburn 9548: =item * &cacheheader()
1.112 bowersj2 9549:
9550: returns cache-controlling header code
9551:
9552: =cut
9553:
1.7 albertel 9554: sub cacheheader {
1.258 albertel 9555: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9556: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9557: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9558: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9559: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9560: return $output;
1.7 albertel 9561: }
9562:
1.112 bowersj2 9563: =pod
9564:
1.648 raeburn 9565: =item * &no_cache($r)
1.112 bowersj2 9566:
9567: specifies header code to not have cache
9568:
9569: =cut
9570:
1.9 albertel 9571: sub no_cache {
1.216 albertel 9572: my ($r) = @_;
9573: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9574: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9575: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9576: $r->no_cache(1);
9577: $r->header_out("Expires" => $date);
9578: $r->header_out("Pragma" => "no-cache");
1.123 www 9579: }
9580:
9581: sub content_type {
1.181 albertel 9582: my ($r,$type,$charset) = @_;
1.299 foxr 9583: if ($r) {
9584: # Note that printout.pl calls this with undef for $r.
9585: &no_cache($r);
9586: }
1.258 albertel 9587: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9588: unless ($charset) {
9589: $charset=&Apache::lonlocal::current_encoding;
9590: }
9591: if ($charset) { $type.='; charset='.$charset; }
9592: if ($r) {
9593: $r->content_type($type);
9594: } else {
9595: print("Content-type: $type\n\n");
9596: }
1.9 albertel 9597: }
1.25 albertel 9598:
1.112 bowersj2 9599: =pod
9600:
1.648 raeburn 9601: =item * &add_to_env($name,$value)
1.112 bowersj2 9602:
1.258 albertel 9603: adds $name to the %env hash with value
1.112 bowersj2 9604: $value, if $name already exists, the entry is converted to an array
9605: reference and $value is added to the array.
9606:
9607: =cut
9608:
1.25 albertel 9609: sub add_to_env {
9610: my ($name,$value)=@_;
1.258 albertel 9611: if (defined($env{$name})) {
9612: if (ref($env{$name})) {
1.25 albertel 9613: #already have multiple values
1.258 albertel 9614: push(@{ $env{$name} },$value);
1.25 albertel 9615: } else {
9616: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9617: my $first=$env{$name};
9618: undef($env{$name});
9619: push(@{ $env{$name} },$first,$value);
1.25 albertel 9620: }
9621: } else {
1.258 albertel 9622: $env{$name}=$value;
1.25 albertel 9623: }
1.31 albertel 9624: }
1.149 albertel 9625:
9626: =pod
9627:
1.648 raeburn 9628: =item * &get_env_multiple($name)
1.149 albertel 9629:
1.258 albertel 9630: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9631: values may be defined and end up as an array ref.
9632:
9633: returns an array of values
9634:
9635: =cut
9636:
9637: sub get_env_multiple {
9638: my ($name) = @_;
9639: my @values;
1.258 albertel 9640: if (defined($env{$name})) {
1.149 albertel 9641: # exists is it an array
1.258 albertel 9642: if (ref($env{$name})) {
9643: @values=@{ $env{$name} };
1.149 albertel 9644: } else {
1.258 albertel 9645: $values[0]=$env{$name};
1.149 albertel 9646: }
9647: }
9648: return(@values);
9649: }
9650:
1.660 raeburn 9651: sub ask_for_embedded_content {
9652: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9653: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 9654: %currsubfile,%unused,$rem);
1.1071 raeburn 9655: my $counter = 0;
9656: my $numnew = 0;
1.987 raeburn 9657: my $numremref = 0;
9658: my $numinvalid = 0;
9659: my $numpathchg = 0;
9660: my $numexisting = 0;
1.1071 raeburn 9661: my $numunused = 0;
9662: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9663: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9664: my $heading = &mt('Upload embedded files');
9665: my $buttontext = &mt('Upload');
9666:
1.1123 raeburn 9667: my ($navmap,$cdom,$cnum);
1.1085 raeburn 9668: if ($env{'request.course.id'}) {
1.1123 raeburn 9669: if ($actionurl eq '/adm/dependencies') {
9670: $navmap = Apache::lonnavmaps::navmap->new();
9671: }
9672: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9673: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 9674: }
1.1123 raeburn 9675: if (($actionurl eq '/adm/portfolio') ||
9676: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 9677: my $current_path='/';
9678: if ($env{'form.currentpath'}) {
9679: $current_path = $env{'form.currentpath'};
9680: }
9681: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 9682: $udom = $cdom;
9683: $uname = $cnum;
1.984 raeburn 9684: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9685: } else {
9686: $udom = $env{'user.domain'};
9687: $uname = $env{'user.name'};
9688: $url = '/userfiles/portfolio';
9689: }
1.987 raeburn 9690: $toplevel = $url.'/';
1.984 raeburn 9691: $url .= $current_path;
9692: $getpropath = 1;
1.987 raeburn 9693: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9694: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9695: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9696: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9697: $toplevel = $url;
1.984 raeburn 9698: if ($rest ne '') {
1.987 raeburn 9699: $url .= $rest;
9700: }
9701: } elsif ($actionurl eq '/adm/coursedocs') {
9702: if (ref($args) eq 'HASH') {
1.1071 raeburn 9703: $url = $args->{'docs_url'};
9704: $toplevel = $url;
1.1084 raeburn 9705: if ($args->{'context'} eq 'paste') {
9706: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9707: ($path) =
9708: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9709: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9710: $fileloc =~ s{^/}{};
9711: }
1.1071 raeburn 9712: }
1.1084 raeburn 9713: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 9714: if ($env{'request.course.id'} ne '') {
9715: if (ref($args) eq 'HASH') {
9716: $url = $args->{'docs_url'};
9717: $title = $args->{'docs_title'};
1.1126 raeburn 9718: $toplevel = $url;
9719: unless ($toplevel =~ m{^/}) {
9720: $toplevel = "/$url";
9721: }
1.1085 raeburn 9722: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 9723: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
9724: $path = $1;
9725: } else {
9726: ($path) =
9727: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9728: }
1.1071 raeburn 9729: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9730: $fileloc =~ s{^/}{};
9731: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9732: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9733: }
1.987 raeburn 9734: }
1.1123 raeburn 9735: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9736: $udom = $cdom;
9737: $uname = $cnum;
9738: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
9739: $toplevel = $url;
9740: $path = $url;
9741: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
9742: $fileloc =~ s{^/}{};
1.987 raeburn 9743: }
1.1126 raeburn 9744: foreach my $file (keys(%{$allfiles})) {
9745: my $embed_file;
9746: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
9747: $embed_file = $1;
9748: } else {
9749: $embed_file = $file;
9750: }
1.987 raeburn 9751: my $absolutepath;
9752: if ($embed_file =~ m{^\w+://}) {
9753: $newfiles{$embed_file} = 1;
9754: $mapping{$embed_file} = $embed_file;
9755: } else {
9756: if ($embed_file =~ m{^/}) {
9757: $absolutepath = $embed_file;
9758: $embed_file =~ s{^(/+)}{};
9759: }
9760: if ($embed_file =~ m{/}) {
9761: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9762: $path = &check_for_traversal($path,$url,$toplevel);
9763: my $item = $fname;
9764: if ($path ne '') {
9765: $item = $path.'/'.$fname;
9766: $subdependencies{$path}{$fname} = 1;
9767: } else {
9768: $dependencies{$item} = 1;
9769: }
9770: if ($absolutepath) {
9771: $mapping{$item} = $absolutepath;
9772: } else {
9773: $mapping{$item} = $embed_file;
9774: }
9775: } else {
9776: $dependencies{$embed_file} = 1;
9777: if ($absolutepath) {
9778: $mapping{$embed_file} = $absolutepath;
9779: } else {
9780: $mapping{$embed_file} = $embed_file;
9781: }
9782: }
1.984 raeburn 9783: }
9784: }
1.1071 raeburn 9785: my $dirptr = 16384;
1.984 raeburn 9786: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9787: $currsubfile{$path} = {};
1.1123 raeburn 9788: if (($actionurl eq '/adm/portfolio') ||
9789: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9790: my ($sublistref,$listerror) =
9791: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9792: if (ref($sublistref) eq 'ARRAY') {
9793: foreach my $line (@{$sublistref}) {
9794: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9795: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9796: }
1.984 raeburn 9797: }
1.987 raeburn 9798: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9799: if (opendir(my $dir,$url.'/'.$path)) {
9800: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9801: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9802: }
1.1084 raeburn 9803: } elsif (($actionurl eq '/adm/dependencies') ||
9804: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 9805: ($args->{'context'} eq 'paste')) ||
9806: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9807: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 9808: my $dir;
9809: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9810: $dir = $fileloc;
9811: } else {
9812: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9813: }
1.1071 raeburn 9814: if ($dir ne '') {
9815: my ($sublistref,$listerror) =
9816: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9817: if (ref($sublistref) eq 'ARRAY') {
9818: foreach my $line (@{$sublistref}) {
9819: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9820: undef,$mtime)=split(/\&/,$line,12);
9821: unless (($testdir&$dirptr) ||
9822: ($file_name =~ /^\.\.?$/)) {
9823: $currsubfile{$path}{$file_name} = [$size,$mtime];
9824: }
9825: }
9826: }
9827: }
1.984 raeburn 9828: }
9829: }
9830: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9831: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9832: my $item = $path.'/'.$file;
9833: unless ($mapping{$item} eq $item) {
9834: $pathchanges{$item} = 1;
9835: }
9836: $existing{$item} = 1;
9837: $numexisting ++;
9838: } else {
9839: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9840: }
9841: }
1.1071 raeburn 9842: if ($actionurl eq '/adm/dependencies') {
9843: foreach my $path (keys(%currsubfile)) {
9844: if (ref($currsubfile{$path}) eq 'HASH') {
9845: foreach my $file (keys(%{$currsubfile{$path}})) {
9846: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 9847: next if (($rem ne '') &&
9848: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9849: (ref($navmap) &&
9850: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9851: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9852: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9853: $unused{$path.'/'.$file} = 1;
9854: }
9855: }
9856: }
9857: }
9858: }
1.984 raeburn 9859: }
1.987 raeburn 9860: my %currfile;
1.1123 raeburn 9861: if (($actionurl eq '/adm/portfolio') ||
9862: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9863: my ($dirlistref,$listerror) =
9864: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9865: if (ref($dirlistref) eq 'ARRAY') {
9866: foreach my $line (@{$dirlistref}) {
9867: my ($file_name,$rest) = split(/\&/,$line,2);
9868: $currfile{$file_name} = 1;
9869: }
1.984 raeburn 9870: }
1.987 raeburn 9871: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9872: if (opendir(my $dir,$url)) {
1.987 raeburn 9873: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9874: map {$currfile{$_} = 1;} @dir_list;
9875: }
1.1084 raeburn 9876: } elsif (($actionurl eq '/adm/dependencies') ||
9877: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 9878: ($args->{'context'} eq 'paste')) ||
9879: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9880: if ($env{'request.course.id'} ne '') {
9881: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9882: if ($dir ne '') {
9883: my ($dirlistref,$listerror) =
9884: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9885: if (ref($dirlistref) eq 'ARRAY') {
9886: foreach my $line (@{$dirlistref}) {
9887: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9888: $size,undef,$mtime)=split(/\&/,$line,12);
9889: unless (($testdir&$dirptr) ||
9890: ($file_name =~ /^\.\.?$/)) {
9891: $currfile{$file_name} = [$size,$mtime];
9892: }
9893: }
9894: }
9895: }
9896: }
1.984 raeburn 9897: }
9898: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9899: if (exists($currfile{$file})) {
1.987 raeburn 9900: unless ($mapping{$file} eq $file) {
9901: $pathchanges{$file} = 1;
9902: }
9903: $existing{$file} = 1;
9904: $numexisting ++;
9905: } else {
1.984 raeburn 9906: $newfiles{$file} = 1;
9907: }
9908: }
1.1071 raeburn 9909: foreach my $file (keys(%currfile)) {
9910: unless (($file eq $filename) ||
9911: ($file eq $filename.'.bak') ||
9912: ($dependencies{$file})) {
1.1085 raeburn 9913: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 9914: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
9915: next if (($rem ne '') &&
9916: (($env{"httpref.$rem".$file} ne '') ||
9917: (ref($navmap) &&
9918: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9919: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9920: ($navmap->getResourceByUrl($rem.$1)))))));
9921: }
1.1085 raeburn 9922: }
1.1071 raeburn 9923: $unused{$file} = 1;
9924: }
9925: }
1.1084 raeburn 9926: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9927: ($args->{'context'} eq 'paste')) {
9928: $counter = scalar(keys(%existing));
9929: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 9930: return ($output,$counter,$numpathchg,\%existing);
9931: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
9932: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
9933: $counter = scalar(keys(%existing));
9934: $numpathchg = scalar(keys(%pathchanges));
9935: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 9936: }
1.984 raeburn 9937: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9938: if ($actionurl eq '/adm/dependencies') {
9939: next if ($embed_file =~ m{^\w+://});
9940: }
1.660 raeburn 9941: $upload_output .= &start_data_table_row().
1.1123 raeburn 9942: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 9943: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9944: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 9945: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
9946: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 9947: }
1.1123 raeburn 9948: $upload_output .= '</td>';
1.1071 raeburn 9949: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 9950: $upload_output.='<td align="right">'.
9951: '<span class="LC_info LC_fontsize_medium">'.
9952: &mt("URL points to web address").'</span>';
1.987 raeburn 9953: $numremref++;
1.660 raeburn 9954: } elsif ($args->{'error_on_invalid_names'}
9955: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 9956: $upload_output.='<td align="right"><span class="LC_warning">'.
9957: &mt('Invalid characters').'</span>';
1.987 raeburn 9958: $numinvalid++;
1.660 raeburn 9959: } else {
1.1123 raeburn 9960: $upload_output .= '<td>'.
9961: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9962: $embed_file,\%mapping,
1.1071 raeburn 9963: $allfiles,$codebase,'upload');
9964: $counter ++;
9965: $numnew ++;
1.987 raeburn 9966: }
9967: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9968: }
9969: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9970: if ($actionurl eq '/adm/dependencies') {
9971: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9972: $modify_output .= &start_data_table_row().
9973: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9974: '<img src="'.&icon($embed_file).'" border="0" />'.
9975: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9976: '<td>'.$size.'</td>'.
9977: '<td>'.$mtime.'</td>'.
9978: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9979: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9980: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9981: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9982: &embedded_file_element('upload_embedded',$counter,
9983: $embed_file,\%mapping,
9984: $allfiles,$codebase,'modify').
9985: '</div></td>'.
9986: &end_data_table_row()."\n";
9987: $counter ++;
9988: } else {
9989: $upload_output .= &start_data_table_row().
1.1123 raeburn 9990: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
9991: '<span class="LC_filename">'.$embed_file.'</span></td>'.
9992: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 9993: &Apache::loncommon::end_data_table_row()."\n";
9994: }
9995: }
9996: my $delidx = $counter;
9997: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9998: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9999: $delete_output .= &start_data_table_row().
10000: '<td><img src="'.&icon($oldfile).'" />'.
10001: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
10002: '<td>'.$size.'</td>'.
10003: '<td>'.$mtime.'</td>'.
10004: '<td><label><input type="checkbox" name="del_upload_dep" '.
10005: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
10006: &embedded_file_element('upload_embedded',$delidx,
10007: $oldfile,\%mapping,$allfiles,
10008: $codebase,'delete').'</td>'.
10009: &end_data_table_row()."\n";
10010: $numunused ++;
10011: $delidx ++;
1.987 raeburn 10012: }
10013: if ($upload_output) {
10014: $upload_output = &start_data_table().
10015: $upload_output.
10016: &end_data_table()."\n";
10017: }
1.1071 raeburn 10018: if ($modify_output) {
10019: $modify_output = &start_data_table().
10020: &start_data_table_header_row().
10021: '<th>'.&mt('File').'</th>'.
10022: '<th>'.&mt('Size (KB)').'</th>'.
10023: '<th>'.&mt('Modified').'</th>'.
10024: '<th>'.&mt('Upload replacement?').'</th>'.
10025: &end_data_table_header_row().
10026: $modify_output.
10027: &end_data_table()."\n";
10028: }
10029: if ($delete_output) {
10030: $delete_output = &start_data_table().
10031: &start_data_table_header_row().
10032: '<th>'.&mt('File').'</th>'.
10033: '<th>'.&mt('Size (KB)').'</th>'.
10034: '<th>'.&mt('Modified').'</th>'.
10035: '<th>'.&mt('Delete?').'</th>'.
10036: &end_data_table_header_row().
10037: $delete_output.
10038: &end_data_table()."\n";
10039: }
1.987 raeburn 10040: my $applies = 0;
10041: if ($numremref) {
10042: $applies ++;
10043: }
10044: if ($numinvalid) {
10045: $applies ++;
10046: }
10047: if ($numexisting) {
10048: $applies ++;
10049: }
1.1071 raeburn 10050: if ($counter || $numunused) {
1.987 raeburn 10051: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
10052: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 10053: $state.'<h3>'.$heading.'</h3>';
10054: if ($actionurl eq '/adm/dependencies') {
10055: if ($numnew) {
10056: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
10057: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
10058: $upload_output.'<br />'."\n";
10059: }
10060: if ($numexisting) {
10061: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
10062: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
10063: $modify_output.'<br />'."\n";
10064: $buttontext = &mt('Save changes');
10065: }
10066: if ($numunused) {
10067: $output .= '<h4>'.&mt('Unused files').'</h4>'.
10068: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
10069: $delete_output.'<br />'."\n";
10070: $buttontext = &mt('Save changes');
10071: }
10072: } else {
10073: $output .= $upload_output.'<br />'."\n";
10074: }
10075: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
10076: $counter.'" />'."\n";
10077: if ($actionurl eq '/adm/dependencies') {
10078: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
10079: $numnew.'" />'."\n";
10080: } elsif ($actionurl eq '') {
1.987 raeburn 10081: $output .= '<input type="hidden" name="phase" value="three" />';
10082: }
10083: } elsif ($applies) {
10084: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
10085: if ($applies > 1) {
10086: $output .=
1.1123 raeburn 10087: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 10088: if ($numremref) {
10089: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
10090: }
10091: if ($numinvalid) {
10092: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
10093: }
10094: if ($numexisting) {
10095: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
10096: }
10097: $output .= '</ul><br />';
10098: } elsif ($numremref) {
10099: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
10100: } elsif ($numinvalid) {
10101: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
10102: } elsif ($numexisting) {
10103: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
10104: }
10105: $output .= $upload_output.'<br />';
10106: }
10107: my ($pathchange_output,$chgcount);
1.1071 raeburn 10108: $chgcount = $counter;
1.987 raeburn 10109: if (keys(%pathchanges) > 0) {
10110: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 10111: if ($counter) {
1.987 raeburn 10112: $output .= &embedded_file_element('pathchange',$chgcount,
10113: $embed_file,\%mapping,
1.1071 raeburn 10114: $allfiles,$codebase,'change');
1.987 raeburn 10115: } else {
10116: $pathchange_output .=
10117: &start_data_table_row().
10118: '<td><input type ="checkbox" name="namechange" value="'.
10119: $chgcount.'" checked="checked" /></td>'.
10120: '<td>'.$mapping{$embed_file}.'</td>'.
10121: '<td>'.$embed_file.
10122: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10123: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10124: '</td>'.&end_data_table_row();
1.660 raeburn 10125: }
1.987 raeburn 10126: $numpathchg ++;
10127: $chgcount ++;
1.660 raeburn 10128: }
10129: }
1.1127 raeburn 10130: if (($counter) || ($numunused)) {
1.987 raeburn 10131: if ($numpathchg) {
10132: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10133: $numpathchg.'" />'."\n";
10134: }
10135: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10136: ($actionurl eq '/adm/imsimport')) {
10137: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10138: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10139: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10140: } elsif ($actionurl eq '/adm/dependencies') {
10141: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10142: }
1.1123 raeburn 10143: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10144: } elsif ($numpathchg) {
10145: my %pathchange = ();
10146: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10147: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10148: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 10149: }
1.987 raeburn 10150: }
1.1071 raeburn 10151: return ($output,$counter,$numpathchg);
1.987 raeburn 10152: }
10153:
10154: sub embedded_file_element {
1.1071 raeburn 10155: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10156: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10157: (ref($codebase) eq 'HASH'));
10158: my $output;
1.1071 raeburn 10159: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10160: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10161: }
10162: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10163: &escape($embed_file).'" />';
10164: unless (($context eq 'upload_embedded') &&
10165: ($mapping->{$embed_file} eq $embed_file)) {
10166: $output .='
10167: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10168: }
10169: my $attrib;
10170: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10171: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10172: }
10173: $output .=
10174: "\n\t\t".
10175: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10176: $attrib.'" />';
10177: if (exists($codebase->{$mapping->{$embed_file}})) {
10178: $output .=
10179: "\n\t\t".
10180: '<input name="codebase_'.$num.'" type="hidden" value="'.
10181: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10182: }
1.987 raeburn 10183: return $output;
1.660 raeburn 10184: }
10185:
1.1071 raeburn 10186: sub get_dependency_details {
10187: my ($currfile,$currsubfile,$embed_file) = @_;
10188: my ($size,$mtime,$showsize,$showmtime);
10189: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10190: if ($embed_file =~ m{/}) {
10191: my ($path,$fname) = split(/\//,$embed_file);
10192: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10193: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10194: }
10195: } else {
10196: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10197: ($size,$mtime) = @{$currfile->{$embed_file}};
10198: }
10199: }
10200: $showsize = $size/1024.0;
10201: $showsize = sprintf("%.1f",$showsize);
10202: if ($mtime > 0) {
10203: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10204: }
10205: }
10206: return ($showsize,$showmtime);
10207: }
10208:
10209: sub ask_embedded_js {
10210: return <<"END";
10211: <script type="text/javascript"">
10212: // <![CDATA[
10213: function toggleBrowse(counter) {
10214: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10215: var fileid = document.getElementById('embedded_item_'+counter);
10216: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10217: if (chkboxid.checked == true) {
10218: uploaddivid.style.display='block';
10219: } else {
10220: uploaddivid.style.display='none';
10221: fileid.value = '';
10222: }
10223: }
10224: // ]]>
10225: </script>
10226:
10227: END
10228: }
10229:
1.661 raeburn 10230: sub upload_embedded {
10231: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10232: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10233: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10234: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10235: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10236: my $orig_uploaded_filename =
10237: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10238: foreach my $type ('orig','ref','attrib','codebase') {
10239: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10240: $env{'form.embedded_'.$type.'_'.$i} =
10241: &unescape($env{'form.embedded_'.$type.'_'.$i});
10242: }
10243: }
1.661 raeburn 10244: my ($path,$fname) =
10245: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10246: # no path, whole string is fname
10247: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10248: $fname = &Apache::lonnet::clean_filename($fname);
10249: # See if there is anything left
10250: next if ($fname eq '');
10251:
10252: # Check if file already exists as a file or directory.
10253: my ($state,$msg);
10254: if ($context eq 'portfolio') {
10255: my $port_path = $dirpath;
10256: if ($group ne '') {
10257: $port_path = "groups/$group/$port_path";
10258: }
1.987 raeburn 10259: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10260: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10261: $dir_root,$port_path,$disk_quota,
10262: $current_disk_usage,$uname,$udom);
10263: if ($state eq 'will_exceed_quota'
1.984 raeburn 10264: || $state eq 'file_locked') {
1.661 raeburn 10265: $output .= $msg;
10266: next;
10267: }
10268: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10269: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10270: if ($state eq 'exists') {
10271: $output .= $msg;
10272: next;
10273: }
10274: }
10275: # Check if extension is valid
10276: if (($fname =~ /\.(\w+)$/) &&
10277: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10278: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661 raeburn 10279: next;
10280: } elsif (($fname =~ /\.(\w+)$/) &&
10281: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10282: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10283: next;
10284: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 10285: $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 10286: next;
10287: }
10288: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 10289: my $subdir = $path;
10290: $subdir =~ s{/+$}{};
1.661 raeburn 10291: if ($context eq 'portfolio') {
1.984 raeburn 10292: my $result;
10293: if ($state eq 'existingfile') {
10294: $result=
10295: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 10296: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10297: } else {
1.984 raeburn 10298: $result=
10299: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10300: $dirpath.
1.1123 raeburn 10301: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10302: if ($result !~ m|^/uploaded/|) {
10303: $output .= '<span class="LC_error">'
10304: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10305: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10306: .'</span><br />';
10307: next;
10308: } else {
1.987 raeburn 10309: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10310: $path.$fname.'</span>').'<br />';
1.984 raeburn 10311: }
1.661 raeburn 10312: }
1.1123 raeburn 10313: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 10314: my $extendedsubdir = $dirpath.'/'.$subdir;
10315: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10316: my $result =
1.1126 raeburn 10317: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10318: if ($result !~ m|^/uploaded/|) {
10319: $output .= '<span class="LC_error">'
10320: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10321: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10322: .'</span><br />';
10323: next;
10324: } else {
10325: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10326: $path.$fname.'</span>').'<br />';
1.1125 raeburn 10327: if ($context eq 'syllabus') {
10328: &Apache::lonnet::make_public_indefinitely($result);
10329: }
1.987 raeburn 10330: }
1.661 raeburn 10331: } else {
10332: # Save the file
10333: my $target = $env{'form.embedded_item_'.$i};
10334: my $fullpath = $dir_root.$dirpath.'/'.$path;
10335: my $dest = $fullpath.$fname;
10336: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10337: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10338: my $count;
10339: my $filepath = $dir_root;
1.1027 raeburn 10340: foreach my $subdir (@parts) {
10341: $filepath .= "/$subdir";
10342: if (!-e $filepath) {
1.661 raeburn 10343: mkdir($filepath,0770);
10344: }
10345: }
10346: my $fh;
10347: if (!open($fh,'>'.$dest)) {
10348: &Apache::lonnet::logthis('Failed to create '.$dest);
10349: $output .= '<span class="LC_error">'.
1.1071 raeburn 10350: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10351: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10352: '</span><br />';
10353: } else {
10354: if (!print $fh $env{'form.embedded_item_'.$i}) {
10355: &Apache::lonnet::logthis('Failed to write to '.$dest);
10356: $output .= '<span class="LC_error">'.
1.1071 raeburn 10357: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10358: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10359: '</span><br />';
10360: } else {
1.987 raeburn 10361: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10362: $url.'</span>').'<br />';
10363: unless ($context eq 'testbank') {
10364: $footer .= &mt('View embedded file: [_1]',
10365: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10366: }
10367: }
10368: close($fh);
10369: }
10370: }
10371: if ($env{'form.embedded_ref_'.$i}) {
10372: $pathchange{$i} = 1;
10373: }
10374: }
10375: if ($output) {
10376: $output = '<p>'.$output.'</p>';
10377: }
10378: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10379: $returnflag = 'ok';
1.1071 raeburn 10380: my $numpathchgs = scalar(keys(%pathchange));
10381: if ($numpathchgs > 0) {
1.987 raeburn 10382: if ($context eq 'portfolio') {
10383: $output .= '<p>'.&mt('or').'</p>';
10384: } elsif ($context eq 'testbank') {
1.1071 raeburn 10385: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10386: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10387: $returnflag = 'modify_orightml';
10388: }
10389: }
1.1071 raeburn 10390: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10391: }
10392:
10393: sub modify_html_form {
10394: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10395: my $end = 0;
10396: my $modifyform;
10397: if ($context eq 'upload_embedded') {
10398: return unless (ref($pathchange) eq 'HASH');
10399: if ($env{'form.number_embedded_items'}) {
10400: $end += $env{'form.number_embedded_items'};
10401: }
10402: if ($env{'form.number_pathchange_items'}) {
10403: $end += $env{'form.number_pathchange_items'};
10404: }
10405: if ($end) {
10406: for (my $i=0; $i<$end; $i++) {
10407: if ($i < $env{'form.number_embedded_items'}) {
10408: next unless($pathchange->{$i});
10409: }
10410: $modifyform .=
10411: &start_data_table_row().
10412: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10413: 'checked="checked" /></td>'.
10414: '<td>'.$env{'form.embedded_ref_'.$i}.
10415: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10416: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10417: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10418: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10419: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10420: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10421: '<td>'.$env{'form.embedded_orig_'.$i}.
10422: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10423: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10424: &end_data_table_row();
1.1071 raeburn 10425: }
1.987 raeburn 10426: }
10427: } else {
10428: $modifyform = $pathchgtable;
10429: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10430: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10431: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10432: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10433: }
10434: }
10435: if ($modifyform) {
1.1071 raeburn 10436: if ($actionurl eq '/adm/dependencies') {
10437: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10438: }
1.987 raeburn 10439: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10440: '<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".
10441: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10442: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10443: '</ol></p>'."\n".'<p>'.
10444: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10445: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10446: &start_data_table()."\n".
10447: &start_data_table_header_row().
10448: '<th>'.&mt('Change?').'</th>'.
10449: '<th>'.&mt('Current reference').'</th>'.
10450: '<th>'.&mt('Required reference').'</th>'.
10451: &end_data_table_header_row()."\n".
10452: $modifyform.
10453: &end_data_table().'<br />'."\n".$hiddenstate.
10454: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10455: '</form>'."\n";
10456: }
10457: return;
10458: }
10459:
10460: sub modify_html_refs {
1.1123 raeburn 10461: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 10462: my $container;
10463: if ($context eq 'portfolio') {
10464: $container = $env{'form.container'};
10465: } elsif ($context eq 'coursedoc') {
10466: $container = $env{'form.primaryurl'};
1.1071 raeburn 10467: } elsif ($context eq 'manage_dependencies') {
10468: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10469: $container = "/$container";
1.1123 raeburn 10470: } elsif ($context eq 'syllabus') {
10471: $container = $url;
1.987 raeburn 10472: } else {
1.1027 raeburn 10473: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10474: }
10475: my (%allfiles,%codebase,$output,$content);
10476: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 10477: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 10478: if (wantarray) {
10479: return ('',0,0);
10480: } else {
10481: return;
10482: }
10483: }
10484: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 10485: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 10486: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10487: if (wantarray) {
10488: return ('',0,0);
10489: } else {
10490: return;
10491: }
10492: }
1.987 raeburn 10493: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10494: if ($content eq '-1') {
10495: if (wantarray) {
10496: return ('',0,0);
10497: } else {
10498: return;
10499: }
10500: }
1.987 raeburn 10501: } else {
1.1071 raeburn 10502: unless ($container =~ /^\Q$dir_root\E/) {
10503: if (wantarray) {
10504: return ('',0,0);
10505: } else {
10506: return;
10507: }
10508: }
1.987 raeburn 10509: if (open(my $fh,"<$container")) {
10510: $content = join('', <$fh>);
10511: close($fh);
10512: } else {
1.1071 raeburn 10513: if (wantarray) {
10514: return ('',0,0);
10515: } else {
10516: return;
10517: }
1.987 raeburn 10518: }
10519: }
10520: my ($count,$codebasecount) = (0,0);
10521: my $mm = new File::MMagic;
10522: my $mime_type = $mm->checktype_contents($content);
10523: if ($mime_type eq 'text/html') {
10524: my $parse_result =
10525: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10526: \%codebase,\$content);
10527: if ($parse_result eq 'ok') {
10528: foreach my $i (@changes) {
10529: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10530: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10531: if ($allfiles{$ref}) {
10532: my $newname = $orig;
10533: my ($attrib_regexp,$codebase);
1.1006 raeburn 10534: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10535: if ($attrib_regexp =~ /:/) {
10536: $attrib_regexp =~ s/\:/|/g;
10537: }
10538: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10539: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10540: $count += $numchg;
1.1123 raeburn 10541: $allfiles{$newname} = $allfiles{$ref};
1.987 raeburn 10542: }
10543: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10544: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10545: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10546: $codebasecount ++;
10547: }
10548: }
10549: }
1.1123 raeburn 10550: my $skiprewrites;
1.987 raeburn 10551: if ($count || $codebasecount) {
10552: my $saveresult;
1.1071 raeburn 10553: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 10554: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 10555: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10556: if ($url eq $container) {
10557: my ($fname) = ($container =~ m{/([^/]+)$});
10558: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10559: $count,'<span class="LC_filename">'.
1.1071 raeburn 10560: $fname.'</span>').'</p>';
1.987 raeburn 10561: } else {
10562: $output = '<p class="LC_error">'.
10563: &mt('Error: update failed for: [_1].',
10564: '<span class="LC_filename">'.
10565: $container.'</span>').'</p>';
10566: }
1.1123 raeburn 10567: if ($context eq 'syllabus') {
10568: unless ($saveresult eq 'ok') {
10569: $skiprewrites = 1;
10570: }
10571: }
1.987 raeburn 10572: } else {
10573: if (open(my $fh,">$container")) {
10574: print $fh $content;
10575: close($fh);
10576: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10577: $count,'<span class="LC_filename">'.
10578: $container.'</span>').'</p>';
1.661 raeburn 10579: } else {
1.987 raeburn 10580: $output = '<p class="LC_error">'.
10581: &mt('Error: could not update [_1].',
10582: '<span class="LC_filename">'.
10583: $container.'</span>').'</p>';
1.661 raeburn 10584: }
10585: }
10586: }
1.1123 raeburn 10587: if (($context eq 'syllabus') && (!$skiprewrites)) {
10588: my ($actionurl,$state);
10589: $actionurl = "/public/$udom/$uname/syllabus";
10590: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
10591: &ask_for_embedded_content($actionurl,$state,\%allfiles,
10592: \%codebase,
10593: {'context' => 'rewrites',
10594: 'ignore_remote_references' => 1,});
10595: if (ref($mapping) eq 'HASH') {
10596: my $rewrites = 0;
10597: foreach my $key (keys(%{$mapping})) {
10598: next if ($key =~ m{^https?://});
10599: my $ref = $mapping->{$key};
10600: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
10601: my $attrib;
10602: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
10603: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
10604: }
10605: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10606: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10607: $rewrites += $numchg;
10608: }
10609: }
10610: if ($rewrites) {
10611: my $saveresult;
10612: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10613: if ($url eq $container) {
10614: my ($fname) = ($container =~ m{/([^/]+)$});
10615: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
10616: $count,'<span class="LC_filename">'.
10617: $fname.'</span>').'</p>';
10618: } else {
10619: $output .= '<p class="LC_error">'.
10620: &mt('Error: could not update links in [_1].',
10621: '<span class="LC_filename">'.
10622: $container.'</span>').'</p>';
10623:
10624: }
10625: }
10626: }
10627: }
1.987 raeburn 10628: } else {
10629: &logthis('Failed to parse '.$container.
10630: ' to modify references: '.$parse_result);
1.661 raeburn 10631: }
10632: }
1.1071 raeburn 10633: if (wantarray) {
10634: return ($output,$count,$codebasecount);
10635: } else {
10636: return $output;
10637: }
1.661 raeburn 10638: }
10639:
10640: sub check_for_existing {
10641: my ($path,$fname,$element) = @_;
10642: my ($state,$msg);
10643: if (-d $path.'/'.$fname) {
10644: $state = 'exists';
10645: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10646: } elsif (-e $path.'/'.$fname) {
10647: $state = 'exists';
10648: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10649: }
10650: if ($state eq 'exists') {
10651: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10652: }
10653: return ($state,$msg);
10654: }
10655:
10656: sub check_for_upload {
10657: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10658: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10659: my $filesize = length($env{'form.'.$element});
10660: if (!$filesize) {
10661: my $msg = '<span class="LC_error">'.
10662: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10663: '<span class="LC_filename">'.$fname.'</span>',
10664: $filesize).'<br />'.
1.1007 raeburn 10665: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10666: '</span>';
10667: return ('zero_bytes',$msg);
10668: }
10669: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10670: my $getpropath = 1;
1.1021 raeburn 10671: my ($dirlistref,$listerror) =
10672: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10673: my $found_file = 0;
10674: my $locked_file = 0;
1.991 raeburn 10675: my @lockers;
10676: my $navmap;
10677: if ($env{'request.course.id'}) {
10678: $navmap = Apache::lonnavmaps::navmap->new();
10679: }
1.1021 raeburn 10680: if (ref($dirlistref) eq 'ARRAY') {
10681: foreach my $line (@{$dirlistref}) {
10682: my ($file_name,$rest)=split(/\&/,$line,2);
10683: if ($file_name eq $fname){
10684: $file_name = $path.$file_name;
10685: if ($group ne '') {
10686: $file_name = $group.$file_name;
10687: }
10688: $found_file = 1;
10689: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10690: foreach my $lock (@lockers) {
10691: if (ref($lock) eq 'ARRAY') {
10692: my ($symb,$crsid) = @{$lock};
10693: if ($crsid eq $env{'request.course.id'}) {
10694: if (ref($navmap)) {
10695: my $res = $navmap->getBySymb($symb);
10696: foreach my $part (@{$res->parts()}) {
10697: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10698: unless (($slot_status == $res->RESERVED) ||
10699: ($slot_status == $res->RESERVED_LOCATION)) {
10700: $locked_file = 1;
10701: }
1.991 raeburn 10702: }
1.1021 raeburn 10703: } else {
10704: $locked_file = 1;
1.991 raeburn 10705: }
10706: } else {
10707: $locked_file = 1;
10708: }
10709: }
1.1021 raeburn 10710: }
10711: } else {
10712: my @info = split(/\&/,$rest);
10713: my $currsize = $info[6]/1000;
10714: if ($currsize < $filesize) {
10715: my $extra = $filesize - $currsize;
10716: if (($current_disk_usage + $extra) > $disk_quota) {
10717: my $msg = '<span class="LC_error">'.
10718: &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.',
10719: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10720: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10721: $disk_quota,$current_disk_usage);
10722: return ('will_exceed_quota',$msg);
10723: }
1.984 raeburn 10724: }
10725: }
1.661 raeburn 10726: }
10727: }
10728: }
10729: if (($current_disk_usage + $filesize) > $disk_quota){
10730: my $msg = '<span class="LC_error">'.
10731: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10732: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10733: return ('will_exceed_quota',$msg);
10734: } elsif ($found_file) {
10735: if ($locked_file) {
10736: my $msg = '<span class="LC_error">';
10737: $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>');
10738: $msg .= '</span><br />';
10739: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10740: return ('file_locked',$msg);
10741: } else {
10742: my $msg = '<span class="LC_error">';
1.984 raeburn 10743: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661 raeburn 10744: $msg .= '</span>';
1.984 raeburn 10745: return ('existingfile',$msg);
1.661 raeburn 10746: }
10747: }
10748: }
10749:
1.987 raeburn 10750: sub check_for_traversal {
10751: my ($path,$url,$toplevel) = @_;
10752: my @parts=split(/\//,$path);
10753: my $cleanpath;
10754: my $fullpath = $url;
10755: for (my $i=0;$i<@parts;$i++) {
10756: next if ($parts[$i] eq '.');
10757: if ($parts[$i] eq '..') {
10758: $fullpath =~ s{([^/]+/)$}{};
10759: } else {
10760: $fullpath .= $parts[$i].'/';
10761: }
10762: }
10763: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10764: $cleanpath = $1;
10765: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10766: my $curr_toprel = $1;
10767: my @parts = split(/\//,$curr_toprel);
10768: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10769: my @urlparts = split(/\//,$url_toprel);
10770: my $doubledots;
10771: my $startdiff = -1;
10772: for (my $i=0; $i<@urlparts; $i++) {
10773: if ($startdiff == -1) {
10774: unless ($urlparts[$i] eq $parts[$i]) {
10775: $startdiff = $i;
10776: $doubledots .= '../';
10777: }
10778: } else {
10779: $doubledots .= '../';
10780: }
10781: }
10782: if ($startdiff > -1) {
10783: $cleanpath = $doubledots;
10784: for (my $i=$startdiff; $i<@parts; $i++) {
10785: $cleanpath .= $parts[$i].'/';
10786: }
10787: }
10788: }
10789: $cleanpath =~ s{(/)$}{};
10790: return $cleanpath;
10791: }
1.31 albertel 10792:
1.1053 raeburn 10793: sub is_archive_file {
10794: my ($mimetype) = @_;
10795: if (($mimetype eq 'application/octet-stream') ||
10796: ($mimetype eq 'application/x-stuffit') ||
10797: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10798: return 1;
10799: }
10800: return;
10801: }
10802:
10803: sub decompress_form {
1.1065 raeburn 10804: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10805: my %lt = &Apache::lonlocal::texthash (
10806: this => 'This file is an archive file.',
1.1067 raeburn 10807: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10808: itsc => 'Its contents are as follows:',
1.1053 raeburn 10809: youm => 'You may wish to extract its contents.',
10810: extr => 'Extract contents',
1.1067 raeburn 10811: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10812: proa => 'Process automatically?',
1.1053 raeburn 10813: yes => 'Yes',
10814: no => 'No',
1.1067 raeburn 10815: fold => 'Title for folder containing movie',
10816: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10817: );
1.1065 raeburn 10818: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10819: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10820: my $info = &list_archive_contents($fileloc,\@paths);
10821: if (@paths) {
10822: foreach my $path (@paths) {
10823: $path =~ s{^/}{};
1.1067 raeburn 10824: if ($path =~ m{^([^/]+)/$}) {
10825: $topdir = $1;
10826: }
1.1065 raeburn 10827: if ($path =~ m{^([^/]+)/}) {
10828: $toplevel{$1} = $path;
10829: } else {
10830: $toplevel{$path} = $path;
10831: }
10832: }
10833: }
1.1067 raeburn 10834: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10835: my @camtasia = ("$topdir/","$topdir/index.html",
10836: "$topdir/media/",
10837: "$topdir/media/$topdir.mp4",
10838: "$topdir/media/FirstFrame.png",
10839: "$topdir/media/player.swf",
10840: "$topdir/media/swfobject.js",
10841: "$topdir/media/expressInstall.swf");
10842: my @diffs = &compare_arrays(\@paths,\@camtasia);
10843: if (@diffs == 0) {
10844: $is_camtasia = 1;
10845: }
10846: }
10847: my $output;
10848: if ($is_camtasia) {
10849: $output = <<"ENDCAM";
10850: <script type="text/javascript" language="Javascript">
10851: // <![CDATA[
10852:
10853: function camtasiaToggle() {
10854: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10855: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10856: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10857:
10858: document.getElementById('camtasia_titles').style.display='block';
10859: } else {
10860: document.getElementById('camtasia_titles').style.display='none';
10861: }
10862: }
10863: }
10864: return;
10865: }
10866:
10867: // ]]>
10868: </script>
10869: <p>$lt{'camt'}</p>
10870: ENDCAM
1.1065 raeburn 10871: } else {
1.1067 raeburn 10872: $output = '<p>'.$lt{'this'};
10873: if ($info eq '') {
10874: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10875: } else {
10876: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10877: '<div><pre>'.$info.'</pre></div>';
10878: }
1.1065 raeburn 10879: }
1.1067 raeburn 10880: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10881: my $duplicates;
10882: my $num = 0;
10883: if (ref($dirlist) eq 'ARRAY') {
10884: foreach my $item (@{$dirlist}) {
10885: if (ref($item) eq 'ARRAY') {
10886: if (exists($toplevel{$item->[0]})) {
10887: $duplicates .=
10888: &start_data_table_row().
10889: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10890: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10891: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10892: 'value="1" />'.&mt('Yes').'</label>'.
10893: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10894: '<td>'.$item->[0].'</td>';
10895: if ($item->[2]) {
10896: $duplicates .= '<td>'.&mt('Directory').'</td>';
10897: } else {
10898: $duplicates .= '<td>'.&mt('File').'</td>';
10899: }
10900: $duplicates .= '<td>'.$item->[3].'</td>'.
10901: '<td>'.
10902: &Apache::lonlocal::locallocaltime($item->[4]).
10903: '</td>'.
10904: &end_data_table_row();
10905: $num ++;
10906: }
10907: }
10908: }
10909: }
10910: my $itemcount;
10911: if (@paths > 0) {
10912: $itemcount = scalar(@paths);
10913: } else {
10914: $itemcount = 1;
10915: }
1.1067 raeburn 10916: if ($is_camtasia) {
10917: $output .= $lt{'auto'}.'<br />'.
10918: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10919: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10920: $lt{'yes'}.'</label> <label>'.
10921: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10922: $lt{'no'}.'</label></span><br />'.
10923: '<div id="camtasia_titles" style="display:block">'.
10924: &Apache::lonhtmlcommon::start_pick_box().
10925: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10926: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10927: &Apache::lonhtmlcommon::row_closure().
10928: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10929: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10930: &Apache::lonhtmlcommon::row_closure(1).
10931: &Apache::lonhtmlcommon::end_pick_box().
10932: '</div>';
10933: }
1.1065 raeburn 10934: $output .=
10935: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10936: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10937: "\n";
1.1065 raeburn 10938: if ($duplicates ne '') {
10939: $output .= '<p><span class="LC_warning">'.
10940: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10941: &start_data_table().
10942: &start_data_table_header_row().
10943: '<th>'.&mt('Overwrite?').'</th>'.
10944: '<th>'.&mt('Name').'</th>'.
10945: '<th>'.&mt('Type').'</th>'.
10946: '<th>'.&mt('Size').'</th>'.
10947: '<th>'.&mt('Last modified').'</th>'.
10948: &end_data_table_header_row().
10949: $duplicates.
10950: &end_data_table().
10951: '</p>';
10952: }
1.1067 raeburn 10953: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10954: if (ref($hiddenelements) eq 'HASH') {
10955: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10956: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10957: }
10958: }
10959: $output .= <<"END";
1.1067 raeburn 10960: <br />
1.1053 raeburn 10961: <input type="submit" name="decompress" value="$lt{'extr'}" />
10962: </form>
10963: $noextract
10964: END
10965: return $output;
10966: }
10967:
1.1065 raeburn 10968: sub decompression_utility {
10969: my ($program) = @_;
10970: my @utilities = ('tar','gunzip','bunzip2','unzip');
10971: my $location;
10972: if (grep(/^\Q$program\E$/,@utilities)) {
10973: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10974: '/usr/sbin/') {
10975: if (-x $dir.$program) {
10976: $location = $dir.$program;
10977: last;
10978: }
10979: }
10980: }
10981: return $location;
10982: }
10983:
10984: sub list_archive_contents {
10985: my ($file,$pathsref) = @_;
10986: my (@cmd,$output);
10987: my $needsregexp;
10988: if ($file =~ /\.zip$/) {
10989: @cmd = (&decompression_utility('unzip'),"-l");
10990: $needsregexp = 1;
10991: } elsif (($file =~ m/\.tar\.gz$/) ||
10992: ($file =~ /\.tgz$/)) {
10993: @cmd = (&decompression_utility('tar'),"-ztf");
10994: } elsif ($file =~ /\.tar\.bz2$/) {
10995: @cmd = (&decompression_utility('tar'),"-jtf");
10996: } elsif ($file =~ m|\.tar$|) {
10997: @cmd = (&decompression_utility('tar'),"-tf");
10998: }
10999: if (@cmd) {
11000: undef($!);
11001: undef($@);
11002: if (open(my $fh,"-|", @cmd, $file)) {
11003: while (my $line = <$fh>) {
11004: $output .= $line;
11005: chomp($line);
11006: my $item;
11007: if ($needsregexp) {
11008: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
11009: } else {
11010: $item = $line;
11011: }
11012: if ($item ne '') {
11013: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
11014: push(@{$pathsref},$item);
11015: }
11016: }
11017: }
11018: close($fh);
11019: }
11020: }
11021: return $output;
11022: }
11023:
1.1053 raeburn 11024: sub decompress_uploaded_file {
11025: my ($file,$dir) = @_;
11026: &Apache::lonnet::appenv({'cgi.file' => $file});
11027: &Apache::lonnet::appenv({'cgi.dir' => $dir});
11028: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
11029: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
11030: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
11031: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
11032: my $decompressed = $env{'cgi.decompressed'};
11033: &Apache::lonnet::delenv('cgi.file');
11034: &Apache::lonnet::delenv('cgi.dir');
11035: &Apache::lonnet::delenv('cgi.decompressed');
11036: return ($decompressed,$result);
11037: }
11038:
1.1055 raeburn 11039: sub process_decompression {
11040: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
11041: my ($dir,$error,$warning,$output);
11042: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
1.1120 bisitz 11043: $error = &mt('Filename not a supported archive file type.').
11044: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 11045: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
11046: } else {
11047: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11048: if ($docuhome eq 'no_host') {
11049: $error = &mt('Could not determine home server for course.');
11050: } else {
11051: my @ids=&Apache::lonnet::current_machine_ids();
11052: my $currdir = "$dir_root/$destination";
11053: if (grep(/^\Q$docuhome\E$/,@ids)) {
11054: $dir = &LONCAPA::propath($docudom,$docuname).
11055: "$dir_root/$destination";
11056: } else {
11057: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
11058: "$dir_root/$docudom/$docuname/$destination";
11059: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
11060: $error = &mt('Archive file not found.');
11061: }
11062: }
1.1065 raeburn 11063: my (@to_overwrite,@to_skip);
11064: if ($env{'form.archive_overwrite_total'} > 0) {
11065: my $total = $env{'form.archive_overwrite_total'};
11066: for (my $i=0; $i<$total; $i++) {
11067: if ($env{'form.archive_overwrite_'.$i} == 1) {
11068: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
11069: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
11070: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
11071: }
11072: }
11073: }
11074: my $numskip = scalar(@to_skip);
11075: if (($numskip > 0) &&
11076: ($numskip == $env{'form.archive_itemcount'})) {
11077: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
11078: } elsif ($dir eq '') {
1.1055 raeburn 11079: $error = &mt('Directory containing archive file unavailable.');
11080: } elsif (!$error) {
1.1065 raeburn 11081: my ($decompressed,$display);
11082: if ($numskip > 0) {
11083: my $tempdir = time.'_'.$$.int(rand(10000));
11084: mkdir("$dir/$tempdir",0755);
11085: system("mv $dir/$file $dir/$tempdir/$file");
11086: ($decompressed,$display) =
11087: &decompress_uploaded_file($file,"$dir/$tempdir");
11088: foreach my $item (@to_skip) {
11089: if (($item ne '') && ($item !~ /\.\./)) {
11090: if (-f "$dir/$tempdir/$item") {
11091: unlink("$dir/$tempdir/$item");
11092: } elsif (-d "$dir/$tempdir/$item") {
11093: system("rm -rf $dir/$tempdir/$item");
11094: }
11095: }
11096: }
11097: system("mv $dir/$tempdir/* $dir");
11098: rmdir("$dir/$tempdir");
11099: } else {
11100: ($decompressed,$display) =
11101: &decompress_uploaded_file($file,$dir);
11102: }
1.1055 raeburn 11103: if ($decompressed eq 'ok') {
1.1065 raeburn 11104: $output = '<p class="LC_info">'.
11105: &mt('Files extracted successfully from archive.').
11106: '</p>'."\n";
1.1055 raeburn 11107: my ($warning,$result,@contents);
11108: my ($newdirlistref,$newlisterror) =
11109: &Apache::lonnet::dirlist($currdir,$docudom,
11110: $docuname,1);
11111: my (%is_dir,%changes,@newitems);
11112: my $dirptr = 16384;
1.1065 raeburn 11113: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 11114: foreach my $dir_line (@{$newdirlistref}) {
11115: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 11116: unless (($item =~ /^\.+$/) || ($item eq $file) ||
11117: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 11118: push(@newitems,$item);
11119: if ($dirptr&$testdir) {
11120: $is_dir{$item} = 1;
11121: }
11122: $changes{$item} = 1;
11123: }
11124: }
11125: }
11126: if (keys(%changes) > 0) {
11127: foreach my $item (sort(@newitems)) {
11128: if ($changes{$item}) {
11129: push(@contents,$item);
11130: }
11131: }
11132: }
11133: if (@contents > 0) {
1.1067 raeburn 11134: my $wantform;
11135: unless ($env{'form.autoextract_camtasia'}) {
11136: $wantform = 1;
11137: }
1.1056 raeburn 11138: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11139: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11140: $currdir,\%is_dir,
11141: \%children,\%parent,
1.1056 raeburn 11142: \@contents,\%dirorder,
11143: \%titles,$wantform);
1.1055 raeburn 11144: if ($datatable ne '') {
11145: $output .= &archive_options_form('decompressed',$datatable,
11146: $count,$hiddenelem);
1.1065 raeburn 11147: my $startcount = 6;
1.1055 raeburn 11148: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11149: \%titles,\%children);
1.1055 raeburn 11150: }
1.1067 raeburn 11151: if ($env{'form.autoextract_camtasia'}) {
11152: my %displayed;
11153: my $total = 1;
11154: $env{'form.archive_directory'} = [];
11155: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11156: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11157: $path =~ s{/$}{};
11158: my $item;
11159: if ($path ne '') {
11160: $item = "$path/$titles{$i}";
11161: } else {
11162: $item = $titles{$i};
11163: }
11164: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11165: if ($item eq $contents[0]) {
11166: push(@{$env{'form.archive_directory'}},$i);
11167: $env{'form.archive_'.$i} = 'display';
11168: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11169: $displayed{'folder'} = $i;
11170: } elsif ($item eq "$contents[0]/index.html") {
11171: $env{'form.archive_'.$i} = 'display';
11172: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11173: $displayed{'web'} = $i;
11174: } else {
11175: if ($item eq "$contents[0]/media") {
11176: push(@{$env{'form.archive_directory'}},$i);
11177: }
11178: $env{'form.archive_'.$i} = 'dependency';
11179: }
11180: $total ++;
11181: }
11182: for (my $i=1; $i<$total; $i++) {
11183: next if ($i == $displayed{'web'});
11184: next if ($i == $displayed{'folder'});
11185: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11186: }
11187: $env{'form.phase'} = 'decompress_cleanup';
11188: $env{'form.archivedelete'} = 1;
11189: $env{'form.archive_count'} = $total-1;
11190: $output .=
11191: &process_extracted_files('coursedocs',$docudom,
11192: $docuname,$destination,
11193: $dir_root,$hiddenelem);
11194: }
1.1055 raeburn 11195: } else {
11196: $warning = &mt('No new items extracted from archive file.');
11197: }
11198: } else {
11199: $output = $display;
11200: $error = &mt('An error occurred during extraction from the archive file.');
11201: }
11202: }
11203: }
11204: }
11205: if ($error) {
11206: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11207: $error.'</p>'."\n";
11208: }
11209: if ($warning) {
11210: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11211: }
11212: return $output;
11213: }
11214:
11215: sub get_extracted {
1.1056 raeburn 11216: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11217: $titles,$wantform) = @_;
1.1055 raeburn 11218: my $count = 0;
11219: my $depth = 0;
11220: my $datatable;
1.1056 raeburn 11221: my @hierarchy;
1.1055 raeburn 11222: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11223: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11224: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11225: foreach my $item (@{$contents}) {
11226: $count ++;
1.1056 raeburn 11227: @{$dirorder->{$count}} = @hierarchy;
11228: $titles->{$count} = $item;
1.1055 raeburn 11229: &archive_hierarchy($depth,$count,$parent,$children);
11230: if ($wantform) {
11231: $datatable .= &archive_row($is_dir->{$item},$item,
11232: $currdir,$depth,$count);
11233: }
11234: if ($is_dir->{$item}) {
11235: $depth ++;
1.1056 raeburn 11236: push(@hierarchy,$count);
11237: $parent->{$depth} = $count;
1.1055 raeburn 11238: $datatable .=
11239: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11240: \$depth,\$count,\@hierarchy,$dirorder,
11241: $children,$parent,$titles,$wantform);
1.1055 raeburn 11242: $depth --;
1.1056 raeburn 11243: pop(@hierarchy);
1.1055 raeburn 11244: }
11245: }
11246: return ($count,$datatable);
11247: }
11248:
11249: sub recurse_extracted_archive {
1.1056 raeburn 11250: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11251: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11252: my $result='';
1.1056 raeburn 11253: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11254: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11255: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11256: return $result;
11257: }
11258: my $dirptr = 16384;
11259: my ($newdirlistref,$newlisterror) =
11260: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11261: if (ref($newdirlistref) eq 'ARRAY') {
11262: foreach my $dir_line (@{$newdirlistref}) {
11263: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11264: unless ($item =~ /^\.+$/) {
11265: $$count ++;
1.1056 raeburn 11266: @{$dirorder->{$$count}} = @{$hierarchy};
11267: $titles->{$$count} = $item;
1.1055 raeburn 11268: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11269:
1.1055 raeburn 11270: my $is_dir;
11271: if ($dirptr&$testdir) {
11272: $is_dir = 1;
11273: }
11274: if ($wantform) {
11275: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11276: }
11277: if ($is_dir) {
11278: $$depth ++;
1.1056 raeburn 11279: push(@{$hierarchy},$$count);
11280: $parent->{$$depth} = $$count;
1.1055 raeburn 11281: $result .=
11282: &recurse_extracted_archive("$currdir/$item",$docudom,
11283: $docuname,$depth,$count,
1.1056 raeburn 11284: $hierarchy,$dirorder,$children,
11285: $parent,$titles,$wantform);
1.1055 raeburn 11286: $$depth --;
1.1056 raeburn 11287: pop(@{$hierarchy});
1.1055 raeburn 11288: }
11289: }
11290: }
11291: }
11292: return $result;
11293: }
11294:
11295: sub archive_hierarchy {
11296: my ($depth,$count,$parent,$children) =@_;
11297: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11298: if (exists($parent->{$depth})) {
11299: $children->{$parent->{$depth}} .= $count.':';
11300: }
11301: }
11302: return;
11303: }
11304:
11305: sub archive_row {
11306: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11307: my ($name) = ($item =~ m{([^/]+)$});
11308: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11309: 'display' => 'Add as file',
1.1055 raeburn 11310: 'dependency' => 'Include as dependency',
11311: 'discard' => 'Discard',
11312: );
11313: if ($is_dir) {
1.1059 raeburn 11314: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11315: }
1.1056 raeburn 11316: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11317: my $offset = 0;
1.1055 raeburn 11318: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11319: $offset ++;
1.1065 raeburn 11320: if ($action ne 'display') {
11321: $offset ++;
11322: }
1.1055 raeburn 11323: $output .= '<td><span class="LC_nobreak">'.
11324: '<label><input type="radio" name="archive_'.$count.
11325: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11326: my $text = $choices{$action};
11327: if ($is_dir) {
11328: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11329: if ($action eq 'display') {
1.1059 raeburn 11330: $text = &mt('Add as folder');
1.1055 raeburn 11331: }
1.1056 raeburn 11332: } else {
11333: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11334:
11335: }
11336: $output .= ' /> '.$choices{$action}.'</label></span>';
11337: if ($action eq 'dependency') {
11338: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11339: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11340: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11341: '<option value=""></option>'."\n".
11342: '</select>'."\n".
11343: '</div>';
1.1059 raeburn 11344: } elsif ($action eq 'display') {
11345: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11346: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11347: '</div>';
1.1055 raeburn 11348: }
1.1056 raeburn 11349: $output .= '</td>';
1.1055 raeburn 11350: }
11351: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11352: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11353: for (my $i=0; $i<$depth; $i++) {
11354: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11355: }
11356: if ($is_dir) {
11357: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11358: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11359: } else {
11360: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11361: }
11362: $output .= ' '.$name.'</td>'."\n".
11363: &end_data_table_row();
11364: return $output;
11365: }
11366:
11367: sub archive_options_form {
1.1065 raeburn 11368: my ($form,$display,$count,$hiddenelem) = @_;
11369: my %lt = &Apache::lonlocal::texthash(
11370: perm => 'Permanently remove archive file?',
11371: hows => 'How should each extracted item be incorporated in the course?',
11372: cont => 'Content actions for all',
11373: addf => 'Add as folder/file',
11374: incd => 'Include as dependency for a displayed file',
11375: disc => 'Discard',
11376: no => 'No',
11377: yes => 'Yes',
11378: save => 'Save',
11379: );
11380: my $output = <<"END";
11381: <form name="$form" method="post" action="">
11382: <p><span class="LC_nobreak">$lt{'perm'}
11383: <label>
11384: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11385: </label>
11386:
11387: <label>
11388: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11389: </span>
11390: </p>
11391: <input type="hidden" name="phase" value="decompress_cleanup" />
11392: <br />$lt{'hows'}
11393: <div class="LC_columnSection">
11394: <fieldset>
11395: <legend>$lt{'cont'}</legend>
11396: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11397: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11398: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11399: </fieldset>
11400: </div>
11401: END
11402: return $output.
1.1055 raeburn 11403: &start_data_table()."\n".
1.1065 raeburn 11404: $display."\n".
1.1055 raeburn 11405: &end_data_table()."\n".
11406: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11407: $hiddenelem.
1.1065 raeburn 11408: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11409: '</form>';
11410: }
11411:
11412: sub archive_javascript {
1.1056 raeburn 11413: my ($startcount,$numitems,$titles,$children) = @_;
11414: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11415: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11416: my $scripttag = <<START;
11417: <script type="text/javascript">
11418: // <![CDATA[
11419:
11420: function checkAll(form,prefix) {
11421: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11422: for (var i=0; i < form.elements.length; i++) {
11423: var id = form.elements[i].id;
11424: if ((id != '') && (id != undefined)) {
11425: if (idstr.test(id)) {
11426: if (form.elements[i].type == 'radio') {
11427: form.elements[i].checked = true;
1.1056 raeburn 11428: var nostart = i-$startcount;
1.1059 raeburn 11429: var offset = nostart%7;
11430: var count = (nostart-offset)/7;
1.1056 raeburn 11431: dependencyCheck(form,count,offset);
1.1055 raeburn 11432: }
11433: }
11434: }
11435: }
11436: }
11437:
11438: function propagateCheck(form,count) {
11439: if (count > 0) {
1.1059 raeburn 11440: var startelement = $startcount + ((count-1) * 7);
11441: for (var j=1; j<6; j++) {
11442: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11443: var item = startelement + j;
11444: if (form.elements[item].type == 'radio') {
11445: if (form.elements[item].checked) {
11446: containerCheck(form,count,j);
11447: break;
11448: }
1.1055 raeburn 11449: }
11450: }
11451: }
11452: }
11453: }
11454:
11455: numitems = $numitems
1.1056 raeburn 11456: var titles = new Array(numitems);
11457: var parents = new Array(numitems);
1.1055 raeburn 11458: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11459: parents[i] = new Array;
1.1055 raeburn 11460: }
1.1059 raeburn 11461: var maintitle = '$maintitle';
1.1055 raeburn 11462:
11463: START
11464:
1.1056 raeburn 11465: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11466: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11467: for (my $i=0; $i<@contents; $i ++) {
11468: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11469: }
11470: }
11471:
1.1056 raeburn 11472: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11473: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11474: }
11475:
1.1055 raeburn 11476: $scripttag .= <<END;
11477:
11478: function containerCheck(form,count,offset) {
11479: if (count > 0) {
1.1056 raeburn 11480: dependencyCheck(form,count,offset);
1.1059 raeburn 11481: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11482: form.elements[item].checked = true;
11483: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11484: if (parents[count].length > 0) {
11485: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11486: containerCheck(form,parents[count][j],offset);
11487: }
11488: }
11489: }
11490: }
11491: }
11492:
11493: function dependencyCheck(form,count,offset) {
11494: if (count > 0) {
1.1059 raeburn 11495: var chosen = (offset+$startcount)+7*(count-1);
11496: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11497: var currtype = form.elements[depitem].type;
11498: if (form.elements[chosen].value == 'dependency') {
11499: document.getElementById('arc_depon_'+count).style.display='block';
11500: form.elements[depitem].options.length = 0;
11501: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 11502: for (var i=1; i<=numitems; i++) {
11503: if (i == count) {
11504: continue;
11505: }
1.1059 raeburn 11506: var startelement = $startcount + (i-1) * 7;
11507: for (var j=1; j<6; j++) {
11508: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11509: var item = startelement + j;
11510: if (form.elements[item].type == 'radio') {
11511: if (form.elements[item].checked) {
11512: if (form.elements[item].value == 'display') {
11513: var n = form.elements[depitem].options.length;
11514: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11515: }
11516: }
11517: }
11518: }
11519: }
11520: }
11521: } else {
11522: document.getElementById('arc_depon_'+count).style.display='none';
11523: form.elements[depitem].options.length = 0;
11524: form.elements[depitem].options[0] = new Option('Select','',true,true);
11525: }
1.1059 raeburn 11526: titleCheck(form,count,offset);
1.1056 raeburn 11527: }
11528: }
11529:
11530: function propagateSelect(form,count,offset) {
11531: if (count > 0) {
1.1065 raeburn 11532: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11533: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11534: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11535: if (parents[count].length > 0) {
11536: for (var j=0; j<parents[count].length; j++) {
11537: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11538: }
11539: }
11540: }
11541: }
11542: }
1.1056 raeburn 11543:
11544: function containerSelect(form,count,offset,picked) {
11545: if (count > 0) {
1.1065 raeburn 11546: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11547: if (form.elements[item].type == 'radio') {
11548: if (form.elements[item].value == 'dependency') {
11549: if (form.elements[item+1].type == 'select-one') {
11550: for (var i=0; i<form.elements[item+1].options.length; i++) {
11551: if (form.elements[item+1].options[i].value == picked) {
11552: form.elements[item+1].selectedIndex = i;
11553: break;
11554: }
11555: }
11556: }
11557: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11558: if (parents[count].length > 0) {
11559: for (var j=0; j<parents[count].length; j++) {
11560: containerSelect(form,parents[count][j],offset,picked);
11561: }
11562: }
11563: }
11564: }
11565: }
11566: }
11567: }
11568:
1.1059 raeburn 11569: function titleCheck(form,count,offset) {
11570: if (count > 0) {
11571: var chosen = (offset+$startcount)+7*(count-1);
11572: var depitem = $startcount + ((count-1) * 7) + 2;
11573: var currtype = form.elements[depitem].type;
11574: if (form.elements[chosen].value == 'display') {
11575: document.getElementById('arc_title_'+count).style.display='block';
11576: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11577: document.getElementById('archive_title_'+count).value=maintitle;
11578: }
11579: } else {
11580: document.getElementById('arc_title_'+count).style.display='none';
11581: if (currtype == 'text') {
11582: document.getElementById('archive_title_'+count).value='';
11583: }
11584: }
11585: }
11586: return;
11587: }
11588:
1.1055 raeburn 11589: // ]]>
11590: </script>
11591: END
11592: return $scripttag;
11593: }
11594:
11595: sub process_extracted_files {
1.1067 raeburn 11596: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11597: my $numitems = $env{'form.archive_count'};
11598: return unless ($numitems);
11599: my @ids=&Apache::lonnet::current_machine_ids();
11600: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11601: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11602: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11603: if (grep(/^\Q$docuhome\E$/,@ids)) {
11604: $prefix = &LONCAPA::propath($docudom,$docuname);
11605: $pathtocheck = "$dir_root/$destination";
11606: $dir = $dir_root;
11607: $ishome = 1;
11608: } else {
11609: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11610: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11611: $dir = "$dir_root/$docudom/$docuname";
11612: }
11613: my $currdir = "$dir_root/$destination";
11614: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11615: if ($env{'form.folderpath'}) {
11616: my @items = split('&',$env{'form.folderpath'});
11617: $folders{'0'} = $items[-2];
1.1099 raeburn 11618: if ($env{'form.folderpath'} =~ /\:1$/) {
11619: $containers{'0'}='page';
11620: } else {
11621: $containers{'0'}='sequence';
11622: }
1.1055 raeburn 11623: }
11624: my @archdirs = &get_env_multiple('form.archive_directory');
11625: if ($numitems) {
11626: for (my $i=1; $i<=$numitems; $i++) {
11627: my $path = $env{'form.archive_content_'.$i};
11628: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11629: my $item = $1;
11630: $toplevelitems{$item} = $i;
11631: if (grep(/^\Q$i\E$/,@archdirs)) {
11632: $is_dir{$item} = 1;
11633: }
11634: }
11635: }
11636: }
1.1067 raeburn 11637: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11638: if (keys(%toplevelitems) > 0) {
11639: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11640: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11641: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11642: }
1.1066 raeburn 11643: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11644: if ($numitems) {
11645: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 11646: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11647: my $path = $env{'form.archive_content_'.$i};
11648: if ($path =~ /^\Q$pathtocheck\E/) {
11649: if ($env{'form.archive_'.$i} eq 'discard') {
11650: if ($prefix ne '' && $path ne '') {
11651: if (-e $prefix.$path) {
1.1066 raeburn 11652: if ((@archdirs > 0) &&
11653: (grep(/^\Q$i\E$/,@archdirs))) {
11654: $todeletedir{$prefix.$path} = 1;
11655: } else {
11656: $todelete{$prefix.$path} = 1;
11657: }
1.1055 raeburn 11658: }
11659: }
11660: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11661: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11662: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11663: $docstitle = $env{'form.archive_title_'.$i};
11664: if ($docstitle eq '') {
11665: $docstitle = $title;
11666: }
1.1055 raeburn 11667: $outer = 0;
1.1056 raeburn 11668: if (ref($dirorder{$i}) eq 'ARRAY') {
11669: if (@{$dirorder{$i}} > 0) {
11670: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11671: if ($env{'form.archive_'.$item} eq 'display') {
11672: $outer = $item;
11673: last;
11674: }
11675: }
11676: }
11677: }
11678: my ($errtext,$fatal) =
11679: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11680: '/'.$folders{$outer}.'.'.
11681: $containers{$outer});
11682: next if ($fatal);
11683: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11684: if ($context eq 'coursedocs') {
1.1056 raeburn 11685: $mapinner{$i} = time;
1.1055 raeburn 11686: $folders{$i} = 'default_'.$mapinner{$i};
11687: $containers{$i} = 'sequence';
11688: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11689: $folders{$i}.'.'.$containers{$i};
11690: my $newidx = &LONCAPA::map::getresidx();
11691: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11692: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11693: push(@LONCAPA::map::order,$newidx);
11694: my ($outtext,$errtext) =
11695: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11696: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11697: '.'.$containers{$outer},1,1);
1.1056 raeburn 11698: $newseqid{$i} = $newidx;
1.1067 raeburn 11699: unless ($errtext) {
11700: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11701: }
1.1055 raeburn 11702: }
11703: } else {
11704: if ($context eq 'coursedocs') {
11705: my $newidx=&LONCAPA::map::getresidx();
11706: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11707: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11708: $title;
11709: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11710: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11711: }
11712: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11713: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11714: }
11715: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11716: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11717: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11718: unless ($ishome) {
11719: my $fetch = "$newdest{$i}/$title";
11720: $fetch =~ s/^\Q$prefix$dir\E//;
11721: $prompttofetch{$fetch} = 1;
11722: }
1.1055 raeburn 11723: }
11724: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11725: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11726: push(@LONCAPA::map::order, $newidx);
11727: my ($outtext,$errtext)=
11728: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11729: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11730: '.'.$containers{$outer},1,1);
1.1067 raeburn 11731: unless ($errtext) {
11732: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11733: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11734: }
11735: }
1.1055 raeburn 11736: }
11737: }
1.1086 raeburn 11738: }
11739: } else {
11740: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11741: }
11742: }
11743: for (my $i=1; $i<=$numitems; $i++) {
11744: next unless ($env{'form.archive_'.$i} eq 'dependency');
11745: my $path = $env{'form.archive_content_'.$i};
11746: if ($path =~ /^\Q$pathtocheck\E/) {
11747: my ($title) = ($path =~ m{/([^/]+)$});
11748: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11749: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11750: if (ref($dirorder{$i}) eq 'ARRAY') {
11751: my ($itemidx,$fullpath,$relpath);
11752: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11753: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11754: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 11755: if ($dirorder{$i}->[$j] eq $container) {
11756: $itemidx = $j;
1.1056 raeburn 11757: }
11758: }
1.1086 raeburn 11759: }
11760: if ($itemidx eq '') {
11761: $itemidx = 0;
11762: }
11763: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11764: if ($mapinner{$referrer{$i}}) {
11765: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11766: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11767: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11768: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11769: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11770: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11771: if (!-e $fullpath) {
11772: mkdir($fullpath,0755);
1.1056 raeburn 11773: }
11774: }
1.1086 raeburn 11775: } else {
11776: last;
1.1056 raeburn 11777: }
1.1086 raeburn 11778: }
11779: }
11780: } elsif ($newdest{$referrer{$i}}) {
11781: $fullpath = $newdest{$referrer{$i}};
11782: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11783: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11784: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11785: last;
11786: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11787: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11788: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11789: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11790: if (!-e $fullpath) {
11791: mkdir($fullpath,0755);
1.1056 raeburn 11792: }
11793: }
1.1086 raeburn 11794: } else {
11795: last;
1.1056 raeburn 11796: }
1.1055 raeburn 11797: }
11798: }
1.1086 raeburn 11799: if ($fullpath ne '') {
11800: if (-e "$prefix$path") {
11801: system("mv $prefix$path $fullpath/$title");
11802: }
11803: if (-e "$fullpath/$title") {
11804: my $showpath;
11805: if ($relpath ne '') {
11806: $showpath = "$relpath/$title";
11807: } else {
11808: $showpath = "/$title";
11809: }
11810: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11811: }
11812: unless ($ishome) {
11813: my $fetch = "$fullpath/$title";
11814: $fetch =~ s/^\Q$prefix$dir\E//;
11815: $prompttofetch{$fetch} = 1;
11816: }
11817: }
1.1055 raeburn 11818: }
1.1086 raeburn 11819: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11820: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11821: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11822: }
11823: } else {
11824: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11825: }
11826: }
11827: if (keys(%todelete)) {
11828: foreach my $key (keys(%todelete)) {
11829: unlink($key);
1.1066 raeburn 11830: }
11831: }
11832: if (keys(%todeletedir)) {
11833: foreach my $key (keys(%todeletedir)) {
11834: rmdir($key);
11835: }
11836: }
11837: foreach my $dir (sort(keys(%is_dir))) {
11838: if (($pathtocheck ne '') && ($dir ne '')) {
11839: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11840: }
11841: }
1.1067 raeburn 11842: if ($result ne '') {
11843: $output .= '<ul>'."\n".
11844: $result."\n".
11845: '</ul>';
11846: }
11847: unless ($ishome) {
11848: my $replicationfail;
11849: foreach my $item (keys(%prompttofetch)) {
11850: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11851: unless ($fetchresult eq 'ok') {
11852: $replicationfail .= '<li>'.$item.'</li>'."\n";
11853: }
11854: }
11855: if ($replicationfail) {
11856: $output .= '<p class="LC_error">'.
11857: &mt('Course home server failed to retrieve:').'<ul>'.
11858: $replicationfail.
11859: '</ul></p>';
11860: }
11861: }
1.1055 raeburn 11862: } else {
11863: $warning = &mt('No items found in archive.');
11864: }
11865: if ($error) {
11866: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11867: $error.'</p>'."\n";
11868: }
11869: if ($warning) {
11870: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11871: }
11872: return $output;
11873: }
11874:
1.1066 raeburn 11875: sub cleanup_empty_dirs {
11876: my ($path) = @_;
11877: if (($path ne '') && (-d $path)) {
11878: if (opendir(my $dirh,$path)) {
11879: my @dircontents = grep(!/^\./,readdir($dirh));
11880: my $numitems = 0;
11881: foreach my $item (@dircontents) {
11882: if (-d "$path/$item") {
1.1111 raeburn 11883: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 11884: if (-e "$path/$item") {
11885: $numitems ++;
11886: }
11887: } else {
11888: $numitems ++;
11889: }
11890: }
11891: if ($numitems == 0) {
11892: rmdir($path);
11893: }
11894: closedir($dirh);
11895: }
11896: }
11897: return;
11898: }
11899:
1.41 ng 11900: =pod
1.45 matthew 11901:
1.1068 raeburn 11902: =item &get_folder_hierarchy()
11903:
11904: Provides hierarchy of names of folders/sub-folders containing the current
11905: item,
11906:
11907: Inputs: 3
11908: - $navmap - navmaps object
11909:
11910: - $map - url for map (either the trigger itself, or map containing
11911: the resource, which is the trigger).
11912:
11913: - $showitem - 1 => show title for map itself; 0 => do not show.
11914:
11915: Outputs: 1 @pathitems - array of folder/subfolder names.
11916:
11917: =cut
11918:
11919: sub get_folder_hierarchy {
11920: my ($navmap,$map,$showitem) = @_;
11921: my @pathitems;
11922: if (ref($navmap)) {
11923: my $mapres = $navmap->getResourceByUrl($map);
11924: if (ref($mapres)) {
11925: my $pcslist = $mapres->map_hierarchy();
11926: if ($pcslist ne '') {
11927: my @pcs = split(/,/,$pcslist);
11928: foreach my $pc (@pcs) {
11929: if ($pc == 1) {
1.1129 raeburn 11930: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 11931: } else {
11932: my $res = $navmap->getByMapPc($pc);
11933: if (ref($res)) {
11934: my $title = $res->compTitle();
11935: $title =~ s/\W+/_/g;
11936: if ($title ne '') {
11937: push(@pathitems,$title);
11938: }
11939: }
11940: }
11941: }
11942: }
1.1071 raeburn 11943: if ($showitem) {
11944: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 11945: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 11946: } else {
11947: my $maptitle = $mapres->compTitle();
11948: $maptitle =~ s/\W+/_/g;
11949: if ($maptitle ne '') {
11950: push(@pathitems,$maptitle);
11951: }
1.1068 raeburn 11952: }
11953: }
11954: }
11955: }
11956: return @pathitems;
11957: }
11958:
11959: =pod
11960:
1.1015 raeburn 11961: =item * &get_turnedin_filepath()
11962:
11963: Determines path in a user's portfolio file for storage of files uploaded
11964: to a specific essayresponse or dropbox item.
11965:
11966: Inputs: 3 required + 1 optional.
11967: $symb is symb for resource, $uname and $udom are for current user (required).
11968: $caller is optional (can be "submission", if routine is called when storing
11969: an upoaded file when "Submit Answer" button was pressed).
11970:
11971: Returns array containing $path and $multiresp.
11972: $path is path in portfolio. $multiresp is 1 if this resource contains more
11973: than one file upload item. Callers of routine should append partid as a
11974: subdirectory to $path in cases where $multiresp is 1.
11975:
11976: Called by: homework/essayresponse.pm and homework/structuretags.pm
11977:
11978: =cut
11979:
11980: sub get_turnedin_filepath {
11981: my ($symb,$uname,$udom,$caller) = @_;
11982: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11983: my $turnindir;
11984: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11985: $turnindir = $userhash{'turnindir'};
11986: my ($path,$multiresp);
11987: if ($turnindir eq '') {
11988: if ($caller eq 'submission') {
11989: $turnindir = &mt('turned in');
11990: $turnindir =~ s/\W+/_/g;
11991: my %newhash = (
11992: 'turnindir' => $turnindir,
11993: );
11994: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11995: }
11996: }
11997: if ($turnindir ne '') {
11998: $path = '/'.$turnindir.'/';
11999: my ($multipart,$turnin,@pathitems);
12000: my $navmap = Apache::lonnavmaps::navmap->new();
12001: if (defined($navmap)) {
12002: my $mapres = $navmap->getResourceByUrl($map);
12003: if (ref($mapres)) {
12004: my $pcslist = $mapres->map_hierarchy();
12005: if ($pcslist ne '') {
12006: foreach my $pc (split(/,/,$pcslist)) {
12007: my $res = $navmap->getByMapPc($pc);
12008: if (ref($res)) {
12009: my $title = $res->compTitle();
12010: $title =~ s/\W+/_/g;
12011: if ($title ne '') {
12012: push(@pathitems,$title);
12013: }
12014: }
12015: }
12016: }
12017: my $maptitle = $mapres->compTitle();
12018: $maptitle =~ s/\W+/_/g;
12019: if ($maptitle ne '') {
12020: push(@pathitems,$maptitle);
12021: }
12022: unless ($env{'request.state'} eq 'construct') {
12023: my $res = $navmap->getBySymb($symb);
12024: if (ref($res)) {
12025: my $partlist = $res->parts();
12026: my $totaluploads = 0;
12027: if (ref($partlist) eq 'ARRAY') {
12028: foreach my $part (@{$partlist}) {
12029: my @types = $res->responseType($part);
12030: my @ids = $res->responseIds($part);
12031: for (my $i=0; $i < scalar(@ids); $i++) {
12032: if ($types[$i] eq 'essay') {
12033: my $partid = $part.'_'.$ids[$i];
12034: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
12035: $totaluploads ++;
12036: }
12037: }
12038: }
12039: }
12040: if ($totaluploads > 1) {
12041: $multiresp = 1;
12042: }
12043: }
12044: }
12045: }
12046: } else {
12047: return;
12048: }
12049: } else {
12050: return;
12051: }
12052: my $restitle=&Apache::lonnet::gettitle($symb);
12053: $restitle =~ s/\W+/_/g;
12054: if ($restitle eq '') {
12055: $restitle = ($resurl =~ m{/[^/]+$});
12056: if ($restitle eq '') {
12057: $restitle = time;
12058: }
12059: }
12060: push(@pathitems,$restitle);
12061: $path .= join('/',@pathitems);
12062: }
12063: return ($path,$multiresp);
12064: }
12065:
12066: =pod
12067:
1.464 albertel 12068: =back
1.41 ng 12069:
1.112 bowersj2 12070: =head1 CSV Upload/Handling functions
1.38 albertel 12071:
1.41 ng 12072: =over 4
12073:
1.648 raeburn 12074: =item * &upfile_store($r)
1.41 ng 12075:
12076: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 12077: needs $env{'form.upfile'}
1.41 ng 12078: returns $datatoken to be put into hidden field
12079:
12080: =cut
1.31 albertel 12081:
12082: sub upfile_store {
12083: my $r=shift;
1.258 albertel 12084: $env{'form.upfile'}=~s/\r/\n/gs;
12085: $env{'form.upfile'}=~s/\f/\n/gs;
12086: $env{'form.upfile'}=~s/\n+/\n/gs;
12087: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 12088:
1.258 albertel 12089: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
12090: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 12091: {
1.158 raeburn 12092: my $datafile = $r->dir_config('lonDaemons').
12093: '/tmp/'.$datatoken.'.tmp';
12094: if ( open(my $fh,">$datafile") ) {
1.258 albertel 12095: print $fh $env{'form.upfile'};
1.158 raeburn 12096: close($fh);
12097: }
1.31 albertel 12098: }
12099: return $datatoken;
12100: }
12101:
1.56 matthew 12102: =pod
12103:
1.648 raeburn 12104: =item * &load_tmp_file($r)
1.41 ng 12105:
12106: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 12107: needs $env{'form.datatoken'},
12108: sets $env{'form.upfile'} to the contents of the file
1.41 ng 12109:
12110: =cut
1.31 albertel 12111:
12112: sub load_tmp_file {
12113: my $r=shift;
12114: my @studentdata=();
12115: {
1.158 raeburn 12116: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 12117: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 12118: if ( open(my $fh,"<$studentfile") ) {
12119: @studentdata=<$fh>;
12120: close($fh);
12121: }
1.31 albertel 12122: }
1.258 albertel 12123: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12124: }
12125:
1.56 matthew 12126: =pod
12127:
1.648 raeburn 12128: =item * &upfile_record_sep()
1.41 ng 12129:
12130: Separate uploaded file into records
12131: returns array of records,
1.258 albertel 12132: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12133:
12134: =cut
1.31 albertel 12135:
12136: sub upfile_record_sep {
1.258 albertel 12137: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12138: } else {
1.248 albertel 12139: my @records;
1.258 albertel 12140: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12141: if ($line=~/^\s*$/) { next; }
12142: push(@records,$line);
12143: }
12144: return @records;
1.31 albertel 12145: }
12146: }
12147:
1.56 matthew 12148: =pod
12149:
1.648 raeburn 12150: =item * &record_sep($record)
1.41 ng 12151:
1.258 albertel 12152: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12153:
12154: =cut
12155:
1.263 www 12156: sub takeleft {
12157: my $index=shift;
12158: return substr('0000'.$index,-4,4);
12159: }
12160:
1.31 albertel 12161: sub record_sep {
12162: my $record=shift;
12163: my %components=();
1.258 albertel 12164: if ($env{'form.upfiletype'} eq 'xml') {
12165: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12166: my $i=0;
1.356 albertel 12167: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12168: $field=~s/^(\"|\')//;
12169: $field=~s/(\"|\')$//;
1.263 www 12170: $components{&takeleft($i)}=$field;
1.31 albertel 12171: $i++;
12172: }
1.258 albertel 12173: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12174: my $i=0;
1.356 albertel 12175: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12176: $field=~s/^(\"|\')//;
12177: $field=~s/(\"|\')$//;
1.263 www 12178: $components{&takeleft($i)}=$field;
1.31 albertel 12179: $i++;
12180: }
12181: } else {
1.561 www 12182: my $separator=',';
1.480 banghart 12183: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12184: $separator=';';
1.480 banghart 12185: }
1.31 albertel 12186: my $i=0;
1.561 www 12187: # the character we are looking for to indicate the end of a quote or a record
12188: my $looking_for=$separator;
12189: # do not add the characters to the fields
12190: my $ignore=0;
12191: # we just encountered a separator (or the beginning of the record)
12192: my $just_found_separator=1;
12193: # store the field we are working on here
12194: my $field='';
12195: # work our way through all characters in record
12196: foreach my $character ($record=~/(.)/g) {
12197: if ($character eq $looking_for) {
12198: if ($character ne $separator) {
12199: # Found the end of a quote, again looking for separator
12200: $looking_for=$separator;
12201: $ignore=1;
12202: } else {
12203: # Found a separator, store away what we got
12204: $components{&takeleft($i)}=$field;
12205: $i++;
12206: $just_found_separator=1;
12207: $ignore=0;
12208: $field='';
12209: }
12210: next;
12211: }
12212: # single or double quotation marks after a separator indicate beginning of a quote
12213: # we are now looking for the end of the quote and need to ignore separators
12214: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12215: $looking_for=$character;
12216: next;
12217: }
12218: # ignore would be true after we reached the end of a quote
12219: if ($ignore) { next; }
12220: if (($just_found_separator) && ($character=~/\s/)) { next; }
12221: $field.=$character;
12222: $just_found_separator=0;
1.31 albertel 12223: }
1.561 www 12224: # catch the very last entry, since we never encountered the separator
12225: $components{&takeleft($i)}=$field;
1.31 albertel 12226: }
12227: return %components;
12228: }
12229:
1.144 matthew 12230: ######################################################
12231: ######################################################
12232:
1.56 matthew 12233: =pod
12234:
1.648 raeburn 12235: =item * &upfile_select_html()
1.41 ng 12236:
1.144 matthew 12237: Return HTML code to select a file from the users machine and specify
12238: the file type.
1.41 ng 12239:
12240: =cut
12241:
1.144 matthew 12242: ######################################################
12243: ######################################################
1.31 albertel 12244: sub upfile_select_html {
1.144 matthew 12245: my %Types = (
12246: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12247: semisv => &mt('Semicolon separated values'),
1.144 matthew 12248: space => &mt('Space separated'),
12249: tab => &mt('Tabulator separated'),
12250: # xml => &mt('HTML/XML'),
12251: );
12252: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12253: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12254: foreach my $type (sort(keys(%Types))) {
12255: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12256: }
12257: $Str .= "</select>\n";
12258: return $Str;
1.31 albertel 12259: }
12260:
1.301 albertel 12261: sub get_samples {
12262: my ($records,$toget) = @_;
12263: my @samples=({});
12264: my $got=0;
12265: foreach my $rec (@$records) {
12266: my %temp = &record_sep($rec);
12267: if (! grep(/\S/, values(%temp))) { next; }
12268: if (%temp) {
12269: $samples[$got]=\%temp;
12270: $got++;
12271: if ($got == $toget) { last; }
12272: }
12273: }
12274: return \@samples;
12275: }
12276:
1.144 matthew 12277: ######################################################
12278: ######################################################
12279:
1.56 matthew 12280: =pod
12281:
1.648 raeburn 12282: =item * &csv_print_samples($r,$records)
1.41 ng 12283:
12284: Prints a table of sample values from each column uploaded $r is an
12285: Apache Request ref, $records is an arrayref from
12286: &Apache::loncommon::upfile_record_sep
12287:
12288: =cut
12289:
1.144 matthew 12290: ######################################################
12291: ######################################################
1.31 albertel 12292: sub csv_print_samples {
12293: my ($r,$records) = @_;
1.662 bisitz 12294: my $samples = &get_samples($records,5);
1.301 albertel 12295:
1.594 raeburn 12296: $r->print(&mt('Samples').'<br />'.&start_data_table().
12297: &start_data_table_header_row());
1.356 albertel 12298: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12299: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12300: $r->print(&end_data_table_header_row());
1.301 albertel 12301: foreach my $hash (@$samples) {
1.594 raeburn 12302: $r->print(&start_data_table_row());
1.356 albertel 12303: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12304: $r->print('<td>');
1.356 albertel 12305: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12306: $r->print('</td>');
12307: }
1.594 raeburn 12308: $r->print(&end_data_table_row());
1.31 albertel 12309: }
1.594 raeburn 12310: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12311: }
12312:
1.144 matthew 12313: ######################################################
12314: ######################################################
12315:
1.56 matthew 12316: =pod
12317:
1.648 raeburn 12318: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12319:
12320: Prints a table to create associations between values and table columns.
1.144 matthew 12321:
1.41 ng 12322: $r is an Apache Request ref,
12323: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12324: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12325:
12326: =cut
12327:
1.144 matthew 12328: ######################################################
12329: ######################################################
1.31 albertel 12330: sub csv_print_select_table {
12331: my ($r,$records,$d) = @_;
1.301 albertel 12332: my $i=0;
12333: my $samples = &get_samples($records,1);
1.144 matthew 12334: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12335: &start_data_table().&start_data_table_header_row().
1.144 matthew 12336: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12337: '<th>'.&mt('Column').'</th>'.
12338: &end_data_table_header_row()."\n");
1.356 albertel 12339: foreach my $array_ref (@$d) {
12340: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12341: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12342:
1.875 bisitz 12343: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12344: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12345: $r->print('<option value="none"></option>');
1.356 albertel 12346: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12347: $r->print('<option value="'.$sample.'"'.
12348: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12349: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12350: }
1.594 raeburn 12351: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12352: $i++;
12353: }
1.594 raeburn 12354: $r->print(&end_data_table());
1.31 albertel 12355: $i--;
12356: return $i;
12357: }
1.56 matthew 12358:
1.144 matthew 12359: ######################################################
12360: ######################################################
12361:
1.56 matthew 12362: =pod
1.31 albertel 12363:
1.648 raeburn 12364: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12365:
12366: Prints a table of sample values from the upload and can make associate samples to internal names.
12367:
12368: $r is an Apache Request ref,
12369: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12370: $d is an array of 2 element arrays (internal name, displayed name)
12371:
12372: =cut
12373:
1.144 matthew 12374: ######################################################
12375: ######################################################
1.31 albertel 12376: sub csv_samples_select_table {
12377: my ($r,$records,$d) = @_;
12378: my $i=0;
1.144 matthew 12379: #
1.662 bisitz 12380: my $max_samples = 5;
12381: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12382: $r->print(&start_data_table().
12383: &start_data_table_header_row().'<th>'.
12384: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12385: &end_data_table_header_row());
1.301 albertel 12386:
12387: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12388: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12389: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12390: foreach my $option (@$d) {
12391: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12392: $r->print('<option value="'.$value.'"'.
1.253 albertel 12393: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12394: $display.'</option>');
1.31 albertel 12395: }
12396: $r->print('</select></td><td>');
1.662 bisitz 12397: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12398: if (defined($samples->[$line]{$key})) {
12399: $r->print($samples->[$line]{$key}."<br />\n");
12400: }
12401: }
1.594 raeburn 12402: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12403: $i++;
12404: }
1.594 raeburn 12405: $r->print(&end_data_table());
1.31 albertel 12406: $i--;
12407: return($i);
1.115 matthew 12408: }
12409:
1.144 matthew 12410: ######################################################
12411: ######################################################
12412:
1.115 matthew 12413: =pod
12414:
1.648 raeburn 12415: =item * &clean_excel_name($name)
1.115 matthew 12416:
12417: Returns a replacement for $name which does not contain any illegal characters.
12418:
12419: =cut
12420:
1.144 matthew 12421: ######################################################
12422: ######################################################
1.115 matthew 12423: sub clean_excel_name {
12424: my ($name) = @_;
12425: $name =~ s/[:\*\?\/\\]//g;
12426: if (length($name) > 31) {
12427: $name = substr($name,0,31);
12428: }
12429: return $name;
1.25 albertel 12430: }
1.84 albertel 12431:
1.85 albertel 12432: =pod
12433:
1.648 raeburn 12434: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12435:
12436: Returns either 1 or undef
12437:
12438: 1 if the part is to be hidden, undef if it is to be shown
12439:
12440: Arguments are:
12441:
12442: $id the id of the part to be checked
12443: $symb, optional the symb of the resource to check
12444: $udom, optional the domain of the user to check for
12445: $uname, optional the username of the user to check for
12446:
12447: =cut
1.84 albertel 12448:
12449: sub check_if_partid_hidden {
12450: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12451: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12452: $symb,$udom,$uname);
1.141 albertel 12453: my $truth=1;
12454: #if the string starts with !, then the list is the list to show not hide
12455: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12456: my @hiddenlist=split(/,/,$hiddenparts);
12457: foreach my $checkid (@hiddenlist) {
1.141 albertel 12458: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12459: }
1.141 albertel 12460: return !$truth;
1.84 albertel 12461: }
1.127 matthew 12462:
1.138 matthew 12463:
12464: ############################################################
12465: ############################################################
12466:
12467: =pod
12468:
1.157 matthew 12469: =back
12470:
1.138 matthew 12471: =head1 cgi-bin script and graphing routines
12472:
1.157 matthew 12473: =over 4
12474:
1.648 raeburn 12475: =item * &get_cgi_id()
1.138 matthew 12476:
12477: Inputs: none
12478:
12479: Returns an id which can be used to pass environment variables
12480: to various cgi-bin scripts. These environment variables will
12481: be removed from the users environment after a given time by
12482: the routine &Apache::lonnet::transfer_profile_to_env.
12483:
12484: =cut
12485:
12486: ############################################################
12487: ############################################################
1.152 albertel 12488: my $uniq=0;
1.136 matthew 12489: sub get_cgi_id {
1.154 albertel 12490: $uniq=($uniq+1)%100000;
1.280 albertel 12491: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12492: }
12493:
1.127 matthew 12494: ############################################################
12495: ############################################################
12496:
12497: =pod
12498:
1.648 raeburn 12499: =item * &DrawBarGraph()
1.127 matthew 12500:
1.138 matthew 12501: Facilitates the plotting of data in a (stacked) bar graph.
12502: Puts plot definition data into the users environment in order for
12503: graph.png to plot it. Returns an <img> tag for the plot.
12504: The bars on the plot are labeled '1','2',...,'n'.
12505:
12506: Inputs:
12507:
12508: =over 4
12509:
12510: =item $Title: string, the title of the plot
12511:
12512: =item $xlabel: string, text describing the X-axis of the plot
12513:
12514: =item $ylabel: string, text describing the Y-axis of the plot
12515:
12516: =item $Max: scalar, the maximum Y value to use in the plot
12517: If $Max is < any data point, the graph will not be rendered.
12518:
1.140 matthew 12519: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12520: they are plotted. If undefined, default values will be used.
12521:
1.178 matthew 12522: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12523:
1.138 matthew 12524: =item @Values: An array of array references. Each array reference holds data
12525: to be plotted in a stacked bar chart.
12526:
1.239 matthew 12527: =item If the final element of @Values is a hash reference the key/value
12528: pairs will be added to the graph definition.
12529:
1.138 matthew 12530: =back
12531:
12532: Returns:
12533:
12534: An <img> tag which references graph.png and the appropriate identifying
12535: information for the plot.
12536:
1.127 matthew 12537: =cut
12538:
12539: ############################################################
12540: ############################################################
1.134 matthew 12541: sub DrawBarGraph {
1.178 matthew 12542: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12543: #
12544: if (! defined($colors)) {
12545: $colors = ['#33ff00',
12546: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12547: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12548: ];
12549: }
1.228 matthew 12550: my $extra_settings = {};
12551: if (ref($Values[-1]) eq 'HASH') {
12552: $extra_settings = pop(@Values);
12553: }
1.127 matthew 12554: #
1.136 matthew 12555: my $identifier = &get_cgi_id();
12556: my $id = 'cgi.'.$identifier;
1.129 matthew 12557: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12558: return '';
12559: }
1.225 matthew 12560: #
12561: my @Labels;
12562: if (defined($labels)) {
12563: @Labels = @$labels;
12564: } else {
12565: for (my $i=0;$i<@{$Values[0]};$i++) {
12566: push (@Labels,$i+1);
12567: }
12568: }
12569: #
1.129 matthew 12570: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12571: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12572: my %ValuesHash;
12573: my $NumSets=1;
12574: foreach my $array (@Values) {
12575: next if (! ref($array));
1.136 matthew 12576: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12577: join(',',@$array);
1.129 matthew 12578: }
1.127 matthew 12579: #
1.136 matthew 12580: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12581: if ($NumBars < 3) {
12582: $width = 120+$NumBars*32;
1.220 matthew 12583: $xskip = 1;
1.225 matthew 12584: $bar_width = 30;
12585: } elsif ($NumBars < 5) {
12586: $width = 120+$NumBars*20;
12587: $xskip = 1;
12588: $bar_width = 20;
1.220 matthew 12589: } elsif ($NumBars < 10) {
1.136 matthew 12590: $width = 120+$NumBars*15;
12591: $xskip = 1;
12592: $bar_width = 15;
12593: } elsif ($NumBars <= 25) {
12594: $width = 120+$NumBars*11;
12595: $xskip = 5;
12596: $bar_width = 8;
12597: } elsif ($NumBars <= 50) {
12598: $width = 120+$NumBars*8;
12599: $xskip = 5;
12600: $bar_width = 4;
12601: } else {
12602: $width = 120+$NumBars*8;
12603: $xskip = 5;
12604: $bar_width = 4;
12605: }
12606: #
1.137 matthew 12607: $Max = 1 if ($Max < 1);
12608: if ( int($Max) < $Max ) {
12609: $Max++;
12610: $Max = int($Max);
12611: }
1.127 matthew 12612: $Title = '' if (! defined($Title));
12613: $xlabel = '' if (! defined($xlabel));
12614: $ylabel = '' if (! defined($ylabel));
1.369 www 12615: $ValuesHash{$id.'.title'} = &escape($Title);
12616: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12617: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12618: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12619: $ValuesHash{$id.'.NumBars'} = $NumBars;
12620: $ValuesHash{$id.'.NumSets'} = $NumSets;
12621: $ValuesHash{$id.'.PlotType'} = 'bar';
12622: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12623: $ValuesHash{$id.'.height'} = $height;
12624: $ValuesHash{$id.'.width'} = $width;
12625: $ValuesHash{$id.'.xskip'} = $xskip;
12626: $ValuesHash{$id.'.bar_width'} = $bar_width;
12627: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12628: #
1.228 matthew 12629: # Deal with other parameters
12630: while (my ($key,$value) = each(%$extra_settings)) {
12631: $ValuesHash{$id.'.'.$key} = $value;
12632: }
12633: #
1.646 raeburn 12634: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12635: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12636: }
12637:
12638: ############################################################
12639: ############################################################
12640:
12641: =pod
12642:
1.648 raeburn 12643: =item * &DrawXYGraph()
1.137 matthew 12644:
1.138 matthew 12645: Facilitates the plotting of data in an XY graph.
12646: Puts plot definition data into the users environment in order for
12647: graph.png to plot it. Returns an <img> tag for the plot.
12648:
12649: Inputs:
12650:
12651: =over 4
12652:
12653: =item $Title: string, the title of the plot
12654:
12655: =item $xlabel: string, text describing the X-axis of the plot
12656:
12657: =item $ylabel: string, text describing the Y-axis of the plot
12658:
12659: =item $Max: scalar, the maximum Y value to use in the plot
12660: If $Max is < any data point, the graph will not be rendered.
12661:
12662: =item $colors: Array ref containing the hex color codes for the data to be
12663: plotted in. If undefined, default values will be used.
12664:
12665: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12666:
12667: =item $Ydata: Array ref containing Array refs.
1.185 www 12668: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12669:
12670: =item %Values: hash indicating or overriding any default values which are
12671: passed to graph.png.
12672: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12673:
12674: =back
12675:
12676: Returns:
12677:
12678: An <img> tag which references graph.png and the appropriate identifying
12679: information for the plot.
12680:
1.137 matthew 12681: =cut
12682:
12683: ############################################################
12684: ############################################################
12685: sub DrawXYGraph {
12686: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12687: #
12688: # Create the identifier for the graph
12689: my $identifier = &get_cgi_id();
12690: my $id = 'cgi.'.$identifier;
12691: #
12692: $Title = '' if (! defined($Title));
12693: $xlabel = '' if (! defined($xlabel));
12694: $ylabel = '' if (! defined($ylabel));
12695: my %ValuesHash =
12696: (
1.369 www 12697: $id.'.title' => &escape($Title),
12698: $id.'.xlabel' => &escape($xlabel),
12699: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12700: $id.'.y_max_value'=> $Max,
12701: $id.'.labels' => join(',',@$Xlabels),
12702: $id.'.PlotType' => 'XY',
12703: );
12704: #
12705: if (defined($colors) && ref($colors) eq 'ARRAY') {
12706: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12707: }
12708: #
12709: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12710: return '';
12711: }
12712: my $NumSets=1;
1.138 matthew 12713: foreach my $array (@{$Ydata}){
1.137 matthew 12714: next if (! ref($array));
12715: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12716: }
1.138 matthew 12717: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12718: #
12719: # Deal with other parameters
12720: while (my ($key,$value) = each(%Values)) {
12721: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12722: }
12723: #
1.646 raeburn 12724: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12725: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12726: }
12727:
12728: ############################################################
12729: ############################################################
12730:
12731: =pod
12732:
1.648 raeburn 12733: =item * &DrawXYYGraph()
1.138 matthew 12734:
12735: Facilitates the plotting of data in an XY graph with two Y axes.
12736: Puts plot definition data into the users environment in order for
12737: graph.png to plot it. Returns an <img> tag for the plot.
12738:
12739: Inputs:
12740:
12741: =over 4
12742:
12743: =item $Title: string, the title of the plot
12744:
12745: =item $xlabel: string, text describing the X-axis of the plot
12746:
12747: =item $ylabel: string, text describing the Y-axis of the plot
12748:
12749: =item $colors: Array ref containing the hex color codes for the data to be
12750: plotted in. If undefined, default values will be used.
12751:
12752: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12753:
12754: =item $Ydata1: The first data set
12755:
12756: =item $Min1: The minimum value of the left Y-axis
12757:
12758: =item $Max1: The maximum value of the left Y-axis
12759:
12760: =item $Ydata2: The second data set
12761:
12762: =item $Min2: The minimum value of the right Y-axis
12763:
12764: =item $Max2: The maximum value of the left Y-axis
12765:
12766: =item %Values: hash indicating or overriding any default values which are
12767: passed to graph.png.
12768: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12769:
12770: =back
12771:
12772: Returns:
12773:
12774: An <img> tag which references graph.png and the appropriate identifying
12775: information for the plot.
1.136 matthew 12776:
12777: =cut
12778:
12779: ############################################################
12780: ############################################################
1.137 matthew 12781: sub DrawXYYGraph {
12782: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12783: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12784: #
12785: # Create the identifier for the graph
12786: my $identifier = &get_cgi_id();
12787: my $id = 'cgi.'.$identifier;
12788: #
12789: $Title = '' if (! defined($Title));
12790: $xlabel = '' if (! defined($xlabel));
12791: $ylabel = '' if (! defined($ylabel));
12792: my %ValuesHash =
12793: (
1.369 www 12794: $id.'.title' => &escape($Title),
12795: $id.'.xlabel' => &escape($xlabel),
12796: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12797: $id.'.labels' => join(',',@$Xlabels),
12798: $id.'.PlotType' => 'XY',
12799: $id.'.NumSets' => 2,
1.137 matthew 12800: $id.'.two_axes' => 1,
12801: $id.'.y1_max_value' => $Max1,
12802: $id.'.y1_min_value' => $Min1,
12803: $id.'.y2_max_value' => $Max2,
12804: $id.'.y2_min_value' => $Min2,
1.136 matthew 12805: );
12806: #
1.137 matthew 12807: if (defined($colors) && ref($colors) eq 'ARRAY') {
12808: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12809: }
12810: #
12811: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12812: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12813: return '';
12814: }
12815: my $NumSets=1;
1.137 matthew 12816: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12817: next if (! ref($array));
12818: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12819: }
12820: #
12821: # Deal with other parameters
12822: while (my ($key,$value) = each(%Values)) {
12823: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12824: }
12825: #
1.646 raeburn 12826: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12827: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12828: }
12829:
12830: ############################################################
12831: ############################################################
12832:
12833: =pod
12834:
1.157 matthew 12835: =back
12836:
1.139 matthew 12837: =head1 Statistics helper routines?
12838:
12839: Bad place for them but what the hell.
12840:
1.157 matthew 12841: =over 4
12842:
1.648 raeburn 12843: =item * &chartlink()
1.139 matthew 12844:
12845: Returns a link to the chart for a specific student.
12846:
12847: Inputs:
12848:
12849: =over 4
12850:
12851: =item $linktext: The text of the link
12852:
12853: =item $sname: The students username
12854:
12855: =item $sdomain: The students domain
12856:
12857: =back
12858:
1.157 matthew 12859: =back
12860:
1.139 matthew 12861: =cut
12862:
12863: ############################################################
12864: ############################################################
12865: sub chartlink {
12866: my ($linktext, $sname, $sdomain) = @_;
12867: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12868: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12869: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12870: '">'.$linktext.'</a>';
1.153 matthew 12871: }
12872:
12873: #######################################################
12874: #######################################################
12875:
12876: =pod
12877:
12878: =head1 Course Environment Routines
1.157 matthew 12879:
12880: =over 4
1.153 matthew 12881:
1.648 raeburn 12882: =item * &restore_course_settings()
1.153 matthew 12883:
1.648 raeburn 12884: =item * &store_course_settings()
1.153 matthew 12885:
12886: Restores/Store indicated form parameters from the course environment.
12887: Will not overwrite existing values of the form parameters.
12888:
12889: Inputs:
12890: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12891:
12892: a hash ref describing the data to be stored. For example:
12893:
12894: %Save_Parameters = ('Status' => 'scalar',
12895: 'chartoutputmode' => 'scalar',
12896: 'chartoutputdata' => 'scalar',
12897: 'Section' => 'array',
1.373 raeburn 12898: 'Group' => 'array',
1.153 matthew 12899: 'StudentData' => 'array',
12900: 'Maps' => 'array');
12901:
12902: Returns: both routines return nothing
12903:
1.631 raeburn 12904: =back
12905:
1.153 matthew 12906: =cut
12907:
12908: #######################################################
12909: #######################################################
12910: sub store_course_settings {
1.496 albertel 12911: return &store_settings($env{'request.course.id'},@_);
12912: }
12913:
12914: sub store_settings {
1.153 matthew 12915: # save to the environment
12916: # appenv the same items, just to be safe
1.300 albertel 12917: my $udom = $env{'user.domain'};
12918: my $uname = $env{'user.name'};
1.496 albertel 12919: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12920: my %SaveHash;
12921: my %AppHash;
12922: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12923: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12924: my $envname = 'environment.'.$basename;
1.258 albertel 12925: if (exists($env{'form.'.$setting})) {
1.153 matthew 12926: # Save this value away
12927: if ($type eq 'scalar' &&
1.258 albertel 12928: (! exists($env{$envname}) ||
12929: $env{$envname} ne $env{'form.'.$setting})) {
12930: $SaveHash{$basename} = $env{'form.'.$setting};
12931: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12932: } elsif ($type eq 'array') {
12933: my $stored_form;
1.258 albertel 12934: if (ref($env{'form.'.$setting})) {
1.153 matthew 12935: $stored_form = join(',',
12936: map {
1.369 www 12937: &escape($_);
1.258 albertel 12938: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12939: } else {
12940: $stored_form =
1.369 www 12941: &escape($env{'form.'.$setting});
1.153 matthew 12942: }
12943: # Determine if the array contents are the same.
1.258 albertel 12944: if ($stored_form ne $env{$envname}) {
1.153 matthew 12945: $SaveHash{$basename} = $stored_form;
12946: $AppHash{$envname} = $stored_form;
12947: }
12948: }
12949: }
12950: }
12951: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12952: $udom,$uname);
1.153 matthew 12953: if ($put_result !~ /^(ok|delayed)/) {
12954: &Apache::lonnet::logthis('unable to save form parameters, '.
12955: 'got error:'.$put_result);
12956: }
12957: # Make sure these settings stick around in this session, too
1.646 raeburn 12958: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12959: return;
12960: }
12961:
12962: sub restore_course_settings {
1.499 albertel 12963: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12964: }
12965:
12966: sub restore_settings {
12967: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12968: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12969: next if (exists($env{'form.'.$setting}));
1.496 albertel 12970: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12971: '.'.$setting;
1.258 albertel 12972: if (exists($env{$envname})) {
1.153 matthew 12973: if ($type eq 'scalar') {
1.258 albertel 12974: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12975: } elsif ($type eq 'array') {
1.258 albertel 12976: $env{'form.'.$setting} = [
1.153 matthew 12977: map {
1.369 www 12978: &unescape($_);
1.258 albertel 12979: } split(',',$env{$envname})
1.153 matthew 12980: ];
12981: }
12982: }
12983: }
1.127 matthew 12984: }
12985:
1.618 raeburn 12986: #######################################################
12987: #######################################################
12988:
12989: =pod
12990:
12991: =head1 Domain E-mail Routines
12992:
12993: =over 4
12994:
1.648 raeburn 12995: =item * &build_recipient_list()
1.618 raeburn 12996:
1.884 raeburn 12997: Build recipient lists for five types of e-mail:
1.766 raeburn 12998: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12999: (d) Help requests, (e) Course requests needing approval, generated by
13000: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
13001: loncoursequeueadmin.pm respectively.
1.618 raeburn 13002:
13003: Inputs:
1.619 raeburn 13004: defmail (scalar - email address of default recipient),
1.618 raeburn 13005: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 13006: defdom (domain for which to retrieve configuration settings),
13007: origmail (scalar - email address of recipient from loncapa.conf,
13008: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 13009:
1.655 raeburn 13010: Returns: comma separated list of addresses to which to send e-mail.
13011:
13012: =back
1.618 raeburn 13013:
13014: =cut
13015:
13016: ############################################################
13017: ############################################################
13018: sub build_recipient_list {
1.619 raeburn 13019: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 13020: my @recipients;
13021: my $otheremails;
13022: my %domconfig =
13023: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
13024: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 13025: if (exists($domconfig{'contacts'}{$mailing})) {
13026: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
13027: my @contacts = ('adminemail','supportemail');
13028: foreach my $item (@contacts) {
13029: if ($domconfig{'contacts'}{$mailing}{$item}) {
13030: my $addr = $domconfig{'contacts'}{$item};
13031: if (!grep(/^\Q$addr\E$/,@recipients)) {
13032: push(@recipients,$addr);
13033: }
1.619 raeburn 13034: }
1.766 raeburn 13035: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 13036: }
13037: }
1.766 raeburn 13038: } elsif ($origmail ne '') {
13039: push(@recipients,$origmail);
1.618 raeburn 13040: }
1.619 raeburn 13041: } elsif ($origmail ne '') {
13042: push(@recipients,$origmail);
1.618 raeburn 13043: }
1.688 raeburn 13044: if (defined($defmail)) {
13045: if ($defmail ne '') {
13046: push(@recipients,$defmail);
13047: }
1.618 raeburn 13048: }
13049: if ($otheremails) {
1.619 raeburn 13050: my @others;
13051: if ($otheremails =~ /,/) {
13052: @others = split(/,/,$otheremails);
1.618 raeburn 13053: } else {
1.619 raeburn 13054: push(@others,$otheremails);
13055: }
13056: foreach my $addr (@others) {
13057: if (!grep(/^\Q$addr\E$/,@recipients)) {
13058: push(@recipients,$addr);
13059: }
1.618 raeburn 13060: }
13061: }
1.619 raeburn 13062: my $recipientlist = join(',',@recipients);
1.618 raeburn 13063: return $recipientlist;
13064: }
13065:
1.127 matthew 13066: ############################################################
13067: ############################################################
1.154 albertel 13068:
1.655 raeburn 13069: =pod
13070:
13071: =head1 Course Catalog Routines
13072:
13073: =over 4
13074:
13075: =item * &gather_categories()
13076:
13077: Converts category definitions - keys of categories hash stored in
13078: coursecategories in configuration.db on the primary library server in a
13079: domain - to an array. Also generates javascript and idx hash used to
13080: generate Domain Coordinator interface for editing Course Categories.
13081:
13082: Inputs:
1.663 raeburn 13083:
1.655 raeburn 13084: categories (reference to hash of category definitions).
1.663 raeburn 13085:
1.655 raeburn 13086: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13087: categories and subcategories).
1.663 raeburn 13088:
1.655 raeburn 13089: idx (reference to hash of counters used in Domain Coordinator interface for
13090: editing Course Categories).
1.663 raeburn 13091:
1.655 raeburn 13092: jsarray (reference to array of categories used to create Javascript arrays for
13093: Domain Coordinator interface for editing Course Categories).
13094:
13095: Returns: nothing
13096:
13097: Side effects: populates cats, idx and jsarray.
13098:
13099: =cut
13100:
13101: sub gather_categories {
13102: my ($categories,$cats,$idx,$jsarray) = @_;
13103: my %counters;
13104: my $num = 0;
13105: foreach my $item (keys(%{$categories})) {
13106: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
13107: if ($container eq '' && $depth == 0) {
13108: $cats->[$depth][$categories->{$item}] = $cat;
13109: } else {
13110: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
13111: }
13112: my ($escitem,$tail) = split(/:/,$item,2);
13113: if ($counters{$tail} eq '') {
13114: $counters{$tail} = $num;
13115: $num ++;
13116: }
13117: if (ref($idx) eq 'HASH') {
13118: $idx->{$item} = $counters{$tail};
13119: }
13120: if (ref($jsarray) eq 'ARRAY') {
13121: push(@{$jsarray->[$counters{$tail}]},$item);
13122: }
13123: }
13124: return;
13125: }
13126:
13127: =pod
13128:
13129: =item * &extract_categories()
13130:
13131: Used to generate breadcrumb trails for course categories.
13132:
13133: Inputs:
1.663 raeburn 13134:
1.655 raeburn 13135: categories (reference to hash of category definitions).
1.663 raeburn 13136:
1.655 raeburn 13137: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13138: categories and subcategories).
1.663 raeburn 13139:
1.655 raeburn 13140: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13141:
1.655 raeburn 13142: allitems (reference to hash - key is category key
13143: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13144:
1.655 raeburn 13145: idx (reference to hash of counters used in Domain Coordinator interface for
13146: editing Course Categories).
1.663 raeburn 13147:
1.655 raeburn 13148: jsarray (reference to array of categories used to create Javascript arrays for
13149: Domain Coordinator interface for editing Course Categories).
13150:
1.665 raeburn 13151: subcats (reference to hash of arrays containing all subcategories within each
13152: category, -recursive)
13153:
1.655 raeburn 13154: Returns: nothing
13155:
13156: Side effects: populates trails and allitems hash references.
13157:
13158: =cut
13159:
13160: sub extract_categories {
1.665 raeburn 13161: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13162: if (ref($categories) eq 'HASH') {
13163: &gather_categories($categories,$cats,$idx,$jsarray);
13164: if (ref($cats->[0]) eq 'ARRAY') {
13165: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13166: my $name = $cats->[0][$i];
13167: my $item = &escape($name).'::0';
13168: my $trailstr;
13169: if ($name eq 'instcode') {
13170: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13171: } elsif ($name eq 'communities') {
13172: $trailstr = &mt('Communities');
1.655 raeburn 13173: } else {
13174: $trailstr = $name;
13175: }
13176: if ($allitems->{$item} eq '') {
13177: push(@{$trails},$trailstr);
13178: $allitems->{$item} = scalar(@{$trails})-1;
13179: }
13180: my @parents = ($name);
13181: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13182: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13183: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13184: if (ref($subcats) eq 'HASH') {
13185: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13186: }
13187: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13188: }
13189: } else {
13190: if (ref($subcats) eq 'HASH') {
13191: $subcats->{$item} = [];
1.655 raeburn 13192: }
13193: }
13194: }
13195: }
13196: }
13197: return;
13198: }
13199:
13200: =pod
13201:
13202: =item *&recurse_categories()
13203:
13204: Recursively used to generate breadcrumb trails for course categories.
13205:
13206: Inputs:
1.663 raeburn 13207:
1.655 raeburn 13208: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13209: categories and subcategories).
1.663 raeburn 13210:
1.655 raeburn 13211: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13212:
13213: category (current course category, for which breadcrumb trail is being generated).
13214:
13215: trails (reference to array of breadcrumb trails for each category).
13216:
1.655 raeburn 13217: allitems (reference to hash - key is category key
13218: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13219:
1.655 raeburn 13220: parents (array containing containers directories for current category,
13221: back to top level).
13222:
13223: Returns: nothing
13224:
13225: Side effects: populates trails and allitems hash references
13226:
13227: =cut
13228:
13229: sub recurse_categories {
1.665 raeburn 13230: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13231: my $shallower = $depth - 1;
13232: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13233: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13234: my $name = $cats->[$depth]{$category}[$k];
13235: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13236: my $trailstr = join(' -> ',(@{$parents},$category));
13237: if ($allitems->{$item} eq '') {
13238: push(@{$trails},$trailstr);
13239: $allitems->{$item} = scalar(@{$trails})-1;
13240: }
13241: my $deeper = $depth+1;
13242: push(@{$parents},$category);
1.665 raeburn 13243: if (ref($subcats) eq 'HASH') {
13244: my $subcat = &escape($name).':'.$category.':'.$depth;
13245: for (my $j=@{$parents}; $j>=0; $j--) {
13246: my $higher;
13247: if ($j > 0) {
13248: $higher = &escape($parents->[$j]).':'.
13249: &escape($parents->[$j-1]).':'.$j;
13250: } else {
13251: $higher = &escape($parents->[$j]).'::'.$j;
13252: }
13253: push(@{$subcats->{$higher}},$subcat);
13254: }
13255: }
13256: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13257: $subcats);
1.655 raeburn 13258: pop(@{$parents});
13259: }
13260: } else {
13261: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13262: my $trailstr = join(' -> ',(@{$parents},$category));
13263: if ($allitems->{$item} eq '') {
13264: push(@{$trails},$trailstr);
13265: $allitems->{$item} = scalar(@{$trails})-1;
13266: }
13267: }
13268: return;
13269: }
13270:
1.663 raeburn 13271: =pod
13272:
13273: =item *&assign_categories_table()
13274:
13275: Create a datatable for display of hierarchical categories in a domain,
13276: with checkboxes to allow a course to be categorized.
13277:
13278: Inputs:
13279:
13280: cathash - reference to hash of categories defined for the domain (from
13281: configuration.db)
13282:
13283: currcat - scalar with an & separated list of categories assigned to a course.
13284:
1.919 raeburn 13285: type - scalar contains course type (Course or Community).
13286:
1.663 raeburn 13287: Returns: $output (markup to be displayed)
13288:
13289: =cut
13290:
13291: sub assign_categories_table {
1.919 raeburn 13292: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13293: my $output;
13294: if (ref($cathash) eq 'HASH') {
13295: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13296: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13297: $maxdepth = scalar(@cats);
13298: if (@cats > 0) {
13299: my $itemcount = 0;
13300: if (ref($cats[0]) eq 'ARRAY') {
13301: my @currcategories;
13302: if ($currcat ne '') {
13303: @currcategories = split('&',$currcat);
13304: }
1.919 raeburn 13305: my $table;
1.663 raeburn 13306: for (my $i=0; $i<@{$cats[0]}; $i++) {
13307: my $parent = $cats[0][$i];
1.919 raeburn 13308: next if ($parent eq 'instcode');
13309: if ($type eq 'Community') {
13310: next unless ($parent eq 'communities');
13311: } else {
13312: next if ($parent eq 'communities');
13313: }
1.663 raeburn 13314: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13315: my $item = &escape($parent).'::0';
13316: my $checked = '';
13317: if (@currcategories > 0) {
13318: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13319: $checked = ' checked="checked"';
1.663 raeburn 13320: }
13321: }
1.919 raeburn 13322: my $parent_title = $parent;
13323: if ($parent eq 'communities') {
13324: $parent_title = &mt('Communities');
13325: }
13326: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13327: '<input type="checkbox" name="usecategory" value="'.
13328: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13329: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13330: my $depth = 1;
13331: push(@path,$parent);
1.919 raeburn 13332: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13333: pop(@path);
1.919 raeburn 13334: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13335: $itemcount ++;
13336: }
1.919 raeburn 13337: if ($itemcount) {
13338: $output = &Apache::loncommon::start_data_table().
13339: $table.
13340: &Apache::loncommon::end_data_table();
13341: }
1.663 raeburn 13342: }
13343: }
13344: }
13345: return $output;
13346: }
13347:
13348: =pod
13349:
13350: =item *&assign_category_rows()
13351:
13352: Create a datatable row for display of nested categories in a domain,
13353: with checkboxes to allow a course to be categorized,called recursively.
13354:
13355: Inputs:
13356:
13357: itemcount - track row number for alternating colors
13358:
13359: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13360: categories and subcategories.
13361:
13362: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13363:
13364: parent - parent of current category item
13365:
13366: path - Array containing all categories back up through the hierarchy from the
13367: current category to the top level.
13368:
13369: currcategories - reference to array of current categories assigned to the course
13370:
13371: Returns: $output (markup to be displayed).
13372:
13373: =cut
13374:
13375: sub assign_category_rows {
13376: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13377: my ($text,$name,$item,$chgstr);
13378: if (ref($cats) eq 'ARRAY') {
13379: my $maxdepth = scalar(@{$cats});
13380: if (ref($cats->[$depth]) eq 'HASH') {
13381: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13382: my $numchildren = @{$cats->[$depth]{$parent}};
13383: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13384: $text .= '<td><table class="LC_datatable">';
13385: for (my $j=0; $j<$numchildren; $j++) {
13386: $name = $cats->[$depth]{$parent}[$j];
13387: $item = &escape($name).':'.&escape($parent).':'.$depth;
13388: my $deeper = $depth+1;
13389: my $checked = '';
13390: if (ref($currcategories) eq 'ARRAY') {
13391: if (@{$currcategories} > 0) {
13392: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13393: $checked = ' checked="checked"';
1.663 raeburn 13394: }
13395: }
13396: }
1.664 raeburn 13397: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13398: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13399: $item.'"'.$checked.' />'.$name.'</label></span>'.
13400: '<input type="hidden" name="catname" value="'.$name.'" />'.
13401: '</td><td>';
1.663 raeburn 13402: if (ref($path) eq 'ARRAY') {
13403: push(@{$path},$name);
13404: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13405: pop(@{$path});
13406: }
13407: $text .= '</td></tr>';
13408: }
13409: $text .= '</table></td>';
13410: }
13411: }
13412: }
13413: return $text;
13414: }
13415:
1.655 raeburn 13416: ############################################################
13417: ############################################################
13418:
13419:
1.443 albertel 13420: sub commit_customrole {
1.664 raeburn 13421: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13422: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13423: ($start?', '.&mt('starting').' '.localtime($start):'').
13424: ($end?', ending '.localtime($end):'').': <b>'.
13425: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13426: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13427: '</b><br />';
13428: return $output;
13429: }
13430:
13431: sub commit_standardrole {
1.1116 raeburn 13432: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 13433: my ($output,$logmsg,$linefeed);
13434: if ($context eq 'auto') {
13435: $linefeed = "\n";
13436: } else {
13437: $linefeed = "<br />\n";
13438: }
1.443 albertel 13439: if ($three eq 'st') {
1.541 raeburn 13440: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 13441: $one,$two,$sec,$context,$credits);
1.541 raeburn 13442: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13443: ($result eq 'unknown_course') || ($result eq 'refused')) {
13444: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13445: } else {
1.541 raeburn 13446: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13447: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13448: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13449: if ($context eq 'auto') {
13450: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13451: } else {
13452: $output .= '<b>'.$result.'</b>'.$linefeed.
13453: &mt('Add to classlist').': <b>ok</b>';
13454: }
13455: $output .= $linefeed;
1.443 albertel 13456: }
13457: } else {
13458: $output = &mt('Assigning').' '.$three.' in '.$url.
13459: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13460: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13461: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13462: if ($context eq 'auto') {
13463: $output .= $result.$linefeed;
13464: } else {
13465: $output .= '<b>'.$result.'</b>'.$linefeed;
13466: }
1.443 albertel 13467: }
13468: return $output;
13469: }
13470:
13471: sub commit_studentrole {
1.1116 raeburn 13472: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
13473: $credits) = @_;
1.626 raeburn 13474: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13475: if ($context eq 'auto') {
13476: $linefeed = "\n";
13477: } else {
13478: $linefeed = '<br />'."\n";
13479: }
1.443 albertel 13480: if (defined($one) && defined($two)) {
13481: my $cid=$one.'_'.$two;
13482: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13483: my $secchange = 0;
13484: my $expire_role_result;
13485: my $modify_section_result;
1.628 raeburn 13486: if ($oldsec ne '-1') {
13487: if ($oldsec ne $sec) {
1.443 albertel 13488: $secchange = 1;
1.628 raeburn 13489: my $now = time;
1.443 albertel 13490: my $uurl='/'.$cid;
13491: $uurl=~s/\_/\//g;
13492: if ($oldsec) {
13493: $uurl.='/'.$oldsec;
13494: }
1.626 raeburn 13495: $oldsecurl = $uurl;
1.628 raeburn 13496: $expire_role_result =
1.652 raeburn 13497: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13498: if ($env{'request.course.sec'} ne '') {
13499: if ($expire_role_result eq 'refused') {
13500: my @roles = ('st');
13501: my @statuses = ('previous');
13502: my @roledoms = ($one);
13503: my $withsec = 1;
13504: my %roleshash =
13505: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13506: \@statuses,\@roles,\@roledoms,$withsec);
13507: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13508: my ($oldstart,$oldend) =
13509: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13510: if ($oldend > 0 && $oldend <= $now) {
13511: $expire_role_result = 'ok';
13512: }
13513: }
13514: }
13515: }
1.443 albertel 13516: $result = $expire_role_result;
13517: }
13518: }
13519: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 13520: $modify_section_result =
13521: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
13522: undef,undef,undef,$sec,
13523: $end,$start,'','',$cid,
13524: '',$context,$credits);
1.443 albertel 13525: if ($modify_section_result =~ /^ok/) {
13526: if ($secchange == 1) {
1.628 raeburn 13527: if ($sec eq '') {
13528: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13529: } else {
13530: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13531: }
1.443 albertel 13532: } elsif ($oldsec eq '-1') {
1.628 raeburn 13533: if ($sec eq '') {
13534: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13535: } else {
13536: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13537: }
1.443 albertel 13538: } else {
1.628 raeburn 13539: if ($sec eq '') {
13540: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13541: } else {
13542: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13543: }
1.443 albertel 13544: }
13545: } else {
1.1115 raeburn 13546: if ($secchange) {
1.628 raeburn 13547: $$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;
13548: } else {
13549: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13550: }
1.443 albertel 13551: }
13552: $result = $modify_section_result;
13553: } elsif ($secchange == 1) {
1.628 raeburn 13554: if ($oldsec eq '') {
1.1103 raeburn 13555: $$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 13556: } else {
13557: $$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;
13558: }
1.626 raeburn 13559: if ($expire_role_result eq 'refused') {
13560: my $newsecurl = '/'.$cid;
13561: $newsecurl =~ s/\_/\//g;
13562: if ($sec ne '') {
13563: $newsecurl.='/'.$sec;
13564: }
13565: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13566: if ($sec eq '') {
13567: $$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;
13568: } else {
13569: $$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;
13570: }
13571: }
13572: }
1.443 albertel 13573: }
13574: } else {
1.626 raeburn 13575: $$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 13576: $result = "error: incomplete course id\n";
13577: }
13578: return $result;
13579: }
13580:
1.1108 raeburn 13581: sub show_role_extent {
13582: my ($scope,$context,$role) = @_;
13583: $scope =~ s{^/}{};
13584: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
13585: push(@courseroles,'co');
13586: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
13587: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
13588: $scope =~ s{/}{_};
13589: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
13590: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
13591: my ($audom,$auname) = split(/\//,$scope);
13592: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
13593: &Apache::loncommon::plainname($auname,$audom).'</span>');
13594: } else {
13595: $scope =~ s{/$}{};
13596: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
13597: &Apache::lonnet::domain($scope,'description').'</span>');
13598: }
13599: }
13600:
1.443 albertel 13601: ############################################################
13602: ############################################################
13603:
1.566 albertel 13604: sub check_clone {
1.578 raeburn 13605: my ($args,$linefeed) = @_;
1.566 albertel 13606: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13607: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13608: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13609: my $clonemsg;
13610: my $can_clone = 0;
1.944 raeburn 13611: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13612: if ($lctype ne 'community') {
13613: $lctype = 'course';
13614: }
1.566 albertel 13615: if ($clonehome eq 'no_host') {
1.944 raeburn 13616: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13617: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
13618: } else {
13619: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
13620: }
1.566 albertel 13621: } else {
13622: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13623: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13624: if ($clonedesc{'type'} ne 'Community') {
13625: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
13626: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13627: }
13628: }
1.882 raeburn 13629: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13630: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13631: $can_clone = 1;
13632: } else {
13633: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13634: $args->{'clonedomain'},$args->{'clonecourse'});
13635: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13636: if (grep(/^\*$/,@cloners)) {
13637: $can_clone = 1;
13638: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13639: $can_clone = 1;
13640: } else {
1.908 raeburn 13641: my $ccrole = 'cc';
1.944 raeburn 13642: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13643: $ccrole = 'co';
13644: }
1.578 raeburn 13645: my %roleshash =
13646: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13647: $args->{'ccdomain'},
1.908 raeburn 13648: 'userroles',['active'],[$ccrole],
1.578 raeburn 13649: [$args->{'clonedomain'}]);
1.908 raeburn 13650: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13651: $can_clone = 1;
13652: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13653: $can_clone = 1;
13654: } else {
1.944 raeburn 13655: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13656: $clonemsg = &mt('No new community created.').$linefeed.&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]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
13657: } else {
13658: $clonemsg = &mt('No new course created.').$linefeed.&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]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
13659: }
1.578 raeburn 13660: }
1.566 albertel 13661: }
1.578 raeburn 13662: }
1.566 albertel 13663: }
13664: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13665: }
13666:
1.444 albertel 13667: sub construct_course {
1.885 raeburn 13668: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13669: my $outcome;
1.541 raeburn 13670: my $linefeed = '<br />'."\n";
13671: if ($context eq 'auto') {
13672: $linefeed = "\n";
13673: }
1.566 albertel 13674:
13675: #
13676: # Are we cloning?
13677: #
13678: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13679: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13680: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13681: if ($context ne 'auto') {
1.578 raeburn 13682: if ($clonemsg ne '') {
13683: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13684: }
1.566 albertel 13685: }
13686: $outcome .= $clonemsg.$linefeed;
13687:
13688: if (!$can_clone) {
13689: return (0,$outcome);
13690: }
13691: }
13692:
1.444 albertel 13693: #
13694: # Open course
13695: #
13696: my $crstype = lc($args->{'crstype'});
13697: my %cenv=();
13698: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13699: $args->{'cdescr'},
13700: $args->{'curl'},
13701: $args->{'course_home'},
13702: $args->{'nonstandard'},
13703: $args->{'crscode'},
13704: $args->{'ccuname'}.':'.
13705: $args->{'ccdomain'},
1.882 raeburn 13706: $args->{'crstype'},
1.885 raeburn 13707: $cnum,$context,$category);
1.444 albertel 13708:
13709: # Note: The testing routines depend on this being output; see
13710: # Utils::Course. This needs to at least be output as a comment
13711: # if anyone ever decides to not show this, and Utils::Course::new
13712: # will need to be suitably modified.
1.541 raeburn 13713: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13714: if ($$courseid =~ /^error:/) {
13715: return (0,$outcome);
13716: }
13717:
1.444 albertel 13718: #
13719: # Check if created correctly
13720: #
1.479 albertel 13721: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13722: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13723: if ($crsuhome eq 'no_host') {
13724: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13725: return (0,$outcome);
13726: }
1.541 raeburn 13727: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13728:
1.444 albertel 13729: #
1.566 albertel 13730: # Do the cloning
13731: #
13732: if ($can_clone && $cloneid) {
13733: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13734: if ($context ne 'auto') {
13735: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13736: }
13737: $outcome .= $clonemsg.$linefeed;
13738: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13739: # Copy all files
1.637 www 13740: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13741: # Restore URL
1.566 albertel 13742: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13743: # Restore title
1.566 albertel 13744: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13745: # Restore creation date, creator and creation context.
13746: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13747: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13748: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13749: # Mark as cloned
1.566 albertel 13750: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13751: # Need to clone grading mode
13752: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13753: $cenv{'grading'}=$newenv{'grading'};
13754: # Do not clone these environment entries
13755: &Apache::lonnet::del('environment',
13756: ['default_enrollment_start_date',
13757: 'default_enrollment_end_date',
13758: 'question.email',
13759: 'policy.email',
13760: 'comment.email',
13761: 'pch.users.denied',
1.725 raeburn 13762: 'plc.users.denied',
13763: 'hidefromcat',
1.1121 raeburn 13764: 'checkforpriv',
1.725 raeburn 13765: 'categories'],
1.638 www 13766: $$crsudom,$$crsunum);
1.444 albertel 13767: }
1.566 albertel 13768:
1.444 albertel 13769: #
13770: # Set environment (will override cloned, if existing)
13771: #
13772: my @sections = ();
13773: my @xlists = ();
13774: if ($args->{'crstype'}) {
13775: $cenv{'type'}=$args->{'crstype'};
13776: }
13777: if ($args->{'crsid'}) {
13778: $cenv{'courseid'}=$args->{'crsid'};
13779: }
13780: if ($args->{'crscode'}) {
13781: $cenv{'internal.coursecode'}=$args->{'crscode'};
13782: }
13783: if ($args->{'crsquota'} ne '') {
13784: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13785: } else {
13786: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13787: }
13788: if ($args->{'ccuname'}) {
13789: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13790: ':'.$args->{'ccdomain'};
13791: } else {
13792: $cenv{'internal.courseowner'} = $args->{'curruser'};
13793: }
1.1116 raeburn 13794: if ($args->{'defaultcredits'}) {
13795: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
13796: }
1.444 albertel 13797: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13798: if ($args->{'crssections'}) {
13799: $cenv{'internal.sectionnums'} = '';
13800: if ($args->{'crssections'} =~ m/,/) {
13801: @sections = split/,/,$args->{'crssections'};
13802: } else {
13803: $sections[0] = $args->{'crssections'};
13804: }
13805: if (@sections > 0) {
13806: foreach my $item (@sections) {
13807: my ($sec,$gp) = split/:/,$item;
13808: my $class = $args->{'crscode'}.$sec;
13809: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13810: $cenv{'internal.sectionnums'} .= $item.',';
13811: unless ($addcheck eq 'ok') {
13812: push @badclasses, $class;
13813: }
13814: }
13815: $cenv{'internal.sectionnums'} =~ s/,$//;
13816: }
13817: }
13818: # do not hide course coordinator from staff listing,
13819: # even if privileged
13820: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 13821: # add course coordinator's domain to domains to check for privileged users
13822: # if different to course domain
13823: if ($$crsudom ne $args->{'ccdomain'}) {
13824: $cenv{'checkforpriv'} = $args->{'ccdomain'};
13825: }
1.444 albertel 13826: # add crosslistings
13827: if ($args->{'crsxlist'}) {
13828: $cenv{'internal.crosslistings'}='';
13829: if ($args->{'crsxlist'} =~ m/,/) {
13830: @xlists = split/,/,$args->{'crsxlist'};
13831: } else {
13832: $xlists[0] = $args->{'crsxlist'};
13833: }
13834: if (@xlists > 0) {
13835: foreach my $item (@xlists) {
13836: my ($xl,$gp) = split/:/,$item;
13837: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13838: $cenv{'internal.crosslistings'} .= $item.',';
13839: unless ($addcheck eq 'ok') {
13840: push @badclasses, $xl;
13841: }
13842: }
13843: $cenv{'internal.crosslistings'} =~ s/,$//;
13844: }
13845: }
13846: if ($args->{'autoadds'}) {
13847: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13848: }
13849: if ($args->{'autodrops'}) {
13850: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13851: }
13852: # check for notification of enrollment changes
13853: my @notified = ();
13854: if ($args->{'notify_owner'}) {
13855: if ($args->{'ccuname'} ne '') {
13856: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13857: }
13858: }
13859: if ($args->{'notify_dc'}) {
13860: if ($uname ne '') {
1.630 raeburn 13861: push(@notified,$uname.':'.$udom);
1.444 albertel 13862: }
13863: }
13864: if (@notified > 0) {
13865: my $notifylist;
13866: if (@notified > 1) {
13867: $notifylist = join(',',@notified);
13868: } else {
13869: $notifylist = $notified[0];
13870: }
13871: $cenv{'internal.notifylist'} = $notifylist;
13872: }
13873: if (@badclasses > 0) {
13874: my %lt=&Apache::lonlocal::texthash(
13875: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course. However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
13876: 'dnhr' => 'does not have rights to access enrollment in these classes',
13877: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13878: );
1.541 raeburn 13879: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13880: ' ('.$lt{'adby'}.')';
13881: if ($context eq 'auto') {
13882: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13883: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13884: foreach my $item (@badclasses) {
13885: if ($context eq 'auto') {
13886: $outcome .= " - $item\n";
13887: } else {
13888: $outcome .= "<li>$item</li>\n";
13889: }
13890: }
13891: if ($context eq 'auto') {
13892: $outcome .= $linefeed;
13893: } else {
1.566 albertel 13894: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13895: }
13896: }
1.444 albertel 13897: }
13898: if ($args->{'no_end_date'}) {
13899: $args->{'endaccess'} = 0;
13900: }
13901: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13902: $cenv{'internal.autoend'}=$args->{'enrollend'};
13903: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13904: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13905: if ($args->{'showphotos'}) {
13906: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13907: }
13908: $cenv{'internal.authtype'} = $args->{'authtype'};
13909: $cenv{'internal.autharg'} = $args->{'autharg'};
13910: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13911: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13912: 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');
13913: if ($context eq 'auto') {
13914: $outcome .= $krb_msg;
13915: } else {
1.566 albertel 13916: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13917: }
13918: $outcome .= $linefeed;
1.444 albertel 13919: }
13920: }
13921: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13922: if ($args->{'setpolicy'}) {
13923: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13924: }
13925: if ($args->{'setcontent'}) {
13926: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13927: }
13928: }
13929: if ($args->{'reshome'}) {
13930: $cenv{'reshome'}=$args->{'reshome'}.'/';
13931: $cenv{'reshome'}=~s/\/+$/\//;
13932: }
13933: #
13934: # course has keyed access
13935: #
13936: if ($args->{'setkeys'}) {
13937: $cenv{'keyaccess'}='yes';
13938: }
13939: # if specified, key authority is not course, but user
13940: # only active if keyaccess is yes
13941: if ($args->{'keyauth'}) {
1.487 albertel 13942: my ($user,$domain) = split(':',$args->{'keyauth'});
13943: $user = &LONCAPA::clean_username($user);
13944: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13945: if ($user ne '' && $domain ne '') {
1.487 albertel 13946: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13947: }
13948: }
13949:
13950: if ($args->{'disresdis'}) {
13951: $cenv{'pch.roles.denied'}='st';
13952: }
13953: if ($args->{'disablechat'}) {
13954: $cenv{'plc.roles.denied'}='st';
13955: }
13956:
13957: # Record we've not yet viewed the Course Initialization Helper for this
13958: # course
13959: $cenv{'course.helper.not.run'} = 1;
13960: #
13961: # Use new Randomseed
13962: #
13963: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13964: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13965: #
13966: # The encryption code and receipt prefix for this course
13967: #
13968: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13969: $cenv{'internal.encpref'}=100+int(9*rand(99));
13970: #
13971: # By default, use standard grading
13972: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13973:
1.541 raeburn 13974: $outcome .= $linefeed.&mt('Setting environment').': '.
13975: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13976: #
13977: # Open all assignments
13978: #
13979: if ($args->{'openall'}) {
13980: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13981: my %storecontent = ($storeunder => time,
13982: $storeunder.'.type' => 'date_start');
13983:
13984: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13985: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13986: }
13987: #
13988: # Set first page
13989: #
13990: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13991: || ($cloneid)) {
1.445 albertel 13992: use LONCAPA::map;
1.444 albertel 13993: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13994:
13995: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13996: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13997:
1.444 albertel 13998: $outcome .= ($fatal?$errtext:'read ok').' - ';
13999: my $title; my $url;
14000: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 14001: $title=&mt('Syllabus');
1.444 albertel 14002: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
14003: } else {
1.963 raeburn 14004: $title=&mt('Table of Contents');
1.444 albertel 14005: $url='/adm/navmaps';
14006: }
1.445 albertel 14007:
14008: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
14009: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
14010:
14011: if ($errtext) { $fatal=2; }
1.541 raeburn 14012: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 14013: }
1.566 albertel 14014:
14015: return (1,$outcome);
1.444 albertel 14016: }
14017:
14018: ############################################################
14019: ############################################################
14020:
1.953 droeschl 14021: #SD
14022: # only Community and Course, or anything else?
1.378 raeburn 14023: sub course_type {
14024: my ($cid) = @_;
14025: if (!defined($cid)) {
14026: $cid = $env{'request.course.id'};
14027: }
1.404 albertel 14028: if (defined($env{'course.'.$cid.'.type'})) {
14029: return $env{'course.'.$cid.'.type'};
1.378 raeburn 14030: } else {
14031: return 'Course';
1.377 raeburn 14032: }
14033: }
1.156 albertel 14034:
1.406 raeburn 14035: sub group_term {
14036: my $crstype = &course_type();
14037: my %names = (
14038: 'Course' => 'group',
1.865 raeburn 14039: 'Community' => 'group',
1.406 raeburn 14040: );
14041: return $names{$crstype};
14042: }
14043:
1.902 raeburn 14044: sub course_types {
14045: my @types = ('official','unofficial','community');
14046: my %typename = (
14047: official => 'Official course',
14048: unofficial => 'Unofficial course',
14049: community => 'Community',
14050: );
14051: return (\@types,\%typename);
14052: }
14053:
1.156 albertel 14054: sub icon {
14055: my ($file)=@_;
1.505 albertel 14056: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 14057: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 14058: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 14059: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
14060: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
14061: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14062: $curfext.".gif") {
14063: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14064: $curfext.".gif";
14065: }
14066: }
1.249 albertel 14067: return &lonhttpdurl($iconname);
1.154 albertel 14068: }
1.84 albertel 14069:
1.575 albertel 14070: sub lonhttpdurl {
1.692 www 14071: #
14072: # Had been used for "small fry" static images on separate port 8080.
14073: # Modify here if lightweight http functionality desired again.
14074: # Currently eliminated due to increasing firewall issues.
14075: #
1.575 albertel 14076: my ($url)=@_;
1.692 www 14077: return $url;
1.215 albertel 14078: }
14079:
1.213 albertel 14080: sub connection_aborted {
14081: my ($r)=@_;
14082: $r->print(" ");$r->rflush();
14083: my $c = $r->connection;
14084: return $c->aborted();
14085: }
14086:
1.221 foxr 14087: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 14088: # strings as 'strings'.
14089: sub escape_single {
1.221 foxr 14090: my ($input) = @_;
1.223 albertel 14091: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 14092: $input =~ s/\'/\\\'/g; # Esacpe the 's....
14093: return $input;
14094: }
1.223 albertel 14095:
1.222 foxr 14096: # Same as escape_single, but escape's "'s This
14097: # can be used for "strings"
14098: sub escape_double {
14099: my ($input) = @_;
14100: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
14101: $input =~ s/\"/\\\"/g; # Esacpe the "s....
14102: return $input;
14103: }
1.223 albertel 14104:
1.222 foxr 14105: # Escapes the last element of a full URL.
14106: sub escape_url {
14107: my ($url) = @_;
1.238 raeburn 14108: my @urlslices = split(/\//, $url,-1);
1.369 www 14109: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 14110: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 14111: }
1.462 albertel 14112:
1.820 raeburn 14113: sub compare_arrays {
14114: my ($arrayref1,$arrayref2) = @_;
14115: my (@difference,%count);
14116: @difference = ();
14117: %count = ();
14118: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
14119: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
14120: foreach my $element (keys(%count)) {
14121: if ($count{$element} == 1) {
14122: push(@difference,$element);
14123: }
14124: }
14125: }
14126: return @difference;
14127: }
14128:
1.817 bisitz 14129: # -------------------------------------------------------- Initialize user login
1.462 albertel 14130: sub init_user_environment {
1.463 albertel 14131: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14132: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14133:
14134: my $public=($username eq 'public' && $domain eq 'public');
14135:
14136: # See if old ID present, if so, remove
14137:
1.1062 raeburn 14138: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14139: my $now=time;
14140:
14141: if ($public) {
14142: my $max_public=100;
14143: my $oldest;
14144: my $oldest_time=0;
14145: for(my $next=1;$next<=$max_public;$next++) {
14146: if (-e $lonids."/publicuser_$next.id") {
14147: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14148: if ($mtime<$oldest_time || !$oldest_time) {
14149: $oldest_time=$mtime;
14150: $oldest=$next;
14151: }
14152: } else {
14153: $cookie="publicuser_$next";
14154: last;
14155: }
14156: }
14157: if (!$cookie) { $cookie="publicuser_$oldest"; }
14158: } else {
1.463 albertel 14159: # if this isn't a robot, kill any existing non-robot sessions
14160: if (!$args->{'robot'}) {
14161: opendir(DIR,$lonids);
14162: while ($filename=readdir(DIR)) {
14163: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14164: unlink($lonids.'/'.$filename);
14165: }
1.462 albertel 14166: }
1.463 albertel 14167: closedir(DIR);
1.462 albertel 14168: }
14169: # Give them a new cookie
1.463 albertel 14170: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14171: : $now.$$.int(rand(10000)));
1.463 albertel 14172: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14173:
14174: # Initialize roles
14175:
1.1062 raeburn 14176: ($userroles,$firstaccenv,$timerintenv) =
14177: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14178: }
14179: # ------------------------------------ Check browser type and MathML capability
14180:
14181: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
14182: $clientunicode,$clientos) = &decode_user_agent($r);
14183:
14184: # ------------------------------------------------------------- Get environment
14185:
14186: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14187: my ($tmp) = keys(%userenv);
14188: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14189: } else {
14190: undef(%userenv);
14191: }
14192: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14193: $form->{'interface'}=$userenv{'interface'};
14194: }
14195: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14196:
14197: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14198: foreach my $option ('interface','localpath','localres') {
14199: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14200: }
14201: # --------------------------------------------------------- Write first profile
14202:
14203: {
14204: my %initial_env =
14205: ("user.name" => $username,
14206: "user.domain" => $domain,
14207: "user.home" => $authhost,
14208: "browser.type" => $clientbrowser,
14209: "browser.version" => $clientversion,
14210: "browser.mathml" => $clientmathml,
14211: "browser.unicode" => $clientunicode,
14212: "browser.os" => $clientos,
14213: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14214: "request.course.fn" => '',
14215: "request.course.uri" => '',
14216: "request.course.sec" => '',
14217: "request.role" => 'cm',
14218: "request.role.adv" => $env{'user.adv'},
14219: "request.host" => $ENV{'REMOTE_ADDR'},);
14220:
14221: if ($form->{'localpath'}) {
14222: $initial_env{"browser.localpath"} = $form->{'localpath'};
14223: $initial_env{"browser.localres"} = $form->{'localres'};
14224: }
14225:
14226: if ($form->{'interface'}) {
14227: $form->{'interface'}=~s/\W//gs;
14228: $initial_env{"browser.interface"} = $form->{'interface'};
14229: $env{'browser.interface'}=$form->{'interface'};
14230: }
14231:
1.981 raeburn 14232: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14233: my %domdef;
14234: unless ($domain eq 'public') {
14235: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14236: }
1.980 raeburn 14237:
1.1081 raeburn 14238: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14239: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14240: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14241: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14242: }
14243:
1.864 raeburn 14244: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 14245: $userenv{'canrequest.'.$crstype} =
14246: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 14247: 'reload','requestcourses',
14248: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 14249: }
14250:
1.1092 raeburn 14251: $userenv{'canrequest.author'} =
14252: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
14253: 'reload','requestauthor',
14254: \%userenv,\%domdef,\%is_adv);
14255: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
14256: $domain,$username);
14257: my $reqstatus = $reqauthor{'author_status'};
14258: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
14259: if (ref($reqauthor{'author'}) eq 'HASH') {
14260: $userenv{'requestauthorqueued'} = $reqstatus.':'.
14261: $reqauthor{'author'}{'timestamp'};
14262: }
14263: }
14264:
1.462 albertel 14265: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 14266:
1.462 albertel 14267: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
14268: &GDBM_WRCREAT(),0640)) {
14269: &_add_to_env(\%disk_env,\%initial_env);
14270: &_add_to_env(\%disk_env,\%userenv,'environment.');
14271: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 14272: if (ref($firstaccenv) eq 'HASH') {
14273: &_add_to_env(\%disk_env,$firstaccenv);
14274: }
14275: if (ref($timerintenv) eq 'HASH') {
14276: &_add_to_env(\%disk_env,$timerintenv);
14277: }
1.463 albertel 14278: if (ref($args->{'extra_env'})) {
14279: &_add_to_env(\%disk_env,$args->{'extra_env'});
14280: }
1.462 albertel 14281: untie(%disk_env);
14282: } else {
1.705 tempelho 14283: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
14284: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 14285: return 'error: '.$!;
14286: }
14287: }
14288: $env{'request.role'}='cm';
14289: $env{'request.role.adv'}=$env{'user.adv'};
14290: $env{'browser.type'}=$clientbrowser;
14291:
14292: return $cookie;
14293:
14294: }
14295:
14296: sub _add_to_env {
14297: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 14298: if (ref($env_data) eq 'HASH') {
14299: while (my ($key,$value) = each(%$env_data)) {
14300: $idf->{$prefix.$key} = $value;
14301: $env{$prefix.$key} = $value;
14302: }
1.462 albertel 14303: }
14304: }
14305:
1.685 tempelho 14306: # --- Get the symbolic name of a problem and the url
14307: sub get_symb {
14308: my ($request,$silent) = @_;
1.726 raeburn 14309: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 14310: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
14311: if ($symb eq '') {
14312: if (!$silent) {
1.1071 raeburn 14313: if (ref($request)) {
14314: $request->print("Unable to handle ambiguous references:$url:.");
14315: }
1.685 tempelho 14316: return ();
14317: }
14318: }
14319: &Apache::lonenc::check_decrypt(\$symb);
14320: return ($symb);
14321: }
14322:
14323: # --------------------------------------------------------------Get annotation
14324:
14325: sub get_annotation {
14326: my ($symb,$enc) = @_;
14327:
14328: my $key = $symb;
14329: if (!$enc) {
14330: $key =
14331: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
14332: }
14333: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
14334: return $annotation{$key};
14335: }
14336:
14337: sub clean_symb {
1.731 raeburn 14338: my ($symb,$delete_enc) = @_;
1.685 tempelho 14339:
14340: &Apache::lonenc::check_decrypt(\$symb);
14341: my $enc = $env{'request.enc'};
1.731 raeburn 14342: if ($delete_enc) {
1.730 raeburn 14343: delete($env{'request.enc'});
14344: }
1.685 tempelho 14345:
14346: return ($symb,$enc);
14347: }
1.462 albertel 14348:
1.990 raeburn 14349: sub build_release_hashes {
14350: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
14351: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
14352: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
14353: (ref($randomizetry) eq 'HASH'));
14354: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14355: my ($item,$name,$value) = split(/:/,$key);
14356: if ($item eq 'parameter') {
14357: if (ref($checkparms->{$name}) eq 'ARRAY') {
14358: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
14359: push(@{$checkparms->{$name}},$value);
14360: }
14361: } else {
14362: push(@{$checkparms->{$name}},$value);
14363: }
14364: } elsif ($item eq 'resourcetag') {
14365: if ($name eq 'responsetype') {
14366: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
14367: }
14368: } elsif ($item eq 'course') {
14369: if ($name eq 'crstype') {
14370: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14371: }
14372: }
14373: }
14374: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14375: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14376: return;
14377: }
14378:
1.1083 raeburn 14379: sub update_content_constraints {
14380: my ($cdom,$cnum,$chome,$cid) = @_;
14381: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14382: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14383: my %checkresponsetypes;
14384: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14385: my ($item,$name,$value) = split(/:/,$key);
14386: if ($item eq 'resourcetag') {
14387: if ($name eq 'responsetype') {
14388: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14389: }
14390: }
14391: }
14392: my $navmap = Apache::lonnavmaps::navmap->new();
14393: if (defined($navmap)) {
14394: my %allresponses;
14395: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14396: my %responses = $res->responseTypes();
14397: foreach my $key (keys(%responses)) {
14398: next unless(exists($checkresponsetypes{$key}));
14399: $allresponses{$key} += $responses{$key};
14400: }
14401: }
14402: foreach my $key (keys(%allresponses)) {
14403: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14404: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14405: ($reqdmajor,$reqdminor) = ($major,$minor);
14406: }
14407: }
14408: undef($navmap);
14409: }
14410: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14411: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14412: }
14413: return;
14414: }
14415:
1.1110 raeburn 14416: sub allmaps_incourse {
14417: my ($cdom,$cnum,$chome,$cid) = @_;
14418: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
14419: $cid = $env{'request.course.id'};
14420: $cdom = $env{'course.'.$cid.'.domain'};
14421: $cnum = $env{'course.'.$cid.'.num'};
14422: $chome = $env{'course.'.$cid.'.home'};
14423: }
14424: my %allmaps = ();
14425: my $lastchange =
14426: &Apache::lonnet::get_coursechange($cdom,$cnum);
14427: if ($lastchange > $env{'request.course.tied'}) {
14428: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
14429: unless ($ferr) {
14430: &update_content_constraints($cdom,$cnum,$chome,$cid);
14431: }
14432: }
14433: my $navmap = Apache::lonnavmaps::navmap->new();
14434: if (defined($navmap)) {
14435: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
14436: $allmaps{$res->src()} = 1;
14437: }
14438: }
14439: return \%allmaps;
14440: }
14441:
1.1083 raeburn 14442: sub parse_supplemental_title {
14443: my ($title) = @_;
14444:
14445: my ($foldertitle,$renametitle);
14446: if ($title =~ /&&&/) {
14447: $title = &HTML::Entites::decode($title);
14448: }
14449: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14450: $renametitle=$4;
14451: my ($time,$uname,$udom) = ($1,$2,$3);
14452: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14453: my $name = &plainname($uname,$udom);
14454: $name = &HTML::Entities::encode($name,'"<>&\'');
14455: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14456: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14457: $name.': <br />'.$foldertitle;
14458: }
14459: if (wantarray) {
14460: return ($title,$foldertitle,$renametitle);
14461: }
14462: return $title;
14463: }
14464:
1.1101 raeburn 14465: sub symb_to_docspath {
14466: my ($symb) = @_;
14467: return unless ($symb);
14468: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
14469: if ($resurl=~/\.(sequence|page)$/) {
14470: $mapurl=$resurl;
14471: } elsif ($resurl eq 'adm/navmaps') {
14472: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
14473: }
14474: my $mapresobj;
14475: my $navmap = Apache::lonnavmaps::navmap->new();
14476: if (ref($navmap)) {
14477: $mapresobj = $navmap->getResourceByUrl($mapurl);
14478: }
14479: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
14480: my $type=$2;
14481: my $path;
14482: if (ref($mapresobj)) {
14483: my $pcslist = $mapresobj->map_hierarchy();
14484: if ($pcslist ne '') {
14485: foreach my $pc (split(/,/,$pcslist)) {
14486: next if ($pc <= 1);
14487: my $res = $navmap->getByMapPc($pc);
14488: if (ref($res)) {
14489: my $thisurl = $res->src();
14490: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
14491: my $thistitle = $res->title();
14492: $path .= '&'.
14493: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
14494: &Apache::lonhtmlcommon::entity_encode($thistitle).
14495: ':'.$res->randompick().
14496: ':'.$res->randomout().
14497: ':'.$res->encrypted().
14498: ':'.$res->randomorder().
14499: ':'.$res->is_page();
14500: }
14501: }
14502: }
14503: $path =~ s/^\&//;
14504: my $maptitle = $mapresobj->title();
14505: if ($mapurl eq 'default') {
1.1129 raeburn 14506: $maptitle = 'Main Content';
1.1101 raeburn 14507: }
14508: $path .= (($path ne '')? '&' : '').
14509: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
14510: &Apache::lonhtmlcommon::entity_encode($maptitle).
14511: ':'.$mapresobj->randompick().
14512: ':'.$mapresobj->randomout().
14513: ':'.$mapresobj->encrypted().
14514: ':'.$mapresobj->randomorder().
14515: ':'.$mapresobj->is_page();
14516: } else {
14517: my $maptitle = &Apache::lonnet::gettitle($mapurl);
14518: my $ispage = (($type eq 'page')? 1 : '');
14519: if ($mapurl eq 'default') {
1.1129 raeburn 14520: $maptitle = 'Main Content';
1.1101 raeburn 14521: }
14522: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
14523: &Apache::lonhtmlcommon::entity_encode($maptitle).':::::'.$ispage;
14524: }
14525: unless ($mapurl eq 'default') {
14526: $path = 'default&'.
1.1129 raeburn 14527: &Apache::lonhtmlcommon::entity_encode('Main Content').
1.1101 raeburn 14528: ':::::&'.$path;
14529: }
14530: return $path;
14531: }
14532:
1.1094 raeburn 14533: sub captcha_display {
14534: my ($context,$lonhost) = @_;
14535: my ($output,$error);
14536: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14537: if ($captcha eq 'original') {
1.1094 raeburn 14538: $output = &create_captcha();
14539: unless ($output) {
14540: $error = 'captcha';
14541: }
14542: } elsif ($captcha eq 'recaptcha') {
14543: $output = &create_recaptcha($pubkey);
14544: unless ($output) {
1.1095 raeburn 14545: $error = 'recaptcha';
1.1094 raeburn 14546: }
14547: }
14548: return ($output,$error);
14549: }
14550:
14551: sub captcha_response {
14552: my ($context,$lonhost) = @_;
14553: my ($captcha_chk,$captcha_error);
14554: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14555: if ($captcha eq 'original') {
1.1094 raeburn 14556: ($captcha_chk,$captcha_error) = &check_captcha();
14557: } elsif ($captcha eq 'recaptcha') {
14558: $captcha_chk = &check_recaptcha($privkey);
14559: } else {
14560: $captcha_chk = 1;
14561: }
14562: return ($captcha_chk,$captcha_error);
14563: }
14564:
14565: sub get_captcha_config {
14566: my ($context,$lonhost) = @_;
1.1095 raeburn 14567: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 14568: my $hostname = &Apache::lonnet::hostname($lonhost);
14569: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14570: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 14571: if ($context eq 'usercreation') {
14572: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
14573: if (ref($domconfig{$context}) eq 'HASH') {
14574: $hashtocheck = $domconfig{$context}{'cancreate'};
14575: if (ref($hashtocheck) eq 'HASH') {
14576: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
14577: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
14578: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
14579: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
14580: }
14581: if ($privkey && $pubkey) {
14582: $captcha = 'recaptcha';
14583: } else {
14584: $captcha = 'original';
14585: }
14586: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
14587: $captcha = 'original';
14588: }
1.1094 raeburn 14589: }
1.1095 raeburn 14590: } else {
14591: $captcha = 'captcha';
14592: }
14593: } elsif ($context eq 'login') {
14594: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
14595: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
14596: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
14597: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 14598: if ($privkey && $pubkey) {
14599: $captcha = 'recaptcha';
1.1095 raeburn 14600: } else {
14601: $captcha = 'original';
1.1094 raeburn 14602: }
1.1095 raeburn 14603: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
14604: $captcha = 'original';
1.1094 raeburn 14605: }
14606: }
14607: return ($captcha,$pubkey,$privkey);
14608: }
14609:
14610: sub create_captcha {
14611: my %captcha_params = &captcha_settings();
14612: my ($output,$maxtries,$tries) = ('',10,0);
14613: while ($tries < $maxtries) {
14614: $tries ++;
14615: my $captcha = Authen::Captcha->new (
14616: output_folder => $captcha_params{'output_dir'},
14617: data_folder => $captcha_params{'db_dir'},
14618: );
14619: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14620:
14621: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14622: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14623: &mt('Type in the letters/numbers shown below').' '.
14624: '<input type="text" size="5" name="code" value="" /><br />'.
14625: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14626: last;
14627: }
14628: }
14629: return $output;
14630: }
14631:
14632: sub captcha_settings {
14633: my %captcha_params = (
14634: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14635: www_output_dir => "/captchaspool",
14636: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14637: numchars => '5',
14638: );
14639: return %captcha_params;
14640: }
14641:
14642: sub check_captcha {
14643: my ($captcha_chk,$captcha_error);
14644: my $code = $env{'form.code'};
14645: my $md5sum = $env{'form.crypt'};
14646: my %captcha_params = &captcha_settings();
14647: my $captcha = Authen::Captcha->new(
14648: output_folder => $captcha_params{'output_dir'},
14649: data_folder => $captcha_params{'db_dir'},
14650: );
1.1109 raeburn 14651: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 14652: my %captcha_hash = (
14653: 0 => 'Code not checked (file error)',
14654: -1 => 'Failed: code expired',
14655: -2 => 'Failed: invalid code (not in database)',
14656: -3 => 'Failed: invalid code (code does not match crypt)',
14657: );
14658: if ($captcha_chk != 1) {
14659: $captcha_error = $captcha_hash{$captcha_chk}
14660: }
14661: return ($captcha_chk,$captcha_error);
14662: }
14663:
14664: sub create_recaptcha {
14665: my ($pubkey) = @_;
14666: my $captcha = Captcha::reCAPTCHA->new;
14667: return $captcha->get_options_setter({theme => 'white'})."\n".
14668: $captcha->get_html($pubkey).
14669: &mt('If either word is hard to read, [_1] will replace them.',
1.1133 raeburn 14670: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1094 raeburn 14671: '<br /><br />';
14672: }
14673:
14674: sub check_recaptcha {
14675: my ($privkey) = @_;
14676: my $captcha_chk;
14677: my $captcha = Captcha::reCAPTCHA->new;
14678: my $captcha_result =
14679: $captcha->check_answer(
14680: $privkey,
14681: $ENV{'REMOTE_ADDR'},
14682: $env{'form.recaptcha_challenge_field'},
14683: $env{'form.recaptcha_response_field'},
14684: );
14685: if ($captcha_result->{is_valid}) {
14686: $captcha_chk = 1;
14687: }
14688: return $captcha_chk;
14689: }
14690:
1.41 ng 14691: =pod
14692:
14693: =back
14694:
1.112 bowersj2 14695: =cut
1.41 ng 14696:
1.112 bowersj2 14697: 1;
14698: __END__;
1.41 ng 14699:
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