Annotation of loncom/interface/loncommon.pm, revision 1.1151
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1151 ! raeburn 4: # $Id: loncommon.pm,v 1.1150 2013/08/20 14:33:42 bisitz 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:
1.1137 raeburn 2352: =item * $clientmobile
2353:
1.1141 raeburn 2354: =item * $clientinfo
2355:
1.87 matthew 2356: =back
2357:
1.157 matthew 2358: =back
2359:
1.87 matthew 2360: =cut
2361:
2362: ###############################################################
2363: ###############################################################
2364: sub decode_user_agent {
1.247 albertel 2365: my ($r)=@_;
1.87 matthew 2366: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2367: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2368: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2369: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2370: my $clientbrowser='unknown';
2371: my $clientversion='0';
2372: my $clientmathml='';
2373: my $clientunicode='0';
1.1137 raeburn 2374: my $clientmobile=0;
1.87 matthew 2375: for (my $i=0;$i<=$#browsertype;$i++) {
2376: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2377: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2378: $clientbrowser=$bname;
2379: $httpbrowser=~/$vreg/i;
2380: $clientversion=$1;
2381: $clientmathml=($clientversion>=$minv);
2382: $clientunicode=($clientversion>=$univ);
2383: }
2384: }
2385: my $clientos='unknown';
1.1141 raeburn 2386: my $clientinfo;
1.87 matthew 2387: if (($httpbrowser=~/linux/i) ||
2388: ($httpbrowser=~/unix/i) ||
2389: ($httpbrowser=~/ux/i) ||
2390: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2391: if (($httpbrowser=~/vax/i) ||
2392: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2393: if ($httpbrowser=~/next/i) { $clientos='next'; }
2394: if (($httpbrowser=~/mac/i) ||
2395: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2396: if ($httpbrowser=~/win/i) { $clientos='win'; }
2397: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 2398: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2399: $clientmobile=lc($1);
2400: }
1.1141 raeburn 2401: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2402: $clientinfo = 'firefox-'.$1;
2403: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2404: $clientinfo = 'chromeframe-'.$1;
2405: }
1.87 matthew 2406: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1141 raeburn 2407: $clientunicode,$clientos,$clientmobile,$clientinfo);
1.87 matthew 2408: }
2409:
1.32 matthew 2410: ###############################################################
2411: ## Authentication changing form generation subroutines ##
2412: ###############################################################
2413: ##
2414: ## All of the authform_xxxxxxx subroutines take their inputs in a
2415: ## hash, and have reasonable default values.
2416: ##
2417: ## formname = the name given in the <form> tag.
1.35 matthew 2418: #-------------------------------------------
2419:
1.45 matthew 2420: =pod
2421:
1.112 bowersj2 2422: =head1 Authentication Routines
2423:
2424: =over 4
2425:
1.648 raeburn 2426: =item * &authform_xxxxxx()
1.35 matthew 2427:
2428: The authform_xxxxxx subroutines provide javascript and html forms which
2429: handle some of the conveniences required for authentication forms.
2430: This is not an optimal method, but it works.
2431:
2432: =over 4
2433:
1.112 bowersj2 2434: =item * authform_header
1.35 matthew 2435:
1.112 bowersj2 2436: =item * authform_authorwarning
1.35 matthew 2437:
1.112 bowersj2 2438: =item * authform_nochange
1.35 matthew 2439:
1.112 bowersj2 2440: =item * authform_kerberos
1.35 matthew 2441:
1.112 bowersj2 2442: =item * authform_internal
1.35 matthew 2443:
1.112 bowersj2 2444: =item * authform_filesystem
1.35 matthew 2445:
2446: =back
2447:
1.648 raeburn 2448: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2449:
1.35 matthew 2450: =cut
2451:
2452: #-------------------------------------------
1.32 matthew 2453: sub authform_header{
2454: my %in = (
2455: formname => 'cu',
1.80 albertel 2456: kerb_def_dom => '',
1.32 matthew 2457: @_,
2458: );
2459: $in{'formname'} = 'document.' . $in{'formname'};
2460: my $result='';
1.80 albertel 2461:
2462: #---------------------------------------------- Code for upper case translation
2463: my $Javascript_toUpperCase;
2464: unless ($in{kerb_def_dom}) {
2465: $Javascript_toUpperCase =<<"END";
2466: switch (choice) {
2467: case 'krb': currentform.elements[choicearg].value =
2468: currentform.elements[choicearg].value.toUpperCase();
2469: break;
2470: default:
2471: }
2472: END
2473: } else {
2474: $Javascript_toUpperCase = "";
2475: }
2476:
1.165 raeburn 2477: my $radioval = "'nochange'";
1.591 raeburn 2478: if (defined($in{'curr_authtype'})) {
2479: if ($in{'curr_authtype'} ne '') {
2480: $radioval = "'".$in{'curr_authtype'}."arg'";
2481: }
1.174 matthew 2482: }
1.165 raeburn 2483: my $argfield = 'null';
1.591 raeburn 2484: if (defined($in{'mode'})) {
1.165 raeburn 2485: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2486: if (defined($in{'curr_autharg'})) {
2487: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2488: $argfield = "'$in{'curr_autharg'}'";
2489: }
2490: }
2491: }
2492: }
2493:
1.32 matthew 2494: $result.=<<"END";
2495: var current = new Object();
1.165 raeburn 2496: current.radiovalue = $radioval;
2497: current.argfield = $argfield;
1.32 matthew 2498:
2499: function changed_radio(choice,currentform) {
2500: var choicearg = choice + 'arg';
2501: // If a radio button in changed, we need to change the argfield
2502: if (current.radiovalue != choice) {
2503: current.radiovalue = choice;
2504: if (current.argfield != null) {
2505: currentform.elements[current.argfield].value = '';
2506: }
2507: if (choice == 'nochange') {
2508: current.argfield = null;
2509: } else {
2510: current.argfield = choicearg;
2511: switch(choice) {
2512: case 'krb':
2513: currentform.elements[current.argfield].value =
2514: "$in{'kerb_def_dom'}";
2515: break;
2516: default:
2517: break;
2518: }
2519: }
2520: }
2521: return;
2522: }
1.22 www 2523:
1.32 matthew 2524: function changed_text(choice,currentform) {
2525: var choicearg = choice + 'arg';
2526: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2527: $Javascript_toUpperCase
1.32 matthew 2528: // clear old field
2529: if ((current.argfield != choicearg) && (current.argfield != null)) {
2530: currentform.elements[current.argfield].value = '';
2531: }
2532: current.argfield = choicearg;
2533: }
2534: set_auth_radio_buttons(choice,currentform);
2535: return;
1.20 www 2536: }
1.32 matthew 2537:
2538: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2539: var numauthchoices = currentform.login.length;
2540: if (typeof numauthchoices == "undefined") {
2541: return;
2542: }
1.32 matthew 2543: var i=0;
1.986 raeburn 2544: while (i < numauthchoices) {
1.32 matthew 2545: if (currentform.login[i].value == newvalue) { break; }
2546: i++;
2547: }
1.986 raeburn 2548: if (i == numauthchoices) {
1.32 matthew 2549: return;
2550: }
2551: current.radiovalue = newvalue;
2552: currentform.login[i].checked = true;
2553: return;
2554: }
2555: END
2556: return $result;
2557: }
2558:
1.1106 raeburn 2559: sub authform_authorwarning {
1.32 matthew 2560: my $result='';
1.144 matthew 2561: $result='<i>'.
2562: &mt('As a general rule, only authors or co-authors should be '.
2563: 'filesystem authenticated '.
2564: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2565: return $result;
2566: }
2567:
1.1106 raeburn 2568: sub authform_nochange {
1.32 matthew 2569: my %in = (
2570: formname => 'document.cu',
2571: kerb_def_dom => 'MSU.EDU',
2572: @_,
2573: );
1.1106 raeburn 2574: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2575: my $result;
1.1104 raeburn 2576: if (!$authnum) {
1.1105 raeburn 2577: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2578: } else {
2579: $result = '<label>'.&mt('[_1] Do not change login data',
2580: '<input type="radio" name="login" value="nochange" '.
2581: 'checked="checked" onclick="'.
1.281 albertel 2582: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2583: '</label>';
1.586 raeburn 2584: }
1.32 matthew 2585: return $result;
2586: }
2587:
1.591 raeburn 2588: sub authform_kerberos {
1.32 matthew 2589: my %in = (
2590: formname => 'document.cu',
2591: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2592: kerb_def_auth => 'krb4',
1.32 matthew 2593: @_,
2594: );
1.586 raeburn 2595: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2596: $autharg,$jscall);
1.1106 raeburn 2597: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2598: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2599: $check5 = ' checked="checked"';
1.80 albertel 2600: } else {
1.772 bisitz 2601: $check4 = ' checked="checked"';
1.80 albertel 2602: }
1.165 raeburn 2603: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2604: if (defined($in{'curr_authtype'})) {
2605: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2606: $krbcheck = ' checked="checked"';
1.623 raeburn 2607: if (defined($in{'mode'})) {
2608: if ($in{'mode'} eq 'modifyuser') {
2609: $krbcheck = '';
2610: }
2611: }
1.591 raeburn 2612: if (defined($in{'curr_kerb_ver'})) {
2613: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2614: $check5 = ' checked="checked"';
1.591 raeburn 2615: $check4 = '';
2616: } else {
1.772 bisitz 2617: $check4 = ' checked="checked"';
1.591 raeburn 2618: $check5 = '';
2619: }
1.586 raeburn 2620: }
1.591 raeburn 2621: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2622: $krbarg = $in{'curr_autharg'};
2623: }
1.586 raeburn 2624: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2625: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2626: $result =
2627: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2628: $in{'curr_autharg'},$krbver);
2629: } else {
2630: $result =
2631: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2632: }
2633: return $result;
2634: }
2635: }
2636: } else {
2637: if ($authnum == 1) {
1.784 bisitz 2638: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2639: }
2640: }
1.586 raeburn 2641: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2642: return;
1.587 raeburn 2643: } elsif ($authtype eq '') {
1.591 raeburn 2644: if (defined($in{'mode'})) {
1.587 raeburn 2645: if ($in{'mode'} eq 'modifycourse') {
2646: if ($authnum == 1) {
1.1104 raeburn 2647: $authtype = '<input type="radio" name="login" value="krb" />';
1.587 raeburn 2648: }
2649: }
2650: }
1.586 raeburn 2651: }
2652: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2653: if ($authtype eq '') {
2654: $authtype = '<input type="radio" name="login" value="krb" '.
2655: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2656: $krbcheck.' />';
2657: }
2658: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 2659: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2660: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 2661: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2662: $in{'curr_authtype'} eq 'krb4')) {
2663: $result .= &mt
1.144 matthew 2664: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2665: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2666: '<label>'.$authtype,
1.281 albertel 2667: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2668: 'value="'.$krbarg.'" '.
1.144 matthew 2669: 'onchange="'.$jscall.'" />',
1.281 albertel 2670: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2671: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2672: '</label>');
1.586 raeburn 2673: } elsif ($can_assign{'krb4'}) {
2674: $result .= &mt
2675: ('[_1] Kerberos authenticated with domain [_2] '.
2676: '[_3] Version 4 [_4]',
2677: '<label>'.$authtype,
2678: '</label><input type="text" size="10" name="krbarg" '.
2679: 'value="'.$krbarg.'" '.
2680: 'onchange="'.$jscall.'" />',
2681: '<label><input type="hidden" name="krbver" value="4" />',
2682: '</label>');
2683: } elsif ($can_assign{'krb5'}) {
2684: $result .= &mt
2685: ('[_1] Kerberos authenticated with domain [_2] '.
2686: '[_3] Version 5 [_4]',
2687: '<label>'.$authtype,
2688: '</label><input type="text" size="10" name="krbarg" '.
2689: 'value="'.$krbarg.'" '.
2690: 'onchange="'.$jscall.'" />',
2691: '<label><input type="hidden" name="krbver" value="5" />',
2692: '</label>');
2693: }
1.32 matthew 2694: return $result;
2695: }
2696:
1.1106 raeburn 2697: sub authform_internal {
1.586 raeburn 2698: my %in = (
1.32 matthew 2699: formname => 'document.cu',
2700: kerb_def_dom => 'MSU.EDU',
2701: @_,
2702: );
1.586 raeburn 2703: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2704: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2705: if (defined($in{'curr_authtype'})) {
2706: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2707: if ($can_assign{'int'}) {
1.772 bisitz 2708: $intcheck = 'checked="checked" ';
1.623 raeburn 2709: if (defined($in{'mode'})) {
2710: if ($in{'mode'} eq 'modifyuser') {
2711: $intcheck = '';
2712: }
2713: }
1.591 raeburn 2714: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2715: $intarg = $in{'curr_autharg'};
2716: }
2717: } else {
2718: $result = &mt('Currently internally authenticated.');
2719: return $result;
1.165 raeburn 2720: }
2721: }
1.586 raeburn 2722: } else {
2723: if ($authnum == 1) {
1.784 bisitz 2724: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2725: }
2726: }
2727: if (!$can_assign{'int'}) {
2728: return;
1.587 raeburn 2729: } elsif ($authtype eq '') {
1.591 raeburn 2730: if (defined($in{'mode'})) {
1.587 raeburn 2731: if ($in{'mode'} eq 'modifycourse') {
2732: if ($authnum == 1) {
1.1104 raeburn 2733: $authtype = '<input type="radio" name="login" value="int" />';
1.587 raeburn 2734: }
2735: }
2736: }
1.165 raeburn 2737: }
1.586 raeburn 2738: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2739: if ($authtype eq '') {
2740: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2741: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2742: }
1.605 bisitz 2743: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2744: $intarg.'" onchange="'.$jscall.'" />';
2745: $result = &mt
1.144 matthew 2746: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2747: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2748: $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 2749: return $result;
2750: }
2751:
1.1104 raeburn 2752: sub authform_local {
1.32 matthew 2753: my %in = (
2754: formname => 'document.cu',
2755: kerb_def_dom => 'MSU.EDU',
2756: @_,
2757: );
1.586 raeburn 2758: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2759: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2760: if (defined($in{'curr_authtype'})) {
2761: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2762: if ($can_assign{'loc'}) {
1.772 bisitz 2763: $loccheck = 'checked="checked" ';
1.623 raeburn 2764: if (defined($in{'mode'})) {
2765: if ($in{'mode'} eq 'modifyuser') {
2766: $loccheck = '';
2767: }
2768: }
1.591 raeburn 2769: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2770: $locarg = $in{'curr_autharg'};
2771: }
2772: } else {
2773: $result = &mt('Currently using local (institutional) authentication.');
2774: return $result;
1.165 raeburn 2775: }
2776: }
1.586 raeburn 2777: } else {
2778: if ($authnum == 1) {
1.784 bisitz 2779: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2780: }
2781: }
2782: if (!$can_assign{'loc'}) {
2783: return;
1.587 raeburn 2784: } elsif ($authtype eq '') {
1.591 raeburn 2785: if (defined($in{'mode'})) {
1.587 raeburn 2786: if ($in{'mode'} eq 'modifycourse') {
2787: if ($authnum == 1) {
1.1104 raeburn 2788: $authtype = '<input type="radio" name="login" value="loc" />';
1.587 raeburn 2789: }
2790: }
2791: }
1.165 raeburn 2792: }
1.586 raeburn 2793: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2794: if ($authtype eq '') {
2795: $authtype = '<input type="radio" name="login" value="loc" '.
2796: $loccheck.' onchange="'.$jscall.'" onclick="'.
2797: $jscall.'" />';
2798: }
2799: $autharg = '<input type="text" size="10" name="locarg" value="'.
2800: $locarg.'" onchange="'.$jscall.'" />';
2801: $result = &mt('[_1] Local Authentication with argument [_2]',
2802: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2803: return $result;
2804: }
2805:
1.1106 raeburn 2806: sub authform_filesystem {
1.32 matthew 2807: my %in = (
2808: formname => 'document.cu',
2809: kerb_def_dom => 'MSU.EDU',
2810: @_,
2811: );
1.586 raeburn 2812: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1106 raeburn 2813: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2814: if (defined($in{'curr_authtype'})) {
2815: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2816: if ($can_assign{'fsys'}) {
1.772 bisitz 2817: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2818: if (defined($in{'mode'})) {
2819: if ($in{'mode'} eq 'modifyuser') {
2820: $fsyscheck = '';
2821: }
2822: }
1.586 raeburn 2823: } else {
2824: $result = &mt('Currently Filesystem Authenticated.');
2825: return $result;
2826: }
2827: }
2828: } else {
2829: if ($authnum == 1) {
1.784 bisitz 2830: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2831: }
2832: }
2833: if (!$can_assign{'fsys'}) {
2834: return;
1.587 raeburn 2835: } elsif ($authtype eq '') {
1.591 raeburn 2836: if (defined($in{'mode'})) {
1.587 raeburn 2837: if ($in{'mode'} eq 'modifycourse') {
2838: if ($authnum == 1) {
1.1104 raeburn 2839: $authtype = '<input type="radio" name="login" value="fsys" />';
1.587 raeburn 2840: }
2841: }
2842: }
1.586 raeburn 2843: }
2844: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2845: if ($authtype eq '') {
2846: $authtype = '<input type="radio" name="login" value="fsys" '.
2847: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2848: $jscall.'" />';
2849: }
2850: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2851: ' onchange="'.$jscall.'" />';
2852: $result = &mt
1.144 matthew 2853: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2854: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2855: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2856: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2857: 'onchange="'.$jscall.'" />');
1.32 matthew 2858: return $result;
2859: }
2860:
1.586 raeburn 2861: sub get_assignable_auth {
2862: my ($dom) = @_;
2863: if ($dom eq '') {
2864: $dom = $env{'request.role.domain'};
2865: }
2866: my %can_assign = (
2867: krb4 => 1,
2868: krb5 => 1,
2869: int => 1,
2870: loc => 1,
2871: );
2872: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2873: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2874: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2875: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2876: my $context;
2877: if ($env{'request.role'} =~ /^au/) {
2878: $context = 'author';
2879: } elsif ($env{'request.role'} =~ /^dc/) {
2880: $context = 'domain';
2881: } elsif ($env{'request.course.id'}) {
2882: $context = 'course';
2883: }
2884: if ($context) {
2885: if (ref($authhash->{$context}) eq 'HASH') {
2886: %can_assign = %{$authhash->{$context}};
2887: }
2888: }
2889: }
2890: }
2891: my $authnum = 0;
2892: foreach my $key (keys(%can_assign)) {
2893: if ($can_assign{$key}) {
2894: $authnum ++;
2895: }
2896: }
2897: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2898: $authnum --;
2899: }
2900: return ($authnum,%can_assign);
2901: }
2902:
1.80 albertel 2903: ###############################################################
2904: ## Get Kerberos Defaults for Domain ##
2905: ###############################################################
2906: ##
2907: ## Returns default kerberos version and an associated argument
2908: ## as listed in file domain.tab. If not listed, provides
2909: ## appropriate default domain and kerberos version.
2910: ##
2911: #-------------------------------------------
2912:
2913: =pod
2914:
1.648 raeburn 2915: =item * &get_kerberos_defaults()
1.80 albertel 2916:
2917: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2918: version and domain. If not found, it defaults to version 4 and the
2919: domain of the server.
1.80 albertel 2920:
1.648 raeburn 2921: =over 4
2922:
1.80 albertel 2923: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2924:
1.648 raeburn 2925: =back
2926:
2927: =back
2928:
1.80 albertel 2929: =cut
2930:
2931: #-------------------------------------------
2932: sub get_kerberos_defaults {
2933: my $domain=shift;
1.641 raeburn 2934: my ($krbdef,$krbdefdom);
2935: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2936: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2937: $krbdef = $domdefaults{'auth_def'};
2938: $krbdefdom = $domdefaults{'auth_arg_def'};
2939: } else {
1.80 albertel 2940: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2941: my $krbdefdom=$1;
2942: $krbdefdom=~tr/a-z/A-Z/;
2943: $krbdef = "krb4";
2944: }
2945: return ($krbdef,$krbdefdom);
2946: }
1.112 bowersj2 2947:
1.32 matthew 2948:
1.46 matthew 2949: ###############################################################
2950: ## Thesaurus Functions ##
2951: ###############################################################
1.20 www 2952:
1.46 matthew 2953: =pod
1.20 www 2954:
1.112 bowersj2 2955: =head1 Thesaurus Functions
2956:
2957: =over 4
2958:
1.648 raeburn 2959: =item * &initialize_keywords()
1.46 matthew 2960:
2961: Initializes the package variable %Keywords if it is empty. Uses the
2962: package variable $thesaurus_db_file.
2963:
2964: =cut
2965:
2966: ###################################################
2967:
2968: sub initialize_keywords {
2969: return 1 if (scalar keys(%Keywords));
2970: # If we are here, %Keywords is empty, so fill it up
2971: # Make sure the file we need exists...
2972: if (! -e $thesaurus_db_file) {
2973: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2974: " failed because it does not exist");
2975: return 0;
2976: }
2977: # Set up the hash as a database
2978: my %thesaurus_db;
2979: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2980: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2981: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2982: $thesaurus_db_file);
2983: return 0;
2984: }
2985: # Get the average number of appearances of a word.
2986: my $avecount = $thesaurus_db{'average.count'};
2987: # Put keywords (those that appear > average) into %Keywords
2988: while (my ($word,$data)=each (%thesaurus_db)) {
2989: my ($count,undef) = split /:/,$data;
2990: $Keywords{$word}++ if ($count > $avecount);
2991: }
2992: untie %thesaurus_db;
2993: # Remove special values from %Keywords.
1.356 albertel 2994: foreach my $value ('total.count','average.count') {
2995: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2996: }
1.46 matthew 2997: return 1;
2998: }
2999:
3000: ###################################################
3001:
3002: =pod
3003:
1.648 raeburn 3004: =item * &keyword($word)
1.46 matthew 3005:
3006: Returns true if $word is a keyword. A keyword is a word that appears more
3007: than the average number of times in the thesaurus database. Calls
3008: &initialize_keywords
3009:
3010: =cut
3011:
3012: ###################################################
1.20 www 3013:
3014: sub keyword {
1.46 matthew 3015: return if (!&initialize_keywords());
3016: my $word=lc(shift());
3017: $word=~s/\W//g;
3018: return exists($Keywords{$word});
1.20 www 3019: }
1.46 matthew 3020:
3021: ###############################################################
3022:
3023: =pod
1.20 www 3024:
1.648 raeburn 3025: =item * &get_related_words()
1.46 matthew 3026:
1.160 matthew 3027: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3028: an array of words. If the keyword is not in the thesaurus, an empty array
3029: will be returned. The order of the words returned is determined by the
3030: database which holds them.
3031:
3032: Uses global $thesaurus_db_file.
3033:
1.1057 foxr 3034:
1.46 matthew 3035: =cut
3036:
3037: ###############################################################
3038: sub get_related_words {
3039: my $keyword = shift;
3040: my %thesaurus_db;
3041: if (! -e $thesaurus_db_file) {
3042: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3043: "failed because the file does not exist");
3044: return ();
3045: }
3046: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3047: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3048: return ();
3049: }
3050: my @Words=();
1.429 www 3051: my $count=0;
1.46 matthew 3052: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3053: # The first element is the number of times
3054: # the word appears. We do not need it now.
1.429 www 3055: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3056: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3057: my $threshold=$mostfrequentcount/10;
3058: foreach my $possibleword (@RelatedWords) {
3059: my ($word,$wordcount)=split(/\,/,$possibleword);
3060: if ($wordcount>$threshold) {
3061: push(@Words,$word);
3062: $count++;
3063: if ($count>10) { last; }
3064: }
1.20 www 3065: }
3066: }
1.46 matthew 3067: untie %thesaurus_db;
3068: return @Words;
1.14 harris41 3069: }
1.1090 foxr 3070: ###############################################################
3071: #
3072: # Spell checking
3073: #
3074:
3075: =pod
3076:
1.1142 raeburn 3077: =back
3078:
1.1090 foxr 3079: =head1 Spell checking
3080:
3081: =over 4
3082:
3083: =item * &check_spelling($wordlist $language)
3084:
3085: Takes a string containing words and feeds it to an external
3086: spellcheck program via a pipeline. Returns a string containing
3087: them mis-spelled words.
3088:
3089: Parameters:
3090:
3091: =over 4
3092:
3093: =item - $wordlist
3094:
3095: String that will be fed into the spellcheck program.
3096:
3097: =item - $language
3098:
3099: Language string that specifies the language for which the spell
3100: check will be performed.
3101:
3102: =back
3103:
3104: =back
3105:
3106: Note: This sub assumes that aspell is installed.
3107:
3108:
3109: =cut
3110:
1.46 matthew 3111:
1.1090 foxr 3112: sub check_spelling {
3113: my ($wordlist, $language) = @_;
1.1091 foxr 3114: my @misspellings;
3115:
3116: # Generate the speller and set the langauge.
3117: # if explicitly selected:
1.1090 foxr 3118:
1.1091 foxr 3119: my $speller = Text::Aspell->new;
1.1090 foxr 3120: if ($language) {
1.1091 foxr 3121: $speller->set_option('lang', $language);
1.1090 foxr 3122: }
3123:
1.1091 foxr 3124: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3125:
1.1091 foxr 3126: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3127:
1.1091 foxr 3128: foreach my $word (@words) {
3129: if(! $speller->check($word)) {
3130: push(@misspellings, $word);
1.1090 foxr 3131: }
3132: }
1.1091 foxr 3133: return join(' ', @misspellings);
3134:
1.1090 foxr 3135: }
3136:
1.61 www 3137: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3138: =pod
3139:
1.112 bowersj2 3140: =head1 User Name Functions
3141:
3142: =over 4
3143:
1.648 raeburn 3144: =item * &plainname($uname,$udom,$first)
1.81 albertel 3145:
1.112 bowersj2 3146: Takes a users logon name and returns it as a string in
1.226 albertel 3147: "first middle last generation" form
3148: if $first is set to 'lastname' then it returns it as
3149: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3150:
3151: =cut
1.61 www 3152:
1.295 www 3153:
1.81 albertel 3154: ###############################################################
1.61 www 3155: sub plainname {
1.226 albertel 3156: my ($uname,$udom,$first)=@_;
1.537 albertel 3157: return if (!defined($uname) || !defined($udom));
1.295 www 3158: my %names=&getnames($uname,$udom);
1.226 albertel 3159: my $name=&Apache::lonnet::format_name($names{'firstname'},
3160: $names{'middlename'},
3161: $names{'lastname'},
3162: $names{'generation'},$first);
3163: $name=~s/^\s+//;
1.62 www 3164: $name=~s/\s+$//;
3165: $name=~s/\s+/ /g;
1.353 albertel 3166: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3167: return $name;
1.61 www 3168: }
1.66 www 3169:
3170: # -------------------------------------------------------------------- Nickname
1.81 albertel 3171: =pod
3172:
1.648 raeburn 3173: =item * &nickname($uname,$udom)
1.81 albertel 3174:
3175: Gets a users name and returns it as a string as
3176:
3177: ""nickname""
1.66 www 3178:
1.81 albertel 3179: if the user has a nickname or
3180:
3181: "first middle last generation"
3182:
3183: if the user does not
3184:
3185: =cut
1.66 www 3186:
3187: sub nickname {
3188: my ($uname,$udom)=@_;
1.537 albertel 3189: return if (!defined($uname) || !defined($udom));
1.295 www 3190: my %names=&getnames($uname,$udom);
1.68 albertel 3191: my $name=$names{'nickname'};
1.66 www 3192: if ($name) {
3193: $name='"'.$name.'"';
3194: } else {
3195: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3196: $names{'lastname'}.' '.$names{'generation'};
3197: $name=~s/\s+$//;
3198: $name=~s/\s+/ /g;
3199: }
3200: return $name;
3201: }
3202:
1.295 www 3203: sub getnames {
3204: my ($uname,$udom)=@_;
1.537 albertel 3205: return if (!defined($uname) || !defined($udom));
1.433 albertel 3206: if ($udom eq 'public' && $uname eq 'public') {
3207: return ('lastname' => &mt('Public'));
3208: }
1.295 www 3209: my $id=$uname.':'.$udom;
3210: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3211: if ($cached) {
3212: return %{$names};
3213: } else {
3214: my %loadnames=&Apache::lonnet::get('environment',
3215: ['firstname','middlename','lastname','generation','nickname'],
3216: $udom,$uname);
3217: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3218: return %loadnames;
3219: }
3220: }
1.61 www 3221:
1.542 raeburn 3222: # -------------------------------------------------------------------- getemails
1.648 raeburn 3223:
1.542 raeburn 3224: =pod
3225:
1.648 raeburn 3226: =item * &getemails($uname,$udom)
1.542 raeburn 3227:
3228: Gets a user's email information and returns it as a hash with keys:
3229: notification, critnotification, permanentemail
3230:
3231: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3232: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3233:
1.648 raeburn 3234:
1.542 raeburn 3235: =cut
3236:
1.648 raeburn 3237:
1.466 albertel 3238: sub getemails {
3239: my ($uname,$udom)=@_;
3240: if ($udom eq 'public' && $uname eq 'public') {
3241: return;
3242: }
1.467 www 3243: if (!$udom) { $udom=$env{'user.domain'}; }
3244: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3245: my $id=$uname.':'.$udom;
3246: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3247: if ($cached) {
3248: return %{$names};
3249: } else {
3250: my %loadnames=&Apache::lonnet::get('environment',
3251: ['notification','critnotification',
3252: 'permanentemail'],
3253: $udom,$uname);
3254: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3255: return %loadnames;
3256: }
3257: }
3258:
1.551 albertel 3259: sub flush_email_cache {
3260: my ($uname,$udom)=@_;
3261: if (!$udom) { $udom =$env{'user.domain'}; }
3262: if (!$uname) { $uname=$env{'user.name'}; }
3263: return if ($udom eq 'public' && $uname eq 'public');
3264: my $id=$uname.':'.$udom;
3265: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3266: }
3267:
1.728 raeburn 3268: # -------------------------------------------------------------------- getlangs
3269:
3270: =pod
3271:
3272: =item * &getlangs($uname,$udom)
3273:
3274: Gets a user's language preference and returns it as a hash with key:
3275: language.
3276:
3277: =cut
3278:
3279:
3280: sub getlangs {
3281: my ($uname,$udom) = @_;
3282: if (!$udom) { $udom =$env{'user.domain'}; }
3283: if (!$uname) { $uname=$env{'user.name'}; }
3284: my $id=$uname.':'.$udom;
3285: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3286: if ($cached) {
3287: return %{$langs};
3288: } else {
3289: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3290: $udom,$uname);
3291: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3292: return %loadlangs;
3293: }
3294: }
3295:
3296: sub flush_langs_cache {
3297: my ($uname,$udom)=@_;
3298: if (!$udom) { $udom =$env{'user.domain'}; }
3299: if (!$uname) { $uname=$env{'user.name'}; }
3300: return if ($udom eq 'public' && $uname eq 'public');
3301: my $id=$uname.':'.$udom;
3302: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3303: }
3304:
1.61 www 3305: # ------------------------------------------------------------------ Screenname
1.81 albertel 3306:
3307: =pod
3308:
1.648 raeburn 3309: =item * &screenname($uname,$udom)
1.81 albertel 3310:
3311: Gets a users screenname and returns it as a string
3312:
3313: =cut
1.61 www 3314:
3315: sub screenname {
3316: my ($uname,$udom)=@_;
1.258 albertel 3317: if ($uname eq $env{'user.name'} &&
3318: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3319: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3320: return $names{'screenname'};
1.62 www 3321: }
3322:
1.212 albertel 3323:
1.802 bisitz 3324: # ------------------------------------------------------------- Confirm Wrapper
3325: =pod
3326:
1.1142 raeburn 3327: =item * &confirmwrapper($message)
1.802 bisitz 3328:
3329: Wrap messages about completion of operation in box
3330:
3331: =cut
3332:
3333: sub confirmwrapper {
3334: my ($message)=@_;
3335: if ($message) {
3336: return "\n".'<div class="LC_confirm_box">'."\n"
3337: .$message."\n"
3338: .'</div>'."\n";
3339: } else {
3340: return $message;
3341: }
3342: }
3343:
1.62 www 3344: # ------------------------------------------------------------- Message Wrapper
3345:
3346: sub messagewrapper {
1.369 www 3347: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3348: return
1.441 albertel 3349: '<a href="/adm/email?compose=individual&'.
3350: 'recname='.$username.'&recdom='.$domain.
3351: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3352: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3353: }
1.802 bisitz 3354:
1.74 www 3355: # --------------------------------------------------------------- Notes Wrapper
3356:
3357: sub noteswrapper {
3358: my ($link,$un,$do)=@_;
3359: return
1.896 amueller 3360: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3361: }
1.802 bisitz 3362:
1.62 www 3363: # ------------------------------------------------------------- Aboutme Wrapper
3364:
3365: sub aboutmewrapper {
1.1070 raeburn 3366: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3367: if (!defined($username) && !defined($domain)) {
3368: return;
3369: }
1.1096 raeburn 3370: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3371: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3372: }
3373:
3374: # ------------------------------------------------------------ Syllabus Wrapper
3375:
3376: sub syllabuswrapper {
1.707 bisitz 3377: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3378: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3379: }
1.14 harris41 3380:
1.802 bisitz 3381: # -----------------------------------------------------------------------------
3382:
1.208 matthew 3383: sub track_student_link {
1.887 raeburn 3384: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3385: my $link ="/adm/trackstudent?";
1.208 matthew 3386: my $title = 'View recent activity';
3387: if (defined($sname) && $sname !~ /^\s*$/ &&
3388: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3389: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3390: $title .= ' of this student';
1.268 albertel 3391: }
1.208 matthew 3392: if (defined($target) && $target !~ /^\s*$/) {
3393: $target = qq{target="$target"};
3394: } else {
3395: $target = '';
3396: }
1.268 albertel 3397: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3398: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3399: $title = &mt($title);
3400: $linktext = &mt($linktext);
1.448 albertel 3401: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3402: &help_open_topic('View_recent_activity');
1.208 matthew 3403: }
3404:
1.781 raeburn 3405: sub slot_reservations_link {
3406: my ($linktext,$sname,$sdom,$target) = @_;
3407: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3408: my $title = 'View slot reservation history';
3409: if (defined($sname) && $sname !~ /^\s*$/ &&
3410: defined($sdom) && $sdom !~ /^\s*$/) {
3411: $link .= "&uname=$sname&udom=$sdom";
3412: $title .= ' of this student';
3413: }
3414: if (defined($target) && $target !~ /^\s*$/) {
3415: $target = qq{target="$target"};
3416: } else {
3417: $target = '';
3418: }
3419: $title = &mt($title);
3420: $linktext = &mt($linktext);
3421: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3422: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3423:
3424: }
3425:
1.508 www 3426: # ===================================================== Display a student photo
3427:
3428:
1.509 albertel 3429: sub student_image_tag {
1.508 www 3430: my ($domain,$user)=@_;
3431: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3432: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3433: return '<img src="'.$imgsrc.'" align="right" />';
3434: } else {
3435: return '';
3436: }
3437: }
3438:
1.112 bowersj2 3439: =pod
3440:
3441: =back
3442:
3443: =head1 Access .tab File Data
3444:
3445: =over 4
3446:
1.648 raeburn 3447: =item * &languageids()
1.112 bowersj2 3448:
3449: returns list of all language ids
3450:
3451: =cut
3452:
1.14 harris41 3453: sub languageids {
1.16 harris41 3454: return sort(keys(%language));
1.14 harris41 3455: }
3456:
1.112 bowersj2 3457: =pod
3458:
1.648 raeburn 3459: =item * &languagedescription()
1.112 bowersj2 3460:
3461: returns description of a specified language id
3462:
3463: =cut
3464:
1.14 harris41 3465: sub languagedescription {
1.125 www 3466: my $code=shift;
3467: return ($supported_language{$code}?'* ':'').
3468: $language{$code}.
1.126 www 3469: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3470: }
3471:
1.1048 foxr 3472: =pod
3473:
3474: =item * &plainlanguagedescription
3475:
3476: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3477: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3478:
3479: =cut
3480:
1.145 www 3481: sub plainlanguagedescription {
3482: my $code=shift;
3483: return $language{$code};
3484: }
3485:
1.1048 foxr 3486: =pod
3487:
3488: =item * &supportedlanguagecode
3489:
3490: Returns the supported language code (e.g. sptutf maps to pt) given a language
3491: code.
3492:
3493: =cut
3494:
1.145 www 3495: sub supportedlanguagecode {
3496: my $code=shift;
3497: return $supported_language{$code};
1.97 www 3498: }
3499:
1.112 bowersj2 3500: =pod
3501:
1.1048 foxr 3502: =item * &latexlanguage()
3503:
3504: Given a language key code returns the correspondnig language to use
3505: to select the correct hyphenation on LaTeX printouts. This is undef if there
3506: is no supported hyphenation for the language code.
3507:
3508: =cut
3509:
3510: sub latexlanguage {
3511: my $code = shift;
3512: return $latex_language{$code};
3513: }
3514:
3515: =pod
3516:
3517: =item * &latexhyphenation()
3518:
3519: Same as above but what's supplied is the language as it might be stored
3520: in the metadata.
3521:
3522: =cut
3523:
3524: sub latexhyphenation {
3525: my $key = shift;
3526: return $latex_language_bykey{$key};
3527: }
3528:
3529: =pod
3530:
1.648 raeburn 3531: =item * ©rightids()
1.112 bowersj2 3532:
3533: returns list of all copyrights
3534:
3535: =cut
3536:
3537: sub copyrightids {
3538: return sort(keys(%cprtag));
3539: }
3540:
3541: =pod
3542:
1.648 raeburn 3543: =item * ©rightdescription()
1.112 bowersj2 3544:
3545: returns description of a specified copyright id
3546:
3547: =cut
3548:
3549: sub copyrightdescription {
1.166 www 3550: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3551: }
1.197 matthew 3552:
3553: =pod
3554:
1.648 raeburn 3555: =item * &source_copyrightids()
1.192 taceyjo1 3556:
3557: returns list of all source copyrights
3558:
3559: =cut
3560:
3561: sub source_copyrightids {
3562: return sort(keys(%scprtag));
3563: }
3564:
3565: =pod
3566:
1.648 raeburn 3567: =item * &source_copyrightdescription()
1.192 taceyjo1 3568:
3569: returns description of a specified source copyright id
3570:
3571: =cut
3572:
3573: sub source_copyrightdescription {
3574: return &mt($scprtag{shift(@_)});
3575: }
1.112 bowersj2 3576:
3577: =pod
3578:
1.648 raeburn 3579: =item * &filecategories()
1.112 bowersj2 3580:
3581: returns list of all file categories
3582:
3583: =cut
3584:
3585: sub filecategories {
3586: return sort(keys(%category_extensions));
3587: }
3588:
3589: =pod
3590:
1.648 raeburn 3591: =item * &filecategorytypes()
1.112 bowersj2 3592:
3593: returns list of file types belonging to a given file
3594: category
3595:
3596: =cut
3597:
3598: sub filecategorytypes {
1.356 albertel 3599: my ($cat) = @_;
3600: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3601: }
3602:
3603: =pod
3604:
1.648 raeburn 3605: =item * &fileembstyle()
1.112 bowersj2 3606:
3607: returns embedding style for a specified file type
3608:
3609: =cut
3610:
3611: sub fileembstyle {
3612: return $fe{lc(shift(@_))};
1.169 www 3613: }
3614:
1.351 www 3615: sub filemimetype {
3616: return $fm{lc(shift(@_))};
3617: }
3618:
1.169 www 3619:
3620: sub filecategoryselect {
3621: my ($name,$value)=@_;
1.189 matthew 3622: return &select_form($value,$name,
1.970 raeburn 3623: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3624: }
3625:
3626: =pod
3627:
1.648 raeburn 3628: =item * &filedescription()
1.112 bowersj2 3629:
3630: returns description for a specified file type
3631:
3632: =cut
3633:
3634: sub filedescription {
1.188 matthew 3635: my $file_description = $fd{lc(shift())};
3636: $file_description =~ s:([\[\]]):~$1:g;
3637: return &mt($file_description);
1.112 bowersj2 3638: }
3639:
3640: =pod
3641:
1.648 raeburn 3642: =item * &filedescriptionex()
1.112 bowersj2 3643:
3644: returns description for a specified file type with
3645: extra formatting
3646:
3647: =cut
3648:
3649: sub filedescriptionex {
3650: my $ex=shift;
1.188 matthew 3651: my $file_description = $fd{lc($ex)};
3652: $file_description =~ s:([\[\]]):~$1:g;
3653: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3654: }
3655:
3656: # End of .tab access
3657: =pod
3658:
3659: =back
3660:
3661: =cut
3662:
3663: # ------------------------------------------------------------------ File Types
3664: sub fileextensions {
3665: return sort(keys(%fe));
3666: }
3667:
1.97 www 3668: # ----------------------------------------------------------- Display Languages
3669: # returns a hash with all desired display languages
3670: #
3671:
3672: sub display_languages {
3673: my %languages=();
1.695 raeburn 3674: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3675: $languages{$lang}=1;
1.97 www 3676: }
3677: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3678: if ($env{'form.displaylanguage'}) {
1.356 albertel 3679: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3680: $languages{$lang}=1;
1.97 www 3681: }
3682: }
3683: return %languages;
1.14 harris41 3684: }
3685:
1.582 albertel 3686: sub languages {
3687: my ($possible_langs) = @_;
1.695 raeburn 3688: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3689: if (!ref($possible_langs)) {
3690: if( wantarray ) {
3691: return @preferred_langs;
3692: } else {
3693: return $preferred_langs[0];
3694: }
3695: }
3696: my %possibilities = map { $_ => 1 } (@$possible_langs);
3697: my @preferred_possibilities;
3698: foreach my $preferred_lang (@preferred_langs) {
3699: if (exists($possibilities{$preferred_lang})) {
3700: push(@preferred_possibilities, $preferred_lang);
3701: }
3702: }
3703: if( wantarray ) {
3704: return @preferred_possibilities;
3705: }
3706: return $preferred_possibilities[0];
3707: }
3708:
1.742 raeburn 3709: sub user_lang {
3710: my ($touname,$toudom,$fromcid) = @_;
3711: my @userlangs;
3712: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3713: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3714: $env{'course.'.$fromcid.'.languages'}));
3715: } else {
3716: my %langhash = &getlangs($touname,$toudom);
3717: if ($langhash{'languages'} ne '') {
3718: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3719: } else {
3720: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3721: if ($domdefs{'lang_def'} ne '') {
3722: @userlangs = ($domdefs{'lang_def'});
3723: }
3724: }
3725: }
3726: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3727: my $user_lh = Apache::localize->get_handle(@languages);
3728: return $user_lh;
3729: }
3730:
3731:
1.112 bowersj2 3732: ###############################################################
3733: ## Student Answer Attempts ##
3734: ###############################################################
3735:
3736: =pod
3737:
3738: =head1 Alternate Problem Views
3739:
3740: =over 4
3741:
1.648 raeburn 3742: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3743: $getattempt, $regexp, $gradesub)
3744:
3745: Return string with previous attempt on problem. Arguments:
3746:
3747: =over 4
3748:
3749: =item * $symb: Problem, including path
3750:
3751: =item * $username: username of the desired student
3752:
3753: =item * $domain: domain of the desired student
1.14 harris41 3754:
1.112 bowersj2 3755: =item * $course: Course ID
1.14 harris41 3756:
1.112 bowersj2 3757: =item * $getattempt: Leave blank for all attempts, otherwise put
3758: something
1.14 harris41 3759:
1.112 bowersj2 3760: =item * $regexp: if string matches this regexp, the string will be
3761: sent to $gradesub
1.14 harris41 3762:
1.112 bowersj2 3763: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3764:
1.112 bowersj2 3765: =back
1.14 harris41 3766:
1.112 bowersj2 3767: The output string is a table containing all desired attempts, if any.
1.16 harris41 3768:
1.112 bowersj2 3769: =cut
1.1 albertel 3770:
3771: sub get_previous_attempt {
1.43 ng 3772: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3773: my $prevattempts='';
1.43 ng 3774: no strict 'refs';
1.1 albertel 3775: if ($symb) {
1.3 albertel 3776: my (%returnhash)=
3777: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3778: if ($returnhash{'version'}) {
3779: my %lasthash=();
3780: my $version;
3781: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3782: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3783: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3784: }
1.1 albertel 3785: }
1.596 albertel 3786: $prevattempts=&start_data_table().&start_data_table_header_row();
3787: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3788: my (%typeparts,%lasthidden);
1.945 raeburn 3789: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3790: foreach my $key (sort(keys(%lasthash))) {
3791: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3792: if ($#parts > 0) {
1.31 albertel 3793: my $data=$parts[-1];
1.989 raeburn 3794: next if ($data eq 'foilorder');
1.31 albertel 3795: pop(@parts);
1.1010 www 3796: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3797: if ($data eq 'type') {
3798: unless ($showsurv) {
3799: my $id = join(',',@parts);
3800: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3801: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3802: $lasthidden{$ign.'.'.$id} = 1;
3803: }
1.945 raeburn 3804: }
1.1010 www 3805: }
1.31 albertel 3806: } else {
1.41 ng 3807: if ($#parts == 0) {
3808: $prevattempts.='<th>'.$parts[0].'</th>';
3809: } else {
3810: $prevattempts.='<th>'.$ign.'</th>';
3811: }
1.31 albertel 3812: }
1.16 harris41 3813: }
1.596 albertel 3814: $prevattempts.=&end_data_table_header_row();
1.40 ng 3815: if ($getattempt eq '') {
3816: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3817: my @hidden;
3818: if (%typeparts) {
3819: foreach my $id (keys(%typeparts)) {
3820: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3821: push(@hidden,$id);
3822: }
3823: }
3824: }
3825: $prevattempts.=&start_data_table_row().
3826: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3827: if (@hidden) {
3828: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3829: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3830: my $hide;
3831: foreach my $id (@hidden) {
3832: if ($key =~ /^\Q$id\E/) {
3833: $hide = 1;
3834: last;
3835: }
3836: }
3837: if ($hide) {
3838: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3839: if (($data eq 'award') || ($data eq 'awarddetail')) {
3840: my $value = &format_previous_attempt_value($key,
3841: $returnhash{$version.':'.$key});
3842: $prevattempts.='<td>'.$value.' </td>';
3843: } else {
3844: $prevattempts.='<td> </td>';
3845: }
3846: } else {
3847: if ($key =~ /\./) {
3848: my $value = &format_previous_attempt_value($key,
3849: $returnhash{$version.':'.$key});
3850: $prevattempts.='<td>'.$value.' </td>';
3851: } else {
3852: $prevattempts.='<td> </td>';
3853: }
3854: }
3855: }
3856: } else {
3857: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3858: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3859: my $value = &format_previous_attempt_value($key,
3860: $returnhash{$version.':'.$key});
3861: $prevattempts.='<td>'.$value.' </td>';
3862: }
3863: }
3864: $prevattempts.=&end_data_table_row();
1.40 ng 3865: }
1.1 albertel 3866: }
1.945 raeburn 3867: my @currhidden = keys(%lasthidden);
1.596 albertel 3868: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3869: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3870: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3871: if (%typeparts) {
3872: my $hidden;
3873: foreach my $id (@currhidden) {
3874: if ($key =~ /^\Q$id\E/) {
3875: $hidden = 1;
3876: last;
3877: }
3878: }
3879: if ($hidden) {
3880: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3881: if (($data eq 'award') || ($data eq 'awarddetail')) {
3882: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3883: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3884: $value = &$gradesub($value);
3885: }
3886: $prevattempts.='<td>'.$value.' </td>';
3887: } else {
3888: $prevattempts.='<td> </td>';
3889: }
3890: } else {
3891: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3892: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3893: $value = &$gradesub($value);
3894: }
3895: $prevattempts.='<td>'.$value.' </td>';
3896: }
3897: } else {
3898: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3899: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3900: $value = &$gradesub($value);
3901: }
3902: $prevattempts.='<td>'.$value.' </td>';
3903: }
1.16 harris41 3904: }
1.596 albertel 3905: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3906: } else {
1.596 albertel 3907: $prevattempts=
3908: &start_data_table().&start_data_table_row().
3909: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3910: &end_data_table_row().&end_data_table();
1.1 albertel 3911: }
3912: } else {
1.596 albertel 3913: $prevattempts=
3914: &start_data_table().&start_data_table_row().
3915: '<td>'.&mt('No data.').'</td>'.
3916: &end_data_table_row().&end_data_table();
1.1 albertel 3917: }
1.10 albertel 3918: }
3919:
1.581 albertel 3920: sub format_previous_attempt_value {
3921: my ($key,$value) = @_;
1.1011 www 3922: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3923: $value = &Apache::lonlocal::locallocaltime($value);
3924: } elsif (ref($value) eq 'ARRAY') {
3925: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3926: } elsif ($key =~ /answerstring$/) {
3927: my %answers = &Apache::lonnet::str2hash($value);
3928: my @anskeys = sort(keys(%answers));
3929: if (@anskeys == 1) {
3930: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3931: if ($answer =~ m{\0}) {
3932: $answer =~ s{\0}{,}g;
1.988 raeburn 3933: }
3934: my $tag_internal_answer_name = 'INTERNAL';
3935: if ($anskeys[0] eq $tag_internal_answer_name) {
3936: $value = $answer;
3937: } else {
3938: $value = $anskeys[0].'='.$answer;
3939: }
3940: } else {
3941: foreach my $ans (@anskeys) {
3942: my $answer = $answers{$ans};
1.1001 raeburn 3943: if ($answer =~ m{\0}) {
3944: $answer =~ s{\0}{,}g;
1.988 raeburn 3945: }
3946: $value .= $ans.'='.$answer.'<br />';;
3947: }
3948: }
1.581 albertel 3949: } else {
3950: $value = &unescape($value);
3951: }
3952: return $value;
3953: }
3954:
3955:
1.107 albertel 3956: sub relative_to_absolute {
3957: my ($url,$output)=@_;
3958: my $parser=HTML::TokeParser->new(\$output);
3959: my $token;
3960: my $thisdir=$url;
3961: my @rlinks=();
3962: while ($token=$parser->get_token) {
3963: if ($token->[0] eq 'S') {
3964: if ($token->[1] eq 'a') {
3965: if ($token->[2]->{'href'}) {
3966: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3967: }
3968: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3969: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3970: } elsif ($token->[1] eq 'base') {
3971: $thisdir=$token->[2]->{'href'};
3972: }
3973: }
3974: }
3975: $thisdir=~s-/[^/]*$--;
1.356 albertel 3976: foreach my $link (@rlinks) {
1.726 raeburn 3977: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3978: ($link=~/^\//) ||
3979: ($link=~/^javascript:/i) ||
3980: ($link=~/^mailto:/i) ||
3981: ($link=~/^\#/)) {
3982: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3983: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3984: }
3985: }
3986: # -------------------------------------------------- Deal with Applet codebases
3987: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3988: return $output;
3989: }
3990:
1.112 bowersj2 3991: =pod
3992:
1.648 raeburn 3993: =item * &get_student_view()
1.112 bowersj2 3994:
3995: show a snapshot of what student was looking at
3996:
3997: =cut
3998:
1.10 albertel 3999: sub get_student_view {
1.186 albertel 4000: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4001: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4002: my (%form);
1.10 albertel 4003: my @elements=('symb','courseid','domain','username');
4004: foreach my $element (@elements) {
1.186 albertel 4005: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4006: }
1.186 albertel 4007: if (defined($moreenv)) {
4008: %form=(%form,%{$moreenv});
4009: }
1.236 albertel 4010: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4011: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4012: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4013: $userview=~s/\<body[^\>]*\>//gi;
4014: $userview=~s/\<\/body\>//gi;
4015: $userview=~s/\<html\>//gi;
4016: $userview=~s/\<\/html\>//gi;
4017: $userview=~s/\<head\>//gi;
4018: $userview=~s/\<\/head\>//gi;
4019: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4020: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4021: if (wantarray) {
4022: return ($userview,$response);
4023: } else {
4024: return $userview;
4025: }
4026: }
4027:
4028: sub get_student_view_with_retries {
4029: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4030:
4031: my $ok = 0; # True if we got a good response.
4032: my $content;
4033: my $response;
4034:
4035: # Try to get the student_view done. within the retries count:
4036:
4037: do {
4038: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4039: $ok = $response->is_success;
4040: if (!$ok) {
4041: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4042: }
4043: $retries--;
4044: } while (!$ok && ($retries > 0));
4045:
4046: if (!$ok) {
4047: $content = ''; # On error return an empty content.
4048: }
1.651 www 4049: if (wantarray) {
4050: return ($content, $response);
4051: } else {
4052: return $content;
4053: }
1.11 albertel 4054: }
4055:
1.112 bowersj2 4056: =pod
4057:
1.648 raeburn 4058: =item * &get_student_answers()
1.112 bowersj2 4059:
4060: show a snapshot of how student was answering problem
4061:
4062: =cut
4063:
1.11 albertel 4064: sub get_student_answers {
1.100 sakharuk 4065: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4066: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4067: my (%moreenv);
1.11 albertel 4068: my @elements=('symb','courseid','domain','username');
4069: foreach my $element (@elements) {
1.186 albertel 4070: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4071: }
1.186 albertel 4072: $moreenv{'grade_target'}='answer';
4073: %moreenv=(%form,%moreenv);
1.497 raeburn 4074: $feedurl = &Apache::lonnet::clutter($feedurl);
4075: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4076: return $userview;
1.1 albertel 4077: }
1.116 albertel 4078:
4079: =pod
4080:
4081: =item * &submlink()
4082:
1.242 albertel 4083: Inputs: $text $uname $udom $symb $target
1.116 albertel 4084:
4085: Returns: A link to grades.pm such as to see the SUBM view of a student
4086:
4087: =cut
4088:
4089: ###############################################
4090: sub submlink {
1.242 albertel 4091: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4092: if (!($uname && $udom)) {
4093: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4094: &Apache::lonnet::whichuser($symb);
1.116 albertel 4095: if (!$symb) { $symb=$cursymb; }
4096: }
1.254 matthew 4097: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4098: $symb=&escape($symb);
1.960 bisitz 4099: if ($target) { $target=" target=\"$target\""; }
4100: return
4101: '<a href="/adm/grades?command=submission'.
4102: '&symb='.$symb.
4103: '&student='.$uname.
4104: '&userdom='.$udom.'"'.
4105: $target.'>'.$text.'</a>';
1.242 albertel 4106: }
4107: ##############################################
4108:
4109: =pod
4110:
4111: =item * &pgrdlink()
4112:
4113: Inputs: $text $uname $udom $symb $target
4114:
4115: Returns: A link to grades.pm such as to see the PGRD view of a student
4116:
4117: =cut
4118:
4119: ###############################################
4120: sub pgrdlink {
4121: my $link=&submlink(@_);
4122: $link=~s/(&command=submission)/$1&showgrading=yes/;
4123: return $link;
4124: }
4125: ##############################################
4126:
4127: =pod
4128:
4129: =item * &pprmlink()
4130:
4131: Inputs: $text $uname $udom $symb $target
4132:
4133: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4134: student and a specific resource
1.242 albertel 4135:
4136: =cut
4137:
4138: ###############################################
4139: sub pprmlink {
4140: my ($text,$uname,$udom,$symb,$target)=@_;
4141: if (!($uname && $udom)) {
4142: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4143: &Apache::lonnet::whichuser($symb);
1.242 albertel 4144: if (!$symb) { $symb=$cursymb; }
4145: }
1.254 matthew 4146: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4147: $symb=&escape($symb);
1.242 albertel 4148: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4149: return '<a href="/adm/parmset?command=set&'.
4150: 'symb='.$symb.'&uname='.$uname.
4151: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4152: }
4153: ##############################################
1.37 matthew 4154:
1.112 bowersj2 4155: =pod
4156:
4157: =back
4158:
4159: =cut
4160:
1.37 matthew 4161: ###############################################
1.51 www 4162:
4163:
4164: sub timehash {
1.687 raeburn 4165: my ($thistime) = @_;
4166: my $timezone = &Apache::lonlocal::gettimezone();
4167: my $dt = DateTime->from_epoch(epoch => $thistime)
4168: ->set_time_zone($timezone);
4169: my $wday = $dt->day_of_week();
4170: if ($wday == 7) { $wday = 0; }
4171: return ( 'second' => $dt->second(),
4172: 'minute' => $dt->minute(),
4173: 'hour' => $dt->hour(),
4174: 'day' => $dt->day_of_month(),
4175: 'month' => $dt->month(),
4176: 'year' => $dt->year(),
4177: 'weekday' => $wday,
4178: 'dayyear' => $dt->day_of_year(),
4179: 'dlsav' => $dt->is_dst() );
1.51 www 4180: }
4181:
1.370 www 4182: sub utc_string {
4183: my ($date)=@_;
1.371 www 4184: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4185: }
4186:
1.51 www 4187: sub maketime {
4188: my %th=@_;
1.687 raeburn 4189: my ($epoch_time,$timezone,$dt);
4190: $timezone = &Apache::lonlocal::gettimezone();
4191: eval {
4192: $dt = DateTime->new( year => $th{'year'},
4193: month => $th{'month'},
4194: day => $th{'day'},
4195: hour => $th{'hour'},
4196: minute => $th{'minute'},
4197: second => $th{'second'},
4198: time_zone => $timezone,
4199: );
4200: };
4201: if (!$@) {
4202: $epoch_time = $dt->epoch;
4203: if ($epoch_time) {
4204: return $epoch_time;
4205: }
4206: }
1.51 www 4207: return POSIX::mktime(
4208: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4209: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4210: }
4211:
4212: #########################################
1.51 www 4213:
4214: sub findallcourses {
1.482 raeburn 4215: my ($roles,$uname,$udom) = @_;
1.355 albertel 4216: my %roles;
4217: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4218: my %courses;
1.51 www 4219: my $now=time;
1.482 raeburn 4220: if (!defined($uname)) {
4221: $uname = $env{'user.name'};
4222: }
4223: if (!defined($udom)) {
4224: $udom = $env{'user.domain'};
4225: }
4226: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4227: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4228: if (!%roles) {
4229: %roles = (
4230: cc => 1,
1.907 raeburn 4231: co => 1,
1.482 raeburn 4232: in => 1,
4233: ep => 1,
4234: ta => 1,
4235: cr => 1,
4236: st => 1,
4237: );
4238: }
4239: foreach my $entry (keys(%roleshash)) {
4240: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4241: if ($trole =~ /^cr/) {
4242: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4243: } else {
4244: next if (!exists($roles{$trole}));
4245: }
4246: if ($tend) {
4247: next if ($tend < $now);
4248: }
4249: if ($tstart) {
4250: next if ($tstart > $now);
4251: }
1.1058 raeburn 4252: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4253: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4254: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4255: if ($secpart eq '') {
4256: ($cnum,$role) = split(/_/,$cnumpart);
4257: $sec = 'none';
1.1058 raeburn 4258: $value .= $cnum.'/';
1.482 raeburn 4259: } else {
4260: $cnum = $cnumpart;
4261: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4262: $value .= $cnum.'/'.$sec;
4263: }
4264: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4265: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4266: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4267: }
4268: } else {
4269: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4270: }
1.482 raeburn 4271: }
4272: } else {
4273: foreach my $key (keys(%env)) {
1.483 albertel 4274: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4275: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4276: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4277: next if ($role eq 'ca' || $role eq 'aa');
4278: next if (%roles && !exists($roles{$role}));
4279: my ($starttime,$endtime)=split(/\./,$env{$key});
4280: my $active=1;
4281: if ($starttime) {
4282: if ($now<$starttime) { $active=0; }
4283: }
4284: if ($endtime) {
4285: if ($now>$endtime) { $active=0; }
4286: }
4287: if ($active) {
1.1058 raeburn 4288: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4289: if ($sec eq '') {
4290: $sec = 'none';
1.1058 raeburn 4291: } else {
4292: $value .= $sec;
4293: }
4294: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4295: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4296: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4297: }
4298: } else {
4299: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4300: }
1.474 raeburn 4301: }
4302: }
1.51 www 4303: }
4304: }
1.474 raeburn 4305: return %courses;
1.51 www 4306: }
1.37 matthew 4307:
1.54 www 4308: ###############################################
1.474 raeburn 4309:
4310: sub blockcheck {
1.1062 raeburn 4311: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4312:
4313: if (!defined($udom)) {
4314: $udom = $env{'user.domain'};
4315: }
4316: if (!defined($uname)) {
4317: $uname = $env{'user.name'};
4318: }
4319:
4320: # If uname and udom are for a course, check for blocks in the course.
4321:
4322: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4323: my ($startblock,$endblock,$triggerblock) =
4324: &get_blocks($setters,$activity,$udom,$uname,$url);
4325: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4326: }
1.474 raeburn 4327:
1.502 raeburn 4328: my $startblock = 0;
4329: my $endblock = 0;
1.1062 raeburn 4330: my $triggerblock = '';
1.482 raeburn 4331: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4332:
1.490 raeburn 4333: # If uname is for a user, and activity is course-specific, i.e.,
4334: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4335:
1.490 raeburn 4336: if (($activity eq 'boards' || $activity eq 'chat' ||
4337: $activity eq 'groups') && ($env{'request.course.id'})) {
4338: foreach my $key (keys(%live_courses)) {
4339: if ($key ne $env{'request.course.id'}) {
4340: delete($live_courses{$key});
4341: }
4342: }
4343: }
4344:
4345: my $otheruser = 0;
4346: my %own_courses;
4347: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4348: # Resource belongs to user other than current user.
4349: $otheruser = 1;
4350: # Gather courses for current user
4351: %own_courses =
4352: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4353: }
4354:
4355: # Gather active course roles - course coordinator, instructor,
4356: # exam proctor, ta, student, or custom role.
1.474 raeburn 4357:
4358: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4359: my ($cdom,$cnum);
4360: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4361: $cdom = $env{'course.'.$course.'.domain'};
4362: $cnum = $env{'course.'.$course.'.num'};
4363: } else {
1.490 raeburn 4364: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4365: }
4366: my $no_ownblock = 0;
4367: my $no_userblock = 0;
1.533 raeburn 4368: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4369: # Check if current user has 'evb' priv for this
4370: if (defined($own_courses{$course})) {
4371: foreach my $sec (keys(%{$own_courses{$course}})) {
4372: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4373: if ($sec ne 'none') {
4374: $checkrole .= '/'.$sec;
4375: }
4376: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4377: $no_ownblock = 1;
4378: last;
4379: }
4380: }
4381: }
4382: # if they have 'evb' priv and are currently not playing student
4383: next if (($no_ownblock) &&
4384: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4385: }
1.474 raeburn 4386: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4387: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4388: if ($sec ne 'none') {
1.482 raeburn 4389: $checkrole .= '/'.$sec;
1.474 raeburn 4390: }
1.490 raeburn 4391: if ($otheruser) {
4392: # Resource belongs to user other than current user.
4393: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4394: my (%allroles,%userroles);
4395: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4396: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4397: my ($trole,$tdom,$tnum,$tsec);
4398: if ($entry =~ /^cr/) {
4399: ($trole,$tdom,$tnum,$tsec) =
4400: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4401: } else {
4402: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4403: }
4404: my ($spec,$area,$trest);
4405: $area = '/'.$tdom.'/'.$tnum;
4406: $trest = $tnum;
4407: if ($tsec ne '') {
4408: $area .= '/'.$tsec;
4409: $trest .= '/'.$tsec;
4410: }
4411: $spec = $trole.'.'.$area;
4412: if ($trole =~ /^cr/) {
4413: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4414: $tdom,$spec,$trest,$area);
4415: } else {
4416: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4417: $tdom,$spec,$trest,$area);
4418: }
4419: }
4420: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4421: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4422: if ($1) {
4423: $no_userblock = 1;
4424: last;
4425: }
1.486 raeburn 4426: }
4427: }
1.490 raeburn 4428: } else {
4429: # Resource belongs to current user
4430: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4431: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4432: $no_ownblock = 1;
4433: last;
4434: }
1.474 raeburn 4435: }
4436: }
4437: # if they have the evb priv and are currently not playing student
1.482 raeburn 4438: next if (($no_ownblock) &&
1.491 albertel 4439: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4440: next if ($no_userblock);
1.474 raeburn 4441:
1.866 kalberla 4442: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4443: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4444:
1.1062 raeburn 4445: my ($start,$end,$trigger) =
4446: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4447: if (($start != 0) &&
4448: (($startblock == 0) || ($startblock > $start))) {
4449: $startblock = $start;
1.1062 raeburn 4450: if ($trigger ne '') {
4451: $triggerblock = $trigger;
4452: }
1.502 raeburn 4453: }
4454: if (($end != 0) &&
4455: (($endblock == 0) || ($endblock < $end))) {
4456: $endblock = $end;
1.1062 raeburn 4457: if ($trigger ne '') {
4458: $triggerblock = $trigger;
4459: }
1.502 raeburn 4460: }
1.490 raeburn 4461: }
1.1062 raeburn 4462: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4463: }
4464:
4465: sub get_blocks {
1.1062 raeburn 4466: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4467: my $startblock = 0;
4468: my $endblock = 0;
1.1062 raeburn 4469: my $triggerblock = '';
1.490 raeburn 4470: my $course = $cdom.'_'.$cnum;
4471: $setters->{$course} = {};
4472: $setters->{$course}{'staff'} = [];
4473: $setters->{$course}{'times'} = [];
1.1062 raeburn 4474: $setters->{$course}{'triggers'} = [];
4475: my (@blockers,%triggered);
4476: my $now = time;
4477: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4478: if ($activity eq 'docs') {
4479: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4480: foreach my $block (@blockers) {
4481: if ($block =~ /^firstaccess____(.+)$/) {
4482: my $item = $1;
4483: my $type = 'map';
4484: my $timersymb = $item;
4485: if ($item eq 'course') {
4486: $type = 'course';
4487: } elsif ($item =~ /___\d+___/) {
4488: $type = 'resource';
4489: } else {
4490: $timersymb = &Apache::lonnet::symbread($item);
4491: }
4492: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4493: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4494: $triggered{$block} = {
4495: start => $start,
4496: end => $end,
4497: type => $type,
4498: };
4499: }
4500: }
4501: } else {
4502: foreach my $block (keys(%commblocks)) {
4503: if ($block =~ m/^(\d+)____(\d+)$/) {
4504: my ($start,$end) = ($1,$2);
4505: if ($start <= time && $end >= time) {
4506: if (ref($commblocks{$block}) eq 'HASH') {
4507: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4508: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4509: unless(grep(/^\Q$block\E$/,@blockers)) {
4510: push(@blockers,$block);
4511: }
4512: }
4513: }
4514: }
4515: }
4516: } elsif ($block =~ /^firstaccess____(.+)$/) {
4517: my $item = $1;
4518: my $timersymb = $item;
4519: my $type = 'map';
4520: if ($item eq 'course') {
4521: $type = 'course';
4522: } elsif ($item =~ /___\d+___/) {
4523: $type = 'resource';
4524: } else {
4525: $timersymb = &Apache::lonnet::symbread($item);
4526: }
4527: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4528: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4529: if ($start && $end) {
4530: if (($start <= time) && ($end >= time)) {
4531: unless (grep(/^\Q$block\E$/,@blockers)) {
4532: push(@blockers,$block);
4533: $triggered{$block} = {
4534: start => $start,
4535: end => $end,
4536: type => $type,
4537: };
4538: }
4539: }
1.490 raeburn 4540: }
1.1062 raeburn 4541: }
4542: }
4543: }
4544: foreach my $blocker (@blockers) {
4545: my ($staff_name,$staff_dom,$title,$blocks) =
4546: &parse_block_record($commblocks{$blocker});
4547: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4548: my ($start,$end,$triggertype);
4549: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4550: ($start,$end) = ($1,$2);
4551: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4552: $start = $triggered{$blocker}{'start'};
4553: $end = $triggered{$blocker}{'end'};
4554: $triggertype = $triggered{$blocker}{'type'};
4555: }
4556: if ($start) {
4557: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4558: if ($triggertype) {
4559: push(@{$$setters{$course}{'triggers'}},$triggertype);
4560: } else {
4561: push(@{$$setters{$course}{'triggers'}},0);
4562: }
4563: if ( ($startblock == 0) || ($startblock > $start) ) {
4564: $startblock = $start;
4565: if ($triggertype) {
4566: $triggerblock = $blocker;
1.474 raeburn 4567: }
4568: }
1.1062 raeburn 4569: if ( ($endblock == 0) || ($endblock < $end) ) {
4570: $endblock = $end;
4571: if ($triggertype) {
4572: $triggerblock = $blocker;
4573: }
4574: }
1.474 raeburn 4575: }
4576: }
1.1062 raeburn 4577: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4578: }
4579:
4580: sub parse_block_record {
4581: my ($record) = @_;
4582: my ($setuname,$setudom,$title,$blocks);
4583: if (ref($record) eq 'HASH') {
4584: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4585: $title = &unescape($record->{'event'});
4586: $blocks = $record->{'blocks'};
4587: } else {
4588: my @data = split(/:/,$record,3);
4589: if (scalar(@data) eq 2) {
4590: $title = $data[1];
4591: ($setuname,$setudom) = split(/@/,$data[0]);
4592: } else {
4593: ($setuname,$setudom,$title) = @data;
4594: }
4595: $blocks = { 'com' => 'on' };
4596: }
4597: return ($setuname,$setudom,$title,$blocks);
4598: }
4599:
1.854 kalberla 4600: sub blocking_status {
1.1062 raeburn 4601: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4602: my %setters;
1.890 droeschl 4603:
1.1061 raeburn 4604: # check for active blocking
1.1062 raeburn 4605: my ($startblock,$endblock,$triggerblock) =
4606: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4607: my $blocked = 0;
4608: if ($startblock && $endblock) {
4609: $blocked = 1;
4610: }
1.890 droeschl 4611:
1.1061 raeburn 4612: # caller just wants to know whether a block is active
4613: if (!wantarray) { return $blocked; }
4614:
4615: # build a link to a popup window containing the details
4616: my $querystring = "?activity=$activity";
4617: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4618: if ($activity eq 'port') {
4619: $querystring .= "&udom=$udom" if $udom;
4620: $querystring .= "&uname=$uname" if $uname;
4621: } elsif ($activity eq 'docs') {
4622: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4623: }
1.1061 raeburn 4624:
4625: my $output .= <<'END_MYBLOCK';
4626: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4627: var options = "width=" + w + ",height=" + h + ",";
4628: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4629: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4630: var newWin = window.open(url, wdwName, options);
4631: newWin.focus();
4632: }
1.890 droeschl 4633: END_MYBLOCK
1.854 kalberla 4634:
1.1061 raeburn 4635: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4636:
1.1061 raeburn 4637: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4638: my $text = &mt('Communication Blocked');
4639: if ($activity eq 'docs') {
4640: $text = &mt('Content Access Blocked');
1.1063 raeburn 4641: } elsif ($activity eq 'printout') {
4642: $text = &mt('Printing Blocked');
1.1062 raeburn 4643: }
1.1061 raeburn 4644: $output .= <<"END_BLOCK";
1.867 kalberla 4645: <div class='LC_comblock'>
1.869 kalberla 4646: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4647: title='$text'>
4648: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4649: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4650: title='$text'>$text</a>
1.867 kalberla 4651: </div>
4652:
4653: END_BLOCK
1.474 raeburn 4654:
1.1061 raeburn 4655: return ($blocked, $output);
1.854 kalberla 4656: }
1.490 raeburn 4657:
1.60 matthew 4658: ###############################################
4659:
1.682 raeburn 4660: sub check_ip_acc {
4661: my ($acc)=@_;
4662: &Apache::lonxml::debug("acc is $acc");
4663: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4664: return 1;
4665: }
4666: my $allowed=0;
4667: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4668:
4669: my $name;
4670: foreach my $pattern (split(',',$acc)) {
4671: $pattern =~ s/^\s*//;
4672: $pattern =~ s/\s*$//;
4673: if ($pattern =~ /\*$/) {
4674: #35.8.*
4675: $pattern=~s/\*//;
4676: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4677: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4678: #35.8.3.[34-56]
4679: my $low=$2;
4680: my $high=$3;
4681: $pattern=$1;
4682: if ($ip =~ /^\Q$pattern\E/) {
4683: my $last=(split(/\./,$ip))[3];
4684: if ($last <=$high && $last >=$low) { $allowed=1; }
4685: }
4686: } elsif ($pattern =~ /^\*/) {
4687: #*.msu.edu
4688: $pattern=~s/\*//;
4689: if (!defined($name)) {
4690: use Socket;
4691: my $netaddr=inet_aton($ip);
4692: ($name)=gethostbyaddr($netaddr,AF_INET);
4693: }
4694: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4695: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4696: #127.0.0.1
4697: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4698: } else {
4699: #some.name.com
4700: if (!defined($name)) {
4701: use Socket;
4702: my $netaddr=inet_aton($ip);
4703: ($name)=gethostbyaddr($netaddr,AF_INET);
4704: }
4705: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4706: }
4707: if ($allowed) { last; }
4708: }
4709: return $allowed;
4710: }
4711:
4712: ###############################################
4713:
1.60 matthew 4714: =pod
4715:
1.112 bowersj2 4716: =head1 Domain Template Functions
4717:
4718: =over 4
4719:
4720: =item * &determinedomain()
1.60 matthew 4721:
4722: Inputs: $domain (usually will be undef)
4723:
1.63 www 4724: Returns: Determines which domain should be used for designs
1.60 matthew 4725:
4726: =cut
1.54 www 4727:
1.60 matthew 4728: ###############################################
1.63 www 4729: sub determinedomain {
4730: my $domain=shift;
1.531 albertel 4731: if (! $domain) {
1.60 matthew 4732: # Determine domain if we have not been given one
1.893 raeburn 4733: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4734: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4735: if ($env{'request.role.domain'}) {
4736: $domain=$env{'request.role.domain'};
1.60 matthew 4737: }
4738: }
1.63 www 4739: return $domain;
4740: }
4741: ###############################################
1.517 raeburn 4742:
1.518 albertel 4743: sub devalidate_domconfig_cache {
4744: my ($udom)=@_;
4745: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4746: }
4747:
4748: # ---------------------- Get domain configuration for a domain
4749: sub get_domainconf {
4750: my ($udom) = @_;
4751: my $cachetime=1800;
4752: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4753: if (defined($cached)) { return %{$result}; }
4754:
4755: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4756: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4757: my (%designhash,%legacy);
1.518 albertel 4758: if (keys(%domconfig) > 0) {
4759: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4760: if (keys(%{$domconfig{'login'}})) {
4761: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4762: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4763: if ($key eq 'loginvia') {
4764: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4765: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4766: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4767: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4768: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4769: $designhash{$udom.'.login.loginvia'} = $server;
4770: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4771:
4772: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4773: } else {
1.1013 raeburn 4774: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4775: }
4776: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4777: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4778: }
1.946 raeburn 4779: }
4780: }
4781: }
4782: }
4783: } else {
4784: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4785: $designhash{$udom.'.login.'.$key.'_'.$img} =
4786: $domconfig{'login'}{$key}{$img};
4787: }
1.699 raeburn 4788: }
4789: } else {
4790: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4791: }
1.632 raeburn 4792: }
4793: } else {
4794: $legacy{'login'} = 1;
1.518 albertel 4795: }
1.632 raeburn 4796: } else {
4797: $legacy{'login'} = 1;
1.518 albertel 4798: }
4799: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4800: if (keys(%{$domconfig{'rolecolors'}})) {
4801: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4802: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4803: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4804: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4805: }
1.518 albertel 4806: }
4807: }
1.632 raeburn 4808: } else {
4809: $legacy{'rolecolors'} = 1;
1.518 albertel 4810: }
1.632 raeburn 4811: } else {
4812: $legacy{'rolecolors'} = 1;
1.518 albertel 4813: }
1.948 raeburn 4814: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4815: if ($domconfig{'autoenroll'}{'co-owners'}) {
4816: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4817: }
4818: }
1.632 raeburn 4819: if (keys(%legacy) > 0) {
4820: my %legacyhash = &get_legacy_domconf($udom);
4821: foreach my $item (keys(%legacyhash)) {
4822: if ($item =~ /^\Q$udom\E\.login/) {
4823: if ($legacy{'login'}) {
4824: $designhash{$item} = $legacyhash{$item};
4825: }
4826: } else {
4827: if ($legacy{'rolecolors'}) {
4828: $designhash{$item} = $legacyhash{$item};
4829: }
1.518 albertel 4830: }
4831: }
4832: }
1.632 raeburn 4833: } else {
4834: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4835: }
4836: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4837: $cachetime);
4838: return %designhash;
4839: }
4840:
1.632 raeburn 4841: sub get_legacy_domconf {
4842: my ($udom) = @_;
4843: my %legacyhash;
4844: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4845: my $designfile = $designdir.'/'.$udom.'.tab';
4846: if (-e $designfile) {
4847: if ( open (my $fh,"<$designfile") ) {
4848: while (my $line = <$fh>) {
4849: next if ($line =~ /^\#/);
4850: chomp($line);
4851: my ($key,$val)=(split(/\=/,$line));
4852: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4853: }
4854: close($fh);
4855: }
4856: }
1.1026 raeburn 4857: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4858: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4859: }
4860: return %legacyhash;
4861: }
4862:
1.63 www 4863: =pod
4864:
1.112 bowersj2 4865: =item * &domainlogo()
1.63 www 4866:
4867: Inputs: $domain (usually will be undef)
4868:
4869: Returns: A link to a domain logo, if the domain logo exists.
4870: If the domain logo does not exist, a description of the domain.
4871:
4872: =cut
1.112 bowersj2 4873:
1.63 www 4874: ###############################################
4875: sub domainlogo {
1.517 raeburn 4876: my $domain = &determinedomain(shift);
1.518 albertel 4877: my %designhash = &get_domainconf($domain);
1.517 raeburn 4878: # See if there is a logo
4879: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4880: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4881: if ($imgsrc =~ m{^/(adm|res)/}) {
4882: if ($imgsrc =~ m{^/res/}) {
4883: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4884: &Apache::lonnet::repcopy($local_name);
4885: }
4886: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4887: }
4888: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4889: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4890: return &Apache::lonnet::domain($domain,'description');
1.59 www 4891: } else {
1.60 matthew 4892: return '';
1.59 www 4893: }
4894: }
1.63 www 4895: ##############################################
4896:
4897: =pod
4898:
1.112 bowersj2 4899: =item * &designparm()
1.63 www 4900:
4901: Inputs: $which parameter; $domain (usually will be undef)
4902:
4903: Returns: value of designparamter $which
4904:
4905: =cut
1.112 bowersj2 4906:
1.397 albertel 4907:
1.400 albertel 4908: ##############################################
1.397 albertel 4909: sub designparm {
4910: my ($which,$domain)=@_;
4911: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4912: return $env{'environment.color.'.$which};
1.96 www 4913: }
1.63 www 4914: $domain=&determinedomain($domain);
1.1016 raeburn 4915: my %domdesign;
4916: unless ($domain eq 'public') {
4917: %domdesign = &get_domainconf($domain);
4918: }
1.520 raeburn 4919: my $output;
1.517 raeburn 4920: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4921: $output = $domdesign{$domain.'.'.$which};
1.63 www 4922: } else {
1.520 raeburn 4923: $output = $defaultdesign{$which};
4924: }
4925: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4926: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4927: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4928: if ($output =~ m{^/res/}) {
4929: my $local_name = &Apache::lonnet::filelocation('',$output);
4930: &Apache::lonnet::repcopy($local_name);
4931: }
1.520 raeburn 4932: $output = &lonhttpdurl($output);
4933: }
1.63 www 4934: }
1.520 raeburn 4935: return $output;
1.63 www 4936: }
1.59 www 4937:
1.822 bisitz 4938: ##############################################
4939: =pod
4940:
1.832 bisitz 4941: =item * &authorspace()
4942:
1.1028 raeburn 4943: Inputs: $url (usually will be undef).
1.832 bisitz 4944:
1.1132 raeburn 4945: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 4946: directory being viewed (or for which action is being taken).
4947: If $url is provided, and begins /priv/<domain>/<uname>
4948: the path will be that portion of the $context argument.
4949: Otherwise the path will be for the author space of the current
4950: user when the current role is author, or for that of the
4951: co-author/assistant co-author space when the current role
4952: is co-author or assistant co-author.
1.832 bisitz 4953:
4954: =cut
4955:
4956: sub authorspace {
1.1028 raeburn 4957: my ($url) = @_;
4958: if ($url ne '') {
4959: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4960: return $1;
4961: }
4962: }
1.832 bisitz 4963: my $caname = '';
1.1024 www 4964: my $cadom = '';
1.1028 raeburn 4965: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4966: ($cadom,$caname) =
1.832 bisitz 4967: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4968: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4969: $caname = $env{'user.name'};
1.1024 www 4970: $cadom = $env{'user.domain'};
1.832 bisitz 4971: }
1.1028 raeburn 4972: if (($caname ne '') && ($cadom ne '')) {
4973: return "/priv/$cadom/$caname/";
4974: }
4975: return;
1.832 bisitz 4976: }
4977:
4978: ##############################################
4979: =pod
4980:
1.822 bisitz 4981: =item * &head_subbox()
4982:
4983: Inputs: $content (contains HTML code with page functions, etc.)
4984:
4985: Returns: HTML div with $content
4986: To be included in page header
4987:
4988: =cut
4989:
4990: sub head_subbox {
4991: my ($content)=@_;
4992: my $output =
1.993 raeburn 4993: '<div class="LC_head_subbox">'
1.822 bisitz 4994: .$content
4995: .'</div>'
4996: }
4997:
4998: ##############################################
4999: =pod
5000:
5001: =item * &CSTR_pageheader()
5002:
1.1026 raeburn 5003: Input: (optional) filename from which breadcrumb trail is built.
5004: In most cases no input as needed, as $env{'request.filename'}
5005: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5006:
5007: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5008: To be included on Authoring Space pages
1.822 bisitz 5009:
5010: =cut
5011:
5012: sub CSTR_pageheader {
1.1026 raeburn 5013: my ($trailfile) = @_;
5014: if ($trailfile eq '') {
5015: $trailfile = $env{'request.filename'};
5016: }
5017:
5018: # this is for resources; directories have customtitle, and crumbs
5019: # and select recent are created in lonpubdir.pm
5020:
5021: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5022: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5023: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5024: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5025: $formaction =~ s{/+}{/}g;
1.822 bisitz 5026:
5027: my $parentpath = '';
5028: my $lastitem = '';
5029: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5030: $parentpath = $1;
5031: $lastitem = $2;
5032: } else {
5033: $lastitem = $thisdisfn;
5034: }
1.921 bisitz 5035:
5036: my $output =
1.822 bisitz 5037: '<div>'
5038: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1132 raeburn 5039: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5040: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5041: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5042: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5043:
5044: if ($lastitem) {
5045: $output .=
5046: '<span class="LC_filename">'
5047: .$lastitem
5048: .'</span>';
5049: }
5050: $output .=
5051: '<br />'
1.822 bisitz 5052: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5053: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5054: .'</form>'
5055: .&Apache::lonmenu::constspaceform()
5056: .'</div>';
1.921 bisitz 5057:
5058: return $output;
1.822 bisitz 5059: }
5060:
1.60 matthew 5061: ###############################################
5062: ###############################################
5063:
5064: =pod
5065:
1.112 bowersj2 5066: =back
5067:
1.549 albertel 5068: =head1 HTML Helpers
1.112 bowersj2 5069:
5070: =over 4
5071:
5072: =item * &bodytag()
1.60 matthew 5073:
5074: Returns a uniform header for LON-CAPA web pages.
5075:
5076: Inputs:
5077:
1.112 bowersj2 5078: =over 4
5079:
5080: =item * $title, A title to be displayed on the page.
5081:
5082: =item * $function, the current role (can be undef).
5083:
5084: =item * $addentries, extra parameters for the <body> tag.
5085:
5086: =item * $bodyonly, if defined, only return the <body> tag.
5087:
5088: =item * $domain, if defined, force a given domain.
5089:
5090: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5091: text interface only)
1.60 matthew 5092:
1.814 bisitz 5093: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5094: navigational links
1.317 albertel 5095:
1.338 albertel 5096: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5097:
1.460 albertel 5098: =item * $args, optional argument valid values are
5099: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5100: inherit_jsmath -> when creating popup window in a page,
5101: should it have jsmath forced on by the
5102: current page
1.460 albertel 5103:
1.1096 raeburn 5104: =item * $advtoolsref, optional argument, ref to an array containing
5105: inlineremote items to be added in "Functions" menu below
5106: breadcrumbs.
5107:
1.112 bowersj2 5108: =back
5109:
1.60 matthew 5110: Returns: A uniform header for LON-CAPA web pages.
5111: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5112: If $bodyonly is undef or zero, an html string containing a <body> tag and
5113: other decorations will be returned.
5114:
5115: =cut
5116:
1.54 www 5117: sub bodytag {
1.831 bisitz 5118: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 raeburn 5119: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5120:
1.954 raeburn 5121: my $public;
5122: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5123: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5124: $public = 1;
5125: }
1.460 albertel 5126: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 5127:
1.183 matthew 5128: $function = &get_users_function() if (!$function);
1.339 albertel 5129: my $img = &designparm($function.'.img',$domain);
5130: my $font = &designparm($function.'.font',$domain);
5131: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5132:
1.803 bisitz 5133: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5134: 'bgcolor' => $pgbg,
1.339 albertel 5135: 'text' => $font,
5136: 'alink' => &designparm($function.'.alink',$domain),
5137: 'vlink' => &designparm($function.'.vlink',$domain),
5138: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5139: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5140:
1.63 www 5141: # role and realm
1.378 raeburn 5142: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5143: if ($role eq 'ca') {
1.479 albertel 5144: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5145: $realm = &plainname($rname,$rdom);
1.378 raeburn 5146: }
1.55 www 5147: # realm
1.258 albertel 5148: if ($env{'request.course.id'}) {
1.378 raeburn 5149: if ($env{'request.role'} !~ /^cr/) {
5150: $role = &Apache::lonnet::plaintext($role,&course_type());
5151: }
1.898 raeburn 5152: if ($env{'request.course.sec'}) {
5153: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5154: }
1.359 albertel 5155: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5156: } else {
5157: $role = &Apache::lonnet::plaintext($role);
1.54 www 5158: }
1.433 albertel 5159:
1.359 albertel 5160: if (!$realm) { $realm=' '; }
1.330 albertel 5161:
1.438 albertel 5162: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5163:
1.101 www 5164: # construct main body tag
1.359 albertel 5165: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5166: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5167:
1.1131 raeburn 5168: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5169:
1.1130 raeburn 5170: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5171: return $bodytag;
1.1130 raeburn 5172: }
1.359 albertel 5173:
1.954 raeburn 5174: if ($public) {
1.433 albertel 5175: undef($role);
5176: }
1.359 albertel 5177:
1.762 bisitz 5178: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5179: #
5180: # Extra info if you are the DC
5181: my $dc_info = '';
5182: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5183: $env{'course.'.$env{'request.course.id'}.
5184: '.domain'}.'/'})) {
5185: my $cid = $env{'request.course.id'};
1.917 raeburn 5186: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5187: $dc_info =~ s/\s+$//;
1.359 albertel 5188: }
5189:
1.898 raeburn 5190: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5191:
1.903 droeschl 5192: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5193:
5194: # if ($env{'request.state'} eq 'construct') {
5195: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5196: # }
5197:
1.1130 raeburn 5198: $bodytag .= Apache::lonhtmlcommon::scripttag(
5199: Apache::lonmenu::utilityfunctions(), 'start');
1.359 albertel 5200:
1.1130 raeburn 5201: my ($left,$right) = Apache::lonmenu::primary_menu();
1.359 albertel 5202:
1.916 droeschl 5203: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5204: if ($dc_info) {
5205: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5206: }
1.1130 raeburn 5207: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916 droeschl 5208: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5209: return $bodytag;
5210: }
1.894 droeschl 5211:
1.927 raeburn 5212: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130 raeburn 5213: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5214: }
1.916 droeschl 5215:
1.1130 raeburn 5216: $bodytag .= $right;
1.852 droeschl 5217:
1.917 raeburn 5218: if ($dc_info) {
5219: $dc_info = &dc_courseid_toggle($dc_info);
5220: }
5221: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5222:
1.903 droeschl 5223: #don't show menus for public users
1.954 raeburn 5224: if (!$public){
1.903 droeschl 5225: $bodytag .= Apache::lonmenu::secondary_menu();
5226: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5227: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5228: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5229: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5230: $args->{'bread_crumbs'});
1.1096 raeburn 5231: } elsif ($forcereg) {
5232: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
5233: $args->{'group'});
5234: } else {
5235: $bodytag .=
5236: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5237: $forcereg,$args->{'group'},
5238: $args->{'bread_crumbs'},
5239: $advtoolsref);
1.920 raeburn 5240: }
1.903 droeschl 5241: }else{
5242: # this is to seperate menu from content when there's no secondary
5243: # menu. Especially needed for public accessible ressources.
5244: $bodytag .= '<hr style="clear:both" />';
5245: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5246: }
1.903 droeschl 5247:
1.235 raeburn 5248: return $bodytag;
1.182 matthew 5249: }
5250:
1.917 raeburn 5251: sub dc_courseid_toggle {
5252: my ($dc_info) = @_;
1.980 raeburn 5253: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5254: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5255: &mt('(More ...)').'</a></span>'.
5256: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5257: }
5258:
1.330 albertel 5259: sub make_attr_string {
5260: my ($register,$attr_ref) = @_;
5261:
5262: if ($attr_ref && !ref($attr_ref)) {
5263: die("addentries Must be a hash ref ".
5264: join(':',caller(1))." ".
5265: join(':',caller(0))." ");
5266: }
5267:
5268: if ($register) {
1.339 albertel 5269: my ($on_load,$on_unload);
5270: foreach my $key (keys(%{$attr_ref})) {
5271: if (lc($key) eq 'onload') {
5272: $on_load.=$attr_ref->{$key}.';';
5273: delete($attr_ref->{$key});
5274:
5275: } elsif (lc($key) eq 'onunload') {
5276: $on_unload.=$attr_ref->{$key}.';';
5277: delete($attr_ref->{$key});
5278: }
5279: }
1.953 droeschl 5280: $attr_ref->{'onload'} = $on_load;
5281: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5282: }
1.339 albertel 5283:
1.330 albertel 5284: my $attr_string;
5285: foreach my $attr (keys(%$attr_ref)) {
5286: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5287: }
5288: return $attr_string;
5289: }
5290:
5291:
1.182 matthew 5292: ###############################################
1.251 albertel 5293: ###############################################
5294:
5295: =pod
5296:
5297: =item * &endbodytag()
5298:
5299: Returns a uniform footer for LON-CAPA web pages.
5300:
1.635 raeburn 5301: Inputs: 1 - optional reference to an args hash
5302: If in the hash, key for noredirectlink has a value which evaluates to true,
5303: a 'Continue' link is not displayed if the page contains an
5304: internal redirect in the <head></head> section,
5305: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5306:
5307: =cut
5308:
5309: sub endbodytag {
1.635 raeburn 5310: my ($args) = @_;
1.1080 raeburn 5311: my $endbodytag;
5312: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5313: $endbodytag='</body>';
5314: }
1.269 albertel 5315: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5316: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5317: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5318: $endbodytag=
5319: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5320: &mt('Continue').'</a>'.
5321: $endbodytag;
5322: }
1.315 albertel 5323: }
1.251 albertel 5324: return $endbodytag;
5325: }
5326:
1.352 albertel 5327: =pod
5328:
5329: =item * &standard_css()
5330:
5331: Returns a style sheet
5332:
5333: Inputs: (all optional)
5334: domain -> force to color decorate a page for a specific
5335: domain
5336: function -> force usage of a specific rolish color scheme
5337: bgcolor -> override the default page bgcolor
5338:
5339: =cut
5340:
1.343 albertel 5341: sub standard_css {
1.345 albertel 5342: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5343: $function = &get_users_function() if (!$function);
5344: my $img = &designparm($function.'.img', $domain);
5345: my $tabbg = &designparm($function.'.tabbg', $domain);
5346: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5347: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5348: #second colour for later usage
1.345 albertel 5349: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5350: my $pgbg_or_bgcolor =
5351: $bgcolor ||
1.352 albertel 5352: &designparm($function.'.pgbg', $domain);
1.382 albertel 5353: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5354: my $alink = &designparm($function.'.alink', $domain);
5355: my $vlink = &designparm($function.'.vlink', $domain);
5356: my $link = &designparm($function.'.link', $domain);
5357:
1.602 albertel 5358: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5359: my $mono = 'monospace';
1.850 bisitz 5360: my $data_table_head = $sidebg;
5361: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5362: my $data_table_dark = '#E0E0E0';
1.470 banghart 5363: my $data_table_darker = '#CCCCCC';
1.349 albertel 5364: my $data_table_highlight = '#FFFF00';
1.352 albertel 5365: my $mail_new = '#FFBB77';
5366: my $mail_new_hover = '#DD9955';
5367: my $mail_read = '#BBBB77';
5368: my $mail_read_hover = '#999944';
5369: my $mail_replied = '#AAAA88';
5370: my $mail_replied_hover = '#888855';
5371: my $mail_other = '#99BBBB';
5372: my $mail_other_hover = '#669999';
1.391 albertel 5373: my $table_header = '#DDDDDD';
1.489 raeburn 5374: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5375: my $lg_border_color = '#C8C8C8';
1.952 onken 5376: my $button_hover = '#BF2317';
1.392 albertel 5377:
1.608 albertel 5378: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5379: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5380: : '0 3px 0 4px';
1.448 albertel 5381:
1.523 albertel 5382:
1.343 albertel 5383: return <<END;
1.947 droeschl 5384:
5385: /* needed for iframe to allow 100% height in FF */
5386: body, html {
5387: margin: 0;
5388: padding: 0 0.5%;
5389: height: 99%; /* to avoid scrollbars */
5390: }
5391:
1.795 www 5392: body {
1.911 bisitz 5393: font-family: $sans;
5394: line-height:130%;
5395: font-size:0.83em;
5396: color:$font;
1.795 www 5397: }
5398:
1.959 onken 5399: a:focus,
5400: a:focus img {
1.795 www 5401: color: red;
5402: }
1.698 harmsja 5403:
1.911 bisitz 5404: form, .inline {
5405: display: inline;
1.795 www 5406: }
1.721 harmsja 5407:
1.795 www 5408: .LC_right {
1.911 bisitz 5409: text-align:right;
1.795 www 5410: }
5411:
5412: .LC_middle {
1.911 bisitz 5413: vertical-align:middle;
1.795 www 5414: }
1.721 harmsja 5415:
1.1130 raeburn 5416: .LC_floatleft {
5417: float: left;
5418: }
5419:
5420: .LC_floatright {
5421: float: right;
5422: }
5423:
1.911 bisitz 5424: .LC_400Box {
5425: width:400px;
5426: }
1.721 harmsja 5427:
1.947 droeschl 5428: .LC_iframecontainer {
5429: width: 98%;
5430: margin: 0;
5431: position: fixed;
5432: top: 8.5em;
5433: bottom: 0;
5434: }
5435:
5436: .LC_iframecontainer iframe{
5437: border: none;
5438: width: 100%;
5439: height: 100%;
5440: }
5441:
1.778 bisitz 5442: .LC_filename {
5443: font-family: $mono;
5444: white-space:pre;
1.921 bisitz 5445: font-size: 120%;
1.778 bisitz 5446: }
5447:
5448: .LC_fileicon {
5449: border: none;
5450: height: 1.3em;
5451: vertical-align: text-bottom;
5452: margin-right: 0.3em;
5453: text-decoration:none;
5454: }
5455:
1.1008 www 5456: .LC_setting {
5457: text-decoration:underline;
5458: }
5459:
1.350 albertel 5460: .LC_error {
5461: color: red;
5462: }
1.795 www 5463:
1.1097 bisitz 5464: .LC_warning {
5465: color: darkorange;
5466: }
5467:
1.457 albertel 5468: .LC_diff_removed {
1.733 bisitz 5469: color: red;
1.394 albertel 5470: }
1.532 albertel 5471:
5472: .LC_info,
1.457 albertel 5473: .LC_success,
5474: .LC_diff_added {
1.350 albertel 5475: color: green;
5476: }
1.795 www 5477:
1.802 bisitz 5478: div.LC_confirm_box {
5479: background-color: #FAFAFA;
5480: border: 1px solid $lg_border_color;
5481: margin-right: 0;
5482: padding: 5px;
5483: }
5484:
5485: div.LC_confirm_box .LC_error img,
5486: div.LC_confirm_box .LC_success img {
5487: vertical-align: middle;
5488: }
5489:
1.440 albertel 5490: .LC_icon {
1.771 droeschl 5491: border: none;
1.790 droeschl 5492: vertical-align: middle;
1.771 droeschl 5493: }
5494:
1.543 albertel 5495: .LC_docs_spacer {
5496: width: 25px;
5497: height: 1px;
1.771 droeschl 5498: border: none;
1.543 albertel 5499: }
1.346 albertel 5500:
1.532 albertel 5501: .LC_internal_info {
1.735 bisitz 5502: color: #999999;
1.532 albertel 5503: }
5504:
1.794 www 5505: .LC_discussion {
1.1050 www 5506: background: $data_table_dark;
1.911 bisitz 5507: border: 1px solid black;
5508: margin: 2px;
1.794 www 5509: }
5510:
5511: .LC_disc_action_left {
1.1050 www 5512: background: $sidebg;
1.911 bisitz 5513: text-align: left;
1.1050 www 5514: padding: 4px;
5515: margin: 2px;
1.794 www 5516: }
5517:
5518: .LC_disc_action_right {
1.1050 www 5519: background: $sidebg;
1.911 bisitz 5520: text-align: right;
1.1050 www 5521: padding: 4px;
5522: margin: 2px;
1.794 www 5523: }
5524:
5525: .LC_disc_new_item {
1.911 bisitz 5526: background: white;
5527: border: 2px solid red;
1.1050 www 5528: margin: 4px;
5529: padding: 4px;
1.794 www 5530: }
5531:
5532: .LC_disc_old_item {
1.911 bisitz 5533: background: white;
1.1050 www 5534: margin: 4px;
5535: padding: 4px;
1.794 www 5536: }
5537:
1.458 albertel 5538: table.LC_pastsubmission {
5539: border: 1px solid black;
5540: margin: 2px;
5541: }
5542:
1.924 bisitz 5543: table#LC_menubuttons {
1.345 albertel 5544: width: 100%;
5545: background: $pgbg;
1.392 albertel 5546: border: 2px;
1.402 albertel 5547: border-collapse: separate;
1.803 bisitz 5548: padding: 0;
1.345 albertel 5549: }
1.392 albertel 5550:
1.801 tempelho 5551: table#LC_title_bar a {
5552: color: $fontmenu;
5553: }
1.836 bisitz 5554:
1.807 droeschl 5555: table#LC_title_bar {
1.819 tempelho 5556: clear: both;
1.836 bisitz 5557: display: none;
1.807 droeschl 5558: }
5559:
1.795 www 5560: table#LC_title_bar,
1.933 droeschl 5561: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5562: table#LC_title_bar.LC_with_remote {
1.359 albertel 5563: width: 100%;
1.392 albertel 5564: border-color: $pgbg;
5565: border-style: solid;
5566: border-width: $border;
1.379 albertel 5567: background: $pgbg;
1.801 tempelho 5568: color: $fontmenu;
1.392 albertel 5569: border-collapse: collapse;
1.803 bisitz 5570: padding: 0;
1.819 tempelho 5571: margin: 0;
1.359 albertel 5572: }
1.795 www 5573:
1.933 droeschl 5574: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5575: margin: 0;
5576: padding: 0;
1.933 droeschl 5577: position: relative;
5578: list-style: none;
1.913 droeschl 5579: }
1.933 droeschl 5580: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5581: display: inline;
5582: }
1.933 droeschl 5583:
5584: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5585: padding: 0;
1.933 droeschl 5586: margin: 0;
5587: float: left;
1.913 droeschl 5588: }
1.933 droeschl 5589: .LC_breadcrumb_tools_tools {
5590: padding: 0;
5591: margin: 0;
1.913 droeschl 5592: float: right;
5593: }
5594:
1.359 albertel 5595: table#LC_title_bar td {
5596: background: $tabbg;
5597: }
1.795 www 5598:
1.911 bisitz 5599: table#LC_menubuttons img {
1.803 bisitz 5600: border: none;
1.346 albertel 5601: }
1.795 www 5602:
1.842 droeschl 5603: .LC_breadcrumbs_component {
1.911 bisitz 5604: float: right;
5605: margin: 0 1em;
1.357 albertel 5606: }
1.842 droeschl 5607: .LC_breadcrumbs_component img {
1.911 bisitz 5608: vertical-align: middle;
1.777 tempelho 5609: }
1.795 www 5610:
1.383 albertel 5611: td.LC_table_cell_checkbox {
5612: text-align: center;
5613: }
1.795 www 5614:
5615: .LC_fontsize_small {
1.911 bisitz 5616: font-size: 70%;
1.705 tempelho 5617: }
5618:
1.844 bisitz 5619: #LC_breadcrumbs {
1.911 bisitz 5620: clear:both;
5621: background: $sidebg;
5622: border-bottom: 1px solid $lg_border_color;
5623: line-height: 2.5em;
1.933 droeschl 5624: overflow: hidden;
1.911 bisitz 5625: margin: 0;
5626: padding: 0;
1.995 raeburn 5627: text-align: left;
1.819 tempelho 5628: }
1.862 bisitz 5629:
1.1098 bisitz 5630: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 5631: clear:both;
5632: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5633: border: 1px solid $sidebg;
1.1098 bisitz 5634: margin: 0 0 10px 0;
1.966 bisitz 5635: padding: 3px;
1.995 raeburn 5636: text-align: left;
1.822 bisitz 5637: }
5638:
1.795 www 5639: .LC_fontsize_medium {
1.911 bisitz 5640: font-size: 85%;
1.705 tempelho 5641: }
5642:
1.795 www 5643: .LC_fontsize_large {
1.911 bisitz 5644: font-size: 120%;
1.705 tempelho 5645: }
5646:
1.346 albertel 5647: .LC_menubuttons_inline_text {
5648: color: $font;
1.698 harmsja 5649: font-size: 90%;
1.701 harmsja 5650: padding-left:3px;
1.346 albertel 5651: }
5652:
1.934 droeschl 5653: .LC_menubuttons_inline_text img{
5654: vertical-align: middle;
5655: }
5656:
1.1051 www 5657: li.LC_menubuttons_inline_text img {
1.951 onken 5658: cursor:pointer;
1.1002 droeschl 5659: text-decoration: none;
1.951 onken 5660: }
5661:
1.526 www 5662: .LC_menubuttons_link {
5663: text-decoration: none;
5664: }
1.795 www 5665:
1.522 albertel 5666: .LC_menubuttons_category {
1.521 www 5667: color: $font;
1.526 www 5668: background: $pgbg;
1.521 www 5669: font-size: larger;
5670: font-weight: bold;
5671: }
5672:
1.346 albertel 5673: td.LC_menubuttons_text {
1.911 bisitz 5674: color: $font;
1.346 albertel 5675: }
1.706 harmsja 5676:
1.346 albertel 5677: .LC_current_location {
5678: background: $tabbg;
5679: }
1.795 www 5680:
1.938 bisitz 5681: table.LC_data_table {
1.347 albertel 5682: border: 1px solid #000000;
1.402 albertel 5683: border-collapse: separate;
1.426 albertel 5684: border-spacing: 1px;
1.610 albertel 5685: background: $pgbg;
1.347 albertel 5686: }
1.795 www 5687:
1.422 albertel 5688: .LC_data_table_dense {
5689: font-size: small;
5690: }
1.795 www 5691:
1.507 raeburn 5692: table.LC_nested_outer {
5693: border: 1px solid #000000;
1.589 raeburn 5694: border-collapse: collapse;
1.803 bisitz 5695: border-spacing: 0;
1.507 raeburn 5696: width: 100%;
5697: }
1.795 www 5698:
1.879 raeburn 5699: table.LC_innerpickbox,
1.507 raeburn 5700: table.LC_nested {
1.803 bisitz 5701: border: none;
1.589 raeburn 5702: border-collapse: collapse;
1.803 bisitz 5703: border-spacing: 0;
1.507 raeburn 5704: width: 100%;
5705: }
1.795 www 5706:
1.911 bisitz 5707: table.LC_data_table tr th,
5708: table.LC_calendar tr th,
1.879 raeburn 5709: table.LC_prior_tries tr th,
5710: table.LC_innerpickbox tr th {
1.349 albertel 5711: font-weight: bold;
5712: background-color: $data_table_head;
1.801 tempelho 5713: color:$fontmenu;
1.701 harmsja 5714: font-size:90%;
1.347 albertel 5715: }
1.795 www 5716:
1.879 raeburn 5717: table.LC_innerpickbox tr th,
5718: table.LC_innerpickbox tr td {
5719: vertical-align: top;
5720: }
5721:
1.711 raeburn 5722: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5723: background-color: #CCCCCC;
1.711 raeburn 5724: font-weight: bold;
5725: text-align: left;
5726: }
1.795 www 5727:
1.912 bisitz 5728: table.LC_data_table tr.LC_odd_row > td {
5729: background-color: $data_table_light;
5730: padding: 2px;
5731: vertical-align: top;
5732: }
5733:
1.809 bisitz 5734: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5735: background-color: $data_table_light;
1.912 bisitz 5736: vertical-align: top;
5737: }
5738:
5739: table.LC_data_table tr.LC_even_row > td {
5740: background-color: $data_table_dark;
1.425 albertel 5741: padding: 2px;
1.900 bisitz 5742: vertical-align: top;
1.347 albertel 5743: }
1.795 www 5744:
1.809 bisitz 5745: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5746: background-color: $data_table_dark;
1.900 bisitz 5747: vertical-align: top;
1.347 albertel 5748: }
1.795 www 5749:
1.425 albertel 5750: table.LC_data_table tr.LC_data_table_highlight td {
5751: background-color: $data_table_darker;
5752: }
1.795 www 5753:
1.639 raeburn 5754: table.LC_data_table tr td.LC_leftcol_header {
5755: background-color: $data_table_head;
5756: font-weight: bold;
5757: }
1.795 www 5758:
1.451 albertel 5759: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5760: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5761: font-weight: bold;
5762: font-style: italic;
5763: text-align: center;
5764: padding: 8px;
1.347 albertel 5765: }
1.795 www 5766:
1.1114 raeburn 5767: table.LC_data_table tr.LC_empty_row td,
5768: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 5769: background-color: $sidebg;
5770: }
5771:
5772: table.LC_nested tr.LC_empty_row td {
5773: background-color: #FFFFFF;
5774: }
5775:
1.890 droeschl 5776: table.LC_caption {
5777: }
5778:
1.507 raeburn 5779: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5780: padding: 4ex
5781: }
1.795 www 5782:
1.507 raeburn 5783: table.LC_nested_outer tr th {
5784: font-weight: bold;
1.801 tempelho 5785: color:$fontmenu;
1.507 raeburn 5786: background-color: $data_table_head;
1.701 harmsja 5787: font-size: small;
1.507 raeburn 5788: border-bottom: 1px solid #000000;
5789: }
1.795 www 5790:
1.507 raeburn 5791: table.LC_nested_outer tr td.LC_subheader {
5792: background-color: $data_table_head;
5793: font-weight: bold;
5794: font-size: small;
5795: border-bottom: 1px solid #000000;
5796: text-align: right;
1.451 albertel 5797: }
1.795 www 5798:
1.507 raeburn 5799: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5800: background-color: #CCCCCC;
1.451 albertel 5801: font-weight: bold;
5802: font-size: small;
1.507 raeburn 5803: text-align: center;
5804: }
1.795 www 5805:
1.589 raeburn 5806: table.LC_nested tr.LC_info_row td.LC_left_item,
5807: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5808: text-align: left;
1.451 albertel 5809: }
1.795 www 5810:
1.507 raeburn 5811: table.LC_nested td {
1.735 bisitz 5812: background-color: #FFFFFF;
1.451 albertel 5813: font-size: small;
1.507 raeburn 5814: }
1.795 www 5815:
1.507 raeburn 5816: table.LC_nested_outer tr th.LC_right_item,
5817: table.LC_nested tr.LC_info_row td.LC_right_item,
5818: table.LC_nested tr.LC_odd_row td.LC_right_item,
5819: table.LC_nested tr td.LC_right_item {
1.451 albertel 5820: text-align: right;
5821: }
5822:
1.507 raeburn 5823: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5824: background-color: #EEEEEE;
1.451 albertel 5825: }
5826:
1.473 raeburn 5827: table.LC_createuser {
5828: }
5829:
5830: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5831: font-size: small;
1.473 raeburn 5832: }
5833:
5834: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5835: background-color: #CCCCCC;
1.473 raeburn 5836: font-weight: bold;
5837: text-align: center;
5838: }
5839:
1.349 albertel 5840: table.LC_calendar {
5841: border: 1px solid #000000;
5842: border-collapse: collapse;
1.917 raeburn 5843: width: 98%;
1.349 albertel 5844: }
1.795 www 5845:
1.349 albertel 5846: table.LC_calendar_pickdate {
5847: font-size: xx-small;
5848: }
1.795 www 5849:
1.349 albertel 5850: table.LC_calendar tr td {
5851: border: 1px solid #000000;
5852: vertical-align: top;
1.917 raeburn 5853: width: 14%;
1.349 albertel 5854: }
1.795 www 5855:
1.349 albertel 5856: table.LC_calendar tr td.LC_calendar_day_empty {
5857: background-color: $data_table_dark;
5858: }
1.795 www 5859:
1.779 bisitz 5860: table.LC_calendar tr td.LC_calendar_day_current {
5861: background-color: $data_table_highlight;
1.777 tempelho 5862: }
1.795 www 5863:
1.938 bisitz 5864: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5865: background-color: $mail_new;
5866: }
1.795 www 5867:
1.938 bisitz 5868: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5869: background-color: $mail_new_hover;
5870: }
1.795 www 5871:
1.938 bisitz 5872: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5873: background-color: $mail_read;
5874: }
1.795 www 5875:
1.938 bisitz 5876: /*
5877: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5878: background-color: $mail_read_hover;
5879: }
1.938 bisitz 5880: */
1.795 www 5881:
1.938 bisitz 5882: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5883: background-color: $mail_replied;
5884: }
1.795 www 5885:
1.938 bisitz 5886: /*
5887: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5888: background-color: $mail_replied_hover;
5889: }
1.938 bisitz 5890: */
1.795 www 5891:
1.938 bisitz 5892: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5893: background-color: $mail_other;
5894: }
1.795 www 5895:
1.938 bisitz 5896: /*
5897: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5898: background-color: $mail_other_hover;
5899: }
1.938 bisitz 5900: */
1.494 raeburn 5901:
1.777 tempelho 5902: table.LC_data_table tr > td.LC_browser_file,
5903: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5904: background: #AAEE77;
1.389 albertel 5905: }
1.795 www 5906:
1.777 tempelho 5907: table.LC_data_table tr > td.LC_browser_file_locked,
5908: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5909: background: #FFAA99;
1.387 albertel 5910: }
1.795 www 5911:
1.777 tempelho 5912: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5913: background: #888888;
1.779 bisitz 5914: }
1.795 www 5915:
1.777 tempelho 5916: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5917: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5918: background: #F8F866;
1.777 tempelho 5919: }
1.795 www 5920:
1.696 bisitz 5921: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5922: background: #E0E8FF;
1.387 albertel 5923: }
1.696 bisitz 5924:
1.707 bisitz 5925: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5926: /* background: #77FF77; */
1.707 bisitz 5927: }
1.795 www 5928:
1.707 bisitz 5929: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5930: border-right: 8px solid #FFFF77;
1.707 bisitz 5931: }
1.795 www 5932:
1.707 bisitz 5933: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5934: border-right: 8px solid #FFAA77;
1.707 bisitz 5935: }
1.795 www 5936:
1.707 bisitz 5937: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5938: border-right: 8px solid #FF7777;
1.707 bisitz 5939: }
1.795 www 5940:
1.707 bisitz 5941: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5942: border-right: 8px solid #AAFF77;
1.707 bisitz 5943: }
1.795 www 5944:
1.707 bisitz 5945: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5946: border-right: 8px solid #11CC55;
1.707 bisitz 5947: }
5948:
1.388 albertel 5949: span.LC_current_location {
1.701 harmsja 5950: font-size:larger;
1.388 albertel 5951: background: $pgbg;
5952: }
1.387 albertel 5953:
1.1029 www 5954: span.LC_current_nav_location {
5955: font-weight:bold;
5956: background: $sidebg;
5957: }
5958:
1.395 albertel 5959: span.LC_parm_menu_item {
5960: font-size: larger;
5961: }
1.795 www 5962:
1.395 albertel 5963: span.LC_parm_scope_all {
5964: color: red;
5965: }
1.795 www 5966:
1.395 albertel 5967: span.LC_parm_scope_folder {
5968: color: green;
5969: }
1.795 www 5970:
1.395 albertel 5971: span.LC_parm_scope_resource {
5972: color: orange;
5973: }
1.795 www 5974:
1.395 albertel 5975: span.LC_parm_part {
5976: color: blue;
5977: }
1.795 www 5978:
1.911 bisitz 5979: span.LC_parm_folder,
5980: span.LC_parm_symb {
1.395 albertel 5981: font-size: x-small;
5982: font-family: $mono;
5983: color: #AAAAAA;
5984: }
5985:
1.977 bisitz 5986: ul.LC_parm_parmlist li {
5987: display: inline-block;
5988: padding: 0.3em 0.8em;
5989: vertical-align: top;
5990: width: 150px;
5991: border-top:1px solid $lg_border_color;
5992: }
5993:
1.795 www 5994: td.LC_parm_overview_level_menu,
5995: td.LC_parm_overview_map_menu,
5996: td.LC_parm_overview_parm_selectors,
5997: td.LC_parm_overview_restrictions {
1.396 albertel 5998: border: 1px solid black;
5999: border-collapse: collapse;
6000: }
1.795 www 6001:
1.396 albertel 6002: table.LC_parm_overview_restrictions td {
6003: border-width: 1px 4px 1px 4px;
6004: border-style: solid;
6005: border-color: $pgbg;
6006: text-align: center;
6007: }
1.795 www 6008:
1.396 albertel 6009: table.LC_parm_overview_restrictions th {
6010: background: $tabbg;
6011: border-width: 1px 4px 1px 4px;
6012: border-style: solid;
6013: border-color: $pgbg;
6014: }
1.795 www 6015:
1.398 albertel 6016: table#LC_helpmenu {
1.803 bisitz 6017: border: none;
1.398 albertel 6018: height: 55px;
1.803 bisitz 6019: border-spacing: 0;
1.398 albertel 6020: }
6021:
6022: table#LC_helpmenu fieldset legend {
6023: font-size: larger;
6024: }
1.795 www 6025:
1.397 albertel 6026: table#LC_helpmenu_links {
6027: width: 100%;
6028: border: 1px solid black;
6029: background: $pgbg;
1.803 bisitz 6030: padding: 0;
1.397 albertel 6031: border-spacing: 1px;
6032: }
1.795 www 6033:
1.397 albertel 6034: table#LC_helpmenu_links tr td {
6035: padding: 1px;
6036: background: $tabbg;
1.399 albertel 6037: text-align: center;
6038: font-weight: bold;
1.397 albertel 6039: }
1.396 albertel 6040:
1.795 www 6041: table#LC_helpmenu_links a:link,
6042: table#LC_helpmenu_links a:visited,
1.397 albertel 6043: table#LC_helpmenu_links a:active {
6044: text-decoration: none;
6045: color: $font;
6046: }
1.795 www 6047:
1.397 albertel 6048: table#LC_helpmenu_links a:hover {
6049: text-decoration: underline;
6050: color: $vlink;
6051: }
1.396 albertel 6052:
1.417 albertel 6053: .LC_chrt_popup_exists {
6054: border: 1px solid #339933;
6055: margin: -1px;
6056: }
1.795 www 6057:
1.417 albertel 6058: .LC_chrt_popup_up {
6059: border: 1px solid yellow;
6060: margin: -1px;
6061: }
1.795 www 6062:
1.417 albertel 6063: .LC_chrt_popup {
6064: border: 1px solid #8888FF;
6065: background: #CCCCFF;
6066: }
1.795 www 6067:
1.421 albertel 6068: table.LC_pick_box {
6069: border-collapse: separate;
6070: background: white;
6071: border: 1px solid black;
6072: border-spacing: 1px;
6073: }
1.795 www 6074:
1.421 albertel 6075: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6076: background: $sidebg;
1.421 albertel 6077: font-weight: bold;
1.900 bisitz 6078: text-align: left;
1.740 bisitz 6079: vertical-align: top;
1.421 albertel 6080: width: 184px;
6081: padding: 8px;
6082: }
1.795 www 6083:
1.579 raeburn 6084: table.LC_pick_box td.LC_pick_box_value {
6085: text-align: left;
6086: padding: 8px;
6087: }
1.795 www 6088:
1.579 raeburn 6089: table.LC_pick_box td.LC_pick_box_select {
6090: text-align: left;
6091: padding: 8px;
6092: }
1.795 www 6093:
1.424 albertel 6094: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6095: padding: 0;
1.421 albertel 6096: height: 1px;
6097: background: black;
6098: }
1.795 www 6099:
1.421 albertel 6100: table.LC_pick_box td.LC_pick_box_submit {
6101: text-align: right;
6102: }
1.795 www 6103:
1.579 raeburn 6104: table.LC_pick_box td.LC_evenrow_value {
6105: text-align: left;
6106: padding: 8px;
6107: background-color: $data_table_light;
6108: }
1.795 www 6109:
1.579 raeburn 6110: table.LC_pick_box td.LC_oddrow_value {
6111: text-align: left;
6112: padding: 8px;
6113: background-color: $data_table_light;
6114: }
1.795 www 6115:
1.579 raeburn 6116: span.LC_helpform_receipt_cat {
6117: font-weight: bold;
6118: }
1.795 www 6119:
1.424 albertel 6120: table.LC_group_priv_box {
6121: background: white;
6122: border: 1px solid black;
6123: border-spacing: 1px;
6124: }
1.795 www 6125:
1.424 albertel 6126: table.LC_group_priv_box td.LC_pick_box_title {
6127: background: $tabbg;
6128: font-weight: bold;
6129: text-align: right;
6130: width: 184px;
6131: }
1.795 www 6132:
1.424 albertel 6133: table.LC_group_priv_box td.LC_groups_fixed {
6134: background: $data_table_light;
6135: text-align: center;
6136: }
1.795 www 6137:
1.424 albertel 6138: table.LC_group_priv_box td.LC_groups_optional {
6139: background: $data_table_dark;
6140: text-align: center;
6141: }
1.795 www 6142:
1.424 albertel 6143: table.LC_group_priv_box td.LC_groups_functionality {
6144: background: $data_table_darker;
6145: text-align: center;
6146: font-weight: bold;
6147: }
1.795 www 6148:
1.424 albertel 6149: table.LC_group_priv td {
6150: text-align: left;
1.803 bisitz 6151: padding: 0;
1.424 albertel 6152: }
6153:
6154: .LC_navbuttons {
6155: margin: 2ex 0ex 2ex 0ex;
6156: }
1.795 www 6157:
1.423 albertel 6158: .LC_topic_bar {
6159: font-weight: bold;
6160: background: $tabbg;
1.918 wenzelju 6161: margin: 1em 0em 1em 2em;
1.805 bisitz 6162: padding: 3px;
1.918 wenzelju 6163: font-size: 1.2em;
1.423 albertel 6164: }
1.795 www 6165:
1.423 albertel 6166: .LC_topic_bar span {
1.918 wenzelju 6167: left: 0.5em;
6168: position: absolute;
1.423 albertel 6169: vertical-align: middle;
1.918 wenzelju 6170: font-size: 1.2em;
1.423 albertel 6171: }
1.795 www 6172:
1.423 albertel 6173: table.LC_course_group_status {
6174: margin: 20px;
6175: }
1.795 www 6176:
1.423 albertel 6177: table.LC_status_selector td {
6178: vertical-align: top;
6179: text-align: center;
1.424 albertel 6180: padding: 4px;
6181: }
1.795 www 6182:
1.599 albertel 6183: div.LC_feedback_link {
1.616 albertel 6184: clear: both;
1.829 kalberla 6185: background: $sidebg;
1.779 bisitz 6186: width: 100%;
1.829 kalberla 6187: padding-bottom: 10px;
6188: border: 1px $tabbg solid;
1.833 kalberla 6189: height: 22px;
6190: line-height: 22px;
6191: padding-top: 5px;
6192: }
6193:
6194: div.LC_feedback_link img {
6195: height: 22px;
1.867 kalberla 6196: vertical-align:middle;
1.829 kalberla 6197: }
6198:
1.911 bisitz 6199: div.LC_feedback_link a {
1.829 kalberla 6200: text-decoration: none;
1.489 raeburn 6201: }
1.795 www 6202:
1.867 kalberla 6203: div.LC_comblock {
1.911 bisitz 6204: display:inline;
1.867 kalberla 6205: color:$font;
6206: font-size:90%;
6207: }
6208:
6209: div.LC_feedback_link div.LC_comblock {
6210: padding-left:5px;
6211: }
6212:
6213: div.LC_feedback_link div.LC_comblock a {
6214: color:$font;
6215: }
6216:
1.489 raeburn 6217: span.LC_feedback_link {
1.858 bisitz 6218: /* background: $feedback_link_bg; */
1.599 albertel 6219: font-size: larger;
6220: }
1.795 www 6221:
1.599 albertel 6222: span.LC_message_link {
1.858 bisitz 6223: /* background: $feedback_link_bg; */
1.599 albertel 6224: font-size: larger;
6225: position: absolute;
6226: right: 1em;
1.489 raeburn 6227: }
1.421 albertel 6228:
1.515 albertel 6229: table.LC_prior_tries {
1.524 albertel 6230: border: 1px solid #000000;
6231: border-collapse: separate;
6232: border-spacing: 1px;
1.515 albertel 6233: }
1.523 albertel 6234:
1.515 albertel 6235: table.LC_prior_tries td {
1.524 albertel 6236: padding: 2px;
1.515 albertel 6237: }
1.523 albertel 6238:
6239: .LC_answer_correct {
1.795 www 6240: background: lightgreen;
6241: color: darkgreen;
6242: padding: 6px;
1.523 albertel 6243: }
1.795 www 6244:
1.523 albertel 6245: .LC_answer_charged_try {
1.797 www 6246: background: #FFAAAA;
1.795 www 6247: color: darkred;
6248: padding: 6px;
1.523 albertel 6249: }
1.795 www 6250:
1.779 bisitz 6251: .LC_answer_not_charged_try,
1.523 albertel 6252: .LC_answer_no_grade,
6253: .LC_answer_late {
1.795 www 6254: background: lightyellow;
1.523 albertel 6255: color: black;
1.795 www 6256: padding: 6px;
1.523 albertel 6257: }
1.795 www 6258:
1.523 albertel 6259: .LC_answer_previous {
1.795 www 6260: background: lightblue;
6261: color: darkblue;
6262: padding: 6px;
1.523 albertel 6263: }
1.795 www 6264:
1.779 bisitz 6265: .LC_answer_no_message {
1.777 tempelho 6266: background: #FFFFFF;
6267: color: black;
1.795 www 6268: padding: 6px;
1.779 bisitz 6269: }
1.795 www 6270:
1.779 bisitz 6271: .LC_answer_unknown {
6272: background: orange;
6273: color: black;
1.795 www 6274: padding: 6px;
1.777 tempelho 6275: }
1.795 www 6276:
1.529 albertel 6277: span.LC_prior_numerical,
6278: span.LC_prior_string,
6279: span.LC_prior_custom,
6280: span.LC_prior_reaction,
6281: span.LC_prior_math {
1.925 bisitz 6282: font-family: $mono;
1.523 albertel 6283: white-space: pre;
6284: }
6285:
1.525 albertel 6286: span.LC_prior_string {
1.925 bisitz 6287: font-family: $mono;
1.525 albertel 6288: white-space: pre;
6289: }
6290:
1.523 albertel 6291: table.LC_prior_option {
6292: width: 100%;
6293: border-collapse: collapse;
6294: }
1.795 www 6295:
1.911 bisitz 6296: table.LC_prior_rank,
1.795 www 6297: table.LC_prior_match {
1.528 albertel 6298: border-collapse: collapse;
6299: }
1.795 www 6300:
1.528 albertel 6301: table.LC_prior_option tr td,
6302: table.LC_prior_rank tr td,
6303: table.LC_prior_match tr td {
1.524 albertel 6304: border: 1px solid #000000;
1.515 albertel 6305: }
6306:
1.855 bisitz 6307: .LC_nobreak {
1.544 albertel 6308: white-space: nowrap;
1.519 raeburn 6309: }
6310:
1.576 raeburn 6311: span.LC_cusr_emph {
6312: font-style: italic;
6313: }
6314:
1.633 raeburn 6315: span.LC_cusr_subheading {
6316: font-weight: normal;
6317: font-size: 85%;
6318: }
6319:
1.861 bisitz 6320: div.LC_docs_entry_move {
1.859 bisitz 6321: border: 1px solid #BBBBBB;
1.545 albertel 6322: background: #DDDDDD;
1.861 bisitz 6323: width: 22px;
1.859 bisitz 6324: padding: 1px;
6325: margin: 0;
1.545 albertel 6326: }
6327:
1.861 bisitz 6328: table.LC_data_table tr > td.LC_docs_entry_commands,
6329: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6330: font-size: x-small;
6331: }
1.795 www 6332:
1.861 bisitz 6333: .LC_docs_entry_parameter {
6334: white-space: nowrap;
6335: }
6336:
1.544 albertel 6337: .LC_docs_copy {
1.545 albertel 6338: color: #000099;
1.544 albertel 6339: }
1.795 www 6340:
1.544 albertel 6341: .LC_docs_cut {
1.545 albertel 6342: color: #550044;
1.544 albertel 6343: }
1.795 www 6344:
1.544 albertel 6345: .LC_docs_rename {
1.545 albertel 6346: color: #009900;
1.544 albertel 6347: }
1.795 www 6348:
1.544 albertel 6349: .LC_docs_remove {
1.545 albertel 6350: color: #990000;
6351: }
6352:
1.547 albertel 6353: .LC_docs_reinit_warn,
6354: .LC_docs_ext_edit {
6355: font-size: x-small;
6356: }
6357:
1.545 albertel 6358: table.LC_docs_adddocs td,
6359: table.LC_docs_adddocs th {
6360: border: 1px solid #BBBBBB;
6361: padding: 4px;
6362: background: #DDDDDD;
1.543 albertel 6363: }
6364:
1.584 albertel 6365: table.LC_sty_begin {
6366: background: #BBFFBB;
6367: }
1.795 www 6368:
1.584 albertel 6369: table.LC_sty_end {
6370: background: #FFBBBB;
6371: }
6372:
1.589 raeburn 6373: table.LC_double_column {
1.803 bisitz 6374: border-width: 0;
1.589 raeburn 6375: border-collapse: collapse;
6376: width: 100%;
6377: padding: 2px;
6378: }
6379:
6380: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6381: top: 2px;
1.589 raeburn 6382: left: 2px;
6383: width: 47%;
6384: vertical-align: top;
6385: }
6386:
6387: table.LC_double_column tr td.LC_right_col {
6388: top: 2px;
1.779 bisitz 6389: right: 2px;
1.589 raeburn 6390: width: 47%;
6391: vertical-align: top;
6392: }
6393:
1.591 raeburn 6394: div.LC_left_float {
6395: float: left;
6396: padding-right: 5%;
1.597 albertel 6397: padding-bottom: 4px;
1.591 raeburn 6398: }
6399:
6400: div.LC_clear_float_header {
1.597 albertel 6401: padding-bottom: 2px;
1.591 raeburn 6402: }
6403:
6404: div.LC_clear_float_footer {
1.597 albertel 6405: padding-top: 10px;
1.591 raeburn 6406: clear: both;
6407: }
6408:
1.597 albertel 6409: div.LC_grade_show_user {
1.941 bisitz 6410: /* border-left: 5px solid $sidebg; */
6411: border-top: 5px solid #000000;
6412: margin: 50px 0 0 0;
1.936 bisitz 6413: padding: 15px 0 5px 10px;
1.597 albertel 6414: }
1.795 www 6415:
1.936 bisitz 6416: div.LC_grade_show_user_odd_row {
1.941 bisitz 6417: /* border-left: 5px solid #000000; */
6418: }
6419:
6420: div.LC_grade_show_user div.LC_Box {
6421: margin-right: 50px;
1.597 albertel 6422: }
6423:
6424: div.LC_grade_submissions,
6425: div.LC_grade_message_center,
1.936 bisitz 6426: div.LC_grade_info_links {
1.597 albertel 6427: margin: 5px;
6428: width: 99%;
6429: background: #FFFFFF;
6430: }
1.795 www 6431:
1.597 albertel 6432: div.LC_grade_submissions_header,
1.936 bisitz 6433: div.LC_grade_message_center_header {
1.705 tempelho 6434: font-weight: bold;
6435: font-size: large;
1.597 albertel 6436: }
1.795 www 6437:
1.597 albertel 6438: div.LC_grade_submissions_body,
1.936 bisitz 6439: div.LC_grade_message_center_body {
1.597 albertel 6440: border: 1px solid black;
6441: width: 99%;
6442: background: #FFFFFF;
6443: }
1.795 www 6444:
1.613 albertel 6445: table.LC_scantron_action {
6446: width: 100%;
6447: }
1.795 www 6448:
1.613 albertel 6449: table.LC_scantron_action tr th {
1.698 harmsja 6450: font-weight:bold;
6451: font-style:normal;
1.613 albertel 6452: }
1.795 www 6453:
1.779 bisitz 6454: .LC_edit_problem_header,
1.614 albertel 6455: div.LC_edit_problem_footer {
1.705 tempelho 6456: font-weight: normal;
6457: font-size: medium;
1.602 albertel 6458: margin: 2px;
1.1060 bisitz 6459: background-color: $sidebg;
1.600 albertel 6460: }
1.795 www 6461:
1.600 albertel 6462: div.LC_edit_problem_header,
1.602 albertel 6463: div.LC_edit_problem_header div,
1.614 albertel 6464: div.LC_edit_problem_footer,
6465: div.LC_edit_problem_footer div,
1.602 albertel 6466: div.LC_edit_problem_editxml_header,
6467: div.LC_edit_problem_editxml_header div {
1.600 albertel 6468: margin-top: 5px;
6469: }
1.795 www 6470:
1.600 albertel 6471: div.LC_edit_problem_header_title {
1.705 tempelho 6472: font-weight: bold;
6473: font-size: larger;
1.602 albertel 6474: background: $tabbg;
6475: padding: 3px;
1.1060 bisitz 6476: margin: 0 0 5px 0;
1.602 albertel 6477: }
1.795 www 6478:
1.602 albertel 6479: table.LC_edit_problem_header_title {
6480: width: 100%;
1.600 albertel 6481: background: $tabbg;
1.602 albertel 6482: }
6483:
6484: div.LC_edit_problem_discards {
6485: float: left;
6486: padding-bottom: 5px;
6487: }
1.795 www 6488:
1.602 albertel 6489: div.LC_edit_problem_saves {
6490: float: right;
6491: padding-bottom: 5px;
1.600 albertel 6492: }
1.795 www 6493:
1.1124 bisitz 6494: .LC_edit_opt {
6495: padding-left: 1em;
6496: white-space: nowrap;
6497: }
6498:
1.911 bisitz 6499: img.stift {
1.803 bisitz 6500: border-width: 0;
6501: vertical-align: middle;
1.677 riegler 6502: }
1.680 riegler 6503:
1.923 bisitz 6504: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6505: vertical-align: top;
1.777 tempelho 6506: }
1.795 www 6507:
1.716 raeburn 6508: div.LC_createcourse {
1.911 bisitz 6509: margin: 10px 10px 10px 10px;
1.716 raeburn 6510: }
6511:
1.917 raeburn 6512: .LC_dccid {
1.1130 raeburn 6513: float: right;
1.917 raeburn 6514: margin: 0.2em 0 0 0;
6515: padding: 0;
6516: font-size: 90%;
6517: display:none;
6518: }
6519:
1.897 wenzelju 6520: ol.LC_primary_menu a:hover,
1.721 harmsja 6521: ol#LC_MenuBreadcrumbs a:hover,
6522: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6523: ul#LC_secondary_menu a:hover,
1.721 harmsja 6524: .LC_FormSectionClearButton input:hover
1.795 www 6525: ul.LC_TabContent li:hover a {
1.952 onken 6526: color:$button_hover;
1.911 bisitz 6527: text-decoration:none;
1.693 droeschl 6528: }
6529:
1.779 bisitz 6530: h1 {
1.911 bisitz 6531: padding: 0;
6532: line-height:130%;
1.693 droeschl 6533: }
1.698 harmsja 6534:
1.911 bisitz 6535: h2,
6536: h3,
6537: h4,
6538: h5,
6539: h6 {
6540: margin: 5px 0 5px 0;
6541: padding: 0;
6542: line-height:130%;
1.693 droeschl 6543: }
1.795 www 6544:
6545: .LC_hcell {
1.911 bisitz 6546: padding:3px 15px 3px 15px;
6547: margin: 0;
6548: background-color:$tabbg;
6549: color:$fontmenu;
6550: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6551: }
1.795 www 6552:
1.840 bisitz 6553: .LC_Box > .LC_hcell {
1.911 bisitz 6554: margin: 0 -10px 10px -10px;
1.835 bisitz 6555: }
6556:
1.721 harmsja 6557: .LC_noBorder {
1.911 bisitz 6558: border: 0;
1.698 harmsja 6559: }
1.693 droeschl 6560:
1.721 harmsja 6561: .LC_FormSectionClearButton input {
1.911 bisitz 6562: background-color:transparent;
6563: border: none;
6564: cursor:pointer;
6565: text-decoration:underline;
1.693 droeschl 6566: }
1.763 bisitz 6567:
6568: .LC_help_open_topic {
1.911 bisitz 6569: color: #FFFFFF;
6570: background-color: #EEEEFF;
6571: margin: 1px;
6572: padding: 4px;
6573: border: 1px solid #000033;
6574: white-space: nowrap;
6575: /* vertical-align: middle; */
1.759 neumanie 6576: }
1.693 droeschl 6577:
1.911 bisitz 6578: dl,
6579: ul,
6580: div,
6581: fieldset {
6582: margin: 10px 10px 10px 0;
6583: /* overflow: hidden; */
1.693 droeschl 6584: }
1.795 www 6585:
1.838 bisitz 6586: fieldset > legend {
1.911 bisitz 6587: font-weight: bold;
6588: padding: 0 5px 0 5px;
1.838 bisitz 6589: }
6590:
1.813 bisitz 6591: #LC_nav_bar {
1.911 bisitz 6592: float: left;
1.995 raeburn 6593: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6594: margin: 0 0 2px 0;
1.807 droeschl 6595: }
6596:
1.916 droeschl 6597: #LC_realm {
6598: margin: 0.2em 0 0 0;
6599: padding: 0;
6600: font-weight: bold;
6601: text-align: center;
1.995 raeburn 6602: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6603: }
6604:
1.911 bisitz 6605: #LC_nav_bar em {
6606: font-weight: bold;
6607: font-style: normal;
1.807 droeschl 6608: }
6609:
1.897 wenzelju 6610: ol.LC_primary_menu {
1.934 droeschl 6611: margin: 0;
1.1076 raeburn 6612: padding: 0;
1.995 raeburn 6613: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6614: }
6615:
1.852 droeschl 6616: ol#LC_PathBreadcrumbs {
1.911 bisitz 6617: margin: 0;
1.693 droeschl 6618: }
6619:
1.897 wenzelju 6620: ol.LC_primary_menu li {
1.1076 raeburn 6621: color: RGB(80, 80, 80);
6622: vertical-align: middle;
6623: text-align: left;
6624: list-style: none;
6625: float: left;
6626: }
6627:
6628: ol.LC_primary_menu li a {
6629: display: block;
6630: margin: 0;
6631: padding: 0 5px 0 10px;
6632: text-decoration: none;
6633: }
6634:
6635: ol.LC_primary_menu li ul {
6636: display: none;
6637: width: 10em;
6638: background-color: $data_table_light;
6639: }
6640:
6641: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6642: display: block;
6643: position: absolute;
6644: margin: 0;
6645: padding: 0;
1.1078 raeburn 6646: z-index: 2;
1.1076 raeburn 6647: }
6648:
6649: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6650: font-size: 90%;
1.911 bisitz 6651: vertical-align: top;
1.1076 raeburn 6652: float: none;
1.1079 raeburn 6653: border-left: 1px solid black;
6654: border-right: 1px solid black;
1.1076 raeburn 6655: }
6656:
6657: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6658: background-color:$data_table_light;
1.1076 raeburn 6659: }
6660:
6661: ol.LC_primary_menu li li a:hover {
6662: color:$button_hover;
6663: background-color:$data_table_dark;
1.693 droeschl 6664: }
6665:
1.897 wenzelju 6666: ol.LC_primary_menu li img {
1.911 bisitz 6667: vertical-align: bottom;
1.934 droeschl 6668: height: 1.1em;
1.1077 raeburn 6669: margin: 0.2em 0 0 0;
1.693 droeschl 6670: }
6671:
1.897 wenzelju 6672: ol.LC_primary_menu a {
1.911 bisitz 6673: color: RGB(80, 80, 80);
6674: text-decoration: none;
1.693 droeschl 6675: }
1.795 www 6676:
1.949 droeschl 6677: ol.LC_primary_menu a.LC_new_message {
6678: font-weight:bold;
6679: color: darkred;
6680: }
6681:
1.975 raeburn 6682: ol.LC_docs_parameters {
6683: margin-left: 0;
6684: padding: 0;
6685: list-style: none;
6686: }
6687:
6688: ol.LC_docs_parameters li {
6689: margin: 0;
6690: padding-right: 20px;
6691: display: inline;
6692: }
6693:
1.976 raeburn 6694: ol.LC_docs_parameters li:before {
6695: content: "\\002022 \\0020";
6696: }
6697:
6698: li.LC_docs_parameters_title {
6699: font-weight: bold;
6700: }
6701:
6702: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6703: content: "";
6704: }
6705:
1.897 wenzelju 6706: ul#LC_secondary_menu {
1.1107 raeburn 6707: clear: right;
1.911 bisitz 6708: color: $fontmenu;
6709: background: $tabbg;
6710: list-style: none;
6711: padding: 0;
6712: margin: 0;
6713: width: 100%;
1.995 raeburn 6714: text-align: left;
1.1107 raeburn 6715: float: left;
1.808 droeschl 6716: }
6717:
1.897 wenzelju 6718: ul#LC_secondary_menu li {
1.911 bisitz 6719: font-weight: bold;
6720: line-height: 1.8em;
1.1107 raeburn 6721: border-right: 1px solid black;
6722: float: left;
6723: }
6724:
6725: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
6726: background-color: $data_table_light;
6727: }
6728:
6729: ul#LC_secondary_menu li a {
1.911 bisitz 6730: padding: 0 0.8em;
1.1107 raeburn 6731: }
6732:
6733: ul#LC_secondary_menu li ul {
6734: display: none;
6735: }
6736:
6737: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
6738: display: block;
6739: position: absolute;
6740: margin: 0;
6741: padding: 0;
6742: list-style:none;
6743: float: none;
6744: background-color: $data_table_light;
6745: z-index: 2;
6746: margin-left: -1px;
6747: }
6748:
6749: ul#LC_secondary_menu li ul li {
6750: font-size: 90%;
6751: vertical-align: top;
6752: border-left: 1px solid black;
1.911 bisitz 6753: border-right: 1px solid black;
1.1119 raeburn 6754: background-color: $data_table_light;
1.1107 raeburn 6755: list-style:none;
6756: float: none;
6757: }
6758:
6759: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
6760: background-color: $data_table_dark;
1.807 droeschl 6761: }
6762:
1.847 tempelho 6763: ul.LC_TabContent {
1.911 bisitz 6764: display:block;
6765: background: $sidebg;
6766: border-bottom: solid 1px $lg_border_color;
6767: list-style:none;
1.1020 raeburn 6768: margin: -1px -10px 0 -10px;
1.911 bisitz 6769: padding: 0;
1.693 droeschl 6770: }
6771:
1.795 www 6772: ul.LC_TabContent li,
6773: ul.LC_TabContentBigger li {
1.911 bisitz 6774: float:left;
1.741 harmsja 6775: }
1.795 www 6776:
1.897 wenzelju 6777: ul#LC_secondary_menu li a {
1.911 bisitz 6778: color: $fontmenu;
6779: text-decoration: none;
1.693 droeschl 6780: }
1.795 www 6781:
1.721 harmsja 6782: ul.LC_TabContent {
1.952 onken 6783: min-height:20px;
1.721 harmsja 6784: }
1.795 www 6785:
6786: ul.LC_TabContent li {
1.911 bisitz 6787: vertical-align:middle;
1.959 onken 6788: padding: 0 16px 0 10px;
1.911 bisitz 6789: background-color:$tabbg;
6790: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6791: border-left: solid 1px $font;
1.721 harmsja 6792: }
1.795 www 6793:
1.847 tempelho 6794: ul.LC_TabContent .right {
1.911 bisitz 6795: float:right;
1.847 tempelho 6796: }
6797:
1.911 bisitz 6798: ul.LC_TabContent li a,
6799: ul.LC_TabContent li {
6800: color:rgb(47,47,47);
6801: text-decoration:none;
6802: font-size:95%;
6803: font-weight:bold;
1.952 onken 6804: min-height:20px;
6805: }
6806:
1.959 onken 6807: ul.LC_TabContent li a:hover,
6808: ul.LC_TabContent li a:focus {
1.952 onken 6809: color: $button_hover;
1.959 onken 6810: background:none;
6811: outline:none;
1.952 onken 6812: }
6813:
6814: ul.LC_TabContent li:hover {
6815: color: $button_hover;
6816: cursor:pointer;
1.721 harmsja 6817: }
1.795 www 6818:
1.911 bisitz 6819: ul.LC_TabContent li.active {
1.952 onken 6820: color: $font;
1.911 bisitz 6821: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6822: border-bottom:solid 1px #FFFFFF;
6823: cursor: default;
1.744 ehlerst 6824: }
1.795 www 6825:
1.959 onken 6826: ul.LC_TabContent li.active a {
6827: color:$font;
6828: background:#FFFFFF;
6829: outline: none;
6830: }
1.1047 raeburn 6831:
6832: ul.LC_TabContent li.goback {
6833: float: left;
6834: border-left: none;
6835: }
6836:
1.870 tempelho 6837: #maincoursedoc {
1.911 bisitz 6838: clear:both;
1.870 tempelho 6839: }
6840:
6841: ul.LC_TabContentBigger {
1.911 bisitz 6842: display:block;
6843: list-style:none;
6844: padding: 0;
1.870 tempelho 6845: }
6846:
1.795 www 6847: ul.LC_TabContentBigger li {
1.911 bisitz 6848: vertical-align:bottom;
6849: height: 30px;
6850: font-size:110%;
6851: font-weight:bold;
6852: color: #737373;
1.841 tempelho 6853: }
6854:
1.957 onken 6855: ul.LC_TabContentBigger li.active {
6856: position: relative;
6857: top: 1px;
6858: }
6859:
1.870 tempelho 6860: ul.LC_TabContentBigger li a {
1.911 bisitz 6861: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6862: height: 30px;
6863: line-height: 30px;
6864: text-align: center;
6865: display: block;
6866: text-decoration: none;
1.958 onken 6867: outline: none;
1.741 harmsja 6868: }
1.795 www 6869:
1.870 tempelho 6870: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6871: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6872: color:$font;
1.744 ehlerst 6873: }
1.795 www 6874:
1.870 tempelho 6875: ul.LC_TabContentBigger li b {
1.911 bisitz 6876: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6877: display: block;
6878: float: left;
6879: padding: 0 30px;
1.957 onken 6880: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6881: }
6882:
1.956 onken 6883: ul.LC_TabContentBigger li:hover b {
6884: color:$button_hover;
6885: }
6886:
1.870 tempelho 6887: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6888: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6889: color:$font;
1.957 onken 6890: border: 0;
1.741 harmsja 6891: }
1.693 droeschl 6892:
1.870 tempelho 6893:
1.862 bisitz 6894: ul.LC_CourseBreadcrumbs {
6895: background: $sidebg;
1.1020 raeburn 6896: height: 2em;
1.862 bisitz 6897: padding-left: 10px;
1.1020 raeburn 6898: margin: 0;
1.862 bisitz 6899: list-style-position: inside;
6900: }
6901:
1.911 bisitz 6902: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6903: ol#LC_PathBreadcrumbs {
1.911 bisitz 6904: padding-left: 10px;
6905: margin: 0;
1.933 droeschl 6906: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6907: }
6908:
1.911 bisitz 6909: ol#LC_MenuBreadcrumbs li,
6910: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6911: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6912: display: inline;
1.933 droeschl 6913: white-space: normal;
1.693 droeschl 6914: }
6915:
1.823 bisitz 6916: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6917: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6918: text-decoration: none;
6919: font-size:90%;
1.693 droeschl 6920: }
1.795 www 6921:
1.969 droeschl 6922: ol#LC_MenuBreadcrumbs h1 {
6923: display: inline;
6924: font-size: 90%;
6925: line-height: 2.5em;
6926: margin: 0;
6927: padding: 0;
6928: }
6929:
1.795 www 6930: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6931: text-decoration:none;
6932: font-size:100%;
6933: font-weight:bold;
1.693 droeschl 6934: }
1.795 www 6935:
1.840 bisitz 6936: .LC_Box {
1.911 bisitz 6937: border: solid 1px $lg_border_color;
6938: padding: 0 10px 10px 10px;
1.746 neumanie 6939: }
1.795 www 6940:
1.1020 raeburn 6941: .LC_DocsBox {
6942: border: solid 1px $lg_border_color;
6943: padding: 0 0 10px 10px;
6944: }
6945:
1.795 www 6946: .LC_AboutMe_Image {
1.911 bisitz 6947: float:left;
6948: margin-right:10px;
1.747 neumanie 6949: }
1.795 www 6950:
6951: .LC_Clear_AboutMe_Image {
1.911 bisitz 6952: clear:left;
1.747 neumanie 6953: }
1.795 www 6954:
1.721 harmsja 6955: dl.LC_ListStyleClean dt {
1.911 bisitz 6956: padding-right: 5px;
6957: display: table-header-group;
1.693 droeschl 6958: }
6959:
1.721 harmsja 6960: dl.LC_ListStyleClean dd {
1.911 bisitz 6961: display: table-row;
1.693 droeschl 6962: }
6963:
1.721 harmsja 6964: .LC_ListStyleClean,
6965: .LC_ListStyleSimple,
6966: .LC_ListStyleNormal,
1.795 www 6967: .LC_ListStyleSpecial {
1.911 bisitz 6968: /* display:block; */
6969: list-style-position: inside;
6970: list-style-type: none;
6971: overflow: hidden;
6972: padding: 0;
1.693 droeschl 6973: }
6974:
1.721 harmsja 6975: .LC_ListStyleSimple li,
6976: .LC_ListStyleSimple dd,
6977: .LC_ListStyleNormal li,
6978: .LC_ListStyleNormal dd,
6979: .LC_ListStyleSpecial li,
1.795 www 6980: .LC_ListStyleSpecial dd {
1.911 bisitz 6981: margin: 0;
6982: padding: 5px 5px 5px 10px;
6983: clear: both;
1.693 droeschl 6984: }
6985:
1.721 harmsja 6986: .LC_ListStyleClean li,
6987: .LC_ListStyleClean dd {
1.911 bisitz 6988: padding-top: 0;
6989: padding-bottom: 0;
1.693 droeschl 6990: }
6991:
1.721 harmsja 6992: .LC_ListStyleSimple dd,
1.795 www 6993: .LC_ListStyleSimple li {
1.911 bisitz 6994: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6995: }
6996:
1.721 harmsja 6997: .LC_ListStyleSpecial li,
6998: .LC_ListStyleSpecial dd {
1.911 bisitz 6999: list-style-type: none;
7000: background-color: RGB(220, 220, 220);
7001: margin-bottom: 4px;
1.693 droeschl 7002: }
7003:
1.721 harmsja 7004: table.LC_SimpleTable {
1.911 bisitz 7005: margin:5px;
7006: border:solid 1px $lg_border_color;
1.795 www 7007: }
1.693 droeschl 7008:
1.721 harmsja 7009: table.LC_SimpleTable tr {
1.911 bisitz 7010: padding: 0;
7011: border:solid 1px $lg_border_color;
1.693 droeschl 7012: }
1.795 www 7013:
7014: table.LC_SimpleTable thead {
1.911 bisitz 7015: background:rgb(220,220,220);
1.693 droeschl 7016: }
7017:
1.721 harmsja 7018: div.LC_columnSection {
1.911 bisitz 7019: display: block;
7020: clear: both;
7021: overflow: hidden;
7022: margin: 0;
1.693 droeschl 7023: }
7024:
1.721 harmsja 7025: div.LC_columnSection>* {
1.911 bisitz 7026: float: left;
7027: margin: 10px 20px 10px 0;
7028: overflow:hidden;
1.693 droeschl 7029: }
1.721 harmsja 7030:
1.795 www 7031: table em {
1.911 bisitz 7032: font-weight: bold;
7033: font-style: normal;
1.748 schulted 7034: }
1.795 www 7035:
1.779 bisitz 7036: table.LC_tableBrowseRes,
1.795 www 7037: table.LC_tableOfContent {
1.911 bisitz 7038: border:none;
7039: border-spacing: 1px;
7040: padding: 3px;
7041: background-color: #FFFFFF;
7042: font-size: 90%;
1.753 droeschl 7043: }
1.789 droeschl 7044:
1.911 bisitz 7045: table.LC_tableOfContent {
7046: border-collapse: collapse;
1.789 droeschl 7047: }
7048:
1.771 droeschl 7049: table.LC_tableBrowseRes a,
1.768 schulted 7050: table.LC_tableOfContent a {
1.911 bisitz 7051: background-color: transparent;
7052: text-decoration: none;
1.753 droeschl 7053: }
7054:
1.795 www 7055: table.LC_tableOfContent img {
1.911 bisitz 7056: border: none;
7057: height: 1.3em;
7058: vertical-align: text-bottom;
7059: margin-right: 0.3em;
1.753 droeschl 7060: }
1.757 schulted 7061:
1.795 www 7062: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7063: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7064: }
7065:
1.795 www 7066: a#LC_content_toolbar_everything {
1.911 bisitz 7067: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7068: }
7069:
1.795 www 7070: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7071: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7072: }
7073:
1.795 www 7074: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7075: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7076: }
7077:
1.795 www 7078: a#LC_content_toolbar_changefolder {
1.911 bisitz 7079: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7080: }
7081:
1.795 www 7082: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7083: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7084: }
7085:
1.1043 raeburn 7086: a#LC_content_toolbar_edittoplevel {
7087: background-image:url(/res/adm/pages/edittoplevel.gif);
7088: }
7089:
1.795 www 7090: ul#LC_toolbar li a:hover {
1.911 bisitz 7091: background-position: bottom center;
1.757 schulted 7092: }
7093:
1.795 www 7094: ul#LC_toolbar {
1.911 bisitz 7095: padding: 0;
7096: margin: 2px;
7097: list-style:none;
7098: position:relative;
7099: background-color:white;
1.1082 raeburn 7100: overflow: auto;
1.757 schulted 7101: }
7102:
1.795 www 7103: ul#LC_toolbar li {
1.911 bisitz 7104: border:1px solid white;
7105: padding: 0;
7106: margin: 0;
7107: float: left;
7108: display:inline;
7109: vertical-align:middle;
1.1082 raeburn 7110: white-space: nowrap;
1.911 bisitz 7111: }
1.757 schulted 7112:
1.783 amueller 7113:
1.795 www 7114: a.LC_toolbarItem {
1.911 bisitz 7115: display:block;
7116: padding: 0;
7117: margin: 0;
7118: height: 32px;
7119: width: 32px;
7120: color:white;
7121: border: none;
7122: background-repeat:no-repeat;
7123: background-color:transparent;
1.757 schulted 7124: }
7125:
1.915 droeschl 7126: ul.LC_funclist {
7127: margin: 0;
7128: padding: 0.5em 1em 0.5em 0;
7129: }
7130:
1.933 droeschl 7131: ul.LC_funclist > li:first-child {
7132: font-weight:bold;
7133: margin-left:0.8em;
7134: }
7135:
1.915 droeschl 7136: ul.LC_funclist + ul.LC_funclist {
7137: /*
7138: left border as a seperator if we have more than
7139: one list
7140: */
7141: border-left: 1px solid $sidebg;
7142: /*
7143: this hides the left border behind the border of the
7144: outer box if element is wrapped to the next 'line'
7145: */
7146: margin-left: -1px;
7147: }
7148:
1.843 bisitz 7149: ul.LC_funclist li {
1.915 droeschl 7150: display: inline;
1.782 bisitz 7151: white-space: nowrap;
1.915 droeschl 7152: margin: 0 0 0 25px;
7153: line-height: 150%;
1.782 bisitz 7154: }
7155:
1.974 wenzelju 7156: .LC_hidden {
7157: display: none;
7158: }
7159:
1.1030 www 7160: .LCmodal-overlay {
7161: position:fixed;
7162: top:0;
7163: right:0;
7164: bottom:0;
7165: left:0;
7166: height:100%;
7167: width:100%;
7168: margin:0;
7169: padding:0;
7170: background:#999;
7171: opacity:.75;
7172: filter: alpha(opacity=75);
7173: -moz-opacity: 0.75;
7174: z-index:101;
7175: }
7176:
7177: * html .LCmodal-overlay {
7178: position: absolute;
7179: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7180: }
7181:
7182: .LCmodal-window {
7183: position:fixed;
7184: top:50%;
7185: left:50%;
7186: margin:0;
7187: padding:0;
7188: z-index:102;
7189: }
7190:
7191: * html .LCmodal-window {
7192: position:absolute;
7193: }
7194:
7195: .LCclose-window {
7196: position:absolute;
7197: width:32px;
7198: height:32px;
7199: right:8px;
7200: top:8px;
7201: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7202: text-indent:-99999px;
7203: overflow:hidden;
7204: cursor:pointer;
7205: }
7206:
1.1100 raeburn 7207: /*
7208: styles used by TTH when "Default set of options to pass to tth/m
7209: when converting TeX" in course settings has been set
7210:
7211: option passed: -t
7212:
7213: */
7214:
7215: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7216: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7217: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7218: td div.norm {line-height:normal;}
7219:
7220: /*
7221: option passed -y3
7222: */
7223:
7224: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7225: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7226: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7227:
1.343 albertel 7228: END
7229: }
7230:
1.306 albertel 7231: =pod
7232:
7233: =item * &headtag()
7234:
7235: Returns a uniform footer for LON-CAPA web pages.
7236:
1.307 albertel 7237: Inputs: $title - optional title for the head
7238: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7239: $args - optional arguments
1.319 albertel 7240: force_register - if is true call registerurl so the remote is
7241: informed
1.415 albertel 7242: redirect -> array ref of
7243: 1- seconds before redirect occurs
7244: 2- url to redirect to
7245: 3- whether the side effect should occur
1.315 albertel 7246: (side effect of setting
7247: $env{'internal.head.redirect'} to the url
7248: redirected too)
1.352 albertel 7249: domain -> force to color decorate a page for a specific
7250: domain
7251: function -> force usage of a specific rolish color scheme
7252: bgcolor -> override the default page bgcolor
1.460 albertel 7253: no_auto_mt_title
7254: -> prevent &mt()ing the title arg
1.464 albertel 7255:
1.306 albertel 7256: =cut
7257:
7258: sub headtag {
1.313 albertel 7259: my ($title,$head_extra,$args) = @_;
1.306 albertel 7260:
1.363 albertel 7261: my $function = $args->{'function'} || &get_users_function();
7262: my $domain = $args->{'domain'} || &determinedomain();
7263: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7264: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7265: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7266: #time(),
1.418 albertel 7267: $env{'environment.color.timestamp'},
1.363 albertel 7268: $function,$domain,$bgcolor);
7269:
1.369 www 7270: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7271:
1.308 albertel 7272: my $result =
7273: '<head>'.
1.461 albertel 7274: &font_settings();
1.319 albertel 7275:
1.1064 raeburn 7276: my $inhibitprint = &print_suppression();
7277:
1.461 albertel 7278: if (!$args->{'frameset'}) {
7279: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7280: }
1.962 droeschl 7281: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7282: $result .= Apache::lonxml::display_title();
1.319 albertel 7283: }
1.436 albertel 7284: if (!$args->{'no_nav_bar'}
7285: && !$args->{'only_body'}
7286: && !$args->{'frameset'}) {
7287: $result .= &help_menu_js();
1.1032 www 7288: $result.=&modal_window();
1.1038 www 7289: $result.=&togglebox_script();
1.1034 www 7290: $result.=&wishlist_window();
1.1041 www 7291: $result.=&LCprogressbarUpdate_script();
1.1034 www 7292: } else {
7293: if ($args->{'add_modal'}) {
7294: $result.=&modal_window();
7295: }
7296: if ($args->{'add_wishlist'}) {
7297: $result.=&wishlist_window();
7298: }
1.1038 www 7299: if ($args->{'add_togglebox'}) {
7300: $result.=&togglebox_script();
7301: }
1.1041 www 7302: if ($args->{'add_progressbar'}) {
7303: $result.=&LCprogressbarUpdate_script();
7304: }
1.436 albertel 7305: }
1.314 albertel 7306: if (ref($args->{'redirect'})) {
1.414 albertel 7307: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7308: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7309: if (!$inhibit_continue) {
7310: $env{'internal.head.redirect'} = $url;
7311: }
1.313 albertel 7312: $result.=<<ADDMETA
7313: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7314: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7315: ADDMETA
7316: }
1.306 albertel 7317: if (!defined($title)) {
7318: $title = 'The LearningOnline Network with CAPA';
7319: }
1.460 albertel 7320: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7321: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7322: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7323: .$inhibitprint
1.414 albertel 7324: .$head_extra;
1.1137 raeburn 7325: if ($env{'browser.mobile'}) {
7326: $result .= '
7327: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
7328: <meta name="apple-mobile-web-app-capable" content="yes" />';
7329: }
1.962 droeschl 7330: return $result.'</head>';
1.306 albertel 7331: }
7332:
7333: =pod
7334:
1.340 albertel 7335: =item * &font_settings()
7336:
7337: Returns neccessary <meta> to set the proper encoding
7338:
7339: Inputs: none
7340:
7341: =cut
7342:
7343: sub font_settings {
7344: my $headerstring='';
1.647 www 7345: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7346: $headerstring.=
7347: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7348: }
7349: return $headerstring;
7350: }
7351:
1.341 albertel 7352: =pod
7353:
1.1064 raeburn 7354: =item * &print_suppression()
7355:
7356: In course context returns css which causes the body to be blank when media="print",
7357: if printout generation is unavailable for the current resource.
7358:
7359: This could be because:
7360:
7361: (a) printstartdate is in the future
7362:
7363: (b) printenddate is in the past
7364:
7365: (c) there is an active exam block with "printout"
7366: functionality blocked
7367:
7368: Users with pav, pfo or evb privileges are exempt.
7369:
7370: Inputs: none
7371:
7372: =cut
7373:
7374:
7375: sub print_suppression {
7376: my $noprint;
7377: if ($env{'request.course.id'}) {
7378: my $scope = $env{'request.course.id'};
7379: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7380: (&Apache::lonnet::allowed('pfo',$scope))) {
7381: return;
7382: }
7383: if ($env{'request.course.sec'} ne '') {
7384: $scope .= "/$env{'request.course.sec'}";
7385: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7386: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7387: return;
1.1064 raeburn 7388: }
7389: }
7390: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7391: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7392: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7393: if ($blocked) {
7394: my $checkrole = "cm./$cdom/$cnum";
7395: if ($env{'request.course.sec'} ne '') {
7396: $checkrole .= "/$env{'request.course.sec'}";
7397: }
7398: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7399: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7400: $noprint = 1;
7401: }
7402: }
7403: unless ($noprint) {
7404: my $symb = &Apache::lonnet::symbread();
7405: if ($symb ne '') {
7406: my $navmap = Apache::lonnavmaps::navmap->new();
7407: if (ref($navmap)) {
7408: my $res = $navmap->getBySymb($symb);
7409: if (ref($res)) {
7410: if (!$res->resprintable()) {
7411: $noprint = 1;
7412: }
7413: }
7414: }
7415: }
7416: }
7417: if ($noprint) {
7418: return <<"ENDSTYLE";
7419: <style type="text/css" media="print">
7420: body { display:none }
7421: </style>
7422: ENDSTYLE
7423: }
7424: }
7425: return;
7426: }
7427:
7428: =pod
7429:
1.341 albertel 7430: =item * &xml_begin()
7431:
7432: Returns the needed doctype and <html>
7433:
7434: Inputs: none
7435:
7436: =cut
7437:
7438: sub xml_begin {
7439: my $output='';
7440:
7441: if ($env{'browser.mathml'}) {
7442: $output='<?xml version="1.0"?>'
7443: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7444: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7445:
7446: # .'<!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">] >'
7447: .'<!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">'
7448: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7449: .'xmlns="http://www.w3.org/1999/xhtml">';
7450: } else {
1.849 bisitz 7451: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7452: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7453: }
7454: return $output;
7455: }
1.340 albertel 7456:
7457: =pod
7458:
1.306 albertel 7459: =item * &start_page()
7460:
7461: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7462:
1.648 raeburn 7463: Inputs:
7464:
7465: =over 4
7466:
7467: $title - optional title for the page
7468:
7469: $head_extra - optional extra HTML to incude inside the <head>
7470:
7471: $args - additional optional args supported are:
7472:
7473: =over 8
7474:
7475: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7476: arg on
1.814 bisitz 7477: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7478: add_entries -> additional attributes to add to the <body>
7479: domain -> force to color decorate a page for a
1.317 albertel 7480: specific domain
1.648 raeburn 7481: function -> force usage of a specific rolish color
1.317 albertel 7482: scheme
1.648 raeburn 7483: redirect -> see &headtag()
7484: bgcolor -> override the default page bg color
7485: js_ready -> return a string ready for being used in
1.317 albertel 7486: a javascript writeln
1.648 raeburn 7487: html_encode -> return a string ready for being used in
1.320 albertel 7488: a html attribute
1.648 raeburn 7489: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7490: $forcereg arg
1.648 raeburn 7491: frameset -> if true will start with a <frameset>
1.330 albertel 7492: rather than <body>
1.648 raeburn 7493: skip_phases -> hash ref of
1.338 albertel 7494: head -> skip the <html><head> generation
7495: body -> skip all <body> generation
1.648 raeburn 7496: no_auto_mt_title -> prevent &mt()ing the title arg
7497: inherit_jsmath -> when creating popup window in a page,
7498: should it have jsmath forced on by the
7499: current page
1.867 kalberla 7500: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7501: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 raeburn 7502: group -> includes the current group, if page is for a
7503: specific group
1.361 albertel 7504:
1.648 raeburn 7505: =back
1.460 albertel 7506:
1.648 raeburn 7507: =back
1.562 albertel 7508:
1.306 albertel 7509: =cut
7510:
7511: sub start_page {
1.309 albertel 7512: my ($title,$head_extra,$args) = @_;
1.318 albertel 7513: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7514:
1.315 albertel 7515: $env{'internal.start_page'}++;
1.1096 raeburn 7516: my ($result,@advtools);
1.964 droeschl 7517:
1.338 albertel 7518: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7519: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7520: }
7521:
7522: if (! exists($args->{'skip_phases'}{'body'}) ) {
7523: if ($args->{'frameset'}) {
7524: my $attr_string = &make_attr_string($args->{'force_register'},
7525: $args->{'add_entries'});
7526: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7527: } else {
7528: $result .=
7529: &bodytag($title,
7530: $args->{'function'}, $args->{'add_entries'},
7531: $args->{'only_body'}, $args->{'domain'},
7532: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 7533: $args->{'bgcolor'}, $args,
7534: \@advtools);
1.831 bisitz 7535: }
1.330 albertel 7536: }
1.338 albertel 7537:
1.315 albertel 7538: if ($args->{'js_ready'}) {
1.713 kaisler 7539: $result = &js_ready($result);
1.315 albertel 7540: }
1.320 albertel 7541: if ($args->{'html_encode'}) {
1.713 kaisler 7542: $result = &html_encode($result);
7543: }
7544:
1.813 bisitz 7545: # Preparation for new and consistent functionlist at top of screen
7546: # if ($args->{'functionlist'}) {
7547: # $result .= &build_functionlist();
7548: #}
7549:
1.964 droeschl 7550: # Don't add anything more if only_body wanted or in const space
7551: return $result if $args->{'only_body'}
7552: || $env{'request.state'} eq 'construct';
1.813 bisitz 7553:
7554: #Breadcrumbs
1.758 kaisler 7555: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7556: &Apache::lonhtmlcommon::clear_breadcrumbs();
7557: #if any br links exists, add them to the breadcrumbs
7558: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7559: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7560: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7561: }
7562: }
1.1096 raeburn 7563: # if @advtools array contains items add then to the breadcrumbs
7564: if (@advtools > 0) {
7565: &Apache::lonmenu::advtools_crumbs(@advtools);
7566: }
1.758 kaisler 7567:
7568: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7569: if(exists($args->{'bread_crumbs_component'})){
7570: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7571: }else{
7572: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7573: }
1.320 albertel 7574: }
1.315 albertel 7575: return $result;
1.306 albertel 7576: }
7577:
7578: sub end_page {
1.315 albertel 7579: my ($args) = @_;
7580: $env{'internal.end_page'}++;
1.330 albertel 7581: my $result;
1.335 albertel 7582: if ($args->{'discussion'}) {
7583: my ($target,$parser);
7584: if (ref($args->{'discussion'})) {
7585: ($target,$parser) =($args->{'discussion'}{'target'},
7586: $args->{'discussion'}{'parser'});
7587: }
7588: $result .= &Apache::lonxml::xmlend($target,$parser);
7589: }
1.330 albertel 7590: if ($args->{'frameset'}) {
7591: $result .= '</frameset>';
7592: } else {
1.635 raeburn 7593: $result .= &endbodytag($args);
1.330 albertel 7594: }
1.1080 raeburn 7595: unless ($args->{'notbody'}) {
7596: $result .= "\n</html>";
7597: }
1.330 albertel 7598:
1.315 albertel 7599: if ($args->{'js_ready'}) {
1.317 albertel 7600: $result = &js_ready($result);
1.315 albertel 7601: }
1.335 albertel 7602:
1.320 albertel 7603: if ($args->{'html_encode'}) {
7604: $result = &html_encode($result);
7605: }
1.335 albertel 7606:
1.315 albertel 7607: return $result;
7608: }
7609:
1.1034 www 7610: sub wishlist_window {
7611: return(<<'ENDWISHLIST');
1.1046 raeburn 7612: <script type="text/javascript">
1.1034 www 7613: // <![CDATA[
7614: // <!-- BEGIN LON-CAPA Internal
7615: function set_wishlistlink(title, path) {
7616: if (!title) {
7617: title = document.title;
7618: title = title.replace(/^LON-CAPA /,'');
7619: }
7620: if (!path) {
7621: path = location.pathname;
7622: }
7623: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7624: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7625: }
7626: // END LON-CAPA Internal -->
7627: // ]]>
7628: </script>
7629: ENDWISHLIST
7630: }
7631:
1.1030 www 7632: sub modal_window {
7633: return(<<'ENDMODAL');
1.1046 raeburn 7634: <script type="text/javascript">
1.1030 www 7635: // <![CDATA[
7636: // <!-- BEGIN LON-CAPA Internal
7637: var modalWindow = {
7638: parent:"body",
7639: windowId:null,
7640: content:null,
7641: width:null,
7642: height:null,
7643: close:function()
7644: {
7645: $(".LCmodal-window").remove();
7646: $(".LCmodal-overlay").remove();
7647: },
7648: open:function()
7649: {
7650: var modal = "";
7651: modal += "<div class=\"LCmodal-overlay\"></div>";
7652: 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;\">";
7653: modal += this.content;
7654: modal += "</div>";
7655:
7656: $(this.parent).append(modal);
7657:
7658: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7659: $(".LCclose-window").click(function(){modalWindow.close();});
7660: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7661: }
7662: };
1.1140 raeburn 7663: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 7664: {
7665: modalWindow.windowId = "myModal";
7666: modalWindow.width = width;
7667: modalWindow.height = height;
1.1140 raeburn 7668: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 7669: modalWindow.open();
7670: };
7671: // END LON-CAPA Internal -->
7672: // ]]>
7673: </script>
7674: ENDMODAL
7675: }
7676:
7677: sub modal_link {
1.1140 raeburn 7678: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 7679: unless ($width) { $width=480; }
7680: unless ($height) { $height=400; }
1.1031 www 7681: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 7682: unless ($transparency) { $transparency='true'; }
7683:
1.1074 raeburn 7684: my $target_attr;
7685: if (defined($target)) {
7686: $target_attr = 'target="'.$target.'"';
7687: }
7688: return <<"ENDLINK";
1.1140 raeburn 7689: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074 raeburn 7690: $linktext</a>
7691: ENDLINK
1.1030 www 7692: }
7693:
1.1032 www 7694: sub modal_adhoc_script {
7695: my ($funcname,$width,$height,$content)=@_;
7696: return (<<ENDADHOC);
1.1046 raeburn 7697: <script type="text/javascript">
1.1032 www 7698: // <![CDATA[
7699: var $funcname = function()
7700: {
7701: modalWindow.windowId = "myModal";
7702: modalWindow.width = $width;
7703: modalWindow.height = $height;
7704: modalWindow.content = '$content';
7705: modalWindow.open();
7706: };
7707: // ]]>
7708: </script>
7709: ENDADHOC
7710: }
7711:
1.1041 www 7712: sub modal_adhoc_inner {
7713: my ($funcname,$width,$height,$content)=@_;
7714: my $innerwidth=$width-20;
7715: $content=&js_ready(
1.1140 raeburn 7716: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
7717: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
7718: $content.
1.1041 www 7719: &end_scrollbox().
1.1140 raeburn 7720: &end_page()
1.1041 www 7721: );
7722: return &modal_adhoc_script($funcname,$width,$height,$content);
7723: }
7724:
7725: sub modal_adhoc_window {
7726: my ($funcname,$width,$height,$content,$linktext)=@_;
7727: return &modal_adhoc_inner($funcname,$width,$height,$content).
7728: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7729: }
7730:
7731: sub modal_adhoc_launch {
7732: my ($funcname,$width,$height,$content)=@_;
7733: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7734: <script type="text/javascript">
7735: // <![CDATA[
7736: $funcname();
7737: // ]]>
7738: </script>
7739: ENDLAUNCH
7740: }
7741:
7742: sub modal_adhoc_close {
7743: return (<<ENDCLOSE);
7744: <script type="text/javascript">
7745: // <![CDATA[
7746: modalWindow.close();
7747: // ]]>
7748: </script>
7749: ENDCLOSE
7750: }
7751:
1.1038 www 7752: sub togglebox_script {
7753: return(<<ENDTOGGLE);
7754: <script type="text/javascript">
7755: // <![CDATA[
7756: function LCtoggleDisplay(id,hidetext,showtext) {
7757: link = document.getElementById(id + "link").childNodes[0];
7758: with (document.getElementById(id).style) {
7759: if (display == "none" ) {
7760: display = "inline";
7761: link.nodeValue = hidetext;
7762: } else {
7763: display = "none";
7764: link.nodeValue = showtext;
7765: }
7766: }
7767: }
7768: // ]]>
7769: </script>
7770: ENDTOGGLE
7771: }
7772:
1.1039 www 7773: sub start_togglebox {
7774: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7775: unless ($heading) { $heading=''; } else { $heading.=' '; }
7776: unless ($showtext) { $showtext=&mt('show'); }
7777: unless ($hidetext) { $hidetext=&mt('hide'); }
7778: unless ($headerbg) { $headerbg='#FFFFFF'; }
7779: return &start_data_table().
7780: &start_data_table_header_row().
7781: '<td bgcolor="'.$headerbg.'">'.$heading.
7782: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7783: $showtext.'\')">'.$showtext.'</a>]</td>'.
7784: &end_data_table_header_row().
7785: '<tr id="'.$id.'" style="display:none""><td>';
7786: }
7787:
7788: sub end_togglebox {
7789: return '</td></tr>'.&end_data_table();
7790: }
7791:
1.1041 www 7792: sub LCprogressbar_script {
1.1045 www 7793: my ($id)=@_;
1.1041 www 7794: return(<<ENDPROGRESS);
7795: <script type="text/javascript">
7796: // <![CDATA[
1.1045 www 7797: \$('#progressbar$id').progressbar({
1.1041 www 7798: value: 0,
7799: change: function(event, ui) {
7800: var newVal = \$(this).progressbar('option', 'value');
7801: \$('.pblabel', this).text(LCprogressTxt);
7802: }
7803: });
7804: // ]]>
7805: </script>
7806: ENDPROGRESS
7807: }
7808:
7809: sub LCprogressbarUpdate_script {
7810: return(<<ENDPROGRESSUPDATE);
7811: <style type="text/css">
7812: .ui-progressbar { position:relative; }
7813: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7814: </style>
7815: <script type="text/javascript">
7816: // <![CDATA[
1.1045 www 7817: var LCprogressTxt='---';
7818:
7819: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7820: LCprogressTxt=progresstext;
1.1045 www 7821: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7822: }
7823: // ]]>
7824: </script>
7825: ENDPROGRESSUPDATE
7826: }
7827:
1.1042 www 7828: my $LClastpercent;
1.1045 www 7829: my $LCidcnt;
7830: my $LCcurrentid;
1.1042 www 7831:
1.1041 www 7832: sub LCprogressbar {
1.1042 www 7833: my ($r)=(@_);
7834: $LClastpercent=0;
1.1045 www 7835: $LCidcnt++;
7836: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7837: my $starting=&mt('Starting');
7838: my $content=(<<ENDPROGBAR);
1.1045 www 7839: <div id="progressbar$LCcurrentid">
1.1041 www 7840: <span class="pblabel">$starting</span>
7841: </div>
7842: ENDPROGBAR
1.1045 www 7843: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7844: }
7845:
7846: sub LCprogressbarUpdate {
1.1042 www 7847: my ($r,$val,$text)=@_;
7848: unless ($val) {
7849: if ($LClastpercent) {
7850: $val=$LClastpercent;
7851: } else {
7852: $val=0;
7853: }
7854: }
1.1041 www 7855: if ($val<0) { $val=0; }
7856: if ($val>100) { $val=0; }
1.1042 www 7857: $LClastpercent=$val;
1.1041 www 7858: unless ($text) { $text=$val.'%'; }
7859: $text=&js_ready($text);
1.1044 www 7860: &r_print($r,<<ENDUPDATE);
1.1041 www 7861: <script type="text/javascript">
7862: // <![CDATA[
1.1045 www 7863: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7864: // ]]>
7865: </script>
7866: ENDUPDATE
1.1035 www 7867: }
7868:
1.1042 www 7869: sub LCprogressbarClose {
7870: my ($r)=@_;
7871: $LClastpercent=0;
1.1044 www 7872: &r_print($r,<<ENDCLOSE);
1.1042 www 7873: <script type="text/javascript">
7874: // <![CDATA[
1.1045 www 7875: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7876: // ]]>
7877: </script>
7878: ENDCLOSE
1.1044 www 7879: }
7880:
7881: sub r_print {
7882: my ($r,$to_print)=@_;
7883: if ($r) {
7884: $r->print($to_print);
7885: $r->rflush();
7886: } else {
7887: print($to_print);
7888: }
1.1042 www 7889: }
7890:
1.320 albertel 7891: sub html_encode {
7892: my ($result) = @_;
7893:
1.322 albertel 7894: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7895:
7896: return $result;
7897: }
1.1044 www 7898:
1.317 albertel 7899: sub js_ready {
7900: my ($result) = @_;
7901:
1.323 albertel 7902: $result =~ s/[\n\r]/ /xmsg;
7903: $result =~ s/\\/\\\\/xmsg;
7904: $result =~ s/'/\\'/xmsg;
1.372 albertel 7905: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7906:
7907: return $result;
7908: }
7909:
1.315 albertel 7910: sub validate_page {
7911: if ( exists($env{'internal.start_page'})
1.316 albertel 7912: && $env{'internal.start_page'} > 1) {
7913: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7914: $env{'internal.start_page'}.' '.
1.316 albertel 7915: $ENV{'request.filename'});
1.315 albertel 7916: }
7917: if ( exists($env{'internal.end_page'})
1.316 albertel 7918: && $env{'internal.end_page'} > 1) {
7919: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7920: $env{'internal.end_page'}.' '.
1.316 albertel 7921: $env{'request.filename'});
1.315 albertel 7922: }
7923: if ( exists($env{'internal.start_page'})
7924: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7925: &Apache::lonnet::logthis('start_page called without end_page '.
7926: $env{'request.filename'});
1.315 albertel 7927: }
7928: if ( ! exists($env{'internal.start_page'})
7929: && exists($env{'internal.end_page'})) {
1.316 albertel 7930: &Apache::lonnet::logthis('end_page called without start_page'.
7931: $env{'request.filename'});
1.315 albertel 7932: }
1.306 albertel 7933: }
1.315 albertel 7934:
1.996 www 7935:
7936: sub start_scrollbox {
1.1140 raeburn 7937: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 7938: unless ($outerwidth) { $outerwidth='520px'; }
7939: unless ($width) { $width='500px'; }
7940: unless ($height) { $height='200px'; }
1.1075 raeburn 7941: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7942: if ($id ne '') {
1.1140 raeburn 7943: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 7944: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 7945: }
1.1075 raeburn 7946: if ($bgcolor ne '') {
7947: $tdcol = "background-color: $bgcolor;";
7948: }
1.1137 raeburn 7949: my $nicescroll_js;
7950: if ($env{'browser.mobile'}) {
1.1140 raeburn 7951: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
7952: }
7953: return <<"END";
7954: $nicescroll_js
7955:
7956: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
7957: <div style="overflow:auto; width:$width; height:$height;"$div_id>
7958: END
7959: }
7960:
7961: sub end_scrollbox {
7962: return '</div></td></tr></table>';
7963: }
7964:
7965: sub nicescroll_javascript {
7966: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
7967: my %options;
7968: if (ref($cursor) eq 'HASH') {
7969: %options = %{$cursor};
7970: }
7971: unless ($options{'railalign'} =~ /^left|right$/) {
7972: $options{'railalign'} = 'left';
7973: }
7974: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
7975: my $function = &get_users_function();
7976: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 7977: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 7978: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 7979: }
1.1140 raeburn 7980: }
7981: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
7982: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 7983: $options{'cursoropacity'}='1.0';
7984: }
1.1140 raeburn 7985: } else {
7986: $options{'cursoropacity'}='1.0';
7987: }
7988: if ($options{'cursorfixedheight'} eq 'none') {
7989: delete($options{'cursorfixedheight'});
7990: } else {
7991: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
7992: }
7993: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
7994: delete($options{'railoffset'});
7995: }
7996: my @niceoptions;
7997: while (my($key,$value) = each(%options)) {
7998: if ($value =~ /^\{.+\}$/) {
7999: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 8000: } else {
1.1140 raeburn 8001: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 8002: }
1.1140 raeburn 8003: }
8004: my $nicescroll_js = '
1.1137 raeburn 8005: $(document).ready(
1.1140 raeburn 8006: function() {
8007: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
8008: }
1.1137 raeburn 8009: );
8010: ';
1.1140 raeburn 8011: if ($framecheck) {
8012: $nicescroll_js .= '
8013: function expand_div(caller) {
8014: if (top === self) {
8015: document.getElementById("'.$id.'").style.width = "auto";
8016: document.getElementById("'.$id.'").style.height = "auto";
8017: } else {
8018: try {
8019: if (parent.frames) {
8020: if (parent.frames.length > 1) {
8021: var framesrc = parent.frames[1].location.href;
8022: var currsrc = framesrc.replace(/\#.*$/,"");
8023: if ((caller == "search") || (currsrc == "'.$location.'")) {
8024: document.getElementById("'.$id.'").style.width = "auto";
8025: document.getElementById("'.$id.'").style.height = "auto";
8026: }
8027: }
8028: }
8029: } catch (e) {
8030: return;
8031: }
1.1137 raeburn 8032: }
1.1140 raeburn 8033: return;
1.996 www 8034: }
1.1140 raeburn 8035: ';
8036: }
8037: if ($needjsready) {
8038: $nicescroll_js = '
8039: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
8040: } else {
8041: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
8042: }
8043: return $nicescroll_js;
1.996 www 8044: }
8045:
1.318 albertel 8046: sub simple_error_page {
1.1150 bisitz 8047: my ($r,$title,$msg,$args) = @_;
1.1151 ! raeburn 8048: if (ref($args) eq 'HASH') {
! 8049: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
! 8050: } else {
! 8051: $msg = &mt($msg);
! 8052: }
1.1150 bisitz 8053:
1.318 albertel 8054: my $page =
8055: &Apache::loncommon::start_page($title).
1.1150 bisitz 8056: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 8057: &Apache::loncommon::end_page();
8058: if (ref($r)) {
8059: $r->print($page);
1.327 albertel 8060: return;
1.318 albertel 8061: }
8062: return $page;
8063: }
1.347 albertel 8064:
8065: {
1.610 albertel 8066: my @row_count;
1.961 onken 8067:
8068: sub start_data_table_count {
8069: unshift(@row_count, 0);
8070: return;
8071: }
8072:
8073: sub end_data_table_count {
8074: shift(@row_count);
8075: return;
8076: }
8077:
1.347 albertel 8078: sub start_data_table {
1.1018 raeburn 8079: my ($add_class,$id) = @_;
1.422 albertel 8080: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 8081: my $table_id;
8082: if (defined($id)) {
8083: $table_id = ' id="'.$id.'"';
8084: }
1.961 onken 8085: &start_data_table_count();
1.1018 raeburn 8086: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 8087: }
8088:
8089: sub end_data_table {
1.961 onken 8090: &end_data_table_count();
1.389 albertel 8091: return '</table>'."\n";;
1.347 albertel 8092: }
8093:
8094: sub start_data_table_row {
1.974 wenzelju 8095: my ($add_class, $id) = @_;
1.610 albertel 8096: $row_count[0]++;
8097: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 8098: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 8099: $id = (' id="'.$id.'"') unless ($id eq '');
8100: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 8101: }
1.471 banghart 8102:
8103: sub continue_data_table_row {
1.974 wenzelju 8104: my ($add_class, $id) = @_;
1.610 albertel 8105: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 8106: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
8107: $id = (' id="'.$id.'"') unless ($id eq '');
8108: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 8109: }
1.347 albertel 8110:
8111: sub end_data_table_row {
1.389 albertel 8112: return '</tr>'."\n";;
1.347 albertel 8113: }
1.367 www 8114:
1.421 albertel 8115: sub start_data_table_empty_row {
1.707 bisitz 8116: # $row_count[0]++;
1.421 albertel 8117: return '<tr class="LC_empty_row" >'."\n";;
8118: }
8119:
8120: sub end_data_table_empty_row {
8121: return '</tr>'."\n";;
8122: }
8123:
1.367 www 8124: sub start_data_table_header_row {
1.389 albertel 8125: return '<tr class="LC_header_row">'."\n";;
1.367 www 8126: }
8127:
8128: sub end_data_table_header_row {
1.389 albertel 8129: return '</tr>'."\n";;
1.367 www 8130: }
1.890 droeschl 8131:
8132: sub data_table_caption {
8133: my $caption = shift;
8134: return "<caption class=\"LC_caption\">$caption</caption>";
8135: }
1.347 albertel 8136: }
8137:
1.548 albertel 8138: =pod
8139:
8140: =item * &inhibit_menu_check($arg)
8141:
8142: Checks for a inhibitmenu state and generates output to preserve it
8143:
8144: Inputs: $arg - can be any of
8145: - undef - in which case the return value is a string
8146: to add into arguments list of a uri
8147: - 'input' - in which case the return value is a HTML
8148: <form> <input> field of type hidden to
8149: preserve the value
8150: - a url - in which case the return value is the url with
8151: the neccesary cgi args added to preserve the
8152: inhibitmenu state
8153: - a ref to a url - no return value, but the string is
8154: updated to include the neccessary cgi
8155: args to preserve the inhibitmenu state
8156:
8157: =cut
8158:
8159: sub inhibit_menu_check {
8160: my ($arg) = @_;
8161: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
8162: if ($arg eq 'input') {
8163: if ($env{'form.inhibitmenu'}) {
8164: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
8165: } else {
8166: return
8167: }
8168: }
8169: if ($env{'form.inhibitmenu'}) {
8170: if (ref($arg)) {
8171: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8172: } elsif ($arg eq '') {
8173: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
8174: } else {
8175: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
8176: }
8177: }
8178: if (!ref($arg)) {
8179: return $arg;
8180: }
8181: }
8182:
1.251 albertel 8183: ###############################################
1.182 matthew 8184:
8185: =pod
8186:
1.549 albertel 8187: =back
8188:
8189: =head1 User Information Routines
8190:
8191: =over 4
8192:
1.405 albertel 8193: =item * &get_users_function()
1.182 matthew 8194:
8195: Used by &bodytag to determine the current users primary role.
8196: Returns either 'student','coordinator','admin', or 'author'.
8197:
8198: =cut
8199:
8200: ###############################################
8201: sub get_users_function {
1.815 tempelho 8202: my $function = 'norole';
1.818 tempelho 8203: if ($env{'request.role'}=~/^(st)/) {
8204: $function='student';
8205: }
1.907 raeburn 8206: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8207: $function='coordinator';
8208: }
1.258 albertel 8209: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8210: $function='admin';
8211: }
1.826 bisitz 8212: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8213: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8214: $function='author';
8215: }
8216: return $function;
1.54 www 8217: }
1.99 www 8218:
8219: ###############################################
8220:
1.233 raeburn 8221: =pod
8222:
1.821 raeburn 8223: =item * &show_course()
8224:
8225: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8226: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8227:
8228: Inputs:
8229: None
8230:
8231: Outputs:
8232: Scalar: 1 if 'Course' to be used, 0 otherwise.
8233:
8234: =cut
8235:
8236: ###############################################
8237: sub show_course {
8238: my $course = !$env{'user.adv'};
8239: if (!$env{'user.adv'}) {
8240: foreach my $env (keys(%env)) {
8241: next if ($env !~ m/^user\.priv\./);
8242: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8243: $course = 0;
8244: last;
8245: }
8246: }
8247: }
8248: return $course;
8249: }
8250:
8251: ###############################################
8252:
8253: =pod
8254:
1.542 raeburn 8255: =item * &check_user_status()
1.274 raeburn 8256:
8257: Determines current status of supplied role for a
8258: specific user. Roles can be active, previous or future.
8259:
8260: Inputs:
8261: user's domain, user's username, course's domain,
1.375 raeburn 8262: course's number, optional section ID.
1.274 raeburn 8263:
8264: Outputs:
8265: role status: active, previous or future.
8266:
8267: =cut
8268:
8269: sub check_user_status {
1.412 raeburn 8270: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8271: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8272: my @uroles = keys %userinfo;
8273: my $srchstr;
8274: my $active_chk = 'none';
1.412 raeburn 8275: my $now = time;
1.274 raeburn 8276: if (@uroles > 0) {
1.908 raeburn 8277: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8278: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8279: } else {
1.412 raeburn 8280: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8281: }
8282: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8283: my $role_end = 0;
8284: my $role_start = 0;
8285: $active_chk = 'active';
1.412 raeburn 8286: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8287: $role_end = $1;
8288: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8289: $role_start = $1;
1.274 raeburn 8290: }
8291: }
8292: if ($role_start > 0) {
1.412 raeburn 8293: if ($now < $role_start) {
1.274 raeburn 8294: $active_chk = 'future';
8295: }
8296: }
8297: if ($role_end > 0) {
1.412 raeburn 8298: if ($now > $role_end) {
1.274 raeburn 8299: $active_chk = 'previous';
8300: }
8301: }
8302: }
8303: }
8304: return $active_chk;
8305: }
8306:
8307: ###############################################
8308:
8309: =pod
8310:
1.405 albertel 8311: =item * &get_sections()
1.233 raeburn 8312:
8313: Determines all the sections for a course including
8314: sections with students and sections containing other roles.
1.419 raeburn 8315: Incoming parameters:
8316:
8317: 1. domain
8318: 2. course number
8319: 3. reference to array containing roles for which sections should
8320: be gathered (optional).
8321: 4. reference to array containing status types for which sections
8322: should be gathered (optional).
8323:
8324: If the third argument is undefined, sections are gathered for any role.
8325: If the fourth argument is undefined, sections are gathered for any status.
8326: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8327:
1.374 raeburn 8328: Returns section hash (keys are section IDs, values are
8329: number of users in each section), subject to the
1.419 raeburn 8330: optional roles filter, optional status filter
1.233 raeburn 8331:
8332: =cut
8333:
8334: ###############################################
8335: sub get_sections {
1.419 raeburn 8336: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8337: if (!defined($cdom) || !defined($cnum)) {
8338: my $cid = $env{'request.course.id'};
8339:
8340: return if (!defined($cid));
8341:
8342: $cdom = $env{'course.'.$cid.'.domain'};
8343: $cnum = $env{'course.'.$cid.'.num'};
8344: }
8345:
8346: my %sectioncount;
1.419 raeburn 8347: my $now = time;
1.240 albertel 8348:
1.1118 raeburn 8349: my $check_students = 1;
8350: my $only_students = 0;
8351: if (ref($possible_roles) eq 'ARRAY') {
8352: if (grep(/^st$/,@{$possible_roles})) {
8353: if (@{$possible_roles} == 1) {
8354: $only_students = 1;
8355: }
8356: } else {
8357: $check_students = 0;
8358: }
8359: }
8360:
8361: if ($check_students) {
1.276 albertel 8362: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8363: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8364: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8365: my $start_index = &Apache::loncoursedata::CL_START();
8366: my $end_index = &Apache::loncoursedata::CL_END();
8367: my $status;
1.366 albertel 8368: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8369: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8370: $data->[$status_index],
8371: $data->[$start_index],
8372: $data->[$end_index]);
8373: if ($stu_status eq 'Active') {
8374: $status = 'active';
8375: } elsif ($end < $now) {
8376: $status = 'previous';
8377: } elsif ($start > $now) {
8378: $status = 'future';
8379: }
8380: if ($section ne '-1' && $section !~ /^\s*$/) {
8381: if ((!defined($possible_status)) || (($status ne '') &&
8382: (grep/^\Q$status\E$/,@{$possible_status}))) {
8383: $sectioncount{$section}++;
8384: }
1.240 albertel 8385: }
8386: }
8387: }
1.1118 raeburn 8388: if ($only_students) {
8389: return %sectioncount;
8390: }
1.240 albertel 8391: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8392: foreach my $user (sort(keys(%courseroles))) {
8393: if ($user !~ /^(\w{2})/) { next; }
8394: my ($role) = ($user =~ /^(\w{2})/);
8395: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8396: my ($section,$status);
1.240 albertel 8397: if ($role eq 'cr' &&
8398: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8399: $section=$1;
8400: }
8401: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8402: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8403: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8404: if ($end == -1 && $start == -1) {
8405: next; #deleted role
8406: }
8407: if (!defined($possible_status)) {
8408: $sectioncount{$section}++;
8409: } else {
8410: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8411: $status = 'active';
8412: } elsif ($end < $now) {
8413: $status = 'future';
8414: } elsif ($start > $now) {
8415: $status = 'previous';
8416: }
8417: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8418: $sectioncount{$section}++;
8419: }
8420: }
1.233 raeburn 8421: }
1.366 albertel 8422: return %sectioncount;
1.233 raeburn 8423: }
8424:
1.274 raeburn 8425: ###############################################
1.294 raeburn 8426:
8427: =pod
1.405 albertel 8428:
8429: =item * &get_course_users()
8430:
1.275 raeburn 8431: Retrieves usernames:domains for users in the specified course
8432: with specific role(s), and access status.
8433:
8434: Incoming parameters:
1.277 albertel 8435: 1. course domain
8436: 2. course number
8437: 3. access status: users must have - either active,
1.275 raeburn 8438: previous, future, or all.
1.277 albertel 8439: 4. reference to array of permissible roles
1.288 raeburn 8440: 5. reference to array of section restrictions (optional)
8441: 6. reference to results object (hash of hashes).
8442: 7. reference to optional userdata hash
1.609 raeburn 8443: 8. reference to optional statushash
1.630 raeburn 8444: 9. flag if privileged users (except those set to unhide in
8445: course settings) should be excluded
1.609 raeburn 8446: Keys of top level results hash are roles.
1.275 raeburn 8447: Keys of inner hashes are username:domain, with
8448: values set to access type.
1.288 raeburn 8449: Optional userdata hash returns an array with arguments in the
8450: same order as loncoursedata::get_classlist() for student data.
8451:
1.609 raeburn 8452: Optional statushash returns
8453:
1.288 raeburn 8454: Entries for end, start, section and status are blank because
8455: of the possibility of multiple values for non-student roles.
8456:
1.275 raeburn 8457: =cut
1.405 albertel 8458:
1.275 raeburn 8459: ###############################################
1.405 albertel 8460:
1.275 raeburn 8461: sub get_course_users {
1.630 raeburn 8462: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8463: my %idx = ();
1.419 raeburn 8464: my %seclists;
1.288 raeburn 8465:
8466: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8467: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8468: $idx{end} = &Apache::loncoursedata::CL_END();
8469: $idx{start} = &Apache::loncoursedata::CL_START();
8470: $idx{id} = &Apache::loncoursedata::CL_ID();
8471: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8472: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8473: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8474:
1.290 albertel 8475: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8476: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8477: my $now = time;
1.277 albertel 8478: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8479: my $match = 0;
1.412 raeburn 8480: my $secmatch = 0;
1.419 raeburn 8481: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8482: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8483: if ($section eq '') {
8484: $section = 'none';
8485: }
1.291 albertel 8486: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8487: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8488: $secmatch = 1;
8489: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8490: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8491: $secmatch = 1;
8492: }
8493: } else {
1.419 raeburn 8494: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8495: $secmatch = 1;
8496: }
1.290 albertel 8497: }
1.412 raeburn 8498: if (!$secmatch) {
8499: next;
8500: }
1.419 raeburn 8501: }
1.275 raeburn 8502: if (defined($$types{'active'})) {
1.288 raeburn 8503: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8504: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8505: $match = 1;
1.275 raeburn 8506: }
8507: }
8508: if (defined($$types{'previous'})) {
1.609 raeburn 8509: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8510: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8511: $match = 1;
1.275 raeburn 8512: }
8513: }
8514: if (defined($$types{'future'})) {
1.609 raeburn 8515: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8516: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8517: $match = 1;
1.275 raeburn 8518: }
8519: }
1.609 raeburn 8520: if ($match) {
8521: push(@{$seclists{$student}},$section);
8522: if (ref($userdata) eq 'HASH') {
8523: $$userdata{$student} = $$classlist{$student};
8524: }
8525: if (ref($statushash) eq 'HASH') {
8526: $statushash->{$student}{'st'}{$section} = $status;
8527: }
1.288 raeburn 8528: }
1.275 raeburn 8529: }
8530: }
1.412 raeburn 8531: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8532: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8533: my $now = time;
1.609 raeburn 8534: my %displaystatus = ( previous => 'Expired',
8535: active => 'Active',
8536: future => 'Future',
8537: );
1.1121 raeburn 8538: my (%nothide,@possdoms);
1.630 raeburn 8539: if ($hidepriv) {
8540: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8541: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8542: if ($user !~ /:/) {
8543: $nothide{join(':',split(/[\@]/,$user))}=1;
8544: } else {
8545: $nothide{$user} = 1;
8546: }
8547: }
1.1121 raeburn 8548: my @possdoms = ($cdom);
8549: if ($coursehash{'checkforpriv'}) {
8550: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
8551: }
1.630 raeburn 8552: }
1.439 raeburn 8553: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8554: my $match = 0;
1.412 raeburn 8555: my $secmatch = 0;
1.439 raeburn 8556: my $status;
1.412 raeburn 8557: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8558: $user =~ s/:$//;
1.439 raeburn 8559: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8560: if ($end == -1 || $start == -1) {
8561: next;
8562: }
8563: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8564: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8565: my ($uname,$udom) = split(/:/,$user);
8566: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8567: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8568: $secmatch = 1;
8569: } elsif ($usec eq '') {
1.420 albertel 8570: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8571: $secmatch = 1;
8572: }
8573: } else {
8574: if (grep(/^\Q$usec\E$/,@{$sections})) {
8575: $secmatch = 1;
8576: }
8577: }
8578: if (!$secmatch) {
8579: next;
8580: }
1.288 raeburn 8581: }
1.419 raeburn 8582: if ($usec eq '') {
8583: $usec = 'none';
8584: }
1.275 raeburn 8585: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8586: if ($hidepriv) {
1.1121 raeburn 8587: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 8588: (!$nothide{$uname.':'.$udom})) {
8589: next;
8590: }
8591: }
1.503 raeburn 8592: if ($end > 0 && $end < $now) {
1.439 raeburn 8593: $status = 'previous';
8594: } elsif ($start > $now) {
8595: $status = 'future';
8596: } else {
8597: $status = 'active';
8598: }
1.277 albertel 8599: foreach my $type (keys(%{$types})) {
1.275 raeburn 8600: if ($status eq $type) {
1.420 albertel 8601: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8602: push(@{$$users{$role}{$user}},$type);
8603: }
1.288 raeburn 8604: $match = 1;
8605: }
8606: }
1.419 raeburn 8607: if (($match) && (ref($userdata) eq 'HASH')) {
8608: if (!exists($$userdata{$uname.':'.$udom})) {
8609: &get_user_info($udom,$uname,\%idx,$userdata);
8610: }
1.420 albertel 8611: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8612: push(@{$seclists{$uname.':'.$udom}},$usec);
8613: }
1.609 raeburn 8614: if (ref($statushash) eq 'HASH') {
8615: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8616: }
1.275 raeburn 8617: }
8618: }
8619: }
8620: }
1.290 albertel 8621: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8622: if ((defined($cdom)) && (defined($cnum))) {
8623: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8624: if ( defined($csettings{'internal.courseowner'}) ) {
8625: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8626: next if ($owner eq '');
8627: my ($ownername,$ownerdom);
8628: if ($owner =~ /^([^:]+):([^:]+)$/) {
8629: $ownername = $1;
8630: $ownerdom = $2;
8631: } else {
8632: $ownername = $owner;
8633: $ownerdom = $cdom;
8634: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8635: }
8636: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8637: if (defined($userdata) &&
1.609 raeburn 8638: !exists($$userdata{$owner})) {
8639: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8640: if (!grep(/^none$/,@{$seclists{$owner}})) {
8641: push(@{$seclists{$owner}},'none');
8642: }
8643: if (ref($statushash) eq 'HASH') {
8644: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8645: }
1.290 albertel 8646: }
1.279 raeburn 8647: }
8648: }
8649: }
1.419 raeburn 8650: foreach my $user (keys(%seclists)) {
8651: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8652: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8653: }
1.275 raeburn 8654: }
8655: return;
8656: }
8657:
1.288 raeburn 8658: sub get_user_info {
8659: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8660: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8661: &plainname($uname,$udom,'lastname');
1.291 albertel 8662: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8663: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8664: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8665: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8666: return;
8667: }
1.275 raeburn 8668:
1.472 raeburn 8669: ###############################################
8670:
8671: =pod
8672:
8673: =item * &get_user_quota()
8674:
1.1134 raeburn 8675: Retrieves quota assigned for storage of user files.
8676: Default is to report quota for portfolio files.
1.472 raeburn 8677:
8678: Incoming parameters:
8679: 1. user's username
8680: 2. user's domain
1.1134 raeburn 8681: 3. quota name - portfolio, author, or course
1.1136 raeburn 8682: (if no quota name provided, defaults to portfolio).
8683: 4. crstype - official, unofficial or community, if quota name is
8684: course
1.472 raeburn 8685:
8686: Returns:
1.536 raeburn 8687: 1. Disk quota (in Mb) assigned to student.
8688: 2. (Optional) Type of setting: custom or default
8689: (individually assigned or default for user's
8690: institutional status).
8691: 3. (Optional) - User's institutional status (e.g., faculty, staff
8692: or student - types as defined in localenroll::inst_usertypes
8693: for user's domain, which determines default quota for user.
8694: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8695:
8696: If a value has been stored in the user's environment,
1.536 raeburn 8697: it will return that, otherwise it returns the maximal default
1.1134 raeburn 8698: defined for the user's institutional status(es) in the domain.
1.472 raeburn 8699:
8700: =cut
8701:
8702: ###############################################
8703:
8704:
8705: sub get_user_quota {
1.1136 raeburn 8706: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 8707: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8708: if (!defined($udom)) {
8709: $udom = $env{'user.domain'};
8710: }
8711: if (!defined($uname)) {
8712: $uname = $env{'user.name'};
8713: }
8714: if (($udom eq '' || $uname eq '') ||
8715: ($udom eq 'public') && ($uname eq 'public')) {
8716: $quota = 0;
1.536 raeburn 8717: $quotatype = 'default';
8718: $defquota = 0;
1.472 raeburn 8719: } else {
1.536 raeburn 8720: my $inststatus;
1.1134 raeburn 8721: if ($quotaname eq 'course') {
8722: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
8723: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
8724: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
8725: } else {
8726: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
8727: $quota = $cenv{'internal.uploadquota'};
8728: }
1.536 raeburn 8729: } else {
1.1134 raeburn 8730: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8731: if ($quotaname eq 'author') {
8732: $quota = $env{'environment.authorquota'};
8733: } else {
8734: $quota = $env{'environment.portfolioquota'};
8735: }
8736: $inststatus = $env{'environment.inststatus'};
8737: } else {
8738: my %userenv =
8739: &Apache::lonnet::get('environment',['portfolioquota',
8740: 'authorquota','inststatus'],$udom,$uname);
8741: my ($tmp) = keys(%userenv);
8742: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8743: if ($quotaname eq 'author') {
8744: $quota = $userenv{'authorquota'};
8745: } else {
8746: $quota = $userenv{'portfolioquota'};
8747: }
8748: $inststatus = $userenv{'inststatus'};
8749: } else {
8750: undef(%userenv);
8751: }
8752: }
8753: }
8754: if ($quota eq '' || wantarray) {
8755: if ($quotaname eq 'course') {
8756: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1136 raeburn 8757: if (($crstype eq 'official') || ($crstype eq 'unofficial') || ($crstype eq 'community')) {
8758: $defquota = $domdefs{$crstype.'quota'};
8759: }
8760: if ($defquota eq '') {
8761: $defquota = 500;
8762: }
1.1134 raeburn 8763: } else {
8764: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
8765: }
8766: if ($quota eq '') {
8767: $quota = $defquota;
8768: $quotatype = 'default';
8769: } else {
8770: $quotatype = 'custom';
8771: }
1.472 raeburn 8772: }
8773: }
1.536 raeburn 8774: if (wantarray) {
8775: return ($quota,$quotatype,$settingstatus,$defquota);
8776: } else {
8777: return $quota;
8778: }
1.472 raeburn 8779: }
8780:
8781: ###############################################
8782:
8783: =pod
8784:
8785: =item * &default_quota()
8786:
1.536 raeburn 8787: Retrieves default quota assigned for storage of user portfolio files,
8788: given an (optional) user's institutional status.
1.472 raeburn 8789:
8790: Incoming parameters:
1.1142 raeburn 8791:
1.472 raeburn 8792: 1. domain
1.536 raeburn 8793: 2. (Optional) institutional status(es). This is a : separated list of
8794: status types (e.g., faculty, staff, student etc.)
8795: which apply to the user for whom the default is being retrieved.
8796: If the institutional status string in undefined, the domain
1.1134 raeburn 8797: default quota will be returned.
8798: 3. quota name - portfolio, author, or course
8799: (if no quota name provided, defaults to portfolio).
1.472 raeburn 8800:
8801: Returns:
1.1142 raeburn 8802:
1.472 raeburn 8803: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8804: 2. (Optional) institutional type which determined the value of the
8805: default quota.
1.472 raeburn 8806:
8807: If a value has been stored in the domain's configuration db,
8808: it will return that, otherwise it returns 20 (for backwards
8809: compatibility with domains which have not set up a configuration
8810: db file; the original statically defined portfolio quota was 20 Mb).
8811:
1.536 raeburn 8812: If the user's status includes multiple types (e.g., staff and student),
8813: the largest default quota which applies to the user determines the
8814: default quota returned.
8815:
1.472 raeburn 8816: =cut
8817:
8818: ###############################################
8819:
8820:
8821: sub default_quota {
1.1134 raeburn 8822: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 8823: my ($defquota,$settingstatus);
8824: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8825: ['quotas'],$udom);
1.1134 raeburn 8826: my $key = 'defaultquota';
8827: if ($quotaname eq 'author') {
8828: $key = 'authorquota';
8829: }
1.622 raeburn 8830: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8831: if ($inststatus ne '') {
1.765 raeburn 8832: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8833: foreach my $item (@statuses) {
1.1134 raeburn 8834: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
8835: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 8836: if ($defquota eq '') {
1.1134 raeburn 8837: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 8838: $settingstatus = $item;
1.1134 raeburn 8839: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
8840: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 8841: $settingstatus = $item;
8842: }
8843: }
1.1134 raeburn 8844: } elsif ($key eq 'defaultquota') {
1.711 raeburn 8845: if ($quotahash{'quotas'}{$item} ne '') {
8846: if ($defquota eq '') {
8847: $defquota = $quotahash{'quotas'}{$item};
8848: $settingstatus = $item;
8849: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8850: $defquota = $quotahash{'quotas'}{$item};
8851: $settingstatus = $item;
8852: }
1.536 raeburn 8853: }
8854: }
8855: }
8856: }
8857: if ($defquota eq '') {
1.1134 raeburn 8858: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
8859: $defquota = $quotahash{'quotas'}{$key}{'default'};
8860: } elsif ($key eq 'defaultquota') {
1.711 raeburn 8861: $defquota = $quotahash{'quotas'}{'default'};
8862: }
1.536 raeburn 8863: $settingstatus = 'default';
1.1139 raeburn 8864: if ($defquota eq '') {
8865: if ($quotaname eq 'author') {
8866: $defquota = 500;
8867: }
8868: }
1.536 raeburn 8869: }
8870: } else {
8871: $settingstatus = 'default';
1.1134 raeburn 8872: if ($quotaname eq 'author') {
8873: $defquota = 500;
8874: } else {
8875: $defquota = 20;
8876: }
1.536 raeburn 8877: }
8878: if (wantarray) {
8879: return ($defquota,$settingstatus);
1.472 raeburn 8880: } else {
1.536 raeburn 8881: return $defquota;
1.472 raeburn 8882: }
8883: }
8884:
1.1135 raeburn 8885: ###############################################
8886:
8887: =pod
8888:
1.1136 raeburn 8889: =item * &excess_filesize_warning()
1.1135 raeburn 8890:
8891: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 8892: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 8893: space to be exceeded.
1.1136 raeburn 8894:
8895: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 8896: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 8897:
8898: Inputs: 6
1.1136 raeburn 8899: 1. username or coursenum
1.1135 raeburn 8900: 2. domain
1.1136 raeburn 8901: 3. context ('author' or 'course')
1.1135 raeburn 8902: 4. filename of file for which action is being requested
8903: 5. filesize (kB) of file
8904: 6. action being taken: copy or upload.
8905:
8906: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 8907: otherwise return null.
8908:
8909: =back
1.1135 raeburn 8910:
8911: =cut
8912:
1.1136 raeburn 8913: sub excess_filesize_warning {
8914: my ($uname,$udom,$context,$filename,$filesize,$action) = @_;
8915: my $current_disk_usage = 0;
8916: my $disk_quota = &get_user_quota($uname,$udom,$context); #expressed in MB
8917: if ($context eq 'author') {
8918: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
8919: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
8920: } else {
8921: foreach my $subdir ('docs','supplemental') {
8922: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
8923: }
8924: }
1.1135 raeburn 8925: $disk_quota = int($disk_quota * 1000);
8926: if (($current_disk_usage + $filesize) > $disk_quota) {
8927: return '<p><span class="LC_warning">'.
8928: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
8929: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</span>'.
8930: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
8931: $disk_quota,$current_disk_usage).
8932: '</p>';
8933: }
8934: return;
8935: }
8936:
8937: ###############################################
8938:
8939:
1.1136 raeburn 8940:
8941:
1.384 raeburn 8942: sub get_secgrprole_info {
8943: my ($cdom,$cnum,$needroles,$type) = @_;
8944: my %sections_count = &get_sections($cdom,$cnum);
8945: my @sections = (sort {$a <=> $b} keys(%sections_count));
8946: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8947: my @groups = sort(keys(%curr_groups));
8948: my $allroles = [];
8949: my $rolehash;
8950: my $accesshash = {
8951: active => 'Currently has access',
8952: future => 'Will have future access',
8953: previous => 'Previously had access',
8954: };
8955: if ($needroles) {
8956: $rolehash = {'all' => 'all'};
1.385 albertel 8957: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8958: if (&Apache::lonnet::error(%user_roles)) {
8959: undef(%user_roles);
8960: }
8961: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8962: my ($role)=split(/\:/,$item,2);
8963: if ($role eq 'cr') { next; }
8964: if ($role =~ /^cr/) {
8965: $$rolehash{$role} = (split('/',$role))[3];
8966: } else {
8967: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8968: }
8969: }
8970: foreach my $key (sort(keys(%{$rolehash}))) {
8971: push(@{$allroles},$key);
8972: }
8973: push (@{$allroles},'st');
8974: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8975: }
8976: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8977: }
8978:
1.555 raeburn 8979: sub user_picker {
1.994 raeburn 8980: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8981: my $currdom = $dom;
8982: my %curr_selected = (
8983: srchin => 'dom',
1.580 raeburn 8984: srchby => 'lastname',
1.555 raeburn 8985: );
8986: my $srchterm;
1.625 raeburn 8987: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8988: if ($srch->{'srchby'} ne '') {
8989: $curr_selected{'srchby'} = $srch->{'srchby'};
8990: }
8991: if ($srch->{'srchin'} ne '') {
8992: $curr_selected{'srchin'} = $srch->{'srchin'};
8993: }
8994: if ($srch->{'srchtype'} ne '') {
8995: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8996: }
8997: if ($srch->{'srchdomain'} ne '') {
8998: $currdom = $srch->{'srchdomain'};
8999: }
9000: $srchterm = $srch->{'srchterm'};
9001: }
9002: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 9003: 'usr' => 'Search criteria',
1.563 raeburn 9004: 'doma' => 'Domain/institution to search',
1.558 albertel 9005: 'uname' => 'username',
9006: 'lastname' => 'last name',
1.555 raeburn 9007: 'lastfirst' => 'last name, first name',
1.558 albertel 9008: 'crs' => 'in this course',
1.576 raeburn 9009: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 9010: 'alc' => 'all LON-CAPA',
1.573 raeburn 9011: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 9012: 'exact' => 'is',
9013: 'contains' => 'contains',
1.569 raeburn 9014: 'begins' => 'begins with',
1.571 raeburn 9015: 'youm' => "You must include some text to search for.",
9016: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
9017: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
9018: 'yomc' => "You must choose a domain when using an institutional directory search.",
9019: 'ymcd' => "You must choose a domain when using a domain search.",
9020: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
9021: 'whse' => "When searching by last,first you must include at least one character in the first name.",
9022: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 9023: );
1.563 raeburn 9024: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
9025: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 9026:
9027: my @srchins = ('crs','dom','alc','instd');
9028:
9029: foreach my $option (@srchins) {
9030: # FIXME 'alc' option unavailable until
9031: # loncreateuser::print_user_query_page()
9032: # has been completed.
9033: next if ($option eq 'alc');
1.880 raeburn 9034: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 9035: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 9036: if ($curr_selected{'srchin'} eq $option) {
9037: $srchinsel .= '
9038: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9039: } else {
9040: $srchinsel .= '
9041: <option value="'.$option.'">'.$lt{$option}.'</option>';
9042: }
1.555 raeburn 9043: }
1.563 raeburn 9044: $srchinsel .= "\n </select>\n";
1.555 raeburn 9045:
9046: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 9047: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 9048: if ($curr_selected{'srchby'} eq $option) {
9049: $srchbysel .= '
9050: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9051: } else {
9052: $srchbysel .= '
9053: <option value="'.$option.'">'.$lt{$option}.'</option>';
9054: }
9055: }
9056: $srchbysel .= "\n </select>\n";
9057:
9058: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 9059: foreach my $option ('begins','contains','exact') {
1.555 raeburn 9060: if ($curr_selected{'srchtype'} eq $option) {
9061: $srchtypesel .= '
9062: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
9063: } else {
9064: $srchtypesel .= '
9065: <option value="'.$option.'">'.$lt{$option}.'</option>';
9066: }
9067: }
9068: $srchtypesel .= "\n </select>\n";
9069:
1.558 albertel 9070: my ($newuserscript,$new_user_create);
1.994 raeburn 9071: my $context_dom = $env{'request.role.domain'};
9072: if ($context eq 'requestcrs') {
9073: if ($env{'form.coursedom'} ne '') {
9074: $context_dom = $env{'form.coursedom'};
9075: }
9076: }
1.556 raeburn 9077: if ($forcenewuser) {
1.576 raeburn 9078: if (ref($srch) eq 'HASH') {
1.994 raeburn 9079: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 9080: if ($cancreate) {
9081: $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>';
9082: } else {
1.799 bisitz 9083: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 9084: my %usertypetext = (
9085: official => 'institutional',
9086: unofficial => 'non-institutional',
9087: );
1.799 bisitz 9088: $new_user_create = '<p class="LC_warning">'
9089: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
9090: .' '
9091: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
9092: ,'<a href="'.$helplink.'">','</a>')
9093: .'</p><br />';
1.627 raeburn 9094: }
1.576 raeburn 9095: }
9096: }
9097:
1.556 raeburn 9098: $newuserscript = <<"ENDSCRIPT";
9099:
1.570 raeburn 9100: function setSearch(createnew,callingForm) {
1.556 raeburn 9101: if (createnew == 1) {
1.570 raeburn 9102: for (var i=0; i<callingForm.srchby.length; i++) {
9103: if (callingForm.srchby.options[i].value == 'uname') {
9104: callingForm.srchby.selectedIndex = i;
1.556 raeburn 9105: }
9106: }
1.570 raeburn 9107: for (var i=0; i<callingForm.srchin.length; i++) {
9108: if ( callingForm.srchin.options[i].value == 'dom') {
9109: callingForm.srchin.selectedIndex = i;
1.556 raeburn 9110: }
9111: }
1.570 raeburn 9112: for (var i=0; i<callingForm.srchtype.length; i++) {
9113: if (callingForm.srchtype.options[i].value == 'exact') {
9114: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 9115: }
9116: }
1.570 raeburn 9117: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 9118: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 9119: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 9120: }
9121: }
9122: }
9123: }
9124: ENDSCRIPT
1.558 albertel 9125:
1.556 raeburn 9126: }
9127:
1.555 raeburn 9128: my $output = <<"END_BLOCK";
1.556 raeburn 9129: <script type="text/javascript">
1.824 bisitz 9130: // <![CDATA[
1.570 raeburn 9131: function validateEntry(callingForm) {
1.558 albertel 9132:
1.556 raeburn 9133: var checkok = 1;
1.558 albertel 9134: var srchin;
1.570 raeburn 9135: for (var i=0; i<callingForm.srchin.length; i++) {
9136: if ( callingForm.srchin[i].checked ) {
9137: srchin = callingForm.srchin[i].value;
1.558 albertel 9138: }
9139: }
9140:
1.570 raeburn 9141: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
9142: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
9143: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
9144: var srchterm = callingForm.srchterm.value;
9145: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 9146: var msg = "";
9147:
9148: if (srchterm == "") {
9149: checkok = 0;
1.571 raeburn 9150: msg += "$lt{'youm'}\\n";
1.556 raeburn 9151: }
9152:
1.569 raeburn 9153: if (srchtype== 'begins') {
9154: if (srchterm.length < 2) {
9155: checkok = 0;
1.571 raeburn 9156: msg += "$lt{'thte'}\\n";
1.569 raeburn 9157: }
9158: }
9159:
1.556 raeburn 9160: if (srchtype== 'contains') {
9161: if (srchterm.length < 3) {
9162: checkok = 0;
1.571 raeburn 9163: msg += "$lt{'thet'}\\n";
1.556 raeburn 9164: }
9165: }
9166: if (srchin == 'instd') {
9167: if (srchdomain == '') {
9168: checkok = 0;
1.571 raeburn 9169: msg += "$lt{'yomc'}\\n";
1.556 raeburn 9170: }
9171: }
9172: if (srchin == 'dom') {
9173: if (srchdomain == '') {
9174: checkok = 0;
1.571 raeburn 9175: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 9176: }
9177: }
9178: if (srchby == 'lastfirst') {
9179: if (srchterm.indexOf(",") == -1) {
9180: checkok = 0;
1.571 raeburn 9181: msg += "$lt{'whus'}\\n";
1.556 raeburn 9182: }
9183: if (srchterm.indexOf(",") == srchterm.length -1) {
9184: checkok = 0;
1.571 raeburn 9185: msg += "$lt{'whse'}\\n";
1.556 raeburn 9186: }
9187: }
9188: if (checkok == 0) {
1.571 raeburn 9189: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 9190: return;
9191: }
9192: if (checkok == 1) {
1.570 raeburn 9193: callingForm.submit();
1.556 raeburn 9194: }
9195: }
9196:
9197: $newuserscript
9198:
1.824 bisitz 9199: // ]]>
1.556 raeburn 9200: </script>
1.558 albertel 9201:
9202: $new_user_create
9203:
1.555 raeburn 9204: END_BLOCK
1.558 albertel 9205:
1.876 raeburn 9206: $output .= &Apache::lonhtmlcommon::start_pick_box().
9207: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
9208: $domform.
9209: &Apache::lonhtmlcommon::row_closure().
9210: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
9211: $srchbysel.
9212: $srchtypesel.
9213: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
9214: $srchinsel.
9215: &Apache::lonhtmlcommon::row_closure(1).
9216: &Apache::lonhtmlcommon::end_pick_box().
9217: '<br />';
1.555 raeburn 9218: return $output;
9219: }
9220:
1.612 raeburn 9221: sub user_rule_check {
1.615 raeburn 9222: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 9223: my $response;
9224: if (ref($usershash) eq 'HASH') {
9225: foreach my $user (keys(%{$usershash})) {
9226: my ($uname,$udom) = split(/:/,$user);
9227: next if ($udom eq '' || $uname eq '');
1.615 raeburn 9228: my ($id,$newuser);
1.612 raeburn 9229: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 9230: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 9231: $id = $usershash->{$user}->{'id'};
9232: }
9233: my $inst_response;
9234: if (ref($checks) eq 'HASH') {
9235: if (defined($checks->{'username'})) {
1.615 raeburn 9236: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9237: &Apache::lonnet::get_instuser($udom,$uname);
9238: } elsif (defined($checks->{'id'})) {
1.615 raeburn 9239: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 9240: &Apache::lonnet::get_instuser($udom,undef,$id);
9241: }
1.615 raeburn 9242: } else {
9243: ($inst_response,%{$inst_results->{$user}}) =
9244: &Apache::lonnet::get_instuser($udom,$uname);
9245: return;
1.612 raeburn 9246: }
1.615 raeburn 9247: if (!$got_rules->{$udom}) {
1.612 raeburn 9248: my %domconfig = &Apache::lonnet::get_dom('configuration',
9249: ['usercreation'],$udom);
9250: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 9251: foreach my $item ('username','id') {
1.612 raeburn 9252: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
9253: $$curr_rules{$udom}{$item} =
9254: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 9255: }
9256: }
9257: }
1.615 raeburn 9258: $got_rules->{$udom} = 1;
1.585 raeburn 9259: }
1.612 raeburn 9260: foreach my $item (keys(%{$checks})) {
9261: if (ref($$curr_rules{$udom}) eq 'HASH') {
9262: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
9263: if (@{$$curr_rules{$udom}{$item}} > 0) {
9264: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
9265: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
9266: if ($rule_check{$rule}) {
9267: $$rulematch{$user}{$item} = $rule;
9268: if ($inst_response eq 'ok') {
1.615 raeburn 9269: if (ref($inst_results) eq 'HASH') {
9270: if (ref($inst_results->{$user}) eq 'HASH') {
9271: if (keys(%{$inst_results->{$user}}) == 0) {
9272: $$alerts{$item}{$udom}{$uname} = 1;
9273: }
1.612 raeburn 9274: }
9275: }
1.615 raeburn 9276: }
9277: last;
1.585 raeburn 9278: }
9279: }
9280: }
9281: }
9282: }
9283: }
9284: }
9285: }
1.612 raeburn 9286: return;
9287: }
9288:
9289: sub user_rule_formats {
9290: my ($domain,$domdesc,$curr_rules,$check) = @_;
9291: my %text = (
9292: 'username' => 'Usernames',
9293: 'id' => 'IDs',
9294: );
9295: my $output;
9296: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
9297: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
9298: if (@{$ruleorder} > 0) {
1.1102 raeburn 9299: $output = '<br />'.
9300: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
9301: '<span class="LC_cusr_emph">','</span>',$domdesc).
9302: ' <ul>';
1.612 raeburn 9303: foreach my $rule (@{$ruleorder}) {
9304: if (ref($curr_rules) eq 'ARRAY') {
9305: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
9306: if (ref($rules->{$rule}) eq 'HASH') {
9307: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
9308: $rules->{$rule}{'desc'}.'</li>';
9309: }
9310: }
9311: }
9312: }
9313: $output .= '</ul>';
9314: }
9315: }
9316: return $output;
9317: }
9318:
9319: sub instrule_disallow_msg {
1.615 raeburn 9320: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 9321: my $response;
9322: my %text = (
9323: item => 'username',
9324: items => 'usernames',
9325: match => 'matches',
9326: do => 'does',
9327: action => 'a username',
9328: one => 'one',
9329: );
9330: if ($count > 1) {
9331: $text{'item'} = 'usernames';
9332: $text{'match'} ='match';
9333: $text{'do'} = 'do';
9334: $text{'action'} = 'usernames',
9335: $text{'one'} = 'ones';
9336: }
9337: if ($checkitem eq 'id') {
9338: $text{'items'} = 'IDs';
9339: $text{'item'} = 'ID';
9340: $text{'action'} = 'an ID';
1.615 raeburn 9341: if ($count > 1) {
9342: $text{'item'} = 'IDs';
9343: $text{'action'} = 'IDs';
9344: }
1.612 raeburn 9345: }
1.674 bisitz 9346: $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 9347: if ($mode eq 'upload') {
9348: if ($checkitem eq 'username') {
9349: $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'}.");
9350: } elsif ($checkitem eq 'id') {
1.674 bisitz 9351: $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 9352: }
1.669 raeburn 9353: } elsif ($mode eq 'selfcreate') {
9354: if ($checkitem eq 'id') {
9355: $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.");
9356: }
1.615 raeburn 9357: } else {
9358: if ($checkitem eq 'username') {
9359: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9360: } elsif ($checkitem eq 'id') {
9361: $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.");
9362: }
1.612 raeburn 9363: }
9364: return $response;
1.585 raeburn 9365: }
9366:
1.624 raeburn 9367: sub personal_data_fieldtitles {
9368: my %fieldtitles = &Apache::lonlocal::texthash (
9369: id => 'Student/Employee ID',
9370: permanentemail => 'E-mail address',
9371: lastname => 'Last Name',
9372: firstname => 'First Name',
9373: middlename => 'Middle Name',
9374: generation => 'Generation',
9375: gen => 'Generation',
1.765 raeburn 9376: inststatus => 'Affiliation',
1.624 raeburn 9377: );
9378: return %fieldtitles;
9379: }
9380:
1.642 raeburn 9381: sub sorted_inst_types {
9382: my ($dom) = @_;
9383: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9384: my $othertitle = &mt('All users');
9385: if ($env{'request.course.id'}) {
1.668 raeburn 9386: $othertitle = &mt('Any users');
1.642 raeburn 9387: }
9388: my @types;
9389: if (ref($order) eq 'ARRAY') {
9390: @types = @{$order};
9391: }
9392: if (@types == 0) {
9393: if (ref($usertypes) eq 'HASH') {
9394: @types = sort(keys(%{$usertypes}));
9395: }
9396: }
9397: if (keys(%{$usertypes}) > 0) {
9398: $othertitle = &mt('Other users');
9399: }
9400: return ($othertitle,$usertypes,\@types);
9401: }
9402:
1.645 raeburn 9403: sub get_institutional_codes {
9404: my ($settings,$allcourses,$LC_code) = @_;
9405: # Get complete list of course sections to update
9406: my @currsections = ();
9407: my @currxlists = ();
9408: my $coursecode = $$settings{'internal.coursecode'};
9409:
9410: if ($$settings{'internal.sectionnums'} ne '') {
9411: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9412: }
9413:
9414: if ($$settings{'internal.crosslistings'} ne '') {
9415: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9416: }
9417:
9418: if (@currxlists > 0) {
9419: foreach (@currxlists) {
9420: if (m/^([^:]+):(\w*)$/) {
9421: unless (grep/^$1$/,@{$allcourses}) {
9422: push @{$allcourses},$1;
9423: $$LC_code{$1} = $2;
9424: }
9425: }
9426: }
9427: }
9428:
9429: if (@currsections > 0) {
9430: foreach (@currsections) {
9431: if (m/^(\w+):(\w*)$/) {
9432: my $sec = $coursecode.$1;
9433: my $lc_sec = $2;
9434: unless (grep/^$sec$/,@{$allcourses}) {
9435: push @{$allcourses},$sec;
9436: $$LC_code{$sec} = $lc_sec;
9437: }
9438: }
9439: }
9440: }
9441: return;
9442: }
9443:
1.971 raeburn 9444: sub get_standard_codeitems {
9445: return ('Year','Semester','Department','Number','Section');
9446: }
9447:
1.112 bowersj2 9448: =pod
9449:
1.780 raeburn 9450: =head1 Slot Helpers
9451:
9452: =over 4
9453:
9454: =item * sorted_slots()
9455:
1.1040 raeburn 9456: Sorts an array of slot names in order of an optional sort key,
9457: default sort is by slot start time (earliest first).
1.780 raeburn 9458:
9459: Inputs:
9460:
9461: =over 4
9462:
9463: slotsarr - Reference to array of unsorted slot names.
9464:
9465: slots - Reference to hash of hash, where outer hash keys are slot names.
9466:
1.1040 raeburn 9467: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9468:
1.549 albertel 9469: =back
9470:
1.780 raeburn 9471: Returns:
9472:
9473: =over 4
9474:
1.1040 raeburn 9475: sorted - An array of slot names sorted by a specified sort key
9476: (default sort key is start time of the slot).
1.780 raeburn 9477:
9478: =back
9479:
9480: =cut
9481:
9482:
9483: sub sorted_slots {
1.1040 raeburn 9484: my ($slotsarr,$slots,$sortkey) = @_;
9485: if ($sortkey eq '') {
9486: $sortkey = 'starttime';
9487: }
1.780 raeburn 9488: my @sorted;
9489: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9490: @sorted =
9491: sort {
9492: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9493: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9494: }
9495: if (ref($slots->{$a})) { return -1;}
9496: if (ref($slots->{$b})) { return 1;}
9497: return 0;
9498: } @{$slotsarr};
9499: }
9500: return @sorted;
9501: }
9502:
1.1040 raeburn 9503: =pod
9504:
9505: =item * get_future_slots()
9506:
9507: Inputs:
9508:
9509: =over 4
9510:
9511: cnum - course number
9512:
9513: cdom - course domain
9514:
9515: now - current UNIX time
9516:
9517: symb - optional symb
9518:
9519: =back
9520:
9521: Returns:
9522:
9523: =over 4
9524:
9525: sorted_reservable - ref to array of student_schedulable slots currently
9526: reservable, ordered by end date of reservation period.
9527:
9528: reservable_now - ref to hash of student_schedulable slots currently
9529: reservable.
9530:
9531: Keys in inner hash are:
9532: (a) symb: either blank or symb to which slot use is restricted.
9533: (b) endreserve: end date of reservation period.
9534:
9535: sorted_future - ref to array of student_schedulable slots reservable in
9536: the future, ordered by start date of reservation period.
9537:
9538: future_reservable - ref to hash of student_schedulable slots reservable
9539: in the future.
9540:
9541: Keys in inner hash are:
9542: (a) symb: either blank or symb to which slot use is restricted.
9543: (b) startreserve: start date of reservation period.
9544:
9545: =back
9546:
9547: =cut
9548:
9549: sub get_future_slots {
9550: my ($cnum,$cdom,$now,$symb) = @_;
9551: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9552: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9553: foreach my $slot (keys(%slots)) {
9554: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9555: if ($symb) {
9556: next if (($slots{$slot}->{'symb'} ne '') &&
9557: ($slots{$slot}->{'symb'} ne $symb));
9558: }
9559: if (($slots{$slot}->{'starttime'} > $now) &&
9560: ($slots{$slot}->{'endtime'} > $now)) {
9561: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9562: my $userallowed = 0;
9563: if ($slots{$slot}->{'allowedsections'}) {
9564: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9565: if (!defined($env{'request.role.sec'})
9566: && grep(/^No section assigned$/,@allowed_sec)) {
9567: $userallowed=1;
9568: } else {
9569: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9570: $userallowed=1;
9571: }
9572: }
9573: unless ($userallowed) {
9574: if (defined($env{'request.course.groups'})) {
9575: my @groups = split(/:/,$env{'request.course.groups'});
9576: foreach my $group (@groups) {
9577: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9578: $userallowed=1;
9579: last;
9580: }
9581: }
9582: }
9583: }
9584: }
9585: if ($slots{$slot}->{'allowedusers'}) {
9586: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9587: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9588: if (grep(/^\Q$user\E$/,@allowed_users)) {
9589: $userallowed = 1;
9590: }
9591: }
9592: next unless($userallowed);
9593: }
9594: my $startreserve = $slots{$slot}->{'startreserve'};
9595: my $endreserve = $slots{$slot}->{'endreserve'};
9596: my $symb = $slots{$slot}->{'symb'};
9597: if (($startreserve < $now) &&
9598: (!$endreserve || $endreserve > $now)) {
9599: my $lastres = $endreserve;
9600: if (!$lastres) {
9601: $lastres = $slots{$slot}->{'starttime'};
9602: }
9603: $reservable_now{$slot} = {
9604: symb => $symb,
9605: endreserve => $lastres
9606: };
9607: } elsif (($startreserve > $now) &&
9608: (!$endreserve || $endreserve > $startreserve)) {
9609: $future_reservable{$slot} = {
9610: symb => $symb,
9611: startreserve => $startreserve
9612: };
9613: }
9614: }
9615: }
9616: my @unsorted_reservable = keys(%reservable_now);
9617: if (@unsorted_reservable > 0) {
9618: @sorted_reservable =
9619: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9620: }
9621: my @unsorted_future = keys(%future_reservable);
9622: if (@unsorted_future > 0) {
9623: @sorted_future =
9624: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9625: }
9626: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9627: }
1.780 raeburn 9628:
9629: =pod
9630:
1.1057 foxr 9631: =back
9632:
1.549 albertel 9633: =head1 HTTP Helpers
9634:
9635: =over 4
9636:
1.648 raeburn 9637: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9638:
1.258 albertel 9639: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9640: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9641: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9642:
9643: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9644: $possible_names is an ref to an array of form element names. As an example:
9645: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9646: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9647:
9648: =cut
1.1 albertel 9649:
1.6 albertel 9650: sub get_unprocessed_cgi {
1.25 albertel 9651: my ($query,$possible_names)= @_;
1.26 matthew 9652: # $Apache::lonxml::debug=1;
1.356 albertel 9653: foreach my $pair (split(/&/,$query)) {
9654: my ($name, $value) = split(/=/,$pair);
1.369 www 9655: $name = &unescape($name);
1.25 albertel 9656: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9657: $value =~ tr/+/ /;
9658: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9659: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9660: }
1.16 harris41 9661: }
1.6 albertel 9662: }
9663:
1.112 bowersj2 9664: =pod
9665:
1.648 raeburn 9666: =item * &cacheheader()
1.112 bowersj2 9667:
9668: returns cache-controlling header code
9669:
9670: =cut
9671:
1.7 albertel 9672: sub cacheheader {
1.258 albertel 9673: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9674: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9675: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9676: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9677: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9678: return $output;
1.7 albertel 9679: }
9680:
1.112 bowersj2 9681: =pod
9682:
1.648 raeburn 9683: =item * &no_cache($r)
1.112 bowersj2 9684:
9685: specifies header code to not have cache
9686:
9687: =cut
9688:
1.9 albertel 9689: sub no_cache {
1.216 albertel 9690: my ($r) = @_;
9691: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9692: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9693: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9694: $r->no_cache(1);
9695: $r->header_out("Expires" => $date);
9696: $r->header_out("Pragma" => "no-cache");
1.123 www 9697: }
9698:
9699: sub content_type {
1.181 albertel 9700: my ($r,$type,$charset) = @_;
1.299 foxr 9701: if ($r) {
9702: # Note that printout.pl calls this with undef for $r.
9703: &no_cache($r);
9704: }
1.258 albertel 9705: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9706: unless ($charset) {
9707: $charset=&Apache::lonlocal::current_encoding;
9708: }
9709: if ($charset) { $type.='; charset='.$charset; }
9710: if ($r) {
9711: $r->content_type($type);
9712: } else {
9713: print("Content-type: $type\n\n");
9714: }
1.9 albertel 9715: }
1.25 albertel 9716:
1.112 bowersj2 9717: =pod
9718:
1.648 raeburn 9719: =item * &add_to_env($name,$value)
1.112 bowersj2 9720:
1.258 albertel 9721: adds $name to the %env hash with value
1.112 bowersj2 9722: $value, if $name already exists, the entry is converted to an array
9723: reference and $value is added to the array.
9724:
9725: =cut
9726:
1.25 albertel 9727: sub add_to_env {
9728: my ($name,$value)=@_;
1.258 albertel 9729: if (defined($env{$name})) {
9730: if (ref($env{$name})) {
1.25 albertel 9731: #already have multiple values
1.258 albertel 9732: push(@{ $env{$name} },$value);
1.25 albertel 9733: } else {
9734: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9735: my $first=$env{$name};
9736: undef($env{$name});
9737: push(@{ $env{$name} },$first,$value);
1.25 albertel 9738: }
9739: } else {
1.258 albertel 9740: $env{$name}=$value;
1.25 albertel 9741: }
1.31 albertel 9742: }
1.149 albertel 9743:
9744: =pod
9745:
1.648 raeburn 9746: =item * &get_env_multiple($name)
1.149 albertel 9747:
1.258 albertel 9748: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9749: values may be defined and end up as an array ref.
9750:
9751: returns an array of values
9752:
9753: =cut
9754:
9755: sub get_env_multiple {
9756: my ($name) = @_;
9757: my @values;
1.258 albertel 9758: if (defined($env{$name})) {
1.149 albertel 9759: # exists is it an array
1.258 albertel 9760: if (ref($env{$name})) {
9761: @values=@{ $env{$name} };
1.149 albertel 9762: } else {
1.258 albertel 9763: $values[0]=$env{$name};
1.149 albertel 9764: }
9765: }
9766: return(@values);
9767: }
9768:
1.660 raeburn 9769: sub ask_for_embedded_content {
9770: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9771: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 9772: %currsubfile,%unused,$rem);
1.1071 raeburn 9773: my $counter = 0;
9774: my $numnew = 0;
1.987 raeburn 9775: my $numremref = 0;
9776: my $numinvalid = 0;
9777: my $numpathchg = 0;
9778: my $numexisting = 0;
1.1071 raeburn 9779: my $numunused = 0;
9780: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9781: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9782: my $heading = &mt('Upload embedded files');
9783: my $buttontext = &mt('Upload');
9784:
1.1123 raeburn 9785: my ($navmap,$cdom,$cnum);
1.1085 raeburn 9786: if ($env{'request.course.id'}) {
1.1123 raeburn 9787: if ($actionurl eq '/adm/dependencies') {
9788: $navmap = Apache::lonnavmaps::navmap->new();
9789: }
9790: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9791: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 9792: }
1.1123 raeburn 9793: if (($actionurl eq '/adm/portfolio') ||
9794: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 9795: my $current_path='/';
9796: if ($env{'form.currentpath'}) {
9797: $current_path = $env{'form.currentpath'};
9798: }
9799: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 9800: $udom = $cdom;
9801: $uname = $cnum;
1.984 raeburn 9802: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9803: } else {
9804: $udom = $env{'user.domain'};
9805: $uname = $env{'user.name'};
9806: $url = '/userfiles/portfolio';
9807: }
1.987 raeburn 9808: $toplevel = $url.'/';
1.984 raeburn 9809: $url .= $current_path;
9810: $getpropath = 1;
1.987 raeburn 9811: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9812: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9813: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9814: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9815: $toplevel = $url;
1.984 raeburn 9816: if ($rest ne '') {
1.987 raeburn 9817: $url .= $rest;
9818: }
9819: } elsif ($actionurl eq '/adm/coursedocs') {
9820: if (ref($args) eq 'HASH') {
1.1071 raeburn 9821: $url = $args->{'docs_url'};
9822: $toplevel = $url;
1.1084 raeburn 9823: if ($args->{'context'} eq 'paste') {
9824: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9825: ($path) =
9826: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9827: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9828: $fileloc =~ s{^/}{};
9829: }
1.1071 raeburn 9830: }
1.1084 raeburn 9831: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 9832: if ($env{'request.course.id'} ne '') {
9833: if (ref($args) eq 'HASH') {
9834: $url = $args->{'docs_url'};
9835: $title = $args->{'docs_title'};
1.1126 raeburn 9836: $toplevel = $url;
9837: unless ($toplevel =~ m{^/}) {
9838: $toplevel = "/$url";
9839: }
1.1085 raeburn 9840: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 9841: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
9842: $path = $1;
9843: } else {
9844: ($path) =
9845: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9846: }
1.1071 raeburn 9847: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9848: $fileloc =~ s{^/}{};
9849: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9850: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9851: }
1.987 raeburn 9852: }
1.1123 raeburn 9853: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9854: $udom = $cdom;
9855: $uname = $cnum;
9856: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
9857: $toplevel = $url;
9858: $path = $url;
9859: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
9860: $fileloc =~ s{^/}{};
1.987 raeburn 9861: }
1.1126 raeburn 9862: foreach my $file (keys(%{$allfiles})) {
9863: my $embed_file;
9864: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
9865: $embed_file = $1;
9866: } else {
9867: $embed_file = $file;
9868: }
1.987 raeburn 9869: my $absolutepath;
1.1147 raeburn 9870: my $cleaned_file = &clean_path($embed_file);
9871: if ($cleaned_file =~ m{^\w+://}) {
9872: $newfiles{$cleaned_file} = 1;
9873: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 9874: } else {
9875: if ($embed_file =~ m{^/}) {
9876: $absolutepath = $embed_file;
9877: }
1.1147 raeburn 9878: if ($cleaned_file =~ m{/}) {
9879: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 9880: $path = &check_for_traversal($path,$url,$toplevel);
9881: my $item = $fname;
9882: if ($path ne '') {
9883: $item = $path.'/'.$fname;
9884: $subdependencies{$path}{$fname} = 1;
9885: } else {
9886: $dependencies{$item} = 1;
9887: }
9888: if ($absolutepath) {
9889: $mapping{$item} = $absolutepath;
9890: } else {
9891: $mapping{$item} = $embed_file;
9892: }
9893: } else {
9894: $dependencies{$embed_file} = 1;
9895: if ($absolutepath) {
1.1147 raeburn 9896: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 9897: } else {
1.1147 raeburn 9898: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 9899: }
9900: }
1.984 raeburn 9901: }
9902: }
1.1071 raeburn 9903: my $dirptr = 16384;
1.984 raeburn 9904: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9905: $currsubfile{$path} = {};
1.1123 raeburn 9906: if (($actionurl eq '/adm/portfolio') ||
9907: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9908: my ($sublistref,$listerror) =
9909: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9910: if (ref($sublistref) eq 'ARRAY') {
9911: foreach my $line (@{$sublistref}) {
9912: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9913: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9914: }
1.984 raeburn 9915: }
1.987 raeburn 9916: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9917: if (opendir(my $dir,$url.'/'.$path)) {
9918: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9919: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9920: }
1.1084 raeburn 9921: } elsif (($actionurl eq '/adm/dependencies') ||
9922: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 9923: ($args->{'context'} eq 'paste')) ||
9924: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9925: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 9926: my $dir;
9927: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
9928: $dir = $fileloc;
9929: } else {
9930: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9931: }
1.1071 raeburn 9932: if ($dir ne '') {
9933: my ($sublistref,$listerror) =
9934: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9935: if (ref($sublistref) eq 'ARRAY') {
9936: foreach my $line (@{$sublistref}) {
9937: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9938: undef,$mtime)=split(/\&/,$line,12);
9939: unless (($testdir&$dirptr) ||
9940: ($file_name =~ /^\.\.?$/)) {
9941: $currsubfile{$path}{$file_name} = [$size,$mtime];
9942: }
9943: }
9944: }
9945: }
1.984 raeburn 9946: }
9947: }
9948: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9949: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9950: my $item = $path.'/'.$file;
9951: unless ($mapping{$item} eq $item) {
9952: $pathchanges{$item} = 1;
9953: }
9954: $existing{$item} = 1;
9955: $numexisting ++;
9956: } else {
9957: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9958: }
9959: }
1.1071 raeburn 9960: if ($actionurl eq '/adm/dependencies') {
9961: foreach my $path (keys(%currsubfile)) {
9962: if (ref($currsubfile{$path}) eq 'HASH') {
9963: foreach my $file (keys(%{$currsubfile{$path}})) {
9964: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 9965: next if (($rem ne '') &&
9966: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9967: (ref($navmap) &&
9968: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9969: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9970: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9971: $unused{$path.'/'.$file} = 1;
9972: }
9973: }
9974: }
9975: }
9976: }
1.984 raeburn 9977: }
1.987 raeburn 9978: my %currfile;
1.1123 raeburn 9979: if (($actionurl eq '/adm/portfolio') ||
9980: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9981: my ($dirlistref,$listerror) =
9982: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9983: if (ref($dirlistref) eq 'ARRAY') {
9984: foreach my $line (@{$dirlistref}) {
9985: my ($file_name,$rest) = split(/\&/,$line,2);
9986: $currfile{$file_name} = 1;
9987: }
1.984 raeburn 9988: }
1.987 raeburn 9989: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9990: if (opendir(my $dir,$url)) {
1.987 raeburn 9991: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9992: map {$currfile{$_} = 1;} @dir_list;
9993: }
1.1084 raeburn 9994: } elsif (($actionurl eq '/adm/dependencies') ||
9995: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 9996: ($args->{'context'} eq 'paste')) ||
9997: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 9998: if ($env{'request.course.id'} ne '') {
9999: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10000: if ($dir ne '') {
10001: my ($dirlistref,$listerror) =
10002: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
10003: if (ref($dirlistref) eq 'ARRAY') {
10004: foreach my $line (@{$dirlistref}) {
10005: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
10006: $size,undef,$mtime)=split(/\&/,$line,12);
10007: unless (($testdir&$dirptr) ||
10008: ($file_name =~ /^\.\.?$/)) {
10009: $currfile{$file_name} = [$size,$mtime];
10010: }
10011: }
10012: }
10013: }
10014: }
1.984 raeburn 10015: }
10016: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 10017: if (exists($currfile{$file})) {
1.987 raeburn 10018: unless ($mapping{$file} eq $file) {
10019: $pathchanges{$file} = 1;
10020: }
10021: $existing{$file} = 1;
10022: $numexisting ++;
10023: } else {
1.984 raeburn 10024: $newfiles{$file} = 1;
10025: }
10026: }
1.1071 raeburn 10027: foreach my $file (keys(%currfile)) {
10028: unless (($file eq $filename) ||
10029: ($file eq $filename.'.bak') ||
10030: ($dependencies{$file})) {
1.1085 raeburn 10031: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 10032: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
10033: next if (($rem ne '') &&
10034: (($env{"httpref.$rem".$file} ne '') ||
10035: (ref($navmap) &&
10036: (($navmap->getResourceByUrl($rem.$file) ne '') ||
10037: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10038: ($navmap->getResourceByUrl($rem.$1)))))));
10039: }
1.1085 raeburn 10040: }
1.1071 raeburn 10041: $unused{$file} = 1;
10042: }
10043: }
1.1084 raeburn 10044: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
10045: ($args->{'context'} eq 'paste')) {
10046: $counter = scalar(keys(%existing));
10047: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 10048: return ($output,$counter,$numpathchg,\%existing);
10049: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
10050: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
10051: $counter = scalar(keys(%existing));
10052: $numpathchg = scalar(keys(%pathchanges));
10053: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 10054: }
1.984 raeburn 10055: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 10056: if ($actionurl eq '/adm/dependencies') {
10057: next if ($embed_file =~ m{^\w+://});
10058: }
1.660 raeburn 10059: $upload_output .= &start_data_table_row().
1.1123 raeburn 10060: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 10061: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 10062: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 10063: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
10064: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 10065: }
1.1123 raeburn 10066: $upload_output .= '</td>';
1.1071 raeburn 10067: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 10068: $upload_output.='<td align="right">'.
10069: '<span class="LC_info LC_fontsize_medium">'.
10070: &mt("URL points to web address").'</span>';
1.987 raeburn 10071: $numremref++;
1.660 raeburn 10072: } elsif ($args->{'error_on_invalid_names'}
10073: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 10074: $upload_output.='<td align="right"><span class="LC_warning">'.
10075: &mt('Invalid characters').'</span>';
1.987 raeburn 10076: $numinvalid++;
1.660 raeburn 10077: } else {
1.1123 raeburn 10078: $upload_output .= '<td>'.
10079: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 10080: $embed_file,\%mapping,
1.1071 raeburn 10081: $allfiles,$codebase,'upload');
10082: $counter ++;
10083: $numnew ++;
1.987 raeburn 10084: }
10085: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
10086: }
10087: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 10088: if ($actionurl eq '/adm/dependencies') {
10089: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
10090: $modify_output .= &start_data_table_row().
10091: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
10092: '<img src="'.&icon($embed_file).'" border="0" />'.
10093: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
10094: '<td>'.$size.'</td>'.
10095: '<td>'.$mtime.'</td>'.
10096: '<td><label><input type="checkbox" name="mod_upload_dep" '.
10097: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
10098: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
10099: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
10100: &embedded_file_element('upload_embedded',$counter,
10101: $embed_file,\%mapping,
10102: $allfiles,$codebase,'modify').
10103: '</div></td>'.
10104: &end_data_table_row()."\n";
10105: $counter ++;
10106: } else {
10107: $upload_output .= &start_data_table_row().
1.1123 raeburn 10108: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
10109: '<span class="LC_filename">'.$embed_file.'</span></td>'.
10110: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 10111: &Apache::loncommon::end_data_table_row()."\n";
10112: }
10113: }
10114: my $delidx = $counter;
10115: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
10116: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
10117: $delete_output .= &start_data_table_row().
10118: '<td><img src="'.&icon($oldfile).'" />'.
10119: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
10120: '<td>'.$size.'</td>'.
10121: '<td>'.$mtime.'</td>'.
10122: '<td><label><input type="checkbox" name="del_upload_dep" '.
10123: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
10124: &embedded_file_element('upload_embedded',$delidx,
10125: $oldfile,\%mapping,$allfiles,
10126: $codebase,'delete').'</td>'.
10127: &end_data_table_row()."\n";
10128: $numunused ++;
10129: $delidx ++;
1.987 raeburn 10130: }
10131: if ($upload_output) {
10132: $upload_output = &start_data_table().
10133: $upload_output.
10134: &end_data_table()."\n";
10135: }
1.1071 raeburn 10136: if ($modify_output) {
10137: $modify_output = &start_data_table().
10138: &start_data_table_header_row().
10139: '<th>'.&mt('File').'</th>'.
10140: '<th>'.&mt('Size (KB)').'</th>'.
10141: '<th>'.&mt('Modified').'</th>'.
10142: '<th>'.&mt('Upload replacement?').'</th>'.
10143: &end_data_table_header_row().
10144: $modify_output.
10145: &end_data_table()."\n";
10146: }
10147: if ($delete_output) {
10148: $delete_output = &start_data_table().
10149: &start_data_table_header_row().
10150: '<th>'.&mt('File').'</th>'.
10151: '<th>'.&mt('Size (KB)').'</th>'.
10152: '<th>'.&mt('Modified').'</th>'.
10153: '<th>'.&mt('Delete?').'</th>'.
10154: &end_data_table_header_row().
10155: $delete_output.
10156: &end_data_table()."\n";
10157: }
1.987 raeburn 10158: my $applies = 0;
10159: if ($numremref) {
10160: $applies ++;
10161: }
10162: if ($numinvalid) {
10163: $applies ++;
10164: }
10165: if ($numexisting) {
10166: $applies ++;
10167: }
1.1071 raeburn 10168: if ($counter || $numunused) {
1.987 raeburn 10169: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
10170: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 10171: $state.'<h3>'.$heading.'</h3>';
10172: if ($actionurl eq '/adm/dependencies') {
10173: if ($numnew) {
10174: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
10175: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
10176: $upload_output.'<br />'."\n";
10177: }
10178: if ($numexisting) {
10179: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
10180: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
10181: $modify_output.'<br />'."\n";
10182: $buttontext = &mt('Save changes');
10183: }
10184: if ($numunused) {
10185: $output .= '<h4>'.&mt('Unused files').'</h4>'.
10186: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
10187: $delete_output.'<br />'."\n";
10188: $buttontext = &mt('Save changes');
10189: }
10190: } else {
10191: $output .= $upload_output.'<br />'."\n";
10192: }
10193: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
10194: $counter.'" />'."\n";
10195: if ($actionurl eq '/adm/dependencies') {
10196: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
10197: $numnew.'" />'."\n";
10198: } elsif ($actionurl eq '') {
1.987 raeburn 10199: $output .= '<input type="hidden" name="phase" value="three" />';
10200: }
10201: } elsif ($applies) {
10202: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
10203: if ($applies > 1) {
10204: $output .=
1.1123 raeburn 10205: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 10206: if ($numremref) {
10207: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
10208: }
10209: if ($numinvalid) {
10210: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
10211: }
10212: if ($numexisting) {
10213: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
10214: }
10215: $output .= '</ul><br />';
10216: } elsif ($numremref) {
10217: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
10218: } elsif ($numinvalid) {
10219: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
10220: } elsif ($numexisting) {
10221: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
10222: }
10223: $output .= $upload_output.'<br />';
10224: }
10225: my ($pathchange_output,$chgcount);
1.1071 raeburn 10226: $chgcount = $counter;
1.987 raeburn 10227: if (keys(%pathchanges) > 0) {
10228: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 10229: if ($counter) {
1.987 raeburn 10230: $output .= &embedded_file_element('pathchange',$chgcount,
10231: $embed_file,\%mapping,
1.1071 raeburn 10232: $allfiles,$codebase,'change');
1.987 raeburn 10233: } else {
10234: $pathchange_output .=
10235: &start_data_table_row().
10236: '<td><input type ="checkbox" name="namechange" value="'.
10237: $chgcount.'" checked="checked" /></td>'.
10238: '<td>'.$mapping{$embed_file}.'</td>'.
10239: '<td>'.$embed_file.
10240: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 10241: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 10242: '</td>'.&end_data_table_row();
1.660 raeburn 10243: }
1.987 raeburn 10244: $numpathchg ++;
10245: $chgcount ++;
1.660 raeburn 10246: }
10247: }
1.1127 raeburn 10248: if (($counter) || ($numunused)) {
1.987 raeburn 10249: if ($numpathchg) {
10250: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
10251: $numpathchg.'" />'."\n";
10252: }
10253: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10254: ($actionurl eq '/adm/imsimport')) {
10255: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
10256: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
10257: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 10258: } elsif ($actionurl eq '/adm/dependencies') {
10259: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 10260: }
1.1123 raeburn 10261: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 10262: } elsif ($numpathchg) {
10263: my %pathchange = ();
10264: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
10265: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10266: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 10267: }
1.987 raeburn 10268: }
1.1071 raeburn 10269: return ($output,$counter,$numpathchg);
1.987 raeburn 10270: }
10271:
1.1147 raeburn 10272: =pod
10273:
10274: =item * clean_path($name)
10275:
10276: Performs clean-up of directories, subdirectories and filename in an
10277: embedded object, referenced in an HTML file which is being uploaded
10278: to a course or portfolio, where
10279: "Upload embedded images/multimedia files if HTML file" checkbox was
10280: checked.
10281:
10282: Clean-up is similar to replacements in lonnet::clean_filename()
10283: except each / between sub-directory and next level is preserved.
10284:
10285: =cut
10286:
10287: sub clean_path {
10288: my ($embed_file) = @_;
10289: $embed_file =~s{^/+}{};
10290: my @contents;
10291: if ($embed_file =~ m{/}) {
10292: @contents = split(/\//,$embed_file);
10293: } else {
10294: @contents = ($embed_file);
10295: }
10296: my $lastidx = scalar(@contents)-1;
10297: for (my $i=0; $i<=$lastidx; $i++) {
10298: $contents[$i]=~s{\\}{/}g;
10299: $contents[$i]=~s/\s+/\_/g;
10300: $contents[$i]=~s{[^/\w\.\-]}{}g;
10301: if ($i == $lastidx) {
10302: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
10303: }
10304: }
10305: if ($lastidx > 0) {
10306: return join('/',@contents);
10307: } else {
10308: return $contents[0];
10309: }
10310: }
10311:
1.987 raeburn 10312: sub embedded_file_element {
1.1071 raeburn 10313: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 10314: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
10315: (ref($codebase) eq 'HASH'));
10316: my $output;
1.1071 raeburn 10317: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 10318: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
10319: }
10320: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
10321: &escape($embed_file).'" />';
10322: unless (($context eq 'upload_embedded') &&
10323: ($mapping->{$embed_file} eq $embed_file)) {
10324: $output .='
10325: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
10326: }
10327: my $attrib;
10328: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
10329: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
10330: }
10331: $output .=
10332: "\n\t\t".
10333: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
10334: $attrib.'" />';
10335: if (exists($codebase->{$mapping->{$embed_file}})) {
10336: $output .=
10337: "\n\t\t".
10338: '<input name="codebase_'.$num.'" type="hidden" value="'.
10339: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 10340: }
1.987 raeburn 10341: return $output;
1.660 raeburn 10342: }
10343:
1.1071 raeburn 10344: sub get_dependency_details {
10345: my ($currfile,$currsubfile,$embed_file) = @_;
10346: my ($size,$mtime,$showsize,$showmtime);
10347: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
10348: if ($embed_file =~ m{/}) {
10349: my ($path,$fname) = split(/\//,$embed_file);
10350: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
10351: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
10352: }
10353: } else {
10354: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
10355: ($size,$mtime) = @{$currfile->{$embed_file}};
10356: }
10357: }
10358: $showsize = $size/1024.0;
10359: $showsize = sprintf("%.1f",$showsize);
10360: if ($mtime > 0) {
10361: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
10362: }
10363: }
10364: return ($showsize,$showmtime);
10365: }
10366:
10367: sub ask_embedded_js {
10368: return <<"END";
10369: <script type="text/javascript"">
10370: // <![CDATA[
10371: function toggleBrowse(counter) {
10372: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
10373: var fileid = document.getElementById('embedded_item_'+counter);
10374: var uploaddivid = document.getElementById('moduploaddep_'+counter);
10375: if (chkboxid.checked == true) {
10376: uploaddivid.style.display='block';
10377: } else {
10378: uploaddivid.style.display='none';
10379: fileid.value = '';
10380: }
10381: }
10382: // ]]>
10383: </script>
10384:
10385: END
10386: }
10387:
1.661 raeburn 10388: sub upload_embedded {
10389: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 10390: $current_disk_usage,$hiddenstate,$actionurl) = @_;
10391: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 10392: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
10393: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
10394: my $orig_uploaded_filename =
10395: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 10396: foreach my $type ('orig','ref','attrib','codebase') {
10397: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
10398: $env{'form.embedded_'.$type.'_'.$i} =
10399: &unescape($env{'form.embedded_'.$type.'_'.$i});
10400: }
10401: }
1.661 raeburn 10402: my ($path,$fname) =
10403: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
10404: # no path, whole string is fname
10405: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
10406: $fname = &Apache::lonnet::clean_filename($fname);
10407: # See if there is anything left
10408: next if ($fname eq '');
10409:
10410: # Check if file already exists as a file or directory.
10411: my ($state,$msg);
10412: if ($context eq 'portfolio') {
10413: my $port_path = $dirpath;
10414: if ($group ne '') {
10415: $port_path = "groups/$group/$port_path";
10416: }
1.987 raeburn 10417: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10418: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10419: $dir_root,$port_path,$disk_quota,
10420: $current_disk_usage,$uname,$udom);
10421: if ($state eq 'will_exceed_quota'
1.984 raeburn 10422: || $state eq 'file_locked') {
1.661 raeburn 10423: $output .= $msg;
10424: next;
10425: }
10426: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10427: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10428: if ($state eq 'exists') {
10429: $output .= $msg;
10430: next;
10431: }
10432: }
10433: # Check if extension is valid
10434: if (($fname =~ /\.(\w+)$/) &&
10435: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10436: $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 10437: next;
10438: } elsif (($fname =~ /\.(\w+)$/) &&
10439: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10440: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10441: next;
10442: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 10443: $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 10444: next;
10445: }
10446: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 10447: my $subdir = $path;
10448: $subdir =~ s{/+$}{};
1.661 raeburn 10449: if ($context eq 'portfolio') {
1.984 raeburn 10450: my $result;
10451: if ($state eq 'existingfile') {
10452: $result=
10453: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 10454: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 10455: } else {
1.984 raeburn 10456: $result=
10457: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10458: $dirpath.
1.1123 raeburn 10459: $env{'form.currentpath'}.$subdir);
1.984 raeburn 10460: if ($result !~ m|^/uploaded/|) {
10461: $output .= '<span class="LC_error">'
10462: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10463: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10464: .'</span><br />';
10465: next;
10466: } else {
1.987 raeburn 10467: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10468: $path.$fname.'</span>').'<br />';
1.984 raeburn 10469: }
1.661 raeburn 10470: }
1.1123 raeburn 10471: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 10472: my $extendedsubdir = $dirpath.'/'.$subdir;
10473: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 10474: my $result =
1.1126 raeburn 10475: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 10476: if ($result !~ m|^/uploaded/|) {
10477: $output .= '<span class="LC_error">'
10478: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10479: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10480: .'</span><br />';
10481: next;
10482: } else {
10483: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10484: $path.$fname.'</span>').'<br />';
1.1125 raeburn 10485: if ($context eq 'syllabus') {
10486: &Apache::lonnet::make_public_indefinitely($result);
10487: }
1.987 raeburn 10488: }
1.661 raeburn 10489: } else {
10490: # Save the file
10491: my $target = $env{'form.embedded_item_'.$i};
10492: my $fullpath = $dir_root.$dirpath.'/'.$path;
10493: my $dest = $fullpath.$fname;
10494: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10495: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10496: my $count;
10497: my $filepath = $dir_root;
1.1027 raeburn 10498: foreach my $subdir (@parts) {
10499: $filepath .= "/$subdir";
10500: if (!-e $filepath) {
1.661 raeburn 10501: mkdir($filepath,0770);
10502: }
10503: }
10504: my $fh;
10505: if (!open($fh,'>'.$dest)) {
10506: &Apache::lonnet::logthis('Failed to create '.$dest);
10507: $output .= '<span class="LC_error">'.
1.1071 raeburn 10508: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10509: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10510: '</span><br />';
10511: } else {
10512: if (!print $fh $env{'form.embedded_item_'.$i}) {
10513: &Apache::lonnet::logthis('Failed to write to '.$dest);
10514: $output .= '<span class="LC_error">'.
1.1071 raeburn 10515: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10516: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10517: '</span><br />';
10518: } else {
1.987 raeburn 10519: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10520: $url.'</span>').'<br />';
10521: unless ($context eq 'testbank') {
10522: $footer .= &mt('View embedded file: [_1]',
10523: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10524: }
10525: }
10526: close($fh);
10527: }
10528: }
10529: if ($env{'form.embedded_ref_'.$i}) {
10530: $pathchange{$i} = 1;
10531: }
10532: }
10533: if ($output) {
10534: $output = '<p>'.$output.'</p>';
10535: }
10536: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10537: $returnflag = 'ok';
1.1071 raeburn 10538: my $numpathchgs = scalar(keys(%pathchange));
10539: if ($numpathchgs > 0) {
1.987 raeburn 10540: if ($context eq 'portfolio') {
10541: $output .= '<p>'.&mt('or').'</p>';
10542: } elsif ($context eq 'testbank') {
1.1071 raeburn 10543: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10544: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10545: $returnflag = 'modify_orightml';
10546: }
10547: }
1.1071 raeburn 10548: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10549: }
10550:
10551: sub modify_html_form {
10552: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10553: my $end = 0;
10554: my $modifyform;
10555: if ($context eq 'upload_embedded') {
10556: return unless (ref($pathchange) eq 'HASH');
10557: if ($env{'form.number_embedded_items'}) {
10558: $end += $env{'form.number_embedded_items'};
10559: }
10560: if ($env{'form.number_pathchange_items'}) {
10561: $end += $env{'form.number_pathchange_items'};
10562: }
10563: if ($end) {
10564: for (my $i=0; $i<$end; $i++) {
10565: if ($i < $env{'form.number_embedded_items'}) {
10566: next unless($pathchange->{$i});
10567: }
10568: $modifyform .=
10569: &start_data_table_row().
10570: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10571: 'checked="checked" /></td>'.
10572: '<td>'.$env{'form.embedded_ref_'.$i}.
10573: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10574: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10575: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10576: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10577: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10578: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10579: '<td>'.$env{'form.embedded_orig_'.$i}.
10580: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10581: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10582: &end_data_table_row();
1.1071 raeburn 10583: }
1.987 raeburn 10584: }
10585: } else {
10586: $modifyform = $pathchgtable;
10587: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10588: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10589: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10590: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10591: }
10592: }
10593: if ($modifyform) {
1.1071 raeburn 10594: if ($actionurl eq '/adm/dependencies') {
10595: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10596: }
1.987 raeburn 10597: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10598: '<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".
10599: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10600: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10601: '</ol></p>'."\n".'<p>'.
10602: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10603: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10604: &start_data_table()."\n".
10605: &start_data_table_header_row().
10606: '<th>'.&mt('Change?').'</th>'.
10607: '<th>'.&mt('Current reference').'</th>'.
10608: '<th>'.&mt('Required reference').'</th>'.
10609: &end_data_table_header_row()."\n".
10610: $modifyform.
10611: &end_data_table().'<br />'."\n".$hiddenstate.
10612: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10613: '</form>'."\n";
10614: }
10615: return;
10616: }
10617:
10618: sub modify_html_refs {
1.1123 raeburn 10619: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 10620: my $container;
10621: if ($context eq 'portfolio') {
10622: $container = $env{'form.container'};
10623: } elsif ($context eq 'coursedoc') {
10624: $container = $env{'form.primaryurl'};
1.1071 raeburn 10625: } elsif ($context eq 'manage_dependencies') {
10626: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10627: $container = "/$container";
1.1123 raeburn 10628: } elsif ($context eq 'syllabus') {
10629: $container = $url;
1.987 raeburn 10630: } else {
1.1027 raeburn 10631: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10632: }
10633: my (%allfiles,%codebase,$output,$content);
10634: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 10635: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 10636: if (wantarray) {
10637: return ('',0,0);
10638: } else {
10639: return;
10640: }
10641: }
10642: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 10643: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 10644: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10645: if (wantarray) {
10646: return ('',0,0);
10647: } else {
10648: return;
10649: }
10650: }
1.987 raeburn 10651: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10652: if ($content eq '-1') {
10653: if (wantarray) {
10654: return ('',0,0);
10655: } else {
10656: return;
10657: }
10658: }
1.987 raeburn 10659: } else {
1.1071 raeburn 10660: unless ($container =~ /^\Q$dir_root\E/) {
10661: if (wantarray) {
10662: return ('',0,0);
10663: } else {
10664: return;
10665: }
10666: }
1.987 raeburn 10667: if (open(my $fh,"<$container")) {
10668: $content = join('', <$fh>);
10669: close($fh);
10670: } else {
1.1071 raeburn 10671: if (wantarray) {
10672: return ('',0,0);
10673: } else {
10674: return;
10675: }
1.987 raeburn 10676: }
10677: }
10678: my ($count,$codebasecount) = (0,0);
10679: my $mm = new File::MMagic;
10680: my $mime_type = $mm->checktype_contents($content);
10681: if ($mime_type eq 'text/html') {
10682: my $parse_result =
10683: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10684: \%codebase,\$content);
10685: if ($parse_result eq 'ok') {
10686: foreach my $i (@changes) {
10687: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10688: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10689: if ($allfiles{$ref}) {
10690: my $newname = $orig;
10691: my ($attrib_regexp,$codebase);
1.1006 raeburn 10692: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10693: if ($attrib_regexp =~ /:/) {
10694: $attrib_regexp =~ s/\:/|/g;
10695: }
10696: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10697: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10698: $count += $numchg;
1.1123 raeburn 10699: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 10700: delete($allfiles{$ref});
1.987 raeburn 10701: }
10702: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10703: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10704: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10705: $codebasecount ++;
10706: }
10707: }
10708: }
1.1123 raeburn 10709: my $skiprewrites;
1.987 raeburn 10710: if ($count || $codebasecount) {
10711: my $saveresult;
1.1071 raeburn 10712: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 10713: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 10714: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10715: if ($url eq $container) {
10716: my ($fname) = ($container =~ m{/([^/]+)$});
10717: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10718: $count,'<span class="LC_filename">'.
1.1071 raeburn 10719: $fname.'</span>').'</p>';
1.987 raeburn 10720: } else {
10721: $output = '<p class="LC_error">'.
10722: &mt('Error: update failed for: [_1].',
10723: '<span class="LC_filename">'.
10724: $container.'</span>').'</p>';
10725: }
1.1123 raeburn 10726: if ($context eq 'syllabus') {
10727: unless ($saveresult eq 'ok') {
10728: $skiprewrites = 1;
10729: }
10730: }
1.987 raeburn 10731: } else {
10732: if (open(my $fh,">$container")) {
10733: print $fh $content;
10734: close($fh);
10735: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10736: $count,'<span class="LC_filename">'.
10737: $container.'</span>').'</p>';
1.661 raeburn 10738: } else {
1.987 raeburn 10739: $output = '<p class="LC_error">'.
10740: &mt('Error: could not update [_1].',
10741: '<span class="LC_filename">'.
10742: $container.'</span>').'</p>';
1.661 raeburn 10743: }
10744: }
10745: }
1.1123 raeburn 10746: if (($context eq 'syllabus') && (!$skiprewrites)) {
10747: my ($actionurl,$state);
10748: $actionurl = "/public/$udom/$uname/syllabus";
10749: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
10750: &ask_for_embedded_content($actionurl,$state,\%allfiles,
10751: \%codebase,
10752: {'context' => 'rewrites',
10753: 'ignore_remote_references' => 1,});
10754: if (ref($mapping) eq 'HASH') {
10755: my $rewrites = 0;
10756: foreach my $key (keys(%{$mapping})) {
10757: next if ($key =~ m{^https?://});
10758: my $ref = $mapping->{$key};
10759: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
10760: my $attrib;
10761: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
10762: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
10763: }
10764: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10765: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10766: $rewrites += $numchg;
10767: }
10768: }
10769: if ($rewrites) {
10770: my $saveresult;
10771: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10772: if ($url eq $container) {
10773: my ($fname) = ($container =~ m{/([^/]+)$});
10774: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
10775: $count,'<span class="LC_filename">'.
10776: $fname.'</span>').'</p>';
10777: } else {
10778: $output .= '<p class="LC_error">'.
10779: &mt('Error: could not update links in [_1].',
10780: '<span class="LC_filename">'.
10781: $container.'</span>').'</p>';
10782:
10783: }
10784: }
10785: }
10786: }
1.987 raeburn 10787: } else {
10788: &logthis('Failed to parse '.$container.
10789: ' to modify references: '.$parse_result);
1.661 raeburn 10790: }
10791: }
1.1071 raeburn 10792: if (wantarray) {
10793: return ($output,$count,$codebasecount);
10794: } else {
10795: return $output;
10796: }
1.661 raeburn 10797: }
10798:
10799: sub check_for_existing {
10800: my ($path,$fname,$element) = @_;
10801: my ($state,$msg);
10802: if (-d $path.'/'.$fname) {
10803: $state = 'exists';
10804: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10805: } elsif (-e $path.'/'.$fname) {
10806: $state = 'exists';
10807: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10808: }
10809: if ($state eq 'exists') {
10810: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10811: }
10812: return ($state,$msg);
10813: }
10814:
10815: sub check_for_upload {
10816: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10817: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10818: my $filesize = length($env{'form.'.$element});
10819: if (!$filesize) {
10820: my $msg = '<span class="LC_error">'.
10821: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10822: '<span class="LC_filename">'.$fname.'</span>',
10823: $filesize).'<br />'.
1.1007 raeburn 10824: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10825: '</span>';
10826: return ('zero_bytes',$msg);
10827: }
10828: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10829: my $getpropath = 1;
1.1021 raeburn 10830: my ($dirlistref,$listerror) =
10831: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10832: my $found_file = 0;
10833: my $locked_file = 0;
1.991 raeburn 10834: my @lockers;
10835: my $navmap;
10836: if ($env{'request.course.id'}) {
10837: $navmap = Apache::lonnavmaps::navmap->new();
10838: }
1.1021 raeburn 10839: if (ref($dirlistref) eq 'ARRAY') {
10840: foreach my $line (@{$dirlistref}) {
10841: my ($file_name,$rest)=split(/\&/,$line,2);
10842: if ($file_name eq $fname){
10843: $file_name = $path.$file_name;
10844: if ($group ne '') {
10845: $file_name = $group.$file_name;
10846: }
10847: $found_file = 1;
10848: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10849: foreach my $lock (@lockers) {
10850: if (ref($lock) eq 'ARRAY') {
10851: my ($symb,$crsid) = @{$lock};
10852: if ($crsid eq $env{'request.course.id'}) {
10853: if (ref($navmap)) {
10854: my $res = $navmap->getBySymb($symb);
10855: foreach my $part (@{$res->parts()}) {
10856: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10857: unless (($slot_status == $res->RESERVED) ||
10858: ($slot_status == $res->RESERVED_LOCATION)) {
10859: $locked_file = 1;
10860: }
1.991 raeburn 10861: }
1.1021 raeburn 10862: } else {
10863: $locked_file = 1;
1.991 raeburn 10864: }
10865: } else {
10866: $locked_file = 1;
10867: }
10868: }
1.1021 raeburn 10869: }
10870: } else {
10871: my @info = split(/\&/,$rest);
10872: my $currsize = $info[6]/1000;
10873: if ($currsize < $filesize) {
10874: my $extra = $filesize - $currsize;
10875: if (($current_disk_usage + $extra) > $disk_quota) {
10876: my $msg = '<span class="LC_error">'.
10877: &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.',
10878: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10879: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10880: $disk_quota,$current_disk_usage);
10881: return ('will_exceed_quota',$msg);
10882: }
1.984 raeburn 10883: }
10884: }
1.661 raeburn 10885: }
10886: }
10887: }
10888: if (($current_disk_usage + $filesize) > $disk_quota){
10889: my $msg = '<span class="LC_error">'.
10890: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10891: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10892: return ('will_exceed_quota',$msg);
10893: } elsif ($found_file) {
10894: if ($locked_file) {
10895: my $msg = '<span class="LC_error">';
10896: $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>');
10897: $msg .= '</span><br />';
10898: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10899: return ('file_locked',$msg);
10900: } else {
10901: my $msg = '<span class="LC_error">';
1.984 raeburn 10902: $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 10903: $msg .= '</span>';
1.984 raeburn 10904: return ('existingfile',$msg);
1.661 raeburn 10905: }
10906: }
10907: }
10908:
1.987 raeburn 10909: sub check_for_traversal {
10910: my ($path,$url,$toplevel) = @_;
10911: my @parts=split(/\//,$path);
10912: my $cleanpath;
10913: my $fullpath = $url;
10914: for (my $i=0;$i<@parts;$i++) {
10915: next if ($parts[$i] eq '.');
10916: if ($parts[$i] eq '..') {
10917: $fullpath =~ s{([^/]+/)$}{};
10918: } else {
10919: $fullpath .= $parts[$i].'/';
10920: }
10921: }
10922: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10923: $cleanpath = $1;
10924: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10925: my $curr_toprel = $1;
10926: my @parts = split(/\//,$curr_toprel);
10927: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10928: my @urlparts = split(/\//,$url_toprel);
10929: my $doubledots;
10930: my $startdiff = -1;
10931: for (my $i=0; $i<@urlparts; $i++) {
10932: if ($startdiff == -1) {
10933: unless ($urlparts[$i] eq $parts[$i]) {
10934: $startdiff = $i;
10935: $doubledots .= '../';
10936: }
10937: } else {
10938: $doubledots .= '../';
10939: }
10940: }
10941: if ($startdiff > -1) {
10942: $cleanpath = $doubledots;
10943: for (my $i=$startdiff; $i<@parts; $i++) {
10944: $cleanpath .= $parts[$i].'/';
10945: }
10946: }
10947: }
10948: $cleanpath =~ s{(/)$}{};
10949: return $cleanpath;
10950: }
1.31 albertel 10951:
1.1053 raeburn 10952: sub is_archive_file {
10953: my ($mimetype) = @_;
10954: if (($mimetype eq 'application/octet-stream') ||
10955: ($mimetype eq 'application/x-stuffit') ||
10956: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10957: return 1;
10958: }
10959: return;
10960: }
10961:
10962: sub decompress_form {
1.1065 raeburn 10963: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10964: my %lt = &Apache::lonlocal::texthash (
10965: this => 'This file is an archive file.',
1.1067 raeburn 10966: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10967: itsc => 'Its contents are as follows:',
1.1053 raeburn 10968: youm => 'You may wish to extract its contents.',
10969: extr => 'Extract contents',
1.1067 raeburn 10970: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10971: proa => 'Process automatically?',
1.1053 raeburn 10972: yes => 'Yes',
10973: no => 'No',
1.1067 raeburn 10974: fold => 'Title for folder containing movie',
10975: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10976: );
1.1065 raeburn 10977: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10978: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10979: my $info = &list_archive_contents($fileloc,\@paths);
10980: if (@paths) {
10981: foreach my $path (@paths) {
10982: $path =~ s{^/}{};
1.1067 raeburn 10983: if ($path =~ m{^([^/]+)/$}) {
10984: $topdir = $1;
10985: }
1.1065 raeburn 10986: if ($path =~ m{^([^/]+)/}) {
10987: $toplevel{$1} = $path;
10988: } else {
10989: $toplevel{$path} = $path;
10990: }
10991: }
10992: }
1.1067 raeburn 10993: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10994: my @camtasia = ("$topdir/","$topdir/index.html",
10995: "$topdir/media/",
10996: "$topdir/media/$topdir.mp4",
10997: "$topdir/media/FirstFrame.png",
10998: "$topdir/media/player.swf",
10999: "$topdir/media/swfobject.js",
11000: "$topdir/media/expressInstall.swf");
11001: my @diffs = &compare_arrays(\@paths,\@camtasia);
11002: if (@diffs == 0) {
11003: $is_camtasia = 1;
11004: }
11005: }
11006: my $output;
11007: if ($is_camtasia) {
11008: $output = <<"ENDCAM";
11009: <script type="text/javascript" language="Javascript">
11010: // <![CDATA[
11011:
11012: function camtasiaToggle() {
11013: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
11014: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
11015: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
11016:
11017: document.getElementById('camtasia_titles').style.display='block';
11018: } else {
11019: document.getElementById('camtasia_titles').style.display='none';
11020: }
11021: }
11022: }
11023: return;
11024: }
11025:
11026: // ]]>
11027: </script>
11028: <p>$lt{'camt'}</p>
11029: ENDCAM
1.1065 raeburn 11030: } else {
1.1067 raeburn 11031: $output = '<p>'.$lt{'this'};
11032: if ($info eq '') {
11033: $output .= ' '.$lt{'youm'}.'</p>'."\n";
11034: } else {
11035: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
11036: '<div><pre>'.$info.'</pre></div>';
11037: }
1.1065 raeburn 11038: }
1.1067 raeburn 11039: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 11040: my $duplicates;
11041: my $num = 0;
11042: if (ref($dirlist) eq 'ARRAY') {
11043: foreach my $item (@{$dirlist}) {
11044: if (ref($item) eq 'ARRAY') {
11045: if (exists($toplevel{$item->[0]})) {
11046: $duplicates .=
11047: &start_data_table_row().
11048: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
11049: 'value="0" checked="checked" />'.&mt('No').'</label>'.
11050: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
11051: 'value="1" />'.&mt('Yes').'</label>'.
11052: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
11053: '<td>'.$item->[0].'</td>';
11054: if ($item->[2]) {
11055: $duplicates .= '<td>'.&mt('Directory').'</td>';
11056: } else {
11057: $duplicates .= '<td>'.&mt('File').'</td>';
11058: }
11059: $duplicates .= '<td>'.$item->[3].'</td>'.
11060: '<td>'.
11061: &Apache::lonlocal::locallocaltime($item->[4]).
11062: '</td>'.
11063: &end_data_table_row();
11064: $num ++;
11065: }
11066: }
11067: }
11068: }
11069: my $itemcount;
11070: if (@paths > 0) {
11071: $itemcount = scalar(@paths);
11072: } else {
11073: $itemcount = 1;
11074: }
1.1067 raeburn 11075: if ($is_camtasia) {
11076: $output .= $lt{'auto'}.'<br />'.
11077: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
11078: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
11079: $lt{'yes'}.'</label> <label>'.
11080: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
11081: $lt{'no'}.'</label></span><br />'.
11082: '<div id="camtasia_titles" style="display:block">'.
11083: &Apache::lonhtmlcommon::start_pick_box().
11084: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
11085: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
11086: &Apache::lonhtmlcommon::row_closure().
11087: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
11088: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
11089: &Apache::lonhtmlcommon::row_closure(1).
11090: &Apache::lonhtmlcommon::end_pick_box().
11091: '</div>';
11092: }
1.1065 raeburn 11093: $output .=
11094: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 11095: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
11096: "\n";
1.1065 raeburn 11097: if ($duplicates ne '') {
11098: $output .= '<p><span class="LC_warning">'.
11099: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
11100: &start_data_table().
11101: &start_data_table_header_row().
11102: '<th>'.&mt('Overwrite?').'</th>'.
11103: '<th>'.&mt('Name').'</th>'.
11104: '<th>'.&mt('Type').'</th>'.
11105: '<th>'.&mt('Size').'</th>'.
11106: '<th>'.&mt('Last modified').'</th>'.
11107: &end_data_table_header_row().
11108: $duplicates.
11109: &end_data_table().
11110: '</p>';
11111: }
1.1067 raeburn 11112: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 11113: if (ref($hiddenelements) eq 'HASH') {
11114: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
11115: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
11116: }
11117: }
11118: $output .= <<"END";
1.1067 raeburn 11119: <br />
1.1053 raeburn 11120: <input type="submit" name="decompress" value="$lt{'extr'}" />
11121: </form>
11122: $noextract
11123: END
11124: return $output;
11125: }
11126:
1.1065 raeburn 11127: sub decompression_utility {
11128: my ($program) = @_;
11129: my @utilities = ('tar','gunzip','bunzip2','unzip');
11130: my $location;
11131: if (grep(/^\Q$program\E$/,@utilities)) {
11132: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
11133: '/usr/sbin/') {
11134: if (-x $dir.$program) {
11135: $location = $dir.$program;
11136: last;
11137: }
11138: }
11139: }
11140: return $location;
11141: }
11142:
11143: sub list_archive_contents {
11144: my ($file,$pathsref) = @_;
11145: my (@cmd,$output);
11146: my $needsregexp;
11147: if ($file =~ /\.zip$/) {
11148: @cmd = (&decompression_utility('unzip'),"-l");
11149: $needsregexp = 1;
11150: } elsif (($file =~ m/\.tar\.gz$/) ||
11151: ($file =~ /\.tgz$/)) {
11152: @cmd = (&decompression_utility('tar'),"-ztf");
11153: } elsif ($file =~ /\.tar\.bz2$/) {
11154: @cmd = (&decompression_utility('tar'),"-jtf");
11155: } elsif ($file =~ m|\.tar$|) {
11156: @cmd = (&decompression_utility('tar'),"-tf");
11157: }
11158: if (@cmd) {
11159: undef($!);
11160: undef($@);
11161: if (open(my $fh,"-|", @cmd, $file)) {
11162: while (my $line = <$fh>) {
11163: $output .= $line;
11164: chomp($line);
11165: my $item;
11166: if ($needsregexp) {
11167: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
11168: } else {
11169: $item = $line;
11170: }
11171: if ($item ne '') {
11172: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
11173: push(@{$pathsref},$item);
11174: }
11175: }
11176: }
11177: close($fh);
11178: }
11179: }
11180: return $output;
11181: }
11182:
1.1053 raeburn 11183: sub decompress_uploaded_file {
11184: my ($file,$dir) = @_;
11185: &Apache::lonnet::appenv({'cgi.file' => $file});
11186: &Apache::lonnet::appenv({'cgi.dir' => $dir});
11187: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
11188: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
11189: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
11190: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
11191: my $decompressed = $env{'cgi.decompressed'};
11192: &Apache::lonnet::delenv('cgi.file');
11193: &Apache::lonnet::delenv('cgi.dir');
11194: &Apache::lonnet::delenv('cgi.decompressed');
11195: return ($decompressed,$result);
11196: }
11197:
1.1055 raeburn 11198: sub process_decompression {
11199: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
11200: my ($dir,$error,$warning,$output);
11201: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
1.1120 bisitz 11202: $error = &mt('Filename not a supported archive file type.').
11203: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 11204: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
11205: } else {
11206: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11207: if ($docuhome eq 'no_host') {
11208: $error = &mt('Could not determine home server for course.');
11209: } else {
11210: my @ids=&Apache::lonnet::current_machine_ids();
11211: my $currdir = "$dir_root/$destination";
11212: if (grep(/^\Q$docuhome\E$/,@ids)) {
11213: $dir = &LONCAPA::propath($docudom,$docuname).
11214: "$dir_root/$destination";
11215: } else {
11216: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
11217: "$dir_root/$docudom/$docuname/$destination";
11218: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
11219: $error = &mt('Archive file not found.');
11220: }
11221: }
1.1065 raeburn 11222: my (@to_overwrite,@to_skip);
11223: if ($env{'form.archive_overwrite_total'} > 0) {
11224: my $total = $env{'form.archive_overwrite_total'};
11225: for (my $i=0; $i<$total; $i++) {
11226: if ($env{'form.archive_overwrite_'.$i} == 1) {
11227: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
11228: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
11229: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
11230: }
11231: }
11232: }
11233: my $numskip = scalar(@to_skip);
11234: if (($numskip > 0) &&
11235: ($numskip == $env{'form.archive_itemcount'})) {
11236: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
11237: } elsif ($dir eq '') {
1.1055 raeburn 11238: $error = &mt('Directory containing archive file unavailable.');
11239: } elsif (!$error) {
1.1065 raeburn 11240: my ($decompressed,$display);
11241: if ($numskip > 0) {
11242: my $tempdir = time.'_'.$$.int(rand(10000));
11243: mkdir("$dir/$tempdir",0755);
11244: system("mv $dir/$file $dir/$tempdir/$file");
11245: ($decompressed,$display) =
11246: &decompress_uploaded_file($file,"$dir/$tempdir");
11247: foreach my $item (@to_skip) {
11248: if (($item ne '') && ($item !~ /\.\./)) {
11249: if (-f "$dir/$tempdir/$item") {
11250: unlink("$dir/$tempdir/$item");
11251: } elsif (-d "$dir/$tempdir/$item") {
11252: system("rm -rf $dir/$tempdir/$item");
11253: }
11254: }
11255: }
11256: system("mv $dir/$tempdir/* $dir");
11257: rmdir("$dir/$tempdir");
11258: } else {
11259: ($decompressed,$display) =
11260: &decompress_uploaded_file($file,$dir);
11261: }
1.1055 raeburn 11262: if ($decompressed eq 'ok') {
1.1065 raeburn 11263: $output = '<p class="LC_info">'.
11264: &mt('Files extracted successfully from archive.').
11265: '</p>'."\n";
1.1055 raeburn 11266: my ($warning,$result,@contents);
11267: my ($newdirlistref,$newlisterror) =
11268: &Apache::lonnet::dirlist($currdir,$docudom,
11269: $docuname,1);
11270: my (%is_dir,%changes,@newitems);
11271: my $dirptr = 16384;
1.1065 raeburn 11272: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 11273: foreach my $dir_line (@{$newdirlistref}) {
11274: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 11275: unless (($item =~ /^\.+$/) || ($item eq $file) ||
11276: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 11277: push(@newitems,$item);
11278: if ($dirptr&$testdir) {
11279: $is_dir{$item} = 1;
11280: }
11281: $changes{$item} = 1;
11282: }
11283: }
11284: }
11285: if (keys(%changes) > 0) {
11286: foreach my $item (sort(@newitems)) {
11287: if ($changes{$item}) {
11288: push(@contents,$item);
11289: }
11290: }
11291: }
11292: if (@contents > 0) {
1.1067 raeburn 11293: my $wantform;
11294: unless ($env{'form.autoextract_camtasia'}) {
11295: $wantform = 1;
11296: }
1.1056 raeburn 11297: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 11298: my ($count,$datatable) = &get_extracted($docudom,$docuname,
11299: $currdir,\%is_dir,
11300: \%children,\%parent,
1.1056 raeburn 11301: \@contents,\%dirorder,
11302: \%titles,$wantform);
1.1055 raeburn 11303: if ($datatable ne '') {
11304: $output .= &archive_options_form('decompressed',$datatable,
11305: $count,$hiddenelem);
1.1065 raeburn 11306: my $startcount = 6;
1.1055 raeburn 11307: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 11308: \%titles,\%children);
1.1055 raeburn 11309: }
1.1067 raeburn 11310: if ($env{'form.autoextract_camtasia'}) {
11311: my %displayed;
11312: my $total = 1;
11313: $env{'form.archive_directory'} = [];
11314: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
11315: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
11316: $path =~ s{/$}{};
11317: my $item;
11318: if ($path ne '') {
11319: $item = "$path/$titles{$i}";
11320: } else {
11321: $item = $titles{$i};
11322: }
11323: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
11324: if ($item eq $contents[0]) {
11325: push(@{$env{'form.archive_directory'}},$i);
11326: $env{'form.archive_'.$i} = 'display';
11327: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
11328: $displayed{'folder'} = $i;
11329: } elsif ($item eq "$contents[0]/index.html") {
11330: $env{'form.archive_'.$i} = 'display';
11331: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
11332: $displayed{'web'} = $i;
11333: } else {
11334: if ($item eq "$contents[0]/media") {
11335: push(@{$env{'form.archive_directory'}},$i);
11336: }
11337: $env{'form.archive_'.$i} = 'dependency';
11338: }
11339: $total ++;
11340: }
11341: for (my $i=1; $i<$total; $i++) {
11342: next if ($i == $displayed{'web'});
11343: next if ($i == $displayed{'folder'});
11344: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
11345: }
11346: $env{'form.phase'} = 'decompress_cleanup';
11347: $env{'form.archivedelete'} = 1;
11348: $env{'form.archive_count'} = $total-1;
11349: $output .=
11350: &process_extracted_files('coursedocs',$docudom,
11351: $docuname,$destination,
11352: $dir_root,$hiddenelem);
11353: }
1.1055 raeburn 11354: } else {
11355: $warning = &mt('No new items extracted from archive file.');
11356: }
11357: } else {
11358: $output = $display;
11359: $error = &mt('An error occurred during extraction from the archive file.');
11360: }
11361: }
11362: }
11363: }
11364: if ($error) {
11365: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11366: $error.'</p>'."\n";
11367: }
11368: if ($warning) {
11369: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11370: }
11371: return $output;
11372: }
11373:
11374: sub get_extracted {
1.1056 raeburn 11375: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
11376: $titles,$wantform) = @_;
1.1055 raeburn 11377: my $count = 0;
11378: my $depth = 0;
11379: my $datatable;
1.1056 raeburn 11380: my @hierarchy;
1.1055 raeburn 11381: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 11382: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
11383: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 11384: foreach my $item (@{$contents}) {
11385: $count ++;
1.1056 raeburn 11386: @{$dirorder->{$count}} = @hierarchy;
11387: $titles->{$count} = $item;
1.1055 raeburn 11388: &archive_hierarchy($depth,$count,$parent,$children);
11389: if ($wantform) {
11390: $datatable .= &archive_row($is_dir->{$item},$item,
11391: $currdir,$depth,$count);
11392: }
11393: if ($is_dir->{$item}) {
11394: $depth ++;
1.1056 raeburn 11395: push(@hierarchy,$count);
11396: $parent->{$depth} = $count;
1.1055 raeburn 11397: $datatable .=
11398: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 11399: \$depth,\$count,\@hierarchy,$dirorder,
11400: $children,$parent,$titles,$wantform);
1.1055 raeburn 11401: $depth --;
1.1056 raeburn 11402: pop(@hierarchy);
1.1055 raeburn 11403: }
11404: }
11405: return ($count,$datatable);
11406: }
11407:
11408: sub recurse_extracted_archive {
1.1056 raeburn 11409: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
11410: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 11411: my $result='';
1.1056 raeburn 11412: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
11413: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
11414: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 11415: return $result;
11416: }
11417: my $dirptr = 16384;
11418: my ($newdirlistref,$newlisterror) =
11419: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
11420: if (ref($newdirlistref) eq 'ARRAY') {
11421: foreach my $dir_line (@{$newdirlistref}) {
11422: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
11423: unless ($item =~ /^\.+$/) {
11424: $$count ++;
1.1056 raeburn 11425: @{$dirorder->{$$count}} = @{$hierarchy};
11426: $titles->{$$count} = $item;
1.1055 raeburn 11427: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 11428:
1.1055 raeburn 11429: my $is_dir;
11430: if ($dirptr&$testdir) {
11431: $is_dir = 1;
11432: }
11433: if ($wantform) {
11434: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
11435: }
11436: if ($is_dir) {
11437: $$depth ++;
1.1056 raeburn 11438: push(@{$hierarchy},$$count);
11439: $parent->{$$depth} = $$count;
1.1055 raeburn 11440: $result .=
11441: &recurse_extracted_archive("$currdir/$item",$docudom,
11442: $docuname,$depth,$count,
1.1056 raeburn 11443: $hierarchy,$dirorder,$children,
11444: $parent,$titles,$wantform);
1.1055 raeburn 11445: $$depth --;
1.1056 raeburn 11446: pop(@{$hierarchy});
1.1055 raeburn 11447: }
11448: }
11449: }
11450: }
11451: return $result;
11452: }
11453:
11454: sub archive_hierarchy {
11455: my ($depth,$count,$parent,$children) =@_;
11456: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
11457: if (exists($parent->{$depth})) {
11458: $children->{$parent->{$depth}} .= $count.':';
11459: }
11460: }
11461: return;
11462: }
11463:
11464: sub archive_row {
11465: my ($is_dir,$item,$currdir,$depth,$count) = @_;
11466: my ($name) = ($item =~ m{([^/]+)$});
11467: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 11468: 'display' => 'Add as file',
1.1055 raeburn 11469: 'dependency' => 'Include as dependency',
11470: 'discard' => 'Discard',
11471: );
11472: if ($is_dir) {
1.1059 raeburn 11473: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 11474: }
1.1056 raeburn 11475: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11476: my $offset = 0;
1.1055 raeburn 11477: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11478: $offset ++;
1.1065 raeburn 11479: if ($action ne 'display') {
11480: $offset ++;
11481: }
1.1055 raeburn 11482: $output .= '<td><span class="LC_nobreak">'.
11483: '<label><input type="radio" name="archive_'.$count.
11484: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11485: my $text = $choices{$action};
11486: if ($is_dir) {
11487: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11488: if ($action eq 'display') {
1.1059 raeburn 11489: $text = &mt('Add as folder');
1.1055 raeburn 11490: }
1.1056 raeburn 11491: } else {
11492: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11493:
11494: }
11495: $output .= ' /> '.$choices{$action}.'</label></span>';
11496: if ($action eq 'dependency') {
11497: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11498: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11499: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11500: '<option value=""></option>'."\n".
11501: '</select>'."\n".
11502: '</div>';
1.1059 raeburn 11503: } elsif ($action eq 'display') {
11504: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11505: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11506: '</div>';
1.1055 raeburn 11507: }
1.1056 raeburn 11508: $output .= '</td>';
1.1055 raeburn 11509: }
11510: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11511: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11512: for (my $i=0; $i<$depth; $i++) {
11513: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11514: }
11515: if ($is_dir) {
11516: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11517: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11518: } else {
11519: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11520: }
11521: $output .= ' '.$name.'</td>'."\n".
11522: &end_data_table_row();
11523: return $output;
11524: }
11525:
11526: sub archive_options_form {
1.1065 raeburn 11527: my ($form,$display,$count,$hiddenelem) = @_;
11528: my %lt = &Apache::lonlocal::texthash(
11529: perm => 'Permanently remove archive file?',
11530: hows => 'How should each extracted item be incorporated in the course?',
11531: cont => 'Content actions for all',
11532: addf => 'Add as folder/file',
11533: incd => 'Include as dependency for a displayed file',
11534: disc => 'Discard',
11535: no => 'No',
11536: yes => 'Yes',
11537: save => 'Save',
11538: );
11539: my $output = <<"END";
11540: <form name="$form" method="post" action="">
11541: <p><span class="LC_nobreak">$lt{'perm'}
11542: <label>
11543: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11544: </label>
11545:
11546: <label>
11547: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11548: </span>
11549: </p>
11550: <input type="hidden" name="phase" value="decompress_cleanup" />
11551: <br />$lt{'hows'}
11552: <div class="LC_columnSection">
11553: <fieldset>
11554: <legend>$lt{'cont'}</legend>
11555: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11556: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11557: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11558: </fieldset>
11559: </div>
11560: END
11561: return $output.
1.1055 raeburn 11562: &start_data_table()."\n".
1.1065 raeburn 11563: $display."\n".
1.1055 raeburn 11564: &end_data_table()."\n".
11565: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11566: $hiddenelem.
1.1065 raeburn 11567: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11568: '</form>';
11569: }
11570:
11571: sub archive_javascript {
1.1056 raeburn 11572: my ($startcount,$numitems,$titles,$children) = @_;
11573: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11574: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11575: my $scripttag = <<START;
11576: <script type="text/javascript">
11577: // <![CDATA[
11578:
11579: function checkAll(form,prefix) {
11580: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11581: for (var i=0; i < form.elements.length; i++) {
11582: var id = form.elements[i].id;
11583: if ((id != '') && (id != undefined)) {
11584: if (idstr.test(id)) {
11585: if (form.elements[i].type == 'radio') {
11586: form.elements[i].checked = true;
1.1056 raeburn 11587: var nostart = i-$startcount;
1.1059 raeburn 11588: var offset = nostart%7;
11589: var count = (nostart-offset)/7;
1.1056 raeburn 11590: dependencyCheck(form,count,offset);
1.1055 raeburn 11591: }
11592: }
11593: }
11594: }
11595: }
11596:
11597: function propagateCheck(form,count) {
11598: if (count > 0) {
1.1059 raeburn 11599: var startelement = $startcount + ((count-1) * 7);
11600: for (var j=1; j<6; j++) {
11601: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11602: var item = startelement + j;
11603: if (form.elements[item].type == 'radio') {
11604: if (form.elements[item].checked) {
11605: containerCheck(form,count,j);
11606: break;
11607: }
1.1055 raeburn 11608: }
11609: }
11610: }
11611: }
11612: }
11613:
11614: numitems = $numitems
1.1056 raeburn 11615: var titles = new Array(numitems);
11616: var parents = new Array(numitems);
1.1055 raeburn 11617: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11618: parents[i] = new Array;
1.1055 raeburn 11619: }
1.1059 raeburn 11620: var maintitle = '$maintitle';
1.1055 raeburn 11621:
11622: START
11623:
1.1056 raeburn 11624: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11625: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11626: for (my $i=0; $i<@contents; $i ++) {
11627: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11628: }
11629: }
11630:
1.1056 raeburn 11631: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11632: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11633: }
11634:
1.1055 raeburn 11635: $scripttag .= <<END;
11636:
11637: function containerCheck(form,count,offset) {
11638: if (count > 0) {
1.1056 raeburn 11639: dependencyCheck(form,count,offset);
1.1059 raeburn 11640: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11641: form.elements[item].checked = true;
11642: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11643: if (parents[count].length > 0) {
11644: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11645: containerCheck(form,parents[count][j],offset);
11646: }
11647: }
11648: }
11649: }
11650: }
11651:
11652: function dependencyCheck(form,count,offset) {
11653: if (count > 0) {
1.1059 raeburn 11654: var chosen = (offset+$startcount)+7*(count-1);
11655: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11656: var currtype = form.elements[depitem].type;
11657: if (form.elements[chosen].value == 'dependency') {
11658: document.getElementById('arc_depon_'+count).style.display='block';
11659: form.elements[depitem].options.length = 0;
11660: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 11661: for (var i=1; i<=numitems; i++) {
11662: if (i == count) {
11663: continue;
11664: }
1.1059 raeburn 11665: var startelement = $startcount + (i-1) * 7;
11666: for (var j=1; j<6; j++) {
11667: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11668: var item = startelement + j;
11669: if (form.elements[item].type == 'radio') {
11670: if (form.elements[item].checked) {
11671: if (form.elements[item].value == 'display') {
11672: var n = form.elements[depitem].options.length;
11673: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11674: }
11675: }
11676: }
11677: }
11678: }
11679: }
11680: } else {
11681: document.getElementById('arc_depon_'+count).style.display='none';
11682: form.elements[depitem].options.length = 0;
11683: form.elements[depitem].options[0] = new Option('Select','',true,true);
11684: }
1.1059 raeburn 11685: titleCheck(form,count,offset);
1.1056 raeburn 11686: }
11687: }
11688:
11689: function propagateSelect(form,count,offset) {
11690: if (count > 0) {
1.1065 raeburn 11691: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11692: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11693: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11694: if (parents[count].length > 0) {
11695: for (var j=0; j<parents[count].length; j++) {
11696: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11697: }
11698: }
11699: }
11700: }
11701: }
1.1056 raeburn 11702:
11703: function containerSelect(form,count,offset,picked) {
11704: if (count > 0) {
1.1065 raeburn 11705: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11706: if (form.elements[item].type == 'radio') {
11707: if (form.elements[item].value == 'dependency') {
11708: if (form.elements[item+1].type == 'select-one') {
11709: for (var i=0; i<form.elements[item+1].options.length; i++) {
11710: if (form.elements[item+1].options[i].value == picked) {
11711: form.elements[item+1].selectedIndex = i;
11712: break;
11713: }
11714: }
11715: }
11716: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11717: if (parents[count].length > 0) {
11718: for (var j=0; j<parents[count].length; j++) {
11719: containerSelect(form,parents[count][j],offset,picked);
11720: }
11721: }
11722: }
11723: }
11724: }
11725: }
11726: }
11727:
1.1059 raeburn 11728: function titleCheck(form,count,offset) {
11729: if (count > 0) {
11730: var chosen = (offset+$startcount)+7*(count-1);
11731: var depitem = $startcount + ((count-1) * 7) + 2;
11732: var currtype = form.elements[depitem].type;
11733: if (form.elements[chosen].value == 'display') {
11734: document.getElementById('arc_title_'+count).style.display='block';
11735: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11736: document.getElementById('archive_title_'+count).value=maintitle;
11737: }
11738: } else {
11739: document.getElementById('arc_title_'+count).style.display='none';
11740: if (currtype == 'text') {
11741: document.getElementById('archive_title_'+count).value='';
11742: }
11743: }
11744: }
11745: return;
11746: }
11747:
1.1055 raeburn 11748: // ]]>
11749: </script>
11750: END
11751: return $scripttag;
11752: }
11753:
11754: sub process_extracted_files {
1.1067 raeburn 11755: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11756: my $numitems = $env{'form.archive_count'};
11757: return unless ($numitems);
11758: my @ids=&Apache::lonnet::current_machine_ids();
11759: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11760: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11761: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11762: if (grep(/^\Q$docuhome\E$/,@ids)) {
11763: $prefix = &LONCAPA::propath($docudom,$docuname);
11764: $pathtocheck = "$dir_root/$destination";
11765: $dir = $dir_root;
11766: $ishome = 1;
11767: } else {
11768: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11769: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11770: $dir = "$dir_root/$docudom/$docuname";
11771: }
11772: my $currdir = "$dir_root/$destination";
11773: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11774: if ($env{'form.folderpath'}) {
11775: my @items = split('&',$env{'form.folderpath'});
11776: $folders{'0'} = $items[-2];
1.1099 raeburn 11777: if ($env{'form.folderpath'} =~ /\:1$/) {
11778: $containers{'0'}='page';
11779: } else {
11780: $containers{'0'}='sequence';
11781: }
1.1055 raeburn 11782: }
11783: my @archdirs = &get_env_multiple('form.archive_directory');
11784: if ($numitems) {
11785: for (my $i=1; $i<=$numitems; $i++) {
11786: my $path = $env{'form.archive_content_'.$i};
11787: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11788: my $item = $1;
11789: $toplevelitems{$item} = $i;
11790: if (grep(/^\Q$i\E$/,@archdirs)) {
11791: $is_dir{$item} = 1;
11792: }
11793: }
11794: }
11795: }
1.1067 raeburn 11796: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11797: if (keys(%toplevelitems) > 0) {
11798: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11799: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11800: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11801: }
1.1066 raeburn 11802: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11803: if ($numitems) {
11804: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 11805: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11806: my $path = $env{'form.archive_content_'.$i};
11807: if ($path =~ /^\Q$pathtocheck\E/) {
11808: if ($env{'form.archive_'.$i} eq 'discard') {
11809: if ($prefix ne '' && $path ne '') {
11810: if (-e $prefix.$path) {
1.1066 raeburn 11811: if ((@archdirs > 0) &&
11812: (grep(/^\Q$i\E$/,@archdirs))) {
11813: $todeletedir{$prefix.$path} = 1;
11814: } else {
11815: $todelete{$prefix.$path} = 1;
11816: }
1.1055 raeburn 11817: }
11818: }
11819: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11820: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11821: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11822: $docstitle = $env{'form.archive_title_'.$i};
11823: if ($docstitle eq '') {
11824: $docstitle = $title;
11825: }
1.1055 raeburn 11826: $outer = 0;
1.1056 raeburn 11827: if (ref($dirorder{$i}) eq 'ARRAY') {
11828: if (@{$dirorder{$i}} > 0) {
11829: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11830: if ($env{'form.archive_'.$item} eq 'display') {
11831: $outer = $item;
11832: last;
11833: }
11834: }
11835: }
11836: }
11837: my ($errtext,$fatal) =
11838: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11839: '/'.$folders{$outer}.'.'.
11840: $containers{$outer});
11841: next if ($fatal);
11842: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11843: if ($context eq 'coursedocs') {
1.1056 raeburn 11844: $mapinner{$i} = time;
1.1055 raeburn 11845: $folders{$i} = 'default_'.$mapinner{$i};
11846: $containers{$i} = 'sequence';
11847: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11848: $folders{$i}.'.'.$containers{$i};
11849: my $newidx = &LONCAPA::map::getresidx();
11850: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11851: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11852: push(@LONCAPA::map::order,$newidx);
11853: my ($outtext,$errtext) =
11854: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11855: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11856: '.'.$containers{$outer},1,1);
1.1056 raeburn 11857: $newseqid{$i} = $newidx;
1.1067 raeburn 11858: unless ($errtext) {
11859: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11860: }
1.1055 raeburn 11861: }
11862: } else {
11863: if ($context eq 'coursedocs') {
11864: my $newidx=&LONCAPA::map::getresidx();
11865: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11866: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11867: $title;
11868: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11869: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11870: }
11871: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11872: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11873: }
11874: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11875: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11876: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11877: unless ($ishome) {
11878: my $fetch = "$newdest{$i}/$title";
11879: $fetch =~ s/^\Q$prefix$dir\E//;
11880: $prompttofetch{$fetch} = 1;
11881: }
1.1055 raeburn 11882: }
11883: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11884: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11885: push(@LONCAPA::map::order, $newidx);
11886: my ($outtext,$errtext)=
11887: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11888: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11889: '.'.$containers{$outer},1,1);
1.1067 raeburn 11890: unless ($errtext) {
11891: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11892: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11893: }
11894: }
1.1055 raeburn 11895: }
11896: }
1.1086 raeburn 11897: }
11898: } else {
11899: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11900: }
11901: }
11902: for (my $i=1; $i<=$numitems; $i++) {
11903: next unless ($env{'form.archive_'.$i} eq 'dependency');
11904: my $path = $env{'form.archive_content_'.$i};
11905: if ($path =~ /^\Q$pathtocheck\E/) {
11906: my ($title) = ($path =~ m{/([^/]+)$});
11907: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11908: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11909: if (ref($dirorder{$i}) eq 'ARRAY') {
11910: my ($itemidx,$fullpath,$relpath);
11911: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11912: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11913: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 11914: if ($dirorder{$i}->[$j] eq $container) {
11915: $itemidx = $j;
1.1056 raeburn 11916: }
11917: }
1.1086 raeburn 11918: }
11919: if ($itemidx eq '') {
11920: $itemidx = 0;
11921: }
11922: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11923: if ($mapinner{$referrer{$i}}) {
11924: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11925: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11926: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11927: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11928: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11929: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11930: if (!-e $fullpath) {
11931: mkdir($fullpath,0755);
1.1056 raeburn 11932: }
11933: }
1.1086 raeburn 11934: } else {
11935: last;
1.1056 raeburn 11936: }
1.1086 raeburn 11937: }
11938: }
11939: } elsif ($newdest{$referrer{$i}}) {
11940: $fullpath = $newdest{$referrer{$i}};
11941: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11942: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11943: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11944: last;
11945: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11946: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11947: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11948: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11949: if (!-e $fullpath) {
11950: mkdir($fullpath,0755);
1.1056 raeburn 11951: }
11952: }
1.1086 raeburn 11953: } else {
11954: last;
1.1056 raeburn 11955: }
1.1055 raeburn 11956: }
11957: }
1.1086 raeburn 11958: if ($fullpath ne '') {
11959: if (-e "$prefix$path") {
11960: system("mv $prefix$path $fullpath/$title");
11961: }
11962: if (-e "$fullpath/$title") {
11963: my $showpath;
11964: if ($relpath ne '') {
11965: $showpath = "$relpath/$title";
11966: } else {
11967: $showpath = "/$title";
11968: }
11969: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11970: }
11971: unless ($ishome) {
11972: my $fetch = "$fullpath/$title";
11973: $fetch =~ s/^\Q$prefix$dir\E//;
11974: $prompttofetch{$fetch} = 1;
11975: }
11976: }
1.1055 raeburn 11977: }
1.1086 raeburn 11978: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11979: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11980: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11981: }
11982: } else {
11983: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11984: }
11985: }
11986: if (keys(%todelete)) {
11987: foreach my $key (keys(%todelete)) {
11988: unlink($key);
1.1066 raeburn 11989: }
11990: }
11991: if (keys(%todeletedir)) {
11992: foreach my $key (keys(%todeletedir)) {
11993: rmdir($key);
11994: }
11995: }
11996: foreach my $dir (sort(keys(%is_dir))) {
11997: if (($pathtocheck ne '') && ($dir ne '')) {
11998: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11999: }
12000: }
1.1067 raeburn 12001: if ($result ne '') {
12002: $output .= '<ul>'."\n".
12003: $result."\n".
12004: '</ul>';
12005: }
12006: unless ($ishome) {
12007: my $replicationfail;
12008: foreach my $item (keys(%prompttofetch)) {
12009: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
12010: unless ($fetchresult eq 'ok') {
12011: $replicationfail .= '<li>'.$item.'</li>'."\n";
12012: }
12013: }
12014: if ($replicationfail) {
12015: $output .= '<p class="LC_error">'.
12016: &mt('Course home server failed to retrieve:').'<ul>'.
12017: $replicationfail.
12018: '</ul></p>';
12019: }
12020: }
1.1055 raeburn 12021: } else {
12022: $warning = &mt('No items found in archive.');
12023: }
12024: if ($error) {
12025: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12026: $error.'</p>'."\n";
12027: }
12028: if ($warning) {
12029: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12030: }
12031: return $output;
12032: }
12033:
1.1066 raeburn 12034: sub cleanup_empty_dirs {
12035: my ($path) = @_;
12036: if (($path ne '') && (-d $path)) {
12037: if (opendir(my $dirh,$path)) {
12038: my @dircontents = grep(!/^\./,readdir($dirh));
12039: my $numitems = 0;
12040: foreach my $item (@dircontents) {
12041: if (-d "$path/$item") {
1.1111 raeburn 12042: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 12043: if (-e "$path/$item") {
12044: $numitems ++;
12045: }
12046: } else {
12047: $numitems ++;
12048: }
12049: }
12050: if ($numitems == 0) {
12051: rmdir($path);
12052: }
12053: closedir($dirh);
12054: }
12055: }
12056: return;
12057: }
12058:
1.41 ng 12059: =pod
1.45 matthew 12060:
1.1068 raeburn 12061: =item &get_folder_hierarchy()
12062:
12063: Provides hierarchy of names of folders/sub-folders containing the current
12064: item,
12065:
12066: Inputs: 3
12067: - $navmap - navmaps object
12068:
12069: - $map - url for map (either the trigger itself, or map containing
12070: the resource, which is the trigger).
12071:
12072: - $showitem - 1 => show title for map itself; 0 => do not show.
12073:
12074: Outputs: 1 @pathitems - array of folder/subfolder names.
12075:
12076: =cut
12077:
12078: sub get_folder_hierarchy {
12079: my ($navmap,$map,$showitem) = @_;
12080: my @pathitems;
12081: if (ref($navmap)) {
12082: my $mapres = $navmap->getResourceByUrl($map);
12083: if (ref($mapres)) {
12084: my $pcslist = $mapres->map_hierarchy();
12085: if ($pcslist ne '') {
12086: my @pcs = split(/,/,$pcslist);
12087: foreach my $pc (@pcs) {
12088: if ($pc == 1) {
1.1129 raeburn 12089: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 12090: } else {
12091: my $res = $navmap->getByMapPc($pc);
12092: if (ref($res)) {
12093: my $title = $res->compTitle();
12094: $title =~ s/\W+/_/g;
12095: if ($title ne '') {
12096: push(@pathitems,$title);
12097: }
12098: }
12099: }
12100: }
12101: }
1.1071 raeburn 12102: if ($showitem) {
12103: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 12104: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 12105: } else {
12106: my $maptitle = $mapres->compTitle();
12107: $maptitle =~ s/\W+/_/g;
12108: if ($maptitle ne '') {
12109: push(@pathitems,$maptitle);
12110: }
1.1068 raeburn 12111: }
12112: }
12113: }
12114: }
12115: return @pathitems;
12116: }
12117:
12118: =pod
12119:
1.1015 raeburn 12120: =item * &get_turnedin_filepath()
12121:
12122: Determines path in a user's portfolio file for storage of files uploaded
12123: to a specific essayresponse or dropbox item.
12124:
12125: Inputs: 3 required + 1 optional.
12126: $symb is symb for resource, $uname and $udom are for current user (required).
12127: $caller is optional (can be "submission", if routine is called when storing
12128: an upoaded file when "Submit Answer" button was pressed).
12129:
12130: Returns array containing $path and $multiresp.
12131: $path is path in portfolio. $multiresp is 1 if this resource contains more
12132: than one file upload item. Callers of routine should append partid as a
12133: subdirectory to $path in cases where $multiresp is 1.
12134:
12135: Called by: homework/essayresponse.pm and homework/structuretags.pm
12136:
12137: =cut
12138:
12139: sub get_turnedin_filepath {
12140: my ($symb,$uname,$udom,$caller) = @_;
12141: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
12142: my $turnindir;
12143: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
12144: $turnindir = $userhash{'turnindir'};
12145: my ($path,$multiresp);
12146: if ($turnindir eq '') {
12147: if ($caller eq 'submission') {
12148: $turnindir = &mt('turned in');
12149: $turnindir =~ s/\W+/_/g;
12150: my %newhash = (
12151: 'turnindir' => $turnindir,
12152: );
12153: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
12154: }
12155: }
12156: if ($turnindir ne '') {
12157: $path = '/'.$turnindir.'/';
12158: my ($multipart,$turnin,@pathitems);
12159: my $navmap = Apache::lonnavmaps::navmap->new();
12160: if (defined($navmap)) {
12161: my $mapres = $navmap->getResourceByUrl($map);
12162: if (ref($mapres)) {
12163: my $pcslist = $mapres->map_hierarchy();
12164: if ($pcslist ne '') {
12165: foreach my $pc (split(/,/,$pcslist)) {
12166: my $res = $navmap->getByMapPc($pc);
12167: if (ref($res)) {
12168: my $title = $res->compTitle();
12169: $title =~ s/\W+/_/g;
12170: if ($title ne '') {
1.1149 raeburn 12171: if (($pc > 1) && (length($title) > 12)) {
12172: $title = substr($title,0,12);
12173: }
1.1015 raeburn 12174: push(@pathitems,$title);
12175: }
12176: }
12177: }
12178: }
12179: my $maptitle = $mapres->compTitle();
12180: $maptitle =~ s/\W+/_/g;
12181: if ($maptitle ne '') {
1.1149 raeburn 12182: if (length($maptitle) > 12) {
12183: $maptitle = substr($maptitle,0,12);
12184: }
1.1015 raeburn 12185: push(@pathitems,$maptitle);
12186: }
12187: unless ($env{'request.state'} eq 'construct') {
12188: my $res = $navmap->getBySymb($symb);
12189: if (ref($res)) {
12190: my $partlist = $res->parts();
12191: my $totaluploads = 0;
12192: if (ref($partlist) eq 'ARRAY') {
12193: foreach my $part (@{$partlist}) {
12194: my @types = $res->responseType($part);
12195: my @ids = $res->responseIds($part);
12196: for (my $i=0; $i < scalar(@ids); $i++) {
12197: if ($types[$i] eq 'essay') {
12198: my $partid = $part.'_'.$ids[$i];
12199: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
12200: $totaluploads ++;
12201: }
12202: }
12203: }
12204: }
12205: if ($totaluploads > 1) {
12206: $multiresp = 1;
12207: }
12208: }
12209: }
12210: }
12211: } else {
12212: return;
12213: }
12214: } else {
12215: return;
12216: }
12217: my $restitle=&Apache::lonnet::gettitle($symb);
12218: $restitle =~ s/\W+/_/g;
12219: if ($restitle eq '') {
12220: $restitle = ($resurl =~ m{/[^/]+$});
12221: if ($restitle eq '') {
12222: $restitle = time;
12223: }
12224: }
1.1149 raeburn 12225: if (length($restitle) > 12) {
12226: $restitle = substr($restitle,0,12);
12227: }
1.1015 raeburn 12228: push(@pathitems,$restitle);
12229: $path .= join('/',@pathitems);
12230: }
12231: return ($path,$multiresp);
12232: }
12233:
12234: =pod
12235:
1.464 albertel 12236: =back
1.41 ng 12237:
1.112 bowersj2 12238: =head1 CSV Upload/Handling functions
1.38 albertel 12239:
1.41 ng 12240: =over 4
12241:
1.648 raeburn 12242: =item * &upfile_store($r)
1.41 ng 12243:
12244: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 12245: needs $env{'form.upfile'}
1.41 ng 12246: returns $datatoken to be put into hidden field
12247:
12248: =cut
1.31 albertel 12249:
12250: sub upfile_store {
12251: my $r=shift;
1.258 albertel 12252: $env{'form.upfile'}=~s/\r/\n/gs;
12253: $env{'form.upfile'}=~s/\f/\n/gs;
12254: $env{'form.upfile'}=~s/\n+/\n/gs;
12255: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 12256:
1.258 albertel 12257: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
12258: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 12259: {
1.158 raeburn 12260: my $datafile = $r->dir_config('lonDaemons').
12261: '/tmp/'.$datatoken.'.tmp';
12262: if ( open(my $fh,">$datafile") ) {
1.258 albertel 12263: print $fh $env{'form.upfile'};
1.158 raeburn 12264: close($fh);
12265: }
1.31 albertel 12266: }
12267: return $datatoken;
12268: }
12269:
1.56 matthew 12270: =pod
12271:
1.648 raeburn 12272: =item * &load_tmp_file($r)
1.41 ng 12273:
12274: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 12275: needs $env{'form.datatoken'},
12276: sets $env{'form.upfile'} to the contents of the file
1.41 ng 12277:
12278: =cut
1.31 albertel 12279:
12280: sub load_tmp_file {
12281: my $r=shift;
12282: my @studentdata=();
12283: {
1.158 raeburn 12284: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 12285: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 12286: if ( open(my $fh,"<$studentfile") ) {
12287: @studentdata=<$fh>;
12288: close($fh);
12289: }
1.31 albertel 12290: }
1.258 albertel 12291: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 12292: }
12293:
1.56 matthew 12294: =pod
12295:
1.648 raeburn 12296: =item * &upfile_record_sep()
1.41 ng 12297:
12298: Separate uploaded file into records
12299: returns array of records,
1.258 albertel 12300: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 12301:
12302: =cut
1.31 albertel 12303:
12304: sub upfile_record_sep {
1.258 albertel 12305: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 12306: } else {
1.248 albertel 12307: my @records;
1.258 albertel 12308: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 12309: if ($line=~/^\s*$/) { next; }
12310: push(@records,$line);
12311: }
12312: return @records;
1.31 albertel 12313: }
12314: }
12315:
1.56 matthew 12316: =pod
12317:
1.648 raeburn 12318: =item * &record_sep($record)
1.41 ng 12319:
1.258 albertel 12320: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 12321:
12322: =cut
12323:
1.263 www 12324: sub takeleft {
12325: my $index=shift;
12326: return substr('0000'.$index,-4,4);
12327: }
12328:
1.31 albertel 12329: sub record_sep {
12330: my $record=shift;
12331: my %components=();
1.258 albertel 12332: if ($env{'form.upfiletype'} eq 'xml') {
12333: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 12334: my $i=0;
1.356 albertel 12335: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 12336: $field=~s/^(\"|\')//;
12337: $field=~s/(\"|\')$//;
1.263 www 12338: $components{&takeleft($i)}=$field;
1.31 albertel 12339: $i++;
12340: }
1.258 albertel 12341: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 12342: my $i=0;
1.356 albertel 12343: foreach my $field (split(/\t/,$record)) {
1.31 albertel 12344: $field=~s/^(\"|\')//;
12345: $field=~s/(\"|\')$//;
1.263 www 12346: $components{&takeleft($i)}=$field;
1.31 albertel 12347: $i++;
12348: }
12349: } else {
1.561 www 12350: my $separator=',';
1.480 banghart 12351: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 12352: $separator=';';
1.480 banghart 12353: }
1.31 albertel 12354: my $i=0;
1.561 www 12355: # the character we are looking for to indicate the end of a quote or a record
12356: my $looking_for=$separator;
12357: # do not add the characters to the fields
12358: my $ignore=0;
12359: # we just encountered a separator (or the beginning of the record)
12360: my $just_found_separator=1;
12361: # store the field we are working on here
12362: my $field='';
12363: # work our way through all characters in record
12364: foreach my $character ($record=~/(.)/g) {
12365: if ($character eq $looking_for) {
12366: if ($character ne $separator) {
12367: # Found the end of a quote, again looking for separator
12368: $looking_for=$separator;
12369: $ignore=1;
12370: } else {
12371: # Found a separator, store away what we got
12372: $components{&takeleft($i)}=$field;
12373: $i++;
12374: $just_found_separator=1;
12375: $ignore=0;
12376: $field='';
12377: }
12378: next;
12379: }
12380: # single or double quotation marks after a separator indicate beginning of a quote
12381: # we are now looking for the end of the quote and need to ignore separators
12382: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
12383: $looking_for=$character;
12384: next;
12385: }
12386: # ignore would be true after we reached the end of a quote
12387: if ($ignore) { next; }
12388: if (($just_found_separator) && ($character=~/\s/)) { next; }
12389: $field.=$character;
12390: $just_found_separator=0;
1.31 albertel 12391: }
1.561 www 12392: # catch the very last entry, since we never encountered the separator
12393: $components{&takeleft($i)}=$field;
1.31 albertel 12394: }
12395: return %components;
12396: }
12397:
1.144 matthew 12398: ######################################################
12399: ######################################################
12400:
1.56 matthew 12401: =pod
12402:
1.648 raeburn 12403: =item * &upfile_select_html()
1.41 ng 12404:
1.144 matthew 12405: Return HTML code to select a file from the users machine and specify
12406: the file type.
1.41 ng 12407:
12408: =cut
12409:
1.144 matthew 12410: ######################################################
12411: ######################################################
1.31 albertel 12412: sub upfile_select_html {
1.144 matthew 12413: my %Types = (
12414: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 12415: semisv => &mt('Semicolon separated values'),
1.144 matthew 12416: space => &mt('Space separated'),
12417: tab => &mt('Tabulator separated'),
12418: # xml => &mt('HTML/XML'),
12419: );
12420: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 12421: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 12422: foreach my $type (sort(keys(%Types))) {
12423: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
12424: }
12425: $Str .= "</select>\n";
12426: return $Str;
1.31 albertel 12427: }
12428:
1.301 albertel 12429: sub get_samples {
12430: my ($records,$toget) = @_;
12431: my @samples=({});
12432: my $got=0;
12433: foreach my $rec (@$records) {
12434: my %temp = &record_sep($rec);
12435: if (! grep(/\S/, values(%temp))) { next; }
12436: if (%temp) {
12437: $samples[$got]=\%temp;
12438: $got++;
12439: if ($got == $toget) { last; }
12440: }
12441: }
12442: return \@samples;
12443: }
12444:
1.144 matthew 12445: ######################################################
12446: ######################################################
12447:
1.56 matthew 12448: =pod
12449:
1.648 raeburn 12450: =item * &csv_print_samples($r,$records)
1.41 ng 12451:
12452: Prints a table of sample values from each column uploaded $r is an
12453: Apache Request ref, $records is an arrayref from
12454: &Apache::loncommon::upfile_record_sep
12455:
12456: =cut
12457:
1.144 matthew 12458: ######################################################
12459: ######################################################
1.31 albertel 12460: sub csv_print_samples {
12461: my ($r,$records) = @_;
1.662 bisitz 12462: my $samples = &get_samples($records,5);
1.301 albertel 12463:
1.594 raeburn 12464: $r->print(&mt('Samples').'<br />'.&start_data_table().
12465: &start_data_table_header_row());
1.356 albertel 12466: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 12467: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 12468: $r->print(&end_data_table_header_row());
1.301 albertel 12469: foreach my $hash (@$samples) {
1.594 raeburn 12470: $r->print(&start_data_table_row());
1.356 albertel 12471: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 12472: $r->print('<td>');
1.356 albertel 12473: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 12474: $r->print('</td>');
12475: }
1.594 raeburn 12476: $r->print(&end_data_table_row());
1.31 albertel 12477: }
1.594 raeburn 12478: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 12479: }
12480:
1.144 matthew 12481: ######################################################
12482: ######################################################
12483:
1.56 matthew 12484: =pod
12485:
1.648 raeburn 12486: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12487:
12488: Prints a table to create associations between values and table columns.
1.144 matthew 12489:
1.41 ng 12490: $r is an Apache Request ref,
12491: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12492: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12493:
12494: =cut
12495:
1.144 matthew 12496: ######################################################
12497: ######################################################
1.31 albertel 12498: sub csv_print_select_table {
12499: my ($r,$records,$d) = @_;
1.301 albertel 12500: my $i=0;
12501: my $samples = &get_samples($records,1);
1.144 matthew 12502: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12503: &start_data_table().&start_data_table_header_row().
1.144 matthew 12504: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12505: '<th>'.&mt('Column').'</th>'.
12506: &end_data_table_header_row()."\n");
1.356 albertel 12507: foreach my $array_ref (@$d) {
12508: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12509: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12510:
1.875 bisitz 12511: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12512: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12513: $r->print('<option value="none"></option>');
1.356 albertel 12514: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12515: $r->print('<option value="'.$sample.'"'.
12516: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12517: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12518: }
1.594 raeburn 12519: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12520: $i++;
12521: }
1.594 raeburn 12522: $r->print(&end_data_table());
1.31 albertel 12523: $i--;
12524: return $i;
12525: }
1.56 matthew 12526:
1.144 matthew 12527: ######################################################
12528: ######################################################
12529:
1.56 matthew 12530: =pod
1.31 albertel 12531:
1.648 raeburn 12532: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12533:
12534: Prints a table of sample values from the upload and can make associate samples to internal names.
12535:
12536: $r is an Apache Request ref,
12537: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12538: $d is an array of 2 element arrays (internal name, displayed name)
12539:
12540: =cut
12541:
1.144 matthew 12542: ######################################################
12543: ######################################################
1.31 albertel 12544: sub csv_samples_select_table {
12545: my ($r,$records,$d) = @_;
12546: my $i=0;
1.144 matthew 12547: #
1.662 bisitz 12548: my $max_samples = 5;
12549: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12550: $r->print(&start_data_table().
12551: &start_data_table_header_row().'<th>'.
12552: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12553: &end_data_table_header_row());
1.301 albertel 12554:
12555: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12556: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12557: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12558: foreach my $option (@$d) {
12559: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12560: $r->print('<option value="'.$value.'"'.
1.253 albertel 12561: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12562: $display.'</option>');
1.31 albertel 12563: }
12564: $r->print('</select></td><td>');
1.662 bisitz 12565: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12566: if (defined($samples->[$line]{$key})) {
12567: $r->print($samples->[$line]{$key}."<br />\n");
12568: }
12569: }
1.594 raeburn 12570: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12571: $i++;
12572: }
1.594 raeburn 12573: $r->print(&end_data_table());
1.31 albertel 12574: $i--;
12575: return($i);
1.115 matthew 12576: }
12577:
1.144 matthew 12578: ######################################################
12579: ######################################################
12580:
1.115 matthew 12581: =pod
12582:
1.648 raeburn 12583: =item * &clean_excel_name($name)
1.115 matthew 12584:
12585: Returns a replacement for $name which does not contain any illegal characters.
12586:
12587: =cut
12588:
1.144 matthew 12589: ######################################################
12590: ######################################################
1.115 matthew 12591: sub clean_excel_name {
12592: my ($name) = @_;
12593: $name =~ s/[:\*\?\/\\]//g;
12594: if (length($name) > 31) {
12595: $name = substr($name,0,31);
12596: }
12597: return $name;
1.25 albertel 12598: }
1.84 albertel 12599:
1.85 albertel 12600: =pod
12601:
1.648 raeburn 12602: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12603:
12604: Returns either 1 or undef
12605:
12606: 1 if the part is to be hidden, undef if it is to be shown
12607:
12608: Arguments are:
12609:
12610: $id the id of the part to be checked
12611: $symb, optional the symb of the resource to check
12612: $udom, optional the domain of the user to check for
12613: $uname, optional the username of the user to check for
12614:
12615: =cut
1.84 albertel 12616:
12617: sub check_if_partid_hidden {
12618: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12619: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12620: $symb,$udom,$uname);
1.141 albertel 12621: my $truth=1;
12622: #if the string starts with !, then the list is the list to show not hide
12623: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12624: my @hiddenlist=split(/,/,$hiddenparts);
12625: foreach my $checkid (@hiddenlist) {
1.141 albertel 12626: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12627: }
1.141 albertel 12628: return !$truth;
1.84 albertel 12629: }
1.127 matthew 12630:
1.138 matthew 12631:
12632: ############################################################
12633: ############################################################
12634:
12635: =pod
12636:
1.157 matthew 12637: =back
12638:
1.138 matthew 12639: =head1 cgi-bin script and graphing routines
12640:
1.157 matthew 12641: =over 4
12642:
1.648 raeburn 12643: =item * &get_cgi_id()
1.138 matthew 12644:
12645: Inputs: none
12646:
12647: Returns an id which can be used to pass environment variables
12648: to various cgi-bin scripts. These environment variables will
12649: be removed from the users environment after a given time by
12650: the routine &Apache::lonnet::transfer_profile_to_env.
12651:
12652: =cut
12653:
12654: ############################################################
12655: ############################################################
1.152 albertel 12656: my $uniq=0;
1.136 matthew 12657: sub get_cgi_id {
1.154 albertel 12658: $uniq=($uniq+1)%100000;
1.280 albertel 12659: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12660: }
12661:
1.127 matthew 12662: ############################################################
12663: ############################################################
12664:
12665: =pod
12666:
1.648 raeburn 12667: =item * &DrawBarGraph()
1.127 matthew 12668:
1.138 matthew 12669: Facilitates the plotting of data in a (stacked) bar graph.
12670: Puts plot definition data into the users environment in order for
12671: graph.png to plot it. Returns an <img> tag for the plot.
12672: The bars on the plot are labeled '1','2',...,'n'.
12673:
12674: Inputs:
12675:
12676: =over 4
12677:
12678: =item $Title: string, the title of the plot
12679:
12680: =item $xlabel: string, text describing the X-axis of the plot
12681:
12682: =item $ylabel: string, text describing the Y-axis of the plot
12683:
12684: =item $Max: scalar, the maximum Y value to use in the plot
12685: If $Max is < any data point, the graph will not be rendered.
12686:
1.140 matthew 12687: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12688: they are plotted. If undefined, default values will be used.
12689:
1.178 matthew 12690: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12691:
1.138 matthew 12692: =item @Values: An array of array references. Each array reference holds data
12693: to be plotted in a stacked bar chart.
12694:
1.239 matthew 12695: =item If the final element of @Values is a hash reference the key/value
12696: pairs will be added to the graph definition.
12697:
1.138 matthew 12698: =back
12699:
12700: Returns:
12701:
12702: An <img> tag which references graph.png and the appropriate identifying
12703: information for the plot.
12704:
1.127 matthew 12705: =cut
12706:
12707: ############################################################
12708: ############################################################
1.134 matthew 12709: sub DrawBarGraph {
1.178 matthew 12710: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12711: #
12712: if (! defined($colors)) {
12713: $colors = ['#33ff00',
12714: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12715: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12716: ];
12717: }
1.228 matthew 12718: my $extra_settings = {};
12719: if (ref($Values[-1]) eq 'HASH') {
12720: $extra_settings = pop(@Values);
12721: }
1.127 matthew 12722: #
1.136 matthew 12723: my $identifier = &get_cgi_id();
12724: my $id = 'cgi.'.$identifier;
1.129 matthew 12725: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12726: return '';
12727: }
1.225 matthew 12728: #
12729: my @Labels;
12730: if (defined($labels)) {
12731: @Labels = @$labels;
12732: } else {
12733: for (my $i=0;$i<@{$Values[0]};$i++) {
12734: push (@Labels,$i+1);
12735: }
12736: }
12737: #
1.129 matthew 12738: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12739: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12740: my %ValuesHash;
12741: my $NumSets=1;
12742: foreach my $array (@Values) {
12743: next if (! ref($array));
1.136 matthew 12744: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12745: join(',',@$array);
1.129 matthew 12746: }
1.127 matthew 12747: #
1.136 matthew 12748: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12749: if ($NumBars < 3) {
12750: $width = 120+$NumBars*32;
1.220 matthew 12751: $xskip = 1;
1.225 matthew 12752: $bar_width = 30;
12753: } elsif ($NumBars < 5) {
12754: $width = 120+$NumBars*20;
12755: $xskip = 1;
12756: $bar_width = 20;
1.220 matthew 12757: } elsif ($NumBars < 10) {
1.136 matthew 12758: $width = 120+$NumBars*15;
12759: $xskip = 1;
12760: $bar_width = 15;
12761: } elsif ($NumBars <= 25) {
12762: $width = 120+$NumBars*11;
12763: $xskip = 5;
12764: $bar_width = 8;
12765: } elsif ($NumBars <= 50) {
12766: $width = 120+$NumBars*8;
12767: $xskip = 5;
12768: $bar_width = 4;
12769: } else {
12770: $width = 120+$NumBars*8;
12771: $xskip = 5;
12772: $bar_width = 4;
12773: }
12774: #
1.137 matthew 12775: $Max = 1 if ($Max < 1);
12776: if ( int($Max) < $Max ) {
12777: $Max++;
12778: $Max = int($Max);
12779: }
1.127 matthew 12780: $Title = '' if (! defined($Title));
12781: $xlabel = '' if (! defined($xlabel));
12782: $ylabel = '' if (! defined($ylabel));
1.369 www 12783: $ValuesHash{$id.'.title'} = &escape($Title);
12784: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12785: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12786: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12787: $ValuesHash{$id.'.NumBars'} = $NumBars;
12788: $ValuesHash{$id.'.NumSets'} = $NumSets;
12789: $ValuesHash{$id.'.PlotType'} = 'bar';
12790: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12791: $ValuesHash{$id.'.height'} = $height;
12792: $ValuesHash{$id.'.width'} = $width;
12793: $ValuesHash{$id.'.xskip'} = $xskip;
12794: $ValuesHash{$id.'.bar_width'} = $bar_width;
12795: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12796: #
1.228 matthew 12797: # Deal with other parameters
12798: while (my ($key,$value) = each(%$extra_settings)) {
12799: $ValuesHash{$id.'.'.$key} = $value;
12800: }
12801: #
1.646 raeburn 12802: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12803: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12804: }
12805:
12806: ############################################################
12807: ############################################################
12808:
12809: =pod
12810:
1.648 raeburn 12811: =item * &DrawXYGraph()
1.137 matthew 12812:
1.138 matthew 12813: Facilitates the plotting of data in an XY graph.
12814: Puts plot definition data into the users environment in order for
12815: graph.png to plot it. Returns an <img> tag for the plot.
12816:
12817: Inputs:
12818:
12819: =over 4
12820:
12821: =item $Title: string, the title of the plot
12822:
12823: =item $xlabel: string, text describing the X-axis of the plot
12824:
12825: =item $ylabel: string, text describing the Y-axis of the plot
12826:
12827: =item $Max: scalar, the maximum Y value to use in the plot
12828: If $Max is < any data point, the graph will not be rendered.
12829:
12830: =item $colors: Array ref containing the hex color codes for the data to be
12831: plotted in. If undefined, default values will be used.
12832:
12833: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12834:
12835: =item $Ydata: Array ref containing Array refs.
1.185 www 12836: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12837:
12838: =item %Values: hash indicating or overriding any default values which are
12839: passed to graph.png.
12840: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12841:
12842: =back
12843:
12844: Returns:
12845:
12846: An <img> tag which references graph.png and the appropriate identifying
12847: information for the plot.
12848:
1.137 matthew 12849: =cut
12850:
12851: ############################################################
12852: ############################################################
12853: sub DrawXYGraph {
12854: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12855: #
12856: # Create the identifier for the graph
12857: my $identifier = &get_cgi_id();
12858: my $id = 'cgi.'.$identifier;
12859: #
12860: $Title = '' if (! defined($Title));
12861: $xlabel = '' if (! defined($xlabel));
12862: $ylabel = '' if (! defined($ylabel));
12863: my %ValuesHash =
12864: (
1.369 www 12865: $id.'.title' => &escape($Title),
12866: $id.'.xlabel' => &escape($xlabel),
12867: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12868: $id.'.y_max_value'=> $Max,
12869: $id.'.labels' => join(',',@$Xlabels),
12870: $id.'.PlotType' => 'XY',
12871: );
12872: #
12873: if (defined($colors) && ref($colors) eq 'ARRAY') {
12874: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12875: }
12876: #
12877: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12878: return '';
12879: }
12880: my $NumSets=1;
1.138 matthew 12881: foreach my $array (@{$Ydata}){
1.137 matthew 12882: next if (! ref($array));
12883: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12884: }
1.138 matthew 12885: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12886: #
12887: # Deal with other parameters
12888: while (my ($key,$value) = each(%Values)) {
12889: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12890: }
12891: #
1.646 raeburn 12892: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12893: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12894: }
12895:
12896: ############################################################
12897: ############################################################
12898:
12899: =pod
12900:
1.648 raeburn 12901: =item * &DrawXYYGraph()
1.138 matthew 12902:
12903: Facilitates the plotting of data in an XY graph with two Y axes.
12904: Puts plot definition data into the users environment in order for
12905: graph.png to plot it. Returns an <img> tag for the plot.
12906:
12907: Inputs:
12908:
12909: =over 4
12910:
12911: =item $Title: string, the title of the plot
12912:
12913: =item $xlabel: string, text describing the X-axis of the plot
12914:
12915: =item $ylabel: string, text describing the Y-axis of the plot
12916:
12917: =item $colors: Array ref containing the hex color codes for the data to be
12918: plotted in. If undefined, default values will be used.
12919:
12920: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12921:
12922: =item $Ydata1: The first data set
12923:
12924: =item $Min1: The minimum value of the left Y-axis
12925:
12926: =item $Max1: The maximum value of the left Y-axis
12927:
12928: =item $Ydata2: The second data set
12929:
12930: =item $Min2: The minimum value of the right Y-axis
12931:
12932: =item $Max2: The maximum value of the left Y-axis
12933:
12934: =item %Values: hash indicating or overriding any default values which are
12935: passed to graph.png.
12936: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12937:
12938: =back
12939:
12940: Returns:
12941:
12942: An <img> tag which references graph.png and the appropriate identifying
12943: information for the plot.
1.136 matthew 12944:
12945: =cut
12946:
12947: ############################################################
12948: ############################################################
1.137 matthew 12949: sub DrawXYYGraph {
12950: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12951: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12952: #
12953: # Create the identifier for the graph
12954: my $identifier = &get_cgi_id();
12955: my $id = 'cgi.'.$identifier;
12956: #
12957: $Title = '' if (! defined($Title));
12958: $xlabel = '' if (! defined($xlabel));
12959: $ylabel = '' if (! defined($ylabel));
12960: my %ValuesHash =
12961: (
1.369 www 12962: $id.'.title' => &escape($Title),
12963: $id.'.xlabel' => &escape($xlabel),
12964: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12965: $id.'.labels' => join(',',@$Xlabels),
12966: $id.'.PlotType' => 'XY',
12967: $id.'.NumSets' => 2,
1.137 matthew 12968: $id.'.two_axes' => 1,
12969: $id.'.y1_max_value' => $Max1,
12970: $id.'.y1_min_value' => $Min1,
12971: $id.'.y2_max_value' => $Max2,
12972: $id.'.y2_min_value' => $Min2,
1.136 matthew 12973: );
12974: #
1.137 matthew 12975: if (defined($colors) && ref($colors) eq 'ARRAY') {
12976: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12977: }
12978: #
12979: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12980: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12981: return '';
12982: }
12983: my $NumSets=1;
1.137 matthew 12984: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12985: next if (! ref($array));
12986: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12987: }
12988: #
12989: # Deal with other parameters
12990: while (my ($key,$value) = each(%Values)) {
12991: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12992: }
12993: #
1.646 raeburn 12994: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12995: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12996: }
12997:
12998: ############################################################
12999: ############################################################
13000:
13001: =pod
13002:
1.157 matthew 13003: =back
13004:
1.139 matthew 13005: =head1 Statistics helper routines?
13006:
13007: Bad place for them but what the hell.
13008:
1.157 matthew 13009: =over 4
13010:
1.648 raeburn 13011: =item * &chartlink()
1.139 matthew 13012:
13013: Returns a link to the chart for a specific student.
13014:
13015: Inputs:
13016:
13017: =over 4
13018:
13019: =item $linktext: The text of the link
13020:
13021: =item $sname: The students username
13022:
13023: =item $sdomain: The students domain
13024:
13025: =back
13026:
1.157 matthew 13027: =back
13028:
1.139 matthew 13029: =cut
13030:
13031: ############################################################
13032: ############################################################
13033: sub chartlink {
13034: my ($linktext, $sname, $sdomain) = @_;
13035: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 13036: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 13037: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 13038: '">'.$linktext.'</a>';
1.153 matthew 13039: }
13040:
13041: #######################################################
13042: #######################################################
13043:
13044: =pod
13045:
13046: =head1 Course Environment Routines
1.157 matthew 13047:
13048: =over 4
1.153 matthew 13049:
1.648 raeburn 13050: =item * &restore_course_settings()
1.153 matthew 13051:
1.648 raeburn 13052: =item * &store_course_settings()
1.153 matthew 13053:
13054: Restores/Store indicated form parameters from the course environment.
13055: Will not overwrite existing values of the form parameters.
13056:
13057: Inputs:
13058: a scalar describing the data (e.g. 'chart', 'problem_analysis')
13059:
13060: a hash ref describing the data to be stored. For example:
13061:
13062: %Save_Parameters = ('Status' => 'scalar',
13063: 'chartoutputmode' => 'scalar',
13064: 'chartoutputdata' => 'scalar',
13065: 'Section' => 'array',
1.373 raeburn 13066: 'Group' => 'array',
1.153 matthew 13067: 'StudentData' => 'array',
13068: 'Maps' => 'array');
13069:
13070: Returns: both routines return nothing
13071:
1.631 raeburn 13072: =back
13073:
1.153 matthew 13074: =cut
13075:
13076: #######################################################
13077: #######################################################
13078: sub store_course_settings {
1.496 albertel 13079: return &store_settings($env{'request.course.id'},@_);
13080: }
13081:
13082: sub store_settings {
1.153 matthew 13083: # save to the environment
13084: # appenv the same items, just to be safe
1.300 albertel 13085: my $udom = $env{'user.domain'};
13086: my $uname = $env{'user.name'};
1.496 albertel 13087: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13088: my %SaveHash;
13089: my %AppHash;
13090: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 13091: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 13092: my $envname = 'environment.'.$basename;
1.258 albertel 13093: if (exists($env{'form.'.$setting})) {
1.153 matthew 13094: # Save this value away
13095: if ($type eq 'scalar' &&
1.258 albertel 13096: (! exists($env{$envname}) ||
13097: $env{$envname} ne $env{'form.'.$setting})) {
13098: $SaveHash{$basename} = $env{'form.'.$setting};
13099: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 13100: } elsif ($type eq 'array') {
13101: my $stored_form;
1.258 albertel 13102: if (ref($env{'form.'.$setting})) {
1.153 matthew 13103: $stored_form = join(',',
13104: map {
1.369 www 13105: &escape($_);
1.258 albertel 13106: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 13107: } else {
13108: $stored_form =
1.369 www 13109: &escape($env{'form.'.$setting});
1.153 matthew 13110: }
13111: # Determine if the array contents are the same.
1.258 albertel 13112: if ($stored_form ne $env{$envname}) {
1.153 matthew 13113: $SaveHash{$basename} = $stored_form;
13114: $AppHash{$envname} = $stored_form;
13115: }
13116: }
13117: }
13118: }
13119: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 13120: $udom,$uname);
1.153 matthew 13121: if ($put_result !~ /^(ok|delayed)/) {
13122: &Apache::lonnet::logthis('unable to save form parameters, '.
13123: 'got error:'.$put_result);
13124: }
13125: # Make sure these settings stick around in this session, too
1.646 raeburn 13126: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 13127: return;
13128: }
13129:
13130: sub restore_course_settings {
1.499 albertel 13131: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 13132: }
13133:
13134: sub restore_settings {
13135: my ($context,$prefix,$Settings) = @_;
1.153 matthew 13136: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 13137: next if (exists($env{'form.'.$setting}));
1.496 albertel 13138: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 13139: '.'.$setting;
1.258 albertel 13140: if (exists($env{$envname})) {
1.153 matthew 13141: if ($type eq 'scalar') {
1.258 albertel 13142: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 13143: } elsif ($type eq 'array') {
1.258 albertel 13144: $env{'form.'.$setting} = [
1.153 matthew 13145: map {
1.369 www 13146: &unescape($_);
1.258 albertel 13147: } split(',',$env{$envname})
1.153 matthew 13148: ];
13149: }
13150: }
13151: }
1.127 matthew 13152: }
13153:
1.618 raeburn 13154: #######################################################
13155: #######################################################
13156:
13157: =pod
13158:
13159: =head1 Domain E-mail Routines
13160:
13161: =over 4
13162:
1.648 raeburn 13163: =item * &build_recipient_list()
1.618 raeburn 13164:
1.1144 raeburn 13165: Build recipient lists for following types of e-mail:
1.766 raeburn 13166: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 13167: (d) Help requests, (e) Course requests needing approval, (f) loncapa
13168: module change checking, student/employee ID conflict checks, as
13169: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
13170: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 13171:
13172: Inputs:
1.619 raeburn 13173: defmail (scalar - email address of default recipient),
1.1144 raeburn 13174: mailing type (scalar: errormail, packagesmail, helpdeskmail,
13175: requestsmail, updatesmail, or idconflictsmail).
13176:
1.619 raeburn 13177: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 13178:
1.619 raeburn 13179: origmail (scalar - email address of recipient from loncapa.conf,
13180: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 13181:
1.655 raeburn 13182: Returns: comma separated list of addresses to which to send e-mail.
13183:
13184: =back
1.618 raeburn 13185:
13186: =cut
13187:
13188: ############################################################
13189: ############################################################
13190: sub build_recipient_list {
1.619 raeburn 13191: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 13192: my @recipients;
13193: my $otheremails;
13194: my %domconfig =
13195: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
13196: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 13197: if (exists($domconfig{'contacts'}{$mailing})) {
13198: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
13199: my @contacts = ('adminemail','supportemail');
13200: foreach my $item (@contacts) {
13201: if ($domconfig{'contacts'}{$mailing}{$item}) {
13202: my $addr = $domconfig{'contacts'}{$item};
13203: if (!grep(/^\Q$addr\E$/,@recipients)) {
13204: push(@recipients,$addr);
13205: }
1.619 raeburn 13206: }
1.766 raeburn 13207: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 13208: }
13209: }
1.766 raeburn 13210: } elsif ($origmail ne '') {
13211: push(@recipients,$origmail);
1.618 raeburn 13212: }
1.619 raeburn 13213: } elsif ($origmail ne '') {
13214: push(@recipients,$origmail);
1.618 raeburn 13215: }
1.688 raeburn 13216: if (defined($defmail)) {
13217: if ($defmail ne '') {
13218: push(@recipients,$defmail);
13219: }
1.618 raeburn 13220: }
13221: if ($otheremails) {
1.619 raeburn 13222: my @others;
13223: if ($otheremails =~ /,/) {
13224: @others = split(/,/,$otheremails);
1.618 raeburn 13225: } else {
1.619 raeburn 13226: push(@others,$otheremails);
13227: }
13228: foreach my $addr (@others) {
13229: if (!grep(/^\Q$addr\E$/,@recipients)) {
13230: push(@recipients,$addr);
13231: }
1.618 raeburn 13232: }
13233: }
1.619 raeburn 13234: my $recipientlist = join(',',@recipients);
1.618 raeburn 13235: return $recipientlist;
13236: }
13237:
1.127 matthew 13238: ############################################################
13239: ############################################################
1.154 albertel 13240:
1.655 raeburn 13241: =pod
13242:
13243: =head1 Course Catalog Routines
13244:
13245: =over 4
13246:
13247: =item * &gather_categories()
13248:
13249: Converts category definitions - keys of categories hash stored in
13250: coursecategories in configuration.db on the primary library server in a
13251: domain - to an array. Also generates javascript and idx hash used to
13252: generate Domain Coordinator interface for editing Course Categories.
13253:
13254: Inputs:
1.663 raeburn 13255:
1.655 raeburn 13256: categories (reference to hash of category definitions).
1.663 raeburn 13257:
1.655 raeburn 13258: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13259: categories and subcategories).
1.663 raeburn 13260:
1.655 raeburn 13261: idx (reference to hash of counters used in Domain Coordinator interface for
13262: editing Course Categories).
1.663 raeburn 13263:
1.655 raeburn 13264: jsarray (reference to array of categories used to create Javascript arrays for
13265: Domain Coordinator interface for editing Course Categories).
13266:
13267: Returns: nothing
13268:
13269: Side effects: populates cats, idx and jsarray.
13270:
13271: =cut
13272:
13273: sub gather_categories {
13274: my ($categories,$cats,$idx,$jsarray) = @_;
13275: my %counters;
13276: my $num = 0;
13277: foreach my $item (keys(%{$categories})) {
13278: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
13279: if ($container eq '' && $depth == 0) {
13280: $cats->[$depth][$categories->{$item}] = $cat;
13281: } else {
13282: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
13283: }
13284: my ($escitem,$tail) = split(/:/,$item,2);
13285: if ($counters{$tail} eq '') {
13286: $counters{$tail} = $num;
13287: $num ++;
13288: }
13289: if (ref($idx) eq 'HASH') {
13290: $idx->{$item} = $counters{$tail};
13291: }
13292: if (ref($jsarray) eq 'ARRAY') {
13293: push(@{$jsarray->[$counters{$tail}]},$item);
13294: }
13295: }
13296: return;
13297: }
13298:
13299: =pod
13300:
13301: =item * &extract_categories()
13302:
13303: Used to generate breadcrumb trails for course categories.
13304:
13305: Inputs:
1.663 raeburn 13306:
1.655 raeburn 13307: categories (reference to hash of category definitions).
1.663 raeburn 13308:
1.655 raeburn 13309: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13310: categories and subcategories).
1.663 raeburn 13311:
1.655 raeburn 13312: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 13313:
1.655 raeburn 13314: allitems (reference to hash - key is category key
13315: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13316:
1.655 raeburn 13317: idx (reference to hash of counters used in Domain Coordinator interface for
13318: editing Course Categories).
1.663 raeburn 13319:
1.655 raeburn 13320: jsarray (reference to array of categories used to create Javascript arrays for
13321: Domain Coordinator interface for editing Course Categories).
13322:
1.665 raeburn 13323: subcats (reference to hash of arrays containing all subcategories within each
13324: category, -recursive)
13325:
1.655 raeburn 13326: Returns: nothing
13327:
13328: Side effects: populates trails and allitems hash references.
13329:
13330: =cut
13331:
13332: sub extract_categories {
1.665 raeburn 13333: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 13334: if (ref($categories) eq 'HASH') {
13335: &gather_categories($categories,$cats,$idx,$jsarray);
13336: if (ref($cats->[0]) eq 'ARRAY') {
13337: for (my $i=0; $i<@{$cats->[0]}; $i++) {
13338: my $name = $cats->[0][$i];
13339: my $item = &escape($name).'::0';
13340: my $trailstr;
13341: if ($name eq 'instcode') {
13342: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 13343: } elsif ($name eq 'communities') {
13344: $trailstr = &mt('Communities');
1.655 raeburn 13345: } else {
13346: $trailstr = $name;
13347: }
13348: if ($allitems->{$item} eq '') {
13349: push(@{$trails},$trailstr);
13350: $allitems->{$item} = scalar(@{$trails})-1;
13351: }
13352: my @parents = ($name);
13353: if (ref($cats->[1]{$name}) eq 'ARRAY') {
13354: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
13355: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 13356: if (ref($subcats) eq 'HASH') {
13357: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
13358: }
13359: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
13360: }
13361: } else {
13362: if (ref($subcats) eq 'HASH') {
13363: $subcats->{$item} = [];
1.655 raeburn 13364: }
13365: }
13366: }
13367: }
13368: }
13369: return;
13370: }
13371:
13372: =pod
13373:
13374: =item *&recurse_categories()
13375:
13376: Recursively used to generate breadcrumb trails for course categories.
13377:
13378: Inputs:
1.663 raeburn 13379:
1.655 raeburn 13380: cats (reference to array of arrays/hashes which encapsulates hierarchy of
13381: categories and subcategories).
1.663 raeburn 13382:
1.655 raeburn 13383: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 13384:
13385: category (current course category, for which breadcrumb trail is being generated).
13386:
13387: trails (reference to array of breadcrumb trails for each category).
13388:
1.655 raeburn 13389: allitems (reference to hash - key is category key
13390: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 13391:
1.655 raeburn 13392: parents (array containing containers directories for current category,
13393: back to top level).
13394:
13395: Returns: nothing
13396:
13397: Side effects: populates trails and allitems hash references
13398:
13399: =cut
13400:
13401: sub recurse_categories {
1.665 raeburn 13402: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 13403: my $shallower = $depth - 1;
13404: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
13405: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
13406: my $name = $cats->[$depth]{$category}[$k];
13407: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13408: my $trailstr = join(' -> ',(@{$parents},$category));
13409: if ($allitems->{$item} eq '') {
13410: push(@{$trails},$trailstr);
13411: $allitems->{$item} = scalar(@{$trails})-1;
13412: }
13413: my $deeper = $depth+1;
13414: push(@{$parents},$category);
1.665 raeburn 13415: if (ref($subcats) eq 'HASH') {
13416: my $subcat = &escape($name).':'.$category.':'.$depth;
13417: for (my $j=@{$parents}; $j>=0; $j--) {
13418: my $higher;
13419: if ($j > 0) {
13420: $higher = &escape($parents->[$j]).':'.
13421: &escape($parents->[$j-1]).':'.$j;
13422: } else {
13423: $higher = &escape($parents->[$j]).'::'.$j;
13424: }
13425: push(@{$subcats->{$higher}},$subcat);
13426: }
13427: }
13428: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
13429: $subcats);
1.655 raeburn 13430: pop(@{$parents});
13431: }
13432: } else {
13433: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
13434: my $trailstr = join(' -> ',(@{$parents},$category));
13435: if ($allitems->{$item} eq '') {
13436: push(@{$trails},$trailstr);
13437: $allitems->{$item} = scalar(@{$trails})-1;
13438: }
13439: }
13440: return;
13441: }
13442:
1.663 raeburn 13443: =pod
13444:
13445: =item *&assign_categories_table()
13446:
13447: Create a datatable for display of hierarchical categories in a domain,
13448: with checkboxes to allow a course to be categorized.
13449:
13450: Inputs:
13451:
13452: cathash - reference to hash of categories defined for the domain (from
13453: configuration.db)
13454:
13455: currcat - scalar with an & separated list of categories assigned to a course.
13456:
1.919 raeburn 13457: type - scalar contains course type (Course or Community).
13458:
1.663 raeburn 13459: Returns: $output (markup to be displayed)
13460:
13461: =cut
13462:
13463: sub assign_categories_table {
1.919 raeburn 13464: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 13465: my $output;
13466: if (ref($cathash) eq 'HASH') {
13467: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
13468: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
13469: $maxdepth = scalar(@cats);
13470: if (@cats > 0) {
13471: my $itemcount = 0;
13472: if (ref($cats[0]) eq 'ARRAY') {
13473: my @currcategories;
13474: if ($currcat ne '') {
13475: @currcategories = split('&',$currcat);
13476: }
1.919 raeburn 13477: my $table;
1.663 raeburn 13478: for (my $i=0; $i<@{$cats[0]}; $i++) {
13479: my $parent = $cats[0][$i];
1.919 raeburn 13480: next if ($parent eq 'instcode');
13481: if ($type eq 'Community') {
13482: next unless ($parent eq 'communities');
13483: } else {
13484: next if ($parent eq 'communities');
13485: }
1.663 raeburn 13486: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13487: my $item = &escape($parent).'::0';
13488: my $checked = '';
13489: if (@currcategories > 0) {
13490: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13491: $checked = ' checked="checked"';
1.663 raeburn 13492: }
13493: }
1.919 raeburn 13494: my $parent_title = $parent;
13495: if ($parent eq 'communities') {
13496: $parent_title = &mt('Communities');
13497: }
13498: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13499: '<input type="checkbox" name="usecategory" value="'.
13500: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13501: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13502: my $depth = 1;
13503: push(@path,$parent);
1.919 raeburn 13504: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13505: pop(@path);
1.919 raeburn 13506: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13507: $itemcount ++;
13508: }
1.919 raeburn 13509: if ($itemcount) {
13510: $output = &Apache::loncommon::start_data_table().
13511: $table.
13512: &Apache::loncommon::end_data_table();
13513: }
1.663 raeburn 13514: }
13515: }
13516: }
13517: return $output;
13518: }
13519:
13520: =pod
13521:
13522: =item *&assign_category_rows()
13523:
13524: Create a datatable row for display of nested categories in a domain,
13525: with checkboxes to allow a course to be categorized,called recursively.
13526:
13527: Inputs:
13528:
13529: itemcount - track row number for alternating colors
13530:
13531: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13532: categories and subcategories.
13533:
13534: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13535:
13536: parent - parent of current category item
13537:
13538: path - Array containing all categories back up through the hierarchy from the
13539: current category to the top level.
13540:
13541: currcategories - reference to array of current categories assigned to the course
13542:
13543: Returns: $output (markup to be displayed).
13544:
13545: =cut
13546:
13547: sub assign_category_rows {
13548: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13549: my ($text,$name,$item,$chgstr);
13550: if (ref($cats) eq 'ARRAY') {
13551: my $maxdepth = scalar(@{$cats});
13552: if (ref($cats->[$depth]) eq 'HASH') {
13553: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13554: my $numchildren = @{$cats->[$depth]{$parent}};
13555: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 13556: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 13557: for (my $j=0; $j<$numchildren; $j++) {
13558: $name = $cats->[$depth]{$parent}[$j];
13559: $item = &escape($name).':'.&escape($parent).':'.$depth;
13560: my $deeper = $depth+1;
13561: my $checked = '';
13562: if (ref($currcategories) eq 'ARRAY') {
13563: if (@{$currcategories} > 0) {
13564: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13565: $checked = ' checked="checked"';
1.663 raeburn 13566: }
13567: }
13568: }
1.664 raeburn 13569: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13570: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13571: $item.'"'.$checked.' />'.$name.'</label></span>'.
13572: '<input type="hidden" name="catname" value="'.$name.'" />'.
13573: '</td><td>';
1.663 raeburn 13574: if (ref($path) eq 'ARRAY') {
13575: push(@{$path},$name);
13576: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13577: pop(@{$path});
13578: }
13579: $text .= '</td></tr>';
13580: }
13581: $text .= '</table></td>';
13582: }
13583: }
13584: }
13585: return $text;
13586: }
13587:
1.655 raeburn 13588: ############################################################
13589: ############################################################
13590:
13591:
1.443 albertel 13592: sub commit_customrole {
1.664 raeburn 13593: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13594: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13595: ($start?', '.&mt('starting').' '.localtime($start):'').
13596: ($end?', ending '.localtime($end):'').': <b>'.
13597: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13598: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13599: '</b><br />';
13600: return $output;
13601: }
13602:
13603: sub commit_standardrole {
1.1116 raeburn 13604: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 13605: my ($output,$logmsg,$linefeed);
13606: if ($context eq 'auto') {
13607: $linefeed = "\n";
13608: } else {
13609: $linefeed = "<br />\n";
13610: }
1.443 albertel 13611: if ($three eq 'st') {
1.541 raeburn 13612: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 13613: $one,$two,$sec,$context,$credits);
1.541 raeburn 13614: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13615: ($result eq 'unknown_course') || ($result eq 'refused')) {
13616: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13617: } else {
1.541 raeburn 13618: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13619: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13620: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13621: if ($context eq 'auto') {
13622: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13623: } else {
13624: $output .= '<b>'.$result.'</b>'.$linefeed.
13625: &mt('Add to classlist').': <b>ok</b>';
13626: }
13627: $output .= $linefeed;
1.443 albertel 13628: }
13629: } else {
13630: $output = &mt('Assigning').' '.$three.' in '.$url.
13631: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13632: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13633: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13634: if ($context eq 'auto') {
13635: $output .= $result.$linefeed;
13636: } else {
13637: $output .= '<b>'.$result.'</b>'.$linefeed;
13638: }
1.443 albertel 13639: }
13640: return $output;
13641: }
13642:
13643: sub commit_studentrole {
1.1116 raeburn 13644: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
13645: $credits) = @_;
1.626 raeburn 13646: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13647: if ($context eq 'auto') {
13648: $linefeed = "\n";
13649: } else {
13650: $linefeed = '<br />'."\n";
13651: }
1.443 albertel 13652: if (defined($one) && defined($two)) {
13653: my $cid=$one.'_'.$two;
13654: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13655: my $secchange = 0;
13656: my $expire_role_result;
13657: my $modify_section_result;
1.628 raeburn 13658: if ($oldsec ne '-1') {
13659: if ($oldsec ne $sec) {
1.443 albertel 13660: $secchange = 1;
1.628 raeburn 13661: my $now = time;
1.443 albertel 13662: my $uurl='/'.$cid;
13663: $uurl=~s/\_/\//g;
13664: if ($oldsec) {
13665: $uurl.='/'.$oldsec;
13666: }
1.626 raeburn 13667: $oldsecurl = $uurl;
1.628 raeburn 13668: $expire_role_result =
1.652 raeburn 13669: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13670: if ($env{'request.course.sec'} ne '') {
13671: if ($expire_role_result eq 'refused') {
13672: my @roles = ('st');
13673: my @statuses = ('previous');
13674: my @roledoms = ($one);
13675: my $withsec = 1;
13676: my %roleshash =
13677: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13678: \@statuses,\@roles,\@roledoms,$withsec);
13679: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13680: my ($oldstart,$oldend) =
13681: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13682: if ($oldend > 0 && $oldend <= $now) {
13683: $expire_role_result = 'ok';
13684: }
13685: }
13686: }
13687: }
1.443 albertel 13688: $result = $expire_role_result;
13689: }
13690: }
13691: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 13692: $modify_section_result =
13693: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
13694: undef,undef,undef,$sec,
13695: $end,$start,'','',$cid,
13696: '',$context,$credits);
1.443 albertel 13697: if ($modify_section_result =~ /^ok/) {
13698: if ($secchange == 1) {
1.628 raeburn 13699: if ($sec eq '') {
13700: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13701: } else {
13702: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13703: }
1.443 albertel 13704: } elsif ($oldsec eq '-1') {
1.628 raeburn 13705: if ($sec eq '') {
13706: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13707: } else {
13708: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13709: }
1.443 albertel 13710: } else {
1.628 raeburn 13711: if ($sec eq '') {
13712: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13713: } else {
13714: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13715: }
1.443 albertel 13716: }
13717: } else {
1.1115 raeburn 13718: if ($secchange) {
1.628 raeburn 13719: $$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;
13720: } else {
13721: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13722: }
1.443 albertel 13723: }
13724: $result = $modify_section_result;
13725: } elsif ($secchange == 1) {
1.628 raeburn 13726: if ($oldsec eq '') {
1.1103 raeburn 13727: $$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 13728: } else {
13729: $$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;
13730: }
1.626 raeburn 13731: if ($expire_role_result eq 'refused') {
13732: my $newsecurl = '/'.$cid;
13733: $newsecurl =~ s/\_/\//g;
13734: if ($sec ne '') {
13735: $newsecurl.='/'.$sec;
13736: }
13737: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13738: if ($sec eq '') {
13739: $$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;
13740: } else {
13741: $$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;
13742: }
13743: }
13744: }
1.443 albertel 13745: }
13746: } else {
1.626 raeburn 13747: $$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 13748: $result = "error: incomplete course id\n";
13749: }
13750: return $result;
13751: }
13752:
1.1108 raeburn 13753: sub show_role_extent {
13754: my ($scope,$context,$role) = @_;
13755: $scope =~ s{^/}{};
13756: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
13757: push(@courseroles,'co');
13758: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
13759: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
13760: $scope =~ s{/}{_};
13761: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
13762: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
13763: my ($audom,$auname) = split(/\//,$scope);
13764: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
13765: &Apache::loncommon::plainname($auname,$audom).'</span>');
13766: } else {
13767: $scope =~ s{/$}{};
13768: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
13769: &Apache::lonnet::domain($scope,'description').'</span>');
13770: }
13771: }
13772:
1.443 albertel 13773: ############################################################
13774: ############################################################
13775:
1.566 albertel 13776: sub check_clone {
1.578 raeburn 13777: my ($args,$linefeed) = @_;
1.566 albertel 13778: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13779: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13780: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13781: my $clonemsg;
13782: my $can_clone = 0;
1.944 raeburn 13783: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13784: if ($lctype ne 'community') {
13785: $lctype = 'course';
13786: }
1.566 albertel 13787: if ($clonehome eq 'no_host') {
1.944 raeburn 13788: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13789: $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'});
13790: } else {
13791: $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'});
13792: }
1.566 albertel 13793: } else {
13794: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13795: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13796: if ($clonedesc{'type'} ne 'Community') {
13797: $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'});
13798: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13799: }
13800: }
1.882 raeburn 13801: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13802: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13803: $can_clone = 1;
13804: } else {
13805: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13806: $args->{'clonedomain'},$args->{'clonecourse'});
13807: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13808: if (grep(/^\*$/,@cloners)) {
13809: $can_clone = 1;
13810: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13811: $can_clone = 1;
13812: } else {
1.908 raeburn 13813: my $ccrole = 'cc';
1.944 raeburn 13814: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13815: $ccrole = 'co';
13816: }
1.578 raeburn 13817: my %roleshash =
13818: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13819: $args->{'ccdomain'},
1.908 raeburn 13820: 'userroles',['active'],[$ccrole],
1.578 raeburn 13821: [$args->{'clonedomain'}]);
1.908 raeburn 13822: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13823: $can_clone = 1;
13824: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13825: $can_clone = 1;
13826: } else {
1.944 raeburn 13827: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13828: $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'});
13829: } else {
13830: $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'});
13831: }
1.578 raeburn 13832: }
1.566 albertel 13833: }
1.578 raeburn 13834: }
1.566 albertel 13835: }
13836: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13837: }
13838:
1.444 albertel 13839: sub construct_course {
1.885 raeburn 13840: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13841: my $outcome;
1.541 raeburn 13842: my $linefeed = '<br />'."\n";
13843: if ($context eq 'auto') {
13844: $linefeed = "\n";
13845: }
1.566 albertel 13846:
13847: #
13848: # Are we cloning?
13849: #
13850: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13851: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13852: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13853: if ($context ne 'auto') {
1.578 raeburn 13854: if ($clonemsg ne '') {
13855: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13856: }
1.566 albertel 13857: }
13858: $outcome .= $clonemsg.$linefeed;
13859:
13860: if (!$can_clone) {
13861: return (0,$outcome);
13862: }
13863: }
13864:
1.444 albertel 13865: #
13866: # Open course
13867: #
13868: my $crstype = lc($args->{'crstype'});
13869: my %cenv=();
13870: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13871: $args->{'cdescr'},
13872: $args->{'curl'},
13873: $args->{'course_home'},
13874: $args->{'nonstandard'},
13875: $args->{'crscode'},
13876: $args->{'ccuname'}.':'.
13877: $args->{'ccdomain'},
1.882 raeburn 13878: $args->{'crstype'},
1.885 raeburn 13879: $cnum,$context,$category);
1.444 albertel 13880:
13881: # Note: The testing routines depend on this being output; see
13882: # Utils::Course. This needs to at least be output as a comment
13883: # if anyone ever decides to not show this, and Utils::Course::new
13884: # will need to be suitably modified.
1.541 raeburn 13885: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13886: if ($$courseid =~ /^error:/) {
13887: return (0,$outcome);
13888: }
13889:
1.444 albertel 13890: #
13891: # Check if created correctly
13892: #
1.479 albertel 13893: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13894: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13895: if ($crsuhome eq 'no_host') {
13896: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13897: return (0,$outcome);
13898: }
1.541 raeburn 13899: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13900:
1.444 albertel 13901: #
1.566 albertel 13902: # Do the cloning
13903: #
13904: if ($can_clone && $cloneid) {
13905: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13906: if ($context ne 'auto') {
13907: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13908: }
13909: $outcome .= $clonemsg.$linefeed;
13910: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13911: # Copy all files
1.637 www 13912: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13913: # Restore URL
1.566 albertel 13914: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13915: # Restore title
1.566 albertel 13916: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13917: # Restore creation date, creator and creation context.
13918: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13919: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13920: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13921: # Mark as cloned
1.566 albertel 13922: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13923: # Need to clone grading mode
13924: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13925: $cenv{'grading'}=$newenv{'grading'};
13926: # Do not clone these environment entries
13927: &Apache::lonnet::del('environment',
13928: ['default_enrollment_start_date',
13929: 'default_enrollment_end_date',
13930: 'question.email',
13931: 'policy.email',
13932: 'comment.email',
13933: 'pch.users.denied',
1.725 raeburn 13934: 'plc.users.denied',
13935: 'hidefromcat',
1.1121 raeburn 13936: 'checkforpriv',
1.725 raeburn 13937: 'categories'],
1.638 www 13938: $$crsudom,$$crsunum);
1.444 albertel 13939: }
1.566 albertel 13940:
1.444 albertel 13941: #
13942: # Set environment (will override cloned, if existing)
13943: #
13944: my @sections = ();
13945: my @xlists = ();
13946: if ($args->{'crstype'}) {
13947: $cenv{'type'}=$args->{'crstype'};
13948: }
13949: if ($args->{'crsid'}) {
13950: $cenv{'courseid'}=$args->{'crsid'};
13951: }
13952: if ($args->{'crscode'}) {
13953: $cenv{'internal.coursecode'}=$args->{'crscode'};
13954: }
13955: if ($args->{'crsquota'} ne '') {
13956: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13957: } else {
13958: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13959: }
13960: if ($args->{'ccuname'}) {
13961: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13962: ':'.$args->{'ccdomain'};
13963: } else {
13964: $cenv{'internal.courseowner'} = $args->{'curruser'};
13965: }
1.1116 raeburn 13966: if ($args->{'defaultcredits'}) {
13967: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
13968: }
1.444 albertel 13969: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13970: if ($args->{'crssections'}) {
13971: $cenv{'internal.sectionnums'} = '';
13972: if ($args->{'crssections'} =~ m/,/) {
13973: @sections = split/,/,$args->{'crssections'};
13974: } else {
13975: $sections[0] = $args->{'crssections'};
13976: }
13977: if (@sections > 0) {
13978: foreach my $item (@sections) {
13979: my ($sec,$gp) = split/:/,$item;
13980: my $class = $args->{'crscode'}.$sec;
13981: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13982: $cenv{'internal.sectionnums'} .= $item.',';
13983: unless ($addcheck eq 'ok') {
13984: push @badclasses, $class;
13985: }
13986: }
13987: $cenv{'internal.sectionnums'} =~ s/,$//;
13988: }
13989: }
13990: # do not hide course coordinator from staff listing,
13991: # even if privileged
13992: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 13993: # add course coordinator's domain to domains to check for privileged users
13994: # if different to course domain
13995: if ($$crsudom ne $args->{'ccdomain'}) {
13996: $cenv{'checkforpriv'} = $args->{'ccdomain'};
13997: }
1.444 albertel 13998: # add crosslistings
13999: if ($args->{'crsxlist'}) {
14000: $cenv{'internal.crosslistings'}='';
14001: if ($args->{'crsxlist'} =~ m/,/) {
14002: @xlists = split/,/,$args->{'crsxlist'};
14003: } else {
14004: $xlists[0] = $args->{'crsxlist'};
14005: }
14006: if (@xlists > 0) {
14007: foreach my $item (@xlists) {
14008: my ($xl,$gp) = split/:/,$item;
14009: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
14010: $cenv{'internal.crosslistings'} .= $item.',';
14011: unless ($addcheck eq 'ok') {
14012: push @badclasses, $xl;
14013: }
14014: }
14015: $cenv{'internal.crosslistings'} =~ s/,$//;
14016: }
14017: }
14018: if ($args->{'autoadds'}) {
14019: $cenv{'internal.autoadds'}=$args->{'autoadds'};
14020: }
14021: if ($args->{'autodrops'}) {
14022: $cenv{'internal.autodrops'}=$args->{'autodrops'};
14023: }
14024: # check for notification of enrollment changes
14025: my @notified = ();
14026: if ($args->{'notify_owner'}) {
14027: if ($args->{'ccuname'} ne '') {
14028: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
14029: }
14030: }
14031: if ($args->{'notify_dc'}) {
14032: if ($uname ne '') {
1.630 raeburn 14033: push(@notified,$uname.':'.$udom);
1.444 albertel 14034: }
14035: }
14036: if (@notified > 0) {
14037: my $notifylist;
14038: if (@notified > 1) {
14039: $notifylist = join(',',@notified);
14040: } else {
14041: $notifylist = $notified[0];
14042: }
14043: $cenv{'internal.notifylist'} = $notifylist;
14044: }
14045: if (@badclasses > 0) {
14046: my %lt=&Apache::lonlocal::texthash(
14047: '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',
14048: 'dnhr' => 'does not have rights to access enrollment in these classes',
14049: 'adby' => 'as determined by the policies of your institution on access to official classlists'
14050: );
1.541 raeburn 14051: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
14052: ' ('.$lt{'adby'}.')';
14053: if ($context eq 'auto') {
14054: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 14055: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 14056: foreach my $item (@badclasses) {
14057: if ($context eq 'auto') {
14058: $outcome .= " - $item\n";
14059: } else {
14060: $outcome .= "<li>$item</li>\n";
14061: }
14062: }
14063: if ($context eq 'auto') {
14064: $outcome .= $linefeed;
14065: } else {
1.566 albertel 14066: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 14067: }
14068: }
1.444 albertel 14069: }
14070: if ($args->{'no_end_date'}) {
14071: $args->{'endaccess'} = 0;
14072: }
14073: $cenv{'internal.autostart'}=$args->{'enrollstart'};
14074: $cenv{'internal.autoend'}=$args->{'enrollend'};
14075: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
14076: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
14077: if ($args->{'showphotos'}) {
14078: $cenv{'internal.showphotos'}=$args->{'showphotos'};
14079: }
14080: $cenv{'internal.authtype'} = $args->{'authtype'};
14081: $cenv{'internal.autharg'} = $args->{'autharg'};
14082: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
14083: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 14084: 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');
14085: if ($context eq 'auto') {
14086: $outcome .= $krb_msg;
14087: } else {
1.566 albertel 14088: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 14089: }
14090: $outcome .= $linefeed;
1.444 albertel 14091: }
14092: }
14093: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
14094: if ($args->{'setpolicy'}) {
14095: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14096: }
14097: if ($args->{'setcontent'}) {
14098: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
14099: }
14100: }
14101: if ($args->{'reshome'}) {
14102: $cenv{'reshome'}=$args->{'reshome'}.'/';
14103: $cenv{'reshome'}=~s/\/+$/\//;
14104: }
14105: #
14106: # course has keyed access
14107: #
14108: if ($args->{'setkeys'}) {
14109: $cenv{'keyaccess'}='yes';
14110: }
14111: # if specified, key authority is not course, but user
14112: # only active if keyaccess is yes
14113: if ($args->{'keyauth'}) {
1.487 albertel 14114: my ($user,$domain) = split(':',$args->{'keyauth'});
14115: $user = &LONCAPA::clean_username($user);
14116: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 14117: if ($user ne '' && $domain ne '') {
1.487 albertel 14118: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 14119: }
14120: }
14121:
14122: if ($args->{'disresdis'}) {
14123: $cenv{'pch.roles.denied'}='st';
14124: }
14125: if ($args->{'disablechat'}) {
14126: $cenv{'plc.roles.denied'}='st';
14127: }
14128:
14129: # Record we've not yet viewed the Course Initialization Helper for this
14130: # course
14131: $cenv{'course.helper.not.run'} = 1;
14132: #
14133: # Use new Randomseed
14134: #
14135: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
14136: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
14137: #
14138: # The encryption code and receipt prefix for this course
14139: #
14140: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
14141: $cenv{'internal.encpref'}=100+int(9*rand(99));
14142: #
14143: # By default, use standard grading
14144: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
14145:
1.541 raeburn 14146: $outcome .= $linefeed.&mt('Setting environment').': '.
14147: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14148: #
14149: # Open all assignments
14150: #
14151: if ($args->{'openall'}) {
14152: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
14153: my %storecontent = ($storeunder => time,
14154: $storeunder.'.type' => 'date_start');
14155:
14156: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 14157: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 14158: }
14159: #
14160: # Set first page
14161: #
14162: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
14163: || ($cloneid)) {
1.445 albertel 14164: use LONCAPA::map;
1.444 albertel 14165: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 14166:
14167: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
14168: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
14169:
1.444 albertel 14170: $outcome .= ($fatal?$errtext:'read ok').' - ';
14171: my $title; my $url;
14172: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 14173: $title=&mt('Syllabus');
1.444 albertel 14174: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
14175: } else {
1.963 raeburn 14176: $title=&mt('Table of Contents');
1.444 albertel 14177: $url='/adm/navmaps';
14178: }
1.445 albertel 14179:
14180: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
14181: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
14182:
14183: if ($errtext) { $fatal=2; }
1.541 raeburn 14184: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 14185: }
1.566 albertel 14186:
14187: return (1,$outcome);
1.444 albertel 14188: }
14189:
14190: ############################################################
14191: ############################################################
14192:
1.953 droeschl 14193: #SD
14194: # only Community and Course, or anything else?
1.378 raeburn 14195: sub course_type {
14196: my ($cid) = @_;
14197: if (!defined($cid)) {
14198: $cid = $env{'request.course.id'};
14199: }
1.404 albertel 14200: if (defined($env{'course.'.$cid.'.type'})) {
14201: return $env{'course.'.$cid.'.type'};
1.378 raeburn 14202: } else {
14203: return 'Course';
1.377 raeburn 14204: }
14205: }
1.156 albertel 14206:
1.406 raeburn 14207: sub group_term {
14208: my $crstype = &course_type();
14209: my %names = (
14210: 'Course' => 'group',
1.865 raeburn 14211: 'Community' => 'group',
1.406 raeburn 14212: );
14213: return $names{$crstype};
14214: }
14215:
1.902 raeburn 14216: sub course_types {
14217: my @types = ('official','unofficial','community');
14218: my %typename = (
14219: official => 'Official course',
14220: unofficial => 'Unofficial course',
14221: community => 'Community',
14222: );
14223: return (\@types,\%typename);
14224: }
14225:
1.156 albertel 14226: sub icon {
14227: my ($file)=@_;
1.505 albertel 14228: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 14229: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 14230: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 14231: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
14232: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
14233: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14234: $curfext.".gif") {
14235: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
14236: $curfext.".gif";
14237: }
14238: }
1.249 albertel 14239: return &lonhttpdurl($iconname);
1.154 albertel 14240: }
1.84 albertel 14241:
1.575 albertel 14242: sub lonhttpdurl {
1.692 www 14243: #
14244: # Had been used for "small fry" static images on separate port 8080.
14245: # Modify here if lightweight http functionality desired again.
14246: # Currently eliminated due to increasing firewall issues.
14247: #
1.575 albertel 14248: my ($url)=@_;
1.692 www 14249: return $url;
1.215 albertel 14250: }
14251:
1.213 albertel 14252: sub connection_aborted {
14253: my ($r)=@_;
14254: $r->print(" ");$r->rflush();
14255: my $c = $r->connection;
14256: return $c->aborted();
14257: }
14258:
1.221 foxr 14259: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 14260: # strings as 'strings'.
14261: sub escape_single {
1.221 foxr 14262: my ($input) = @_;
1.223 albertel 14263: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 14264: $input =~ s/\'/\\\'/g; # Esacpe the 's....
14265: return $input;
14266: }
1.223 albertel 14267:
1.222 foxr 14268: # Same as escape_single, but escape's "'s This
14269: # can be used for "strings"
14270: sub escape_double {
14271: my ($input) = @_;
14272: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
14273: $input =~ s/\"/\\\"/g; # Esacpe the "s....
14274: return $input;
14275: }
1.223 albertel 14276:
1.222 foxr 14277: # Escapes the last element of a full URL.
14278: sub escape_url {
14279: my ($url) = @_;
1.238 raeburn 14280: my @urlslices = split(/\//, $url,-1);
1.369 www 14281: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 14282: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 14283: }
1.462 albertel 14284:
1.820 raeburn 14285: sub compare_arrays {
14286: my ($arrayref1,$arrayref2) = @_;
14287: my (@difference,%count);
14288: @difference = ();
14289: %count = ();
14290: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
14291: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
14292: foreach my $element (keys(%count)) {
14293: if ($count{$element} == 1) {
14294: push(@difference,$element);
14295: }
14296: }
14297: }
14298: return @difference;
14299: }
14300:
1.817 bisitz 14301: # -------------------------------------------------------- Initialize user login
1.462 albertel 14302: sub init_user_environment {
1.463 albertel 14303: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 14304: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
14305:
14306: my $public=($username eq 'public' && $domain eq 'public');
14307:
14308: # See if old ID present, if so, remove
14309:
1.1062 raeburn 14310: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 14311: my $now=time;
14312:
14313: if ($public) {
14314: my $max_public=100;
14315: my $oldest;
14316: my $oldest_time=0;
14317: for(my $next=1;$next<=$max_public;$next++) {
14318: if (-e $lonids."/publicuser_$next.id") {
14319: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
14320: if ($mtime<$oldest_time || !$oldest_time) {
14321: $oldest_time=$mtime;
14322: $oldest=$next;
14323: }
14324: } else {
14325: $cookie="publicuser_$next";
14326: last;
14327: }
14328: }
14329: if (!$cookie) { $cookie="publicuser_$oldest"; }
14330: } else {
1.463 albertel 14331: # if this isn't a robot, kill any existing non-robot sessions
14332: if (!$args->{'robot'}) {
14333: opendir(DIR,$lonids);
14334: while ($filename=readdir(DIR)) {
14335: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
14336: unlink($lonids.'/'.$filename);
14337: }
1.462 albertel 14338: }
1.463 albertel 14339: closedir(DIR);
1.462 albertel 14340: }
14341: # Give them a new cookie
1.463 albertel 14342: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 14343: : $now.$$.int(rand(10000)));
1.463 albertel 14344: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 14345:
14346: # Initialize roles
14347:
1.1062 raeburn 14348: ($userroles,$firstaccenv,$timerintenv) =
14349: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 14350: }
14351: # ------------------------------------ Check browser type and MathML capability
14352:
14353: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1141 raeburn 14354: $clientunicode,$clientos,$clientmobile,$clientinfo) = &decode_user_agent($r);
1.462 albertel 14355:
14356: # ------------------------------------------------------------- Get environment
14357:
14358: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
14359: my ($tmp) = keys(%userenv);
14360: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
14361: } else {
14362: undef(%userenv);
14363: }
14364: if (($userenv{'interface'}) && (!$form->{'interface'})) {
14365: $form->{'interface'}=$userenv{'interface'};
14366: }
14367: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
14368:
14369: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 14370: foreach my $option ('interface','localpath','localres') {
14371: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 14372: }
14373: # --------------------------------------------------------- Write first profile
14374:
14375: {
14376: my %initial_env =
14377: ("user.name" => $username,
14378: "user.domain" => $domain,
14379: "user.home" => $authhost,
14380: "browser.type" => $clientbrowser,
14381: "browser.version" => $clientversion,
14382: "browser.mathml" => $clientmathml,
14383: "browser.unicode" => $clientunicode,
14384: "browser.os" => $clientos,
1.1137 raeburn 14385: "browser.mobile" => $clientmobile,
1.1141 raeburn 14386: "browser.info" => $clientinfo,
1.462 albertel 14387: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
14388: "request.course.fn" => '',
14389: "request.course.uri" => '',
14390: "request.course.sec" => '',
14391: "request.role" => 'cm',
14392: "request.role.adv" => $env{'user.adv'},
14393: "request.host" => $ENV{'REMOTE_ADDR'},);
14394:
14395: if ($form->{'localpath'}) {
14396: $initial_env{"browser.localpath"} = $form->{'localpath'};
14397: $initial_env{"browser.localres"} = $form->{'localres'};
14398: }
14399:
14400: if ($form->{'interface'}) {
14401: $form->{'interface'}=~s/\W//gs;
14402: $initial_env{"browser.interface"} = $form->{'interface'};
14403: $env{'browser.interface'}=$form->{'interface'};
14404: }
14405:
1.981 raeburn 14406: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 14407: my %domdef;
14408: unless ($domain eq 'public') {
14409: %domdef = &Apache::lonnet::get_domain_defaults($domain);
14410: }
1.980 raeburn 14411:
1.1081 raeburn 14412: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 14413: $userenv{'availabletools.'.$tool} =
1.980 raeburn 14414: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
14415: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 14416: }
14417:
1.864 raeburn 14418: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 14419: $userenv{'canrequest.'.$crstype} =
14420: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 14421: 'reload','requestcourses',
14422: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 14423: }
14424:
1.1092 raeburn 14425: $userenv{'canrequest.author'} =
14426: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
14427: 'reload','requestauthor',
14428: \%userenv,\%domdef,\%is_adv);
14429: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
14430: $domain,$username);
14431: my $reqstatus = $reqauthor{'author_status'};
14432: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
14433: if (ref($reqauthor{'author'}) eq 'HASH') {
14434: $userenv{'requestauthorqueued'} = $reqstatus.':'.
14435: $reqauthor{'author'}{'timestamp'};
14436: }
14437: }
14438:
1.462 albertel 14439: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 14440:
1.462 albertel 14441: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
14442: &GDBM_WRCREAT(),0640)) {
14443: &_add_to_env(\%disk_env,\%initial_env);
14444: &_add_to_env(\%disk_env,\%userenv,'environment.');
14445: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 14446: if (ref($firstaccenv) eq 'HASH') {
14447: &_add_to_env(\%disk_env,$firstaccenv);
14448: }
14449: if (ref($timerintenv) eq 'HASH') {
14450: &_add_to_env(\%disk_env,$timerintenv);
14451: }
1.463 albertel 14452: if (ref($args->{'extra_env'})) {
14453: &_add_to_env(\%disk_env,$args->{'extra_env'});
14454: }
1.462 albertel 14455: untie(%disk_env);
14456: } else {
1.705 tempelho 14457: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
14458: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 14459: return 'error: '.$!;
14460: }
14461: }
14462: $env{'request.role'}='cm';
14463: $env{'request.role.adv'}=$env{'user.adv'};
14464: $env{'browser.type'}=$clientbrowser;
14465:
14466: return $cookie;
14467:
14468: }
14469:
14470: sub _add_to_env {
14471: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 14472: if (ref($env_data) eq 'HASH') {
14473: while (my ($key,$value) = each(%$env_data)) {
14474: $idf->{$prefix.$key} = $value;
14475: $env{$prefix.$key} = $value;
14476: }
1.462 albertel 14477: }
14478: }
14479:
1.685 tempelho 14480: # --- Get the symbolic name of a problem and the url
14481: sub get_symb {
14482: my ($request,$silent) = @_;
1.726 raeburn 14483: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 14484: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
14485: if ($symb eq '') {
14486: if (!$silent) {
1.1071 raeburn 14487: if (ref($request)) {
14488: $request->print("Unable to handle ambiguous references:$url:.");
14489: }
1.685 tempelho 14490: return ();
14491: }
14492: }
14493: &Apache::lonenc::check_decrypt(\$symb);
14494: return ($symb);
14495: }
14496:
14497: # --------------------------------------------------------------Get annotation
14498:
14499: sub get_annotation {
14500: my ($symb,$enc) = @_;
14501:
14502: my $key = $symb;
14503: if (!$enc) {
14504: $key =
14505: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
14506: }
14507: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
14508: return $annotation{$key};
14509: }
14510:
14511: sub clean_symb {
1.731 raeburn 14512: my ($symb,$delete_enc) = @_;
1.685 tempelho 14513:
14514: &Apache::lonenc::check_decrypt(\$symb);
14515: my $enc = $env{'request.enc'};
1.731 raeburn 14516: if ($delete_enc) {
1.730 raeburn 14517: delete($env{'request.enc'});
14518: }
1.685 tempelho 14519:
14520: return ($symb,$enc);
14521: }
1.462 albertel 14522:
1.990 raeburn 14523: sub build_release_hashes {
14524: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
14525: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
14526: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
14527: (ref($randomizetry) eq 'HASH'));
14528: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14529: my ($item,$name,$value) = split(/:/,$key);
14530: if ($item eq 'parameter') {
14531: if (ref($checkparms->{$name}) eq 'ARRAY') {
14532: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
14533: push(@{$checkparms->{$name}},$value);
14534: }
14535: } else {
14536: push(@{$checkparms->{$name}},$value);
14537: }
14538: } elsif ($item eq 'resourcetag') {
14539: if ($name eq 'responsetype') {
14540: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
14541: }
14542: } elsif ($item eq 'course') {
14543: if ($name eq 'crstype') {
14544: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14545: }
14546: }
14547: }
14548: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14549: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14550: return;
14551: }
14552:
1.1083 raeburn 14553: sub update_content_constraints {
14554: my ($cdom,$cnum,$chome,$cid) = @_;
14555: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14556: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14557: my %checkresponsetypes;
14558: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14559: my ($item,$name,$value) = split(/:/,$key);
14560: if ($item eq 'resourcetag') {
14561: if ($name eq 'responsetype') {
14562: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14563: }
14564: }
14565: }
14566: my $navmap = Apache::lonnavmaps::navmap->new();
14567: if (defined($navmap)) {
14568: my %allresponses;
14569: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14570: my %responses = $res->responseTypes();
14571: foreach my $key (keys(%responses)) {
14572: next unless(exists($checkresponsetypes{$key}));
14573: $allresponses{$key} += $responses{$key};
14574: }
14575: }
14576: foreach my $key (keys(%allresponses)) {
14577: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14578: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14579: ($reqdmajor,$reqdminor) = ($major,$minor);
14580: }
14581: }
14582: undef($navmap);
14583: }
14584: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14585: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14586: }
14587: return;
14588: }
14589:
1.1110 raeburn 14590: sub allmaps_incourse {
14591: my ($cdom,$cnum,$chome,$cid) = @_;
14592: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
14593: $cid = $env{'request.course.id'};
14594: $cdom = $env{'course.'.$cid.'.domain'};
14595: $cnum = $env{'course.'.$cid.'.num'};
14596: $chome = $env{'course.'.$cid.'.home'};
14597: }
14598: my %allmaps = ();
14599: my $lastchange =
14600: &Apache::lonnet::get_coursechange($cdom,$cnum);
14601: if ($lastchange > $env{'request.course.tied'}) {
14602: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
14603: unless ($ferr) {
14604: &update_content_constraints($cdom,$cnum,$chome,$cid);
14605: }
14606: }
14607: my $navmap = Apache::lonnavmaps::navmap->new();
14608: if (defined($navmap)) {
14609: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
14610: $allmaps{$res->src()} = 1;
14611: }
14612: }
14613: return \%allmaps;
14614: }
14615:
1.1083 raeburn 14616: sub parse_supplemental_title {
14617: my ($title) = @_;
14618:
14619: my ($foldertitle,$renametitle);
14620: if ($title =~ /&&&/) {
14621: $title = &HTML::Entites::decode($title);
14622: }
14623: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14624: $renametitle=$4;
14625: my ($time,$uname,$udom) = ($1,$2,$3);
14626: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14627: my $name = &plainname($uname,$udom);
14628: $name = &HTML::Entities::encode($name,'"<>&\'');
14629: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14630: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14631: $name.': <br />'.$foldertitle;
14632: }
14633: if (wantarray) {
14634: return ($title,$foldertitle,$renametitle);
14635: }
14636: return $title;
14637: }
14638:
1.1143 raeburn 14639: sub recurse_supplemental {
14640: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
14641: if ($suppmap) {
14642: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
14643: if ($fatal) {
14644: $errors ++;
14645: } else {
14646: if ($#LONCAPA::map::resources > 0) {
14647: foreach my $res (@LONCAPA::map::resources) {
14648: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
14649: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 14650: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
14651: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1143 raeburn 14652: } else {
14653: $numfiles ++;
14654: }
14655: }
14656: }
14657: }
14658: }
14659: }
14660: return ($numfiles,$errors);
14661: }
14662:
1.1101 raeburn 14663: sub symb_to_docspath {
14664: my ($symb) = @_;
14665: return unless ($symb);
14666: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
14667: if ($resurl=~/\.(sequence|page)$/) {
14668: $mapurl=$resurl;
14669: } elsif ($resurl eq 'adm/navmaps') {
14670: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
14671: }
14672: my $mapresobj;
14673: my $navmap = Apache::lonnavmaps::navmap->new();
14674: if (ref($navmap)) {
14675: $mapresobj = $navmap->getResourceByUrl($mapurl);
14676: }
14677: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
14678: my $type=$2;
14679: my $path;
14680: if (ref($mapresobj)) {
14681: my $pcslist = $mapresobj->map_hierarchy();
14682: if ($pcslist ne '') {
14683: foreach my $pc (split(/,/,$pcslist)) {
14684: next if ($pc <= 1);
14685: my $res = $navmap->getByMapPc($pc);
14686: if (ref($res)) {
14687: my $thisurl = $res->src();
14688: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
14689: my $thistitle = $res->title();
14690: $path .= '&'.
14691: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 14692: &escape($thistitle).
1.1101 raeburn 14693: ':'.$res->randompick().
14694: ':'.$res->randomout().
14695: ':'.$res->encrypted().
14696: ':'.$res->randomorder().
14697: ':'.$res->is_page();
14698: }
14699: }
14700: }
14701: $path =~ s/^\&//;
14702: my $maptitle = $mapresobj->title();
14703: if ($mapurl eq 'default') {
1.1129 raeburn 14704: $maptitle = 'Main Content';
1.1101 raeburn 14705: }
14706: $path .= (($path ne '')? '&' : '').
14707: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 14708: &escape($maptitle).
1.1101 raeburn 14709: ':'.$mapresobj->randompick().
14710: ':'.$mapresobj->randomout().
14711: ':'.$mapresobj->encrypted().
14712: ':'.$mapresobj->randomorder().
14713: ':'.$mapresobj->is_page();
14714: } else {
14715: my $maptitle = &Apache::lonnet::gettitle($mapurl);
14716: my $ispage = (($type eq 'page')? 1 : '');
14717: if ($mapurl eq 'default') {
1.1129 raeburn 14718: $maptitle = 'Main Content';
1.1101 raeburn 14719: }
14720: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 14721: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 14722: }
14723: unless ($mapurl eq 'default') {
14724: $path = 'default&'.
1.1146 raeburn 14725: &escape('Main Content').
1.1101 raeburn 14726: ':::::&'.$path;
14727: }
14728: return $path;
14729: }
14730:
1.1094 raeburn 14731: sub captcha_display {
14732: my ($context,$lonhost) = @_;
14733: my ($output,$error);
14734: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14735: if ($captcha eq 'original') {
1.1094 raeburn 14736: $output = &create_captcha();
14737: unless ($output) {
14738: $error = 'captcha';
14739: }
14740: } elsif ($captcha eq 'recaptcha') {
14741: $output = &create_recaptcha($pubkey);
14742: unless ($output) {
1.1095 raeburn 14743: $error = 'recaptcha';
1.1094 raeburn 14744: }
14745: }
14746: return ($output,$error);
14747: }
14748:
14749: sub captcha_response {
14750: my ($context,$lonhost) = @_;
14751: my ($captcha_chk,$captcha_error);
14752: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14753: if ($captcha eq 'original') {
1.1094 raeburn 14754: ($captcha_chk,$captcha_error) = &check_captcha();
14755: } elsif ($captcha eq 'recaptcha') {
14756: $captcha_chk = &check_recaptcha($privkey);
14757: } else {
14758: $captcha_chk = 1;
14759: }
14760: return ($captcha_chk,$captcha_error);
14761: }
14762:
14763: sub get_captcha_config {
14764: my ($context,$lonhost) = @_;
1.1095 raeburn 14765: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 14766: my $hostname = &Apache::lonnet::hostname($lonhost);
14767: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14768: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 14769: if ($context eq 'usercreation') {
14770: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
14771: if (ref($domconfig{$context}) eq 'HASH') {
14772: $hashtocheck = $domconfig{$context}{'cancreate'};
14773: if (ref($hashtocheck) eq 'HASH') {
14774: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
14775: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
14776: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
14777: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
14778: }
14779: if ($privkey && $pubkey) {
14780: $captcha = 'recaptcha';
14781: } else {
14782: $captcha = 'original';
14783: }
14784: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
14785: $captcha = 'original';
14786: }
1.1094 raeburn 14787: }
1.1095 raeburn 14788: } else {
14789: $captcha = 'captcha';
14790: }
14791: } elsif ($context eq 'login') {
14792: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
14793: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
14794: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
14795: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 14796: if ($privkey && $pubkey) {
14797: $captcha = 'recaptcha';
1.1095 raeburn 14798: } else {
14799: $captcha = 'original';
1.1094 raeburn 14800: }
1.1095 raeburn 14801: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
14802: $captcha = 'original';
1.1094 raeburn 14803: }
14804: }
14805: return ($captcha,$pubkey,$privkey);
14806: }
14807:
14808: sub create_captcha {
14809: my %captcha_params = &captcha_settings();
14810: my ($output,$maxtries,$tries) = ('',10,0);
14811: while ($tries < $maxtries) {
14812: $tries ++;
14813: my $captcha = Authen::Captcha->new (
14814: output_folder => $captcha_params{'output_dir'},
14815: data_folder => $captcha_params{'db_dir'},
14816: );
14817: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14818:
14819: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14820: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14821: &mt('Type in the letters/numbers shown below').' '.
14822: '<input type="text" size="5" name="code" value="" /><br />'.
14823: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14824: last;
14825: }
14826: }
14827: return $output;
14828: }
14829:
14830: sub captcha_settings {
14831: my %captcha_params = (
14832: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14833: www_output_dir => "/captchaspool",
14834: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14835: numchars => '5',
14836: );
14837: return %captcha_params;
14838: }
14839:
14840: sub check_captcha {
14841: my ($captcha_chk,$captcha_error);
14842: my $code = $env{'form.code'};
14843: my $md5sum = $env{'form.crypt'};
14844: my %captcha_params = &captcha_settings();
14845: my $captcha = Authen::Captcha->new(
14846: output_folder => $captcha_params{'output_dir'},
14847: data_folder => $captcha_params{'db_dir'},
14848: );
1.1109 raeburn 14849: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 14850: my %captcha_hash = (
14851: 0 => 'Code not checked (file error)',
14852: -1 => 'Failed: code expired',
14853: -2 => 'Failed: invalid code (not in database)',
14854: -3 => 'Failed: invalid code (code does not match crypt)',
14855: );
14856: if ($captcha_chk != 1) {
14857: $captcha_error = $captcha_hash{$captcha_chk}
14858: }
14859: return ($captcha_chk,$captcha_error);
14860: }
14861:
14862: sub create_recaptcha {
14863: my ($pubkey) = @_;
14864: my $captcha = Captcha::reCAPTCHA->new;
14865: return $captcha->get_options_setter({theme => 'white'})."\n".
14866: $captcha->get_html($pubkey).
14867: &mt('If either word is hard to read, [_1] will replace them.',
1.1133 raeburn 14868: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1094 raeburn 14869: '<br /><br />';
14870: }
14871:
14872: sub check_recaptcha {
14873: my ($privkey) = @_;
14874: my $captcha_chk;
14875: my $captcha = Captcha::reCAPTCHA->new;
14876: my $captcha_result =
14877: $captcha->check_answer(
14878: $privkey,
14879: $ENV{'REMOTE_ADDR'},
14880: $env{'form.recaptcha_challenge_field'},
14881: $env{'form.recaptcha_response_field'},
14882: );
14883: if ($captcha_result->{is_valid}) {
14884: $captcha_chk = 1;
14885: }
14886: return $captcha_chk;
14887: }
14888:
1.41 ng 14889: =pod
14890:
14891: =back
14892:
1.112 bowersj2 14893: =cut
1.41 ng 14894:
1.112 bowersj2 14895: 1;
14896: __END__;
1.41 ng 14897:
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