Annotation of loncom/interface/loncommon.pm, revision 1.1096
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1096 ! raeburn 4: # $Id: loncommon.pm,v 1.1095 2012/08/27 06:28:06 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.1096 ! raeburn 3329: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
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.1096 ! raeburn 5063: =item * $advtoolsref, optional argument, ref to an array containing
! 5064: inlineremote items to be added in "Functions" menu below
! 5065: breadcrumbs.
! 5066:
1.112 bowersj2 5067: =back
5068:
1.60 matthew 5069: Returns: A uniform header for LON-CAPA web pages.
5070: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5071: If $bodyonly is undef or zero, an html string containing a <body> tag and
5072: other decorations will be returned.
5073:
5074: =cut
5075:
1.54 www 5076: sub bodytag {
1.831 bisitz 5077: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 ! raeburn 5078: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5079:
1.954 raeburn 5080: my $public;
5081: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5082: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5083: $public = 1;
5084: }
1.460 albertel 5085: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 5086:
1.183 matthew 5087: $function = &get_users_function() if (!$function);
1.339 albertel 5088: my $img = &designparm($function.'.img',$domain);
5089: my $font = &designparm($function.'.font',$domain);
5090: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5091:
1.803 bisitz 5092: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5093: 'bgcolor' => $pgbg,
1.339 albertel 5094: 'text' => $font,
5095: 'alink' => &designparm($function.'.alink',$domain),
5096: 'vlink' => &designparm($function.'.vlink',$domain),
5097: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5098: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5099:
1.63 www 5100: # role and realm
1.378 raeburn 5101: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5102: if ($role eq 'ca') {
1.479 albertel 5103: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5104: $realm = &plainname($rname,$rdom);
1.378 raeburn 5105: }
1.55 www 5106: # realm
1.258 albertel 5107: if ($env{'request.course.id'}) {
1.378 raeburn 5108: if ($env{'request.role'} !~ /^cr/) {
5109: $role = &Apache::lonnet::plaintext($role,&course_type());
5110: }
1.898 raeburn 5111: if ($env{'request.course.sec'}) {
5112: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5113: }
1.359 albertel 5114: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5115: } else {
5116: $role = &Apache::lonnet::plaintext($role);
1.54 www 5117: }
1.433 albertel 5118:
1.359 albertel 5119: if (!$realm) { $realm=' '; }
1.330 albertel 5120:
1.438 albertel 5121: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5122:
1.101 www 5123: # construct main body tag
1.359 albertel 5124: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5125: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5126:
1.530 albertel 5127: if ($bodyonly) {
1.60 matthew 5128: return $bodytag;
1.798 tempelho 5129: }
1.359 albertel 5130:
1.410 albertel 5131: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5132: if ($public) {
1.433 albertel 5133: undef($role);
1.434 albertel 5134: } else {
1.1070 raeburn 5135: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5136: undef,'LC_menubuttons_link');
1.433 albertel 5137: }
1.359 albertel 5138:
1.762 bisitz 5139: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5140: #
5141: # Extra info if you are the DC
5142: my $dc_info = '';
5143: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5144: $env{'course.'.$env{'request.course.id'}.
5145: '.domain'}.'/'})) {
5146: my $cid = $env{'request.course.id'};
1.917 raeburn 5147: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5148: $dc_info =~ s/\s+$//;
1.359 albertel 5149: }
5150:
1.898 raeburn 5151: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5152: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5153:
1.916 droeschl 5154: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
5155: return $bodytag;
5156: }
1.903 droeschl 5157:
5158: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5159:
5160: # if ($env{'request.state'} eq 'construct') {
5161: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5162: # }
5163:
1.359 albertel 5164:
5165:
1.916 droeschl 5166: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5167: if ($dc_info) {
5168: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5169: }
1.916 droeschl 5170: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5171: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5172: return $bodytag;
5173: }
1.894 droeschl 5174:
1.927 raeburn 5175: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5176: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5177: }
1.916 droeschl 5178:
1.903 droeschl 5179: $bodytag .= Apache::lonhtmlcommon::scripttag(
5180: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5181:
1.903 droeschl 5182: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5183:
1.917 raeburn 5184: if ($dc_info) {
5185: $dc_info = &dc_courseid_toggle($dc_info);
5186: }
5187: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5188:
1.903 droeschl 5189: #don't show menus for public users
1.954 raeburn 5190: if (!$public){
1.903 droeschl 5191: $bodytag .= Apache::lonmenu::secondary_menu();
5192: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5193: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5194: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5195: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5196: $args->{'bread_crumbs'});
1.1096 ! raeburn 5197: } elsif ($forcereg) {
! 5198: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
! 5199: $args->{'group'});
! 5200: } else {
! 5201: $bodytag .=
! 5202: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
! 5203: $forcereg,$args->{'group'},
! 5204: $args->{'bread_crumbs'},
! 5205: $advtoolsref);
1.920 raeburn 5206: }
1.903 droeschl 5207: }else{
5208: # this is to seperate menu from content when there's no secondary
5209: # menu. Especially needed for public accessible ressources.
5210: $bodytag .= '<hr style="clear:both" />';
5211: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5212: }
1.903 droeschl 5213:
1.235 raeburn 5214: return $bodytag;
1.182 matthew 5215: }
5216:
1.917 raeburn 5217: sub dc_courseid_toggle {
5218: my ($dc_info) = @_;
1.980 raeburn 5219: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5220: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5221: &mt('(More ...)').'</a></span>'.
5222: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5223: }
5224:
1.330 albertel 5225: sub make_attr_string {
5226: my ($register,$attr_ref) = @_;
5227:
5228: if ($attr_ref && !ref($attr_ref)) {
5229: die("addentries Must be a hash ref ".
5230: join(':',caller(1))." ".
5231: join(':',caller(0))." ");
5232: }
5233:
5234: if ($register) {
1.339 albertel 5235: my ($on_load,$on_unload);
5236: foreach my $key (keys(%{$attr_ref})) {
5237: if (lc($key) eq 'onload') {
5238: $on_load.=$attr_ref->{$key}.';';
5239: delete($attr_ref->{$key});
5240:
5241: } elsif (lc($key) eq 'onunload') {
5242: $on_unload.=$attr_ref->{$key}.';';
5243: delete($attr_ref->{$key});
5244: }
5245: }
1.953 droeschl 5246: $attr_ref->{'onload'} = $on_load;
5247: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 5248: }
1.339 albertel 5249:
1.330 albertel 5250: my $attr_string;
5251: foreach my $attr (keys(%$attr_ref)) {
5252: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5253: }
5254: return $attr_string;
5255: }
5256:
5257:
1.182 matthew 5258: ###############################################
1.251 albertel 5259: ###############################################
5260:
5261: =pod
5262:
5263: =item * &endbodytag()
5264:
5265: Returns a uniform footer for LON-CAPA web pages.
5266:
1.635 raeburn 5267: Inputs: 1 - optional reference to an args hash
5268: If in the hash, key for noredirectlink has a value which evaluates to true,
5269: a 'Continue' link is not displayed if the page contains an
5270: internal redirect in the <head></head> section,
5271: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5272:
5273: =cut
5274:
5275: sub endbodytag {
1.635 raeburn 5276: my ($args) = @_;
1.1080 raeburn 5277: my $endbodytag;
5278: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5279: $endbodytag='</body>';
5280: }
1.269 albertel 5281: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5282: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5283: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5284: $endbodytag=
5285: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5286: &mt('Continue').'</a>'.
5287: $endbodytag;
5288: }
1.315 albertel 5289: }
1.251 albertel 5290: return $endbodytag;
5291: }
5292:
1.352 albertel 5293: =pod
5294:
5295: =item * &standard_css()
5296:
5297: Returns a style sheet
5298:
5299: Inputs: (all optional)
5300: domain -> force to color decorate a page for a specific
5301: domain
5302: function -> force usage of a specific rolish color scheme
5303: bgcolor -> override the default page bgcolor
5304:
5305: =cut
5306:
1.343 albertel 5307: sub standard_css {
1.345 albertel 5308: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5309: $function = &get_users_function() if (!$function);
5310: my $img = &designparm($function.'.img', $domain);
5311: my $tabbg = &designparm($function.'.tabbg', $domain);
5312: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5313: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5314: #second colour for later usage
1.345 albertel 5315: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5316: my $pgbg_or_bgcolor =
5317: $bgcolor ||
1.352 albertel 5318: &designparm($function.'.pgbg', $domain);
1.382 albertel 5319: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5320: my $alink = &designparm($function.'.alink', $domain);
5321: my $vlink = &designparm($function.'.vlink', $domain);
5322: my $link = &designparm($function.'.link', $domain);
5323:
1.602 albertel 5324: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5325: my $mono = 'monospace';
1.850 bisitz 5326: my $data_table_head = $sidebg;
5327: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5328: my $data_table_dark = '#E0E0E0';
1.470 banghart 5329: my $data_table_darker = '#CCCCCC';
1.349 albertel 5330: my $data_table_highlight = '#FFFF00';
1.352 albertel 5331: my $mail_new = '#FFBB77';
5332: my $mail_new_hover = '#DD9955';
5333: my $mail_read = '#BBBB77';
5334: my $mail_read_hover = '#999944';
5335: my $mail_replied = '#AAAA88';
5336: my $mail_replied_hover = '#888855';
5337: my $mail_other = '#99BBBB';
5338: my $mail_other_hover = '#669999';
1.391 albertel 5339: my $table_header = '#DDDDDD';
1.489 raeburn 5340: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5341: my $lg_border_color = '#C8C8C8';
1.952 onken 5342: my $button_hover = '#BF2317';
1.392 albertel 5343:
1.608 albertel 5344: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5345: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5346: : '0 3px 0 4px';
1.448 albertel 5347:
1.523 albertel 5348:
1.343 albertel 5349: return <<END;
1.947 droeschl 5350:
5351: /* needed for iframe to allow 100% height in FF */
5352: body, html {
5353: margin: 0;
5354: padding: 0 0.5%;
5355: height: 99%; /* to avoid scrollbars */
5356: }
5357:
1.795 www 5358: body {
1.911 bisitz 5359: font-family: $sans;
5360: line-height:130%;
5361: font-size:0.83em;
5362: color:$font;
1.795 www 5363: }
5364:
1.959 onken 5365: a:focus,
5366: a:focus img {
1.795 www 5367: color: red;
5368: }
1.698 harmsja 5369:
1.911 bisitz 5370: form, .inline {
5371: display: inline;
1.795 www 5372: }
1.721 harmsja 5373:
1.795 www 5374: .LC_right {
1.911 bisitz 5375: text-align:right;
1.795 www 5376: }
5377:
5378: .LC_middle {
1.911 bisitz 5379: vertical-align:middle;
1.795 www 5380: }
1.721 harmsja 5381:
1.911 bisitz 5382: .LC_400Box {
5383: width:400px;
5384: }
1.721 harmsja 5385:
1.947 droeschl 5386: .LC_iframecontainer {
5387: width: 98%;
5388: margin: 0;
5389: position: fixed;
5390: top: 8.5em;
5391: bottom: 0;
5392: }
5393:
5394: .LC_iframecontainer iframe{
5395: border: none;
5396: width: 100%;
5397: height: 100%;
5398: }
5399:
1.778 bisitz 5400: .LC_filename {
5401: font-family: $mono;
5402: white-space:pre;
1.921 bisitz 5403: font-size: 120%;
1.778 bisitz 5404: }
5405:
5406: .LC_fileicon {
5407: border: none;
5408: height: 1.3em;
5409: vertical-align: text-bottom;
5410: margin-right: 0.3em;
5411: text-decoration:none;
5412: }
5413:
1.1008 www 5414: .LC_setting {
5415: text-decoration:underline;
5416: }
5417:
1.350 albertel 5418: .LC_error {
5419: color: red;
5420: font-size: larger;
5421: }
1.795 www 5422:
1.457 albertel 5423: .LC_warning,
5424: .LC_diff_removed {
1.733 bisitz 5425: color: red;
1.394 albertel 5426: }
1.532 albertel 5427:
5428: .LC_info,
1.457 albertel 5429: .LC_success,
5430: .LC_diff_added {
1.350 albertel 5431: color: green;
5432: }
1.795 www 5433:
1.802 bisitz 5434: div.LC_confirm_box {
5435: background-color: #FAFAFA;
5436: border: 1px solid $lg_border_color;
5437: margin-right: 0;
5438: padding: 5px;
5439: }
5440:
5441: div.LC_confirm_box .LC_error img,
5442: div.LC_confirm_box .LC_success img {
5443: vertical-align: middle;
5444: }
5445:
1.440 albertel 5446: .LC_icon {
1.771 droeschl 5447: border: none;
1.790 droeschl 5448: vertical-align: middle;
1.771 droeschl 5449: }
5450:
1.543 albertel 5451: .LC_docs_spacer {
5452: width: 25px;
5453: height: 1px;
1.771 droeschl 5454: border: none;
1.543 albertel 5455: }
1.346 albertel 5456:
1.532 albertel 5457: .LC_internal_info {
1.735 bisitz 5458: color: #999999;
1.532 albertel 5459: }
5460:
1.794 www 5461: .LC_discussion {
1.1050 www 5462: background: $data_table_dark;
1.911 bisitz 5463: border: 1px solid black;
5464: margin: 2px;
1.794 www 5465: }
5466:
5467: .LC_disc_action_left {
1.1050 www 5468: background: $sidebg;
1.911 bisitz 5469: text-align: left;
1.1050 www 5470: padding: 4px;
5471: margin: 2px;
1.794 www 5472: }
5473:
5474: .LC_disc_action_right {
1.1050 www 5475: background: $sidebg;
1.911 bisitz 5476: text-align: right;
1.1050 www 5477: padding: 4px;
5478: margin: 2px;
1.794 www 5479: }
5480:
5481: .LC_disc_new_item {
1.911 bisitz 5482: background: white;
5483: border: 2px solid red;
1.1050 www 5484: margin: 4px;
5485: padding: 4px;
1.794 www 5486: }
5487:
5488: .LC_disc_old_item {
1.911 bisitz 5489: background: white;
1.1050 www 5490: margin: 4px;
5491: padding: 4px;
1.794 www 5492: }
5493:
1.458 albertel 5494: table.LC_pastsubmission {
5495: border: 1px solid black;
5496: margin: 2px;
5497: }
5498:
1.924 bisitz 5499: table#LC_menubuttons {
1.345 albertel 5500: width: 100%;
5501: background: $pgbg;
1.392 albertel 5502: border: 2px;
1.402 albertel 5503: border-collapse: separate;
1.803 bisitz 5504: padding: 0;
1.345 albertel 5505: }
1.392 albertel 5506:
1.801 tempelho 5507: table#LC_title_bar a {
5508: color: $fontmenu;
5509: }
1.836 bisitz 5510:
1.807 droeschl 5511: table#LC_title_bar {
1.819 tempelho 5512: clear: both;
1.836 bisitz 5513: display: none;
1.807 droeschl 5514: }
5515:
1.795 www 5516: table#LC_title_bar,
1.933 droeschl 5517: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5518: table#LC_title_bar.LC_with_remote {
1.359 albertel 5519: width: 100%;
1.392 albertel 5520: border-color: $pgbg;
5521: border-style: solid;
5522: border-width: $border;
1.379 albertel 5523: background: $pgbg;
1.801 tempelho 5524: color: $fontmenu;
1.392 albertel 5525: border-collapse: collapse;
1.803 bisitz 5526: padding: 0;
1.819 tempelho 5527: margin: 0;
1.359 albertel 5528: }
1.795 www 5529:
1.933 droeschl 5530: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5531: margin: 0;
5532: padding: 0;
1.933 droeschl 5533: position: relative;
5534: list-style: none;
1.913 droeschl 5535: }
1.933 droeschl 5536: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5537: display: inline;
5538: }
1.933 droeschl 5539:
5540: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5541: padding: 0;
1.933 droeschl 5542: margin: 0;
5543: float: left;
1.913 droeschl 5544: }
1.933 droeschl 5545: .LC_breadcrumb_tools_tools {
5546: padding: 0;
5547: margin: 0;
1.913 droeschl 5548: float: right;
5549: }
5550:
1.359 albertel 5551: table#LC_title_bar td {
5552: background: $tabbg;
5553: }
1.795 www 5554:
1.911 bisitz 5555: table#LC_menubuttons img {
1.803 bisitz 5556: border: none;
1.346 albertel 5557: }
1.795 www 5558:
1.842 droeschl 5559: .LC_breadcrumbs_component {
1.911 bisitz 5560: float: right;
5561: margin: 0 1em;
1.357 albertel 5562: }
1.842 droeschl 5563: .LC_breadcrumbs_component img {
1.911 bisitz 5564: vertical-align: middle;
1.777 tempelho 5565: }
1.795 www 5566:
1.383 albertel 5567: td.LC_table_cell_checkbox {
5568: text-align: center;
5569: }
1.795 www 5570:
5571: .LC_fontsize_small {
1.911 bisitz 5572: font-size: 70%;
1.705 tempelho 5573: }
5574:
1.844 bisitz 5575: #LC_breadcrumbs {
1.911 bisitz 5576: clear:both;
5577: background: $sidebg;
5578: border-bottom: 1px solid $lg_border_color;
5579: line-height: 2.5em;
1.933 droeschl 5580: overflow: hidden;
1.911 bisitz 5581: margin: 0;
5582: padding: 0;
1.995 raeburn 5583: text-align: left;
1.819 tempelho 5584: }
1.862 bisitz 5585:
1.993 raeburn 5586: .LC_head_subbox {
1.911 bisitz 5587: clear:both;
5588: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5589: border: 1px solid $sidebg;
5590: margin: 0 0 10px 0;
1.966 bisitz 5591: padding: 3px;
1.995 raeburn 5592: text-align: left;
1.822 bisitz 5593: }
5594:
1.795 www 5595: .LC_fontsize_medium {
1.911 bisitz 5596: font-size: 85%;
1.705 tempelho 5597: }
5598:
1.795 www 5599: .LC_fontsize_large {
1.911 bisitz 5600: font-size: 120%;
1.705 tempelho 5601: }
5602:
1.346 albertel 5603: .LC_menubuttons_inline_text {
5604: color: $font;
1.698 harmsja 5605: font-size: 90%;
1.701 harmsja 5606: padding-left:3px;
1.346 albertel 5607: }
5608:
1.934 droeschl 5609: .LC_menubuttons_inline_text img{
5610: vertical-align: middle;
5611: }
5612:
1.1051 www 5613: li.LC_menubuttons_inline_text img {
1.951 onken 5614: cursor:pointer;
1.1002 droeschl 5615: text-decoration: none;
1.951 onken 5616: }
5617:
1.526 www 5618: .LC_menubuttons_link {
5619: text-decoration: none;
5620: }
1.795 www 5621:
1.522 albertel 5622: .LC_menubuttons_category {
1.521 www 5623: color: $font;
1.526 www 5624: background: $pgbg;
1.521 www 5625: font-size: larger;
5626: font-weight: bold;
5627: }
5628:
1.346 albertel 5629: td.LC_menubuttons_text {
1.911 bisitz 5630: color: $font;
1.346 albertel 5631: }
1.706 harmsja 5632:
1.346 albertel 5633: .LC_current_location {
5634: background: $tabbg;
5635: }
1.795 www 5636:
1.938 bisitz 5637: table.LC_data_table {
1.347 albertel 5638: border: 1px solid #000000;
1.402 albertel 5639: border-collapse: separate;
1.426 albertel 5640: border-spacing: 1px;
1.610 albertel 5641: background: $pgbg;
1.347 albertel 5642: }
1.795 www 5643:
1.422 albertel 5644: .LC_data_table_dense {
5645: font-size: small;
5646: }
1.795 www 5647:
1.507 raeburn 5648: table.LC_nested_outer {
5649: border: 1px solid #000000;
1.589 raeburn 5650: border-collapse: collapse;
1.803 bisitz 5651: border-spacing: 0;
1.507 raeburn 5652: width: 100%;
5653: }
1.795 www 5654:
1.879 raeburn 5655: table.LC_innerpickbox,
1.507 raeburn 5656: table.LC_nested {
1.803 bisitz 5657: border: none;
1.589 raeburn 5658: border-collapse: collapse;
1.803 bisitz 5659: border-spacing: 0;
1.507 raeburn 5660: width: 100%;
5661: }
1.795 www 5662:
1.911 bisitz 5663: table.LC_data_table tr th,
5664: table.LC_calendar tr th,
1.879 raeburn 5665: table.LC_prior_tries tr th,
5666: table.LC_innerpickbox tr th {
1.349 albertel 5667: font-weight: bold;
5668: background-color: $data_table_head;
1.801 tempelho 5669: color:$fontmenu;
1.701 harmsja 5670: font-size:90%;
1.347 albertel 5671: }
1.795 www 5672:
1.879 raeburn 5673: table.LC_innerpickbox tr th,
5674: table.LC_innerpickbox tr td {
5675: vertical-align: top;
5676: }
5677:
1.711 raeburn 5678: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5679: background-color: #CCCCCC;
1.711 raeburn 5680: font-weight: bold;
5681: text-align: left;
5682: }
1.795 www 5683:
1.912 bisitz 5684: table.LC_data_table tr.LC_odd_row > td {
5685: background-color: $data_table_light;
5686: padding: 2px;
5687: vertical-align: top;
5688: }
5689:
1.809 bisitz 5690: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5691: background-color: $data_table_light;
1.912 bisitz 5692: vertical-align: top;
5693: }
5694:
5695: table.LC_data_table tr.LC_even_row > td {
5696: background-color: $data_table_dark;
1.425 albertel 5697: padding: 2px;
1.900 bisitz 5698: vertical-align: top;
1.347 albertel 5699: }
1.795 www 5700:
1.809 bisitz 5701: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5702: background-color: $data_table_dark;
1.900 bisitz 5703: vertical-align: top;
1.347 albertel 5704: }
1.795 www 5705:
1.425 albertel 5706: table.LC_data_table tr.LC_data_table_highlight td {
5707: background-color: $data_table_darker;
5708: }
1.795 www 5709:
1.639 raeburn 5710: table.LC_data_table tr td.LC_leftcol_header {
5711: background-color: $data_table_head;
5712: font-weight: bold;
5713: }
1.795 www 5714:
1.451 albertel 5715: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5716: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5717: font-weight: bold;
5718: font-style: italic;
5719: text-align: center;
5720: padding: 8px;
1.347 albertel 5721: }
1.795 www 5722:
1.940 bisitz 5723: table.LC_data_table tr.LC_empty_row td {
5724: background-color: $sidebg;
5725: }
5726:
5727: table.LC_nested tr.LC_empty_row td {
5728: background-color: #FFFFFF;
5729: }
5730:
1.890 droeschl 5731: table.LC_caption {
5732: }
5733:
1.507 raeburn 5734: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5735: padding: 4ex
5736: }
1.795 www 5737:
1.507 raeburn 5738: table.LC_nested_outer tr th {
5739: font-weight: bold;
1.801 tempelho 5740: color:$fontmenu;
1.507 raeburn 5741: background-color: $data_table_head;
1.701 harmsja 5742: font-size: small;
1.507 raeburn 5743: border-bottom: 1px solid #000000;
5744: }
1.795 www 5745:
1.507 raeburn 5746: table.LC_nested_outer tr td.LC_subheader {
5747: background-color: $data_table_head;
5748: font-weight: bold;
5749: font-size: small;
5750: border-bottom: 1px solid #000000;
5751: text-align: right;
1.451 albertel 5752: }
1.795 www 5753:
1.507 raeburn 5754: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5755: background-color: #CCCCCC;
1.451 albertel 5756: font-weight: bold;
5757: font-size: small;
1.507 raeburn 5758: text-align: center;
5759: }
1.795 www 5760:
1.589 raeburn 5761: table.LC_nested tr.LC_info_row td.LC_left_item,
5762: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5763: text-align: left;
1.451 albertel 5764: }
1.795 www 5765:
1.507 raeburn 5766: table.LC_nested td {
1.735 bisitz 5767: background-color: #FFFFFF;
1.451 albertel 5768: font-size: small;
1.507 raeburn 5769: }
1.795 www 5770:
1.507 raeburn 5771: table.LC_nested_outer tr th.LC_right_item,
5772: table.LC_nested tr.LC_info_row td.LC_right_item,
5773: table.LC_nested tr.LC_odd_row td.LC_right_item,
5774: table.LC_nested tr td.LC_right_item {
1.451 albertel 5775: text-align: right;
5776: }
5777:
1.507 raeburn 5778: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5779: background-color: #EEEEEE;
1.451 albertel 5780: }
5781:
1.473 raeburn 5782: table.LC_createuser {
5783: }
5784:
5785: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5786: font-size: small;
1.473 raeburn 5787: }
5788:
5789: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5790: background-color: #CCCCCC;
1.473 raeburn 5791: font-weight: bold;
5792: text-align: center;
5793: }
5794:
1.349 albertel 5795: table.LC_calendar {
5796: border: 1px solid #000000;
5797: border-collapse: collapse;
1.917 raeburn 5798: width: 98%;
1.349 albertel 5799: }
1.795 www 5800:
1.349 albertel 5801: table.LC_calendar_pickdate {
5802: font-size: xx-small;
5803: }
1.795 www 5804:
1.349 albertel 5805: table.LC_calendar tr td {
5806: border: 1px solid #000000;
5807: vertical-align: top;
1.917 raeburn 5808: width: 14%;
1.349 albertel 5809: }
1.795 www 5810:
1.349 albertel 5811: table.LC_calendar tr td.LC_calendar_day_empty {
5812: background-color: $data_table_dark;
5813: }
1.795 www 5814:
1.779 bisitz 5815: table.LC_calendar tr td.LC_calendar_day_current {
5816: background-color: $data_table_highlight;
1.777 tempelho 5817: }
1.795 www 5818:
1.938 bisitz 5819: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5820: background-color: $mail_new;
5821: }
1.795 www 5822:
1.938 bisitz 5823: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5824: background-color: $mail_new_hover;
5825: }
1.795 www 5826:
1.938 bisitz 5827: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5828: background-color: $mail_read;
5829: }
1.795 www 5830:
1.938 bisitz 5831: /*
5832: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5833: background-color: $mail_read_hover;
5834: }
1.938 bisitz 5835: */
1.795 www 5836:
1.938 bisitz 5837: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5838: background-color: $mail_replied;
5839: }
1.795 www 5840:
1.938 bisitz 5841: /*
5842: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5843: background-color: $mail_replied_hover;
5844: }
1.938 bisitz 5845: */
1.795 www 5846:
1.938 bisitz 5847: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5848: background-color: $mail_other;
5849: }
1.795 www 5850:
1.938 bisitz 5851: /*
5852: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5853: background-color: $mail_other_hover;
5854: }
1.938 bisitz 5855: */
1.494 raeburn 5856:
1.777 tempelho 5857: table.LC_data_table tr > td.LC_browser_file,
5858: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5859: background: #AAEE77;
1.389 albertel 5860: }
1.795 www 5861:
1.777 tempelho 5862: table.LC_data_table tr > td.LC_browser_file_locked,
5863: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5864: background: #FFAA99;
1.387 albertel 5865: }
1.795 www 5866:
1.777 tempelho 5867: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5868: background: #888888;
1.779 bisitz 5869: }
1.795 www 5870:
1.777 tempelho 5871: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5872: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5873: background: #F8F866;
1.777 tempelho 5874: }
1.795 www 5875:
1.696 bisitz 5876: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5877: background: #E0E8FF;
1.387 albertel 5878: }
1.696 bisitz 5879:
1.707 bisitz 5880: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5881: /* background: #77FF77; */
1.707 bisitz 5882: }
1.795 www 5883:
1.707 bisitz 5884: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5885: border-right: 8px solid #FFFF77;
1.707 bisitz 5886: }
1.795 www 5887:
1.707 bisitz 5888: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5889: border-right: 8px solid #FFAA77;
1.707 bisitz 5890: }
1.795 www 5891:
1.707 bisitz 5892: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5893: border-right: 8px solid #FF7777;
1.707 bisitz 5894: }
1.795 www 5895:
1.707 bisitz 5896: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5897: border-right: 8px solid #AAFF77;
1.707 bisitz 5898: }
1.795 www 5899:
1.707 bisitz 5900: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5901: border-right: 8px solid #11CC55;
1.707 bisitz 5902: }
5903:
1.388 albertel 5904: span.LC_current_location {
1.701 harmsja 5905: font-size:larger;
1.388 albertel 5906: background: $pgbg;
5907: }
1.387 albertel 5908:
1.1029 www 5909: span.LC_current_nav_location {
5910: font-weight:bold;
5911: background: $sidebg;
5912: }
5913:
1.395 albertel 5914: span.LC_parm_menu_item {
5915: font-size: larger;
5916: }
1.795 www 5917:
1.395 albertel 5918: span.LC_parm_scope_all {
5919: color: red;
5920: }
1.795 www 5921:
1.395 albertel 5922: span.LC_parm_scope_folder {
5923: color: green;
5924: }
1.795 www 5925:
1.395 albertel 5926: span.LC_parm_scope_resource {
5927: color: orange;
5928: }
1.795 www 5929:
1.395 albertel 5930: span.LC_parm_part {
5931: color: blue;
5932: }
1.795 www 5933:
1.911 bisitz 5934: span.LC_parm_folder,
5935: span.LC_parm_symb {
1.395 albertel 5936: font-size: x-small;
5937: font-family: $mono;
5938: color: #AAAAAA;
5939: }
5940:
1.977 bisitz 5941: ul.LC_parm_parmlist li {
5942: display: inline-block;
5943: padding: 0.3em 0.8em;
5944: vertical-align: top;
5945: width: 150px;
5946: border-top:1px solid $lg_border_color;
5947: }
5948:
1.795 www 5949: td.LC_parm_overview_level_menu,
5950: td.LC_parm_overview_map_menu,
5951: td.LC_parm_overview_parm_selectors,
5952: td.LC_parm_overview_restrictions {
1.396 albertel 5953: border: 1px solid black;
5954: border-collapse: collapse;
5955: }
1.795 www 5956:
1.396 albertel 5957: table.LC_parm_overview_restrictions td {
5958: border-width: 1px 4px 1px 4px;
5959: border-style: solid;
5960: border-color: $pgbg;
5961: text-align: center;
5962: }
1.795 www 5963:
1.396 albertel 5964: table.LC_parm_overview_restrictions th {
5965: background: $tabbg;
5966: border-width: 1px 4px 1px 4px;
5967: border-style: solid;
5968: border-color: $pgbg;
5969: }
1.795 www 5970:
1.398 albertel 5971: table#LC_helpmenu {
1.803 bisitz 5972: border: none;
1.398 albertel 5973: height: 55px;
1.803 bisitz 5974: border-spacing: 0;
1.398 albertel 5975: }
5976:
5977: table#LC_helpmenu fieldset legend {
5978: font-size: larger;
5979: }
1.795 www 5980:
1.397 albertel 5981: table#LC_helpmenu_links {
5982: width: 100%;
5983: border: 1px solid black;
5984: background: $pgbg;
1.803 bisitz 5985: padding: 0;
1.397 albertel 5986: border-spacing: 1px;
5987: }
1.795 www 5988:
1.397 albertel 5989: table#LC_helpmenu_links tr td {
5990: padding: 1px;
5991: background: $tabbg;
1.399 albertel 5992: text-align: center;
5993: font-weight: bold;
1.397 albertel 5994: }
1.396 albertel 5995:
1.795 www 5996: table#LC_helpmenu_links a:link,
5997: table#LC_helpmenu_links a:visited,
1.397 albertel 5998: table#LC_helpmenu_links a:active {
5999: text-decoration: none;
6000: color: $font;
6001: }
1.795 www 6002:
1.397 albertel 6003: table#LC_helpmenu_links a:hover {
6004: text-decoration: underline;
6005: color: $vlink;
6006: }
1.396 albertel 6007:
1.417 albertel 6008: .LC_chrt_popup_exists {
6009: border: 1px solid #339933;
6010: margin: -1px;
6011: }
1.795 www 6012:
1.417 albertel 6013: .LC_chrt_popup_up {
6014: border: 1px solid yellow;
6015: margin: -1px;
6016: }
1.795 www 6017:
1.417 albertel 6018: .LC_chrt_popup {
6019: border: 1px solid #8888FF;
6020: background: #CCCCFF;
6021: }
1.795 www 6022:
1.421 albertel 6023: table.LC_pick_box {
6024: border-collapse: separate;
6025: background: white;
6026: border: 1px solid black;
6027: border-spacing: 1px;
6028: }
1.795 www 6029:
1.421 albertel 6030: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6031: background: $sidebg;
1.421 albertel 6032: font-weight: bold;
1.900 bisitz 6033: text-align: left;
1.740 bisitz 6034: vertical-align: top;
1.421 albertel 6035: width: 184px;
6036: padding: 8px;
6037: }
1.795 www 6038:
1.579 raeburn 6039: table.LC_pick_box td.LC_pick_box_value {
6040: text-align: left;
6041: padding: 8px;
6042: }
1.795 www 6043:
1.579 raeburn 6044: table.LC_pick_box td.LC_pick_box_select {
6045: text-align: left;
6046: padding: 8px;
6047: }
1.795 www 6048:
1.424 albertel 6049: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6050: padding: 0;
1.421 albertel 6051: height: 1px;
6052: background: black;
6053: }
1.795 www 6054:
1.421 albertel 6055: table.LC_pick_box td.LC_pick_box_submit {
6056: text-align: right;
6057: }
1.795 www 6058:
1.579 raeburn 6059: table.LC_pick_box td.LC_evenrow_value {
6060: text-align: left;
6061: padding: 8px;
6062: background-color: $data_table_light;
6063: }
1.795 www 6064:
1.579 raeburn 6065: table.LC_pick_box td.LC_oddrow_value {
6066: text-align: left;
6067: padding: 8px;
6068: background-color: $data_table_light;
6069: }
1.795 www 6070:
1.579 raeburn 6071: span.LC_helpform_receipt_cat {
6072: font-weight: bold;
6073: }
1.795 www 6074:
1.424 albertel 6075: table.LC_group_priv_box {
6076: background: white;
6077: border: 1px solid black;
6078: border-spacing: 1px;
6079: }
1.795 www 6080:
1.424 albertel 6081: table.LC_group_priv_box td.LC_pick_box_title {
6082: background: $tabbg;
6083: font-weight: bold;
6084: text-align: right;
6085: width: 184px;
6086: }
1.795 www 6087:
1.424 albertel 6088: table.LC_group_priv_box td.LC_groups_fixed {
6089: background: $data_table_light;
6090: text-align: center;
6091: }
1.795 www 6092:
1.424 albertel 6093: table.LC_group_priv_box td.LC_groups_optional {
6094: background: $data_table_dark;
6095: text-align: center;
6096: }
1.795 www 6097:
1.424 albertel 6098: table.LC_group_priv_box td.LC_groups_functionality {
6099: background: $data_table_darker;
6100: text-align: center;
6101: font-weight: bold;
6102: }
1.795 www 6103:
1.424 albertel 6104: table.LC_group_priv td {
6105: text-align: left;
1.803 bisitz 6106: padding: 0;
1.424 albertel 6107: }
6108:
6109: .LC_navbuttons {
6110: margin: 2ex 0ex 2ex 0ex;
6111: }
1.795 www 6112:
1.423 albertel 6113: .LC_topic_bar {
6114: font-weight: bold;
6115: background: $tabbg;
1.918 wenzelju 6116: margin: 1em 0em 1em 2em;
1.805 bisitz 6117: padding: 3px;
1.918 wenzelju 6118: font-size: 1.2em;
1.423 albertel 6119: }
1.795 www 6120:
1.423 albertel 6121: .LC_topic_bar span {
1.918 wenzelju 6122: left: 0.5em;
6123: position: absolute;
1.423 albertel 6124: vertical-align: middle;
1.918 wenzelju 6125: font-size: 1.2em;
1.423 albertel 6126: }
1.795 www 6127:
1.423 albertel 6128: table.LC_course_group_status {
6129: margin: 20px;
6130: }
1.795 www 6131:
1.423 albertel 6132: table.LC_status_selector td {
6133: vertical-align: top;
6134: text-align: center;
1.424 albertel 6135: padding: 4px;
6136: }
1.795 www 6137:
1.599 albertel 6138: div.LC_feedback_link {
1.616 albertel 6139: clear: both;
1.829 kalberla 6140: background: $sidebg;
1.779 bisitz 6141: width: 100%;
1.829 kalberla 6142: padding-bottom: 10px;
6143: border: 1px $tabbg solid;
1.833 kalberla 6144: height: 22px;
6145: line-height: 22px;
6146: padding-top: 5px;
6147: }
6148:
6149: div.LC_feedback_link img {
6150: height: 22px;
1.867 kalberla 6151: vertical-align:middle;
1.829 kalberla 6152: }
6153:
1.911 bisitz 6154: div.LC_feedback_link a {
1.829 kalberla 6155: text-decoration: none;
1.489 raeburn 6156: }
1.795 www 6157:
1.867 kalberla 6158: div.LC_comblock {
1.911 bisitz 6159: display:inline;
1.867 kalberla 6160: color:$font;
6161: font-size:90%;
6162: }
6163:
6164: div.LC_feedback_link div.LC_comblock {
6165: padding-left:5px;
6166: }
6167:
6168: div.LC_feedback_link div.LC_comblock a {
6169: color:$font;
6170: }
6171:
1.489 raeburn 6172: span.LC_feedback_link {
1.858 bisitz 6173: /* background: $feedback_link_bg; */
1.599 albertel 6174: font-size: larger;
6175: }
1.795 www 6176:
1.599 albertel 6177: span.LC_message_link {
1.858 bisitz 6178: /* background: $feedback_link_bg; */
1.599 albertel 6179: font-size: larger;
6180: position: absolute;
6181: right: 1em;
1.489 raeburn 6182: }
1.421 albertel 6183:
1.515 albertel 6184: table.LC_prior_tries {
1.524 albertel 6185: border: 1px solid #000000;
6186: border-collapse: separate;
6187: border-spacing: 1px;
1.515 albertel 6188: }
1.523 albertel 6189:
1.515 albertel 6190: table.LC_prior_tries td {
1.524 albertel 6191: padding: 2px;
1.515 albertel 6192: }
1.523 albertel 6193:
6194: .LC_answer_correct {
1.795 www 6195: background: lightgreen;
6196: color: darkgreen;
6197: padding: 6px;
1.523 albertel 6198: }
1.795 www 6199:
1.523 albertel 6200: .LC_answer_charged_try {
1.797 www 6201: background: #FFAAAA;
1.795 www 6202: color: darkred;
6203: padding: 6px;
1.523 albertel 6204: }
1.795 www 6205:
1.779 bisitz 6206: .LC_answer_not_charged_try,
1.523 albertel 6207: .LC_answer_no_grade,
6208: .LC_answer_late {
1.795 www 6209: background: lightyellow;
1.523 albertel 6210: color: black;
1.795 www 6211: padding: 6px;
1.523 albertel 6212: }
1.795 www 6213:
1.523 albertel 6214: .LC_answer_previous {
1.795 www 6215: background: lightblue;
6216: color: darkblue;
6217: padding: 6px;
1.523 albertel 6218: }
1.795 www 6219:
1.779 bisitz 6220: .LC_answer_no_message {
1.777 tempelho 6221: background: #FFFFFF;
6222: color: black;
1.795 www 6223: padding: 6px;
1.779 bisitz 6224: }
1.795 www 6225:
1.779 bisitz 6226: .LC_answer_unknown {
6227: background: orange;
6228: color: black;
1.795 www 6229: padding: 6px;
1.777 tempelho 6230: }
1.795 www 6231:
1.529 albertel 6232: span.LC_prior_numerical,
6233: span.LC_prior_string,
6234: span.LC_prior_custom,
6235: span.LC_prior_reaction,
6236: span.LC_prior_math {
1.925 bisitz 6237: font-family: $mono;
1.523 albertel 6238: white-space: pre;
6239: }
6240:
1.525 albertel 6241: span.LC_prior_string {
1.925 bisitz 6242: font-family: $mono;
1.525 albertel 6243: white-space: pre;
6244: }
6245:
1.523 albertel 6246: table.LC_prior_option {
6247: width: 100%;
6248: border-collapse: collapse;
6249: }
1.795 www 6250:
1.911 bisitz 6251: table.LC_prior_rank,
1.795 www 6252: table.LC_prior_match {
1.528 albertel 6253: border-collapse: collapse;
6254: }
1.795 www 6255:
1.528 albertel 6256: table.LC_prior_option tr td,
6257: table.LC_prior_rank tr td,
6258: table.LC_prior_match tr td {
1.524 albertel 6259: border: 1px solid #000000;
1.515 albertel 6260: }
6261:
1.855 bisitz 6262: .LC_nobreak {
1.544 albertel 6263: white-space: nowrap;
1.519 raeburn 6264: }
6265:
1.576 raeburn 6266: span.LC_cusr_emph {
6267: font-style: italic;
6268: }
6269:
1.633 raeburn 6270: span.LC_cusr_subheading {
6271: font-weight: normal;
6272: font-size: 85%;
6273: }
6274:
1.861 bisitz 6275: div.LC_docs_entry_move {
1.859 bisitz 6276: border: 1px solid #BBBBBB;
1.545 albertel 6277: background: #DDDDDD;
1.861 bisitz 6278: width: 22px;
1.859 bisitz 6279: padding: 1px;
6280: margin: 0;
1.545 albertel 6281: }
6282:
1.861 bisitz 6283: table.LC_data_table tr > td.LC_docs_entry_commands,
6284: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6285: background: #DDDDDD;
6286: font-size: x-small;
6287: }
1.795 www 6288:
1.861 bisitz 6289: .LC_docs_entry_parameter {
6290: white-space: nowrap;
6291: }
6292:
1.544 albertel 6293: .LC_docs_copy {
1.545 albertel 6294: color: #000099;
1.544 albertel 6295: }
1.795 www 6296:
1.544 albertel 6297: .LC_docs_cut {
1.545 albertel 6298: color: #550044;
1.544 albertel 6299: }
1.795 www 6300:
1.544 albertel 6301: .LC_docs_rename {
1.545 albertel 6302: color: #009900;
1.544 albertel 6303: }
1.795 www 6304:
1.544 albertel 6305: .LC_docs_remove {
1.545 albertel 6306: color: #990000;
6307: }
6308:
1.547 albertel 6309: .LC_docs_reinit_warn,
6310: .LC_docs_ext_edit {
6311: font-size: x-small;
6312: }
6313:
1.545 albertel 6314: table.LC_docs_adddocs td,
6315: table.LC_docs_adddocs th {
6316: border: 1px solid #BBBBBB;
6317: padding: 4px;
6318: background: #DDDDDD;
1.543 albertel 6319: }
6320:
1.584 albertel 6321: table.LC_sty_begin {
6322: background: #BBFFBB;
6323: }
1.795 www 6324:
1.584 albertel 6325: table.LC_sty_end {
6326: background: #FFBBBB;
6327: }
6328:
1.589 raeburn 6329: table.LC_double_column {
1.803 bisitz 6330: border-width: 0;
1.589 raeburn 6331: border-collapse: collapse;
6332: width: 100%;
6333: padding: 2px;
6334: }
6335:
6336: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6337: top: 2px;
1.589 raeburn 6338: left: 2px;
6339: width: 47%;
6340: vertical-align: top;
6341: }
6342:
6343: table.LC_double_column tr td.LC_right_col {
6344: top: 2px;
1.779 bisitz 6345: right: 2px;
1.589 raeburn 6346: width: 47%;
6347: vertical-align: top;
6348: }
6349:
1.591 raeburn 6350: div.LC_left_float {
6351: float: left;
6352: padding-right: 5%;
1.597 albertel 6353: padding-bottom: 4px;
1.591 raeburn 6354: }
6355:
6356: div.LC_clear_float_header {
1.597 albertel 6357: padding-bottom: 2px;
1.591 raeburn 6358: }
6359:
6360: div.LC_clear_float_footer {
1.597 albertel 6361: padding-top: 10px;
1.591 raeburn 6362: clear: both;
6363: }
6364:
1.597 albertel 6365: div.LC_grade_show_user {
1.941 bisitz 6366: /* border-left: 5px solid $sidebg; */
6367: border-top: 5px solid #000000;
6368: margin: 50px 0 0 0;
1.936 bisitz 6369: padding: 15px 0 5px 10px;
1.597 albertel 6370: }
1.795 www 6371:
1.936 bisitz 6372: div.LC_grade_show_user_odd_row {
1.941 bisitz 6373: /* border-left: 5px solid #000000; */
6374: }
6375:
6376: div.LC_grade_show_user div.LC_Box {
6377: margin-right: 50px;
1.597 albertel 6378: }
6379:
6380: div.LC_grade_submissions,
6381: div.LC_grade_message_center,
1.936 bisitz 6382: div.LC_grade_info_links {
1.597 albertel 6383: margin: 5px;
6384: width: 99%;
6385: background: #FFFFFF;
6386: }
1.795 www 6387:
1.597 albertel 6388: div.LC_grade_submissions_header,
1.936 bisitz 6389: div.LC_grade_message_center_header {
1.705 tempelho 6390: font-weight: bold;
6391: font-size: large;
1.597 albertel 6392: }
1.795 www 6393:
1.597 albertel 6394: div.LC_grade_submissions_body,
1.936 bisitz 6395: div.LC_grade_message_center_body {
1.597 albertel 6396: border: 1px solid black;
6397: width: 99%;
6398: background: #FFFFFF;
6399: }
1.795 www 6400:
1.613 albertel 6401: table.LC_scantron_action {
6402: width: 100%;
6403: }
1.795 www 6404:
1.613 albertel 6405: table.LC_scantron_action tr th {
1.698 harmsja 6406: font-weight:bold;
6407: font-style:normal;
1.613 albertel 6408: }
1.795 www 6409:
1.779 bisitz 6410: .LC_edit_problem_header,
1.614 albertel 6411: div.LC_edit_problem_footer {
1.705 tempelho 6412: font-weight: normal;
6413: font-size: medium;
1.602 albertel 6414: margin: 2px;
1.1060 bisitz 6415: background-color: $sidebg;
1.600 albertel 6416: }
1.795 www 6417:
1.600 albertel 6418: div.LC_edit_problem_header,
1.602 albertel 6419: div.LC_edit_problem_header div,
1.614 albertel 6420: div.LC_edit_problem_footer,
6421: div.LC_edit_problem_footer div,
1.602 albertel 6422: div.LC_edit_problem_editxml_header,
6423: div.LC_edit_problem_editxml_header div {
1.600 albertel 6424: margin-top: 5px;
6425: }
1.795 www 6426:
1.600 albertel 6427: div.LC_edit_problem_header_title {
1.705 tempelho 6428: font-weight: bold;
6429: font-size: larger;
1.602 albertel 6430: background: $tabbg;
6431: padding: 3px;
1.1060 bisitz 6432: margin: 0 0 5px 0;
1.602 albertel 6433: }
1.795 www 6434:
1.602 albertel 6435: table.LC_edit_problem_header_title {
6436: width: 100%;
1.600 albertel 6437: background: $tabbg;
1.602 albertel 6438: }
6439:
6440: div.LC_edit_problem_discards {
6441: float: left;
6442: padding-bottom: 5px;
6443: }
1.795 www 6444:
1.602 albertel 6445: div.LC_edit_problem_saves {
6446: float: right;
6447: padding-bottom: 5px;
1.600 albertel 6448: }
1.795 www 6449:
1.911 bisitz 6450: img.stift {
1.803 bisitz 6451: border-width: 0;
6452: vertical-align: middle;
1.677 riegler 6453: }
1.680 riegler 6454:
1.923 bisitz 6455: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6456: vertical-align: top;
1.777 tempelho 6457: }
1.795 www 6458:
1.716 raeburn 6459: div.LC_createcourse {
1.911 bisitz 6460: margin: 10px 10px 10px 10px;
1.716 raeburn 6461: }
6462:
1.917 raeburn 6463: .LC_dccid {
6464: margin: 0.2em 0 0 0;
6465: padding: 0;
6466: font-size: 90%;
6467: display:none;
6468: }
6469:
1.897 wenzelju 6470: ol.LC_primary_menu a:hover,
1.721 harmsja 6471: ol#LC_MenuBreadcrumbs a:hover,
6472: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6473: ul#LC_secondary_menu a:hover,
1.721 harmsja 6474: .LC_FormSectionClearButton input:hover
1.795 www 6475: ul.LC_TabContent li:hover a {
1.952 onken 6476: color:$button_hover;
1.911 bisitz 6477: text-decoration:none;
1.693 droeschl 6478: }
6479:
1.779 bisitz 6480: h1 {
1.911 bisitz 6481: padding: 0;
6482: line-height:130%;
1.693 droeschl 6483: }
1.698 harmsja 6484:
1.911 bisitz 6485: h2,
6486: h3,
6487: h4,
6488: h5,
6489: h6 {
6490: margin: 5px 0 5px 0;
6491: padding: 0;
6492: line-height:130%;
1.693 droeschl 6493: }
1.795 www 6494:
6495: .LC_hcell {
1.911 bisitz 6496: padding:3px 15px 3px 15px;
6497: margin: 0;
6498: background-color:$tabbg;
6499: color:$fontmenu;
6500: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6501: }
1.795 www 6502:
1.840 bisitz 6503: .LC_Box > .LC_hcell {
1.911 bisitz 6504: margin: 0 -10px 10px -10px;
1.835 bisitz 6505: }
6506:
1.721 harmsja 6507: .LC_noBorder {
1.911 bisitz 6508: border: 0;
1.698 harmsja 6509: }
1.693 droeschl 6510:
1.721 harmsja 6511: .LC_FormSectionClearButton input {
1.911 bisitz 6512: background-color:transparent;
6513: border: none;
6514: cursor:pointer;
6515: text-decoration:underline;
1.693 droeschl 6516: }
1.763 bisitz 6517:
6518: .LC_help_open_topic {
1.911 bisitz 6519: color: #FFFFFF;
6520: background-color: #EEEEFF;
6521: margin: 1px;
6522: padding: 4px;
6523: border: 1px solid #000033;
6524: white-space: nowrap;
6525: /* vertical-align: middle; */
1.759 neumanie 6526: }
1.693 droeschl 6527:
1.911 bisitz 6528: dl,
6529: ul,
6530: div,
6531: fieldset {
6532: margin: 10px 10px 10px 0;
6533: /* overflow: hidden; */
1.693 droeschl 6534: }
1.795 www 6535:
1.838 bisitz 6536: fieldset > legend {
1.911 bisitz 6537: font-weight: bold;
6538: padding: 0 5px 0 5px;
1.838 bisitz 6539: }
6540:
1.813 bisitz 6541: #LC_nav_bar {
1.911 bisitz 6542: float: left;
1.995 raeburn 6543: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6544: margin: 0 0 2px 0;
1.807 droeschl 6545: }
6546:
1.916 droeschl 6547: #LC_realm {
6548: margin: 0.2em 0 0 0;
6549: padding: 0;
6550: font-weight: bold;
6551: text-align: center;
1.995 raeburn 6552: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6553: }
6554:
1.911 bisitz 6555: #LC_nav_bar em {
6556: font-weight: bold;
6557: font-style: normal;
1.807 droeschl 6558: }
6559:
1.897 wenzelju 6560: ol.LC_primary_menu {
1.911 bisitz 6561: float: right;
1.934 droeschl 6562: margin: 0;
1.1076 raeburn 6563: padding: 0;
1.995 raeburn 6564: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6565: }
6566:
1.852 droeschl 6567: ol#LC_PathBreadcrumbs {
1.911 bisitz 6568: margin: 0;
1.693 droeschl 6569: }
6570:
1.897 wenzelju 6571: ol.LC_primary_menu li {
1.1076 raeburn 6572: color: RGB(80, 80, 80);
6573: vertical-align: middle;
6574: text-align: left;
6575: list-style: none;
6576: float: left;
6577: }
6578:
6579: ol.LC_primary_menu li a {
6580: display: block;
6581: margin: 0;
6582: padding: 0 5px 0 10px;
6583: text-decoration: none;
6584: }
6585:
6586: ol.LC_primary_menu li ul {
6587: display: none;
6588: width: 10em;
6589: background-color: $data_table_light;
6590: }
6591:
6592: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6593: display: block;
6594: position: absolute;
6595: margin: 0;
6596: padding: 0;
1.1078 raeburn 6597: z-index: 2;
1.1076 raeburn 6598: }
6599:
6600: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6601: font-size: 90%;
1.911 bisitz 6602: vertical-align: top;
1.1076 raeburn 6603: float: none;
1.1079 raeburn 6604: border-left: 1px solid black;
6605: border-right: 1px solid black;
1.1076 raeburn 6606: }
6607:
6608: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6609: background-color:$data_table_light;
1.1076 raeburn 6610: }
6611:
6612: ol.LC_primary_menu li li a:hover {
6613: color:$button_hover;
6614: background-color:$data_table_dark;
1.693 droeschl 6615: }
6616:
1.897 wenzelju 6617: ol.LC_primary_menu li img {
1.911 bisitz 6618: vertical-align: bottom;
1.934 droeschl 6619: height: 1.1em;
1.1077 raeburn 6620: margin: 0.2em 0 0 0;
1.693 droeschl 6621: }
6622:
1.897 wenzelju 6623: ol.LC_primary_menu a {
1.911 bisitz 6624: color: RGB(80, 80, 80);
6625: text-decoration: none;
1.693 droeschl 6626: }
1.795 www 6627:
1.949 droeschl 6628: ol.LC_primary_menu a.LC_new_message {
6629: font-weight:bold;
6630: color: darkred;
6631: }
6632:
1.975 raeburn 6633: ol.LC_docs_parameters {
6634: margin-left: 0;
6635: padding: 0;
6636: list-style: none;
6637: }
6638:
6639: ol.LC_docs_parameters li {
6640: margin: 0;
6641: padding-right: 20px;
6642: display: inline;
6643: }
6644:
1.976 raeburn 6645: ol.LC_docs_parameters li:before {
6646: content: "\\002022 \\0020";
6647: }
6648:
6649: li.LC_docs_parameters_title {
6650: font-weight: bold;
6651: }
6652:
6653: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6654: content: "";
6655: }
6656:
1.897 wenzelju 6657: ul#LC_secondary_menu {
1.911 bisitz 6658: clear: both;
6659: color: $fontmenu;
6660: background: $tabbg;
6661: list-style: none;
6662: padding: 0;
6663: margin: 0;
6664: width: 100%;
1.995 raeburn 6665: text-align: left;
1.808 droeschl 6666: }
6667:
1.897 wenzelju 6668: ul#LC_secondary_menu li {
1.911 bisitz 6669: font-weight: bold;
6670: line-height: 1.8em;
6671: padding: 0 0.8em;
6672: border-right: 1px solid black;
6673: display: inline;
6674: vertical-align: middle;
1.807 droeschl 6675: }
6676:
1.847 tempelho 6677: ul.LC_TabContent {
1.911 bisitz 6678: display:block;
6679: background: $sidebg;
6680: border-bottom: solid 1px $lg_border_color;
6681: list-style:none;
1.1020 raeburn 6682: margin: -1px -10px 0 -10px;
1.911 bisitz 6683: padding: 0;
1.693 droeschl 6684: }
6685:
1.795 www 6686: ul.LC_TabContent li,
6687: ul.LC_TabContentBigger li {
1.911 bisitz 6688: float:left;
1.741 harmsja 6689: }
1.795 www 6690:
1.897 wenzelju 6691: ul#LC_secondary_menu li a {
1.911 bisitz 6692: color: $fontmenu;
6693: text-decoration: none;
1.693 droeschl 6694: }
1.795 www 6695:
1.721 harmsja 6696: ul.LC_TabContent {
1.952 onken 6697: min-height:20px;
1.721 harmsja 6698: }
1.795 www 6699:
6700: ul.LC_TabContent li {
1.911 bisitz 6701: vertical-align:middle;
1.959 onken 6702: padding: 0 16px 0 10px;
1.911 bisitz 6703: background-color:$tabbg;
6704: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6705: border-left: solid 1px $font;
1.721 harmsja 6706: }
1.795 www 6707:
1.847 tempelho 6708: ul.LC_TabContent .right {
1.911 bisitz 6709: float:right;
1.847 tempelho 6710: }
6711:
1.911 bisitz 6712: ul.LC_TabContent li a,
6713: ul.LC_TabContent li {
6714: color:rgb(47,47,47);
6715: text-decoration:none;
6716: font-size:95%;
6717: font-weight:bold;
1.952 onken 6718: min-height:20px;
6719: }
6720:
1.959 onken 6721: ul.LC_TabContent li a:hover,
6722: ul.LC_TabContent li a:focus {
1.952 onken 6723: color: $button_hover;
1.959 onken 6724: background:none;
6725: outline:none;
1.952 onken 6726: }
6727:
6728: ul.LC_TabContent li:hover {
6729: color: $button_hover;
6730: cursor:pointer;
1.721 harmsja 6731: }
1.795 www 6732:
1.911 bisitz 6733: ul.LC_TabContent li.active {
1.952 onken 6734: color: $font;
1.911 bisitz 6735: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6736: border-bottom:solid 1px #FFFFFF;
6737: cursor: default;
1.744 ehlerst 6738: }
1.795 www 6739:
1.959 onken 6740: ul.LC_TabContent li.active a {
6741: color:$font;
6742: background:#FFFFFF;
6743: outline: none;
6744: }
1.1047 raeburn 6745:
6746: ul.LC_TabContent li.goback {
6747: float: left;
6748: border-left: none;
6749: }
6750:
1.870 tempelho 6751: #maincoursedoc {
1.911 bisitz 6752: clear:both;
1.870 tempelho 6753: }
6754:
6755: ul.LC_TabContentBigger {
1.911 bisitz 6756: display:block;
6757: list-style:none;
6758: padding: 0;
1.870 tempelho 6759: }
6760:
1.795 www 6761: ul.LC_TabContentBigger li {
1.911 bisitz 6762: vertical-align:bottom;
6763: height: 30px;
6764: font-size:110%;
6765: font-weight:bold;
6766: color: #737373;
1.841 tempelho 6767: }
6768:
1.957 onken 6769: ul.LC_TabContentBigger li.active {
6770: position: relative;
6771: top: 1px;
6772: }
6773:
1.870 tempelho 6774: ul.LC_TabContentBigger li a {
1.911 bisitz 6775: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6776: height: 30px;
6777: line-height: 30px;
6778: text-align: center;
6779: display: block;
6780: text-decoration: none;
1.958 onken 6781: outline: none;
1.741 harmsja 6782: }
1.795 www 6783:
1.870 tempelho 6784: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6785: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6786: color:$font;
1.744 ehlerst 6787: }
1.795 www 6788:
1.870 tempelho 6789: ul.LC_TabContentBigger li b {
1.911 bisitz 6790: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6791: display: block;
6792: float: left;
6793: padding: 0 30px;
1.957 onken 6794: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6795: }
6796:
1.956 onken 6797: ul.LC_TabContentBigger li:hover b {
6798: color:$button_hover;
6799: }
6800:
1.870 tempelho 6801: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6802: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6803: color:$font;
1.957 onken 6804: border: 0;
1.741 harmsja 6805: }
1.693 droeschl 6806:
1.870 tempelho 6807:
1.862 bisitz 6808: ul.LC_CourseBreadcrumbs {
6809: background: $sidebg;
1.1020 raeburn 6810: height: 2em;
1.862 bisitz 6811: padding-left: 10px;
1.1020 raeburn 6812: margin: 0;
1.862 bisitz 6813: list-style-position: inside;
6814: }
6815:
1.911 bisitz 6816: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6817: ol#LC_PathBreadcrumbs {
1.911 bisitz 6818: padding-left: 10px;
6819: margin: 0;
1.933 droeschl 6820: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6821: }
6822:
1.911 bisitz 6823: ol#LC_MenuBreadcrumbs li,
6824: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6825: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6826: display: inline;
1.933 droeschl 6827: white-space: normal;
1.693 droeschl 6828: }
6829:
1.823 bisitz 6830: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6831: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6832: text-decoration: none;
6833: font-size:90%;
1.693 droeschl 6834: }
1.795 www 6835:
1.969 droeschl 6836: ol#LC_MenuBreadcrumbs h1 {
6837: display: inline;
6838: font-size: 90%;
6839: line-height: 2.5em;
6840: margin: 0;
6841: padding: 0;
6842: }
6843:
1.795 www 6844: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6845: text-decoration:none;
6846: font-size:100%;
6847: font-weight:bold;
1.693 droeschl 6848: }
1.795 www 6849:
1.840 bisitz 6850: .LC_Box {
1.911 bisitz 6851: border: solid 1px $lg_border_color;
6852: padding: 0 10px 10px 10px;
1.746 neumanie 6853: }
1.795 www 6854:
1.1020 raeburn 6855: .LC_DocsBox {
6856: border: solid 1px $lg_border_color;
6857: padding: 0 0 10px 10px;
6858: }
6859:
1.795 www 6860: .LC_AboutMe_Image {
1.911 bisitz 6861: float:left;
6862: margin-right:10px;
1.747 neumanie 6863: }
1.795 www 6864:
6865: .LC_Clear_AboutMe_Image {
1.911 bisitz 6866: clear:left;
1.747 neumanie 6867: }
1.795 www 6868:
1.721 harmsja 6869: dl.LC_ListStyleClean dt {
1.911 bisitz 6870: padding-right: 5px;
6871: display: table-header-group;
1.693 droeschl 6872: }
6873:
1.721 harmsja 6874: dl.LC_ListStyleClean dd {
1.911 bisitz 6875: display: table-row;
1.693 droeschl 6876: }
6877:
1.721 harmsja 6878: .LC_ListStyleClean,
6879: .LC_ListStyleSimple,
6880: .LC_ListStyleNormal,
1.795 www 6881: .LC_ListStyleSpecial {
1.911 bisitz 6882: /* display:block; */
6883: list-style-position: inside;
6884: list-style-type: none;
6885: overflow: hidden;
6886: padding: 0;
1.693 droeschl 6887: }
6888:
1.721 harmsja 6889: .LC_ListStyleSimple li,
6890: .LC_ListStyleSimple dd,
6891: .LC_ListStyleNormal li,
6892: .LC_ListStyleNormal dd,
6893: .LC_ListStyleSpecial li,
1.795 www 6894: .LC_ListStyleSpecial dd {
1.911 bisitz 6895: margin: 0;
6896: padding: 5px 5px 5px 10px;
6897: clear: both;
1.693 droeschl 6898: }
6899:
1.721 harmsja 6900: .LC_ListStyleClean li,
6901: .LC_ListStyleClean dd {
1.911 bisitz 6902: padding-top: 0;
6903: padding-bottom: 0;
1.693 droeschl 6904: }
6905:
1.721 harmsja 6906: .LC_ListStyleSimple dd,
1.795 www 6907: .LC_ListStyleSimple li {
1.911 bisitz 6908: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6909: }
6910:
1.721 harmsja 6911: .LC_ListStyleSpecial li,
6912: .LC_ListStyleSpecial dd {
1.911 bisitz 6913: list-style-type: none;
6914: background-color: RGB(220, 220, 220);
6915: margin-bottom: 4px;
1.693 droeschl 6916: }
6917:
1.721 harmsja 6918: table.LC_SimpleTable {
1.911 bisitz 6919: margin:5px;
6920: border:solid 1px $lg_border_color;
1.795 www 6921: }
1.693 droeschl 6922:
1.721 harmsja 6923: table.LC_SimpleTable tr {
1.911 bisitz 6924: padding: 0;
6925: border:solid 1px $lg_border_color;
1.693 droeschl 6926: }
1.795 www 6927:
6928: table.LC_SimpleTable thead {
1.911 bisitz 6929: background:rgb(220,220,220);
1.693 droeschl 6930: }
6931:
1.721 harmsja 6932: div.LC_columnSection {
1.911 bisitz 6933: display: block;
6934: clear: both;
6935: overflow: hidden;
6936: margin: 0;
1.693 droeschl 6937: }
6938:
1.721 harmsja 6939: div.LC_columnSection>* {
1.911 bisitz 6940: float: left;
6941: margin: 10px 20px 10px 0;
6942: overflow:hidden;
1.693 droeschl 6943: }
1.721 harmsja 6944:
1.795 www 6945: table em {
1.911 bisitz 6946: font-weight: bold;
6947: font-style: normal;
1.748 schulted 6948: }
1.795 www 6949:
1.779 bisitz 6950: table.LC_tableBrowseRes,
1.795 www 6951: table.LC_tableOfContent {
1.911 bisitz 6952: border:none;
6953: border-spacing: 1px;
6954: padding: 3px;
6955: background-color: #FFFFFF;
6956: font-size: 90%;
1.753 droeschl 6957: }
1.789 droeschl 6958:
1.911 bisitz 6959: table.LC_tableOfContent {
6960: border-collapse: collapse;
1.789 droeschl 6961: }
6962:
1.771 droeschl 6963: table.LC_tableBrowseRes a,
1.768 schulted 6964: table.LC_tableOfContent a {
1.911 bisitz 6965: background-color: transparent;
6966: text-decoration: none;
1.753 droeschl 6967: }
6968:
1.795 www 6969: table.LC_tableOfContent img {
1.911 bisitz 6970: border: none;
6971: height: 1.3em;
6972: vertical-align: text-bottom;
6973: margin-right: 0.3em;
1.753 droeschl 6974: }
1.757 schulted 6975:
1.795 www 6976: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6977: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6978: }
6979:
1.795 www 6980: a#LC_content_toolbar_everything {
1.911 bisitz 6981: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6982: }
6983:
1.795 www 6984: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6985: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6986: }
6987:
1.795 www 6988: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6989: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6990: }
6991:
1.795 www 6992: a#LC_content_toolbar_changefolder {
1.911 bisitz 6993: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6994: }
6995:
1.795 www 6996: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6997: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6998: }
6999:
1.1043 raeburn 7000: a#LC_content_toolbar_edittoplevel {
7001: background-image:url(/res/adm/pages/edittoplevel.gif);
7002: }
7003:
1.795 www 7004: ul#LC_toolbar li a:hover {
1.911 bisitz 7005: background-position: bottom center;
1.757 schulted 7006: }
7007:
1.795 www 7008: ul#LC_toolbar {
1.911 bisitz 7009: padding: 0;
7010: margin: 2px;
7011: list-style:none;
7012: position:relative;
7013: background-color:white;
1.1082 raeburn 7014: overflow: auto;
1.757 schulted 7015: }
7016:
1.795 www 7017: ul#LC_toolbar li {
1.911 bisitz 7018: border:1px solid white;
7019: padding: 0;
7020: margin: 0;
7021: float: left;
7022: display:inline;
7023: vertical-align:middle;
1.1082 raeburn 7024: white-space: nowrap;
1.911 bisitz 7025: }
1.757 schulted 7026:
1.783 amueller 7027:
1.795 www 7028: a.LC_toolbarItem {
1.911 bisitz 7029: display:block;
7030: padding: 0;
7031: margin: 0;
7032: height: 32px;
7033: width: 32px;
7034: color:white;
7035: border: none;
7036: background-repeat:no-repeat;
7037: background-color:transparent;
1.757 schulted 7038: }
7039:
1.915 droeschl 7040: ul.LC_funclist {
7041: margin: 0;
7042: padding: 0.5em 1em 0.5em 0;
7043: }
7044:
1.933 droeschl 7045: ul.LC_funclist > li:first-child {
7046: font-weight:bold;
7047: margin-left:0.8em;
7048: }
7049:
1.915 droeschl 7050: ul.LC_funclist + ul.LC_funclist {
7051: /*
7052: left border as a seperator if we have more than
7053: one list
7054: */
7055: border-left: 1px solid $sidebg;
7056: /*
7057: this hides the left border behind the border of the
7058: outer box if element is wrapped to the next 'line'
7059: */
7060: margin-left: -1px;
7061: }
7062:
1.843 bisitz 7063: ul.LC_funclist li {
1.915 droeschl 7064: display: inline;
1.782 bisitz 7065: white-space: nowrap;
1.915 droeschl 7066: margin: 0 0 0 25px;
7067: line-height: 150%;
1.782 bisitz 7068: }
7069:
1.974 wenzelju 7070: .LC_hidden {
7071: display: none;
7072: }
7073:
1.1030 www 7074: .LCmodal-overlay {
7075: position:fixed;
7076: top:0;
7077: right:0;
7078: bottom:0;
7079: left:0;
7080: height:100%;
7081: width:100%;
7082: margin:0;
7083: padding:0;
7084: background:#999;
7085: opacity:.75;
7086: filter: alpha(opacity=75);
7087: -moz-opacity: 0.75;
7088: z-index:101;
7089: }
7090:
7091: * html .LCmodal-overlay {
7092: position: absolute;
7093: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7094: }
7095:
7096: .LCmodal-window {
7097: position:fixed;
7098: top:50%;
7099: left:50%;
7100: margin:0;
7101: padding:0;
7102: z-index:102;
7103: }
7104:
7105: * html .LCmodal-window {
7106: position:absolute;
7107: }
7108:
7109: .LCclose-window {
7110: position:absolute;
7111: width:32px;
7112: height:32px;
7113: right:8px;
7114: top:8px;
7115: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7116: text-indent:-99999px;
7117: overflow:hidden;
7118: cursor:pointer;
7119: }
7120:
1.343 albertel 7121: END
7122: }
7123:
1.306 albertel 7124: =pod
7125:
7126: =item * &headtag()
7127:
7128: Returns a uniform footer for LON-CAPA web pages.
7129:
1.307 albertel 7130: Inputs: $title - optional title for the head
7131: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7132: $args - optional arguments
1.319 albertel 7133: force_register - if is true call registerurl so the remote is
7134: informed
1.415 albertel 7135: redirect -> array ref of
7136: 1- seconds before redirect occurs
7137: 2- url to redirect to
7138: 3- whether the side effect should occur
1.315 albertel 7139: (side effect of setting
7140: $env{'internal.head.redirect'} to the url
7141: redirected too)
1.352 albertel 7142: domain -> force to color decorate a page for a specific
7143: domain
7144: function -> force usage of a specific rolish color scheme
7145: bgcolor -> override the default page bgcolor
1.460 albertel 7146: no_auto_mt_title
7147: -> prevent &mt()ing the title arg
1.464 albertel 7148:
1.306 albertel 7149: =cut
7150:
7151: sub headtag {
1.313 albertel 7152: my ($title,$head_extra,$args) = @_;
1.306 albertel 7153:
1.363 albertel 7154: my $function = $args->{'function'} || &get_users_function();
7155: my $domain = $args->{'domain'} || &determinedomain();
7156: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7157: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7158: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7159: #time(),
1.418 albertel 7160: $env{'environment.color.timestamp'},
1.363 albertel 7161: $function,$domain,$bgcolor);
7162:
1.369 www 7163: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7164:
1.308 albertel 7165: my $result =
7166: '<head>'.
1.461 albertel 7167: &font_settings();
1.319 albertel 7168:
1.1064 raeburn 7169: my $inhibitprint = &print_suppression();
7170:
1.461 albertel 7171: if (!$args->{'frameset'}) {
7172: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7173: }
1.962 droeschl 7174: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7175: $result .= Apache::lonxml::display_title();
1.319 albertel 7176: }
1.436 albertel 7177: if (!$args->{'no_nav_bar'}
7178: && !$args->{'only_body'}
7179: && !$args->{'frameset'}) {
7180: $result .= &help_menu_js();
1.1032 www 7181: $result.=&modal_window();
1.1038 www 7182: $result.=&togglebox_script();
1.1034 www 7183: $result.=&wishlist_window();
1.1041 www 7184: $result.=&LCprogressbarUpdate_script();
1.1034 www 7185: } else {
7186: if ($args->{'add_modal'}) {
7187: $result.=&modal_window();
7188: }
7189: if ($args->{'add_wishlist'}) {
7190: $result.=&wishlist_window();
7191: }
1.1038 www 7192: if ($args->{'add_togglebox'}) {
7193: $result.=&togglebox_script();
7194: }
1.1041 www 7195: if ($args->{'add_progressbar'}) {
7196: $result.=&LCprogressbarUpdate_script();
7197: }
1.436 albertel 7198: }
1.314 albertel 7199: if (ref($args->{'redirect'})) {
1.414 albertel 7200: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7201: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7202: if (!$inhibit_continue) {
7203: $env{'internal.head.redirect'} = $url;
7204: }
1.313 albertel 7205: $result.=<<ADDMETA
7206: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7207: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7208: ADDMETA
7209: }
1.306 albertel 7210: if (!defined($title)) {
7211: $title = 'The LearningOnline Network with CAPA';
7212: }
1.460 albertel 7213: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7214: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7215: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7216: .$inhibitprint
1.414 albertel 7217: .$head_extra;
1.962 droeschl 7218: return $result.'</head>';
1.306 albertel 7219: }
7220:
7221: =pod
7222:
1.340 albertel 7223: =item * &font_settings()
7224:
7225: Returns neccessary <meta> to set the proper encoding
7226:
7227: Inputs: none
7228:
7229: =cut
7230:
7231: sub font_settings {
7232: my $headerstring='';
1.647 www 7233: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7234: $headerstring.=
7235: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7236: }
7237: return $headerstring;
7238: }
7239:
1.341 albertel 7240: =pod
7241:
1.1064 raeburn 7242: =item * &print_suppression()
7243:
7244: In course context returns css which causes the body to be blank when media="print",
7245: if printout generation is unavailable for the current resource.
7246:
7247: This could be because:
7248:
7249: (a) printstartdate is in the future
7250:
7251: (b) printenddate is in the past
7252:
7253: (c) there is an active exam block with "printout"
7254: functionality blocked
7255:
7256: Users with pav, pfo or evb privileges are exempt.
7257:
7258: Inputs: none
7259:
7260: =cut
7261:
7262:
7263: sub print_suppression {
7264: my $noprint;
7265: if ($env{'request.course.id'}) {
7266: my $scope = $env{'request.course.id'};
7267: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7268: (&Apache::lonnet::allowed('pfo',$scope))) {
7269: return;
7270: }
7271: if ($env{'request.course.sec'} ne '') {
7272: $scope .= "/$env{'request.course.sec'}";
7273: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7274: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7275: return;
1.1064 raeburn 7276: }
7277: }
7278: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7279: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7280: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7281: if ($blocked) {
7282: my $checkrole = "cm./$cdom/$cnum";
7283: if ($env{'request.course.sec'} ne '') {
7284: $checkrole .= "/$env{'request.course.sec'}";
7285: }
7286: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7287: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7288: $noprint = 1;
7289: }
7290: }
7291: unless ($noprint) {
7292: my $symb = &Apache::lonnet::symbread();
7293: if ($symb ne '') {
7294: my $navmap = Apache::lonnavmaps::navmap->new();
7295: if (ref($navmap)) {
7296: my $res = $navmap->getBySymb($symb);
7297: if (ref($res)) {
7298: if (!$res->resprintable()) {
7299: $noprint = 1;
7300: }
7301: }
7302: }
7303: }
7304: }
7305: if ($noprint) {
7306: return <<"ENDSTYLE";
7307: <style type="text/css" media="print">
7308: body { display:none }
7309: </style>
7310: ENDSTYLE
7311: }
7312: }
7313: return;
7314: }
7315:
7316: =pod
7317:
1.341 albertel 7318: =item * &xml_begin()
7319:
7320: Returns the needed doctype and <html>
7321:
7322: Inputs: none
7323:
7324: =cut
7325:
7326: sub xml_begin {
7327: my $output='';
7328:
7329: if ($env{'browser.mathml'}) {
7330: $output='<?xml version="1.0"?>'
7331: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7332: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7333:
7334: # .'<!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">] >'
7335: .'<!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">'
7336: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7337: .'xmlns="http://www.w3.org/1999/xhtml">';
7338: } else {
1.849 bisitz 7339: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7340: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7341: }
7342: return $output;
7343: }
1.340 albertel 7344:
7345: =pod
7346:
1.306 albertel 7347: =item * &start_page()
7348:
7349: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7350:
1.648 raeburn 7351: Inputs:
7352:
7353: =over 4
7354:
7355: $title - optional title for the page
7356:
7357: $head_extra - optional extra HTML to incude inside the <head>
7358:
7359: $args - additional optional args supported are:
7360:
7361: =over 8
7362:
7363: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7364: arg on
1.814 bisitz 7365: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7366: add_entries -> additional attributes to add to the <body>
7367: domain -> force to color decorate a page for a
1.317 albertel 7368: specific domain
1.648 raeburn 7369: function -> force usage of a specific rolish color
1.317 albertel 7370: scheme
1.648 raeburn 7371: redirect -> see &headtag()
7372: bgcolor -> override the default page bg color
7373: js_ready -> return a string ready for being used in
1.317 albertel 7374: a javascript writeln
1.648 raeburn 7375: html_encode -> return a string ready for being used in
1.320 albertel 7376: a html attribute
1.648 raeburn 7377: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7378: $forcereg arg
1.648 raeburn 7379: frameset -> if true will start with a <frameset>
1.330 albertel 7380: rather than <body>
1.648 raeburn 7381: skip_phases -> hash ref of
1.338 albertel 7382: head -> skip the <html><head> generation
7383: body -> skip all <body> generation
1.648 raeburn 7384: no_auto_mt_title -> prevent &mt()ing the title arg
7385: inherit_jsmath -> when creating popup window in a page,
7386: should it have jsmath forced on by the
7387: current page
1.867 kalberla 7388: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7389: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 ! raeburn 7390: group -> includes the current group, if page is for a
! 7391: specific group
1.361 albertel 7392:
1.648 raeburn 7393: =back
1.460 albertel 7394:
1.648 raeburn 7395: =back
1.562 albertel 7396:
1.306 albertel 7397: =cut
7398:
7399: sub start_page {
1.309 albertel 7400: my ($title,$head_extra,$args) = @_;
1.318 albertel 7401: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7402:
1.315 albertel 7403: $env{'internal.start_page'}++;
1.1096 ! raeburn 7404: my ($result,@advtools);
1.964 droeschl 7405:
1.338 albertel 7406: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7407: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7408: }
7409:
7410: if (! exists($args->{'skip_phases'}{'body'}) ) {
7411: if ($args->{'frameset'}) {
7412: my $attr_string = &make_attr_string($args->{'force_register'},
7413: $args->{'add_entries'});
7414: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7415: } else {
7416: $result .=
7417: &bodytag($title,
7418: $args->{'function'}, $args->{'add_entries'},
7419: $args->{'only_body'}, $args->{'domain'},
7420: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 ! raeburn 7421: $args->{'bgcolor'}, $args,
! 7422: \@advtools);
1.831 bisitz 7423: }
1.330 albertel 7424: }
1.338 albertel 7425:
1.315 albertel 7426: if ($args->{'js_ready'}) {
1.713 kaisler 7427: $result = &js_ready($result);
1.315 albertel 7428: }
1.320 albertel 7429: if ($args->{'html_encode'}) {
1.713 kaisler 7430: $result = &html_encode($result);
7431: }
7432:
1.813 bisitz 7433: # Preparation for new and consistent functionlist at top of screen
7434: # if ($args->{'functionlist'}) {
7435: # $result .= &build_functionlist();
7436: #}
7437:
1.964 droeschl 7438: # Don't add anything more if only_body wanted or in const space
7439: return $result if $args->{'only_body'}
7440: || $env{'request.state'} eq 'construct';
1.813 bisitz 7441:
7442: #Breadcrumbs
1.758 kaisler 7443: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7444: &Apache::lonhtmlcommon::clear_breadcrumbs();
7445: #if any br links exists, add them to the breadcrumbs
7446: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7447: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7448: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7449: }
7450: }
1.1096 ! raeburn 7451: # if @advtools array contains items add then to the breadcrumbs
! 7452: if (@advtools > 0) {
! 7453: &Apache::lonmenu::advtools_crumbs(@advtools);
! 7454: }
1.758 kaisler 7455:
7456: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7457: if(exists($args->{'bread_crumbs_component'})){
7458: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7459: }else{
7460: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7461: }
1.320 albertel 7462: }
1.315 albertel 7463: return $result;
1.306 albertel 7464: }
7465:
7466: sub end_page {
1.315 albertel 7467: my ($args) = @_;
7468: $env{'internal.end_page'}++;
1.330 albertel 7469: my $result;
1.335 albertel 7470: if ($args->{'discussion'}) {
7471: my ($target,$parser);
7472: if (ref($args->{'discussion'})) {
7473: ($target,$parser) =($args->{'discussion'}{'target'},
7474: $args->{'discussion'}{'parser'});
7475: }
7476: $result .= &Apache::lonxml::xmlend($target,$parser);
7477: }
1.330 albertel 7478: if ($args->{'frameset'}) {
7479: $result .= '</frameset>';
7480: } else {
1.635 raeburn 7481: $result .= &endbodytag($args);
1.330 albertel 7482: }
1.1080 raeburn 7483: unless ($args->{'notbody'}) {
7484: $result .= "\n</html>";
7485: }
1.330 albertel 7486:
1.315 albertel 7487: if ($args->{'js_ready'}) {
1.317 albertel 7488: $result = &js_ready($result);
1.315 albertel 7489: }
1.335 albertel 7490:
1.320 albertel 7491: if ($args->{'html_encode'}) {
7492: $result = &html_encode($result);
7493: }
1.335 albertel 7494:
1.315 albertel 7495: return $result;
7496: }
7497:
1.1034 www 7498: sub wishlist_window {
7499: return(<<'ENDWISHLIST');
1.1046 raeburn 7500: <script type="text/javascript">
1.1034 www 7501: // <![CDATA[
7502: // <!-- BEGIN LON-CAPA Internal
7503: function set_wishlistlink(title, path) {
7504: if (!title) {
7505: title = document.title;
7506: title = title.replace(/^LON-CAPA /,'');
7507: }
7508: if (!path) {
7509: path = location.pathname;
7510: }
7511: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7512: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7513: }
7514: // END LON-CAPA Internal -->
7515: // ]]>
7516: </script>
7517: ENDWISHLIST
7518: }
7519:
1.1030 www 7520: sub modal_window {
7521: return(<<'ENDMODAL');
1.1046 raeburn 7522: <script type="text/javascript">
1.1030 www 7523: // <![CDATA[
7524: // <!-- BEGIN LON-CAPA Internal
7525: var modalWindow = {
7526: parent:"body",
7527: windowId:null,
7528: content:null,
7529: width:null,
7530: height:null,
7531: close:function()
7532: {
7533: $(".LCmodal-window").remove();
7534: $(".LCmodal-overlay").remove();
7535: },
7536: open:function()
7537: {
7538: var modal = "";
7539: modal += "<div class=\"LCmodal-overlay\"></div>";
7540: 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;\">";
7541: modal += this.content;
7542: modal += "</div>";
7543:
7544: $(this.parent).append(modal);
7545:
7546: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7547: $(".LCclose-window").click(function(){modalWindow.close();});
7548: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7549: }
7550: };
1.1031 www 7551: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7552: {
7553: modalWindow.windowId = "myModal";
7554: modalWindow.width = width;
7555: modalWindow.height = height;
1.1031 www 7556: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7557: modalWindow.open();
7558: };
7559: // END LON-CAPA Internal -->
7560: // ]]>
7561: </script>
7562: ENDMODAL
7563: }
7564:
7565: sub modal_link {
1.1052 www 7566: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7567: unless ($width) { $width=480; }
7568: unless ($height) { $height=400; }
1.1031 www 7569: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7570: my $target_attr;
7571: if (defined($target)) {
7572: $target_attr = 'target="'.$target.'"';
7573: }
7574: return <<"ENDLINK";
7575: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7576: $linktext</a>
7577: ENDLINK
1.1030 www 7578: }
7579:
1.1032 www 7580: sub modal_adhoc_script {
7581: my ($funcname,$width,$height,$content)=@_;
7582: return (<<ENDADHOC);
1.1046 raeburn 7583: <script type="text/javascript">
1.1032 www 7584: // <![CDATA[
7585: var $funcname = function()
7586: {
7587: modalWindow.windowId = "myModal";
7588: modalWindow.width = $width;
7589: modalWindow.height = $height;
7590: modalWindow.content = '$content';
7591: modalWindow.open();
7592: };
7593: // ]]>
7594: </script>
7595: ENDADHOC
7596: }
7597:
1.1041 www 7598: sub modal_adhoc_inner {
7599: my ($funcname,$width,$height,$content)=@_;
7600: my $innerwidth=$width-20;
7601: $content=&js_ready(
1.1042 www 7602: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7603: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7604: $content.
7605: &end_scrollbox().
7606: &end_page()
7607: );
7608: return &modal_adhoc_script($funcname,$width,$height,$content);
7609: }
7610:
7611: sub modal_adhoc_window {
7612: my ($funcname,$width,$height,$content,$linktext)=@_;
7613: return &modal_adhoc_inner($funcname,$width,$height,$content).
7614: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7615: }
7616:
7617: sub modal_adhoc_launch {
7618: my ($funcname,$width,$height,$content)=@_;
7619: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7620: <script type="text/javascript">
7621: // <![CDATA[
7622: $funcname();
7623: // ]]>
7624: </script>
7625: ENDLAUNCH
7626: }
7627:
7628: sub modal_adhoc_close {
7629: return (<<ENDCLOSE);
7630: <script type="text/javascript">
7631: // <![CDATA[
7632: modalWindow.close();
7633: // ]]>
7634: </script>
7635: ENDCLOSE
7636: }
7637:
1.1038 www 7638: sub togglebox_script {
7639: return(<<ENDTOGGLE);
7640: <script type="text/javascript">
7641: // <![CDATA[
7642: function LCtoggleDisplay(id,hidetext,showtext) {
7643: link = document.getElementById(id + "link").childNodes[0];
7644: with (document.getElementById(id).style) {
7645: if (display == "none" ) {
7646: display = "inline";
7647: link.nodeValue = hidetext;
7648: } else {
7649: display = "none";
7650: link.nodeValue = showtext;
7651: }
7652: }
7653: }
7654: // ]]>
7655: </script>
7656: ENDTOGGLE
7657: }
7658:
1.1039 www 7659: sub start_togglebox {
7660: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7661: unless ($heading) { $heading=''; } else { $heading.=' '; }
7662: unless ($showtext) { $showtext=&mt('show'); }
7663: unless ($hidetext) { $hidetext=&mt('hide'); }
7664: unless ($headerbg) { $headerbg='#FFFFFF'; }
7665: return &start_data_table().
7666: &start_data_table_header_row().
7667: '<td bgcolor="'.$headerbg.'">'.$heading.
7668: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7669: $showtext.'\')">'.$showtext.'</a>]</td>'.
7670: &end_data_table_header_row().
7671: '<tr id="'.$id.'" style="display:none""><td>';
7672: }
7673:
7674: sub end_togglebox {
7675: return '</td></tr>'.&end_data_table();
7676: }
7677:
1.1041 www 7678: sub LCprogressbar_script {
1.1045 www 7679: my ($id)=@_;
1.1041 www 7680: return(<<ENDPROGRESS);
7681: <script type="text/javascript">
7682: // <![CDATA[
1.1045 www 7683: \$('#progressbar$id').progressbar({
1.1041 www 7684: value: 0,
7685: change: function(event, ui) {
7686: var newVal = \$(this).progressbar('option', 'value');
7687: \$('.pblabel', this).text(LCprogressTxt);
7688: }
7689: });
7690: // ]]>
7691: </script>
7692: ENDPROGRESS
7693: }
7694:
7695: sub LCprogressbarUpdate_script {
7696: return(<<ENDPROGRESSUPDATE);
7697: <style type="text/css">
7698: .ui-progressbar { position:relative; }
7699: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7700: </style>
7701: <script type="text/javascript">
7702: // <![CDATA[
1.1045 www 7703: var LCprogressTxt='---';
7704:
7705: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7706: LCprogressTxt=progresstext;
1.1045 www 7707: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7708: }
7709: // ]]>
7710: </script>
7711: ENDPROGRESSUPDATE
7712: }
7713:
1.1042 www 7714: my $LClastpercent;
1.1045 www 7715: my $LCidcnt;
7716: my $LCcurrentid;
1.1042 www 7717:
1.1041 www 7718: sub LCprogressbar {
1.1042 www 7719: my ($r)=(@_);
7720: $LClastpercent=0;
1.1045 www 7721: $LCidcnt++;
7722: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7723: my $starting=&mt('Starting');
7724: my $content=(<<ENDPROGBAR);
7725: <p>
1.1045 www 7726: <div id="progressbar$LCcurrentid">
1.1041 www 7727: <span class="pblabel">$starting</span>
7728: </div>
7729: </p>
7730: ENDPROGBAR
1.1045 www 7731: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7732: }
7733:
7734: sub LCprogressbarUpdate {
1.1042 www 7735: my ($r,$val,$text)=@_;
7736: unless ($val) {
7737: if ($LClastpercent) {
7738: $val=$LClastpercent;
7739: } else {
7740: $val=0;
7741: }
7742: }
1.1041 www 7743: if ($val<0) { $val=0; }
7744: if ($val>100) { $val=0; }
1.1042 www 7745: $LClastpercent=$val;
1.1041 www 7746: unless ($text) { $text=$val.'%'; }
7747: $text=&js_ready($text);
1.1044 www 7748: &r_print($r,<<ENDUPDATE);
1.1041 www 7749: <script type="text/javascript">
7750: // <![CDATA[
1.1045 www 7751: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7752: // ]]>
7753: </script>
7754: ENDUPDATE
1.1035 www 7755: }
7756:
1.1042 www 7757: sub LCprogressbarClose {
7758: my ($r)=@_;
7759: $LClastpercent=0;
1.1044 www 7760: &r_print($r,<<ENDCLOSE);
1.1042 www 7761: <script type="text/javascript">
7762: // <![CDATA[
1.1045 www 7763: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7764: // ]]>
7765: </script>
7766: ENDCLOSE
1.1044 www 7767: }
7768:
7769: sub r_print {
7770: my ($r,$to_print)=@_;
7771: if ($r) {
7772: $r->print($to_print);
7773: $r->rflush();
7774: } else {
7775: print($to_print);
7776: }
1.1042 www 7777: }
7778:
1.320 albertel 7779: sub html_encode {
7780: my ($result) = @_;
7781:
1.322 albertel 7782: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7783:
7784: return $result;
7785: }
1.1044 www 7786:
1.317 albertel 7787: sub js_ready {
7788: my ($result) = @_;
7789:
1.323 albertel 7790: $result =~ s/[\n\r]/ /xmsg;
7791: $result =~ s/\\/\\\\/xmsg;
7792: $result =~ s/'/\\'/xmsg;
1.372 albertel 7793: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7794:
7795: return $result;
7796: }
7797:
1.315 albertel 7798: sub validate_page {
7799: if ( exists($env{'internal.start_page'})
1.316 albertel 7800: && $env{'internal.start_page'} > 1) {
7801: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7802: $env{'internal.start_page'}.' '.
1.316 albertel 7803: $ENV{'request.filename'});
1.315 albertel 7804: }
7805: if ( exists($env{'internal.end_page'})
1.316 albertel 7806: && $env{'internal.end_page'} > 1) {
7807: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7808: $env{'internal.end_page'}.' '.
1.316 albertel 7809: $env{'request.filename'});
1.315 albertel 7810: }
7811: if ( exists($env{'internal.start_page'})
7812: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7813: &Apache::lonnet::logthis('start_page called without end_page '.
7814: $env{'request.filename'});
1.315 albertel 7815: }
7816: if ( ! exists($env{'internal.start_page'})
7817: && exists($env{'internal.end_page'})) {
1.316 albertel 7818: &Apache::lonnet::logthis('end_page called without start_page'.
7819: $env{'request.filename'});
1.315 albertel 7820: }
1.306 albertel 7821: }
1.315 albertel 7822:
1.996 www 7823:
7824: sub start_scrollbox {
1.1075 raeburn 7825: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7826: unless ($outerwidth) { $outerwidth='520px'; }
7827: unless ($width) { $width='500px'; }
7828: unless ($height) { $height='200px'; }
1.1075 raeburn 7829: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7830: if ($id ne '') {
1.1020 raeburn 7831: $table_id = " id='table_$id'";
7832: $div_id = " id='div_$id'";
1.1018 raeburn 7833: }
1.1075 raeburn 7834: if ($bgcolor ne '') {
7835: $tdcol = "background-color: $bgcolor;";
7836: }
7837: return <<"END";
7838: <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>
7839: END
1.996 www 7840: }
7841:
7842: sub end_scrollbox {
1.1036 www 7843: return '</div></td></tr></table>';
1.996 www 7844: }
7845:
1.318 albertel 7846: sub simple_error_page {
7847: my ($r,$title,$msg) = @_;
7848: my $page =
7849: &Apache::loncommon::start_page($title).
1.1096 ! raeburn 7850: '<span class="LC_warning">'.&mt($msg).'</span>'.
1.318 albertel 7851: &Apache::loncommon::end_page();
7852: if (ref($r)) {
7853: $r->print($page);
1.327 albertel 7854: return;
1.318 albertel 7855: }
7856: return $page;
7857: }
1.347 albertel 7858:
7859: {
1.610 albertel 7860: my @row_count;
1.961 onken 7861:
7862: sub start_data_table_count {
7863: unshift(@row_count, 0);
7864: return;
7865: }
7866:
7867: sub end_data_table_count {
7868: shift(@row_count);
7869: return;
7870: }
7871:
1.347 albertel 7872: sub start_data_table {
1.1018 raeburn 7873: my ($add_class,$id) = @_;
1.422 albertel 7874: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7875: my $table_id;
7876: if (defined($id)) {
7877: $table_id = ' id="'.$id.'"';
7878: }
1.961 onken 7879: &start_data_table_count();
1.1018 raeburn 7880: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7881: }
7882:
7883: sub end_data_table {
1.961 onken 7884: &end_data_table_count();
1.389 albertel 7885: return '</table>'."\n";;
1.347 albertel 7886: }
7887:
7888: sub start_data_table_row {
1.974 wenzelju 7889: my ($add_class, $id) = @_;
1.610 albertel 7890: $row_count[0]++;
7891: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7892: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7893: $id = (' id="'.$id.'"') unless ($id eq '');
7894: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7895: }
1.471 banghart 7896:
7897: sub continue_data_table_row {
1.974 wenzelju 7898: my ($add_class, $id) = @_;
1.610 albertel 7899: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7900: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7901: $id = (' id="'.$id.'"') unless ($id eq '');
7902: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7903: }
1.347 albertel 7904:
7905: sub end_data_table_row {
1.389 albertel 7906: return '</tr>'."\n";;
1.347 albertel 7907: }
1.367 www 7908:
1.421 albertel 7909: sub start_data_table_empty_row {
1.707 bisitz 7910: # $row_count[0]++;
1.421 albertel 7911: return '<tr class="LC_empty_row" >'."\n";;
7912: }
7913:
7914: sub end_data_table_empty_row {
7915: return '</tr>'."\n";;
7916: }
7917:
1.367 www 7918: sub start_data_table_header_row {
1.389 albertel 7919: return '<tr class="LC_header_row">'."\n";;
1.367 www 7920: }
7921:
7922: sub end_data_table_header_row {
1.389 albertel 7923: return '</tr>'."\n";;
1.367 www 7924: }
1.890 droeschl 7925:
7926: sub data_table_caption {
7927: my $caption = shift;
7928: return "<caption class=\"LC_caption\">$caption</caption>";
7929: }
1.347 albertel 7930: }
7931:
1.548 albertel 7932: =pod
7933:
7934: =item * &inhibit_menu_check($arg)
7935:
7936: Checks for a inhibitmenu state and generates output to preserve it
7937:
7938: Inputs: $arg - can be any of
7939: - undef - in which case the return value is a string
7940: to add into arguments list of a uri
7941: - 'input' - in which case the return value is a HTML
7942: <form> <input> field of type hidden to
7943: preserve the value
7944: - a url - in which case the return value is the url with
7945: the neccesary cgi args added to preserve the
7946: inhibitmenu state
7947: - a ref to a url - no return value, but the string is
7948: updated to include the neccessary cgi
7949: args to preserve the inhibitmenu state
7950:
7951: =cut
7952:
7953: sub inhibit_menu_check {
7954: my ($arg) = @_;
7955: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7956: if ($arg eq 'input') {
7957: if ($env{'form.inhibitmenu'}) {
7958: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7959: } else {
7960: return
7961: }
7962: }
7963: if ($env{'form.inhibitmenu'}) {
7964: if (ref($arg)) {
7965: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7966: } elsif ($arg eq '') {
7967: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7968: } else {
7969: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7970: }
7971: }
7972: if (!ref($arg)) {
7973: return $arg;
7974: }
7975: }
7976:
1.251 albertel 7977: ###############################################
1.182 matthew 7978:
7979: =pod
7980:
1.549 albertel 7981: =back
7982:
7983: =head1 User Information Routines
7984:
7985: =over 4
7986:
1.405 albertel 7987: =item * &get_users_function()
1.182 matthew 7988:
7989: Used by &bodytag to determine the current users primary role.
7990: Returns either 'student','coordinator','admin', or 'author'.
7991:
7992: =cut
7993:
7994: ###############################################
7995: sub get_users_function {
1.815 tempelho 7996: my $function = 'norole';
1.818 tempelho 7997: if ($env{'request.role'}=~/^(st)/) {
7998: $function='student';
7999: }
1.907 raeburn 8000: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8001: $function='coordinator';
8002: }
1.258 albertel 8003: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8004: $function='admin';
8005: }
1.826 bisitz 8006: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8007: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8008: $function='author';
8009: }
8010: return $function;
1.54 www 8011: }
1.99 www 8012:
8013: ###############################################
8014:
1.233 raeburn 8015: =pod
8016:
1.821 raeburn 8017: =item * &show_course()
8018:
8019: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8020: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8021:
8022: Inputs:
8023: None
8024:
8025: Outputs:
8026: Scalar: 1 if 'Course' to be used, 0 otherwise.
8027:
8028: =cut
8029:
8030: ###############################################
8031: sub show_course {
8032: my $course = !$env{'user.adv'};
8033: if (!$env{'user.adv'}) {
8034: foreach my $env (keys(%env)) {
8035: next if ($env !~ m/^user\.priv\./);
8036: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8037: $course = 0;
8038: last;
8039: }
8040: }
8041: }
8042: return $course;
8043: }
8044:
8045: ###############################################
8046:
8047: =pod
8048:
1.542 raeburn 8049: =item * &check_user_status()
1.274 raeburn 8050:
8051: Determines current status of supplied role for a
8052: specific user. Roles can be active, previous or future.
8053:
8054: Inputs:
8055: user's domain, user's username, course's domain,
1.375 raeburn 8056: course's number, optional section ID.
1.274 raeburn 8057:
8058: Outputs:
8059: role status: active, previous or future.
8060:
8061: =cut
8062:
8063: sub check_user_status {
1.412 raeburn 8064: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8065: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8066: my @uroles = keys %userinfo;
8067: my $srchstr;
8068: my $active_chk = 'none';
1.412 raeburn 8069: my $now = time;
1.274 raeburn 8070: if (@uroles > 0) {
1.908 raeburn 8071: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8072: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8073: } else {
1.412 raeburn 8074: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8075: }
8076: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8077: my $role_end = 0;
8078: my $role_start = 0;
8079: $active_chk = 'active';
1.412 raeburn 8080: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8081: $role_end = $1;
8082: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8083: $role_start = $1;
1.274 raeburn 8084: }
8085: }
8086: if ($role_start > 0) {
1.412 raeburn 8087: if ($now < $role_start) {
1.274 raeburn 8088: $active_chk = 'future';
8089: }
8090: }
8091: if ($role_end > 0) {
1.412 raeburn 8092: if ($now > $role_end) {
1.274 raeburn 8093: $active_chk = 'previous';
8094: }
8095: }
8096: }
8097: }
8098: return $active_chk;
8099: }
8100:
8101: ###############################################
8102:
8103: =pod
8104:
1.405 albertel 8105: =item * &get_sections()
1.233 raeburn 8106:
8107: Determines all the sections for a course including
8108: sections with students and sections containing other roles.
1.419 raeburn 8109: Incoming parameters:
8110:
8111: 1. domain
8112: 2. course number
8113: 3. reference to array containing roles for which sections should
8114: be gathered (optional).
8115: 4. reference to array containing status types for which sections
8116: should be gathered (optional).
8117:
8118: If the third argument is undefined, sections are gathered for any role.
8119: If the fourth argument is undefined, sections are gathered for any status.
8120: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8121:
1.374 raeburn 8122: Returns section hash (keys are section IDs, values are
8123: number of users in each section), subject to the
1.419 raeburn 8124: optional roles filter, optional status filter
1.233 raeburn 8125:
8126: =cut
8127:
8128: ###############################################
8129: sub get_sections {
1.419 raeburn 8130: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8131: if (!defined($cdom) || !defined($cnum)) {
8132: my $cid = $env{'request.course.id'};
8133:
8134: return if (!defined($cid));
8135:
8136: $cdom = $env{'course.'.$cid.'.domain'};
8137: $cnum = $env{'course.'.$cid.'.num'};
8138: }
8139:
8140: my %sectioncount;
1.419 raeburn 8141: my $now = time;
1.240 albertel 8142:
1.366 albertel 8143: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8144: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8145: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8146: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8147: my $start_index = &Apache::loncoursedata::CL_START();
8148: my $end_index = &Apache::loncoursedata::CL_END();
8149: my $status;
1.366 albertel 8150: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8151: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8152: $data->[$status_index],
8153: $data->[$start_index],
8154: $data->[$end_index]);
8155: if ($stu_status eq 'Active') {
8156: $status = 'active';
8157: } elsif ($end < $now) {
8158: $status = 'previous';
8159: } elsif ($start > $now) {
8160: $status = 'future';
8161: }
8162: if ($section ne '-1' && $section !~ /^\s*$/) {
8163: if ((!defined($possible_status)) || (($status ne '') &&
8164: (grep/^\Q$status\E$/,@{$possible_status}))) {
8165: $sectioncount{$section}++;
8166: }
1.240 albertel 8167: }
8168: }
8169: }
8170: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8171: foreach my $user (sort(keys(%courseroles))) {
8172: if ($user !~ /^(\w{2})/) { next; }
8173: my ($role) = ($user =~ /^(\w{2})/);
8174: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8175: my ($section,$status);
1.240 albertel 8176: if ($role eq 'cr' &&
8177: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8178: $section=$1;
8179: }
8180: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8181: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8182: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8183: if ($end == -1 && $start == -1) {
8184: next; #deleted role
8185: }
8186: if (!defined($possible_status)) {
8187: $sectioncount{$section}++;
8188: } else {
8189: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8190: $status = 'active';
8191: } elsif ($end < $now) {
8192: $status = 'future';
8193: } elsif ($start > $now) {
8194: $status = 'previous';
8195: }
8196: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8197: $sectioncount{$section}++;
8198: }
8199: }
1.233 raeburn 8200: }
1.366 albertel 8201: return %sectioncount;
1.233 raeburn 8202: }
8203:
1.274 raeburn 8204: ###############################################
1.294 raeburn 8205:
8206: =pod
1.405 albertel 8207:
8208: =item * &get_course_users()
8209:
1.275 raeburn 8210: Retrieves usernames:domains for users in the specified course
8211: with specific role(s), and access status.
8212:
8213: Incoming parameters:
1.277 albertel 8214: 1. course domain
8215: 2. course number
8216: 3. access status: users must have - either active,
1.275 raeburn 8217: previous, future, or all.
1.277 albertel 8218: 4. reference to array of permissible roles
1.288 raeburn 8219: 5. reference to array of section restrictions (optional)
8220: 6. reference to results object (hash of hashes).
8221: 7. reference to optional userdata hash
1.609 raeburn 8222: 8. reference to optional statushash
1.630 raeburn 8223: 9. flag if privileged users (except those set to unhide in
8224: course settings) should be excluded
1.609 raeburn 8225: Keys of top level results hash are roles.
1.275 raeburn 8226: Keys of inner hashes are username:domain, with
8227: values set to access type.
1.288 raeburn 8228: Optional userdata hash returns an array with arguments in the
8229: same order as loncoursedata::get_classlist() for student data.
8230:
1.609 raeburn 8231: Optional statushash returns
8232:
1.288 raeburn 8233: Entries for end, start, section and status are blank because
8234: of the possibility of multiple values for non-student roles.
8235:
1.275 raeburn 8236: =cut
1.405 albertel 8237:
1.275 raeburn 8238: ###############################################
1.405 albertel 8239:
1.275 raeburn 8240: sub get_course_users {
1.630 raeburn 8241: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8242: my %idx = ();
1.419 raeburn 8243: my %seclists;
1.288 raeburn 8244:
8245: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8246: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8247: $idx{end} = &Apache::loncoursedata::CL_END();
8248: $idx{start} = &Apache::loncoursedata::CL_START();
8249: $idx{id} = &Apache::loncoursedata::CL_ID();
8250: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8251: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8252: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8253:
1.290 albertel 8254: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8255: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8256: my $now = time;
1.277 albertel 8257: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8258: my $match = 0;
1.412 raeburn 8259: my $secmatch = 0;
1.419 raeburn 8260: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8261: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8262: if ($section eq '') {
8263: $section = 'none';
8264: }
1.291 albertel 8265: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8266: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8267: $secmatch = 1;
8268: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8269: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8270: $secmatch = 1;
8271: }
8272: } else {
1.419 raeburn 8273: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8274: $secmatch = 1;
8275: }
1.290 albertel 8276: }
1.412 raeburn 8277: if (!$secmatch) {
8278: next;
8279: }
1.419 raeburn 8280: }
1.275 raeburn 8281: if (defined($$types{'active'})) {
1.288 raeburn 8282: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8283: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8284: $match = 1;
1.275 raeburn 8285: }
8286: }
8287: if (defined($$types{'previous'})) {
1.609 raeburn 8288: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8289: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8290: $match = 1;
1.275 raeburn 8291: }
8292: }
8293: if (defined($$types{'future'})) {
1.609 raeburn 8294: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8295: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8296: $match = 1;
1.275 raeburn 8297: }
8298: }
1.609 raeburn 8299: if ($match) {
8300: push(@{$seclists{$student}},$section);
8301: if (ref($userdata) eq 'HASH') {
8302: $$userdata{$student} = $$classlist{$student};
8303: }
8304: if (ref($statushash) eq 'HASH') {
8305: $statushash->{$student}{'st'}{$section} = $status;
8306: }
1.288 raeburn 8307: }
1.275 raeburn 8308: }
8309: }
1.412 raeburn 8310: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8311: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8312: my $now = time;
1.609 raeburn 8313: my %displaystatus = ( previous => 'Expired',
8314: active => 'Active',
8315: future => 'Future',
8316: );
1.630 raeburn 8317: my %nothide;
8318: if ($hidepriv) {
8319: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8320: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8321: if ($user !~ /:/) {
8322: $nothide{join(':',split(/[\@]/,$user))}=1;
8323: } else {
8324: $nothide{$user} = 1;
8325: }
8326: }
8327: }
1.439 raeburn 8328: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8329: my $match = 0;
1.412 raeburn 8330: my $secmatch = 0;
1.439 raeburn 8331: my $status;
1.412 raeburn 8332: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8333: $user =~ s/:$//;
1.439 raeburn 8334: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8335: if ($end == -1 || $start == -1) {
8336: next;
8337: }
8338: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8339: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8340: my ($uname,$udom) = split(/:/,$user);
8341: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8342: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8343: $secmatch = 1;
8344: } elsif ($usec eq '') {
1.420 albertel 8345: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8346: $secmatch = 1;
8347: }
8348: } else {
8349: if (grep(/^\Q$usec\E$/,@{$sections})) {
8350: $secmatch = 1;
8351: }
8352: }
8353: if (!$secmatch) {
8354: next;
8355: }
1.288 raeburn 8356: }
1.419 raeburn 8357: if ($usec eq '') {
8358: $usec = 'none';
8359: }
1.275 raeburn 8360: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8361: if ($hidepriv) {
8362: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8363: (!$nothide{$uname.':'.$udom})) {
8364: next;
8365: }
8366: }
1.503 raeburn 8367: if ($end > 0 && $end < $now) {
1.439 raeburn 8368: $status = 'previous';
8369: } elsif ($start > $now) {
8370: $status = 'future';
8371: } else {
8372: $status = 'active';
8373: }
1.277 albertel 8374: foreach my $type (keys(%{$types})) {
1.275 raeburn 8375: if ($status eq $type) {
1.420 albertel 8376: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8377: push(@{$$users{$role}{$user}},$type);
8378: }
1.288 raeburn 8379: $match = 1;
8380: }
8381: }
1.419 raeburn 8382: if (($match) && (ref($userdata) eq 'HASH')) {
8383: if (!exists($$userdata{$uname.':'.$udom})) {
8384: &get_user_info($udom,$uname,\%idx,$userdata);
8385: }
1.420 albertel 8386: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8387: push(@{$seclists{$uname.':'.$udom}},$usec);
8388: }
1.609 raeburn 8389: if (ref($statushash) eq 'HASH') {
8390: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8391: }
1.275 raeburn 8392: }
8393: }
8394: }
8395: }
1.290 albertel 8396: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8397: if ((defined($cdom)) && (defined($cnum))) {
8398: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8399: if ( defined($csettings{'internal.courseowner'}) ) {
8400: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8401: next if ($owner eq '');
8402: my ($ownername,$ownerdom);
8403: if ($owner =~ /^([^:]+):([^:]+)$/) {
8404: $ownername = $1;
8405: $ownerdom = $2;
8406: } else {
8407: $ownername = $owner;
8408: $ownerdom = $cdom;
8409: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8410: }
8411: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8412: if (defined($userdata) &&
1.609 raeburn 8413: !exists($$userdata{$owner})) {
8414: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8415: if (!grep(/^none$/,@{$seclists{$owner}})) {
8416: push(@{$seclists{$owner}},'none');
8417: }
8418: if (ref($statushash) eq 'HASH') {
8419: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8420: }
1.290 albertel 8421: }
1.279 raeburn 8422: }
8423: }
8424: }
1.419 raeburn 8425: foreach my $user (keys(%seclists)) {
8426: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8427: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8428: }
1.275 raeburn 8429: }
8430: return;
8431: }
8432:
1.288 raeburn 8433: sub get_user_info {
8434: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8435: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8436: &plainname($uname,$udom,'lastname');
1.291 albertel 8437: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8438: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8439: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8440: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8441: return;
8442: }
1.275 raeburn 8443:
1.472 raeburn 8444: ###############################################
8445:
8446: =pod
8447:
8448: =item * &get_user_quota()
8449:
8450: Retrieves quota assigned for storage of portfolio files for a user
8451:
8452: Incoming parameters:
8453: 1. user's username
8454: 2. user's domain
8455:
8456: Returns:
1.536 raeburn 8457: 1. Disk quota (in Mb) assigned to student.
8458: 2. (Optional) Type of setting: custom or default
8459: (individually assigned or default for user's
8460: institutional status).
8461: 3. (Optional) - User's institutional status (e.g., faculty, staff
8462: or student - types as defined in localenroll::inst_usertypes
8463: for user's domain, which determines default quota for user.
8464: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8465:
8466: If a value has been stored in the user's environment,
1.536 raeburn 8467: it will return that, otherwise it returns the maximal default
8468: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8469:
8470: =cut
8471:
8472: ###############################################
8473:
8474:
8475: sub get_user_quota {
8476: my ($uname,$udom) = @_;
1.536 raeburn 8477: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8478: if (!defined($udom)) {
8479: $udom = $env{'user.domain'};
8480: }
8481: if (!defined($uname)) {
8482: $uname = $env{'user.name'};
8483: }
8484: if (($udom eq '' || $uname eq '') ||
8485: ($udom eq 'public') && ($uname eq 'public')) {
8486: $quota = 0;
1.536 raeburn 8487: $quotatype = 'default';
8488: $defquota = 0;
1.472 raeburn 8489: } else {
1.536 raeburn 8490: my $inststatus;
1.472 raeburn 8491: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8492: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8493: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8494: } else {
1.536 raeburn 8495: my %userenv =
8496: &Apache::lonnet::get('environment',['portfolioquota',
8497: 'inststatus'],$udom,$uname);
1.472 raeburn 8498: my ($tmp) = keys(%userenv);
8499: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8500: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8501: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8502: } else {
8503: undef(%userenv);
8504: }
8505: }
1.536 raeburn 8506: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8507: if ($quota eq '') {
1.536 raeburn 8508: $quota = $defquota;
8509: $quotatype = 'default';
8510: } else {
8511: $quotatype = 'custom';
1.472 raeburn 8512: }
8513: }
1.536 raeburn 8514: if (wantarray) {
8515: return ($quota,$quotatype,$settingstatus,$defquota);
8516: } else {
8517: return $quota;
8518: }
1.472 raeburn 8519: }
8520:
8521: ###############################################
8522:
8523: =pod
8524:
8525: =item * &default_quota()
8526:
1.536 raeburn 8527: Retrieves default quota assigned for storage of user portfolio files,
8528: given an (optional) user's institutional status.
1.472 raeburn 8529:
8530: Incoming parameters:
8531: 1. domain
1.536 raeburn 8532: 2. (Optional) institutional status(es). This is a : separated list of
8533: status types (e.g., faculty, staff, student etc.)
8534: which apply to the user for whom the default is being retrieved.
8535: If the institutional status string in undefined, the domain
8536: default quota will be returned.
1.472 raeburn 8537:
8538: Returns:
8539: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8540: 2. (Optional) institutional type which determined the value of the
8541: default quota.
1.472 raeburn 8542:
8543: If a value has been stored in the domain's configuration db,
8544: it will return that, otherwise it returns 20 (for backwards
8545: compatibility with domains which have not set up a configuration
8546: db file; the original statically defined portfolio quota was 20 Mb).
8547:
1.536 raeburn 8548: If the user's status includes multiple types (e.g., staff and student),
8549: the largest default quota which applies to the user determines the
8550: default quota returned.
8551:
1.780 raeburn 8552: =back
8553:
1.472 raeburn 8554: =cut
8555:
8556: ###############################################
8557:
8558:
8559: sub default_quota {
1.536 raeburn 8560: my ($udom,$inststatus) = @_;
8561: my ($defquota,$settingstatus);
8562: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8563: ['quotas'],$udom);
8564: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8565: if ($inststatus ne '') {
1.765 raeburn 8566: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8567: foreach my $item (@statuses) {
1.711 raeburn 8568: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8569: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8570: if ($defquota eq '') {
8571: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8572: $settingstatus = $item;
8573: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8574: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8575: $settingstatus = $item;
8576: }
8577: }
8578: } else {
8579: if ($quotahash{'quotas'}{$item} ne '') {
8580: if ($defquota eq '') {
8581: $defquota = $quotahash{'quotas'}{$item};
8582: $settingstatus = $item;
8583: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8584: $defquota = $quotahash{'quotas'}{$item};
8585: $settingstatus = $item;
8586: }
1.536 raeburn 8587: }
8588: }
8589: }
8590: }
8591: if ($defquota eq '') {
1.711 raeburn 8592: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8593: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8594: } else {
8595: $defquota = $quotahash{'quotas'}{'default'};
8596: }
1.536 raeburn 8597: $settingstatus = 'default';
8598: }
8599: } else {
8600: $settingstatus = 'default';
8601: $defquota = 20;
8602: }
8603: if (wantarray) {
8604: return ($defquota,$settingstatus);
1.472 raeburn 8605: } else {
1.536 raeburn 8606: return $defquota;
1.472 raeburn 8607: }
8608: }
8609:
1.384 raeburn 8610: sub get_secgrprole_info {
8611: my ($cdom,$cnum,$needroles,$type) = @_;
8612: my %sections_count = &get_sections($cdom,$cnum);
8613: my @sections = (sort {$a <=> $b} keys(%sections_count));
8614: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8615: my @groups = sort(keys(%curr_groups));
8616: my $allroles = [];
8617: my $rolehash;
8618: my $accesshash = {
8619: active => 'Currently has access',
8620: future => 'Will have future access',
8621: previous => 'Previously had access',
8622: };
8623: if ($needroles) {
8624: $rolehash = {'all' => 'all'};
1.385 albertel 8625: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8626: if (&Apache::lonnet::error(%user_roles)) {
8627: undef(%user_roles);
8628: }
8629: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8630: my ($role)=split(/\:/,$item,2);
8631: if ($role eq 'cr') { next; }
8632: if ($role =~ /^cr/) {
8633: $$rolehash{$role} = (split('/',$role))[3];
8634: } else {
8635: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8636: }
8637: }
8638: foreach my $key (sort(keys(%{$rolehash}))) {
8639: push(@{$allroles},$key);
8640: }
8641: push (@{$allroles},'st');
8642: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8643: }
8644: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8645: }
8646:
1.555 raeburn 8647: sub user_picker {
1.994 raeburn 8648: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8649: my $currdom = $dom;
8650: my %curr_selected = (
8651: srchin => 'dom',
1.580 raeburn 8652: srchby => 'lastname',
1.555 raeburn 8653: );
8654: my $srchterm;
1.625 raeburn 8655: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8656: if ($srch->{'srchby'} ne '') {
8657: $curr_selected{'srchby'} = $srch->{'srchby'};
8658: }
8659: if ($srch->{'srchin'} ne '') {
8660: $curr_selected{'srchin'} = $srch->{'srchin'};
8661: }
8662: if ($srch->{'srchtype'} ne '') {
8663: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8664: }
8665: if ($srch->{'srchdomain'} ne '') {
8666: $currdom = $srch->{'srchdomain'};
8667: }
8668: $srchterm = $srch->{'srchterm'};
8669: }
8670: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8671: 'usr' => 'Search criteria',
1.563 raeburn 8672: 'doma' => 'Domain/institution to search',
1.558 albertel 8673: 'uname' => 'username',
8674: 'lastname' => 'last name',
1.555 raeburn 8675: 'lastfirst' => 'last name, first name',
1.558 albertel 8676: 'crs' => 'in this course',
1.576 raeburn 8677: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8678: 'alc' => 'all LON-CAPA',
1.573 raeburn 8679: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8680: 'exact' => 'is',
8681: 'contains' => 'contains',
1.569 raeburn 8682: 'begins' => 'begins with',
1.571 raeburn 8683: 'youm' => "You must include some text to search for.",
8684: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8685: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8686: 'yomc' => "You must choose a domain when using an institutional directory search.",
8687: 'ymcd' => "You must choose a domain when using a domain search.",
8688: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8689: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8690: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8691: );
1.563 raeburn 8692: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8693: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8694:
8695: my @srchins = ('crs','dom','alc','instd');
8696:
8697: foreach my $option (@srchins) {
8698: # FIXME 'alc' option unavailable until
8699: # loncreateuser::print_user_query_page()
8700: # has been completed.
8701: next if ($option eq 'alc');
1.880 raeburn 8702: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8703: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8704: if ($curr_selected{'srchin'} eq $option) {
8705: $srchinsel .= '
8706: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8707: } else {
8708: $srchinsel .= '
8709: <option value="'.$option.'">'.$lt{$option}.'</option>';
8710: }
1.555 raeburn 8711: }
1.563 raeburn 8712: $srchinsel .= "\n </select>\n";
1.555 raeburn 8713:
8714: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8715: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8716: if ($curr_selected{'srchby'} eq $option) {
8717: $srchbysel .= '
8718: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8719: } else {
8720: $srchbysel .= '
8721: <option value="'.$option.'">'.$lt{$option}.'</option>';
8722: }
8723: }
8724: $srchbysel .= "\n </select>\n";
8725:
8726: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8727: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8728: if ($curr_selected{'srchtype'} eq $option) {
8729: $srchtypesel .= '
8730: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8731: } else {
8732: $srchtypesel .= '
8733: <option value="'.$option.'">'.$lt{$option}.'</option>';
8734: }
8735: }
8736: $srchtypesel .= "\n </select>\n";
8737:
1.558 albertel 8738: my ($newuserscript,$new_user_create);
1.994 raeburn 8739: my $context_dom = $env{'request.role.domain'};
8740: if ($context eq 'requestcrs') {
8741: if ($env{'form.coursedom'} ne '') {
8742: $context_dom = $env{'form.coursedom'};
8743: }
8744: }
1.556 raeburn 8745: if ($forcenewuser) {
1.576 raeburn 8746: if (ref($srch) eq 'HASH') {
1.994 raeburn 8747: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8748: if ($cancreate) {
8749: $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>';
8750: } else {
1.799 bisitz 8751: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8752: my %usertypetext = (
8753: official => 'institutional',
8754: unofficial => 'non-institutional',
8755: );
1.799 bisitz 8756: $new_user_create = '<p class="LC_warning">'
8757: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8758: .' '
8759: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8760: ,'<a href="'.$helplink.'">','</a>')
8761: .'</p><br />';
1.627 raeburn 8762: }
1.576 raeburn 8763: }
8764: }
8765:
1.556 raeburn 8766: $newuserscript = <<"ENDSCRIPT";
8767:
1.570 raeburn 8768: function setSearch(createnew,callingForm) {
1.556 raeburn 8769: if (createnew == 1) {
1.570 raeburn 8770: for (var i=0; i<callingForm.srchby.length; i++) {
8771: if (callingForm.srchby.options[i].value == 'uname') {
8772: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8773: }
8774: }
1.570 raeburn 8775: for (var i=0; i<callingForm.srchin.length; i++) {
8776: if ( callingForm.srchin.options[i].value == 'dom') {
8777: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8778: }
8779: }
1.570 raeburn 8780: for (var i=0; i<callingForm.srchtype.length; i++) {
8781: if (callingForm.srchtype.options[i].value == 'exact') {
8782: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8783: }
8784: }
1.570 raeburn 8785: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8786: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8787: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8788: }
8789: }
8790: }
8791: }
8792: ENDSCRIPT
1.558 albertel 8793:
1.556 raeburn 8794: }
8795:
1.555 raeburn 8796: my $output = <<"END_BLOCK";
1.556 raeburn 8797: <script type="text/javascript">
1.824 bisitz 8798: // <![CDATA[
1.570 raeburn 8799: function validateEntry(callingForm) {
1.558 albertel 8800:
1.556 raeburn 8801: var checkok = 1;
1.558 albertel 8802: var srchin;
1.570 raeburn 8803: for (var i=0; i<callingForm.srchin.length; i++) {
8804: if ( callingForm.srchin[i].checked ) {
8805: srchin = callingForm.srchin[i].value;
1.558 albertel 8806: }
8807: }
8808:
1.570 raeburn 8809: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8810: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8811: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8812: var srchterm = callingForm.srchterm.value;
8813: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8814: var msg = "";
8815:
8816: if (srchterm == "") {
8817: checkok = 0;
1.571 raeburn 8818: msg += "$lt{'youm'}\\n";
1.556 raeburn 8819: }
8820:
1.569 raeburn 8821: if (srchtype== 'begins') {
8822: if (srchterm.length < 2) {
8823: checkok = 0;
1.571 raeburn 8824: msg += "$lt{'thte'}\\n";
1.569 raeburn 8825: }
8826: }
8827:
1.556 raeburn 8828: if (srchtype== 'contains') {
8829: if (srchterm.length < 3) {
8830: checkok = 0;
1.571 raeburn 8831: msg += "$lt{'thet'}\\n";
1.556 raeburn 8832: }
8833: }
8834: if (srchin == 'instd') {
8835: if (srchdomain == '') {
8836: checkok = 0;
1.571 raeburn 8837: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8838: }
8839: }
8840: if (srchin == 'dom') {
8841: if (srchdomain == '') {
8842: checkok = 0;
1.571 raeburn 8843: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8844: }
8845: }
8846: if (srchby == 'lastfirst') {
8847: if (srchterm.indexOf(",") == -1) {
8848: checkok = 0;
1.571 raeburn 8849: msg += "$lt{'whus'}\\n";
1.556 raeburn 8850: }
8851: if (srchterm.indexOf(",") == srchterm.length -1) {
8852: checkok = 0;
1.571 raeburn 8853: msg += "$lt{'whse'}\\n";
1.556 raeburn 8854: }
8855: }
8856: if (checkok == 0) {
1.571 raeburn 8857: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8858: return;
8859: }
8860: if (checkok == 1) {
1.570 raeburn 8861: callingForm.submit();
1.556 raeburn 8862: }
8863: }
8864:
8865: $newuserscript
8866:
1.824 bisitz 8867: // ]]>
1.556 raeburn 8868: </script>
1.558 albertel 8869:
8870: $new_user_create
8871:
1.555 raeburn 8872: END_BLOCK
1.558 albertel 8873:
1.876 raeburn 8874: $output .= &Apache::lonhtmlcommon::start_pick_box().
8875: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8876: $domform.
8877: &Apache::lonhtmlcommon::row_closure().
8878: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8879: $srchbysel.
8880: $srchtypesel.
8881: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8882: $srchinsel.
8883: &Apache::lonhtmlcommon::row_closure(1).
8884: &Apache::lonhtmlcommon::end_pick_box().
8885: '<br />';
1.555 raeburn 8886: return $output;
8887: }
8888:
1.612 raeburn 8889: sub user_rule_check {
1.615 raeburn 8890: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8891: my $response;
8892: if (ref($usershash) eq 'HASH') {
8893: foreach my $user (keys(%{$usershash})) {
8894: my ($uname,$udom) = split(/:/,$user);
8895: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8896: my ($id,$newuser);
1.612 raeburn 8897: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8898: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8899: $id = $usershash->{$user}->{'id'};
8900: }
8901: my $inst_response;
8902: if (ref($checks) eq 'HASH') {
8903: if (defined($checks->{'username'})) {
1.615 raeburn 8904: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8905: &Apache::lonnet::get_instuser($udom,$uname);
8906: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8907: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8908: &Apache::lonnet::get_instuser($udom,undef,$id);
8909: }
1.615 raeburn 8910: } else {
8911: ($inst_response,%{$inst_results->{$user}}) =
8912: &Apache::lonnet::get_instuser($udom,$uname);
8913: return;
1.612 raeburn 8914: }
1.615 raeburn 8915: if (!$got_rules->{$udom}) {
1.612 raeburn 8916: my %domconfig = &Apache::lonnet::get_dom('configuration',
8917: ['usercreation'],$udom);
8918: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8919: foreach my $item ('username','id') {
1.612 raeburn 8920: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8921: $$curr_rules{$udom}{$item} =
8922: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8923: }
8924: }
8925: }
1.615 raeburn 8926: $got_rules->{$udom} = 1;
1.585 raeburn 8927: }
1.612 raeburn 8928: foreach my $item (keys(%{$checks})) {
8929: if (ref($$curr_rules{$udom}) eq 'HASH') {
8930: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8931: if (@{$$curr_rules{$udom}{$item}} > 0) {
8932: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8933: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8934: if ($rule_check{$rule}) {
8935: $$rulematch{$user}{$item} = $rule;
8936: if ($inst_response eq 'ok') {
1.615 raeburn 8937: if (ref($inst_results) eq 'HASH') {
8938: if (ref($inst_results->{$user}) eq 'HASH') {
8939: if (keys(%{$inst_results->{$user}}) == 0) {
8940: $$alerts{$item}{$udom}{$uname} = 1;
8941: }
1.612 raeburn 8942: }
8943: }
1.615 raeburn 8944: }
8945: last;
1.585 raeburn 8946: }
8947: }
8948: }
8949: }
8950: }
8951: }
8952: }
8953: }
1.612 raeburn 8954: return;
8955: }
8956:
8957: sub user_rule_formats {
8958: my ($domain,$domdesc,$curr_rules,$check) = @_;
8959: my %text = (
8960: 'username' => 'Usernames',
8961: 'id' => 'IDs',
8962: );
8963: my $output;
8964: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8965: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8966: if (@{$ruleorder} > 0) {
8967: $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>';
8968: foreach my $rule (@{$ruleorder}) {
8969: if (ref($curr_rules) eq 'ARRAY') {
8970: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8971: if (ref($rules->{$rule}) eq 'HASH') {
8972: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8973: $rules->{$rule}{'desc'}.'</li>';
8974: }
8975: }
8976: }
8977: }
8978: $output .= '</ul>';
8979: }
8980: }
8981: return $output;
8982: }
8983:
8984: sub instrule_disallow_msg {
1.615 raeburn 8985: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8986: my $response;
8987: my %text = (
8988: item => 'username',
8989: items => 'usernames',
8990: match => 'matches',
8991: do => 'does',
8992: action => 'a username',
8993: one => 'one',
8994: );
8995: if ($count > 1) {
8996: $text{'item'} = 'usernames';
8997: $text{'match'} ='match';
8998: $text{'do'} = 'do';
8999: $text{'action'} = 'usernames',
9000: $text{'one'} = 'ones';
9001: }
9002: if ($checkitem eq 'id') {
9003: $text{'items'} = 'IDs';
9004: $text{'item'} = 'ID';
9005: $text{'action'} = 'an ID';
1.615 raeburn 9006: if ($count > 1) {
9007: $text{'item'} = 'IDs';
9008: $text{'action'} = 'IDs';
9009: }
1.612 raeburn 9010: }
1.674 bisitz 9011: $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 9012: if ($mode eq 'upload') {
9013: if ($checkitem eq 'username') {
9014: $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'}.");
9015: } elsif ($checkitem eq 'id') {
1.674 bisitz 9016: $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 9017: }
1.669 raeburn 9018: } elsif ($mode eq 'selfcreate') {
9019: if ($checkitem eq 'id') {
9020: $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.");
9021: }
1.615 raeburn 9022: } else {
9023: if ($checkitem eq 'username') {
9024: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9025: } elsif ($checkitem eq 'id') {
9026: $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.");
9027: }
1.612 raeburn 9028: }
9029: return $response;
1.585 raeburn 9030: }
9031:
1.624 raeburn 9032: sub personal_data_fieldtitles {
9033: my %fieldtitles = &Apache::lonlocal::texthash (
9034: id => 'Student/Employee ID',
9035: permanentemail => 'E-mail address',
9036: lastname => 'Last Name',
9037: firstname => 'First Name',
9038: middlename => 'Middle Name',
9039: generation => 'Generation',
9040: gen => 'Generation',
1.765 raeburn 9041: inststatus => 'Affiliation',
1.624 raeburn 9042: );
9043: return %fieldtitles;
9044: }
9045:
1.642 raeburn 9046: sub sorted_inst_types {
9047: my ($dom) = @_;
9048: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9049: my $othertitle = &mt('All users');
9050: if ($env{'request.course.id'}) {
1.668 raeburn 9051: $othertitle = &mt('Any users');
1.642 raeburn 9052: }
9053: my @types;
9054: if (ref($order) eq 'ARRAY') {
9055: @types = @{$order};
9056: }
9057: if (@types == 0) {
9058: if (ref($usertypes) eq 'HASH') {
9059: @types = sort(keys(%{$usertypes}));
9060: }
9061: }
9062: if (keys(%{$usertypes}) > 0) {
9063: $othertitle = &mt('Other users');
9064: }
9065: return ($othertitle,$usertypes,\@types);
9066: }
9067:
1.645 raeburn 9068: sub get_institutional_codes {
9069: my ($settings,$allcourses,$LC_code) = @_;
9070: # Get complete list of course sections to update
9071: my @currsections = ();
9072: my @currxlists = ();
9073: my $coursecode = $$settings{'internal.coursecode'};
9074:
9075: if ($$settings{'internal.sectionnums'} ne '') {
9076: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9077: }
9078:
9079: if ($$settings{'internal.crosslistings'} ne '') {
9080: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9081: }
9082:
9083: if (@currxlists > 0) {
9084: foreach (@currxlists) {
9085: if (m/^([^:]+):(\w*)$/) {
9086: unless (grep/^$1$/,@{$allcourses}) {
9087: push @{$allcourses},$1;
9088: $$LC_code{$1} = $2;
9089: }
9090: }
9091: }
9092: }
9093:
9094: if (@currsections > 0) {
9095: foreach (@currsections) {
9096: if (m/^(\w+):(\w*)$/) {
9097: my $sec = $coursecode.$1;
9098: my $lc_sec = $2;
9099: unless (grep/^$sec$/,@{$allcourses}) {
9100: push @{$allcourses},$sec;
9101: $$LC_code{$sec} = $lc_sec;
9102: }
9103: }
9104: }
9105: }
9106: return;
9107: }
9108:
1.971 raeburn 9109: sub get_standard_codeitems {
9110: return ('Year','Semester','Department','Number','Section');
9111: }
9112:
1.112 bowersj2 9113: =pod
9114:
1.780 raeburn 9115: =head1 Slot Helpers
9116:
9117: =over 4
9118:
9119: =item * sorted_slots()
9120:
1.1040 raeburn 9121: Sorts an array of slot names in order of an optional sort key,
9122: default sort is by slot start time (earliest first).
1.780 raeburn 9123:
9124: Inputs:
9125:
9126: =over 4
9127:
9128: slotsarr - Reference to array of unsorted slot names.
9129:
9130: slots - Reference to hash of hash, where outer hash keys are slot names.
9131:
1.1040 raeburn 9132: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9133:
1.549 albertel 9134: =back
9135:
1.780 raeburn 9136: Returns:
9137:
9138: =over 4
9139:
1.1040 raeburn 9140: sorted - An array of slot names sorted by a specified sort key
9141: (default sort key is start time of the slot).
1.780 raeburn 9142:
9143: =back
9144:
9145: =cut
9146:
9147:
9148: sub sorted_slots {
1.1040 raeburn 9149: my ($slotsarr,$slots,$sortkey) = @_;
9150: if ($sortkey eq '') {
9151: $sortkey = 'starttime';
9152: }
1.780 raeburn 9153: my @sorted;
9154: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9155: @sorted =
9156: sort {
9157: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9158: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9159: }
9160: if (ref($slots->{$a})) { return -1;}
9161: if (ref($slots->{$b})) { return 1;}
9162: return 0;
9163: } @{$slotsarr};
9164: }
9165: return @sorted;
9166: }
9167:
1.1040 raeburn 9168: =pod
9169:
9170: =item * get_future_slots()
9171:
9172: Inputs:
9173:
9174: =over 4
9175:
9176: cnum - course number
9177:
9178: cdom - course domain
9179:
9180: now - current UNIX time
9181:
9182: symb - optional symb
9183:
9184: =back
9185:
9186: Returns:
9187:
9188: =over 4
9189:
9190: sorted_reservable - ref to array of student_schedulable slots currently
9191: reservable, ordered by end date of reservation period.
9192:
9193: reservable_now - ref to hash of student_schedulable slots currently
9194: reservable.
9195:
9196: Keys in inner hash are:
9197: (a) symb: either blank or symb to which slot use is restricted.
9198: (b) endreserve: end date of reservation period.
9199:
9200: sorted_future - ref to array of student_schedulable slots reservable in
9201: the future, ordered by start date of reservation period.
9202:
9203: future_reservable - ref to hash of student_schedulable slots reservable
9204: in the future.
9205:
9206: Keys in inner hash are:
9207: (a) symb: either blank or symb to which slot use is restricted.
9208: (b) startreserve: start date of reservation period.
9209:
9210: =back
9211:
9212: =cut
9213:
9214: sub get_future_slots {
9215: my ($cnum,$cdom,$now,$symb) = @_;
9216: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9217: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9218: foreach my $slot (keys(%slots)) {
9219: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9220: if ($symb) {
9221: next if (($slots{$slot}->{'symb'} ne '') &&
9222: ($slots{$slot}->{'symb'} ne $symb));
9223: }
9224: if (($slots{$slot}->{'starttime'} > $now) &&
9225: ($slots{$slot}->{'endtime'} > $now)) {
9226: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9227: my $userallowed = 0;
9228: if ($slots{$slot}->{'allowedsections'}) {
9229: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9230: if (!defined($env{'request.role.sec'})
9231: && grep(/^No section assigned$/,@allowed_sec)) {
9232: $userallowed=1;
9233: } else {
9234: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9235: $userallowed=1;
9236: }
9237: }
9238: unless ($userallowed) {
9239: if (defined($env{'request.course.groups'})) {
9240: my @groups = split(/:/,$env{'request.course.groups'});
9241: foreach my $group (@groups) {
9242: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9243: $userallowed=1;
9244: last;
9245: }
9246: }
9247: }
9248: }
9249: }
9250: if ($slots{$slot}->{'allowedusers'}) {
9251: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9252: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9253: if (grep(/^\Q$user\E$/,@allowed_users)) {
9254: $userallowed = 1;
9255: }
9256: }
9257: next unless($userallowed);
9258: }
9259: my $startreserve = $slots{$slot}->{'startreserve'};
9260: my $endreserve = $slots{$slot}->{'endreserve'};
9261: my $symb = $slots{$slot}->{'symb'};
9262: if (($startreserve < $now) &&
9263: (!$endreserve || $endreserve > $now)) {
9264: my $lastres = $endreserve;
9265: if (!$lastres) {
9266: $lastres = $slots{$slot}->{'starttime'};
9267: }
9268: $reservable_now{$slot} = {
9269: symb => $symb,
9270: endreserve => $lastres
9271: };
9272: } elsif (($startreserve > $now) &&
9273: (!$endreserve || $endreserve > $startreserve)) {
9274: $future_reservable{$slot} = {
9275: symb => $symb,
9276: startreserve => $startreserve
9277: };
9278: }
9279: }
9280: }
9281: my @unsorted_reservable = keys(%reservable_now);
9282: if (@unsorted_reservable > 0) {
9283: @sorted_reservable =
9284: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9285: }
9286: my @unsorted_future = keys(%future_reservable);
9287: if (@unsorted_future > 0) {
9288: @sorted_future =
9289: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9290: }
9291: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9292: }
1.780 raeburn 9293:
9294: =pod
9295:
1.1057 foxr 9296: =back
9297:
1.549 albertel 9298: =head1 HTTP Helpers
9299:
9300: =over 4
9301:
1.648 raeburn 9302: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9303:
1.258 albertel 9304: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9305: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9306: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9307:
9308: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9309: $possible_names is an ref to an array of form element names. As an example:
9310: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9311: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9312:
9313: =cut
1.1 albertel 9314:
1.6 albertel 9315: sub get_unprocessed_cgi {
1.25 albertel 9316: my ($query,$possible_names)= @_;
1.26 matthew 9317: # $Apache::lonxml::debug=1;
1.356 albertel 9318: foreach my $pair (split(/&/,$query)) {
9319: my ($name, $value) = split(/=/,$pair);
1.369 www 9320: $name = &unescape($name);
1.25 albertel 9321: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9322: $value =~ tr/+/ /;
9323: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9324: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9325: }
1.16 harris41 9326: }
1.6 albertel 9327: }
9328:
1.112 bowersj2 9329: =pod
9330:
1.648 raeburn 9331: =item * &cacheheader()
1.112 bowersj2 9332:
9333: returns cache-controlling header code
9334:
9335: =cut
9336:
1.7 albertel 9337: sub cacheheader {
1.258 albertel 9338: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9339: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9340: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9341: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9342: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9343: return $output;
1.7 albertel 9344: }
9345:
1.112 bowersj2 9346: =pod
9347:
1.648 raeburn 9348: =item * &no_cache($r)
1.112 bowersj2 9349:
9350: specifies header code to not have cache
9351:
9352: =cut
9353:
1.9 albertel 9354: sub no_cache {
1.216 albertel 9355: my ($r) = @_;
9356: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9357: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9358: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9359: $r->no_cache(1);
9360: $r->header_out("Expires" => $date);
9361: $r->header_out("Pragma" => "no-cache");
1.123 www 9362: }
9363:
9364: sub content_type {
1.181 albertel 9365: my ($r,$type,$charset) = @_;
1.299 foxr 9366: if ($r) {
9367: # Note that printout.pl calls this with undef for $r.
9368: &no_cache($r);
9369: }
1.258 albertel 9370: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9371: unless ($charset) {
9372: $charset=&Apache::lonlocal::current_encoding;
9373: }
9374: if ($charset) { $type.='; charset='.$charset; }
9375: if ($r) {
9376: $r->content_type($type);
9377: } else {
9378: print("Content-type: $type\n\n");
9379: }
1.9 albertel 9380: }
1.25 albertel 9381:
1.112 bowersj2 9382: =pod
9383:
1.648 raeburn 9384: =item * &add_to_env($name,$value)
1.112 bowersj2 9385:
1.258 albertel 9386: adds $name to the %env hash with value
1.112 bowersj2 9387: $value, if $name already exists, the entry is converted to an array
9388: reference and $value is added to the array.
9389:
9390: =cut
9391:
1.25 albertel 9392: sub add_to_env {
9393: my ($name,$value)=@_;
1.258 albertel 9394: if (defined($env{$name})) {
9395: if (ref($env{$name})) {
1.25 albertel 9396: #already have multiple values
1.258 albertel 9397: push(@{ $env{$name} },$value);
1.25 albertel 9398: } else {
9399: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9400: my $first=$env{$name};
9401: undef($env{$name});
9402: push(@{ $env{$name} },$first,$value);
1.25 albertel 9403: }
9404: } else {
1.258 albertel 9405: $env{$name}=$value;
1.25 albertel 9406: }
1.31 albertel 9407: }
1.149 albertel 9408:
9409: =pod
9410:
1.648 raeburn 9411: =item * &get_env_multiple($name)
1.149 albertel 9412:
1.258 albertel 9413: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9414: values may be defined and end up as an array ref.
9415:
9416: returns an array of values
9417:
9418: =cut
9419:
9420: sub get_env_multiple {
9421: my ($name) = @_;
9422: my @values;
1.258 albertel 9423: if (defined($env{$name})) {
1.149 albertel 9424: # exists is it an array
1.258 albertel 9425: if (ref($env{$name})) {
9426: @values=@{ $env{$name} };
1.149 albertel 9427: } else {
1.258 albertel 9428: $values[0]=$env{$name};
1.149 albertel 9429: }
9430: }
9431: return(@values);
9432: }
9433:
1.660 raeburn 9434: sub ask_for_embedded_content {
9435: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9436: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 9437: %currsubfile,%unused,$rem);
1.1071 raeburn 9438: my $counter = 0;
9439: my $numnew = 0;
1.987 raeburn 9440: my $numremref = 0;
9441: my $numinvalid = 0;
9442: my $numpathchg = 0;
9443: my $numexisting = 0;
1.1071 raeburn 9444: my $numunused = 0;
9445: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9446: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9447: my $heading = &mt('Upload embedded files');
9448: my $buttontext = &mt('Upload');
9449:
1.1085 raeburn 9450: my $navmap;
9451: if ($env{'request.course.id'}) {
9452: $navmap = Apache::lonnavmaps::navmap->new();
9453: }
1.984 raeburn 9454: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9455: my $current_path='/';
9456: if ($env{'form.currentpath'}) {
9457: $current_path = $env{'form.currentpath'};
9458: }
9459: if ($actionurl eq '/adm/coursegrp_portfolio') {
9460: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9461: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9462: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9463: } else {
9464: $udom = $env{'user.domain'};
9465: $uname = $env{'user.name'};
9466: $url = '/userfiles/portfolio';
9467: }
1.987 raeburn 9468: $toplevel = $url.'/';
1.984 raeburn 9469: $url .= $current_path;
9470: $getpropath = 1;
1.987 raeburn 9471: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9472: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9473: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9474: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9475: $toplevel = $url;
1.984 raeburn 9476: if ($rest ne '') {
1.987 raeburn 9477: $url .= $rest;
9478: }
9479: } elsif ($actionurl eq '/adm/coursedocs') {
9480: if (ref($args) eq 'HASH') {
1.1071 raeburn 9481: $url = $args->{'docs_url'};
9482: $toplevel = $url;
1.1084 raeburn 9483: if ($args->{'context'} eq 'paste') {
9484: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9485: ($path) =
9486: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9487: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9488: $fileloc =~ s{^/}{};
9489: }
1.1071 raeburn 9490: }
1.1084 raeburn 9491: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 9492: if ($env{'request.course.id'} ne '') {
9493: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9494: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9495: if (ref($args) eq 'HASH') {
9496: $url = $args->{'docs_url'};
9497: $title = $args->{'docs_title'};
9498: $toplevel = "/$url";
1.1085 raeburn 9499: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1071 raeburn 9500: ($path) =
9501: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9502: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9503: $fileloc =~ s{^/}{};
9504: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9505: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9506: }
1.987 raeburn 9507: }
9508: }
9509: my $now = time();
9510: foreach my $embed_file (keys(%{$allfiles})) {
9511: my $absolutepath;
9512: if ($embed_file =~ m{^\w+://}) {
9513: $newfiles{$embed_file} = 1;
9514: $mapping{$embed_file} = $embed_file;
9515: } else {
9516: if ($embed_file =~ m{^/}) {
9517: $absolutepath = $embed_file;
9518: $embed_file =~ s{^(/+)}{};
9519: }
9520: if ($embed_file =~ m{/}) {
9521: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9522: $path = &check_for_traversal($path,$url,$toplevel);
9523: my $item = $fname;
9524: if ($path ne '') {
9525: $item = $path.'/'.$fname;
9526: $subdependencies{$path}{$fname} = 1;
9527: } else {
9528: $dependencies{$item} = 1;
9529: }
9530: if ($absolutepath) {
9531: $mapping{$item} = $absolutepath;
9532: } else {
9533: $mapping{$item} = $embed_file;
9534: }
9535: } else {
9536: $dependencies{$embed_file} = 1;
9537: if ($absolutepath) {
9538: $mapping{$embed_file} = $absolutepath;
9539: } else {
9540: $mapping{$embed_file} = $embed_file;
9541: }
9542: }
1.984 raeburn 9543: }
9544: }
1.1071 raeburn 9545: my $dirptr = 16384;
1.984 raeburn 9546: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9547: $currsubfile{$path} = {};
1.984 raeburn 9548: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9549: my ($sublistref,$listerror) =
9550: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9551: if (ref($sublistref) eq 'ARRAY') {
9552: foreach my $line (@{$sublistref}) {
9553: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9554: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9555: }
1.984 raeburn 9556: }
1.987 raeburn 9557: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9558: if (opendir(my $dir,$url.'/'.$path)) {
9559: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9560: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9561: }
1.1084 raeburn 9562: } elsif (($actionurl eq '/adm/dependencies') ||
9563: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9564: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9565: if ($env{'request.course.id'} ne '') {
9566: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9567: if ($dir ne '') {
9568: my ($sublistref,$listerror) =
9569: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9570: if (ref($sublistref) eq 'ARRAY') {
9571: foreach my $line (@{$sublistref}) {
9572: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9573: undef,$mtime)=split(/\&/,$line,12);
9574: unless (($testdir&$dirptr) ||
9575: ($file_name =~ /^\.\.?$/)) {
9576: $currsubfile{$path}{$file_name} = [$size,$mtime];
9577: }
9578: }
9579: }
9580: }
1.984 raeburn 9581: }
9582: }
9583: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9584: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9585: my $item = $path.'/'.$file;
9586: unless ($mapping{$item} eq $item) {
9587: $pathchanges{$item} = 1;
9588: }
9589: $existing{$item} = 1;
9590: $numexisting ++;
9591: } else {
9592: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9593: }
9594: }
1.1071 raeburn 9595: if ($actionurl eq '/adm/dependencies') {
9596: foreach my $path (keys(%currsubfile)) {
9597: if (ref($currsubfile{$path}) eq 'HASH') {
9598: foreach my $file (keys(%{$currsubfile{$path}})) {
9599: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 9600: next if (($rem ne '') &&
9601: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9602: (ref($navmap) &&
9603: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9604: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9605: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9606: $unused{$path.'/'.$file} = 1;
9607: }
9608: }
9609: }
9610: }
9611: }
1.984 raeburn 9612: }
1.987 raeburn 9613: my %currfile;
1.984 raeburn 9614: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9615: my ($dirlistref,$listerror) =
9616: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9617: if (ref($dirlistref) eq 'ARRAY') {
9618: foreach my $line (@{$dirlistref}) {
9619: my ($file_name,$rest) = split(/\&/,$line,2);
9620: $currfile{$file_name} = 1;
9621: }
1.984 raeburn 9622: }
1.987 raeburn 9623: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9624: if (opendir(my $dir,$url)) {
1.987 raeburn 9625: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9626: map {$currfile{$_} = 1;} @dir_list;
9627: }
1.1084 raeburn 9628: } elsif (($actionurl eq '/adm/dependencies') ||
9629: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9630: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9631: if ($env{'request.course.id'} ne '') {
9632: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9633: if ($dir ne '') {
9634: my ($dirlistref,$listerror) =
9635: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9636: if (ref($dirlistref) eq 'ARRAY') {
9637: foreach my $line (@{$dirlistref}) {
9638: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9639: $size,undef,$mtime)=split(/\&/,$line,12);
9640: unless (($testdir&$dirptr) ||
9641: ($file_name =~ /^\.\.?$/)) {
9642: $currfile{$file_name} = [$size,$mtime];
9643: }
9644: }
9645: }
9646: }
9647: }
1.984 raeburn 9648: }
9649: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9650: if (exists($currfile{$file})) {
1.987 raeburn 9651: unless ($mapping{$file} eq $file) {
9652: $pathchanges{$file} = 1;
9653: }
9654: $existing{$file} = 1;
9655: $numexisting ++;
9656: } else {
1.984 raeburn 9657: $newfiles{$file} = 1;
9658: }
9659: }
1.1071 raeburn 9660: foreach my $file (keys(%currfile)) {
9661: unless (($file eq $filename) ||
9662: ($file eq $filename.'.bak') ||
9663: ($dependencies{$file})) {
1.1085 raeburn 9664: if ($actionurl eq '/adm/dependencies') {
9665: next if (($rem ne '') &&
9666: (($env{"httpref.$rem".$file} ne '') ||
9667: (ref($navmap) &&
9668: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9669: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9670: ($navmap->getResourceByUrl($rem.$1)))))));
9671: }
1.1071 raeburn 9672: $unused{$file} = 1;
9673: }
9674: }
1.1084 raeburn 9675: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9676: ($args->{'context'} eq 'paste')) {
9677: $counter = scalar(keys(%existing));
9678: $numpathchg = scalar(keys(%pathchanges));
9679: return ($output,$counter,$numpathchg,\%existing);
9680: }
1.984 raeburn 9681: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9682: if ($actionurl eq '/adm/dependencies') {
9683: next if ($embed_file =~ m{^\w+://});
9684: }
1.660 raeburn 9685: $upload_output .= &start_data_table_row().
1.1071 raeburn 9686: '<td><img src="'.&icon($embed_file).'" /> '.
9687: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9688: unless ($mapping{$embed_file} eq $embed_file) {
9689: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9690: }
9691: $upload_output .= '</td><td>';
1.1071 raeburn 9692: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9693: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9694: $numremref++;
1.660 raeburn 9695: } elsif ($args->{'error_on_invalid_names'}
9696: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.987 raeburn 9697: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9698: $numinvalid++;
1.660 raeburn 9699: } else {
1.1071 raeburn 9700: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9701: $embed_file,\%mapping,
1.1071 raeburn 9702: $allfiles,$codebase,'upload');
9703: $counter ++;
9704: $numnew ++;
1.987 raeburn 9705: }
9706: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9707: }
9708: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9709: if ($actionurl eq '/adm/dependencies') {
9710: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9711: $modify_output .= &start_data_table_row().
9712: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9713: '<img src="'.&icon($embed_file).'" border="0" />'.
9714: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9715: '<td>'.$size.'</td>'.
9716: '<td>'.$mtime.'</td>'.
9717: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9718: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9719: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9720: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9721: &embedded_file_element('upload_embedded',$counter,
9722: $embed_file,\%mapping,
9723: $allfiles,$codebase,'modify').
9724: '</div></td>'.
9725: &end_data_table_row()."\n";
9726: $counter ++;
9727: } else {
9728: $upload_output .= &start_data_table_row().
9729: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9730: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9731: &Apache::loncommon::end_data_table_row()."\n";
9732: }
9733: }
9734: my $delidx = $counter;
9735: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9736: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9737: $delete_output .= &start_data_table_row().
9738: '<td><img src="'.&icon($oldfile).'" />'.
9739: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9740: '<td>'.$size.'</td>'.
9741: '<td>'.$mtime.'</td>'.
9742: '<td><label><input type="checkbox" name="del_upload_dep" '.
9743: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9744: &embedded_file_element('upload_embedded',$delidx,
9745: $oldfile,\%mapping,$allfiles,
9746: $codebase,'delete').'</td>'.
9747: &end_data_table_row()."\n";
9748: $numunused ++;
9749: $delidx ++;
1.987 raeburn 9750: }
9751: if ($upload_output) {
9752: $upload_output = &start_data_table().
9753: $upload_output.
9754: &end_data_table()."\n";
9755: }
1.1071 raeburn 9756: if ($modify_output) {
9757: $modify_output = &start_data_table().
9758: &start_data_table_header_row().
9759: '<th>'.&mt('File').'</th>'.
9760: '<th>'.&mt('Size (KB)').'</th>'.
9761: '<th>'.&mt('Modified').'</th>'.
9762: '<th>'.&mt('Upload replacement?').'</th>'.
9763: &end_data_table_header_row().
9764: $modify_output.
9765: &end_data_table()."\n";
9766: }
9767: if ($delete_output) {
9768: $delete_output = &start_data_table().
9769: &start_data_table_header_row().
9770: '<th>'.&mt('File').'</th>'.
9771: '<th>'.&mt('Size (KB)').'</th>'.
9772: '<th>'.&mt('Modified').'</th>'.
9773: '<th>'.&mt('Delete?').'</th>'.
9774: &end_data_table_header_row().
9775: $delete_output.
9776: &end_data_table()."\n";
9777: }
1.987 raeburn 9778: my $applies = 0;
9779: if ($numremref) {
9780: $applies ++;
9781: }
9782: if ($numinvalid) {
9783: $applies ++;
9784: }
9785: if ($numexisting) {
9786: $applies ++;
9787: }
1.1071 raeburn 9788: if ($counter || $numunused) {
1.987 raeburn 9789: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9790: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9791: $state.'<h3>'.$heading.'</h3>';
9792: if ($actionurl eq '/adm/dependencies') {
9793: if ($numnew) {
9794: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9795: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9796: $upload_output.'<br />'."\n";
9797: }
9798: if ($numexisting) {
9799: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9800: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9801: $modify_output.'<br />'."\n";
9802: $buttontext = &mt('Save changes');
9803: }
9804: if ($numunused) {
9805: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9806: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9807: $delete_output.'<br />'."\n";
9808: $buttontext = &mt('Save changes');
9809: }
9810: } else {
9811: $output .= $upload_output.'<br />'."\n";
9812: }
9813: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9814: $counter.'" />'."\n";
9815: if ($actionurl eq '/adm/dependencies') {
9816: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9817: $numnew.'" />'."\n";
9818: } elsif ($actionurl eq '') {
1.987 raeburn 9819: $output .= '<input type="hidden" name="phase" value="three" />';
9820: }
9821: } elsif ($applies) {
9822: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9823: if ($applies > 1) {
9824: $output .=
9825: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9826: if ($numremref) {
9827: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9828: }
9829: if ($numinvalid) {
9830: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9831: }
9832: if ($numexisting) {
9833: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9834: }
9835: $output .= '</ul><br />';
9836: } elsif ($numremref) {
9837: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9838: } elsif ($numinvalid) {
9839: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9840: } elsif ($numexisting) {
9841: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9842: }
9843: $output .= $upload_output.'<br />';
9844: }
9845: my ($pathchange_output,$chgcount);
1.1071 raeburn 9846: $chgcount = $counter;
1.987 raeburn 9847: if (keys(%pathchanges) > 0) {
9848: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9849: if ($counter) {
1.987 raeburn 9850: $output .= &embedded_file_element('pathchange',$chgcount,
9851: $embed_file,\%mapping,
1.1071 raeburn 9852: $allfiles,$codebase,'change');
1.987 raeburn 9853: } else {
9854: $pathchange_output .=
9855: &start_data_table_row().
9856: '<td><input type ="checkbox" name="namechange" value="'.
9857: $chgcount.'" checked="checked" /></td>'.
9858: '<td>'.$mapping{$embed_file}.'</td>'.
9859: '<td>'.$embed_file.
9860: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9861: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9862: '</td>'.&end_data_table_row();
1.660 raeburn 9863: }
1.987 raeburn 9864: $numpathchg ++;
9865: $chgcount ++;
1.660 raeburn 9866: }
9867: }
1.1071 raeburn 9868: if ($counter) {
1.987 raeburn 9869: if ($numpathchg) {
9870: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9871: $numpathchg.'" />'."\n";
9872: }
9873: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9874: ($actionurl eq '/adm/imsimport')) {
9875: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9876: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9877: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9878: } elsif ($actionurl eq '/adm/dependencies') {
9879: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9880: }
1.1071 raeburn 9881: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9882: } elsif ($numpathchg) {
9883: my %pathchange = ();
9884: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9885: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9886: $output .= '<p>'.&mt('or').'</p>';
9887: }
9888: }
1.1071 raeburn 9889: return ($output,$counter,$numpathchg);
1.987 raeburn 9890: }
9891:
9892: sub embedded_file_element {
1.1071 raeburn 9893: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9894: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9895: (ref($codebase) eq 'HASH'));
9896: my $output;
1.1071 raeburn 9897: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9898: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9899: }
9900: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9901: &escape($embed_file).'" />';
9902: unless (($context eq 'upload_embedded') &&
9903: ($mapping->{$embed_file} eq $embed_file)) {
9904: $output .='
9905: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9906: }
9907: my $attrib;
9908: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9909: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9910: }
9911: $output .=
9912: "\n\t\t".
9913: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9914: $attrib.'" />';
9915: if (exists($codebase->{$mapping->{$embed_file}})) {
9916: $output .=
9917: "\n\t\t".
9918: '<input name="codebase_'.$num.'" type="hidden" value="'.
9919: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9920: }
1.987 raeburn 9921: return $output;
1.660 raeburn 9922: }
9923:
1.1071 raeburn 9924: sub get_dependency_details {
9925: my ($currfile,$currsubfile,$embed_file) = @_;
9926: my ($size,$mtime,$showsize,$showmtime);
9927: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9928: if ($embed_file =~ m{/}) {
9929: my ($path,$fname) = split(/\//,$embed_file);
9930: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9931: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9932: }
9933: } else {
9934: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9935: ($size,$mtime) = @{$currfile->{$embed_file}};
9936: }
9937: }
9938: $showsize = $size/1024.0;
9939: $showsize = sprintf("%.1f",$showsize);
9940: if ($mtime > 0) {
9941: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9942: }
9943: }
9944: return ($showsize,$showmtime);
9945: }
9946:
9947: sub ask_embedded_js {
9948: return <<"END";
9949: <script type="text/javascript"">
9950: // <![CDATA[
9951: function toggleBrowse(counter) {
9952: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9953: var fileid = document.getElementById('embedded_item_'+counter);
9954: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9955: if (chkboxid.checked == true) {
9956: uploaddivid.style.display='block';
9957: } else {
9958: uploaddivid.style.display='none';
9959: fileid.value = '';
9960: }
9961: }
9962: // ]]>
9963: </script>
9964:
9965: END
9966: }
9967:
1.661 raeburn 9968: sub upload_embedded {
9969: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9970: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9971: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9972: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9973: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9974: my $orig_uploaded_filename =
9975: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9976: foreach my $type ('orig','ref','attrib','codebase') {
9977: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9978: $env{'form.embedded_'.$type.'_'.$i} =
9979: &unescape($env{'form.embedded_'.$type.'_'.$i});
9980: }
9981: }
1.661 raeburn 9982: my ($path,$fname) =
9983: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9984: # no path, whole string is fname
9985: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9986: $fname = &Apache::lonnet::clean_filename($fname);
9987: # See if there is anything left
9988: next if ($fname eq '');
9989:
9990: # Check if file already exists as a file or directory.
9991: my ($state,$msg);
9992: if ($context eq 'portfolio') {
9993: my $port_path = $dirpath;
9994: if ($group ne '') {
9995: $port_path = "groups/$group/$port_path";
9996: }
1.987 raeburn 9997: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9998: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9999: $dir_root,$port_path,$disk_quota,
10000: $current_disk_usage,$uname,$udom);
10001: if ($state eq 'will_exceed_quota'
1.984 raeburn 10002: || $state eq 'file_locked') {
1.661 raeburn 10003: $output .= $msg;
10004: next;
10005: }
10006: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10007: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10008: if ($state eq 'exists') {
10009: $output .= $msg;
10010: next;
10011: }
10012: }
10013: # Check if extension is valid
10014: if (($fname =~ /\.(\w+)$/) &&
10015: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10016: $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 10017: next;
10018: } elsif (($fname =~ /\.(\w+)$/) &&
10019: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10020: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10021: next;
10022: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 10023: $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 10024: next;
10025: }
10026: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
10027: if ($context eq 'portfolio') {
1.984 raeburn 10028: my $result;
10029: if ($state eq 'existingfile') {
10030: $result=
10031: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 10032: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 10033: } else {
1.984 raeburn 10034: $result=
10035: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10036: $dirpath.
10037: $env{'form.currentpath'}.$path);
1.984 raeburn 10038: if ($result !~ m|^/uploaded/|) {
10039: $output .= '<span class="LC_error">'
10040: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10041: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10042: .'</span><br />';
10043: next;
10044: } else {
1.987 raeburn 10045: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10046: $path.$fname.'</span>').'<br />';
1.984 raeburn 10047: }
1.661 raeburn 10048: }
1.987 raeburn 10049: } elsif ($context eq 'coursedoc') {
10050: my $result =
10051: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
10052: $dirpath.'/'.$path);
10053: if ($result !~ m|^/uploaded/|) {
10054: $output .= '<span class="LC_error">'
10055: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10056: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10057: .'</span><br />';
10058: next;
10059: } else {
10060: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10061: $path.$fname.'</span>').'<br />';
10062: }
1.661 raeburn 10063: } else {
10064: # Save the file
10065: my $target = $env{'form.embedded_item_'.$i};
10066: my $fullpath = $dir_root.$dirpath.'/'.$path;
10067: my $dest = $fullpath.$fname;
10068: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10069: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10070: my $count;
10071: my $filepath = $dir_root;
1.1027 raeburn 10072: foreach my $subdir (@parts) {
10073: $filepath .= "/$subdir";
10074: if (!-e $filepath) {
1.661 raeburn 10075: mkdir($filepath,0770);
10076: }
10077: }
10078: my $fh;
10079: if (!open($fh,'>'.$dest)) {
10080: &Apache::lonnet::logthis('Failed to create '.$dest);
10081: $output .= '<span class="LC_error">'.
1.1071 raeburn 10082: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10083: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10084: '</span><br />';
10085: } else {
10086: if (!print $fh $env{'form.embedded_item_'.$i}) {
10087: &Apache::lonnet::logthis('Failed to write to '.$dest);
10088: $output .= '<span class="LC_error">'.
1.1071 raeburn 10089: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10090: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10091: '</span><br />';
10092: } else {
1.987 raeburn 10093: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10094: $url.'</span>').'<br />';
10095: unless ($context eq 'testbank') {
10096: $footer .= &mt('View embedded file: [_1]',
10097: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10098: }
10099: }
10100: close($fh);
10101: }
10102: }
10103: if ($env{'form.embedded_ref_'.$i}) {
10104: $pathchange{$i} = 1;
10105: }
10106: }
10107: if ($output) {
10108: $output = '<p>'.$output.'</p>';
10109: }
10110: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10111: $returnflag = 'ok';
1.1071 raeburn 10112: my $numpathchgs = scalar(keys(%pathchange));
10113: if ($numpathchgs > 0) {
1.987 raeburn 10114: if ($context eq 'portfolio') {
10115: $output .= '<p>'.&mt('or').'</p>';
10116: } elsif ($context eq 'testbank') {
1.1071 raeburn 10117: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10118: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10119: $returnflag = 'modify_orightml';
10120: }
10121: }
1.1071 raeburn 10122: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10123: }
10124:
10125: sub modify_html_form {
10126: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10127: my $end = 0;
10128: my $modifyform;
10129: if ($context eq 'upload_embedded') {
10130: return unless (ref($pathchange) eq 'HASH');
10131: if ($env{'form.number_embedded_items'}) {
10132: $end += $env{'form.number_embedded_items'};
10133: }
10134: if ($env{'form.number_pathchange_items'}) {
10135: $end += $env{'form.number_pathchange_items'};
10136: }
10137: if ($end) {
10138: for (my $i=0; $i<$end; $i++) {
10139: if ($i < $env{'form.number_embedded_items'}) {
10140: next unless($pathchange->{$i});
10141: }
10142: $modifyform .=
10143: &start_data_table_row().
10144: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10145: 'checked="checked" /></td>'.
10146: '<td>'.$env{'form.embedded_ref_'.$i}.
10147: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10148: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10149: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10150: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10151: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10152: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10153: '<td>'.$env{'form.embedded_orig_'.$i}.
10154: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10155: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10156: &end_data_table_row();
1.1071 raeburn 10157: }
1.987 raeburn 10158: }
10159: } else {
10160: $modifyform = $pathchgtable;
10161: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10162: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10163: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10164: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10165: }
10166: }
10167: if ($modifyform) {
1.1071 raeburn 10168: if ($actionurl eq '/adm/dependencies') {
10169: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10170: }
1.987 raeburn 10171: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10172: '<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".
10173: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10174: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10175: '</ol></p>'."\n".'<p>'.
10176: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10177: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10178: &start_data_table()."\n".
10179: &start_data_table_header_row().
10180: '<th>'.&mt('Change?').'</th>'.
10181: '<th>'.&mt('Current reference').'</th>'.
10182: '<th>'.&mt('Required reference').'</th>'.
10183: &end_data_table_header_row()."\n".
10184: $modifyform.
10185: &end_data_table().'<br />'."\n".$hiddenstate.
10186: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10187: '</form>'."\n";
10188: }
10189: return;
10190: }
10191:
10192: sub modify_html_refs {
10193: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10194: my $container;
10195: if ($context eq 'portfolio') {
10196: $container = $env{'form.container'};
10197: } elsif ($context eq 'coursedoc') {
10198: $container = $env{'form.primaryurl'};
1.1071 raeburn 10199: } elsif ($context eq 'manage_dependencies') {
10200: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10201: $container = "/$container";
1.987 raeburn 10202: } else {
1.1027 raeburn 10203: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10204: }
10205: my (%allfiles,%codebase,$output,$content);
10206: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10207: unless (@changes > 0) {
10208: if (wantarray) {
10209: return ('',0,0);
10210: } else {
10211: return;
10212: }
10213: }
10214: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10215: ($context eq 'manage_dependencies')) {
10216: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10217: if (wantarray) {
10218: return ('',0,0);
10219: } else {
10220: return;
10221: }
10222: }
1.987 raeburn 10223: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10224: if ($content eq '-1') {
10225: if (wantarray) {
10226: return ('',0,0);
10227: } else {
10228: return;
10229: }
10230: }
1.987 raeburn 10231: } else {
1.1071 raeburn 10232: unless ($container =~ /^\Q$dir_root\E/) {
10233: if (wantarray) {
10234: return ('',0,0);
10235: } else {
10236: return;
10237: }
10238: }
1.987 raeburn 10239: if (open(my $fh,"<$container")) {
10240: $content = join('', <$fh>);
10241: close($fh);
10242: } else {
1.1071 raeburn 10243: if (wantarray) {
10244: return ('',0,0);
10245: } else {
10246: return;
10247: }
1.987 raeburn 10248: }
10249: }
10250: my ($count,$codebasecount) = (0,0);
10251: my $mm = new File::MMagic;
10252: my $mime_type = $mm->checktype_contents($content);
10253: if ($mime_type eq 'text/html') {
10254: my $parse_result =
10255: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10256: \%codebase,\$content);
10257: if ($parse_result eq 'ok') {
10258: foreach my $i (@changes) {
10259: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10260: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10261: if ($allfiles{$ref}) {
10262: my $newname = $orig;
10263: my ($attrib_regexp,$codebase);
1.1006 raeburn 10264: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10265: if ($attrib_regexp =~ /:/) {
10266: $attrib_regexp =~ s/\:/|/g;
10267: }
10268: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10269: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10270: $count += $numchg;
10271: }
10272: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10273: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10274: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10275: $codebasecount ++;
10276: }
10277: }
10278: }
10279: if ($count || $codebasecount) {
10280: my $saveresult;
1.1071 raeburn 10281: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10282: ($context eq 'manage_dependencies')) {
1.987 raeburn 10283: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10284: if ($url eq $container) {
10285: my ($fname) = ($container =~ m{/([^/]+)$});
10286: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10287: $count,'<span class="LC_filename">'.
1.1071 raeburn 10288: $fname.'</span>').'</p>';
1.987 raeburn 10289: } else {
10290: $output = '<p class="LC_error">'.
10291: &mt('Error: update failed for: [_1].',
10292: '<span class="LC_filename">'.
10293: $container.'</span>').'</p>';
10294: }
10295: } else {
10296: if (open(my $fh,">$container")) {
10297: print $fh $content;
10298: close($fh);
10299: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10300: $count,'<span class="LC_filename">'.
10301: $container.'</span>').'</p>';
1.661 raeburn 10302: } else {
1.987 raeburn 10303: $output = '<p class="LC_error">'.
10304: &mt('Error: could not update [_1].',
10305: '<span class="LC_filename">'.
10306: $container.'</span>').'</p>';
1.661 raeburn 10307: }
10308: }
10309: }
1.987 raeburn 10310: } else {
10311: &logthis('Failed to parse '.$container.
10312: ' to modify references: '.$parse_result);
1.661 raeburn 10313: }
10314: }
1.1071 raeburn 10315: if (wantarray) {
10316: return ($output,$count,$codebasecount);
10317: } else {
10318: return $output;
10319: }
1.661 raeburn 10320: }
10321:
10322: sub check_for_existing {
10323: my ($path,$fname,$element) = @_;
10324: my ($state,$msg);
10325: if (-d $path.'/'.$fname) {
10326: $state = 'exists';
10327: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10328: } elsif (-e $path.'/'.$fname) {
10329: $state = 'exists';
10330: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10331: }
10332: if ($state eq 'exists') {
10333: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10334: }
10335: return ($state,$msg);
10336: }
10337:
10338: sub check_for_upload {
10339: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10340: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10341: my $filesize = length($env{'form.'.$element});
10342: if (!$filesize) {
10343: my $msg = '<span class="LC_error">'.
10344: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10345: '<span class="LC_filename">'.$fname.'</span>',
10346: $filesize).'<br />'.
1.1007 raeburn 10347: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10348: '</span>';
10349: return ('zero_bytes',$msg);
10350: }
10351: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10352: my $getpropath = 1;
1.1021 raeburn 10353: my ($dirlistref,$listerror) =
10354: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10355: my $found_file = 0;
10356: my $locked_file = 0;
1.991 raeburn 10357: my @lockers;
10358: my $navmap;
10359: if ($env{'request.course.id'}) {
10360: $navmap = Apache::lonnavmaps::navmap->new();
10361: }
1.1021 raeburn 10362: if (ref($dirlistref) eq 'ARRAY') {
10363: foreach my $line (@{$dirlistref}) {
10364: my ($file_name,$rest)=split(/\&/,$line,2);
10365: if ($file_name eq $fname){
10366: $file_name = $path.$file_name;
10367: if ($group ne '') {
10368: $file_name = $group.$file_name;
10369: }
10370: $found_file = 1;
10371: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10372: foreach my $lock (@lockers) {
10373: if (ref($lock) eq 'ARRAY') {
10374: my ($symb,$crsid) = @{$lock};
10375: if ($crsid eq $env{'request.course.id'}) {
10376: if (ref($navmap)) {
10377: my $res = $navmap->getBySymb($symb);
10378: foreach my $part (@{$res->parts()}) {
10379: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10380: unless (($slot_status == $res->RESERVED) ||
10381: ($slot_status == $res->RESERVED_LOCATION)) {
10382: $locked_file = 1;
10383: }
1.991 raeburn 10384: }
1.1021 raeburn 10385: } else {
10386: $locked_file = 1;
1.991 raeburn 10387: }
10388: } else {
10389: $locked_file = 1;
10390: }
10391: }
1.1021 raeburn 10392: }
10393: } else {
10394: my @info = split(/\&/,$rest);
10395: my $currsize = $info[6]/1000;
10396: if ($currsize < $filesize) {
10397: my $extra = $filesize - $currsize;
10398: if (($current_disk_usage + $extra) > $disk_quota) {
10399: my $msg = '<span class="LC_error">'.
10400: &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.',
10401: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10402: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10403: $disk_quota,$current_disk_usage);
10404: return ('will_exceed_quota',$msg);
10405: }
1.984 raeburn 10406: }
10407: }
1.661 raeburn 10408: }
10409: }
10410: }
10411: if (($current_disk_usage + $filesize) > $disk_quota){
10412: my $msg = '<span class="LC_error">'.
10413: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10414: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10415: return ('will_exceed_quota',$msg);
10416: } elsif ($found_file) {
10417: if ($locked_file) {
10418: my $msg = '<span class="LC_error">';
10419: $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>');
10420: $msg .= '</span><br />';
10421: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10422: return ('file_locked',$msg);
10423: } else {
10424: my $msg = '<span class="LC_error">';
1.984 raeburn 10425: $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 10426: $msg .= '</span>';
1.984 raeburn 10427: return ('existingfile',$msg);
1.661 raeburn 10428: }
10429: }
10430: }
10431:
1.987 raeburn 10432: sub check_for_traversal {
10433: my ($path,$url,$toplevel) = @_;
10434: my @parts=split(/\//,$path);
10435: my $cleanpath;
10436: my $fullpath = $url;
10437: for (my $i=0;$i<@parts;$i++) {
10438: next if ($parts[$i] eq '.');
10439: if ($parts[$i] eq '..') {
10440: $fullpath =~ s{([^/]+/)$}{};
10441: } else {
10442: $fullpath .= $parts[$i].'/';
10443: }
10444: }
10445: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10446: $cleanpath = $1;
10447: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10448: my $curr_toprel = $1;
10449: my @parts = split(/\//,$curr_toprel);
10450: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10451: my @urlparts = split(/\//,$url_toprel);
10452: my $doubledots;
10453: my $startdiff = -1;
10454: for (my $i=0; $i<@urlparts; $i++) {
10455: if ($startdiff == -1) {
10456: unless ($urlparts[$i] eq $parts[$i]) {
10457: $startdiff = $i;
10458: $doubledots .= '../';
10459: }
10460: } else {
10461: $doubledots .= '../';
10462: }
10463: }
10464: if ($startdiff > -1) {
10465: $cleanpath = $doubledots;
10466: for (my $i=$startdiff; $i<@parts; $i++) {
10467: $cleanpath .= $parts[$i].'/';
10468: }
10469: }
10470: }
10471: $cleanpath =~ s{(/)$}{};
10472: return $cleanpath;
10473: }
1.31 albertel 10474:
1.1053 raeburn 10475: sub is_archive_file {
10476: my ($mimetype) = @_;
10477: if (($mimetype eq 'application/octet-stream') ||
10478: ($mimetype eq 'application/x-stuffit') ||
10479: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10480: return 1;
10481: }
10482: return;
10483: }
10484:
10485: sub decompress_form {
1.1065 raeburn 10486: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10487: my %lt = &Apache::lonlocal::texthash (
10488: this => 'This file is an archive file.',
1.1067 raeburn 10489: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10490: itsc => 'Its contents are as follows:',
1.1053 raeburn 10491: youm => 'You may wish to extract its contents.',
10492: extr => 'Extract contents',
1.1067 raeburn 10493: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10494: proa => 'Process automatically?',
1.1053 raeburn 10495: yes => 'Yes',
10496: no => 'No',
1.1067 raeburn 10497: fold => 'Title for folder containing movie',
10498: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10499: );
1.1065 raeburn 10500: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10501: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10502: my $info = &list_archive_contents($fileloc,\@paths);
10503: if (@paths) {
10504: foreach my $path (@paths) {
10505: $path =~ s{^/}{};
1.1067 raeburn 10506: if ($path =~ m{^([^/]+)/$}) {
10507: $topdir = $1;
10508: }
1.1065 raeburn 10509: if ($path =~ m{^([^/]+)/}) {
10510: $toplevel{$1} = $path;
10511: } else {
10512: $toplevel{$path} = $path;
10513: }
10514: }
10515: }
1.1067 raeburn 10516: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10517: my @camtasia = ("$topdir/","$topdir/index.html",
10518: "$topdir/media/",
10519: "$topdir/media/$topdir.mp4",
10520: "$topdir/media/FirstFrame.png",
10521: "$topdir/media/player.swf",
10522: "$topdir/media/swfobject.js",
10523: "$topdir/media/expressInstall.swf");
10524: my @diffs = &compare_arrays(\@paths,\@camtasia);
10525: if (@diffs == 0) {
10526: $is_camtasia = 1;
10527: }
10528: }
10529: my $output;
10530: if ($is_camtasia) {
10531: $output = <<"ENDCAM";
10532: <script type="text/javascript" language="Javascript">
10533: // <![CDATA[
10534:
10535: function camtasiaToggle() {
10536: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10537: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10538: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10539:
10540: document.getElementById('camtasia_titles').style.display='block';
10541: } else {
10542: document.getElementById('camtasia_titles').style.display='none';
10543: }
10544: }
10545: }
10546: return;
10547: }
10548:
10549: // ]]>
10550: </script>
10551: <p>$lt{'camt'}</p>
10552: ENDCAM
1.1065 raeburn 10553: } else {
1.1067 raeburn 10554: $output = '<p>'.$lt{'this'};
10555: if ($info eq '') {
10556: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10557: } else {
10558: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10559: '<div><pre>'.$info.'</pre></div>';
10560: }
1.1065 raeburn 10561: }
1.1067 raeburn 10562: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10563: my $duplicates;
10564: my $num = 0;
10565: if (ref($dirlist) eq 'ARRAY') {
10566: foreach my $item (@{$dirlist}) {
10567: if (ref($item) eq 'ARRAY') {
10568: if (exists($toplevel{$item->[0]})) {
10569: $duplicates .=
10570: &start_data_table_row().
10571: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10572: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10573: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10574: 'value="1" />'.&mt('Yes').'</label>'.
10575: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10576: '<td>'.$item->[0].'</td>';
10577: if ($item->[2]) {
10578: $duplicates .= '<td>'.&mt('Directory').'</td>';
10579: } else {
10580: $duplicates .= '<td>'.&mt('File').'</td>';
10581: }
10582: $duplicates .= '<td>'.$item->[3].'</td>'.
10583: '<td>'.
10584: &Apache::lonlocal::locallocaltime($item->[4]).
10585: '</td>'.
10586: &end_data_table_row();
10587: $num ++;
10588: }
10589: }
10590: }
10591: }
10592: my $itemcount;
10593: if (@paths > 0) {
10594: $itemcount = scalar(@paths);
10595: } else {
10596: $itemcount = 1;
10597: }
1.1067 raeburn 10598: if ($is_camtasia) {
10599: $output .= $lt{'auto'}.'<br />'.
10600: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10601: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10602: $lt{'yes'}.'</label> <label>'.
10603: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10604: $lt{'no'}.'</label></span><br />'.
10605: '<div id="camtasia_titles" style="display:block">'.
10606: &Apache::lonhtmlcommon::start_pick_box().
10607: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10608: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10609: &Apache::lonhtmlcommon::row_closure().
10610: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10611: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10612: &Apache::lonhtmlcommon::row_closure(1).
10613: &Apache::lonhtmlcommon::end_pick_box().
10614: '</div>';
10615: }
1.1065 raeburn 10616: $output .=
10617: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10618: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10619: "\n";
1.1065 raeburn 10620: if ($duplicates ne '') {
10621: $output .= '<p><span class="LC_warning">'.
10622: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10623: &start_data_table().
10624: &start_data_table_header_row().
10625: '<th>'.&mt('Overwrite?').'</th>'.
10626: '<th>'.&mt('Name').'</th>'.
10627: '<th>'.&mt('Type').'</th>'.
10628: '<th>'.&mt('Size').'</th>'.
10629: '<th>'.&mt('Last modified').'</th>'.
10630: &end_data_table_header_row().
10631: $duplicates.
10632: &end_data_table().
10633: '</p>';
10634: }
1.1067 raeburn 10635: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10636: if (ref($hiddenelements) eq 'HASH') {
10637: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10638: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10639: }
10640: }
10641: $output .= <<"END";
1.1067 raeburn 10642: <br />
1.1053 raeburn 10643: <input type="submit" name="decompress" value="$lt{'extr'}" />
10644: </form>
10645: $noextract
10646: END
10647: return $output;
10648: }
10649:
1.1065 raeburn 10650: sub decompression_utility {
10651: my ($program) = @_;
10652: my @utilities = ('tar','gunzip','bunzip2','unzip');
10653: my $location;
10654: if (grep(/^\Q$program\E$/,@utilities)) {
10655: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10656: '/usr/sbin/') {
10657: if (-x $dir.$program) {
10658: $location = $dir.$program;
10659: last;
10660: }
10661: }
10662: }
10663: return $location;
10664: }
10665:
10666: sub list_archive_contents {
10667: my ($file,$pathsref) = @_;
10668: my (@cmd,$output);
10669: my $needsregexp;
10670: if ($file =~ /\.zip$/) {
10671: @cmd = (&decompression_utility('unzip'),"-l");
10672: $needsregexp = 1;
10673: } elsif (($file =~ m/\.tar\.gz$/) ||
10674: ($file =~ /\.tgz$/)) {
10675: @cmd = (&decompression_utility('tar'),"-ztf");
10676: } elsif ($file =~ /\.tar\.bz2$/) {
10677: @cmd = (&decompression_utility('tar'),"-jtf");
10678: } elsif ($file =~ m|\.tar$|) {
10679: @cmd = (&decompression_utility('tar'),"-tf");
10680: }
10681: if (@cmd) {
10682: undef($!);
10683: undef($@);
10684: if (open(my $fh,"-|", @cmd, $file)) {
10685: while (my $line = <$fh>) {
10686: $output .= $line;
10687: chomp($line);
10688: my $item;
10689: if ($needsregexp) {
10690: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10691: } else {
10692: $item = $line;
10693: }
10694: if ($item ne '') {
10695: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10696: push(@{$pathsref},$item);
10697: }
10698: }
10699: }
10700: close($fh);
10701: }
10702: }
10703: return $output;
10704: }
10705:
1.1053 raeburn 10706: sub decompress_uploaded_file {
10707: my ($file,$dir) = @_;
10708: &Apache::lonnet::appenv({'cgi.file' => $file});
10709: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10710: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10711: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10712: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10713: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10714: my $decompressed = $env{'cgi.decompressed'};
10715: &Apache::lonnet::delenv('cgi.file');
10716: &Apache::lonnet::delenv('cgi.dir');
10717: &Apache::lonnet::delenv('cgi.decompressed');
10718: return ($decompressed,$result);
10719: }
10720:
1.1055 raeburn 10721: sub process_decompression {
10722: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10723: my ($dir,$error,$warning,$output);
10724: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10725: $error = &mt('File name not a supported archive file type.').
10726: '<br />'.&mt('File name should end with one of: [_1].',
10727: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10728: } else {
10729: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10730: if ($docuhome eq 'no_host') {
10731: $error = &mt('Could not determine home server for course.');
10732: } else {
10733: my @ids=&Apache::lonnet::current_machine_ids();
10734: my $currdir = "$dir_root/$destination";
10735: if (grep(/^\Q$docuhome\E$/,@ids)) {
10736: $dir = &LONCAPA::propath($docudom,$docuname).
10737: "$dir_root/$destination";
10738: } else {
10739: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10740: "$dir_root/$docudom/$docuname/$destination";
10741: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10742: $error = &mt('Archive file not found.');
10743: }
10744: }
1.1065 raeburn 10745: my (@to_overwrite,@to_skip);
10746: if ($env{'form.archive_overwrite_total'} > 0) {
10747: my $total = $env{'form.archive_overwrite_total'};
10748: for (my $i=0; $i<$total; $i++) {
10749: if ($env{'form.archive_overwrite_'.$i} == 1) {
10750: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10751: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10752: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10753: }
10754: }
10755: }
10756: my $numskip = scalar(@to_skip);
10757: if (($numskip > 0) &&
10758: ($numskip == $env{'form.archive_itemcount'})) {
10759: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10760: } elsif ($dir eq '') {
1.1055 raeburn 10761: $error = &mt('Directory containing archive file unavailable.');
10762: } elsif (!$error) {
1.1065 raeburn 10763: my ($decompressed,$display);
10764: if ($numskip > 0) {
10765: my $tempdir = time.'_'.$$.int(rand(10000));
10766: mkdir("$dir/$tempdir",0755);
10767: system("mv $dir/$file $dir/$tempdir/$file");
10768: ($decompressed,$display) =
10769: &decompress_uploaded_file($file,"$dir/$tempdir");
10770: foreach my $item (@to_skip) {
10771: if (($item ne '') && ($item !~ /\.\./)) {
10772: if (-f "$dir/$tempdir/$item") {
10773: unlink("$dir/$tempdir/$item");
10774: } elsif (-d "$dir/$tempdir/$item") {
10775: system("rm -rf $dir/$tempdir/$item");
10776: }
10777: }
10778: }
10779: system("mv $dir/$tempdir/* $dir");
10780: rmdir("$dir/$tempdir");
10781: } else {
10782: ($decompressed,$display) =
10783: &decompress_uploaded_file($file,$dir);
10784: }
1.1055 raeburn 10785: if ($decompressed eq 'ok') {
1.1065 raeburn 10786: $output = '<p class="LC_info">'.
10787: &mt('Files extracted successfully from archive.').
10788: '</p>'."\n";
1.1055 raeburn 10789: my ($warning,$result,@contents);
10790: my ($newdirlistref,$newlisterror) =
10791: &Apache::lonnet::dirlist($currdir,$docudom,
10792: $docuname,1);
10793: my (%is_dir,%changes,@newitems);
10794: my $dirptr = 16384;
1.1065 raeburn 10795: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10796: foreach my $dir_line (@{$newdirlistref}) {
10797: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10798: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10799: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10800: push(@newitems,$item);
10801: if ($dirptr&$testdir) {
10802: $is_dir{$item} = 1;
10803: }
10804: $changes{$item} = 1;
10805: }
10806: }
10807: }
10808: if (keys(%changes) > 0) {
10809: foreach my $item (sort(@newitems)) {
10810: if ($changes{$item}) {
10811: push(@contents,$item);
10812: }
10813: }
10814: }
10815: if (@contents > 0) {
1.1067 raeburn 10816: my $wantform;
10817: unless ($env{'form.autoextract_camtasia'}) {
10818: $wantform = 1;
10819: }
1.1056 raeburn 10820: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10821: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10822: $currdir,\%is_dir,
10823: \%children,\%parent,
1.1056 raeburn 10824: \@contents,\%dirorder,
10825: \%titles,$wantform);
1.1055 raeburn 10826: if ($datatable ne '') {
10827: $output .= &archive_options_form('decompressed',$datatable,
10828: $count,$hiddenelem);
1.1065 raeburn 10829: my $startcount = 6;
1.1055 raeburn 10830: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10831: \%titles,\%children);
1.1055 raeburn 10832: }
1.1067 raeburn 10833: if ($env{'form.autoextract_camtasia'}) {
10834: my %displayed;
10835: my $total = 1;
10836: $env{'form.archive_directory'} = [];
10837: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10838: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10839: $path =~ s{/$}{};
10840: my $item;
10841: if ($path ne '') {
10842: $item = "$path/$titles{$i}";
10843: } else {
10844: $item = $titles{$i};
10845: }
10846: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10847: if ($item eq $contents[0]) {
10848: push(@{$env{'form.archive_directory'}},$i);
10849: $env{'form.archive_'.$i} = 'display';
10850: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10851: $displayed{'folder'} = $i;
10852: } elsif ($item eq "$contents[0]/index.html") {
10853: $env{'form.archive_'.$i} = 'display';
10854: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10855: $displayed{'web'} = $i;
10856: } else {
10857: if ($item eq "$contents[0]/media") {
10858: push(@{$env{'form.archive_directory'}},$i);
10859: }
10860: $env{'form.archive_'.$i} = 'dependency';
10861: }
10862: $total ++;
10863: }
10864: for (my $i=1; $i<$total; $i++) {
10865: next if ($i == $displayed{'web'});
10866: next if ($i == $displayed{'folder'});
10867: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10868: }
10869: $env{'form.phase'} = 'decompress_cleanup';
10870: $env{'form.archivedelete'} = 1;
10871: $env{'form.archive_count'} = $total-1;
10872: $output .=
10873: &process_extracted_files('coursedocs',$docudom,
10874: $docuname,$destination,
10875: $dir_root,$hiddenelem);
10876: }
1.1055 raeburn 10877: } else {
10878: $warning = &mt('No new items extracted from archive file.');
10879: }
10880: } else {
10881: $output = $display;
10882: $error = &mt('An error occurred during extraction from the archive file.');
10883: }
10884: }
10885: }
10886: }
10887: if ($error) {
10888: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10889: $error.'</p>'."\n";
10890: }
10891: if ($warning) {
10892: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10893: }
10894: return $output;
10895: }
10896:
10897: sub get_extracted {
1.1056 raeburn 10898: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10899: $titles,$wantform) = @_;
1.1055 raeburn 10900: my $count = 0;
10901: my $depth = 0;
10902: my $datatable;
1.1056 raeburn 10903: my @hierarchy;
1.1055 raeburn 10904: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10905: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10906: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10907: foreach my $item (@{$contents}) {
10908: $count ++;
1.1056 raeburn 10909: @{$dirorder->{$count}} = @hierarchy;
10910: $titles->{$count} = $item;
1.1055 raeburn 10911: &archive_hierarchy($depth,$count,$parent,$children);
10912: if ($wantform) {
10913: $datatable .= &archive_row($is_dir->{$item},$item,
10914: $currdir,$depth,$count);
10915: }
10916: if ($is_dir->{$item}) {
10917: $depth ++;
1.1056 raeburn 10918: push(@hierarchy,$count);
10919: $parent->{$depth} = $count;
1.1055 raeburn 10920: $datatable .=
10921: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10922: \$depth,\$count,\@hierarchy,$dirorder,
10923: $children,$parent,$titles,$wantform);
1.1055 raeburn 10924: $depth --;
1.1056 raeburn 10925: pop(@hierarchy);
1.1055 raeburn 10926: }
10927: }
10928: return ($count,$datatable);
10929: }
10930:
10931: sub recurse_extracted_archive {
1.1056 raeburn 10932: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10933: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10934: my $result='';
1.1056 raeburn 10935: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10936: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10937: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10938: return $result;
10939: }
10940: my $dirptr = 16384;
10941: my ($newdirlistref,$newlisterror) =
10942: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10943: if (ref($newdirlistref) eq 'ARRAY') {
10944: foreach my $dir_line (@{$newdirlistref}) {
10945: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10946: unless ($item =~ /^\.+$/) {
10947: $$count ++;
1.1056 raeburn 10948: @{$dirorder->{$$count}} = @{$hierarchy};
10949: $titles->{$$count} = $item;
1.1055 raeburn 10950: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10951:
1.1055 raeburn 10952: my $is_dir;
10953: if ($dirptr&$testdir) {
10954: $is_dir = 1;
10955: }
10956: if ($wantform) {
10957: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10958: }
10959: if ($is_dir) {
10960: $$depth ++;
1.1056 raeburn 10961: push(@{$hierarchy},$$count);
10962: $parent->{$$depth} = $$count;
1.1055 raeburn 10963: $result .=
10964: &recurse_extracted_archive("$currdir/$item",$docudom,
10965: $docuname,$depth,$count,
1.1056 raeburn 10966: $hierarchy,$dirorder,$children,
10967: $parent,$titles,$wantform);
1.1055 raeburn 10968: $$depth --;
1.1056 raeburn 10969: pop(@{$hierarchy});
1.1055 raeburn 10970: }
10971: }
10972: }
10973: }
10974: return $result;
10975: }
10976:
10977: sub archive_hierarchy {
10978: my ($depth,$count,$parent,$children) =@_;
10979: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10980: if (exists($parent->{$depth})) {
10981: $children->{$parent->{$depth}} .= $count.':';
10982: }
10983: }
10984: return;
10985: }
10986:
10987: sub archive_row {
10988: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10989: my ($name) = ($item =~ m{([^/]+)$});
10990: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10991: 'display' => 'Add as file',
1.1055 raeburn 10992: 'dependency' => 'Include as dependency',
10993: 'discard' => 'Discard',
10994: );
10995: if ($is_dir) {
1.1059 raeburn 10996: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10997: }
1.1056 raeburn 10998: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10999: my $offset = 0;
1.1055 raeburn 11000: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11001: $offset ++;
1.1065 raeburn 11002: if ($action ne 'display') {
11003: $offset ++;
11004: }
1.1055 raeburn 11005: $output .= '<td><span class="LC_nobreak">'.
11006: '<label><input type="radio" name="archive_'.$count.
11007: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11008: my $text = $choices{$action};
11009: if ($is_dir) {
11010: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11011: if ($action eq 'display') {
1.1059 raeburn 11012: $text = &mt('Add as folder');
1.1055 raeburn 11013: }
1.1056 raeburn 11014: } else {
11015: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11016:
11017: }
11018: $output .= ' /> '.$choices{$action}.'</label></span>';
11019: if ($action eq 'dependency') {
11020: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11021: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11022: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11023: '<option value=""></option>'."\n".
11024: '</select>'."\n".
11025: '</div>';
1.1059 raeburn 11026: } elsif ($action eq 'display') {
11027: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11028: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11029: '</div>';
1.1055 raeburn 11030: }
1.1056 raeburn 11031: $output .= '</td>';
1.1055 raeburn 11032: }
11033: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11034: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11035: for (my $i=0; $i<$depth; $i++) {
11036: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11037: }
11038: if ($is_dir) {
11039: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11040: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11041: } else {
11042: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11043: }
11044: $output .= ' '.$name.'</td>'."\n".
11045: &end_data_table_row();
11046: return $output;
11047: }
11048:
11049: sub archive_options_form {
1.1065 raeburn 11050: my ($form,$display,$count,$hiddenelem) = @_;
11051: my %lt = &Apache::lonlocal::texthash(
11052: perm => 'Permanently remove archive file?',
11053: hows => 'How should each extracted item be incorporated in the course?',
11054: cont => 'Content actions for all',
11055: addf => 'Add as folder/file',
11056: incd => 'Include as dependency for a displayed file',
11057: disc => 'Discard',
11058: no => 'No',
11059: yes => 'Yes',
11060: save => 'Save',
11061: );
11062: my $output = <<"END";
11063: <form name="$form" method="post" action="">
11064: <p><span class="LC_nobreak">$lt{'perm'}
11065: <label>
11066: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11067: </label>
11068:
11069: <label>
11070: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11071: </span>
11072: </p>
11073: <input type="hidden" name="phase" value="decompress_cleanup" />
11074: <br />$lt{'hows'}
11075: <div class="LC_columnSection">
11076: <fieldset>
11077: <legend>$lt{'cont'}</legend>
11078: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11079: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11080: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11081: </fieldset>
11082: </div>
11083: END
11084: return $output.
1.1055 raeburn 11085: &start_data_table()."\n".
1.1065 raeburn 11086: $display."\n".
1.1055 raeburn 11087: &end_data_table()."\n".
11088: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11089: $hiddenelem.
1.1065 raeburn 11090: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11091: '</form>';
11092: }
11093:
11094: sub archive_javascript {
1.1056 raeburn 11095: my ($startcount,$numitems,$titles,$children) = @_;
11096: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11097: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11098: my $scripttag = <<START;
11099: <script type="text/javascript">
11100: // <![CDATA[
11101:
11102: function checkAll(form,prefix) {
11103: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11104: for (var i=0; i < form.elements.length; i++) {
11105: var id = form.elements[i].id;
11106: if ((id != '') && (id != undefined)) {
11107: if (idstr.test(id)) {
11108: if (form.elements[i].type == 'radio') {
11109: form.elements[i].checked = true;
1.1056 raeburn 11110: var nostart = i-$startcount;
1.1059 raeburn 11111: var offset = nostart%7;
11112: var count = (nostart-offset)/7;
1.1056 raeburn 11113: dependencyCheck(form,count,offset);
1.1055 raeburn 11114: }
11115: }
11116: }
11117: }
11118: }
11119:
11120: function propagateCheck(form,count) {
11121: if (count > 0) {
1.1059 raeburn 11122: var startelement = $startcount + ((count-1) * 7);
11123: for (var j=1; j<6; j++) {
11124: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11125: var item = startelement + j;
11126: if (form.elements[item].type == 'radio') {
11127: if (form.elements[item].checked) {
11128: containerCheck(form,count,j);
11129: break;
11130: }
1.1055 raeburn 11131: }
11132: }
11133: }
11134: }
11135: }
11136:
11137: numitems = $numitems
1.1056 raeburn 11138: var titles = new Array(numitems);
11139: var parents = new Array(numitems);
1.1055 raeburn 11140: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11141: parents[i] = new Array;
1.1055 raeburn 11142: }
1.1059 raeburn 11143: var maintitle = '$maintitle';
1.1055 raeburn 11144:
11145: START
11146:
1.1056 raeburn 11147: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11148: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11149: for (my $i=0; $i<@contents; $i ++) {
11150: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11151: }
11152: }
11153:
1.1056 raeburn 11154: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11155: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11156: }
11157:
1.1055 raeburn 11158: $scripttag .= <<END;
11159:
11160: function containerCheck(form,count,offset) {
11161: if (count > 0) {
1.1056 raeburn 11162: dependencyCheck(form,count,offset);
1.1059 raeburn 11163: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11164: form.elements[item].checked = true;
11165: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11166: if (parents[count].length > 0) {
11167: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11168: containerCheck(form,parents[count][j],offset);
11169: }
11170: }
11171: }
11172: }
11173: }
11174:
11175: function dependencyCheck(form,count,offset) {
11176: if (count > 0) {
1.1059 raeburn 11177: var chosen = (offset+$startcount)+7*(count-1);
11178: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11179: var currtype = form.elements[depitem].type;
11180: if (form.elements[chosen].value == 'dependency') {
11181: document.getElementById('arc_depon_'+count).style.display='block';
11182: form.elements[depitem].options.length = 0;
11183: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 11184: for (var i=1; i<=numitems; i++) {
11185: if (i == count) {
11186: continue;
11187: }
1.1059 raeburn 11188: var startelement = $startcount + (i-1) * 7;
11189: for (var j=1; j<6; j++) {
11190: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11191: var item = startelement + j;
11192: if (form.elements[item].type == 'radio') {
11193: if (form.elements[item].checked) {
11194: if (form.elements[item].value == 'display') {
11195: var n = form.elements[depitem].options.length;
11196: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11197: }
11198: }
11199: }
11200: }
11201: }
11202: }
11203: } else {
11204: document.getElementById('arc_depon_'+count).style.display='none';
11205: form.elements[depitem].options.length = 0;
11206: form.elements[depitem].options[0] = new Option('Select','',true,true);
11207: }
1.1059 raeburn 11208: titleCheck(form,count,offset);
1.1056 raeburn 11209: }
11210: }
11211:
11212: function propagateSelect(form,count,offset) {
11213: if (count > 0) {
1.1065 raeburn 11214: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11215: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11216: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11217: if (parents[count].length > 0) {
11218: for (var j=0; j<parents[count].length; j++) {
11219: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11220: }
11221: }
11222: }
11223: }
11224: }
1.1056 raeburn 11225:
11226: function containerSelect(form,count,offset,picked) {
11227: if (count > 0) {
1.1065 raeburn 11228: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11229: if (form.elements[item].type == 'radio') {
11230: if (form.elements[item].value == 'dependency') {
11231: if (form.elements[item+1].type == 'select-one') {
11232: for (var i=0; i<form.elements[item+1].options.length; i++) {
11233: if (form.elements[item+1].options[i].value == picked) {
11234: form.elements[item+1].selectedIndex = i;
11235: break;
11236: }
11237: }
11238: }
11239: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11240: if (parents[count].length > 0) {
11241: for (var j=0; j<parents[count].length; j++) {
11242: containerSelect(form,parents[count][j],offset,picked);
11243: }
11244: }
11245: }
11246: }
11247: }
11248: }
11249: }
11250:
1.1059 raeburn 11251: function titleCheck(form,count,offset) {
11252: if (count > 0) {
11253: var chosen = (offset+$startcount)+7*(count-1);
11254: var depitem = $startcount + ((count-1) * 7) + 2;
11255: var currtype = form.elements[depitem].type;
11256: if (form.elements[chosen].value == 'display') {
11257: document.getElementById('arc_title_'+count).style.display='block';
11258: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11259: document.getElementById('archive_title_'+count).value=maintitle;
11260: }
11261: } else {
11262: document.getElementById('arc_title_'+count).style.display='none';
11263: if (currtype == 'text') {
11264: document.getElementById('archive_title_'+count).value='';
11265: }
11266: }
11267: }
11268: return;
11269: }
11270:
1.1055 raeburn 11271: // ]]>
11272: </script>
11273: END
11274: return $scripttag;
11275: }
11276:
11277: sub process_extracted_files {
1.1067 raeburn 11278: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11279: my $numitems = $env{'form.archive_count'};
11280: return unless ($numitems);
11281: my @ids=&Apache::lonnet::current_machine_ids();
11282: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11283: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11284: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11285: if (grep(/^\Q$docuhome\E$/,@ids)) {
11286: $prefix = &LONCAPA::propath($docudom,$docuname);
11287: $pathtocheck = "$dir_root/$destination";
11288: $dir = $dir_root;
11289: $ishome = 1;
11290: } else {
11291: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11292: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11293: $dir = "$dir_root/$docudom/$docuname";
11294: }
11295: my $currdir = "$dir_root/$destination";
11296: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11297: if ($env{'form.folderpath'}) {
11298: my @items = split('&',$env{'form.folderpath'});
11299: $folders{'0'} = $items[-2];
11300: $containers{'0'}='sequence';
11301: } elsif ($env{'form.pagepath'}) {
11302: my @items = split('&',$env{'form.pagepath'});
11303: $folders{'0'} = $items[-2];
11304: $containers{'0'}='page';
11305: }
11306: my @archdirs = &get_env_multiple('form.archive_directory');
11307: if ($numitems) {
11308: for (my $i=1; $i<=$numitems; $i++) {
11309: my $path = $env{'form.archive_content_'.$i};
11310: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11311: my $item = $1;
11312: $toplevelitems{$item} = $i;
11313: if (grep(/^\Q$i\E$/,@archdirs)) {
11314: $is_dir{$item} = 1;
11315: }
11316: }
11317: }
11318: }
1.1067 raeburn 11319: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11320: if (keys(%toplevelitems) > 0) {
11321: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11322: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11323: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11324: }
1.1066 raeburn 11325: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11326: if ($numitems) {
11327: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 11328: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11329: my $path = $env{'form.archive_content_'.$i};
11330: if ($path =~ /^\Q$pathtocheck\E/) {
11331: if ($env{'form.archive_'.$i} eq 'discard') {
11332: if ($prefix ne '' && $path ne '') {
11333: if (-e $prefix.$path) {
1.1066 raeburn 11334: if ((@archdirs > 0) &&
11335: (grep(/^\Q$i\E$/,@archdirs))) {
11336: $todeletedir{$prefix.$path} = 1;
11337: } else {
11338: $todelete{$prefix.$path} = 1;
11339: }
1.1055 raeburn 11340: }
11341: }
11342: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11343: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11344: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11345: $docstitle = $env{'form.archive_title_'.$i};
11346: if ($docstitle eq '') {
11347: $docstitle = $title;
11348: }
1.1055 raeburn 11349: $outer = 0;
1.1056 raeburn 11350: if (ref($dirorder{$i}) eq 'ARRAY') {
11351: if (@{$dirorder{$i}} > 0) {
11352: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11353: if ($env{'form.archive_'.$item} eq 'display') {
11354: $outer = $item;
11355: last;
11356: }
11357: }
11358: }
11359: }
11360: my ($errtext,$fatal) =
11361: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11362: '/'.$folders{$outer}.'.'.
11363: $containers{$outer});
11364: next if ($fatal);
11365: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11366: if ($context eq 'coursedocs') {
1.1056 raeburn 11367: $mapinner{$i} = time;
1.1055 raeburn 11368: $folders{$i} = 'default_'.$mapinner{$i};
11369: $containers{$i} = 'sequence';
11370: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11371: $folders{$i}.'.'.$containers{$i};
11372: my $newidx = &LONCAPA::map::getresidx();
11373: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11374: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11375: push(@LONCAPA::map::order,$newidx);
11376: my ($outtext,$errtext) =
11377: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11378: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11379: '.'.$containers{$outer},1,1);
1.1056 raeburn 11380: $newseqid{$i} = $newidx;
1.1067 raeburn 11381: unless ($errtext) {
11382: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11383: }
1.1055 raeburn 11384: }
11385: } else {
11386: if ($context eq 'coursedocs') {
11387: my $newidx=&LONCAPA::map::getresidx();
11388: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11389: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11390: $title;
11391: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11392: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11393: }
11394: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11395: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11396: }
11397: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11398: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11399: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11400: unless ($ishome) {
11401: my $fetch = "$newdest{$i}/$title";
11402: $fetch =~ s/^\Q$prefix$dir\E//;
11403: $prompttofetch{$fetch} = 1;
11404: }
1.1055 raeburn 11405: }
11406: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11407: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11408: push(@LONCAPA::map::order, $newidx);
11409: my ($outtext,$errtext)=
11410: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11411: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11412: '.'.$containers{$outer},1,1);
1.1067 raeburn 11413: unless ($errtext) {
11414: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11415: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11416: }
11417: }
1.1055 raeburn 11418: }
11419: }
1.1086 raeburn 11420: }
11421: } else {
11422: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11423: }
11424: }
11425: for (my $i=1; $i<=$numitems; $i++) {
11426: next unless ($env{'form.archive_'.$i} eq 'dependency');
11427: my $path = $env{'form.archive_content_'.$i};
11428: if ($path =~ /^\Q$pathtocheck\E/) {
11429: my ($title) = ($path =~ m{/([^/]+)$});
11430: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11431: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11432: if (ref($dirorder{$i}) eq 'ARRAY') {
11433: my ($itemidx,$fullpath,$relpath);
11434: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11435: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11436: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 11437: if ($dirorder{$i}->[$j] eq $container) {
11438: $itemidx = $j;
1.1056 raeburn 11439: }
11440: }
1.1086 raeburn 11441: }
11442: if ($itemidx eq '') {
11443: $itemidx = 0;
11444: }
11445: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11446: if ($mapinner{$referrer{$i}}) {
11447: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11448: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11449: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11450: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11451: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11452: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11453: if (!-e $fullpath) {
11454: mkdir($fullpath,0755);
1.1056 raeburn 11455: }
11456: }
1.1086 raeburn 11457: } else {
11458: last;
1.1056 raeburn 11459: }
1.1086 raeburn 11460: }
11461: }
11462: } elsif ($newdest{$referrer{$i}}) {
11463: $fullpath = $newdest{$referrer{$i}};
11464: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11465: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11466: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11467: last;
11468: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11469: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11470: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11471: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11472: if (!-e $fullpath) {
11473: mkdir($fullpath,0755);
1.1056 raeburn 11474: }
11475: }
1.1086 raeburn 11476: } else {
11477: last;
1.1056 raeburn 11478: }
1.1055 raeburn 11479: }
11480: }
1.1086 raeburn 11481: if ($fullpath ne '') {
11482: if (-e "$prefix$path") {
11483: system("mv $prefix$path $fullpath/$title");
11484: }
11485: if (-e "$fullpath/$title") {
11486: my $showpath;
11487: if ($relpath ne '') {
11488: $showpath = "$relpath/$title";
11489: } else {
11490: $showpath = "/$title";
11491: }
11492: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11493: }
11494: unless ($ishome) {
11495: my $fetch = "$fullpath/$title";
11496: $fetch =~ s/^\Q$prefix$dir\E//;
11497: $prompttofetch{$fetch} = 1;
11498: }
11499: }
1.1055 raeburn 11500: }
1.1086 raeburn 11501: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11502: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11503: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11504: }
11505: } else {
11506: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11507: }
11508: }
11509: if (keys(%todelete)) {
11510: foreach my $key (keys(%todelete)) {
11511: unlink($key);
1.1066 raeburn 11512: }
11513: }
11514: if (keys(%todeletedir)) {
11515: foreach my $key (keys(%todeletedir)) {
11516: rmdir($key);
11517: }
11518: }
11519: foreach my $dir (sort(keys(%is_dir))) {
11520: if (($pathtocheck ne '') && ($dir ne '')) {
11521: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11522: }
11523: }
1.1067 raeburn 11524: if ($result ne '') {
11525: $output .= '<ul>'."\n".
11526: $result."\n".
11527: '</ul>';
11528: }
11529: unless ($ishome) {
11530: my $replicationfail;
11531: foreach my $item (keys(%prompttofetch)) {
11532: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11533: unless ($fetchresult eq 'ok') {
11534: $replicationfail .= '<li>'.$item.'</li>'."\n";
11535: }
11536: }
11537: if ($replicationfail) {
11538: $output .= '<p class="LC_error">'.
11539: &mt('Course home server failed to retrieve:').'<ul>'.
11540: $replicationfail.
11541: '</ul></p>';
11542: }
11543: }
1.1055 raeburn 11544: } else {
11545: $warning = &mt('No items found in archive.');
11546: }
11547: if ($error) {
11548: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11549: $error.'</p>'."\n";
11550: }
11551: if ($warning) {
11552: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11553: }
11554: return $output;
11555: }
11556:
1.1066 raeburn 11557: sub cleanup_empty_dirs {
11558: my ($path) = @_;
11559: if (($path ne '') && (-d $path)) {
11560: if (opendir(my $dirh,$path)) {
11561: my @dircontents = grep(!/^\./,readdir($dirh));
11562: my $numitems = 0;
11563: foreach my $item (@dircontents) {
11564: if (-d "$path/$item") {
11565: &recurse_dirs("$path/$item");
11566: if (-e "$path/$item") {
11567: $numitems ++;
11568: }
11569: } else {
11570: $numitems ++;
11571: }
11572: }
11573: if ($numitems == 0) {
11574: rmdir($path);
11575: }
11576: closedir($dirh);
11577: }
11578: }
11579: return;
11580: }
11581:
1.41 ng 11582: =pod
1.45 matthew 11583:
1.1068 raeburn 11584: =item &get_folder_hierarchy()
11585:
11586: Provides hierarchy of names of folders/sub-folders containing the current
11587: item,
11588:
11589: Inputs: 3
11590: - $navmap - navmaps object
11591:
11592: - $map - url for map (either the trigger itself, or map containing
11593: the resource, which is the trigger).
11594:
11595: - $showitem - 1 => show title for map itself; 0 => do not show.
11596:
11597: Outputs: 1 @pathitems - array of folder/subfolder names.
11598:
11599: =cut
11600:
11601: sub get_folder_hierarchy {
11602: my ($navmap,$map,$showitem) = @_;
11603: my @pathitems;
11604: if (ref($navmap)) {
11605: my $mapres = $navmap->getResourceByUrl($map);
11606: if (ref($mapres)) {
11607: my $pcslist = $mapres->map_hierarchy();
11608: if ($pcslist ne '') {
11609: my @pcs = split(/,/,$pcslist);
11610: foreach my $pc (@pcs) {
11611: if ($pc == 1) {
11612: push(@pathitems,&mt('Main Course Documents'));
11613: } else {
11614: my $res = $navmap->getByMapPc($pc);
11615: if (ref($res)) {
11616: my $title = $res->compTitle();
11617: $title =~ s/\W+/_/g;
11618: if ($title ne '') {
11619: push(@pathitems,$title);
11620: }
11621: }
11622: }
11623: }
11624: }
1.1071 raeburn 11625: if ($showitem) {
11626: if ($mapres->{ID} eq '0.0') {
11627: push(@pathitems,&mt('Main Course Documents'));
11628: } else {
11629: my $maptitle = $mapres->compTitle();
11630: $maptitle =~ s/\W+/_/g;
11631: if ($maptitle ne '') {
11632: push(@pathitems,$maptitle);
11633: }
1.1068 raeburn 11634: }
11635: }
11636: }
11637: }
11638: return @pathitems;
11639: }
11640:
11641: =pod
11642:
1.1015 raeburn 11643: =item * &get_turnedin_filepath()
11644:
11645: Determines path in a user's portfolio file for storage of files uploaded
11646: to a specific essayresponse or dropbox item.
11647:
11648: Inputs: 3 required + 1 optional.
11649: $symb is symb for resource, $uname and $udom are for current user (required).
11650: $caller is optional (can be "submission", if routine is called when storing
11651: an upoaded file when "Submit Answer" button was pressed).
11652:
11653: Returns array containing $path and $multiresp.
11654: $path is path in portfolio. $multiresp is 1 if this resource contains more
11655: than one file upload item. Callers of routine should append partid as a
11656: subdirectory to $path in cases where $multiresp is 1.
11657:
11658: Called by: homework/essayresponse.pm and homework/structuretags.pm
11659:
11660: =cut
11661:
11662: sub get_turnedin_filepath {
11663: my ($symb,$uname,$udom,$caller) = @_;
11664: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11665: my $turnindir;
11666: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11667: $turnindir = $userhash{'turnindir'};
11668: my ($path,$multiresp);
11669: if ($turnindir eq '') {
11670: if ($caller eq 'submission') {
11671: $turnindir = &mt('turned in');
11672: $turnindir =~ s/\W+/_/g;
11673: my %newhash = (
11674: 'turnindir' => $turnindir,
11675: );
11676: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11677: }
11678: }
11679: if ($turnindir ne '') {
11680: $path = '/'.$turnindir.'/';
11681: my ($multipart,$turnin,@pathitems);
11682: my $navmap = Apache::lonnavmaps::navmap->new();
11683: if (defined($navmap)) {
11684: my $mapres = $navmap->getResourceByUrl($map);
11685: if (ref($mapres)) {
11686: my $pcslist = $mapres->map_hierarchy();
11687: if ($pcslist ne '') {
11688: foreach my $pc (split(/,/,$pcslist)) {
11689: my $res = $navmap->getByMapPc($pc);
11690: if (ref($res)) {
11691: my $title = $res->compTitle();
11692: $title =~ s/\W+/_/g;
11693: if ($title ne '') {
11694: push(@pathitems,$title);
11695: }
11696: }
11697: }
11698: }
11699: my $maptitle = $mapres->compTitle();
11700: $maptitle =~ s/\W+/_/g;
11701: if ($maptitle ne '') {
11702: push(@pathitems,$maptitle);
11703: }
11704: unless ($env{'request.state'} eq 'construct') {
11705: my $res = $navmap->getBySymb($symb);
11706: if (ref($res)) {
11707: my $partlist = $res->parts();
11708: my $totaluploads = 0;
11709: if (ref($partlist) eq 'ARRAY') {
11710: foreach my $part (@{$partlist}) {
11711: my @types = $res->responseType($part);
11712: my @ids = $res->responseIds($part);
11713: for (my $i=0; $i < scalar(@ids); $i++) {
11714: if ($types[$i] eq 'essay') {
11715: my $partid = $part.'_'.$ids[$i];
11716: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11717: $totaluploads ++;
11718: }
11719: }
11720: }
11721: }
11722: if ($totaluploads > 1) {
11723: $multiresp = 1;
11724: }
11725: }
11726: }
11727: }
11728: } else {
11729: return;
11730: }
11731: } else {
11732: return;
11733: }
11734: my $restitle=&Apache::lonnet::gettitle($symb);
11735: $restitle =~ s/\W+/_/g;
11736: if ($restitle eq '') {
11737: $restitle = ($resurl =~ m{/[^/]+$});
11738: if ($restitle eq '') {
11739: $restitle = time;
11740: }
11741: }
11742: push(@pathitems,$restitle);
11743: $path .= join('/',@pathitems);
11744: }
11745: return ($path,$multiresp);
11746: }
11747:
11748: =pod
11749:
1.464 albertel 11750: =back
1.41 ng 11751:
1.112 bowersj2 11752: =head1 CSV Upload/Handling functions
1.38 albertel 11753:
1.41 ng 11754: =over 4
11755:
1.648 raeburn 11756: =item * &upfile_store($r)
1.41 ng 11757:
11758: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11759: needs $env{'form.upfile'}
1.41 ng 11760: returns $datatoken to be put into hidden field
11761:
11762: =cut
1.31 albertel 11763:
11764: sub upfile_store {
11765: my $r=shift;
1.258 albertel 11766: $env{'form.upfile'}=~s/\r/\n/gs;
11767: $env{'form.upfile'}=~s/\f/\n/gs;
11768: $env{'form.upfile'}=~s/\n+/\n/gs;
11769: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11770:
1.258 albertel 11771: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11772: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11773: {
1.158 raeburn 11774: my $datafile = $r->dir_config('lonDaemons').
11775: '/tmp/'.$datatoken.'.tmp';
11776: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11777: print $fh $env{'form.upfile'};
1.158 raeburn 11778: close($fh);
11779: }
1.31 albertel 11780: }
11781: return $datatoken;
11782: }
11783:
1.56 matthew 11784: =pod
11785:
1.648 raeburn 11786: =item * &load_tmp_file($r)
1.41 ng 11787:
11788: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11789: needs $env{'form.datatoken'},
11790: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11791:
11792: =cut
1.31 albertel 11793:
11794: sub load_tmp_file {
11795: my $r=shift;
11796: my @studentdata=();
11797: {
1.158 raeburn 11798: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11799: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11800: if ( open(my $fh,"<$studentfile") ) {
11801: @studentdata=<$fh>;
11802: close($fh);
11803: }
1.31 albertel 11804: }
1.258 albertel 11805: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11806: }
11807:
1.56 matthew 11808: =pod
11809:
1.648 raeburn 11810: =item * &upfile_record_sep()
1.41 ng 11811:
11812: Separate uploaded file into records
11813: returns array of records,
1.258 albertel 11814: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11815:
11816: =cut
1.31 albertel 11817:
11818: sub upfile_record_sep {
1.258 albertel 11819: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11820: } else {
1.248 albertel 11821: my @records;
1.258 albertel 11822: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11823: if ($line=~/^\s*$/) { next; }
11824: push(@records,$line);
11825: }
11826: return @records;
1.31 albertel 11827: }
11828: }
11829:
1.56 matthew 11830: =pod
11831:
1.648 raeburn 11832: =item * &record_sep($record)
1.41 ng 11833:
1.258 albertel 11834: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11835:
11836: =cut
11837:
1.263 www 11838: sub takeleft {
11839: my $index=shift;
11840: return substr('0000'.$index,-4,4);
11841: }
11842:
1.31 albertel 11843: sub record_sep {
11844: my $record=shift;
11845: my %components=();
1.258 albertel 11846: if ($env{'form.upfiletype'} eq 'xml') {
11847: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11848: my $i=0;
1.356 albertel 11849: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11850: $field=~s/^(\"|\')//;
11851: $field=~s/(\"|\')$//;
1.263 www 11852: $components{&takeleft($i)}=$field;
1.31 albertel 11853: $i++;
11854: }
1.258 albertel 11855: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11856: my $i=0;
1.356 albertel 11857: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11858: $field=~s/^(\"|\')//;
11859: $field=~s/(\"|\')$//;
1.263 www 11860: $components{&takeleft($i)}=$field;
1.31 albertel 11861: $i++;
11862: }
11863: } else {
1.561 www 11864: my $separator=',';
1.480 banghart 11865: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11866: $separator=';';
1.480 banghart 11867: }
1.31 albertel 11868: my $i=0;
1.561 www 11869: # the character we are looking for to indicate the end of a quote or a record
11870: my $looking_for=$separator;
11871: # do not add the characters to the fields
11872: my $ignore=0;
11873: # we just encountered a separator (or the beginning of the record)
11874: my $just_found_separator=1;
11875: # store the field we are working on here
11876: my $field='';
11877: # work our way through all characters in record
11878: foreach my $character ($record=~/(.)/g) {
11879: if ($character eq $looking_for) {
11880: if ($character ne $separator) {
11881: # Found the end of a quote, again looking for separator
11882: $looking_for=$separator;
11883: $ignore=1;
11884: } else {
11885: # Found a separator, store away what we got
11886: $components{&takeleft($i)}=$field;
11887: $i++;
11888: $just_found_separator=1;
11889: $ignore=0;
11890: $field='';
11891: }
11892: next;
11893: }
11894: # single or double quotation marks after a separator indicate beginning of a quote
11895: # we are now looking for the end of the quote and need to ignore separators
11896: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11897: $looking_for=$character;
11898: next;
11899: }
11900: # ignore would be true after we reached the end of a quote
11901: if ($ignore) { next; }
11902: if (($just_found_separator) && ($character=~/\s/)) { next; }
11903: $field.=$character;
11904: $just_found_separator=0;
1.31 albertel 11905: }
1.561 www 11906: # catch the very last entry, since we never encountered the separator
11907: $components{&takeleft($i)}=$field;
1.31 albertel 11908: }
11909: return %components;
11910: }
11911:
1.144 matthew 11912: ######################################################
11913: ######################################################
11914:
1.56 matthew 11915: =pod
11916:
1.648 raeburn 11917: =item * &upfile_select_html()
1.41 ng 11918:
1.144 matthew 11919: Return HTML code to select a file from the users machine and specify
11920: the file type.
1.41 ng 11921:
11922: =cut
11923:
1.144 matthew 11924: ######################################################
11925: ######################################################
1.31 albertel 11926: sub upfile_select_html {
1.144 matthew 11927: my %Types = (
11928: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11929: semisv => &mt('Semicolon separated values'),
1.144 matthew 11930: space => &mt('Space separated'),
11931: tab => &mt('Tabulator separated'),
11932: # xml => &mt('HTML/XML'),
11933: );
11934: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11935: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11936: foreach my $type (sort(keys(%Types))) {
11937: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11938: }
11939: $Str .= "</select>\n";
11940: return $Str;
1.31 albertel 11941: }
11942:
1.301 albertel 11943: sub get_samples {
11944: my ($records,$toget) = @_;
11945: my @samples=({});
11946: my $got=0;
11947: foreach my $rec (@$records) {
11948: my %temp = &record_sep($rec);
11949: if (! grep(/\S/, values(%temp))) { next; }
11950: if (%temp) {
11951: $samples[$got]=\%temp;
11952: $got++;
11953: if ($got == $toget) { last; }
11954: }
11955: }
11956: return \@samples;
11957: }
11958:
1.144 matthew 11959: ######################################################
11960: ######################################################
11961:
1.56 matthew 11962: =pod
11963:
1.648 raeburn 11964: =item * &csv_print_samples($r,$records)
1.41 ng 11965:
11966: Prints a table of sample values from each column uploaded $r is an
11967: Apache Request ref, $records is an arrayref from
11968: &Apache::loncommon::upfile_record_sep
11969:
11970: =cut
11971:
1.144 matthew 11972: ######################################################
11973: ######################################################
1.31 albertel 11974: sub csv_print_samples {
11975: my ($r,$records) = @_;
1.662 bisitz 11976: my $samples = &get_samples($records,5);
1.301 albertel 11977:
1.594 raeburn 11978: $r->print(&mt('Samples').'<br />'.&start_data_table().
11979: &start_data_table_header_row());
1.356 albertel 11980: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11981: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11982: $r->print(&end_data_table_header_row());
1.301 albertel 11983: foreach my $hash (@$samples) {
1.594 raeburn 11984: $r->print(&start_data_table_row());
1.356 albertel 11985: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11986: $r->print('<td>');
1.356 albertel 11987: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11988: $r->print('</td>');
11989: }
1.594 raeburn 11990: $r->print(&end_data_table_row());
1.31 albertel 11991: }
1.594 raeburn 11992: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11993: }
11994:
1.144 matthew 11995: ######################################################
11996: ######################################################
11997:
1.56 matthew 11998: =pod
11999:
1.648 raeburn 12000: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12001:
12002: Prints a table to create associations between values and table columns.
1.144 matthew 12003:
1.41 ng 12004: $r is an Apache Request ref,
12005: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12006: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12007:
12008: =cut
12009:
1.144 matthew 12010: ######################################################
12011: ######################################################
1.31 albertel 12012: sub csv_print_select_table {
12013: my ($r,$records,$d) = @_;
1.301 albertel 12014: my $i=0;
12015: my $samples = &get_samples($records,1);
1.144 matthew 12016: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12017: &start_data_table().&start_data_table_header_row().
1.144 matthew 12018: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12019: '<th>'.&mt('Column').'</th>'.
12020: &end_data_table_header_row()."\n");
1.356 albertel 12021: foreach my $array_ref (@$d) {
12022: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12023: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12024:
1.875 bisitz 12025: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12026: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12027: $r->print('<option value="none"></option>');
1.356 albertel 12028: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12029: $r->print('<option value="'.$sample.'"'.
12030: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12031: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12032: }
1.594 raeburn 12033: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12034: $i++;
12035: }
1.594 raeburn 12036: $r->print(&end_data_table());
1.31 albertel 12037: $i--;
12038: return $i;
12039: }
1.56 matthew 12040:
1.144 matthew 12041: ######################################################
12042: ######################################################
12043:
1.56 matthew 12044: =pod
1.31 albertel 12045:
1.648 raeburn 12046: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12047:
12048: Prints a table of sample values from the upload and can make associate samples to internal names.
12049:
12050: $r is an Apache Request ref,
12051: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12052: $d is an array of 2 element arrays (internal name, displayed name)
12053:
12054: =cut
12055:
1.144 matthew 12056: ######################################################
12057: ######################################################
1.31 albertel 12058: sub csv_samples_select_table {
12059: my ($r,$records,$d) = @_;
12060: my $i=0;
1.144 matthew 12061: #
1.662 bisitz 12062: my $max_samples = 5;
12063: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12064: $r->print(&start_data_table().
12065: &start_data_table_header_row().'<th>'.
12066: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12067: &end_data_table_header_row());
1.301 albertel 12068:
12069: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12070: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12071: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12072: foreach my $option (@$d) {
12073: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12074: $r->print('<option value="'.$value.'"'.
1.253 albertel 12075: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12076: $display.'</option>');
1.31 albertel 12077: }
12078: $r->print('</select></td><td>');
1.662 bisitz 12079: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12080: if (defined($samples->[$line]{$key})) {
12081: $r->print($samples->[$line]{$key}."<br />\n");
12082: }
12083: }
1.594 raeburn 12084: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12085: $i++;
12086: }
1.594 raeburn 12087: $r->print(&end_data_table());
1.31 albertel 12088: $i--;
12089: return($i);
1.115 matthew 12090: }
12091:
1.144 matthew 12092: ######################################################
12093: ######################################################
12094:
1.115 matthew 12095: =pod
12096:
1.648 raeburn 12097: =item * &clean_excel_name($name)
1.115 matthew 12098:
12099: Returns a replacement for $name which does not contain any illegal characters.
12100:
12101: =cut
12102:
1.144 matthew 12103: ######################################################
12104: ######################################################
1.115 matthew 12105: sub clean_excel_name {
12106: my ($name) = @_;
12107: $name =~ s/[:\*\?\/\\]//g;
12108: if (length($name) > 31) {
12109: $name = substr($name,0,31);
12110: }
12111: return $name;
1.25 albertel 12112: }
1.84 albertel 12113:
1.85 albertel 12114: =pod
12115:
1.648 raeburn 12116: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12117:
12118: Returns either 1 or undef
12119:
12120: 1 if the part is to be hidden, undef if it is to be shown
12121:
12122: Arguments are:
12123:
12124: $id the id of the part to be checked
12125: $symb, optional the symb of the resource to check
12126: $udom, optional the domain of the user to check for
12127: $uname, optional the username of the user to check for
12128:
12129: =cut
1.84 albertel 12130:
12131: sub check_if_partid_hidden {
12132: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12133: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12134: $symb,$udom,$uname);
1.141 albertel 12135: my $truth=1;
12136: #if the string starts with !, then the list is the list to show not hide
12137: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12138: my @hiddenlist=split(/,/,$hiddenparts);
12139: foreach my $checkid (@hiddenlist) {
1.141 albertel 12140: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12141: }
1.141 albertel 12142: return !$truth;
1.84 albertel 12143: }
1.127 matthew 12144:
1.138 matthew 12145:
12146: ############################################################
12147: ############################################################
12148:
12149: =pod
12150:
1.157 matthew 12151: =back
12152:
1.138 matthew 12153: =head1 cgi-bin script and graphing routines
12154:
1.157 matthew 12155: =over 4
12156:
1.648 raeburn 12157: =item * &get_cgi_id()
1.138 matthew 12158:
12159: Inputs: none
12160:
12161: Returns an id which can be used to pass environment variables
12162: to various cgi-bin scripts. These environment variables will
12163: be removed from the users environment after a given time by
12164: the routine &Apache::lonnet::transfer_profile_to_env.
12165:
12166: =cut
12167:
12168: ############################################################
12169: ############################################################
1.152 albertel 12170: my $uniq=0;
1.136 matthew 12171: sub get_cgi_id {
1.154 albertel 12172: $uniq=($uniq+1)%100000;
1.280 albertel 12173: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12174: }
12175:
1.127 matthew 12176: ############################################################
12177: ############################################################
12178:
12179: =pod
12180:
1.648 raeburn 12181: =item * &DrawBarGraph()
1.127 matthew 12182:
1.138 matthew 12183: Facilitates the plotting of data in a (stacked) bar graph.
12184: Puts plot definition data into the users environment in order for
12185: graph.png to plot it. Returns an <img> tag for the plot.
12186: The bars on the plot are labeled '1','2',...,'n'.
12187:
12188: Inputs:
12189:
12190: =over 4
12191:
12192: =item $Title: string, the title of the plot
12193:
12194: =item $xlabel: string, text describing the X-axis of the plot
12195:
12196: =item $ylabel: string, text describing the Y-axis of the plot
12197:
12198: =item $Max: scalar, the maximum Y value to use in the plot
12199: If $Max is < any data point, the graph will not be rendered.
12200:
1.140 matthew 12201: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12202: they are plotted. If undefined, default values will be used.
12203:
1.178 matthew 12204: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12205:
1.138 matthew 12206: =item @Values: An array of array references. Each array reference holds data
12207: to be plotted in a stacked bar chart.
12208:
1.239 matthew 12209: =item If the final element of @Values is a hash reference the key/value
12210: pairs will be added to the graph definition.
12211:
1.138 matthew 12212: =back
12213:
12214: Returns:
12215:
12216: An <img> tag which references graph.png and the appropriate identifying
12217: information for the plot.
12218:
1.127 matthew 12219: =cut
12220:
12221: ############################################################
12222: ############################################################
1.134 matthew 12223: sub DrawBarGraph {
1.178 matthew 12224: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12225: #
12226: if (! defined($colors)) {
12227: $colors = ['#33ff00',
12228: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12229: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12230: ];
12231: }
1.228 matthew 12232: my $extra_settings = {};
12233: if (ref($Values[-1]) eq 'HASH') {
12234: $extra_settings = pop(@Values);
12235: }
1.127 matthew 12236: #
1.136 matthew 12237: my $identifier = &get_cgi_id();
12238: my $id = 'cgi.'.$identifier;
1.129 matthew 12239: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12240: return '';
12241: }
1.225 matthew 12242: #
12243: my @Labels;
12244: if (defined($labels)) {
12245: @Labels = @$labels;
12246: } else {
12247: for (my $i=0;$i<@{$Values[0]};$i++) {
12248: push (@Labels,$i+1);
12249: }
12250: }
12251: #
1.129 matthew 12252: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12253: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12254: my %ValuesHash;
12255: my $NumSets=1;
12256: foreach my $array (@Values) {
12257: next if (! ref($array));
1.136 matthew 12258: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12259: join(',',@$array);
1.129 matthew 12260: }
1.127 matthew 12261: #
1.136 matthew 12262: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12263: if ($NumBars < 3) {
12264: $width = 120+$NumBars*32;
1.220 matthew 12265: $xskip = 1;
1.225 matthew 12266: $bar_width = 30;
12267: } elsif ($NumBars < 5) {
12268: $width = 120+$NumBars*20;
12269: $xskip = 1;
12270: $bar_width = 20;
1.220 matthew 12271: } elsif ($NumBars < 10) {
1.136 matthew 12272: $width = 120+$NumBars*15;
12273: $xskip = 1;
12274: $bar_width = 15;
12275: } elsif ($NumBars <= 25) {
12276: $width = 120+$NumBars*11;
12277: $xskip = 5;
12278: $bar_width = 8;
12279: } elsif ($NumBars <= 50) {
12280: $width = 120+$NumBars*8;
12281: $xskip = 5;
12282: $bar_width = 4;
12283: } else {
12284: $width = 120+$NumBars*8;
12285: $xskip = 5;
12286: $bar_width = 4;
12287: }
12288: #
1.137 matthew 12289: $Max = 1 if ($Max < 1);
12290: if ( int($Max) < $Max ) {
12291: $Max++;
12292: $Max = int($Max);
12293: }
1.127 matthew 12294: $Title = '' if (! defined($Title));
12295: $xlabel = '' if (! defined($xlabel));
12296: $ylabel = '' if (! defined($ylabel));
1.369 www 12297: $ValuesHash{$id.'.title'} = &escape($Title);
12298: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12299: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12300: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12301: $ValuesHash{$id.'.NumBars'} = $NumBars;
12302: $ValuesHash{$id.'.NumSets'} = $NumSets;
12303: $ValuesHash{$id.'.PlotType'} = 'bar';
12304: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12305: $ValuesHash{$id.'.height'} = $height;
12306: $ValuesHash{$id.'.width'} = $width;
12307: $ValuesHash{$id.'.xskip'} = $xskip;
12308: $ValuesHash{$id.'.bar_width'} = $bar_width;
12309: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12310: #
1.228 matthew 12311: # Deal with other parameters
12312: while (my ($key,$value) = each(%$extra_settings)) {
12313: $ValuesHash{$id.'.'.$key} = $value;
12314: }
12315: #
1.646 raeburn 12316: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12317: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12318: }
12319:
12320: ############################################################
12321: ############################################################
12322:
12323: =pod
12324:
1.648 raeburn 12325: =item * &DrawXYGraph()
1.137 matthew 12326:
1.138 matthew 12327: Facilitates the plotting of data in an XY graph.
12328: Puts plot definition data into the users environment in order for
12329: graph.png to plot it. Returns an <img> tag for the plot.
12330:
12331: Inputs:
12332:
12333: =over 4
12334:
12335: =item $Title: string, the title of the plot
12336:
12337: =item $xlabel: string, text describing the X-axis of the plot
12338:
12339: =item $ylabel: string, text describing the Y-axis of the plot
12340:
12341: =item $Max: scalar, the maximum Y value to use in the plot
12342: If $Max is < any data point, the graph will not be rendered.
12343:
12344: =item $colors: Array ref containing the hex color codes for the data to be
12345: plotted in. If undefined, default values will be used.
12346:
12347: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12348:
12349: =item $Ydata: Array ref containing Array refs.
1.185 www 12350: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12351:
12352: =item %Values: hash indicating or overriding any default values which are
12353: passed to graph.png.
12354: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12355:
12356: =back
12357:
12358: Returns:
12359:
12360: An <img> tag which references graph.png and the appropriate identifying
12361: information for the plot.
12362:
1.137 matthew 12363: =cut
12364:
12365: ############################################################
12366: ############################################################
12367: sub DrawXYGraph {
12368: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12369: #
12370: # Create the identifier for the graph
12371: my $identifier = &get_cgi_id();
12372: my $id = 'cgi.'.$identifier;
12373: #
12374: $Title = '' if (! defined($Title));
12375: $xlabel = '' if (! defined($xlabel));
12376: $ylabel = '' if (! defined($ylabel));
12377: my %ValuesHash =
12378: (
1.369 www 12379: $id.'.title' => &escape($Title),
12380: $id.'.xlabel' => &escape($xlabel),
12381: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12382: $id.'.y_max_value'=> $Max,
12383: $id.'.labels' => join(',',@$Xlabels),
12384: $id.'.PlotType' => 'XY',
12385: );
12386: #
12387: if (defined($colors) && ref($colors) eq 'ARRAY') {
12388: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12389: }
12390: #
12391: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12392: return '';
12393: }
12394: my $NumSets=1;
1.138 matthew 12395: foreach my $array (@{$Ydata}){
1.137 matthew 12396: next if (! ref($array));
12397: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12398: }
1.138 matthew 12399: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12400: #
12401: # Deal with other parameters
12402: while (my ($key,$value) = each(%Values)) {
12403: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12404: }
12405: #
1.646 raeburn 12406: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12407: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12408: }
12409:
12410: ############################################################
12411: ############################################################
12412:
12413: =pod
12414:
1.648 raeburn 12415: =item * &DrawXYYGraph()
1.138 matthew 12416:
12417: Facilitates the plotting of data in an XY graph with two Y axes.
12418: Puts plot definition data into the users environment in order for
12419: graph.png to plot it. Returns an <img> tag for the plot.
12420:
12421: Inputs:
12422:
12423: =over 4
12424:
12425: =item $Title: string, the title of the plot
12426:
12427: =item $xlabel: string, text describing the X-axis of the plot
12428:
12429: =item $ylabel: string, text describing the Y-axis of the plot
12430:
12431: =item $colors: Array ref containing the hex color codes for the data to be
12432: plotted in. If undefined, default values will be used.
12433:
12434: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12435:
12436: =item $Ydata1: The first data set
12437:
12438: =item $Min1: The minimum value of the left Y-axis
12439:
12440: =item $Max1: The maximum value of the left Y-axis
12441:
12442: =item $Ydata2: The second data set
12443:
12444: =item $Min2: The minimum value of the right Y-axis
12445:
12446: =item $Max2: The maximum value of the left Y-axis
12447:
12448: =item %Values: hash indicating or overriding any default values which are
12449: passed to graph.png.
12450: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12451:
12452: =back
12453:
12454: Returns:
12455:
12456: An <img> tag which references graph.png and the appropriate identifying
12457: information for the plot.
1.136 matthew 12458:
12459: =cut
12460:
12461: ############################################################
12462: ############################################################
1.137 matthew 12463: sub DrawXYYGraph {
12464: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12465: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12466: #
12467: # Create the identifier for the graph
12468: my $identifier = &get_cgi_id();
12469: my $id = 'cgi.'.$identifier;
12470: #
12471: $Title = '' if (! defined($Title));
12472: $xlabel = '' if (! defined($xlabel));
12473: $ylabel = '' if (! defined($ylabel));
12474: my %ValuesHash =
12475: (
1.369 www 12476: $id.'.title' => &escape($Title),
12477: $id.'.xlabel' => &escape($xlabel),
12478: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12479: $id.'.labels' => join(',',@$Xlabels),
12480: $id.'.PlotType' => 'XY',
12481: $id.'.NumSets' => 2,
1.137 matthew 12482: $id.'.two_axes' => 1,
12483: $id.'.y1_max_value' => $Max1,
12484: $id.'.y1_min_value' => $Min1,
12485: $id.'.y2_max_value' => $Max2,
12486: $id.'.y2_min_value' => $Min2,
1.136 matthew 12487: );
12488: #
1.137 matthew 12489: if (defined($colors) && ref($colors) eq 'ARRAY') {
12490: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12491: }
12492: #
12493: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12494: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12495: return '';
12496: }
12497: my $NumSets=1;
1.137 matthew 12498: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12499: next if (! ref($array));
12500: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12501: }
12502: #
12503: # Deal with other parameters
12504: while (my ($key,$value) = each(%Values)) {
12505: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12506: }
12507: #
1.646 raeburn 12508: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12509: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12510: }
12511:
12512: ############################################################
12513: ############################################################
12514:
12515: =pod
12516:
1.157 matthew 12517: =back
12518:
1.139 matthew 12519: =head1 Statistics helper routines?
12520:
12521: Bad place for them but what the hell.
12522:
1.157 matthew 12523: =over 4
12524:
1.648 raeburn 12525: =item * &chartlink()
1.139 matthew 12526:
12527: Returns a link to the chart for a specific student.
12528:
12529: Inputs:
12530:
12531: =over 4
12532:
12533: =item $linktext: The text of the link
12534:
12535: =item $sname: The students username
12536:
12537: =item $sdomain: The students domain
12538:
12539: =back
12540:
1.157 matthew 12541: =back
12542:
1.139 matthew 12543: =cut
12544:
12545: ############################################################
12546: ############################################################
12547: sub chartlink {
12548: my ($linktext, $sname, $sdomain) = @_;
12549: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12550: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12551: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12552: '">'.$linktext.'</a>';
1.153 matthew 12553: }
12554:
12555: #######################################################
12556: #######################################################
12557:
12558: =pod
12559:
12560: =head1 Course Environment Routines
1.157 matthew 12561:
12562: =over 4
1.153 matthew 12563:
1.648 raeburn 12564: =item * &restore_course_settings()
1.153 matthew 12565:
1.648 raeburn 12566: =item * &store_course_settings()
1.153 matthew 12567:
12568: Restores/Store indicated form parameters from the course environment.
12569: Will not overwrite existing values of the form parameters.
12570:
12571: Inputs:
12572: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12573:
12574: a hash ref describing the data to be stored. For example:
12575:
12576: %Save_Parameters = ('Status' => 'scalar',
12577: 'chartoutputmode' => 'scalar',
12578: 'chartoutputdata' => 'scalar',
12579: 'Section' => 'array',
1.373 raeburn 12580: 'Group' => 'array',
1.153 matthew 12581: 'StudentData' => 'array',
12582: 'Maps' => 'array');
12583:
12584: Returns: both routines return nothing
12585:
1.631 raeburn 12586: =back
12587:
1.153 matthew 12588: =cut
12589:
12590: #######################################################
12591: #######################################################
12592: sub store_course_settings {
1.496 albertel 12593: return &store_settings($env{'request.course.id'},@_);
12594: }
12595:
12596: sub store_settings {
1.153 matthew 12597: # save to the environment
12598: # appenv the same items, just to be safe
1.300 albertel 12599: my $udom = $env{'user.domain'};
12600: my $uname = $env{'user.name'};
1.496 albertel 12601: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12602: my %SaveHash;
12603: my %AppHash;
12604: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12605: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12606: my $envname = 'environment.'.$basename;
1.258 albertel 12607: if (exists($env{'form.'.$setting})) {
1.153 matthew 12608: # Save this value away
12609: if ($type eq 'scalar' &&
1.258 albertel 12610: (! exists($env{$envname}) ||
12611: $env{$envname} ne $env{'form.'.$setting})) {
12612: $SaveHash{$basename} = $env{'form.'.$setting};
12613: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12614: } elsif ($type eq 'array') {
12615: my $stored_form;
1.258 albertel 12616: if (ref($env{'form.'.$setting})) {
1.153 matthew 12617: $stored_form = join(',',
12618: map {
1.369 www 12619: &escape($_);
1.258 albertel 12620: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12621: } else {
12622: $stored_form =
1.369 www 12623: &escape($env{'form.'.$setting});
1.153 matthew 12624: }
12625: # Determine if the array contents are the same.
1.258 albertel 12626: if ($stored_form ne $env{$envname}) {
1.153 matthew 12627: $SaveHash{$basename} = $stored_form;
12628: $AppHash{$envname} = $stored_form;
12629: }
12630: }
12631: }
12632: }
12633: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12634: $udom,$uname);
1.153 matthew 12635: if ($put_result !~ /^(ok|delayed)/) {
12636: &Apache::lonnet::logthis('unable to save form parameters, '.
12637: 'got error:'.$put_result);
12638: }
12639: # Make sure these settings stick around in this session, too
1.646 raeburn 12640: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12641: return;
12642: }
12643:
12644: sub restore_course_settings {
1.499 albertel 12645: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12646: }
12647:
12648: sub restore_settings {
12649: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12650: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12651: next if (exists($env{'form.'.$setting}));
1.496 albertel 12652: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12653: '.'.$setting;
1.258 albertel 12654: if (exists($env{$envname})) {
1.153 matthew 12655: if ($type eq 'scalar') {
1.258 albertel 12656: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12657: } elsif ($type eq 'array') {
1.258 albertel 12658: $env{'form.'.$setting} = [
1.153 matthew 12659: map {
1.369 www 12660: &unescape($_);
1.258 albertel 12661: } split(',',$env{$envname})
1.153 matthew 12662: ];
12663: }
12664: }
12665: }
1.127 matthew 12666: }
12667:
1.618 raeburn 12668: #######################################################
12669: #######################################################
12670:
12671: =pod
12672:
12673: =head1 Domain E-mail Routines
12674:
12675: =over 4
12676:
1.648 raeburn 12677: =item * &build_recipient_list()
1.618 raeburn 12678:
1.884 raeburn 12679: Build recipient lists for five types of e-mail:
1.766 raeburn 12680: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12681: (d) Help requests, (e) Course requests needing approval, generated by
12682: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12683: loncoursequeueadmin.pm respectively.
1.618 raeburn 12684:
12685: Inputs:
1.619 raeburn 12686: defmail (scalar - email address of default recipient),
1.618 raeburn 12687: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12688: defdom (domain for which to retrieve configuration settings),
12689: origmail (scalar - email address of recipient from loncapa.conf,
12690: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12691:
1.655 raeburn 12692: Returns: comma separated list of addresses to which to send e-mail.
12693:
12694: =back
1.618 raeburn 12695:
12696: =cut
12697:
12698: ############################################################
12699: ############################################################
12700: sub build_recipient_list {
1.619 raeburn 12701: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12702: my @recipients;
12703: my $otheremails;
12704: my %domconfig =
12705: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12706: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12707: if (exists($domconfig{'contacts'}{$mailing})) {
12708: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12709: my @contacts = ('adminemail','supportemail');
12710: foreach my $item (@contacts) {
12711: if ($domconfig{'contacts'}{$mailing}{$item}) {
12712: my $addr = $domconfig{'contacts'}{$item};
12713: if (!grep(/^\Q$addr\E$/,@recipients)) {
12714: push(@recipients,$addr);
12715: }
1.619 raeburn 12716: }
1.766 raeburn 12717: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12718: }
12719: }
1.766 raeburn 12720: } elsif ($origmail ne '') {
12721: push(@recipients,$origmail);
1.618 raeburn 12722: }
1.619 raeburn 12723: } elsif ($origmail ne '') {
12724: push(@recipients,$origmail);
1.618 raeburn 12725: }
1.688 raeburn 12726: if (defined($defmail)) {
12727: if ($defmail ne '') {
12728: push(@recipients,$defmail);
12729: }
1.618 raeburn 12730: }
12731: if ($otheremails) {
1.619 raeburn 12732: my @others;
12733: if ($otheremails =~ /,/) {
12734: @others = split(/,/,$otheremails);
1.618 raeburn 12735: } else {
1.619 raeburn 12736: push(@others,$otheremails);
12737: }
12738: foreach my $addr (@others) {
12739: if (!grep(/^\Q$addr\E$/,@recipients)) {
12740: push(@recipients,$addr);
12741: }
1.618 raeburn 12742: }
12743: }
1.619 raeburn 12744: my $recipientlist = join(',',@recipients);
1.618 raeburn 12745: return $recipientlist;
12746: }
12747:
1.127 matthew 12748: ############################################################
12749: ############################################################
1.154 albertel 12750:
1.655 raeburn 12751: =pod
12752:
12753: =head1 Course Catalog Routines
12754:
12755: =over 4
12756:
12757: =item * &gather_categories()
12758:
12759: Converts category definitions - keys of categories hash stored in
12760: coursecategories in configuration.db on the primary library server in a
12761: domain - to an array. Also generates javascript and idx hash used to
12762: generate Domain Coordinator interface for editing Course Categories.
12763:
12764: Inputs:
1.663 raeburn 12765:
1.655 raeburn 12766: categories (reference to hash of category definitions).
1.663 raeburn 12767:
1.655 raeburn 12768: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12769: categories and subcategories).
1.663 raeburn 12770:
1.655 raeburn 12771: idx (reference to hash of counters used in Domain Coordinator interface for
12772: editing Course Categories).
1.663 raeburn 12773:
1.655 raeburn 12774: jsarray (reference to array of categories used to create Javascript arrays for
12775: Domain Coordinator interface for editing Course Categories).
12776:
12777: Returns: nothing
12778:
12779: Side effects: populates cats, idx and jsarray.
12780:
12781: =cut
12782:
12783: sub gather_categories {
12784: my ($categories,$cats,$idx,$jsarray) = @_;
12785: my %counters;
12786: my $num = 0;
12787: foreach my $item (keys(%{$categories})) {
12788: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12789: if ($container eq '' && $depth == 0) {
12790: $cats->[$depth][$categories->{$item}] = $cat;
12791: } else {
12792: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12793: }
12794: my ($escitem,$tail) = split(/:/,$item,2);
12795: if ($counters{$tail} eq '') {
12796: $counters{$tail} = $num;
12797: $num ++;
12798: }
12799: if (ref($idx) eq 'HASH') {
12800: $idx->{$item} = $counters{$tail};
12801: }
12802: if (ref($jsarray) eq 'ARRAY') {
12803: push(@{$jsarray->[$counters{$tail}]},$item);
12804: }
12805: }
12806: return;
12807: }
12808:
12809: =pod
12810:
12811: =item * &extract_categories()
12812:
12813: Used to generate breadcrumb trails for course categories.
12814:
12815: Inputs:
1.663 raeburn 12816:
1.655 raeburn 12817: categories (reference to hash of category definitions).
1.663 raeburn 12818:
1.655 raeburn 12819: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12820: categories and subcategories).
1.663 raeburn 12821:
1.655 raeburn 12822: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12823:
1.655 raeburn 12824: allitems (reference to hash - key is category key
12825: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12826:
1.655 raeburn 12827: idx (reference to hash of counters used in Domain Coordinator interface for
12828: editing Course Categories).
1.663 raeburn 12829:
1.655 raeburn 12830: jsarray (reference to array of categories used to create Javascript arrays for
12831: Domain Coordinator interface for editing Course Categories).
12832:
1.665 raeburn 12833: subcats (reference to hash of arrays containing all subcategories within each
12834: category, -recursive)
12835:
1.655 raeburn 12836: Returns: nothing
12837:
12838: Side effects: populates trails and allitems hash references.
12839:
12840: =cut
12841:
12842: sub extract_categories {
1.665 raeburn 12843: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12844: if (ref($categories) eq 'HASH') {
12845: &gather_categories($categories,$cats,$idx,$jsarray);
12846: if (ref($cats->[0]) eq 'ARRAY') {
12847: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12848: my $name = $cats->[0][$i];
12849: my $item = &escape($name).'::0';
12850: my $trailstr;
12851: if ($name eq 'instcode') {
12852: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12853: } elsif ($name eq 'communities') {
12854: $trailstr = &mt('Communities');
1.655 raeburn 12855: } else {
12856: $trailstr = $name;
12857: }
12858: if ($allitems->{$item} eq '') {
12859: push(@{$trails},$trailstr);
12860: $allitems->{$item} = scalar(@{$trails})-1;
12861: }
12862: my @parents = ($name);
12863: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12864: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12865: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12866: if (ref($subcats) eq 'HASH') {
12867: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12868: }
12869: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12870: }
12871: } else {
12872: if (ref($subcats) eq 'HASH') {
12873: $subcats->{$item} = [];
1.655 raeburn 12874: }
12875: }
12876: }
12877: }
12878: }
12879: return;
12880: }
12881:
12882: =pod
12883:
12884: =item *&recurse_categories()
12885:
12886: Recursively used to generate breadcrumb trails for course categories.
12887:
12888: Inputs:
1.663 raeburn 12889:
1.655 raeburn 12890: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12891: categories and subcategories).
1.663 raeburn 12892:
1.655 raeburn 12893: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12894:
12895: category (current course category, for which breadcrumb trail is being generated).
12896:
12897: trails (reference to array of breadcrumb trails for each category).
12898:
1.655 raeburn 12899: allitems (reference to hash - key is category key
12900: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12901:
1.655 raeburn 12902: parents (array containing containers directories for current category,
12903: back to top level).
12904:
12905: Returns: nothing
12906:
12907: Side effects: populates trails and allitems hash references
12908:
12909: =cut
12910:
12911: sub recurse_categories {
1.665 raeburn 12912: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12913: my $shallower = $depth - 1;
12914: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12915: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12916: my $name = $cats->[$depth]{$category}[$k];
12917: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12918: my $trailstr = join(' -> ',(@{$parents},$category));
12919: if ($allitems->{$item} eq '') {
12920: push(@{$trails},$trailstr);
12921: $allitems->{$item} = scalar(@{$trails})-1;
12922: }
12923: my $deeper = $depth+1;
12924: push(@{$parents},$category);
1.665 raeburn 12925: if (ref($subcats) eq 'HASH') {
12926: my $subcat = &escape($name).':'.$category.':'.$depth;
12927: for (my $j=@{$parents}; $j>=0; $j--) {
12928: my $higher;
12929: if ($j > 0) {
12930: $higher = &escape($parents->[$j]).':'.
12931: &escape($parents->[$j-1]).':'.$j;
12932: } else {
12933: $higher = &escape($parents->[$j]).'::'.$j;
12934: }
12935: push(@{$subcats->{$higher}},$subcat);
12936: }
12937: }
12938: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12939: $subcats);
1.655 raeburn 12940: pop(@{$parents});
12941: }
12942: } else {
12943: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12944: my $trailstr = join(' -> ',(@{$parents},$category));
12945: if ($allitems->{$item} eq '') {
12946: push(@{$trails},$trailstr);
12947: $allitems->{$item} = scalar(@{$trails})-1;
12948: }
12949: }
12950: return;
12951: }
12952:
1.663 raeburn 12953: =pod
12954:
12955: =item *&assign_categories_table()
12956:
12957: Create a datatable for display of hierarchical categories in a domain,
12958: with checkboxes to allow a course to be categorized.
12959:
12960: Inputs:
12961:
12962: cathash - reference to hash of categories defined for the domain (from
12963: configuration.db)
12964:
12965: currcat - scalar with an & separated list of categories assigned to a course.
12966:
1.919 raeburn 12967: type - scalar contains course type (Course or Community).
12968:
1.663 raeburn 12969: Returns: $output (markup to be displayed)
12970:
12971: =cut
12972:
12973: sub assign_categories_table {
1.919 raeburn 12974: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12975: my $output;
12976: if (ref($cathash) eq 'HASH') {
12977: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12978: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12979: $maxdepth = scalar(@cats);
12980: if (@cats > 0) {
12981: my $itemcount = 0;
12982: if (ref($cats[0]) eq 'ARRAY') {
12983: my @currcategories;
12984: if ($currcat ne '') {
12985: @currcategories = split('&',$currcat);
12986: }
1.919 raeburn 12987: my $table;
1.663 raeburn 12988: for (my $i=0; $i<@{$cats[0]}; $i++) {
12989: my $parent = $cats[0][$i];
1.919 raeburn 12990: next if ($parent eq 'instcode');
12991: if ($type eq 'Community') {
12992: next unless ($parent eq 'communities');
12993: } else {
12994: next if ($parent eq 'communities');
12995: }
1.663 raeburn 12996: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12997: my $item = &escape($parent).'::0';
12998: my $checked = '';
12999: if (@currcategories > 0) {
13000: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13001: $checked = ' checked="checked"';
1.663 raeburn 13002: }
13003: }
1.919 raeburn 13004: my $parent_title = $parent;
13005: if ($parent eq 'communities') {
13006: $parent_title = &mt('Communities');
13007: }
13008: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13009: '<input type="checkbox" name="usecategory" value="'.
13010: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13011: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13012: my $depth = 1;
13013: push(@path,$parent);
1.919 raeburn 13014: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13015: pop(@path);
1.919 raeburn 13016: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13017: $itemcount ++;
13018: }
1.919 raeburn 13019: if ($itemcount) {
13020: $output = &Apache::loncommon::start_data_table().
13021: $table.
13022: &Apache::loncommon::end_data_table();
13023: }
1.663 raeburn 13024: }
13025: }
13026: }
13027: return $output;
13028: }
13029:
13030: =pod
13031:
13032: =item *&assign_category_rows()
13033:
13034: Create a datatable row for display of nested categories in a domain,
13035: with checkboxes to allow a course to be categorized,called recursively.
13036:
13037: Inputs:
13038:
13039: itemcount - track row number for alternating colors
13040:
13041: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13042: categories and subcategories.
13043:
13044: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13045:
13046: parent - parent of current category item
13047:
13048: path - Array containing all categories back up through the hierarchy from the
13049: current category to the top level.
13050:
13051: currcategories - reference to array of current categories assigned to the course
13052:
13053: Returns: $output (markup to be displayed).
13054:
13055: =cut
13056:
13057: sub assign_category_rows {
13058: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13059: my ($text,$name,$item,$chgstr);
13060: if (ref($cats) eq 'ARRAY') {
13061: my $maxdepth = scalar(@{$cats});
13062: if (ref($cats->[$depth]) eq 'HASH') {
13063: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13064: my $numchildren = @{$cats->[$depth]{$parent}};
13065: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13066: $text .= '<td><table class="LC_datatable">';
13067: for (my $j=0; $j<$numchildren; $j++) {
13068: $name = $cats->[$depth]{$parent}[$j];
13069: $item = &escape($name).':'.&escape($parent).':'.$depth;
13070: my $deeper = $depth+1;
13071: my $checked = '';
13072: if (ref($currcategories) eq 'ARRAY') {
13073: if (@{$currcategories} > 0) {
13074: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13075: $checked = ' checked="checked"';
1.663 raeburn 13076: }
13077: }
13078: }
1.664 raeburn 13079: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13080: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13081: $item.'"'.$checked.' />'.$name.'</label></span>'.
13082: '<input type="hidden" name="catname" value="'.$name.'" />'.
13083: '</td><td>';
1.663 raeburn 13084: if (ref($path) eq 'ARRAY') {
13085: push(@{$path},$name);
13086: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13087: pop(@{$path});
13088: }
13089: $text .= '</td></tr>';
13090: }
13091: $text .= '</table></td>';
13092: }
13093: }
13094: }
13095: return $text;
13096: }
13097:
1.655 raeburn 13098: ############################################################
13099: ############################################################
13100:
13101:
1.443 albertel 13102: sub commit_customrole {
1.664 raeburn 13103: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13104: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13105: ($start?', '.&mt('starting').' '.localtime($start):'').
13106: ($end?', ending '.localtime($end):'').': <b>'.
13107: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13108: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13109: '</b><br />';
13110: return $output;
13111: }
13112:
13113: sub commit_standardrole {
1.541 raeburn 13114: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
13115: my ($output,$logmsg,$linefeed);
13116: if ($context eq 'auto') {
13117: $linefeed = "\n";
13118: } else {
13119: $linefeed = "<br />\n";
13120: }
1.443 albertel 13121: if ($three eq 'st') {
1.541 raeburn 13122: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
13123: $one,$two,$sec,$context);
13124: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13125: ($result eq 'unknown_course') || ($result eq 'refused')) {
13126: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13127: } else {
1.541 raeburn 13128: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13129: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13130: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13131: if ($context eq 'auto') {
13132: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13133: } else {
13134: $output .= '<b>'.$result.'</b>'.$linefeed.
13135: &mt('Add to classlist').': <b>ok</b>';
13136: }
13137: $output .= $linefeed;
1.443 albertel 13138: }
13139: } else {
13140: $output = &mt('Assigning').' '.$three.' in '.$url.
13141: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13142: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13143: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13144: if ($context eq 'auto') {
13145: $output .= $result.$linefeed;
13146: } else {
13147: $output .= '<b>'.$result.'</b>'.$linefeed;
13148: }
1.443 albertel 13149: }
13150: return $output;
13151: }
13152:
13153: sub commit_studentrole {
1.541 raeburn 13154: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 13155: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13156: if ($context eq 'auto') {
13157: $linefeed = "\n";
13158: } else {
13159: $linefeed = '<br />'."\n";
13160: }
1.443 albertel 13161: if (defined($one) && defined($two)) {
13162: my $cid=$one.'_'.$two;
13163: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13164: my $secchange = 0;
13165: my $expire_role_result;
13166: my $modify_section_result;
1.628 raeburn 13167: if ($oldsec ne '-1') {
13168: if ($oldsec ne $sec) {
1.443 albertel 13169: $secchange = 1;
1.628 raeburn 13170: my $now = time;
1.443 albertel 13171: my $uurl='/'.$cid;
13172: $uurl=~s/\_/\//g;
13173: if ($oldsec) {
13174: $uurl.='/'.$oldsec;
13175: }
1.626 raeburn 13176: $oldsecurl = $uurl;
1.628 raeburn 13177: $expire_role_result =
1.652 raeburn 13178: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13179: if ($env{'request.course.sec'} ne '') {
13180: if ($expire_role_result eq 'refused') {
13181: my @roles = ('st');
13182: my @statuses = ('previous');
13183: my @roledoms = ($one);
13184: my $withsec = 1;
13185: my %roleshash =
13186: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13187: \@statuses,\@roles,\@roledoms,$withsec);
13188: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13189: my ($oldstart,$oldend) =
13190: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13191: if ($oldend > 0 && $oldend <= $now) {
13192: $expire_role_result = 'ok';
13193: }
13194: }
13195: }
13196: }
1.443 albertel 13197: $result = $expire_role_result;
13198: }
13199: }
13200: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13201: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13202: if ($modify_section_result =~ /^ok/) {
13203: if ($secchange == 1) {
1.628 raeburn 13204: if ($sec eq '') {
13205: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13206: } else {
13207: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13208: }
1.443 albertel 13209: } elsif ($oldsec eq '-1') {
1.628 raeburn 13210: if ($sec eq '') {
13211: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13212: } else {
13213: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13214: }
1.443 albertel 13215: } else {
1.628 raeburn 13216: if ($sec eq '') {
13217: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13218: } else {
13219: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13220: }
1.443 albertel 13221: }
13222: } else {
1.628 raeburn 13223: if ($secchange) {
13224: $$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;
13225: } else {
13226: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13227: }
1.443 albertel 13228: }
13229: $result = $modify_section_result;
13230: } elsif ($secchange == 1) {
1.628 raeburn 13231: if ($oldsec eq '') {
13232: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13233: } else {
13234: $$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;
13235: }
1.626 raeburn 13236: if ($expire_role_result eq 'refused') {
13237: my $newsecurl = '/'.$cid;
13238: $newsecurl =~ s/\_/\//g;
13239: if ($sec ne '') {
13240: $newsecurl.='/'.$sec;
13241: }
13242: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13243: if ($sec eq '') {
13244: $$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;
13245: } else {
13246: $$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;
13247: }
13248: }
13249: }
1.443 albertel 13250: }
13251: } else {
1.626 raeburn 13252: $$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 13253: $result = "error: incomplete course id\n";
13254: }
13255: return $result;
13256: }
13257:
13258: ############################################################
13259: ############################################################
13260:
1.566 albertel 13261: sub check_clone {
1.578 raeburn 13262: my ($args,$linefeed) = @_;
1.566 albertel 13263: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13264: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13265: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13266: my $clonemsg;
13267: my $can_clone = 0;
1.944 raeburn 13268: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13269: if ($lctype ne 'community') {
13270: $lctype = 'course';
13271: }
1.566 albertel 13272: if ($clonehome eq 'no_host') {
1.944 raeburn 13273: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13274: $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'});
13275: } else {
13276: $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'});
13277: }
1.566 albertel 13278: } else {
13279: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13280: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13281: if ($clonedesc{'type'} ne 'Community') {
13282: $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'});
13283: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13284: }
13285: }
1.882 raeburn 13286: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13287: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13288: $can_clone = 1;
13289: } else {
13290: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13291: $args->{'clonedomain'},$args->{'clonecourse'});
13292: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13293: if (grep(/^\*$/,@cloners)) {
13294: $can_clone = 1;
13295: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13296: $can_clone = 1;
13297: } else {
1.908 raeburn 13298: my $ccrole = 'cc';
1.944 raeburn 13299: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13300: $ccrole = 'co';
13301: }
1.578 raeburn 13302: my %roleshash =
13303: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13304: $args->{'ccdomain'},
1.908 raeburn 13305: 'userroles',['active'],[$ccrole],
1.578 raeburn 13306: [$args->{'clonedomain'}]);
1.908 raeburn 13307: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13308: $can_clone = 1;
13309: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13310: $can_clone = 1;
13311: } else {
1.944 raeburn 13312: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13313: $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'});
13314: } else {
13315: $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'});
13316: }
1.578 raeburn 13317: }
1.566 albertel 13318: }
1.578 raeburn 13319: }
1.566 albertel 13320: }
13321: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13322: }
13323:
1.444 albertel 13324: sub construct_course {
1.885 raeburn 13325: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13326: my $outcome;
1.541 raeburn 13327: my $linefeed = '<br />'."\n";
13328: if ($context eq 'auto') {
13329: $linefeed = "\n";
13330: }
1.566 albertel 13331:
13332: #
13333: # Are we cloning?
13334: #
13335: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13336: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13337: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13338: if ($context ne 'auto') {
1.578 raeburn 13339: if ($clonemsg ne '') {
13340: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13341: }
1.566 albertel 13342: }
13343: $outcome .= $clonemsg.$linefeed;
13344:
13345: if (!$can_clone) {
13346: return (0,$outcome);
13347: }
13348: }
13349:
1.444 albertel 13350: #
13351: # Open course
13352: #
13353: my $crstype = lc($args->{'crstype'});
13354: my %cenv=();
13355: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13356: $args->{'cdescr'},
13357: $args->{'curl'},
13358: $args->{'course_home'},
13359: $args->{'nonstandard'},
13360: $args->{'crscode'},
13361: $args->{'ccuname'}.':'.
13362: $args->{'ccdomain'},
1.882 raeburn 13363: $args->{'crstype'},
1.885 raeburn 13364: $cnum,$context,$category);
1.444 albertel 13365:
13366: # Note: The testing routines depend on this being output; see
13367: # Utils::Course. This needs to at least be output as a comment
13368: # if anyone ever decides to not show this, and Utils::Course::new
13369: # will need to be suitably modified.
1.541 raeburn 13370: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13371: if ($$courseid =~ /^error:/) {
13372: return (0,$outcome);
13373: }
13374:
1.444 albertel 13375: #
13376: # Check if created correctly
13377: #
1.479 albertel 13378: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13379: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13380: if ($crsuhome eq 'no_host') {
13381: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13382: return (0,$outcome);
13383: }
1.541 raeburn 13384: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13385:
1.444 albertel 13386: #
1.566 albertel 13387: # Do the cloning
13388: #
13389: if ($can_clone && $cloneid) {
13390: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13391: if ($context ne 'auto') {
13392: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13393: }
13394: $outcome .= $clonemsg.$linefeed;
13395: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13396: # Copy all files
1.637 www 13397: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13398: # Restore URL
1.566 albertel 13399: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13400: # Restore title
1.566 albertel 13401: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13402: # Restore creation date, creator and creation context.
13403: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13404: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13405: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13406: # Mark as cloned
1.566 albertel 13407: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13408: # Need to clone grading mode
13409: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13410: $cenv{'grading'}=$newenv{'grading'};
13411: # Do not clone these environment entries
13412: &Apache::lonnet::del('environment',
13413: ['default_enrollment_start_date',
13414: 'default_enrollment_end_date',
13415: 'question.email',
13416: 'policy.email',
13417: 'comment.email',
13418: 'pch.users.denied',
1.725 raeburn 13419: 'plc.users.denied',
13420: 'hidefromcat',
13421: 'categories'],
1.638 www 13422: $$crsudom,$$crsunum);
1.444 albertel 13423: }
1.566 albertel 13424:
1.444 albertel 13425: #
13426: # Set environment (will override cloned, if existing)
13427: #
13428: my @sections = ();
13429: my @xlists = ();
13430: if ($args->{'crstype'}) {
13431: $cenv{'type'}=$args->{'crstype'};
13432: }
13433: if ($args->{'crsid'}) {
13434: $cenv{'courseid'}=$args->{'crsid'};
13435: }
13436: if ($args->{'crscode'}) {
13437: $cenv{'internal.coursecode'}=$args->{'crscode'};
13438: }
13439: if ($args->{'crsquota'} ne '') {
13440: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13441: } else {
13442: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13443: }
13444: if ($args->{'ccuname'}) {
13445: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13446: ':'.$args->{'ccdomain'};
13447: } else {
13448: $cenv{'internal.courseowner'} = $args->{'curruser'};
13449: }
13450: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13451: if ($args->{'crssections'}) {
13452: $cenv{'internal.sectionnums'} = '';
13453: if ($args->{'crssections'} =~ m/,/) {
13454: @sections = split/,/,$args->{'crssections'};
13455: } else {
13456: $sections[0] = $args->{'crssections'};
13457: }
13458: if (@sections > 0) {
13459: foreach my $item (@sections) {
13460: my ($sec,$gp) = split/:/,$item;
13461: my $class = $args->{'crscode'}.$sec;
13462: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13463: $cenv{'internal.sectionnums'} .= $item.',';
13464: unless ($addcheck eq 'ok') {
13465: push @badclasses, $class;
13466: }
13467: }
13468: $cenv{'internal.sectionnums'} =~ s/,$//;
13469: }
13470: }
13471: # do not hide course coordinator from staff listing,
13472: # even if privileged
13473: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13474: # add crosslistings
13475: if ($args->{'crsxlist'}) {
13476: $cenv{'internal.crosslistings'}='';
13477: if ($args->{'crsxlist'} =~ m/,/) {
13478: @xlists = split/,/,$args->{'crsxlist'};
13479: } else {
13480: $xlists[0] = $args->{'crsxlist'};
13481: }
13482: if (@xlists > 0) {
13483: foreach my $item (@xlists) {
13484: my ($xl,$gp) = split/:/,$item;
13485: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13486: $cenv{'internal.crosslistings'} .= $item.',';
13487: unless ($addcheck eq 'ok') {
13488: push @badclasses, $xl;
13489: }
13490: }
13491: $cenv{'internal.crosslistings'} =~ s/,$//;
13492: }
13493: }
13494: if ($args->{'autoadds'}) {
13495: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13496: }
13497: if ($args->{'autodrops'}) {
13498: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13499: }
13500: # check for notification of enrollment changes
13501: my @notified = ();
13502: if ($args->{'notify_owner'}) {
13503: if ($args->{'ccuname'} ne '') {
13504: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13505: }
13506: }
13507: if ($args->{'notify_dc'}) {
13508: if ($uname ne '') {
1.630 raeburn 13509: push(@notified,$uname.':'.$udom);
1.444 albertel 13510: }
13511: }
13512: if (@notified > 0) {
13513: my $notifylist;
13514: if (@notified > 1) {
13515: $notifylist = join(',',@notified);
13516: } else {
13517: $notifylist = $notified[0];
13518: }
13519: $cenv{'internal.notifylist'} = $notifylist;
13520: }
13521: if (@badclasses > 0) {
13522: my %lt=&Apache::lonlocal::texthash(
13523: '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',
13524: 'dnhr' => 'does not have rights to access enrollment in these classes',
13525: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13526: );
1.541 raeburn 13527: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13528: ' ('.$lt{'adby'}.')';
13529: if ($context eq 'auto') {
13530: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13531: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13532: foreach my $item (@badclasses) {
13533: if ($context eq 'auto') {
13534: $outcome .= " - $item\n";
13535: } else {
13536: $outcome .= "<li>$item</li>\n";
13537: }
13538: }
13539: if ($context eq 'auto') {
13540: $outcome .= $linefeed;
13541: } else {
1.566 albertel 13542: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13543: }
13544: }
1.444 albertel 13545: }
13546: if ($args->{'no_end_date'}) {
13547: $args->{'endaccess'} = 0;
13548: }
13549: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13550: $cenv{'internal.autoend'}=$args->{'enrollend'};
13551: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13552: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13553: if ($args->{'showphotos'}) {
13554: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13555: }
13556: $cenv{'internal.authtype'} = $args->{'authtype'};
13557: $cenv{'internal.autharg'} = $args->{'autharg'};
13558: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13559: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13560: 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');
13561: if ($context eq 'auto') {
13562: $outcome .= $krb_msg;
13563: } else {
1.566 albertel 13564: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13565: }
13566: $outcome .= $linefeed;
1.444 albertel 13567: }
13568: }
13569: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13570: if ($args->{'setpolicy'}) {
13571: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13572: }
13573: if ($args->{'setcontent'}) {
13574: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13575: }
13576: }
13577: if ($args->{'reshome'}) {
13578: $cenv{'reshome'}=$args->{'reshome'}.'/';
13579: $cenv{'reshome'}=~s/\/+$/\//;
13580: }
13581: #
13582: # course has keyed access
13583: #
13584: if ($args->{'setkeys'}) {
13585: $cenv{'keyaccess'}='yes';
13586: }
13587: # if specified, key authority is not course, but user
13588: # only active if keyaccess is yes
13589: if ($args->{'keyauth'}) {
1.487 albertel 13590: my ($user,$domain) = split(':',$args->{'keyauth'});
13591: $user = &LONCAPA::clean_username($user);
13592: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13593: if ($user ne '' && $domain ne '') {
1.487 albertel 13594: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13595: }
13596: }
13597:
13598: if ($args->{'disresdis'}) {
13599: $cenv{'pch.roles.denied'}='st';
13600: }
13601: if ($args->{'disablechat'}) {
13602: $cenv{'plc.roles.denied'}='st';
13603: }
13604:
13605: # Record we've not yet viewed the Course Initialization Helper for this
13606: # course
13607: $cenv{'course.helper.not.run'} = 1;
13608: #
13609: # Use new Randomseed
13610: #
13611: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13612: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13613: #
13614: # The encryption code and receipt prefix for this course
13615: #
13616: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13617: $cenv{'internal.encpref'}=100+int(9*rand(99));
13618: #
13619: # By default, use standard grading
13620: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13621:
1.541 raeburn 13622: $outcome .= $linefeed.&mt('Setting environment').': '.
13623: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13624: #
13625: # Open all assignments
13626: #
13627: if ($args->{'openall'}) {
13628: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13629: my %storecontent = ($storeunder => time,
13630: $storeunder.'.type' => 'date_start');
13631:
13632: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13633: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13634: }
13635: #
13636: # Set first page
13637: #
13638: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13639: || ($cloneid)) {
1.445 albertel 13640: use LONCAPA::map;
1.444 albertel 13641: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13642:
13643: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13644: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13645:
1.444 albertel 13646: $outcome .= ($fatal?$errtext:'read ok').' - ';
13647: my $title; my $url;
13648: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13649: $title=&mt('Syllabus');
1.444 albertel 13650: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13651: } else {
1.963 raeburn 13652: $title=&mt('Table of Contents');
1.444 albertel 13653: $url='/adm/navmaps';
13654: }
1.445 albertel 13655:
13656: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13657: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13658:
13659: if ($errtext) { $fatal=2; }
1.541 raeburn 13660: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13661: }
1.566 albertel 13662:
13663: return (1,$outcome);
1.444 albertel 13664: }
13665:
13666: ############################################################
13667: ############################################################
13668:
1.953 droeschl 13669: #SD
13670: # only Community and Course, or anything else?
1.378 raeburn 13671: sub course_type {
13672: my ($cid) = @_;
13673: if (!defined($cid)) {
13674: $cid = $env{'request.course.id'};
13675: }
1.404 albertel 13676: if (defined($env{'course.'.$cid.'.type'})) {
13677: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13678: } else {
13679: return 'Course';
1.377 raeburn 13680: }
13681: }
1.156 albertel 13682:
1.406 raeburn 13683: sub group_term {
13684: my $crstype = &course_type();
13685: my %names = (
13686: 'Course' => 'group',
1.865 raeburn 13687: 'Community' => 'group',
1.406 raeburn 13688: );
13689: return $names{$crstype};
13690: }
13691:
1.902 raeburn 13692: sub course_types {
13693: my @types = ('official','unofficial','community');
13694: my %typename = (
13695: official => 'Official course',
13696: unofficial => 'Unofficial course',
13697: community => 'Community',
13698: );
13699: return (\@types,\%typename);
13700: }
13701:
1.156 albertel 13702: sub icon {
13703: my ($file)=@_;
1.505 albertel 13704: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13705: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13706: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13707: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13708: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13709: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13710: $curfext.".gif") {
13711: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13712: $curfext.".gif";
13713: }
13714: }
1.249 albertel 13715: return &lonhttpdurl($iconname);
1.154 albertel 13716: }
1.84 albertel 13717:
1.575 albertel 13718: sub lonhttpdurl {
1.692 www 13719: #
13720: # Had been used for "small fry" static images on separate port 8080.
13721: # Modify here if lightweight http functionality desired again.
13722: # Currently eliminated due to increasing firewall issues.
13723: #
1.575 albertel 13724: my ($url)=@_;
1.692 www 13725: return $url;
1.215 albertel 13726: }
13727:
1.213 albertel 13728: sub connection_aborted {
13729: my ($r)=@_;
13730: $r->print(" ");$r->rflush();
13731: my $c = $r->connection;
13732: return $c->aborted();
13733: }
13734:
1.221 foxr 13735: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13736: # strings as 'strings'.
13737: sub escape_single {
1.221 foxr 13738: my ($input) = @_;
1.223 albertel 13739: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13740: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13741: return $input;
13742: }
1.223 albertel 13743:
1.222 foxr 13744: # Same as escape_single, but escape's "'s This
13745: # can be used for "strings"
13746: sub escape_double {
13747: my ($input) = @_;
13748: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13749: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13750: return $input;
13751: }
1.223 albertel 13752:
1.222 foxr 13753: # Escapes the last element of a full URL.
13754: sub escape_url {
13755: my ($url) = @_;
1.238 raeburn 13756: my @urlslices = split(/\//, $url,-1);
1.369 www 13757: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13758: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13759: }
1.462 albertel 13760:
1.820 raeburn 13761: sub compare_arrays {
13762: my ($arrayref1,$arrayref2) = @_;
13763: my (@difference,%count);
13764: @difference = ();
13765: %count = ();
13766: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13767: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13768: foreach my $element (keys(%count)) {
13769: if ($count{$element} == 1) {
13770: push(@difference,$element);
13771: }
13772: }
13773: }
13774: return @difference;
13775: }
13776:
1.817 bisitz 13777: # -------------------------------------------------------- Initialize user login
1.462 albertel 13778: sub init_user_environment {
1.463 albertel 13779: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13780: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13781:
13782: my $public=($username eq 'public' && $domain eq 'public');
13783:
13784: # See if old ID present, if so, remove
13785:
1.1062 raeburn 13786: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13787: my $now=time;
13788:
13789: if ($public) {
13790: my $max_public=100;
13791: my $oldest;
13792: my $oldest_time=0;
13793: for(my $next=1;$next<=$max_public;$next++) {
13794: if (-e $lonids."/publicuser_$next.id") {
13795: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13796: if ($mtime<$oldest_time || !$oldest_time) {
13797: $oldest_time=$mtime;
13798: $oldest=$next;
13799: }
13800: } else {
13801: $cookie="publicuser_$next";
13802: last;
13803: }
13804: }
13805: if (!$cookie) { $cookie="publicuser_$oldest"; }
13806: } else {
1.463 albertel 13807: # if this isn't a robot, kill any existing non-robot sessions
13808: if (!$args->{'robot'}) {
13809: opendir(DIR,$lonids);
13810: while ($filename=readdir(DIR)) {
13811: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13812: unlink($lonids.'/'.$filename);
13813: }
1.462 albertel 13814: }
1.463 albertel 13815: closedir(DIR);
1.462 albertel 13816: }
13817: # Give them a new cookie
1.463 albertel 13818: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13819: : $now.$$.int(rand(10000)));
1.463 albertel 13820: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13821:
13822: # Initialize roles
13823:
1.1062 raeburn 13824: ($userroles,$firstaccenv,$timerintenv) =
13825: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13826: }
13827: # ------------------------------------ Check browser type and MathML capability
13828:
13829: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13830: $clientunicode,$clientos) = &decode_user_agent($r);
13831:
13832: # ------------------------------------------------------------- Get environment
13833:
13834: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13835: my ($tmp) = keys(%userenv);
13836: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13837: } else {
13838: undef(%userenv);
13839: }
13840: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13841: $form->{'interface'}=$userenv{'interface'};
13842: }
13843: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13844:
13845: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13846: foreach my $option ('interface','localpath','localres') {
13847: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13848: }
13849: # --------------------------------------------------------- Write first profile
13850:
13851: {
13852: my %initial_env =
13853: ("user.name" => $username,
13854: "user.domain" => $domain,
13855: "user.home" => $authhost,
13856: "browser.type" => $clientbrowser,
13857: "browser.version" => $clientversion,
13858: "browser.mathml" => $clientmathml,
13859: "browser.unicode" => $clientunicode,
13860: "browser.os" => $clientos,
13861: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13862: "request.course.fn" => '',
13863: "request.course.uri" => '',
13864: "request.course.sec" => '',
13865: "request.role" => 'cm',
13866: "request.role.adv" => $env{'user.adv'},
13867: "request.host" => $ENV{'REMOTE_ADDR'},);
13868:
13869: if ($form->{'localpath'}) {
13870: $initial_env{"browser.localpath"} = $form->{'localpath'};
13871: $initial_env{"browser.localres"} = $form->{'localres'};
13872: }
13873:
13874: if ($form->{'interface'}) {
13875: $form->{'interface'}=~s/\W//gs;
13876: $initial_env{"browser.interface"} = $form->{'interface'};
13877: $env{'browser.interface'}=$form->{'interface'};
13878: }
13879:
1.981 raeburn 13880: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13881: my %domdef;
13882: unless ($domain eq 'public') {
13883: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13884: }
1.980 raeburn 13885:
1.1081 raeburn 13886: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 13887: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13888: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13889: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13890: }
13891:
1.864 raeburn 13892: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13893: $userenv{'canrequest.'.$crstype} =
13894: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13895: 'reload','requestcourses',
13896: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13897: }
13898:
1.1092 raeburn 13899: $userenv{'canrequest.author'} =
13900: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
13901: 'reload','requestauthor',
13902: \%userenv,\%domdef,\%is_adv);
13903: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
13904: $domain,$username);
13905: my $reqstatus = $reqauthor{'author_status'};
13906: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
13907: if (ref($reqauthor{'author'}) eq 'HASH') {
13908: $userenv{'requestauthorqueued'} = $reqstatus.':'.
13909: $reqauthor{'author'}{'timestamp'};
13910: }
13911: }
13912:
1.462 albertel 13913: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13914:
1.462 albertel 13915: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13916: &GDBM_WRCREAT(),0640)) {
13917: &_add_to_env(\%disk_env,\%initial_env);
13918: &_add_to_env(\%disk_env,\%userenv,'environment.');
13919: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13920: if (ref($firstaccenv) eq 'HASH') {
13921: &_add_to_env(\%disk_env,$firstaccenv);
13922: }
13923: if (ref($timerintenv) eq 'HASH') {
13924: &_add_to_env(\%disk_env,$timerintenv);
13925: }
1.463 albertel 13926: if (ref($args->{'extra_env'})) {
13927: &_add_to_env(\%disk_env,$args->{'extra_env'});
13928: }
1.462 albertel 13929: untie(%disk_env);
13930: } else {
1.705 tempelho 13931: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13932: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13933: return 'error: '.$!;
13934: }
13935: }
13936: $env{'request.role'}='cm';
13937: $env{'request.role.adv'}=$env{'user.adv'};
13938: $env{'browser.type'}=$clientbrowser;
13939:
13940: return $cookie;
13941:
13942: }
13943:
13944: sub _add_to_env {
13945: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13946: if (ref($env_data) eq 'HASH') {
13947: while (my ($key,$value) = each(%$env_data)) {
13948: $idf->{$prefix.$key} = $value;
13949: $env{$prefix.$key} = $value;
13950: }
1.462 albertel 13951: }
13952: }
13953:
1.685 tempelho 13954: # --- Get the symbolic name of a problem and the url
13955: sub get_symb {
13956: my ($request,$silent) = @_;
1.726 raeburn 13957: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13958: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13959: if ($symb eq '') {
13960: if (!$silent) {
1.1071 raeburn 13961: if (ref($request)) {
13962: $request->print("Unable to handle ambiguous references:$url:.");
13963: }
1.685 tempelho 13964: return ();
13965: }
13966: }
13967: &Apache::lonenc::check_decrypt(\$symb);
13968: return ($symb);
13969: }
13970:
13971: # --------------------------------------------------------------Get annotation
13972:
13973: sub get_annotation {
13974: my ($symb,$enc) = @_;
13975:
13976: my $key = $symb;
13977: if (!$enc) {
13978: $key =
13979: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13980: }
13981: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13982: return $annotation{$key};
13983: }
13984:
13985: sub clean_symb {
1.731 raeburn 13986: my ($symb,$delete_enc) = @_;
1.685 tempelho 13987:
13988: &Apache::lonenc::check_decrypt(\$symb);
13989: my $enc = $env{'request.enc'};
1.731 raeburn 13990: if ($delete_enc) {
1.730 raeburn 13991: delete($env{'request.enc'});
13992: }
1.685 tempelho 13993:
13994: return ($symb,$enc);
13995: }
1.462 albertel 13996:
1.990 raeburn 13997: sub build_release_hashes {
13998: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13999: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
14000: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
14001: (ref($randomizetry) eq 'HASH'));
14002: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14003: my ($item,$name,$value) = split(/:/,$key);
14004: if ($item eq 'parameter') {
14005: if (ref($checkparms->{$name}) eq 'ARRAY') {
14006: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
14007: push(@{$checkparms->{$name}},$value);
14008: }
14009: } else {
14010: push(@{$checkparms->{$name}},$value);
14011: }
14012: } elsif ($item eq 'resourcetag') {
14013: if ($name eq 'responsetype') {
14014: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
14015: }
14016: } elsif ($item eq 'course') {
14017: if ($name eq 'crstype') {
14018: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14019: }
14020: }
14021: }
14022: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14023: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14024: return;
14025: }
14026:
1.1083 raeburn 14027: sub update_content_constraints {
14028: my ($cdom,$cnum,$chome,$cid) = @_;
14029: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14030: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14031: my %checkresponsetypes;
14032: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14033: my ($item,$name,$value) = split(/:/,$key);
14034: if ($item eq 'resourcetag') {
14035: if ($name eq 'responsetype') {
14036: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14037: }
14038: }
14039: }
14040: my $navmap = Apache::lonnavmaps::navmap->new();
14041: if (defined($navmap)) {
14042: my %allresponses;
14043: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14044: my %responses = $res->responseTypes();
14045: foreach my $key (keys(%responses)) {
14046: next unless(exists($checkresponsetypes{$key}));
14047: $allresponses{$key} += $responses{$key};
14048: }
14049: }
14050: foreach my $key (keys(%allresponses)) {
14051: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14052: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14053: ($reqdmajor,$reqdminor) = ($major,$minor);
14054: }
14055: }
14056: undef($navmap);
14057: }
14058: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14059: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14060: }
14061: return;
14062: }
14063:
14064: sub parse_supplemental_title {
14065: my ($title) = @_;
14066:
14067: my ($foldertitle,$renametitle);
14068: if ($title =~ /&&&/) {
14069: $title = &HTML::Entites::decode($title);
14070: }
14071: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14072: $renametitle=$4;
14073: my ($time,$uname,$udom) = ($1,$2,$3);
14074: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14075: my $name = &plainname($uname,$udom);
14076: $name = &HTML::Entities::encode($name,'"<>&\'');
14077: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14078: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14079: $name.': <br />'.$foldertitle;
14080: }
14081: if (wantarray) {
14082: return ($title,$foldertitle,$renametitle);
14083: }
14084: return $title;
14085: }
14086:
1.1094 raeburn 14087: sub captcha_display {
14088: my ($context,$lonhost) = @_;
14089: my ($output,$error);
14090: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14091: if ($captcha eq 'original') {
1.1094 raeburn 14092: $output = &create_captcha();
14093: unless ($output) {
14094: $error = 'captcha';
14095: }
14096: } elsif ($captcha eq 'recaptcha') {
14097: $output = &create_recaptcha($pubkey);
14098: unless ($output) {
1.1095 raeburn 14099: $error = 'recaptcha';
1.1094 raeburn 14100: }
14101: }
14102: return ($output,$error);
14103: }
14104:
14105: sub captcha_response {
14106: my ($context,$lonhost) = @_;
14107: my ($captcha_chk,$captcha_error);
14108: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14109: if ($captcha eq 'original') {
1.1094 raeburn 14110: ($captcha_chk,$captcha_error) = &check_captcha();
14111: } elsif ($captcha eq 'recaptcha') {
14112: $captcha_chk = &check_recaptcha($privkey);
14113: } else {
14114: $captcha_chk = 1;
14115: }
14116: return ($captcha_chk,$captcha_error);
14117: }
14118:
14119: sub get_captcha_config {
14120: my ($context,$lonhost) = @_;
1.1095 raeburn 14121: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 14122: my $hostname = &Apache::lonnet::hostname($lonhost);
14123: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14124: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 14125: if ($context eq 'usercreation') {
14126: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
14127: if (ref($domconfig{$context}) eq 'HASH') {
14128: $hashtocheck = $domconfig{$context}{'cancreate'};
14129: if (ref($hashtocheck) eq 'HASH') {
14130: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
14131: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
14132: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
14133: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
14134: }
14135: if ($privkey && $pubkey) {
14136: $captcha = 'recaptcha';
14137: } else {
14138: $captcha = 'original';
14139: }
14140: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
14141: $captcha = 'original';
14142: }
1.1094 raeburn 14143: }
1.1095 raeburn 14144: } else {
14145: $captcha = 'captcha';
14146: }
14147: } elsif ($context eq 'login') {
14148: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
14149: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
14150: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
14151: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 14152: if ($privkey && $pubkey) {
14153: $captcha = 'recaptcha';
1.1095 raeburn 14154: } else {
14155: $captcha = 'original';
1.1094 raeburn 14156: }
1.1095 raeburn 14157: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
14158: $captcha = 'original';
1.1094 raeburn 14159: }
14160: }
14161: return ($captcha,$pubkey,$privkey);
14162: }
14163:
14164: sub create_captcha {
14165: my %captcha_params = &captcha_settings();
14166: my ($output,$maxtries,$tries) = ('',10,0);
14167: while ($tries < $maxtries) {
14168: $tries ++;
14169: my $captcha = Authen::Captcha->new (
14170: output_folder => $captcha_params{'output_dir'},
14171: data_folder => $captcha_params{'db_dir'},
14172: );
14173: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14174:
14175: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14176: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14177: &mt('Type in the letters/numbers shown below').' '.
14178: '<input type="text" size="5" name="code" value="" /><br />'.
14179: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14180: last;
14181: }
14182: }
14183: return $output;
14184: }
14185:
14186: sub captcha_settings {
14187: my %captcha_params = (
14188: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14189: www_output_dir => "/captchaspool",
14190: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14191: numchars => '5',
14192: );
14193: return %captcha_params;
14194: }
14195:
14196: sub check_captcha {
14197: my ($captcha_chk,$captcha_error);
14198: my $code = $env{'form.code'};
14199: my $md5sum = $env{'form.crypt'};
14200: my %captcha_params = &captcha_settings();
14201: my $captcha = Authen::Captcha->new(
14202: output_folder => $captcha_params{'output_dir'},
14203: data_folder => $captcha_params{'db_dir'},
14204: );
14205: my $captcha_chk = $captcha->check_code($code,$md5sum);
14206: my %captcha_hash = (
14207: 0 => 'Code not checked (file error)',
14208: -1 => 'Failed: code expired',
14209: -2 => 'Failed: invalid code (not in database)',
14210: -3 => 'Failed: invalid code (code does not match crypt)',
14211: );
14212: if ($captcha_chk != 1) {
14213: $captcha_error = $captcha_hash{$captcha_chk}
14214: }
14215: return ($captcha_chk,$captcha_error);
14216: }
14217:
14218: sub create_recaptcha {
14219: my ($pubkey) = @_;
14220: my $captcha = Captcha::reCAPTCHA->new;
14221: return $captcha->get_options_setter({theme => 'white'})."\n".
14222: $captcha->get_html($pubkey).
14223: &mt('If either word is hard to read, [_1] will replace them.',
14224: '<image src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
14225: '<br /><br />';
14226: }
14227:
14228: sub check_recaptcha {
14229: my ($privkey) = @_;
14230: my $captcha_chk;
14231: my $captcha = Captcha::reCAPTCHA->new;
14232: my $captcha_result =
14233: $captcha->check_answer(
14234: $privkey,
14235: $ENV{'REMOTE_ADDR'},
14236: $env{'form.recaptcha_challenge_field'},
14237: $env{'form.recaptcha_response_field'},
14238: );
14239: if ($captcha_result->{is_valid}) {
14240: $captcha_chk = 1;
14241: }
14242: return $captcha_chk;
14243: }
14244:
1.41 ng 14245: =pod
14246:
14247: =back
14248:
1.112 bowersj2 14249: =cut
1.41 ng 14250:
1.112 bowersj2 14251: 1;
14252: __END__;
1.41 ng 14253:
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