Annotation of loncom/interface/loncommon.pm, revision 1.1095
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1095 ! raeburn 4: # $Id: loncommon.pm,v 1.1094 2012/08/25 04:34:44 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.1091 foxr 73: use Text::Aspell;
1.1094 raeburn 74: use Authen::Captcha;
75: use Captcha::reCAPTCHA;
1.117 www 76:
1.517 raeburn 77: # ---------------------------------------------- Designs
78: use vars qw(%defaultdesign);
79:
1.22 www 80: my $readit;
81:
1.517 raeburn 82:
1.157 matthew 83: ##
84: ## Global Variables
85: ##
1.46 matthew 86:
1.643 foxr 87:
88: # ----------------------------------------------- SSI with retries:
89: #
90:
91: =pod
92:
1.648 raeburn 93: =head1 Server Side include with retries:
1.643 foxr 94:
95: =over 4
96:
1.648 raeburn 97: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 98:
99: Performs an ssi with some number of retries. Retries continue either
100: until the result is ok or until the retry count supplied by the
101: caller is exhausted.
102:
103: Inputs:
1.648 raeburn 104:
105: =over 4
106:
1.643 foxr 107: resource - Identifies the resource to insert.
1.648 raeburn 108:
1.643 foxr 109: retries - Count of the number of retries allowed.
1.648 raeburn 110:
1.643 foxr 111: form - Hash that identifies the rendering options.
112:
1.648 raeburn 113: =back
114:
115: Returns:
116:
117: =over 4
118:
1.643 foxr 119: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 120:
1.643 foxr 121: response - The response from the last attempt (which may or may not have been successful.
122:
1.648 raeburn 123: =back
124:
125: =back
126:
1.643 foxr 127: =cut
128:
129: sub ssi_with_retries {
130: my ($resource, $retries, %form) = @_;
131:
132:
133: my $ok = 0; # True if we got a good response.
134: my $content;
135: my $response;
136:
137: # Try to get the ssi done. within the retries count:
138:
139: do {
140: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
141: $ok = $response->is_success;
1.650 www 142: if (!$ok) {
143: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
144: }
1.643 foxr 145: $retries--;
146: } while (!$ok && ($retries > 0));
147:
148: if (!$ok) {
149: $content = ''; # On error return an empty content.
150: }
151: return ($content, $response);
152:
153: }
154:
155:
156:
1.20 www 157: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 158: my %language;
1.124 www 159: my %supported_language;
1.1088 foxr 160: my %supported_codes;
1.1048 foxr 161: my %latex_language; # For choosing hyphenation in <transl..>
162: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 163: my %cprtag;
1.192 taceyjo1 164: my %scprtag;
1.351 www 165: my %fe; my %fd; my %fm;
1.41 ng 166: my %category_extensions;
1.12 harris41 167:
1.46 matthew 168: # ---------------------------------------------- Thesaurus variables
1.144 matthew 169: #
170: # %Keywords:
171: # A hash used by &keyword to determine if a word is considered a keyword.
172: # $thesaurus_db_file
173: # Scalar containing the full path to the thesaurus database.
1.46 matthew 174:
175: my %Keywords;
176: my $thesaurus_db_file;
177:
1.144 matthew 178: #
179: # Initialize values from language.tab, copyright.tab, filetypes.tab,
180: # thesaurus.tab, and filecategories.tab.
181: #
1.18 www 182: BEGIN {
1.46 matthew 183: # Variable initialization
184: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
185: #
1.22 www 186: unless ($readit) {
1.12 harris41 187: # ------------------------------------------------------------------- languages
188: {
1.158 raeburn 189: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
190: '/language.tab';
191: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 192: while (my $line = <$fh>) {
193: next if ($line=~/^\#/);
194: chomp($line);
1.1088 foxr 195: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 196: $language{$key}=$val.' - '.$enc;
197: if ($sup) {
198: $supported_language{$key}=$sup;
1.1088 foxr 199: $supported_codes{$key} = $code;
1.158 raeburn 200: }
1.1048 foxr 201: if ($latex) {
202: $latex_language_bykey{$key} = $latex;
1.1088 foxr 203: $latex_language{$code} = $latex;
1.1048 foxr 204: }
1.158 raeburn 205: }
206: close($fh);
207: }
1.12 harris41 208: }
209: # ------------------------------------------------------------------ copyrights
210: {
1.158 raeburn 211: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
212: '/copyright.tab';
213: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 214: while (my $line = <$fh>) {
215: next if ($line=~/^\#/);
216: chomp($line);
217: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 218: $cprtag{$key}=$val;
219: }
220: close($fh);
221: }
1.12 harris41 222: }
1.351 www 223: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 224: {
225: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
226: '/source_copyright.tab';
227: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 228: while (my $line = <$fh>) {
229: next if ($line =~ /^\#/);
230: chomp($line);
231: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 232: $scprtag{$key}=$val;
233: }
234: close($fh);
235: }
236: }
1.63 www 237:
1.517 raeburn 238: # -------------------------------------------------------------- default domain designs
1.63 www 239: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 240: my $designfile = $designdir.'/default.tab';
241: if ( open (my $fh,"<$designfile") ) {
242: while (my $line = <$fh>) {
243: next if ($line =~ /^\#/);
244: chomp($line);
245: my ($key,$val)=(split(/\=/,$line));
246: if ($val) { $defaultdesign{$key}=$val; }
247: }
248: close($fh);
1.63 www 249: }
250:
1.15 harris41 251: # ------------------------------------------------------------- file categories
252: {
1.158 raeburn 253: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
254: '/filecategories.tab';
255: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 256: while (my $line = <$fh>) {
257: next if ($line =~ /^\#/);
258: chomp($line);
259: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 260: push @{$category_extensions{lc($category)}},$extension;
261: }
262: close($fh);
263: }
264:
1.15 harris41 265: }
1.12 harris41 266: # ------------------------------------------------------------------ file types
267: {
1.158 raeburn 268: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
269: '/filetypes.tab';
270: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 271: while (my $line = <$fh>) {
272: next if ($line =~ /^\#/);
273: chomp($line);
274: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 275: if ($descr ne '') {
276: $fe{$ending}=lc($emb);
277: $fd{$ending}=$descr;
1.351 www 278: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 279: }
280: }
281: close($fh);
282: }
1.12 harris41 283: }
1.22 www 284: &Apache::lonnet::logthis(
1.705 tempelho 285: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 286: $readit=1;
1.46 matthew 287: } # end of unless($readit)
1.32 matthew 288:
289: }
1.112 bowersj2 290:
1.42 matthew 291: ###############################################################
292: ## HTML and Javascript Helper Functions ##
293: ###############################################################
294:
295: =pod
296:
1.112 bowersj2 297: =head1 HTML and Javascript Functions
1.42 matthew 298:
1.112 bowersj2 299: =over 4
300:
1.648 raeburn 301: =item * &browser_and_searcher_javascript()
1.112 bowersj2 302:
303: X<browsing, javascript>X<searching, javascript>Returns a string
304: containing javascript with two functions, C<openbrowser> and
305: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
306: tags.
1.42 matthew 307:
1.648 raeburn 308: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 309:
310: inputs: formname, elementname, only, omit
311:
312: formname and elementname indicate the name of the html form and name of
313: the element that the results of the browsing selection are to be placed in.
314:
315: Specifying 'only' will restrict the browser to displaying only files
1.185 www 316: with the given extension. Can be a comma separated list.
1.42 matthew 317:
318: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 319: with the given extension. Can be a comma separated list.
1.42 matthew 320:
1.648 raeburn 321: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 322:
323: Inputs: formname, elementname
324:
325: formname and elementname specify the name of the html form and the name
326: of the element the selection from the search results will be placed in.
1.542 raeburn 327:
1.42 matthew 328: =cut
329:
330: sub browser_and_searcher_javascript {
1.199 albertel 331: my ($mode)=@_;
332: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 333: my $resurl=&escape_single(&lastresurl());
1.42 matthew 334: return <<END;
1.219 albertel 335: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 336: var editbrowser = null;
1.135 albertel 337: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 338: var url = '$resurl/?';
1.42 matthew 339: if (editbrowser == null) {
340: url += 'launch=1&';
341: }
342: url += 'catalogmode=interactive&';
1.199 albertel 343: url += 'mode=$mode&';
1.611 albertel 344: url += 'inhibitmenu=yes&';
1.42 matthew 345: url += 'form=' + formname + '&';
346: if (only != null) {
347: url += 'only=' + only + '&';
1.217 albertel 348: } else {
349: url += 'only=&';
350: }
1.42 matthew 351: if (omit != null) {
352: url += 'omit=' + omit + '&';
1.217 albertel 353: } else {
354: url += 'omit=&';
355: }
1.135 albertel 356: if (titleelement != null) {
357: url += 'titleelement=' + titleelement + '&';
1.217 albertel 358: } else {
359: url += 'titleelement=&';
360: }
1.42 matthew 361: url += 'element=' + elementname + '';
362: var title = 'Browser';
1.435 albertel 363: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 364: options += ',width=700,height=600';
365: editbrowser = open(url,title,options,'1');
366: editbrowser.focus();
367: }
368: var editsearcher;
1.135 albertel 369: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 370: var url = '/adm/searchcat?';
371: if (editsearcher == null) {
372: url += 'launch=1&';
373: }
374: url += 'catalogmode=interactive&';
1.199 albertel 375: url += 'mode=$mode&';
1.42 matthew 376: url += 'form=' + formname + '&';
1.135 albertel 377: if (titleelement != null) {
378: url += 'titleelement=' + titleelement + '&';
1.217 albertel 379: } else {
380: url += 'titleelement=&';
381: }
1.42 matthew 382: url += 'element=' + elementname + '';
383: var title = 'Search';
1.435 albertel 384: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 385: options += ',width=700,height=600';
386: editsearcher = open(url,title,options,'1');
387: editsearcher.focus();
388: }
1.219 albertel 389: // END LON-CAPA Internal -->
1.42 matthew 390: END
1.170 www 391: }
392:
393: sub lastresurl {
1.258 albertel 394: if ($env{'environment.lastresurl'}) {
395: return $env{'environment.lastresurl'}
1.170 www 396: } else {
397: return '/res';
398: }
399: }
400:
401: sub storeresurl {
402: my $resurl=&Apache::lonnet::clutter(shift);
403: unless ($resurl=~/^\/res/) { return 0; }
404: $resurl=~s/\/$//;
405: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 406: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 407: return 1;
1.42 matthew 408: }
409:
1.74 www 410: sub studentbrowser_javascript {
1.111 www 411: unless (
1.258 albertel 412: (($env{'request.course.id'}) &&
1.302 albertel 413: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
414: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
415: '/'.$env{'request.course.sec'})
416: ))
1.258 albertel 417: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 418: ) { return ''; }
1.74 www 419: return (<<'ENDSTDBRW');
1.776 bisitz 420: <script type="text/javascript" language="Javascript">
1.824 bisitz 421: // <![CDATA[
1.74 www 422: var stdeditbrowser;
1.999 www 423: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 424: var url = '/adm/pickstudent?';
425: var filter;
1.558 albertel 426: if (!ignorefilter) {
427: eval('filter=document.'+formname+'.'+uname+'.value;');
428: }
1.74 www 429: if (filter != null) {
430: if (filter != '') {
431: url += 'filter='+filter+'&';
432: }
433: }
434: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 435: '&udomelement='+udom+
436: '&clicker='+clicker;
1.111 www 437: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 438: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 439: var title = 'Student_Browser';
1.74 www 440: var options = 'scrollbars=1,resizable=1,menubar=0';
441: options += ',width=700,height=600';
442: stdeditbrowser = open(url,title,options,'1');
443: stdeditbrowser.focus();
444: }
1.824 bisitz 445: // ]]>
1.74 www 446: </script>
447: ENDSTDBRW
448: }
1.42 matthew 449:
1.1003 www 450: sub resourcebrowser_javascript {
451: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 452: return (<<'ENDRESBRW');
1.1003 www 453: <script type="text/javascript" language="Javascript">
454: // <![CDATA[
455: var reseditbrowser;
1.1004 www 456: function openresbrowser(formname,reslink) {
1.1005 www 457: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 458: var title = 'Resource_Browser';
459: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 460: options += ',width=700,height=500';
1.1004 www 461: reseditbrowser = open(url,title,options,'1');
462: reseditbrowser.focus();
1.1003 www 463: }
464: // ]]>
465: </script>
1.1004 www 466: ENDRESBRW
1.1003 www 467: }
468:
1.74 www 469: sub selectstudent_link {
1.999 www 470: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
471: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
472: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
473: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 474: if ($env{'request.course.id'}) {
1.302 albertel 475: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
476: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
477: '/'.$env{'request.course.sec'})) {
1.111 www 478: return '';
479: }
1.999 www 480: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 481: if ($courseadvonly) {
482: $callargs .= ",'',1,1";
483: }
484: return '<span class="LC_nobreak">'.
485: '<a href="javascript:openstdbrowser('.$callargs.');">'.
486: &mt('Select User').'</a></span>';
1.74 www 487: }
1.258 albertel 488: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 489: $callargs .= ",'',1";
1.793 raeburn 490: return '<span class="LC_nobreak">'.
491: '<a href="javascript:openstdbrowser('.$callargs.');">'.
492: &mt('Select User').'</a></span>';
1.111 www 493: }
494: return '';
1.91 www 495: }
496:
1.1004 www 497: sub selectresource_link {
498: my ($form,$reslink,$arg)=@_;
499:
500: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
501: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
502: unless ($env{'request.course.id'}) { return $arg; }
503: return '<span class="LC_nobreak">'.
504: '<a href="javascript:openresbrowser('.$callargs.');">'.
505: $arg.'</a></span>';
506: }
507:
508:
509:
1.653 raeburn 510: sub authorbrowser_javascript {
511: return <<"ENDAUTHORBRW";
1.776 bisitz 512: <script type="text/javascript" language="JavaScript">
1.824 bisitz 513: // <![CDATA[
1.653 raeburn 514: var stdeditbrowser;
515:
516: function openauthorbrowser(formname,udom) {
517: var url = '/adm/pickauthor?';
518: url += 'form='+formname+'&roledom='+udom;
519: var title = 'Author_Browser';
520: var options = 'scrollbars=1,resizable=1,menubar=0';
521: options += ',width=700,height=600';
522: stdeditbrowser = open(url,title,options,'1');
523: stdeditbrowser.focus();
524: }
525:
1.824 bisitz 526: // ]]>
1.653 raeburn 527: </script>
528: ENDAUTHORBRW
529: }
530:
1.91 www 531: sub coursebrowser_javascript {
1.909 raeburn 532: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 533: my $wintitle = 'Course_Browser';
1.931 raeburn 534: if ($crstype eq 'Community') {
1.932 raeburn 535: $wintitle = 'Community_Browser';
1.909 raeburn 536: }
1.876 raeburn 537: my $id_functions = &javascript_index_functions();
538: my $output = '
1.776 bisitz 539: <script type="text/javascript" language="JavaScript">
1.824 bisitz 540: // <![CDATA[
1.468 raeburn 541: var stdeditbrowser;'."\n";
1.876 raeburn 542:
543: $output .= <<"ENDSTDBRW";
1.909 raeburn 544: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 545: var url = '/adm/pickcourse?';
1.895 raeburn 546: var formid = getFormIdByName(formname);
1.876 raeburn 547: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 548: if (domainfilter != null) {
549: if (domainfilter != '') {
550: url += 'domainfilter='+domainfilter+'&';
551: }
552: }
1.91 www 553: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 554: '&cdomelement='+udom+
555: '&cnameelement='+desc;
1.468 raeburn 556: if (extra_element !=null && extra_element != '') {
1.594 raeburn 557: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 558: url += '&roleelement='+extra_element;
559: if (domainfilter == null || domainfilter == '') {
560: url += '&domainfilter='+extra_element;
561: }
1.234 raeburn 562: }
1.468 raeburn 563: else {
564: if (formname == 'portform') {
565: url += '&setroles='+extra_element;
1.800 raeburn 566: } else {
567: if (formname == 'rules') {
568: url += '&fixeddom='+extra_element;
569: }
1.468 raeburn 570: }
571: }
1.230 raeburn 572: }
1.909 raeburn 573: if (type != null && type != '') {
574: url += '&type='+type;
575: }
576: if (type_elem != null && type_elem != '') {
577: url += '&typeelement='+type_elem;
578: }
1.872 raeburn 579: if (formname == 'ccrs') {
580: var ownername = document.forms[formid].ccuname.value;
581: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
582: url += '&cloner='+ownername+':'+ownerdom;
583: }
1.293 raeburn 584: if (multflag !=null && multflag != '') {
585: url += '&multiple='+multflag;
586: }
1.909 raeburn 587: var title = '$wintitle';
1.91 www 588: var options = 'scrollbars=1,resizable=1,menubar=0';
589: options += ',width=700,height=600';
590: stdeditbrowser = open(url,title,options,'1');
591: stdeditbrowser.focus();
592: }
1.876 raeburn 593: $id_functions
594: ENDSTDBRW
1.905 raeburn 595: if (($sec_element ne '') || ($role_element ne '')) {
596: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 597: }
598: $output .= '
599: // ]]>
600: </script>';
601: return $output;
602: }
603:
604: sub javascript_index_functions {
605: return <<"ENDJS";
606:
607: function getFormIdByName(formname) {
608: for (var i=0;i<document.forms.length;i++) {
609: if (document.forms[i].name == formname) {
610: return i;
611: }
612: }
613: return -1;
614: }
615:
616: function getIndexByName(formid,item) {
617: for (var i=0;i<document.forms[formid].elements.length;i++) {
618: if (document.forms[formid].elements[i].name == item) {
619: return i;
620: }
621: }
622: return -1;
623: }
1.468 raeburn 624:
1.876 raeburn 625: function getDomainFromSelectbox(formname,udom) {
626: var userdom;
627: var formid = getFormIdByName(formname);
628: if (formid > -1) {
629: var domid = getIndexByName(formid,udom);
630: if (domid > -1) {
631: if (document.forms[formid].elements[domid].type == 'select-one') {
632: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
633: }
634: if (document.forms[formid].elements[domid].type == 'hidden') {
635: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 636: }
637: }
638: }
1.876 raeburn 639: return userdom;
640: }
641:
642: ENDJS
1.468 raeburn 643:
1.876 raeburn 644: }
645:
1.1017 raeburn 646: sub javascript_array_indexof {
1.1018 raeburn 647: return <<ENDJS;
1.1017 raeburn 648: <script type="text/javascript" language="JavaScript">
649: // <![CDATA[
650:
651: if (!Array.prototype.indexOf) {
652: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
653: "use strict";
654: if (this === void 0 || this === null) {
655: throw new TypeError();
656: }
657: var t = Object(this);
658: var len = t.length >>> 0;
659: if (len === 0) {
660: return -1;
661: }
662: var n = 0;
663: if (arguments.length > 0) {
664: n = Number(arguments[1]);
1.1088 foxr 665: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 666: n = 0;
667: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
668: n = (n > 0 || -1) * Math.floor(Math.abs(n));
669: }
670: }
671: if (n >= len) {
672: return -1;
673: }
674: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
675: for (; k < len; k++) {
676: if (k in t && t[k] === searchElement) {
677: return k;
678: }
679: }
680: return -1;
681: }
682: }
683:
684: // ]]>
685: </script>
686:
687: ENDJS
688:
689: }
690:
1.876 raeburn 691: sub userbrowser_javascript {
692: my $id_functions = &javascript_index_functions();
693: return <<"ENDUSERBRW";
694:
1.888 raeburn 695: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 696: var url = '/adm/pickuser?';
697: var userdom = getDomainFromSelectbox(formname,udom);
698: if (userdom != null) {
699: if (userdom != '') {
700: url += 'srchdom='+userdom+'&';
701: }
702: }
703: url += 'form=' + formname + '&unameelement='+uname+
704: '&udomelement='+udom+
705: '&ulastelement='+ulast+
706: '&ufirstelement='+ufirst+
707: '&uemailelement='+uemail+
1.881 raeburn 708: '&hideudomelement='+hideudom+
709: '&coursedom='+crsdom;
1.888 raeburn 710: if ((caller != null) && (caller != undefined)) {
711: url += '&caller='+caller;
712: }
1.876 raeburn 713: var title = 'User_Browser';
714: var options = 'scrollbars=1,resizable=1,menubar=0';
715: options += ',width=700,height=600';
716: var stdeditbrowser = open(url,title,options,'1');
717: stdeditbrowser.focus();
718: }
719:
1.888 raeburn 720: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 721: var formid = getFormIdByName(formname);
722: if (formid > -1) {
1.888 raeburn 723: var unameid = getIndexByName(formid,uname);
1.876 raeburn 724: var domid = getIndexByName(formid,udom);
725: var hidedomid = getIndexByName(formid,origdom);
726: if (hidedomid > -1) {
727: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 728: var unameval = document.forms[formid].elements[unameid].value;
729: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
730: if (domid > -1) {
731: var slct = document.forms[formid].elements[domid];
732: if (slct.type == 'select-one') {
733: var i;
734: for (i=0;i<slct.length;i++) {
735: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
736: }
737: }
738: if (slct.type == 'hidden') {
739: slct.value = fixeddom;
1.876 raeburn 740: }
741: }
1.468 raeburn 742: }
743: }
744: }
1.876 raeburn 745: return;
746: }
747:
748: $id_functions
749: ENDUSERBRW
1.468 raeburn 750: }
751:
752: sub setsec_javascript {
1.905 raeburn 753: my ($sec_element,$formname,$role_element) = @_;
754: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
755: $communityrolestr);
756: if ($role_element ne '') {
757: my @allroles = ('st','ta','ep','in','ad');
758: foreach my $crstype ('Course','Community') {
759: if ($crstype eq 'Community') {
760: foreach my $role (@allroles) {
761: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
762: }
763: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
764: } else {
765: foreach my $role (@allroles) {
766: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
767: }
768: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
769: }
770: }
771: $rolestr = '"'.join('","',@allroles).'"';
772: $courserolestr = '"'.join('","',@courserolenames).'"';
773: $communityrolestr = '"'.join('","',@communityrolenames).'"';
774: }
1.468 raeburn 775: my $setsections = qq|
776: function setSect(sectionlist) {
1.629 raeburn 777: var sectionsArray = new Array();
778: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
779: sectionsArray = sectionlist.split(",");
780: }
1.468 raeburn 781: var numSections = sectionsArray.length;
782: document.$formname.$sec_element.length = 0;
783: if (numSections == 0) {
784: document.$formname.$sec_element.multiple=false;
785: document.$formname.$sec_element.size=1;
786: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
787: } else {
788: if (numSections == 1) {
789: document.$formname.$sec_element.multiple=false;
790: document.$formname.$sec_element.size=1;
791: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
792: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
793: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
794: } else {
795: for (var i=0; i<numSections; i++) {
796: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
797: }
798: document.$formname.$sec_element.multiple=true
799: if (numSections < 3) {
800: document.$formname.$sec_element.size=numSections;
801: } else {
802: document.$formname.$sec_element.size=3;
803: }
804: document.$formname.$sec_element.options[0].selected = false
805: }
806: }
1.91 www 807: }
1.905 raeburn 808:
809: function setRole(crstype) {
1.468 raeburn 810: |;
1.905 raeburn 811: if ($role_element eq '') {
812: $setsections .= ' return;
813: }
814: ';
815: } else {
816: $setsections .= qq|
817: var elementLength = document.$formname.$role_element.length;
818: var allroles = Array($rolestr);
819: var courserolenames = Array($courserolestr);
820: var communityrolenames = Array($communityrolestr);
821: if (elementLength != undefined) {
822: if (document.$formname.$role_element.options[5].value == 'cc') {
823: if (crstype == 'Course') {
824: return;
825: } else {
826: allroles[5] = 'co';
827: for (var i=0; i<6; i++) {
828: document.$formname.$role_element.options[i].value = allroles[i];
829: document.$formname.$role_element.options[i].text = communityrolenames[i];
830: }
831: }
832: } else {
833: if (crstype == 'Community') {
834: return;
835: } else {
836: allroles[5] = 'cc';
837: for (var i=0; i<6; i++) {
838: document.$formname.$role_element.options[i].value = allroles[i];
839: document.$formname.$role_element.options[i].text = courserolenames[i];
840: }
841: }
842: }
843: }
844: return;
845: }
846: |;
847: }
1.468 raeburn 848: return $setsections;
849: }
850:
1.91 www 851: sub selectcourse_link {
1.909 raeburn 852: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
853: $typeelement) = @_;
854: my $type = $selecttype;
1.871 raeburn 855: my $linktext = &mt('Select Course');
856: if ($selecttype eq 'Community') {
1.909 raeburn 857: $linktext = &mt('Select Community');
1.906 raeburn 858: } elsif ($selecttype eq 'Course/Community') {
859: $linktext = &mt('Select Course/Community');
1.909 raeburn 860: $type = '';
1.1019 raeburn 861: } elsif ($selecttype eq 'Select') {
862: $linktext = &mt('Select');
863: $type = '';
1.871 raeburn 864: }
1.787 bisitz 865: return '<span class="LC_nobreak">'
866: ."<a href='"
867: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
868: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 869: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 870: ."'>".$linktext.'</a>'
1.787 bisitz 871: .'</span>';
1.74 www 872: }
1.42 matthew 873:
1.653 raeburn 874: sub selectauthor_link {
875: my ($form,$udom)=@_;
876: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
877: &mt('Select Author').'</a>';
878: }
879:
1.876 raeburn 880: sub selectuser_link {
1.881 raeburn 881: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 882: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 883: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 884: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 885: ');">'.$linktext.'</a>';
1.876 raeburn 886: }
887:
1.273 raeburn 888: sub check_uncheck_jscript {
889: my $jscript = <<"ENDSCRT";
890: function checkAll(field) {
891: if (field.length > 0) {
892: for (i = 0; i < field.length; i++) {
1.1093 raeburn 893: if (!field[i].disabled) {
894: field[i].checked = true;
895: }
1.273 raeburn 896: }
897: } else {
1.1093 raeburn 898: if (!field.disabled) {
899: field.checked = true;
900: }
1.273 raeburn 901: }
902: }
903:
904: function uncheckAll(field) {
905: if (field.length > 0) {
906: for (i = 0; i < field.length; i++) {
907: field[i].checked = false ;
1.543 albertel 908: }
909: } else {
1.273 raeburn 910: field.checked = false ;
911: }
912: }
913: ENDSCRT
914: return $jscript;
915: }
916:
1.656 www 917: sub select_timezone {
1.659 raeburn 918: my ($name,$selected,$onchange,$includeempty)=@_;
919: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
920: if ($includeempty) {
921: $output .= '<option value=""';
922: if (($selected eq '') || ($selected eq 'local')) {
923: $output .= ' selected="selected" ';
924: }
925: $output .= '> </option>';
926: }
1.657 raeburn 927: my @timezones = DateTime::TimeZone->all_names;
928: foreach my $tzone (@timezones) {
929: $output.= '<option value="'.$tzone.'"';
930: if ($tzone eq $selected) {
931: $output.=' selected="selected"';
932: }
933: $output.=">$tzone</option>\n";
1.656 www 934: }
935: $output.="</select>";
936: return $output;
937: }
1.273 raeburn 938:
1.687 raeburn 939: sub select_datelocale {
940: my ($name,$selected,$onchange,$includeempty)=@_;
941: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
942: if ($includeempty) {
943: $output .= '<option value=""';
944: if ($selected eq '') {
945: $output .= ' selected="selected" ';
946: }
947: $output .= '> </option>';
948: }
949: my (@possibles,%locale_names);
950: my @locales = DateTime::Locale::Catalog::Locales;
951: foreach my $locale (@locales) {
952: if (ref($locale) eq 'HASH') {
953: my $id = $locale->{'id'};
954: if ($id ne '') {
955: my $en_terr = $locale->{'en_territory'};
956: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 957: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 958: if (grep(/^en$/,@languages) || !@languages) {
959: if ($en_terr ne '') {
960: $locale_names{$id} = '('.$en_terr.')';
961: } elsif ($native_terr ne '') {
962: $locale_names{$id} = $native_terr;
963: }
964: } else {
965: if ($native_terr ne '') {
966: $locale_names{$id} = $native_terr.' ';
967: } elsif ($en_terr ne '') {
968: $locale_names{$id} = '('.$en_terr.')';
969: }
970: }
971: push (@possibles,$id);
972: }
973: }
974: }
975: foreach my $item (sort(@possibles)) {
976: $output.= '<option value="'.$item.'"';
977: if ($item eq $selected) {
978: $output.=' selected="selected"';
979: }
980: $output.=">$item";
981: if ($locale_names{$item} ne '') {
982: $output.=" $locale_names{$item}</option>\n";
983: }
984: $output.="</option>\n";
985: }
986: $output.="</select>";
987: return $output;
988: }
989:
1.792 raeburn 990: sub select_language {
991: my ($name,$selected,$includeempty) = @_;
992: my %langchoices;
993: if ($includeempty) {
994: %langchoices = ('' => 'No language preference');
995: }
996: foreach my $id (&languageids()) {
997: my $code = &supportedlanguagecode($id);
998: if ($code) {
999: $langchoices{$code} = &plainlanguagedescription($id);
1000: }
1001: }
1.970 raeburn 1002: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 1003: }
1004:
1.42 matthew 1005: =pod
1.36 matthew 1006:
1.1088 foxr 1007:
1008: =item * &list_languages()
1009:
1010: Returns an array reference that is suitable for use in language prompters.
1011: Each array element is itself a two element array. The first element
1012: is the language code. The second element a descsriptiuon of the
1013: language itself. This is suitable for use in e.g.
1014: &Apache::edit::select_arg (once dereferenced that is).
1015:
1016: =cut
1017:
1018: sub list_languages {
1019: my @lang_choices;
1020:
1021: foreach my $id (&languageids()) {
1022: my $code = &supportedlanguagecode($id);
1023: if ($code) {
1024: my $selector = $supported_codes{$id};
1025: my $description = &plainlanguagedescription($id);
1026: push (@lang_choices, [$selector, $description]);
1027: }
1028: }
1029: return \@lang_choices;
1030: }
1031:
1032: =pod
1033:
1.648 raeburn 1034: =item * &linked_select_forms(...)
1.36 matthew 1035:
1036: linked_select_forms returns a string containing a <script></script> block
1037: and html for two <select> menus. The select menus will be linked in that
1038: changing the value of the first menu will result in new values being placed
1039: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1040: order unless a defined order is provided.
1.36 matthew 1041:
1042: linked_select_forms takes the following ordered inputs:
1043:
1044: =over 4
1045:
1.112 bowersj2 1046: =item * $formname, the name of the <form> tag
1.36 matthew 1047:
1.112 bowersj2 1048: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1049:
1.112 bowersj2 1050: =item * $firstdefault, the default value for the first menu
1.36 matthew 1051:
1.112 bowersj2 1052: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1053:
1.112 bowersj2 1054: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1055:
1.112 bowersj2 1056: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1057:
1.609 raeburn 1058: =item * $menuorder, the order of values in the first menu
1059:
1.41 ng 1060: =back
1061:
1.36 matthew 1062: Below is an example of such a hash. Only the 'text', 'default', and
1063: 'select2' keys must appear as stated. keys(%menu) are the possible
1064: values for the first select menu. The text that coincides with the
1.41 ng 1065: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1066: and text for the second menu are given in the hash pointed to by
1067: $menu{$choice1}->{'select2'}.
1068:
1.112 bowersj2 1069: my %menu = ( A1 => { text =>"Choice A1" ,
1070: default => "B3",
1071: select2 => {
1072: B1 => "Choice B1",
1073: B2 => "Choice B2",
1074: B3 => "Choice B3",
1075: B4 => "Choice B4"
1.609 raeburn 1076: },
1077: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1078: },
1079: A2 => { text =>"Choice A2" ,
1080: default => "C2",
1081: select2 => {
1082: C1 => "Choice C1",
1083: C2 => "Choice C2",
1084: C3 => "Choice C3"
1.609 raeburn 1085: },
1086: order => ['C2','C1','C3'],
1.112 bowersj2 1087: },
1088: A3 => { text =>"Choice A3" ,
1089: default => "D6",
1090: select2 => {
1091: D1 => "Choice D1",
1092: D2 => "Choice D2",
1093: D3 => "Choice D3",
1094: D4 => "Choice D4",
1095: D5 => "Choice D5",
1096: D6 => "Choice D6",
1097: D7 => "Choice D7"
1.609 raeburn 1098: },
1099: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1100: }
1101: );
1.36 matthew 1102:
1103: =cut
1104:
1105: sub linked_select_forms {
1106: my ($formname,
1107: $middletext,
1108: $firstdefault,
1109: $firstselectname,
1110: $secondselectname,
1.609 raeburn 1111: $hashref,
1112: $menuorder,
1.36 matthew 1113: ) = @_;
1114: my $second = "document.$formname.$secondselectname";
1115: my $first = "document.$formname.$firstselectname";
1116: # output the javascript to do the changing
1117: my $result = '';
1.776 bisitz 1118: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1119: $result.="// <![CDATA[\n";
1.36 matthew 1120: $result.="var select2data = new Object();\n";
1121: $" = '","';
1122: my $debug = '';
1123: foreach my $s1 (sort(keys(%$hashref))) {
1124: $result.="select2data.d_$s1 = new Object();\n";
1125: $result.="select2data.d_$s1.def = new String('".
1126: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1127: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1128: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1129: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1130: @s2values = @{$hashref->{$s1}->{'order'}};
1131: }
1.36 matthew 1132: $result.="\"@s2values\");\n";
1133: $result.="select2data.d_$s1.texts = new Array(";
1134: my @s2texts;
1135: foreach my $value (@s2values) {
1136: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1137: }
1138: $result.="\"@s2texts\");\n";
1139: }
1140: $"=' ';
1141: $result.= <<"END";
1142:
1143: function select1_changed() {
1144: // Determine new choice
1145: var newvalue = "d_" + $first.value;
1146: // update select2
1147: var values = select2data[newvalue].values;
1148: var texts = select2data[newvalue].texts;
1149: var select2def = select2data[newvalue].def;
1150: var i;
1151: // out with the old
1152: for (i = 0; i < $second.options.length; i++) {
1153: $second.options[i] = null;
1154: }
1155: // in with the nuclear
1156: for (i=0;i<values.length; i++) {
1157: $second.options[i] = new Option(values[i]);
1.143 matthew 1158: $second.options[i].value = values[i];
1.36 matthew 1159: $second.options[i].text = texts[i];
1160: if (values[i] == select2def) {
1161: $second.options[i].selected = true;
1162: }
1163: }
1164: }
1.824 bisitz 1165: // ]]>
1.36 matthew 1166: </script>
1167: END
1168: # output the initial values for the selection lists
1169: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1170: my @order = sort(keys(%{$hashref}));
1171: if (ref($menuorder) eq 'ARRAY') {
1172: @order = @{$menuorder};
1173: }
1174: foreach my $value (@order) {
1.36 matthew 1175: $result.=" <option value=\"$value\" ";
1.253 albertel 1176: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1177: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1178: }
1179: $result .= "</select>\n";
1180: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1181: $result .= $middletext;
1182: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1183: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1184:
1185: my @secondorder = sort(keys(%select2));
1186: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1187: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1188: }
1189: foreach my $value (@secondorder) {
1.36 matthew 1190: $result.=" <option value=\"$value\" ";
1.253 albertel 1191: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1192: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1193: }
1194: $result .= "</select>\n";
1195: # return $debug;
1196: return $result;
1197: } # end of sub linked_select_forms {
1198:
1.45 matthew 1199: =pod
1.44 bowersj2 1200:
1.973 raeburn 1201: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1202:
1.112 bowersj2 1203: Returns a string corresponding to an HTML link to the given help
1204: $topic, where $topic corresponds to the name of a .tex file in
1205: /home/httpd/html/adm/help/tex, with underscores replaced by
1206: spaces.
1207:
1208: $text will optionally be linked to the same topic, allowing you to
1209: link text in addition to the graphic. If you do not want to link
1210: text, but wish to specify one of the later parameters, pass an
1211: empty string.
1212:
1213: $stayOnPage is a value that will be interpreted as a boolean. If true,
1214: the link will not open a new window. If false, the link will open
1215: a new window using Javascript. (Default is false.)
1216:
1217: $width and $height are optional numerical parameters that will
1218: override the width and height of the popped up window, which may
1.973 raeburn 1219: be useful for certain help topics with big pictures included.
1220:
1221: $imgid is the id of the img tag used for the help icon. This may be
1222: used in a javascript call to switch the image src. See
1223: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1224:
1225: =cut
1226:
1227: sub help_open_topic {
1.973 raeburn 1228: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1229: $text = "" if (not defined $text);
1.44 bowersj2 1230: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1231: $width = 500 if (not defined $width);
1.44 bowersj2 1232: $height = 400 if (not defined $height);
1233: my $filename = $topic;
1234: $filename =~ s/ /_/g;
1235:
1.48 bowersj2 1236: my $template = "";
1237: my $link;
1.572 banghart 1238:
1.159 www 1239: $topic=~s/\W/\_/g;
1.44 bowersj2 1240:
1.572 banghart 1241: if (!$stayOnPage) {
1.1033 www 1242: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1243: } elsif ($stayOnPage eq 'popup') {
1244: $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 1245: } else {
1.48 bowersj2 1246: $link = "/adm/help/${filename}.hlp";
1247: }
1248:
1249: # Add the text
1.755 neumanie 1250: if ($text ne "") {
1.763 bisitz 1251: $template.='<span class="LC_help_open_topic">'
1252: .'<a target="_top" href="'.$link.'">'
1253: .$text.'</a>';
1.48 bowersj2 1254: }
1255:
1.763 bisitz 1256: # (Always) Add the graphic
1.179 matthew 1257: my $title = &mt('Online Help');
1.667 raeburn 1258: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1259: if ($imgid ne '') {
1260: $imgid = ' id="'.$imgid.'"';
1261: }
1.763 bisitz 1262: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1263: .'<img src="'.$helpicon.'" border="0"'
1264: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1265: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1266: .' /></a>';
1267: if ($text ne "") {
1268: $template.='</span>';
1269: }
1.44 bowersj2 1270: return $template;
1271:
1.106 bowersj2 1272: }
1273:
1274: # This is a quicky function for Latex cheatsheet editing, since it
1275: # appears in at least four places
1276: sub helpLatexCheatsheet {
1.1037 www 1277: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1278: my $out;
1.106 bowersj2 1279: my $addOther = '';
1.732 raeburn 1280: if ($topic) {
1.1037 www 1281: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1282: }
1283: $out = '<span>' # Start cheatsheet
1284: .$addOther
1285: .'<span>'
1.1037 www 1286: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1287: .'</span> <span>'
1.1037 www 1288: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1289: .'</span>';
1.732 raeburn 1290: unless ($not_author) {
1.763 bisitz 1291: $out .= ' <span>'
1.1037 www 1292: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1293: .'</span>';
1.732 raeburn 1294: }
1.763 bisitz 1295: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1296: return $out;
1.172 www 1297: }
1298:
1.430 albertel 1299: sub general_help {
1300: my $helptopic='Student_Intro';
1301: if ($env{'request.role'}=~/^(ca|au)/) {
1302: $helptopic='Authoring_Intro';
1.907 raeburn 1303: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1304: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1305: } elsif ($env{'request.role'}=~/^dc/) {
1306: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1307: }
1308: return $helptopic;
1309: }
1310:
1311: sub update_help_link {
1312: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1313: my $origurl = $ENV{'REQUEST_URI'};
1314: $origurl=~s|^/~|/priv/|;
1315: my $timestamp = time;
1316: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1317: $$datum = &escape($$datum);
1318: }
1319:
1320: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1321: my $output .= <<"ENDOUTPUT";
1322: <script type="text/javascript">
1.824 bisitz 1323: // <![CDATA[
1.430 albertel 1324: banner_link = '$banner_link';
1.824 bisitz 1325: // ]]>
1.430 albertel 1326: </script>
1327: ENDOUTPUT
1328: return $output;
1329: }
1330:
1331: # now just updates the help link and generates a blue icon
1.193 raeburn 1332: sub help_open_menu {
1.430 albertel 1333: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1334: = @_;
1.949 droeschl 1335: $stayOnPage = 1;
1.430 albertel 1336: my $output;
1337: if ($component_help) {
1338: if (!$text) {
1339: $output=&help_open_topic($component_help,undef,$stayOnPage,
1340: $width,$height);
1341: } else {
1342: my $help_text;
1343: $help_text=&unescape($topic);
1344: $output='<table><tr><td>'.
1345: &help_open_topic($component_help,$help_text,$stayOnPage,
1346: $width,$height).'</td></tr></table>';
1347: }
1348: }
1349: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1350: return $output.$banner_link;
1351: }
1352:
1353: sub top_nav_help {
1354: my ($text) = @_;
1.436 albertel 1355: $text = &mt($text);
1.949 droeschl 1356: my $stay_on_page = 1;
1357:
1.572 banghart 1358: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1359: : "javascript:helpMenu('open')";
1.572 banghart 1360: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1361:
1.201 raeburn 1362: my $title = &mt('Get help');
1.436 albertel 1363:
1364: return <<"END";
1365: $banner_link
1366: <a href="$link" title="$title">$text</a>
1367: END
1368: }
1369:
1370: sub help_menu_js {
1371: my ($text) = @_;
1.949 droeschl 1372: my $stayOnPage = 1;
1.436 albertel 1373: my $width = 620;
1374: my $height = 600;
1.430 albertel 1375: my $helptopic=&general_help();
1376: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1377: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1378: my $start_page =
1379: &Apache::loncommon::start_page('Help Menu', undef,
1380: {'frameset' => 1,
1381: 'js_ready' => 1,
1382: 'add_entries' => {
1383: 'border' => '0',
1.579 raeburn 1384: 'rows' => "110,*",},});
1.331 albertel 1385: my $end_page =
1386: &Apache::loncommon::end_page({'frameset' => 1,
1387: 'js_ready' => 1,});
1388:
1.436 albertel 1389: my $template .= <<"ENDTEMPLATE";
1390: <script type="text/javascript">
1.877 bisitz 1391: // <![CDATA[
1.253 albertel 1392: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1393: var banner_link = '';
1.243 raeburn 1394: function helpMenu(target) {
1395: var caller = this;
1396: if (target == 'open') {
1397: var newWindow = null;
1398: try {
1.262 albertel 1399: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1400: }
1401: catch(error) {
1402: writeHelp(caller);
1403: return;
1404: }
1405: if (newWindow) {
1406: caller = newWindow;
1407: }
1.193 raeburn 1408: }
1.243 raeburn 1409: writeHelp(caller);
1410: return;
1411: }
1412: function writeHelp(caller) {
1.1072 raeburn 1413: 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 1414: caller.document.close()
1415: caller.focus()
1.193 raeburn 1416: }
1.877 bisitz 1417: // END LON-CAPA Internal -->
1.253 albertel 1418: // ]]>
1.436 albertel 1419: </script>
1.193 raeburn 1420: ENDTEMPLATE
1421: return $template;
1422: }
1423:
1.172 www 1424: sub help_open_bug {
1425: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1426: unless ($env{'user.adv'}) { return ''; }
1.172 www 1427: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1428: $text = "" if (not defined $text);
1429: $stayOnPage=1;
1.184 albertel 1430: $width = 600 if (not defined $width);
1431: $height = 600 if (not defined $height);
1.172 www 1432:
1433: $topic=~s/\W+/\+/g;
1434: my $link='';
1435: my $template='';
1.379 albertel 1436: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1437: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1438: if (!$stayOnPage)
1439: {
1440: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1441: }
1442: else
1443: {
1444: $link = $url;
1445: }
1446: # Add the text
1447: if ($text ne "")
1448: {
1449: $template .=
1450: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1451: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1452: }
1453:
1454: # Add the graphic
1.179 matthew 1455: my $title = &mt('Report a Bug');
1.215 albertel 1456: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1457: $template .= <<"ENDTEMPLATE";
1.436 albertel 1458: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1459: ENDTEMPLATE
1460: if ($text ne '') { $template.='</td></tr></table>' };
1461: return $template;
1462:
1463: }
1464:
1465: sub help_open_faq {
1466: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1467: unless ($env{'user.adv'}) { return ''; }
1.172 www 1468: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1469: $text = "" if (not defined $text);
1470: $stayOnPage=1;
1471: $width = 350 if (not defined $width);
1472: $height = 400 if (not defined $height);
1473:
1474: $topic=~s/\W+/\+/g;
1475: my $link='';
1476: my $template='';
1477: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1478: if (!$stayOnPage)
1479: {
1480: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1481: }
1482: else
1483: {
1484: $link = $url;
1485: }
1486:
1487: # Add the text
1488: if ($text ne "")
1489: {
1490: $template .=
1.173 www 1491: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1492: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1493: }
1494:
1495: # Add the graphic
1.179 matthew 1496: my $title = &mt('View the FAQ');
1.215 albertel 1497: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1498: $template .= <<"ENDTEMPLATE";
1.436 albertel 1499: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1500: ENDTEMPLATE
1501: if ($text ne '') { $template.='</td></tr></table>' };
1502: return $template;
1503:
1.44 bowersj2 1504: }
1.37 matthew 1505:
1.180 matthew 1506: ###############################################################
1507: ###############################################################
1508:
1.45 matthew 1509: =pod
1510:
1.648 raeburn 1511: =item * &change_content_javascript():
1.256 matthew 1512:
1513: This and the next function allow you to create small sections of an
1514: otherwise static HTML page that you can update on the fly with
1515: Javascript, even in Netscape 4.
1516:
1517: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1518: must be written to the HTML page once. It will prove the Javascript
1519: function "change(name, content)". Calling the change function with the
1520: name of the section
1521: you want to update, matching the name passed to C<changable_area>, and
1522: the new content you want to put in there, will put the content into
1523: that area.
1524:
1525: B<Note>: Netscape 4 only reserves enough space for the changable area
1526: to contain room for the original contents. You need to "make space"
1527: for whatever changes you wish to make, and be B<sure> to check your
1528: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1529: it's adequate for updating a one-line status display, but little more.
1530: This script will set the space to 100% width, so you only need to
1531: worry about height in Netscape 4.
1532:
1533: Modern browsers are much less limiting, and if you can commit to the
1534: user not using Netscape 4, this feature may be used freely with
1535: pretty much any HTML.
1536:
1537: =cut
1538:
1539: sub change_content_javascript {
1540: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1541: if ($env{'browser.type'} eq 'netscape' &&
1542: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1543: return (<<NETSCAPE4);
1544: function change(name, content) {
1545: doc = document.layers[name+"___escape"].layers[0].document;
1546: doc.open();
1547: doc.write(content);
1548: doc.close();
1549: }
1550: NETSCAPE4
1551: } else {
1552: # Otherwise, we need to use semi-standards-compliant code
1553: # (technically, "innerHTML" isn't standard but the equivalent
1554: # is really scary, and every useful browser supports it
1555: return (<<DOMBASED);
1556: function change(name, content) {
1557: element = document.getElementById(name);
1558: element.innerHTML = content;
1559: }
1560: DOMBASED
1561: }
1562: }
1563:
1564: =pod
1565:
1.648 raeburn 1566: =item * &changable_area($name,$origContent):
1.256 matthew 1567:
1568: This provides a "changable area" that can be modified on the fly via
1569: the Javascript code provided in C<change_content_javascript>. $name is
1570: the name you will use to reference the area later; do not repeat the
1571: same name on a given HTML page more then once. $origContent is what
1572: the area will originally contain, which can be left blank.
1573:
1574: =cut
1575:
1576: sub changable_area {
1577: my ($name, $origContent) = @_;
1578:
1.258 albertel 1579: if ($env{'browser.type'} eq 'netscape' &&
1580: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1581: # If this is netscape 4, we need to use the Layer tag
1582: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1583: } else {
1584: return "<span id='$name'>$origContent</span>";
1585: }
1586: }
1587:
1588: =pod
1589:
1.648 raeburn 1590: =item * &viewport_geometry_js
1.590 raeburn 1591:
1592: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1593:
1594: =cut
1595:
1596:
1597: sub viewport_geometry_js {
1598: return <<"GEOMETRY";
1599: var Geometry = {};
1600: function init_geometry() {
1601: if (Geometry.init) { return };
1602: Geometry.init=1;
1603: if (window.innerHeight) {
1604: Geometry.getViewportHeight = function() { return window.innerHeight; };
1605: Geometry.getViewportWidth = function() { return window.innerWidth; };
1606: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1607: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1608: }
1609: else if (document.documentElement && document.documentElement.clientHeight) {
1610: Geometry.getViewportHeight =
1611: function() { return document.documentElement.clientHeight; };
1612: Geometry.getViewportWidth =
1613: function() { return document.documentElement.clientWidth; };
1614:
1615: Geometry.getHorizontalScroll =
1616: function() { return document.documentElement.scrollLeft; };
1617: Geometry.getVerticalScroll =
1618: function() { return document.documentElement.scrollTop; };
1619: }
1620: else if (document.body.clientHeight) {
1621: Geometry.getViewportHeight =
1622: function() { return document.body.clientHeight; };
1623: Geometry.getViewportWidth =
1624: function() { return document.body.clientWidth; };
1625: Geometry.getHorizontalScroll =
1626: function() { return document.body.scrollLeft; };
1627: Geometry.getVerticalScroll =
1628: function() { return document.body.scrollTop; };
1629: }
1630: }
1631:
1632: GEOMETRY
1633: }
1634:
1635: =pod
1636:
1.648 raeburn 1637: =item * &viewport_size_js()
1.590 raeburn 1638:
1639: 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.
1640:
1641: =cut
1642:
1643: sub viewport_size_js {
1644: my $geometry = &viewport_geometry_js();
1645: return <<"DIMS";
1646:
1647: $geometry
1648:
1649: function getViewportDims(width,height) {
1650: init_geometry();
1651: width.value = Geometry.getViewportWidth();
1652: height.value = Geometry.getViewportHeight();
1653: return;
1654: }
1655:
1656: DIMS
1657: }
1658:
1659: =pod
1660:
1.648 raeburn 1661: =item * &resize_textarea_js()
1.565 albertel 1662:
1663: emits the needed javascript to resize a textarea to be as big as possible
1664:
1665: creates a function resize_textrea that takes two IDs first should be
1666: the id of the element to resize, second should be the id of a div that
1667: surrounds everything that comes after the textarea, this routine needs
1668: to be attached to the <body> for the onload and onresize events.
1669:
1.648 raeburn 1670: =back
1.565 albertel 1671:
1672: =cut
1673:
1674: sub resize_textarea_js {
1.590 raeburn 1675: my $geometry = &viewport_geometry_js();
1.565 albertel 1676: return <<"RESIZE";
1677: <script type="text/javascript">
1.824 bisitz 1678: // <![CDATA[
1.590 raeburn 1679: $geometry
1.565 albertel 1680:
1.588 albertel 1681: function getX(element) {
1682: var x = 0;
1683: while (element) {
1684: x += element.offsetLeft;
1685: element = element.offsetParent;
1686: }
1687: return x;
1688: }
1689: function getY(element) {
1690: var y = 0;
1691: while (element) {
1692: y += element.offsetTop;
1693: element = element.offsetParent;
1694: }
1695: return y;
1696: }
1697:
1698:
1.565 albertel 1699: function resize_textarea(textarea_id,bottom_id) {
1700: init_geometry();
1701: var textarea = document.getElementById(textarea_id);
1702: //alert(textarea);
1703:
1.588 albertel 1704: var textarea_top = getY(textarea);
1.565 albertel 1705: var textarea_height = textarea.offsetHeight;
1706: var bottom = document.getElementById(bottom_id);
1.588 albertel 1707: var bottom_top = getY(bottom);
1.565 albertel 1708: var bottom_height = bottom.offsetHeight;
1709: var window_height = Geometry.getViewportHeight();
1.588 albertel 1710: var fudge = 23;
1.565 albertel 1711: var new_height = window_height-fudge-textarea_top-bottom_height;
1712: if (new_height < 300) {
1713: new_height = 300;
1714: }
1715: textarea.style.height=new_height+'px';
1716: }
1.824 bisitz 1717: // ]]>
1.565 albertel 1718: </script>
1719: RESIZE
1720:
1721: }
1722:
1723: =pod
1724:
1.256 matthew 1725: =head1 Excel and CSV file utility routines
1726:
1727: =over 4
1728:
1729: =cut
1730:
1731: ###############################################################
1732: ###############################################################
1733:
1734: =pod
1735:
1.648 raeburn 1736: =item * &csv_translate($text)
1.37 matthew 1737:
1.185 www 1738: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1739: format.
1740:
1741: =cut
1742:
1.180 matthew 1743: ###############################################################
1744: ###############################################################
1.37 matthew 1745: sub csv_translate {
1746: my $text = shift;
1747: $text =~ s/\"/\"\"/g;
1.209 albertel 1748: $text =~ s/\n/ /g;
1.37 matthew 1749: return $text;
1750: }
1.180 matthew 1751:
1752: ###############################################################
1753: ###############################################################
1754:
1755: =pod
1756:
1.648 raeburn 1757: =item * &define_excel_formats()
1.180 matthew 1758:
1759: Define some commonly used Excel cell formats.
1760:
1761: Currently supported formats:
1762:
1763: =over 4
1764:
1765: =item header
1766:
1767: =item bold
1768:
1769: =item h1
1770:
1771: =item h2
1772:
1773: =item h3
1774:
1.256 matthew 1775: =item h4
1776:
1777: =item i
1778:
1.180 matthew 1779: =item date
1780:
1781: =back
1782:
1783: Inputs: $workbook
1784:
1785: Returns: $format, a hash reference.
1786:
1.1057 foxr 1787:
1.180 matthew 1788: =cut
1789:
1790: ###############################################################
1791: ###############################################################
1792: sub define_excel_formats {
1793: my ($workbook) = @_;
1794: my $format;
1795: $format->{'header'} = $workbook->add_format(bold => 1,
1796: bottom => 1,
1797: align => 'center');
1798: $format->{'bold'} = $workbook->add_format(bold=>1);
1799: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1800: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1801: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1802: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1803: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1804: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1805: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1806: return $format;
1807: }
1808:
1809: ###############################################################
1810: ###############################################################
1.113 bowersj2 1811:
1812: =pod
1813:
1.648 raeburn 1814: =item * &create_workbook()
1.255 matthew 1815:
1816: Create an Excel worksheet. If it fails, output message on the
1817: request object and return undefs.
1818:
1819: Inputs: Apache request object
1820:
1821: Returns (undef) on failure,
1822: Excel worksheet object, scalar with filename, and formats
1823: from &Apache::loncommon::define_excel_formats on success
1824:
1825: =cut
1826:
1827: ###############################################################
1828: ###############################################################
1829: sub create_workbook {
1830: my ($r) = @_;
1831: #
1832: # Create the excel spreadsheet
1833: my $filename = '/prtspool/'.
1.258 albertel 1834: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1835: time.'_'.rand(1000000000).'.xls';
1836: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1837: if (! defined($workbook)) {
1838: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1839: $r->print(
1840: '<p class="LC_error">'
1841: .&mt('Problems occurred in creating the new Excel file.')
1842: .' '.&mt('This error has been logged.')
1843: .' '.&mt('Please alert your LON-CAPA administrator.')
1844: .'</p>'
1845: );
1.255 matthew 1846: return (undef);
1847: }
1848: #
1.1014 foxr 1849: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1850: #
1851: my $format = &Apache::loncommon::define_excel_formats($workbook);
1852: return ($workbook,$filename,$format);
1853: }
1854:
1855: ###############################################################
1856: ###############################################################
1857:
1858: =pod
1859:
1.648 raeburn 1860: =item * &create_text_file()
1.113 bowersj2 1861:
1.542 raeburn 1862: Create a file to write to and eventually make available to the user.
1.256 matthew 1863: If file creation fails, outputs an error message on the request object and
1864: return undefs.
1.113 bowersj2 1865:
1.256 matthew 1866: Inputs: Apache request object, and file suffix
1.113 bowersj2 1867:
1.256 matthew 1868: Returns (undef) on failure,
1869: Filehandle and filename on success.
1.113 bowersj2 1870:
1871: =cut
1872:
1.256 matthew 1873: ###############################################################
1874: ###############################################################
1875: sub create_text_file {
1876: my ($r,$suffix) = @_;
1877: if (! defined($suffix)) { $suffix = 'txt'; };
1878: my $fh;
1879: my $filename = '/prtspool/'.
1.258 albertel 1880: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1881: time.'_'.rand(1000000000).'.'.$suffix;
1882: $fh = Apache::File->new('>/home/httpd'.$filename);
1883: if (! defined($fh)) {
1884: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1885: $r->print(
1886: '<p class="LC_error">'
1887: .&mt('Problems occurred in creating the output file.')
1888: .' '.&mt('This error has been logged.')
1889: .' '.&mt('Please alert your LON-CAPA administrator.')
1890: .'</p>'
1891: );
1.113 bowersj2 1892: }
1.256 matthew 1893: return ($fh,$filename)
1.113 bowersj2 1894: }
1895:
1896:
1.256 matthew 1897: =pod
1.113 bowersj2 1898:
1899: =back
1900:
1901: =cut
1.37 matthew 1902:
1903: ###############################################################
1.33 matthew 1904: ## Home server <option> list generating code ##
1905: ###############################################################
1.35 matthew 1906:
1.169 www 1907: # ------------------------------------------
1908:
1909: sub domain_select {
1910: my ($name,$value,$multiple)=@_;
1911: my %domains=map {
1.514 albertel 1912: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1913: } &Apache::lonnet::all_domains();
1.169 www 1914: if ($multiple) {
1915: $domains{''}=&mt('Any domain');
1.550 albertel 1916: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1917: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1918: } else {
1.550 albertel 1919: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1920: return &select_form($name,$value,\%domains);
1.169 www 1921: }
1922: }
1923:
1.282 albertel 1924: #-------------------------------------------
1925:
1926: =pod
1927:
1.519 raeburn 1928: =head1 Routines for form select boxes
1929:
1930: =over 4
1931:
1.648 raeburn 1932: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1933:
1934: Returns a string containing a <select> element int multiple mode
1935:
1936:
1937: Args:
1938: $name - name of the <select> element
1.506 raeburn 1939: $value - scalar or array ref of values that should already be selected
1.282 albertel 1940: $size - number of rows long the select element is
1.283 albertel 1941: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1942: (shown text should already have been &mt())
1.506 raeburn 1943: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1944:
1.282 albertel 1945: =cut
1946:
1947: #-------------------------------------------
1.169 www 1948: sub multiple_select_form {
1.284 albertel 1949: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1950: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1951: my $output='';
1.191 matthew 1952: if (! defined($size)) {
1953: $size = 4;
1.283 albertel 1954: if (scalar(keys(%$hash))<4) {
1955: $size = scalar(keys(%$hash));
1.191 matthew 1956: }
1957: }
1.734 bisitz 1958: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1959: my @order;
1.506 raeburn 1960: if (ref($order) eq 'ARRAY') {
1961: @order = @{$order};
1962: } else {
1963: @order = sort(keys(%$hash));
1.501 banghart 1964: }
1965: if (exists($$hash{'select_form_order'})) {
1966: @order = @{$$hash{'select_form_order'}};
1967: }
1968:
1.284 albertel 1969: foreach my $key (@order) {
1.356 albertel 1970: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1971: $output.='selected="selected" ' if ($selected{$key});
1972: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1973: }
1974: $output.="</select>\n";
1975: return $output;
1976: }
1977:
1.88 www 1978: #-------------------------------------------
1979:
1980: =pod
1981:
1.970 raeburn 1982: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1983:
1984: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1985: allow a user to select options from a ref to a hash containing:
1986: option_name => displayed text. An optional $onchange can include
1987: a javascript onchange item, e.g., onchange="this.form.submit();"
1988:
1.88 www 1989: See lonrights.pm for an example invocation and use.
1990:
1991: =cut
1992:
1993: #-------------------------------------------
1994: sub select_form {
1.970 raeburn 1995: my ($def,$name,$hashref,$onchange) = @_;
1996: return unless (ref($hashref) eq 'HASH');
1997: if ($onchange) {
1998: $onchange = ' onchange="'.$onchange.'"';
1999: }
2000: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 2001: my @keys;
1.970 raeburn 2002: if (exists($hashref->{'select_form_order'})) {
2003: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2004: } else {
1.970 raeburn 2005: @keys=sort(keys(%{$hashref}));
1.128 albertel 2006: }
1.356 albertel 2007: foreach my $key (@keys) {
2008: $selectform.=
2009: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2010: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2011: ">".$hashref->{$key}."</option>\n";
1.88 www 2012: }
2013: $selectform.="</select>";
2014: return $selectform;
2015: }
2016:
1.475 www 2017: # For display filters
2018:
2019: sub display_filter {
1.1074 raeburn 2020: my ($context) = @_;
1.475 www 2021: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2022: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2023: my $phraseinput = 'hidden';
2024: my $includeinput = 'hidden';
2025: my ($checked,$includetypestext);
2026: if ($env{'form.displayfilter'} eq 'containing') {
2027: $phraseinput = 'text';
2028: if ($context eq 'parmslog') {
2029: $includeinput = 'checkbox';
2030: if ($env{'form.includetypes'}) {
2031: $checked = ' checked="checked"';
2032: }
2033: $includetypestext = &mt('Include parameter types');
2034: }
2035: } else {
2036: $includetypestext = ' ';
2037: }
2038: my ($additional,$secondid,$thirdid);
2039: if ($context eq 'parmslog') {
2040: $additional =
2041: '<label><input type="'.$includeinput.'" name="includetypes"'.
2042: $checked.' name="includetypes" value="1" id="includetypes" />'.
2043: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2044: '</label>';
2045: $secondid = 'includetypes';
2046: $thirdid = 'includetypestext';
2047: }
2048: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2049: '$secondid','$thirdid')";
2050: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2051: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2052: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2053: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2054: &mt('Filter: [_1]',
1.477 www 2055: &select_form($env{'form.displayfilter'},
2056: 'displayfilter',
1.970 raeburn 2057: {'currentfolder' => 'Current folder/page',
1.477 www 2058: 'containing' => 'Containing phrase',
1.1074 raeburn 2059: 'none' => 'None'},$onchange)).' '.
2060: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2061: &HTML::Entities::encode($env{'form.containingphrase'}).
2062: '" />'.$additional;
2063: }
2064:
2065: sub display_filter_js {
2066: my $includetext = &mt('Include parameter types');
2067: return <<"ENDJS";
2068:
2069: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2070: var firstType = 'hidden';
2071: if (setter.options[setter.selectedIndex].value == 'containing') {
2072: firstType = 'text';
2073: }
2074: firstObject = document.getElementById(firstid);
2075: if (typeof(firstObject) == 'object') {
2076: if (firstObject.type != firstType) {
2077: changeInputType(firstObject,firstType);
2078: }
2079: }
2080: if (context == 'parmslog') {
2081: var secondType = 'hidden';
2082: if (firstType == 'text') {
2083: secondType = 'checkbox';
2084: }
2085: secondObject = document.getElementById(secondid);
2086: if (typeof(secondObject) == 'object') {
2087: if (secondObject.type != secondType) {
2088: changeInputType(secondObject,secondType);
2089: }
2090: }
2091: var textItem = document.getElementById(thirdid);
2092: var currtext = textItem.innerHTML;
2093: var newtext;
2094: if (firstType == 'text') {
2095: newtext = '$includetext';
2096: } else {
2097: newtext = ' ';
2098: }
2099: if (currtext != newtext) {
2100: textItem.innerHTML = newtext;
2101: }
2102: }
2103: return;
2104: }
2105:
2106: function changeInputType(oldObject,newType) {
2107: var newObject = document.createElement('input');
2108: newObject.type = newType;
2109: if (oldObject.size) {
2110: newObject.size = oldObject.size;
2111: }
2112: if (oldObject.value) {
2113: newObject.value = oldObject.value;
2114: }
2115: if (oldObject.name) {
2116: newObject.name = oldObject.name;
2117: }
2118: if (oldObject.id) {
2119: newObject.id = oldObject.id;
2120: }
2121: oldObject.parentNode.replaceChild(newObject,oldObject);
2122: return;
2123: }
2124:
2125: ENDJS
1.475 www 2126: }
2127:
1.167 www 2128: sub gradeleveldescription {
2129: my $gradelevel=shift;
2130: my %gradelevels=(0 => 'Not specified',
2131: 1 => 'Grade 1',
2132: 2 => 'Grade 2',
2133: 3 => 'Grade 3',
2134: 4 => 'Grade 4',
2135: 5 => 'Grade 5',
2136: 6 => 'Grade 6',
2137: 7 => 'Grade 7',
2138: 8 => 'Grade 8',
2139: 9 => 'Grade 9',
2140: 10 => 'Grade 10',
2141: 11 => 'Grade 11',
2142: 12 => 'Grade 12',
2143: 13 => 'Grade 13',
2144: 14 => '100 Level',
2145: 15 => '200 Level',
2146: 16 => '300 Level',
2147: 17 => '400 Level',
2148: 18 => 'Graduate Level');
2149: return &mt($gradelevels{$gradelevel});
2150: }
2151:
1.163 www 2152: sub select_level_form {
2153: my ($deflevel,$name)=@_;
2154: unless ($deflevel) { $deflevel=0; }
1.167 www 2155: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2156: for (my $i=0; $i<=18; $i++) {
2157: $selectform.="<option value=\"$i\" ".
1.253 albertel 2158: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2159: ">".&gradeleveldescription($i)."</option>\n";
2160: }
2161: $selectform.="</select>";
2162: return $selectform;
1.163 www 2163: }
1.167 www 2164:
1.35 matthew 2165: #-------------------------------------------
2166:
1.45 matthew 2167: =pod
2168:
1.910 raeburn 2169: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2170:
2171: Returns a string containing a <select name='$name' size='1'> form to
2172: allow a user to select the domain to preform an operation in.
2173: See loncreateuser.pm for an example invocation and use.
2174:
1.90 www 2175: If the $includeempty flag is set, it also includes an empty choice ("no domain
2176: selected");
2177:
1.743 raeburn 2178: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2179:
1.910 raeburn 2180: 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.
2181:
2182: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2183:
1.35 matthew 2184: =cut
2185:
2186: #-------------------------------------------
1.34 matthew 2187: sub select_dom_form {
1.910 raeburn 2188: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2189: if ($onchange) {
1.874 raeburn 2190: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2191: }
1.910 raeburn 2192: my @domains;
2193: if (ref($incdoms) eq 'ARRAY') {
2194: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2195: } else {
2196: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2197: }
1.90 www 2198: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2199: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2200: foreach my $dom (@domains) {
2201: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2202: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2203: if ($showdomdesc) {
2204: if ($dom ne '') {
2205: my $domdesc = &Apache::lonnet::domain($dom,'description');
2206: if ($domdesc ne '') {
2207: $selectdomain .= ' ('.$domdesc.')';
2208: }
2209: }
2210: }
2211: $selectdomain .= "</option>\n";
1.34 matthew 2212: }
2213: $selectdomain.="</select>";
2214: return $selectdomain;
2215: }
2216:
1.35 matthew 2217: #-------------------------------------------
2218:
1.45 matthew 2219: =pod
2220:
1.648 raeburn 2221: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2222:
1.586 raeburn 2223: input: 4 arguments (two required, two optional) -
2224: $domain - domain of new user
2225: $name - name of form element
2226: $default - Value of 'default' causes a default item to be first
2227: option, and selected by default.
2228: $hide - Value of 'hide' causes hiding of the name of the server,
2229: if 1 server found, or default, if 0 found.
1.594 raeburn 2230: output: returns 2 items:
1.586 raeburn 2231: (a) form element which contains either:
2232: (i) <select name="$name">
2233: <option value="$hostid1">$hostid $servers{$hostid}</option>
2234: <option value="$hostid2">$hostid $servers{$hostid}</option>
2235: </select>
2236: form item if there are multiple library servers in $domain, or
2237: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2238: if there is only one library server in $domain.
2239:
2240: (b) number of library servers found.
2241:
2242: See loncreateuser.pm for example of use.
1.35 matthew 2243:
2244: =cut
2245:
2246: #-------------------------------------------
1.586 raeburn 2247: sub home_server_form_item {
2248: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2249: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2250: my $result;
2251: my $numlib = keys(%servers);
2252: if ($numlib > 1) {
2253: $result .= '<select name="'.$name.'" />'."\n";
2254: if ($default) {
1.804 bisitz 2255: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2256: '</option>'."\n";
2257: }
2258: foreach my $hostid (sort(keys(%servers))) {
2259: $result.= '<option value="'.$hostid.'">'.
2260: $hostid.' '.$servers{$hostid}."</option>\n";
2261: }
2262: $result .= '</select>'."\n";
2263: } elsif ($numlib == 1) {
2264: my $hostid;
2265: foreach my $item (keys(%servers)) {
2266: $hostid = $item;
2267: }
2268: $result .= '<input type="hidden" name="'.$name.'" value="'.
2269: $hostid.'" />';
2270: if (!$hide) {
2271: $result .= $hostid.' '.$servers{$hostid};
2272: }
2273: $result .= "\n";
2274: } elsif ($default) {
2275: $result .= '<input type="hidden" name="'.$name.
2276: '" value="default" />';
2277: if (!$hide) {
2278: $result .= &mt('default');
2279: }
2280: $result .= "\n";
1.33 matthew 2281: }
1.586 raeburn 2282: return ($result,$numlib);
1.33 matthew 2283: }
1.112 bowersj2 2284:
2285: =pod
2286:
1.534 albertel 2287: =back
2288:
1.112 bowersj2 2289: =cut
1.87 matthew 2290:
2291: ###############################################################
1.112 bowersj2 2292: ## Decoding User Agent ##
1.87 matthew 2293: ###############################################################
2294:
2295: =pod
2296:
1.112 bowersj2 2297: =head1 Decoding the User Agent
2298:
2299: =over 4
2300:
2301: =item * &decode_user_agent()
1.87 matthew 2302:
2303: Inputs: $r
2304:
2305: Outputs:
2306:
2307: =over 4
2308:
1.112 bowersj2 2309: =item * $httpbrowser
1.87 matthew 2310:
1.112 bowersj2 2311: =item * $clientbrowser
1.87 matthew 2312:
1.112 bowersj2 2313: =item * $clientversion
1.87 matthew 2314:
1.112 bowersj2 2315: =item * $clientmathml
1.87 matthew 2316:
1.112 bowersj2 2317: =item * $clientunicode
1.87 matthew 2318:
1.112 bowersj2 2319: =item * $clientos
1.87 matthew 2320:
2321: =back
2322:
1.157 matthew 2323: =back
2324:
1.87 matthew 2325: =cut
2326:
2327: ###############################################################
2328: ###############################################################
2329: sub decode_user_agent {
1.247 albertel 2330: my ($r)=@_;
1.87 matthew 2331: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2332: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2333: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2334: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2335: my $clientbrowser='unknown';
2336: my $clientversion='0';
2337: my $clientmathml='';
2338: my $clientunicode='0';
2339: for (my $i=0;$i<=$#browsertype;$i++) {
2340: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2341: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2342: $clientbrowser=$bname;
2343: $httpbrowser=~/$vreg/i;
2344: $clientversion=$1;
2345: $clientmathml=($clientversion>=$minv);
2346: $clientunicode=($clientversion>=$univ);
2347: }
2348: }
2349: my $clientos='unknown';
2350: if (($httpbrowser=~/linux/i) ||
2351: ($httpbrowser=~/unix/i) ||
2352: ($httpbrowser=~/ux/i) ||
2353: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2354: if (($httpbrowser=~/vax/i) ||
2355: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2356: if ($httpbrowser=~/next/i) { $clientos='next'; }
2357: if (($httpbrowser=~/mac/i) ||
2358: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2359: if ($httpbrowser=~/win/i) { $clientos='win'; }
2360: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2361: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2362: $clientunicode,$clientos,);
2363: }
2364:
1.32 matthew 2365: ###############################################################
2366: ## Authentication changing form generation subroutines ##
2367: ###############################################################
2368: ##
2369: ## All of the authform_xxxxxxx subroutines take their inputs in a
2370: ## hash, and have reasonable default values.
2371: ##
2372: ## formname = the name given in the <form> tag.
1.35 matthew 2373: #-------------------------------------------
2374:
1.45 matthew 2375: =pod
2376:
1.112 bowersj2 2377: =head1 Authentication Routines
2378:
2379: =over 4
2380:
1.648 raeburn 2381: =item * &authform_xxxxxx()
1.35 matthew 2382:
2383: The authform_xxxxxx subroutines provide javascript and html forms which
2384: handle some of the conveniences required for authentication forms.
2385: This is not an optimal method, but it works.
2386:
2387: =over 4
2388:
1.112 bowersj2 2389: =item * authform_header
1.35 matthew 2390:
1.112 bowersj2 2391: =item * authform_authorwarning
1.35 matthew 2392:
1.112 bowersj2 2393: =item * authform_nochange
1.35 matthew 2394:
1.112 bowersj2 2395: =item * authform_kerberos
1.35 matthew 2396:
1.112 bowersj2 2397: =item * authform_internal
1.35 matthew 2398:
1.112 bowersj2 2399: =item * authform_filesystem
1.35 matthew 2400:
2401: =back
2402:
1.648 raeburn 2403: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2404:
1.35 matthew 2405: =cut
2406:
2407: #-------------------------------------------
1.32 matthew 2408: sub authform_header{
2409: my %in = (
2410: formname => 'cu',
1.80 albertel 2411: kerb_def_dom => '',
1.32 matthew 2412: @_,
2413: );
2414: $in{'formname'} = 'document.' . $in{'formname'};
2415: my $result='';
1.80 albertel 2416:
2417: #---------------------------------------------- Code for upper case translation
2418: my $Javascript_toUpperCase;
2419: unless ($in{kerb_def_dom}) {
2420: $Javascript_toUpperCase =<<"END";
2421: switch (choice) {
2422: case 'krb': currentform.elements[choicearg].value =
2423: currentform.elements[choicearg].value.toUpperCase();
2424: break;
2425: default:
2426: }
2427: END
2428: } else {
2429: $Javascript_toUpperCase = "";
2430: }
2431:
1.165 raeburn 2432: my $radioval = "'nochange'";
1.591 raeburn 2433: if (defined($in{'curr_authtype'})) {
2434: if ($in{'curr_authtype'} ne '') {
2435: $radioval = "'".$in{'curr_authtype'}."arg'";
2436: }
1.174 matthew 2437: }
1.165 raeburn 2438: my $argfield = 'null';
1.591 raeburn 2439: if (defined($in{'mode'})) {
1.165 raeburn 2440: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2441: if (defined($in{'curr_autharg'})) {
2442: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2443: $argfield = "'$in{'curr_autharg'}'";
2444: }
2445: }
2446: }
2447: }
2448:
1.32 matthew 2449: $result.=<<"END";
2450: var current = new Object();
1.165 raeburn 2451: current.radiovalue = $radioval;
2452: current.argfield = $argfield;
1.32 matthew 2453:
2454: function changed_radio(choice,currentform) {
2455: var choicearg = choice + 'arg';
2456: // If a radio button in changed, we need to change the argfield
2457: if (current.radiovalue != choice) {
2458: current.radiovalue = choice;
2459: if (current.argfield != null) {
2460: currentform.elements[current.argfield].value = '';
2461: }
2462: if (choice == 'nochange') {
2463: current.argfield = null;
2464: } else {
2465: current.argfield = choicearg;
2466: switch(choice) {
2467: case 'krb':
2468: currentform.elements[current.argfield].value =
2469: "$in{'kerb_def_dom'}";
2470: break;
2471: default:
2472: break;
2473: }
2474: }
2475: }
2476: return;
2477: }
1.22 www 2478:
1.32 matthew 2479: function changed_text(choice,currentform) {
2480: var choicearg = choice + 'arg';
2481: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2482: $Javascript_toUpperCase
1.32 matthew 2483: // clear old field
2484: if ((current.argfield != choicearg) && (current.argfield != null)) {
2485: currentform.elements[current.argfield].value = '';
2486: }
2487: current.argfield = choicearg;
2488: }
2489: set_auth_radio_buttons(choice,currentform);
2490: return;
1.20 www 2491: }
1.32 matthew 2492:
2493: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2494: var numauthchoices = currentform.login.length;
2495: if (typeof numauthchoices == "undefined") {
2496: return;
2497: }
1.32 matthew 2498: var i=0;
1.986 raeburn 2499: while (i < numauthchoices) {
1.32 matthew 2500: if (currentform.login[i].value == newvalue) { break; }
2501: i++;
2502: }
1.986 raeburn 2503: if (i == numauthchoices) {
1.32 matthew 2504: return;
2505: }
2506: current.radiovalue = newvalue;
2507: currentform.login[i].checked = true;
2508: return;
2509: }
2510: END
2511: return $result;
2512: }
2513:
2514: sub authform_authorwarning{
2515: my $result='';
1.144 matthew 2516: $result='<i>'.
2517: &mt('As a general rule, only authors or co-authors should be '.
2518: 'filesystem authenticated '.
2519: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2520: return $result;
2521: }
2522:
2523: sub authform_nochange{
2524: my %in = (
2525: formname => 'document.cu',
2526: kerb_def_dom => 'MSU.EDU',
2527: @_,
2528: );
1.586 raeburn 2529: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2530: my $result;
2531: if (keys(%can_assign) == 0) {
2532: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2533: } else {
2534: $result = '<label>'.&mt('[_1] Do not change login data',
2535: '<input type="radio" name="login" value="nochange" '.
2536: 'checked="checked" onclick="'.
1.281 albertel 2537: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2538: '</label>';
1.586 raeburn 2539: }
1.32 matthew 2540: return $result;
2541: }
2542:
1.591 raeburn 2543: sub authform_kerberos {
1.32 matthew 2544: my %in = (
2545: formname => 'document.cu',
2546: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2547: kerb_def_auth => 'krb4',
1.32 matthew 2548: @_,
2549: );
1.586 raeburn 2550: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2551: $autharg,$jscall);
2552: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2553: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2554: $check5 = ' checked="checked"';
1.80 albertel 2555: } else {
1.772 bisitz 2556: $check4 = ' checked="checked"';
1.80 albertel 2557: }
1.165 raeburn 2558: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2559: if (defined($in{'curr_authtype'})) {
2560: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2561: $krbcheck = ' checked="checked"';
1.623 raeburn 2562: if (defined($in{'mode'})) {
2563: if ($in{'mode'} eq 'modifyuser') {
2564: $krbcheck = '';
2565: }
2566: }
1.591 raeburn 2567: if (defined($in{'curr_kerb_ver'})) {
2568: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2569: $check5 = ' checked="checked"';
1.591 raeburn 2570: $check4 = '';
2571: } else {
1.772 bisitz 2572: $check4 = ' checked="checked"';
1.591 raeburn 2573: $check5 = '';
2574: }
1.586 raeburn 2575: }
1.591 raeburn 2576: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2577: $krbarg = $in{'curr_autharg'};
2578: }
1.586 raeburn 2579: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2580: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2581: $result =
2582: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2583: $in{'curr_autharg'},$krbver);
2584: } else {
2585: $result =
2586: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2587: }
2588: return $result;
2589: }
2590: }
2591: } else {
2592: if ($authnum == 1) {
1.784 bisitz 2593: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2594: }
2595: }
1.586 raeburn 2596: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2597: return;
1.587 raeburn 2598: } elsif ($authtype eq '') {
1.591 raeburn 2599: if (defined($in{'mode'})) {
1.587 raeburn 2600: if ($in{'mode'} eq 'modifycourse') {
2601: if ($authnum == 1) {
1.784 bisitz 2602: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2603: }
2604: }
2605: }
1.586 raeburn 2606: }
2607: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2608: if ($authtype eq '') {
2609: $authtype = '<input type="radio" name="login" value="krb" '.
2610: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2611: $krbcheck.' />';
2612: }
2613: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2614: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2615: $in{'curr_authtype'} eq 'krb5') ||
2616: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2617: $in{'curr_authtype'} eq 'krb4')) {
2618: $result .= &mt
1.144 matthew 2619: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2620: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2621: '<label>'.$authtype,
1.281 albertel 2622: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2623: 'value="'.$krbarg.'" '.
1.144 matthew 2624: 'onchange="'.$jscall.'" />',
1.281 albertel 2625: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2626: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2627: '</label>');
1.586 raeburn 2628: } elsif ($can_assign{'krb4'}) {
2629: $result .= &mt
2630: ('[_1] Kerberos authenticated with domain [_2] '.
2631: '[_3] Version 4 [_4]',
2632: '<label>'.$authtype,
2633: '</label><input type="text" size="10" name="krbarg" '.
2634: 'value="'.$krbarg.'" '.
2635: 'onchange="'.$jscall.'" />',
2636: '<label><input type="hidden" name="krbver" value="4" />',
2637: '</label>');
2638: } elsif ($can_assign{'krb5'}) {
2639: $result .= &mt
2640: ('[_1] Kerberos authenticated with domain [_2] '.
2641: '[_3] Version 5 [_4]',
2642: '<label>'.$authtype,
2643: '</label><input type="text" size="10" name="krbarg" '.
2644: 'value="'.$krbarg.'" '.
2645: 'onchange="'.$jscall.'" />',
2646: '<label><input type="hidden" name="krbver" value="5" />',
2647: '</label>');
2648: }
1.32 matthew 2649: return $result;
2650: }
2651:
2652: sub authform_internal{
1.586 raeburn 2653: my %in = (
1.32 matthew 2654: formname => 'document.cu',
2655: kerb_def_dom => 'MSU.EDU',
2656: @_,
2657: );
1.586 raeburn 2658: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2659: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2660: if (defined($in{'curr_authtype'})) {
2661: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2662: if ($can_assign{'int'}) {
1.772 bisitz 2663: $intcheck = 'checked="checked" ';
1.623 raeburn 2664: if (defined($in{'mode'})) {
2665: if ($in{'mode'} eq 'modifyuser') {
2666: $intcheck = '';
2667: }
2668: }
1.591 raeburn 2669: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2670: $intarg = $in{'curr_autharg'};
2671: }
2672: } else {
2673: $result = &mt('Currently internally authenticated.');
2674: return $result;
1.165 raeburn 2675: }
2676: }
1.586 raeburn 2677: } else {
2678: if ($authnum == 1) {
1.784 bisitz 2679: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2680: }
2681: }
2682: if (!$can_assign{'int'}) {
2683: return;
1.587 raeburn 2684: } elsif ($authtype eq '') {
1.591 raeburn 2685: if (defined($in{'mode'})) {
1.587 raeburn 2686: if ($in{'mode'} eq 'modifycourse') {
2687: if ($authnum == 1) {
1.784 bisitz 2688: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2689: }
2690: }
2691: }
1.165 raeburn 2692: }
1.586 raeburn 2693: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2694: if ($authtype eq '') {
2695: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2696: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2697: }
1.605 bisitz 2698: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2699: $intarg.'" onchange="'.$jscall.'" />';
2700: $result = &mt
1.144 matthew 2701: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2702: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2703: $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 2704: return $result;
2705: }
2706:
2707: sub authform_local{
2708: my %in = (
2709: formname => 'document.cu',
2710: kerb_def_dom => 'MSU.EDU',
2711: @_,
2712: );
1.586 raeburn 2713: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2714: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2715: if (defined($in{'curr_authtype'})) {
2716: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2717: if ($can_assign{'loc'}) {
1.772 bisitz 2718: $loccheck = 'checked="checked" ';
1.623 raeburn 2719: if (defined($in{'mode'})) {
2720: if ($in{'mode'} eq 'modifyuser') {
2721: $loccheck = '';
2722: }
2723: }
1.591 raeburn 2724: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2725: $locarg = $in{'curr_autharg'};
2726: }
2727: } else {
2728: $result = &mt('Currently using local (institutional) authentication.');
2729: return $result;
1.165 raeburn 2730: }
2731: }
1.586 raeburn 2732: } else {
2733: if ($authnum == 1) {
1.784 bisitz 2734: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2735: }
2736: }
2737: if (!$can_assign{'loc'}) {
2738: return;
1.587 raeburn 2739: } elsif ($authtype eq '') {
1.591 raeburn 2740: if (defined($in{'mode'})) {
1.587 raeburn 2741: if ($in{'mode'} eq 'modifycourse') {
2742: if ($authnum == 1) {
1.784 bisitz 2743: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2744: }
2745: }
2746: }
1.165 raeburn 2747: }
1.586 raeburn 2748: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2749: if ($authtype eq '') {
2750: $authtype = '<input type="radio" name="login" value="loc" '.
2751: $loccheck.' onchange="'.$jscall.'" onclick="'.
2752: $jscall.'" />';
2753: }
2754: $autharg = '<input type="text" size="10" name="locarg" value="'.
2755: $locarg.'" onchange="'.$jscall.'" />';
2756: $result = &mt('[_1] Local Authentication with argument [_2]',
2757: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2758: return $result;
2759: }
2760:
2761: sub authform_filesystem{
2762: my %in = (
2763: formname => 'document.cu',
2764: kerb_def_dom => 'MSU.EDU',
2765: @_,
2766: );
1.586 raeburn 2767: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2768: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2769: if (defined($in{'curr_authtype'})) {
2770: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2771: if ($can_assign{'fsys'}) {
1.772 bisitz 2772: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2773: if (defined($in{'mode'})) {
2774: if ($in{'mode'} eq 'modifyuser') {
2775: $fsyscheck = '';
2776: }
2777: }
1.586 raeburn 2778: } else {
2779: $result = &mt('Currently Filesystem Authenticated.');
2780: return $result;
2781: }
2782: }
2783: } else {
2784: if ($authnum == 1) {
1.784 bisitz 2785: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2786: }
2787: }
2788: if (!$can_assign{'fsys'}) {
2789: return;
1.587 raeburn 2790: } elsif ($authtype eq '') {
1.591 raeburn 2791: if (defined($in{'mode'})) {
1.587 raeburn 2792: if ($in{'mode'} eq 'modifycourse') {
2793: if ($authnum == 1) {
1.784 bisitz 2794: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2795: }
2796: }
2797: }
1.586 raeburn 2798: }
2799: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2800: if ($authtype eq '') {
2801: $authtype = '<input type="radio" name="login" value="fsys" '.
2802: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2803: $jscall.'" />';
2804: }
2805: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2806: ' onchange="'.$jscall.'" />';
2807: $result = &mt
1.144 matthew 2808: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2809: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2810: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2811: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2812: 'onchange="'.$jscall.'" />');
1.32 matthew 2813: return $result;
2814: }
2815:
1.586 raeburn 2816: sub get_assignable_auth {
2817: my ($dom) = @_;
2818: if ($dom eq '') {
2819: $dom = $env{'request.role.domain'};
2820: }
2821: my %can_assign = (
2822: krb4 => 1,
2823: krb5 => 1,
2824: int => 1,
2825: loc => 1,
2826: );
2827: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2828: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2829: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2830: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2831: my $context;
2832: if ($env{'request.role'} =~ /^au/) {
2833: $context = 'author';
2834: } elsif ($env{'request.role'} =~ /^dc/) {
2835: $context = 'domain';
2836: } elsif ($env{'request.course.id'}) {
2837: $context = 'course';
2838: }
2839: if ($context) {
2840: if (ref($authhash->{$context}) eq 'HASH') {
2841: %can_assign = %{$authhash->{$context}};
2842: }
2843: }
2844: }
2845: }
2846: my $authnum = 0;
2847: foreach my $key (keys(%can_assign)) {
2848: if ($can_assign{$key}) {
2849: $authnum ++;
2850: }
2851: }
2852: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2853: $authnum --;
2854: }
2855: return ($authnum,%can_assign);
2856: }
2857:
1.80 albertel 2858: ###############################################################
2859: ## Get Kerberos Defaults for Domain ##
2860: ###############################################################
2861: ##
2862: ## Returns default kerberos version and an associated argument
2863: ## as listed in file domain.tab. If not listed, provides
2864: ## appropriate default domain and kerberos version.
2865: ##
2866: #-------------------------------------------
2867:
2868: =pod
2869:
1.648 raeburn 2870: =item * &get_kerberos_defaults()
1.80 albertel 2871:
2872: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2873: version and domain. If not found, it defaults to version 4 and the
2874: domain of the server.
1.80 albertel 2875:
1.648 raeburn 2876: =over 4
2877:
1.80 albertel 2878: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2879:
1.648 raeburn 2880: =back
2881:
2882: =back
2883:
1.80 albertel 2884: =cut
2885:
2886: #-------------------------------------------
2887: sub get_kerberos_defaults {
2888: my $domain=shift;
1.641 raeburn 2889: my ($krbdef,$krbdefdom);
2890: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2891: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2892: $krbdef = $domdefaults{'auth_def'};
2893: $krbdefdom = $domdefaults{'auth_arg_def'};
2894: } else {
1.80 albertel 2895: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2896: my $krbdefdom=$1;
2897: $krbdefdom=~tr/a-z/A-Z/;
2898: $krbdef = "krb4";
2899: }
2900: return ($krbdef,$krbdefdom);
2901: }
1.112 bowersj2 2902:
1.32 matthew 2903:
1.46 matthew 2904: ###############################################################
2905: ## Thesaurus Functions ##
2906: ###############################################################
1.20 www 2907:
1.46 matthew 2908: =pod
1.20 www 2909:
1.112 bowersj2 2910: =head1 Thesaurus Functions
2911:
2912: =over 4
2913:
1.648 raeburn 2914: =item * &initialize_keywords()
1.46 matthew 2915:
2916: Initializes the package variable %Keywords if it is empty. Uses the
2917: package variable $thesaurus_db_file.
2918:
2919: =cut
2920:
2921: ###################################################
2922:
2923: sub initialize_keywords {
2924: return 1 if (scalar keys(%Keywords));
2925: # If we are here, %Keywords is empty, so fill it up
2926: # Make sure the file we need exists...
2927: if (! -e $thesaurus_db_file) {
2928: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2929: " failed because it does not exist");
2930: return 0;
2931: }
2932: # Set up the hash as a database
2933: my %thesaurus_db;
2934: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2935: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2936: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2937: $thesaurus_db_file);
2938: return 0;
2939: }
2940: # Get the average number of appearances of a word.
2941: my $avecount = $thesaurus_db{'average.count'};
2942: # Put keywords (those that appear > average) into %Keywords
2943: while (my ($word,$data)=each (%thesaurus_db)) {
2944: my ($count,undef) = split /:/,$data;
2945: $Keywords{$word}++ if ($count > $avecount);
2946: }
2947: untie %thesaurus_db;
2948: # Remove special values from %Keywords.
1.356 albertel 2949: foreach my $value ('total.count','average.count') {
2950: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2951: }
1.46 matthew 2952: return 1;
2953: }
2954:
2955: ###################################################
2956:
2957: =pod
2958:
1.648 raeburn 2959: =item * &keyword($word)
1.46 matthew 2960:
2961: Returns true if $word is a keyword. A keyword is a word that appears more
2962: than the average number of times in the thesaurus database. Calls
2963: &initialize_keywords
2964:
2965: =cut
2966:
2967: ###################################################
1.20 www 2968:
2969: sub keyword {
1.46 matthew 2970: return if (!&initialize_keywords());
2971: my $word=lc(shift());
2972: $word=~s/\W//g;
2973: return exists($Keywords{$word});
1.20 www 2974: }
1.46 matthew 2975:
2976: ###############################################################
2977:
2978: =pod
1.20 www 2979:
1.648 raeburn 2980: =item * &get_related_words()
1.46 matthew 2981:
1.160 matthew 2982: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2983: an array of words. If the keyword is not in the thesaurus, an empty array
2984: will be returned. The order of the words returned is determined by the
2985: database which holds them.
2986:
2987: Uses global $thesaurus_db_file.
2988:
1.1057 foxr 2989:
1.46 matthew 2990: =cut
2991:
2992: ###############################################################
2993: sub get_related_words {
2994: my $keyword = shift;
2995: my %thesaurus_db;
2996: if (! -e $thesaurus_db_file) {
2997: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2998: "failed because the file does not exist");
2999: return ();
3000: }
3001: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3002: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3003: return ();
3004: }
3005: my @Words=();
1.429 www 3006: my $count=0;
1.46 matthew 3007: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3008: # The first element is the number of times
3009: # the word appears. We do not need it now.
1.429 www 3010: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3011: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3012: my $threshold=$mostfrequentcount/10;
3013: foreach my $possibleword (@RelatedWords) {
3014: my ($word,$wordcount)=split(/\,/,$possibleword);
3015: if ($wordcount>$threshold) {
3016: push(@Words,$word);
3017: $count++;
3018: if ($count>10) { last; }
3019: }
1.20 www 3020: }
3021: }
1.46 matthew 3022: untie %thesaurus_db;
3023: return @Words;
1.14 harris41 3024: }
1.1090 foxr 3025: ###############################################################
3026: #
3027: # Spell checking
3028: #
3029:
3030: =pod
3031:
3032: =head1 Spell checking
3033:
3034: =over 4
3035:
3036: =item * &check_spelling($wordlist $language)
3037:
3038: Takes a string containing words and feeds it to an external
3039: spellcheck program via a pipeline. Returns a string containing
3040: them mis-spelled words.
3041:
3042: Parameters:
3043:
3044: =over 4
3045:
3046: =item - $wordlist
3047:
3048: String that will be fed into the spellcheck program.
3049:
3050: =item - $language
3051:
3052: Language string that specifies the language for which the spell
3053: check will be performed.
3054:
3055: =back
3056:
3057: =back
3058:
3059: Note: This sub assumes that aspell is installed.
3060:
3061:
3062: =cut
3063:
1.46 matthew 3064:
1.112 bowersj2 3065: =pod
3066:
3067: =back
3068:
3069: =cut
1.61 www 3070:
1.1090 foxr 3071: sub check_spelling {
3072: my ($wordlist, $language) = @_;
1.1091 foxr 3073: my @misspellings;
3074:
3075: # Generate the speller and set the langauge.
3076: # if explicitly selected:
1.1090 foxr 3077:
1.1091 foxr 3078: my $speller = Text::Aspell->new;
1.1090 foxr 3079: if ($language) {
1.1091 foxr 3080: $speller->set_option('lang', $language);
1.1090 foxr 3081: }
3082:
1.1091 foxr 3083: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3084:
1.1091 foxr 3085: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3086:
1.1091 foxr 3087: foreach my $word (@words) {
3088: if(! $speller->check($word)) {
3089: push(@misspellings, $word);
1.1090 foxr 3090: }
3091: }
1.1091 foxr 3092: return join(' ', @misspellings);
3093:
1.1090 foxr 3094: }
3095:
1.61 www 3096: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3097: =pod
3098:
1.112 bowersj2 3099: =head1 User Name Functions
3100:
3101: =over 4
3102:
1.648 raeburn 3103: =item * &plainname($uname,$udom,$first)
1.81 albertel 3104:
1.112 bowersj2 3105: Takes a users logon name and returns it as a string in
1.226 albertel 3106: "first middle last generation" form
3107: if $first is set to 'lastname' then it returns it as
3108: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3109:
3110: =cut
1.61 www 3111:
1.295 www 3112:
1.81 albertel 3113: ###############################################################
1.61 www 3114: sub plainname {
1.226 albertel 3115: my ($uname,$udom,$first)=@_;
1.537 albertel 3116: return if (!defined($uname) || !defined($udom));
1.295 www 3117: my %names=&getnames($uname,$udom);
1.226 albertel 3118: my $name=&Apache::lonnet::format_name($names{'firstname'},
3119: $names{'middlename'},
3120: $names{'lastname'},
3121: $names{'generation'},$first);
3122: $name=~s/^\s+//;
1.62 www 3123: $name=~s/\s+$//;
3124: $name=~s/\s+/ /g;
1.353 albertel 3125: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3126: return $name;
1.61 www 3127: }
1.66 www 3128:
3129: # -------------------------------------------------------------------- Nickname
1.81 albertel 3130: =pod
3131:
1.648 raeburn 3132: =item * &nickname($uname,$udom)
1.81 albertel 3133:
3134: Gets a users name and returns it as a string as
3135:
3136: ""nickname""
1.66 www 3137:
1.81 albertel 3138: if the user has a nickname or
3139:
3140: "first middle last generation"
3141:
3142: if the user does not
3143:
3144: =cut
1.66 www 3145:
3146: sub nickname {
3147: my ($uname,$udom)=@_;
1.537 albertel 3148: return if (!defined($uname) || !defined($udom));
1.295 www 3149: my %names=&getnames($uname,$udom);
1.68 albertel 3150: my $name=$names{'nickname'};
1.66 www 3151: if ($name) {
3152: $name='"'.$name.'"';
3153: } else {
3154: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3155: $names{'lastname'}.' '.$names{'generation'};
3156: $name=~s/\s+$//;
3157: $name=~s/\s+/ /g;
3158: }
3159: return $name;
3160: }
3161:
1.295 www 3162: sub getnames {
3163: my ($uname,$udom)=@_;
1.537 albertel 3164: return if (!defined($uname) || !defined($udom));
1.433 albertel 3165: if ($udom eq 'public' && $uname eq 'public') {
3166: return ('lastname' => &mt('Public'));
3167: }
1.295 www 3168: my $id=$uname.':'.$udom;
3169: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3170: if ($cached) {
3171: return %{$names};
3172: } else {
3173: my %loadnames=&Apache::lonnet::get('environment',
3174: ['firstname','middlename','lastname','generation','nickname'],
3175: $udom,$uname);
3176: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3177: return %loadnames;
3178: }
3179: }
1.61 www 3180:
1.542 raeburn 3181: # -------------------------------------------------------------------- getemails
1.648 raeburn 3182:
1.542 raeburn 3183: =pod
3184:
1.648 raeburn 3185: =item * &getemails($uname,$udom)
1.542 raeburn 3186:
3187: Gets a user's email information and returns it as a hash with keys:
3188: notification, critnotification, permanentemail
3189:
3190: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3191: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3192:
1.648 raeburn 3193:
1.542 raeburn 3194: =cut
3195:
1.648 raeburn 3196:
1.466 albertel 3197: sub getemails {
3198: my ($uname,$udom)=@_;
3199: if ($udom eq 'public' && $uname eq 'public') {
3200: return;
3201: }
1.467 www 3202: if (!$udom) { $udom=$env{'user.domain'}; }
3203: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3204: my $id=$uname.':'.$udom;
3205: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3206: if ($cached) {
3207: return %{$names};
3208: } else {
3209: my %loadnames=&Apache::lonnet::get('environment',
3210: ['notification','critnotification',
3211: 'permanentemail'],
3212: $udom,$uname);
3213: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3214: return %loadnames;
3215: }
3216: }
3217:
1.551 albertel 3218: sub flush_email_cache {
3219: my ($uname,$udom)=@_;
3220: if (!$udom) { $udom =$env{'user.domain'}; }
3221: if (!$uname) { $uname=$env{'user.name'}; }
3222: return if ($udom eq 'public' && $uname eq 'public');
3223: my $id=$uname.':'.$udom;
3224: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3225: }
3226:
1.728 raeburn 3227: # -------------------------------------------------------------------- getlangs
3228:
3229: =pod
3230:
3231: =item * &getlangs($uname,$udom)
3232:
3233: Gets a user's language preference and returns it as a hash with key:
3234: language.
3235:
3236: =cut
3237:
3238:
3239: sub getlangs {
3240: my ($uname,$udom) = @_;
3241: if (!$udom) { $udom =$env{'user.domain'}; }
3242: if (!$uname) { $uname=$env{'user.name'}; }
3243: my $id=$uname.':'.$udom;
3244: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3245: if ($cached) {
3246: return %{$langs};
3247: } else {
3248: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3249: $udom,$uname);
3250: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3251: return %loadlangs;
3252: }
3253: }
3254:
3255: sub flush_langs_cache {
3256: my ($uname,$udom)=@_;
3257: if (!$udom) { $udom =$env{'user.domain'}; }
3258: if (!$uname) { $uname=$env{'user.name'}; }
3259: return if ($udom eq 'public' && $uname eq 'public');
3260: my $id=$uname.':'.$udom;
3261: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3262: }
3263:
1.61 www 3264: # ------------------------------------------------------------------ Screenname
1.81 albertel 3265:
3266: =pod
3267:
1.648 raeburn 3268: =item * &screenname($uname,$udom)
1.81 albertel 3269:
3270: Gets a users screenname and returns it as a string
3271:
3272: =cut
1.61 www 3273:
3274: sub screenname {
3275: my ($uname,$udom)=@_;
1.258 albertel 3276: if ($uname eq $env{'user.name'} &&
3277: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3278: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3279: return $names{'screenname'};
1.62 www 3280: }
3281:
1.212 albertel 3282:
1.802 bisitz 3283: # ------------------------------------------------------------- Confirm Wrapper
3284: =pod
3285:
3286: =item confirmwrapper
3287:
3288: Wrap messages about completion of operation in box
3289:
3290: =cut
3291:
3292: sub confirmwrapper {
3293: my ($message)=@_;
3294: if ($message) {
3295: return "\n".'<div class="LC_confirm_box">'."\n"
3296: .$message."\n"
3297: .'</div>'."\n";
3298: } else {
3299: return $message;
3300: }
3301: }
3302:
1.62 www 3303: # ------------------------------------------------------------- Message Wrapper
3304:
3305: sub messagewrapper {
1.369 www 3306: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3307: return
1.441 albertel 3308: '<a href="/adm/email?compose=individual&'.
3309: 'recname='.$username.'&recdom='.$domain.
3310: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3311: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3312: }
1.802 bisitz 3313:
1.74 www 3314: # --------------------------------------------------------------- Notes Wrapper
3315:
3316: sub noteswrapper {
3317: my ($link,$un,$do)=@_;
3318: return
1.896 amueller 3319: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3320: }
1.802 bisitz 3321:
1.62 www 3322: # ------------------------------------------------------------- Aboutme Wrapper
3323:
3324: sub aboutmewrapper {
1.1070 raeburn 3325: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3326: if (!defined($username) && !defined($domain)) {
3327: return;
3328: }
1.892 amueller 3329: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.1070 raeburn 3330: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3331: }
3332:
3333: # ------------------------------------------------------------ Syllabus Wrapper
3334:
3335: sub syllabuswrapper {
1.707 bisitz 3336: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3337: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3338: }
1.14 harris41 3339:
1.802 bisitz 3340: # -----------------------------------------------------------------------------
3341:
1.208 matthew 3342: sub track_student_link {
1.887 raeburn 3343: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3344: my $link ="/adm/trackstudent?";
1.208 matthew 3345: my $title = 'View recent activity';
3346: if (defined($sname) && $sname !~ /^\s*$/ &&
3347: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3348: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3349: $title .= ' of this student';
1.268 albertel 3350: }
1.208 matthew 3351: if (defined($target) && $target !~ /^\s*$/) {
3352: $target = qq{target="$target"};
3353: } else {
3354: $target = '';
3355: }
1.268 albertel 3356: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3357: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3358: $title = &mt($title);
3359: $linktext = &mt($linktext);
1.448 albertel 3360: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3361: &help_open_topic('View_recent_activity');
1.208 matthew 3362: }
3363:
1.781 raeburn 3364: sub slot_reservations_link {
3365: my ($linktext,$sname,$sdom,$target) = @_;
3366: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3367: my $title = 'View slot reservation history';
3368: if (defined($sname) && $sname !~ /^\s*$/ &&
3369: defined($sdom) && $sdom !~ /^\s*$/) {
3370: $link .= "&uname=$sname&udom=$sdom";
3371: $title .= ' of this student';
3372: }
3373: if (defined($target) && $target !~ /^\s*$/) {
3374: $target = qq{target="$target"};
3375: } else {
3376: $target = '';
3377: }
3378: $title = &mt($title);
3379: $linktext = &mt($linktext);
3380: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3381: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3382:
3383: }
3384:
1.508 www 3385: # ===================================================== Display a student photo
3386:
3387:
1.509 albertel 3388: sub student_image_tag {
1.508 www 3389: my ($domain,$user)=@_;
3390: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3391: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3392: return '<img src="'.$imgsrc.'" align="right" />';
3393: } else {
3394: return '';
3395: }
3396: }
3397:
1.112 bowersj2 3398: =pod
3399:
3400: =back
3401:
3402: =head1 Access .tab File Data
3403:
3404: =over 4
3405:
1.648 raeburn 3406: =item * &languageids()
1.112 bowersj2 3407:
3408: returns list of all language ids
3409:
3410: =cut
3411:
1.14 harris41 3412: sub languageids {
1.16 harris41 3413: return sort(keys(%language));
1.14 harris41 3414: }
3415:
1.112 bowersj2 3416: =pod
3417:
1.648 raeburn 3418: =item * &languagedescription()
1.112 bowersj2 3419:
3420: returns description of a specified language id
3421:
3422: =cut
3423:
1.14 harris41 3424: sub languagedescription {
1.125 www 3425: my $code=shift;
3426: return ($supported_language{$code}?'* ':'').
3427: $language{$code}.
1.126 www 3428: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3429: }
3430:
1.1048 foxr 3431: =pod
3432:
3433: =item * &plainlanguagedescription
3434:
3435: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3436: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3437:
3438: =cut
3439:
1.145 www 3440: sub plainlanguagedescription {
3441: my $code=shift;
3442: return $language{$code};
3443: }
3444:
1.1048 foxr 3445: =pod
3446:
3447: =item * &supportedlanguagecode
3448:
3449: Returns the supported language code (e.g. sptutf maps to pt) given a language
3450: code.
3451:
3452: =cut
3453:
1.145 www 3454: sub supportedlanguagecode {
3455: my $code=shift;
3456: return $supported_language{$code};
1.97 www 3457: }
3458:
1.112 bowersj2 3459: =pod
3460:
1.1048 foxr 3461: =item * &latexlanguage()
3462:
3463: Given a language key code returns the correspondnig language to use
3464: to select the correct hyphenation on LaTeX printouts. This is undef if there
3465: is no supported hyphenation for the language code.
3466:
3467: =cut
3468:
3469: sub latexlanguage {
3470: my $code = shift;
3471: return $latex_language{$code};
3472: }
3473:
3474: =pod
3475:
3476: =item * &latexhyphenation()
3477:
3478: Same as above but what's supplied is the language as it might be stored
3479: in the metadata.
3480:
3481: =cut
3482:
3483: sub latexhyphenation {
3484: my $key = shift;
3485: return $latex_language_bykey{$key};
3486: }
3487:
3488: =pod
3489:
1.648 raeburn 3490: =item * ©rightids()
1.112 bowersj2 3491:
3492: returns list of all copyrights
3493:
3494: =cut
3495:
3496: sub copyrightids {
3497: return sort(keys(%cprtag));
3498: }
3499:
3500: =pod
3501:
1.648 raeburn 3502: =item * ©rightdescription()
1.112 bowersj2 3503:
3504: returns description of a specified copyright id
3505:
3506: =cut
3507:
3508: sub copyrightdescription {
1.166 www 3509: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3510: }
1.197 matthew 3511:
3512: =pod
3513:
1.648 raeburn 3514: =item * &source_copyrightids()
1.192 taceyjo1 3515:
3516: returns list of all source copyrights
3517:
3518: =cut
3519:
3520: sub source_copyrightids {
3521: return sort(keys(%scprtag));
3522: }
3523:
3524: =pod
3525:
1.648 raeburn 3526: =item * &source_copyrightdescription()
1.192 taceyjo1 3527:
3528: returns description of a specified source copyright id
3529:
3530: =cut
3531:
3532: sub source_copyrightdescription {
3533: return &mt($scprtag{shift(@_)});
3534: }
1.112 bowersj2 3535:
3536: =pod
3537:
1.648 raeburn 3538: =item * &filecategories()
1.112 bowersj2 3539:
3540: returns list of all file categories
3541:
3542: =cut
3543:
3544: sub filecategories {
3545: return sort(keys(%category_extensions));
3546: }
3547:
3548: =pod
3549:
1.648 raeburn 3550: =item * &filecategorytypes()
1.112 bowersj2 3551:
3552: returns list of file types belonging to a given file
3553: category
3554:
3555: =cut
3556:
3557: sub filecategorytypes {
1.356 albertel 3558: my ($cat) = @_;
3559: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3560: }
3561:
3562: =pod
3563:
1.648 raeburn 3564: =item * &fileembstyle()
1.112 bowersj2 3565:
3566: returns embedding style for a specified file type
3567:
3568: =cut
3569:
3570: sub fileembstyle {
3571: return $fe{lc(shift(@_))};
1.169 www 3572: }
3573:
1.351 www 3574: sub filemimetype {
3575: return $fm{lc(shift(@_))};
3576: }
3577:
1.169 www 3578:
3579: sub filecategoryselect {
3580: my ($name,$value)=@_;
1.189 matthew 3581: return &select_form($value,$name,
1.970 raeburn 3582: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3583: }
3584:
3585: =pod
3586:
1.648 raeburn 3587: =item * &filedescription()
1.112 bowersj2 3588:
3589: returns description for a specified file type
3590:
3591: =cut
3592:
3593: sub filedescription {
1.188 matthew 3594: my $file_description = $fd{lc(shift())};
3595: $file_description =~ s:([\[\]]):~$1:g;
3596: return &mt($file_description);
1.112 bowersj2 3597: }
3598:
3599: =pod
3600:
1.648 raeburn 3601: =item * &filedescriptionex()
1.112 bowersj2 3602:
3603: returns description for a specified file type with
3604: extra formatting
3605:
3606: =cut
3607:
3608: sub filedescriptionex {
3609: my $ex=shift;
1.188 matthew 3610: my $file_description = $fd{lc($ex)};
3611: $file_description =~ s:([\[\]]):~$1:g;
3612: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3613: }
3614:
3615: # End of .tab access
3616: =pod
3617:
3618: =back
3619:
3620: =cut
3621:
3622: # ------------------------------------------------------------------ File Types
3623: sub fileextensions {
3624: return sort(keys(%fe));
3625: }
3626:
1.97 www 3627: # ----------------------------------------------------------- Display Languages
3628: # returns a hash with all desired display languages
3629: #
3630:
3631: sub display_languages {
3632: my %languages=();
1.695 raeburn 3633: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3634: $languages{$lang}=1;
1.97 www 3635: }
3636: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3637: if ($env{'form.displaylanguage'}) {
1.356 albertel 3638: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3639: $languages{$lang}=1;
1.97 www 3640: }
3641: }
3642: return %languages;
1.14 harris41 3643: }
3644:
1.582 albertel 3645: sub languages {
3646: my ($possible_langs) = @_;
1.695 raeburn 3647: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3648: if (!ref($possible_langs)) {
3649: if( wantarray ) {
3650: return @preferred_langs;
3651: } else {
3652: return $preferred_langs[0];
3653: }
3654: }
3655: my %possibilities = map { $_ => 1 } (@$possible_langs);
3656: my @preferred_possibilities;
3657: foreach my $preferred_lang (@preferred_langs) {
3658: if (exists($possibilities{$preferred_lang})) {
3659: push(@preferred_possibilities, $preferred_lang);
3660: }
3661: }
3662: if( wantarray ) {
3663: return @preferred_possibilities;
3664: }
3665: return $preferred_possibilities[0];
3666: }
3667:
1.742 raeburn 3668: sub user_lang {
3669: my ($touname,$toudom,$fromcid) = @_;
3670: my @userlangs;
3671: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3672: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3673: $env{'course.'.$fromcid.'.languages'}));
3674: } else {
3675: my %langhash = &getlangs($touname,$toudom);
3676: if ($langhash{'languages'} ne '') {
3677: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3678: } else {
3679: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3680: if ($domdefs{'lang_def'} ne '') {
3681: @userlangs = ($domdefs{'lang_def'});
3682: }
3683: }
3684: }
3685: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3686: my $user_lh = Apache::localize->get_handle(@languages);
3687: return $user_lh;
3688: }
3689:
3690:
1.112 bowersj2 3691: ###############################################################
3692: ## Student Answer Attempts ##
3693: ###############################################################
3694:
3695: =pod
3696:
3697: =head1 Alternate Problem Views
3698:
3699: =over 4
3700:
1.648 raeburn 3701: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3702: $getattempt, $regexp, $gradesub)
3703:
3704: Return string with previous attempt on problem. Arguments:
3705:
3706: =over 4
3707:
3708: =item * $symb: Problem, including path
3709:
3710: =item * $username: username of the desired student
3711:
3712: =item * $domain: domain of the desired student
1.14 harris41 3713:
1.112 bowersj2 3714: =item * $course: Course ID
1.14 harris41 3715:
1.112 bowersj2 3716: =item * $getattempt: Leave blank for all attempts, otherwise put
3717: something
1.14 harris41 3718:
1.112 bowersj2 3719: =item * $regexp: if string matches this regexp, the string will be
3720: sent to $gradesub
1.14 harris41 3721:
1.112 bowersj2 3722: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3723:
1.112 bowersj2 3724: =back
1.14 harris41 3725:
1.112 bowersj2 3726: The output string is a table containing all desired attempts, if any.
1.16 harris41 3727:
1.112 bowersj2 3728: =cut
1.1 albertel 3729:
3730: sub get_previous_attempt {
1.43 ng 3731: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3732: my $prevattempts='';
1.43 ng 3733: no strict 'refs';
1.1 albertel 3734: if ($symb) {
1.3 albertel 3735: my (%returnhash)=
3736: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3737: if ($returnhash{'version'}) {
3738: my %lasthash=();
3739: my $version;
3740: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3741: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3742: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3743: }
1.1 albertel 3744: }
1.596 albertel 3745: $prevattempts=&start_data_table().&start_data_table_header_row();
3746: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3747: my (%typeparts,%lasthidden);
1.945 raeburn 3748: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3749: foreach my $key (sort(keys(%lasthash))) {
3750: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3751: if ($#parts > 0) {
1.31 albertel 3752: my $data=$parts[-1];
1.989 raeburn 3753: next if ($data eq 'foilorder');
1.31 albertel 3754: pop(@parts);
1.1010 www 3755: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3756: if ($data eq 'type') {
3757: unless ($showsurv) {
3758: my $id = join(',',@parts);
3759: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3760: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3761: $lasthidden{$ign.'.'.$id} = 1;
3762: }
1.945 raeburn 3763: }
1.1010 www 3764: }
1.31 albertel 3765: } else {
1.41 ng 3766: if ($#parts == 0) {
3767: $prevattempts.='<th>'.$parts[0].'</th>';
3768: } else {
3769: $prevattempts.='<th>'.$ign.'</th>';
3770: }
1.31 albertel 3771: }
1.16 harris41 3772: }
1.596 albertel 3773: $prevattempts.=&end_data_table_header_row();
1.40 ng 3774: if ($getattempt eq '') {
3775: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3776: my @hidden;
3777: if (%typeparts) {
3778: foreach my $id (keys(%typeparts)) {
3779: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3780: push(@hidden,$id);
3781: }
3782: }
3783: }
3784: $prevattempts.=&start_data_table_row().
3785: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3786: if (@hidden) {
3787: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3788: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3789: my $hide;
3790: foreach my $id (@hidden) {
3791: if ($key =~ /^\Q$id\E/) {
3792: $hide = 1;
3793: last;
3794: }
3795: }
3796: if ($hide) {
3797: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3798: if (($data eq 'award') || ($data eq 'awarddetail')) {
3799: my $value = &format_previous_attempt_value($key,
3800: $returnhash{$version.':'.$key});
3801: $prevattempts.='<td>'.$value.' </td>';
3802: } else {
3803: $prevattempts.='<td> </td>';
3804: }
3805: } else {
3806: if ($key =~ /\./) {
3807: my $value = &format_previous_attempt_value($key,
3808: $returnhash{$version.':'.$key});
3809: $prevattempts.='<td>'.$value.' </td>';
3810: } else {
3811: $prevattempts.='<td> </td>';
3812: }
3813: }
3814: }
3815: } else {
3816: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3817: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3818: my $value = &format_previous_attempt_value($key,
3819: $returnhash{$version.':'.$key});
3820: $prevattempts.='<td>'.$value.' </td>';
3821: }
3822: }
3823: $prevattempts.=&end_data_table_row();
1.40 ng 3824: }
1.1 albertel 3825: }
1.945 raeburn 3826: my @currhidden = keys(%lasthidden);
1.596 albertel 3827: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3828: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3829: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3830: if (%typeparts) {
3831: my $hidden;
3832: foreach my $id (@currhidden) {
3833: if ($key =~ /^\Q$id\E/) {
3834: $hidden = 1;
3835: last;
3836: }
3837: }
3838: if ($hidden) {
3839: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3840: if (($data eq 'award') || ($data eq 'awarddetail')) {
3841: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3842: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3843: $value = &$gradesub($value);
3844: }
3845: $prevattempts.='<td>'.$value.' </td>';
3846: } else {
3847: $prevattempts.='<td> </td>';
3848: }
3849: } else {
3850: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3851: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3852: $value = &$gradesub($value);
3853: }
3854: $prevattempts.='<td>'.$value.' </td>';
3855: }
3856: } else {
3857: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3858: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3859: $value = &$gradesub($value);
3860: }
3861: $prevattempts.='<td>'.$value.' </td>';
3862: }
1.16 harris41 3863: }
1.596 albertel 3864: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3865: } else {
1.596 albertel 3866: $prevattempts=
3867: &start_data_table().&start_data_table_row().
3868: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3869: &end_data_table_row().&end_data_table();
1.1 albertel 3870: }
3871: } else {
1.596 albertel 3872: $prevattempts=
3873: &start_data_table().&start_data_table_row().
3874: '<td>'.&mt('No data.').'</td>'.
3875: &end_data_table_row().&end_data_table();
1.1 albertel 3876: }
1.10 albertel 3877: }
3878:
1.581 albertel 3879: sub format_previous_attempt_value {
3880: my ($key,$value) = @_;
1.1011 www 3881: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3882: $value = &Apache::lonlocal::locallocaltime($value);
3883: } elsif (ref($value) eq 'ARRAY') {
3884: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3885: } elsif ($key =~ /answerstring$/) {
3886: my %answers = &Apache::lonnet::str2hash($value);
3887: my @anskeys = sort(keys(%answers));
3888: if (@anskeys == 1) {
3889: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3890: if ($answer =~ m{\0}) {
3891: $answer =~ s{\0}{,}g;
1.988 raeburn 3892: }
3893: my $tag_internal_answer_name = 'INTERNAL';
3894: if ($anskeys[0] eq $tag_internal_answer_name) {
3895: $value = $answer;
3896: } else {
3897: $value = $anskeys[0].'='.$answer;
3898: }
3899: } else {
3900: foreach my $ans (@anskeys) {
3901: my $answer = $answers{$ans};
1.1001 raeburn 3902: if ($answer =~ m{\0}) {
3903: $answer =~ s{\0}{,}g;
1.988 raeburn 3904: }
3905: $value .= $ans.'='.$answer.'<br />';;
3906: }
3907: }
1.581 albertel 3908: } else {
3909: $value = &unescape($value);
3910: }
3911: return $value;
3912: }
3913:
3914:
1.107 albertel 3915: sub relative_to_absolute {
3916: my ($url,$output)=@_;
3917: my $parser=HTML::TokeParser->new(\$output);
3918: my $token;
3919: my $thisdir=$url;
3920: my @rlinks=();
3921: while ($token=$parser->get_token) {
3922: if ($token->[0] eq 'S') {
3923: if ($token->[1] eq 'a') {
3924: if ($token->[2]->{'href'}) {
3925: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3926: }
3927: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3928: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3929: } elsif ($token->[1] eq 'base') {
3930: $thisdir=$token->[2]->{'href'};
3931: }
3932: }
3933: }
3934: $thisdir=~s-/[^/]*$--;
1.356 albertel 3935: foreach my $link (@rlinks) {
1.726 raeburn 3936: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3937: ($link=~/^\//) ||
3938: ($link=~/^javascript:/i) ||
3939: ($link=~/^mailto:/i) ||
3940: ($link=~/^\#/)) {
3941: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3942: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3943: }
3944: }
3945: # -------------------------------------------------- Deal with Applet codebases
3946: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3947: return $output;
3948: }
3949:
1.112 bowersj2 3950: =pod
3951:
1.648 raeburn 3952: =item * &get_student_view()
1.112 bowersj2 3953:
3954: show a snapshot of what student was looking at
3955:
3956: =cut
3957:
1.10 albertel 3958: sub get_student_view {
1.186 albertel 3959: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3960: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3961: my (%form);
1.10 albertel 3962: my @elements=('symb','courseid','domain','username');
3963: foreach my $element (@elements) {
1.186 albertel 3964: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3965: }
1.186 albertel 3966: if (defined($moreenv)) {
3967: %form=(%form,%{$moreenv});
3968: }
1.236 albertel 3969: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3970: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3971: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3972: $userview=~s/\<body[^\>]*\>//gi;
3973: $userview=~s/\<\/body\>//gi;
3974: $userview=~s/\<html\>//gi;
3975: $userview=~s/\<\/html\>//gi;
3976: $userview=~s/\<head\>//gi;
3977: $userview=~s/\<\/head\>//gi;
3978: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3979: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3980: if (wantarray) {
3981: return ($userview,$response);
3982: } else {
3983: return $userview;
3984: }
3985: }
3986:
3987: sub get_student_view_with_retries {
3988: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3989:
3990: my $ok = 0; # True if we got a good response.
3991: my $content;
3992: my $response;
3993:
3994: # Try to get the student_view done. within the retries count:
3995:
3996: do {
3997: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3998: $ok = $response->is_success;
3999: if (!$ok) {
4000: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4001: }
4002: $retries--;
4003: } while (!$ok && ($retries > 0));
4004:
4005: if (!$ok) {
4006: $content = ''; # On error return an empty content.
4007: }
1.651 www 4008: if (wantarray) {
4009: return ($content, $response);
4010: } else {
4011: return $content;
4012: }
1.11 albertel 4013: }
4014:
1.112 bowersj2 4015: =pod
4016:
1.648 raeburn 4017: =item * &get_student_answers()
1.112 bowersj2 4018:
4019: show a snapshot of how student was answering problem
4020:
4021: =cut
4022:
1.11 albertel 4023: sub get_student_answers {
1.100 sakharuk 4024: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4025: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4026: my (%moreenv);
1.11 albertel 4027: my @elements=('symb','courseid','domain','username');
4028: foreach my $element (@elements) {
1.186 albertel 4029: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4030: }
1.186 albertel 4031: $moreenv{'grade_target'}='answer';
4032: %moreenv=(%form,%moreenv);
1.497 raeburn 4033: $feedurl = &Apache::lonnet::clutter($feedurl);
4034: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4035: return $userview;
1.1 albertel 4036: }
1.116 albertel 4037:
4038: =pod
4039:
4040: =item * &submlink()
4041:
1.242 albertel 4042: Inputs: $text $uname $udom $symb $target
1.116 albertel 4043:
4044: Returns: A link to grades.pm such as to see the SUBM view of a student
4045:
4046: =cut
4047:
4048: ###############################################
4049: sub submlink {
1.242 albertel 4050: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4051: if (!($uname && $udom)) {
4052: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4053: &Apache::lonnet::whichuser($symb);
1.116 albertel 4054: if (!$symb) { $symb=$cursymb; }
4055: }
1.254 matthew 4056: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4057: $symb=&escape($symb);
1.960 bisitz 4058: if ($target) { $target=" target=\"$target\""; }
4059: return
4060: '<a href="/adm/grades?command=submission'.
4061: '&symb='.$symb.
4062: '&student='.$uname.
4063: '&userdom='.$udom.'"'.
4064: $target.'>'.$text.'</a>';
1.242 albertel 4065: }
4066: ##############################################
4067:
4068: =pod
4069:
4070: =item * &pgrdlink()
4071:
4072: Inputs: $text $uname $udom $symb $target
4073:
4074: Returns: A link to grades.pm such as to see the PGRD view of a student
4075:
4076: =cut
4077:
4078: ###############################################
4079: sub pgrdlink {
4080: my $link=&submlink(@_);
4081: $link=~s/(&command=submission)/$1&showgrading=yes/;
4082: return $link;
4083: }
4084: ##############################################
4085:
4086: =pod
4087:
4088: =item * &pprmlink()
4089:
4090: Inputs: $text $uname $udom $symb $target
4091:
4092: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4093: student and a specific resource
1.242 albertel 4094:
4095: =cut
4096:
4097: ###############################################
4098: sub pprmlink {
4099: my ($text,$uname,$udom,$symb,$target)=@_;
4100: if (!($uname && $udom)) {
4101: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4102: &Apache::lonnet::whichuser($symb);
1.242 albertel 4103: if (!$symb) { $symb=$cursymb; }
4104: }
1.254 matthew 4105: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4106: $symb=&escape($symb);
1.242 albertel 4107: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4108: return '<a href="/adm/parmset?command=set&'.
4109: 'symb='.$symb.'&uname='.$uname.
4110: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4111: }
4112: ##############################################
1.37 matthew 4113:
1.112 bowersj2 4114: =pod
4115:
4116: =back
4117:
4118: =cut
4119:
1.37 matthew 4120: ###############################################
1.51 www 4121:
4122:
4123: sub timehash {
1.687 raeburn 4124: my ($thistime) = @_;
4125: my $timezone = &Apache::lonlocal::gettimezone();
4126: my $dt = DateTime->from_epoch(epoch => $thistime)
4127: ->set_time_zone($timezone);
4128: my $wday = $dt->day_of_week();
4129: if ($wday == 7) { $wday = 0; }
4130: return ( 'second' => $dt->second(),
4131: 'minute' => $dt->minute(),
4132: 'hour' => $dt->hour(),
4133: 'day' => $dt->day_of_month(),
4134: 'month' => $dt->month(),
4135: 'year' => $dt->year(),
4136: 'weekday' => $wday,
4137: 'dayyear' => $dt->day_of_year(),
4138: 'dlsav' => $dt->is_dst() );
1.51 www 4139: }
4140:
1.370 www 4141: sub utc_string {
4142: my ($date)=@_;
1.371 www 4143: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4144: }
4145:
1.51 www 4146: sub maketime {
4147: my %th=@_;
1.687 raeburn 4148: my ($epoch_time,$timezone,$dt);
4149: $timezone = &Apache::lonlocal::gettimezone();
4150: eval {
4151: $dt = DateTime->new( year => $th{'year'},
4152: month => $th{'month'},
4153: day => $th{'day'},
4154: hour => $th{'hour'},
4155: minute => $th{'minute'},
4156: second => $th{'second'},
4157: time_zone => $timezone,
4158: );
4159: };
4160: if (!$@) {
4161: $epoch_time = $dt->epoch;
4162: if ($epoch_time) {
4163: return $epoch_time;
4164: }
4165: }
1.51 www 4166: return POSIX::mktime(
4167: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4168: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4169: }
4170:
4171: #########################################
1.51 www 4172:
4173: sub findallcourses {
1.482 raeburn 4174: my ($roles,$uname,$udom) = @_;
1.355 albertel 4175: my %roles;
4176: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4177: my %courses;
1.51 www 4178: my $now=time;
1.482 raeburn 4179: if (!defined($uname)) {
4180: $uname = $env{'user.name'};
4181: }
4182: if (!defined($udom)) {
4183: $udom = $env{'user.domain'};
4184: }
4185: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4186: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4187: if (!%roles) {
4188: %roles = (
4189: cc => 1,
1.907 raeburn 4190: co => 1,
1.482 raeburn 4191: in => 1,
4192: ep => 1,
4193: ta => 1,
4194: cr => 1,
4195: st => 1,
4196: );
4197: }
4198: foreach my $entry (keys(%roleshash)) {
4199: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4200: if ($trole =~ /^cr/) {
4201: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4202: } else {
4203: next if (!exists($roles{$trole}));
4204: }
4205: if ($tend) {
4206: next if ($tend < $now);
4207: }
4208: if ($tstart) {
4209: next if ($tstart > $now);
4210: }
1.1058 raeburn 4211: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4212: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4213: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4214: if ($secpart eq '') {
4215: ($cnum,$role) = split(/_/,$cnumpart);
4216: $sec = 'none';
1.1058 raeburn 4217: $value .= $cnum.'/';
1.482 raeburn 4218: } else {
4219: $cnum = $cnumpart;
4220: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4221: $value .= $cnum.'/'.$sec;
4222: }
4223: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4224: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4225: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4226: }
4227: } else {
4228: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4229: }
1.482 raeburn 4230: }
4231: } else {
4232: foreach my $key (keys(%env)) {
1.483 albertel 4233: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4234: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4235: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4236: next if ($role eq 'ca' || $role eq 'aa');
4237: next if (%roles && !exists($roles{$role}));
4238: my ($starttime,$endtime)=split(/\./,$env{$key});
4239: my $active=1;
4240: if ($starttime) {
4241: if ($now<$starttime) { $active=0; }
4242: }
4243: if ($endtime) {
4244: if ($now>$endtime) { $active=0; }
4245: }
4246: if ($active) {
1.1058 raeburn 4247: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4248: if ($sec eq '') {
4249: $sec = 'none';
1.1058 raeburn 4250: } else {
4251: $value .= $sec;
4252: }
4253: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4254: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4255: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4256: }
4257: } else {
4258: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4259: }
1.474 raeburn 4260: }
4261: }
1.51 www 4262: }
4263: }
1.474 raeburn 4264: return %courses;
1.51 www 4265: }
1.37 matthew 4266:
1.54 www 4267: ###############################################
1.474 raeburn 4268:
4269: sub blockcheck {
1.1062 raeburn 4270: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4271:
4272: if (!defined($udom)) {
4273: $udom = $env{'user.domain'};
4274: }
4275: if (!defined($uname)) {
4276: $uname = $env{'user.name'};
4277: }
4278:
4279: # If uname and udom are for a course, check for blocks in the course.
4280:
4281: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4282: my ($startblock,$endblock,$triggerblock) =
4283: &get_blocks($setters,$activity,$udom,$uname,$url);
4284: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4285: }
1.474 raeburn 4286:
1.502 raeburn 4287: my $startblock = 0;
4288: my $endblock = 0;
1.1062 raeburn 4289: my $triggerblock = '';
1.482 raeburn 4290: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4291:
1.490 raeburn 4292: # If uname is for a user, and activity is course-specific, i.e.,
4293: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4294:
1.490 raeburn 4295: if (($activity eq 'boards' || $activity eq 'chat' ||
4296: $activity eq 'groups') && ($env{'request.course.id'})) {
4297: foreach my $key (keys(%live_courses)) {
4298: if ($key ne $env{'request.course.id'}) {
4299: delete($live_courses{$key});
4300: }
4301: }
4302: }
4303:
4304: my $otheruser = 0;
4305: my %own_courses;
4306: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4307: # Resource belongs to user other than current user.
4308: $otheruser = 1;
4309: # Gather courses for current user
4310: %own_courses =
4311: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4312: }
4313:
4314: # Gather active course roles - course coordinator, instructor,
4315: # exam proctor, ta, student, or custom role.
1.474 raeburn 4316:
4317: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4318: my ($cdom,$cnum);
4319: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4320: $cdom = $env{'course.'.$course.'.domain'};
4321: $cnum = $env{'course.'.$course.'.num'};
4322: } else {
1.490 raeburn 4323: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4324: }
4325: my $no_ownblock = 0;
4326: my $no_userblock = 0;
1.533 raeburn 4327: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4328: # Check if current user has 'evb' priv for this
4329: if (defined($own_courses{$course})) {
4330: foreach my $sec (keys(%{$own_courses{$course}})) {
4331: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4332: if ($sec ne 'none') {
4333: $checkrole .= '/'.$sec;
4334: }
4335: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4336: $no_ownblock = 1;
4337: last;
4338: }
4339: }
4340: }
4341: # if they have 'evb' priv and are currently not playing student
4342: next if (($no_ownblock) &&
4343: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4344: }
1.474 raeburn 4345: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4346: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4347: if ($sec ne 'none') {
1.482 raeburn 4348: $checkrole .= '/'.$sec;
1.474 raeburn 4349: }
1.490 raeburn 4350: if ($otheruser) {
4351: # Resource belongs to user other than current user.
4352: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4353: my (%allroles,%userroles);
4354: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4355: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4356: my ($trole,$tdom,$tnum,$tsec);
4357: if ($entry =~ /^cr/) {
4358: ($trole,$tdom,$tnum,$tsec) =
4359: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4360: } else {
4361: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4362: }
4363: my ($spec,$area,$trest);
4364: $area = '/'.$tdom.'/'.$tnum;
4365: $trest = $tnum;
4366: if ($tsec ne '') {
4367: $area .= '/'.$tsec;
4368: $trest .= '/'.$tsec;
4369: }
4370: $spec = $trole.'.'.$area;
4371: if ($trole =~ /^cr/) {
4372: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4373: $tdom,$spec,$trest,$area);
4374: } else {
4375: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4376: $tdom,$spec,$trest,$area);
4377: }
4378: }
4379: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4380: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4381: if ($1) {
4382: $no_userblock = 1;
4383: last;
4384: }
1.486 raeburn 4385: }
4386: }
1.490 raeburn 4387: } else {
4388: # Resource belongs to current user
4389: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4390: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4391: $no_ownblock = 1;
4392: last;
4393: }
1.474 raeburn 4394: }
4395: }
4396: # if they have the evb priv and are currently not playing student
1.482 raeburn 4397: next if (($no_ownblock) &&
1.491 albertel 4398: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4399: next if ($no_userblock);
1.474 raeburn 4400:
1.866 kalberla 4401: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4402: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4403:
1.1062 raeburn 4404: my ($start,$end,$trigger) =
4405: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4406: if (($start != 0) &&
4407: (($startblock == 0) || ($startblock > $start))) {
4408: $startblock = $start;
1.1062 raeburn 4409: if ($trigger ne '') {
4410: $triggerblock = $trigger;
4411: }
1.502 raeburn 4412: }
4413: if (($end != 0) &&
4414: (($endblock == 0) || ($endblock < $end))) {
4415: $endblock = $end;
1.1062 raeburn 4416: if ($trigger ne '') {
4417: $triggerblock = $trigger;
4418: }
1.502 raeburn 4419: }
1.490 raeburn 4420: }
1.1062 raeburn 4421: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4422: }
4423:
4424: sub get_blocks {
1.1062 raeburn 4425: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4426: my $startblock = 0;
4427: my $endblock = 0;
1.1062 raeburn 4428: my $triggerblock = '';
1.490 raeburn 4429: my $course = $cdom.'_'.$cnum;
4430: $setters->{$course} = {};
4431: $setters->{$course}{'staff'} = [];
4432: $setters->{$course}{'times'} = [];
1.1062 raeburn 4433: $setters->{$course}{'triggers'} = [];
4434: my (@blockers,%triggered);
4435: my $now = time;
4436: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4437: if ($activity eq 'docs') {
4438: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4439: foreach my $block (@blockers) {
4440: if ($block =~ /^firstaccess____(.+)$/) {
4441: my $item = $1;
4442: my $type = 'map';
4443: my $timersymb = $item;
4444: if ($item eq 'course') {
4445: $type = 'course';
4446: } elsif ($item =~ /___\d+___/) {
4447: $type = 'resource';
4448: } else {
4449: $timersymb = &Apache::lonnet::symbread($item);
4450: }
4451: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4452: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4453: $triggered{$block} = {
4454: start => $start,
4455: end => $end,
4456: type => $type,
4457: };
4458: }
4459: }
4460: } else {
4461: foreach my $block (keys(%commblocks)) {
4462: if ($block =~ m/^(\d+)____(\d+)$/) {
4463: my ($start,$end) = ($1,$2);
4464: if ($start <= time && $end >= time) {
4465: if (ref($commblocks{$block}) eq 'HASH') {
4466: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4467: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4468: unless(grep(/^\Q$block\E$/,@blockers)) {
4469: push(@blockers,$block);
4470: }
4471: }
4472: }
4473: }
4474: }
4475: } elsif ($block =~ /^firstaccess____(.+)$/) {
4476: my $item = $1;
4477: my $timersymb = $item;
4478: my $type = 'map';
4479: if ($item eq 'course') {
4480: $type = 'course';
4481: } elsif ($item =~ /___\d+___/) {
4482: $type = 'resource';
4483: } else {
4484: $timersymb = &Apache::lonnet::symbread($item);
4485: }
4486: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4487: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4488: if ($start && $end) {
4489: if (($start <= time) && ($end >= time)) {
4490: unless (grep(/^\Q$block\E$/,@blockers)) {
4491: push(@blockers,$block);
4492: $triggered{$block} = {
4493: start => $start,
4494: end => $end,
4495: type => $type,
4496: };
4497: }
4498: }
1.490 raeburn 4499: }
1.1062 raeburn 4500: }
4501: }
4502: }
4503: foreach my $blocker (@blockers) {
4504: my ($staff_name,$staff_dom,$title,$blocks) =
4505: &parse_block_record($commblocks{$blocker});
4506: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4507: my ($start,$end,$triggertype);
4508: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4509: ($start,$end) = ($1,$2);
4510: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4511: $start = $triggered{$blocker}{'start'};
4512: $end = $triggered{$blocker}{'end'};
4513: $triggertype = $triggered{$blocker}{'type'};
4514: }
4515: if ($start) {
4516: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4517: if ($triggertype) {
4518: push(@{$$setters{$course}{'triggers'}},$triggertype);
4519: } else {
4520: push(@{$$setters{$course}{'triggers'}},0);
4521: }
4522: if ( ($startblock == 0) || ($startblock > $start) ) {
4523: $startblock = $start;
4524: if ($triggertype) {
4525: $triggerblock = $blocker;
1.474 raeburn 4526: }
4527: }
1.1062 raeburn 4528: if ( ($endblock == 0) || ($endblock < $end) ) {
4529: $endblock = $end;
4530: if ($triggertype) {
4531: $triggerblock = $blocker;
4532: }
4533: }
1.474 raeburn 4534: }
4535: }
1.1062 raeburn 4536: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4537: }
4538:
4539: sub parse_block_record {
4540: my ($record) = @_;
4541: my ($setuname,$setudom,$title,$blocks);
4542: if (ref($record) eq 'HASH') {
4543: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4544: $title = &unescape($record->{'event'});
4545: $blocks = $record->{'blocks'};
4546: } else {
4547: my @data = split(/:/,$record,3);
4548: if (scalar(@data) eq 2) {
4549: $title = $data[1];
4550: ($setuname,$setudom) = split(/@/,$data[0]);
4551: } else {
4552: ($setuname,$setudom,$title) = @data;
4553: }
4554: $blocks = { 'com' => 'on' };
4555: }
4556: return ($setuname,$setudom,$title,$blocks);
4557: }
4558:
1.854 kalberla 4559: sub blocking_status {
1.1062 raeburn 4560: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4561: my %setters;
1.890 droeschl 4562:
1.1061 raeburn 4563: # check for active blocking
1.1062 raeburn 4564: my ($startblock,$endblock,$triggerblock) =
4565: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4566: my $blocked = 0;
4567: if ($startblock && $endblock) {
4568: $blocked = 1;
4569: }
1.890 droeschl 4570:
1.1061 raeburn 4571: # caller just wants to know whether a block is active
4572: if (!wantarray) { return $blocked; }
4573:
4574: # build a link to a popup window containing the details
4575: my $querystring = "?activity=$activity";
4576: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4577: if ($activity eq 'port') {
4578: $querystring .= "&udom=$udom" if $udom;
4579: $querystring .= "&uname=$uname" if $uname;
4580: } elsif ($activity eq 'docs') {
4581: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4582: }
1.1061 raeburn 4583:
4584: my $output .= <<'END_MYBLOCK';
4585: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4586: var options = "width=" + w + ",height=" + h + ",";
4587: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4588: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4589: var newWin = window.open(url, wdwName, options);
4590: newWin.focus();
4591: }
1.890 droeschl 4592: END_MYBLOCK
1.854 kalberla 4593:
1.1061 raeburn 4594: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4595:
1.1061 raeburn 4596: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4597: my $text = &mt('Communication Blocked');
4598: if ($activity eq 'docs') {
4599: $text = &mt('Content Access Blocked');
1.1063 raeburn 4600: } elsif ($activity eq 'printout') {
4601: $text = &mt('Printing Blocked');
1.1062 raeburn 4602: }
1.1061 raeburn 4603: $output .= <<"END_BLOCK";
1.867 kalberla 4604: <div class='LC_comblock'>
1.869 kalberla 4605: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4606: title='$text'>
4607: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4608: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4609: title='$text'>$text</a>
1.867 kalberla 4610: </div>
4611:
4612: END_BLOCK
1.474 raeburn 4613:
1.1061 raeburn 4614: return ($blocked, $output);
1.854 kalberla 4615: }
1.490 raeburn 4616:
1.60 matthew 4617: ###############################################
4618:
1.682 raeburn 4619: sub check_ip_acc {
4620: my ($acc)=@_;
4621: &Apache::lonxml::debug("acc is $acc");
4622: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4623: return 1;
4624: }
4625: my $allowed=0;
4626: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4627:
4628: my $name;
4629: foreach my $pattern (split(',',$acc)) {
4630: $pattern =~ s/^\s*//;
4631: $pattern =~ s/\s*$//;
4632: if ($pattern =~ /\*$/) {
4633: #35.8.*
4634: $pattern=~s/\*//;
4635: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4636: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4637: #35.8.3.[34-56]
4638: my $low=$2;
4639: my $high=$3;
4640: $pattern=$1;
4641: if ($ip =~ /^\Q$pattern\E/) {
4642: my $last=(split(/\./,$ip))[3];
4643: if ($last <=$high && $last >=$low) { $allowed=1; }
4644: }
4645: } elsif ($pattern =~ /^\*/) {
4646: #*.msu.edu
4647: $pattern=~s/\*//;
4648: if (!defined($name)) {
4649: use Socket;
4650: my $netaddr=inet_aton($ip);
4651: ($name)=gethostbyaddr($netaddr,AF_INET);
4652: }
4653: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4654: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4655: #127.0.0.1
4656: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4657: } else {
4658: #some.name.com
4659: if (!defined($name)) {
4660: use Socket;
4661: my $netaddr=inet_aton($ip);
4662: ($name)=gethostbyaddr($netaddr,AF_INET);
4663: }
4664: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4665: }
4666: if ($allowed) { last; }
4667: }
4668: return $allowed;
4669: }
4670:
4671: ###############################################
4672:
1.60 matthew 4673: =pod
4674:
1.112 bowersj2 4675: =head1 Domain Template Functions
4676:
4677: =over 4
4678:
4679: =item * &determinedomain()
1.60 matthew 4680:
4681: Inputs: $domain (usually will be undef)
4682:
1.63 www 4683: Returns: Determines which domain should be used for designs
1.60 matthew 4684:
4685: =cut
1.54 www 4686:
1.60 matthew 4687: ###############################################
1.63 www 4688: sub determinedomain {
4689: my $domain=shift;
1.531 albertel 4690: if (! $domain) {
1.60 matthew 4691: # Determine domain if we have not been given one
1.893 raeburn 4692: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4693: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4694: if ($env{'request.role.domain'}) {
4695: $domain=$env{'request.role.domain'};
1.60 matthew 4696: }
4697: }
1.63 www 4698: return $domain;
4699: }
4700: ###############################################
1.517 raeburn 4701:
1.518 albertel 4702: sub devalidate_domconfig_cache {
4703: my ($udom)=@_;
4704: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4705: }
4706:
4707: # ---------------------- Get domain configuration for a domain
4708: sub get_domainconf {
4709: my ($udom) = @_;
4710: my $cachetime=1800;
4711: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4712: if (defined($cached)) { return %{$result}; }
4713:
4714: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4715: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4716: my (%designhash,%legacy);
1.518 albertel 4717: if (keys(%domconfig) > 0) {
4718: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4719: if (keys(%{$domconfig{'login'}})) {
4720: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4721: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4722: if ($key eq 'loginvia') {
4723: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4724: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4725: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4726: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4727: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4728: $designhash{$udom.'.login.loginvia'} = $server;
4729: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4730:
4731: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4732: } else {
1.1013 raeburn 4733: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4734: }
4735: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4736: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4737: }
1.946 raeburn 4738: }
4739: }
4740: }
4741: }
4742: } else {
4743: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4744: $designhash{$udom.'.login.'.$key.'_'.$img} =
4745: $domconfig{'login'}{$key}{$img};
4746: }
1.699 raeburn 4747: }
4748: } else {
4749: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4750: }
1.632 raeburn 4751: }
4752: } else {
4753: $legacy{'login'} = 1;
1.518 albertel 4754: }
1.632 raeburn 4755: } else {
4756: $legacy{'login'} = 1;
1.518 albertel 4757: }
4758: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4759: if (keys(%{$domconfig{'rolecolors'}})) {
4760: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4761: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4762: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4763: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4764: }
1.518 albertel 4765: }
4766: }
1.632 raeburn 4767: } else {
4768: $legacy{'rolecolors'} = 1;
1.518 albertel 4769: }
1.632 raeburn 4770: } else {
4771: $legacy{'rolecolors'} = 1;
1.518 albertel 4772: }
1.948 raeburn 4773: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4774: if ($domconfig{'autoenroll'}{'co-owners'}) {
4775: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4776: }
4777: }
1.632 raeburn 4778: if (keys(%legacy) > 0) {
4779: my %legacyhash = &get_legacy_domconf($udom);
4780: foreach my $item (keys(%legacyhash)) {
4781: if ($item =~ /^\Q$udom\E\.login/) {
4782: if ($legacy{'login'}) {
4783: $designhash{$item} = $legacyhash{$item};
4784: }
4785: } else {
4786: if ($legacy{'rolecolors'}) {
4787: $designhash{$item} = $legacyhash{$item};
4788: }
1.518 albertel 4789: }
4790: }
4791: }
1.632 raeburn 4792: } else {
4793: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4794: }
4795: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4796: $cachetime);
4797: return %designhash;
4798: }
4799:
1.632 raeburn 4800: sub get_legacy_domconf {
4801: my ($udom) = @_;
4802: my %legacyhash;
4803: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4804: my $designfile = $designdir.'/'.$udom.'.tab';
4805: if (-e $designfile) {
4806: if ( open (my $fh,"<$designfile") ) {
4807: while (my $line = <$fh>) {
4808: next if ($line =~ /^\#/);
4809: chomp($line);
4810: my ($key,$val)=(split(/\=/,$line));
4811: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4812: }
4813: close($fh);
4814: }
4815: }
1.1026 raeburn 4816: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4817: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4818: }
4819: return %legacyhash;
4820: }
4821:
1.63 www 4822: =pod
4823:
1.112 bowersj2 4824: =item * &domainlogo()
1.63 www 4825:
4826: Inputs: $domain (usually will be undef)
4827:
4828: Returns: A link to a domain logo, if the domain logo exists.
4829: If the domain logo does not exist, a description of the domain.
4830:
4831: =cut
1.112 bowersj2 4832:
1.63 www 4833: ###############################################
4834: sub domainlogo {
1.517 raeburn 4835: my $domain = &determinedomain(shift);
1.518 albertel 4836: my %designhash = &get_domainconf($domain);
1.517 raeburn 4837: # See if there is a logo
4838: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4839: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4840: if ($imgsrc =~ m{^/(adm|res)/}) {
4841: if ($imgsrc =~ m{^/res/}) {
4842: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4843: &Apache::lonnet::repcopy($local_name);
4844: }
4845: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4846: }
4847: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4848: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4849: return &Apache::lonnet::domain($domain,'description');
1.59 www 4850: } else {
1.60 matthew 4851: return '';
1.59 www 4852: }
4853: }
1.63 www 4854: ##############################################
4855:
4856: =pod
4857:
1.112 bowersj2 4858: =item * &designparm()
1.63 www 4859:
4860: Inputs: $which parameter; $domain (usually will be undef)
4861:
4862: Returns: value of designparamter $which
4863:
4864: =cut
1.112 bowersj2 4865:
1.397 albertel 4866:
1.400 albertel 4867: ##############################################
1.397 albertel 4868: sub designparm {
4869: my ($which,$domain)=@_;
4870: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4871: return $env{'environment.color.'.$which};
1.96 www 4872: }
1.63 www 4873: $domain=&determinedomain($domain);
1.1016 raeburn 4874: my %domdesign;
4875: unless ($domain eq 'public') {
4876: %domdesign = &get_domainconf($domain);
4877: }
1.520 raeburn 4878: my $output;
1.517 raeburn 4879: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4880: $output = $domdesign{$domain.'.'.$which};
1.63 www 4881: } else {
1.520 raeburn 4882: $output = $defaultdesign{$which};
4883: }
4884: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4885: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4886: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4887: if ($output =~ m{^/res/}) {
4888: my $local_name = &Apache::lonnet::filelocation('',$output);
4889: &Apache::lonnet::repcopy($local_name);
4890: }
1.520 raeburn 4891: $output = &lonhttpdurl($output);
4892: }
1.63 www 4893: }
1.520 raeburn 4894: return $output;
1.63 www 4895: }
1.59 www 4896:
1.822 bisitz 4897: ##############################################
4898: =pod
4899:
1.832 bisitz 4900: =item * &authorspace()
4901:
1.1028 raeburn 4902: Inputs: $url (usually will be undef).
1.832 bisitz 4903:
1.1028 raeburn 4904: Returns: Path to Construction Space containing the resource or
4905: directory being viewed (or for which action is being taken).
4906: If $url is provided, and begins /priv/<domain>/<uname>
4907: the path will be that portion of the $context argument.
4908: Otherwise the path will be for the author space of the current
4909: user when the current role is author, or for that of the
4910: co-author/assistant co-author space when the current role
4911: is co-author or assistant co-author.
1.832 bisitz 4912:
4913: =cut
4914:
4915: sub authorspace {
1.1028 raeburn 4916: my ($url) = @_;
4917: if ($url ne '') {
4918: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4919: return $1;
4920: }
4921: }
1.832 bisitz 4922: my $caname = '';
1.1024 www 4923: my $cadom = '';
1.1028 raeburn 4924: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4925: ($cadom,$caname) =
1.832 bisitz 4926: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4927: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4928: $caname = $env{'user.name'};
1.1024 www 4929: $cadom = $env{'user.domain'};
1.832 bisitz 4930: }
1.1028 raeburn 4931: if (($caname ne '') && ($cadom ne '')) {
4932: return "/priv/$cadom/$caname/";
4933: }
4934: return;
1.832 bisitz 4935: }
4936:
4937: ##############################################
4938: =pod
4939:
1.822 bisitz 4940: =item * &head_subbox()
4941:
4942: Inputs: $content (contains HTML code with page functions, etc.)
4943:
4944: Returns: HTML div with $content
4945: To be included in page header
4946:
4947: =cut
4948:
4949: sub head_subbox {
4950: my ($content)=@_;
4951: my $output =
1.993 raeburn 4952: '<div class="LC_head_subbox">'
1.822 bisitz 4953: .$content
4954: .'</div>'
4955: }
4956:
4957: ##############################################
4958: =pod
4959:
4960: =item * &CSTR_pageheader()
4961:
1.1026 raeburn 4962: Input: (optional) filename from which breadcrumb trail is built.
4963: In most cases no input as needed, as $env{'request.filename'}
4964: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4965:
4966: Returns: HTML div with CSTR path and recent box
4967: To be included on Construction Space pages
4968:
4969: =cut
4970:
4971: sub CSTR_pageheader {
1.1026 raeburn 4972: my ($trailfile) = @_;
4973: if ($trailfile eq '') {
4974: $trailfile = $env{'request.filename'};
4975: }
4976:
4977: # this is for resources; directories have customtitle, and crumbs
4978: # and select recent are created in lonpubdir.pm
4979:
4980: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4981: my ($udom,$uname,$thisdisfn)=
1.1026 raeburn 4982: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
4983: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4984: $formaction =~ s{/+}{/}g;
1.822 bisitz 4985:
4986: my $parentpath = '';
4987: my $lastitem = '';
4988: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4989: $parentpath = $1;
4990: $lastitem = $2;
4991: } else {
4992: $lastitem = $thisdisfn;
4993: }
1.921 bisitz 4994:
4995: my $output =
1.822 bisitz 4996: '<div>'
4997: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4998: .'<b>'.&mt('Construction Space:').'</b> '
4999: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5000: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5001: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5002:
5003: if ($lastitem) {
5004: $output .=
5005: '<span class="LC_filename">'
5006: .$lastitem
5007: .'</span>';
5008: }
5009: $output .=
5010: '<br />'
1.822 bisitz 5011: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5012: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5013: .'</form>'
5014: .&Apache::lonmenu::constspaceform()
5015: .'</div>';
1.921 bisitz 5016:
5017: return $output;
1.822 bisitz 5018: }
5019:
1.60 matthew 5020: ###############################################
5021: ###############################################
5022:
5023: =pod
5024:
1.112 bowersj2 5025: =back
5026:
1.549 albertel 5027: =head1 HTML Helpers
1.112 bowersj2 5028:
5029: =over 4
5030:
5031: =item * &bodytag()
1.60 matthew 5032:
5033: Returns a uniform header for LON-CAPA web pages.
5034:
5035: Inputs:
5036:
1.112 bowersj2 5037: =over 4
5038:
5039: =item * $title, A title to be displayed on the page.
5040:
5041: =item * $function, the current role (can be undef).
5042:
5043: =item * $addentries, extra parameters for the <body> tag.
5044:
5045: =item * $bodyonly, if defined, only return the <body> tag.
5046:
5047: =item * $domain, if defined, force a given domain.
5048:
5049: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5050: text interface only)
1.60 matthew 5051:
1.814 bisitz 5052: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5053: navigational links
1.317 albertel 5054:
1.338 albertel 5055: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5056:
1.460 albertel 5057: =item * $args, optional argument valid values are
5058: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 5059: inherit_jsmath -> when creating popup window in a page,
5060: should it have jsmath forced on by the
5061: current page
1.460 albertel 5062:
1.112 bowersj2 5063: =back
5064:
1.60 matthew 5065: Returns: A uniform header for LON-CAPA web pages.
5066: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5067: If $bodyonly is undef or zero, an html string containing a <body> tag and
5068: other decorations will be returned.
5069:
5070: =cut
5071:
1.54 www 5072: sub bodytag {
1.831 bisitz 5073: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 5074: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 5075:
1.954 raeburn 5076: my $public;
5077: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5078: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5079: $public = 1;
5080: }
1.460 albertel 5081: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 5082:
1.183 matthew 5083: $function = &get_users_function() if (!$function);
1.339 albertel 5084: my $img = &designparm($function.'.img',$domain);
5085: my $font = &designparm($function.'.font',$domain);
5086: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5087:
1.803 bisitz 5088: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5089: 'bgcolor' => $pgbg,
1.339 albertel 5090: 'text' => $font,
5091: 'alink' => &designparm($function.'.alink',$domain),
5092: 'vlink' => &designparm($function.'.vlink',$domain),
5093: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5094: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5095:
1.63 www 5096: # role and realm
1.378 raeburn 5097: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5098: if ($role eq 'ca') {
1.479 albertel 5099: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5100: $realm = &plainname($rname,$rdom);
1.378 raeburn 5101: }
1.55 www 5102: # realm
1.258 albertel 5103: if ($env{'request.course.id'}) {
1.378 raeburn 5104: if ($env{'request.role'} !~ /^cr/) {
5105: $role = &Apache::lonnet::plaintext($role,&course_type());
5106: }
1.898 raeburn 5107: if ($env{'request.course.sec'}) {
5108: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5109: }
1.359 albertel 5110: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5111: } else {
5112: $role = &Apache::lonnet::plaintext($role);
1.54 www 5113: }
1.433 albertel 5114:
1.359 albertel 5115: if (!$realm) { $realm=' '; }
1.330 albertel 5116:
1.438 albertel 5117: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5118:
1.101 www 5119: # construct main body tag
1.359 albertel 5120: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5121: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5122:
1.530 albertel 5123: if ($bodyonly) {
1.60 matthew 5124: return $bodytag;
1.798 tempelho 5125: }
1.359 albertel 5126:
1.410 albertel 5127: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5128: if ($public) {
1.433 albertel 5129: undef($role);
1.434 albertel 5130: } else {
1.1070 raeburn 5131: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5132: undef,'LC_menubuttons_link');
1.433 albertel 5133: }
1.359 albertel 5134:
1.762 bisitz 5135: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5136: #
5137: # Extra info if you are the DC
5138: my $dc_info = '';
5139: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5140: $env{'course.'.$env{'request.course.id'}.
5141: '.domain'}.'/'})) {
5142: my $cid = $env{'request.course.id'};
1.917 raeburn 5143: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5144: $dc_info =~ s/\s+$//;
1.359 albertel 5145: }
5146:
1.898 raeburn 5147: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5148: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5149:
1.916 droeschl 5150: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
5151: return $bodytag;
5152: }
1.903 droeschl 5153:
5154: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5155:
5156: # if ($env{'request.state'} eq 'construct') {
5157: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5158: # }
5159:
1.359 albertel 5160:
5161:
1.916 droeschl 5162: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5163: if ($dc_info) {
5164: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5165: }
1.916 droeschl 5166: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5167: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5168: return $bodytag;
5169: }
1.894 droeschl 5170:
1.927 raeburn 5171: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5172: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5173: }
1.916 droeschl 5174:
1.903 droeschl 5175: $bodytag .= Apache::lonhtmlcommon::scripttag(
5176: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5177:
1.903 droeschl 5178: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5179:
1.917 raeburn 5180: if ($dc_info) {
5181: $dc_info = &dc_courseid_toggle($dc_info);
5182: }
5183: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5184:
1.903 droeschl 5185: #don't show menus for public users
1.954 raeburn 5186: if (!$public){
1.903 droeschl 5187: $bodytag .= Apache::lonmenu::secondary_menu();
5188: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5189: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5190: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5191: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5192: $args->{'bread_crumbs'});
5193: } elsif ($forcereg) {
5194: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
5195: }
1.903 droeschl 5196: }else{
5197: # this is to seperate menu from content when there's no secondary
5198: # menu. Especially needed for public accessible ressources.
5199: $bodytag .= '<hr style="clear:both" />';
5200: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5201: }
1.903 droeschl 5202:
1.235 raeburn 5203: return $bodytag;
1.182 matthew 5204: }
5205:
1.917 raeburn 5206: sub dc_courseid_toggle {
5207: my ($dc_info) = @_;
1.980 raeburn 5208: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5209: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5210: &mt('(More ...)').'</a></span>'.
5211: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5212: }
5213:
1.330 albertel 5214: sub make_attr_string {
5215: my ($register,$attr_ref) = @_;
5216:
5217: if ($attr_ref && !ref($attr_ref)) {
5218: die("addentries Must be a hash ref ".
5219: join(':',caller(1))." ".
5220: join(':',caller(0))." ");
5221: }
5222:
5223: if ($register) {
1.339 albertel 5224: my ($on_load,$on_unload);
5225: foreach my $key (keys(%{$attr_ref})) {
5226: if (lc($key) eq 'onload') {
5227: $on_load.=$attr_ref->{$key}.';';
5228: delete($attr_ref->{$key});
5229:
5230: } elsif (lc($key) eq 'onunload') {
5231: $on_unload.=$attr_ref->{$key}.';';
5232: delete($attr_ref->{$key});
5233: }
5234: }
1.953 droeschl 5235: $attr_ref->{'onload'} = $on_load;
5236: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5237: }
1.339 albertel 5238:
1.330 albertel 5239: my $attr_string;
5240: foreach my $attr (keys(%$attr_ref)) {
5241: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5242: }
5243: return $attr_string;
5244: }
5245:
5246:
1.182 matthew 5247: ###############################################
1.251 albertel 5248: ###############################################
5249:
5250: =pod
5251:
5252: =item * &endbodytag()
5253:
5254: Returns a uniform footer for LON-CAPA web pages.
5255:
1.635 raeburn 5256: Inputs: 1 - optional reference to an args hash
5257: If in the hash, key for noredirectlink has a value which evaluates to true,
5258: a 'Continue' link is not displayed if the page contains an
5259: internal redirect in the <head></head> section,
5260: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5261:
5262: =cut
5263:
5264: sub endbodytag {
1.635 raeburn 5265: my ($args) = @_;
1.1080 raeburn 5266: my $endbodytag;
5267: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5268: $endbodytag='</body>';
5269: }
1.269 albertel 5270: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5271: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5272: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5273: $endbodytag=
5274: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5275: &mt('Continue').'</a>'.
5276: $endbodytag;
5277: }
1.315 albertel 5278: }
1.251 albertel 5279: return $endbodytag;
5280: }
5281:
1.352 albertel 5282: =pod
5283:
5284: =item * &standard_css()
5285:
5286: Returns a style sheet
5287:
5288: Inputs: (all optional)
5289: domain -> force to color decorate a page for a specific
5290: domain
5291: function -> force usage of a specific rolish color scheme
5292: bgcolor -> override the default page bgcolor
5293:
5294: =cut
5295:
1.343 albertel 5296: sub standard_css {
1.345 albertel 5297: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5298: $function = &get_users_function() if (!$function);
5299: my $img = &designparm($function.'.img', $domain);
5300: my $tabbg = &designparm($function.'.tabbg', $domain);
5301: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5302: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5303: #second colour for later usage
1.345 albertel 5304: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5305: my $pgbg_or_bgcolor =
5306: $bgcolor ||
1.352 albertel 5307: &designparm($function.'.pgbg', $domain);
1.382 albertel 5308: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5309: my $alink = &designparm($function.'.alink', $domain);
5310: my $vlink = &designparm($function.'.vlink', $domain);
5311: my $link = &designparm($function.'.link', $domain);
5312:
1.602 albertel 5313: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5314: my $mono = 'monospace';
1.850 bisitz 5315: my $data_table_head = $sidebg;
5316: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5317: my $data_table_dark = '#E0E0E0';
1.470 banghart 5318: my $data_table_darker = '#CCCCCC';
1.349 albertel 5319: my $data_table_highlight = '#FFFF00';
1.352 albertel 5320: my $mail_new = '#FFBB77';
5321: my $mail_new_hover = '#DD9955';
5322: my $mail_read = '#BBBB77';
5323: my $mail_read_hover = '#999944';
5324: my $mail_replied = '#AAAA88';
5325: my $mail_replied_hover = '#888855';
5326: my $mail_other = '#99BBBB';
5327: my $mail_other_hover = '#669999';
1.391 albertel 5328: my $table_header = '#DDDDDD';
1.489 raeburn 5329: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5330: my $lg_border_color = '#C8C8C8';
1.952 onken 5331: my $button_hover = '#BF2317';
1.392 albertel 5332:
1.608 albertel 5333: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5334: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5335: : '0 3px 0 4px';
1.448 albertel 5336:
1.523 albertel 5337:
1.343 albertel 5338: return <<END;
1.947 droeschl 5339:
5340: /* needed for iframe to allow 100% height in FF */
5341: body, html {
5342: margin: 0;
5343: padding: 0 0.5%;
5344: height: 99%; /* to avoid scrollbars */
5345: }
5346:
1.795 www 5347: body {
1.911 bisitz 5348: font-family: $sans;
5349: line-height:130%;
5350: font-size:0.83em;
5351: color:$font;
1.795 www 5352: }
5353:
1.959 onken 5354: a:focus,
5355: a:focus img {
1.795 www 5356: color: red;
5357: }
1.698 harmsja 5358:
1.911 bisitz 5359: form, .inline {
5360: display: inline;
1.795 www 5361: }
1.721 harmsja 5362:
1.795 www 5363: .LC_right {
1.911 bisitz 5364: text-align:right;
1.795 www 5365: }
5366:
5367: .LC_middle {
1.911 bisitz 5368: vertical-align:middle;
1.795 www 5369: }
1.721 harmsja 5370:
1.911 bisitz 5371: .LC_400Box {
5372: width:400px;
5373: }
1.721 harmsja 5374:
1.947 droeschl 5375: .LC_iframecontainer {
5376: width: 98%;
5377: margin: 0;
5378: position: fixed;
5379: top: 8.5em;
5380: bottom: 0;
5381: }
5382:
5383: .LC_iframecontainer iframe{
5384: border: none;
5385: width: 100%;
5386: height: 100%;
5387: }
5388:
1.778 bisitz 5389: .LC_filename {
5390: font-family: $mono;
5391: white-space:pre;
1.921 bisitz 5392: font-size: 120%;
1.778 bisitz 5393: }
5394:
5395: .LC_fileicon {
5396: border: none;
5397: height: 1.3em;
5398: vertical-align: text-bottom;
5399: margin-right: 0.3em;
5400: text-decoration:none;
5401: }
5402:
1.1008 www 5403: .LC_setting {
5404: text-decoration:underline;
5405: }
5406:
1.350 albertel 5407: .LC_error {
5408: color: red;
5409: font-size: larger;
5410: }
1.795 www 5411:
1.457 albertel 5412: .LC_warning,
5413: .LC_diff_removed {
1.733 bisitz 5414: color: red;
1.394 albertel 5415: }
1.532 albertel 5416:
5417: .LC_info,
1.457 albertel 5418: .LC_success,
5419: .LC_diff_added {
1.350 albertel 5420: color: green;
5421: }
1.795 www 5422:
1.802 bisitz 5423: div.LC_confirm_box {
5424: background-color: #FAFAFA;
5425: border: 1px solid $lg_border_color;
5426: margin-right: 0;
5427: padding: 5px;
5428: }
5429:
5430: div.LC_confirm_box .LC_error img,
5431: div.LC_confirm_box .LC_success img {
5432: vertical-align: middle;
5433: }
5434:
1.440 albertel 5435: .LC_icon {
1.771 droeschl 5436: border: none;
1.790 droeschl 5437: vertical-align: middle;
1.771 droeschl 5438: }
5439:
1.543 albertel 5440: .LC_docs_spacer {
5441: width: 25px;
5442: height: 1px;
1.771 droeschl 5443: border: none;
1.543 albertel 5444: }
1.346 albertel 5445:
1.532 albertel 5446: .LC_internal_info {
1.735 bisitz 5447: color: #999999;
1.532 albertel 5448: }
5449:
1.794 www 5450: .LC_discussion {
1.1050 www 5451: background: $data_table_dark;
1.911 bisitz 5452: border: 1px solid black;
5453: margin: 2px;
1.794 www 5454: }
5455:
5456: .LC_disc_action_left {
1.1050 www 5457: background: $sidebg;
1.911 bisitz 5458: text-align: left;
1.1050 www 5459: padding: 4px;
5460: margin: 2px;
1.794 www 5461: }
5462:
5463: .LC_disc_action_right {
1.1050 www 5464: background: $sidebg;
1.911 bisitz 5465: text-align: right;
1.1050 www 5466: padding: 4px;
5467: margin: 2px;
1.794 www 5468: }
5469:
5470: .LC_disc_new_item {
1.911 bisitz 5471: background: white;
5472: border: 2px solid red;
1.1050 www 5473: margin: 4px;
5474: padding: 4px;
1.794 www 5475: }
5476:
5477: .LC_disc_old_item {
1.911 bisitz 5478: background: white;
1.1050 www 5479: margin: 4px;
5480: padding: 4px;
1.794 www 5481: }
5482:
1.458 albertel 5483: table.LC_pastsubmission {
5484: border: 1px solid black;
5485: margin: 2px;
5486: }
5487:
1.924 bisitz 5488: table#LC_menubuttons {
1.345 albertel 5489: width: 100%;
5490: background: $pgbg;
1.392 albertel 5491: border: 2px;
1.402 albertel 5492: border-collapse: separate;
1.803 bisitz 5493: padding: 0;
1.345 albertel 5494: }
1.392 albertel 5495:
1.801 tempelho 5496: table#LC_title_bar a {
5497: color: $fontmenu;
5498: }
1.836 bisitz 5499:
1.807 droeschl 5500: table#LC_title_bar {
1.819 tempelho 5501: clear: both;
1.836 bisitz 5502: display: none;
1.807 droeschl 5503: }
5504:
1.795 www 5505: table#LC_title_bar,
1.933 droeschl 5506: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5507: table#LC_title_bar.LC_with_remote {
1.359 albertel 5508: width: 100%;
1.392 albertel 5509: border-color: $pgbg;
5510: border-style: solid;
5511: border-width: $border;
1.379 albertel 5512: background: $pgbg;
1.801 tempelho 5513: color: $fontmenu;
1.392 albertel 5514: border-collapse: collapse;
1.803 bisitz 5515: padding: 0;
1.819 tempelho 5516: margin: 0;
1.359 albertel 5517: }
1.795 www 5518:
1.933 droeschl 5519: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5520: margin: 0;
5521: padding: 0;
1.933 droeschl 5522: position: relative;
5523: list-style: none;
1.913 droeschl 5524: }
1.933 droeschl 5525: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5526: display: inline;
5527: }
1.933 droeschl 5528:
5529: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5530: padding: 0;
1.933 droeschl 5531: margin: 0;
5532: float: left;
1.913 droeschl 5533: }
1.933 droeschl 5534: .LC_breadcrumb_tools_tools {
5535: padding: 0;
5536: margin: 0;
1.913 droeschl 5537: float: right;
5538: }
5539:
1.359 albertel 5540: table#LC_title_bar td {
5541: background: $tabbg;
5542: }
1.795 www 5543:
1.911 bisitz 5544: table#LC_menubuttons img {
1.803 bisitz 5545: border: none;
1.346 albertel 5546: }
1.795 www 5547:
1.842 droeschl 5548: .LC_breadcrumbs_component {
1.911 bisitz 5549: float: right;
5550: margin: 0 1em;
1.357 albertel 5551: }
1.842 droeschl 5552: .LC_breadcrumbs_component img {
1.911 bisitz 5553: vertical-align: middle;
1.777 tempelho 5554: }
1.795 www 5555:
1.383 albertel 5556: td.LC_table_cell_checkbox {
5557: text-align: center;
5558: }
1.795 www 5559:
5560: .LC_fontsize_small {
1.911 bisitz 5561: font-size: 70%;
1.705 tempelho 5562: }
5563:
1.844 bisitz 5564: #LC_breadcrumbs {
1.911 bisitz 5565: clear:both;
5566: background: $sidebg;
5567: border-bottom: 1px solid $lg_border_color;
5568: line-height: 2.5em;
1.933 droeschl 5569: overflow: hidden;
1.911 bisitz 5570: margin: 0;
5571: padding: 0;
1.995 raeburn 5572: text-align: left;
1.819 tempelho 5573: }
1.862 bisitz 5574:
1.993 raeburn 5575: .LC_head_subbox {
1.911 bisitz 5576: clear:both;
5577: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5578: border: 1px solid $sidebg;
5579: margin: 0 0 10px 0;
1.966 bisitz 5580: padding: 3px;
1.995 raeburn 5581: text-align: left;
1.822 bisitz 5582: }
5583:
1.795 www 5584: .LC_fontsize_medium {
1.911 bisitz 5585: font-size: 85%;
1.705 tempelho 5586: }
5587:
1.795 www 5588: .LC_fontsize_large {
1.911 bisitz 5589: font-size: 120%;
1.705 tempelho 5590: }
5591:
1.346 albertel 5592: .LC_menubuttons_inline_text {
5593: color: $font;
1.698 harmsja 5594: font-size: 90%;
1.701 harmsja 5595: padding-left:3px;
1.346 albertel 5596: }
5597:
1.934 droeschl 5598: .LC_menubuttons_inline_text img{
5599: vertical-align: middle;
5600: }
5601:
1.1051 www 5602: li.LC_menubuttons_inline_text img {
1.951 onken 5603: cursor:pointer;
1.1002 droeschl 5604: text-decoration: none;
1.951 onken 5605: }
5606:
1.526 www 5607: .LC_menubuttons_link {
5608: text-decoration: none;
5609: }
1.795 www 5610:
1.522 albertel 5611: .LC_menubuttons_category {
1.521 www 5612: color: $font;
1.526 www 5613: background: $pgbg;
1.521 www 5614: font-size: larger;
5615: font-weight: bold;
5616: }
5617:
1.346 albertel 5618: td.LC_menubuttons_text {
1.911 bisitz 5619: color: $font;
1.346 albertel 5620: }
1.706 harmsja 5621:
1.346 albertel 5622: .LC_current_location {
5623: background: $tabbg;
5624: }
1.795 www 5625:
1.938 bisitz 5626: table.LC_data_table {
1.347 albertel 5627: border: 1px solid #000000;
1.402 albertel 5628: border-collapse: separate;
1.426 albertel 5629: border-spacing: 1px;
1.610 albertel 5630: background: $pgbg;
1.347 albertel 5631: }
1.795 www 5632:
1.422 albertel 5633: .LC_data_table_dense {
5634: font-size: small;
5635: }
1.795 www 5636:
1.507 raeburn 5637: table.LC_nested_outer {
5638: border: 1px solid #000000;
1.589 raeburn 5639: border-collapse: collapse;
1.803 bisitz 5640: border-spacing: 0;
1.507 raeburn 5641: width: 100%;
5642: }
1.795 www 5643:
1.879 raeburn 5644: table.LC_innerpickbox,
1.507 raeburn 5645: table.LC_nested {
1.803 bisitz 5646: border: none;
1.589 raeburn 5647: border-collapse: collapse;
1.803 bisitz 5648: border-spacing: 0;
1.507 raeburn 5649: width: 100%;
5650: }
1.795 www 5651:
1.911 bisitz 5652: table.LC_data_table tr th,
5653: table.LC_calendar tr th,
1.879 raeburn 5654: table.LC_prior_tries tr th,
5655: table.LC_innerpickbox tr th {
1.349 albertel 5656: font-weight: bold;
5657: background-color: $data_table_head;
1.801 tempelho 5658: color:$fontmenu;
1.701 harmsja 5659: font-size:90%;
1.347 albertel 5660: }
1.795 www 5661:
1.879 raeburn 5662: table.LC_innerpickbox tr th,
5663: table.LC_innerpickbox tr td {
5664: vertical-align: top;
5665: }
5666:
1.711 raeburn 5667: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5668: background-color: #CCCCCC;
1.711 raeburn 5669: font-weight: bold;
5670: text-align: left;
5671: }
1.795 www 5672:
1.912 bisitz 5673: table.LC_data_table tr.LC_odd_row > td {
5674: background-color: $data_table_light;
5675: padding: 2px;
5676: vertical-align: top;
5677: }
5678:
1.809 bisitz 5679: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5680: background-color: $data_table_light;
1.912 bisitz 5681: vertical-align: top;
5682: }
5683:
5684: table.LC_data_table tr.LC_even_row > td {
5685: background-color: $data_table_dark;
1.425 albertel 5686: padding: 2px;
1.900 bisitz 5687: vertical-align: top;
1.347 albertel 5688: }
1.795 www 5689:
1.809 bisitz 5690: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5691: background-color: $data_table_dark;
1.900 bisitz 5692: vertical-align: top;
1.347 albertel 5693: }
1.795 www 5694:
1.425 albertel 5695: table.LC_data_table tr.LC_data_table_highlight td {
5696: background-color: $data_table_darker;
5697: }
1.795 www 5698:
1.639 raeburn 5699: table.LC_data_table tr td.LC_leftcol_header {
5700: background-color: $data_table_head;
5701: font-weight: bold;
5702: }
1.795 www 5703:
1.451 albertel 5704: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5705: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5706: font-weight: bold;
5707: font-style: italic;
5708: text-align: center;
5709: padding: 8px;
1.347 albertel 5710: }
1.795 www 5711:
1.940 bisitz 5712: table.LC_data_table tr.LC_empty_row td {
5713: background-color: $sidebg;
5714: }
5715:
5716: table.LC_nested tr.LC_empty_row td {
5717: background-color: #FFFFFF;
5718: }
5719:
1.890 droeschl 5720: table.LC_caption {
5721: }
5722:
1.507 raeburn 5723: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5724: padding: 4ex
5725: }
1.795 www 5726:
1.507 raeburn 5727: table.LC_nested_outer tr th {
5728: font-weight: bold;
1.801 tempelho 5729: color:$fontmenu;
1.507 raeburn 5730: background-color: $data_table_head;
1.701 harmsja 5731: font-size: small;
1.507 raeburn 5732: border-bottom: 1px solid #000000;
5733: }
1.795 www 5734:
1.507 raeburn 5735: table.LC_nested_outer tr td.LC_subheader {
5736: background-color: $data_table_head;
5737: font-weight: bold;
5738: font-size: small;
5739: border-bottom: 1px solid #000000;
5740: text-align: right;
1.451 albertel 5741: }
1.795 www 5742:
1.507 raeburn 5743: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5744: background-color: #CCCCCC;
1.451 albertel 5745: font-weight: bold;
5746: font-size: small;
1.507 raeburn 5747: text-align: center;
5748: }
1.795 www 5749:
1.589 raeburn 5750: table.LC_nested tr.LC_info_row td.LC_left_item,
5751: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5752: text-align: left;
1.451 albertel 5753: }
1.795 www 5754:
1.507 raeburn 5755: table.LC_nested td {
1.735 bisitz 5756: background-color: #FFFFFF;
1.451 albertel 5757: font-size: small;
1.507 raeburn 5758: }
1.795 www 5759:
1.507 raeburn 5760: table.LC_nested_outer tr th.LC_right_item,
5761: table.LC_nested tr.LC_info_row td.LC_right_item,
5762: table.LC_nested tr.LC_odd_row td.LC_right_item,
5763: table.LC_nested tr td.LC_right_item {
1.451 albertel 5764: text-align: right;
5765: }
5766:
1.507 raeburn 5767: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5768: background-color: #EEEEEE;
1.451 albertel 5769: }
5770:
1.473 raeburn 5771: table.LC_createuser {
5772: }
5773:
5774: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5775: font-size: small;
1.473 raeburn 5776: }
5777:
5778: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5779: background-color: #CCCCCC;
1.473 raeburn 5780: font-weight: bold;
5781: text-align: center;
5782: }
5783:
1.349 albertel 5784: table.LC_calendar {
5785: border: 1px solid #000000;
5786: border-collapse: collapse;
1.917 raeburn 5787: width: 98%;
1.349 albertel 5788: }
1.795 www 5789:
1.349 albertel 5790: table.LC_calendar_pickdate {
5791: font-size: xx-small;
5792: }
1.795 www 5793:
1.349 albertel 5794: table.LC_calendar tr td {
5795: border: 1px solid #000000;
5796: vertical-align: top;
1.917 raeburn 5797: width: 14%;
1.349 albertel 5798: }
1.795 www 5799:
1.349 albertel 5800: table.LC_calendar tr td.LC_calendar_day_empty {
5801: background-color: $data_table_dark;
5802: }
1.795 www 5803:
1.779 bisitz 5804: table.LC_calendar tr td.LC_calendar_day_current {
5805: background-color: $data_table_highlight;
1.777 tempelho 5806: }
1.795 www 5807:
1.938 bisitz 5808: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5809: background-color: $mail_new;
5810: }
1.795 www 5811:
1.938 bisitz 5812: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5813: background-color: $mail_new_hover;
5814: }
1.795 www 5815:
1.938 bisitz 5816: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5817: background-color: $mail_read;
5818: }
1.795 www 5819:
1.938 bisitz 5820: /*
5821: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5822: background-color: $mail_read_hover;
5823: }
1.938 bisitz 5824: */
1.795 www 5825:
1.938 bisitz 5826: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5827: background-color: $mail_replied;
5828: }
1.795 www 5829:
1.938 bisitz 5830: /*
5831: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5832: background-color: $mail_replied_hover;
5833: }
1.938 bisitz 5834: */
1.795 www 5835:
1.938 bisitz 5836: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5837: background-color: $mail_other;
5838: }
1.795 www 5839:
1.938 bisitz 5840: /*
5841: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5842: background-color: $mail_other_hover;
5843: }
1.938 bisitz 5844: */
1.494 raeburn 5845:
1.777 tempelho 5846: table.LC_data_table tr > td.LC_browser_file,
5847: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5848: background: #AAEE77;
1.389 albertel 5849: }
1.795 www 5850:
1.777 tempelho 5851: table.LC_data_table tr > td.LC_browser_file_locked,
5852: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5853: background: #FFAA99;
1.387 albertel 5854: }
1.795 www 5855:
1.777 tempelho 5856: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5857: background: #888888;
1.779 bisitz 5858: }
1.795 www 5859:
1.777 tempelho 5860: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5861: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5862: background: #F8F866;
1.777 tempelho 5863: }
1.795 www 5864:
1.696 bisitz 5865: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5866: background: #E0E8FF;
1.387 albertel 5867: }
1.696 bisitz 5868:
1.707 bisitz 5869: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5870: /* background: #77FF77; */
1.707 bisitz 5871: }
1.795 www 5872:
1.707 bisitz 5873: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5874: border-right: 8px solid #FFFF77;
1.707 bisitz 5875: }
1.795 www 5876:
1.707 bisitz 5877: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5878: border-right: 8px solid #FFAA77;
1.707 bisitz 5879: }
1.795 www 5880:
1.707 bisitz 5881: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5882: border-right: 8px solid #FF7777;
1.707 bisitz 5883: }
1.795 www 5884:
1.707 bisitz 5885: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5886: border-right: 8px solid #AAFF77;
1.707 bisitz 5887: }
1.795 www 5888:
1.707 bisitz 5889: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5890: border-right: 8px solid #11CC55;
1.707 bisitz 5891: }
5892:
1.388 albertel 5893: span.LC_current_location {
1.701 harmsja 5894: font-size:larger;
1.388 albertel 5895: background: $pgbg;
5896: }
1.387 albertel 5897:
1.1029 www 5898: span.LC_current_nav_location {
5899: font-weight:bold;
5900: background: $sidebg;
5901: }
5902:
1.395 albertel 5903: span.LC_parm_menu_item {
5904: font-size: larger;
5905: }
1.795 www 5906:
1.395 albertel 5907: span.LC_parm_scope_all {
5908: color: red;
5909: }
1.795 www 5910:
1.395 albertel 5911: span.LC_parm_scope_folder {
5912: color: green;
5913: }
1.795 www 5914:
1.395 albertel 5915: span.LC_parm_scope_resource {
5916: color: orange;
5917: }
1.795 www 5918:
1.395 albertel 5919: span.LC_parm_part {
5920: color: blue;
5921: }
1.795 www 5922:
1.911 bisitz 5923: span.LC_parm_folder,
5924: span.LC_parm_symb {
1.395 albertel 5925: font-size: x-small;
5926: font-family: $mono;
5927: color: #AAAAAA;
5928: }
5929:
1.977 bisitz 5930: ul.LC_parm_parmlist li {
5931: display: inline-block;
5932: padding: 0.3em 0.8em;
5933: vertical-align: top;
5934: width: 150px;
5935: border-top:1px solid $lg_border_color;
5936: }
5937:
1.795 www 5938: td.LC_parm_overview_level_menu,
5939: td.LC_parm_overview_map_menu,
5940: td.LC_parm_overview_parm_selectors,
5941: td.LC_parm_overview_restrictions {
1.396 albertel 5942: border: 1px solid black;
5943: border-collapse: collapse;
5944: }
1.795 www 5945:
1.396 albertel 5946: table.LC_parm_overview_restrictions td {
5947: border-width: 1px 4px 1px 4px;
5948: border-style: solid;
5949: border-color: $pgbg;
5950: text-align: center;
5951: }
1.795 www 5952:
1.396 albertel 5953: table.LC_parm_overview_restrictions th {
5954: background: $tabbg;
5955: border-width: 1px 4px 1px 4px;
5956: border-style: solid;
5957: border-color: $pgbg;
5958: }
1.795 www 5959:
1.398 albertel 5960: table#LC_helpmenu {
1.803 bisitz 5961: border: none;
1.398 albertel 5962: height: 55px;
1.803 bisitz 5963: border-spacing: 0;
1.398 albertel 5964: }
5965:
5966: table#LC_helpmenu fieldset legend {
5967: font-size: larger;
5968: }
1.795 www 5969:
1.397 albertel 5970: table#LC_helpmenu_links {
5971: width: 100%;
5972: border: 1px solid black;
5973: background: $pgbg;
1.803 bisitz 5974: padding: 0;
1.397 albertel 5975: border-spacing: 1px;
5976: }
1.795 www 5977:
1.397 albertel 5978: table#LC_helpmenu_links tr td {
5979: padding: 1px;
5980: background: $tabbg;
1.399 albertel 5981: text-align: center;
5982: font-weight: bold;
1.397 albertel 5983: }
1.396 albertel 5984:
1.795 www 5985: table#LC_helpmenu_links a:link,
5986: table#LC_helpmenu_links a:visited,
1.397 albertel 5987: table#LC_helpmenu_links a:active {
5988: text-decoration: none;
5989: color: $font;
5990: }
1.795 www 5991:
1.397 albertel 5992: table#LC_helpmenu_links a:hover {
5993: text-decoration: underline;
5994: color: $vlink;
5995: }
1.396 albertel 5996:
1.417 albertel 5997: .LC_chrt_popup_exists {
5998: border: 1px solid #339933;
5999: margin: -1px;
6000: }
1.795 www 6001:
1.417 albertel 6002: .LC_chrt_popup_up {
6003: border: 1px solid yellow;
6004: margin: -1px;
6005: }
1.795 www 6006:
1.417 albertel 6007: .LC_chrt_popup {
6008: border: 1px solid #8888FF;
6009: background: #CCCCFF;
6010: }
1.795 www 6011:
1.421 albertel 6012: table.LC_pick_box {
6013: border-collapse: separate;
6014: background: white;
6015: border: 1px solid black;
6016: border-spacing: 1px;
6017: }
1.795 www 6018:
1.421 albertel 6019: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6020: background: $sidebg;
1.421 albertel 6021: font-weight: bold;
1.900 bisitz 6022: text-align: left;
1.740 bisitz 6023: vertical-align: top;
1.421 albertel 6024: width: 184px;
6025: padding: 8px;
6026: }
1.795 www 6027:
1.579 raeburn 6028: table.LC_pick_box td.LC_pick_box_value {
6029: text-align: left;
6030: padding: 8px;
6031: }
1.795 www 6032:
1.579 raeburn 6033: table.LC_pick_box td.LC_pick_box_select {
6034: text-align: left;
6035: padding: 8px;
6036: }
1.795 www 6037:
1.424 albertel 6038: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6039: padding: 0;
1.421 albertel 6040: height: 1px;
6041: background: black;
6042: }
1.795 www 6043:
1.421 albertel 6044: table.LC_pick_box td.LC_pick_box_submit {
6045: text-align: right;
6046: }
1.795 www 6047:
1.579 raeburn 6048: table.LC_pick_box td.LC_evenrow_value {
6049: text-align: left;
6050: padding: 8px;
6051: background-color: $data_table_light;
6052: }
1.795 www 6053:
1.579 raeburn 6054: table.LC_pick_box td.LC_oddrow_value {
6055: text-align: left;
6056: padding: 8px;
6057: background-color: $data_table_light;
6058: }
1.795 www 6059:
1.579 raeburn 6060: span.LC_helpform_receipt_cat {
6061: font-weight: bold;
6062: }
1.795 www 6063:
1.424 albertel 6064: table.LC_group_priv_box {
6065: background: white;
6066: border: 1px solid black;
6067: border-spacing: 1px;
6068: }
1.795 www 6069:
1.424 albertel 6070: table.LC_group_priv_box td.LC_pick_box_title {
6071: background: $tabbg;
6072: font-weight: bold;
6073: text-align: right;
6074: width: 184px;
6075: }
1.795 www 6076:
1.424 albertel 6077: table.LC_group_priv_box td.LC_groups_fixed {
6078: background: $data_table_light;
6079: text-align: center;
6080: }
1.795 www 6081:
1.424 albertel 6082: table.LC_group_priv_box td.LC_groups_optional {
6083: background: $data_table_dark;
6084: text-align: center;
6085: }
1.795 www 6086:
1.424 albertel 6087: table.LC_group_priv_box td.LC_groups_functionality {
6088: background: $data_table_darker;
6089: text-align: center;
6090: font-weight: bold;
6091: }
1.795 www 6092:
1.424 albertel 6093: table.LC_group_priv td {
6094: text-align: left;
1.803 bisitz 6095: padding: 0;
1.424 albertel 6096: }
6097:
6098: .LC_navbuttons {
6099: margin: 2ex 0ex 2ex 0ex;
6100: }
1.795 www 6101:
1.423 albertel 6102: .LC_topic_bar {
6103: font-weight: bold;
6104: background: $tabbg;
1.918 wenzelju 6105: margin: 1em 0em 1em 2em;
1.805 bisitz 6106: padding: 3px;
1.918 wenzelju 6107: font-size: 1.2em;
1.423 albertel 6108: }
1.795 www 6109:
1.423 albertel 6110: .LC_topic_bar span {
1.918 wenzelju 6111: left: 0.5em;
6112: position: absolute;
1.423 albertel 6113: vertical-align: middle;
1.918 wenzelju 6114: font-size: 1.2em;
1.423 albertel 6115: }
1.795 www 6116:
1.423 albertel 6117: table.LC_course_group_status {
6118: margin: 20px;
6119: }
1.795 www 6120:
1.423 albertel 6121: table.LC_status_selector td {
6122: vertical-align: top;
6123: text-align: center;
1.424 albertel 6124: padding: 4px;
6125: }
1.795 www 6126:
1.599 albertel 6127: div.LC_feedback_link {
1.616 albertel 6128: clear: both;
1.829 kalberla 6129: background: $sidebg;
1.779 bisitz 6130: width: 100%;
1.829 kalberla 6131: padding-bottom: 10px;
6132: border: 1px $tabbg solid;
1.833 kalberla 6133: height: 22px;
6134: line-height: 22px;
6135: padding-top: 5px;
6136: }
6137:
6138: div.LC_feedback_link img {
6139: height: 22px;
1.867 kalberla 6140: vertical-align:middle;
1.829 kalberla 6141: }
6142:
1.911 bisitz 6143: div.LC_feedback_link a {
1.829 kalberla 6144: text-decoration: none;
1.489 raeburn 6145: }
1.795 www 6146:
1.867 kalberla 6147: div.LC_comblock {
1.911 bisitz 6148: display:inline;
1.867 kalberla 6149: color:$font;
6150: font-size:90%;
6151: }
6152:
6153: div.LC_feedback_link div.LC_comblock {
6154: padding-left:5px;
6155: }
6156:
6157: div.LC_feedback_link div.LC_comblock a {
6158: color:$font;
6159: }
6160:
1.489 raeburn 6161: span.LC_feedback_link {
1.858 bisitz 6162: /* background: $feedback_link_bg; */
1.599 albertel 6163: font-size: larger;
6164: }
1.795 www 6165:
1.599 albertel 6166: span.LC_message_link {
1.858 bisitz 6167: /* background: $feedback_link_bg; */
1.599 albertel 6168: font-size: larger;
6169: position: absolute;
6170: right: 1em;
1.489 raeburn 6171: }
1.421 albertel 6172:
1.515 albertel 6173: table.LC_prior_tries {
1.524 albertel 6174: border: 1px solid #000000;
6175: border-collapse: separate;
6176: border-spacing: 1px;
1.515 albertel 6177: }
1.523 albertel 6178:
1.515 albertel 6179: table.LC_prior_tries td {
1.524 albertel 6180: padding: 2px;
1.515 albertel 6181: }
1.523 albertel 6182:
6183: .LC_answer_correct {
1.795 www 6184: background: lightgreen;
6185: color: darkgreen;
6186: padding: 6px;
1.523 albertel 6187: }
1.795 www 6188:
1.523 albertel 6189: .LC_answer_charged_try {
1.797 www 6190: background: #FFAAAA;
1.795 www 6191: color: darkred;
6192: padding: 6px;
1.523 albertel 6193: }
1.795 www 6194:
1.779 bisitz 6195: .LC_answer_not_charged_try,
1.523 albertel 6196: .LC_answer_no_grade,
6197: .LC_answer_late {
1.795 www 6198: background: lightyellow;
1.523 albertel 6199: color: black;
1.795 www 6200: padding: 6px;
1.523 albertel 6201: }
1.795 www 6202:
1.523 albertel 6203: .LC_answer_previous {
1.795 www 6204: background: lightblue;
6205: color: darkblue;
6206: padding: 6px;
1.523 albertel 6207: }
1.795 www 6208:
1.779 bisitz 6209: .LC_answer_no_message {
1.777 tempelho 6210: background: #FFFFFF;
6211: color: black;
1.795 www 6212: padding: 6px;
1.779 bisitz 6213: }
1.795 www 6214:
1.779 bisitz 6215: .LC_answer_unknown {
6216: background: orange;
6217: color: black;
1.795 www 6218: padding: 6px;
1.777 tempelho 6219: }
1.795 www 6220:
1.529 albertel 6221: span.LC_prior_numerical,
6222: span.LC_prior_string,
6223: span.LC_prior_custom,
6224: span.LC_prior_reaction,
6225: span.LC_prior_math {
1.925 bisitz 6226: font-family: $mono;
1.523 albertel 6227: white-space: pre;
6228: }
6229:
1.525 albertel 6230: span.LC_prior_string {
1.925 bisitz 6231: font-family: $mono;
1.525 albertel 6232: white-space: pre;
6233: }
6234:
1.523 albertel 6235: table.LC_prior_option {
6236: width: 100%;
6237: border-collapse: collapse;
6238: }
1.795 www 6239:
1.911 bisitz 6240: table.LC_prior_rank,
1.795 www 6241: table.LC_prior_match {
1.528 albertel 6242: border-collapse: collapse;
6243: }
1.795 www 6244:
1.528 albertel 6245: table.LC_prior_option tr td,
6246: table.LC_prior_rank tr td,
6247: table.LC_prior_match tr td {
1.524 albertel 6248: border: 1px solid #000000;
1.515 albertel 6249: }
6250:
1.855 bisitz 6251: .LC_nobreak {
1.544 albertel 6252: white-space: nowrap;
1.519 raeburn 6253: }
6254:
1.576 raeburn 6255: span.LC_cusr_emph {
6256: font-style: italic;
6257: }
6258:
1.633 raeburn 6259: span.LC_cusr_subheading {
6260: font-weight: normal;
6261: font-size: 85%;
6262: }
6263:
1.861 bisitz 6264: div.LC_docs_entry_move {
1.859 bisitz 6265: border: 1px solid #BBBBBB;
1.545 albertel 6266: background: #DDDDDD;
1.861 bisitz 6267: width: 22px;
1.859 bisitz 6268: padding: 1px;
6269: margin: 0;
1.545 albertel 6270: }
6271:
1.861 bisitz 6272: table.LC_data_table tr > td.LC_docs_entry_commands,
6273: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6274: background: #DDDDDD;
6275: font-size: x-small;
6276: }
1.795 www 6277:
1.861 bisitz 6278: .LC_docs_entry_parameter {
6279: white-space: nowrap;
6280: }
6281:
1.544 albertel 6282: .LC_docs_copy {
1.545 albertel 6283: color: #000099;
1.544 albertel 6284: }
1.795 www 6285:
1.544 albertel 6286: .LC_docs_cut {
1.545 albertel 6287: color: #550044;
1.544 albertel 6288: }
1.795 www 6289:
1.544 albertel 6290: .LC_docs_rename {
1.545 albertel 6291: color: #009900;
1.544 albertel 6292: }
1.795 www 6293:
1.544 albertel 6294: .LC_docs_remove {
1.545 albertel 6295: color: #990000;
6296: }
6297:
1.547 albertel 6298: .LC_docs_reinit_warn,
6299: .LC_docs_ext_edit {
6300: font-size: x-small;
6301: }
6302:
1.545 albertel 6303: table.LC_docs_adddocs td,
6304: table.LC_docs_adddocs th {
6305: border: 1px solid #BBBBBB;
6306: padding: 4px;
6307: background: #DDDDDD;
1.543 albertel 6308: }
6309:
1.584 albertel 6310: table.LC_sty_begin {
6311: background: #BBFFBB;
6312: }
1.795 www 6313:
1.584 albertel 6314: table.LC_sty_end {
6315: background: #FFBBBB;
6316: }
6317:
1.589 raeburn 6318: table.LC_double_column {
1.803 bisitz 6319: border-width: 0;
1.589 raeburn 6320: border-collapse: collapse;
6321: width: 100%;
6322: padding: 2px;
6323: }
6324:
6325: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6326: top: 2px;
1.589 raeburn 6327: left: 2px;
6328: width: 47%;
6329: vertical-align: top;
6330: }
6331:
6332: table.LC_double_column tr td.LC_right_col {
6333: top: 2px;
1.779 bisitz 6334: right: 2px;
1.589 raeburn 6335: width: 47%;
6336: vertical-align: top;
6337: }
6338:
1.591 raeburn 6339: div.LC_left_float {
6340: float: left;
6341: padding-right: 5%;
1.597 albertel 6342: padding-bottom: 4px;
1.591 raeburn 6343: }
6344:
6345: div.LC_clear_float_header {
1.597 albertel 6346: padding-bottom: 2px;
1.591 raeburn 6347: }
6348:
6349: div.LC_clear_float_footer {
1.597 albertel 6350: padding-top: 10px;
1.591 raeburn 6351: clear: both;
6352: }
6353:
1.597 albertel 6354: div.LC_grade_show_user {
1.941 bisitz 6355: /* border-left: 5px solid $sidebg; */
6356: border-top: 5px solid #000000;
6357: margin: 50px 0 0 0;
1.936 bisitz 6358: padding: 15px 0 5px 10px;
1.597 albertel 6359: }
1.795 www 6360:
1.936 bisitz 6361: div.LC_grade_show_user_odd_row {
1.941 bisitz 6362: /* border-left: 5px solid #000000; */
6363: }
6364:
6365: div.LC_grade_show_user div.LC_Box {
6366: margin-right: 50px;
1.597 albertel 6367: }
6368:
6369: div.LC_grade_submissions,
6370: div.LC_grade_message_center,
1.936 bisitz 6371: div.LC_grade_info_links {
1.597 albertel 6372: margin: 5px;
6373: width: 99%;
6374: background: #FFFFFF;
6375: }
1.795 www 6376:
1.597 albertel 6377: div.LC_grade_submissions_header,
1.936 bisitz 6378: div.LC_grade_message_center_header {
1.705 tempelho 6379: font-weight: bold;
6380: font-size: large;
1.597 albertel 6381: }
1.795 www 6382:
1.597 albertel 6383: div.LC_grade_submissions_body,
1.936 bisitz 6384: div.LC_grade_message_center_body {
1.597 albertel 6385: border: 1px solid black;
6386: width: 99%;
6387: background: #FFFFFF;
6388: }
1.795 www 6389:
1.613 albertel 6390: table.LC_scantron_action {
6391: width: 100%;
6392: }
1.795 www 6393:
1.613 albertel 6394: table.LC_scantron_action tr th {
1.698 harmsja 6395: font-weight:bold;
6396: font-style:normal;
1.613 albertel 6397: }
1.795 www 6398:
1.779 bisitz 6399: .LC_edit_problem_header,
1.614 albertel 6400: div.LC_edit_problem_footer {
1.705 tempelho 6401: font-weight: normal;
6402: font-size: medium;
1.602 albertel 6403: margin: 2px;
1.1060 bisitz 6404: background-color: $sidebg;
1.600 albertel 6405: }
1.795 www 6406:
1.600 albertel 6407: div.LC_edit_problem_header,
1.602 albertel 6408: div.LC_edit_problem_header div,
1.614 albertel 6409: div.LC_edit_problem_footer,
6410: div.LC_edit_problem_footer div,
1.602 albertel 6411: div.LC_edit_problem_editxml_header,
6412: div.LC_edit_problem_editxml_header div {
1.600 albertel 6413: margin-top: 5px;
6414: }
1.795 www 6415:
1.600 albertel 6416: div.LC_edit_problem_header_title {
1.705 tempelho 6417: font-weight: bold;
6418: font-size: larger;
1.602 albertel 6419: background: $tabbg;
6420: padding: 3px;
1.1060 bisitz 6421: margin: 0 0 5px 0;
1.602 albertel 6422: }
1.795 www 6423:
1.602 albertel 6424: table.LC_edit_problem_header_title {
6425: width: 100%;
1.600 albertel 6426: background: $tabbg;
1.602 albertel 6427: }
6428:
6429: div.LC_edit_problem_discards {
6430: float: left;
6431: padding-bottom: 5px;
6432: }
1.795 www 6433:
1.602 albertel 6434: div.LC_edit_problem_saves {
6435: float: right;
6436: padding-bottom: 5px;
1.600 albertel 6437: }
1.795 www 6438:
1.911 bisitz 6439: img.stift {
1.803 bisitz 6440: border-width: 0;
6441: vertical-align: middle;
1.677 riegler 6442: }
1.680 riegler 6443:
1.923 bisitz 6444: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6445: vertical-align: top;
1.777 tempelho 6446: }
1.795 www 6447:
1.716 raeburn 6448: div.LC_createcourse {
1.911 bisitz 6449: margin: 10px 10px 10px 10px;
1.716 raeburn 6450: }
6451:
1.917 raeburn 6452: .LC_dccid {
6453: margin: 0.2em 0 0 0;
6454: padding: 0;
6455: font-size: 90%;
6456: display:none;
6457: }
6458:
1.897 wenzelju 6459: ol.LC_primary_menu a:hover,
1.721 harmsja 6460: ol#LC_MenuBreadcrumbs a:hover,
6461: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6462: ul#LC_secondary_menu a:hover,
1.721 harmsja 6463: .LC_FormSectionClearButton input:hover
1.795 www 6464: ul.LC_TabContent li:hover a {
1.952 onken 6465: color:$button_hover;
1.911 bisitz 6466: text-decoration:none;
1.693 droeschl 6467: }
6468:
1.779 bisitz 6469: h1 {
1.911 bisitz 6470: padding: 0;
6471: line-height:130%;
1.693 droeschl 6472: }
1.698 harmsja 6473:
1.911 bisitz 6474: h2,
6475: h3,
6476: h4,
6477: h5,
6478: h6 {
6479: margin: 5px 0 5px 0;
6480: padding: 0;
6481: line-height:130%;
1.693 droeschl 6482: }
1.795 www 6483:
6484: .LC_hcell {
1.911 bisitz 6485: padding:3px 15px 3px 15px;
6486: margin: 0;
6487: background-color:$tabbg;
6488: color:$fontmenu;
6489: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6490: }
1.795 www 6491:
1.840 bisitz 6492: .LC_Box > .LC_hcell {
1.911 bisitz 6493: margin: 0 -10px 10px -10px;
1.835 bisitz 6494: }
6495:
1.721 harmsja 6496: .LC_noBorder {
1.911 bisitz 6497: border: 0;
1.698 harmsja 6498: }
1.693 droeschl 6499:
1.721 harmsja 6500: .LC_FormSectionClearButton input {
1.911 bisitz 6501: background-color:transparent;
6502: border: none;
6503: cursor:pointer;
6504: text-decoration:underline;
1.693 droeschl 6505: }
1.763 bisitz 6506:
6507: .LC_help_open_topic {
1.911 bisitz 6508: color: #FFFFFF;
6509: background-color: #EEEEFF;
6510: margin: 1px;
6511: padding: 4px;
6512: border: 1px solid #000033;
6513: white-space: nowrap;
6514: /* vertical-align: middle; */
1.759 neumanie 6515: }
1.693 droeschl 6516:
1.911 bisitz 6517: dl,
6518: ul,
6519: div,
6520: fieldset {
6521: margin: 10px 10px 10px 0;
6522: /* overflow: hidden; */
1.693 droeschl 6523: }
1.795 www 6524:
1.838 bisitz 6525: fieldset > legend {
1.911 bisitz 6526: font-weight: bold;
6527: padding: 0 5px 0 5px;
1.838 bisitz 6528: }
6529:
1.813 bisitz 6530: #LC_nav_bar {
1.911 bisitz 6531: float: left;
1.995 raeburn 6532: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6533: margin: 0 0 2px 0;
1.807 droeschl 6534: }
6535:
1.916 droeschl 6536: #LC_realm {
6537: margin: 0.2em 0 0 0;
6538: padding: 0;
6539: font-weight: bold;
6540: text-align: center;
1.995 raeburn 6541: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6542: }
6543:
1.911 bisitz 6544: #LC_nav_bar em {
6545: font-weight: bold;
6546: font-style: normal;
1.807 droeschl 6547: }
6548:
1.897 wenzelju 6549: ol.LC_primary_menu {
1.911 bisitz 6550: float: right;
1.934 droeschl 6551: margin: 0;
1.1076 raeburn 6552: padding: 0;
1.995 raeburn 6553: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6554: }
6555:
1.852 droeschl 6556: ol#LC_PathBreadcrumbs {
1.911 bisitz 6557: margin: 0;
1.693 droeschl 6558: }
6559:
1.897 wenzelju 6560: ol.LC_primary_menu li {
1.1076 raeburn 6561: color: RGB(80, 80, 80);
6562: vertical-align: middle;
6563: text-align: left;
6564: list-style: none;
6565: float: left;
6566: }
6567:
6568: ol.LC_primary_menu li a {
6569: display: block;
6570: margin: 0;
6571: padding: 0 5px 0 10px;
6572: text-decoration: none;
6573: }
6574:
6575: ol.LC_primary_menu li ul {
6576: display: none;
6577: width: 10em;
6578: background-color: $data_table_light;
6579: }
6580:
6581: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6582: display: block;
6583: position: absolute;
6584: margin: 0;
6585: padding: 0;
1.1078 raeburn 6586: z-index: 2;
1.1076 raeburn 6587: }
6588:
6589: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6590: font-size: 90%;
1.911 bisitz 6591: vertical-align: top;
1.1076 raeburn 6592: float: none;
1.1079 raeburn 6593: border-left: 1px solid black;
6594: border-right: 1px solid black;
1.1076 raeburn 6595: }
6596:
6597: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6598: background-color:$data_table_light;
1.1076 raeburn 6599: }
6600:
6601: ol.LC_primary_menu li li a:hover {
6602: color:$button_hover;
6603: background-color:$data_table_dark;
1.693 droeschl 6604: }
6605:
1.897 wenzelju 6606: ol.LC_primary_menu li img {
1.911 bisitz 6607: vertical-align: bottom;
1.934 droeschl 6608: height: 1.1em;
1.1077 raeburn 6609: margin: 0.2em 0 0 0;
1.693 droeschl 6610: }
6611:
1.897 wenzelju 6612: ol.LC_primary_menu a {
1.911 bisitz 6613: color: RGB(80, 80, 80);
6614: text-decoration: none;
1.693 droeschl 6615: }
1.795 www 6616:
1.949 droeschl 6617: ol.LC_primary_menu a.LC_new_message {
6618: font-weight:bold;
6619: color: darkred;
6620: }
6621:
1.975 raeburn 6622: ol.LC_docs_parameters {
6623: margin-left: 0;
6624: padding: 0;
6625: list-style: none;
6626: }
6627:
6628: ol.LC_docs_parameters li {
6629: margin: 0;
6630: padding-right: 20px;
6631: display: inline;
6632: }
6633:
1.976 raeburn 6634: ol.LC_docs_parameters li:before {
6635: content: "\\002022 \\0020";
6636: }
6637:
6638: li.LC_docs_parameters_title {
6639: font-weight: bold;
6640: }
6641:
6642: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6643: content: "";
6644: }
6645:
1.897 wenzelju 6646: ul#LC_secondary_menu {
1.911 bisitz 6647: clear: both;
6648: color: $fontmenu;
6649: background: $tabbg;
6650: list-style: none;
6651: padding: 0;
6652: margin: 0;
6653: width: 100%;
1.995 raeburn 6654: text-align: left;
1.808 droeschl 6655: }
6656:
1.897 wenzelju 6657: ul#LC_secondary_menu li {
1.911 bisitz 6658: font-weight: bold;
6659: line-height: 1.8em;
6660: padding: 0 0.8em;
6661: border-right: 1px solid black;
6662: display: inline;
6663: vertical-align: middle;
1.807 droeschl 6664: }
6665:
1.847 tempelho 6666: ul.LC_TabContent {
1.911 bisitz 6667: display:block;
6668: background: $sidebg;
6669: border-bottom: solid 1px $lg_border_color;
6670: list-style:none;
1.1020 raeburn 6671: margin: -1px -10px 0 -10px;
1.911 bisitz 6672: padding: 0;
1.693 droeschl 6673: }
6674:
1.795 www 6675: ul.LC_TabContent li,
6676: ul.LC_TabContentBigger li {
1.911 bisitz 6677: float:left;
1.741 harmsja 6678: }
1.795 www 6679:
1.897 wenzelju 6680: ul#LC_secondary_menu li a {
1.911 bisitz 6681: color: $fontmenu;
6682: text-decoration: none;
1.693 droeschl 6683: }
1.795 www 6684:
1.721 harmsja 6685: ul.LC_TabContent {
1.952 onken 6686: min-height:20px;
1.721 harmsja 6687: }
1.795 www 6688:
6689: ul.LC_TabContent li {
1.911 bisitz 6690: vertical-align:middle;
1.959 onken 6691: padding: 0 16px 0 10px;
1.911 bisitz 6692: background-color:$tabbg;
6693: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6694: border-left: solid 1px $font;
1.721 harmsja 6695: }
1.795 www 6696:
1.847 tempelho 6697: ul.LC_TabContent .right {
1.911 bisitz 6698: float:right;
1.847 tempelho 6699: }
6700:
1.911 bisitz 6701: ul.LC_TabContent li a,
6702: ul.LC_TabContent li {
6703: color:rgb(47,47,47);
6704: text-decoration:none;
6705: font-size:95%;
6706: font-weight:bold;
1.952 onken 6707: min-height:20px;
6708: }
6709:
1.959 onken 6710: ul.LC_TabContent li a:hover,
6711: ul.LC_TabContent li a:focus {
1.952 onken 6712: color: $button_hover;
1.959 onken 6713: background:none;
6714: outline:none;
1.952 onken 6715: }
6716:
6717: ul.LC_TabContent li:hover {
6718: color: $button_hover;
6719: cursor:pointer;
1.721 harmsja 6720: }
1.795 www 6721:
1.911 bisitz 6722: ul.LC_TabContent li.active {
1.952 onken 6723: color: $font;
1.911 bisitz 6724: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6725: border-bottom:solid 1px #FFFFFF;
6726: cursor: default;
1.744 ehlerst 6727: }
1.795 www 6728:
1.959 onken 6729: ul.LC_TabContent li.active a {
6730: color:$font;
6731: background:#FFFFFF;
6732: outline: none;
6733: }
1.1047 raeburn 6734:
6735: ul.LC_TabContent li.goback {
6736: float: left;
6737: border-left: none;
6738: }
6739:
1.870 tempelho 6740: #maincoursedoc {
1.911 bisitz 6741: clear:both;
1.870 tempelho 6742: }
6743:
6744: ul.LC_TabContentBigger {
1.911 bisitz 6745: display:block;
6746: list-style:none;
6747: padding: 0;
1.870 tempelho 6748: }
6749:
1.795 www 6750: ul.LC_TabContentBigger li {
1.911 bisitz 6751: vertical-align:bottom;
6752: height: 30px;
6753: font-size:110%;
6754: font-weight:bold;
6755: color: #737373;
1.841 tempelho 6756: }
6757:
1.957 onken 6758: ul.LC_TabContentBigger li.active {
6759: position: relative;
6760: top: 1px;
6761: }
6762:
1.870 tempelho 6763: ul.LC_TabContentBigger li a {
1.911 bisitz 6764: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6765: height: 30px;
6766: line-height: 30px;
6767: text-align: center;
6768: display: block;
6769: text-decoration: none;
1.958 onken 6770: outline: none;
1.741 harmsja 6771: }
1.795 www 6772:
1.870 tempelho 6773: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6774: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6775: color:$font;
1.744 ehlerst 6776: }
1.795 www 6777:
1.870 tempelho 6778: ul.LC_TabContentBigger li b {
1.911 bisitz 6779: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6780: display: block;
6781: float: left;
6782: padding: 0 30px;
1.957 onken 6783: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6784: }
6785:
1.956 onken 6786: ul.LC_TabContentBigger li:hover b {
6787: color:$button_hover;
6788: }
6789:
1.870 tempelho 6790: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6791: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6792: color:$font;
1.957 onken 6793: border: 0;
1.741 harmsja 6794: }
1.693 droeschl 6795:
1.870 tempelho 6796:
1.862 bisitz 6797: ul.LC_CourseBreadcrumbs {
6798: background: $sidebg;
1.1020 raeburn 6799: height: 2em;
1.862 bisitz 6800: padding-left: 10px;
1.1020 raeburn 6801: margin: 0;
1.862 bisitz 6802: list-style-position: inside;
6803: }
6804:
1.911 bisitz 6805: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6806: ol#LC_PathBreadcrumbs {
1.911 bisitz 6807: padding-left: 10px;
6808: margin: 0;
1.933 droeschl 6809: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6810: }
6811:
1.911 bisitz 6812: ol#LC_MenuBreadcrumbs li,
6813: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6814: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6815: display: inline;
1.933 droeschl 6816: white-space: normal;
1.693 droeschl 6817: }
6818:
1.823 bisitz 6819: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6820: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6821: text-decoration: none;
6822: font-size:90%;
1.693 droeschl 6823: }
1.795 www 6824:
1.969 droeschl 6825: ol#LC_MenuBreadcrumbs h1 {
6826: display: inline;
6827: font-size: 90%;
6828: line-height: 2.5em;
6829: margin: 0;
6830: padding: 0;
6831: }
6832:
1.795 www 6833: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6834: text-decoration:none;
6835: font-size:100%;
6836: font-weight:bold;
1.693 droeschl 6837: }
1.795 www 6838:
1.840 bisitz 6839: .LC_Box {
1.911 bisitz 6840: border: solid 1px $lg_border_color;
6841: padding: 0 10px 10px 10px;
1.746 neumanie 6842: }
1.795 www 6843:
1.1020 raeburn 6844: .LC_DocsBox {
6845: border: solid 1px $lg_border_color;
6846: padding: 0 0 10px 10px;
6847: }
6848:
1.795 www 6849: .LC_AboutMe_Image {
1.911 bisitz 6850: float:left;
6851: margin-right:10px;
1.747 neumanie 6852: }
1.795 www 6853:
6854: .LC_Clear_AboutMe_Image {
1.911 bisitz 6855: clear:left;
1.747 neumanie 6856: }
1.795 www 6857:
1.721 harmsja 6858: dl.LC_ListStyleClean dt {
1.911 bisitz 6859: padding-right: 5px;
6860: display: table-header-group;
1.693 droeschl 6861: }
6862:
1.721 harmsja 6863: dl.LC_ListStyleClean dd {
1.911 bisitz 6864: display: table-row;
1.693 droeschl 6865: }
6866:
1.721 harmsja 6867: .LC_ListStyleClean,
6868: .LC_ListStyleSimple,
6869: .LC_ListStyleNormal,
1.795 www 6870: .LC_ListStyleSpecial {
1.911 bisitz 6871: /* display:block; */
6872: list-style-position: inside;
6873: list-style-type: none;
6874: overflow: hidden;
6875: padding: 0;
1.693 droeschl 6876: }
6877:
1.721 harmsja 6878: .LC_ListStyleSimple li,
6879: .LC_ListStyleSimple dd,
6880: .LC_ListStyleNormal li,
6881: .LC_ListStyleNormal dd,
6882: .LC_ListStyleSpecial li,
1.795 www 6883: .LC_ListStyleSpecial dd {
1.911 bisitz 6884: margin: 0;
6885: padding: 5px 5px 5px 10px;
6886: clear: both;
1.693 droeschl 6887: }
6888:
1.721 harmsja 6889: .LC_ListStyleClean li,
6890: .LC_ListStyleClean dd {
1.911 bisitz 6891: padding-top: 0;
6892: padding-bottom: 0;
1.693 droeschl 6893: }
6894:
1.721 harmsja 6895: .LC_ListStyleSimple dd,
1.795 www 6896: .LC_ListStyleSimple li {
1.911 bisitz 6897: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6898: }
6899:
1.721 harmsja 6900: .LC_ListStyleSpecial li,
6901: .LC_ListStyleSpecial dd {
1.911 bisitz 6902: list-style-type: none;
6903: background-color: RGB(220, 220, 220);
6904: margin-bottom: 4px;
1.693 droeschl 6905: }
6906:
1.721 harmsja 6907: table.LC_SimpleTable {
1.911 bisitz 6908: margin:5px;
6909: border:solid 1px $lg_border_color;
1.795 www 6910: }
1.693 droeschl 6911:
1.721 harmsja 6912: table.LC_SimpleTable tr {
1.911 bisitz 6913: padding: 0;
6914: border:solid 1px $lg_border_color;
1.693 droeschl 6915: }
1.795 www 6916:
6917: table.LC_SimpleTable thead {
1.911 bisitz 6918: background:rgb(220,220,220);
1.693 droeschl 6919: }
6920:
1.721 harmsja 6921: div.LC_columnSection {
1.911 bisitz 6922: display: block;
6923: clear: both;
6924: overflow: hidden;
6925: margin: 0;
1.693 droeschl 6926: }
6927:
1.721 harmsja 6928: div.LC_columnSection>* {
1.911 bisitz 6929: float: left;
6930: margin: 10px 20px 10px 0;
6931: overflow:hidden;
1.693 droeschl 6932: }
1.721 harmsja 6933:
1.795 www 6934: table em {
1.911 bisitz 6935: font-weight: bold;
6936: font-style: normal;
1.748 schulted 6937: }
1.795 www 6938:
1.779 bisitz 6939: table.LC_tableBrowseRes,
1.795 www 6940: table.LC_tableOfContent {
1.911 bisitz 6941: border:none;
6942: border-spacing: 1px;
6943: padding: 3px;
6944: background-color: #FFFFFF;
6945: font-size: 90%;
1.753 droeschl 6946: }
1.789 droeschl 6947:
1.911 bisitz 6948: table.LC_tableOfContent {
6949: border-collapse: collapse;
1.789 droeschl 6950: }
6951:
1.771 droeschl 6952: table.LC_tableBrowseRes a,
1.768 schulted 6953: table.LC_tableOfContent a {
1.911 bisitz 6954: background-color: transparent;
6955: text-decoration: none;
1.753 droeschl 6956: }
6957:
1.795 www 6958: table.LC_tableOfContent img {
1.911 bisitz 6959: border: none;
6960: height: 1.3em;
6961: vertical-align: text-bottom;
6962: margin-right: 0.3em;
1.753 droeschl 6963: }
1.757 schulted 6964:
1.795 www 6965: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6966: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6967: }
6968:
1.795 www 6969: a#LC_content_toolbar_everything {
1.911 bisitz 6970: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6971: }
6972:
1.795 www 6973: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6974: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6975: }
6976:
1.795 www 6977: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6978: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6979: }
6980:
1.795 www 6981: a#LC_content_toolbar_changefolder {
1.911 bisitz 6982: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6983: }
6984:
1.795 www 6985: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6986: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6987: }
6988:
1.1043 raeburn 6989: a#LC_content_toolbar_edittoplevel {
6990: background-image:url(/res/adm/pages/edittoplevel.gif);
6991: }
6992:
1.795 www 6993: ul#LC_toolbar li a:hover {
1.911 bisitz 6994: background-position: bottom center;
1.757 schulted 6995: }
6996:
1.795 www 6997: ul#LC_toolbar {
1.911 bisitz 6998: padding: 0;
6999: margin: 2px;
7000: list-style:none;
7001: position:relative;
7002: background-color:white;
1.1082 raeburn 7003: overflow: auto;
1.757 schulted 7004: }
7005:
1.795 www 7006: ul#LC_toolbar li {
1.911 bisitz 7007: border:1px solid white;
7008: padding: 0;
7009: margin: 0;
7010: float: left;
7011: display:inline;
7012: vertical-align:middle;
1.1082 raeburn 7013: white-space: nowrap;
1.911 bisitz 7014: }
1.757 schulted 7015:
1.783 amueller 7016:
1.795 www 7017: a.LC_toolbarItem {
1.911 bisitz 7018: display:block;
7019: padding: 0;
7020: margin: 0;
7021: height: 32px;
7022: width: 32px;
7023: color:white;
7024: border: none;
7025: background-repeat:no-repeat;
7026: background-color:transparent;
1.757 schulted 7027: }
7028:
1.915 droeschl 7029: ul.LC_funclist {
7030: margin: 0;
7031: padding: 0.5em 1em 0.5em 0;
7032: }
7033:
1.933 droeschl 7034: ul.LC_funclist > li:first-child {
7035: font-weight:bold;
7036: margin-left:0.8em;
7037: }
7038:
1.915 droeschl 7039: ul.LC_funclist + ul.LC_funclist {
7040: /*
7041: left border as a seperator if we have more than
7042: one list
7043: */
7044: border-left: 1px solid $sidebg;
7045: /*
7046: this hides the left border behind the border of the
7047: outer box if element is wrapped to the next 'line'
7048: */
7049: margin-left: -1px;
7050: }
7051:
1.843 bisitz 7052: ul.LC_funclist li {
1.915 droeschl 7053: display: inline;
1.782 bisitz 7054: white-space: nowrap;
1.915 droeschl 7055: margin: 0 0 0 25px;
7056: line-height: 150%;
1.782 bisitz 7057: }
7058:
1.974 wenzelju 7059: .LC_hidden {
7060: display: none;
7061: }
7062:
1.1030 www 7063: .LCmodal-overlay {
7064: position:fixed;
7065: top:0;
7066: right:0;
7067: bottom:0;
7068: left:0;
7069: height:100%;
7070: width:100%;
7071: margin:0;
7072: padding:0;
7073: background:#999;
7074: opacity:.75;
7075: filter: alpha(opacity=75);
7076: -moz-opacity: 0.75;
7077: z-index:101;
7078: }
7079:
7080: * html .LCmodal-overlay {
7081: position: absolute;
7082: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7083: }
7084:
7085: .LCmodal-window {
7086: position:fixed;
7087: top:50%;
7088: left:50%;
7089: margin:0;
7090: padding:0;
7091: z-index:102;
7092: }
7093:
7094: * html .LCmodal-window {
7095: position:absolute;
7096: }
7097:
7098: .LCclose-window {
7099: position:absolute;
7100: width:32px;
7101: height:32px;
7102: right:8px;
7103: top:8px;
7104: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7105: text-indent:-99999px;
7106: overflow:hidden;
7107: cursor:pointer;
7108: }
7109:
1.343 albertel 7110: END
7111: }
7112:
1.306 albertel 7113: =pod
7114:
7115: =item * &headtag()
7116:
7117: Returns a uniform footer for LON-CAPA web pages.
7118:
1.307 albertel 7119: Inputs: $title - optional title for the head
7120: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7121: $args - optional arguments
1.319 albertel 7122: force_register - if is true call registerurl so the remote is
7123: informed
1.415 albertel 7124: redirect -> array ref of
7125: 1- seconds before redirect occurs
7126: 2- url to redirect to
7127: 3- whether the side effect should occur
1.315 albertel 7128: (side effect of setting
7129: $env{'internal.head.redirect'} to the url
7130: redirected too)
1.352 albertel 7131: domain -> force to color decorate a page for a specific
7132: domain
7133: function -> force usage of a specific rolish color scheme
7134: bgcolor -> override the default page bgcolor
1.460 albertel 7135: no_auto_mt_title
7136: -> prevent &mt()ing the title arg
1.464 albertel 7137:
1.306 albertel 7138: =cut
7139:
7140: sub headtag {
1.313 albertel 7141: my ($title,$head_extra,$args) = @_;
1.306 albertel 7142:
1.363 albertel 7143: my $function = $args->{'function'} || &get_users_function();
7144: my $domain = $args->{'domain'} || &determinedomain();
7145: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7146: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7147: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7148: #time(),
1.418 albertel 7149: $env{'environment.color.timestamp'},
1.363 albertel 7150: $function,$domain,$bgcolor);
7151:
1.369 www 7152: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7153:
1.308 albertel 7154: my $result =
7155: '<head>'.
1.461 albertel 7156: &font_settings();
1.319 albertel 7157:
1.1064 raeburn 7158: my $inhibitprint = &print_suppression();
7159:
1.461 albertel 7160: if (!$args->{'frameset'}) {
7161: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7162: }
1.962 droeschl 7163: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7164: $result .= Apache::lonxml::display_title();
1.319 albertel 7165: }
1.436 albertel 7166: if (!$args->{'no_nav_bar'}
7167: && !$args->{'only_body'}
7168: && !$args->{'frameset'}) {
7169: $result .= &help_menu_js();
1.1032 www 7170: $result.=&modal_window();
1.1038 www 7171: $result.=&togglebox_script();
1.1034 www 7172: $result.=&wishlist_window();
1.1041 www 7173: $result.=&LCprogressbarUpdate_script();
1.1034 www 7174: } else {
7175: if ($args->{'add_modal'}) {
7176: $result.=&modal_window();
7177: }
7178: if ($args->{'add_wishlist'}) {
7179: $result.=&wishlist_window();
7180: }
1.1038 www 7181: if ($args->{'add_togglebox'}) {
7182: $result.=&togglebox_script();
7183: }
1.1041 www 7184: if ($args->{'add_progressbar'}) {
7185: $result.=&LCprogressbarUpdate_script();
7186: }
1.436 albertel 7187: }
1.314 albertel 7188: if (ref($args->{'redirect'})) {
1.414 albertel 7189: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7190: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7191: if (!$inhibit_continue) {
7192: $env{'internal.head.redirect'} = $url;
7193: }
1.313 albertel 7194: $result.=<<ADDMETA
7195: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7196: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7197: ADDMETA
7198: }
1.306 albertel 7199: if (!defined($title)) {
7200: $title = 'The LearningOnline Network with CAPA';
7201: }
1.460 albertel 7202: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7203: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7204: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7205: .$inhibitprint
1.414 albertel 7206: .$head_extra;
1.962 droeschl 7207: return $result.'</head>';
1.306 albertel 7208: }
7209:
7210: =pod
7211:
1.340 albertel 7212: =item * &font_settings()
7213:
7214: Returns neccessary <meta> to set the proper encoding
7215:
7216: Inputs: none
7217:
7218: =cut
7219:
7220: sub font_settings {
7221: my $headerstring='';
1.647 www 7222: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7223: $headerstring.=
7224: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7225: }
7226: return $headerstring;
7227: }
7228:
1.341 albertel 7229: =pod
7230:
1.1064 raeburn 7231: =item * &print_suppression()
7232:
7233: In course context returns css which causes the body to be blank when media="print",
7234: if printout generation is unavailable for the current resource.
7235:
7236: This could be because:
7237:
7238: (a) printstartdate is in the future
7239:
7240: (b) printenddate is in the past
7241:
7242: (c) there is an active exam block with "printout"
7243: functionality blocked
7244:
7245: Users with pav, pfo or evb privileges are exempt.
7246:
7247: Inputs: none
7248:
7249: =cut
7250:
7251:
7252: sub print_suppression {
7253: my $noprint;
7254: if ($env{'request.course.id'}) {
7255: my $scope = $env{'request.course.id'};
7256: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7257: (&Apache::lonnet::allowed('pfo',$scope))) {
7258: return;
7259: }
7260: if ($env{'request.course.sec'} ne '') {
7261: $scope .= "/$env{'request.course.sec'}";
7262: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7263: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7264: return;
1.1064 raeburn 7265: }
7266: }
7267: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7268: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7269: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7270: if ($blocked) {
7271: my $checkrole = "cm./$cdom/$cnum";
7272: if ($env{'request.course.sec'} ne '') {
7273: $checkrole .= "/$env{'request.course.sec'}";
7274: }
7275: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7276: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7277: $noprint = 1;
7278: }
7279: }
7280: unless ($noprint) {
7281: my $symb = &Apache::lonnet::symbread();
7282: if ($symb ne '') {
7283: my $navmap = Apache::lonnavmaps::navmap->new();
7284: if (ref($navmap)) {
7285: my $res = $navmap->getBySymb($symb);
7286: if (ref($res)) {
7287: if (!$res->resprintable()) {
7288: $noprint = 1;
7289: }
7290: }
7291: }
7292: }
7293: }
7294: if ($noprint) {
7295: return <<"ENDSTYLE";
7296: <style type="text/css" media="print">
7297: body { display:none }
7298: </style>
7299: ENDSTYLE
7300: }
7301: }
7302: return;
7303: }
7304:
7305: =pod
7306:
1.341 albertel 7307: =item * &xml_begin()
7308:
7309: Returns the needed doctype and <html>
7310:
7311: Inputs: none
7312:
7313: =cut
7314:
7315: sub xml_begin {
7316: my $output='';
7317:
7318: if ($env{'browser.mathml'}) {
7319: $output='<?xml version="1.0"?>'
7320: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7321: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7322:
7323: # .'<!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">] >'
7324: .'<!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">'
7325: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7326: .'xmlns="http://www.w3.org/1999/xhtml">';
7327: } else {
1.849 bisitz 7328: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7329: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7330: }
7331: return $output;
7332: }
1.340 albertel 7333:
7334: =pod
7335:
1.306 albertel 7336: =item * &start_page()
7337:
7338: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7339:
1.648 raeburn 7340: Inputs:
7341:
7342: =over 4
7343:
7344: $title - optional title for the page
7345:
7346: $head_extra - optional extra HTML to incude inside the <head>
7347:
7348: $args - additional optional args supported are:
7349:
7350: =over 8
7351:
7352: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7353: arg on
1.814 bisitz 7354: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7355: add_entries -> additional attributes to add to the <body>
7356: domain -> force to color decorate a page for a
1.317 albertel 7357: specific domain
1.648 raeburn 7358: function -> force usage of a specific rolish color
1.317 albertel 7359: scheme
1.648 raeburn 7360: redirect -> see &headtag()
7361: bgcolor -> override the default page bg color
7362: js_ready -> return a string ready for being used in
1.317 albertel 7363: a javascript writeln
1.648 raeburn 7364: html_encode -> return a string ready for being used in
1.320 albertel 7365: a html attribute
1.648 raeburn 7366: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7367: $forcereg arg
1.648 raeburn 7368: frameset -> if true will start with a <frameset>
1.330 albertel 7369: rather than <body>
1.648 raeburn 7370: skip_phases -> hash ref of
1.338 albertel 7371: head -> skip the <html><head> generation
7372: body -> skip all <body> generation
1.648 raeburn 7373: no_auto_mt_title -> prevent &mt()ing the title arg
7374: inherit_jsmath -> when creating popup window in a page,
7375: should it have jsmath forced on by the
7376: current page
1.867 kalberla 7377: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7378: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 7379:
1.648 raeburn 7380: =back
1.460 albertel 7381:
1.648 raeburn 7382: =back
1.562 albertel 7383:
1.306 albertel 7384: =cut
7385:
7386: sub start_page {
1.309 albertel 7387: my ($title,$head_extra,$args) = @_;
1.318 albertel 7388: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7389:
1.315 albertel 7390: $env{'internal.start_page'}++;
1.338 albertel 7391: my $result;
1.964 droeschl 7392:
1.338 albertel 7393: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7394: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7395: }
7396:
7397: if (! exists($args->{'skip_phases'}{'body'}) ) {
7398: if ($args->{'frameset'}) {
7399: my $attr_string = &make_attr_string($args->{'force_register'},
7400: $args->{'add_entries'});
7401: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7402: } else {
7403: $result .=
7404: &bodytag($title,
7405: $args->{'function'}, $args->{'add_entries'},
7406: $args->{'only_body'}, $args->{'domain'},
7407: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 7408: $args->{'bgcolor'}, $args);
1.831 bisitz 7409: }
1.330 albertel 7410: }
1.338 albertel 7411:
1.315 albertel 7412: if ($args->{'js_ready'}) {
1.713 kaisler 7413: $result = &js_ready($result);
1.315 albertel 7414: }
1.320 albertel 7415: if ($args->{'html_encode'}) {
1.713 kaisler 7416: $result = &html_encode($result);
7417: }
7418:
1.813 bisitz 7419: # Preparation for new and consistent functionlist at top of screen
7420: # if ($args->{'functionlist'}) {
7421: # $result .= &build_functionlist();
7422: #}
7423:
1.964 droeschl 7424: # Don't add anything more if only_body wanted or in const space
7425: return $result if $args->{'only_body'}
7426: || $env{'request.state'} eq 'construct';
1.813 bisitz 7427:
7428: #Breadcrumbs
1.758 kaisler 7429: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7430: &Apache::lonhtmlcommon::clear_breadcrumbs();
7431: #if any br links exists, add them to the breadcrumbs
7432: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7433: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7434: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7435: }
7436: }
7437:
7438: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7439: if(exists($args->{'bread_crumbs_component'})){
7440: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7441: }else{
7442: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7443: }
1.320 albertel 7444: }
1.315 albertel 7445: return $result;
1.306 albertel 7446: }
7447:
7448: sub end_page {
1.315 albertel 7449: my ($args) = @_;
7450: $env{'internal.end_page'}++;
1.330 albertel 7451: my $result;
1.335 albertel 7452: if ($args->{'discussion'}) {
7453: my ($target,$parser);
7454: if (ref($args->{'discussion'})) {
7455: ($target,$parser) =($args->{'discussion'}{'target'},
7456: $args->{'discussion'}{'parser'});
7457: }
7458: $result .= &Apache::lonxml::xmlend($target,$parser);
7459: }
1.330 albertel 7460: if ($args->{'frameset'}) {
7461: $result .= '</frameset>';
7462: } else {
1.635 raeburn 7463: $result .= &endbodytag($args);
1.330 albertel 7464: }
1.1080 raeburn 7465: unless ($args->{'notbody'}) {
7466: $result .= "\n</html>";
7467: }
1.330 albertel 7468:
1.315 albertel 7469: if ($args->{'js_ready'}) {
1.317 albertel 7470: $result = &js_ready($result);
1.315 albertel 7471: }
1.335 albertel 7472:
1.320 albertel 7473: if ($args->{'html_encode'}) {
7474: $result = &html_encode($result);
7475: }
1.335 albertel 7476:
1.315 albertel 7477: return $result;
7478: }
7479:
1.1034 www 7480: sub wishlist_window {
7481: return(<<'ENDWISHLIST');
1.1046 raeburn 7482: <script type="text/javascript">
1.1034 www 7483: // <![CDATA[
7484: // <!-- BEGIN LON-CAPA Internal
7485: function set_wishlistlink(title, path) {
7486: if (!title) {
7487: title = document.title;
7488: title = title.replace(/^LON-CAPA /,'');
7489: }
7490: if (!path) {
7491: path = location.pathname;
7492: }
7493: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7494: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7495: }
7496: // END LON-CAPA Internal -->
7497: // ]]>
7498: </script>
7499: ENDWISHLIST
7500: }
7501:
1.1030 www 7502: sub modal_window {
7503: return(<<'ENDMODAL');
1.1046 raeburn 7504: <script type="text/javascript">
1.1030 www 7505: // <![CDATA[
7506: // <!-- BEGIN LON-CAPA Internal
7507: var modalWindow = {
7508: parent:"body",
7509: windowId:null,
7510: content:null,
7511: width:null,
7512: height:null,
7513: close:function()
7514: {
7515: $(".LCmodal-window").remove();
7516: $(".LCmodal-overlay").remove();
7517: },
7518: open:function()
7519: {
7520: var modal = "";
7521: modal += "<div class=\"LCmodal-overlay\"></div>";
7522: 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;\">";
7523: modal += this.content;
7524: modal += "</div>";
7525:
7526: $(this.parent).append(modal);
7527:
7528: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7529: $(".LCclose-window").click(function(){modalWindow.close();});
7530: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7531: }
7532: };
1.1031 www 7533: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7534: {
7535: modalWindow.windowId = "myModal";
7536: modalWindow.width = width;
7537: modalWindow.height = height;
1.1031 www 7538: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7539: modalWindow.open();
7540: };
7541: // END LON-CAPA Internal -->
7542: // ]]>
7543: </script>
7544: ENDMODAL
7545: }
7546:
7547: sub modal_link {
1.1052 www 7548: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7549: unless ($width) { $width=480; }
7550: unless ($height) { $height=400; }
1.1031 www 7551: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7552: my $target_attr;
7553: if (defined($target)) {
7554: $target_attr = 'target="'.$target.'"';
7555: }
7556: return <<"ENDLINK";
7557: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7558: $linktext</a>
7559: ENDLINK
1.1030 www 7560: }
7561:
1.1032 www 7562: sub modal_adhoc_script {
7563: my ($funcname,$width,$height,$content)=@_;
7564: return (<<ENDADHOC);
1.1046 raeburn 7565: <script type="text/javascript">
1.1032 www 7566: // <![CDATA[
7567: var $funcname = function()
7568: {
7569: modalWindow.windowId = "myModal";
7570: modalWindow.width = $width;
7571: modalWindow.height = $height;
7572: modalWindow.content = '$content';
7573: modalWindow.open();
7574: };
7575: // ]]>
7576: </script>
7577: ENDADHOC
7578: }
7579:
1.1041 www 7580: sub modal_adhoc_inner {
7581: my ($funcname,$width,$height,$content)=@_;
7582: my $innerwidth=$width-20;
7583: $content=&js_ready(
1.1042 www 7584: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7585: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7586: $content.
7587: &end_scrollbox().
7588: &end_page()
7589: );
7590: return &modal_adhoc_script($funcname,$width,$height,$content);
7591: }
7592:
7593: sub modal_adhoc_window {
7594: my ($funcname,$width,$height,$content,$linktext)=@_;
7595: return &modal_adhoc_inner($funcname,$width,$height,$content).
7596: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7597: }
7598:
7599: sub modal_adhoc_launch {
7600: my ($funcname,$width,$height,$content)=@_;
7601: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7602: <script type="text/javascript">
7603: // <![CDATA[
7604: $funcname();
7605: // ]]>
7606: </script>
7607: ENDLAUNCH
7608: }
7609:
7610: sub modal_adhoc_close {
7611: return (<<ENDCLOSE);
7612: <script type="text/javascript">
7613: // <![CDATA[
7614: modalWindow.close();
7615: // ]]>
7616: </script>
7617: ENDCLOSE
7618: }
7619:
1.1038 www 7620: sub togglebox_script {
7621: return(<<ENDTOGGLE);
7622: <script type="text/javascript">
7623: // <![CDATA[
7624: function LCtoggleDisplay(id,hidetext,showtext) {
7625: link = document.getElementById(id + "link").childNodes[0];
7626: with (document.getElementById(id).style) {
7627: if (display == "none" ) {
7628: display = "inline";
7629: link.nodeValue = hidetext;
7630: } else {
7631: display = "none";
7632: link.nodeValue = showtext;
7633: }
7634: }
7635: }
7636: // ]]>
7637: </script>
7638: ENDTOGGLE
7639: }
7640:
1.1039 www 7641: sub start_togglebox {
7642: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7643: unless ($heading) { $heading=''; } else { $heading.=' '; }
7644: unless ($showtext) { $showtext=&mt('show'); }
7645: unless ($hidetext) { $hidetext=&mt('hide'); }
7646: unless ($headerbg) { $headerbg='#FFFFFF'; }
7647: return &start_data_table().
7648: &start_data_table_header_row().
7649: '<td bgcolor="'.$headerbg.'">'.$heading.
7650: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7651: $showtext.'\')">'.$showtext.'</a>]</td>'.
7652: &end_data_table_header_row().
7653: '<tr id="'.$id.'" style="display:none""><td>';
7654: }
7655:
7656: sub end_togglebox {
7657: return '</td></tr>'.&end_data_table();
7658: }
7659:
1.1041 www 7660: sub LCprogressbar_script {
1.1045 www 7661: my ($id)=@_;
1.1041 www 7662: return(<<ENDPROGRESS);
7663: <script type="text/javascript">
7664: // <![CDATA[
1.1045 www 7665: \$('#progressbar$id').progressbar({
1.1041 www 7666: value: 0,
7667: change: function(event, ui) {
7668: var newVal = \$(this).progressbar('option', 'value');
7669: \$('.pblabel', this).text(LCprogressTxt);
7670: }
7671: });
7672: // ]]>
7673: </script>
7674: ENDPROGRESS
7675: }
7676:
7677: sub LCprogressbarUpdate_script {
7678: return(<<ENDPROGRESSUPDATE);
7679: <style type="text/css">
7680: .ui-progressbar { position:relative; }
7681: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7682: </style>
7683: <script type="text/javascript">
7684: // <![CDATA[
1.1045 www 7685: var LCprogressTxt='---';
7686:
7687: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7688: LCprogressTxt=progresstext;
1.1045 www 7689: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7690: }
7691: // ]]>
7692: </script>
7693: ENDPROGRESSUPDATE
7694: }
7695:
1.1042 www 7696: my $LClastpercent;
1.1045 www 7697: my $LCidcnt;
7698: my $LCcurrentid;
1.1042 www 7699:
1.1041 www 7700: sub LCprogressbar {
1.1042 www 7701: my ($r)=(@_);
7702: $LClastpercent=0;
1.1045 www 7703: $LCidcnt++;
7704: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7705: my $starting=&mt('Starting');
7706: my $content=(<<ENDPROGBAR);
7707: <p>
1.1045 www 7708: <div id="progressbar$LCcurrentid">
1.1041 www 7709: <span class="pblabel">$starting</span>
7710: </div>
7711: </p>
7712: ENDPROGBAR
1.1045 www 7713: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7714: }
7715:
7716: sub LCprogressbarUpdate {
1.1042 www 7717: my ($r,$val,$text)=@_;
7718: unless ($val) {
7719: if ($LClastpercent) {
7720: $val=$LClastpercent;
7721: } else {
7722: $val=0;
7723: }
7724: }
1.1041 www 7725: if ($val<0) { $val=0; }
7726: if ($val>100) { $val=0; }
1.1042 www 7727: $LClastpercent=$val;
1.1041 www 7728: unless ($text) { $text=$val.'%'; }
7729: $text=&js_ready($text);
1.1044 www 7730: &r_print($r,<<ENDUPDATE);
1.1041 www 7731: <script type="text/javascript">
7732: // <![CDATA[
1.1045 www 7733: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7734: // ]]>
7735: </script>
7736: ENDUPDATE
1.1035 www 7737: }
7738:
1.1042 www 7739: sub LCprogressbarClose {
7740: my ($r)=@_;
7741: $LClastpercent=0;
1.1044 www 7742: &r_print($r,<<ENDCLOSE);
1.1042 www 7743: <script type="text/javascript">
7744: // <![CDATA[
1.1045 www 7745: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7746: // ]]>
7747: </script>
7748: ENDCLOSE
1.1044 www 7749: }
7750:
7751: sub r_print {
7752: my ($r,$to_print)=@_;
7753: if ($r) {
7754: $r->print($to_print);
7755: $r->rflush();
7756: } else {
7757: print($to_print);
7758: }
1.1042 www 7759: }
7760:
1.320 albertel 7761: sub html_encode {
7762: my ($result) = @_;
7763:
1.322 albertel 7764: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7765:
7766: return $result;
7767: }
1.1044 www 7768:
1.317 albertel 7769: sub js_ready {
7770: my ($result) = @_;
7771:
1.323 albertel 7772: $result =~ s/[\n\r]/ /xmsg;
7773: $result =~ s/\\/\\\\/xmsg;
7774: $result =~ s/'/\\'/xmsg;
1.372 albertel 7775: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7776:
7777: return $result;
7778: }
7779:
1.315 albertel 7780: sub validate_page {
7781: if ( exists($env{'internal.start_page'})
1.316 albertel 7782: && $env{'internal.start_page'} > 1) {
7783: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7784: $env{'internal.start_page'}.' '.
1.316 albertel 7785: $ENV{'request.filename'});
1.315 albertel 7786: }
7787: if ( exists($env{'internal.end_page'})
1.316 albertel 7788: && $env{'internal.end_page'} > 1) {
7789: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7790: $env{'internal.end_page'}.' '.
1.316 albertel 7791: $env{'request.filename'});
1.315 albertel 7792: }
7793: if ( exists($env{'internal.start_page'})
7794: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7795: &Apache::lonnet::logthis('start_page called without end_page '.
7796: $env{'request.filename'});
1.315 albertel 7797: }
7798: if ( ! exists($env{'internal.start_page'})
7799: && exists($env{'internal.end_page'})) {
1.316 albertel 7800: &Apache::lonnet::logthis('end_page called without start_page'.
7801: $env{'request.filename'});
1.315 albertel 7802: }
1.306 albertel 7803: }
1.315 albertel 7804:
1.996 www 7805:
7806: sub start_scrollbox {
1.1075 raeburn 7807: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7808: unless ($outerwidth) { $outerwidth='520px'; }
7809: unless ($width) { $width='500px'; }
7810: unless ($height) { $height='200px'; }
1.1075 raeburn 7811: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7812: if ($id ne '') {
1.1020 raeburn 7813: $table_id = " id='table_$id'";
7814: $div_id = " id='div_$id'";
1.1018 raeburn 7815: }
1.1075 raeburn 7816: if ($bgcolor ne '') {
7817: $tdcol = "background-color: $bgcolor;";
7818: }
7819: return <<"END";
7820: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol"><div style="overflow:auto; width:$width; height: $height;"$div_id>
7821: END
1.996 www 7822: }
7823:
7824: sub end_scrollbox {
1.1036 www 7825: return '</div></td></tr></table>';
1.996 www 7826: }
7827:
1.318 albertel 7828: sub simple_error_page {
7829: my ($r,$title,$msg) = @_;
7830: my $page =
7831: &Apache::loncommon::start_page($title).
7832: &mt($msg).
7833: &Apache::loncommon::end_page();
7834: if (ref($r)) {
7835: $r->print($page);
1.327 albertel 7836: return;
1.318 albertel 7837: }
7838: return $page;
7839: }
1.347 albertel 7840:
7841: {
1.610 albertel 7842: my @row_count;
1.961 onken 7843:
7844: sub start_data_table_count {
7845: unshift(@row_count, 0);
7846: return;
7847: }
7848:
7849: sub end_data_table_count {
7850: shift(@row_count);
7851: return;
7852: }
7853:
1.347 albertel 7854: sub start_data_table {
1.1018 raeburn 7855: my ($add_class,$id) = @_;
1.422 albertel 7856: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7857: my $table_id;
7858: if (defined($id)) {
7859: $table_id = ' id="'.$id.'"';
7860: }
1.961 onken 7861: &start_data_table_count();
1.1018 raeburn 7862: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7863: }
7864:
7865: sub end_data_table {
1.961 onken 7866: &end_data_table_count();
1.389 albertel 7867: return '</table>'."\n";;
1.347 albertel 7868: }
7869:
7870: sub start_data_table_row {
1.974 wenzelju 7871: my ($add_class, $id) = @_;
1.610 albertel 7872: $row_count[0]++;
7873: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7874: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7875: $id = (' id="'.$id.'"') unless ($id eq '');
7876: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7877: }
1.471 banghart 7878:
7879: sub continue_data_table_row {
1.974 wenzelju 7880: my ($add_class, $id) = @_;
1.610 albertel 7881: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7882: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7883: $id = (' id="'.$id.'"') unless ($id eq '');
7884: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7885: }
1.347 albertel 7886:
7887: sub end_data_table_row {
1.389 albertel 7888: return '</tr>'."\n";;
1.347 albertel 7889: }
1.367 www 7890:
1.421 albertel 7891: sub start_data_table_empty_row {
1.707 bisitz 7892: # $row_count[0]++;
1.421 albertel 7893: return '<tr class="LC_empty_row" >'."\n";;
7894: }
7895:
7896: sub end_data_table_empty_row {
7897: return '</tr>'."\n";;
7898: }
7899:
1.367 www 7900: sub start_data_table_header_row {
1.389 albertel 7901: return '<tr class="LC_header_row">'."\n";;
1.367 www 7902: }
7903:
7904: sub end_data_table_header_row {
1.389 albertel 7905: return '</tr>'."\n";;
1.367 www 7906: }
1.890 droeschl 7907:
7908: sub data_table_caption {
7909: my $caption = shift;
7910: return "<caption class=\"LC_caption\">$caption</caption>";
7911: }
1.347 albertel 7912: }
7913:
1.548 albertel 7914: =pod
7915:
7916: =item * &inhibit_menu_check($arg)
7917:
7918: Checks for a inhibitmenu state and generates output to preserve it
7919:
7920: Inputs: $arg - can be any of
7921: - undef - in which case the return value is a string
7922: to add into arguments list of a uri
7923: - 'input' - in which case the return value is a HTML
7924: <form> <input> field of type hidden to
7925: preserve the value
7926: - a url - in which case the return value is the url with
7927: the neccesary cgi args added to preserve the
7928: inhibitmenu state
7929: - a ref to a url - no return value, but the string is
7930: updated to include the neccessary cgi
7931: args to preserve the inhibitmenu state
7932:
7933: =cut
7934:
7935: sub inhibit_menu_check {
7936: my ($arg) = @_;
7937: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7938: if ($arg eq 'input') {
7939: if ($env{'form.inhibitmenu'}) {
7940: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7941: } else {
7942: return
7943: }
7944: }
7945: if ($env{'form.inhibitmenu'}) {
7946: if (ref($arg)) {
7947: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7948: } elsif ($arg eq '') {
7949: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7950: } else {
7951: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7952: }
7953: }
7954: if (!ref($arg)) {
7955: return $arg;
7956: }
7957: }
7958:
1.251 albertel 7959: ###############################################
1.182 matthew 7960:
7961: =pod
7962:
1.549 albertel 7963: =back
7964:
7965: =head1 User Information Routines
7966:
7967: =over 4
7968:
1.405 albertel 7969: =item * &get_users_function()
1.182 matthew 7970:
7971: Used by &bodytag to determine the current users primary role.
7972: Returns either 'student','coordinator','admin', or 'author'.
7973:
7974: =cut
7975:
7976: ###############################################
7977: sub get_users_function {
1.815 tempelho 7978: my $function = 'norole';
1.818 tempelho 7979: if ($env{'request.role'}=~/^(st)/) {
7980: $function='student';
7981: }
1.907 raeburn 7982: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7983: $function='coordinator';
7984: }
1.258 albertel 7985: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7986: $function='admin';
7987: }
1.826 bisitz 7988: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7989: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7990: $function='author';
7991: }
7992: return $function;
1.54 www 7993: }
1.99 www 7994:
7995: ###############################################
7996:
1.233 raeburn 7997: =pod
7998:
1.821 raeburn 7999: =item * &show_course()
8000:
8001: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8002: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8003:
8004: Inputs:
8005: None
8006:
8007: Outputs:
8008: Scalar: 1 if 'Course' to be used, 0 otherwise.
8009:
8010: =cut
8011:
8012: ###############################################
8013: sub show_course {
8014: my $course = !$env{'user.adv'};
8015: if (!$env{'user.adv'}) {
8016: foreach my $env (keys(%env)) {
8017: next if ($env !~ m/^user\.priv\./);
8018: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8019: $course = 0;
8020: last;
8021: }
8022: }
8023: }
8024: return $course;
8025: }
8026:
8027: ###############################################
8028:
8029: =pod
8030:
1.542 raeburn 8031: =item * &check_user_status()
1.274 raeburn 8032:
8033: Determines current status of supplied role for a
8034: specific user. Roles can be active, previous or future.
8035:
8036: Inputs:
8037: user's domain, user's username, course's domain,
1.375 raeburn 8038: course's number, optional section ID.
1.274 raeburn 8039:
8040: Outputs:
8041: role status: active, previous or future.
8042:
8043: =cut
8044:
8045: sub check_user_status {
1.412 raeburn 8046: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8047: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8048: my @uroles = keys %userinfo;
8049: my $srchstr;
8050: my $active_chk = 'none';
1.412 raeburn 8051: my $now = time;
1.274 raeburn 8052: if (@uroles > 0) {
1.908 raeburn 8053: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8054: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8055: } else {
1.412 raeburn 8056: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8057: }
8058: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8059: my $role_end = 0;
8060: my $role_start = 0;
8061: $active_chk = 'active';
1.412 raeburn 8062: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8063: $role_end = $1;
8064: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8065: $role_start = $1;
1.274 raeburn 8066: }
8067: }
8068: if ($role_start > 0) {
1.412 raeburn 8069: if ($now < $role_start) {
1.274 raeburn 8070: $active_chk = 'future';
8071: }
8072: }
8073: if ($role_end > 0) {
1.412 raeburn 8074: if ($now > $role_end) {
1.274 raeburn 8075: $active_chk = 'previous';
8076: }
8077: }
8078: }
8079: }
8080: return $active_chk;
8081: }
8082:
8083: ###############################################
8084:
8085: =pod
8086:
1.405 albertel 8087: =item * &get_sections()
1.233 raeburn 8088:
8089: Determines all the sections for a course including
8090: sections with students and sections containing other roles.
1.419 raeburn 8091: Incoming parameters:
8092:
8093: 1. domain
8094: 2. course number
8095: 3. reference to array containing roles for which sections should
8096: be gathered (optional).
8097: 4. reference to array containing status types for which sections
8098: should be gathered (optional).
8099:
8100: If the third argument is undefined, sections are gathered for any role.
8101: If the fourth argument is undefined, sections are gathered for any status.
8102: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8103:
1.374 raeburn 8104: Returns section hash (keys are section IDs, values are
8105: number of users in each section), subject to the
1.419 raeburn 8106: optional roles filter, optional status filter
1.233 raeburn 8107:
8108: =cut
8109:
8110: ###############################################
8111: sub get_sections {
1.419 raeburn 8112: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8113: if (!defined($cdom) || !defined($cnum)) {
8114: my $cid = $env{'request.course.id'};
8115:
8116: return if (!defined($cid));
8117:
8118: $cdom = $env{'course.'.$cid.'.domain'};
8119: $cnum = $env{'course.'.$cid.'.num'};
8120: }
8121:
8122: my %sectioncount;
1.419 raeburn 8123: my $now = time;
1.240 albertel 8124:
1.366 albertel 8125: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8126: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8127: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8128: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8129: my $start_index = &Apache::loncoursedata::CL_START();
8130: my $end_index = &Apache::loncoursedata::CL_END();
8131: my $status;
1.366 albertel 8132: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8133: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8134: $data->[$status_index],
8135: $data->[$start_index],
8136: $data->[$end_index]);
8137: if ($stu_status eq 'Active') {
8138: $status = 'active';
8139: } elsif ($end < $now) {
8140: $status = 'previous';
8141: } elsif ($start > $now) {
8142: $status = 'future';
8143: }
8144: if ($section ne '-1' && $section !~ /^\s*$/) {
8145: if ((!defined($possible_status)) || (($status ne '') &&
8146: (grep/^\Q$status\E$/,@{$possible_status}))) {
8147: $sectioncount{$section}++;
8148: }
1.240 albertel 8149: }
8150: }
8151: }
8152: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8153: foreach my $user (sort(keys(%courseroles))) {
8154: if ($user !~ /^(\w{2})/) { next; }
8155: my ($role) = ($user =~ /^(\w{2})/);
8156: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8157: my ($section,$status);
1.240 albertel 8158: if ($role eq 'cr' &&
8159: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8160: $section=$1;
8161: }
8162: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8163: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8164: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8165: if ($end == -1 && $start == -1) {
8166: next; #deleted role
8167: }
8168: if (!defined($possible_status)) {
8169: $sectioncount{$section}++;
8170: } else {
8171: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8172: $status = 'active';
8173: } elsif ($end < $now) {
8174: $status = 'future';
8175: } elsif ($start > $now) {
8176: $status = 'previous';
8177: }
8178: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8179: $sectioncount{$section}++;
8180: }
8181: }
1.233 raeburn 8182: }
1.366 albertel 8183: return %sectioncount;
1.233 raeburn 8184: }
8185:
1.274 raeburn 8186: ###############################################
1.294 raeburn 8187:
8188: =pod
1.405 albertel 8189:
8190: =item * &get_course_users()
8191:
1.275 raeburn 8192: Retrieves usernames:domains for users in the specified course
8193: with specific role(s), and access status.
8194:
8195: Incoming parameters:
1.277 albertel 8196: 1. course domain
8197: 2. course number
8198: 3. access status: users must have - either active,
1.275 raeburn 8199: previous, future, or all.
1.277 albertel 8200: 4. reference to array of permissible roles
1.288 raeburn 8201: 5. reference to array of section restrictions (optional)
8202: 6. reference to results object (hash of hashes).
8203: 7. reference to optional userdata hash
1.609 raeburn 8204: 8. reference to optional statushash
1.630 raeburn 8205: 9. flag if privileged users (except those set to unhide in
8206: course settings) should be excluded
1.609 raeburn 8207: Keys of top level results hash are roles.
1.275 raeburn 8208: Keys of inner hashes are username:domain, with
8209: values set to access type.
1.288 raeburn 8210: Optional userdata hash returns an array with arguments in the
8211: same order as loncoursedata::get_classlist() for student data.
8212:
1.609 raeburn 8213: Optional statushash returns
8214:
1.288 raeburn 8215: Entries for end, start, section and status are blank because
8216: of the possibility of multiple values for non-student roles.
8217:
1.275 raeburn 8218: =cut
1.405 albertel 8219:
1.275 raeburn 8220: ###############################################
1.405 albertel 8221:
1.275 raeburn 8222: sub get_course_users {
1.630 raeburn 8223: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8224: my %idx = ();
1.419 raeburn 8225: my %seclists;
1.288 raeburn 8226:
8227: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8228: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8229: $idx{end} = &Apache::loncoursedata::CL_END();
8230: $idx{start} = &Apache::loncoursedata::CL_START();
8231: $idx{id} = &Apache::loncoursedata::CL_ID();
8232: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8233: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8234: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8235:
1.290 albertel 8236: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8237: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8238: my $now = time;
1.277 albertel 8239: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8240: my $match = 0;
1.412 raeburn 8241: my $secmatch = 0;
1.419 raeburn 8242: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8243: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8244: if ($section eq '') {
8245: $section = 'none';
8246: }
1.291 albertel 8247: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8248: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8249: $secmatch = 1;
8250: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8251: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8252: $secmatch = 1;
8253: }
8254: } else {
1.419 raeburn 8255: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8256: $secmatch = 1;
8257: }
1.290 albertel 8258: }
1.412 raeburn 8259: if (!$secmatch) {
8260: next;
8261: }
1.419 raeburn 8262: }
1.275 raeburn 8263: if (defined($$types{'active'})) {
1.288 raeburn 8264: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8265: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8266: $match = 1;
1.275 raeburn 8267: }
8268: }
8269: if (defined($$types{'previous'})) {
1.609 raeburn 8270: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8271: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8272: $match = 1;
1.275 raeburn 8273: }
8274: }
8275: if (defined($$types{'future'})) {
1.609 raeburn 8276: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8277: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8278: $match = 1;
1.275 raeburn 8279: }
8280: }
1.609 raeburn 8281: if ($match) {
8282: push(@{$seclists{$student}},$section);
8283: if (ref($userdata) eq 'HASH') {
8284: $$userdata{$student} = $$classlist{$student};
8285: }
8286: if (ref($statushash) eq 'HASH') {
8287: $statushash->{$student}{'st'}{$section} = $status;
8288: }
1.288 raeburn 8289: }
1.275 raeburn 8290: }
8291: }
1.412 raeburn 8292: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8293: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8294: my $now = time;
1.609 raeburn 8295: my %displaystatus = ( previous => 'Expired',
8296: active => 'Active',
8297: future => 'Future',
8298: );
1.630 raeburn 8299: my %nothide;
8300: if ($hidepriv) {
8301: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8302: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8303: if ($user !~ /:/) {
8304: $nothide{join(':',split(/[\@]/,$user))}=1;
8305: } else {
8306: $nothide{$user} = 1;
8307: }
8308: }
8309: }
1.439 raeburn 8310: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8311: my $match = 0;
1.412 raeburn 8312: my $secmatch = 0;
1.439 raeburn 8313: my $status;
1.412 raeburn 8314: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8315: $user =~ s/:$//;
1.439 raeburn 8316: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8317: if ($end == -1 || $start == -1) {
8318: next;
8319: }
8320: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8321: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8322: my ($uname,$udom) = split(/:/,$user);
8323: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8324: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8325: $secmatch = 1;
8326: } elsif ($usec eq '') {
1.420 albertel 8327: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8328: $secmatch = 1;
8329: }
8330: } else {
8331: if (grep(/^\Q$usec\E$/,@{$sections})) {
8332: $secmatch = 1;
8333: }
8334: }
8335: if (!$secmatch) {
8336: next;
8337: }
1.288 raeburn 8338: }
1.419 raeburn 8339: if ($usec eq '') {
8340: $usec = 'none';
8341: }
1.275 raeburn 8342: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8343: if ($hidepriv) {
8344: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8345: (!$nothide{$uname.':'.$udom})) {
8346: next;
8347: }
8348: }
1.503 raeburn 8349: if ($end > 0 && $end < $now) {
1.439 raeburn 8350: $status = 'previous';
8351: } elsif ($start > $now) {
8352: $status = 'future';
8353: } else {
8354: $status = 'active';
8355: }
1.277 albertel 8356: foreach my $type (keys(%{$types})) {
1.275 raeburn 8357: if ($status eq $type) {
1.420 albertel 8358: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8359: push(@{$$users{$role}{$user}},$type);
8360: }
1.288 raeburn 8361: $match = 1;
8362: }
8363: }
1.419 raeburn 8364: if (($match) && (ref($userdata) eq 'HASH')) {
8365: if (!exists($$userdata{$uname.':'.$udom})) {
8366: &get_user_info($udom,$uname,\%idx,$userdata);
8367: }
1.420 albertel 8368: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8369: push(@{$seclists{$uname.':'.$udom}},$usec);
8370: }
1.609 raeburn 8371: if (ref($statushash) eq 'HASH') {
8372: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8373: }
1.275 raeburn 8374: }
8375: }
8376: }
8377: }
1.290 albertel 8378: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8379: if ((defined($cdom)) && (defined($cnum))) {
8380: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8381: if ( defined($csettings{'internal.courseowner'}) ) {
8382: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8383: next if ($owner eq '');
8384: my ($ownername,$ownerdom);
8385: if ($owner =~ /^([^:]+):([^:]+)$/) {
8386: $ownername = $1;
8387: $ownerdom = $2;
8388: } else {
8389: $ownername = $owner;
8390: $ownerdom = $cdom;
8391: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8392: }
8393: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8394: if (defined($userdata) &&
1.609 raeburn 8395: !exists($$userdata{$owner})) {
8396: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8397: if (!grep(/^none$/,@{$seclists{$owner}})) {
8398: push(@{$seclists{$owner}},'none');
8399: }
8400: if (ref($statushash) eq 'HASH') {
8401: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8402: }
1.290 albertel 8403: }
1.279 raeburn 8404: }
8405: }
8406: }
1.419 raeburn 8407: foreach my $user (keys(%seclists)) {
8408: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8409: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8410: }
1.275 raeburn 8411: }
8412: return;
8413: }
8414:
1.288 raeburn 8415: sub get_user_info {
8416: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8417: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8418: &plainname($uname,$udom,'lastname');
1.291 albertel 8419: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8420: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8421: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8422: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8423: return;
8424: }
1.275 raeburn 8425:
1.472 raeburn 8426: ###############################################
8427:
8428: =pod
8429:
8430: =item * &get_user_quota()
8431:
8432: Retrieves quota assigned for storage of portfolio files for a user
8433:
8434: Incoming parameters:
8435: 1. user's username
8436: 2. user's domain
8437:
8438: Returns:
1.536 raeburn 8439: 1. Disk quota (in Mb) assigned to student.
8440: 2. (Optional) Type of setting: custom or default
8441: (individually assigned or default for user's
8442: institutional status).
8443: 3. (Optional) - User's institutional status (e.g., faculty, staff
8444: or student - types as defined in localenroll::inst_usertypes
8445: for user's domain, which determines default quota for user.
8446: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8447:
8448: If a value has been stored in the user's environment,
1.536 raeburn 8449: it will return that, otherwise it returns the maximal default
8450: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8451:
8452: =cut
8453:
8454: ###############################################
8455:
8456:
8457: sub get_user_quota {
8458: my ($uname,$udom) = @_;
1.536 raeburn 8459: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8460: if (!defined($udom)) {
8461: $udom = $env{'user.domain'};
8462: }
8463: if (!defined($uname)) {
8464: $uname = $env{'user.name'};
8465: }
8466: if (($udom eq '' || $uname eq '') ||
8467: ($udom eq 'public') && ($uname eq 'public')) {
8468: $quota = 0;
1.536 raeburn 8469: $quotatype = 'default';
8470: $defquota = 0;
1.472 raeburn 8471: } else {
1.536 raeburn 8472: my $inststatus;
1.472 raeburn 8473: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8474: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8475: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8476: } else {
1.536 raeburn 8477: my %userenv =
8478: &Apache::lonnet::get('environment',['portfolioquota',
8479: 'inststatus'],$udom,$uname);
1.472 raeburn 8480: my ($tmp) = keys(%userenv);
8481: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8482: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8483: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8484: } else {
8485: undef(%userenv);
8486: }
8487: }
1.536 raeburn 8488: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8489: if ($quota eq '') {
1.536 raeburn 8490: $quota = $defquota;
8491: $quotatype = 'default';
8492: } else {
8493: $quotatype = 'custom';
1.472 raeburn 8494: }
8495: }
1.536 raeburn 8496: if (wantarray) {
8497: return ($quota,$quotatype,$settingstatus,$defquota);
8498: } else {
8499: return $quota;
8500: }
1.472 raeburn 8501: }
8502:
8503: ###############################################
8504:
8505: =pod
8506:
8507: =item * &default_quota()
8508:
1.536 raeburn 8509: Retrieves default quota assigned for storage of user portfolio files,
8510: given an (optional) user's institutional status.
1.472 raeburn 8511:
8512: Incoming parameters:
8513: 1. domain
1.536 raeburn 8514: 2. (Optional) institutional status(es). This is a : separated list of
8515: status types (e.g., faculty, staff, student etc.)
8516: which apply to the user for whom the default is being retrieved.
8517: If the institutional status string in undefined, the domain
8518: default quota will be returned.
1.472 raeburn 8519:
8520: Returns:
8521: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8522: 2. (Optional) institutional type which determined the value of the
8523: default quota.
1.472 raeburn 8524:
8525: If a value has been stored in the domain's configuration db,
8526: it will return that, otherwise it returns 20 (for backwards
8527: compatibility with domains which have not set up a configuration
8528: db file; the original statically defined portfolio quota was 20 Mb).
8529:
1.536 raeburn 8530: If the user's status includes multiple types (e.g., staff and student),
8531: the largest default quota which applies to the user determines the
8532: default quota returned.
8533:
1.780 raeburn 8534: =back
8535:
1.472 raeburn 8536: =cut
8537:
8538: ###############################################
8539:
8540:
8541: sub default_quota {
1.536 raeburn 8542: my ($udom,$inststatus) = @_;
8543: my ($defquota,$settingstatus);
8544: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8545: ['quotas'],$udom);
8546: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8547: if ($inststatus ne '') {
1.765 raeburn 8548: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8549: foreach my $item (@statuses) {
1.711 raeburn 8550: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8551: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8552: if ($defquota eq '') {
8553: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8554: $settingstatus = $item;
8555: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8556: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8557: $settingstatus = $item;
8558: }
8559: }
8560: } else {
8561: if ($quotahash{'quotas'}{$item} ne '') {
8562: if ($defquota eq '') {
8563: $defquota = $quotahash{'quotas'}{$item};
8564: $settingstatus = $item;
8565: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8566: $defquota = $quotahash{'quotas'}{$item};
8567: $settingstatus = $item;
8568: }
1.536 raeburn 8569: }
8570: }
8571: }
8572: }
8573: if ($defquota eq '') {
1.711 raeburn 8574: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8575: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8576: } else {
8577: $defquota = $quotahash{'quotas'}{'default'};
8578: }
1.536 raeburn 8579: $settingstatus = 'default';
8580: }
8581: } else {
8582: $settingstatus = 'default';
8583: $defquota = 20;
8584: }
8585: if (wantarray) {
8586: return ($defquota,$settingstatus);
1.472 raeburn 8587: } else {
1.536 raeburn 8588: return $defquota;
1.472 raeburn 8589: }
8590: }
8591:
1.384 raeburn 8592: sub get_secgrprole_info {
8593: my ($cdom,$cnum,$needroles,$type) = @_;
8594: my %sections_count = &get_sections($cdom,$cnum);
8595: my @sections = (sort {$a <=> $b} keys(%sections_count));
8596: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8597: my @groups = sort(keys(%curr_groups));
8598: my $allroles = [];
8599: my $rolehash;
8600: my $accesshash = {
8601: active => 'Currently has access',
8602: future => 'Will have future access',
8603: previous => 'Previously had access',
8604: };
8605: if ($needroles) {
8606: $rolehash = {'all' => 'all'};
1.385 albertel 8607: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8608: if (&Apache::lonnet::error(%user_roles)) {
8609: undef(%user_roles);
8610: }
8611: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8612: my ($role)=split(/\:/,$item,2);
8613: if ($role eq 'cr') { next; }
8614: if ($role =~ /^cr/) {
8615: $$rolehash{$role} = (split('/',$role))[3];
8616: } else {
8617: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8618: }
8619: }
8620: foreach my $key (sort(keys(%{$rolehash}))) {
8621: push(@{$allroles},$key);
8622: }
8623: push (@{$allroles},'st');
8624: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8625: }
8626: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8627: }
8628:
1.555 raeburn 8629: sub user_picker {
1.994 raeburn 8630: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8631: my $currdom = $dom;
8632: my %curr_selected = (
8633: srchin => 'dom',
1.580 raeburn 8634: srchby => 'lastname',
1.555 raeburn 8635: );
8636: my $srchterm;
1.625 raeburn 8637: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8638: if ($srch->{'srchby'} ne '') {
8639: $curr_selected{'srchby'} = $srch->{'srchby'};
8640: }
8641: if ($srch->{'srchin'} ne '') {
8642: $curr_selected{'srchin'} = $srch->{'srchin'};
8643: }
8644: if ($srch->{'srchtype'} ne '') {
8645: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8646: }
8647: if ($srch->{'srchdomain'} ne '') {
8648: $currdom = $srch->{'srchdomain'};
8649: }
8650: $srchterm = $srch->{'srchterm'};
8651: }
8652: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8653: 'usr' => 'Search criteria',
1.563 raeburn 8654: 'doma' => 'Domain/institution to search',
1.558 albertel 8655: 'uname' => 'username',
8656: 'lastname' => 'last name',
1.555 raeburn 8657: 'lastfirst' => 'last name, first name',
1.558 albertel 8658: 'crs' => 'in this course',
1.576 raeburn 8659: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8660: 'alc' => 'all LON-CAPA',
1.573 raeburn 8661: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8662: 'exact' => 'is',
8663: 'contains' => 'contains',
1.569 raeburn 8664: 'begins' => 'begins with',
1.571 raeburn 8665: 'youm' => "You must include some text to search for.",
8666: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8667: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8668: 'yomc' => "You must choose a domain when using an institutional directory search.",
8669: 'ymcd' => "You must choose a domain when using a domain search.",
8670: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8671: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8672: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8673: );
1.563 raeburn 8674: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8675: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8676:
8677: my @srchins = ('crs','dom','alc','instd');
8678:
8679: foreach my $option (@srchins) {
8680: # FIXME 'alc' option unavailable until
8681: # loncreateuser::print_user_query_page()
8682: # has been completed.
8683: next if ($option eq 'alc');
1.880 raeburn 8684: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8685: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8686: if ($curr_selected{'srchin'} eq $option) {
8687: $srchinsel .= '
8688: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8689: } else {
8690: $srchinsel .= '
8691: <option value="'.$option.'">'.$lt{$option}.'</option>';
8692: }
1.555 raeburn 8693: }
1.563 raeburn 8694: $srchinsel .= "\n </select>\n";
1.555 raeburn 8695:
8696: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8697: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8698: if ($curr_selected{'srchby'} eq $option) {
8699: $srchbysel .= '
8700: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8701: } else {
8702: $srchbysel .= '
8703: <option value="'.$option.'">'.$lt{$option}.'</option>';
8704: }
8705: }
8706: $srchbysel .= "\n </select>\n";
8707:
8708: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8709: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8710: if ($curr_selected{'srchtype'} eq $option) {
8711: $srchtypesel .= '
8712: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8713: } else {
8714: $srchtypesel .= '
8715: <option value="'.$option.'">'.$lt{$option}.'</option>';
8716: }
8717: }
8718: $srchtypesel .= "\n </select>\n";
8719:
1.558 albertel 8720: my ($newuserscript,$new_user_create);
1.994 raeburn 8721: my $context_dom = $env{'request.role.domain'};
8722: if ($context eq 'requestcrs') {
8723: if ($env{'form.coursedom'} ne '') {
8724: $context_dom = $env{'form.coursedom'};
8725: }
8726: }
1.556 raeburn 8727: if ($forcenewuser) {
1.576 raeburn 8728: if (ref($srch) eq 'HASH') {
1.994 raeburn 8729: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8730: if ($cancreate) {
8731: $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>';
8732: } else {
1.799 bisitz 8733: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8734: my %usertypetext = (
8735: official => 'institutional',
8736: unofficial => 'non-institutional',
8737: );
1.799 bisitz 8738: $new_user_create = '<p class="LC_warning">'
8739: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8740: .' '
8741: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8742: ,'<a href="'.$helplink.'">','</a>')
8743: .'</p><br />';
1.627 raeburn 8744: }
1.576 raeburn 8745: }
8746: }
8747:
1.556 raeburn 8748: $newuserscript = <<"ENDSCRIPT";
8749:
1.570 raeburn 8750: function setSearch(createnew,callingForm) {
1.556 raeburn 8751: if (createnew == 1) {
1.570 raeburn 8752: for (var i=0; i<callingForm.srchby.length; i++) {
8753: if (callingForm.srchby.options[i].value == 'uname') {
8754: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8755: }
8756: }
1.570 raeburn 8757: for (var i=0; i<callingForm.srchin.length; i++) {
8758: if ( callingForm.srchin.options[i].value == 'dom') {
8759: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8760: }
8761: }
1.570 raeburn 8762: for (var i=0; i<callingForm.srchtype.length; i++) {
8763: if (callingForm.srchtype.options[i].value == 'exact') {
8764: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8765: }
8766: }
1.570 raeburn 8767: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8768: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8769: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8770: }
8771: }
8772: }
8773: }
8774: ENDSCRIPT
1.558 albertel 8775:
1.556 raeburn 8776: }
8777:
1.555 raeburn 8778: my $output = <<"END_BLOCK";
1.556 raeburn 8779: <script type="text/javascript">
1.824 bisitz 8780: // <![CDATA[
1.570 raeburn 8781: function validateEntry(callingForm) {
1.558 albertel 8782:
1.556 raeburn 8783: var checkok = 1;
1.558 albertel 8784: var srchin;
1.570 raeburn 8785: for (var i=0; i<callingForm.srchin.length; i++) {
8786: if ( callingForm.srchin[i].checked ) {
8787: srchin = callingForm.srchin[i].value;
1.558 albertel 8788: }
8789: }
8790:
1.570 raeburn 8791: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8792: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8793: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8794: var srchterm = callingForm.srchterm.value;
8795: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8796: var msg = "";
8797:
8798: if (srchterm == "") {
8799: checkok = 0;
1.571 raeburn 8800: msg += "$lt{'youm'}\\n";
1.556 raeburn 8801: }
8802:
1.569 raeburn 8803: if (srchtype== 'begins') {
8804: if (srchterm.length < 2) {
8805: checkok = 0;
1.571 raeburn 8806: msg += "$lt{'thte'}\\n";
1.569 raeburn 8807: }
8808: }
8809:
1.556 raeburn 8810: if (srchtype== 'contains') {
8811: if (srchterm.length < 3) {
8812: checkok = 0;
1.571 raeburn 8813: msg += "$lt{'thet'}\\n";
1.556 raeburn 8814: }
8815: }
8816: if (srchin == 'instd') {
8817: if (srchdomain == '') {
8818: checkok = 0;
1.571 raeburn 8819: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8820: }
8821: }
8822: if (srchin == 'dom') {
8823: if (srchdomain == '') {
8824: checkok = 0;
1.571 raeburn 8825: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8826: }
8827: }
8828: if (srchby == 'lastfirst') {
8829: if (srchterm.indexOf(",") == -1) {
8830: checkok = 0;
1.571 raeburn 8831: msg += "$lt{'whus'}\\n";
1.556 raeburn 8832: }
8833: if (srchterm.indexOf(",") == srchterm.length -1) {
8834: checkok = 0;
1.571 raeburn 8835: msg += "$lt{'whse'}\\n";
1.556 raeburn 8836: }
8837: }
8838: if (checkok == 0) {
1.571 raeburn 8839: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8840: return;
8841: }
8842: if (checkok == 1) {
1.570 raeburn 8843: callingForm.submit();
1.556 raeburn 8844: }
8845: }
8846:
8847: $newuserscript
8848:
1.824 bisitz 8849: // ]]>
1.556 raeburn 8850: </script>
1.558 albertel 8851:
8852: $new_user_create
8853:
1.555 raeburn 8854: END_BLOCK
1.558 albertel 8855:
1.876 raeburn 8856: $output .= &Apache::lonhtmlcommon::start_pick_box().
8857: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8858: $domform.
8859: &Apache::lonhtmlcommon::row_closure().
8860: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8861: $srchbysel.
8862: $srchtypesel.
8863: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8864: $srchinsel.
8865: &Apache::lonhtmlcommon::row_closure(1).
8866: &Apache::lonhtmlcommon::end_pick_box().
8867: '<br />';
1.555 raeburn 8868: return $output;
8869: }
8870:
1.612 raeburn 8871: sub user_rule_check {
1.615 raeburn 8872: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8873: my $response;
8874: if (ref($usershash) eq 'HASH') {
8875: foreach my $user (keys(%{$usershash})) {
8876: my ($uname,$udom) = split(/:/,$user);
8877: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8878: my ($id,$newuser);
1.612 raeburn 8879: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8880: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8881: $id = $usershash->{$user}->{'id'};
8882: }
8883: my $inst_response;
8884: if (ref($checks) eq 'HASH') {
8885: if (defined($checks->{'username'})) {
1.615 raeburn 8886: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8887: &Apache::lonnet::get_instuser($udom,$uname);
8888: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8889: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8890: &Apache::lonnet::get_instuser($udom,undef,$id);
8891: }
1.615 raeburn 8892: } else {
8893: ($inst_response,%{$inst_results->{$user}}) =
8894: &Apache::lonnet::get_instuser($udom,$uname);
8895: return;
1.612 raeburn 8896: }
1.615 raeburn 8897: if (!$got_rules->{$udom}) {
1.612 raeburn 8898: my %domconfig = &Apache::lonnet::get_dom('configuration',
8899: ['usercreation'],$udom);
8900: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8901: foreach my $item ('username','id') {
1.612 raeburn 8902: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8903: $$curr_rules{$udom}{$item} =
8904: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8905: }
8906: }
8907: }
1.615 raeburn 8908: $got_rules->{$udom} = 1;
1.585 raeburn 8909: }
1.612 raeburn 8910: foreach my $item (keys(%{$checks})) {
8911: if (ref($$curr_rules{$udom}) eq 'HASH') {
8912: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8913: if (@{$$curr_rules{$udom}{$item}} > 0) {
8914: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8915: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8916: if ($rule_check{$rule}) {
8917: $$rulematch{$user}{$item} = $rule;
8918: if ($inst_response eq 'ok') {
1.615 raeburn 8919: if (ref($inst_results) eq 'HASH') {
8920: if (ref($inst_results->{$user}) eq 'HASH') {
8921: if (keys(%{$inst_results->{$user}}) == 0) {
8922: $$alerts{$item}{$udom}{$uname} = 1;
8923: }
1.612 raeburn 8924: }
8925: }
1.615 raeburn 8926: }
8927: last;
1.585 raeburn 8928: }
8929: }
8930: }
8931: }
8932: }
8933: }
8934: }
8935: }
1.612 raeburn 8936: return;
8937: }
8938:
8939: sub user_rule_formats {
8940: my ($domain,$domdesc,$curr_rules,$check) = @_;
8941: my %text = (
8942: 'username' => 'Usernames',
8943: 'id' => 'IDs',
8944: );
8945: my $output;
8946: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8947: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8948: if (@{$ruleorder} > 0) {
8949: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
8950: foreach my $rule (@{$ruleorder}) {
8951: if (ref($curr_rules) eq 'ARRAY') {
8952: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8953: if (ref($rules->{$rule}) eq 'HASH') {
8954: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8955: $rules->{$rule}{'desc'}.'</li>';
8956: }
8957: }
8958: }
8959: }
8960: $output .= '</ul>';
8961: }
8962: }
8963: return $output;
8964: }
8965:
8966: sub instrule_disallow_msg {
1.615 raeburn 8967: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8968: my $response;
8969: my %text = (
8970: item => 'username',
8971: items => 'usernames',
8972: match => 'matches',
8973: do => 'does',
8974: action => 'a username',
8975: one => 'one',
8976: );
8977: if ($count > 1) {
8978: $text{'item'} = 'usernames';
8979: $text{'match'} ='match';
8980: $text{'do'} = 'do';
8981: $text{'action'} = 'usernames',
8982: $text{'one'} = 'ones';
8983: }
8984: if ($checkitem eq 'id') {
8985: $text{'items'} = 'IDs';
8986: $text{'item'} = 'ID';
8987: $text{'action'} = 'an ID';
1.615 raeburn 8988: if ($count > 1) {
8989: $text{'item'} = 'IDs';
8990: $text{'action'} = 'IDs';
8991: }
1.612 raeburn 8992: }
1.674 bisitz 8993: $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 8994: if ($mode eq 'upload') {
8995: if ($checkitem eq 'username') {
8996: $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'}.");
8997: } elsif ($checkitem eq 'id') {
1.674 bisitz 8998: $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 8999: }
1.669 raeburn 9000: } elsif ($mode eq 'selfcreate') {
9001: if ($checkitem eq 'id') {
9002: $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.");
9003: }
1.615 raeburn 9004: } else {
9005: if ($checkitem eq 'username') {
9006: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9007: } elsif ($checkitem eq 'id') {
9008: $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.");
9009: }
1.612 raeburn 9010: }
9011: return $response;
1.585 raeburn 9012: }
9013:
1.624 raeburn 9014: sub personal_data_fieldtitles {
9015: my %fieldtitles = &Apache::lonlocal::texthash (
9016: id => 'Student/Employee ID',
9017: permanentemail => 'E-mail address',
9018: lastname => 'Last Name',
9019: firstname => 'First Name',
9020: middlename => 'Middle Name',
9021: generation => 'Generation',
9022: gen => 'Generation',
1.765 raeburn 9023: inststatus => 'Affiliation',
1.624 raeburn 9024: );
9025: return %fieldtitles;
9026: }
9027:
1.642 raeburn 9028: sub sorted_inst_types {
9029: my ($dom) = @_;
9030: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9031: my $othertitle = &mt('All users');
9032: if ($env{'request.course.id'}) {
1.668 raeburn 9033: $othertitle = &mt('Any users');
1.642 raeburn 9034: }
9035: my @types;
9036: if (ref($order) eq 'ARRAY') {
9037: @types = @{$order};
9038: }
9039: if (@types == 0) {
9040: if (ref($usertypes) eq 'HASH') {
9041: @types = sort(keys(%{$usertypes}));
9042: }
9043: }
9044: if (keys(%{$usertypes}) > 0) {
9045: $othertitle = &mt('Other users');
9046: }
9047: return ($othertitle,$usertypes,\@types);
9048: }
9049:
1.645 raeburn 9050: sub get_institutional_codes {
9051: my ($settings,$allcourses,$LC_code) = @_;
9052: # Get complete list of course sections to update
9053: my @currsections = ();
9054: my @currxlists = ();
9055: my $coursecode = $$settings{'internal.coursecode'};
9056:
9057: if ($$settings{'internal.sectionnums'} ne '') {
9058: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9059: }
9060:
9061: if ($$settings{'internal.crosslistings'} ne '') {
9062: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9063: }
9064:
9065: if (@currxlists > 0) {
9066: foreach (@currxlists) {
9067: if (m/^([^:]+):(\w*)$/) {
9068: unless (grep/^$1$/,@{$allcourses}) {
9069: push @{$allcourses},$1;
9070: $$LC_code{$1} = $2;
9071: }
9072: }
9073: }
9074: }
9075:
9076: if (@currsections > 0) {
9077: foreach (@currsections) {
9078: if (m/^(\w+):(\w*)$/) {
9079: my $sec = $coursecode.$1;
9080: my $lc_sec = $2;
9081: unless (grep/^$sec$/,@{$allcourses}) {
9082: push @{$allcourses},$sec;
9083: $$LC_code{$sec} = $lc_sec;
9084: }
9085: }
9086: }
9087: }
9088: return;
9089: }
9090:
1.971 raeburn 9091: sub get_standard_codeitems {
9092: return ('Year','Semester','Department','Number','Section');
9093: }
9094:
1.112 bowersj2 9095: =pod
9096:
1.780 raeburn 9097: =head1 Slot Helpers
9098:
9099: =over 4
9100:
9101: =item * sorted_slots()
9102:
1.1040 raeburn 9103: Sorts an array of slot names in order of an optional sort key,
9104: default sort is by slot start time (earliest first).
1.780 raeburn 9105:
9106: Inputs:
9107:
9108: =over 4
9109:
9110: slotsarr - Reference to array of unsorted slot names.
9111:
9112: slots - Reference to hash of hash, where outer hash keys are slot names.
9113:
1.1040 raeburn 9114: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9115:
1.549 albertel 9116: =back
9117:
1.780 raeburn 9118: Returns:
9119:
9120: =over 4
9121:
1.1040 raeburn 9122: sorted - An array of slot names sorted by a specified sort key
9123: (default sort key is start time of the slot).
1.780 raeburn 9124:
9125: =back
9126:
9127: =cut
9128:
9129:
9130: sub sorted_slots {
1.1040 raeburn 9131: my ($slotsarr,$slots,$sortkey) = @_;
9132: if ($sortkey eq '') {
9133: $sortkey = 'starttime';
9134: }
1.780 raeburn 9135: my @sorted;
9136: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9137: @sorted =
9138: sort {
9139: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9140: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9141: }
9142: if (ref($slots->{$a})) { return -1;}
9143: if (ref($slots->{$b})) { return 1;}
9144: return 0;
9145: } @{$slotsarr};
9146: }
9147: return @sorted;
9148: }
9149:
1.1040 raeburn 9150: =pod
9151:
9152: =item * get_future_slots()
9153:
9154: Inputs:
9155:
9156: =over 4
9157:
9158: cnum - course number
9159:
9160: cdom - course domain
9161:
9162: now - current UNIX time
9163:
9164: symb - optional symb
9165:
9166: =back
9167:
9168: Returns:
9169:
9170: =over 4
9171:
9172: sorted_reservable - ref to array of student_schedulable slots currently
9173: reservable, ordered by end date of reservation period.
9174:
9175: reservable_now - ref to hash of student_schedulable slots currently
9176: reservable.
9177:
9178: Keys in inner hash are:
9179: (a) symb: either blank or symb to which slot use is restricted.
9180: (b) endreserve: end date of reservation period.
9181:
9182: sorted_future - ref to array of student_schedulable slots reservable in
9183: the future, ordered by start date of reservation period.
9184:
9185: future_reservable - ref to hash of student_schedulable slots reservable
9186: in the future.
9187:
9188: Keys in inner hash are:
9189: (a) symb: either blank or symb to which slot use is restricted.
9190: (b) startreserve: start date of reservation period.
9191:
9192: =back
9193:
9194: =cut
9195:
9196: sub get_future_slots {
9197: my ($cnum,$cdom,$now,$symb) = @_;
9198: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9199: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9200: foreach my $slot (keys(%slots)) {
9201: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9202: if ($symb) {
9203: next if (($slots{$slot}->{'symb'} ne '') &&
9204: ($slots{$slot}->{'symb'} ne $symb));
9205: }
9206: if (($slots{$slot}->{'starttime'} > $now) &&
9207: ($slots{$slot}->{'endtime'} > $now)) {
9208: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9209: my $userallowed = 0;
9210: if ($slots{$slot}->{'allowedsections'}) {
9211: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9212: if (!defined($env{'request.role.sec'})
9213: && grep(/^No section assigned$/,@allowed_sec)) {
9214: $userallowed=1;
9215: } else {
9216: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9217: $userallowed=1;
9218: }
9219: }
9220: unless ($userallowed) {
9221: if (defined($env{'request.course.groups'})) {
9222: my @groups = split(/:/,$env{'request.course.groups'});
9223: foreach my $group (@groups) {
9224: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9225: $userallowed=1;
9226: last;
9227: }
9228: }
9229: }
9230: }
9231: }
9232: if ($slots{$slot}->{'allowedusers'}) {
9233: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9234: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9235: if (grep(/^\Q$user\E$/,@allowed_users)) {
9236: $userallowed = 1;
9237: }
9238: }
9239: next unless($userallowed);
9240: }
9241: my $startreserve = $slots{$slot}->{'startreserve'};
9242: my $endreserve = $slots{$slot}->{'endreserve'};
9243: my $symb = $slots{$slot}->{'symb'};
9244: if (($startreserve < $now) &&
9245: (!$endreserve || $endreserve > $now)) {
9246: my $lastres = $endreserve;
9247: if (!$lastres) {
9248: $lastres = $slots{$slot}->{'starttime'};
9249: }
9250: $reservable_now{$slot} = {
9251: symb => $symb,
9252: endreserve => $lastres
9253: };
9254: } elsif (($startreserve > $now) &&
9255: (!$endreserve || $endreserve > $startreserve)) {
9256: $future_reservable{$slot} = {
9257: symb => $symb,
9258: startreserve => $startreserve
9259: };
9260: }
9261: }
9262: }
9263: my @unsorted_reservable = keys(%reservable_now);
9264: if (@unsorted_reservable > 0) {
9265: @sorted_reservable =
9266: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9267: }
9268: my @unsorted_future = keys(%future_reservable);
9269: if (@unsorted_future > 0) {
9270: @sorted_future =
9271: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9272: }
9273: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9274: }
1.780 raeburn 9275:
9276: =pod
9277:
1.1057 foxr 9278: =back
9279:
1.549 albertel 9280: =head1 HTTP Helpers
9281:
9282: =over 4
9283:
1.648 raeburn 9284: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9285:
1.258 albertel 9286: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9287: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9288: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9289:
9290: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9291: $possible_names is an ref to an array of form element names. As an example:
9292: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9293: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9294:
9295: =cut
1.1 albertel 9296:
1.6 albertel 9297: sub get_unprocessed_cgi {
1.25 albertel 9298: my ($query,$possible_names)= @_;
1.26 matthew 9299: # $Apache::lonxml::debug=1;
1.356 albertel 9300: foreach my $pair (split(/&/,$query)) {
9301: my ($name, $value) = split(/=/,$pair);
1.369 www 9302: $name = &unescape($name);
1.25 albertel 9303: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9304: $value =~ tr/+/ /;
9305: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9306: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9307: }
1.16 harris41 9308: }
1.6 albertel 9309: }
9310:
1.112 bowersj2 9311: =pod
9312:
1.648 raeburn 9313: =item * &cacheheader()
1.112 bowersj2 9314:
9315: returns cache-controlling header code
9316:
9317: =cut
9318:
1.7 albertel 9319: sub cacheheader {
1.258 albertel 9320: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9321: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9322: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9323: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9324: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9325: return $output;
1.7 albertel 9326: }
9327:
1.112 bowersj2 9328: =pod
9329:
1.648 raeburn 9330: =item * &no_cache($r)
1.112 bowersj2 9331:
9332: specifies header code to not have cache
9333:
9334: =cut
9335:
1.9 albertel 9336: sub no_cache {
1.216 albertel 9337: my ($r) = @_;
9338: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9339: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9340: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9341: $r->no_cache(1);
9342: $r->header_out("Expires" => $date);
9343: $r->header_out("Pragma" => "no-cache");
1.123 www 9344: }
9345:
9346: sub content_type {
1.181 albertel 9347: my ($r,$type,$charset) = @_;
1.299 foxr 9348: if ($r) {
9349: # Note that printout.pl calls this with undef for $r.
9350: &no_cache($r);
9351: }
1.258 albertel 9352: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9353: unless ($charset) {
9354: $charset=&Apache::lonlocal::current_encoding;
9355: }
9356: if ($charset) { $type.='; charset='.$charset; }
9357: if ($r) {
9358: $r->content_type($type);
9359: } else {
9360: print("Content-type: $type\n\n");
9361: }
1.9 albertel 9362: }
1.25 albertel 9363:
1.112 bowersj2 9364: =pod
9365:
1.648 raeburn 9366: =item * &add_to_env($name,$value)
1.112 bowersj2 9367:
1.258 albertel 9368: adds $name to the %env hash with value
1.112 bowersj2 9369: $value, if $name already exists, the entry is converted to an array
9370: reference and $value is added to the array.
9371:
9372: =cut
9373:
1.25 albertel 9374: sub add_to_env {
9375: my ($name,$value)=@_;
1.258 albertel 9376: if (defined($env{$name})) {
9377: if (ref($env{$name})) {
1.25 albertel 9378: #already have multiple values
1.258 albertel 9379: push(@{ $env{$name} },$value);
1.25 albertel 9380: } else {
9381: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9382: my $first=$env{$name};
9383: undef($env{$name});
9384: push(@{ $env{$name} },$first,$value);
1.25 albertel 9385: }
9386: } else {
1.258 albertel 9387: $env{$name}=$value;
1.25 albertel 9388: }
1.31 albertel 9389: }
1.149 albertel 9390:
9391: =pod
9392:
1.648 raeburn 9393: =item * &get_env_multiple($name)
1.149 albertel 9394:
1.258 albertel 9395: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9396: values may be defined and end up as an array ref.
9397:
9398: returns an array of values
9399:
9400: =cut
9401:
9402: sub get_env_multiple {
9403: my ($name) = @_;
9404: my @values;
1.258 albertel 9405: if (defined($env{$name})) {
1.149 albertel 9406: # exists is it an array
1.258 albertel 9407: if (ref($env{$name})) {
9408: @values=@{ $env{$name} };
1.149 albertel 9409: } else {
1.258 albertel 9410: $values[0]=$env{$name};
1.149 albertel 9411: }
9412: }
9413: return(@values);
9414: }
9415:
1.660 raeburn 9416: sub ask_for_embedded_content {
9417: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9418: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 9419: %currsubfile,%unused,$rem);
1.1071 raeburn 9420: my $counter = 0;
9421: my $numnew = 0;
1.987 raeburn 9422: my $numremref = 0;
9423: my $numinvalid = 0;
9424: my $numpathchg = 0;
9425: my $numexisting = 0;
1.1071 raeburn 9426: my $numunused = 0;
9427: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9428: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9429: my $heading = &mt('Upload embedded files');
9430: my $buttontext = &mt('Upload');
9431:
1.1085 raeburn 9432: my $navmap;
9433: if ($env{'request.course.id'}) {
9434: $navmap = Apache::lonnavmaps::navmap->new();
9435: }
1.984 raeburn 9436: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9437: my $current_path='/';
9438: if ($env{'form.currentpath'}) {
9439: $current_path = $env{'form.currentpath'};
9440: }
9441: if ($actionurl eq '/adm/coursegrp_portfolio') {
9442: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9443: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9444: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9445: } else {
9446: $udom = $env{'user.domain'};
9447: $uname = $env{'user.name'};
9448: $url = '/userfiles/portfolio';
9449: }
1.987 raeburn 9450: $toplevel = $url.'/';
1.984 raeburn 9451: $url .= $current_path;
9452: $getpropath = 1;
1.987 raeburn 9453: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9454: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9455: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9456: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9457: $toplevel = $url;
1.984 raeburn 9458: if ($rest ne '') {
1.987 raeburn 9459: $url .= $rest;
9460: }
9461: } elsif ($actionurl eq '/adm/coursedocs') {
9462: if (ref($args) eq 'HASH') {
1.1071 raeburn 9463: $url = $args->{'docs_url'};
9464: $toplevel = $url;
1.1084 raeburn 9465: if ($args->{'context'} eq 'paste') {
9466: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9467: ($path) =
9468: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9469: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9470: $fileloc =~ s{^/}{};
9471: }
1.1071 raeburn 9472: }
1.1084 raeburn 9473: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 9474: if ($env{'request.course.id'} ne '') {
9475: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9476: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9477: if (ref($args) eq 'HASH') {
9478: $url = $args->{'docs_url'};
9479: $title = $args->{'docs_title'};
9480: $toplevel = "/$url";
1.1085 raeburn 9481: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1071 raeburn 9482: ($path) =
9483: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9484: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9485: $fileloc =~ s{^/}{};
9486: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9487: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9488: }
1.987 raeburn 9489: }
9490: }
9491: my $now = time();
9492: foreach my $embed_file (keys(%{$allfiles})) {
9493: my $absolutepath;
9494: if ($embed_file =~ m{^\w+://}) {
9495: $newfiles{$embed_file} = 1;
9496: $mapping{$embed_file} = $embed_file;
9497: } else {
9498: if ($embed_file =~ m{^/}) {
9499: $absolutepath = $embed_file;
9500: $embed_file =~ s{^(/+)}{};
9501: }
9502: if ($embed_file =~ m{/}) {
9503: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9504: $path = &check_for_traversal($path,$url,$toplevel);
9505: my $item = $fname;
9506: if ($path ne '') {
9507: $item = $path.'/'.$fname;
9508: $subdependencies{$path}{$fname} = 1;
9509: } else {
9510: $dependencies{$item} = 1;
9511: }
9512: if ($absolutepath) {
9513: $mapping{$item} = $absolutepath;
9514: } else {
9515: $mapping{$item} = $embed_file;
9516: }
9517: } else {
9518: $dependencies{$embed_file} = 1;
9519: if ($absolutepath) {
9520: $mapping{$embed_file} = $absolutepath;
9521: } else {
9522: $mapping{$embed_file} = $embed_file;
9523: }
9524: }
1.984 raeburn 9525: }
9526: }
1.1071 raeburn 9527: my $dirptr = 16384;
1.984 raeburn 9528: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9529: $currsubfile{$path} = {};
1.984 raeburn 9530: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9531: my ($sublistref,$listerror) =
9532: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9533: if (ref($sublistref) eq 'ARRAY') {
9534: foreach my $line (@{$sublistref}) {
9535: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9536: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9537: }
1.984 raeburn 9538: }
1.987 raeburn 9539: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9540: if (opendir(my $dir,$url.'/'.$path)) {
9541: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9542: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9543: }
1.1084 raeburn 9544: } elsif (($actionurl eq '/adm/dependencies') ||
9545: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9546: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9547: if ($env{'request.course.id'} ne '') {
9548: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9549: if ($dir ne '') {
9550: my ($sublistref,$listerror) =
9551: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9552: if (ref($sublistref) eq 'ARRAY') {
9553: foreach my $line (@{$sublistref}) {
9554: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9555: undef,$mtime)=split(/\&/,$line,12);
9556: unless (($testdir&$dirptr) ||
9557: ($file_name =~ /^\.\.?$/)) {
9558: $currsubfile{$path}{$file_name} = [$size,$mtime];
9559: }
9560: }
9561: }
9562: }
1.984 raeburn 9563: }
9564: }
9565: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9566: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9567: my $item = $path.'/'.$file;
9568: unless ($mapping{$item} eq $item) {
9569: $pathchanges{$item} = 1;
9570: }
9571: $existing{$item} = 1;
9572: $numexisting ++;
9573: } else {
9574: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9575: }
9576: }
1.1071 raeburn 9577: if ($actionurl eq '/adm/dependencies') {
9578: foreach my $path (keys(%currsubfile)) {
9579: if (ref($currsubfile{$path}) eq 'HASH') {
9580: foreach my $file (keys(%{$currsubfile{$path}})) {
9581: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 9582: next if (($rem ne '') &&
9583: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9584: (ref($navmap) &&
9585: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9586: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9587: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9588: $unused{$path.'/'.$file} = 1;
9589: }
9590: }
9591: }
9592: }
9593: }
1.984 raeburn 9594: }
1.987 raeburn 9595: my %currfile;
1.984 raeburn 9596: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9597: my ($dirlistref,$listerror) =
9598: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9599: if (ref($dirlistref) eq 'ARRAY') {
9600: foreach my $line (@{$dirlistref}) {
9601: my ($file_name,$rest) = split(/\&/,$line,2);
9602: $currfile{$file_name} = 1;
9603: }
1.984 raeburn 9604: }
1.987 raeburn 9605: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9606: if (opendir(my $dir,$url)) {
1.987 raeburn 9607: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9608: map {$currfile{$_} = 1;} @dir_list;
9609: }
1.1084 raeburn 9610: } elsif (($actionurl eq '/adm/dependencies') ||
9611: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9612: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9613: if ($env{'request.course.id'} ne '') {
9614: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9615: if ($dir ne '') {
9616: my ($dirlistref,$listerror) =
9617: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9618: if (ref($dirlistref) eq 'ARRAY') {
9619: foreach my $line (@{$dirlistref}) {
9620: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9621: $size,undef,$mtime)=split(/\&/,$line,12);
9622: unless (($testdir&$dirptr) ||
9623: ($file_name =~ /^\.\.?$/)) {
9624: $currfile{$file_name} = [$size,$mtime];
9625: }
9626: }
9627: }
9628: }
9629: }
1.984 raeburn 9630: }
9631: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9632: if (exists($currfile{$file})) {
1.987 raeburn 9633: unless ($mapping{$file} eq $file) {
9634: $pathchanges{$file} = 1;
9635: }
9636: $existing{$file} = 1;
9637: $numexisting ++;
9638: } else {
1.984 raeburn 9639: $newfiles{$file} = 1;
9640: }
9641: }
1.1071 raeburn 9642: foreach my $file (keys(%currfile)) {
9643: unless (($file eq $filename) ||
9644: ($file eq $filename.'.bak') ||
9645: ($dependencies{$file})) {
1.1085 raeburn 9646: if ($actionurl eq '/adm/dependencies') {
9647: next if (($rem ne '') &&
9648: (($env{"httpref.$rem".$file} ne '') ||
9649: (ref($navmap) &&
9650: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9651: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9652: ($navmap->getResourceByUrl($rem.$1)))))));
9653: }
1.1071 raeburn 9654: $unused{$file} = 1;
9655: }
9656: }
1.1084 raeburn 9657: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9658: ($args->{'context'} eq 'paste')) {
9659: $counter = scalar(keys(%existing));
9660: $numpathchg = scalar(keys(%pathchanges));
9661: return ($output,$counter,$numpathchg,\%existing);
9662: }
1.984 raeburn 9663: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9664: if ($actionurl eq '/adm/dependencies') {
9665: next if ($embed_file =~ m{^\w+://});
9666: }
1.660 raeburn 9667: $upload_output .= &start_data_table_row().
1.1071 raeburn 9668: '<td><img src="'.&icon($embed_file).'" /> '.
9669: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9670: unless ($mapping{$embed_file} eq $embed_file) {
9671: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9672: }
9673: $upload_output .= '</td><td>';
1.1071 raeburn 9674: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9675: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9676: $numremref++;
1.660 raeburn 9677: } elsif ($args->{'error_on_invalid_names'}
9678: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.987 raeburn 9679: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9680: $numinvalid++;
1.660 raeburn 9681: } else {
1.1071 raeburn 9682: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9683: $embed_file,\%mapping,
1.1071 raeburn 9684: $allfiles,$codebase,'upload');
9685: $counter ++;
9686: $numnew ++;
1.987 raeburn 9687: }
9688: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9689: }
9690: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9691: if ($actionurl eq '/adm/dependencies') {
9692: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9693: $modify_output .= &start_data_table_row().
9694: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9695: '<img src="'.&icon($embed_file).'" border="0" />'.
9696: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9697: '<td>'.$size.'</td>'.
9698: '<td>'.$mtime.'</td>'.
9699: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9700: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9701: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9702: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9703: &embedded_file_element('upload_embedded',$counter,
9704: $embed_file,\%mapping,
9705: $allfiles,$codebase,'modify').
9706: '</div></td>'.
9707: &end_data_table_row()."\n";
9708: $counter ++;
9709: } else {
9710: $upload_output .= &start_data_table_row().
9711: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9712: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9713: &Apache::loncommon::end_data_table_row()."\n";
9714: }
9715: }
9716: my $delidx = $counter;
9717: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9718: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9719: $delete_output .= &start_data_table_row().
9720: '<td><img src="'.&icon($oldfile).'" />'.
9721: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9722: '<td>'.$size.'</td>'.
9723: '<td>'.$mtime.'</td>'.
9724: '<td><label><input type="checkbox" name="del_upload_dep" '.
9725: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9726: &embedded_file_element('upload_embedded',$delidx,
9727: $oldfile,\%mapping,$allfiles,
9728: $codebase,'delete').'</td>'.
9729: &end_data_table_row()."\n";
9730: $numunused ++;
9731: $delidx ++;
1.987 raeburn 9732: }
9733: if ($upload_output) {
9734: $upload_output = &start_data_table().
9735: $upload_output.
9736: &end_data_table()."\n";
9737: }
1.1071 raeburn 9738: if ($modify_output) {
9739: $modify_output = &start_data_table().
9740: &start_data_table_header_row().
9741: '<th>'.&mt('File').'</th>'.
9742: '<th>'.&mt('Size (KB)').'</th>'.
9743: '<th>'.&mt('Modified').'</th>'.
9744: '<th>'.&mt('Upload replacement?').'</th>'.
9745: &end_data_table_header_row().
9746: $modify_output.
9747: &end_data_table()."\n";
9748: }
9749: if ($delete_output) {
9750: $delete_output = &start_data_table().
9751: &start_data_table_header_row().
9752: '<th>'.&mt('File').'</th>'.
9753: '<th>'.&mt('Size (KB)').'</th>'.
9754: '<th>'.&mt('Modified').'</th>'.
9755: '<th>'.&mt('Delete?').'</th>'.
9756: &end_data_table_header_row().
9757: $delete_output.
9758: &end_data_table()."\n";
9759: }
1.987 raeburn 9760: my $applies = 0;
9761: if ($numremref) {
9762: $applies ++;
9763: }
9764: if ($numinvalid) {
9765: $applies ++;
9766: }
9767: if ($numexisting) {
9768: $applies ++;
9769: }
1.1071 raeburn 9770: if ($counter || $numunused) {
1.987 raeburn 9771: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9772: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9773: $state.'<h3>'.$heading.'</h3>';
9774: if ($actionurl eq '/adm/dependencies') {
9775: if ($numnew) {
9776: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9777: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9778: $upload_output.'<br />'."\n";
9779: }
9780: if ($numexisting) {
9781: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9782: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9783: $modify_output.'<br />'."\n";
9784: $buttontext = &mt('Save changes');
9785: }
9786: if ($numunused) {
9787: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9788: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9789: $delete_output.'<br />'."\n";
9790: $buttontext = &mt('Save changes');
9791: }
9792: } else {
9793: $output .= $upload_output.'<br />'."\n";
9794: }
9795: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9796: $counter.'" />'."\n";
9797: if ($actionurl eq '/adm/dependencies') {
9798: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9799: $numnew.'" />'."\n";
9800: } elsif ($actionurl eq '') {
1.987 raeburn 9801: $output .= '<input type="hidden" name="phase" value="three" />';
9802: }
9803: } elsif ($applies) {
9804: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9805: if ($applies > 1) {
9806: $output .=
9807: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9808: if ($numremref) {
9809: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9810: }
9811: if ($numinvalid) {
9812: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9813: }
9814: if ($numexisting) {
9815: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9816: }
9817: $output .= '</ul><br />';
9818: } elsif ($numremref) {
9819: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9820: } elsif ($numinvalid) {
9821: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9822: } elsif ($numexisting) {
9823: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9824: }
9825: $output .= $upload_output.'<br />';
9826: }
9827: my ($pathchange_output,$chgcount);
1.1071 raeburn 9828: $chgcount = $counter;
1.987 raeburn 9829: if (keys(%pathchanges) > 0) {
9830: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9831: if ($counter) {
1.987 raeburn 9832: $output .= &embedded_file_element('pathchange',$chgcount,
9833: $embed_file,\%mapping,
1.1071 raeburn 9834: $allfiles,$codebase,'change');
1.987 raeburn 9835: } else {
9836: $pathchange_output .=
9837: &start_data_table_row().
9838: '<td><input type ="checkbox" name="namechange" value="'.
9839: $chgcount.'" checked="checked" /></td>'.
9840: '<td>'.$mapping{$embed_file}.'</td>'.
9841: '<td>'.$embed_file.
9842: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9843: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9844: '</td>'.&end_data_table_row();
1.660 raeburn 9845: }
1.987 raeburn 9846: $numpathchg ++;
9847: $chgcount ++;
1.660 raeburn 9848: }
9849: }
1.1071 raeburn 9850: if ($counter) {
1.987 raeburn 9851: if ($numpathchg) {
9852: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9853: $numpathchg.'" />'."\n";
9854: }
9855: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9856: ($actionurl eq '/adm/imsimport')) {
9857: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9858: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9859: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9860: } elsif ($actionurl eq '/adm/dependencies') {
9861: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9862: }
1.1071 raeburn 9863: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9864: } elsif ($numpathchg) {
9865: my %pathchange = ();
9866: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9867: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9868: $output .= '<p>'.&mt('or').'</p>';
9869: }
9870: }
1.1071 raeburn 9871: return ($output,$counter,$numpathchg);
1.987 raeburn 9872: }
9873:
9874: sub embedded_file_element {
1.1071 raeburn 9875: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9876: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9877: (ref($codebase) eq 'HASH'));
9878: my $output;
1.1071 raeburn 9879: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9880: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9881: }
9882: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9883: &escape($embed_file).'" />';
9884: unless (($context eq 'upload_embedded') &&
9885: ($mapping->{$embed_file} eq $embed_file)) {
9886: $output .='
9887: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9888: }
9889: my $attrib;
9890: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9891: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9892: }
9893: $output .=
9894: "\n\t\t".
9895: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9896: $attrib.'" />';
9897: if (exists($codebase->{$mapping->{$embed_file}})) {
9898: $output .=
9899: "\n\t\t".
9900: '<input name="codebase_'.$num.'" type="hidden" value="'.
9901: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9902: }
1.987 raeburn 9903: return $output;
1.660 raeburn 9904: }
9905:
1.1071 raeburn 9906: sub get_dependency_details {
9907: my ($currfile,$currsubfile,$embed_file) = @_;
9908: my ($size,$mtime,$showsize,$showmtime);
9909: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9910: if ($embed_file =~ m{/}) {
9911: my ($path,$fname) = split(/\//,$embed_file);
9912: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9913: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9914: }
9915: } else {
9916: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9917: ($size,$mtime) = @{$currfile->{$embed_file}};
9918: }
9919: }
9920: $showsize = $size/1024.0;
9921: $showsize = sprintf("%.1f",$showsize);
9922: if ($mtime > 0) {
9923: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9924: }
9925: }
9926: return ($showsize,$showmtime);
9927: }
9928:
9929: sub ask_embedded_js {
9930: return <<"END";
9931: <script type="text/javascript"">
9932: // <![CDATA[
9933: function toggleBrowse(counter) {
9934: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9935: var fileid = document.getElementById('embedded_item_'+counter);
9936: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9937: if (chkboxid.checked == true) {
9938: uploaddivid.style.display='block';
9939: } else {
9940: uploaddivid.style.display='none';
9941: fileid.value = '';
9942: }
9943: }
9944: // ]]>
9945: </script>
9946:
9947: END
9948: }
9949:
1.661 raeburn 9950: sub upload_embedded {
9951: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9952: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9953: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9954: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9955: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9956: my $orig_uploaded_filename =
9957: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9958: foreach my $type ('orig','ref','attrib','codebase') {
9959: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9960: $env{'form.embedded_'.$type.'_'.$i} =
9961: &unescape($env{'form.embedded_'.$type.'_'.$i});
9962: }
9963: }
1.661 raeburn 9964: my ($path,$fname) =
9965: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9966: # no path, whole string is fname
9967: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9968: $fname = &Apache::lonnet::clean_filename($fname);
9969: # See if there is anything left
9970: next if ($fname eq '');
9971:
9972: # Check if file already exists as a file or directory.
9973: my ($state,$msg);
9974: if ($context eq 'portfolio') {
9975: my $port_path = $dirpath;
9976: if ($group ne '') {
9977: $port_path = "groups/$group/$port_path";
9978: }
1.987 raeburn 9979: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9980: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9981: $dir_root,$port_path,$disk_quota,
9982: $current_disk_usage,$uname,$udom);
9983: if ($state eq 'will_exceed_quota'
1.984 raeburn 9984: || $state eq 'file_locked') {
1.661 raeburn 9985: $output .= $msg;
9986: next;
9987: }
9988: } elsif (($context eq 'author') || ($context eq 'testbank')) {
9989: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
9990: if ($state eq 'exists') {
9991: $output .= $msg;
9992: next;
9993: }
9994: }
9995: # Check if extension is valid
9996: if (($fname =~ /\.(\w+)$/) &&
9997: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 9998: $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 9999: next;
10000: } elsif (($fname =~ /\.(\w+)$/) &&
10001: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10002: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10003: next;
10004: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 10005: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 10006: next;
10007: }
10008: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
10009: if ($context eq 'portfolio') {
1.984 raeburn 10010: my $result;
10011: if ($state eq 'existingfile') {
10012: $result=
10013: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 10014: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 10015: } else {
1.984 raeburn 10016: $result=
10017: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10018: $dirpath.
10019: $env{'form.currentpath'}.$path);
1.984 raeburn 10020: if ($result !~ m|^/uploaded/|) {
10021: $output .= '<span class="LC_error">'
10022: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10023: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10024: .'</span><br />';
10025: next;
10026: } else {
1.987 raeburn 10027: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10028: $path.$fname.'</span>').'<br />';
1.984 raeburn 10029: }
1.661 raeburn 10030: }
1.987 raeburn 10031: } elsif ($context eq 'coursedoc') {
10032: my $result =
10033: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
10034: $dirpath.'/'.$path);
10035: if ($result !~ m|^/uploaded/|) {
10036: $output .= '<span class="LC_error">'
10037: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10038: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10039: .'</span><br />';
10040: next;
10041: } else {
10042: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10043: $path.$fname.'</span>').'<br />';
10044: }
1.661 raeburn 10045: } else {
10046: # Save the file
10047: my $target = $env{'form.embedded_item_'.$i};
10048: my $fullpath = $dir_root.$dirpath.'/'.$path;
10049: my $dest = $fullpath.$fname;
10050: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10051: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10052: my $count;
10053: my $filepath = $dir_root;
1.1027 raeburn 10054: foreach my $subdir (@parts) {
10055: $filepath .= "/$subdir";
10056: if (!-e $filepath) {
1.661 raeburn 10057: mkdir($filepath,0770);
10058: }
10059: }
10060: my $fh;
10061: if (!open($fh,'>'.$dest)) {
10062: &Apache::lonnet::logthis('Failed to create '.$dest);
10063: $output .= '<span class="LC_error">'.
1.1071 raeburn 10064: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10065: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10066: '</span><br />';
10067: } else {
10068: if (!print $fh $env{'form.embedded_item_'.$i}) {
10069: &Apache::lonnet::logthis('Failed to write to '.$dest);
10070: $output .= '<span class="LC_error">'.
1.1071 raeburn 10071: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10072: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10073: '</span><br />';
10074: } else {
1.987 raeburn 10075: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10076: $url.'</span>').'<br />';
10077: unless ($context eq 'testbank') {
10078: $footer .= &mt('View embedded file: [_1]',
10079: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10080: }
10081: }
10082: close($fh);
10083: }
10084: }
10085: if ($env{'form.embedded_ref_'.$i}) {
10086: $pathchange{$i} = 1;
10087: }
10088: }
10089: if ($output) {
10090: $output = '<p>'.$output.'</p>';
10091: }
10092: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10093: $returnflag = 'ok';
1.1071 raeburn 10094: my $numpathchgs = scalar(keys(%pathchange));
10095: if ($numpathchgs > 0) {
1.987 raeburn 10096: if ($context eq 'portfolio') {
10097: $output .= '<p>'.&mt('or').'</p>';
10098: } elsif ($context eq 'testbank') {
1.1071 raeburn 10099: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10100: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10101: $returnflag = 'modify_orightml';
10102: }
10103: }
1.1071 raeburn 10104: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10105: }
10106:
10107: sub modify_html_form {
10108: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10109: my $end = 0;
10110: my $modifyform;
10111: if ($context eq 'upload_embedded') {
10112: return unless (ref($pathchange) eq 'HASH');
10113: if ($env{'form.number_embedded_items'}) {
10114: $end += $env{'form.number_embedded_items'};
10115: }
10116: if ($env{'form.number_pathchange_items'}) {
10117: $end += $env{'form.number_pathchange_items'};
10118: }
10119: if ($end) {
10120: for (my $i=0; $i<$end; $i++) {
10121: if ($i < $env{'form.number_embedded_items'}) {
10122: next unless($pathchange->{$i});
10123: }
10124: $modifyform .=
10125: &start_data_table_row().
10126: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10127: 'checked="checked" /></td>'.
10128: '<td>'.$env{'form.embedded_ref_'.$i}.
10129: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10130: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10131: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10132: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10133: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10134: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10135: '<td>'.$env{'form.embedded_orig_'.$i}.
10136: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10137: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10138: &end_data_table_row();
1.1071 raeburn 10139: }
1.987 raeburn 10140: }
10141: } else {
10142: $modifyform = $pathchgtable;
10143: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10144: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10145: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10146: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10147: }
10148: }
10149: if ($modifyform) {
1.1071 raeburn 10150: if ($actionurl eq '/adm/dependencies') {
10151: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10152: }
1.987 raeburn 10153: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10154: '<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".
10155: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10156: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10157: '</ol></p>'."\n".'<p>'.
10158: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10159: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10160: &start_data_table()."\n".
10161: &start_data_table_header_row().
10162: '<th>'.&mt('Change?').'</th>'.
10163: '<th>'.&mt('Current reference').'</th>'.
10164: '<th>'.&mt('Required reference').'</th>'.
10165: &end_data_table_header_row()."\n".
10166: $modifyform.
10167: &end_data_table().'<br />'."\n".$hiddenstate.
10168: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10169: '</form>'."\n";
10170: }
10171: return;
10172: }
10173:
10174: sub modify_html_refs {
10175: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10176: my $container;
10177: if ($context eq 'portfolio') {
10178: $container = $env{'form.container'};
10179: } elsif ($context eq 'coursedoc') {
10180: $container = $env{'form.primaryurl'};
1.1071 raeburn 10181: } elsif ($context eq 'manage_dependencies') {
10182: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10183: $container = "/$container";
1.987 raeburn 10184: } else {
1.1027 raeburn 10185: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10186: }
10187: my (%allfiles,%codebase,$output,$content);
10188: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10189: unless (@changes > 0) {
10190: if (wantarray) {
10191: return ('',0,0);
10192: } else {
10193: return;
10194: }
10195: }
10196: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10197: ($context eq 'manage_dependencies')) {
10198: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10199: if (wantarray) {
10200: return ('',0,0);
10201: } else {
10202: return;
10203: }
10204: }
1.987 raeburn 10205: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10206: if ($content eq '-1') {
10207: if (wantarray) {
10208: return ('',0,0);
10209: } else {
10210: return;
10211: }
10212: }
1.987 raeburn 10213: } else {
1.1071 raeburn 10214: unless ($container =~ /^\Q$dir_root\E/) {
10215: if (wantarray) {
10216: return ('',0,0);
10217: } else {
10218: return;
10219: }
10220: }
1.987 raeburn 10221: if (open(my $fh,"<$container")) {
10222: $content = join('', <$fh>);
10223: close($fh);
10224: } else {
1.1071 raeburn 10225: if (wantarray) {
10226: return ('',0,0);
10227: } else {
10228: return;
10229: }
1.987 raeburn 10230: }
10231: }
10232: my ($count,$codebasecount) = (0,0);
10233: my $mm = new File::MMagic;
10234: my $mime_type = $mm->checktype_contents($content);
10235: if ($mime_type eq 'text/html') {
10236: my $parse_result =
10237: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10238: \%codebase,\$content);
10239: if ($parse_result eq 'ok') {
10240: foreach my $i (@changes) {
10241: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10242: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10243: if ($allfiles{$ref}) {
10244: my $newname = $orig;
10245: my ($attrib_regexp,$codebase);
1.1006 raeburn 10246: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10247: if ($attrib_regexp =~ /:/) {
10248: $attrib_regexp =~ s/\:/|/g;
10249: }
10250: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10251: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10252: $count += $numchg;
10253: }
10254: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10255: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10256: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10257: $codebasecount ++;
10258: }
10259: }
10260: }
10261: if ($count || $codebasecount) {
10262: my $saveresult;
1.1071 raeburn 10263: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10264: ($context eq 'manage_dependencies')) {
1.987 raeburn 10265: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10266: if ($url eq $container) {
10267: my ($fname) = ($container =~ m{/([^/]+)$});
10268: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10269: $count,'<span class="LC_filename">'.
1.1071 raeburn 10270: $fname.'</span>').'</p>';
1.987 raeburn 10271: } else {
10272: $output = '<p class="LC_error">'.
10273: &mt('Error: update failed for: [_1].',
10274: '<span class="LC_filename">'.
10275: $container.'</span>').'</p>';
10276: }
10277: } else {
10278: if (open(my $fh,">$container")) {
10279: print $fh $content;
10280: close($fh);
10281: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10282: $count,'<span class="LC_filename">'.
10283: $container.'</span>').'</p>';
1.661 raeburn 10284: } else {
1.987 raeburn 10285: $output = '<p class="LC_error">'.
10286: &mt('Error: could not update [_1].',
10287: '<span class="LC_filename">'.
10288: $container.'</span>').'</p>';
1.661 raeburn 10289: }
10290: }
10291: }
1.987 raeburn 10292: } else {
10293: &logthis('Failed to parse '.$container.
10294: ' to modify references: '.$parse_result);
1.661 raeburn 10295: }
10296: }
1.1071 raeburn 10297: if (wantarray) {
10298: return ($output,$count,$codebasecount);
10299: } else {
10300: return $output;
10301: }
1.661 raeburn 10302: }
10303:
10304: sub check_for_existing {
10305: my ($path,$fname,$element) = @_;
10306: my ($state,$msg);
10307: if (-d $path.'/'.$fname) {
10308: $state = 'exists';
10309: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10310: } elsif (-e $path.'/'.$fname) {
10311: $state = 'exists';
10312: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10313: }
10314: if ($state eq 'exists') {
10315: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10316: }
10317: return ($state,$msg);
10318: }
10319:
10320: sub check_for_upload {
10321: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10322: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10323: my $filesize = length($env{'form.'.$element});
10324: if (!$filesize) {
10325: my $msg = '<span class="LC_error">'.
10326: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10327: '<span class="LC_filename">'.$fname.'</span>',
10328: $filesize).'<br />'.
1.1007 raeburn 10329: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10330: '</span>';
10331: return ('zero_bytes',$msg);
10332: }
10333: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10334: my $getpropath = 1;
1.1021 raeburn 10335: my ($dirlistref,$listerror) =
10336: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10337: my $found_file = 0;
10338: my $locked_file = 0;
1.991 raeburn 10339: my @lockers;
10340: my $navmap;
10341: if ($env{'request.course.id'}) {
10342: $navmap = Apache::lonnavmaps::navmap->new();
10343: }
1.1021 raeburn 10344: if (ref($dirlistref) eq 'ARRAY') {
10345: foreach my $line (@{$dirlistref}) {
10346: my ($file_name,$rest)=split(/\&/,$line,2);
10347: if ($file_name eq $fname){
10348: $file_name = $path.$file_name;
10349: if ($group ne '') {
10350: $file_name = $group.$file_name;
10351: }
10352: $found_file = 1;
10353: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10354: foreach my $lock (@lockers) {
10355: if (ref($lock) eq 'ARRAY') {
10356: my ($symb,$crsid) = @{$lock};
10357: if ($crsid eq $env{'request.course.id'}) {
10358: if (ref($navmap)) {
10359: my $res = $navmap->getBySymb($symb);
10360: foreach my $part (@{$res->parts()}) {
10361: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10362: unless (($slot_status == $res->RESERVED) ||
10363: ($slot_status == $res->RESERVED_LOCATION)) {
10364: $locked_file = 1;
10365: }
1.991 raeburn 10366: }
1.1021 raeburn 10367: } else {
10368: $locked_file = 1;
1.991 raeburn 10369: }
10370: } else {
10371: $locked_file = 1;
10372: }
10373: }
1.1021 raeburn 10374: }
10375: } else {
10376: my @info = split(/\&/,$rest);
10377: my $currsize = $info[6]/1000;
10378: if ($currsize < $filesize) {
10379: my $extra = $filesize - $currsize;
10380: if (($current_disk_usage + $extra) > $disk_quota) {
10381: my $msg = '<span class="LC_error">'.
10382: &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.',
10383: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10384: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10385: $disk_quota,$current_disk_usage);
10386: return ('will_exceed_quota',$msg);
10387: }
1.984 raeburn 10388: }
10389: }
1.661 raeburn 10390: }
10391: }
10392: }
10393: if (($current_disk_usage + $filesize) > $disk_quota){
10394: my $msg = '<span class="LC_error">'.
10395: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10396: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10397: return ('will_exceed_quota',$msg);
10398: } elsif ($found_file) {
10399: if ($locked_file) {
10400: my $msg = '<span class="LC_error">';
10401: $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>');
10402: $msg .= '</span><br />';
10403: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10404: return ('file_locked',$msg);
10405: } else {
10406: my $msg = '<span class="LC_error">';
1.984 raeburn 10407: $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 10408: $msg .= '</span>';
1.984 raeburn 10409: return ('existingfile',$msg);
1.661 raeburn 10410: }
10411: }
10412: }
10413:
1.987 raeburn 10414: sub check_for_traversal {
10415: my ($path,$url,$toplevel) = @_;
10416: my @parts=split(/\//,$path);
10417: my $cleanpath;
10418: my $fullpath = $url;
10419: for (my $i=0;$i<@parts;$i++) {
10420: next if ($parts[$i] eq '.');
10421: if ($parts[$i] eq '..') {
10422: $fullpath =~ s{([^/]+/)$}{};
10423: } else {
10424: $fullpath .= $parts[$i].'/';
10425: }
10426: }
10427: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10428: $cleanpath = $1;
10429: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10430: my $curr_toprel = $1;
10431: my @parts = split(/\//,$curr_toprel);
10432: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10433: my @urlparts = split(/\//,$url_toprel);
10434: my $doubledots;
10435: my $startdiff = -1;
10436: for (my $i=0; $i<@urlparts; $i++) {
10437: if ($startdiff == -1) {
10438: unless ($urlparts[$i] eq $parts[$i]) {
10439: $startdiff = $i;
10440: $doubledots .= '../';
10441: }
10442: } else {
10443: $doubledots .= '../';
10444: }
10445: }
10446: if ($startdiff > -1) {
10447: $cleanpath = $doubledots;
10448: for (my $i=$startdiff; $i<@parts; $i++) {
10449: $cleanpath .= $parts[$i].'/';
10450: }
10451: }
10452: }
10453: $cleanpath =~ s{(/)$}{};
10454: return $cleanpath;
10455: }
1.31 albertel 10456:
1.1053 raeburn 10457: sub is_archive_file {
10458: my ($mimetype) = @_;
10459: if (($mimetype eq 'application/octet-stream') ||
10460: ($mimetype eq 'application/x-stuffit') ||
10461: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10462: return 1;
10463: }
10464: return;
10465: }
10466:
10467: sub decompress_form {
1.1065 raeburn 10468: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10469: my %lt = &Apache::lonlocal::texthash (
10470: this => 'This file is an archive file.',
1.1067 raeburn 10471: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10472: itsc => 'Its contents are as follows:',
1.1053 raeburn 10473: youm => 'You may wish to extract its contents.',
10474: extr => 'Extract contents',
1.1067 raeburn 10475: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10476: proa => 'Process automatically?',
1.1053 raeburn 10477: yes => 'Yes',
10478: no => 'No',
1.1067 raeburn 10479: fold => 'Title for folder containing movie',
10480: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10481: );
1.1065 raeburn 10482: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10483: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10484: my $info = &list_archive_contents($fileloc,\@paths);
10485: if (@paths) {
10486: foreach my $path (@paths) {
10487: $path =~ s{^/}{};
1.1067 raeburn 10488: if ($path =~ m{^([^/]+)/$}) {
10489: $topdir = $1;
10490: }
1.1065 raeburn 10491: if ($path =~ m{^([^/]+)/}) {
10492: $toplevel{$1} = $path;
10493: } else {
10494: $toplevel{$path} = $path;
10495: }
10496: }
10497: }
1.1067 raeburn 10498: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10499: my @camtasia = ("$topdir/","$topdir/index.html",
10500: "$topdir/media/",
10501: "$topdir/media/$topdir.mp4",
10502: "$topdir/media/FirstFrame.png",
10503: "$topdir/media/player.swf",
10504: "$topdir/media/swfobject.js",
10505: "$topdir/media/expressInstall.swf");
10506: my @diffs = &compare_arrays(\@paths,\@camtasia);
10507: if (@diffs == 0) {
10508: $is_camtasia = 1;
10509: }
10510: }
10511: my $output;
10512: if ($is_camtasia) {
10513: $output = <<"ENDCAM";
10514: <script type="text/javascript" language="Javascript">
10515: // <![CDATA[
10516:
10517: function camtasiaToggle() {
10518: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10519: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10520: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10521:
10522: document.getElementById('camtasia_titles').style.display='block';
10523: } else {
10524: document.getElementById('camtasia_titles').style.display='none';
10525: }
10526: }
10527: }
10528: return;
10529: }
10530:
10531: // ]]>
10532: </script>
10533: <p>$lt{'camt'}</p>
10534: ENDCAM
1.1065 raeburn 10535: } else {
1.1067 raeburn 10536: $output = '<p>'.$lt{'this'};
10537: if ($info eq '') {
10538: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10539: } else {
10540: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10541: '<div><pre>'.$info.'</pre></div>';
10542: }
1.1065 raeburn 10543: }
1.1067 raeburn 10544: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10545: my $duplicates;
10546: my $num = 0;
10547: if (ref($dirlist) eq 'ARRAY') {
10548: foreach my $item (@{$dirlist}) {
10549: if (ref($item) eq 'ARRAY') {
10550: if (exists($toplevel{$item->[0]})) {
10551: $duplicates .=
10552: &start_data_table_row().
10553: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10554: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10555: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10556: 'value="1" />'.&mt('Yes').'</label>'.
10557: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10558: '<td>'.$item->[0].'</td>';
10559: if ($item->[2]) {
10560: $duplicates .= '<td>'.&mt('Directory').'</td>';
10561: } else {
10562: $duplicates .= '<td>'.&mt('File').'</td>';
10563: }
10564: $duplicates .= '<td>'.$item->[3].'</td>'.
10565: '<td>'.
10566: &Apache::lonlocal::locallocaltime($item->[4]).
10567: '</td>'.
10568: &end_data_table_row();
10569: $num ++;
10570: }
10571: }
10572: }
10573: }
10574: my $itemcount;
10575: if (@paths > 0) {
10576: $itemcount = scalar(@paths);
10577: } else {
10578: $itemcount = 1;
10579: }
1.1067 raeburn 10580: if ($is_camtasia) {
10581: $output .= $lt{'auto'}.'<br />'.
10582: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10583: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10584: $lt{'yes'}.'</label> <label>'.
10585: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10586: $lt{'no'}.'</label></span><br />'.
10587: '<div id="camtasia_titles" style="display:block">'.
10588: &Apache::lonhtmlcommon::start_pick_box().
10589: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10590: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10591: &Apache::lonhtmlcommon::row_closure().
10592: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10593: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10594: &Apache::lonhtmlcommon::row_closure(1).
10595: &Apache::lonhtmlcommon::end_pick_box().
10596: '</div>';
10597: }
1.1065 raeburn 10598: $output .=
10599: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10600: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10601: "\n";
1.1065 raeburn 10602: if ($duplicates ne '') {
10603: $output .= '<p><span class="LC_warning">'.
10604: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10605: &start_data_table().
10606: &start_data_table_header_row().
10607: '<th>'.&mt('Overwrite?').'</th>'.
10608: '<th>'.&mt('Name').'</th>'.
10609: '<th>'.&mt('Type').'</th>'.
10610: '<th>'.&mt('Size').'</th>'.
10611: '<th>'.&mt('Last modified').'</th>'.
10612: &end_data_table_header_row().
10613: $duplicates.
10614: &end_data_table().
10615: '</p>';
10616: }
1.1067 raeburn 10617: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10618: if (ref($hiddenelements) eq 'HASH') {
10619: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10620: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10621: }
10622: }
10623: $output .= <<"END";
1.1067 raeburn 10624: <br />
1.1053 raeburn 10625: <input type="submit" name="decompress" value="$lt{'extr'}" />
10626: </form>
10627: $noextract
10628: END
10629: return $output;
10630: }
10631:
1.1065 raeburn 10632: sub decompression_utility {
10633: my ($program) = @_;
10634: my @utilities = ('tar','gunzip','bunzip2','unzip');
10635: my $location;
10636: if (grep(/^\Q$program\E$/,@utilities)) {
10637: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10638: '/usr/sbin/') {
10639: if (-x $dir.$program) {
10640: $location = $dir.$program;
10641: last;
10642: }
10643: }
10644: }
10645: return $location;
10646: }
10647:
10648: sub list_archive_contents {
10649: my ($file,$pathsref) = @_;
10650: my (@cmd,$output);
10651: my $needsregexp;
10652: if ($file =~ /\.zip$/) {
10653: @cmd = (&decompression_utility('unzip'),"-l");
10654: $needsregexp = 1;
10655: } elsif (($file =~ m/\.tar\.gz$/) ||
10656: ($file =~ /\.tgz$/)) {
10657: @cmd = (&decompression_utility('tar'),"-ztf");
10658: } elsif ($file =~ /\.tar\.bz2$/) {
10659: @cmd = (&decompression_utility('tar'),"-jtf");
10660: } elsif ($file =~ m|\.tar$|) {
10661: @cmd = (&decompression_utility('tar'),"-tf");
10662: }
10663: if (@cmd) {
10664: undef($!);
10665: undef($@);
10666: if (open(my $fh,"-|", @cmd, $file)) {
10667: while (my $line = <$fh>) {
10668: $output .= $line;
10669: chomp($line);
10670: my $item;
10671: if ($needsregexp) {
10672: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10673: } else {
10674: $item = $line;
10675: }
10676: if ($item ne '') {
10677: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10678: push(@{$pathsref},$item);
10679: }
10680: }
10681: }
10682: close($fh);
10683: }
10684: }
10685: return $output;
10686: }
10687:
1.1053 raeburn 10688: sub decompress_uploaded_file {
10689: my ($file,$dir) = @_;
10690: &Apache::lonnet::appenv({'cgi.file' => $file});
10691: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10692: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10693: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10694: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10695: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10696: my $decompressed = $env{'cgi.decompressed'};
10697: &Apache::lonnet::delenv('cgi.file');
10698: &Apache::lonnet::delenv('cgi.dir');
10699: &Apache::lonnet::delenv('cgi.decompressed');
10700: return ($decompressed,$result);
10701: }
10702:
1.1055 raeburn 10703: sub process_decompression {
10704: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10705: my ($dir,$error,$warning,$output);
10706: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10707: $error = &mt('File name not a supported archive file type.').
10708: '<br />'.&mt('File name should end with one of: [_1].',
10709: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10710: } else {
10711: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10712: if ($docuhome eq 'no_host') {
10713: $error = &mt('Could not determine home server for course.');
10714: } else {
10715: my @ids=&Apache::lonnet::current_machine_ids();
10716: my $currdir = "$dir_root/$destination";
10717: if (grep(/^\Q$docuhome\E$/,@ids)) {
10718: $dir = &LONCAPA::propath($docudom,$docuname).
10719: "$dir_root/$destination";
10720: } else {
10721: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10722: "$dir_root/$docudom/$docuname/$destination";
10723: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10724: $error = &mt('Archive file not found.');
10725: }
10726: }
1.1065 raeburn 10727: my (@to_overwrite,@to_skip);
10728: if ($env{'form.archive_overwrite_total'} > 0) {
10729: my $total = $env{'form.archive_overwrite_total'};
10730: for (my $i=0; $i<$total; $i++) {
10731: if ($env{'form.archive_overwrite_'.$i} == 1) {
10732: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10733: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10734: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10735: }
10736: }
10737: }
10738: my $numskip = scalar(@to_skip);
10739: if (($numskip > 0) &&
10740: ($numskip == $env{'form.archive_itemcount'})) {
10741: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10742: } elsif ($dir eq '') {
1.1055 raeburn 10743: $error = &mt('Directory containing archive file unavailable.');
10744: } elsif (!$error) {
1.1065 raeburn 10745: my ($decompressed,$display);
10746: if ($numskip > 0) {
10747: my $tempdir = time.'_'.$$.int(rand(10000));
10748: mkdir("$dir/$tempdir",0755);
10749: system("mv $dir/$file $dir/$tempdir/$file");
10750: ($decompressed,$display) =
10751: &decompress_uploaded_file($file,"$dir/$tempdir");
10752: foreach my $item (@to_skip) {
10753: if (($item ne '') && ($item !~ /\.\./)) {
10754: if (-f "$dir/$tempdir/$item") {
10755: unlink("$dir/$tempdir/$item");
10756: } elsif (-d "$dir/$tempdir/$item") {
10757: system("rm -rf $dir/$tempdir/$item");
10758: }
10759: }
10760: }
10761: system("mv $dir/$tempdir/* $dir");
10762: rmdir("$dir/$tempdir");
10763: } else {
10764: ($decompressed,$display) =
10765: &decompress_uploaded_file($file,$dir);
10766: }
1.1055 raeburn 10767: if ($decompressed eq 'ok') {
1.1065 raeburn 10768: $output = '<p class="LC_info">'.
10769: &mt('Files extracted successfully from archive.').
10770: '</p>'."\n";
1.1055 raeburn 10771: my ($warning,$result,@contents);
10772: my ($newdirlistref,$newlisterror) =
10773: &Apache::lonnet::dirlist($currdir,$docudom,
10774: $docuname,1);
10775: my (%is_dir,%changes,@newitems);
10776: my $dirptr = 16384;
1.1065 raeburn 10777: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10778: foreach my $dir_line (@{$newdirlistref}) {
10779: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10780: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10781: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10782: push(@newitems,$item);
10783: if ($dirptr&$testdir) {
10784: $is_dir{$item} = 1;
10785: }
10786: $changes{$item} = 1;
10787: }
10788: }
10789: }
10790: if (keys(%changes) > 0) {
10791: foreach my $item (sort(@newitems)) {
10792: if ($changes{$item}) {
10793: push(@contents,$item);
10794: }
10795: }
10796: }
10797: if (@contents > 0) {
1.1067 raeburn 10798: my $wantform;
10799: unless ($env{'form.autoextract_camtasia'}) {
10800: $wantform = 1;
10801: }
1.1056 raeburn 10802: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10803: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10804: $currdir,\%is_dir,
10805: \%children,\%parent,
1.1056 raeburn 10806: \@contents,\%dirorder,
10807: \%titles,$wantform);
1.1055 raeburn 10808: if ($datatable ne '') {
10809: $output .= &archive_options_form('decompressed',$datatable,
10810: $count,$hiddenelem);
1.1065 raeburn 10811: my $startcount = 6;
1.1055 raeburn 10812: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10813: \%titles,\%children);
1.1055 raeburn 10814: }
1.1067 raeburn 10815: if ($env{'form.autoextract_camtasia'}) {
10816: my %displayed;
10817: my $total = 1;
10818: $env{'form.archive_directory'} = [];
10819: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10820: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10821: $path =~ s{/$}{};
10822: my $item;
10823: if ($path ne '') {
10824: $item = "$path/$titles{$i}";
10825: } else {
10826: $item = $titles{$i};
10827: }
10828: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10829: if ($item eq $contents[0]) {
10830: push(@{$env{'form.archive_directory'}},$i);
10831: $env{'form.archive_'.$i} = 'display';
10832: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10833: $displayed{'folder'} = $i;
10834: } elsif ($item eq "$contents[0]/index.html") {
10835: $env{'form.archive_'.$i} = 'display';
10836: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10837: $displayed{'web'} = $i;
10838: } else {
10839: if ($item eq "$contents[0]/media") {
10840: push(@{$env{'form.archive_directory'}},$i);
10841: }
10842: $env{'form.archive_'.$i} = 'dependency';
10843: }
10844: $total ++;
10845: }
10846: for (my $i=1; $i<$total; $i++) {
10847: next if ($i == $displayed{'web'});
10848: next if ($i == $displayed{'folder'});
10849: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10850: }
10851: $env{'form.phase'} = 'decompress_cleanup';
10852: $env{'form.archivedelete'} = 1;
10853: $env{'form.archive_count'} = $total-1;
10854: $output .=
10855: &process_extracted_files('coursedocs',$docudom,
10856: $docuname,$destination,
10857: $dir_root,$hiddenelem);
10858: }
1.1055 raeburn 10859: } else {
10860: $warning = &mt('No new items extracted from archive file.');
10861: }
10862: } else {
10863: $output = $display;
10864: $error = &mt('An error occurred during extraction from the archive file.');
10865: }
10866: }
10867: }
10868: }
10869: if ($error) {
10870: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10871: $error.'</p>'."\n";
10872: }
10873: if ($warning) {
10874: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10875: }
10876: return $output;
10877: }
10878:
10879: sub get_extracted {
1.1056 raeburn 10880: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10881: $titles,$wantform) = @_;
1.1055 raeburn 10882: my $count = 0;
10883: my $depth = 0;
10884: my $datatable;
1.1056 raeburn 10885: my @hierarchy;
1.1055 raeburn 10886: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10887: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10888: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10889: foreach my $item (@{$contents}) {
10890: $count ++;
1.1056 raeburn 10891: @{$dirorder->{$count}} = @hierarchy;
10892: $titles->{$count} = $item;
1.1055 raeburn 10893: &archive_hierarchy($depth,$count,$parent,$children);
10894: if ($wantform) {
10895: $datatable .= &archive_row($is_dir->{$item},$item,
10896: $currdir,$depth,$count);
10897: }
10898: if ($is_dir->{$item}) {
10899: $depth ++;
1.1056 raeburn 10900: push(@hierarchy,$count);
10901: $parent->{$depth} = $count;
1.1055 raeburn 10902: $datatable .=
10903: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10904: \$depth,\$count,\@hierarchy,$dirorder,
10905: $children,$parent,$titles,$wantform);
1.1055 raeburn 10906: $depth --;
1.1056 raeburn 10907: pop(@hierarchy);
1.1055 raeburn 10908: }
10909: }
10910: return ($count,$datatable);
10911: }
10912:
10913: sub recurse_extracted_archive {
1.1056 raeburn 10914: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10915: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10916: my $result='';
1.1056 raeburn 10917: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10918: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10919: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10920: return $result;
10921: }
10922: my $dirptr = 16384;
10923: my ($newdirlistref,$newlisterror) =
10924: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10925: if (ref($newdirlistref) eq 'ARRAY') {
10926: foreach my $dir_line (@{$newdirlistref}) {
10927: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10928: unless ($item =~ /^\.+$/) {
10929: $$count ++;
1.1056 raeburn 10930: @{$dirorder->{$$count}} = @{$hierarchy};
10931: $titles->{$$count} = $item;
1.1055 raeburn 10932: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10933:
1.1055 raeburn 10934: my $is_dir;
10935: if ($dirptr&$testdir) {
10936: $is_dir = 1;
10937: }
10938: if ($wantform) {
10939: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10940: }
10941: if ($is_dir) {
10942: $$depth ++;
1.1056 raeburn 10943: push(@{$hierarchy},$$count);
10944: $parent->{$$depth} = $$count;
1.1055 raeburn 10945: $result .=
10946: &recurse_extracted_archive("$currdir/$item",$docudom,
10947: $docuname,$depth,$count,
1.1056 raeburn 10948: $hierarchy,$dirorder,$children,
10949: $parent,$titles,$wantform);
1.1055 raeburn 10950: $$depth --;
1.1056 raeburn 10951: pop(@{$hierarchy});
1.1055 raeburn 10952: }
10953: }
10954: }
10955: }
10956: return $result;
10957: }
10958:
10959: sub archive_hierarchy {
10960: my ($depth,$count,$parent,$children) =@_;
10961: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10962: if (exists($parent->{$depth})) {
10963: $children->{$parent->{$depth}} .= $count.':';
10964: }
10965: }
10966: return;
10967: }
10968:
10969: sub archive_row {
10970: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10971: my ($name) = ($item =~ m{([^/]+)$});
10972: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10973: 'display' => 'Add as file',
1.1055 raeburn 10974: 'dependency' => 'Include as dependency',
10975: 'discard' => 'Discard',
10976: );
10977: if ($is_dir) {
1.1059 raeburn 10978: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10979: }
1.1056 raeburn 10980: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10981: my $offset = 0;
1.1055 raeburn 10982: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 10983: $offset ++;
1.1065 raeburn 10984: if ($action ne 'display') {
10985: $offset ++;
10986: }
1.1055 raeburn 10987: $output .= '<td><span class="LC_nobreak">'.
10988: '<label><input type="radio" name="archive_'.$count.
10989: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
10990: my $text = $choices{$action};
10991: if ($is_dir) {
10992: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
10993: if ($action eq 'display') {
1.1059 raeburn 10994: $text = &mt('Add as folder');
1.1055 raeburn 10995: }
1.1056 raeburn 10996: } else {
10997: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
10998:
10999: }
11000: $output .= ' /> '.$choices{$action}.'</label></span>';
11001: if ($action eq 'dependency') {
11002: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11003: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11004: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11005: '<option value=""></option>'."\n".
11006: '</select>'."\n".
11007: '</div>';
1.1059 raeburn 11008: } elsif ($action eq 'display') {
11009: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11010: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11011: '</div>';
1.1055 raeburn 11012: }
1.1056 raeburn 11013: $output .= '</td>';
1.1055 raeburn 11014: }
11015: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11016: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11017: for (my $i=0; $i<$depth; $i++) {
11018: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11019: }
11020: if ($is_dir) {
11021: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11022: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11023: } else {
11024: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11025: }
11026: $output .= ' '.$name.'</td>'."\n".
11027: &end_data_table_row();
11028: return $output;
11029: }
11030:
11031: sub archive_options_form {
1.1065 raeburn 11032: my ($form,$display,$count,$hiddenelem) = @_;
11033: my %lt = &Apache::lonlocal::texthash(
11034: perm => 'Permanently remove archive file?',
11035: hows => 'How should each extracted item be incorporated in the course?',
11036: cont => 'Content actions for all',
11037: addf => 'Add as folder/file',
11038: incd => 'Include as dependency for a displayed file',
11039: disc => 'Discard',
11040: no => 'No',
11041: yes => 'Yes',
11042: save => 'Save',
11043: );
11044: my $output = <<"END";
11045: <form name="$form" method="post" action="">
11046: <p><span class="LC_nobreak">$lt{'perm'}
11047: <label>
11048: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11049: </label>
11050:
11051: <label>
11052: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11053: </span>
11054: </p>
11055: <input type="hidden" name="phase" value="decompress_cleanup" />
11056: <br />$lt{'hows'}
11057: <div class="LC_columnSection">
11058: <fieldset>
11059: <legend>$lt{'cont'}</legend>
11060: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11061: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11062: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11063: </fieldset>
11064: </div>
11065: END
11066: return $output.
1.1055 raeburn 11067: &start_data_table()."\n".
1.1065 raeburn 11068: $display."\n".
1.1055 raeburn 11069: &end_data_table()."\n".
11070: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11071: $hiddenelem.
1.1065 raeburn 11072: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11073: '</form>';
11074: }
11075:
11076: sub archive_javascript {
1.1056 raeburn 11077: my ($startcount,$numitems,$titles,$children) = @_;
11078: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11079: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11080: my $scripttag = <<START;
11081: <script type="text/javascript">
11082: // <![CDATA[
11083:
11084: function checkAll(form,prefix) {
11085: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11086: for (var i=0; i < form.elements.length; i++) {
11087: var id = form.elements[i].id;
11088: if ((id != '') && (id != undefined)) {
11089: if (idstr.test(id)) {
11090: if (form.elements[i].type == 'radio') {
11091: form.elements[i].checked = true;
1.1056 raeburn 11092: var nostart = i-$startcount;
1.1059 raeburn 11093: var offset = nostart%7;
11094: var count = (nostart-offset)/7;
1.1056 raeburn 11095: dependencyCheck(form,count,offset);
1.1055 raeburn 11096: }
11097: }
11098: }
11099: }
11100: }
11101:
11102: function propagateCheck(form,count) {
11103: if (count > 0) {
1.1059 raeburn 11104: var startelement = $startcount + ((count-1) * 7);
11105: for (var j=1; j<6; j++) {
11106: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11107: var item = startelement + j;
11108: if (form.elements[item].type == 'radio') {
11109: if (form.elements[item].checked) {
11110: containerCheck(form,count,j);
11111: break;
11112: }
1.1055 raeburn 11113: }
11114: }
11115: }
11116: }
11117: }
11118:
11119: numitems = $numitems
1.1056 raeburn 11120: var titles = new Array(numitems);
11121: var parents = new Array(numitems);
1.1055 raeburn 11122: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11123: parents[i] = new Array;
1.1055 raeburn 11124: }
1.1059 raeburn 11125: var maintitle = '$maintitle';
1.1055 raeburn 11126:
11127: START
11128:
1.1056 raeburn 11129: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11130: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11131: for (my $i=0; $i<@contents; $i ++) {
11132: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11133: }
11134: }
11135:
1.1056 raeburn 11136: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11137: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11138: }
11139:
1.1055 raeburn 11140: $scripttag .= <<END;
11141:
11142: function containerCheck(form,count,offset) {
11143: if (count > 0) {
1.1056 raeburn 11144: dependencyCheck(form,count,offset);
1.1059 raeburn 11145: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11146: form.elements[item].checked = true;
11147: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11148: if (parents[count].length > 0) {
11149: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11150: containerCheck(form,parents[count][j],offset);
11151: }
11152: }
11153: }
11154: }
11155: }
11156:
11157: function dependencyCheck(form,count,offset) {
11158: if (count > 0) {
1.1059 raeburn 11159: var chosen = (offset+$startcount)+7*(count-1);
11160: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11161: var currtype = form.elements[depitem].type;
11162: if (form.elements[chosen].value == 'dependency') {
11163: document.getElementById('arc_depon_'+count).style.display='block';
11164: form.elements[depitem].options.length = 0;
11165: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 11166: for (var i=1; i<=numitems; i++) {
11167: if (i == count) {
11168: continue;
11169: }
1.1059 raeburn 11170: var startelement = $startcount + (i-1) * 7;
11171: for (var j=1; j<6; j++) {
11172: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11173: var item = startelement + j;
11174: if (form.elements[item].type == 'radio') {
11175: if (form.elements[item].checked) {
11176: if (form.elements[item].value == 'display') {
11177: var n = form.elements[depitem].options.length;
11178: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11179: }
11180: }
11181: }
11182: }
11183: }
11184: }
11185: } else {
11186: document.getElementById('arc_depon_'+count).style.display='none';
11187: form.elements[depitem].options.length = 0;
11188: form.elements[depitem].options[0] = new Option('Select','',true,true);
11189: }
1.1059 raeburn 11190: titleCheck(form,count,offset);
1.1056 raeburn 11191: }
11192: }
11193:
11194: function propagateSelect(form,count,offset) {
11195: if (count > 0) {
1.1065 raeburn 11196: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11197: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11198: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11199: if (parents[count].length > 0) {
11200: for (var j=0; j<parents[count].length; j++) {
11201: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11202: }
11203: }
11204: }
11205: }
11206: }
1.1056 raeburn 11207:
11208: function containerSelect(form,count,offset,picked) {
11209: if (count > 0) {
1.1065 raeburn 11210: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11211: if (form.elements[item].type == 'radio') {
11212: if (form.elements[item].value == 'dependency') {
11213: if (form.elements[item+1].type == 'select-one') {
11214: for (var i=0; i<form.elements[item+1].options.length; i++) {
11215: if (form.elements[item+1].options[i].value == picked) {
11216: form.elements[item+1].selectedIndex = i;
11217: break;
11218: }
11219: }
11220: }
11221: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11222: if (parents[count].length > 0) {
11223: for (var j=0; j<parents[count].length; j++) {
11224: containerSelect(form,parents[count][j],offset,picked);
11225: }
11226: }
11227: }
11228: }
11229: }
11230: }
11231: }
11232:
1.1059 raeburn 11233: function titleCheck(form,count,offset) {
11234: if (count > 0) {
11235: var chosen = (offset+$startcount)+7*(count-1);
11236: var depitem = $startcount + ((count-1) * 7) + 2;
11237: var currtype = form.elements[depitem].type;
11238: if (form.elements[chosen].value == 'display') {
11239: document.getElementById('arc_title_'+count).style.display='block';
11240: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11241: document.getElementById('archive_title_'+count).value=maintitle;
11242: }
11243: } else {
11244: document.getElementById('arc_title_'+count).style.display='none';
11245: if (currtype == 'text') {
11246: document.getElementById('archive_title_'+count).value='';
11247: }
11248: }
11249: }
11250: return;
11251: }
11252:
1.1055 raeburn 11253: // ]]>
11254: </script>
11255: END
11256: return $scripttag;
11257: }
11258:
11259: sub process_extracted_files {
1.1067 raeburn 11260: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11261: my $numitems = $env{'form.archive_count'};
11262: return unless ($numitems);
11263: my @ids=&Apache::lonnet::current_machine_ids();
11264: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11265: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11266: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11267: if (grep(/^\Q$docuhome\E$/,@ids)) {
11268: $prefix = &LONCAPA::propath($docudom,$docuname);
11269: $pathtocheck = "$dir_root/$destination";
11270: $dir = $dir_root;
11271: $ishome = 1;
11272: } else {
11273: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11274: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11275: $dir = "$dir_root/$docudom/$docuname";
11276: }
11277: my $currdir = "$dir_root/$destination";
11278: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11279: if ($env{'form.folderpath'}) {
11280: my @items = split('&',$env{'form.folderpath'});
11281: $folders{'0'} = $items[-2];
11282: $containers{'0'}='sequence';
11283: } elsif ($env{'form.pagepath'}) {
11284: my @items = split('&',$env{'form.pagepath'});
11285: $folders{'0'} = $items[-2];
11286: $containers{'0'}='page';
11287: }
11288: my @archdirs = &get_env_multiple('form.archive_directory');
11289: if ($numitems) {
11290: for (my $i=1; $i<=$numitems; $i++) {
11291: my $path = $env{'form.archive_content_'.$i};
11292: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11293: my $item = $1;
11294: $toplevelitems{$item} = $i;
11295: if (grep(/^\Q$i\E$/,@archdirs)) {
11296: $is_dir{$item} = 1;
11297: }
11298: }
11299: }
11300: }
1.1067 raeburn 11301: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11302: if (keys(%toplevelitems) > 0) {
11303: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11304: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11305: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11306: }
1.1066 raeburn 11307: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11308: if ($numitems) {
11309: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 11310: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11311: my $path = $env{'form.archive_content_'.$i};
11312: if ($path =~ /^\Q$pathtocheck\E/) {
11313: if ($env{'form.archive_'.$i} eq 'discard') {
11314: if ($prefix ne '' && $path ne '') {
11315: if (-e $prefix.$path) {
1.1066 raeburn 11316: if ((@archdirs > 0) &&
11317: (grep(/^\Q$i\E$/,@archdirs))) {
11318: $todeletedir{$prefix.$path} = 1;
11319: } else {
11320: $todelete{$prefix.$path} = 1;
11321: }
1.1055 raeburn 11322: }
11323: }
11324: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11325: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11326: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11327: $docstitle = $env{'form.archive_title_'.$i};
11328: if ($docstitle eq '') {
11329: $docstitle = $title;
11330: }
1.1055 raeburn 11331: $outer = 0;
1.1056 raeburn 11332: if (ref($dirorder{$i}) eq 'ARRAY') {
11333: if (@{$dirorder{$i}} > 0) {
11334: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11335: if ($env{'form.archive_'.$item} eq 'display') {
11336: $outer = $item;
11337: last;
11338: }
11339: }
11340: }
11341: }
11342: my ($errtext,$fatal) =
11343: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11344: '/'.$folders{$outer}.'.'.
11345: $containers{$outer});
11346: next if ($fatal);
11347: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11348: if ($context eq 'coursedocs') {
1.1056 raeburn 11349: $mapinner{$i} = time;
1.1055 raeburn 11350: $folders{$i} = 'default_'.$mapinner{$i};
11351: $containers{$i} = 'sequence';
11352: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11353: $folders{$i}.'.'.$containers{$i};
11354: my $newidx = &LONCAPA::map::getresidx();
11355: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11356: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11357: push(@LONCAPA::map::order,$newidx);
11358: my ($outtext,$errtext) =
11359: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11360: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11361: '.'.$containers{$outer},1,1);
1.1056 raeburn 11362: $newseqid{$i} = $newidx;
1.1067 raeburn 11363: unless ($errtext) {
11364: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11365: }
1.1055 raeburn 11366: }
11367: } else {
11368: if ($context eq 'coursedocs') {
11369: my $newidx=&LONCAPA::map::getresidx();
11370: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11371: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11372: $title;
11373: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11374: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11375: }
11376: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11377: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11378: }
11379: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11380: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11381: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11382: unless ($ishome) {
11383: my $fetch = "$newdest{$i}/$title";
11384: $fetch =~ s/^\Q$prefix$dir\E//;
11385: $prompttofetch{$fetch} = 1;
11386: }
1.1055 raeburn 11387: }
11388: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11389: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11390: push(@LONCAPA::map::order, $newidx);
11391: my ($outtext,$errtext)=
11392: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11393: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11394: '.'.$containers{$outer},1,1);
1.1067 raeburn 11395: unless ($errtext) {
11396: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11397: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11398: }
11399: }
1.1055 raeburn 11400: }
11401: }
1.1086 raeburn 11402: }
11403: } else {
11404: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11405: }
11406: }
11407: for (my $i=1; $i<=$numitems; $i++) {
11408: next unless ($env{'form.archive_'.$i} eq 'dependency');
11409: my $path = $env{'form.archive_content_'.$i};
11410: if ($path =~ /^\Q$pathtocheck\E/) {
11411: my ($title) = ($path =~ m{/([^/]+)$});
11412: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11413: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11414: if (ref($dirorder{$i}) eq 'ARRAY') {
11415: my ($itemidx,$fullpath,$relpath);
11416: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11417: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11418: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 11419: if ($dirorder{$i}->[$j] eq $container) {
11420: $itemidx = $j;
1.1056 raeburn 11421: }
11422: }
1.1086 raeburn 11423: }
11424: if ($itemidx eq '') {
11425: $itemidx = 0;
11426: }
11427: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11428: if ($mapinner{$referrer{$i}}) {
11429: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11430: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11431: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11432: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11433: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11434: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11435: if (!-e $fullpath) {
11436: mkdir($fullpath,0755);
1.1056 raeburn 11437: }
11438: }
1.1086 raeburn 11439: } else {
11440: last;
1.1056 raeburn 11441: }
1.1086 raeburn 11442: }
11443: }
11444: } elsif ($newdest{$referrer{$i}}) {
11445: $fullpath = $newdest{$referrer{$i}};
11446: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11447: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11448: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11449: last;
11450: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11451: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11452: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11453: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11454: if (!-e $fullpath) {
11455: mkdir($fullpath,0755);
1.1056 raeburn 11456: }
11457: }
1.1086 raeburn 11458: } else {
11459: last;
1.1056 raeburn 11460: }
1.1055 raeburn 11461: }
11462: }
1.1086 raeburn 11463: if ($fullpath ne '') {
11464: if (-e "$prefix$path") {
11465: system("mv $prefix$path $fullpath/$title");
11466: }
11467: if (-e "$fullpath/$title") {
11468: my $showpath;
11469: if ($relpath ne '') {
11470: $showpath = "$relpath/$title";
11471: } else {
11472: $showpath = "/$title";
11473: }
11474: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11475: }
11476: unless ($ishome) {
11477: my $fetch = "$fullpath/$title";
11478: $fetch =~ s/^\Q$prefix$dir\E//;
11479: $prompttofetch{$fetch} = 1;
11480: }
11481: }
1.1055 raeburn 11482: }
1.1086 raeburn 11483: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11484: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11485: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11486: }
11487: } else {
11488: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11489: }
11490: }
11491: if (keys(%todelete)) {
11492: foreach my $key (keys(%todelete)) {
11493: unlink($key);
1.1066 raeburn 11494: }
11495: }
11496: if (keys(%todeletedir)) {
11497: foreach my $key (keys(%todeletedir)) {
11498: rmdir($key);
11499: }
11500: }
11501: foreach my $dir (sort(keys(%is_dir))) {
11502: if (($pathtocheck ne '') && ($dir ne '')) {
11503: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11504: }
11505: }
1.1067 raeburn 11506: if ($result ne '') {
11507: $output .= '<ul>'."\n".
11508: $result."\n".
11509: '</ul>';
11510: }
11511: unless ($ishome) {
11512: my $replicationfail;
11513: foreach my $item (keys(%prompttofetch)) {
11514: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11515: unless ($fetchresult eq 'ok') {
11516: $replicationfail .= '<li>'.$item.'</li>'."\n";
11517: }
11518: }
11519: if ($replicationfail) {
11520: $output .= '<p class="LC_error">'.
11521: &mt('Course home server failed to retrieve:').'<ul>'.
11522: $replicationfail.
11523: '</ul></p>';
11524: }
11525: }
1.1055 raeburn 11526: } else {
11527: $warning = &mt('No items found in archive.');
11528: }
11529: if ($error) {
11530: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11531: $error.'</p>'."\n";
11532: }
11533: if ($warning) {
11534: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11535: }
11536: return $output;
11537: }
11538:
1.1066 raeburn 11539: sub cleanup_empty_dirs {
11540: my ($path) = @_;
11541: if (($path ne '') && (-d $path)) {
11542: if (opendir(my $dirh,$path)) {
11543: my @dircontents = grep(!/^\./,readdir($dirh));
11544: my $numitems = 0;
11545: foreach my $item (@dircontents) {
11546: if (-d "$path/$item") {
11547: &recurse_dirs("$path/$item");
11548: if (-e "$path/$item") {
11549: $numitems ++;
11550: }
11551: } else {
11552: $numitems ++;
11553: }
11554: }
11555: if ($numitems == 0) {
11556: rmdir($path);
11557: }
11558: closedir($dirh);
11559: }
11560: }
11561: return;
11562: }
11563:
1.41 ng 11564: =pod
1.45 matthew 11565:
1.1068 raeburn 11566: =item &get_folder_hierarchy()
11567:
11568: Provides hierarchy of names of folders/sub-folders containing the current
11569: item,
11570:
11571: Inputs: 3
11572: - $navmap - navmaps object
11573:
11574: - $map - url for map (either the trigger itself, or map containing
11575: the resource, which is the trigger).
11576:
11577: - $showitem - 1 => show title for map itself; 0 => do not show.
11578:
11579: Outputs: 1 @pathitems - array of folder/subfolder names.
11580:
11581: =cut
11582:
11583: sub get_folder_hierarchy {
11584: my ($navmap,$map,$showitem) = @_;
11585: my @pathitems;
11586: if (ref($navmap)) {
11587: my $mapres = $navmap->getResourceByUrl($map);
11588: if (ref($mapres)) {
11589: my $pcslist = $mapres->map_hierarchy();
11590: if ($pcslist ne '') {
11591: my @pcs = split(/,/,$pcslist);
11592: foreach my $pc (@pcs) {
11593: if ($pc == 1) {
11594: push(@pathitems,&mt('Main Course Documents'));
11595: } else {
11596: my $res = $navmap->getByMapPc($pc);
11597: if (ref($res)) {
11598: my $title = $res->compTitle();
11599: $title =~ s/\W+/_/g;
11600: if ($title ne '') {
11601: push(@pathitems,$title);
11602: }
11603: }
11604: }
11605: }
11606: }
1.1071 raeburn 11607: if ($showitem) {
11608: if ($mapres->{ID} eq '0.0') {
11609: push(@pathitems,&mt('Main Course Documents'));
11610: } else {
11611: my $maptitle = $mapres->compTitle();
11612: $maptitle =~ s/\W+/_/g;
11613: if ($maptitle ne '') {
11614: push(@pathitems,$maptitle);
11615: }
1.1068 raeburn 11616: }
11617: }
11618: }
11619: }
11620: return @pathitems;
11621: }
11622:
11623: =pod
11624:
1.1015 raeburn 11625: =item * &get_turnedin_filepath()
11626:
11627: Determines path in a user's portfolio file for storage of files uploaded
11628: to a specific essayresponse or dropbox item.
11629:
11630: Inputs: 3 required + 1 optional.
11631: $symb is symb for resource, $uname and $udom are for current user (required).
11632: $caller is optional (can be "submission", if routine is called when storing
11633: an upoaded file when "Submit Answer" button was pressed).
11634:
11635: Returns array containing $path and $multiresp.
11636: $path is path in portfolio. $multiresp is 1 if this resource contains more
11637: than one file upload item. Callers of routine should append partid as a
11638: subdirectory to $path in cases where $multiresp is 1.
11639:
11640: Called by: homework/essayresponse.pm and homework/structuretags.pm
11641:
11642: =cut
11643:
11644: sub get_turnedin_filepath {
11645: my ($symb,$uname,$udom,$caller) = @_;
11646: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11647: my $turnindir;
11648: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11649: $turnindir = $userhash{'turnindir'};
11650: my ($path,$multiresp);
11651: if ($turnindir eq '') {
11652: if ($caller eq 'submission') {
11653: $turnindir = &mt('turned in');
11654: $turnindir =~ s/\W+/_/g;
11655: my %newhash = (
11656: 'turnindir' => $turnindir,
11657: );
11658: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11659: }
11660: }
11661: if ($turnindir ne '') {
11662: $path = '/'.$turnindir.'/';
11663: my ($multipart,$turnin,@pathitems);
11664: my $navmap = Apache::lonnavmaps::navmap->new();
11665: if (defined($navmap)) {
11666: my $mapres = $navmap->getResourceByUrl($map);
11667: if (ref($mapres)) {
11668: my $pcslist = $mapres->map_hierarchy();
11669: if ($pcslist ne '') {
11670: foreach my $pc (split(/,/,$pcslist)) {
11671: my $res = $navmap->getByMapPc($pc);
11672: if (ref($res)) {
11673: my $title = $res->compTitle();
11674: $title =~ s/\W+/_/g;
11675: if ($title ne '') {
11676: push(@pathitems,$title);
11677: }
11678: }
11679: }
11680: }
11681: my $maptitle = $mapres->compTitle();
11682: $maptitle =~ s/\W+/_/g;
11683: if ($maptitle ne '') {
11684: push(@pathitems,$maptitle);
11685: }
11686: unless ($env{'request.state'} eq 'construct') {
11687: my $res = $navmap->getBySymb($symb);
11688: if (ref($res)) {
11689: my $partlist = $res->parts();
11690: my $totaluploads = 0;
11691: if (ref($partlist) eq 'ARRAY') {
11692: foreach my $part (@{$partlist}) {
11693: my @types = $res->responseType($part);
11694: my @ids = $res->responseIds($part);
11695: for (my $i=0; $i < scalar(@ids); $i++) {
11696: if ($types[$i] eq 'essay') {
11697: my $partid = $part.'_'.$ids[$i];
11698: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11699: $totaluploads ++;
11700: }
11701: }
11702: }
11703: }
11704: if ($totaluploads > 1) {
11705: $multiresp = 1;
11706: }
11707: }
11708: }
11709: }
11710: } else {
11711: return;
11712: }
11713: } else {
11714: return;
11715: }
11716: my $restitle=&Apache::lonnet::gettitle($symb);
11717: $restitle =~ s/\W+/_/g;
11718: if ($restitle eq '') {
11719: $restitle = ($resurl =~ m{/[^/]+$});
11720: if ($restitle eq '') {
11721: $restitle = time;
11722: }
11723: }
11724: push(@pathitems,$restitle);
11725: $path .= join('/',@pathitems);
11726: }
11727: return ($path,$multiresp);
11728: }
11729:
11730: =pod
11731:
1.464 albertel 11732: =back
1.41 ng 11733:
1.112 bowersj2 11734: =head1 CSV Upload/Handling functions
1.38 albertel 11735:
1.41 ng 11736: =over 4
11737:
1.648 raeburn 11738: =item * &upfile_store($r)
1.41 ng 11739:
11740: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11741: needs $env{'form.upfile'}
1.41 ng 11742: returns $datatoken to be put into hidden field
11743:
11744: =cut
1.31 albertel 11745:
11746: sub upfile_store {
11747: my $r=shift;
1.258 albertel 11748: $env{'form.upfile'}=~s/\r/\n/gs;
11749: $env{'form.upfile'}=~s/\f/\n/gs;
11750: $env{'form.upfile'}=~s/\n+/\n/gs;
11751: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11752:
1.258 albertel 11753: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11754: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11755: {
1.158 raeburn 11756: my $datafile = $r->dir_config('lonDaemons').
11757: '/tmp/'.$datatoken.'.tmp';
11758: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11759: print $fh $env{'form.upfile'};
1.158 raeburn 11760: close($fh);
11761: }
1.31 albertel 11762: }
11763: return $datatoken;
11764: }
11765:
1.56 matthew 11766: =pod
11767:
1.648 raeburn 11768: =item * &load_tmp_file($r)
1.41 ng 11769:
11770: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11771: needs $env{'form.datatoken'},
11772: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11773:
11774: =cut
1.31 albertel 11775:
11776: sub load_tmp_file {
11777: my $r=shift;
11778: my @studentdata=();
11779: {
1.158 raeburn 11780: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11781: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11782: if ( open(my $fh,"<$studentfile") ) {
11783: @studentdata=<$fh>;
11784: close($fh);
11785: }
1.31 albertel 11786: }
1.258 albertel 11787: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11788: }
11789:
1.56 matthew 11790: =pod
11791:
1.648 raeburn 11792: =item * &upfile_record_sep()
1.41 ng 11793:
11794: Separate uploaded file into records
11795: returns array of records,
1.258 albertel 11796: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11797:
11798: =cut
1.31 albertel 11799:
11800: sub upfile_record_sep {
1.258 albertel 11801: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11802: } else {
1.248 albertel 11803: my @records;
1.258 albertel 11804: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11805: if ($line=~/^\s*$/) { next; }
11806: push(@records,$line);
11807: }
11808: return @records;
1.31 albertel 11809: }
11810: }
11811:
1.56 matthew 11812: =pod
11813:
1.648 raeburn 11814: =item * &record_sep($record)
1.41 ng 11815:
1.258 albertel 11816: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11817:
11818: =cut
11819:
1.263 www 11820: sub takeleft {
11821: my $index=shift;
11822: return substr('0000'.$index,-4,4);
11823: }
11824:
1.31 albertel 11825: sub record_sep {
11826: my $record=shift;
11827: my %components=();
1.258 albertel 11828: if ($env{'form.upfiletype'} eq 'xml') {
11829: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11830: my $i=0;
1.356 albertel 11831: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11832: $field=~s/^(\"|\')//;
11833: $field=~s/(\"|\')$//;
1.263 www 11834: $components{&takeleft($i)}=$field;
1.31 albertel 11835: $i++;
11836: }
1.258 albertel 11837: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11838: my $i=0;
1.356 albertel 11839: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11840: $field=~s/^(\"|\')//;
11841: $field=~s/(\"|\')$//;
1.263 www 11842: $components{&takeleft($i)}=$field;
1.31 albertel 11843: $i++;
11844: }
11845: } else {
1.561 www 11846: my $separator=',';
1.480 banghart 11847: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11848: $separator=';';
1.480 banghart 11849: }
1.31 albertel 11850: my $i=0;
1.561 www 11851: # the character we are looking for to indicate the end of a quote or a record
11852: my $looking_for=$separator;
11853: # do not add the characters to the fields
11854: my $ignore=0;
11855: # we just encountered a separator (or the beginning of the record)
11856: my $just_found_separator=1;
11857: # store the field we are working on here
11858: my $field='';
11859: # work our way through all characters in record
11860: foreach my $character ($record=~/(.)/g) {
11861: if ($character eq $looking_for) {
11862: if ($character ne $separator) {
11863: # Found the end of a quote, again looking for separator
11864: $looking_for=$separator;
11865: $ignore=1;
11866: } else {
11867: # Found a separator, store away what we got
11868: $components{&takeleft($i)}=$field;
11869: $i++;
11870: $just_found_separator=1;
11871: $ignore=0;
11872: $field='';
11873: }
11874: next;
11875: }
11876: # single or double quotation marks after a separator indicate beginning of a quote
11877: # we are now looking for the end of the quote and need to ignore separators
11878: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11879: $looking_for=$character;
11880: next;
11881: }
11882: # ignore would be true after we reached the end of a quote
11883: if ($ignore) { next; }
11884: if (($just_found_separator) && ($character=~/\s/)) { next; }
11885: $field.=$character;
11886: $just_found_separator=0;
1.31 albertel 11887: }
1.561 www 11888: # catch the very last entry, since we never encountered the separator
11889: $components{&takeleft($i)}=$field;
1.31 albertel 11890: }
11891: return %components;
11892: }
11893:
1.144 matthew 11894: ######################################################
11895: ######################################################
11896:
1.56 matthew 11897: =pod
11898:
1.648 raeburn 11899: =item * &upfile_select_html()
1.41 ng 11900:
1.144 matthew 11901: Return HTML code to select a file from the users machine and specify
11902: the file type.
1.41 ng 11903:
11904: =cut
11905:
1.144 matthew 11906: ######################################################
11907: ######################################################
1.31 albertel 11908: sub upfile_select_html {
1.144 matthew 11909: my %Types = (
11910: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11911: semisv => &mt('Semicolon separated values'),
1.144 matthew 11912: space => &mt('Space separated'),
11913: tab => &mt('Tabulator separated'),
11914: # xml => &mt('HTML/XML'),
11915: );
11916: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11917: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11918: foreach my $type (sort(keys(%Types))) {
11919: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11920: }
11921: $Str .= "</select>\n";
11922: return $Str;
1.31 albertel 11923: }
11924:
1.301 albertel 11925: sub get_samples {
11926: my ($records,$toget) = @_;
11927: my @samples=({});
11928: my $got=0;
11929: foreach my $rec (@$records) {
11930: my %temp = &record_sep($rec);
11931: if (! grep(/\S/, values(%temp))) { next; }
11932: if (%temp) {
11933: $samples[$got]=\%temp;
11934: $got++;
11935: if ($got == $toget) { last; }
11936: }
11937: }
11938: return \@samples;
11939: }
11940:
1.144 matthew 11941: ######################################################
11942: ######################################################
11943:
1.56 matthew 11944: =pod
11945:
1.648 raeburn 11946: =item * &csv_print_samples($r,$records)
1.41 ng 11947:
11948: Prints a table of sample values from each column uploaded $r is an
11949: Apache Request ref, $records is an arrayref from
11950: &Apache::loncommon::upfile_record_sep
11951:
11952: =cut
11953:
1.144 matthew 11954: ######################################################
11955: ######################################################
1.31 albertel 11956: sub csv_print_samples {
11957: my ($r,$records) = @_;
1.662 bisitz 11958: my $samples = &get_samples($records,5);
1.301 albertel 11959:
1.594 raeburn 11960: $r->print(&mt('Samples').'<br />'.&start_data_table().
11961: &start_data_table_header_row());
1.356 albertel 11962: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11963: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11964: $r->print(&end_data_table_header_row());
1.301 albertel 11965: foreach my $hash (@$samples) {
1.594 raeburn 11966: $r->print(&start_data_table_row());
1.356 albertel 11967: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11968: $r->print('<td>');
1.356 albertel 11969: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11970: $r->print('</td>');
11971: }
1.594 raeburn 11972: $r->print(&end_data_table_row());
1.31 albertel 11973: }
1.594 raeburn 11974: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11975: }
11976:
1.144 matthew 11977: ######################################################
11978: ######################################################
11979:
1.56 matthew 11980: =pod
11981:
1.648 raeburn 11982: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 11983:
11984: Prints a table to create associations between values and table columns.
1.144 matthew 11985:
1.41 ng 11986: $r is an Apache Request ref,
11987: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 11988: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 11989:
11990: =cut
11991:
1.144 matthew 11992: ######################################################
11993: ######################################################
1.31 albertel 11994: sub csv_print_select_table {
11995: my ($r,$records,$d) = @_;
1.301 albertel 11996: my $i=0;
11997: my $samples = &get_samples($records,1);
1.144 matthew 11998: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 11999: &start_data_table().&start_data_table_header_row().
1.144 matthew 12000: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12001: '<th>'.&mt('Column').'</th>'.
12002: &end_data_table_header_row()."\n");
1.356 albertel 12003: foreach my $array_ref (@$d) {
12004: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12005: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12006:
1.875 bisitz 12007: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12008: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12009: $r->print('<option value="none"></option>');
1.356 albertel 12010: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12011: $r->print('<option value="'.$sample.'"'.
12012: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12013: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12014: }
1.594 raeburn 12015: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12016: $i++;
12017: }
1.594 raeburn 12018: $r->print(&end_data_table());
1.31 albertel 12019: $i--;
12020: return $i;
12021: }
1.56 matthew 12022:
1.144 matthew 12023: ######################################################
12024: ######################################################
12025:
1.56 matthew 12026: =pod
1.31 albertel 12027:
1.648 raeburn 12028: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12029:
12030: Prints a table of sample values from the upload and can make associate samples to internal names.
12031:
12032: $r is an Apache Request ref,
12033: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12034: $d is an array of 2 element arrays (internal name, displayed name)
12035:
12036: =cut
12037:
1.144 matthew 12038: ######################################################
12039: ######################################################
1.31 albertel 12040: sub csv_samples_select_table {
12041: my ($r,$records,$d) = @_;
12042: my $i=0;
1.144 matthew 12043: #
1.662 bisitz 12044: my $max_samples = 5;
12045: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12046: $r->print(&start_data_table().
12047: &start_data_table_header_row().'<th>'.
12048: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12049: &end_data_table_header_row());
1.301 albertel 12050:
12051: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12052: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12053: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12054: foreach my $option (@$d) {
12055: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12056: $r->print('<option value="'.$value.'"'.
1.253 albertel 12057: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12058: $display.'</option>');
1.31 albertel 12059: }
12060: $r->print('</select></td><td>');
1.662 bisitz 12061: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12062: if (defined($samples->[$line]{$key})) {
12063: $r->print($samples->[$line]{$key}."<br />\n");
12064: }
12065: }
1.594 raeburn 12066: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12067: $i++;
12068: }
1.594 raeburn 12069: $r->print(&end_data_table());
1.31 albertel 12070: $i--;
12071: return($i);
1.115 matthew 12072: }
12073:
1.144 matthew 12074: ######################################################
12075: ######################################################
12076:
1.115 matthew 12077: =pod
12078:
1.648 raeburn 12079: =item * &clean_excel_name($name)
1.115 matthew 12080:
12081: Returns a replacement for $name which does not contain any illegal characters.
12082:
12083: =cut
12084:
1.144 matthew 12085: ######################################################
12086: ######################################################
1.115 matthew 12087: sub clean_excel_name {
12088: my ($name) = @_;
12089: $name =~ s/[:\*\?\/\\]//g;
12090: if (length($name) > 31) {
12091: $name = substr($name,0,31);
12092: }
12093: return $name;
1.25 albertel 12094: }
1.84 albertel 12095:
1.85 albertel 12096: =pod
12097:
1.648 raeburn 12098: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12099:
12100: Returns either 1 or undef
12101:
12102: 1 if the part is to be hidden, undef if it is to be shown
12103:
12104: Arguments are:
12105:
12106: $id the id of the part to be checked
12107: $symb, optional the symb of the resource to check
12108: $udom, optional the domain of the user to check for
12109: $uname, optional the username of the user to check for
12110:
12111: =cut
1.84 albertel 12112:
12113: sub check_if_partid_hidden {
12114: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12115: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12116: $symb,$udom,$uname);
1.141 albertel 12117: my $truth=1;
12118: #if the string starts with !, then the list is the list to show not hide
12119: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12120: my @hiddenlist=split(/,/,$hiddenparts);
12121: foreach my $checkid (@hiddenlist) {
1.141 albertel 12122: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12123: }
1.141 albertel 12124: return !$truth;
1.84 albertel 12125: }
1.127 matthew 12126:
1.138 matthew 12127:
12128: ############################################################
12129: ############################################################
12130:
12131: =pod
12132:
1.157 matthew 12133: =back
12134:
1.138 matthew 12135: =head1 cgi-bin script and graphing routines
12136:
1.157 matthew 12137: =over 4
12138:
1.648 raeburn 12139: =item * &get_cgi_id()
1.138 matthew 12140:
12141: Inputs: none
12142:
12143: Returns an id which can be used to pass environment variables
12144: to various cgi-bin scripts. These environment variables will
12145: be removed from the users environment after a given time by
12146: the routine &Apache::lonnet::transfer_profile_to_env.
12147:
12148: =cut
12149:
12150: ############################################################
12151: ############################################################
1.152 albertel 12152: my $uniq=0;
1.136 matthew 12153: sub get_cgi_id {
1.154 albertel 12154: $uniq=($uniq+1)%100000;
1.280 albertel 12155: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12156: }
12157:
1.127 matthew 12158: ############################################################
12159: ############################################################
12160:
12161: =pod
12162:
1.648 raeburn 12163: =item * &DrawBarGraph()
1.127 matthew 12164:
1.138 matthew 12165: Facilitates the plotting of data in a (stacked) bar graph.
12166: Puts plot definition data into the users environment in order for
12167: graph.png to plot it. Returns an <img> tag for the plot.
12168: The bars on the plot are labeled '1','2',...,'n'.
12169:
12170: Inputs:
12171:
12172: =over 4
12173:
12174: =item $Title: string, the title of the plot
12175:
12176: =item $xlabel: string, text describing the X-axis of the plot
12177:
12178: =item $ylabel: string, text describing the Y-axis of the plot
12179:
12180: =item $Max: scalar, the maximum Y value to use in the plot
12181: If $Max is < any data point, the graph will not be rendered.
12182:
1.140 matthew 12183: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12184: they are plotted. If undefined, default values will be used.
12185:
1.178 matthew 12186: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12187:
1.138 matthew 12188: =item @Values: An array of array references. Each array reference holds data
12189: to be plotted in a stacked bar chart.
12190:
1.239 matthew 12191: =item If the final element of @Values is a hash reference the key/value
12192: pairs will be added to the graph definition.
12193:
1.138 matthew 12194: =back
12195:
12196: Returns:
12197:
12198: An <img> tag which references graph.png and the appropriate identifying
12199: information for the plot.
12200:
1.127 matthew 12201: =cut
12202:
12203: ############################################################
12204: ############################################################
1.134 matthew 12205: sub DrawBarGraph {
1.178 matthew 12206: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12207: #
12208: if (! defined($colors)) {
12209: $colors = ['#33ff00',
12210: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12211: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12212: ];
12213: }
1.228 matthew 12214: my $extra_settings = {};
12215: if (ref($Values[-1]) eq 'HASH') {
12216: $extra_settings = pop(@Values);
12217: }
1.127 matthew 12218: #
1.136 matthew 12219: my $identifier = &get_cgi_id();
12220: my $id = 'cgi.'.$identifier;
1.129 matthew 12221: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12222: return '';
12223: }
1.225 matthew 12224: #
12225: my @Labels;
12226: if (defined($labels)) {
12227: @Labels = @$labels;
12228: } else {
12229: for (my $i=0;$i<@{$Values[0]};$i++) {
12230: push (@Labels,$i+1);
12231: }
12232: }
12233: #
1.129 matthew 12234: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12235: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12236: my %ValuesHash;
12237: my $NumSets=1;
12238: foreach my $array (@Values) {
12239: next if (! ref($array));
1.136 matthew 12240: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12241: join(',',@$array);
1.129 matthew 12242: }
1.127 matthew 12243: #
1.136 matthew 12244: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12245: if ($NumBars < 3) {
12246: $width = 120+$NumBars*32;
1.220 matthew 12247: $xskip = 1;
1.225 matthew 12248: $bar_width = 30;
12249: } elsif ($NumBars < 5) {
12250: $width = 120+$NumBars*20;
12251: $xskip = 1;
12252: $bar_width = 20;
1.220 matthew 12253: } elsif ($NumBars < 10) {
1.136 matthew 12254: $width = 120+$NumBars*15;
12255: $xskip = 1;
12256: $bar_width = 15;
12257: } elsif ($NumBars <= 25) {
12258: $width = 120+$NumBars*11;
12259: $xskip = 5;
12260: $bar_width = 8;
12261: } elsif ($NumBars <= 50) {
12262: $width = 120+$NumBars*8;
12263: $xskip = 5;
12264: $bar_width = 4;
12265: } else {
12266: $width = 120+$NumBars*8;
12267: $xskip = 5;
12268: $bar_width = 4;
12269: }
12270: #
1.137 matthew 12271: $Max = 1 if ($Max < 1);
12272: if ( int($Max) < $Max ) {
12273: $Max++;
12274: $Max = int($Max);
12275: }
1.127 matthew 12276: $Title = '' if (! defined($Title));
12277: $xlabel = '' if (! defined($xlabel));
12278: $ylabel = '' if (! defined($ylabel));
1.369 www 12279: $ValuesHash{$id.'.title'} = &escape($Title);
12280: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12281: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12282: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12283: $ValuesHash{$id.'.NumBars'} = $NumBars;
12284: $ValuesHash{$id.'.NumSets'} = $NumSets;
12285: $ValuesHash{$id.'.PlotType'} = 'bar';
12286: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12287: $ValuesHash{$id.'.height'} = $height;
12288: $ValuesHash{$id.'.width'} = $width;
12289: $ValuesHash{$id.'.xskip'} = $xskip;
12290: $ValuesHash{$id.'.bar_width'} = $bar_width;
12291: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12292: #
1.228 matthew 12293: # Deal with other parameters
12294: while (my ($key,$value) = each(%$extra_settings)) {
12295: $ValuesHash{$id.'.'.$key} = $value;
12296: }
12297: #
1.646 raeburn 12298: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12299: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12300: }
12301:
12302: ############################################################
12303: ############################################################
12304:
12305: =pod
12306:
1.648 raeburn 12307: =item * &DrawXYGraph()
1.137 matthew 12308:
1.138 matthew 12309: Facilitates the plotting of data in an XY graph.
12310: Puts plot definition data into the users environment in order for
12311: graph.png to plot it. Returns an <img> tag for the plot.
12312:
12313: Inputs:
12314:
12315: =over 4
12316:
12317: =item $Title: string, the title of the plot
12318:
12319: =item $xlabel: string, text describing the X-axis of the plot
12320:
12321: =item $ylabel: string, text describing the Y-axis of the plot
12322:
12323: =item $Max: scalar, the maximum Y value to use in the plot
12324: If $Max is < any data point, the graph will not be rendered.
12325:
12326: =item $colors: Array ref containing the hex color codes for the data to be
12327: plotted in. If undefined, default values will be used.
12328:
12329: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12330:
12331: =item $Ydata: Array ref containing Array refs.
1.185 www 12332: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12333:
12334: =item %Values: hash indicating or overriding any default values which are
12335: passed to graph.png.
12336: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12337:
12338: =back
12339:
12340: Returns:
12341:
12342: An <img> tag which references graph.png and the appropriate identifying
12343: information for the plot.
12344:
1.137 matthew 12345: =cut
12346:
12347: ############################################################
12348: ############################################################
12349: sub DrawXYGraph {
12350: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12351: #
12352: # Create the identifier for the graph
12353: my $identifier = &get_cgi_id();
12354: my $id = 'cgi.'.$identifier;
12355: #
12356: $Title = '' if (! defined($Title));
12357: $xlabel = '' if (! defined($xlabel));
12358: $ylabel = '' if (! defined($ylabel));
12359: my %ValuesHash =
12360: (
1.369 www 12361: $id.'.title' => &escape($Title),
12362: $id.'.xlabel' => &escape($xlabel),
12363: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12364: $id.'.y_max_value'=> $Max,
12365: $id.'.labels' => join(',',@$Xlabels),
12366: $id.'.PlotType' => 'XY',
12367: );
12368: #
12369: if (defined($colors) && ref($colors) eq 'ARRAY') {
12370: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12371: }
12372: #
12373: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12374: return '';
12375: }
12376: my $NumSets=1;
1.138 matthew 12377: foreach my $array (@{$Ydata}){
1.137 matthew 12378: next if (! ref($array));
12379: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12380: }
1.138 matthew 12381: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12382: #
12383: # Deal with other parameters
12384: while (my ($key,$value) = each(%Values)) {
12385: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12386: }
12387: #
1.646 raeburn 12388: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12389: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12390: }
12391:
12392: ############################################################
12393: ############################################################
12394:
12395: =pod
12396:
1.648 raeburn 12397: =item * &DrawXYYGraph()
1.138 matthew 12398:
12399: Facilitates the plotting of data in an XY graph with two Y axes.
12400: Puts plot definition data into the users environment in order for
12401: graph.png to plot it. Returns an <img> tag for the plot.
12402:
12403: Inputs:
12404:
12405: =over 4
12406:
12407: =item $Title: string, the title of the plot
12408:
12409: =item $xlabel: string, text describing the X-axis of the plot
12410:
12411: =item $ylabel: string, text describing the Y-axis of the plot
12412:
12413: =item $colors: Array ref containing the hex color codes for the data to be
12414: plotted in. If undefined, default values will be used.
12415:
12416: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12417:
12418: =item $Ydata1: The first data set
12419:
12420: =item $Min1: The minimum value of the left Y-axis
12421:
12422: =item $Max1: The maximum value of the left Y-axis
12423:
12424: =item $Ydata2: The second data set
12425:
12426: =item $Min2: The minimum value of the right Y-axis
12427:
12428: =item $Max2: The maximum value of the left Y-axis
12429:
12430: =item %Values: hash indicating or overriding any default values which are
12431: passed to graph.png.
12432: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12433:
12434: =back
12435:
12436: Returns:
12437:
12438: An <img> tag which references graph.png and the appropriate identifying
12439: information for the plot.
1.136 matthew 12440:
12441: =cut
12442:
12443: ############################################################
12444: ############################################################
1.137 matthew 12445: sub DrawXYYGraph {
12446: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12447: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12448: #
12449: # Create the identifier for the graph
12450: my $identifier = &get_cgi_id();
12451: my $id = 'cgi.'.$identifier;
12452: #
12453: $Title = '' if (! defined($Title));
12454: $xlabel = '' if (! defined($xlabel));
12455: $ylabel = '' if (! defined($ylabel));
12456: my %ValuesHash =
12457: (
1.369 www 12458: $id.'.title' => &escape($Title),
12459: $id.'.xlabel' => &escape($xlabel),
12460: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12461: $id.'.labels' => join(',',@$Xlabels),
12462: $id.'.PlotType' => 'XY',
12463: $id.'.NumSets' => 2,
1.137 matthew 12464: $id.'.two_axes' => 1,
12465: $id.'.y1_max_value' => $Max1,
12466: $id.'.y1_min_value' => $Min1,
12467: $id.'.y2_max_value' => $Max2,
12468: $id.'.y2_min_value' => $Min2,
1.136 matthew 12469: );
12470: #
1.137 matthew 12471: if (defined($colors) && ref($colors) eq 'ARRAY') {
12472: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12473: }
12474: #
12475: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12476: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12477: return '';
12478: }
12479: my $NumSets=1;
1.137 matthew 12480: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12481: next if (! ref($array));
12482: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12483: }
12484: #
12485: # Deal with other parameters
12486: while (my ($key,$value) = each(%Values)) {
12487: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12488: }
12489: #
1.646 raeburn 12490: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12491: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12492: }
12493:
12494: ############################################################
12495: ############################################################
12496:
12497: =pod
12498:
1.157 matthew 12499: =back
12500:
1.139 matthew 12501: =head1 Statistics helper routines?
12502:
12503: Bad place for them but what the hell.
12504:
1.157 matthew 12505: =over 4
12506:
1.648 raeburn 12507: =item * &chartlink()
1.139 matthew 12508:
12509: Returns a link to the chart for a specific student.
12510:
12511: Inputs:
12512:
12513: =over 4
12514:
12515: =item $linktext: The text of the link
12516:
12517: =item $sname: The students username
12518:
12519: =item $sdomain: The students domain
12520:
12521: =back
12522:
1.157 matthew 12523: =back
12524:
1.139 matthew 12525: =cut
12526:
12527: ############################################################
12528: ############################################################
12529: sub chartlink {
12530: my ($linktext, $sname, $sdomain) = @_;
12531: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12532: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12533: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12534: '">'.$linktext.'</a>';
1.153 matthew 12535: }
12536:
12537: #######################################################
12538: #######################################################
12539:
12540: =pod
12541:
12542: =head1 Course Environment Routines
1.157 matthew 12543:
12544: =over 4
1.153 matthew 12545:
1.648 raeburn 12546: =item * &restore_course_settings()
1.153 matthew 12547:
1.648 raeburn 12548: =item * &store_course_settings()
1.153 matthew 12549:
12550: Restores/Store indicated form parameters from the course environment.
12551: Will not overwrite existing values of the form parameters.
12552:
12553: Inputs:
12554: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12555:
12556: a hash ref describing the data to be stored. For example:
12557:
12558: %Save_Parameters = ('Status' => 'scalar',
12559: 'chartoutputmode' => 'scalar',
12560: 'chartoutputdata' => 'scalar',
12561: 'Section' => 'array',
1.373 raeburn 12562: 'Group' => 'array',
1.153 matthew 12563: 'StudentData' => 'array',
12564: 'Maps' => 'array');
12565:
12566: Returns: both routines return nothing
12567:
1.631 raeburn 12568: =back
12569:
1.153 matthew 12570: =cut
12571:
12572: #######################################################
12573: #######################################################
12574: sub store_course_settings {
1.496 albertel 12575: return &store_settings($env{'request.course.id'},@_);
12576: }
12577:
12578: sub store_settings {
1.153 matthew 12579: # save to the environment
12580: # appenv the same items, just to be safe
1.300 albertel 12581: my $udom = $env{'user.domain'};
12582: my $uname = $env{'user.name'};
1.496 albertel 12583: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12584: my %SaveHash;
12585: my %AppHash;
12586: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12587: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12588: my $envname = 'environment.'.$basename;
1.258 albertel 12589: if (exists($env{'form.'.$setting})) {
1.153 matthew 12590: # Save this value away
12591: if ($type eq 'scalar' &&
1.258 albertel 12592: (! exists($env{$envname}) ||
12593: $env{$envname} ne $env{'form.'.$setting})) {
12594: $SaveHash{$basename} = $env{'form.'.$setting};
12595: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12596: } elsif ($type eq 'array') {
12597: my $stored_form;
1.258 albertel 12598: if (ref($env{'form.'.$setting})) {
1.153 matthew 12599: $stored_form = join(',',
12600: map {
1.369 www 12601: &escape($_);
1.258 albertel 12602: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12603: } else {
12604: $stored_form =
1.369 www 12605: &escape($env{'form.'.$setting});
1.153 matthew 12606: }
12607: # Determine if the array contents are the same.
1.258 albertel 12608: if ($stored_form ne $env{$envname}) {
1.153 matthew 12609: $SaveHash{$basename} = $stored_form;
12610: $AppHash{$envname} = $stored_form;
12611: }
12612: }
12613: }
12614: }
12615: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12616: $udom,$uname);
1.153 matthew 12617: if ($put_result !~ /^(ok|delayed)/) {
12618: &Apache::lonnet::logthis('unable to save form parameters, '.
12619: 'got error:'.$put_result);
12620: }
12621: # Make sure these settings stick around in this session, too
1.646 raeburn 12622: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12623: return;
12624: }
12625:
12626: sub restore_course_settings {
1.499 albertel 12627: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12628: }
12629:
12630: sub restore_settings {
12631: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12632: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12633: next if (exists($env{'form.'.$setting}));
1.496 albertel 12634: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12635: '.'.$setting;
1.258 albertel 12636: if (exists($env{$envname})) {
1.153 matthew 12637: if ($type eq 'scalar') {
1.258 albertel 12638: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12639: } elsif ($type eq 'array') {
1.258 albertel 12640: $env{'form.'.$setting} = [
1.153 matthew 12641: map {
1.369 www 12642: &unescape($_);
1.258 albertel 12643: } split(',',$env{$envname})
1.153 matthew 12644: ];
12645: }
12646: }
12647: }
1.127 matthew 12648: }
12649:
1.618 raeburn 12650: #######################################################
12651: #######################################################
12652:
12653: =pod
12654:
12655: =head1 Domain E-mail Routines
12656:
12657: =over 4
12658:
1.648 raeburn 12659: =item * &build_recipient_list()
1.618 raeburn 12660:
1.884 raeburn 12661: Build recipient lists for five types of e-mail:
1.766 raeburn 12662: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12663: (d) Help requests, (e) Course requests needing approval, generated by
12664: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12665: loncoursequeueadmin.pm respectively.
1.618 raeburn 12666:
12667: Inputs:
1.619 raeburn 12668: defmail (scalar - email address of default recipient),
1.618 raeburn 12669: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12670: defdom (domain for which to retrieve configuration settings),
12671: origmail (scalar - email address of recipient from loncapa.conf,
12672: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12673:
1.655 raeburn 12674: Returns: comma separated list of addresses to which to send e-mail.
12675:
12676: =back
1.618 raeburn 12677:
12678: =cut
12679:
12680: ############################################################
12681: ############################################################
12682: sub build_recipient_list {
1.619 raeburn 12683: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12684: my @recipients;
12685: my $otheremails;
12686: my %domconfig =
12687: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12688: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12689: if (exists($domconfig{'contacts'}{$mailing})) {
12690: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12691: my @contacts = ('adminemail','supportemail');
12692: foreach my $item (@contacts) {
12693: if ($domconfig{'contacts'}{$mailing}{$item}) {
12694: my $addr = $domconfig{'contacts'}{$item};
12695: if (!grep(/^\Q$addr\E$/,@recipients)) {
12696: push(@recipients,$addr);
12697: }
1.619 raeburn 12698: }
1.766 raeburn 12699: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12700: }
12701: }
1.766 raeburn 12702: } elsif ($origmail ne '') {
12703: push(@recipients,$origmail);
1.618 raeburn 12704: }
1.619 raeburn 12705: } elsif ($origmail ne '') {
12706: push(@recipients,$origmail);
1.618 raeburn 12707: }
1.688 raeburn 12708: if (defined($defmail)) {
12709: if ($defmail ne '') {
12710: push(@recipients,$defmail);
12711: }
1.618 raeburn 12712: }
12713: if ($otheremails) {
1.619 raeburn 12714: my @others;
12715: if ($otheremails =~ /,/) {
12716: @others = split(/,/,$otheremails);
1.618 raeburn 12717: } else {
1.619 raeburn 12718: push(@others,$otheremails);
12719: }
12720: foreach my $addr (@others) {
12721: if (!grep(/^\Q$addr\E$/,@recipients)) {
12722: push(@recipients,$addr);
12723: }
1.618 raeburn 12724: }
12725: }
1.619 raeburn 12726: my $recipientlist = join(',',@recipients);
1.618 raeburn 12727: return $recipientlist;
12728: }
12729:
1.127 matthew 12730: ############################################################
12731: ############################################################
1.154 albertel 12732:
1.655 raeburn 12733: =pod
12734:
12735: =head1 Course Catalog Routines
12736:
12737: =over 4
12738:
12739: =item * &gather_categories()
12740:
12741: Converts category definitions - keys of categories hash stored in
12742: coursecategories in configuration.db on the primary library server in a
12743: domain - to an array. Also generates javascript and idx hash used to
12744: generate Domain Coordinator interface for editing Course Categories.
12745:
12746: Inputs:
1.663 raeburn 12747:
1.655 raeburn 12748: categories (reference to hash of category definitions).
1.663 raeburn 12749:
1.655 raeburn 12750: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12751: categories and subcategories).
1.663 raeburn 12752:
1.655 raeburn 12753: idx (reference to hash of counters used in Domain Coordinator interface for
12754: editing Course Categories).
1.663 raeburn 12755:
1.655 raeburn 12756: jsarray (reference to array of categories used to create Javascript arrays for
12757: Domain Coordinator interface for editing Course Categories).
12758:
12759: Returns: nothing
12760:
12761: Side effects: populates cats, idx and jsarray.
12762:
12763: =cut
12764:
12765: sub gather_categories {
12766: my ($categories,$cats,$idx,$jsarray) = @_;
12767: my %counters;
12768: my $num = 0;
12769: foreach my $item (keys(%{$categories})) {
12770: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12771: if ($container eq '' && $depth == 0) {
12772: $cats->[$depth][$categories->{$item}] = $cat;
12773: } else {
12774: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12775: }
12776: my ($escitem,$tail) = split(/:/,$item,2);
12777: if ($counters{$tail} eq '') {
12778: $counters{$tail} = $num;
12779: $num ++;
12780: }
12781: if (ref($idx) eq 'HASH') {
12782: $idx->{$item} = $counters{$tail};
12783: }
12784: if (ref($jsarray) eq 'ARRAY') {
12785: push(@{$jsarray->[$counters{$tail}]},$item);
12786: }
12787: }
12788: return;
12789: }
12790:
12791: =pod
12792:
12793: =item * &extract_categories()
12794:
12795: Used to generate breadcrumb trails for course categories.
12796:
12797: Inputs:
1.663 raeburn 12798:
1.655 raeburn 12799: categories (reference to hash of category definitions).
1.663 raeburn 12800:
1.655 raeburn 12801: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12802: categories and subcategories).
1.663 raeburn 12803:
1.655 raeburn 12804: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12805:
1.655 raeburn 12806: allitems (reference to hash - key is category key
12807: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12808:
1.655 raeburn 12809: idx (reference to hash of counters used in Domain Coordinator interface for
12810: editing Course Categories).
1.663 raeburn 12811:
1.655 raeburn 12812: jsarray (reference to array of categories used to create Javascript arrays for
12813: Domain Coordinator interface for editing Course Categories).
12814:
1.665 raeburn 12815: subcats (reference to hash of arrays containing all subcategories within each
12816: category, -recursive)
12817:
1.655 raeburn 12818: Returns: nothing
12819:
12820: Side effects: populates trails and allitems hash references.
12821:
12822: =cut
12823:
12824: sub extract_categories {
1.665 raeburn 12825: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12826: if (ref($categories) eq 'HASH') {
12827: &gather_categories($categories,$cats,$idx,$jsarray);
12828: if (ref($cats->[0]) eq 'ARRAY') {
12829: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12830: my $name = $cats->[0][$i];
12831: my $item = &escape($name).'::0';
12832: my $trailstr;
12833: if ($name eq 'instcode') {
12834: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12835: } elsif ($name eq 'communities') {
12836: $trailstr = &mt('Communities');
1.655 raeburn 12837: } else {
12838: $trailstr = $name;
12839: }
12840: if ($allitems->{$item} eq '') {
12841: push(@{$trails},$trailstr);
12842: $allitems->{$item} = scalar(@{$trails})-1;
12843: }
12844: my @parents = ($name);
12845: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12846: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12847: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12848: if (ref($subcats) eq 'HASH') {
12849: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12850: }
12851: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12852: }
12853: } else {
12854: if (ref($subcats) eq 'HASH') {
12855: $subcats->{$item} = [];
1.655 raeburn 12856: }
12857: }
12858: }
12859: }
12860: }
12861: return;
12862: }
12863:
12864: =pod
12865:
12866: =item *&recurse_categories()
12867:
12868: Recursively used to generate breadcrumb trails for course categories.
12869:
12870: Inputs:
1.663 raeburn 12871:
1.655 raeburn 12872: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12873: categories and subcategories).
1.663 raeburn 12874:
1.655 raeburn 12875: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12876:
12877: category (current course category, for which breadcrumb trail is being generated).
12878:
12879: trails (reference to array of breadcrumb trails for each category).
12880:
1.655 raeburn 12881: allitems (reference to hash - key is category key
12882: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12883:
1.655 raeburn 12884: parents (array containing containers directories for current category,
12885: back to top level).
12886:
12887: Returns: nothing
12888:
12889: Side effects: populates trails and allitems hash references
12890:
12891: =cut
12892:
12893: sub recurse_categories {
1.665 raeburn 12894: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12895: my $shallower = $depth - 1;
12896: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12897: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12898: my $name = $cats->[$depth]{$category}[$k];
12899: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12900: my $trailstr = join(' -> ',(@{$parents},$category));
12901: if ($allitems->{$item} eq '') {
12902: push(@{$trails},$trailstr);
12903: $allitems->{$item} = scalar(@{$trails})-1;
12904: }
12905: my $deeper = $depth+1;
12906: push(@{$parents},$category);
1.665 raeburn 12907: if (ref($subcats) eq 'HASH') {
12908: my $subcat = &escape($name).':'.$category.':'.$depth;
12909: for (my $j=@{$parents}; $j>=0; $j--) {
12910: my $higher;
12911: if ($j > 0) {
12912: $higher = &escape($parents->[$j]).':'.
12913: &escape($parents->[$j-1]).':'.$j;
12914: } else {
12915: $higher = &escape($parents->[$j]).'::'.$j;
12916: }
12917: push(@{$subcats->{$higher}},$subcat);
12918: }
12919: }
12920: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12921: $subcats);
1.655 raeburn 12922: pop(@{$parents});
12923: }
12924: } else {
12925: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12926: my $trailstr = join(' -> ',(@{$parents},$category));
12927: if ($allitems->{$item} eq '') {
12928: push(@{$trails},$trailstr);
12929: $allitems->{$item} = scalar(@{$trails})-1;
12930: }
12931: }
12932: return;
12933: }
12934:
1.663 raeburn 12935: =pod
12936:
12937: =item *&assign_categories_table()
12938:
12939: Create a datatable for display of hierarchical categories in a domain,
12940: with checkboxes to allow a course to be categorized.
12941:
12942: Inputs:
12943:
12944: cathash - reference to hash of categories defined for the domain (from
12945: configuration.db)
12946:
12947: currcat - scalar with an & separated list of categories assigned to a course.
12948:
1.919 raeburn 12949: type - scalar contains course type (Course or Community).
12950:
1.663 raeburn 12951: Returns: $output (markup to be displayed)
12952:
12953: =cut
12954:
12955: sub assign_categories_table {
1.919 raeburn 12956: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12957: my $output;
12958: if (ref($cathash) eq 'HASH') {
12959: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12960: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12961: $maxdepth = scalar(@cats);
12962: if (@cats > 0) {
12963: my $itemcount = 0;
12964: if (ref($cats[0]) eq 'ARRAY') {
12965: my @currcategories;
12966: if ($currcat ne '') {
12967: @currcategories = split('&',$currcat);
12968: }
1.919 raeburn 12969: my $table;
1.663 raeburn 12970: for (my $i=0; $i<@{$cats[0]}; $i++) {
12971: my $parent = $cats[0][$i];
1.919 raeburn 12972: next if ($parent eq 'instcode');
12973: if ($type eq 'Community') {
12974: next unless ($parent eq 'communities');
12975: } else {
12976: next if ($parent eq 'communities');
12977: }
1.663 raeburn 12978: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12979: my $item = &escape($parent).'::0';
12980: my $checked = '';
12981: if (@currcategories > 0) {
12982: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 12983: $checked = ' checked="checked"';
1.663 raeburn 12984: }
12985: }
1.919 raeburn 12986: my $parent_title = $parent;
12987: if ($parent eq 'communities') {
12988: $parent_title = &mt('Communities');
12989: }
12990: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
12991: '<input type="checkbox" name="usecategory" value="'.
12992: $item.'"'.$checked.' />'.$parent_title.'</span>'.
12993: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 12994: my $depth = 1;
12995: push(@path,$parent);
1.919 raeburn 12996: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 12997: pop(@path);
1.919 raeburn 12998: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 12999: $itemcount ++;
13000: }
1.919 raeburn 13001: if ($itemcount) {
13002: $output = &Apache::loncommon::start_data_table().
13003: $table.
13004: &Apache::loncommon::end_data_table();
13005: }
1.663 raeburn 13006: }
13007: }
13008: }
13009: return $output;
13010: }
13011:
13012: =pod
13013:
13014: =item *&assign_category_rows()
13015:
13016: Create a datatable row for display of nested categories in a domain,
13017: with checkboxes to allow a course to be categorized,called recursively.
13018:
13019: Inputs:
13020:
13021: itemcount - track row number for alternating colors
13022:
13023: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13024: categories and subcategories.
13025:
13026: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13027:
13028: parent - parent of current category item
13029:
13030: path - Array containing all categories back up through the hierarchy from the
13031: current category to the top level.
13032:
13033: currcategories - reference to array of current categories assigned to the course
13034:
13035: Returns: $output (markup to be displayed).
13036:
13037: =cut
13038:
13039: sub assign_category_rows {
13040: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13041: my ($text,$name,$item,$chgstr);
13042: if (ref($cats) eq 'ARRAY') {
13043: my $maxdepth = scalar(@{$cats});
13044: if (ref($cats->[$depth]) eq 'HASH') {
13045: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13046: my $numchildren = @{$cats->[$depth]{$parent}};
13047: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13048: $text .= '<td><table class="LC_datatable">';
13049: for (my $j=0; $j<$numchildren; $j++) {
13050: $name = $cats->[$depth]{$parent}[$j];
13051: $item = &escape($name).':'.&escape($parent).':'.$depth;
13052: my $deeper = $depth+1;
13053: my $checked = '';
13054: if (ref($currcategories) eq 'ARRAY') {
13055: if (@{$currcategories} > 0) {
13056: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13057: $checked = ' checked="checked"';
1.663 raeburn 13058: }
13059: }
13060: }
1.664 raeburn 13061: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13062: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13063: $item.'"'.$checked.' />'.$name.'</label></span>'.
13064: '<input type="hidden" name="catname" value="'.$name.'" />'.
13065: '</td><td>';
1.663 raeburn 13066: if (ref($path) eq 'ARRAY') {
13067: push(@{$path},$name);
13068: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13069: pop(@{$path});
13070: }
13071: $text .= '</td></tr>';
13072: }
13073: $text .= '</table></td>';
13074: }
13075: }
13076: }
13077: return $text;
13078: }
13079:
1.655 raeburn 13080: ############################################################
13081: ############################################################
13082:
13083:
1.443 albertel 13084: sub commit_customrole {
1.664 raeburn 13085: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13086: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13087: ($start?', '.&mt('starting').' '.localtime($start):'').
13088: ($end?', ending '.localtime($end):'').': <b>'.
13089: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13090: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13091: '</b><br />';
13092: return $output;
13093: }
13094:
13095: sub commit_standardrole {
1.541 raeburn 13096: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
13097: my ($output,$logmsg,$linefeed);
13098: if ($context eq 'auto') {
13099: $linefeed = "\n";
13100: } else {
13101: $linefeed = "<br />\n";
13102: }
1.443 albertel 13103: if ($three eq 'st') {
1.541 raeburn 13104: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
13105: $one,$two,$sec,$context);
13106: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13107: ($result eq 'unknown_course') || ($result eq 'refused')) {
13108: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13109: } else {
1.541 raeburn 13110: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13111: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13112: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13113: if ($context eq 'auto') {
13114: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13115: } else {
13116: $output .= '<b>'.$result.'</b>'.$linefeed.
13117: &mt('Add to classlist').': <b>ok</b>';
13118: }
13119: $output .= $linefeed;
1.443 albertel 13120: }
13121: } else {
13122: $output = &mt('Assigning').' '.$three.' in '.$url.
13123: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13124: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13125: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13126: if ($context eq 'auto') {
13127: $output .= $result.$linefeed;
13128: } else {
13129: $output .= '<b>'.$result.'</b>'.$linefeed;
13130: }
1.443 albertel 13131: }
13132: return $output;
13133: }
13134:
13135: sub commit_studentrole {
1.541 raeburn 13136: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 13137: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13138: if ($context eq 'auto') {
13139: $linefeed = "\n";
13140: } else {
13141: $linefeed = '<br />'."\n";
13142: }
1.443 albertel 13143: if (defined($one) && defined($two)) {
13144: my $cid=$one.'_'.$two;
13145: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13146: my $secchange = 0;
13147: my $expire_role_result;
13148: my $modify_section_result;
1.628 raeburn 13149: if ($oldsec ne '-1') {
13150: if ($oldsec ne $sec) {
1.443 albertel 13151: $secchange = 1;
1.628 raeburn 13152: my $now = time;
1.443 albertel 13153: my $uurl='/'.$cid;
13154: $uurl=~s/\_/\//g;
13155: if ($oldsec) {
13156: $uurl.='/'.$oldsec;
13157: }
1.626 raeburn 13158: $oldsecurl = $uurl;
1.628 raeburn 13159: $expire_role_result =
1.652 raeburn 13160: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13161: if ($env{'request.course.sec'} ne '') {
13162: if ($expire_role_result eq 'refused') {
13163: my @roles = ('st');
13164: my @statuses = ('previous');
13165: my @roledoms = ($one);
13166: my $withsec = 1;
13167: my %roleshash =
13168: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13169: \@statuses,\@roles,\@roledoms,$withsec);
13170: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13171: my ($oldstart,$oldend) =
13172: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13173: if ($oldend > 0 && $oldend <= $now) {
13174: $expire_role_result = 'ok';
13175: }
13176: }
13177: }
13178: }
1.443 albertel 13179: $result = $expire_role_result;
13180: }
13181: }
13182: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13183: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13184: if ($modify_section_result =~ /^ok/) {
13185: if ($secchange == 1) {
1.628 raeburn 13186: if ($sec eq '') {
13187: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13188: } else {
13189: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13190: }
1.443 albertel 13191: } elsif ($oldsec eq '-1') {
1.628 raeburn 13192: if ($sec eq '') {
13193: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13194: } else {
13195: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13196: }
1.443 albertel 13197: } else {
1.628 raeburn 13198: if ($sec eq '') {
13199: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13200: } else {
13201: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13202: }
1.443 albertel 13203: }
13204: } else {
1.628 raeburn 13205: if ($secchange) {
13206: $$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;
13207: } else {
13208: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13209: }
1.443 albertel 13210: }
13211: $result = $modify_section_result;
13212: } elsif ($secchange == 1) {
1.628 raeburn 13213: if ($oldsec eq '') {
13214: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13215: } else {
13216: $$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;
13217: }
1.626 raeburn 13218: if ($expire_role_result eq 'refused') {
13219: my $newsecurl = '/'.$cid;
13220: $newsecurl =~ s/\_/\//g;
13221: if ($sec ne '') {
13222: $newsecurl.='/'.$sec;
13223: }
13224: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13225: if ($sec eq '') {
13226: $$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;
13227: } else {
13228: $$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;
13229: }
13230: }
13231: }
1.443 albertel 13232: }
13233: } else {
1.626 raeburn 13234: $$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 13235: $result = "error: incomplete course id\n";
13236: }
13237: return $result;
13238: }
13239:
13240: ############################################################
13241: ############################################################
13242:
1.566 albertel 13243: sub check_clone {
1.578 raeburn 13244: my ($args,$linefeed) = @_;
1.566 albertel 13245: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13246: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13247: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13248: my $clonemsg;
13249: my $can_clone = 0;
1.944 raeburn 13250: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13251: if ($lctype ne 'community') {
13252: $lctype = 'course';
13253: }
1.566 albertel 13254: if ($clonehome eq 'no_host') {
1.944 raeburn 13255: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13256: $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'});
13257: } else {
13258: $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'});
13259: }
1.566 albertel 13260: } else {
13261: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13262: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13263: if ($clonedesc{'type'} ne 'Community') {
13264: $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'});
13265: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13266: }
13267: }
1.882 raeburn 13268: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13269: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13270: $can_clone = 1;
13271: } else {
13272: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13273: $args->{'clonedomain'},$args->{'clonecourse'});
13274: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13275: if (grep(/^\*$/,@cloners)) {
13276: $can_clone = 1;
13277: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13278: $can_clone = 1;
13279: } else {
1.908 raeburn 13280: my $ccrole = 'cc';
1.944 raeburn 13281: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13282: $ccrole = 'co';
13283: }
1.578 raeburn 13284: my %roleshash =
13285: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13286: $args->{'ccdomain'},
1.908 raeburn 13287: 'userroles',['active'],[$ccrole],
1.578 raeburn 13288: [$args->{'clonedomain'}]);
1.908 raeburn 13289: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13290: $can_clone = 1;
13291: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13292: $can_clone = 1;
13293: } else {
1.944 raeburn 13294: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13295: $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'});
13296: } else {
13297: $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'});
13298: }
1.578 raeburn 13299: }
1.566 albertel 13300: }
1.578 raeburn 13301: }
1.566 albertel 13302: }
13303: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13304: }
13305:
1.444 albertel 13306: sub construct_course {
1.885 raeburn 13307: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13308: my $outcome;
1.541 raeburn 13309: my $linefeed = '<br />'."\n";
13310: if ($context eq 'auto') {
13311: $linefeed = "\n";
13312: }
1.566 albertel 13313:
13314: #
13315: # Are we cloning?
13316: #
13317: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13318: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13319: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13320: if ($context ne 'auto') {
1.578 raeburn 13321: if ($clonemsg ne '') {
13322: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13323: }
1.566 albertel 13324: }
13325: $outcome .= $clonemsg.$linefeed;
13326:
13327: if (!$can_clone) {
13328: return (0,$outcome);
13329: }
13330: }
13331:
1.444 albertel 13332: #
13333: # Open course
13334: #
13335: my $crstype = lc($args->{'crstype'});
13336: my %cenv=();
13337: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13338: $args->{'cdescr'},
13339: $args->{'curl'},
13340: $args->{'course_home'},
13341: $args->{'nonstandard'},
13342: $args->{'crscode'},
13343: $args->{'ccuname'}.':'.
13344: $args->{'ccdomain'},
1.882 raeburn 13345: $args->{'crstype'},
1.885 raeburn 13346: $cnum,$context,$category);
1.444 albertel 13347:
13348: # Note: The testing routines depend on this being output; see
13349: # Utils::Course. This needs to at least be output as a comment
13350: # if anyone ever decides to not show this, and Utils::Course::new
13351: # will need to be suitably modified.
1.541 raeburn 13352: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13353: if ($$courseid =~ /^error:/) {
13354: return (0,$outcome);
13355: }
13356:
1.444 albertel 13357: #
13358: # Check if created correctly
13359: #
1.479 albertel 13360: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13361: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13362: if ($crsuhome eq 'no_host') {
13363: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13364: return (0,$outcome);
13365: }
1.541 raeburn 13366: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13367:
1.444 albertel 13368: #
1.566 albertel 13369: # Do the cloning
13370: #
13371: if ($can_clone && $cloneid) {
13372: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13373: if ($context ne 'auto') {
13374: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13375: }
13376: $outcome .= $clonemsg.$linefeed;
13377: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13378: # Copy all files
1.637 www 13379: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13380: # Restore URL
1.566 albertel 13381: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13382: # Restore title
1.566 albertel 13383: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13384: # Restore creation date, creator and creation context.
13385: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13386: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13387: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13388: # Mark as cloned
1.566 albertel 13389: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13390: # Need to clone grading mode
13391: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13392: $cenv{'grading'}=$newenv{'grading'};
13393: # Do not clone these environment entries
13394: &Apache::lonnet::del('environment',
13395: ['default_enrollment_start_date',
13396: 'default_enrollment_end_date',
13397: 'question.email',
13398: 'policy.email',
13399: 'comment.email',
13400: 'pch.users.denied',
1.725 raeburn 13401: 'plc.users.denied',
13402: 'hidefromcat',
13403: 'categories'],
1.638 www 13404: $$crsudom,$$crsunum);
1.444 albertel 13405: }
1.566 albertel 13406:
1.444 albertel 13407: #
13408: # Set environment (will override cloned, if existing)
13409: #
13410: my @sections = ();
13411: my @xlists = ();
13412: if ($args->{'crstype'}) {
13413: $cenv{'type'}=$args->{'crstype'};
13414: }
13415: if ($args->{'crsid'}) {
13416: $cenv{'courseid'}=$args->{'crsid'};
13417: }
13418: if ($args->{'crscode'}) {
13419: $cenv{'internal.coursecode'}=$args->{'crscode'};
13420: }
13421: if ($args->{'crsquota'} ne '') {
13422: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13423: } else {
13424: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13425: }
13426: if ($args->{'ccuname'}) {
13427: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13428: ':'.$args->{'ccdomain'};
13429: } else {
13430: $cenv{'internal.courseowner'} = $args->{'curruser'};
13431: }
13432: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13433: if ($args->{'crssections'}) {
13434: $cenv{'internal.sectionnums'} = '';
13435: if ($args->{'crssections'} =~ m/,/) {
13436: @sections = split/,/,$args->{'crssections'};
13437: } else {
13438: $sections[0] = $args->{'crssections'};
13439: }
13440: if (@sections > 0) {
13441: foreach my $item (@sections) {
13442: my ($sec,$gp) = split/:/,$item;
13443: my $class = $args->{'crscode'}.$sec;
13444: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13445: $cenv{'internal.sectionnums'} .= $item.',';
13446: unless ($addcheck eq 'ok') {
13447: push @badclasses, $class;
13448: }
13449: }
13450: $cenv{'internal.sectionnums'} =~ s/,$//;
13451: }
13452: }
13453: # do not hide course coordinator from staff listing,
13454: # even if privileged
13455: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13456: # add crosslistings
13457: if ($args->{'crsxlist'}) {
13458: $cenv{'internal.crosslistings'}='';
13459: if ($args->{'crsxlist'} =~ m/,/) {
13460: @xlists = split/,/,$args->{'crsxlist'};
13461: } else {
13462: $xlists[0] = $args->{'crsxlist'};
13463: }
13464: if (@xlists > 0) {
13465: foreach my $item (@xlists) {
13466: my ($xl,$gp) = split/:/,$item;
13467: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13468: $cenv{'internal.crosslistings'} .= $item.',';
13469: unless ($addcheck eq 'ok') {
13470: push @badclasses, $xl;
13471: }
13472: }
13473: $cenv{'internal.crosslistings'} =~ s/,$//;
13474: }
13475: }
13476: if ($args->{'autoadds'}) {
13477: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13478: }
13479: if ($args->{'autodrops'}) {
13480: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13481: }
13482: # check for notification of enrollment changes
13483: my @notified = ();
13484: if ($args->{'notify_owner'}) {
13485: if ($args->{'ccuname'} ne '') {
13486: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13487: }
13488: }
13489: if ($args->{'notify_dc'}) {
13490: if ($uname ne '') {
1.630 raeburn 13491: push(@notified,$uname.':'.$udom);
1.444 albertel 13492: }
13493: }
13494: if (@notified > 0) {
13495: my $notifylist;
13496: if (@notified > 1) {
13497: $notifylist = join(',',@notified);
13498: } else {
13499: $notifylist = $notified[0];
13500: }
13501: $cenv{'internal.notifylist'} = $notifylist;
13502: }
13503: if (@badclasses > 0) {
13504: my %lt=&Apache::lonlocal::texthash(
13505: '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',
13506: 'dnhr' => 'does not have rights to access enrollment in these classes',
13507: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13508: );
1.541 raeburn 13509: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13510: ' ('.$lt{'adby'}.')';
13511: if ($context eq 'auto') {
13512: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13513: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13514: foreach my $item (@badclasses) {
13515: if ($context eq 'auto') {
13516: $outcome .= " - $item\n";
13517: } else {
13518: $outcome .= "<li>$item</li>\n";
13519: }
13520: }
13521: if ($context eq 'auto') {
13522: $outcome .= $linefeed;
13523: } else {
1.566 albertel 13524: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13525: }
13526: }
1.444 albertel 13527: }
13528: if ($args->{'no_end_date'}) {
13529: $args->{'endaccess'} = 0;
13530: }
13531: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13532: $cenv{'internal.autoend'}=$args->{'enrollend'};
13533: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13534: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13535: if ($args->{'showphotos'}) {
13536: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13537: }
13538: $cenv{'internal.authtype'} = $args->{'authtype'};
13539: $cenv{'internal.autharg'} = $args->{'autharg'};
13540: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13541: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13542: 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');
13543: if ($context eq 'auto') {
13544: $outcome .= $krb_msg;
13545: } else {
1.566 albertel 13546: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13547: }
13548: $outcome .= $linefeed;
1.444 albertel 13549: }
13550: }
13551: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13552: if ($args->{'setpolicy'}) {
13553: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13554: }
13555: if ($args->{'setcontent'}) {
13556: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13557: }
13558: }
13559: if ($args->{'reshome'}) {
13560: $cenv{'reshome'}=$args->{'reshome'}.'/';
13561: $cenv{'reshome'}=~s/\/+$/\//;
13562: }
13563: #
13564: # course has keyed access
13565: #
13566: if ($args->{'setkeys'}) {
13567: $cenv{'keyaccess'}='yes';
13568: }
13569: # if specified, key authority is not course, but user
13570: # only active if keyaccess is yes
13571: if ($args->{'keyauth'}) {
1.487 albertel 13572: my ($user,$domain) = split(':',$args->{'keyauth'});
13573: $user = &LONCAPA::clean_username($user);
13574: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13575: if ($user ne '' && $domain ne '') {
1.487 albertel 13576: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13577: }
13578: }
13579:
13580: if ($args->{'disresdis'}) {
13581: $cenv{'pch.roles.denied'}='st';
13582: }
13583: if ($args->{'disablechat'}) {
13584: $cenv{'plc.roles.denied'}='st';
13585: }
13586:
13587: # Record we've not yet viewed the Course Initialization Helper for this
13588: # course
13589: $cenv{'course.helper.not.run'} = 1;
13590: #
13591: # Use new Randomseed
13592: #
13593: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13594: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13595: #
13596: # The encryption code and receipt prefix for this course
13597: #
13598: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13599: $cenv{'internal.encpref'}=100+int(9*rand(99));
13600: #
13601: # By default, use standard grading
13602: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13603:
1.541 raeburn 13604: $outcome .= $linefeed.&mt('Setting environment').': '.
13605: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13606: #
13607: # Open all assignments
13608: #
13609: if ($args->{'openall'}) {
13610: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13611: my %storecontent = ($storeunder => time,
13612: $storeunder.'.type' => 'date_start');
13613:
13614: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13615: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13616: }
13617: #
13618: # Set first page
13619: #
13620: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13621: || ($cloneid)) {
1.445 albertel 13622: use LONCAPA::map;
1.444 albertel 13623: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13624:
13625: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13626: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13627:
1.444 albertel 13628: $outcome .= ($fatal?$errtext:'read ok').' - ';
13629: my $title; my $url;
13630: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13631: $title=&mt('Syllabus');
1.444 albertel 13632: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13633: } else {
1.963 raeburn 13634: $title=&mt('Table of Contents');
1.444 albertel 13635: $url='/adm/navmaps';
13636: }
1.445 albertel 13637:
13638: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13639: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13640:
13641: if ($errtext) { $fatal=2; }
1.541 raeburn 13642: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13643: }
1.566 albertel 13644:
13645: return (1,$outcome);
1.444 albertel 13646: }
13647:
13648: ############################################################
13649: ############################################################
13650:
1.953 droeschl 13651: #SD
13652: # only Community and Course, or anything else?
1.378 raeburn 13653: sub course_type {
13654: my ($cid) = @_;
13655: if (!defined($cid)) {
13656: $cid = $env{'request.course.id'};
13657: }
1.404 albertel 13658: if (defined($env{'course.'.$cid.'.type'})) {
13659: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13660: } else {
13661: return 'Course';
1.377 raeburn 13662: }
13663: }
1.156 albertel 13664:
1.406 raeburn 13665: sub group_term {
13666: my $crstype = &course_type();
13667: my %names = (
13668: 'Course' => 'group',
1.865 raeburn 13669: 'Community' => 'group',
1.406 raeburn 13670: );
13671: return $names{$crstype};
13672: }
13673:
1.902 raeburn 13674: sub course_types {
13675: my @types = ('official','unofficial','community');
13676: my %typename = (
13677: official => 'Official course',
13678: unofficial => 'Unofficial course',
13679: community => 'Community',
13680: );
13681: return (\@types,\%typename);
13682: }
13683:
1.156 albertel 13684: sub icon {
13685: my ($file)=@_;
1.505 albertel 13686: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13687: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13688: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13689: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13690: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13691: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13692: $curfext.".gif") {
13693: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13694: $curfext.".gif";
13695: }
13696: }
1.249 albertel 13697: return &lonhttpdurl($iconname);
1.154 albertel 13698: }
1.84 albertel 13699:
1.575 albertel 13700: sub lonhttpdurl {
1.692 www 13701: #
13702: # Had been used for "small fry" static images on separate port 8080.
13703: # Modify here if lightweight http functionality desired again.
13704: # Currently eliminated due to increasing firewall issues.
13705: #
1.575 albertel 13706: my ($url)=@_;
1.692 www 13707: return $url;
1.215 albertel 13708: }
13709:
1.213 albertel 13710: sub connection_aborted {
13711: my ($r)=@_;
13712: $r->print(" ");$r->rflush();
13713: my $c = $r->connection;
13714: return $c->aborted();
13715: }
13716:
1.221 foxr 13717: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13718: # strings as 'strings'.
13719: sub escape_single {
1.221 foxr 13720: my ($input) = @_;
1.223 albertel 13721: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13722: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13723: return $input;
13724: }
1.223 albertel 13725:
1.222 foxr 13726: # Same as escape_single, but escape's "'s This
13727: # can be used for "strings"
13728: sub escape_double {
13729: my ($input) = @_;
13730: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13731: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13732: return $input;
13733: }
1.223 albertel 13734:
1.222 foxr 13735: # Escapes the last element of a full URL.
13736: sub escape_url {
13737: my ($url) = @_;
1.238 raeburn 13738: my @urlslices = split(/\//, $url,-1);
1.369 www 13739: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13740: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13741: }
1.462 albertel 13742:
1.820 raeburn 13743: sub compare_arrays {
13744: my ($arrayref1,$arrayref2) = @_;
13745: my (@difference,%count);
13746: @difference = ();
13747: %count = ();
13748: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13749: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13750: foreach my $element (keys(%count)) {
13751: if ($count{$element} == 1) {
13752: push(@difference,$element);
13753: }
13754: }
13755: }
13756: return @difference;
13757: }
13758:
1.817 bisitz 13759: # -------------------------------------------------------- Initialize user login
1.462 albertel 13760: sub init_user_environment {
1.463 albertel 13761: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13762: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13763:
13764: my $public=($username eq 'public' && $domain eq 'public');
13765:
13766: # See if old ID present, if so, remove
13767:
1.1062 raeburn 13768: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13769: my $now=time;
13770:
13771: if ($public) {
13772: my $max_public=100;
13773: my $oldest;
13774: my $oldest_time=0;
13775: for(my $next=1;$next<=$max_public;$next++) {
13776: if (-e $lonids."/publicuser_$next.id") {
13777: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13778: if ($mtime<$oldest_time || !$oldest_time) {
13779: $oldest_time=$mtime;
13780: $oldest=$next;
13781: }
13782: } else {
13783: $cookie="publicuser_$next";
13784: last;
13785: }
13786: }
13787: if (!$cookie) { $cookie="publicuser_$oldest"; }
13788: } else {
1.463 albertel 13789: # if this isn't a robot, kill any existing non-robot sessions
13790: if (!$args->{'robot'}) {
13791: opendir(DIR,$lonids);
13792: while ($filename=readdir(DIR)) {
13793: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13794: unlink($lonids.'/'.$filename);
13795: }
1.462 albertel 13796: }
1.463 albertel 13797: closedir(DIR);
1.462 albertel 13798: }
13799: # Give them a new cookie
1.463 albertel 13800: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13801: : $now.$$.int(rand(10000)));
1.463 albertel 13802: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13803:
13804: # Initialize roles
13805:
1.1062 raeburn 13806: ($userroles,$firstaccenv,$timerintenv) =
13807: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13808: }
13809: # ------------------------------------ Check browser type and MathML capability
13810:
13811: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13812: $clientunicode,$clientos) = &decode_user_agent($r);
13813:
13814: # ------------------------------------------------------------- Get environment
13815:
13816: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13817: my ($tmp) = keys(%userenv);
13818: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13819: } else {
13820: undef(%userenv);
13821: }
13822: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13823: $form->{'interface'}=$userenv{'interface'};
13824: }
13825: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13826:
13827: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13828: foreach my $option ('interface','localpath','localres') {
13829: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13830: }
13831: # --------------------------------------------------------- Write first profile
13832:
13833: {
13834: my %initial_env =
13835: ("user.name" => $username,
13836: "user.domain" => $domain,
13837: "user.home" => $authhost,
13838: "browser.type" => $clientbrowser,
13839: "browser.version" => $clientversion,
13840: "browser.mathml" => $clientmathml,
13841: "browser.unicode" => $clientunicode,
13842: "browser.os" => $clientos,
13843: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13844: "request.course.fn" => '',
13845: "request.course.uri" => '',
13846: "request.course.sec" => '',
13847: "request.role" => 'cm',
13848: "request.role.adv" => $env{'user.adv'},
13849: "request.host" => $ENV{'REMOTE_ADDR'},);
13850:
13851: if ($form->{'localpath'}) {
13852: $initial_env{"browser.localpath"} = $form->{'localpath'};
13853: $initial_env{"browser.localres"} = $form->{'localres'};
13854: }
13855:
13856: if ($form->{'interface'}) {
13857: $form->{'interface'}=~s/\W//gs;
13858: $initial_env{"browser.interface"} = $form->{'interface'};
13859: $env{'browser.interface'}=$form->{'interface'};
13860: }
13861:
1.981 raeburn 13862: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13863: my %domdef;
13864: unless ($domain eq 'public') {
13865: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13866: }
1.980 raeburn 13867:
1.1081 raeburn 13868: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 13869: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13870: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13871: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13872: }
13873:
1.864 raeburn 13874: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13875: $userenv{'canrequest.'.$crstype} =
13876: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13877: 'reload','requestcourses',
13878: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13879: }
13880:
1.1092 raeburn 13881: $userenv{'canrequest.author'} =
13882: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
13883: 'reload','requestauthor',
13884: \%userenv,\%domdef,\%is_adv);
13885: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
13886: $domain,$username);
13887: my $reqstatus = $reqauthor{'author_status'};
13888: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
13889: if (ref($reqauthor{'author'}) eq 'HASH') {
13890: $userenv{'requestauthorqueued'} = $reqstatus.':'.
13891: $reqauthor{'author'}{'timestamp'};
13892: }
13893: }
13894:
1.462 albertel 13895: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13896:
1.462 albertel 13897: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13898: &GDBM_WRCREAT(),0640)) {
13899: &_add_to_env(\%disk_env,\%initial_env);
13900: &_add_to_env(\%disk_env,\%userenv,'environment.');
13901: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13902: if (ref($firstaccenv) eq 'HASH') {
13903: &_add_to_env(\%disk_env,$firstaccenv);
13904: }
13905: if (ref($timerintenv) eq 'HASH') {
13906: &_add_to_env(\%disk_env,$timerintenv);
13907: }
1.463 albertel 13908: if (ref($args->{'extra_env'})) {
13909: &_add_to_env(\%disk_env,$args->{'extra_env'});
13910: }
1.462 albertel 13911: untie(%disk_env);
13912: } else {
1.705 tempelho 13913: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13914: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13915: return 'error: '.$!;
13916: }
13917: }
13918: $env{'request.role'}='cm';
13919: $env{'request.role.adv'}=$env{'user.adv'};
13920: $env{'browser.type'}=$clientbrowser;
13921:
13922: return $cookie;
13923:
13924: }
13925:
13926: sub _add_to_env {
13927: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13928: if (ref($env_data) eq 'HASH') {
13929: while (my ($key,$value) = each(%$env_data)) {
13930: $idf->{$prefix.$key} = $value;
13931: $env{$prefix.$key} = $value;
13932: }
1.462 albertel 13933: }
13934: }
13935:
1.685 tempelho 13936: # --- Get the symbolic name of a problem and the url
13937: sub get_symb {
13938: my ($request,$silent) = @_;
1.726 raeburn 13939: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13940: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13941: if ($symb eq '') {
13942: if (!$silent) {
1.1071 raeburn 13943: if (ref($request)) {
13944: $request->print("Unable to handle ambiguous references:$url:.");
13945: }
1.685 tempelho 13946: return ();
13947: }
13948: }
13949: &Apache::lonenc::check_decrypt(\$symb);
13950: return ($symb);
13951: }
13952:
13953: # --------------------------------------------------------------Get annotation
13954:
13955: sub get_annotation {
13956: my ($symb,$enc) = @_;
13957:
13958: my $key = $symb;
13959: if (!$enc) {
13960: $key =
13961: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13962: }
13963: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13964: return $annotation{$key};
13965: }
13966:
13967: sub clean_symb {
1.731 raeburn 13968: my ($symb,$delete_enc) = @_;
1.685 tempelho 13969:
13970: &Apache::lonenc::check_decrypt(\$symb);
13971: my $enc = $env{'request.enc'};
1.731 raeburn 13972: if ($delete_enc) {
1.730 raeburn 13973: delete($env{'request.enc'});
13974: }
1.685 tempelho 13975:
13976: return ($symb,$enc);
13977: }
1.462 albertel 13978:
1.990 raeburn 13979: sub build_release_hashes {
13980: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13981: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
13982: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
13983: (ref($randomizetry) eq 'HASH'));
13984: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
13985: my ($item,$name,$value) = split(/:/,$key);
13986: if ($item eq 'parameter') {
13987: if (ref($checkparms->{$name}) eq 'ARRAY') {
13988: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
13989: push(@{$checkparms->{$name}},$value);
13990: }
13991: } else {
13992: push(@{$checkparms->{$name}},$value);
13993: }
13994: } elsif ($item eq 'resourcetag') {
13995: if ($name eq 'responsetype') {
13996: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
13997: }
13998: } elsif ($item eq 'course') {
13999: if ($name eq 'crstype') {
14000: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14001: }
14002: }
14003: }
14004: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14005: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14006: return;
14007: }
14008:
1.1083 raeburn 14009: sub update_content_constraints {
14010: my ($cdom,$cnum,$chome,$cid) = @_;
14011: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14012: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14013: my %checkresponsetypes;
14014: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14015: my ($item,$name,$value) = split(/:/,$key);
14016: if ($item eq 'resourcetag') {
14017: if ($name eq 'responsetype') {
14018: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14019: }
14020: }
14021: }
14022: my $navmap = Apache::lonnavmaps::navmap->new();
14023: if (defined($navmap)) {
14024: my %allresponses;
14025: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14026: my %responses = $res->responseTypes();
14027: foreach my $key (keys(%responses)) {
14028: next unless(exists($checkresponsetypes{$key}));
14029: $allresponses{$key} += $responses{$key};
14030: }
14031: }
14032: foreach my $key (keys(%allresponses)) {
14033: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14034: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14035: ($reqdmajor,$reqdminor) = ($major,$minor);
14036: }
14037: }
14038: undef($navmap);
14039: }
14040: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14041: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14042: }
14043: return;
14044: }
14045:
14046: sub parse_supplemental_title {
14047: my ($title) = @_;
14048:
14049: my ($foldertitle,$renametitle);
14050: if ($title =~ /&&&/) {
14051: $title = &HTML::Entites::decode($title);
14052: }
14053: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14054: $renametitle=$4;
14055: my ($time,$uname,$udom) = ($1,$2,$3);
14056: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14057: my $name = &plainname($uname,$udom);
14058: $name = &HTML::Entities::encode($name,'"<>&\'');
14059: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14060: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14061: $name.': <br />'.$foldertitle;
14062: }
14063: if (wantarray) {
14064: return ($title,$foldertitle,$renametitle);
14065: }
14066: return $title;
14067: }
14068:
1.1094 raeburn 14069: sub captcha_display {
14070: my ($context,$lonhost) = @_;
14071: my ($output,$error);
14072: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 ! raeburn 14073: if ($captcha eq 'original') {
1.1094 raeburn 14074: $output = &create_captcha();
14075: unless ($output) {
14076: $error = 'captcha';
14077: }
14078: } elsif ($captcha eq 'recaptcha') {
14079: $output = &create_recaptcha($pubkey);
14080: unless ($output) {
1.1095 ! raeburn 14081: $error = 'recaptcha';
1.1094 raeburn 14082: }
14083: }
14084: return ($output,$error);
14085: }
14086:
14087: sub captcha_response {
14088: my ($context,$lonhost) = @_;
14089: my ($captcha_chk,$captcha_error);
14090: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 ! raeburn 14091: if ($captcha eq 'original') {
1.1094 raeburn 14092: ($captcha_chk,$captcha_error) = &check_captcha();
14093: } elsif ($captcha eq 'recaptcha') {
14094: $captcha_chk = &check_recaptcha($privkey);
14095: } else {
14096: $captcha_chk = 1;
14097: }
14098: return ($captcha_chk,$captcha_error);
14099: }
14100:
14101: sub get_captcha_config {
14102: my ($context,$lonhost) = @_;
1.1095 ! raeburn 14103: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 14104: my $hostname = &Apache::lonnet::hostname($lonhost);
14105: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14106: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 ! raeburn 14107: if ($context eq 'usercreation') {
! 14108: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
! 14109: if (ref($domconfig{$context}) eq 'HASH') {
! 14110: $hashtocheck = $domconfig{$context}{'cancreate'};
! 14111: if (ref($hashtocheck) eq 'HASH') {
! 14112: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
! 14113: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
! 14114: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
! 14115: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
! 14116: }
! 14117: if ($privkey && $pubkey) {
! 14118: $captcha = 'recaptcha';
! 14119: } else {
! 14120: $captcha = 'original';
! 14121: }
! 14122: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
! 14123: $captcha = 'original';
! 14124: }
1.1094 raeburn 14125: }
1.1095 ! raeburn 14126: } else {
! 14127: $captcha = 'captcha';
! 14128: }
! 14129: } elsif ($context eq 'login') {
! 14130: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
! 14131: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
! 14132: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
! 14133: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 14134: if ($privkey && $pubkey) {
14135: $captcha = 'recaptcha';
1.1095 ! raeburn 14136: } else {
! 14137: $captcha = 'original';
1.1094 raeburn 14138: }
1.1095 ! raeburn 14139: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
! 14140: $captcha = 'original';
1.1094 raeburn 14141: }
14142: }
14143: return ($captcha,$pubkey,$privkey);
14144: }
14145:
14146: sub create_captcha {
14147: my %captcha_params = &captcha_settings();
14148: my ($output,$maxtries,$tries) = ('',10,0);
14149: while ($tries < $maxtries) {
14150: $tries ++;
14151: my $captcha = Authen::Captcha->new (
14152: output_folder => $captcha_params{'output_dir'},
14153: data_folder => $captcha_params{'db_dir'},
14154: );
14155: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14156:
14157: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14158: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14159: &mt('Type in the letters/numbers shown below').' '.
14160: '<input type="text" size="5" name="code" value="" /><br />'.
14161: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14162: last;
14163: }
14164: }
14165: return $output;
14166: }
14167:
14168: sub captcha_settings {
14169: my %captcha_params = (
14170: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14171: www_output_dir => "/captchaspool",
14172: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14173: numchars => '5',
14174: );
14175: return %captcha_params;
14176: }
14177:
14178: sub check_captcha {
14179: my ($captcha_chk,$captcha_error);
14180: my $code = $env{'form.code'};
14181: my $md5sum = $env{'form.crypt'};
14182: my %captcha_params = &captcha_settings();
14183: my $captcha = Authen::Captcha->new(
14184: output_folder => $captcha_params{'output_dir'},
14185: data_folder => $captcha_params{'db_dir'},
14186: );
14187: my $captcha_chk = $captcha->check_code($code,$md5sum);
14188: my %captcha_hash = (
14189: 0 => 'Code not checked (file error)',
14190: -1 => 'Failed: code expired',
14191: -2 => 'Failed: invalid code (not in database)',
14192: -3 => 'Failed: invalid code (code does not match crypt)',
14193: );
14194: if ($captcha_chk != 1) {
14195: $captcha_error = $captcha_hash{$captcha_chk}
14196: }
14197: return ($captcha_chk,$captcha_error);
14198: }
14199:
14200: sub create_recaptcha {
14201: my ($pubkey) = @_;
14202: my $captcha = Captcha::reCAPTCHA->new;
14203: return $captcha->get_options_setter({theme => 'white'})."\n".
14204: $captcha->get_html($pubkey).
14205: &mt('If either word is hard to read, [_1] will replace them.',
14206: '<image src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
14207: '<br /><br />';
14208: }
14209:
14210: sub check_recaptcha {
14211: my ($privkey) = @_;
14212: my $captcha_chk;
14213: my $captcha = Captcha::reCAPTCHA->new;
14214: my $captcha_result =
14215: $captcha->check_answer(
14216: $privkey,
14217: $ENV{'REMOTE_ADDR'},
14218: $env{'form.recaptcha_challenge_field'},
14219: $env{'form.recaptcha_response_field'},
14220: );
14221: if ($captcha_result->{is_valid}) {
14222: $captcha_chk = 1;
14223: }
14224: return $captcha_chk;
14225: }
14226:
1.41 ng 14227: =pod
14228:
14229: =back
14230:
1.112 bowersj2 14231: =cut
1.41 ng 14232:
1.112 bowersj2 14233: 1;
14234: __END__;
1.41 ng 14235:
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