Annotation of loncom/interface/loncommon.pm, revision 1.1097
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1097 ! bisitz 4: # $Id: loncommon.pm,v 1.1096 2012/11/08 20:46:42 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: }
1.795 www 5421:
1.1097 ! bisitz 5422: .LC_warning {
! 5423: color: darkorange;
! 5424: }
! 5425:
1.457 albertel 5426: .LC_diff_removed {
1.733 bisitz 5427: color: red;
1.394 albertel 5428: }
1.532 albertel 5429:
5430: .LC_info,
1.457 albertel 5431: .LC_success,
5432: .LC_diff_added {
1.350 albertel 5433: color: green;
5434: }
1.795 www 5435:
1.802 bisitz 5436: div.LC_confirm_box {
5437: background-color: #FAFAFA;
5438: border: 1px solid $lg_border_color;
5439: margin-right: 0;
5440: padding: 5px;
5441: }
5442:
5443: div.LC_confirm_box .LC_error img,
5444: div.LC_confirm_box .LC_success img {
5445: vertical-align: middle;
5446: }
5447:
1.440 albertel 5448: .LC_icon {
1.771 droeschl 5449: border: none;
1.790 droeschl 5450: vertical-align: middle;
1.771 droeschl 5451: }
5452:
1.543 albertel 5453: .LC_docs_spacer {
5454: width: 25px;
5455: height: 1px;
1.771 droeschl 5456: border: none;
1.543 albertel 5457: }
1.346 albertel 5458:
1.532 albertel 5459: .LC_internal_info {
1.735 bisitz 5460: color: #999999;
1.532 albertel 5461: }
5462:
1.794 www 5463: .LC_discussion {
1.1050 www 5464: background: $data_table_dark;
1.911 bisitz 5465: border: 1px solid black;
5466: margin: 2px;
1.794 www 5467: }
5468:
5469: .LC_disc_action_left {
1.1050 www 5470: background: $sidebg;
1.911 bisitz 5471: text-align: left;
1.1050 www 5472: padding: 4px;
5473: margin: 2px;
1.794 www 5474: }
5475:
5476: .LC_disc_action_right {
1.1050 www 5477: background: $sidebg;
1.911 bisitz 5478: text-align: right;
1.1050 www 5479: padding: 4px;
5480: margin: 2px;
1.794 www 5481: }
5482:
5483: .LC_disc_new_item {
1.911 bisitz 5484: background: white;
5485: border: 2px solid red;
1.1050 www 5486: margin: 4px;
5487: padding: 4px;
1.794 www 5488: }
5489:
5490: .LC_disc_old_item {
1.911 bisitz 5491: background: white;
1.1050 www 5492: margin: 4px;
5493: padding: 4px;
1.794 www 5494: }
5495:
1.458 albertel 5496: table.LC_pastsubmission {
5497: border: 1px solid black;
5498: margin: 2px;
5499: }
5500:
1.924 bisitz 5501: table#LC_menubuttons {
1.345 albertel 5502: width: 100%;
5503: background: $pgbg;
1.392 albertel 5504: border: 2px;
1.402 albertel 5505: border-collapse: separate;
1.803 bisitz 5506: padding: 0;
1.345 albertel 5507: }
1.392 albertel 5508:
1.801 tempelho 5509: table#LC_title_bar a {
5510: color: $fontmenu;
5511: }
1.836 bisitz 5512:
1.807 droeschl 5513: table#LC_title_bar {
1.819 tempelho 5514: clear: both;
1.836 bisitz 5515: display: none;
1.807 droeschl 5516: }
5517:
1.795 www 5518: table#LC_title_bar,
1.933 droeschl 5519: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5520: table#LC_title_bar.LC_with_remote {
1.359 albertel 5521: width: 100%;
1.392 albertel 5522: border-color: $pgbg;
5523: border-style: solid;
5524: border-width: $border;
1.379 albertel 5525: background: $pgbg;
1.801 tempelho 5526: color: $fontmenu;
1.392 albertel 5527: border-collapse: collapse;
1.803 bisitz 5528: padding: 0;
1.819 tempelho 5529: margin: 0;
1.359 albertel 5530: }
1.795 www 5531:
1.933 droeschl 5532: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5533: margin: 0;
5534: padding: 0;
1.933 droeschl 5535: position: relative;
5536: list-style: none;
1.913 droeschl 5537: }
1.933 droeschl 5538: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5539: display: inline;
5540: }
1.933 droeschl 5541:
5542: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5543: padding: 0;
1.933 droeschl 5544: margin: 0;
5545: float: left;
1.913 droeschl 5546: }
1.933 droeschl 5547: .LC_breadcrumb_tools_tools {
5548: padding: 0;
5549: margin: 0;
1.913 droeschl 5550: float: right;
5551: }
5552:
1.359 albertel 5553: table#LC_title_bar td {
5554: background: $tabbg;
5555: }
1.795 www 5556:
1.911 bisitz 5557: table#LC_menubuttons img {
1.803 bisitz 5558: border: none;
1.346 albertel 5559: }
1.795 www 5560:
1.842 droeschl 5561: .LC_breadcrumbs_component {
1.911 bisitz 5562: float: right;
5563: margin: 0 1em;
1.357 albertel 5564: }
1.842 droeschl 5565: .LC_breadcrumbs_component img {
1.911 bisitz 5566: vertical-align: middle;
1.777 tempelho 5567: }
1.795 www 5568:
1.383 albertel 5569: td.LC_table_cell_checkbox {
5570: text-align: center;
5571: }
1.795 www 5572:
5573: .LC_fontsize_small {
1.911 bisitz 5574: font-size: 70%;
1.705 tempelho 5575: }
5576:
1.844 bisitz 5577: #LC_breadcrumbs {
1.911 bisitz 5578: clear:both;
5579: background: $sidebg;
5580: border-bottom: 1px solid $lg_border_color;
5581: line-height: 2.5em;
1.933 droeschl 5582: overflow: hidden;
1.911 bisitz 5583: margin: 0;
5584: padding: 0;
1.995 raeburn 5585: text-align: left;
1.819 tempelho 5586: }
1.862 bisitz 5587:
1.993 raeburn 5588: .LC_head_subbox {
1.911 bisitz 5589: clear:both;
5590: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5591: border: 1px solid $sidebg;
5592: margin: 0 0 10px 0;
1.966 bisitz 5593: padding: 3px;
1.995 raeburn 5594: text-align: left;
1.822 bisitz 5595: }
5596:
1.795 www 5597: .LC_fontsize_medium {
1.911 bisitz 5598: font-size: 85%;
1.705 tempelho 5599: }
5600:
1.795 www 5601: .LC_fontsize_large {
1.911 bisitz 5602: font-size: 120%;
1.705 tempelho 5603: }
5604:
1.346 albertel 5605: .LC_menubuttons_inline_text {
5606: color: $font;
1.698 harmsja 5607: font-size: 90%;
1.701 harmsja 5608: padding-left:3px;
1.346 albertel 5609: }
5610:
1.934 droeschl 5611: .LC_menubuttons_inline_text img{
5612: vertical-align: middle;
5613: }
5614:
1.1051 www 5615: li.LC_menubuttons_inline_text img {
1.951 onken 5616: cursor:pointer;
1.1002 droeschl 5617: text-decoration: none;
1.951 onken 5618: }
5619:
1.526 www 5620: .LC_menubuttons_link {
5621: text-decoration: none;
5622: }
1.795 www 5623:
1.522 albertel 5624: .LC_menubuttons_category {
1.521 www 5625: color: $font;
1.526 www 5626: background: $pgbg;
1.521 www 5627: font-size: larger;
5628: font-weight: bold;
5629: }
5630:
1.346 albertel 5631: td.LC_menubuttons_text {
1.911 bisitz 5632: color: $font;
1.346 albertel 5633: }
1.706 harmsja 5634:
1.346 albertel 5635: .LC_current_location {
5636: background: $tabbg;
5637: }
1.795 www 5638:
1.938 bisitz 5639: table.LC_data_table {
1.347 albertel 5640: border: 1px solid #000000;
1.402 albertel 5641: border-collapse: separate;
1.426 albertel 5642: border-spacing: 1px;
1.610 albertel 5643: background: $pgbg;
1.347 albertel 5644: }
1.795 www 5645:
1.422 albertel 5646: .LC_data_table_dense {
5647: font-size: small;
5648: }
1.795 www 5649:
1.507 raeburn 5650: table.LC_nested_outer {
5651: border: 1px solid #000000;
1.589 raeburn 5652: border-collapse: collapse;
1.803 bisitz 5653: border-spacing: 0;
1.507 raeburn 5654: width: 100%;
5655: }
1.795 www 5656:
1.879 raeburn 5657: table.LC_innerpickbox,
1.507 raeburn 5658: table.LC_nested {
1.803 bisitz 5659: border: none;
1.589 raeburn 5660: border-collapse: collapse;
1.803 bisitz 5661: border-spacing: 0;
1.507 raeburn 5662: width: 100%;
5663: }
1.795 www 5664:
1.911 bisitz 5665: table.LC_data_table tr th,
5666: table.LC_calendar tr th,
1.879 raeburn 5667: table.LC_prior_tries tr th,
5668: table.LC_innerpickbox tr th {
1.349 albertel 5669: font-weight: bold;
5670: background-color: $data_table_head;
1.801 tempelho 5671: color:$fontmenu;
1.701 harmsja 5672: font-size:90%;
1.347 albertel 5673: }
1.795 www 5674:
1.879 raeburn 5675: table.LC_innerpickbox tr th,
5676: table.LC_innerpickbox tr td {
5677: vertical-align: top;
5678: }
5679:
1.711 raeburn 5680: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5681: background-color: #CCCCCC;
1.711 raeburn 5682: font-weight: bold;
5683: text-align: left;
5684: }
1.795 www 5685:
1.912 bisitz 5686: table.LC_data_table tr.LC_odd_row > td {
5687: background-color: $data_table_light;
5688: padding: 2px;
5689: vertical-align: top;
5690: }
5691:
1.809 bisitz 5692: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5693: background-color: $data_table_light;
1.912 bisitz 5694: vertical-align: top;
5695: }
5696:
5697: table.LC_data_table tr.LC_even_row > td {
5698: background-color: $data_table_dark;
1.425 albertel 5699: padding: 2px;
1.900 bisitz 5700: vertical-align: top;
1.347 albertel 5701: }
1.795 www 5702:
1.809 bisitz 5703: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5704: background-color: $data_table_dark;
1.900 bisitz 5705: vertical-align: top;
1.347 albertel 5706: }
1.795 www 5707:
1.425 albertel 5708: table.LC_data_table tr.LC_data_table_highlight td {
5709: background-color: $data_table_darker;
5710: }
1.795 www 5711:
1.639 raeburn 5712: table.LC_data_table tr td.LC_leftcol_header {
5713: background-color: $data_table_head;
5714: font-weight: bold;
5715: }
1.795 www 5716:
1.451 albertel 5717: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5718: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5719: font-weight: bold;
5720: font-style: italic;
5721: text-align: center;
5722: padding: 8px;
1.347 albertel 5723: }
1.795 www 5724:
1.940 bisitz 5725: table.LC_data_table tr.LC_empty_row td {
5726: background-color: $sidebg;
5727: }
5728:
5729: table.LC_nested tr.LC_empty_row td {
5730: background-color: #FFFFFF;
5731: }
5732:
1.890 droeschl 5733: table.LC_caption {
5734: }
5735:
1.507 raeburn 5736: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5737: padding: 4ex
5738: }
1.795 www 5739:
1.507 raeburn 5740: table.LC_nested_outer tr th {
5741: font-weight: bold;
1.801 tempelho 5742: color:$fontmenu;
1.507 raeburn 5743: background-color: $data_table_head;
1.701 harmsja 5744: font-size: small;
1.507 raeburn 5745: border-bottom: 1px solid #000000;
5746: }
1.795 www 5747:
1.507 raeburn 5748: table.LC_nested_outer tr td.LC_subheader {
5749: background-color: $data_table_head;
5750: font-weight: bold;
5751: font-size: small;
5752: border-bottom: 1px solid #000000;
5753: text-align: right;
1.451 albertel 5754: }
1.795 www 5755:
1.507 raeburn 5756: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5757: background-color: #CCCCCC;
1.451 albertel 5758: font-weight: bold;
5759: font-size: small;
1.507 raeburn 5760: text-align: center;
5761: }
1.795 www 5762:
1.589 raeburn 5763: table.LC_nested tr.LC_info_row td.LC_left_item,
5764: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5765: text-align: left;
1.451 albertel 5766: }
1.795 www 5767:
1.507 raeburn 5768: table.LC_nested td {
1.735 bisitz 5769: background-color: #FFFFFF;
1.451 albertel 5770: font-size: small;
1.507 raeburn 5771: }
1.795 www 5772:
1.507 raeburn 5773: table.LC_nested_outer tr th.LC_right_item,
5774: table.LC_nested tr.LC_info_row td.LC_right_item,
5775: table.LC_nested tr.LC_odd_row td.LC_right_item,
5776: table.LC_nested tr td.LC_right_item {
1.451 albertel 5777: text-align: right;
5778: }
5779:
1.507 raeburn 5780: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5781: background-color: #EEEEEE;
1.451 albertel 5782: }
5783:
1.473 raeburn 5784: table.LC_createuser {
5785: }
5786:
5787: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5788: font-size: small;
1.473 raeburn 5789: }
5790:
5791: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5792: background-color: #CCCCCC;
1.473 raeburn 5793: font-weight: bold;
5794: text-align: center;
5795: }
5796:
1.349 albertel 5797: table.LC_calendar {
5798: border: 1px solid #000000;
5799: border-collapse: collapse;
1.917 raeburn 5800: width: 98%;
1.349 albertel 5801: }
1.795 www 5802:
1.349 albertel 5803: table.LC_calendar_pickdate {
5804: font-size: xx-small;
5805: }
1.795 www 5806:
1.349 albertel 5807: table.LC_calendar tr td {
5808: border: 1px solid #000000;
5809: vertical-align: top;
1.917 raeburn 5810: width: 14%;
1.349 albertel 5811: }
1.795 www 5812:
1.349 albertel 5813: table.LC_calendar tr td.LC_calendar_day_empty {
5814: background-color: $data_table_dark;
5815: }
1.795 www 5816:
1.779 bisitz 5817: table.LC_calendar tr td.LC_calendar_day_current {
5818: background-color: $data_table_highlight;
1.777 tempelho 5819: }
1.795 www 5820:
1.938 bisitz 5821: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5822: background-color: $mail_new;
5823: }
1.795 www 5824:
1.938 bisitz 5825: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5826: background-color: $mail_new_hover;
5827: }
1.795 www 5828:
1.938 bisitz 5829: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5830: background-color: $mail_read;
5831: }
1.795 www 5832:
1.938 bisitz 5833: /*
5834: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5835: background-color: $mail_read_hover;
5836: }
1.938 bisitz 5837: */
1.795 www 5838:
1.938 bisitz 5839: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5840: background-color: $mail_replied;
5841: }
1.795 www 5842:
1.938 bisitz 5843: /*
5844: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5845: background-color: $mail_replied_hover;
5846: }
1.938 bisitz 5847: */
1.795 www 5848:
1.938 bisitz 5849: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5850: background-color: $mail_other;
5851: }
1.795 www 5852:
1.938 bisitz 5853: /*
5854: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5855: background-color: $mail_other_hover;
5856: }
1.938 bisitz 5857: */
1.494 raeburn 5858:
1.777 tempelho 5859: table.LC_data_table tr > td.LC_browser_file,
5860: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5861: background: #AAEE77;
1.389 albertel 5862: }
1.795 www 5863:
1.777 tempelho 5864: table.LC_data_table tr > td.LC_browser_file_locked,
5865: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5866: background: #FFAA99;
1.387 albertel 5867: }
1.795 www 5868:
1.777 tempelho 5869: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5870: background: #888888;
1.779 bisitz 5871: }
1.795 www 5872:
1.777 tempelho 5873: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5874: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5875: background: #F8F866;
1.777 tempelho 5876: }
1.795 www 5877:
1.696 bisitz 5878: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5879: background: #E0E8FF;
1.387 albertel 5880: }
1.696 bisitz 5881:
1.707 bisitz 5882: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5883: /* background: #77FF77; */
1.707 bisitz 5884: }
1.795 www 5885:
1.707 bisitz 5886: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5887: border-right: 8px solid #FFFF77;
1.707 bisitz 5888: }
1.795 www 5889:
1.707 bisitz 5890: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5891: border-right: 8px solid #FFAA77;
1.707 bisitz 5892: }
1.795 www 5893:
1.707 bisitz 5894: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5895: border-right: 8px solid #FF7777;
1.707 bisitz 5896: }
1.795 www 5897:
1.707 bisitz 5898: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5899: border-right: 8px solid #AAFF77;
1.707 bisitz 5900: }
1.795 www 5901:
1.707 bisitz 5902: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5903: border-right: 8px solid #11CC55;
1.707 bisitz 5904: }
5905:
1.388 albertel 5906: span.LC_current_location {
1.701 harmsja 5907: font-size:larger;
1.388 albertel 5908: background: $pgbg;
5909: }
1.387 albertel 5910:
1.1029 www 5911: span.LC_current_nav_location {
5912: font-weight:bold;
5913: background: $sidebg;
5914: }
5915:
1.395 albertel 5916: span.LC_parm_menu_item {
5917: font-size: larger;
5918: }
1.795 www 5919:
1.395 albertel 5920: span.LC_parm_scope_all {
5921: color: red;
5922: }
1.795 www 5923:
1.395 albertel 5924: span.LC_parm_scope_folder {
5925: color: green;
5926: }
1.795 www 5927:
1.395 albertel 5928: span.LC_parm_scope_resource {
5929: color: orange;
5930: }
1.795 www 5931:
1.395 albertel 5932: span.LC_parm_part {
5933: color: blue;
5934: }
1.795 www 5935:
1.911 bisitz 5936: span.LC_parm_folder,
5937: span.LC_parm_symb {
1.395 albertel 5938: font-size: x-small;
5939: font-family: $mono;
5940: color: #AAAAAA;
5941: }
5942:
1.977 bisitz 5943: ul.LC_parm_parmlist li {
5944: display: inline-block;
5945: padding: 0.3em 0.8em;
5946: vertical-align: top;
5947: width: 150px;
5948: border-top:1px solid $lg_border_color;
5949: }
5950:
1.795 www 5951: td.LC_parm_overview_level_menu,
5952: td.LC_parm_overview_map_menu,
5953: td.LC_parm_overview_parm_selectors,
5954: td.LC_parm_overview_restrictions {
1.396 albertel 5955: border: 1px solid black;
5956: border-collapse: collapse;
5957: }
1.795 www 5958:
1.396 albertel 5959: table.LC_parm_overview_restrictions td {
5960: border-width: 1px 4px 1px 4px;
5961: border-style: solid;
5962: border-color: $pgbg;
5963: text-align: center;
5964: }
1.795 www 5965:
1.396 albertel 5966: table.LC_parm_overview_restrictions th {
5967: background: $tabbg;
5968: border-width: 1px 4px 1px 4px;
5969: border-style: solid;
5970: border-color: $pgbg;
5971: }
1.795 www 5972:
1.398 albertel 5973: table#LC_helpmenu {
1.803 bisitz 5974: border: none;
1.398 albertel 5975: height: 55px;
1.803 bisitz 5976: border-spacing: 0;
1.398 albertel 5977: }
5978:
5979: table#LC_helpmenu fieldset legend {
5980: font-size: larger;
5981: }
1.795 www 5982:
1.397 albertel 5983: table#LC_helpmenu_links {
5984: width: 100%;
5985: border: 1px solid black;
5986: background: $pgbg;
1.803 bisitz 5987: padding: 0;
1.397 albertel 5988: border-spacing: 1px;
5989: }
1.795 www 5990:
1.397 albertel 5991: table#LC_helpmenu_links tr td {
5992: padding: 1px;
5993: background: $tabbg;
1.399 albertel 5994: text-align: center;
5995: font-weight: bold;
1.397 albertel 5996: }
1.396 albertel 5997:
1.795 www 5998: table#LC_helpmenu_links a:link,
5999: table#LC_helpmenu_links a:visited,
1.397 albertel 6000: table#LC_helpmenu_links a:active {
6001: text-decoration: none;
6002: color: $font;
6003: }
1.795 www 6004:
1.397 albertel 6005: table#LC_helpmenu_links a:hover {
6006: text-decoration: underline;
6007: color: $vlink;
6008: }
1.396 albertel 6009:
1.417 albertel 6010: .LC_chrt_popup_exists {
6011: border: 1px solid #339933;
6012: margin: -1px;
6013: }
1.795 www 6014:
1.417 albertel 6015: .LC_chrt_popup_up {
6016: border: 1px solid yellow;
6017: margin: -1px;
6018: }
1.795 www 6019:
1.417 albertel 6020: .LC_chrt_popup {
6021: border: 1px solid #8888FF;
6022: background: #CCCCFF;
6023: }
1.795 www 6024:
1.421 albertel 6025: table.LC_pick_box {
6026: border-collapse: separate;
6027: background: white;
6028: border: 1px solid black;
6029: border-spacing: 1px;
6030: }
1.795 www 6031:
1.421 albertel 6032: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6033: background: $sidebg;
1.421 albertel 6034: font-weight: bold;
1.900 bisitz 6035: text-align: left;
1.740 bisitz 6036: vertical-align: top;
1.421 albertel 6037: width: 184px;
6038: padding: 8px;
6039: }
1.795 www 6040:
1.579 raeburn 6041: table.LC_pick_box td.LC_pick_box_value {
6042: text-align: left;
6043: padding: 8px;
6044: }
1.795 www 6045:
1.579 raeburn 6046: table.LC_pick_box td.LC_pick_box_select {
6047: text-align: left;
6048: padding: 8px;
6049: }
1.795 www 6050:
1.424 albertel 6051: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6052: padding: 0;
1.421 albertel 6053: height: 1px;
6054: background: black;
6055: }
1.795 www 6056:
1.421 albertel 6057: table.LC_pick_box td.LC_pick_box_submit {
6058: text-align: right;
6059: }
1.795 www 6060:
1.579 raeburn 6061: table.LC_pick_box td.LC_evenrow_value {
6062: text-align: left;
6063: padding: 8px;
6064: background-color: $data_table_light;
6065: }
1.795 www 6066:
1.579 raeburn 6067: table.LC_pick_box td.LC_oddrow_value {
6068: text-align: left;
6069: padding: 8px;
6070: background-color: $data_table_light;
6071: }
1.795 www 6072:
1.579 raeburn 6073: span.LC_helpform_receipt_cat {
6074: font-weight: bold;
6075: }
1.795 www 6076:
1.424 albertel 6077: table.LC_group_priv_box {
6078: background: white;
6079: border: 1px solid black;
6080: border-spacing: 1px;
6081: }
1.795 www 6082:
1.424 albertel 6083: table.LC_group_priv_box td.LC_pick_box_title {
6084: background: $tabbg;
6085: font-weight: bold;
6086: text-align: right;
6087: width: 184px;
6088: }
1.795 www 6089:
1.424 albertel 6090: table.LC_group_priv_box td.LC_groups_fixed {
6091: background: $data_table_light;
6092: text-align: center;
6093: }
1.795 www 6094:
1.424 albertel 6095: table.LC_group_priv_box td.LC_groups_optional {
6096: background: $data_table_dark;
6097: text-align: center;
6098: }
1.795 www 6099:
1.424 albertel 6100: table.LC_group_priv_box td.LC_groups_functionality {
6101: background: $data_table_darker;
6102: text-align: center;
6103: font-weight: bold;
6104: }
1.795 www 6105:
1.424 albertel 6106: table.LC_group_priv td {
6107: text-align: left;
1.803 bisitz 6108: padding: 0;
1.424 albertel 6109: }
6110:
6111: .LC_navbuttons {
6112: margin: 2ex 0ex 2ex 0ex;
6113: }
1.795 www 6114:
1.423 albertel 6115: .LC_topic_bar {
6116: font-weight: bold;
6117: background: $tabbg;
1.918 wenzelju 6118: margin: 1em 0em 1em 2em;
1.805 bisitz 6119: padding: 3px;
1.918 wenzelju 6120: font-size: 1.2em;
1.423 albertel 6121: }
1.795 www 6122:
1.423 albertel 6123: .LC_topic_bar span {
1.918 wenzelju 6124: left: 0.5em;
6125: position: absolute;
1.423 albertel 6126: vertical-align: middle;
1.918 wenzelju 6127: font-size: 1.2em;
1.423 albertel 6128: }
1.795 www 6129:
1.423 albertel 6130: table.LC_course_group_status {
6131: margin: 20px;
6132: }
1.795 www 6133:
1.423 albertel 6134: table.LC_status_selector td {
6135: vertical-align: top;
6136: text-align: center;
1.424 albertel 6137: padding: 4px;
6138: }
1.795 www 6139:
1.599 albertel 6140: div.LC_feedback_link {
1.616 albertel 6141: clear: both;
1.829 kalberla 6142: background: $sidebg;
1.779 bisitz 6143: width: 100%;
1.829 kalberla 6144: padding-bottom: 10px;
6145: border: 1px $tabbg solid;
1.833 kalberla 6146: height: 22px;
6147: line-height: 22px;
6148: padding-top: 5px;
6149: }
6150:
6151: div.LC_feedback_link img {
6152: height: 22px;
1.867 kalberla 6153: vertical-align:middle;
1.829 kalberla 6154: }
6155:
1.911 bisitz 6156: div.LC_feedback_link a {
1.829 kalberla 6157: text-decoration: none;
1.489 raeburn 6158: }
1.795 www 6159:
1.867 kalberla 6160: div.LC_comblock {
1.911 bisitz 6161: display:inline;
1.867 kalberla 6162: color:$font;
6163: font-size:90%;
6164: }
6165:
6166: div.LC_feedback_link div.LC_comblock {
6167: padding-left:5px;
6168: }
6169:
6170: div.LC_feedback_link div.LC_comblock a {
6171: color:$font;
6172: }
6173:
1.489 raeburn 6174: span.LC_feedback_link {
1.858 bisitz 6175: /* background: $feedback_link_bg; */
1.599 albertel 6176: font-size: larger;
6177: }
1.795 www 6178:
1.599 albertel 6179: span.LC_message_link {
1.858 bisitz 6180: /* background: $feedback_link_bg; */
1.599 albertel 6181: font-size: larger;
6182: position: absolute;
6183: right: 1em;
1.489 raeburn 6184: }
1.421 albertel 6185:
1.515 albertel 6186: table.LC_prior_tries {
1.524 albertel 6187: border: 1px solid #000000;
6188: border-collapse: separate;
6189: border-spacing: 1px;
1.515 albertel 6190: }
1.523 albertel 6191:
1.515 albertel 6192: table.LC_prior_tries td {
1.524 albertel 6193: padding: 2px;
1.515 albertel 6194: }
1.523 albertel 6195:
6196: .LC_answer_correct {
1.795 www 6197: background: lightgreen;
6198: color: darkgreen;
6199: padding: 6px;
1.523 albertel 6200: }
1.795 www 6201:
1.523 albertel 6202: .LC_answer_charged_try {
1.797 www 6203: background: #FFAAAA;
1.795 www 6204: color: darkred;
6205: padding: 6px;
1.523 albertel 6206: }
1.795 www 6207:
1.779 bisitz 6208: .LC_answer_not_charged_try,
1.523 albertel 6209: .LC_answer_no_grade,
6210: .LC_answer_late {
1.795 www 6211: background: lightyellow;
1.523 albertel 6212: color: black;
1.795 www 6213: padding: 6px;
1.523 albertel 6214: }
1.795 www 6215:
1.523 albertel 6216: .LC_answer_previous {
1.795 www 6217: background: lightblue;
6218: color: darkblue;
6219: padding: 6px;
1.523 albertel 6220: }
1.795 www 6221:
1.779 bisitz 6222: .LC_answer_no_message {
1.777 tempelho 6223: background: #FFFFFF;
6224: color: black;
1.795 www 6225: padding: 6px;
1.779 bisitz 6226: }
1.795 www 6227:
1.779 bisitz 6228: .LC_answer_unknown {
6229: background: orange;
6230: color: black;
1.795 www 6231: padding: 6px;
1.777 tempelho 6232: }
1.795 www 6233:
1.529 albertel 6234: span.LC_prior_numerical,
6235: span.LC_prior_string,
6236: span.LC_prior_custom,
6237: span.LC_prior_reaction,
6238: span.LC_prior_math {
1.925 bisitz 6239: font-family: $mono;
1.523 albertel 6240: white-space: pre;
6241: }
6242:
1.525 albertel 6243: span.LC_prior_string {
1.925 bisitz 6244: font-family: $mono;
1.525 albertel 6245: white-space: pre;
6246: }
6247:
1.523 albertel 6248: table.LC_prior_option {
6249: width: 100%;
6250: border-collapse: collapse;
6251: }
1.795 www 6252:
1.911 bisitz 6253: table.LC_prior_rank,
1.795 www 6254: table.LC_prior_match {
1.528 albertel 6255: border-collapse: collapse;
6256: }
1.795 www 6257:
1.528 albertel 6258: table.LC_prior_option tr td,
6259: table.LC_prior_rank tr td,
6260: table.LC_prior_match tr td {
1.524 albertel 6261: border: 1px solid #000000;
1.515 albertel 6262: }
6263:
1.855 bisitz 6264: .LC_nobreak {
1.544 albertel 6265: white-space: nowrap;
1.519 raeburn 6266: }
6267:
1.576 raeburn 6268: span.LC_cusr_emph {
6269: font-style: italic;
6270: }
6271:
1.633 raeburn 6272: span.LC_cusr_subheading {
6273: font-weight: normal;
6274: font-size: 85%;
6275: }
6276:
1.861 bisitz 6277: div.LC_docs_entry_move {
1.859 bisitz 6278: border: 1px solid #BBBBBB;
1.545 albertel 6279: background: #DDDDDD;
1.861 bisitz 6280: width: 22px;
1.859 bisitz 6281: padding: 1px;
6282: margin: 0;
1.545 albertel 6283: }
6284:
1.861 bisitz 6285: table.LC_data_table tr > td.LC_docs_entry_commands,
6286: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6287: background: #DDDDDD;
6288: font-size: x-small;
6289: }
1.795 www 6290:
1.861 bisitz 6291: .LC_docs_entry_parameter {
6292: white-space: nowrap;
6293: }
6294:
1.544 albertel 6295: .LC_docs_copy {
1.545 albertel 6296: color: #000099;
1.544 albertel 6297: }
1.795 www 6298:
1.544 albertel 6299: .LC_docs_cut {
1.545 albertel 6300: color: #550044;
1.544 albertel 6301: }
1.795 www 6302:
1.544 albertel 6303: .LC_docs_rename {
1.545 albertel 6304: color: #009900;
1.544 albertel 6305: }
1.795 www 6306:
1.544 albertel 6307: .LC_docs_remove {
1.545 albertel 6308: color: #990000;
6309: }
6310:
1.547 albertel 6311: .LC_docs_reinit_warn,
6312: .LC_docs_ext_edit {
6313: font-size: x-small;
6314: }
6315:
1.545 albertel 6316: table.LC_docs_adddocs td,
6317: table.LC_docs_adddocs th {
6318: border: 1px solid #BBBBBB;
6319: padding: 4px;
6320: background: #DDDDDD;
1.543 albertel 6321: }
6322:
1.584 albertel 6323: table.LC_sty_begin {
6324: background: #BBFFBB;
6325: }
1.795 www 6326:
1.584 albertel 6327: table.LC_sty_end {
6328: background: #FFBBBB;
6329: }
6330:
1.589 raeburn 6331: table.LC_double_column {
1.803 bisitz 6332: border-width: 0;
1.589 raeburn 6333: border-collapse: collapse;
6334: width: 100%;
6335: padding: 2px;
6336: }
6337:
6338: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6339: top: 2px;
1.589 raeburn 6340: left: 2px;
6341: width: 47%;
6342: vertical-align: top;
6343: }
6344:
6345: table.LC_double_column tr td.LC_right_col {
6346: top: 2px;
1.779 bisitz 6347: right: 2px;
1.589 raeburn 6348: width: 47%;
6349: vertical-align: top;
6350: }
6351:
1.591 raeburn 6352: div.LC_left_float {
6353: float: left;
6354: padding-right: 5%;
1.597 albertel 6355: padding-bottom: 4px;
1.591 raeburn 6356: }
6357:
6358: div.LC_clear_float_header {
1.597 albertel 6359: padding-bottom: 2px;
1.591 raeburn 6360: }
6361:
6362: div.LC_clear_float_footer {
1.597 albertel 6363: padding-top: 10px;
1.591 raeburn 6364: clear: both;
6365: }
6366:
1.597 albertel 6367: div.LC_grade_show_user {
1.941 bisitz 6368: /* border-left: 5px solid $sidebg; */
6369: border-top: 5px solid #000000;
6370: margin: 50px 0 0 0;
1.936 bisitz 6371: padding: 15px 0 5px 10px;
1.597 albertel 6372: }
1.795 www 6373:
1.936 bisitz 6374: div.LC_grade_show_user_odd_row {
1.941 bisitz 6375: /* border-left: 5px solid #000000; */
6376: }
6377:
6378: div.LC_grade_show_user div.LC_Box {
6379: margin-right: 50px;
1.597 albertel 6380: }
6381:
6382: div.LC_grade_submissions,
6383: div.LC_grade_message_center,
1.936 bisitz 6384: div.LC_grade_info_links {
1.597 albertel 6385: margin: 5px;
6386: width: 99%;
6387: background: #FFFFFF;
6388: }
1.795 www 6389:
1.597 albertel 6390: div.LC_grade_submissions_header,
1.936 bisitz 6391: div.LC_grade_message_center_header {
1.705 tempelho 6392: font-weight: bold;
6393: font-size: large;
1.597 albertel 6394: }
1.795 www 6395:
1.597 albertel 6396: div.LC_grade_submissions_body,
1.936 bisitz 6397: div.LC_grade_message_center_body {
1.597 albertel 6398: border: 1px solid black;
6399: width: 99%;
6400: background: #FFFFFF;
6401: }
1.795 www 6402:
1.613 albertel 6403: table.LC_scantron_action {
6404: width: 100%;
6405: }
1.795 www 6406:
1.613 albertel 6407: table.LC_scantron_action tr th {
1.698 harmsja 6408: font-weight:bold;
6409: font-style:normal;
1.613 albertel 6410: }
1.795 www 6411:
1.779 bisitz 6412: .LC_edit_problem_header,
1.614 albertel 6413: div.LC_edit_problem_footer {
1.705 tempelho 6414: font-weight: normal;
6415: font-size: medium;
1.602 albertel 6416: margin: 2px;
1.1060 bisitz 6417: background-color: $sidebg;
1.600 albertel 6418: }
1.795 www 6419:
1.600 albertel 6420: div.LC_edit_problem_header,
1.602 albertel 6421: div.LC_edit_problem_header div,
1.614 albertel 6422: div.LC_edit_problem_footer,
6423: div.LC_edit_problem_footer div,
1.602 albertel 6424: div.LC_edit_problem_editxml_header,
6425: div.LC_edit_problem_editxml_header div {
1.600 albertel 6426: margin-top: 5px;
6427: }
1.795 www 6428:
1.600 albertel 6429: div.LC_edit_problem_header_title {
1.705 tempelho 6430: font-weight: bold;
6431: font-size: larger;
1.602 albertel 6432: background: $tabbg;
6433: padding: 3px;
1.1060 bisitz 6434: margin: 0 0 5px 0;
1.602 albertel 6435: }
1.795 www 6436:
1.602 albertel 6437: table.LC_edit_problem_header_title {
6438: width: 100%;
1.600 albertel 6439: background: $tabbg;
1.602 albertel 6440: }
6441:
6442: div.LC_edit_problem_discards {
6443: float: left;
6444: padding-bottom: 5px;
6445: }
1.795 www 6446:
1.602 albertel 6447: div.LC_edit_problem_saves {
6448: float: right;
6449: padding-bottom: 5px;
1.600 albertel 6450: }
1.795 www 6451:
1.911 bisitz 6452: img.stift {
1.803 bisitz 6453: border-width: 0;
6454: vertical-align: middle;
1.677 riegler 6455: }
1.680 riegler 6456:
1.923 bisitz 6457: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6458: vertical-align: top;
1.777 tempelho 6459: }
1.795 www 6460:
1.716 raeburn 6461: div.LC_createcourse {
1.911 bisitz 6462: margin: 10px 10px 10px 10px;
1.716 raeburn 6463: }
6464:
1.917 raeburn 6465: .LC_dccid {
6466: margin: 0.2em 0 0 0;
6467: padding: 0;
6468: font-size: 90%;
6469: display:none;
6470: }
6471:
1.897 wenzelju 6472: ol.LC_primary_menu a:hover,
1.721 harmsja 6473: ol#LC_MenuBreadcrumbs a:hover,
6474: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6475: ul#LC_secondary_menu a:hover,
1.721 harmsja 6476: .LC_FormSectionClearButton input:hover
1.795 www 6477: ul.LC_TabContent li:hover a {
1.952 onken 6478: color:$button_hover;
1.911 bisitz 6479: text-decoration:none;
1.693 droeschl 6480: }
6481:
1.779 bisitz 6482: h1 {
1.911 bisitz 6483: padding: 0;
6484: line-height:130%;
1.693 droeschl 6485: }
1.698 harmsja 6486:
1.911 bisitz 6487: h2,
6488: h3,
6489: h4,
6490: h5,
6491: h6 {
6492: margin: 5px 0 5px 0;
6493: padding: 0;
6494: line-height:130%;
1.693 droeschl 6495: }
1.795 www 6496:
6497: .LC_hcell {
1.911 bisitz 6498: padding:3px 15px 3px 15px;
6499: margin: 0;
6500: background-color:$tabbg;
6501: color:$fontmenu;
6502: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6503: }
1.795 www 6504:
1.840 bisitz 6505: .LC_Box > .LC_hcell {
1.911 bisitz 6506: margin: 0 -10px 10px -10px;
1.835 bisitz 6507: }
6508:
1.721 harmsja 6509: .LC_noBorder {
1.911 bisitz 6510: border: 0;
1.698 harmsja 6511: }
1.693 droeschl 6512:
1.721 harmsja 6513: .LC_FormSectionClearButton input {
1.911 bisitz 6514: background-color:transparent;
6515: border: none;
6516: cursor:pointer;
6517: text-decoration:underline;
1.693 droeschl 6518: }
1.763 bisitz 6519:
6520: .LC_help_open_topic {
1.911 bisitz 6521: color: #FFFFFF;
6522: background-color: #EEEEFF;
6523: margin: 1px;
6524: padding: 4px;
6525: border: 1px solid #000033;
6526: white-space: nowrap;
6527: /* vertical-align: middle; */
1.759 neumanie 6528: }
1.693 droeschl 6529:
1.911 bisitz 6530: dl,
6531: ul,
6532: div,
6533: fieldset {
6534: margin: 10px 10px 10px 0;
6535: /* overflow: hidden; */
1.693 droeschl 6536: }
1.795 www 6537:
1.838 bisitz 6538: fieldset > legend {
1.911 bisitz 6539: font-weight: bold;
6540: padding: 0 5px 0 5px;
1.838 bisitz 6541: }
6542:
1.813 bisitz 6543: #LC_nav_bar {
1.911 bisitz 6544: float: left;
1.995 raeburn 6545: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6546: margin: 0 0 2px 0;
1.807 droeschl 6547: }
6548:
1.916 droeschl 6549: #LC_realm {
6550: margin: 0.2em 0 0 0;
6551: padding: 0;
6552: font-weight: bold;
6553: text-align: center;
1.995 raeburn 6554: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6555: }
6556:
1.911 bisitz 6557: #LC_nav_bar em {
6558: font-weight: bold;
6559: font-style: normal;
1.807 droeschl 6560: }
6561:
1.897 wenzelju 6562: ol.LC_primary_menu {
1.911 bisitz 6563: float: right;
1.934 droeschl 6564: margin: 0;
1.1076 raeburn 6565: padding: 0;
1.995 raeburn 6566: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6567: }
6568:
1.852 droeschl 6569: ol#LC_PathBreadcrumbs {
1.911 bisitz 6570: margin: 0;
1.693 droeschl 6571: }
6572:
1.897 wenzelju 6573: ol.LC_primary_menu li {
1.1076 raeburn 6574: color: RGB(80, 80, 80);
6575: vertical-align: middle;
6576: text-align: left;
6577: list-style: none;
6578: float: left;
6579: }
6580:
6581: ol.LC_primary_menu li a {
6582: display: block;
6583: margin: 0;
6584: padding: 0 5px 0 10px;
6585: text-decoration: none;
6586: }
6587:
6588: ol.LC_primary_menu li ul {
6589: display: none;
6590: width: 10em;
6591: background-color: $data_table_light;
6592: }
6593:
6594: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6595: display: block;
6596: position: absolute;
6597: margin: 0;
6598: padding: 0;
1.1078 raeburn 6599: z-index: 2;
1.1076 raeburn 6600: }
6601:
6602: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6603: font-size: 90%;
1.911 bisitz 6604: vertical-align: top;
1.1076 raeburn 6605: float: none;
1.1079 raeburn 6606: border-left: 1px solid black;
6607: border-right: 1px solid black;
1.1076 raeburn 6608: }
6609:
6610: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078 raeburn 6611: background-color:$data_table_light;
1.1076 raeburn 6612: }
6613:
6614: ol.LC_primary_menu li li a:hover {
6615: color:$button_hover;
6616: background-color:$data_table_dark;
1.693 droeschl 6617: }
6618:
1.897 wenzelju 6619: ol.LC_primary_menu li img {
1.911 bisitz 6620: vertical-align: bottom;
1.934 droeschl 6621: height: 1.1em;
1.1077 raeburn 6622: margin: 0.2em 0 0 0;
1.693 droeschl 6623: }
6624:
1.897 wenzelju 6625: ol.LC_primary_menu a {
1.911 bisitz 6626: color: RGB(80, 80, 80);
6627: text-decoration: none;
1.693 droeschl 6628: }
1.795 www 6629:
1.949 droeschl 6630: ol.LC_primary_menu a.LC_new_message {
6631: font-weight:bold;
6632: color: darkred;
6633: }
6634:
1.975 raeburn 6635: ol.LC_docs_parameters {
6636: margin-left: 0;
6637: padding: 0;
6638: list-style: none;
6639: }
6640:
6641: ol.LC_docs_parameters li {
6642: margin: 0;
6643: padding-right: 20px;
6644: display: inline;
6645: }
6646:
1.976 raeburn 6647: ol.LC_docs_parameters li:before {
6648: content: "\\002022 \\0020";
6649: }
6650:
6651: li.LC_docs_parameters_title {
6652: font-weight: bold;
6653: }
6654:
6655: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6656: content: "";
6657: }
6658:
1.897 wenzelju 6659: ul#LC_secondary_menu {
1.911 bisitz 6660: clear: both;
6661: color: $fontmenu;
6662: background: $tabbg;
6663: list-style: none;
6664: padding: 0;
6665: margin: 0;
6666: width: 100%;
1.995 raeburn 6667: text-align: left;
1.808 droeschl 6668: }
6669:
1.897 wenzelju 6670: ul#LC_secondary_menu li {
1.911 bisitz 6671: font-weight: bold;
6672: line-height: 1.8em;
6673: padding: 0 0.8em;
6674: border-right: 1px solid black;
6675: display: inline;
6676: vertical-align: middle;
1.807 droeschl 6677: }
6678:
1.847 tempelho 6679: ul.LC_TabContent {
1.911 bisitz 6680: display:block;
6681: background: $sidebg;
6682: border-bottom: solid 1px $lg_border_color;
6683: list-style:none;
1.1020 raeburn 6684: margin: -1px -10px 0 -10px;
1.911 bisitz 6685: padding: 0;
1.693 droeschl 6686: }
6687:
1.795 www 6688: ul.LC_TabContent li,
6689: ul.LC_TabContentBigger li {
1.911 bisitz 6690: float:left;
1.741 harmsja 6691: }
1.795 www 6692:
1.897 wenzelju 6693: ul#LC_secondary_menu li a {
1.911 bisitz 6694: color: $fontmenu;
6695: text-decoration: none;
1.693 droeschl 6696: }
1.795 www 6697:
1.721 harmsja 6698: ul.LC_TabContent {
1.952 onken 6699: min-height:20px;
1.721 harmsja 6700: }
1.795 www 6701:
6702: ul.LC_TabContent li {
1.911 bisitz 6703: vertical-align:middle;
1.959 onken 6704: padding: 0 16px 0 10px;
1.911 bisitz 6705: background-color:$tabbg;
6706: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6707: border-left: solid 1px $font;
1.721 harmsja 6708: }
1.795 www 6709:
1.847 tempelho 6710: ul.LC_TabContent .right {
1.911 bisitz 6711: float:right;
1.847 tempelho 6712: }
6713:
1.911 bisitz 6714: ul.LC_TabContent li a,
6715: ul.LC_TabContent li {
6716: color:rgb(47,47,47);
6717: text-decoration:none;
6718: font-size:95%;
6719: font-weight:bold;
1.952 onken 6720: min-height:20px;
6721: }
6722:
1.959 onken 6723: ul.LC_TabContent li a:hover,
6724: ul.LC_TabContent li a:focus {
1.952 onken 6725: color: $button_hover;
1.959 onken 6726: background:none;
6727: outline:none;
1.952 onken 6728: }
6729:
6730: ul.LC_TabContent li:hover {
6731: color: $button_hover;
6732: cursor:pointer;
1.721 harmsja 6733: }
1.795 www 6734:
1.911 bisitz 6735: ul.LC_TabContent li.active {
1.952 onken 6736: color: $font;
1.911 bisitz 6737: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6738: border-bottom:solid 1px #FFFFFF;
6739: cursor: default;
1.744 ehlerst 6740: }
1.795 www 6741:
1.959 onken 6742: ul.LC_TabContent li.active a {
6743: color:$font;
6744: background:#FFFFFF;
6745: outline: none;
6746: }
1.1047 raeburn 6747:
6748: ul.LC_TabContent li.goback {
6749: float: left;
6750: border-left: none;
6751: }
6752:
1.870 tempelho 6753: #maincoursedoc {
1.911 bisitz 6754: clear:both;
1.870 tempelho 6755: }
6756:
6757: ul.LC_TabContentBigger {
1.911 bisitz 6758: display:block;
6759: list-style:none;
6760: padding: 0;
1.870 tempelho 6761: }
6762:
1.795 www 6763: ul.LC_TabContentBigger li {
1.911 bisitz 6764: vertical-align:bottom;
6765: height: 30px;
6766: font-size:110%;
6767: font-weight:bold;
6768: color: #737373;
1.841 tempelho 6769: }
6770:
1.957 onken 6771: ul.LC_TabContentBigger li.active {
6772: position: relative;
6773: top: 1px;
6774: }
6775:
1.870 tempelho 6776: ul.LC_TabContentBigger li a {
1.911 bisitz 6777: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6778: height: 30px;
6779: line-height: 30px;
6780: text-align: center;
6781: display: block;
6782: text-decoration: none;
1.958 onken 6783: outline: none;
1.741 harmsja 6784: }
1.795 www 6785:
1.870 tempelho 6786: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6787: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6788: color:$font;
1.744 ehlerst 6789: }
1.795 www 6790:
1.870 tempelho 6791: ul.LC_TabContentBigger li b {
1.911 bisitz 6792: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6793: display: block;
6794: float: left;
6795: padding: 0 30px;
1.957 onken 6796: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6797: }
6798:
1.956 onken 6799: ul.LC_TabContentBigger li:hover b {
6800: color:$button_hover;
6801: }
6802:
1.870 tempelho 6803: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6804: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6805: color:$font;
1.957 onken 6806: border: 0;
1.741 harmsja 6807: }
1.693 droeschl 6808:
1.870 tempelho 6809:
1.862 bisitz 6810: ul.LC_CourseBreadcrumbs {
6811: background: $sidebg;
1.1020 raeburn 6812: height: 2em;
1.862 bisitz 6813: padding-left: 10px;
1.1020 raeburn 6814: margin: 0;
1.862 bisitz 6815: list-style-position: inside;
6816: }
6817:
1.911 bisitz 6818: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6819: ol#LC_PathBreadcrumbs {
1.911 bisitz 6820: padding-left: 10px;
6821: margin: 0;
1.933 droeschl 6822: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6823: }
6824:
1.911 bisitz 6825: ol#LC_MenuBreadcrumbs li,
6826: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6827: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6828: display: inline;
1.933 droeschl 6829: white-space: normal;
1.693 droeschl 6830: }
6831:
1.823 bisitz 6832: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6833: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6834: text-decoration: none;
6835: font-size:90%;
1.693 droeschl 6836: }
1.795 www 6837:
1.969 droeschl 6838: ol#LC_MenuBreadcrumbs h1 {
6839: display: inline;
6840: font-size: 90%;
6841: line-height: 2.5em;
6842: margin: 0;
6843: padding: 0;
6844: }
6845:
1.795 www 6846: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6847: text-decoration:none;
6848: font-size:100%;
6849: font-weight:bold;
1.693 droeschl 6850: }
1.795 www 6851:
1.840 bisitz 6852: .LC_Box {
1.911 bisitz 6853: border: solid 1px $lg_border_color;
6854: padding: 0 10px 10px 10px;
1.746 neumanie 6855: }
1.795 www 6856:
1.1020 raeburn 6857: .LC_DocsBox {
6858: border: solid 1px $lg_border_color;
6859: padding: 0 0 10px 10px;
6860: }
6861:
1.795 www 6862: .LC_AboutMe_Image {
1.911 bisitz 6863: float:left;
6864: margin-right:10px;
1.747 neumanie 6865: }
1.795 www 6866:
6867: .LC_Clear_AboutMe_Image {
1.911 bisitz 6868: clear:left;
1.747 neumanie 6869: }
1.795 www 6870:
1.721 harmsja 6871: dl.LC_ListStyleClean dt {
1.911 bisitz 6872: padding-right: 5px;
6873: display: table-header-group;
1.693 droeschl 6874: }
6875:
1.721 harmsja 6876: dl.LC_ListStyleClean dd {
1.911 bisitz 6877: display: table-row;
1.693 droeschl 6878: }
6879:
1.721 harmsja 6880: .LC_ListStyleClean,
6881: .LC_ListStyleSimple,
6882: .LC_ListStyleNormal,
1.795 www 6883: .LC_ListStyleSpecial {
1.911 bisitz 6884: /* display:block; */
6885: list-style-position: inside;
6886: list-style-type: none;
6887: overflow: hidden;
6888: padding: 0;
1.693 droeschl 6889: }
6890:
1.721 harmsja 6891: .LC_ListStyleSimple li,
6892: .LC_ListStyleSimple dd,
6893: .LC_ListStyleNormal li,
6894: .LC_ListStyleNormal dd,
6895: .LC_ListStyleSpecial li,
1.795 www 6896: .LC_ListStyleSpecial dd {
1.911 bisitz 6897: margin: 0;
6898: padding: 5px 5px 5px 10px;
6899: clear: both;
1.693 droeschl 6900: }
6901:
1.721 harmsja 6902: .LC_ListStyleClean li,
6903: .LC_ListStyleClean dd {
1.911 bisitz 6904: padding-top: 0;
6905: padding-bottom: 0;
1.693 droeschl 6906: }
6907:
1.721 harmsja 6908: .LC_ListStyleSimple dd,
1.795 www 6909: .LC_ListStyleSimple li {
1.911 bisitz 6910: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6911: }
6912:
1.721 harmsja 6913: .LC_ListStyleSpecial li,
6914: .LC_ListStyleSpecial dd {
1.911 bisitz 6915: list-style-type: none;
6916: background-color: RGB(220, 220, 220);
6917: margin-bottom: 4px;
1.693 droeschl 6918: }
6919:
1.721 harmsja 6920: table.LC_SimpleTable {
1.911 bisitz 6921: margin:5px;
6922: border:solid 1px $lg_border_color;
1.795 www 6923: }
1.693 droeschl 6924:
1.721 harmsja 6925: table.LC_SimpleTable tr {
1.911 bisitz 6926: padding: 0;
6927: border:solid 1px $lg_border_color;
1.693 droeschl 6928: }
1.795 www 6929:
6930: table.LC_SimpleTable thead {
1.911 bisitz 6931: background:rgb(220,220,220);
1.693 droeschl 6932: }
6933:
1.721 harmsja 6934: div.LC_columnSection {
1.911 bisitz 6935: display: block;
6936: clear: both;
6937: overflow: hidden;
6938: margin: 0;
1.693 droeschl 6939: }
6940:
1.721 harmsja 6941: div.LC_columnSection>* {
1.911 bisitz 6942: float: left;
6943: margin: 10px 20px 10px 0;
6944: overflow:hidden;
1.693 droeschl 6945: }
1.721 harmsja 6946:
1.795 www 6947: table em {
1.911 bisitz 6948: font-weight: bold;
6949: font-style: normal;
1.748 schulted 6950: }
1.795 www 6951:
1.779 bisitz 6952: table.LC_tableBrowseRes,
1.795 www 6953: table.LC_tableOfContent {
1.911 bisitz 6954: border:none;
6955: border-spacing: 1px;
6956: padding: 3px;
6957: background-color: #FFFFFF;
6958: font-size: 90%;
1.753 droeschl 6959: }
1.789 droeschl 6960:
1.911 bisitz 6961: table.LC_tableOfContent {
6962: border-collapse: collapse;
1.789 droeschl 6963: }
6964:
1.771 droeschl 6965: table.LC_tableBrowseRes a,
1.768 schulted 6966: table.LC_tableOfContent a {
1.911 bisitz 6967: background-color: transparent;
6968: text-decoration: none;
1.753 droeschl 6969: }
6970:
1.795 www 6971: table.LC_tableOfContent img {
1.911 bisitz 6972: border: none;
6973: height: 1.3em;
6974: vertical-align: text-bottom;
6975: margin-right: 0.3em;
1.753 droeschl 6976: }
1.757 schulted 6977:
1.795 www 6978: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6979: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6980: }
6981:
1.795 www 6982: a#LC_content_toolbar_everything {
1.911 bisitz 6983: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6984: }
6985:
1.795 www 6986: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6987: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6988: }
6989:
1.795 www 6990: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6991: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6992: }
6993:
1.795 www 6994: a#LC_content_toolbar_changefolder {
1.911 bisitz 6995: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6996: }
6997:
1.795 www 6998: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6999: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7000: }
7001:
1.1043 raeburn 7002: a#LC_content_toolbar_edittoplevel {
7003: background-image:url(/res/adm/pages/edittoplevel.gif);
7004: }
7005:
1.795 www 7006: ul#LC_toolbar li a:hover {
1.911 bisitz 7007: background-position: bottom center;
1.757 schulted 7008: }
7009:
1.795 www 7010: ul#LC_toolbar {
1.911 bisitz 7011: padding: 0;
7012: margin: 2px;
7013: list-style:none;
7014: position:relative;
7015: background-color:white;
1.1082 raeburn 7016: overflow: auto;
1.757 schulted 7017: }
7018:
1.795 www 7019: ul#LC_toolbar li {
1.911 bisitz 7020: border:1px solid white;
7021: padding: 0;
7022: margin: 0;
7023: float: left;
7024: display:inline;
7025: vertical-align:middle;
1.1082 raeburn 7026: white-space: nowrap;
1.911 bisitz 7027: }
1.757 schulted 7028:
1.783 amueller 7029:
1.795 www 7030: a.LC_toolbarItem {
1.911 bisitz 7031: display:block;
7032: padding: 0;
7033: margin: 0;
7034: height: 32px;
7035: width: 32px;
7036: color:white;
7037: border: none;
7038: background-repeat:no-repeat;
7039: background-color:transparent;
1.757 schulted 7040: }
7041:
1.915 droeschl 7042: ul.LC_funclist {
7043: margin: 0;
7044: padding: 0.5em 1em 0.5em 0;
7045: }
7046:
1.933 droeschl 7047: ul.LC_funclist > li:first-child {
7048: font-weight:bold;
7049: margin-left:0.8em;
7050: }
7051:
1.915 droeschl 7052: ul.LC_funclist + ul.LC_funclist {
7053: /*
7054: left border as a seperator if we have more than
7055: one list
7056: */
7057: border-left: 1px solid $sidebg;
7058: /*
7059: this hides the left border behind the border of the
7060: outer box if element is wrapped to the next 'line'
7061: */
7062: margin-left: -1px;
7063: }
7064:
1.843 bisitz 7065: ul.LC_funclist li {
1.915 droeschl 7066: display: inline;
1.782 bisitz 7067: white-space: nowrap;
1.915 droeschl 7068: margin: 0 0 0 25px;
7069: line-height: 150%;
1.782 bisitz 7070: }
7071:
1.974 wenzelju 7072: .LC_hidden {
7073: display: none;
7074: }
7075:
1.1030 www 7076: .LCmodal-overlay {
7077: position:fixed;
7078: top:0;
7079: right:0;
7080: bottom:0;
7081: left:0;
7082: height:100%;
7083: width:100%;
7084: margin:0;
7085: padding:0;
7086: background:#999;
7087: opacity:.75;
7088: filter: alpha(opacity=75);
7089: -moz-opacity: 0.75;
7090: z-index:101;
7091: }
7092:
7093: * html .LCmodal-overlay {
7094: position: absolute;
7095: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7096: }
7097:
7098: .LCmodal-window {
7099: position:fixed;
7100: top:50%;
7101: left:50%;
7102: margin:0;
7103: padding:0;
7104: z-index:102;
7105: }
7106:
7107: * html .LCmodal-window {
7108: position:absolute;
7109: }
7110:
7111: .LCclose-window {
7112: position:absolute;
7113: width:32px;
7114: height:32px;
7115: right:8px;
7116: top:8px;
7117: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7118: text-indent:-99999px;
7119: overflow:hidden;
7120: cursor:pointer;
7121: }
7122:
1.343 albertel 7123: END
7124: }
7125:
1.306 albertel 7126: =pod
7127:
7128: =item * &headtag()
7129:
7130: Returns a uniform footer for LON-CAPA web pages.
7131:
1.307 albertel 7132: Inputs: $title - optional title for the head
7133: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7134: $args - optional arguments
1.319 albertel 7135: force_register - if is true call registerurl so the remote is
7136: informed
1.415 albertel 7137: redirect -> array ref of
7138: 1- seconds before redirect occurs
7139: 2- url to redirect to
7140: 3- whether the side effect should occur
1.315 albertel 7141: (side effect of setting
7142: $env{'internal.head.redirect'} to the url
7143: redirected too)
1.352 albertel 7144: domain -> force to color decorate a page for a specific
7145: domain
7146: function -> force usage of a specific rolish color scheme
7147: bgcolor -> override the default page bgcolor
1.460 albertel 7148: no_auto_mt_title
7149: -> prevent &mt()ing the title arg
1.464 albertel 7150:
1.306 albertel 7151: =cut
7152:
7153: sub headtag {
1.313 albertel 7154: my ($title,$head_extra,$args) = @_;
1.306 albertel 7155:
1.363 albertel 7156: my $function = $args->{'function'} || &get_users_function();
7157: my $domain = $args->{'domain'} || &determinedomain();
7158: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7159: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7160: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7161: #time(),
1.418 albertel 7162: $env{'environment.color.timestamp'},
1.363 albertel 7163: $function,$domain,$bgcolor);
7164:
1.369 www 7165: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7166:
1.308 albertel 7167: my $result =
7168: '<head>'.
1.461 albertel 7169: &font_settings();
1.319 albertel 7170:
1.1064 raeburn 7171: my $inhibitprint = &print_suppression();
7172:
1.461 albertel 7173: if (!$args->{'frameset'}) {
7174: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7175: }
1.962 droeschl 7176: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
7177: $result .= Apache::lonxml::display_title();
1.319 albertel 7178: }
1.436 albertel 7179: if (!$args->{'no_nav_bar'}
7180: && !$args->{'only_body'}
7181: && !$args->{'frameset'}) {
7182: $result .= &help_menu_js();
1.1032 www 7183: $result.=&modal_window();
1.1038 www 7184: $result.=&togglebox_script();
1.1034 www 7185: $result.=&wishlist_window();
1.1041 www 7186: $result.=&LCprogressbarUpdate_script();
1.1034 www 7187: } else {
7188: if ($args->{'add_modal'}) {
7189: $result.=&modal_window();
7190: }
7191: if ($args->{'add_wishlist'}) {
7192: $result.=&wishlist_window();
7193: }
1.1038 www 7194: if ($args->{'add_togglebox'}) {
7195: $result.=&togglebox_script();
7196: }
1.1041 www 7197: if ($args->{'add_progressbar'}) {
7198: $result.=&LCprogressbarUpdate_script();
7199: }
1.436 albertel 7200: }
1.314 albertel 7201: if (ref($args->{'redirect'})) {
1.414 albertel 7202: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7203: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7204: if (!$inhibit_continue) {
7205: $env{'internal.head.redirect'} = $url;
7206: }
1.313 albertel 7207: $result.=<<ADDMETA
7208: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7209: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7210: ADDMETA
7211: }
1.306 albertel 7212: if (!defined($title)) {
7213: $title = 'The LearningOnline Network with CAPA';
7214: }
1.460 albertel 7215: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7216: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7217: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7218: .$inhibitprint
1.414 albertel 7219: .$head_extra;
1.962 droeschl 7220: return $result.'</head>';
1.306 albertel 7221: }
7222:
7223: =pod
7224:
1.340 albertel 7225: =item * &font_settings()
7226:
7227: Returns neccessary <meta> to set the proper encoding
7228:
7229: Inputs: none
7230:
7231: =cut
7232:
7233: sub font_settings {
7234: my $headerstring='';
1.647 www 7235: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7236: $headerstring.=
7237: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7238: }
7239: return $headerstring;
7240: }
7241:
1.341 albertel 7242: =pod
7243:
1.1064 raeburn 7244: =item * &print_suppression()
7245:
7246: In course context returns css which causes the body to be blank when media="print",
7247: if printout generation is unavailable for the current resource.
7248:
7249: This could be because:
7250:
7251: (a) printstartdate is in the future
7252:
7253: (b) printenddate is in the past
7254:
7255: (c) there is an active exam block with "printout"
7256: functionality blocked
7257:
7258: Users with pav, pfo or evb privileges are exempt.
7259:
7260: Inputs: none
7261:
7262: =cut
7263:
7264:
7265: sub print_suppression {
7266: my $noprint;
7267: if ($env{'request.course.id'}) {
7268: my $scope = $env{'request.course.id'};
7269: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7270: (&Apache::lonnet::allowed('pfo',$scope))) {
7271: return;
7272: }
7273: if ($env{'request.course.sec'} ne '') {
7274: $scope .= "/$env{'request.course.sec'}";
7275: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7276: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7277: return;
1.1064 raeburn 7278: }
7279: }
7280: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7281: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7282: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7283: if ($blocked) {
7284: my $checkrole = "cm./$cdom/$cnum";
7285: if ($env{'request.course.sec'} ne '') {
7286: $checkrole .= "/$env{'request.course.sec'}";
7287: }
7288: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7289: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7290: $noprint = 1;
7291: }
7292: }
7293: unless ($noprint) {
7294: my $symb = &Apache::lonnet::symbread();
7295: if ($symb ne '') {
7296: my $navmap = Apache::lonnavmaps::navmap->new();
7297: if (ref($navmap)) {
7298: my $res = $navmap->getBySymb($symb);
7299: if (ref($res)) {
7300: if (!$res->resprintable()) {
7301: $noprint = 1;
7302: }
7303: }
7304: }
7305: }
7306: }
7307: if ($noprint) {
7308: return <<"ENDSTYLE";
7309: <style type="text/css" media="print">
7310: body { display:none }
7311: </style>
7312: ENDSTYLE
7313: }
7314: }
7315: return;
7316: }
7317:
7318: =pod
7319:
1.341 albertel 7320: =item * &xml_begin()
7321:
7322: Returns the needed doctype and <html>
7323:
7324: Inputs: none
7325:
7326: =cut
7327:
7328: sub xml_begin {
7329: my $output='';
7330:
7331: if ($env{'browser.mathml'}) {
7332: $output='<?xml version="1.0"?>'
7333: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7334: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7335:
7336: # .'<!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">] >'
7337: .'<!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">'
7338: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7339: .'xmlns="http://www.w3.org/1999/xhtml">';
7340: } else {
1.849 bisitz 7341: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7342: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7343: }
7344: return $output;
7345: }
1.340 albertel 7346:
7347: =pod
7348:
1.306 albertel 7349: =item * &start_page()
7350:
7351: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7352:
1.648 raeburn 7353: Inputs:
7354:
7355: =over 4
7356:
7357: $title - optional title for the page
7358:
7359: $head_extra - optional extra HTML to incude inside the <head>
7360:
7361: $args - additional optional args supported are:
7362:
7363: =over 8
7364:
7365: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7366: arg on
1.814 bisitz 7367: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7368: add_entries -> additional attributes to add to the <body>
7369: domain -> force to color decorate a page for a
1.317 albertel 7370: specific domain
1.648 raeburn 7371: function -> force usage of a specific rolish color
1.317 albertel 7372: scheme
1.648 raeburn 7373: redirect -> see &headtag()
7374: bgcolor -> override the default page bg color
7375: js_ready -> return a string ready for being used in
1.317 albertel 7376: a javascript writeln
1.648 raeburn 7377: html_encode -> return a string ready for being used in
1.320 albertel 7378: a html attribute
1.648 raeburn 7379: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7380: $forcereg arg
1.648 raeburn 7381: frameset -> if true will start with a <frameset>
1.330 albertel 7382: rather than <body>
1.648 raeburn 7383: skip_phases -> hash ref of
1.338 albertel 7384: head -> skip the <html><head> generation
7385: body -> skip all <body> generation
1.648 raeburn 7386: no_auto_mt_title -> prevent &mt()ing the title arg
7387: inherit_jsmath -> when creating popup window in a page,
7388: should it have jsmath forced on by the
7389: current page
1.867 kalberla 7390: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7391: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1096 raeburn 7392: group -> includes the current group, if page is for a
7393: specific group
1.361 albertel 7394:
1.648 raeburn 7395: =back
1.460 albertel 7396:
1.648 raeburn 7397: =back
1.562 albertel 7398:
1.306 albertel 7399: =cut
7400:
7401: sub start_page {
1.309 albertel 7402: my ($title,$head_extra,$args) = @_;
1.318 albertel 7403: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7404:
1.315 albertel 7405: $env{'internal.start_page'}++;
1.1096 raeburn 7406: my ($result,@advtools);
1.964 droeschl 7407:
1.338 albertel 7408: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7409: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7410: }
7411:
7412: if (! exists($args->{'skip_phases'}{'body'}) ) {
7413: if ($args->{'frameset'}) {
7414: my $attr_string = &make_attr_string($args->{'force_register'},
7415: $args->{'add_entries'});
7416: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7417: } else {
7418: $result .=
7419: &bodytag($title,
7420: $args->{'function'}, $args->{'add_entries'},
7421: $args->{'only_body'}, $args->{'domain'},
7422: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 7423: $args->{'bgcolor'}, $args,
7424: \@advtools);
1.831 bisitz 7425: }
1.330 albertel 7426: }
1.338 albertel 7427:
1.315 albertel 7428: if ($args->{'js_ready'}) {
1.713 kaisler 7429: $result = &js_ready($result);
1.315 albertel 7430: }
1.320 albertel 7431: if ($args->{'html_encode'}) {
1.713 kaisler 7432: $result = &html_encode($result);
7433: }
7434:
1.813 bisitz 7435: # Preparation for new and consistent functionlist at top of screen
7436: # if ($args->{'functionlist'}) {
7437: # $result .= &build_functionlist();
7438: #}
7439:
1.964 droeschl 7440: # Don't add anything more if only_body wanted or in const space
7441: return $result if $args->{'only_body'}
7442: || $env{'request.state'} eq 'construct';
1.813 bisitz 7443:
7444: #Breadcrumbs
1.758 kaisler 7445: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7446: &Apache::lonhtmlcommon::clear_breadcrumbs();
7447: #if any br links exists, add them to the breadcrumbs
7448: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7449: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7450: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7451: }
7452: }
1.1096 raeburn 7453: # if @advtools array contains items add then to the breadcrumbs
7454: if (@advtools > 0) {
7455: &Apache::lonmenu::advtools_crumbs(@advtools);
7456: }
1.758 kaisler 7457:
7458: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7459: if(exists($args->{'bread_crumbs_component'})){
7460: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7461: }else{
7462: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7463: }
1.320 albertel 7464: }
1.315 albertel 7465: return $result;
1.306 albertel 7466: }
7467:
7468: sub end_page {
1.315 albertel 7469: my ($args) = @_;
7470: $env{'internal.end_page'}++;
1.330 albertel 7471: my $result;
1.335 albertel 7472: if ($args->{'discussion'}) {
7473: my ($target,$parser);
7474: if (ref($args->{'discussion'})) {
7475: ($target,$parser) =($args->{'discussion'}{'target'},
7476: $args->{'discussion'}{'parser'});
7477: }
7478: $result .= &Apache::lonxml::xmlend($target,$parser);
7479: }
1.330 albertel 7480: if ($args->{'frameset'}) {
7481: $result .= '</frameset>';
7482: } else {
1.635 raeburn 7483: $result .= &endbodytag($args);
1.330 albertel 7484: }
1.1080 raeburn 7485: unless ($args->{'notbody'}) {
7486: $result .= "\n</html>";
7487: }
1.330 albertel 7488:
1.315 albertel 7489: if ($args->{'js_ready'}) {
1.317 albertel 7490: $result = &js_ready($result);
1.315 albertel 7491: }
1.335 albertel 7492:
1.320 albertel 7493: if ($args->{'html_encode'}) {
7494: $result = &html_encode($result);
7495: }
1.335 albertel 7496:
1.315 albertel 7497: return $result;
7498: }
7499:
1.1034 www 7500: sub wishlist_window {
7501: return(<<'ENDWISHLIST');
1.1046 raeburn 7502: <script type="text/javascript">
1.1034 www 7503: // <![CDATA[
7504: // <!-- BEGIN LON-CAPA Internal
7505: function set_wishlistlink(title, path) {
7506: if (!title) {
7507: title = document.title;
7508: title = title.replace(/^LON-CAPA /,'');
7509: }
7510: if (!path) {
7511: path = location.pathname;
7512: }
7513: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7514: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7515: }
7516: // END LON-CAPA Internal -->
7517: // ]]>
7518: </script>
7519: ENDWISHLIST
7520: }
7521:
1.1030 www 7522: sub modal_window {
7523: return(<<'ENDMODAL');
1.1046 raeburn 7524: <script type="text/javascript">
1.1030 www 7525: // <![CDATA[
7526: // <!-- BEGIN LON-CAPA Internal
7527: var modalWindow = {
7528: parent:"body",
7529: windowId:null,
7530: content:null,
7531: width:null,
7532: height:null,
7533: close:function()
7534: {
7535: $(".LCmodal-window").remove();
7536: $(".LCmodal-overlay").remove();
7537: },
7538: open:function()
7539: {
7540: var modal = "";
7541: modal += "<div class=\"LCmodal-overlay\"></div>";
7542: 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;\">";
7543: modal += this.content;
7544: modal += "</div>";
7545:
7546: $(this.parent).append(modal);
7547:
7548: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7549: $(".LCclose-window").click(function(){modalWindow.close();});
7550: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7551: }
7552: };
1.1031 www 7553: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7554: {
7555: modalWindow.windowId = "myModal";
7556: modalWindow.width = width;
7557: modalWindow.height = height;
1.1031 www 7558: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7559: modalWindow.open();
7560: };
7561: // END LON-CAPA Internal -->
7562: // ]]>
7563: </script>
7564: ENDMODAL
7565: }
7566:
7567: sub modal_link {
1.1052 www 7568: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7569: unless ($width) { $width=480; }
7570: unless ($height) { $height=400; }
1.1031 www 7571: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7572: my $target_attr;
7573: if (defined($target)) {
7574: $target_attr = 'target="'.$target.'"';
7575: }
7576: return <<"ENDLINK";
7577: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7578: $linktext</a>
7579: ENDLINK
1.1030 www 7580: }
7581:
1.1032 www 7582: sub modal_adhoc_script {
7583: my ($funcname,$width,$height,$content)=@_;
7584: return (<<ENDADHOC);
1.1046 raeburn 7585: <script type="text/javascript">
1.1032 www 7586: // <![CDATA[
7587: var $funcname = function()
7588: {
7589: modalWindow.windowId = "myModal";
7590: modalWindow.width = $width;
7591: modalWindow.height = $height;
7592: modalWindow.content = '$content';
7593: modalWindow.open();
7594: };
7595: // ]]>
7596: </script>
7597: ENDADHOC
7598: }
7599:
1.1041 www 7600: sub modal_adhoc_inner {
7601: my ($funcname,$width,$height,$content)=@_;
7602: my $innerwidth=$width-20;
7603: $content=&js_ready(
1.1042 www 7604: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7605: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7606: $content.
7607: &end_scrollbox().
7608: &end_page()
7609: );
7610: return &modal_adhoc_script($funcname,$width,$height,$content);
7611: }
7612:
7613: sub modal_adhoc_window {
7614: my ($funcname,$width,$height,$content,$linktext)=@_;
7615: return &modal_adhoc_inner($funcname,$width,$height,$content).
7616: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7617: }
7618:
7619: sub modal_adhoc_launch {
7620: my ($funcname,$width,$height,$content)=@_;
7621: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7622: <script type="text/javascript">
7623: // <![CDATA[
7624: $funcname();
7625: // ]]>
7626: </script>
7627: ENDLAUNCH
7628: }
7629:
7630: sub modal_adhoc_close {
7631: return (<<ENDCLOSE);
7632: <script type="text/javascript">
7633: // <![CDATA[
7634: modalWindow.close();
7635: // ]]>
7636: </script>
7637: ENDCLOSE
7638: }
7639:
1.1038 www 7640: sub togglebox_script {
7641: return(<<ENDTOGGLE);
7642: <script type="text/javascript">
7643: // <![CDATA[
7644: function LCtoggleDisplay(id,hidetext,showtext) {
7645: link = document.getElementById(id + "link").childNodes[0];
7646: with (document.getElementById(id).style) {
7647: if (display == "none" ) {
7648: display = "inline";
7649: link.nodeValue = hidetext;
7650: } else {
7651: display = "none";
7652: link.nodeValue = showtext;
7653: }
7654: }
7655: }
7656: // ]]>
7657: </script>
7658: ENDTOGGLE
7659: }
7660:
1.1039 www 7661: sub start_togglebox {
7662: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7663: unless ($heading) { $heading=''; } else { $heading.=' '; }
7664: unless ($showtext) { $showtext=&mt('show'); }
7665: unless ($hidetext) { $hidetext=&mt('hide'); }
7666: unless ($headerbg) { $headerbg='#FFFFFF'; }
7667: return &start_data_table().
7668: &start_data_table_header_row().
7669: '<td bgcolor="'.$headerbg.'">'.$heading.
7670: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7671: $showtext.'\')">'.$showtext.'</a>]</td>'.
7672: &end_data_table_header_row().
7673: '<tr id="'.$id.'" style="display:none""><td>';
7674: }
7675:
7676: sub end_togglebox {
7677: return '</td></tr>'.&end_data_table();
7678: }
7679:
1.1041 www 7680: sub LCprogressbar_script {
1.1045 www 7681: my ($id)=@_;
1.1041 www 7682: return(<<ENDPROGRESS);
7683: <script type="text/javascript">
7684: // <![CDATA[
1.1045 www 7685: \$('#progressbar$id').progressbar({
1.1041 www 7686: value: 0,
7687: change: function(event, ui) {
7688: var newVal = \$(this).progressbar('option', 'value');
7689: \$('.pblabel', this).text(LCprogressTxt);
7690: }
7691: });
7692: // ]]>
7693: </script>
7694: ENDPROGRESS
7695: }
7696:
7697: sub LCprogressbarUpdate_script {
7698: return(<<ENDPROGRESSUPDATE);
7699: <style type="text/css">
7700: .ui-progressbar { position:relative; }
7701: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7702: </style>
7703: <script type="text/javascript">
7704: // <![CDATA[
1.1045 www 7705: var LCprogressTxt='---';
7706:
7707: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7708: LCprogressTxt=progresstext;
1.1045 www 7709: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7710: }
7711: // ]]>
7712: </script>
7713: ENDPROGRESSUPDATE
7714: }
7715:
1.1042 www 7716: my $LClastpercent;
1.1045 www 7717: my $LCidcnt;
7718: my $LCcurrentid;
1.1042 www 7719:
1.1041 www 7720: sub LCprogressbar {
1.1042 www 7721: my ($r)=(@_);
7722: $LClastpercent=0;
1.1045 www 7723: $LCidcnt++;
7724: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7725: my $starting=&mt('Starting');
7726: my $content=(<<ENDPROGBAR);
7727: <p>
1.1045 www 7728: <div id="progressbar$LCcurrentid">
1.1041 www 7729: <span class="pblabel">$starting</span>
7730: </div>
7731: </p>
7732: ENDPROGBAR
1.1045 www 7733: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7734: }
7735:
7736: sub LCprogressbarUpdate {
1.1042 www 7737: my ($r,$val,$text)=@_;
7738: unless ($val) {
7739: if ($LClastpercent) {
7740: $val=$LClastpercent;
7741: } else {
7742: $val=0;
7743: }
7744: }
1.1041 www 7745: if ($val<0) { $val=0; }
7746: if ($val>100) { $val=0; }
1.1042 www 7747: $LClastpercent=$val;
1.1041 www 7748: unless ($text) { $text=$val.'%'; }
7749: $text=&js_ready($text);
1.1044 www 7750: &r_print($r,<<ENDUPDATE);
1.1041 www 7751: <script type="text/javascript">
7752: // <![CDATA[
1.1045 www 7753: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7754: // ]]>
7755: </script>
7756: ENDUPDATE
1.1035 www 7757: }
7758:
1.1042 www 7759: sub LCprogressbarClose {
7760: my ($r)=@_;
7761: $LClastpercent=0;
1.1044 www 7762: &r_print($r,<<ENDCLOSE);
1.1042 www 7763: <script type="text/javascript">
7764: // <![CDATA[
1.1045 www 7765: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7766: // ]]>
7767: </script>
7768: ENDCLOSE
1.1044 www 7769: }
7770:
7771: sub r_print {
7772: my ($r,$to_print)=@_;
7773: if ($r) {
7774: $r->print($to_print);
7775: $r->rflush();
7776: } else {
7777: print($to_print);
7778: }
1.1042 www 7779: }
7780:
1.320 albertel 7781: sub html_encode {
7782: my ($result) = @_;
7783:
1.322 albertel 7784: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7785:
7786: return $result;
7787: }
1.1044 www 7788:
1.317 albertel 7789: sub js_ready {
7790: my ($result) = @_;
7791:
1.323 albertel 7792: $result =~ s/[\n\r]/ /xmsg;
7793: $result =~ s/\\/\\\\/xmsg;
7794: $result =~ s/'/\\'/xmsg;
1.372 albertel 7795: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7796:
7797: return $result;
7798: }
7799:
1.315 albertel 7800: sub validate_page {
7801: if ( exists($env{'internal.start_page'})
1.316 albertel 7802: && $env{'internal.start_page'} > 1) {
7803: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7804: $env{'internal.start_page'}.' '.
1.316 albertel 7805: $ENV{'request.filename'});
1.315 albertel 7806: }
7807: if ( exists($env{'internal.end_page'})
1.316 albertel 7808: && $env{'internal.end_page'} > 1) {
7809: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7810: $env{'internal.end_page'}.' '.
1.316 albertel 7811: $env{'request.filename'});
1.315 albertel 7812: }
7813: if ( exists($env{'internal.start_page'})
7814: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7815: &Apache::lonnet::logthis('start_page called without end_page '.
7816: $env{'request.filename'});
1.315 albertel 7817: }
7818: if ( ! exists($env{'internal.start_page'})
7819: && exists($env{'internal.end_page'})) {
1.316 albertel 7820: &Apache::lonnet::logthis('end_page called without start_page'.
7821: $env{'request.filename'});
1.315 albertel 7822: }
1.306 albertel 7823: }
1.315 albertel 7824:
1.996 www 7825:
7826: sub start_scrollbox {
1.1075 raeburn 7827: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7828: unless ($outerwidth) { $outerwidth='520px'; }
7829: unless ($width) { $width='500px'; }
7830: unless ($height) { $height='200px'; }
1.1075 raeburn 7831: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7832: if ($id ne '') {
1.1020 raeburn 7833: $table_id = " id='table_$id'";
7834: $div_id = " id='div_$id'";
1.1018 raeburn 7835: }
1.1075 raeburn 7836: if ($bgcolor ne '') {
7837: $tdcol = "background-color: $bgcolor;";
7838: }
7839: return <<"END";
7840: <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>
7841: END
1.996 www 7842: }
7843:
7844: sub end_scrollbox {
1.1036 www 7845: return '</div></td></tr></table>';
1.996 www 7846: }
7847:
1.318 albertel 7848: sub simple_error_page {
7849: my ($r,$title,$msg) = @_;
7850: my $page =
7851: &Apache::loncommon::start_page($title).
1.1097 ! bisitz 7852: '<p class="LC_error">'.&mt($msg).'</p>'.
1.318 albertel 7853: &Apache::loncommon::end_page();
7854: if (ref($r)) {
7855: $r->print($page);
1.327 albertel 7856: return;
1.318 albertel 7857: }
7858: return $page;
7859: }
1.347 albertel 7860:
7861: {
1.610 albertel 7862: my @row_count;
1.961 onken 7863:
7864: sub start_data_table_count {
7865: unshift(@row_count, 0);
7866: return;
7867: }
7868:
7869: sub end_data_table_count {
7870: shift(@row_count);
7871: return;
7872: }
7873:
1.347 albertel 7874: sub start_data_table {
1.1018 raeburn 7875: my ($add_class,$id) = @_;
1.422 albertel 7876: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7877: my $table_id;
7878: if (defined($id)) {
7879: $table_id = ' id="'.$id.'"';
7880: }
1.961 onken 7881: &start_data_table_count();
1.1018 raeburn 7882: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7883: }
7884:
7885: sub end_data_table {
1.961 onken 7886: &end_data_table_count();
1.389 albertel 7887: return '</table>'."\n";;
1.347 albertel 7888: }
7889:
7890: sub start_data_table_row {
1.974 wenzelju 7891: my ($add_class, $id) = @_;
1.610 albertel 7892: $row_count[0]++;
7893: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7894: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7895: $id = (' id="'.$id.'"') unless ($id eq '');
7896: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7897: }
1.471 banghart 7898:
7899: sub continue_data_table_row {
1.974 wenzelju 7900: my ($add_class, $id) = @_;
1.610 albertel 7901: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7902: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7903: $id = (' id="'.$id.'"') unless ($id eq '');
7904: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7905: }
1.347 albertel 7906:
7907: sub end_data_table_row {
1.389 albertel 7908: return '</tr>'."\n";;
1.347 albertel 7909: }
1.367 www 7910:
1.421 albertel 7911: sub start_data_table_empty_row {
1.707 bisitz 7912: # $row_count[0]++;
1.421 albertel 7913: return '<tr class="LC_empty_row" >'."\n";;
7914: }
7915:
7916: sub end_data_table_empty_row {
7917: return '</tr>'."\n";;
7918: }
7919:
1.367 www 7920: sub start_data_table_header_row {
1.389 albertel 7921: return '<tr class="LC_header_row">'."\n";;
1.367 www 7922: }
7923:
7924: sub end_data_table_header_row {
1.389 albertel 7925: return '</tr>'."\n";;
1.367 www 7926: }
1.890 droeschl 7927:
7928: sub data_table_caption {
7929: my $caption = shift;
7930: return "<caption class=\"LC_caption\">$caption</caption>";
7931: }
1.347 albertel 7932: }
7933:
1.548 albertel 7934: =pod
7935:
7936: =item * &inhibit_menu_check($arg)
7937:
7938: Checks for a inhibitmenu state and generates output to preserve it
7939:
7940: Inputs: $arg - can be any of
7941: - undef - in which case the return value is a string
7942: to add into arguments list of a uri
7943: - 'input' - in which case the return value is a HTML
7944: <form> <input> field of type hidden to
7945: preserve the value
7946: - a url - in which case the return value is the url with
7947: the neccesary cgi args added to preserve the
7948: inhibitmenu state
7949: - a ref to a url - no return value, but the string is
7950: updated to include the neccessary cgi
7951: args to preserve the inhibitmenu state
7952:
7953: =cut
7954:
7955: sub inhibit_menu_check {
7956: my ($arg) = @_;
7957: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7958: if ($arg eq 'input') {
7959: if ($env{'form.inhibitmenu'}) {
7960: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7961: } else {
7962: return
7963: }
7964: }
7965: if ($env{'form.inhibitmenu'}) {
7966: if (ref($arg)) {
7967: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7968: } elsif ($arg eq '') {
7969: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7970: } else {
7971: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7972: }
7973: }
7974: if (!ref($arg)) {
7975: return $arg;
7976: }
7977: }
7978:
1.251 albertel 7979: ###############################################
1.182 matthew 7980:
7981: =pod
7982:
1.549 albertel 7983: =back
7984:
7985: =head1 User Information Routines
7986:
7987: =over 4
7988:
1.405 albertel 7989: =item * &get_users_function()
1.182 matthew 7990:
7991: Used by &bodytag to determine the current users primary role.
7992: Returns either 'student','coordinator','admin', or 'author'.
7993:
7994: =cut
7995:
7996: ###############################################
7997: sub get_users_function {
1.815 tempelho 7998: my $function = 'norole';
1.818 tempelho 7999: if ($env{'request.role'}=~/^(st)/) {
8000: $function='student';
8001: }
1.907 raeburn 8002: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 8003: $function='coordinator';
8004: }
1.258 albertel 8005: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 8006: $function='admin';
8007: }
1.826 bisitz 8008: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 8009: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 8010: $function='author';
8011: }
8012: return $function;
1.54 www 8013: }
1.99 www 8014:
8015: ###############################################
8016:
1.233 raeburn 8017: =pod
8018:
1.821 raeburn 8019: =item * &show_course()
8020:
8021: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8022: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8023:
8024: Inputs:
8025: None
8026:
8027: Outputs:
8028: Scalar: 1 if 'Course' to be used, 0 otherwise.
8029:
8030: =cut
8031:
8032: ###############################################
8033: sub show_course {
8034: my $course = !$env{'user.adv'};
8035: if (!$env{'user.adv'}) {
8036: foreach my $env (keys(%env)) {
8037: next if ($env !~ m/^user\.priv\./);
8038: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8039: $course = 0;
8040: last;
8041: }
8042: }
8043: }
8044: return $course;
8045: }
8046:
8047: ###############################################
8048:
8049: =pod
8050:
1.542 raeburn 8051: =item * &check_user_status()
1.274 raeburn 8052:
8053: Determines current status of supplied role for a
8054: specific user. Roles can be active, previous or future.
8055:
8056: Inputs:
8057: user's domain, user's username, course's domain,
1.375 raeburn 8058: course's number, optional section ID.
1.274 raeburn 8059:
8060: Outputs:
8061: role status: active, previous or future.
8062:
8063: =cut
8064:
8065: sub check_user_status {
1.412 raeburn 8066: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8067: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8068: my @uroles = keys %userinfo;
8069: my $srchstr;
8070: my $active_chk = 'none';
1.412 raeburn 8071: my $now = time;
1.274 raeburn 8072: if (@uroles > 0) {
1.908 raeburn 8073: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8074: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8075: } else {
1.412 raeburn 8076: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8077: }
8078: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8079: my $role_end = 0;
8080: my $role_start = 0;
8081: $active_chk = 'active';
1.412 raeburn 8082: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8083: $role_end = $1;
8084: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8085: $role_start = $1;
1.274 raeburn 8086: }
8087: }
8088: if ($role_start > 0) {
1.412 raeburn 8089: if ($now < $role_start) {
1.274 raeburn 8090: $active_chk = 'future';
8091: }
8092: }
8093: if ($role_end > 0) {
1.412 raeburn 8094: if ($now > $role_end) {
1.274 raeburn 8095: $active_chk = 'previous';
8096: }
8097: }
8098: }
8099: }
8100: return $active_chk;
8101: }
8102:
8103: ###############################################
8104:
8105: =pod
8106:
1.405 albertel 8107: =item * &get_sections()
1.233 raeburn 8108:
8109: Determines all the sections for a course including
8110: sections with students and sections containing other roles.
1.419 raeburn 8111: Incoming parameters:
8112:
8113: 1. domain
8114: 2. course number
8115: 3. reference to array containing roles for which sections should
8116: be gathered (optional).
8117: 4. reference to array containing status types for which sections
8118: should be gathered (optional).
8119:
8120: If the third argument is undefined, sections are gathered for any role.
8121: If the fourth argument is undefined, sections are gathered for any status.
8122: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8123:
1.374 raeburn 8124: Returns section hash (keys are section IDs, values are
8125: number of users in each section), subject to the
1.419 raeburn 8126: optional roles filter, optional status filter
1.233 raeburn 8127:
8128: =cut
8129:
8130: ###############################################
8131: sub get_sections {
1.419 raeburn 8132: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8133: if (!defined($cdom) || !defined($cnum)) {
8134: my $cid = $env{'request.course.id'};
8135:
8136: return if (!defined($cid));
8137:
8138: $cdom = $env{'course.'.$cid.'.domain'};
8139: $cnum = $env{'course.'.$cid.'.num'};
8140: }
8141:
8142: my %sectioncount;
1.419 raeburn 8143: my $now = time;
1.240 albertel 8144:
1.366 albertel 8145: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8146: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8147: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8148: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8149: my $start_index = &Apache::loncoursedata::CL_START();
8150: my $end_index = &Apache::loncoursedata::CL_END();
8151: my $status;
1.366 albertel 8152: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8153: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8154: $data->[$status_index],
8155: $data->[$start_index],
8156: $data->[$end_index]);
8157: if ($stu_status eq 'Active') {
8158: $status = 'active';
8159: } elsif ($end < $now) {
8160: $status = 'previous';
8161: } elsif ($start > $now) {
8162: $status = 'future';
8163: }
8164: if ($section ne '-1' && $section !~ /^\s*$/) {
8165: if ((!defined($possible_status)) || (($status ne '') &&
8166: (grep/^\Q$status\E$/,@{$possible_status}))) {
8167: $sectioncount{$section}++;
8168: }
1.240 albertel 8169: }
8170: }
8171: }
8172: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8173: foreach my $user (sort(keys(%courseroles))) {
8174: if ($user !~ /^(\w{2})/) { next; }
8175: my ($role) = ($user =~ /^(\w{2})/);
8176: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8177: my ($section,$status);
1.240 albertel 8178: if ($role eq 'cr' &&
8179: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8180: $section=$1;
8181: }
8182: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8183: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8184: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8185: if ($end == -1 && $start == -1) {
8186: next; #deleted role
8187: }
8188: if (!defined($possible_status)) {
8189: $sectioncount{$section}++;
8190: } else {
8191: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8192: $status = 'active';
8193: } elsif ($end < $now) {
8194: $status = 'future';
8195: } elsif ($start > $now) {
8196: $status = 'previous';
8197: }
8198: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8199: $sectioncount{$section}++;
8200: }
8201: }
1.233 raeburn 8202: }
1.366 albertel 8203: return %sectioncount;
1.233 raeburn 8204: }
8205:
1.274 raeburn 8206: ###############################################
1.294 raeburn 8207:
8208: =pod
1.405 albertel 8209:
8210: =item * &get_course_users()
8211:
1.275 raeburn 8212: Retrieves usernames:domains for users in the specified course
8213: with specific role(s), and access status.
8214:
8215: Incoming parameters:
1.277 albertel 8216: 1. course domain
8217: 2. course number
8218: 3. access status: users must have - either active,
1.275 raeburn 8219: previous, future, or all.
1.277 albertel 8220: 4. reference to array of permissible roles
1.288 raeburn 8221: 5. reference to array of section restrictions (optional)
8222: 6. reference to results object (hash of hashes).
8223: 7. reference to optional userdata hash
1.609 raeburn 8224: 8. reference to optional statushash
1.630 raeburn 8225: 9. flag if privileged users (except those set to unhide in
8226: course settings) should be excluded
1.609 raeburn 8227: Keys of top level results hash are roles.
1.275 raeburn 8228: Keys of inner hashes are username:domain, with
8229: values set to access type.
1.288 raeburn 8230: Optional userdata hash returns an array with arguments in the
8231: same order as loncoursedata::get_classlist() for student data.
8232:
1.609 raeburn 8233: Optional statushash returns
8234:
1.288 raeburn 8235: Entries for end, start, section and status are blank because
8236: of the possibility of multiple values for non-student roles.
8237:
1.275 raeburn 8238: =cut
1.405 albertel 8239:
1.275 raeburn 8240: ###############################################
1.405 albertel 8241:
1.275 raeburn 8242: sub get_course_users {
1.630 raeburn 8243: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8244: my %idx = ();
1.419 raeburn 8245: my %seclists;
1.288 raeburn 8246:
8247: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8248: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8249: $idx{end} = &Apache::loncoursedata::CL_END();
8250: $idx{start} = &Apache::loncoursedata::CL_START();
8251: $idx{id} = &Apache::loncoursedata::CL_ID();
8252: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8253: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8254: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8255:
1.290 albertel 8256: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8257: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8258: my $now = time;
1.277 albertel 8259: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8260: my $match = 0;
1.412 raeburn 8261: my $secmatch = 0;
1.419 raeburn 8262: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8263: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8264: if ($section eq '') {
8265: $section = 'none';
8266: }
1.291 albertel 8267: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8268: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8269: $secmatch = 1;
8270: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8271: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8272: $secmatch = 1;
8273: }
8274: } else {
1.419 raeburn 8275: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8276: $secmatch = 1;
8277: }
1.290 albertel 8278: }
1.412 raeburn 8279: if (!$secmatch) {
8280: next;
8281: }
1.419 raeburn 8282: }
1.275 raeburn 8283: if (defined($$types{'active'})) {
1.288 raeburn 8284: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8285: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8286: $match = 1;
1.275 raeburn 8287: }
8288: }
8289: if (defined($$types{'previous'})) {
1.609 raeburn 8290: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8291: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8292: $match = 1;
1.275 raeburn 8293: }
8294: }
8295: if (defined($$types{'future'})) {
1.609 raeburn 8296: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8297: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8298: $match = 1;
1.275 raeburn 8299: }
8300: }
1.609 raeburn 8301: if ($match) {
8302: push(@{$seclists{$student}},$section);
8303: if (ref($userdata) eq 'HASH') {
8304: $$userdata{$student} = $$classlist{$student};
8305: }
8306: if (ref($statushash) eq 'HASH') {
8307: $statushash->{$student}{'st'}{$section} = $status;
8308: }
1.288 raeburn 8309: }
1.275 raeburn 8310: }
8311: }
1.412 raeburn 8312: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8313: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8314: my $now = time;
1.609 raeburn 8315: my %displaystatus = ( previous => 'Expired',
8316: active => 'Active',
8317: future => 'Future',
8318: );
1.630 raeburn 8319: my %nothide;
8320: if ($hidepriv) {
8321: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8322: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8323: if ($user !~ /:/) {
8324: $nothide{join(':',split(/[\@]/,$user))}=1;
8325: } else {
8326: $nothide{$user} = 1;
8327: }
8328: }
8329: }
1.439 raeburn 8330: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8331: my $match = 0;
1.412 raeburn 8332: my $secmatch = 0;
1.439 raeburn 8333: my $status;
1.412 raeburn 8334: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8335: $user =~ s/:$//;
1.439 raeburn 8336: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8337: if ($end == -1 || $start == -1) {
8338: next;
8339: }
8340: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8341: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8342: my ($uname,$udom) = split(/:/,$user);
8343: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8344: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8345: $secmatch = 1;
8346: } elsif ($usec eq '') {
1.420 albertel 8347: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8348: $secmatch = 1;
8349: }
8350: } else {
8351: if (grep(/^\Q$usec\E$/,@{$sections})) {
8352: $secmatch = 1;
8353: }
8354: }
8355: if (!$secmatch) {
8356: next;
8357: }
1.288 raeburn 8358: }
1.419 raeburn 8359: if ($usec eq '') {
8360: $usec = 'none';
8361: }
1.275 raeburn 8362: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8363: if ($hidepriv) {
8364: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8365: (!$nothide{$uname.':'.$udom})) {
8366: next;
8367: }
8368: }
1.503 raeburn 8369: if ($end > 0 && $end < $now) {
1.439 raeburn 8370: $status = 'previous';
8371: } elsif ($start > $now) {
8372: $status = 'future';
8373: } else {
8374: $status = 'active';
8375: }
1.277 albertel 8376: foreach my $type (keys(%{$types})) {
1.275 raeburn 8377: if ($status eq $type) {
1.420 albertel 8378: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8379: push(@{$$users{$role}{$user}},$type);
8380: }
1.288 raeburn 8381: $match = 1;
8382: }
8383: }
1.419 raeburn 8384: if (($match) && (ref($userdata) eq 'HASH')) {
8385: if (!exists($$userdata{$uname.':'.$udom})) {
8386: &get_user_info($udom,$uname,\%idx,$userdata);
8387: }
1.420 albertel 8388: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8389: push(@{$seclists{$uname.':'.$udom}},$usec);
8390: }
1.609 raeburn 8391: if (ref($statushash) eq 'HASH') {
8392: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8393: }
1.275 raeburn 8394: }
8395: }
8396: }
8397: }
1.290 albertel 8398: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8399: if ((defined($cdom)) && (defined($cnum))) {
8400: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8401: if ( defined($csettings{'internal.courseowner'}) ) {
8402: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8403: next if ($owner eq '');
8404: my ($ownername,$ownerdom);
8405: if ($owner =~ /^([^:]+):([^:]+)$/) {
8406: $ownername = $1;
8407: $ownerdom = $2;
8408: } else {
8409: $ownername = $owner;
8410: $ownerdom = $cdom;
8411: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8412: }
8413: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8414: if (defined($userdata) &&
1.609 raeburn 8415: !exists($$userdata{$owner})) {
8416: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8417: if (!grep(/^none$/,@{$seclists{$owner}})) {
8418: push(@{$seclists{$owner}},'none');
8419: }
8420: if (ref($statushash) eq 'HASH') {
8421: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8422: }
1.290 albertel 8423: }
1.279 raeburn 8424: }
8425: }
8426: }
1.419 raeburn 8427: foreach my $user (keys(%seclists)) {
8428: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8429: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8430: }
1.275 raeburn 8431: }
8432: return;
8433: }
8434:
1.288 raeburn 8435: sub get_user_info {
8436: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8437: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8438: &plainname($uname,$udom,'lastname');
1.291 albertel 8439: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8440: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8441: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8442: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8443: return;
8444: }
1.275 raeburn 8445:
1.472 raeburn 8446: ###############################################
8447:
8448: =pod
8449:
8450: =item * &get_user_quota()
8451:
8452: Retrieves quota assigned for storage of portfolio files for a user
8453:
8454: Incoming parameters:
8455: 1. user's username
8456: 2. user's domain
8457:
8458: Returns:
1.536 raeburn 8459: 1. Disk quota (in Mb) assigned to student.
8460: 2. (Optional) Type of setting: custom or default
8461: (individually assigned or default for user's
8462: institutional status).
8463: 3. (Optional) - User's institutional status (e.g., faculty, staff
8464: or student - types as defined in localenroll::inst_usertypes
8465: for user's domain, which determines default quota for user.
8466: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8467:
8468: If a value has been stored in the user's environment,
1.536 raeburn 8469: it will return that, otherwise it returns the maximal default
8470: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8471:
8472: =cut
8473:
8474: ###############################################
8475:
8476:
8477: sub get_user_quota {
8478: my ($uname,$udom) = @_;
1.536 raeburn 8479: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8480: if (!defined($udom)) {
8481: $udom = $env{'user.domain'};
8482: }
8483: if (!defined($uname)) {
8484: $uname = $env{'user.name'};
8485: }
8486: if (($udom eq '' || $uname eq '') ||
8487: ($udom eq 'public') && ($uname eq 'public')) {
8488: $quota = 0;
1.536 raeburn 8489: $quotatype = 'default';
8490: $defquota = 0;
1.472 raeburn 8491: } else {
1.536 raeburn 8492: my $inststatus;
1.472 raeburn 8493: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8494: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8495: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8496: } else {
1.536 raeburn 8497: my %userenv =
8498: &Apache::lonnet::get('environment',['portfolioquota',
8499: 'inststatus'],$udom,$uname);
1.472 raeburn 8500: my ($tmp) = keys(%userenv);
8501: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8502: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8503: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8504: } else {
8505: undef(%userenv);
8506: }
8507: }
1.536 raeburn 8508: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8509: if ($quota eq '') {
1.536 raeburn 8510: $quota = $defquota;
8511: $quotatype = 'default';
8512: } else {
8513: $quotatype = 'custom';
1.472 raeburn 8514: }
8515: }
1.536 raeburn 8516: if (wantarray) {
8517: return ($quota,$quotatype,$settingstatus,$defquota);
8518: } else {
8519: return $quota;
8520: }
1.472 raeburn 8521: }
8522:
8523: ###############################################
8524:
8525: =pod
8526:
8527: =item * &default_quota()
8528:
1.536 raeburn 8529: Retrieves default quota assigned for storage of user portfolio files,
8530: given an (optional) user's institutional status.
1.472 raeburn 8531:
8532: Incoming parameters:
8533: 1. domain
1.536 raeburn 8534: 2. (Optional) institutional status(es). This is a : separated list of
8535: status types (e.g., faculty, staff, student etc.)
8536: which apply to the user for whom the default is being retrieved.
8537: If the institutional status string in undefined, the domain
8538: default quota will be returned.
1.472 raeburn 8539:
8540: Returns:
8541: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8542: 2. (Optional) institutional type which determined the value of the
8543: default quota.
1.472 raeburn 8544:
8545: If a value has been stored in the domain's configuration db,
8546: it will return that, otherwise it returns 20 (for backwards
8547: compatibility with domains which have not set up a configuration
8548: db file; the original statically defined portfolio quota was 20 Mb).
8549:
1.536 raeburn 8550: If the user's status includes multiple types (e.g., staff and student),
8551: the largest default quota which applies to the user determines the
8552: default quota returned.
8553:
1.780 raeburn 8554: =back
8555:
1.472 raeburn 8556: =cut
8557:
8558: ###############################################
8559:
8560:
8561: sub default_quota {
1.536 raeburn 8562: my ($udom,$inststatus) = @_;
8563: my ($defquota,$settingstatus);
8564: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8565: ['quotas'],$udom);
8566: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8567: if ($inststatus ne '') {
1.765 raeburn 8568: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8569: foreach my $item (@statuses) {
1.711 raeburn 8570: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8571: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8572: if ($defquota eq '') {
8573: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8574: $settingstatus = $item;
8575: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8576: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8577: $settingstatus = $item;
8578: }
8579: }
8580: } else {
8581: if ($quotahash{'quotas'}{$item} ne '') {
8582: if ($defquota eq '') {
8583: $defquota = $quotahash{'quotas'}{$item};
8584: $settingstatus = $item;
8585: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8586: $defquota = $quotahash{'quotas'}{$item};
8587: $settingstatus = $item;
8588: }
1.536 raeburn 8589: }
8590: }
8591: }
8592: }
8593: if ($defquota eq '') {
1.711 raeburn 8594: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8595: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8596: } else {
8597: $defquota = $quotahash{'quotas'}{'default'};
8598: }
1.536 raeburn 8599: $settingstatus = 'default';
8600: }
8601: } else {
8602: $settingstatus = 'default';
8603: $defquota = 20;
8604: }
8605: if (wantarray) {
8606: return ($defquota,$settingstatus);
1.472 raeburn 8607: } else {
1.536 raeburn 8608: return $defquota;
1.472 raeburn 8609: }
8610: }
8611:
1.384 raeburn 8612: sub get_secgrprole_info {
8613: my ($cdom,$cnum,$needroles,$type) = @_;
8614: my %sections_count = &get_sections($cdom,$cnum);
8615: my @sections = (sort {$a <=> $b} keys(%sections_count));
8616: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8617: my @groups = sort(keys(%curr_groups));
8618: my $allroles = [];
8619: my $rolehash;
8620: my $accesshash = {
8621: active => 'Currently has access',
8622: future => 'Will have future access',
8623: previous => 'Previously had access',
8624: };
8625: if ($needroles) {
8626: $rolehash = {'all' => 'all'};
1.385 albertel 8627: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8628: if (&Apache::lonnet::error(%user_roles)) {
8629: undef(%user_roles);
8630: }
8631: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8632: my ($role)=split(/\:/,$item,2);
8633: if ($role eq 'cr') { next; }
8634: if ($role =~ /^cr/) {
8635: $$rolehash{$role} = (split('/',$role))[3];
8636: } else {
8637: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8638: }
8639: }
8640: foreach my $key (sort(keys(%{$rolehash}))) {
8641: push(@{$allroles},$key);
8642: }
8643: push (@{$allroles},'st');
8644: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8645: }
8646: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8647: }
8648:
1.555 raeburn 8649: sub user_picker {
1.994 raeburn 8650: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8651: my $currdom = $dom;
8652: my %curr_selected = (
8653: srchin => 'dom',
1.580 raeburn 8654: srchby => 'lastname',
1.555 raeburn 8655: );
8656: my $srchterm;
1.625 raeburn 8657: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8658: if ($srch->{'srchby'} ne '') {
8659: $curr_selected{'srchby'} = $srch->{'srchby'};
8660: }
8661: if ($srch->{'srchin'} ne '') {
8662: $curr_selected{'srchin'} = $srch->{'srchin'};
8663: }
8664: if ($srch->{'srchtype'} ne '') {
8665: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8666: }
8667: if ($srch->{'srchdomain'} ne '') {
8668: $currdom = $srch->{'srchdomain'};
8669: }
8670: $srchterm = $srch->{'srchterm'};
8671: }
8672: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8673: 'usr' => 'Search criteria',
1.563 raeburn 8674: 'doma' => 'Domain/institution to search',
1.558 albertel 8675: 'uname' => 'username',
8676: 'lastname' => 'last name',
1.555 raeburn 8677: 'lastfirst' => 'last name, first name',
1.558 albertel 8678: 'crs' => 'in this course',
1.576 raeburn 8679: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8680: 'alc' => 'all LON-CAPA',
1.573 raeburn 8681: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8682: 'exact' => 'is',
8683: 'contains' => 'contains',
1.569 raeburn 8684: 'begins' => 'begins with',
1.571 raeburn 8685: 'youm' => "You must include some text to search for.",
8686: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8687: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8688: 'yomc' => "You must choose a domain when using an institutional directory search.",
8689: 'ymcd' => "You must choose a domain when using a domain search.",
8690: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8691: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8692: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8693: );
1.563 raeburn 8694: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8695: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8696:
8697: my @srchins = ('crs','dom','alc','instd');
8698:
8699: foreach my $option (@srchins) {
8700: # FIXME 'alc' option unavailable until
8701: # loncreateuser::print_user_query_page()
8702: # has been completed.
8703: next if ($option eq 'alc');
1.880 raeburn 8704: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8705: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8706: if ($curr_selected{'srchin'} eq $option) {
8707: $srchinsel .= '
8708: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8709: } else {
8710: $srchinsel .= '
8711: <option value="'.$option.'">'.$lt{$option}.'</option>';
8712: }
1.555 raeburn 8713: }
1.563 raeburn 8714: $srchinsel .= "\n </select>\n";
1.555 raeburn 8715:
8716: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8717: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8718: if ($curr_selected{'srchby'} eq $option) {
8719: $srchbysel .= '
8720: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8721: } else {
8722: $srchbysel .= '
8723: <option value="'.$option.'">'.$lt{$option}.'</option>';
8724: }
8725: }
8726: $srchbysel .= "\n </select>\n";
8727:
8728: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8729: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8730: if ($curr_selected{'srchtype'} eq $option) {
8731: $srchtypesel .= '
8732: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8733: } else {
8734: $srchtypesel .= '
8735: <option value="'.$option.'">'.$lt{$option}.'</option>';
8736: }
8737: }
8738: $srchtypesel .= "\n </select>\n";
8739:
1.558 albertel 8740: my ($newuserscript,$new_user_create);
1.994 raeburn 8741: my $context_dom = $env{'request.role.domain'};
8742: if ($context eq 'requestcrs') {
8743: if ($env{'form.coursedom'} ne '') {
8744: $context_dom = $env{'form.coursedom'};
8745: }
8746: }
1.556 raeburn 8747: if ($forcenewuser) {
1.576 raeburn 8748: if (ref($srch) eq 'HASH') {
1.994 raeburn 8749: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8750: if ($cancreate) {
8751: $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>';
8752: } else {
1.799 bisitz 8753: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8754: my %usertypetext = (
8755: official => 'institutional',
8756: unofficial => 'non-institutional',
8757: );
1.799 bisitz 8758: $new_user_create = '<p class="LC_warning">'
8759: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8760: .' '
8761: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8762: ,'<a href="'.$helplink.'">','</a>')
8763: .'</p><br />';
1.627 raeburn 8764: }
1.576 raeburn 8765: }
8766: }
8767:
1.556 raeburn 8768: $newuserscript = <<"ENDSCRIPT";
8769:
1.570 raeburn 8770: function setSearch(createnew,callingForm) {
1.556 raeburn 8771: if (createnew == 1) {
1.570 raeburn 8772: for (var i=0; i<callingForm.srchby.length; i++) {
8773: if (callingForm.srchby.options[i].value == 'uname') {
8774: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8775: }
8776: }
1.570 raeburn 8777: for (var i=0; i<callingForm.srchin.length; i++) {
8778: if ( callingForm.srchin.options[i].value == 'dom') {
8779: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8780: }
8781: }
1.570 raeburn 8782: for (var i=0; i<callingForm.srchtype.length; i++) {
8783: if (callingForm.srchtype.options[i].value == 'exact') {
8784: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8785: }
8786: }
1.570 raeburn 8787: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8788: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8789: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8790: }
8791: }
8792: }
8793: }
8794: ENDSCRIPT
1.558 albertel 8795:
1.556 raeburn 8796: }
8797:
1.555 raeburn 8798: my $output = <<"END_BLOCK";
1.556 raeburn 8799: <script type="text/javascript">
1.824 bisitz 8800: // <![CDATA[
1.570 raeburn 8801: function validateEntry(callingForm) {
1.558 albertel 8802:
1.556 raeburn 8803: var checkok = 1;
1.558 albertel 8804: var srchin;
1.570 raeburn 8805: for (var i=0; i<callingForm.srchin.length; i++) {
8806: if ( callingForm.srchin[i].checked ) {
8807: srchin = callingForm.srchin[i].value;
1.558 albertel 8808: }
8809: }
8810:
1.570 raeburn 8811: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8812: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8813: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8814: var srchterm = callingForm.srchterm.value;
8815: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8816: var msg = "";
8817:
8818: if (srchterm == "") {
8819: checkok = 0;
1.571 raeburn 8820: msg += "$lt{'youm'}\\n";
1.556 raeburn 8821: }
8822:
1.569 raeburn 8823: if (srchtype== 'begins') {
8824: if (srchterm.length < 2) {
8825: checkok = 0;
1.571 raeburn 8826: msg += "$lt{'thte'}\\n";
1.569 raeburn 8827: }
8828: }
8829:
1.556 raeburn 8830: if (srchtype== 'contains') {
8831: if (srchterm.length < 3) {
8832: checkok = 0;
1.571 raeburn 8833: msg += "$lt{'thet'}\\n";
1.556 raeburn 8834: }
8835: }
8836: if (srchin == 'instd') {
8837: if (srchdomain == '') {
8838: checkok = 0;
1.571 raeburn 8839: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8840: }
8841: }
8842: if (srchin == 'dom') {
8843: if (srchdomain == '') {
8844: checkok = 0;
1.571 raeburn 8845: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8846: }
8847: }
8848: if (srchby == 'lastfirst') {
8849: if (srchterm.indexOf(",") == -1) {
8850: checkok = 0;
1.571 raeburn 8851: msg += "$lt{'whus'}\\n";
1.556 raeburn 8852: }
8853: if (srchterm.indexOf(",") == srchterm.length -1) {
8854: checkok = 0;
1.571 raeburn 8855: msg += "$lt{'whse'}\\n";
1.556 raeburn 8856: }
8857: }
8858: if (checkok == 0) {
1.571 raeburn 8859: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8860: return;
8861: }
8862: if (checkok == 1) {
1.570 raeburn 8863: callingForm.submit();
1.556 raeburn 8864: }
8865: }
8866:
8867: $newuserscript
8868:
1.824 bisitz 8869: // ]]>
1.556 raeburn 8870: </script>
1.558 albertel 8871:
8872: $new_user_create
8873:
1.555 raeburn 8874: END_BLOCK
1.558 albertel 8875:
1.876 raeburn 8876: $output .= &Apache::lonhtmlcommon::start_pick_box().
8877: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8878: $domform.
8879: &Apache::lonhtmlcommon::row_closure().
8880: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8881: $srchbysel.
8882: $srchtypesel.
8883: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8884: $srchinsel.
8885: &Apache::lonhtmlcommon::row_closure(1).
8886: &Apache::lonhtmlcommon::end_pick_box().
8887: '<br />';
1.555 raeburn 8888: return $output;
8889: }
8890:
1.612 raeburn 8891: sub user_rule_check {
1.615 raeburn 8892: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8893: my $response;
8894: if (ref($usershash) eq 'HASH') {
8895: foreach my $user (keys(%{$usershash})) {
8896: my ($uname,$udom) = split(/:/,$user);
8897: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8898: my ($id,$newuser);
1.612 raeburn 8899: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8900: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8901: $id = $usershash->{$user}->{'id'};
8902: }
8903: my $inst_response;
8904: if (ref($checks) eq 'HASH') {
8905: if (defined($checks->{'username'})) {
1.615 raeburn 8906: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8907: &Apache::lonnet::get_instuser($udom,$uname);
8908: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8909: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8910: &Apache::lonnet::get_instuser($udom,undef,$id);
8911: }
1.615 raeburn 8912: } else {
8913: ($inst_response,%{$inst_results->{$user}}) =
8914: &Apache::lonnet::get_instuser($udom,$uname);
8915: return;
1.612 raeburn 8916: }
1.615 raeburn 8917: if (!$got_rules->{$udom}) {
1.612 raeburn 8918: my %domconfig = &Apache::lonnet::get_dom('configuration',
8919: ['usercreation'],$udom);
8920: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8921: foreach my $item ('username','id') {
1.612 raeburn 8922: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8923: $$curr_rules{$udom}{$item} =
8924: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8925: }
8926: }
8927: }
1.615 raeburn 8928: $got_rules->{$udom} = 1;
1.585 raeburn 8929: }
1.612 raeburn 8930: foreach my $item (keys(%{$checks})) {
8931: if (ref($$curr_rules{$udom}) eq 'HASH') {
8932: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8933: if (@{$$curr_rules{$udom}{$item}} > 0) {
8934: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8935: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8936: if ($rule_check{$rule}) {
8937: $$rulematch{$user}{$item} = $rule;
8938: if ($inst_response eq 'ok') {
1.615 raeburn 8939: if (ref($inst_results) eq 'HASH') {
8940: if (ref($inst_results->{$user}) eq 'HASH') {
8941: if (keys(%{$inst_results->{$user}}) == 0) {
8942: $$alerts{$item}{$udom}{$uname} = 1;
8943: }
1.612 raeburn 8944: }
8945: }
1.615 raeburn 8946: }
8947: last;
1.585 raeburn 8948: }
8949: }
8950: }
8951: }
8952: }
8953: }
8954: }
8955: }
1.612 raeburn 8956: return;
8957: }
8958:
8959: sub user_rule_formats {
8960: my ($domain,$domdesc,$curr_rules,$check) = @_;
8961: my %text = (
8962: 'username' => 'Usernames',
8963: 'id' => 'IDs',
8964: );
8965: my $output;
8966: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8967: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8968: if (@{$ruleorder} > 0) {
8969: $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>';
8970: foreach my $rule (@{$ruleorder}) {
8971: if (ref($curr_rules) eq 'ARRAY') {
8972: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8973: if (ref($rules->{$rule}) eq 'HASH') {
8974: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8975: $rules->{$rule}{'desc'}.'</li>';
8976: }
8977: }
8978: }
8979: }
8980: $output .= '</ul>';
8981: }
8982: }
8983: return $output;
8984: }
8985:
8986: sub instrule_disallow_msg {
1.615 raeburn 8987: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8988: my $response;
8989: my %text = (
8990: item => 'username',
8991: items => 'usernames',
8992: match => 'matches',
8993: do => 'does',
8994: action => 'a username',
8995: one => 'one',
8996: );
8997: if ($count > 1) {
8998: $text{'item'} = 'usernames';
8999: $text{'match'} ='match';
9000: $text{'do'} = 'do';
9001: $text{'action'} = 'usernames',
9002: $text{'one'} = 'ones';
9003: }
9004: if ($checkitem eq 'id') {
9005: $text{'items'} = 'IDs';
9006: $text{'item'} = 'ID';
9007: $text{'action'} = 'an ID';
1.615 raeburn 9008: if ($count > 1) {
9009: $text{'item'} = 'IDs';
9010: $text{'action'} = 'IDs';
9011: }
1.612 raeburn 9012: }
1.674 bisitz 9013: $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 9014: if ($mode eq 'upload') {
9015: if ($checkitem eq 'username') {
9016: $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'}.");
9017: } elsif ($checkitem eq 'id') {
1.674 bisitz 9018: $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 9019: }
1.669 raeburn 9020: } elsif ($mode eq 'selfcreate') {
9021: if ($checkitem eq 'id') {
9022: $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.");
9023: }
1.615 raeburn 9024: } else {
9025: if ($checkitem eq 'username') {
9026: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9027: } elsif ($checkitem eq 'id') {
9028: $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.");
9029: }
1.612 raeburn 9030: }
9031: return $response;
1.585 raeburn 9032: }
9033:
1.624 raeburn 9034: sub personal_data_fieldtitles {
9035: my %fieldtitles = &Apache::lonlocal::texthash (
9036: id => 'Student/Employee ID',
9037: permanentemail => 'E-mail address',
9038: lastname => 'Last Name',
9039: firstname => 'First Name',
9040: middlename => 'Middle Name',
9041: generation => 'Generation',
9042: gen => 'Generation',
1.765 raeburn 9043: inststatus => 'Affiliation',
1.624 raeburn 9044: );
9045: return %fieldtitles;
9046: }
9047:
1.642 raeburn 9048: sub sorted_inst_types {
9049: my ($dom) = @_;
9050: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9051: my $othertitle = &mt('All users');
9052: if ($env{'request.course.id'}) {
1.668 raeburn 9053: $othertitle = &mt('Any users');
1.642 raeburn 9054: }
9055: my @types;
9056: if (ref($order) eq 'ARRAY') {
9057: @types = @{$order};
9058: }
9059: if (@types == 0) {
9060: if (ref($usertypes) eq 'HASH') {
9061: @types = sort(keys(%{$usertypes}));
9062: }
9063: }
9064: if (keys(%{$usertypes}) > 0) {
9065: $othertitle = &mt('Other users');
9066: }
9067: return ($othertitle,$usertypes,\@types);
9068: }
9069:
1.645 raeburn 9070: sub get_institutional_codes {
9071: my ($settings,$allcourses,$LC_code) = @_;
9072: # Get complete list of course sections to update
9073: my @currsections = ();
9074: my @currxlists = ();
9075: my $coursecode = $$settings{'internal.coursecode'};
9076:
9077: if ($$settings{'internal.sectionnums'} ne '') {
9078: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9079: }
9080:
9081: if ($$settings{'internal.crosslistings'} ne '') {
9082: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9083: }
9084:
9085: if (@currxlists > 0) {
9086: foreach (@currxlists) {
9087: if (m/^([^:]+):(\w*)$/) {
9088: unless (grep/^$1$/,@{$allcourses}) {
9089: push @{$allcourses},$1;
9090: $$LC_code{$1} = $2;
9091: }
9092: }
9093: }
9094: }
9095:
9096: if (@currsections > 0) {
9097: foreach (@currsections) {
9098: if (m/^(\w+):(\w*)$/) {
9099: my $sec = $coursecode.$1;
9100: my $lc_sec = $2;
9101: unless (grep/^$sec$/,@{$allcourses}) {
9102: push @{$allcourses},$sec;
9103: $$LC_code{$sec} = $lc_sec;
9104: }
9105: }
9106: }
9107: }
9108: return;
9109: }
9110:
1.971 raeburn 9111: sub get_standard_codeitems {
9112: return ('Year','Semester','Department','Number','Section');
9113: }
9114:
1.112 bowersj2 9115: =pod
9116:
1.780 raeburn 9117: =head1 Slot Helpers
9118:
9119: =over 4
9120:
9121: =item * sorted_slots()
9122:
1.1040 raeburn 9123: Sorts an array of slot names in order of an optional sort key,
9124: default sort is by slot start time (earliest first).
1.780 raeburn 9125:
9126: Inputs:
9127:
9128: =over 4
9129:
9130: slotsarr - Reference to array of unsorted slot names.
9131:
9132: slots - Reference to hash of hash, where outer hash keys are slot names.
9133:
1.1040 raeburn 9134: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9135:
1.549 albertel 9136: =back
9137:
1.780 raeburn 9138: Returns:
9139:
9140: =over 4
9141:
1.1040 raeburn 9142: sorted - An array of slot names sorted by a specified sort key
9143: (default sort key is start time of the slot).
1.780 raeburn 9144:
9145: =back
9146:
9147: =cut
9148:
9149:
9150: sub sorted_slots {
1.1040 raeburn 9151: my ($slotsarr,$slots,$sortkey) = @_;
9152: if ($sortkey eq '') {
9153: $sortkey = 'starttime';
9154: }
1.780 raeburn 9155: my @sorted;
9156: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9157: @sorted =
9158: sort {
9159: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9160: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9161: }
9162: if (ref($slots->{$a})) { return -1;}
9163: if (ref($slots->{$b})) { return 1;}
9164: return 0;
9165: } @{$slotsarr};
9166: }
9167: return @sorted;
9168: }
9169:
1.1040 raeburn 9170: =pod
9171:
9172: =item * get_future_slots()
9173:
9174: Inputs:
9175:
9176: =over 4
9177:
9178: cnum - course number
9179:
9180: cdom - course domain
9181:
9182: now - current UNIX time
9183:
9184: symb - optional symb
9185:
9186: =back
9187:
9188: Returns:
9189:
9190: =over 4
9191:
9192: sorted_reservable - ref to array of student_schedulable slots currently
9193: reservable, ordered by end date of reservation period.
9194:
9195: reservable_now - ref to hash of student_schedulable slots currently
9196: reservable.
9197:
9198: Keys in inner hash are:
9199: (a) symb: either blank or symb to which slot use is restricted.
9200: (b) endreserve: end date of reservation period.
9201:
9202: sorted_future - ref to array of student_schedulable slots reservable in
9203: the future, ordered by start date of reservation period.
9204:
9205: future_reservable - ref to hash of student_schedulable slots reservable
9206: in the future.
9207:
9208: Keys in inner hash are:
9209: (a) symb: either blank or symb to which slot use is restricted.
9210: (b) startreserve: start date of reservation period.
9211:
9212: =back
9213:
9214: =cut
9215:
9216: sub get_future_slots {
9217: my ($cnum,$cdom,$now,$symb) = @_;
9218: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9219: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9220: foreach my $slot (keys(%slots)) {
9221: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9222: if ($symb) {
9223: next if (($slots{$slot}->{'symb'} ne '') &&
9224: ($slots{$slot}->{'symb'} ne $symb));
9225: }
9226: if (($slots{$slot}->{'starttime'} > $now) &&
9227: ($slots{$slot}->{'endtime'} > $now)) {
9228: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9229: my $userallowed = 0;
9230: if ($slots{$slot}->{'allowedsections'}) {
9231: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9232: if (!defined($env{'request.role.sec'})
9233: && grep(/^No section assigned$/,@allowed_sec)) {
9234: $userallowed=1;
9235: } else {
9236: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9237: $userallowed=1;
9238: }
9239: }
9240: unless ($userallowed) {
9241: if (defined($env{'request.course.groups'})) {
9242: my @groups = split(/:/,$env{'request.course.groups'});
9243: foreach my $group (@groups) {
9244: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9245: $userallowed=1;
9246: last;
9247: }
9248: }
9249: }
9250: }
9251: }
9252: if ($slots{$slot}->{'allowedusers'}) {
9253: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9254: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9255: if (grep(/^\Q$user\E$/,@allowed_users)) {
9256: $userallowed = 1;
9257: }
9258: }
9259: next unless($userallowed);
9260: }
9261: my $startreserve = $slots{$slot}->{'startreserve'};
9262: my $endreserve = $slots{$slot}->{'endreserve'};
9263: my $symb = $slots{$slot}->{'symb'};
9264: if (($startreserve < $now) &&
9265: (!$endreserve || $endreserve > $now)) {
9266: my $lastres = $endreserve;
9267: if (!$lastres) {
9268: $lastres = $slots{$slot}->{'starttime'};
9269: }
9270: $reservable_now{$slot} = {
9271: symb => $symb,
9272: endreserve => $lastres
9273: };
9274: } elsif (($startreserve > $now) &&
9275: (!$endreserve || $endreserve > $startreserve)) {
9276: $future_reservable{$slot} = {
9277: symb => $symb,
9278: startreserve => $startreserve
9279: };
9280: }
9281: }
9282: }
9283: my @unsorted_reservable = keys(%reservable_now);
9284: if (@unsorted_reservable > 0) {
9285: @sorted_reservable =
9286: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9287: }
9288: my @unsorted_future = keys(%future_reservable);
9289: if (@unsorted_future > 0) {
9290: @sorted_future =
9291: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9292: }
9293: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9294: }
1.780 raeburn 9295:
9296: =pod
9297:
1.1057 foxr 9298: =back
9299:
1.549 albertel 9300: =head1 HTTP Helpers
9301:
9302: =over 4
9303:
1.648 raeburn 9304: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9305:
1.258 albertel 9306: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9307: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9308: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9309:
9310: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9311: $possible_names is an ref to an array of form element names. As an example:
9312: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9313: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9314:
9315: =cut
1.1 albertel 9316:
1.6 albertel 9317: sub get_unprocessed_cgi {
1.25 albertel 9318: my ($query,$possible_names)= @_;
1.26 matthew 9319: # $Apache::lonxml::debug=1;
1.356 albertel 9320: foreach my $pair (split(/&/,$query)) {
9321: my ($name, $value) = split(/=/,$pair);
1.369 www 9322: $name = &unescape($name);
1.25 albertel 9323: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9324: $value =~ tr/+/ /;
9325: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9326: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9327: }
1.16 harris41 9328: }
1.6 albertel 9329: }
9330:
1.112 bowersj2 9331: =pod
9332:
1.648 raeburn 9333: =item * &cacheheader()
1.112 bowersj2 9334:
9335: returns cache-controlling header code
9336:
9337: =cut
9338:
1.7 albertel 9339: sub cacheheader {
1.258 albertel 9340: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9341: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9342: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9343: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9344: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9345: return $output;
1.7 albertel 9346: }
9347:
1.112 bowersj2 9348: =pod
9349:
1.648 raeburn 9350: =item * &no_cache($r)
1.112 bowersj2 9351:
9352: specifies header code to not have cache
9353:
9354: =cut
9355:
1.9 albertel 9356: sub no_cache {
1.216 albertel 9357: my ($r) = @_;
9358: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9359: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9360: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9361: $r->no_cache(1);
9362: $r->header_out("Expires" => $date);
9363: $r->header_out("Pragma" => "no-cache");
1.123 www 9364: }
9365:
9366: sub content_type {
1.181 albertel 9367: my ($r,$type,$charset) = @_;
1.299 foxr 9368: if ($r) {
9369: # Note that printout.pl calls this with undef for $r.
9370: &no_cache($r);
9371: }
1.258 albertel 9372: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9373: unless ($charset) {
9374: $charset=&Apache::lonlocal::current_encoding;
9375: }
9376: if ($charset) { $type.='; charset='.$charset; }
9377: if ($r) {
9378: $r->content_type($type);
9379: } else {
9380: print("Content-type: $type\n\n");
9381: }
1.9 albertel 9382: }
1.25 albertel 9383:
1.112 bowersj2 9384: =pod
9385:
1.648 raeburn 9386: =item * &add_to_env($name,$value)
1.112 bowersj2 9387:
1.258 albertel 9388: adds $name to the %env hash with value
1.112 bowersj2 9389: $value, if $name already exists, the entry is converted to an array
9390: reference and $value is added to the array.
9391:
9392: =cut
9393:
1.25 albertel 9394: sub add_to_env {
9395: my ($name,$value)=@_;
1.258 albertel 9396: if (defined($env{$name})) {
9397: if (ref($env{$name})) {
1.25 albertel 9398: #already have multiple values
1.258 albertel 9399: push(@{ $env{$name} },$value);
1.25 albertel 9400: } else {
9401: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9402: my $first=$env{$name};
9403: undef($env{$name});
9404: push(@{ $env{$name} },$first,$value);
1.25 albertel 9405: }
9406: } else {
1.258 albertel 9407: $env{$name}=$value;
1.25 albertel 9408: }
1.31 albertel 9409: }
1.149 albertel 9410:
9411: =pod
9412:
1.648 raeburn 9413: =item * &get_env_multiple($name)
1.149 albertel 9414:
1.258 albertel 9415: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9416: values may be defined and end up as an array ref.
9417:
9418: returns an array of values
9419:
9420: =cut
9421:
9422: sub get_env_multiple {
9423: my ($name) = @_;
9424: my @values;
1.258 albertel 9425: if (defined($env{$name})) {
1.149 albertel 9426: # exists is it an array
1.258 albertel 9427: if (ref($env{$name})) {
9428: @values=@{ $env{$name} };
1.149 albertel 9429: } else {
1.258 albertel 9430: $values[0]=$env{$name};
1.149 albertel 9431: }
9432: }
9433: return(@values);
9434: }
9435:
1.660 raeburn 9436: sub ask_for_embedded_content {
9437: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9438: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 9439: %currsubfile,%unused,$rem);
1.1071 raeburn 9440: my $counter = 0;
9441: my $numnew = 0;
1.987 raeburn 9442: my $numremref = 0;
9443: my $numinvalid = 0;
9444: my $numpathchg = 0;
9445: my $numexisting = 0;
1.1071 raeburn 9446: my $numunused = 0;
9447: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9448: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9449: my $heading = &mt('Upload embedded files');
9450: my $buttontext = &mt('Upload');
9451:
1.1085 raeburn 9452: my $navmap;
9453: if ($env{'request.course.id'}) {
9454: $navmap = Apache::lonnavmaps::navmap->new();
9455: }
1.984 raeburn 9456: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9457: my $current_path='/';
9458: if ($env{'form.currentpath'}) {
9459: $current_path = $env{'form.currentpath'};
9460: }
9461: if ($actionurl eq '/adm/coursegrp_portfolio') {
9462: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9463: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9464: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9465: } else {
9466: $udom = $env{'user.domain'};
9467: $uname = $env{'user.name'};
9468: $url = '/userfiles/portfolio';
9469: }
1.987 raeburn 9470: $toplevel = $url.'/';
1.984 raeburn 9471: $url .= $current_path;
9472: $getpropath = 1;
1.987 raeburn 9473: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9474: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9475: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9476: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9477: $toplevel = $url;
1.984 raeburn 9478: if ($rest ne '') {
1.987 raeburn 9479: $url .= $rest;
9480: }
9481: } elsif ($actionurl eq '/adm/coursedocs') {
9482: if (ref($args) eq 'HASH') {
1.1071 raeburn 9483: $url = $args->{'docs_url'};
9484: $toplevel = $url;
1.1084 raeburn 9485: if ($args->{'context'} eq 'paste') {
9486: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9487: ($path) =
9488: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9489: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9490: $fileloc =~ s{^/}{};
9491: }
1.1071 raeburn 9492: }
1.1084 raeburn 9493: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 9494: if ($env{'request.course.id'} ne '') {
9495: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9496: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9497: if (ref($args) eq 'HASH') {
9498: $url = $args->{'docs_url'};
9499: $title = $args->{'docs_title'};
9500: $toplevel = "/$url";
1.1085 raeburn 9501: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1071 raeburn 9502: ($path) =
9503: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9504: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9505: $fileloc =~ s{^/}{};
9506: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9507: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9508: }
1.987 raeburn 9509: }
9510: }
9511: my $now = time();
9512: foreach my $embed_file (keys(%{$allfiles})) {
9513: my $absolutepath;
9514: if ($embed_file =~ m{^\w+://}) {
9515: $newfiles{$embed_file} = 1;
9516: $mapping{$embed_file} = $embed_file;
9517: } else {
9518: if ($embed_file =~ m{^/}) {
9519: $absolutepath = $embed_file;
9520: $embed_file =~ s{^(/+)}{};
9521: }
9522: if ($embed_file =~ m{/}) {
9523: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9524: $path = &check_for_traversal($path,$url,$toplevel);
9525: my $item = $fname;
9526: if ($path ne '') {
9527: $item = $path.'/'.$fname;
9528: $subdependencies{$path}{$fname} = 1;
9529: } else {
9530: $dependencies{$item} = 1;
9531: }
9532: if ($absolutepath) {
9533: $mapping{$item} = $absolutepath;
9534: } else {
9535: $mapping{$item} = $embed_file;
9536: }
9537: } else {
9538: $dependencies{$embed_file} = 1;
9539: if ($absolutepath) {
9540: $mapping{$embed_file} = $absolutepath;
9541: } else {
9542: $mapping{$embed_file} = $embed_file;
9543: }
9544: }
1.984 raeburn 9545: }
9546: }
1.1071 raeburn 9547: my $dirptr = 16384;
1.984 raeburn 9548: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9549: $currsubfile{$path} = {};
1.984 raeburn 9550: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9551: my ($sublistref,$listerror) =
9552: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9553: if (ref($sublistref) eq 'ARRAY') {
9554: foreach my $line (@{$sublistref}) {
9555: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9556: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9557: }
1.984 raeburn 9558: }
1.987 raeburn 9559: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9560: if (opendir(my $dir,$url.'/'.$path)) {
9561: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9562: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9563: }
1.1084 raeburn 9564: } elsif (($actionurl eq '/adm/dependencies') ||
9565: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9566: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9567: if ($env{'request.course.id'} ne '') {
9568: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9569: if ($dir ne '') {
9570: my ($sublistref,$listerror) =
9571: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9572: if (ref($sublistref) eq 'ARRAY') {
9573: foreach my $line (@{$sublistref}) {
9574: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9575: undef,$mtime)=split(/\&/,$line,12);
9576: unless (($testdir&$dirptr) ||
9577: ($file_name =~ /^\.\.?$/)) {
9578: $currsubfile{$path}{$file_name} = [$size,$mtime];
9579: }
9580: }
9581: }
9582: }
1.984 raeburn 9583: }
9584: }
9585: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9586: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9587: my $item = $path.'/'.$file;
9588: unless ($mapping{$item} eq $item) {
9589: $pathchanges{$item} = 1;
9590: }
9591: $existing{$item} = 1;
9592: $numexisting ++;
9593: } else {
9594: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9595: }
9596: }
1.1071 raeburn 9597: if ($actionurl eq '/adm/dependencies') {
9598: foreach my $path (keys(%currsubfile)) {
9599: if (ref($currsubfile{$path}) eq 'HASH') {
9600: foreach my $file (keys(%{$currsubfile{$path}})) {
9601: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 9602: next if (($rem ne '') &&
9603: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9604: (ref($navmap) &&
9605: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9606: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9607: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9608: $unused{$path.'/'.$file} = 1;
9609: }
9610: }
9611: }
9612: }
9613: }
1.984 raeburn 9614: }
1.987 raeburn 9615: my %currfile;
1.984 raeburn 9616: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9617: my ($dirlistref,$listerror) =
9618: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9619: if (ref($dirlistref) eq 'ARRAY') {
9620: foreach my $line (@{$dirlistref}) {
9621: my ($file_name,$rest) = split(/\&/,$line,2);
9622: $currfile{$file_name} = 1;
9623: }
1.984 raeburn 9624: }
1.987 raeburn 9625: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9626: if (opendir(my $dir,$url)) {
1.987 raeburn 9627: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9628: map {$currfile{$_} = 1;} @dir_list;
9629: }
1.1084 raeburn 9630: } elsif (($actionurl eq '/adm/dependencies') ||
9631: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9632: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9633: if ($env{'request.course.id'} ne '') {
9634: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9635: if ($dir ne '') {
9636: my ($dirlistref,$listerror) =
9637: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9638: if (ref($dirlistref) eq 'ARRAY') {
9639: foreach my $line (@{$dirlistref}) {
9640: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9641: $size,undef,$mtime)=split(/\&/,$line,12);
9642: unless (($testdir&$dirptr) ||
9643: ($file_name =~ /^\.\.?$/)) {
9644: $currfile{$file_name} = [$size,$mtime];
9645: }
9646: }
9647: }
9648: }
9649: }
1.984 raeburn 9650: }
9651: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9652: if (exists($currfile{$file})) {
1.987 raeburn 9653: unless ($mapping{$file} eq $file) {
9654: $pathchanges{$file} = 1;
9655: }
9656: $existing{$file} = 1;
9657: $numexisting ++;
9658: } else {
1.984 raeburn 9659: $newfiles{$file} = 1;
9660: }
9661: }
1.1071 raeburn 9662: foreach my $file (keys(%currfile)) {
9663: unless (($file eq $filename) ||
9664: ($file eq $filename.'.bak') ||
9665: ($dependencies{$file})) {
1.1085 raeburn 9666: if ($actionurl eq '/adm/dependencies') {
9667: next if (($rem ne '') &&
9668: (($env{"httpref.$rem".$file} ne '') ||
9669: (ref($navmap) &&
9670: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9671: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9672: ($navmap->getResourceByUrl($rem.$1)))))));
9673: }
1.1071 raeburn 9674: $unused{$file} = 1;
9675: }
9676: }
1.1084 raeburn 9677: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9678: ($args->{'context'} eq 'paste')) {
9679: $counter = scalar(keys(%existing));
9680: $numpathchg = scalar(keys(%pathchanges));
9681: return ($output,$counter,$numpathchg,\%existing);
9682: }
1.984 raeburn 9683: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9684: if ($actionurl eq '/adm/dependencies') {
9685: next if ($embed_file =~ m{^\w+://});
9686: }
1.660 raeburn 9687: $upload_output .= &start_data_table_row().
1.1071 raeburn 9688: '<td><img src="'.&icon($embed_file).'" /> '.
9689: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9690: unless ($mapping{$embed_file} eq $embed_file) {
9691: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9692: }
9693: $upload_output .= '</td><td>';
1.1071 raeburn 9694: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9695: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9696: $numremref++;
1.660 raeburn 9697: } elsif ($args->{'error_on_invalid_names'}
9698: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.987 raeburn 9699: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9700: $numinvalid++;
1.660 raeburn 9701: } else {
1.1071 raeburn 9702: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9703: $embed_file,\%mapping,
1.1071 raeburn 9704: $allfiles,$codebase,'upload');
9705: $counter ++;
9706: $numnew ++;
1.987 raeburn 9707: }
9708: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9709: }
9710: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9711: if ($actionurl eq '/adm/dependencies') {
9712: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9713: $modify_output .= &start_data_table_row().
9714: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9715: '<img src="'.&icon($embed_file).'" border="0" />'.
9716: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9717: '<td>'.$size.'</td>'.
9718: '<td>'.$mtime.'</td>'.
9719: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9720: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9721: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9722: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9723: &embedded_file_element('upload_embedded',$counter,
9724: $embed_file,\%mapping,
9725: $allfiles,$codebase,'modify').
9726: '</div></td>'.
9727: &end_data_table_row()."\n";
9728: $counter ++;
9729: } else {
9730: $upload_output .= &start_data_table_row().
9731: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9732: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9733: &Apache::loncommon::end_data_table_row()."\n";
9734: }
9735: }
9736: my $delidx = $counter;
9737: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9738: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9739: $delete_output .= &start_data_table_row().
9740: '<td><img src="'.&icon($oldfile).'" />'.
9741: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9742: '<td>'.$size.'</td>'.
9743: '<td>'.$mtime.'</td>'.
9744: '<td><label><input type="checkbox" name="del_upload_dep" '.
9745: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9746: &embedded_file_element('upload_embedded',$delidx,
9747: $oldfile,\%mapping,$allfiles,
9748: $codebase,'delete').'</td>'.
9749: &end_data_table_row()."\n";
9750: $numunused ++;
9751: $delidx ++;
1.987 raeburn 9752: }
9753: if ($upload_output) {
9754: $upload_output = &start_data_table().
9755: $upload_output.
9756: &end_data_table()."\n";
9757: }
1.1071 raeburn 9758: if ($modify_output) {
9759: $modify_output = &start_data_table().
9760: &start_data_table_header_row().
9761: '<th>'.&mt('File').'</th>'.
9762: '<th>'.&mt('Size (KB)').'</th>'.
9763: '<th>'.&mt('Modified').'</th>'.
9764: '<th>'.&mt('Upload replacement?').'</th>'.
9765: &end_data_table_header_row().
9766: $modify_output.
9767: &end_data_table()."\n";
9768: }
9769: if ($delete_output) {
9770: $delete_output = &start_data_table().
9771: &start_data_table_header_row().
9772: '<th>'.&mt('File').'</th>'.
9773: '<th>'.&mt('Size (KB)').'</th>'.
9774: '<th>'.&mt('Modified').'</th>'.
9775: '<th>'.&mt('Delete?').'</th>'.
9776: &end_data_table_header_row().
9777: $delete_output.
9778: &end_data_table()."\n";
9779: }
1.987 raeburn 9780: my $applies = 0;
9781: if ($numremref) {
9782: $applies ++;
9783: }
9784: if ($numinvalid) {
9785: $applies ++;
9786: }
9787: if ($numexisting) {
9788: $applies ++;
9789: }
1.1071 raeburn 9790: if ($counter || $numunused) {
1.987 raeburn 9791: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9792: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9793: $state.'<h3>'.$heading.'</h3>';
9794: if ($actionurl eq '/adm/dependencies') {
9795: if ($numnew) {
9796: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9797: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9798: $upload_output.'<br />'."\n";
9799: }
9800: if ($numexisting) {
9801: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9802: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9803: $modify_output.'<br />'."\n";
9804: $buttontext = &mt('Save changes');
9805: }
9806: if ($numunused) {
9807: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9808: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9809: $delete_output.'<br />'."\n";
9810: $buttontext = &mt('Save changes');
9811: }
9812: } else {
9813: $output .= $upload_output.'<br />'."\n";
9814: }
9815: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9816: $counter.'" />'."\n";
9817: if ($actionurl eq '/adm/dependencies') {
9818: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9819: $numnew.'" />'."\n";
9820: } elsif ($actionurl eq '') {
1.987 raeburn 9821: $output .= '<input type="hidden" name="phase" value="three" />';
9822: }
9823: } elsif ($applies) {
9824: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9825: if ($applies > 1) {
9826: $output .=
9827: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9828: if ($numremref) {
9829: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9830: }
9831: if ($numinvalid) {
9832: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9833: }
9834: if ($numexisting) {
9835: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9836: }
9837: $output .= '</ul><br />';
9838: } elsif ($numremref) {
9839: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9840: } elsif ($numinvalid) {
9841: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9842: } elsif ($numexisting) {
9843: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9844: }
9845: $output .= $upload_output.'<br />';
9846: }
9847: my ($pathchange_output,$chgcount);
1.1071 raeburn 9848: $chgcount = $counter;
1.987 raeburn 9849: if (keys(%pathchanges) > 0) {
9850: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9851: if ($counter) {
1.987 raeburn 9852: $output .= &embedded_file_element('pathchange',$chgcount,
9853: $embed_file,\%mapping,
1.1071 raeburn 9854: $allfiles,$codebase,'change');
1.987 raeburn 9855: } else {
9856: $pathchange_output .=
9857: &start_data_table_row().
9858: '<td><input type ="checkbox" name="namechange" value="'.
9859: $chgcount.'" checked="checked" /></td>'.
9860: '<td>'.$mapping{$embed_file}.'</td>'.
9861: '<td>'.$embed_file.
9862: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9863: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9864: '</td>'.&end_data_table_row();
1.660 raeburn 9865: }
1.987 raeburn 9866: $numpathchg ++;
9867: $chgcount ++;
1.660 raeburn 9868: }
9869: }
1.1071 raeburn 9870: if ($counter) {
1.987 raeburn 9871: if ($numpathchg) {
9872: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9873: $numpathchg.'" />'."\n";
9874: }
9875: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9876: ($actionurl eq '/adm/imsimport')) {
9877: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9878: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9879: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9880: } elsif ($actionurl eq '/adm/dependencies') {
9881: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9882: }
1.1071 raeburn 9883: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9884: } elsif ($numpathchg) {
9885: my %pathchange = ();
9886: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9887: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9888: $output .= '<p>'.&mt('or').'</p>';
9889: }
9890: }
1.1071 raeburn 9891: return ($output,$counter,$numpathchg);
1.987 raeburn 9892: }
9893:
9894: sub embedded_file_element {
1.1071 raeburn 9895: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9896: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9897: (ref($codebase) eq 'HASH'));
9898: my $output;
1.1071 raeburn 9899: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9900: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9901: }
9902: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9903: &escape($embed_file).'" />';
9904: unless (($context eq 'upload_embedded') &&
9905: ($mapping->{$embed_file} eq $embed_file)) {
9906: $output .='
9907: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9908: }
9909: my $attrib;
9910: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9911: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9912: }
9913: $output .=
9914: "\n\t\t".
9915: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9916: $attrib.'" />';
9917: if (exists($codebase->{$mapping->{$embed_file}})) {
9918: $output .=
9919: "\n\t\t".
9920: '<input name="codebase_'.$num.'" type="hidden" value="'.
9921: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9922: }
1.987 raeburn 9923: return $output;
1.660 raeburn 9924: }
9925:
1.1071 raeburn 9926: sub get_dependency_details {
9927: my ($currfile,$currsubfile,$embed_file) = @_;
9928: my ($size,$mtime,$showsize,$showmtime);
9929: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9930: if ($embed_file =~ m{/}) {
9931: my ($path,$fname) = split(/\//,$embed_file);
9932: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9933: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9934: }
9935: } else {
9936: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9937: ($size,$mtime) = @{$currfile->{$embed_file}};
9938: }
9939: }
9940: $showsize = $size/1024.0;
9941: $showsize = sprintf("%.1f",$showsize);
9942: if ($mtime > 0) {
9943: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9944: }
9945: }
9946: return ($showsize,$showmtime);
9947: }
9948:
9949: sub ask_embedded_js {
9950: return <<"END";
9951: <script type="text/javascript"">
9952: // <![CDATA[
9953: function toggleBrowse(counter) {
9954: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9955: var fileid = document.getElementById('embedded_item_'+counter);
9956: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9957: if (chkboxid.checked == true) {
9958: uploaddivid.style.display='block';
9959: } else {
9960: uploaddivid.style.display='none';
9961: fileid.value = '';
9962: }
9963: }
9964: // ]]>
9965: </script>
9966:
9967: END
9968: }
9969:
1.661 raeburn 9970: sub upload_embedded {
9971: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9972: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9973: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9974: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9975: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9976: my $orig_uploaded_filename =
9977: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9978: foreach my $type ('orig','ref','attrib','codebase') {
9979: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9980: $env{'form.embedded_'.$type.'_'.$i} =
9981: &unescape($env{'form.embedded_'.$type.'_'.$i});
9982: }
9983: }
1.661 raeburn 9984: my ($path,$fname) =
9985: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9986: # no path, whole string is fname
9987: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9988: $fname = &Apache::lonnet::clean_filename($fname);
9989: # See if there is anything left
9990: next if ($fname eq '');
9991:
9992: # Check if file already exists as a file or directory.
9993: my ($state,$msg);
9994: if ($context eq 'portfolio') {
9995: my $port_path = $dirpath;
9996: if ($group ne '') {
9997: $port_path = "groups/$group/$port_path";
9998: }
1.987 raeburn 9999: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
10000: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 10001: $dir_root,$port_path,$disk_quota,
10002: $current_disk_usage,$uname,$udom);
10003: if ($state eq 'will_exceed_quota'
1.984 raeburn 10004: || $state eq 'file_locked') {
1.661 raeburn 10005: $output .= $msg;
10006: next;
10007: }
10008: } elsif (($context eq 'author') || ($context eq 'testbank')) {
10009: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
10010: if ($state eq 'exists') {
10011: $output .= $msg;
10012: next;
10013: }
10014: }
10015: # Check if extension is valid
10016: if (($fname =~ /\.(\w+)$/) &&
10017: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10018: $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 10019: next;
10020: } elsif (($fname =~ /\.(\w+)$/) &&
10021: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10022: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10023: next;
10024: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 10025: $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 10026: next;
10027: }
10028: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
10029: if ($context eq 'portfolio') {
1.984 raeburn 10030: my $result;
10031: if ($state eq 'existingfile') {
10032: $result=
10033: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 10034: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 10035: } else {
1.984 raeburn 10036: $result=
10037: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10038: $dirpath.
10039: $env{'form.currentpath'}.$path);
1.984 raeburn 10040: if ($result !~ m|^/uploaded/|) {
10041: $output .= '<span class="LC_error">'
10042: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10043: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10044: .'</span><br />';
10045: next;
10046: } else {
1.987 raeburn 10047: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10048: $path.$fname.'</span>').'<br />';
1.984 raeburn 10049: }
1.661 raeburn 10050: }
1.987 raeburn 10051: } elsif ($context eq 'coursedoc') {
10052: my $result =
10053: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
10054: $dirpath.'/'.$path);
10055: if ($result !~ m|^/uploaded/|) {
10056: $output .= '<span class="LC_error">'
10057: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10058: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10059: .'</span><br />';
10060: next;
10061: } else {
10062: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10063: $path.$fname.'</span>').'<br />';
10064: }
1.661 raeburn 10065: } else {
10066: # Save the file
10067: my $target = $env{'form.embedded_item_'.$i};
10068: my $fullpath = $dir_root.$dirpath.'/'.$path;
10069: my $dest = $fullpath.$fname;
10070: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10071: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10072: my $count;
10073: my $filepath = $dir_root;
1.1027 raeburn 10074: foreach my $subdir (@parts) {
10075: $filepath .= "/$subdir";
10076: if (!-e $filepath) {
1.661 raeburn 10077: mkdir($filepath,0770);
10078: }
10079: }
10080: my $fh;
10081: if (!open($fh,'>'.$dest)) {
10082: &Apache::lonnet::logthis('Failed to create '.$dest);
10083: $output .= '<span class="LC_error">'.
1.1071 raeburn 10084: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10085: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10086: '</span><br />';
10087: } else {
10088: if (!print $fh $env{'form.embedded_item_'.$i}) {
10089: &Apache::lonnet::logthis('Failed to write to '.$dest);
10090: $output .= '<span class="LC_error">'.
1.1071 raeburn 10091: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10092: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10093: '</span><br />';
10094: } else {
1.987 raeburn 10095: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10096: $url.'</span>').'<br />';
10097: unless ($context eq 'testbank') {
10098: $footer .= &mt('View embedded file: [_1]',
10099: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10100: }
10101: }
10102: close($fh);
10103: }
10104: }
10105: if ($env{'form.embedded_ref_'.$i}) {
10106: $pathchange{$i} = 1;
10107: }
10108: }
10109: if ($output) {
10110: $output = '<p>'.$output.'</p>';
10111: }
10112: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10113: $returnflag = 'ok';
1.1071 raeburn 10114: my $numpathchgs = scalar(keys(%pathchange));
10115: if ($numpathchgs > 0) {
1.987 raeburn 10116: if ($context eq 'portfolio') {
10117: $output .= '<p>'.&mt('or').'</p>';
10118: } elsif ($context eq 'testbank') {
1.1071 raeburn 10119: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10120: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10121: $returnflag = 'modify_orightml';
10122: }
10123: }
1.1071 raeburn 10124: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10125: }
10126:
10127: sub modify_html_form {
10128: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10129: my $end = 0;
10130: my $modifyform;
10131: if ($context eq 'upload_embedded') {
10132: return unless (ref($pathchange) eq 'HASH');
10133: if ($env{'form.number_embedded_items'}) {
10134: $end += $env{'form.number_embedded_items'};
10135: }
10136: if ($env{'form.number_pathchange_items'}) {
10137: $end += $env{'form.number_pathchange_items'};
10138: }
10139: if ($end) {
10140: for (my $i=0; $i<$end; $i++) {
10141: if ($i < $env{'form.number_embedded_items'}) {
10142: next unless($pathchange->{$i});
10143: }
10144: $modifyform .=
10145: &start_data_table_row().
10146: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10147: 'checked="checked" /></td>'.
10148: '<td>'.$env{'form.embedded_ref_'.$i}.
10149: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10150: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10151: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10152: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10153: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10154: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10155: '<td>'.$env{'form.embedded_orig_'.$i}.
10156: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10157: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10158: &end_data_table_row();
1.1071 raeburn 10159: }
1.987 raeburn 10160: }
10161: } else {
10162: $modifyform = $pathchgtable;
10163: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10164: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10165: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10166: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10167: }
10168: }
10169: if ($modifyform) {
1.1071 raeburn 10170: if ($actionurl eq '/adm/dependencies') {
10171: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10172: }
1.987 raeburn 10173: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10174: '<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".
10175: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10176: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10177: '</ol></p>'."\n".'<p>'.
10178: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10179: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10180: &start_data_table()."\n".
10181: &start_data_table_header_row().
10182: '<th>'.&mt('Change?').'</th>'.
10183: '<th>'.&mt('Current reference').'</th>'.
10184: '<th>'.&mt('Required reference').'</th>'.
10185: &end_data_table_header_row()."\n".
10186: $modifyform.
10187: &end_data_table().'<br />'."\n".$hiddenstate.
10188: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10189: '</form>'."\n";
10190: }
10191: return;
10192: }
10193:
10194: sub modify_html_refs {
10195: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10196: my $container;
10197: if ($context eq 'portfolio') {
10198: $container = $env{'form.container'};
10199: } elsif ($context eq 'coursedoc') {
10200: $container = $env{'form.primaryurl'};
1.1071 raeburn 10201: } elsif ($context eq 'manage_dependencies') {
10202: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10203: $container = "/$container";
1.987 raeburn 10204: } else {
1.1027 raeburn 10205: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10206: }
10207: my (%allfiles,%codebase,$output,$content);
10208: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10209: unless (@changes > 0) {
10210: if (wantarray) {
10211: return ('',0,0);
10212: } else {
10213: return;
10214: }
10215: }
10216: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10217: ($context eq 'manage_dependencies')) {
10218: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10219: if (wantarray) {
10220: return ('',0,0);
10221: } else {
10222: return;
10223: }
10224: }
1.987 raeburn 10225: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10226: if ($content eq '-1') {
10227: if (wantarray) {
10228: return ('',0,0);
10229: } else {
10230: return;
10231: }
10232: }
1.987 raeburn 10233: } else {
1.1071 raeburn 10234: unless ($container =~ /^\Q$dir_root\E/) {
10235: if (wantarray) {
10236: return ('',0,0);
10237: } else {
10238: return;
10239: }
10240: }
1.987 raeburn 10241: if (open(my $fh,"<$container")) {
10242: $content = join('', <$fh>);
10243: close($fh);
10244: } else {
1.1071 raeburn 10245: if (wantarray) {
10246: return ('',0,0);
10247: } else {
10248: return;
10249: }
1.987 raeburn 10250: }
10251: }
10252: my ($count,$codebasecount) = (0,0);
10253: my $mm = new File::MMagic;
10254: my $mime_type = $mm->checktype_contents($content);
10255: if ($mime_type eq 'text/html') {
10256: my $parse_result =
10257: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10258: \%codebase,\$content);
10259: if ($parse_result eq 'ok') {
10260: foreach my $i (@changes) {
10261: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10262: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10263: if ($allfiles{$ref}) {
10264: my $newname = $orig;
10265: my ($attrib_regexp,$codebase);
1.1006 raeburn 10266: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10267: if ($attrib_regexp =~ /:/) {
10268: $attrib_regexp =~ s/\:/|/g;
10269: }
10270: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10271: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10272: $count += $numchg;
10273: }
10274: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10275: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10276: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10277: $codebasecount ++;
10278: }
10279: }
10280: }
10281: if ($count || $codebasecount) {
10282: my $saveresult;
1.1071 raeburn 10283: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10284: ($context eq 'manage_dependencies')) {
1.987 raeburn 10285: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10286: if ($url eq $container) {
10287: my ($fname) = ($container =~ m{/([^/]+)$});
10288: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10289: $count,'<span class="LC_filename">'.
1.1071 raeburn 10290: $fname.'</span>').'</p>';
1.987 raeburn 10291: } else {
10292: $output = '<p class="LC_error">'.
10293: &mt('Error: update failed for: [_1].',
10294: '<span class="LC_filename">'.
10295: $container.'</span>').'</p>';
10296: }
10297: } else {
10298: if (open(my $fh,">$container")) {
10299: print $fh $content;
10300: close($fh);
10301: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10302: $count,'<span class="LC_filename">'.
10303: $container.'</span>').'</p>';
1.661 raeburn 10304: } else {
1.987 raeburn 10305: $output = '<p class="LC_error">'.
10306: &mt('Error: could not update [_1].',
10307: '<span class="LC_filename">'.
10308: $container.'</span>').'</p>';
1.661 raeburn 10309: }
10310: }
10311: }
1.987 raeburn 10312: } else {
10313: &logthis('Failed to parse '.$container.
10314: ' to modify references: '.$parse_result);
1.661 raeburn 10315: }
10316: }
1.1071 raeburn 10317: if (wantarray) {
10318: return ($output,$count,$codebasecount);
10319: } else {
10320: return $output;
10321: }
1.661 raeburn 10322: }
10323:
10324: sub check_for_existing {
10325: my ($path,$fname,$element) = @_;
10326: my ($state,$msg);
10327: if (-d $path.'/'.$fname) {
10328: $state = 'exists';
10329: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10330: } elsif (-e $path.'/'.$fname) {
10331: $state = 'exists';
10332: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10333: }
10334: if ($state eq 'exists') {
10335: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10336: }
10337: return ($state,$msg);
10338: }
10339:
10340: sub check_for_upload {
10341: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10342: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10343: my $filesize = length($env{'form.'.$element});
10344: if (!$filesize) {
10345: my $msg = '<span class="LC_error">'.
10346: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10347: '<span class="LC_filename">'.$fname.'</span>',
10348: $filesize).'<br />'.
1.1007 raeburn 10349: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10350: '</span>';
10351: return ('zero_bytes',$msg);
10352: }
10353: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10354: my $getpropath = 1;
1.1021 raeburn 10355: my ($dirlistref,$listerror) =
10356: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10357: my $found_file = 0;
10358: my $locked_file = 0;
1.991 raeburn 10359: my @lockers;
10360: my $navmap;
10361: if ($env{'request.course.id'}) {
10362: $navmap = Apache::lonnavmaps::navmap->new();
10363: }
1.1021 raeburn 10364: if (ref($dirlistref) eq 'ARRAY') {
10365: foreach my $line (@{$dirlistref}) {
10366: my ($file_name,$rest)=split(/\&/,$line,2);
10367: if ($file_name eq $fname){
10368: $file_name = $path.$file_name;
10369: if ($group ne '') {
10370: $file_name = $group.$file_name;
10371: }
10372: $found_file = 1;
10373: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10374: foreach my $lock (@lockers) {
10375: if (ref($lock) eq 'ARRAY') {
10376: my ($symb,$crsid) = @{$lock};
10377: if ($crsid eq $env{'request.course.id'}) {
10378: if (ref($navmap)) {
10379: my $res = $navmap->getBySymb($symb);
10380: foreach my $part (@{$res->parts()}) {
10381: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10382: unless (($slot_status == $res->RESERVED) ||
10383: ($slot_status == $res->RESERVED_LOCATION)) {
10384: $locked_file = 1;
10385: }
1.991 raeburn 10386: }
1.1021 raeburn 10387: } else {
10388: $locked_file = 1;
1.991 raeburn 10389: }
10390: } else {
10391: $locked_file = 1;
10392: }
10393: }
1.1021 raeburn 10394: }
10395: } else {
10396: my @info = split(/\&/,$rest);
10397: my $currsize = $info[6]/1000;
10398: if ($currsize < $filesize) {
10399: my $extra = $filesize - $currsize;
10400: if (($current_disk_usage + $extra) > $disk_quota) {
10401: my $msg = '<span class="LC_error">'.
10402: &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.',
10403: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10404: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10405: $disk_quota,$current_disk_usage);
10406: return ('will_exceed_quota',$msg);
10407: }
1.984 raeburn 10408: }
10409: }
1.661 raeburn 10410: }
10411: }
10412: }
10413: if (($current_disk_usage + $filesize) > $disk_quota){
10414: my $msg = '<span class="LC_error">'.
10415: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10416: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10417: return ('will_exceed_quota',$msg);
10418: } elsif ($found_file) {
10419: if ($locked_file) {
10420: my $msg = '<span class="LC_error">';
10421: $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>');
10422: $msg .= '</span><br />';
10423: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10424: return ('file_locked',$msg);
10425: } else {
10426: my $msg = '<span class="LC_error">';
1.984 raeburn 10427: $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 10428: $msg .= '</span>';
1.984 raeburn 10429: return ('existingfile',$msg);
1.661 raeburn 10430: }
10431: }
10432: }
10433:
1.987 raeburn 10434: sub check_for_traversal {
10435: my ($path,$url,$toplevel) = @_;
10436: my @parts=split(/\//,$path);
10437: my $cleanpath;
10438: my $fullpath = $url;
10439: for (my $i=0;$i<@parts;$i++) {
10440: next if ($parts[$i] eq '.');
10441: if ($parts[$i] eq '..') {
10442: $fullpath =~ s{([^/]+/)$}{};
10443: } else {
10444: $fullpath .= $parts[$i].'/';
10445: }
10446: }
10447: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10448: $cleanpath = $1;
10449: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10450: my $curr_toprel = $1;
10451: my @parts = split(/\//,$curr_toprel);
10452: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10453: my @urlparts = split(/\//,$url_toprel);
10454: my $doubledots;
10455: my $startdiff = -1;
10456: for (my $i=0; $i<@urlparts; $i++) {
10457: if ($startdiff == -1) {
10458: unless ($urlparts[$i] eq $parts[$i]) {
10459: $startdiff = $i;
10460: $doubledots .= '../';
10461: }
10462: } else {
10463: $doubledots .= '../';
10464: }
10465: }
10466: if ($startdiff > -1) {
10467: $cleanpath = $doubledots;
10468: for (my $i=$startdiff; $i<@parts; $i++) {
10469: $cleanpath .= $parts[$i].'/';
10470: }
10471: }
10472: }
10473: $cleanpath =~ s{(/)$}{};
10474: return $cleanpath;
10475: }
1.31 albertel 10476:
1.1053 raeburn 10477: sub is_archive_file {
10478: my ($mimetype) = @_;
10479: if (($mimetype eq 'application/octet-stream') ||
10480: ($mimetype eq 'application/x-stuffit') ||
10481: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10482: return 1;
10483: }
10484: return;
10485: }
10486:
10487: sub decompress_form {
1.1065 raeburn 10488: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10489: my %lt = &Apache::lonlocal::texthash (
10490: this => 'This file is an archive file.',
1.1067 raeburn 10491: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10492: itsc => 'Its contents are as follows:',
1.1053 raeburn 10493: youm => 'You may wish to extract its contents.',
10494: extr => 'Extract contents',
1.1067 raeburn 10495: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10496: proa => 'Process automatically?',
1.1053 raeburn 10497: yes => 'Yes',
10498: no => 'No',
1.1067 raeburn 10499: fold => 'Title for folder containing movie',
10500: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10501: );
1.1065 raeburn 10502: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10503: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10504: my $info = &list_archive_contents($fileloc,\@paths);
10505: if (@paths) {
10506: foreach my $path (@paths) {
10507: $path =~ s{^/}{};
1.1067 raeburn 10508: if ($path =~ m{^([^/]+)/$}) {
10509: $topdir = $1;
10510: }
1.1065 raeburn 10511: if ($path =~ m{^([^/]+)/}) {
10512: $toplevel{$1} = $path;
10513: } else {
10514: $toplevel{$path} = $path;
10515: }
10516: }
10517: }
1.1067 raeburn 10518: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10519: my @camtasia = ("$topdir/","$topdir/index.html",
10520: "$topdir/media/",
10521: "$topdir/media/$topdir.mp4",
10522: "$topdir/media/FirstFrame.png",
10523: "$topdir/media/player.swf",
10524: "$topdir/media/swfobject.js",
10525: "$topdir/media/expressInstall.swf");
10526: my @diffs = &compare_arrays(\@paths,\@camtasia);
10527: if (@diffs == 0) {
10528: $is_camtasia = 1;
10529: }
10530: }
10531: my $output;
10532: if ($is_camtasia) {
10533: $output = <<"ENDCAM";
10534: <script type="text/javascript" language="Javascript">
10535: // <![CDATA[
10536:
10537: function camtasiaToggle() {
10538: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10539: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10540: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10541:
10542: document.getElementById('camtasia_titles').style.display='block';
10543: } else {
10544: document.getElementById('camtasia_titles').style.display='none';
10545: }
10546: }
10547: }
10548: return;
10549: }
10550:
10551: // ]]>
10552: </script>
10553: <p>$lt{'camt'}</p>
10554: ENDCAM
1.1065 raeburn 10555: } else {
1.1067 raeburn 10556: $output = '<p>'.$lt{'this'};
10557: if ($info eq '') {
10558: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10559: } else {
10560: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10561: '<div><pre>'.$info.'</pre></div>';
10562: }
1.1065 raeburn 10563: }
1.1067 raeburn 10564: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10565: my $duplicates;
10566: my $num = 0;
10567: if (ref($dirlist) eq 'ARRAY') {
10568: foreach my $item (@{$dirlist}) {
10569: if (ref($item) eq 'ARRAY') {
10570: if (exists($toplevel{$item->[0]})) {
10571: $duplicates .=
10572: &start_data_table_row().
10573: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10574: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10575: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10576: 'value="1" />'.&mt('Yes').'</label>'.
10577: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10578: '<td>'.$item->[0].'</td>';
10579: if ($item->[2]) {
10580: $duplicates .= '<td>'.&mt('Directory').'</td>';
10581: } else {
10582: $duplicates .= '<td>'.&mt('File').'</td>';
10583: }
10584: $duplicates .= '<td>'.$item->[3].'</td>'.
10585: '<td>'.
10586: &Apache::lonlocal::locallocaltime($item->[4]).
10587: '</td>'.
10588: &end_data_table_row();
10589: $num ++;
10590: }
10591: }
10592: }
10593: }
10594: my $itemcount;
10595: if (@paths > 0) {
10596: $itemcount = scalar(@paths);
10597: } else {
10598: $itemcount = 1;
10599: }
1.1067 raeburn 10600: if ($is_camtasia) {
10601: $output .= $lt{'auto'}.'<br />'.
10602: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10603: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10604: $lt{'yes'}.'</label> <label>'.
10605: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10606: $lt{'no'}.'</label></span><br />'.
10607: '<div id="camtasia_titles" style="display:block">'.
10608: &Apache::lonhtmlcommon::start_pick_box().
10609: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10610: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10611: &Apache::lonhtmlcommon::row_closure().
10612: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10613: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10614: &Apache::lonhtmlcommon::row_closure(1).
10615: &Apache::lonhtmlcommon::end_pick_box().
10616: '</div>';
10617: }
1.1065 raeburn 10618: $output .=
10619: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10620: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10621: "\n";
1.1065 raeburn 10622: if ($duplicates ne '') {
10623: $output .= '<p><span class="LC_warning">'.
10624: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10625: &start_data_table().
10626: &start_data_table_header_row().
10627: '<th>'.&mt('Overwrite?').'</th>'.
10628: '<th>'.&mt('Name').'</th>'.
10629: '<th>'.&mt('Type').'</th>'.
10630: '<th>'.&mt('Size').'</th>'.
10631: '<th>'.&mt('Last modified').'</th>'.
10632: &end_data_table_header_row().
10633: $duplicates.
10634: &end_data_table().
10635: '</p>';
10636: }
1.1067 raeburn 10637: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10638: if (ref($hiddenelements) eq 'HASH') {
10639: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10640: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10641: }
10642: }
10643: $output .= <<"END";
1.1067 raeburn 10644: <br />
1.1053 raeburn 10645: <input type="submit" name="decompress" value="$lt{'extr'}" />
10646: </form>
10647: $noextract
10648: END
10649: return $output;
10650: }
10651:
1.1065 raeburn 10652: sub decompression_utility {
10653: my ($program) = @_;
10654: my @utilities = ('tar','gunzip','bunzip2','unzip');
10655: my $location;
10656: if (grep(/^\Q$program\E$/,@utilities)) {
10657: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10658: '/usr/sbin/') {
10659: if (-x $dir.$program) {
10660: $location = $dir.$program;
10661: last;
10662: }
10663: }
10664: }
10665: return $location;
10666: }
10667:
10668: sub list_archive_contents {
10669: my ($file,$pathsref) = @_;
10670: my (@cmd,$output);
10671: my $needsregexp;
10672: if ($file =~ /\.zip$/) {
10673: @cmd = (&decompression_utility('unzip'),"-l");
10674: $needsregexp = 1;
10675: } elsif (($file =~ m/\.tar\.gz$/) ||
10676: ($file =~ /\.tgz$/)) {
10677: @cmd = (&decompression_utility('tar'),"-ztf");
10678: } elsif ($file =~ /\.tar\.bz2$/) {
10679: @cmd = (&decompression_utility('tar'),"-jtf");
10680: } elsif ($file =~ m|\.tar$|) {
10681: @cmd = (&decompression_utility('tar'),"-tf");
10682: }
10683: if (@cmd) {
10684: undef($!);
10685: undef($@);
10686: if (open(my $fh,"-|", @cmd, $file)) {
10687: while (my $line = <$fh>) {
10688: $output .= $line;
10689: chomp($line);
10690: my $item;
10691: if ($needsregexp) {
10692: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10693: } else {
10694: $item = $line;
10695: }
10696: if ($item ne '') {
10697: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10698: push(@{$pathsref},$item);
10699: }
10700: }
10701: }
10702: close($fh);
10703: }
10704: }
10705: return $output;
10706: }
10707:
1.1053 raeburn 10708: sub decompress_uploaded_file {
10709: my ($file,$dir) = @_;
10710: &Apache::lonnet::appenv({'cgi.file' => $file});
10711: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10712: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10713: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10714: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10715: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10716: my $decompressed = $env{'cgi.decompressed'};
10717: &Apache::lonnet::delenv('cgi.file');
10718: &Apache::lonnet::delenv('cgi.dir');
10719: &Apache::lonnet::delenv('cgi.decompressed');
10720: return ($decompressed,$result);
10721: }
10722:
1.1055 raeburn 10723: sub process_decompression {
10724: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10725: my ($dir,$error,$warning,$output);
10726: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10727: $error = &mt('File name not a supported archive file type.').
10728: '<br />'.&mt('File name should end with one of: [_1].',
10729: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10730: } else {
10731: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10732: if ($docuhome eq 'no_host') {
10733: $error = &mt('Could not determine home server for course.');
10734: } else {
10735: my @ids=&Apache::lonnet::current_machine_ids();
10736: my $currdir = "$dir_root/$destination";
10737: if (grep(/^\Q$docuhome\E$/,@ids)) {
10738: $dir = &LONCAPA::propath($docudom,$docuname).
10739: "$dir_root/$destination";
10740: } else {
10741: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10742: "$dir_root/$docudom/$docuname/$destination";
10743: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10744: $error = &mt('Archive file not found.');
10745: }
10746: }
1.1065 raeburn 10747: my (@to_overwrite,@to_skip);
10748: if ($env{'form.archive_overwrite_total'} > 0) {
10749: my $total = $env{'form.archive_overwrite_total'};
10750: for (my $i=0; $i<$total; $i++) {
10751: if ($env{'form.archive_overwrite_'.$i} == 1) {
10752: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10753: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10754: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10755: }
10756: }
10757: }
10758: my $numskip = scalar(@to_skip);
10759: if (($numskip > 0) &&
10760: ($numskip == $env{'form.archive_itemcount'})) {
10761: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10762: } elsif ($dir eq '') {
1.1055 raeburn 10763: $error = &mt('Directory containing archive file unavailable.');
10764: } elsif (!$error) {
1.1065 raeburn 10765: my ($decompressed,$display);
10766: if ($numskip > 0) {
10767: my $tempdir = time.'_'.$$.int(rand(10000));
10768: mkdir("$dir/$tempdir",0755);
10769: system("mv $dir/$file $dir/$tempdir/$file");
10770: ($decompressed,$display) =
10771: &decompress_uploaded_file($file,"$dir/$tempdir");
10772: foreach my $item (@to_skip) {
10773: if (($item ne '') && ($item !~ /\.\./)) {
10774: if (-f "$dir/$tempdir/$item") {
10775: unlink("$dir/$tempdir/$item");
10776: } elsif (-d "$dir/$tempdir/$item") {
10777: system("rm -rf $dir/$tempdir/$item");
10778: }
10779: }
10780: }
10781: system("mv $dir/$tempdir/* $dir");
10782: rmdir("$dir/$tempdir");
10783: } else {
10784: ($decompressed,$display) =
10785: &decompress_uploaded_file($file,$dir);
10786: }
1.1055 raeburn 10787: if ($decompressed eq 'ok') {
1.1065 raeburn 10788: $output = '<p class="LC_info">'.
10789: &mt('Files extracted successfully from archive.').
10790: '</p>'."\n";
1.1055 raeburn 10791: my ($warning,$result,@contents);
10792: my ($newdirlistref,$newlisterror) =
10793: &Apache::lonnet::dirlist($currdir,$docudom,
10794: $docuname,1);
10795: my (%is_dir,%changes,@newitems);
10796: my $dirptr = 16384;
1.1065 raeburn 10797: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10798: foreach my $dir_line (@{$newdirlistref}) {
10799: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10800: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10801: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10802: push(@newitems,$item);
10803: if ($dirptr&$testdir) {
10804: $is_dir{$item} = 1;
10805: }
10806: $changes{$item} = 1;
10807: }
10808: }
10809: }
10810: if (keys(%changes) > 0) {
10811: foreach my $item (sort(@newitems)) {
10812: if ($changes{$item}) {
10813: push(@contents,$item);
10814: }
10815: }
10816: }
10817: if (@contents > 0) {
1.1067 raeburn 10818: my $wantform;
10819: unless ($env{'form.autoextract_camtasia'}) {
10820: $wantform = 1;
10821: }
1.1056 raeburn 10822: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10823: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10824: $currdir,\%is_dir,
10825: \%children,\%parent,
1.1056 raeburn 10826: \@contents,\%dirorder,
10827: \%titles,$wantform);
1.1055 raeburn 10828: if ($datatable ne '') {
10829: $output .= &archive_options_form('decompressed',$datatable,
10830: $count,$hiddenelem);
1.1065 raeburn 10831: my $startcount = 6;
1.1055 raeburn 10832: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10833: \%titles,\%children);
1.1055 raeburn 10834: }
1.1067 raeburn 10835: if ($env{'form.autoextract_camtasia'}) {
10836: my %displayed;
10837: my $total = 1;
10838: $env{'form.archive_directory'} = [];
10839: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10840: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10841: $path =~ s{/$}{};
10842: my $item;
10843: if ($path ne '') {
10844: $item = "$path/$titles{$i}";
10845: } else {
10846: $item = $titles{$i};
10847: }
10848: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10849: if ($item eq $contents[0]) {
10850: push(@{$env{'form.archive_directory'}},$i);
10851: $env{'form.archive_'.$i} = 'display';
10852: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10853: $displayed{'folder'} = $i;
10854: } elsif ($item eq "$contents[0]/index.html") {
10855: $env{'form.archive_'.$i} = 'display';
10856: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10857: $displayed{'web'} = $i;
10858: } else {
10859: if ($item eq "$contents[0]/media") {
10860: push(@{$env{'form.archive_directory'}},$i);
10861: }
10862: $env{'form.archive_'.$i} = 'dependency';
10863: }
10864: $total ++;
10865: }
10866: for (my $i=1; $i<$total; $i++) {
10867: next if ($i == $displayed{'web'});
10868: next if ($i == $displayed{'folder'});
10869: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10870: }
10871: $env{'form.phase'} = 'decompress_cleanup';
10872: $env{'form.archivedelete'} = 1;
10873: $env{'form.archive_count'} = $total-1;
10874: $output .=
10875: &process_extracted_files('coursedocs',$docudom,
10876: $docuname,$destination,
10877: $dir_root,$hiddenelem);
10878: }
1.1055 raeburn 10879: } else {
10880: $warning = &mt('No new items extracted from archive file.');
10881: }
10882: } else {
10883: $output = $display;
10884: $error = &mt('An error occurred during extraction from the archive file.');
10885: }
10886: }
10887: }
10888: }
10889: if ($error) {
10890: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10891: $error.'</p>'."\n";
10892: }
10893: if ($warning) {
10894: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10895: }
10896: return $output;
10897: }
10898:
10899: sub get_extracted {
1.1056 raeburn 10900: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10901: $titles,$wantform) = @_;
1.1055 raeburn 10902: my $count = 0;
10903: my $depth = 0;
10904: my $datatable;
1.1056 raeburn 10905: my @hierarchy;
1.1055 raeburn 10906: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10907: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10908: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10909: foreach my $item (@{$contents}) {
10910: $count ++;
1.1056 raeburn 10911: @{$dirorder->{$count}} = @hierarchy;
10912: $titles->{$count} = $item;
1.1055 raeburn 10913: &archive_hierarchy($depth,$count,$parent,$children);
10914: if ($wantform) {
10915: $datatable .= &archive_row($is_dir->{$item},$item,
10916: $currdir,$depth,$count);
10917: }
10918: if ($is_dir->{$item}) {
10919: $depth ++;
1.1056 raeburn 10920: push(@hierarchy,$count);
10921: $parent->{$depth} = $count;
1.1055 raeburn 10922: $datatable .=
10923: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10924: \$depth,\$count,\@hierarchy,$dirorder,
10925: $children,$parent,$titles,$wantform);
1.1055 raeburn 10926: $depth --;
1.1056 raeburn 10927: pop(@hierarchy);
1.1055 raeburn 10928: }
10929: }
10930: return ($count,$datatable);
10931: }
10932:
10933: sub recurse_extracted_archive {
1.1056 raeburn 10934: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10935: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10936: my $result='';
1.1056 raeburn 10937: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10938: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10939: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10940: return $result;
10941: }
10942: my $dirptr = 16384;
10943: my ($newdirlistref,$newlisterror) =
10944: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10945: if (ref($newdirlistref) eq 'ARRAY') {
10946: foreach my $dir_line (@{$newdirlistref}) {
10947: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10948: unless ($item =~ /^\.+$/) {
10949: $$count ++;
1.1056 raeburn 10950: @{$dirorder->{$$count}} = @{$hierarchy};
10951: $titles->{$$count} = $item;
1.1055 raeburn 10952: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10953:
1.1055 raeburn 10954: my $is_dir;
10955: if ($dirptr&$testdir) {
10956: $is_dir = 1;
10957: }
10958: if ($wantform) {
10959: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10960: }
10961: if ($is_dir) {
10962: $$depth ++;
1.1056 raeburn 10963: push(@{$hierarchy},$$count);
10964: $parent->{$$depth} = $$count;
1.1055 raeburn 10965: $result .=
10966: &recurse_extracted_archive("$currdir/$item",$docudom,
10967: $docuname,$depth,$count,
1.1056 raeburn 10968: $hierarchy,$dirorder,$children,
10969: $parent,$titles,$wantform);
1.1055 raeburn 10970: $$depth --;
1.1056 raeburn 10971: pop(@{$hierarchy});
1.1055 raeburn 10972: }
10973: }
10974: }
10975: }
10976: return $result;
10977: }
10978:
10979: sub archive_hierarchy {
10980: my ($depth,$count,$parent,$children) =@_;
10981: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10982: if (exists($parent->{$depth})) {
10983: $children->{$parent->{$depth}} .= $count.':';
10984: }
10985: }
10986: return;
10987: }
10988:
10989: sub archive_row {
10990: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10991: my ($name) = ($item =~ m{([^/]+)$});
10992: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10993: 'display' => 'Add as file',
1.1055 raeburn 10994: 'dependency' => 'Include as dependency',
10995: 'discard' => 'Discard',
10996: );
10997: if ($is_dir) {
1.1059 raeburn 10998: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10999: }
1.1056 raeburn 11000: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
11001: my $offset = 0;
1.1055 raeburn 11002: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 11003: $offset ++;
1.1065 raeburn 11004: if ($action ne 'display') {
11005: $offset ++;
11006: }
1.1055 raeburn 11007: $output .= '<td><span class="LC_nobreak">'.
11008: '<label><input type="radio" name="archive_'.$count.
11009: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
11010: my $text = $choices{$action};
11011: if ($is_dir) {
11012: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
11013: if ($action eq 'display') {
1.1059 raeburn 11014: $text = &mt('Add as folder');
1.1055 raeburn 11015: }
1.1056 raeburn 11016: } else {
11017: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11018:
11019: }
11020: $output .= ' /> '.$choices{$action}.'</label></span>';
11021: if ($action eq 'dependency') {
11022: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11023: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11024: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11025: '<option value=""></option>'."\n".
11026: '</select>'."\n".
11027: '</div>';
1.1059 raeburn 11028: } elsif ($action eq 'display') {
11029: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11030: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11031: '</div>';
1.1055 raeburn 11032: }
1.1056 raeburn 11033: $output .= '</td>';
1.1055 raeburn 11034: }
11035: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11036: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11037: for (my $i=0; $i<$depth; $i++) {
11038: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11039: }
11040: if ($is_dir) {
11041: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11042: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11043: } else {
11044: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11045: }
11046: $output .= ' '.$name.'</td>'."\n".
11047: &end_data_table_row();
11048: return $output;
11049: }
11050:
11051: sub archive_options_form {
1.1065 raeburn 11052: my ($form,$display,$count,$hiddenelem) = @_;
11053: my %lt = &Apache::lonlocal::texthash(
11054: perm => 'Permanently remove archive file?',
11055: hows => 'How should each extracted item be incorporated in the course?',
11056: cont => 'Content actions for all',
11057: addf => 'Add as folder/file',
11058: incd => 'Include as dependency for a displayed file',
11059: disc => 'Discard',
11060: no => 'No',
11061: yes => 'Yes',
11062: save => 'Save',
11063: );
11064: my $output = <<"END";
11065: <form name="$form" method="post" action="">
11066: <p><span class="LC_nobreak">$lt{'perm'}
11067: <label>
11068: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11069: </label>
11070:
11071: <label>
11072: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11073: </span>
11074: </p>
11075: <input type="hidden" name="phase" value="decompress_cleanup" />
11076: <br />$lt{'hows'}
11077: <div class="LC_columnSection">
11078: <fieldset>
11079: <legend>$lt{'cont'}</legend>
11080: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11081: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11082: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11083: </fieldset>
11084: </div>
11085: END
11086: return $output.
1.1055 raeburn 11087: &start_data_table()."\n".
1.1065 raeburn 11088: $display."\n".
1.1055 raeburn 11089: &end_data_table()."\n".
11090: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11091: $hiddenelem.
1.1065 raeburn 11092: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11093: '</form>';
11094: }
11095:
11096: sub archive_javascript {
1.1056 raeburn 11097: my ($startcount,$numitems,$titles,$children) = @_;
11098: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11099: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11100: my $scripttag = <<START;
11101: <script type="text/javascript">
11102: // <![CDATA[
11103:
11104: function checkAll(form,prefix) {
11105: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11106: for (var i=0; i < form.elements.length; i++) {
11107: var id = form.elements[i].id;
11108: if ((id != '') && (id != undefined)) {
11109: if (idstr.test(id)) {
11110: if (form.elements[i].type == 'radio') {
11111: form.elements[i].checked = true;
1.1056 raeburn 11112: var nostart = i-$startcount;
1.1059 raeburn 11113: var offset = nostart%7;
11114: var count = (nostart-offset)/7;
1.1056 raeburn 11115: dependencyCheck(form,count,offset);
1.1055 raeburn 11116: }
11117: }
11118: }
11119: }
11120: }
11121:
11122: function propagateCheck(form,count) {
11123: if (count > 0) {
1.1059 raeburn 11124: var startelement = $startcount + ((count-1) * 7);
11125: for (var j=1; j<6; j++) {
11126: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11127: var item = startelement + j;
11128: if (form.elements[item].type == 'radio') {
11129: if (form.elements[item].checked) {
11130: containerCheck(form,count,j);
11131: break;
11132: }
1.1055 raeburn 11133: }
11134: }
11135: }
11136: }
11137: }
11138:
11139: numitems = $numitems
1.1056 raeburn 11140: var titles = new Array(numitems);
11141: var parents = new Array(numitems);
1.1055 raeburn 11142: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11143: parents[i] = new Array;
1.1055 raeburn 11144: }
1.1059 raeburn 11145: var maintitle = '$maintitle';
1.1055 raeburn 11146:
11147: START
11148:
1.1056 raeburn 11149: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11150: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11151: for (my $i=0; $i<@contents; $i ++) {
11152: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11153: }
11154: }
11155:
1.1056 raeburn 11156: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11157: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11158: }
11159:
1.1055 raeburn 11160: $scripttag .= <<END;
11161:
11162: function containerCheck(form,count,offset) {
11163: if (count > 0) {
1.1056 raeburn 11164: dependencyCheck(form,count,offset);
1.1059 raeburn 11165: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11166: form.elements[item].checked = true;
11167: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11168: if (parents[count].length > 0) {
11169: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11170: containerCheck(form,parents[count][j],offset);
11171: }
11172: }
11173: }
11174: }
11175: }
11176:
11177: function dependencyCheck(form,count,offset) {
11178: if (count > 0) {
1.1059 raeburn 11179: var chosen = (offset+$startcount)+7*(count-1);
11180: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11181: var currtype = form.elements[depitem].type;
11182: if (form.elements[chosen].value == 'dependency') {
11183: document.getElementById('arc_depon_'+count).style.display='block';
11184: form.elements[depitem].options.length = 0;
11185: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 11186: for (var i=1; i<=numitems; i++) {
11187: if (i == count) {
11188: continue;
11189: }
1.1059 raeburn 11190: var startelement = $startcount + (i-1) * 7;
11191: for (var j=1; j<6; j++) {
11192: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11193: var item = startelement + j;
11194: if (form.elements[item].type == 'radio') {
11195: if (form.elements[item].checked) {
11196: if (form.elements[item].value == 'display') {
11197: var n = form.elements[depitem].options.length;
11198: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11199: }
11200: }
11201: }
11202: }
11203: }
11204: }
11205: } else {
11206: document.getElementById('arc_depon_'+count).style.display='none';
11207: form.elements[depitem].options.length = 0;
11208: form.elements[depitem].options[0] = new Option('Select','',true,true);
11209: }
1.1059 raeburn 11210: titleCheck(form,count,offset);
1.1056 raeburn 11211: }
11212: }
11213:
11214: function propagateSelect(form,count,offset) {
11215: if (count > 0) {
1.1065 raeburn 11216: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11217: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11218: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11219: if (parents[count].length > 0) {
11220: for (var j=0; j<parents[count].length; j++) {
11221: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11222: }
11223: }
11224: }
11225: }
11226: }
1.1056 raeburn 11227:
11228: function containerSelect(form,count,offset,picked) {
11229: if (count > 0) {
1.1065 raeburn 11230: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11231: if (form.elements[item].type == 'radio') {
11232: if (form.elements[item].value == 'dependency') {
11233: if (form.elements[item+1].type == 'select-one') {
11234: for (var i=0; i<form.elements[item+1].options.length; i++) {
11235: if (form.elements[item+1].options[i].value == picked) {
11236: form.elements[item+1].selectedIndex = i;
11237: break;
11238: }
11239: }
11240: }
11241: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11242: if (parents[count].length > 0) {
11243: for (var j=0; j<parents[count].length; j++) {
11244: containerSelect(form,parents[count][j],offset,picked);
11245: }
11246: }
11247: }
11248: }
11249: }
11250: }
11251: }
11252:
1.1059 raeburn 11253: function titleCheck(form,count,offset) {
11254: if (count > 0) {
11255: var chosen = (offset+$startcount)+7*(count-1);
11256: var depitem = $startcount + ((count-1) * 7) + 2;
11257: var currtype = form.elements[depitem].type;
11258: if (form.elements[chosen].value == 'display') {
11259: document.getElementById('arc_title_'+count).style.display='block';
11260: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11261: document.getElementById('archive_title_'+count).value=maintitle;
11262: }
11263: } else {
11264: document.getElementById('arc_title_'+count).style.display='none';
11265: if (currtype == 'text') {
11266: document.getElementById('archive_title_'+count).value='';
11267: }
11268: }
11269: }
11270: return;
11271: }
11272:
1.1055 raeburn 11273: // ]]>
11274: </script>
11275: END
11276: return $scripttag;
11277: }
11278:
11279: sub process_extracted_files {
1.1067 raeburn 11280: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11281: my $numitems = $env{'form.archive_count'};
11282: return unless ($numitems);
11283: my @ids=&Apache::lonnet::current_machine_ids();
11284: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11285: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11286: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11287: if (grep(/^\Q$docuhome\E$/,@ids)) {
11288: $prefix = &LONCAPA::propath($docudom,$docuname);
11289: $pathtocheck = "$dir_root/$destination";
11290: $dir = $dir_root;
11291: $ishome = 1;
11292: } else {
11293: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11294: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11295: $dir = "$dir_root/$docudom/$docuname";
11296: }
11297: my $currdir = "$dir_root/$destination";
11298: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11299: if ($env{'form.folderpath'}) {
11300: my @items = split('&',$env{'form.folderpath'});
11301: $folders{'0'} = $items[-2];
11302: $containers{'0'}='sequence';
11303: } elsif ($env{'form.pagepath'}) {
11304: my @items = split('&',$env{'form.pagepath'});
11305: $folders{'0'} = $items[-2];
11306: $containers{'0'}='page';
11307: }
11308: my @archdirs = &get_env_multiple('form.archive_directory');
11309: if ($numitems) {
11310: for (my $i=1; $i<=$numitems; $i++) {
11311: my $path = $env{'form.archive_content_'.$i};
11312: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11313: my $item = $1;
11314: $toplevelitems{$item} = $i;
11315: if (grep(/^\Q$i\E$/,@archdirs)) {
11316: $is_dir{$item} = 1;
11317: }
11318: }
11319: }
11320: }
1.1067 raeburn 11321: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11322: if (keys(%toplevelitems) > 0) {
11323: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11324: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11325: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11326: }
1.1066 raeburn 11327: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11328: if ($numitems) {
11329: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 11330: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11331: my $path = $env{'form.archive_content_'.$i};
11332: if ($path =~ /^\Q$pathtocheck\E/) {
11333: if ($env{'form.archive_'.$i} eq 'discard') {
11334: if ($prefix ne '' && $path ne '') {
11335: if (-e $prefix.$path) {
1.1066 raeburn 11336: if ((@archdirs > 0) &&
11337: (grep(/^\Q$i\E$/,@archdirs))) {
11338: $todeletedir{$prefix.$path} = 1;
11339: } else {
11340: $todelete{$prefix.$path} = 1;
11341: }
1.1055 raeburn 11342: }
11343: }
11344: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11345: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11346: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11347: $docstitle = $env{'form.archive_title_'.$i};
11348: if ($docstitle eq '') {
11349: $docstitle = $title;
11350: }
1.1055 raeburn 11351: $outer = 0;
1.1056 raeburn 11352: if (ref($dirorder{$i}) eq 'ARRAY') {
11353: if (@{$dirorder{$i}} > 0) {
11354: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11355: if ($env{'form.archive_'.$item} eq 'display') {
11356: $outer = $item;
11357: last;
11358: }
11359: }
11360: }
11361: }
11362: my ($errtext,$fatal) =
11363: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11364: '/'.$folders{$outer}.'.'.
11365: $containers{$outer});
11366: next if ($fatal);
11367: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11368: if ($context eq 'coursedocs') {
1.1056 raeburn 11369: $mapinner{$i} = time;
1.1055 raeburn 11370: $folders{$i} = 'default_'.$mapinner{$i};
11371: $containers{$i} = 'sequence';
11372: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11373: $folders{$i}.'.'.$containers{$i};
11374: my $newidx = &LONCAPA::map::getresidx();
11375: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11376: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11377: push(@LONCAPA::map::order,$newidx);
11378: my ($outtext,$errtext) =
11379: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11380: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11381: '.'.$containers{$outer},1,1);
1.1056 raeburn 11382: $newseqid{$i} = $newidx;
1.1067 raeburn 11383: unless ($errtext) {
11384: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11385: }
1.1055 raeburn 11386: }
11387: } else {
11388: if ($context eq 'coursedocs') {
11389: my $newidx=&LONCAPA::map::getresidx();
11390: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11391: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11392: $title;
11393: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11394: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11395: }
11396: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11397: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11398: }
11399: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11400: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11401: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11402: unless ($ishome) {
11403: my $fetch = "$newdest{$i}/$title";
11404: $fetch =~ s/^\Q$prefix$dir\E//;
11405: $prompttofetch{$fetch} = 1;
11406: }
1.1055 raeburn 11407: }
11408: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11409: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11410: push(@LONCAPA::map::order, $newidx);
11411: my ($outtext,$errtext)=
11412: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11413: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 11414: '.'.$containers{$outer},1,1);
1.1067 raeburn 11415: unless ($errtext) {
11416: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11417: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11418: }
11419: }
1.1055 raeburn 11420: }
11421: }
1.1086 raeburn 11422: }
11423: } else {
11424: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11425: }
11426: }
11427: for (my $i=1; $i<=$numitems; $i++) {
11428: next unless ($env{'form.archive_'.$i} eq 'dependency');
11429: my $path = $env{'form.archive_content_'.$i};
11430: if ($path =~ /^\Q$pathtocheck\E/) {
11431: my ($title) = ($path =~ m{/([^/]+)$});
11432: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11433: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11434: if (ref($dirorder{$i}) eq 'ARRAY') {
11435: my ($itemidx,$fullpath,$relpath);
11436: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11437: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11438: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 11439: if ($dirorder{$i}->[$j] eq $container) {
11440: $itemidx = $j;
1.1056 raeburn 11441: }
11442: }
1.1086 raeburn 11443: }
11444: if ($itemidx eq '') {
11445: $itemidx = 0;
11446: }
11447: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11448: if ($mapinner{$referrer{$i}}) {
11449: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11450: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11451: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11452: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11453: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11454: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11455: if (!-e $fullpath) {
11456: mkdir($fullpath,0755);
1.1056 raeburn 11457: }
11458: }
1.1086 raeburn 11459: } else {
11460: last;
1.1056 raeburn 11461: }
1.1086 raeburn 11462: }
11463: }
11464: } elsif ($newdest{$referrer{$i}}) {
11465: $fullpath = $newdest{$referrer{$i}};
11466: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11467: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11468: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11469: last;
11470: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11471: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11472: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11473: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11474: if (!-e $fullpath) {
11475: mkdir($fullpath,0755);
1.1056 raeburn 11476: }
11477: }
1.1086 raeburn 11478: } else {
11479: last;
1.1056 raeburn 11480: }
1.1055 raeburn 11481: }
11482: }
1.1086 raeburn 11483: if ($fullpath ne '') {
11484: if (-e "$prefix$path") {
11485: system("mv $prefix$path $fullpath/$title");
11486: }
11487: if (-e "$fullpath/$title") {
11488: my $showpath;
11489: if ($relpath ne '') {
11490: $showpath = "$relpath/$title";
11491: } else {
11492: $showpath = "/$title";
11493: }
11494: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11495: }
11496: unless ($ishome) {
11497: my $fetch = "$fullpath/$title";
11498: $fetch =~ s/^\Q$prefix$dir\E//;
11499: $prompttofetch{$fetch} = 1;
11500: }
11501: }
1.1055 raeburn 11502: }
1.1086 raeburn 11503: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11504: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11505: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11506: }
11507: } else {
11508: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11509: }
11510: }
11511: if (keys(%todelete)) {
11512: foreach my $key (keys(%todelete)) {
11513: unlink($key);
1.1066 raeburn 11514: }
11515: }
11516: if (keys(%todeletedir)) {
11517: foreach my $key (keys(%todeletedir)) {
11518: rmdir($key);
11519: }
11520: }
11521: foreach my $dir (sort(keys(%is_dir))) {
11522: if (($pathtocheck ne '') && ($dir ne '')) {
11523: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11524: }
11525: }
1.1067 raeburn 11526: if ($result ne '') {
11527: $output .= '<ul>'."\n".
11528: $result."\n".
11529: '</ul>';
11530: }
11531: unless ($ishome) {
11532: my $replicationfail;
11533: foreach my $item (keys(%prompttofetch)) {
11534: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11535: unless ($fetchresult eq 'ok') {
11536: $replicationfail .= '<li>'.$item.'</li>'."\n";
11537: }
11538: }
11539: if ($replicationfail) {
11540: $output .= '<p class="LC_error">'.
11541: &mt('Course home server failed to retrieve:').'<ul>'.
11542: $replicationfail.
11543: '</ul></p>';
11544: }
11545: }
1.1055 raeburn 11546: } else {
11547: $warning = &mt('No items found in archive.');
11548: }
11549: if ($error) {
11550: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11551: $error.'</p>'."\n";
11552: }
11553: if ($warning) {
11554: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11555: }
11556: return $output;
11557: }
11558:
1.1066 raeburn 11559: sub cleanup_empty_dirs {
11560: my ($path) = @_;
11561: if (($path ne '') && (-d $path)) {
11562: if (opendir(my $dirh,$path)) {
11563: my @dircontents = grep(!/^\./,readdir($dirh));
11564: my $numitems = 0;
11565: foreach my $item (@dircontents) {
11566: if (-d "$path/$item") {
11567: &recurse_dirs("$path/$item");
11568: if (-e "$path/$item") {
11569: $numitems ++;
11570: }
11571: } else {
11572: $numitems ++;
11573: }
11574: }
11575: if ($numitems == 0) {
11576: rmdir($path);
11577: }
11578: closedir($dirh);
11579: }
11580: }
11581: return;
11582: }
11583:
1.41 ng 11584: =pod
1.45 matthew 11585:
1.1068 raeburn 11586: =item &get_folder_hierarchy()
11587:
11588: Provides hierarchy of names of folders/sub-folders containing the current
11589: item,
11590:
11591: Inputs: 3
11592: - $navmap - navmaps object
11593:
11594: - $map - url for map (either the trigger itself, or map containing
11595: the resource, which is the trigger).
11596:
11597: - $showitem - 1 => show title for map itself; 0 => do not show.
11598:
11599: Outputs: 1 @pathitems - array of folder/subfolder names.
11600:
11601: =cut
11602:
11603: sub get_folder_hierarchy {
11604: my ($navmap,$map,$showitem) = @_;
11605: my @pathitems;
11606: if (ref($navmap)) {
11607: my $mapres = $navmap->getResourceByUrl($map);
11608: if (ref($mapres)) {
11609: my $pcslist = $mapres->map_hierarchy();
11610: if ($pcslist ne '') {
11611: my @pcs = split(/,/,$pcslist);
11612: foreach my $pc (@pcs) {
11613: if ($pc == 1) {
11614: push(@pathitems,&mt('Main Course Documents'));
11615: } else {
11616: my $res = $navmap->getByMapPc($pc);
11617: if (ref($res)) {
11618: my $title = $res->compTitle();
11619: $title =~ s/\W+/_/g;
11620: if ($title ne '') {
11621: push(@pathitems,$title);
11622: }
11623: }
11624: }
11625: }
11626: }
1.1071 raeburn 11627: if ($showitem) {
11628: if ($mapres->{ID} eq '0.0') {
11629: push(@pathitems,&mt('Main Course Documents'));
11630: } else {
11631: my $maptitle = $mapres->compTitle();
11632: $maptitle =~ s/\W+/_/g;
11633: if ($maptitle ne '') {
11634: push(@pathitems,$maptitle);
11635: }
1.1068 raeburn 11636: }
11637: }
11638: }
11639: }
11640: return @pathitems;
11641: }
11642:
11643: =pod
11644:
1.1015 raeburn 11645: =item * &get_turnedin_filepath()
11646:
11647: Determines path in a user's portfolio file for storage of files uploaded
11648: to a specific essayresponse or dropbox item.
11649:
11650: Inputs: 3 required + 1 optional.
11651: $symb is symb for resource, $uname and $udom are for current user (required).
11652: $caller is optional (can be "submission", if routine is called when storing
11653: an upoaded file when "Submit Answer" button was pressed).
11654:
11655: Returns array containing $path and $multiresp.
11656: $path is path in portfolio. $multiresp is 1 if this resource contains more
11657: than one file upload item. Callers of routine should append partid as a
11658: subdirectory to $path in cases where $multiresp is 1.
11659:
11660: Called by: homework/essayresponse.pm and homework/structuretags.pm
11661:
11662: =cut
11663:
11664: sub get_turnedin_filepath {
11665: my ($symb,$uname,$udom,$caller) = @_;
11666: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11667: my $turnindir;
11668: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11669: $turnindir = $userhash{'turnindir'};
11670: my ($path,$multiresp);
11671: if ($turnindir eq '') {
11672: if ($caller eq 'submission') {
11673: $turnindir = &mt('turned in');
11674: $turnindir =~ s/\W+/_/g;
11675: my %newhash = (
11676: 'turnindir' => $turnindir,
11677: );
11678: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11679: }
11680: }
11681: if ($turnindir ne '') {
11682: $path = '/'.$turnindir.'/';
11683: my ($multipart,$turnin,@pathitems);
11684: my $navmap = Apache::lonnavmaps::navmap->new();
11685: if (defined($navmap)) {
11686: my $mapres = $navmap->getResourceByUrl($map);
11687: if (ref($mapres)) {
11688: my $pcslist = $mapres->map_hierarchy();
11689: if ($pcslist ne '') {
11690: foreach my $pc (split(/,/,$pcslist)) {
11691: my $res = $navmap->getByMapPc($pc);
11692: if (ref($res)) {
11693: my $title = $res->compTitle();
11694: $title =~ s/\W+/_/g;
11695: if ($title ne '') {
11696: push(@pathitems,$title);
11697: }
11698: }
11699: }
11700: }
11701: my $maptitle = $mapres->compTitle();
11702: $maptitle =~ s/\W+/_/g;
11703: if ($maptitle ne '') {
11704: push(@pathitems,$maptitle);
11705: }
11706: unless ($env{'request.state'} eq 'construct') {
11707: my $res = $navmap->getBySymb($symb);
11708: if (ref($res)) {
11709: my $partlist = $res->parts();
11710: my $totaluploads = 0;
11711: if (ref($partlist) eq 'ARRAY') {
11712: foreach my $part (@{$partlist}) {
11713: my @types = $res->responseType($part);
11714: my @ids = $res->responseIds($part);
11715: for (my $i=0; $i < scalar(@ids); $i++) {
11716: if ($types[$i] eq 'essay') {
11717: my $partid = $part.'_'.$ids[$i];
11718: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11719: $totaluploads ++;
11720: }
11721: }
11722: }
11723: }
11724: if ($totaluploads > 1) {
11725: $multiresp = 1;
11726: }
11727: }
11728: }
11729: }
11730: } else {
11731: return;
11732: }
11733: } else {
11734: return;
11735: }
11736: my $restitle=&Apache::lonnet::gettitle($symb);
11737: $restitle =~ s/\W+/_/g;
11738: if ($restitle eq '') {
11739: $restitle = ($resurl =~ m{/[^/]+$});
11740: if ($restitle eq '') {
11741: $restitle = time;
11742: }
11743: }
11744: push(@pathitems,$restitle);
11745: $path .= join('/',@pathitems);
11746: }
11747: return ($path,$multiresp);
11748: }
11749:
11750: =pod
11751:
1.464 albertel 11752: =back
1.41 ng 11753:
1.112 bowersj2 11754: =head1 CSV Upload/Handling functions
1.38 albertel 11755:
1.41 ng 11756: =over 4
11757:
1.648 raeburn 11758: =item * &upfile_store($r)
1.41 ng 11759:
11760: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11761: needs $env{'form.upfile'}
1.41 ng 11762: returns $datatoken to be put into hidden field
11763:
11764: =cut
1.31 albertel 11765:
11766: sub upfile_store {
11767: my $r=shift;
1.258 albertel 11768: $env{'form.upfile'}=~s/\r/\n/gs;
11769: $env{'form.upfile'}=~s/\f/\n/gs;
11770: $env{'form.upfile'}=~s/\n+/\n/gs;
11771: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11772:
1.258 albertel 11773: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11774: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11775: {
1.158 raeburn 11776: my $datafile = $r->dir_config('lonDaemons').
11777: '/tmp/'.$datatoken.'.tmp';
11778: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11779: print $fh $env{'form.upfile'};
1.158 raeburn 11780: close($fh);
11781: }
1.31 albertel 11782: }
11783: return $datatoken;
11784: }
11785:
1.56 matthew 11786: =pod
11787:
1.648 raeburn 11788: =item * &load_tmp_file($r)
1.41 ng 11789:
11790: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11791: needs $env{'form.datatoken'},
11792: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11793:
11794: =cut
1.31 albertel 11795:
11796: sub load_tmp_file {
11797: my $r=shift;
11798: my @studentdata=();
11799: {
1.158 raeburn 11800: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11801: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11802: if ( open(my $fh,"<$studentfile") ) {
11803: @studentdata=<$fh>;
11804: close($fh);
11805: }
1.31 albertel 11806: }
1.258 albertel 11807: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11808: }
11809:
1.56 matthew 11810: =pod
11811:
1.648 raeburn 11812: =item * &upfile_record_sep()
1.41 ng 11813:
11814: Separate uploaded file into records
11815: returns array of records,
1.258 albertel 11816: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11817:
11818: =cut
1.31 albertel 11819:
11820: sub upfile_record_sep {
1.258 albertel 11821: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11822: } else {
1.248 albertel 11823: my @records;
1.258 albertel 11824: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11825: if ($line=~/^\s*$/) { next; }
11826: push(@records,$line);
11827: }
11828: return @records;
1.31 albertel 11829: }
11830: }
11831:
1.56 matthew 11832: =pod
11833:
1.648 raeburn 11834: =item * &record_sep($record)
1.41 ng 11835:
1.258 albertel 11836: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11837:
11838: =cut
11839:
1.263 www 11840: sub takeleft {
11841: my $index=shift;
11842: return substr('0000'.$index,-4,4);
11843: }
11844:
1.31 albertel 11845: sub record_sep {
11846: my $record=shift;
11847: my %components=();
1.258 albertel 11848: if ($env{'form.upfiletype'} eq 'xml') {
11849: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11850: my $i=0;
1.356 albertel 11851: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11852: $field=~s/^(\"|\')//;
11853: $field=~s/(\"|\')$//;
1.263 www 11854: $components{&takeleft($i)}=$field;
1.31 albertel 11855: $i++;
11856: }
1.258 albertel 11857: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11858: my $i=0;
1.356 albertel 11859: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11860: $field=~s/^(\"|\')//;
11861: $field=~s/(\"|\')$//;
1.263 www 11862: $components{&takeleft($i)}=$field;
1.31 albertel 11863: $i++;
11864: }
11865: } else {
1.561 www 11866: my $separator=',';
1.480 banghart 11867: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11868: $separator=';';
1.480 banghart 11869: }
1.31 albertel 11870: my $i=0;
1.561 www 11871: # the character we are looking for to indicate the end of a quote or a record
11872: my $looking_for=$separator;
11873: # do not add the characters to the fields
11874: my $ignore=0;
11875: # we just encountered a separator (or the beginning of the record)
11876: my $just_found_separator=1;
11877: # store the field we are working on here
11878: my $field='';
11879: # work our way through all characters in record
11880: foreach my $character ($record=~/(.)/g) {
11881: if ($character eq $looking_for) {
11882: if ($character ne $separator) {
11883: # Found the end of a quote, again looking for separator
11884: $looking_for=$separator;
11885: $ignore=1;
11886: } else {
11887: # Found a separator, store away what we got
11888: $components{&takeleft($i)}=$field;
11889: $i++;
11890: $just_found_separator=1;
11891: $ignore=0;
11892: $field='';
11893: }
11894: next;
11895: }
11896: # single or double quotation marks after a separator indicate beginning of a quote
11897: # we are now looking for the end of the quote and need to ignore separators
11898: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11899: $looking_for=$character;
11900: next;
11901: }
11902: # ignore would be true after we reached the end of a quote
11903: if ($ignore) { next; }
11904: if (($just_found_separator) && ($character=~/\s/)) { next; }
11905: $field.=$character;
11906: $just_found_separator=0;
1.31 albertel 11907: }
1.561 www 11908: # catch the very last entry, since we never encountered the separator
11909: $components{&takeleft($i)}=$field;
1.31 albertel 11910: }
11911: return %components;
11912: }
11913:
1.144 matthew 11914: ######################################################
11915: ######################################################
11916:
1.56 matthew 11917: =pod
11918:
1.648 raeburn 11919: =item * &upfile_select_html()
1.41 ng 11920:
1.144 matthew 11921: Return HTML code to select a file from the users machine and specify
11922: the file type.
1.41 ng 11923:
11924: =cut
11925:
1.144 matthew 11926: ######################################################
11927: ######################################################
1.31 albertel 11928: sub upfile_select_html {
1.144 matthew 11929: my %Types = (
11930: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11931: semisv => &mt('Semicolon separated values'),
1.144 matthew 11932: space => &mt('Space separated'),
11933: tab => &mt('Tabulator separated'),
11934: # xml => &mt('HTML/XML'),
11935: );
11936: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11937: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11938: foreach my $type (sort(keys(%Types))) {
11939: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11940: }
11941: $Str .= "</select>\n";
11942: return $Str;
1.31 albertel 11943: }
11944:
1.301 albertel 11945: sub get_samples {
11946: my ($records,$toget) = @_;
11947: my @samples=({});
11948: my $got=0;
11949: foreach my $rec (@$records) {
11950: my %temp = &record_sep($rec);
11951: if (! grep(/\S/, values(%temp))) { next; }
11952: if (%temp) {
11953: $samples[$got]=\%temp;
11954: $got++;
11955: if ($got == $toget) { last; }
11956: }
11957: }
11958: return \@samples;
11959: }
11960:
1.144 matthew 11961: ######################################################
11962: ######################################################
11963:
1.56 matthew 11964: =pod
11965:
1.648 raeburn 11966: =item * &csv_print_samples($r,$records)
1.41 ng 11967:
11968: Prints a table of sample values from each column uploaded $r is an
11969: Apache Request ref, $records is an arrayref from
11970: &Apache::loncommon::upfile_record_sep
11971:
11972: =cut
11973:
1.144 matthew 11974: ######################################################
11975: ######################################################
1.31 albertel 11976: sub csv_print_samples {
11977: my ($r,$records) = @_;
1.662 bisitz 11978: my $samples = &get_samples($records,5);
1.301 albertel 11979:
1.594 raeburn 11980: $r->print(&mt('Samples').'<br />'.&start_data_table().
11981: &start_data_table_header_row());
1.356 albertel 11982: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11983: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11984: $r->print(&end_data_table_header_row());
1.301 albertel 11985: foreach my $hash (@$samples) {
1.594 raeburn 11986: $r->print(&start_data_table_row());
1.356 albertel 11987: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11988: $r->print('<td>');
1.356 albertel 11989: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11990: $r->print('</td>');
11991: }
1.594 raeburn 11992: $r->print(&end_data_table_row());
1.31 albertel 11993: }
1.594 raeburn 11994: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11995: }
11996:
1.144 matthew 11997: ######################################################
11998: ######################################################
11999:
1.56 matthew 12000: =pod
12001:
1.648 raeburn 12002: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 12003:
12004: Prints a table to create associations between values and table columns.
1.144 matthew 12005:
1.41 ng 12006: $r is an Apache Request ref,
12007: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 12008: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 12009:
12010: =cut
12011:
1.144 matthew 12012: ######################################################
12013: ######################################################
1.31 albertel 12014: sub csv_print_select_table {
12015: my ($r,$records,$d) = @_;
1.301 albertel 12016: my $i=0;
12017: my $samples = &get_samples($records,1);
1.144 matthew 12018: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12019: &start_data_table().&start_data_table_header_row().
1.144 matthew 12020: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12021: '<th>'.&mt('Column').'</th>'.
12022: &end_data_table_header_row()."\n");
1.356 albertel 12023: foreach my $array_ref (@$d) {
12024: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12025: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12026:
1.875 bisitz 12027: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12028: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12029: $r->print('<option value="none"></option>');
1.356 albertel 12030: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12031: $r->print('<option value="'.$sample.'"'.
12032: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12033: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12034: }
1.594 raeburn 12035: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12036: $i++;
12037: }
1.594 raeburn 12038: $r->print(&end_data_table());
1.31 albertel 12039: $i--;
12040: return $i;
12041: }
1.56 matthew 12042:
1.144 matthew 12043: ######################################################
12044: ######################################################
12045:
1.56 matthew 12046: =pod
1.31 albertel 12047:
1.648 raeburn 12048: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12049:
12050: Prints a table of sample values from the upload and can make associate samples to internal names.
12051:
12052: $r is an Apache Request ref,
12053: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12054: $d is an array of 2 element arrays (internal name, displayed name)
12055:
12056: =cut
12057:
1.144 matthew 12058: ######################################################
12059: ######################################################
1.31 albertel 12060: sub csv_samples_select_table {
12061: my ($r,$records,$d) = @_;
12062: my $i=0;
1.144 matthew 12063: #
1.662 bisitz 12064: my $max_samples = 5;
12065: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12066: $r->print(&start_data_table().
12067: &start_data_table_header_row().'<th>'.
12068: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12069: &end_data_table_header_row());
1.301 albertel 12070:
12071: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12072: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12073: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12074: foreach my $option (@$d) {
12075: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12076: $r->print('<option value="'.$value.'"'.
1.253 albertel 12077: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12078: $display.'</option>');
1.31 albertel 12079: }
12080: $r->print('</select></td><td>');
1.662 bisitz 12081: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12082: if (defined($samples->[$line]{$key})) {
12083: $r->print($samples->[$line]{$key}."<br />\n");
12084: }
12085: }
1.594 raeburn 12086: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12087: $i++;
12088: }
1.594 raeburn 12089: $r->print(&end_data_table());
1.31 albertel 12090: $i--;
12091: return($i);
1.115 matthew 12092: }
12093:
1.144 matthew 12094: ######################################################
12095: ######################################################
12096:
1.115 matthew 12097: =pod
12098:
1.648 raeburn 12099: =item * &clean_excel_name($name)
1.115 matthew 12100:
12101: Returns a replacement for $name which does not contain any illegal characters.
12102:
12103: =cut
12104:
1.144 matthew 12105: ######################################################
12106: ######################################################
1.115 matthew 12107: sub clean_excel_name {
12108: my ($name) = @_;
12109: $name =~ s/[:\*\?\/\\]//g;
12110: if (length($name) > 31) {
12111: $name = substr($name,0,31);
12112: }
12113: return $name;
1.25 albertel 12114: }
1.84 albertel 12115:
1.85 albertel 12116: =pod
12117:
1.648 raeburn 12118: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12119:
12120: Returns either 1 or undef
12121:
12122: 1 if the part is to be hidden, undef if it is to be shown
12123:
12124: Arguments are:
12125:
12126: $id the id of the part to be checked
12127: $symb, optional the symb of the resource to check
12128: $udom, optional the domain of the user to check for
12129: $uname, optional the username of the user to check for
12130:
12131: =cut
1.84 albertel 12132:
12133: sub check_if_partid_hidden {
12134: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12135: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12136: $symb,$udom,$uname);
1.141 albertel 12137: my $truth=1;
12138: #if the string starts with !, then the list is the list to show not hide
12139: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12140: my @hiddenlist=split(/,/,$hiddenparts);
12141: foreach my $checkid (@hiddenlist) {
1.141 albertel 12142: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12143: }
1.141 albertel 12144: return !$truth;
1.84 albertel 12145: }
1.127 matthew 12146:
1.138 matthew 12147:
12148: ############################################################
12149: ############################################################
12150:
12151: =pod
12152:
1.157 matthew 12153: =back
12154:
1.138 matthew 12155: =head1 cgi-bin script and graphing routines
12156:
1.157 matthew 12157: =over 4
12158:
1.648 raeburn 12159: =item * &get_cgi_id()
1.138 matthew 12160:
12161: Inputs: none
12162:
12163: Returns an id which can be used to pass environment variables
12164: to various cgi-bin scripts. These environment variables will
12165: be removed from the users environment after a given time by
12166: the routine &Apache::lonnet::transfer_profile_to_env.
12167:
12168: =cut
12169:
12170: ############################################################
12171: ############################################################
1.152 albertel 12172: my $uniq=0;
1.136 matthew 12173: sub get_cgi_id {
1.154 albertel 12174: $uniq=($uniq+1)%100000;
1.280 albertel 12175: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12176: }
12177:
1.127 matthew 12178: ############################################################
12179: ############################################################
12180:
12181: =pod
12182:
1.648 raeburn 12183: =item * &DrawBarGraph()
1.127 matthew 12184:
1.138 matthew 12185: Facilitates the plotting of data in a (stacked) bar graph.
12186: Puts plot definition data into the users environment in order for
12187: graph.png to plot it. Returns an <img> tag for the plot.
12188: The bars on the plot are labeled '1','2',...,'n'.
12189:
12190: Inputs:
12191:
12192: =over 4
12193:
12194: =item $Title: string, the title of the plot
12195:
12196: =item $xlabel: string, text describing the X-axis of the plot
12197:
12198: =item $ylabel: string, text describing the Y-axis of the plot
12199:
12200: =item $Max: scalar, the maximum Y value to use in the plot
12201: If $Max is < any data point, the graph will not be rendered.
12202:
1.140 matthew 12203: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12204: they are plotted. If undefined, default values will be used.
12205:
1.178 matthew 12206: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12207:
1.138 matthew 12208: =item @Values: An array of array references. Each array reference holds data
12209: to be plotted in a stacked bar chart.
12210:
1.239 matthew 12211: =item If the final element of @Values is a hash reference the key/value
12212: pairs will be added to the graph definition.
12213:
1.138 matthew 12214: =back
12215:
12216: Returns:
12217:
12218: An <img> tag which references graph.png and the appropriate identifying
12219: information for the plot.
12220:
1.127 matthew 12221: =cut
12222:
12223: ############################################################
12224: ############################################################
1.134 matthew 12225: sub DrawBarGraph {
1.178 matthew 12226: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12227: #
12228: if (! defined($colors)) {
12229: $colors = ['#33ff00',
12230: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12231: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12232: ];
12233: }
1.228 matthew 12234: my $extra_settings = {};
12235: if (ref($Values[-1]) eq 'HASH') {
12236: $extra_settings = pop(@Values);
12237: }
1.127 matthew 12238: #
1.136 matthew 12239: my $identifier = &get_cgi_id();
12240: my $id = 'cgi.'.$identifier;
1.129 matthew 12241: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12242: return '';
12243: }
1.225 matthew 12244: #
12245: my @Labels;
12246: if (defined($labels)) {
12247: @Labels = @$labels;
12248: } else {
12249: for (my $i=0;$i<@{$Values[0]};$i++) {
12250: push (@Labels,$i+1);
12251: }
12252: }
12253: #
1.129 matthew 12254: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12255: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12256: my %ValuesHash;
12257: my $NumSets=1;
12258: foreach my $array (@Values) {
12259: next if (! ref($array));
1.136 matthew 12260: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12261: join(',',@$array);
1.129 matthew 12262: }
1.127 matthew 12263: #
1.136 matthew 12264: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12265: if ($NumBars < 3) {
12266: $width = 120+$NumBars*32;
1.220 matthew 12267: $xskip = 1;
1.225 matthew 12268: $bar_width = 30;
12269: } elsif ($NumBars < 5) {
12270: $width = 120+$NumBars*20;
12271: $xskip = 1;
12272: $bar_width = 20;
1.220 matthew 12273: } elsif ($NumBars < 10) {
1.136 matthew 12274: $width = 120+$NumBars*15;
12275: $xskip = 1;
12276: $bar_width = 15;
12277: } elsif ($NumBars <= 25) {
12278: $width = 120+$NumBars*11;
12279: $xskip = 5;
12280: $bar_width = 8;
12281: } elsif ($NumBars <= 50) {
12282: $width = 120+$NumBars*8;
12283: $xskip = 5;
12284: $bar_width = 4;
12285: } else {
12286: $width = 120+$NumBars*8;
12287: $xskip = 5;
12288: $bar_width = 4;
12289: }
12290: #
1.137 matthew 12291: $Max = 1 if ($Max < 1);
12292: if ( int($Max) < $Max ) {
12293: $Max++;
12294: $Max = int($Max);
12295: }
1.127 matthew 12296: $Title = '' if (! defined($Title));
12297: $xlabel = '' if (! defined($xlabel));
12298: $ylabel = '' if (! defined($ylabel));
1.369 www 12299: $ValuesHash{$id.'.title'} = &escape($Title);
12300: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12301: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12302: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12303: $ValuesHash{$id.'.NumBars'} = $NumBars;
12304: $ValuesHash{$id.'.NumSets'} = $NumSets;
12305: $ValuesHash{$id.'.PlotType'} = 'bar';
12306: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12307: $ValuesHash{$id.'.height'} = $height;
12308: $ValuesHash{$id.'.width'} = $width;
12309: $ValuesHash{$id.'.xskip'} = $xskip;
12310: $ValuesHash{$id.'.bar_width'} = $bar_width;
12311: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12312: #
1.228 matthew 12313: # Deal with other parameters
12314: while (my ($key,$value) = each(%$extra_settings)) {
12315: $ValuesHash{$id.'.'.$key} = $value;
12316: }
12317: #
1.646 raeburn 12318: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12319: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12320: }
12321:
12322: ############################################################
12323: ############################################################
12324:
12325: =pod
12326:
1.648 raeburn 12327: =item * &DrawXYGraph()
1.137 matthew 12328:
1.138 matthew 12329: Facilitates the plotting of data in an XY graph.
12330: Puts plot definition data into the users environment in order for
12331: graph.png to plot it. Returns an <img> tag for the plot.
12332:
12333: Inputs:
12334:
12335: =over 4
12336:
12337: =item $Title: string, the title of the plot
12338:
12339: =item $xlabel: string, text describing the X-axis of the plot
12340:
12341: =item $ylabel: string, text describing the Y-axis of the plot
12342:
12343: =item $Max: scalar, the maximum Y value to use in the plot
12344: If $Max is < any data point, the graph will not be rendered.
12345:
12346: =item $colors: Array ref containing the hex color codes for the data to be
12347: plotted in. If undefined, default values will be used.
12348:
12349: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12350:
12351: =item $Ydata: Array ref containing Array refs.
1.185 www 12352: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12353:
12354: =item %Values: hash indicating or overriding any default values which are
12355: passed to graph.png.
12356: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12357:
12358: =back
12359:
12360: Returns:
12361:
12362: An <img> tag which references graph.png and the appropriate identifying
12363: information for the plot.
12364:
1.137 matthew 12365: =cut
12366:
12367: ############################################################
12368: ############################################################
12369: sub DrawXYGraph {
12370: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12371: #
12372: # Create the identifier for the graph
12373: my $identifier = &get_cgi_id();
12374: my $id = 'cgi.'.$identifier;
12375: #
12376: $Title = '' if (! defined($Title));
12377: $xlabel = '' if (! defined($xlabel));
12378: $ylabel = '' if (! defined($ylabel));
12379: my %ValuesHash =
12380: (
1.369 www 12381: $id.'.title' => &escape($Title),
12382: $id.'.xlabel' => &escape($xlabel),
12383: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12384: $id.'.y_max_value'=> $Max,
12385: $id.'.labels' => join(',',@$Xlabels),
12386: $id.'.PlotType' => 'XY',
12387: );
12388: #
12389: if (defined($colors) && ref($colors) eq 'ARRAY') {
12390: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12391: }
12392: #
12393: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12394: return '';
12395: }
12396: my $NumSets=1;
1.138 matthew 12397: foreach my $array (@{$Ydata}){
1.137 matthew 12398: next if (! ref($array));
12399: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12400: }
1.138 matthew 12401: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12402: #
12403: # Deal with other parameters
12404: while (my ($key,$value) = each(%Values)) {
12405: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12406: }
12407: #
1.646 raeburn 12408: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12409: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12410: }
12411:
12412: ############################################################
12413: ############################################################
12414:
12415: =pod
12416:
1.648 raeburn 12417: =item * &DrawXYYGraph()
1.138 matthew 12418:
12419: Facilitates the plotting of data in an XY graph with two Y axes.
12420: Puts plot definition data into the users environment in order for
12421: graph.png to plot it. Returns an <img> tag for the plot.
12422:
12423: Inputs:
12424:
12425: =over 4
12426:
12427: =item $Title: string, the title of the plot
12428:
12429: =item $xlabel: string, text describing the X-axis of the plot
12430:
12431: =item $ylabel: string, text describing the Y-axis of the plot
12432:
12433: =item $colors: Array ref containing the hex color codes for the data to be
12434: plotted in. If undefined, default values will be used.
12435:
12436: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12437:
12438: =item $Ydata1: The first data set
12439:
12440: =item $Min1: The minimum value of the left Y-axis
12441:
12442: =item $Max1: The maximum value of the left Y-axis
12443:
12444: =item $Ydata2: The second data set
12445:
12446: =item $Min2: The minimum value of the right Y-axis
12447:
12448: =item $Max2: The maximum value of the left Y-axis
12449:
12450: =item %Values: hash indicating or overriding any default values which are
12451: passed to graph.png.
12452: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12453:
12454: =back
12455:
12456: Returns:
12457:
12458: An <img> tag which references graph.png and the appropriate identifying
12459: information for the plot.
1.136 matthew 12460:
12461: =cut
12462:
12463: ############################################################
12464: ############################################################
1.137 matthew 12465: sub DrawXYYGraph {
12466: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12467: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12468: #
12469: # Create the identifier for the graph
12470: my $identifier = &get_cgi_id();
12471: my $id = 'cgi.'.$identifier;
12472: #
12473: $Title = '' if (! defined($Title));
12474: $xlabel = '' if (! defined($xlabel));
12475: $ylabel = '' if (! defined($ylabel));
12476: my %ValuesHash =
12477: (
1.369 www 12478: $id.'.title' => &escape($Title),
12479: $id.'.xlabel' => &escape($xlabel),
12480: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12481: $id.'.labels' => join(',',@$Xlabels),
12482: $id.'.PlotType' => 'XY',
12483: $id.'.NumSets' => 2,
1.137 matthew 12484: $id.'.two_axes' => 1,
12485: $id.'.y1_max_value' => $Max1,
12486: $id.'.y1_min_value' => $Min1,
12487: $id.'.y2_max_value' => $Max2,
12488: $id.'.y2_min_value' => $Min2,
1.136 matthew 12489: );
12490: #
1.137 matthew 12491: if (defined($colors) && ref($colors) eq 'ARRAY') {
12492: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12493: }
12494: #
12495: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12496: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12497: return '';
12498: }
12499: my $NumSets=1;
1.137 matthew 12500: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12501: next if (! ref($array));
12502: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12503: }
12504: #
12505: # Deal with other parameters
12506: while (my ($key,$value) = each(%Values)) {
12507: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12508: }
12509: #
1.646 raeburn 12510: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12511: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12512: }
12513:
12514: ############################################################
12515: ############################################################
12516:
12517: =pod
12518:
1.157 matthew 12519: =back
12520:
1.139 matthew 12521: =head1 Statistics helper routines?
12522:
12523: Bad place for them but what the hell.
12524:
1.157 matthew 12525: =over 4
12526:
1.648 raeburn 12527: =item * &chartlink()
1.139 matthew 12528:
12529: Returns a link to the chart for a specific student.
12530:
12531: Inputs:
12532:
12533: =over 4
12534:
12535: =item $linktext: The text of the link
12536:
12537: =item $sname: The students username
12538:
12539: =item $sdomain: The students domain
12540:
12541: =back
12542:
1.157 matthew 12543: =back
12544:
1.139 matthew 12545: =cut
12546:
12547: ############################################################
12548: ############################################################
12549: sub chartlink {
12550: my ($linktext, $sname, $sdomain) = @_;
12551: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12552: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12553: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12554: '">'.$linktext.'</a>';
1.153 matthew 12555: }
12556:
12557: #######################################################
12558: #######################################################
12559:
12560: =pod
12561:
12562: =head1 Course Environment Routines
1.157 matthew 12563:
12564: =over 4
1.153 matthew 12565:
1.648 raeburn 12566: =item * &restore_course_settings()
1.153 matthew 12567:
1.648 raeburn 12568: =item * &store_course_settings()
1.153 matthew 12569:
12570: Restores/Store indicated form parameters from the course environment.
12571: Will not overwrite existing values of the form parameters.
12572:
12573: Inputs:
12574: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12575:
12576: a hash ref describing the data to be stored. For example:
12577:
12578: %Save_Parameters = ('Status' => 'scalar',
12579: 'chartoutputmode' => 'scalar',
12580: 'chartoutputdata' => 'scalar',
12581: 'Section' => 'array',
1.373 raeburn 12582: 'Group' => 'array',
1.153 matthew 12583: 'StudentData' => 'array',
12584: 'Maps' => 'array');
12585:
12586: Returns: both routines return nothing
12587:
1.631 raeburn 12588: =back
12589:
1.153 matthew 12590: =cut
12591:
12592: #######################################################
12593: #######################################################
12594: sub store_course_settings {
1.496 albertel 12595: return &store_settings($env{'request.course.id'},@_);
12596: }
12597:
12598: sub store_settings {
1.153 matthew 12599: # save to the environment
12600: # appenv the same items, just to be safe
1.300 albertel 12601: my $udom = $env{'user.domain'};
12602: my $uname = $env{'user.name'};
1.496 albertel 12603: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12604: my %SaveHash;
12605: my %AppHash;
12606: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12607: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12608: my $envname = 'environment.'.$basename;
1.258 albertel 12609: if (exists($env{'form.'.$setting})) {
1.153 matthew 12610: # Save this value away
12611: if ($type eq 'scalar' &&
1.258 albertel 12612: (! exists($env{$envname}) ||
12613: $env{$envname} ne $env{'form.'.$setting})) {
12614: $SaveHash{$basename} = $env{'form.'.$setting};
12615: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12616: } elsif ($type eq 'array') {
12617: my $stored_form;
1.258 albertel 12618: if (ref($env{'form.'.$setting})) {
1.153 matthew 12619: $stored_form = join(',',
12620: map {
1.369 www 12621: &escape($_);
1.258 albertel 12622: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12623: } else {
12624: $stored_form =
1.369 www 12625: &escape($env{'form.'.$setting});
1.153 matthew 12626: }
12627: # Determine if the array contents are the same.
1.258 albertel 12628: if ($stored_form ne $env{$envname}) {
1.153 matthew 12629: $SaveHash{$basename} = $stored_form;
12630: $AppHash{$envname} = $stored_form;
12631: }
12632: }
12633: }
12634: }
12635: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12636: $udom,$uname);
1.153 matthew 12637: if ($put_result !~ /^(ok|delayed)/) {
12638: &Apache::lonnet::logthis('unable to save form parameters, '.
12639: 'got error:'.$put_result);
12640: }
12641: # Make sure these settings stick around in this session, too
1.646 raeburn 12642: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12643: return;
12644: }
12645:
12646: sub restore_course_settings {
1.499 albertel 12647: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12648: }
12649:
12650: sub restore_settings {
12651: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12652: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12653: next if (exists($env{'form.'.$setting}));
1.496 albertel 12654: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12655: '.'.$setting;
1.258 albertel 12656: if (exists($env{$envname})) {
1.153 matthew 12657: if ($type eq 'scalar') {
1.258 albertel 12658: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12659: } elsif ($type eq 'array') {
1.258 albertel 12660: $env{'form.'.$setting} = [
1.153 matthew 12661: map {
1.369 www 12662: &unescape($_);
1.258 albertel 12663: } split(',',$env{$envname})
1.153 matthew 12664: ];
12665: }
12666: }
12667: }
1.127 matthew 12668: }
12669:
1.618 raeburn 12670: #######################################################
12671: #######################################################
12672:
12673: =pod
12674:
12675: =head1 Domain E-mail Routines
12676:
12677: =over 4
12678:
1.648 raeburn 12679: =item * &build_recipient_list()
1.618 raeburn 12680:
1.884 raeburn 12681: Build recipient lists for five types of e-mail:
1.766 raeburn 12682: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12683: (d) Help requests, (e) Course requests needing approval, generated by
12684: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12685: loncoursequeueadmin.pm respectively.
1.618 raeburn 12686:
12687: Inputs:
1.619 raeburn 12688: defmail (scalar - email address of default recipient),
1.618 raeburn 12689: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12690: defdom (domain for which to retrieve configuration settings),
12691: origmail (scalar - email address of recipient from loncapa.conf,
12692: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12693:
1.655 raeburn 12694: Returns: comma separated list of addresses to which to send e-mail.
12695:
12696: =back
1.618 raeburn 12697:
12698: =cut
12699:
12700: ############################################################
12701: ############################################################
12702: sub build_recipient_list {
1.619 raeburn 12703: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12704: my @recipients;
12705: my $otheremails;
12706: my %domconfig =
12707: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12708: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12709: if (exists($domconfig{'contacts'}{$mailing})) {
12710: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12711: my @contacts = ('adminemail','supportemail');
12712: foreach my $item (@contacts) {
12713: if ($domconfig{'contacts'}{$mailing}{$item}) {
12714: my $addr = $domconfig{'contacts'}{$item};
12715: if (!grep(/^\Q$addr\E$/,@recipients)) {
12716: push(@recipients,$addr);
12717: }
1.619 raeburn 12718: }
1.766 raeburn 12719: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12720: }
12721: }
1.766 raeburn 12722: } elsif ($origmail ne '') {
12723: push(@recipients,$origmail);
1.618 raeburn 12724: }
1.619 raeburn 12725: } elsif ($origmail ne '') {
12726: push(@recipients,$origmail);
1.618 raeburn 12727: }
1.688 raeburn 12728: if (defined($defmail)) {
12729: if ($defmail ne '') {
12730: push(@recipients,$defmail);
12731: }
1.618 raeburn 12732: }
12733: if ($otheremails) {
1.619 raeburn 12734: my @others;
12735: if ($otheremails =~ /,/) {
12736: @others = split(/,/,$otheremails);
1.618 raeburn 12737: } else {
1.619 raeburn 12738: push(@others,$otheremails);
12739: }
12740: foreach my $addr (@others) {
12741: if (!grep(/^\Q$addr\E$/,@recipients)) {
12742: push(@recipients,$addr);
12743: }
1.618 raeburn 12744: }
12745: }
1.619 raeburn 12746: my $recipientlist = join(',',@recipients);
1.618 raeburn 12747: return $recipientlist;
12748: }
12749:
1.127 matthew 12750: ############################################################
12751: ############################################################
1.154 albertel 12752:
1.655 raeburn 12753: =pod
12754:
12755: =head1 Course Catalog Routines
12756:
12757: =over 4
12758:
12759: =item * &gather_categories()
12760:
12761: Converts category definitions - keys of categories hash stored in
12762: coursecategories in configuration.db on the primary library server in a
12763: domain - to an array. Also generates javascript and idx hash used to
12764: generate Domain Coordinator interface for editing Course Categories.
12765:
12766: Inputs:
1.663 raeburn 12767:
1.655 raeburn 12768: categories (reference to hash of category definitions).
1.663 raeburn 12769:
1.655 raeburn 12770: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12771: categories and subcategories).
1.663 raeburn 12772:
1.655 raeburn 12773: idx (reference to hash of counters used in Domain Coordinator interface for
12774: editing Course Categories).
1.663 raeburn 12775:
1.655 raeburn 12776: jsarray (reference to array of categories used to create Javascript arrays for
12777: Domain Coordinator interface for editing Course Categories).
12778:
12779: Returns: nothing
12780:
12781: Side effects: populates cats, idx and jsarray.
12782:
12783: =cut
12784:
12785: sub gather_categories {
12786: my ($categories,$cats,$idx,$jsarray) = @_;
12787: my %counters;
12788: my $num = 0;
12789: foreach my $item (keys(%{$categories})) {
12790: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12791: if ($container eq '' && $depth == 0) {
12792: $cats->[$depth][$categories->{$item}] = $cat;
12793: } else {
12794: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12795: }
12796: my ($escitem,$tail) = split(/:/,$item,2);
12797: if ($counters{$tail} eq '') {
12798: $counters{$tail} = $num;
12799: $num ++;
12800: }
12801: if (ref($idx) eq 'HASH') {
12802: $idx->{$item} = $counters{$tail};
12803: }
12804: if (ref($jsarray) eq 'ARRAY') {
12805: push(@{$jsarray->[$counters{$tail}]},$item);
12806: }
12807: }
12808: return;
12809: }
12810:
12811: =pod
12812:
12813: =item * &extract_categories()
12814:
12815: Used to generate breadcrumb trails for course categories.
12816:
12817: Inputs:
1.663 raeburn 12818:
1.655 raeburn 12819: categories (reference to hash of category definitions).
1.663 raeburn 12820:
1.655 raeburn 12821: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12822: categories and subcategories).
1.663 raeburn 12823:
1.655 raeburn 12824: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12825:
1.655 raeburn 12826: allitems (reference to hash - key is category key
12827: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12828:
1.655 raeburn 12829: idx (reference to hash of counters used in Domain Coordinator interface for
12830: editing Course Categories).
1.663 raeburn 12831:
1.655 raeburn 12832: jsarray (reference to array of categories used to create Javascript arrays for
12833: Domain Coordinator interface for editing Course Categories).
12834:
1.665 raeburn 12835: subcats (reference to hash of arrays containing all subcategories within each
12836: category, -recursive)
12837:
1.655 raeburn 12838: Returns: nothing
12839:
12840: Side effects: populates trails and allitems hash references.
12841:
12842: =cut
12843:
12844: sub extract_categories {
1.665 raeburn 12845: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12846: if (ref($categories) eq 'HASH') {
12847: &gather_categories($categories,$cats,$idx,$jsarray);
12848: if (ref($cats->[0]) eq 'ARRAY') {
12849: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12850: my $name = $cats->[0][$i];
12851: my $item = &escape($name).'::0';
12852: my $trailstr;
12853: if ($name eq 'instcode') {
12854: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12855: } elsif ($name eq 'communities') {
12856: $trailstr = &mt('Communities');
1.655 raeburn 12857: } else {
12858: $trailstr = $name;
12859: }
12860: if ($allitems->{$item} eq '') {
12861: push(@{$trails},$trailstr);
12862: $allitems->{$item} = scalar(@{$trails})-1;
12863: }
12864: my @parents = ($name);
12865: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12866: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12867: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12868: if (ref($subcats) eq 'HASH') {
12869: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12870: }
12871: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12872: }
12873: } else {
12874: if (ref($subcats) eq 'HASH') {
12875: $subcats->{$item} = [];
1.655 raeburn 12876: }
12877: }
12878: }
12879: }
12880: }
12881: return;
12882: }
12883:
12884: =pod
12885:
12886: =item *&recurse_categories()
12887:
12888: Recursively used to generate breadcrumb trails for course categories.
12889:
12890: Inputs:
1.663 raeburn 12891:
1.655 raeburn 12892: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12893: categories and subcategories).
1.663 raeburn 12894:
1.655 raeburn 12895: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12896:
12897: category (current course category, for which breadcrumb trail is being generated).
12898:
12899: trails (reference to array of breadcrumb trails for each category).
12900:
1.655 raeburn 12901: allitems (reference to hash - key is category key
12902: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12903:
1.655 raeburn 12904: parents (array containing containers directories for current category,
12905: back to top level).
12906:
12907: Returns: nothing
12908:
12909: Side effects: populates trails and allitems hash references
12910:
12911: =cut
12912:
12913: sub recurse_categories {
1.665 raeburn 12914: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12915: my $shallower = $depth - 1;
12916: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12917: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12918: my $name = $cats->[$depth]{$category}[$k];
12919: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12920: my $trailstr = join(' -> ',(@{$parents},$category));
12921: if ($allitems->{$item} eq '') {
12922: push(@{$trails},$trailstr);
12923: $allitems->{$item} = scalar(@{$trails})-1;
12924: }
12925: my $deeper = $depth+1;
12926: push(@{$parents},$category);
1.665 raeburn 12927: if (ref($subcats) eq 'HASH') {
12928: my $subcat = &escape($name).':'.$category.':'.$depth;
12929: for (my $j=@{$parents}; $j>=0; $j--) {
12930: my $higher;
12931: if ($j > 0) {
12932: $higher = &escape($parents->[$j]).':'.
12933: &escape($parents->[$j-1]).':'.$j;
12934: } else {
12935: $higher = &escape($parents->[$j]).'::'.$j;
12936: }
12937: push(@{$subcats->{$higher}},$subcat);
12938: }
12939: }
12940: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12941: $subcats);
1.655 raeburn 12942: pop(@{$parents});
12943: }
12944: } else {
12945: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12946: my $trailstr = join(' -> ',(@{$parents},$category));
12947: if ($allitems->{$item} eq '') {
12948: push(@{$trails},$trailstr);
12949: $allitems->{$item} = scalar(@{$trails})-1;
12950: }
12951: }
12952: return;
12953: }
12954:
1.663 raeburn 12955: =pod
12956:
12957: =item *&assign_categories_table()
12958:
12959: Create a datatable for display of hierarchical categories in a domain,
12960: with checkboxes to allow a course to be categorized.
12961:
12962: Inputs:
12963:
12964: cathash - reference to hash of categories defined for the domain (from
12965: configuration.db)
12966:
12967: currcat - scalar with an & separated list of categories assigned to a course.
12968:
1.919 raeburn 12969: type - scalar contains course type (Course or Community).
12970:
1.663 raeburn 12971: Returns: $output (markup to be displayed)
12972:
12973: =cut
12974:
12975: sub assign_categories_table {
1.919 raeburn 12976: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12977: my $output;
12978: if (ref($cathash) eq 'HASH') {
12979: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12980: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12981: $maxdepth = scalar(@cats);
12982: if (@cats > 0) {
12983: my $itemcount = 0;
12984: if (ref($cats[0]) eq 'ARRAY') {
12985: my @currcategories;
12986: if ($currcat ne '') {
12987: @currcategories = split('&',$currcat);
12988: }
1.919 raeburn 12989: my $table;
1.663 raeburn 12990: for (my $i=0; $i<@{$cats[0]}; $i++) {
12991: my $parent = $cats[0][$i];
1.919 raeburn 12992: next if ($parent eq 'instcode');
12993: if ($type eq 'Community') {
12994: next unless ($parent eq 'communities');
12995: } else {
12996: next if ($parent eq 'communities');
12997: }
1.663 raeburn 12998: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12999: my $item = &escape($parent).'::0';
13000: my $checked = '';
13001: if (@currcategories > 0) {
13002: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 13003: $checked = ' checked="checked"';
1.663 raeburn 13004: }
13005: }
1.919 raeburn 13006: my $parent_title = $parent;
13007: if ($parent eq 'communities') {
13008: $parent_title = &mt('Communities');
13009: }
13010: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
13011: '<input type="checkbox" name="usecategory" value="'.
13012: $item.'"'.$checked.' />'.$parent_title.'</span>'.
13013: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13014: my $depth = 1;
13015: push(@path,$parent);
1.919 raeburn 13016: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13017: pop(@path);
1.919 raeburn 13018: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13019: $itemcount ++;
13020: }
1.919 raeburn 13021: if ($itemcount) {
13022: $output = &Apache::loncommon::start_data_table().
13023: $table.
13024: &Apache::loncommon::end_data_table();
13025: }
1.663 raeburn 13026: }
13027: }
13028: }
13029: return $output;
13030: }
13031:
13032: =pod
13033:
13034: =item *&assign_category_rows()
13035:
13036: Create a datatable row for display of nested categories in a domain,
13037: with checkboxes to allow a course to be categorized,called recursively.
13038:
13039: Inputs:
13040:
13041: itemcount - track row number for alternating colors
13042:
13043: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13044: categories and subcategories.
13045:
13046: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13047:
13048: parent - parent of current category item
13049:
13050: path - Array containing all categories back up through the hierarchy from the
13051: current category to the top level.
13052:
13053: currcategories - reference to array of current categories assigned to the course
13054:
13055: Returns: $output (markup to be displayed).
13056:
13057: =cut
13058:
13059: sub assign_category_rows {
13060: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13061: my ($text,$name,$item,$chgstr);
13062: if (ref($cats) eq 'ARRAY') {
13063: my $maxdepth = scalar(@{$cats});
13064: if (ref($cats->[$depth]) eq 'HASH') {
13065: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13066: my $numchildren = @{$cats->[$depth]{$parent}};
13067: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13068: $text .= '<td><table class="LC_datatable">';
13069: for (my $j=0; $j<$numchildren; $j++) {
13070: $name = $cats->[$depth]{$parent}[$j];
13071: $item = &escape($name).':'.&escape($parent).':'.$depth;
13072: my $deeper = $depth+1;
13073: my $checked = '';
13074: if (ref($currcategories) eq 'ARRAY') {
13075: if (@{$currcategories} > 0) {
13076: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13077: $checked = ' checked="checked"';
1.663 raeburn 13078: }
13079: }
13080: }
1.664 raeburn 13081: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13082: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13083: $item.'"'.$checked.' />'.$name.'</label></span>'.
13084: '<input type="hidden" name="catname" value="'.$name.'" />'.
13085: '</td><td>';
1.663 raeburn 13086: if (ref($path) eq 'ARRAY') {
13087: push(@{$path},$name);
13088: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13089: pop(@{$path});
13090: }
13091: $text .= '</td></tr>';
13092: }
13093: $text .= '</table></td>';
13094: }
13095: }
13096: }
13097: return $text;
13098: }
13099:
1.655 raeburn 13100: ############################################################
13101: ############################################################
13102:
13103:
1.443 albertel 13104: sub commit_customrole {
1.664 raeburn 13105: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13106: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13107: ($start?', '.&mt('starting').' '.localtime($start):'').
13108: ($end?', ending '.localtime($end):'').': <b>'.
13109: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13110: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13111: '</b><br />';
13112: return $output;
13113: }
13114:
13115: sub commit_standardrole {
1.541 raeburn 13116: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
13117: my ($output,$logmsg,$linefeed);
13118: if ($context eq 'auto') {
13119: $linefeed = "\n";
13120: } else {
13121: $linefeed = "<br />\n";
13122: }
1.443 albertel 13123: if ($three eq 'st') {
1.541 raeburn 13124: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
13125: $one,$two,$sec,$context);
13126: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13127: ($result eq 'unknown_course') || ($result eq 'refused')) {
13128: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13129: } else {
1.541 raeburn 13130: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13131: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13132: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13133: if ($context eq 'auto') {
13134: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13135: } else {
13136: $output .= '<b>'.$result.'</b>'.$linefeed.
13137: &mt('Add to classlist').': <b>ok</b>';
13138: }
13139: $output .= $linefeed;
1.443 albertel 13140: }
13141: } else {
13142: $output = &mt('Assigning').' '.$three.' in '.$url.
13143: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13144: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13145: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13146: if ($context eq 'auto') {
13147: $output .= $result.$linefeed;
13148: } else {
13149: $output .= '<b>'.$result.'</b>'.$linefeed;
13150: }
1.443 albertel 13151: }
13152: return $output;
13153: }
13154:
13155: sub commit_studentrole {
1.541 raeburn 13156: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 13157: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13158: if ($context eq 'auto') {
13159: $linefeed = "\n";
13160: } else {
13161: $linefeed = '<br />'."\n";
13162: }
1.443 albertel 13163: if (defined($one) && defined($two)) {
13164: my $cid=$one.'_'.$two;
13165: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13166: my $secchange = 0;
13167: my $expire_role_result;
13168: my $modify_section_result;
1.628 raeburn 13169: if ($oldsec ne '-1') {
13170: if ($oldsec ne $sec) {
1.443 albertel 13171: $secchange = 1;
1.628 raeburn 13172: my $now = time;
1.443 albertel 13173: my $uurl='/'.$cid;
13174: $uurl=~s/\_/\//g;
13175: if ($oldsec) {
13176: $uurl.='/'.$oldsec;
13177: }
1.626 raeburn 13178: $oldsecurl = $uurl;
1.628 raeburn 13179: $expire_role_result =
1.652 raeburn 13180: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13181: if ($env{'request.course.sec'} ne '') {
13182: if ($expire_role_result eq 'refused') {
13183: my @roles = ('st');
13184: my @statuses = ('previous');
13185: my @roledoms = ($one);
13186: my $withsec = 1;
13187: my %roleshash =
13188: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13189: \@statuses,\@roles,\@roledoms,$withsec);
13190: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13191: my ($oldstart,$oldend) =
13192: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13193: if ($oldend > 0 && $oldend <= $now) {
13194: $expire_role_result = 'ok';
13195: }
13196: }
13197: }
13198: }
1.443 albertel 13199: $result = $expire_role_result;
13200: }
13201: }
13202: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13203: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13204: if ($modify_section_result =~ /^ok/) {
13205: if ($secchange == 1) {
1.628 raeburn 13206: if ($sec eq '') {
13207: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13208: } else {
13209: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13210: }
1.443 albertel 13211: } elsif ($oldsec eq '-1') {
1.628 raeburn 13212: if ($sec eq '') {
13213: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13214: } else {
13215: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13216: }
1.443 albertel 13217: } else {
1.628 raeburn 13218: if ($sec eq '') {
13219: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13220: } else {
13221: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13222: }
1.443 albertel 13223: }
13224: } else {
1.628 raeburn 13225: if ($secchange) {
13226: $$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;
13227: } else {
13228: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13229: }
1.443 albertel 13230: }
13231: $result = $modify_section_result;
13232: } elsif ($secchange == 1) {
1.628 raeburn 13233: if ($oldsec eq '') {
13234: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13235: } else {
13236: $$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;
13237: }
1.626 raeburn 13238: if ($expire_role_result eq 'refused') {
13239: my $newsecurl = '/'.$cid;
13240: $newsecurl =~ s/\_/\//g;
13241: if ($sec ne '') {
13242: $newsecurl.='/'.$sec;
13243: }
13244: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13245: if ($sec eq '') {
13246: $$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;
13247: } else {
13248: $$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;
13249: }
13250: }
13251: }
1.443 albertel 13252: }
13253: } else {
1.626 raeburn 13254: $$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 13255: $result = "error: incomplete course id\n";
13256: }
13257: return $result;
13258: }
13259:
13260: ############################################################
13261: ############################################################
13262:
1.566 albertel 13263: sub check_clone {
1.578 raeburn 13264: my ($args,$linefeed) = @_;
1.566 albertel 13265: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13266: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13267: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13268: my $clonemsg;
13269: my $can_clone = 0;
1.944 raeburn 13270: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13271: if ($lctype ne 'community') {
13272: $lctype = 'course';
13273: }
1.566 albertel 13274: if ($clonehome eq 'no_host') {
1.944 raeburn 13275: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13276: $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'});
13277: } else {
13278: $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'});
13279: }
1.566 albertel 13280: } else {
13281: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13282: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13283: if ($clonedesc{'type'} ne 'Community') {
13284: $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'});
13285: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13286: }
13287: }
1.882 raeburn 13288: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13289: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13290: $can_clone = 1;
13291: } else {
13292: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13293: $args->{'clonedomain'},$args->{'clonecourse'});
13294: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13295: if (grep(/^\*$/,@cloners)) {
13296: $can_clone = 1;
13297: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13298: $can_clone = 1;
13299: } else {
1.908 raeburn 13300: my $ccrole = 'cc';
1.944 raeburn 13301: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13302: $ccrole = 'co';
13303: }
1.578 raeburn 13304: my %roleshash =
13305: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13306: $args->{'ccdomain'},
1.908 raeburn 13307: 'userroles',['active'],[$ccrole],
1.578 raeburn 13308: [$args->{'clonedomain'}]);
1.908 raeburn 13309: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13310: $can_clone = 1;
13311: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13312: $can_clone = 1;
13313: } else {
1.944 raeburn 13314: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13315: $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'});
13316: } else {
13317: $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'});
13318: }
1.578 raeburn 13319: }
1.566 albertel 13320: }
1.578 raeburn 13321: }
1.566 albertel 13322: }
13323: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13324: }
13325:
1.444 albertel 13326: sub construct_course {
1.885 raeburn 13327: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13328: my $outcome;
1.541 raeburn 13329: my $linefeed = '<br />'."\n";
13330: if ($context eq 'auto') {
13331: $linefeed = "\n";
13332: }
1.566 albertel 13333:
13334: #
13335: # Are we cloning?
13336: #
13337: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13338: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13339: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13340: if ($context ne 'auto') {
1.578 raeburn 13341: if ($clonemsg ne '') {
13342: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13343: }
1.566 albertel 13344: }
13345: $outcome .= $clonemsg.$linefeed;
13346:
13347: if (!$can_clone) {
13348: return (0,$outcome);
13349: }
13350: }
13351:
1.444 albertel 13352: #
13353: # Open course
13354: #
13355: my $crstype = lc($args->{'crstype'});
13356: my %cenv=();
13357: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13358: $args->{'cdescr'},
13359: $args->{'curl'},
13360: $args->{'course_home'},
13361: $args->{'nonstandard'},
13362: $args->{'crscode'},
13363: $args->{'ccuname'}.':'.
13364: $args->{'ccdomain'},
1.882 raeburn 13365: $args->{'crstype'},
1.885 raeburn 13366: $cnum,$context,$category);
1.444 albertel 13367:
13368: # Note: The testing routines depend on this being output; see
13369: # Utils::Course. This needs to at least be output as a comment
13370: # if anyone ever decides to not show this, and Utils::Course::new
13371: # will need to be suitably modified.
1.541 raeburn 13372: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13373: if ($$courseid =~ /^error:/) {
13374: return (0,$outcome);
13375: }
13376:
1.444 albertel 13377: #
13378: # Check if created correctly
13379: #
1.479 albertel 13380: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13381: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13382: if ($crsuhome eq 'no_host') {
13383: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13384: return (0,$outcome);
13385: }
1.541 raeburn 13386: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13387:
1.444 albertel 13388: #
1.566 albertel 13389: # Do the cloning
13390: #
13391: if ($can_clone && $cloneid) {
13392: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13393: if ($context ne 'auto') {
13394: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13395: }
13396: $outcome .= $clonemsg.$linefeed;
13397: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13398: # Copy all files
1.637 www 13399: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13400: # Restore URL
1.566 albertel 13401: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13402: # Restore title
1.566 albertel 13403: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13404: # Restore creation date, creator and creation context.
13405: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13406: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13407: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13408: # Mark as cloned
1.566 albertel 13409: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13410: # Need to clone grading mode
13411: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13412: $cenv{'grading'}=$newenv{'grading'};
13413: # Do not clone these environment entries
13414: &Apache::lonnet::del('environment',
13415: ['default_enrollment_start_date',
13416: 'default_enrollment_end_date',
13417: 'question.email',
13418: 'policy.email',
13419: 'comment.email',
13420: 'pch.users.denied',
1.725 raeburn 13421: 'plc.users.denied',
13422: 'hidefromcat',
13423: 'categories'],
1.638 www 13424: $$crsudom,$$crsunum);
1.444 albertel 13425: }
1.566 albertel 13426:
1.444 albertel 13427: #
13428: # Set environment (will override cloned, if existing)
13429: #
13430: my @sections = ();
13431: my @xlists = ();
13432: if ($args->{'crstype'}) {
13433: $cenv{'type'}=$args->{'crstype'};
13434: }
13435: if ($args->{'crsid'}) {
13436: $cenv{'courseid'}=$args->{'crsid'};
13437: }
13438: if ($args->{'crscode'}) {
13439: $cenv{'internal.coursecode'}=$args->{'crscode'};
13440: }
13441: if ($args->{'crsquota'} ne '') {
13442: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13443: } else {
13444: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13445: }
13446: if ($args->{'ccuname'}) {
13447: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13448: ':'.$args->{'ccdomain'};
13449: } else {
13450: $cenv{'internal.courseowner'} = $args->{'curruser'};
13451: }
13452: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13453: if ($args->{'crssections'}) {
13454: $cenv{'internal.sectionnums'} = '';
13455: if ($args->{'crssections'} =~ m/,/) {
13456: @sections = split/,/,$args->{'crssections'};
13457: } else {
13458: $sections[0] = $args->{'crssections'};
13459: }
13460: if (@sections > 0) {
13461: foreach my $item (@sections) {
13462: my ($sec,$gp) = split/:/,$item;
13463: my $class = $args->{'crscode'}.$sec;
13464: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13465: $cenv{'internal.sectionnums'} .= $item.',';
13466: unless ($addcheck eq 'ok') {
13467: push @badclasses, $class;
13468: }
13469: }
13470: $cenv{'internal.sectionnums'} =~ s/,$//;
13471: }
13472: }
13473: # do not hide course coordinator from staff listing,
13474: # even if privileged
13475: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13476: # add crosslistings
13477: if ($args->{'crsxlist'}) {
13478: $cenv{'internal.crosslistings'}='';
13479: if ($args->{'crsxlist'} =~ m/,/) {
13480: @xlists = split/,/,$args->{'crsxlist'};
13481: } else {
13482: $xlists[0] = $args->{'crsxlist'};
13483: }
13484: if (@xlists > 0) {
13485: foreach my $item (@xlists) {
13486: my ($xl,$gp) = split/:/,$item;
13487: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13488: $cenv{'internal.crosslistings'} .= $item.',';
13489: unless ($addcheck eq 'ok') {
13490: push @badclasses, $xl;
13491: }
13492: }
13493: $cenv{'internal.crosslistings'} =~ s/,$//;
13494: }
13495: }
13496: if ($args->{'autoadds'}) {
13497: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13498: }
13499: if ($args->{'autodrops'}) {
13500: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13501: }
13502: # check for notification of enrollment changes
13503: my @notified = ();
13504: if ($args->{'notify_owner'}) {
13505: if ($args->{'ccuname'} ne '') {
13506: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13507: }
13508: }
13509: if ($args->{'notify_dc'}) {
13510: if ($uname ne '') {
1.630 raeburn 13511: push(@notified,$uname.':'.$udom);
1.444 albertel 13512: }
13513: }
13514: if (@notified > 0) {
13515: my $notifylist;
13516: if (@notified > 1) {
13517: $notifylist = join(',',@notified);
13518: } else {
13519: $notifylist = $notified[0];
13520: }
13521: $cenv{'internal.notifylist'} = $notifylist;
13522: }
13523: if (@badclasses > 0) {
13524: my %lt=&Apache::lonlocal::texthash(
13525: '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',
13526: 'dnhr' => 'does not have rights to access enrollment in these classes',
13527: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13528: );
1.541 raeburn 13529: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13530: ' ('.$lt{'adby'}.')';
13531: if ($context eq 'auto') {
13532: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13533: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13534: foreach my $item (@badclasses) {
13535: if ($context eq 'auto') {
13536: $outcome .= " - $item\n";
13537: } else {
13538: $outcome .= "<li>$item</li>\n";
13539: }
13540: }
13541: if ($context eq 'auto') {
13542: $outcome .= $linefeed;
13543: } else {
1.566 albertel 13544: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13545: }
13546: }
1.444 albertel 13547: }
13548: if ($args->{'no_end_date'}) {
13549: $args->{'endaccess'} = 0;
13550: }
13551: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13552: $cenv{'internal.autoend'}=$args->{'enrollend'};
13553: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13554: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13555: if ($args->{'showphotos'}) {
13556: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13557: }
13558: $cenv{'internal.authtype'} = $args->{'authtype'};
13559: $cenv{'internal.autharg'} = $args->{'autharg'};
13560: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13561: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13562: 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');
13563: if ($context eq 'auto') {
13564: $outcome .= $krb_msg;
13565: } else {
1.566 albertel 13566: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13567: }
13568: $outcome .= $linefeed;
1.444 albertel 13569: }
13570: }
13571: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13572: if ($args->{'setpolicy'}) {
13573: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13574: }
13575: if ($args->{'setcontent'}) {
13576: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13577: }
13578: }
13579: if ($args->{'reshome'}) {
13580: $cenv{'reshome'}=$args->{'reshome'}.'/';
13581: $cenv{'reshome'}=~s/\/+$/\//;
13582: }
13583: #
13584: # course has keyed access
13585: #
13586: if ($args->{'setkeys'}) {
13587: $cenv{'keyaccess'}='yes';
13588: }
13589: # if specified, key authority is not course, but user
13590: # only active if keyaccess is yes
13591: if ($args->{'keyauth'}) {
1.487 albertel 13592: my ($user,$domain) = split(':',$args->{'keyauth'});
13593: $user = &LONCAPA::clean_username($user);
13594: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13595: if ($user ne '' && $domain ne '') {
1.487 albertel 13596: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13597: }
13598: }
13599:
13600: if ($args->{'disresdis'}) {
13601: $cenv{'pch.roles.denied'}='st';
13602: }
13603: if ($args->{'disablechat'}) {
13604: $cenv{'plc.roles.denied'}='st';
13605: }
13606:
13607: # Record we've not yet viewed the Course Initialization Helper for this
13608: # course
13609: $cenv{'course.helper.not.run'} = 1;
13610: #
13611: # Use new Randomseed
13612: #
13613: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13614: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13615: #
13616: # The encryption code and receipt prefix for this course
13617: #
13618: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13619: $cenv{'internal.encpref'}=100+int(9*rand(99));
13620: #
13621: # By default, use standard grading
13622: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13623:
1.541 raeburn 13624: $outcome .= $linefeed.&mt('Setting environment').': '.
13625: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13626: #
13627: # Open all assignments
13628: #
13629: if ($args->{'openall'}) {
13630: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13631: my %storecontent = ($storeunder => time,
13632: $storeunder.'.type' => 'date_start');
13633:
13634: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13635: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13636: }
13637: #
13638: # Set first page
13639: #
13640: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13641: || ($cloneid)) {
1.445 albertel 13642: use LONCAPA::map;
1.444 albertel 13643: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13644:
13645: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13646: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13647:
1.444 albertel 13648: $outcome .= ($fatal?$errtext:'read ok').' - ';
13649: my $title; my $url;
13650: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13651: $title=&mt('Syllabus');
1.444 albertel 13652: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13653: } else {
1.963 raeburn 13654: $title=&mt('Table of Contents');
1.444 albertel 13655: $url='/adm/navmaps';
13656: }
1.445 albertel 13657:
13658: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13659: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13660:
13661: if ($errtext) { $fatal=2; }
1.541 raeburn 13662: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13663: }
1.566 albertel 13664:
13665: return (1,$outcome);
1.444 albertel 13666: }
13667:
13668: ############################################################
13669: ############################################################
13670:
1.953 droeschl 13671: #SD
13672: # only Community and Course, or anything else?
1.378 raeburn 13673: sub course_type {
13674: my ($cid) = @_;
13675: if (!defined($cid)) {
13676: $cid = $env{'request.course.id'};
13677: }
1.404 albertel 13678: if (defined($env{'course.'.$cid.'.type'})) {
13679: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13680: } else {
13681: return 'Course';
1.377 raeburn 13682: }
13683: }
1.156 albertel 13684:
1.406 raeburn 13685: sub group_term {
13686: my $crstype = &course_type();
13687: my %names = (
13688: 'Course' => 'group',
1.865 raeburn 13689: 'Community' => 'group',
1.406 raeburn 13690: );
13691: return $names{$crstype};
13692: }
13693:
1.902 raeburn 13694: sub course_types {
13695: my @types = ('official','unofficial','community');
13696: my %typename = (
13697: official => 'Official course',
13698: unofficial => 'Unofficial course',
13699: community => 'Community',
13700: );
13701: return (\@types,\%typename);
13702: }
13703:
1.156 albertel 13704: sub icon {
13705: my ($file)=@_;
1.505 albertel 13706: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13707: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13708: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13709: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13710: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13711: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13712: $curfext.".gif") {
13713: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13714: $curfext.".gif";
13715: }
13716: }
1.249 albertel 13717: return &lonhttpdurl($iconname);
1.154 albertel 13718: }
1.84 albertel 13719:
1.575 albertel 13720: sub lonhttpdurl {
1.692 www 13721: #
13722: # Had been used for "small fry" static images on separate port 8080.
13723: # Modify here if lightweight http functionality desired again.
13724: # Currently eliminated due to increasing firewall issues.
13725: #
1.575 albertel 13726: my ($url)=@_;
1.692 www 13727: return $url;
1.215 albertel 13728: }
13729:
1.213 albertel 13730: sub connection_aborted {
13731: my ($r)=@_;
13732: $r->print(" ");$r->rflush();
13733: my $c = $r->connection;
13734: return $c->aborted();
13735: }
13736:
1.221 foxr 13737: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13738: # strings as 'strings'.
13739: sub escape_single {
1.221 foxr 13740: my ($input) = @_;
1.223 albertel 13741: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13742: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13743: return $input;
13744: }
1.223 albertel 13745:
1.222 foxr 13746: # Same as escape_single, but escape's "'s This
13747: # can be used for "strings"
13748: sub escape_double {
13749: my ($input) = @_;
13750: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13751: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13752: return $input;
13753: }
1.223 albertel 13754:
1.222 foxr 13755: # Escapes the last element of a full URL.
13756: sub escape_url {
13757: my ($url) = @_;
1.238 raeburn 13758: my @urlslices = split(/\//, $url,-1);
1.369 www 13759: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13760: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13761: }
1.462 albertel 13762:
1.820 raeburn 13763: sub compare_arrays {
13764: my ($arrayref1,$arrayref2) = @_;
13765: my (@difference,%count);
13766: @difference = ();
13767: %count = ();
13768: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13769: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13770: foreach my $element (keys(%count)) {
13771: if ($count{$element} == 1) {
13772: push(@difference,$element);
13773: }
13774: }
13775: }
13776: return @difference;
13777: }
13778:
1.817 bisitz 13779: # -------------------------------------------------------- Initialize user login
1.462 albertel 13780: sub init_user_environment {
1.463 albertel 13781: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13782: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13783:
13784: my $public=($username eq 'public' && $domain eq 'public');
13785:
13786: # See if old ID present, if so, remove
13787:
1.1062 raeburn 13788: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13789: my $now=time;
13790:
13791: if ($public) {
13792: my $max_public=100;
13793: my $oldest;
13794: my $oldest_time=0;
13795: for(my $next=1;$next<=$max_public;$next++) {
13796: if (-e $lonids."/publicuser_$next.id") {
13797: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13798: if ($mtime<$oldest_time || !$oldest_time) {
13799: $oldest_time=$mtime;
13800: $oldest=$next;
13801: }
13802: } else {
13803: $cookie="publicuser_$next";
13804: last;
13805: }
13806: }
13807: if (!$cookie) { $cookie="publicuser_$oldest"; }
13808: } else {
1.463 albertel 13809: # if this isn't a robot, kill any existing non-robot sessions
13810: if (!$args->{'robot'}) {
13811: opendir(DIR,$lonids);
13812: while ($filename=readdir(DIR)) {
13813: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13814: unlink($lonids.'/'.$filename);
13815: }
1.462 albertel 13816: }
1.463 albertel 13817: closedir(DIR);
1.462 albertel 13818: }
13819: # Give them a new cookie
1.463 albertel 13820: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13821: : $now.$$.int(rand(10000)));
1.463 albertel 13822: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13823:
13824: # Initialize roles
13825:
1.1062 raeburn 13826: ($userroles,$firstaccenv,$timerintenv) =
13827: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13828: }
13829: # ------------------------------------ Check browser type and MathML capability
13830:
13831: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13832: $clientunicode,$clientos) = &decode_user_agent($r);
13833:
13834: # ------------------------------------------------------------- Get environment
13835:
13836: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13837: my ($tmp) = keys(%userenv);
13838: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13839: } else {
13840: undef(%userenv);
13841: }
13842: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13843: $form->{'interface'}=$userenv{'interface'};
13844: }
13845: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13846:
13847: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13848: foreach my $option ('interface','localpath','localres') {
13849: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13850: }
13851: # --------------------------------------------------------- Write first profile
13852:
13853: {
13854: my %initial_env =
13855: ("user.name" => $username,
13856: "user.domain" => $domain,
13857: "user.home" => $authhost,
13858: "browser.type" => $clientbrowser,
13859: "browser.version" => $clientversion,
13860: "browser.mathml" => $clientmathml,
13861: "browser.unicode" => $clientunicode,
13862: "browser.os" => $clientos,
13863: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13864: "request.course.fn" => '',
13865: "request.course.uri" => '',
13866: "request.course.sec" => '',
13867: "request.role" => 'cm',
13868: "request.role.adv" => $env{'user.adv'},
13869: "request.host" => $ENV{'REMOTE_ADDR'},);
13870:
13871: if ($form->{'localpath'}) {
13872: $initial_env{"browser.localpath"} = $form->{'localpath'};
13873: $initial_env{"browser.localres"} = $form->{'localres'};
13874: }
13875:
13876: if ($form->{'interface'}) {
13877: $form->{'interface'}=~s/\W//gs;
13878: $initial_env{"browser.interface"} = $form->{'interface'};
13879: $env{'browser.interface'}=$form->{'interface'};
13880: }
13881:
1.981 raeburn 13882: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13883: my %domdef;
13884: unless ($domain eq 'public') {
13885: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13886: }
1.980 raeburn 13887:
1.1081 raeburn 13888: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 13889: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13890: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13891: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13892: }
13893:
1.864 raeburn 13894: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13895: $userenv{'canrequest.'.$crstype} =
13896: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13897: 'reload','requestcourses',
13898: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13899: }
13900:
1.1092 raeburn 13901: $userenv{'canrequest.author'} =
13902: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
13903: 'reload','requestauthor',
13904: \%userenv,\%domdef,\%is_adv);
13905: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
13906: $domain,$username);
13907: my $reqstatus = $reqauthor{'author_status'};
13908: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
13909: if (ref($reqauthor{'author'}) eq 'HASH') {
13910: $userenv{'requestauthorqueued'} = $reqstatus.':'.
13911: $reqauthor{'author'}{'timestamp'};
13912: }
13913: }
13914:
1.462 albertel 13915: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13916:
1.462 albertel 13917: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13918: &GDBM_WRCREAT(),0640)) {
13919: &_add_to_env(\%disk_env,\%initial_env);
13920: &_add_to_env(\%disk_env,\%userenv,'environment.');
13921: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13922: if (ref($firstaccenv) eq 'HASH') {
13923: &_add_to_env(\%disk_env,$firstaccenv);
13924: }
13925: if (ref($timerintenv) eq 'HASH') {
13926: &_add_to_env(\%disk_env,$timerintenv);
13927: }
1.463 albertel 13928: if (ref($args->{'extra_env'})) {
13929: &_add_to_env(\%disk_env,$args->{'extra_env'});
13930: }
1.462 albertel 13931: untie(%disk_env);
13932: } else {
1.705 tempelho 13933: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13934: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13935: return 'error: '.$!;
13936: }
13937: }
13938: $env{'request.role'}='cm';
13939: $env{'request.role.adv'}=$env{'user.adv'};
13940: $env{'browser.type'}=$clientbrowser;
13941:
13942: return $cookie;
13943:
13944: }
13945:
13946: sub _add_to_env {
13947: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13948: if (ref($env_data) eq 'HASH') {
13949: while (my ($key,$value) = each(%$env_data)) {
13950: $idf->{$prefix.$key} = $value;
13951: $env{$prefix.$key} = $value;
13952: }
1.462 albertel 13953: }
13954: }
13955:
1.685 tempelho 13956: # --- Get the symbolic name of a problem and the url
13957: sub get_symb {
13958: my ($request,$silent) = @_;
1.726 raeburn 13959: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13960: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13961: if ($symb eq '') {
13962: if (!$silent) {
1.1071 raeburn 13963: if (ref($request)) {
13964: $request->print("Unable to handle ambiguous references:$url:.");
13965: }
1.685 tempelho 13966: return ();
13967: }
13968: }
13969: &Apache::lonenc::check_decrypt(\$symb);
13970: return ($symb);
13971: }
13972:
13973: # --------------------------------------------------------------Get annotation
13974:
13975: sub get_annotation {
13976: my ($symb,$enc) = @_;
13977:
13978: my $key = $symb;
13979: if (!$enc) {
13980: $key =
13981: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13982: }
13983: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13984: return $annotation{$key};
13985: }
13986:
13987: sub clean_symb {
1.731 raeburn 13988: my ($symb,$delete_enc) = @_;
1.685 tempelho 13989:
13990: &Apache::lonenc::check_decrypt(\$symb);
13991: my $enc = $env{'request.enc'};
1.731 raeburn 13992: if ($delete_enc) {
1.730 raeburn 13993: delete($env{'request.enc'});
13994: }
1.685 tempelho 13995:
13996: return ($symb,$enc);
13997: }
1.462 albertel 13998:
1.990 raeburn 13999: sub build_release_hashes {
14000: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
14001: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
14002: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
14003: (ref($randomizetry) eq 'HASH'));
14004: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14005: my ($item,$name,$value) = split(/:/,$key);
14006: if ($item eq 'parameter') {
14007: if (ref($checkparms->{$name}) eq 'ARRAY') {
14008: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
14009: push(@{$checkparms->{$name}},$value);
14010: }
14011: } else {
14012: push(@{$checkparms->{$name}},$value);
14013: }
14014: } elsif ($item eq 'resourcetag') {
14015: if ($name eq 'responsetype') {
14016: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
14017: }
14018: } elsif ($item eq 'course') {
14019: if ($name eq 'crstype') {
14020: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
14021: }
14022: }
14023: }
14024: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
14025: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
14026: return;
14027: }
14028:
1.1083 raeburn 14029: sub update_content_constraints {
14030: my ($cdom,$cnum,$chome,$cid) = @_;
14031: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14032: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14033: my %checkresponsetypes;
14034: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14035: my ($item,$name,$value) = split(/:/,$key);
14036: if ($item eq 'resourcetag') {
14037: if ($name eq 'responsetype') {
14038: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14039: }
14040: }
14041: }
14042: my $navmap = Apache::lonnavmaps::navmap->new();
14043: if (defined($navmap)) {
14044: my %allresponses;
14045: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14046: my %responses = $res->responseTypes();
14047: foreach my $key (keys(%responses)) {
14048: next unless(exists($checkresponsetypes{$key}));
14049: $allresponses{$key} += $responses{$key};
14050: }
14051: }
14052: foreach my $key (keys(%allresponses)) {
14053: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14054: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14055: ($reqdmajor,$reqdminor) = ($major,$minor);
14056: }
14057: }
14058: undef($navmap);
14059: }
14060: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14061: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14062: }
14063: return;
14064: }
14065:
14066: sub parse_supplemental_title {
14067: my ($title) = @_;
14068:
14069: my ($foldertitle,$renametitle);
14070: if ($title =~ /&&&/) {
14071: $title = &HTML::Entites::decode($title);
14072: }
14073: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14074: $renametitle=$4;
14075: my ($time,$uname,$udom) = ($1,$2,$3);
14076: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14077: my $name = &plainname($uname,$udom);
14078: $name = &HTML::Entities::encode($name,'"<>&\'');
14079: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14080: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14081: $name.': <br />'.$foldertitle;
14082: }
14083: if (wantarray) {
14084: return ($title,$foldertitle,$renametitle);
14085: }
14086: return $title;
14087: }
14088:
1.1094 raeburn 14089: sub captcha_display {
14090: my ($context,$lonhost) = @_;
14091: my ($output,$error);
14092: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14093: if ($captcha eq 'original') {
1.1094 raeburn 14094: $output = &create_captcha();
14095: unless ($output) {
14096: $error = 'captcha';
14097: }
14098: } elsif ($captcha eq 'recaptcha') {
14099: $output = &create_recaptcha($pubkey);
14100: unless ($output) {
1.1095 raeburn 14101: $error = 'recaptcha';
1.1094 raeburn 14102: }
14103: }
14104: return ($output,$error);
14105: }
14106:
14107: sub captcha_response {
14108: my ($context,$lonhost) = @_;
14109: my ($captcha_chk,$captcha_error);
14110: my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 14111: if ($captcha eq 'original') {
1.1094 raeburn 14112: ($captcha_chk,$captcha_error) = &check_captcha();
14113: } elsif ($captcha eq 'recaptcha') {
14114: $captcha_chk = &check_recaptcha($privkey);
14115: } else {
14116: $captcha_chk = 1;
14117: }
14118: return ($captcha_chk,$captcha_error);
14119: }
14120:
14121: sub get_captcha_config {
14122: my ($context,$lonhost) = @_;
1.1095 raeburn 14123: my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094 raeburn 14124: my $hostname = &Apache::lonnet::hostname($lonhost);
14125: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
14126: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 14127: if ($context eq 'usercreation') {
14128: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
14129: if (ref($domconfig{$context}) eq 'HASH') {
14130: $hashtocheck = $domconfig{$context}{'cancreate'};
14131: if (ref($hashtocheck) eq 'HASH') {
14132: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
14133: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
14134: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
14135: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
14136: }
14137: if ($privkey && $pubkey) {
14138: $captcha = 'recaptcha';
14139: } else {
14140: $captcha = 'original';
14141: }
14142: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
14143: $captcha = 'original';
14144: }
1.1094 raeburn 14145: }
1.1095 raeburn 14146: } else {
14147: $captcha = 'captcha';
14148: }
14149: } elsif ($context eq 'login') {
14150: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
14151: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
14152: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
14153: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 14154: if ($privkey && $pubkey) {
14155: $captcha = 'recaptcha';
1.1095 raeburn 14156: } else {
14157: $captcha = 'original';
1.1094 raeburn 14158: }
1.1095 raeburn 14159: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
14160: $captcha = 'original';
1.1094 raeburn 14161: }
14162: }
14163: return ($captcha,$pubkey,$privkey);
14164: }
14165:
14166: sub create_captcha {
14167: my %captcha_params = &captcha_settings();
14168: my ($output,$maxtries,$tries) = ('',10,0);
14169: while ($tries < $maxtries) {
14170: $tries ++;
14171: my $captcha = Authen::Captcha->new (
14172: output_folder => $captcha_params{'output_dir'},
14173: data_folder => $captcha_params{'db_dir'},
14174: );
14175: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
14176:
14177: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
14178: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
14179: &mt('Type in the letters/numbers shown below').' '.
14180: '<input type="text" size="5" name="code" value="" /><br />'.
14181: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
14182: last;
14183: }
14184: }
14185: return $output;
14186: }
14187:
14188: sub captcha_settings {
14189: my %captcha_params = (
14190: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
14191: www_output_dir => "/captchaspool",
14192: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
14193: numchars => '5',
14194: );
14195: return %captcha_params;
14196: }
14197:
14198: sub check_captcha {
14199: my ($captcha_chk,$captcha_error);
14200: my $code = $env{'form.code'};
14201: my $md5sum = $env{'form.crypt'};
14202: my %captcha_params = &captcha_settings();
14203: my $captcha = Authen::Captcha->new(
14204: output_folder => $captcha_params{'output_dir'},
14205: data_folder => $captcha_params{'db_dir'},
14206: );
14207: my $captcha_chk = $captcha->check_code($code,$md5sum);
14208: my %captcha_hash = (
14209: 0 => 'Code not checked (file error)',
14210: -1 => 'Failed: code expired',
14211: -2 => 'Failed: invalid code (not in database)',
14212: -3 => 'Failed: invalid code (code does not match crypt)',
14213: );
14214: if ($captcha_chk != 1) {
14215: $captcha_error = $captcha_hash{$captcha_chk}
14216: }
14217: return ($captcha_chk,$captcha_error);
14218: }
14219:
14220: sub create_recaptcha {
14221: my ($pubkey) = @_;
14222: my $captcha = Captcha::reCAPTCHA->new;
14223: return $captcha->get_options_setter({theme => 'white'})."\n".
14224: $captcha->get_html($pubkey).
14225: &mt('If either word is hard to read, [_1] will replace them.',
14226: '<image src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
14227: '<br /><br />';
14228: }
14229:
14230: sub check_recaptcha {
14231: my ($privkey) = @_;
14232: my $captcha_chk;
14233: my $captcha = Captcha::reCAPTCHA->new;
14234: my $captcha_result =
14235: $captcha->check_answer(
14236: $privkey,
14237: $ENV{'REMOTE_ADDR'},
14238: $env{'form.recaptcha_challenge_field'},
14239: $env{'form.recaptcha_response_field'},
14240: );
14241: if ($captcha_result->{is_valid}) {
14242: $captcha_chk = 1;
14243: }
14244: return $captcha_chk;
14245: }
14246:
1.41 ng 14247: =pod
14248:
14249: =back
14250:
1.112 bowersj2 14251: =cut
1.41 ng 14252:
1.112 bowersj2 14253: 1;
14254: __END__;
1.41 ng 14255:
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