Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.13
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1075.2.13! raeburn 4: # $Id: loncommon.pm,v 1.1075.2.12 2012/08/03 17:35:32 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.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.1048 foxr 157: my %latex_language; # For choosing hyphenation in <transl..>
158: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 159: my %cprtag;
1.192 taceyjo1 160: my %scprtag;
1.351 www 161: my %fe; my %fd; my %fm;
1.41 ng 162: my %category_extensions;
1.12 harris41 163:
1.46 matthew 164: # ---------------------------------------------- Thesaurus variables
1.144 matthew 165: #
166: # %Keywords:
167: # A hash used by &keyword to determine if a word is considered a keyword.
168: # $thesaurus_db_file
169: # Scalar containing the full path to the thesaurus database.
1.46 matthew 170:
171: my %Keywords;
172: my $thesaurus_db_file;
173:
1.144 matthew 174: #
175: # Initialize values from language.tab, copyright.tab, filetypes.tab,
176: # thesaurus.tab, and filecategories.tab.
177: #
1.18 www 178: BEGIN {
1.46 matthew 179: # Variable initialization
180: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
181: #
1.22 www 182: unless ($readit) {
1.12 harris41 183: # ------------------------------------------------------------------- languages
184: {
1.158 raeburn 185: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
186: '/language.tab';
187: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 188: while (my $line = <$fh>) {
189: next if ($line=~/^\#/);
190: chomp($line);
1.1048 foxr 191: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 192: $language{$key}=$val.' - '.$enc;
193: if ($sup) {
194: $supported_language{$key}=$sup;
195: }
1.1048 foxr 196: if ($latex) {
197: $latex_language_bykey{$key} = $latex;
198: $latex_language{$two} = $latex;
199: }
1.158 raeburn 200: }
201: close($fh);
202: }
1.12 harris41 203: }
204: # ------------------------------------------------------------------ copyrights
205: {
1.158 raeburn 206: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
207: '/copyright.tab';
208: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
212: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 213: $cprtag{$key}=$val;
214: }
215: close($fh);
216: }
1.12 harris41 217: }
1.351 www 218: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 219: {
220: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
221: '/source_copyright.tab';
222: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 223: while (my $line = <$fh>) {
224: next if ($line =~ /^\#/);
225: chomp($line);
226: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 227: $scprtag{$key}=$val;
228: }
229: close($fh);
230: }
231: }
1.63 www 232:
1.517 raeburn 233: # -------------------------------------------------------------- default domain designs
1.63 www 234: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 235: my $designfile = $designdir.'/default.tab';
236: if ( open (my $fh,"<$designfile") ) {
237: while (my $line = <$fh>) {
238: next if ($line =~ /^\#/);
239: chomp($line);
240: my ($key,$val)=(split(/\=/,$line));
241: if ($val) { $defaultdesign{$key}=$val; }
242: }
243: close($fh);
1.63 www 244: }
245:
1.15 harris41 246: # ------------------------------------------------------------- file categories
247: {
1.158 raeburn 248: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
249: '/filecategories.tab';
250: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 251: while (my $line = <$fh>) {
252: next if ($line =~ /^\#/);
253: chomp($line);
254: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 255: push @{$category_extensions{lc($category)}},$extension;
256: }
257: close($fh);
258: }
259:
1.15 harris41 260: }
1.12 harris41 261: # ------------------------------------------------------------------ file types
262: {
1.158 raeburn 263: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
264: '/filetypes.tab';
265: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 266: while (my $line = <$fh>) {
267: next if ($line =~ /^\#/);
268: chomp($line);
269: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 270: if ($descr ne '') {
271: $fe{$ending}=lc($emb);
272: $fd{$ending}=$descr;
1.351 www 273: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 274: }
275: }
276: close($fh);
277: }
1.12 harris41 278: }
1.22 www 279: &Apache::lonnet::logthis(
1.705 tempelho 280: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 281: $readit=1;
1.46 matthew 282: } # end of unless($readit)
1.32 matthew 283:
284: }
1.112 bowersj2 285:
1.42 matthew 286: ###############################################################
287: ## HTML and Javascript Helper Functions ##
288: ###############################################################
289:
290: =pod
291:
1.112 bowersj2 292: =head1 HTML and Javascript Functions
1.42 matthew 293:
1.112 bowersj2 294: =over 4
295:
1.648 raeburn 296: =item * &browser_and_searcher_javascript()
1.112 bowersj2 297:
298: X<browsing, javascript>X<searching, javascript>Returns a string
299: containing javascript with two functions, C<openbrowser> and
300: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
301: tags.
1.42 matthew 302:
1.648 raeburn 303: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 304:
305: inputs: formname, elementname, only, omit
306:
307: formname and elementname indicate the name of the html form and name of
308: the element that the results of the browsing selection are to be placed in.
309:
310: Specifying 'only' will restrict the browser to displaying only files
1.185 www 311: with the given extension. Can be a comma separated list.
1.42 matthew 312:
313: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 314: with the given extension. Can be a comma separated list.
1.42 matthew 315:
1.648 raeburn 316: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 317:
318: Inputs: formname, elementname
319:
320: formname and elementname specify the name of the html form and the name
321: of the element the selection from the search results will be placed in.
1.542 raeburn 322:
1.42 matthew 323: =cut
324:
325: sub browser_and_searcher_javascript {
1.199 albertel 326: my ($mode)=@_;
327: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 328: my $resurl=&escape_single(&lastresurl());
1.42 matthew 329: return <<END;
1.219 albertel 330: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 331: var editbrowser = null;
1.135 albertel 332: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 333: var url = '$resurl/?';
1.42 matthew 334: if (editbrowser == null) {
335: url += 'launch=1&';
336: }
337: url += 'catalogmode=interactive&';
1.199 albertel 338: url += 'mode=$mode&';
1.611 albertel 339: url += 'inhibitmenu=yes&';
1.42 matthew 340: url += 'form=' + formname + '&';
341: if (only != null) {
342: url += 'only=' + only + '&';
1.217 albertel 343: } else {
344: url += 'only=&';
345: }
1.42 matthew 346: if (omit != null) {
347: url += 'omit=' + omit + '&';
1.217 albertel 348: } else {
349: url += 'omit=&';
350: }
1.135 albertel 351: if (titleelement != null) {
352: url += 'titleelement=' + titleelement + '&';
1.217 albertel 353: } else {
354: url += 'titleelement=&';
355: }
1.42 matthew 356: url += 'element=' + elementname + '';
357: var title = 'Browser';
1.435 albertel 358: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 359: options += ',width=700,height=600';
360: editbrowser = open(url,title,options,'1');
361: editbrowser.focus();
362: }
363: var editsearcher;
1.135 albertel 364: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 365: var url = '/adm/searchcat?';
366: if (editsearcher == null) {
367: url += 'launch=1&';
368: }
369: url += 'catalogmode=interactive&';
1.199 albertel 370: url += 'mode=$mode&';
1.42 matthew 371: url += 'form=' + formname + '&';
1.135 albertel 372: if (titleelement != null) {
373: url += 'titleelement=' + titleelement + '&';
1.217 albertel 374: } else {
375: url += 'titleelement=&';
376: }
1.42 matthew 377: url += 'element=' + elementname + '';
378: var title = 'Search';
1.435 albertel 379: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 380: options += ',width=700,height=600';
381: editsearcher = open(url,title,options,'1');
382: editsearcher.focus();
383: }
1.219 albertel 384: // END LON-CAPA Internal -->
1.42 matthew 385: END
1.170 www 386: }
387:
388: sub lastresurl {
1.258 albertel 389: if ($env{'environment.lastresurl'}) {
390: return $env{'environment.lastresurl'}
1.170 www 391: } else {
392: return '/res';
393: }
394: }
395:
396: sub storeresurl {
397: my $resurl=&Apache::lonnet::clutter(shift);
398: unless ($resurl=~/^\/res/) { return 0; }
399: $resurl=~s/\/$//;
400: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 401: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 402: return 1;
1.42 matthew 403: }
404:
1.74 www 405: sub studentbrowser_javascript {
1.111 www 406: unless (
1.258 albertel 407: (($env{'request.course.id'}) &&
1.302 albertel 408: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
409: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
410: '/'.$env{'request.course.sec'})
411: ))
1.258 albertel 412: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 413: ) { return ''; }
1.74 www 414: return (<<'ENDSTDBRW');
1.776 bisitz 415: <script type="text/javascript" language="Javascript">
1.824 bisitz 416: // <![CDATA[
1.74 www 417: var stdeditbrowser;
1.999 www 418: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 419: var url = '/adm/pickstudent?';
420: var filter;
1.558 albertel 421: if (!ignorefilter) {
422: eval('filter=document.'+formname+'.'+uname+'.value;');
423: }
1.74 www 424: if (filter != null) {
425: if (filter != '') {
426: url += 'filter='+filter+'&';
427: }
428: }
429: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 430: '&udomelement='+udom+
431: '&clicker='+clicker;
1.111 www 432: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 433: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 434: var title = 'Student_Browser';
1.74 www 435: var options = 'scrollbars=1,resizable=1,menubar=0';
436: options += ',width=700,height=600';
437: stdeditbrowser = open(url,title,options,'1');
438: stdeditbrowser.focus();
439: }
1.824 bisitz 440: // ]]>
1.74 www 441: </script>
442: ENDSTDBRW
443: }
1.42 matthew 444:
1.1003 www 445: sub resourcebrowser_javascript {
446: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 447: return (<<'ENDRESBRW');
1.1003 www 448: <script type="text/javascript" language="Javascript">
449: // <![CDATA[
450: var reseditbrowser;
1.1004 www 451: function openresbrowser(formname,reslink) {
1.1005 www 452: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 453: var title = 'Resource_Browser';
454: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 455: options += ',width=700,height=500';
1.1004 www 456: reseditbrowser = open(url,title,options,'1');
457: reseditbrowser.focus();
1.1003 www 458: }
459: // ]]>
460: </script>
1.1004 www 461: ENDRESBRW
1.1003 www 462: }
463:
1.74 www 464: sub selectstudent_link {
1.999 www 465: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
466: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
467: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
468: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 469: if ($env{'request.course.id'}) {
1.302 albertel 470: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
471: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
472: '/'.$env{'request.course.sec'})) {
1.111 www 473: return '';
474: }
1.999 www 475: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 476: if ($courseadvonly) {
477: $callargs .= ",'',1,1";
478: }
479: return '<span class="LC_nobreak">'.
480: '<a href="javascript:openstdbrowser('.$callargs.');">'.
481: &mt('Select User').'</a></span>';
1.74 www 482: }
1.258 albertel 483: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 484: $callargs .= ",'',1";
1.793 raeburn 485: return '<span class="LC_nobreak">'.
486: '<a href="javascript:openstdbrowser('.$callargs.');">'.
487: &mt('Select User').'</a></span>';
1.111 www 488: }
489: return '';
1.91 www 490: }
491:
1.1004 www 492: sub selectresource_link {
493: my ($form,$reslink,$arg)=@_;
494:
495: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
496: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
497: unless ($env{'request.course.id'}) { return $arg; }
498: return '<span class="LC_nobreak">'.
499: '<a href="javascript:openresbrowser('.$callargs.');">'.
500: $arg.'</a></span>';
501: }
502:
503:
504:
1.653 raeburn 505: sub authorbrowser_javascript {
506: return <<"ENDAUTHORBRW";
1.776 bisitz 507: <script type="text/javascript" language="JavaScript">
1.824 bisitz 508: // <![CDATA[
1.653 raeburn 509: var stdeditbrowser;
510:
511: function openauthorbrowser(formname,udom) {
512: var url = '/adm/pickauthor?';
513: url += 'form='+formname+'&roledom='+udom;
514: var title = 'Author_Browser';
515: var options = 'scrollbars=1,resizable=1,menubar=0';
516: options += ',width=700,height=600';
517: stdeditbrowser = open(url,title,options,'1');
518: stdeditbrowser.focus();
519: }
520:
1.824 bisitz 521: // ]]>
1.653 raeburn 522: </script>
523: ENDAUTHORBRW
524: }
525:
1.91 www 526: sub coursebrowser_javascript {
1.909 raeburn 527: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 528: my $wintitle = 'Course_Browser';
1.931 raeburn 529: if ($crstype eq 'Community') {
1.932 raeburn 530: $wintitle = 'Community_Browser';
1.909 raeburn 531: }
1.876 raeburn 532: my $id_functions = &javascript_index_functions();
533: my $output = '
1.776 bisitz 534: <script type="text/javascript" language="JavaScript">
1.824 bisitz 535: // <![CDATA[
1.468 raeburn 536: var stdeditbrowser;'."\n";
1.876 raeburn 537:
538: $output .= <<"ENDSTDBRW";
1.909 raeburn 539: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 540: var url = '/adm/pickcourse?';
1.895 raeburn 541: var formid = getFormIdByName(formname);
1.876 raeburn 542: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 543: if (domainfilter != null) {
544: if (domainfilter != '') {
545: url += 'domainfilter='+domainfilter+'&';
546: }
547: }
1.91 www 548: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 549: '&cdomelement='+udom+
550: '&cnameelement='+desc;
1.468 raeburn 551: if (extra_element !=null && extra_element != '') {
1.594 raeburn 552: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 553: url += '&roleelement='+extra_element;
554: if (domainfilter == null || domainfilter == '') {
555: url += '&domainfilter='+extra_element;
556: }
1.234 raeburn 557: }
1.468 raeburn 558: else {
559: if (formname == 'portform') {
560: url += '&setroles='+extra_element;
1.800 raeburn 561: } else {
562: if (formname == 'rules') {
563: url += '&fixeddom='+extra_element;
564: }
1.468 raeburn 565: }
566: }
1.230 raeburn 567: }
1.909 raeburn 568: if (type != null && type != '') {
569: url += '&type='+type;
570: }
571: if (type_elem != null && type_elem != '') {
572: url += '&typeelement='+type_elem;
573: }
1.872 raeburn 574: if (formname == 'ccrs') {
575: var ownername = document.forms[formid].ccuname.value;
576: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
577: url += '&cloner='+ownername+':'+ownerdom;
578: }
1.293 raeburn 579: if (multflag !=null && multflag != '') {
580: url += '&multiple='+multflag;
581: }
1.909 raeburn 582: var title = '$wintitle';
1.91 www 583: var options = 'scrollbars=1,resizable=1,menubar=0';
584: options += ',width=700,height=600';
585: stdeditbrowser = open(url,title,options,'1');
586: stdeditbrowser.focus();
587: }
1.876 raeburn 588: $id_functions
589: ENDSTDBRW
1.905 raeburn 590: if (($sec_element ne '') || ($role_element ne '')) {
591: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 592: }
593: $output .= '
594: // ]]>
595: </script>';
596: return $output;
597: }
598:
599: sub javascript_index_functions {
600: return <<"ENDJS";
601:
602: function getFormIdByName(formname) {
603: for (var i=0;i<document.forms.length;i++) {
604: if (document.forms[i].name == formname) {
605: return i;
606: }
607: }
608: return -1;
609: }
610:
611: function getIndexByName(formid,item) {
612: for (var i=0;i<document.forms[formid].elements.length;i++) {
613: if (document.forms[formid].elements[i].name == item) {
614: return i;
615: }
616: }
617: return -1;
618: }
1.468 raeburn 619:
1.876 raeburn 620: function getDomainFromSelectbox(formname,udom) {
621: var userdom;
622: var formid = getFormIdByName(formname);
623: if (formid > -1) {
624: var domid = getIndexByName(formid,udom);
625: if (domid > -1) {
626: if (document.forms[formid].elements[domid].type == 'select-one') {
627: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
628: }
629: if (document.forms[formid].elements[domid].type == 'hidden') {
630: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 631: }
632: }
633: }
1.876 raeburn 634: return userdom;
635: }
636:
637: ENDJS
1.468 raeburn 638:
1.876 raeburn 639: }
640:
1.1017 raeburn 641: sub javascript_array_indexof {
1.1018 raeburn 642: return <<ENDJS;
1.1017 raeburn 643: <script type="text/javascript" language="JavaScript">
644: // <![CDATA[
645:
646: if (!Array.prototype.indexOf) {
647: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
648: "use strict";
649: if (this === void 0 || this === null) {
650: throw new TypeError();
651: }
652: var t = Object(this);
653: var len = t.length >>> 0;
654: if (len === 0) {
655: return -1;
656: }
657: var n = 0;
658: if (arguments.length > 0) {
659: n = Number(arguments[1]);
660: if (n !== n) { // shortcut for verifying if it's NaN
661: n = 0;
662: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
663: n = (n > 0 || -1) * Math.floor(Math.abs(n));
664: }
665: }
666: if (n >= len) {
667: return -1;
668: }
669: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
670: for (; k < len; k++) {
671: if (k in t && t[k] === searchElement) {
672: return k;
673: }
674: }
675: return -1;
676: }
677: }
678:
679: // ]]>
680: </script>
681:
682: ENDJS
683:
684: }
685:
1.876 raeburn 686: sub userbrowser_javascript {
687: my $id_functions = &javascript_index_functions();
688: return <<"ENDUSERBRW";
689:
1.888 raeburn 690: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 691: var url = '/adm/pickuser?';
692: var userdom = getDomainFromSelectbox(formname,udom);
693: if (userdom != null) {
694: if (userdom != '') {
695: url += 'srchdom='+userdom+'&';
696: }
697: }
698: url += 'form=' + formname + '&unameelement='+uname+
699: '&udomelement='+udom+
700: '&ulastelement='+ulast+
701: '&ufirstelement='+ufirst+
702: '&uemailelement='+uemail+
1.881 raeburn 703: '&hideudomelement='+hideudom+
704: '&coursedom='+crsdom;
1.888 raeburn 705: if ((caller != null) && (caller != undefined)) {
706: url += '&caller='+caller;
707: }
1.876 raeburn 708: var title = 'User_Browser';
709: var options = 'scrollbars=1,resizable=1,menubar=0';
710: options += ',width=700,height=600';
711: var stdeditbrowser = open(url,title,options,'1');
712: stdeditbrowser.focus();
713: }
714:
1.888 raeburn 715: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 716: var formid = getFormIdByName(formname);
717: if (formid > -1) {
1.888 raeburn 718: var unameid = getIndexByName(formid,uname);
1.876 raeburn 719: var domid = getIndexByName(formid,udom);
720: var hidedomid = getIndexByName(formid,origdom);
721: if (hidedomid > -1) {
722: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 723: var unameval = document.forms[formid].elements[unameid].value;
724: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
725: if (domid > -1) {
726: var slct = document.forms[formid].elements[domid];
727: if (slct.type == 'select-one') {
728: var i;
729: for (i=0;i<slct.length;i++) {
730: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
731: }
732: }
733: if (slct.type == 'hidden') {
734: slct.value = fixeddom;
1.876 raeburn 735: }
736: }
1.468 raeburn 737: }
738: }
739: }
1.876 raeburn 740: return;
741: }
742:
743: $id_functions
744: ENDUSERBRW
1.468 raeburn 745: }
746:
747: sub setsec_javascript {
1.905 raeburn 748: my ($sec_element,$formname,$role_element) = @_;
749: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
750: $communityrolestr);
751: if ($role_element ne '') {
752: my @allroles = ('st','ta','ep','in','ad');
753: foreach my $crstype ('Course','Community') {
754: if ($crstype eq 'Community') {
755: foreach my $role (@allroles) {
756: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
757: }
758: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
759: } else {
760: foreach my $role (@allroles) {
761: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
762: }
763: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
764: }
765: }
766: $rolestr = '"'.join('","',@allroles).'"';
767: $courserolestr = '"'.join('","',@courserolenames).'"';
768: $communityrolestr = '"'.join('","',@communityrolenames).'"';
769: }
1.468 raeburn 770: my $setsections = qq|
771: function setSect(sectionlist) {
1.629 raeburn 772: var sectionsArray = new Array();
773: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
774: sectionsArray = sectionlist.split(",");
775: }
1.468 raeburn 776: var numSections = sectionsArray.length;
777: document.$formname.$sec_element.length = 0;
778: if (numSections == 0) {
779: document.$formname.$sec_element.multiple=false;
780: document.$formname.$sec_element.size=1;
781: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
782: } else {
783: if (numSections == 1) {
784: document.$formname.$sec_element.multiple=false;
785: document.$formname.$sec_element.size=1;
786: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
787: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
788: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
789: } else {
790: for (var i=0; i<numSections; i++) {
791: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
792: }
793: document.$formname.$sec_element.multiple=true
794: if (numSections < 3) {
795: document.$formname.$sec_element.size=numSections;
796: } else {
797: document.$formname.$sec_element.size=3;
798: }
799: document.$formname.$sec_element.options[0].selected = false
800: }
801: }
1.91 www 802: }
1.905 raeburn 803:
804: function setRole(crstype) {
1.468 raeburn 805: |;
1.905 raeburn 806: if ($role_element eq '') {
807: $setsections .= ' return;
808: }
809: ';
810: } else {
811: $setsections .= qq|
812: var elementLength = document.$formname.$role_element.length;
813: var allroles = Array($rolestr);
814: var courserolenames = Array($courserolestr);
815: var communityrolenames = Array($communityrolestr);
816: if (elementLength != undefined) {
817: if (document.$formname.$role_element.options[5].value == 'cc') {
818: if (crstype == 'Course') {
819: return;
820: } else {
821: allroles[5] = 'co';
822: for (var i=0; i<6; i++) {
823: document.$formname.$role_element.options[i].value = allroles[i];
824: document.$formname.$role_element.options[i].text = communityrolenames[i];
825: }
826: }
827: } else {
828: if (crstype == 'Community') {
829: return;
830: } else {
831: allroles[5] = 'cc';
832: for (var i=0; i<6; i++) {
833: document.$formname.$role_element.options[i].value = allroles[i];
834: document.$formname.$role_element.options[i].text = courserolenames[i];
835: }
836: }
837: }
838: }
839: return;
840: }
841: |;
842: }
1.468 raeburn 843: return $setsections;
844: }
845:
1.91 www 846: sub selectcourse_link {
1.909 raeburn 847: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
848: $typeelement) = @_;
849: my $type = $selecttype;
1.871 raeburn 850: my $linktext = &mt('Select Course');
851: if ($selecttype eq 'Community') {
1.909 raeburn 852: $linktext = &mt('Select Community');
1.906 raeburn 853: } elsif ($selecttype eq 'Course/Community') {
854: $linktext = &mt('Select Course/Community');
1.909 raeburn 855: $type = '';
1.1019 raeburn 856: } elsif ($selecttype eq 'Select') {
857: $linktext = &mt('Select');
858: $type = '';
1.871 raeburn 859: }
1.787 bisitz 860: return '<span class="LC_nobreak">'
861: ."<a href='"
862: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
863: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 864: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 865: ."'>".$linktext.'</a>'
1.787 bisitz 866: .'</span>';
1.74 www 867: }
1.42 matthew 868:
1.653 raeburn 869: sub selectauthor_link {
870: my ($form,$udom)=@_;
871: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
872: &mt('Select Author').'</a>';
873: }
874:
1.876 raeburn 875: sub selectuser_link {
1.881 raeburn 876: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 877: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 878: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 879: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 880: ');">'.$linktext.'</a>';
1.876 raeburn 881: }
882:
1.273 raeburn 883: sub check_uncheck_jscript {
884: my $jscript = <<"ENDSCRT";
885: function checkAll(field) {
886: if (field.length > 0) {
887: for (i = 0; i < field.length; i++) {
888: field[i].checked = true ;
889: }
890: } else {
891: field.checked = true
892: }
893: }
894:
895: function uncheckAll(field) {
896: if (field.length > 0) {
897: for (i = 0; i < field.length; i++) {
898: field[i].checked = false ;
1.543 albertel 899: }
900: } else {
1.273 raeburn 901: field.checked = false ;
902: }
903: }
904: ENDSCRT
905: return $jscript;
906: }
907:
1.656 www 908: sub select_timezone {
1.659 raeburn 909: my ($name,$selected,$onchange,$includeempty)=@_;
910: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
911: if ($includeempty) {
912: $output .= '<option value=""';
913: if (($selected eq '') || ($selected eq 'local')) {
914: $output .= ' selected="selected" ';
915: }
916: $output .= '> </option>';
917: }
1.657 raeburn 918: my @timezones = DateTime::TimeZone->all_names;
919: foreach my $tzone (@timezones) {
920: $output.= '<option value="'.$tzone.'"';
921: if ($tzone eq $selected) {
922: $output.=' selected="selected"';
923: }
924: $output.=">$tzone</option>\n";
1.656 www 925: }
926: $output.="</select>";
927: return $output;
928: }
1.273 raeburn 929:
1.687 raeburn 930: sub select_datelocale {
931: my ($name,$selected,$onchange,$includeempty)=@_;
932: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
933: if ($includeempty) {
934: $output .= '<option value=""';
935: if ($selected eq '') {
936: $output .= ' selected="selected" ';
937: }
938: $output .= '> </option>';
939: }
940: my (@possibles,%locale_names);
941: my @locales = DateTime::Locale::Catalog::Locales;
942: foreach my $locale (@locales) {
943: if (ref($locale) eq 'HASH') {
944: my $id = $locale->{'id'};
945: if ($id ne '') {
946: my $en_terr = $locale->{'en_territory'};
947: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 948: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 949: if (grep(/^en$/,@languages) || !@languages) {
950: if ($en_terr ne '') {
951: $locale_names{$id} = '('.$en_terr.')';
952: } elsif ($native_terr ne '') {
953: $locale_names{$id} = $native_terr;
954: }
955: } else {
956: if ($native_terr ne '') {
957: $locale_names{$id} = $native_terr.' ';
958: } elsif ($en_terr ne '') {
959: $locale_names{$id} = '('.$en_terr.')';
960: }
961: }
962: push (@possibles,$id);
963: }
964: }
965: }
966: foreach my $item (sort(@possibles)) {
967: $output.= '<option value="'.$item.'"';
968: if ($item eq $selected) {
969: $output.=' selected="selected"';
970: }
971: $output.=">$item";
972: if ($locale_names{$item} ne '') {
973: $output.=" $locale_names{$item}</option>\n";
974: }
975: $output.="</option>\n";
976: }
977: $output.="</select>";
978: return $output;
979: }
980:
1.792 raeburn 981: sub select_language {
982: my ($name,$selected,$includeempty) = @_;
983: my %langchoices;
984: if ($includeempty) {
985: %langchoices = ('' => 'No language preference');
986: }
987: foreach my $id (&languageids()) {
988: my $code = &supportedlanguagecode($id);
989: if ($code) {
990: $langchoices{$code} = &plainlanguagedescription($id);
991: }
992: }
1.970 raeburn 993: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 994: }
995:
1.42 matthew 996: =pod
1.36 matthew 997:
1.648 raeburn 998: =item * &linked_select_forms(...)
1.36 matthew 999:
1000: linked_select_forms returns a string containing a <script></script> block
1001: and html for two <select> menus. The select menus will be linked in that
1002: changing the value of the first menu will result in new values being placed
1003: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1004: order unless a defined order is provided.
1.36 matthew 1005:
1006: linked_select_forms takes the following ordered inputs:
1007:
1008: =over 4
1009:
1.112 bowersj2 1010: =item * $formname, the name of the <form> tag
1.36 matthew 1011:
1.112 bowersj2 1012: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1013:
1.112 bowersj2 1014: =item * $firstdefault, the default value for the first menu
1.36 matthew 1015:
1.112 bowersj2 1016: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1017:
1.112 bowersj2 1018: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1019:
1.112 bowersj2 1020: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1021:
1.609 raeburn 1022: =item * $menuorder, the order of values in the first menu
1023:
1.41 ng 1024: =back
1025:
1.36 matthew 1026: Below is an example of such a hash. Only the 'text', 'default', and
1027: 'select2' keys must appear as stated. keys(%menu) are the possible
1028: values for the first select menu. The text that coincides with the
1.41 ng 1029: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1030: and text for the second menu are given in the hash pointed to by
1031: $menu{$choice1}->{'select2'}.
1032:
1.112 bowersj2 1033: my %menu = ( A1 => { text =>"Choice A1" ,
1034: default => "B3",
1035: select2 => {
1036: B1 => "Choice B1",
1037: B2 => "Choice B2",
1038: B3 => "Choice B3",
1039: B4 => "Choice B4"
1.609 raeburn 1040: },
1041: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1042: },
1043: A2 => { text =>"Choice A2" ,
1044: default => "C2",
1045: select2 => {
1046: C1 => "Choice C1",
1047: C2 => "Choice C2",
1048: C3 => "Choice C3"
1.609 raeburn 1049: },
1050: order => ['C2','C1','C3'],
1.112 bowersj2 1051: },
1052: A3 => { text =>"Choice A3" ,
1053: default => "D6",
1054: select2 => {
1055: D1 => "Choice D1",
1056: D2 => "Choice D2",
1057: D3 => "Choice D3",
1058: D4 => "Choice D4",
1059: D5 => "Choice D5",
1060: D6 => "Choice D6",
1061: D7 => "Choice D7"
1.609 raeburn 1062: },
1063: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1064: }
1065: );
1.36 matthew 1066:
1067: =cut
1068:
1069: sub linked_select_forms {
1070: my ($formname,
1071: $middletext,
1072: $firstdefault,
1073: $firstselectname,
1074: $secondselectname,
1.609 raeburn 1075: $hashref,
1076: $menuorder,
1.36 matthew 1077: ) = @_;
1078: my $second = "document.$formname.$secondselectname";
1079: my $first = "document.$formname.$firstselectname";
1080: # output the javascript to do the changing
1081: my $result = '';
1.776 bisitz 1082: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1083: $result.="// <![CDATA[\n";
1.36 matthew 1084: $result.="var select2data = new Object();\n";
1085: $" = '","';
1086: my $debug = '';
1087: foreach my $s1 (sort(keys(%$hashref))) {
1088: $result.="select2data.d_$s1 = new Object();\n";
1089: $result.="select2data.d_$s1.def = new String('".
1090: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1091: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1092: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1093: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1094: @s2values = @{$hashref->{$s1}->{'order'}};
1095: }
1.36 matthew 1096: $result.="\"@s2values\");\n";
1097: $result.="select2data.d_$s1.texts = new Array(";
1098: my @s2texts;
1099: foreach my $value (@s2values) {
1100: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1101: }
1102: $result.="\"@s2texts\");\n";
1103: }
1104: $"=' ';
1105: $result.= <<"END";
1106:
1107: function select1_changed() {
1108: // Determine new choice
1109: var newvalue = "d_" + $first.value;
1110: // update select2
1111: var values = select2data[newvalue].values;
1112: var texts = select2data[newvalue].texts;
1113: var select2def = select2data[newvalue].def;
1114: var i;
1115: // out with the old
1116: for (i = 0; i < $second.options.length; i++) {
1117: $second.options[i] = null;
1118: }
1119: // in with the nuclear
1120: for (i=0;i<values.length; i++) {
1121: $second.options[i] = new Option(values[i]);
1.143 matthew 1122: $second.options[i].value = values[i];
1.36 matthew 1123: $second.options[i].text = texts[i];
1124: if (values[i] == select2def) {
1125: $second.options[i].selected = true;
1126: }
1127: }
1128: }
1.824 bisitz 1129: // ]]>
1.36 matthew 1130: </script>
1131: END
1132: # output the initial values for the selection lists
1133: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1134: my @order = sort(keys(%{$hashref}));
1135: if (ref($menuorder) eq 'ARRAY') {
1136: @order = @{$menuorder};
1137: }
1138: foreach my $value (@order) {
1.36 matthew 1139: $result.=" <option value=\"$value\" ";
1.253 albertel 1140: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1141: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1142: }
1143: $result .= "</select>\n";
1144: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1145: $result .= $middletext;
1146: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1147: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1148:
1149: my @secondorder = sort(keys(%select2));
1150: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1151: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1152: }
1153: foreach my $value (@secondorder) {
1.36 matthew 1154: $result.=" <option value=\"$value\" ";
1.253 albertel 1155: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1156: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1157: }
1158: $result .= "</select>\n";
1159: # return $debug;
1160: return $result;
1161: } # end of sub linked_select_forms {
1162:
1.45 matthew 1163: =pod
1.44 bowersj2 1164:
1.973 raeburn 1165: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1166:
1.112 bowersj2 1167: Returns a string corresponding to an HTML link to the given help
1168: $topic, where $topic corresponds to the name of a .tex file in
1169: /home/httpd/html/adm/help/tex, with underscores replaced by
1170: spaces.
1171:
1172: $text will optionally be linked to the same topic, allowing you to
1173: link text in addition to the graphic. If you do not want to link
1174: text, but wish to specify one of the later parameters, pass an
1175: empty string.
1176:
1177: $stayOnPage is a value that will be interpreted as a boolean. If true,
1178: the link will not open a new window. If false, the link will open
1179: a new window using Javascript. (Default is false.)
1180:
1181: $width and $height are optional numerical parameters that will
1182: override the width and height of the popped up window, which may
1.973 raeburn 1183: be useful for certain help topics with big pictures included.
1184:
1185: $imgid is the id of the img tag used for the help icon. This may be
1186: used in a javascript call to switch the image src. See
1187: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1188:
1189: =cut
1190:
1191: sub help_open_topic {
1.973 raeburn 1192: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1193: $text = "" if (not defined $text);
1.44 bowersj2 1194: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1195: $width = 500 if (not defined $width);
1.44 bowersj2 1196: $height = 400 if (not defined $height);
1197: my $filename = $topic;
1198: $filename =~ s/ /_/g;
1199:
1.48 bowersj2 1200: my $template = "";
1201: my $link;
1.572 banghart 1202:
1.159 www 1203: $topic=~s/\W/\_/g;
1.44 bowersj2 1204:
1.572 banghart 1205: if (!$stayOnPage) {
1.1033 www 1206: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1207: } elsif ($stayOnPage eq 'popup') {
1208: $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 1209: } else {
1.48 bowersj2 1210: $link = "/adm/help/${filename}.hlp";
1211: }
1212:
1213: # Add the text
1.755 neumanie 1214: if ($text ne "") {
1.763 bisitz 1215: $template.='<span class="LC_help_open_topic">'
1216: .'<a target="_top" href="'.$link.'">'
1217: .$text.'</a>';
1.48 bowersj2 1218: }
1219:
1.763 bisitz 1220: # (Always) Add the graphic
1.179 matthew 1221: my $title = &mt('Online Help');
1.667 raeburn 1222: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1223: if ($imgid ne '') {
1224: $imgid = ' id="'.$imgid.'"';
1225: }
1.763 bisitz 1226: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1227: .'<img src="'.$helpicon.'" border="0"'
1228: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1229: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1230: .' /></a>';
1231: if ($text ne "") {
1232: $template.='</span>';
1233: }
1.44 bowersj2 1234: return $template;
1235:
1.106 bowersj2 1236: }
1237:
1238: # This is a quicky function for Latex cheatsheet editing, since it
1239: # appears in at least four places
1240: sub helpLatexCheatsheet {
1.1037 www 1241: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1242: my $out;
1.106 bowersj2 1243: my $addOther = '';
1.732 raeburn 1244: if ($topic) {
1.1037 www 1245: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1246: }
1247: $out = '<span>' # Start cheatsheet
1248: .$addOther
1249: .'<span>'
1.1037 www 1250: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1251: .'</span> <span>'
1.1037 www 1252: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1253: .'</span>';
1.732 raeburn 1254: unless ($not_author) {
1.763 bisitz 1255: $out .= ' <span>'
1.1037 www 1256: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763 bisitz 1257: .'</span>';
1.732 raeburn 1258: }
1.763 bisitz 1259: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1260: return $out;
1.172 www 1261: }
1262:
1.430 albertel 1263: sub general_help {
1264: my $helptopic='Student_Intro';
1265: if ($env{'request.role'}=~/^(ca|au)/) {
1266: $helptopic='Authoring_Intro';
1.907 raeburn 1267: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1268: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1269: } elsif ($env{'request.role'}=~/^dc/) {
1270: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1271: }
1272: return $helptopic;
1273: }
1274:
1275: sub update_help_link {
1276: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1277: my $origurl = $ENV{'REQUEST_URI'};
1278: $origurl=~s|^/~|/priv/|;
1279: my $timestamp = time;
1280: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1281: $$datum = &escape($$datum);
1282: }
1283:
1284: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1285: my $output .= <<"ENDOUTPUT";
1286: <script type="text/javascript">
1.824 bisitz 1287: // <![CDATA[
1.430 albertel 1288: banner_link = '$banner_link';
1.824 bisitz 1289: // ]]>
1.430 albertel 1290: </script>
1291: ENDOUTPUT
1292: return $output;
1293: }
1294:
1295: # now just updates the help link and generates a blue icon
1.193 raeburn 1296: sub help_open_menu {
1.430 albertel 1297: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1298: = @_;
1.949 droeschl 1299: $stayOnPage = 1;
1.430 albertel 1300: my $output;
1301: if ($component_help) {
1302: if (!$text) {
1303: $output=&help_open_topic($component_help,undef,$stayOnPage,
1304: $width,$height);
1305: } else {
1306: my $help_text;
1307: $help_text=&unescape($topic);
1308: $output='<table><tr><td>'.
1309: &help_open_topic($component_help,$help_text,$stayOnPage,
1310: $width,$height).'</td></tr></table>';
1311: }
1312: }
1313: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1314: return $output.$banner_link;
1315: }
1316:
1317: sub top_nav_help {
1318: my ($text) = @_;
1.436 albertel 1319: $text = &mt($text);
1.949 droeschl 1320: my $stay_on_page = 1;
1321:
1.572 banghart 1322: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1323: : "javascript:helpMenu('open')";
1.572 banghart 1324: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1325:
1.201 raeburn 1326: my $title = &mt('Get help');
1.436 albertel 1327:
1328: return <<"END";
1329: $banner_link
1330: <a href="$link" title="$title">$text</a>
1331: END
1332: }
1333:
1334: sub help_menu_js {
1335: my ($text) = @_;
1.949 droeschl 1336: my $stayOnPage = 1;
1.436 albertel 1337: my $width = 620;
1338: my $height = 600;
1.430 albertel 1339: my $helptopic=&general_help();
1340: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1341: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1342: my $start_page =
1343: &Apache::loncommon::start_page('Help Menu', undef,
1344: {'frameset' => 1,
1345: 'js_ready' => 1,
1346: 'add_entries' => {
1347: 'border' => '0',
1.579 raeburn 1348: 'rows' => "110,*",},});
1.331 albertel 1349: my $end_page =
1350: &Apache::loncommon::end_page({'frameset' => 1,
1351: 'js_ready' => 1,});
1352:
1.436 albertel 1353: my $template .= <<"ENDTEMPLATE";
1354: <script type="text/javascript">
1.877 bisitz 1355: // <![CDATA[
1.253 albertel 1356: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1357: var banner_link = '';
1.243 raeburn 1358: function helpMenu(target) {
1359: var caller = this;
1360: if (target == 'open') {
1361: var newWindow = null;
1362: try {
1.262 albertel 1363: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1364: }
1365: catch(error) {
1366: writeHelp(caller);
1367: return;
1368: }
1369: if (newWindow) {
1370: caller = newWindow;
1371: }
1.193 raeburn 1372: }
1.243 raeburn 1373: writeHelp(caller);
1374: return;
1375: }
1376: function writeHelp(caller) {
1.1072 raeburn 1377: 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 1378: caller.document.close()
1379: caller.focus()
1.193 raeburn 1380: }
1.877 bisitz 1381: // END LON-CAPA Internal -->
1.253 albertel 1382: // ]]>
1.436 albertel 1383: </script>
1.193 raeburn 1384: ENDTEMPLATE
1385: return $template;
1386: }
1387:
1.172 www 1388: sub help_open_bug {
1389: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1390: unless ($env{'user.adv'}) { return ''; }
1.172 www 1391: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1392: $text = "" if (not defined $text);
1393: $stayOnPage=1;
1.184 albertel 1394: $width = 600 if (not defined $width);
1395: $height = 600 if (not defined $height);
1.172 www 1396:
1397: $topic=~s/\W+/\+/g;
1398: my $link='';
1399: my $template='';
1.379 albertel 1400: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1401: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1402: if (!$stayOnPage)
1403: {
1404: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1405: }
1406: else
1407: {
1408: $link = $url;
1409: }
1410: # Add the text
1411: if ($text ne "")
1412: {
1413: $template .=
1414: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1415: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1416: }
1417:
1418: # Add the graphic
1.179 matthew 1419: my $title = &mt('Report a Bug');
1.215 albertel 1420: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1421: $template .= <<"ENDTEMPLATE";
1.436 albertel 1422: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1423: ENDTEMPLATE
1424: if ($text ne '') { $template.='</td></tr></table>' };
1425: return $template;
1426:
1427: }
1428:
1429: sub help_open_faq {
1430: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1431: unless ($env{'user.adv'}) { return ''; }
1.172 www 1432: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1433: $text = "" if (not defined $text);
1434: $stayOnPage=1;
1435: $width = 350 if (not defined $width);
1436: $height = 400 if (not defined $height);
1437:
1438: $topic=~s/\W+/\+/g;
1439: my $link='';
1440: my $template='';
1441: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1442: if (!$stayOnPage)
1443: {
1444: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1445: }
1446: else
1447: {
1448: $link = $url;
1449: }
1450:
1451: # Add the text
1452: if ($text ne "")
1453: {
1454: $template .=
1.173 www 1455: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1456: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1457: }
1458:
1459: # Add the graphic
1.179 matthew 1460: my $title = &mt('View the FAQ');
1.215 albertel 1461: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1462: $template .= <<"ENDTEMPLATE";
1.436 albertel 1463: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1464: ENDTEMPLATE
1465: if ($text ne '') { $template.='</td></tr></table>' };
1466: return $template;
1467:
1.44 bowersj2 1468: }
1.37 matthew 1469:
1.180 matthew 1470: ###############################################################
1471: ###############################################################
1472:
1.45 matthew 1473: =pod
1474:
1.648 raeburn 1475: =item * &change_content_javascript():
1.256 matthew 1476:
1477: This and the next function allow you to create small sections of an
1478: otherwise static HTML page that you can update on the fly with
1479: Javascript, even in Netscape 4.
1480:
1481: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1482: must be written to the HTML page once. It will prove the Javascript
1483: function "change(name, content)". Calling the change function with the
1484: name of the section
1485: you want to update, matching the name passed to C<changable_area>, and
1486: the new content you want to put in there, will put the content into
1487: that area.
1488:
1489: B<Note>: Netscape 4 only reserves enough space for the changable area
1490: to contain room for the original contents. You need to "make space"
1491: for whatever changes you wish to make, and be B<sure> to check your
1492: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1493: it's adequate for updating a one-line status display, but little more.
1494: This script will set the space to 100% width, so you only need to
1495: worry about height in Netscape 4.
1496:
1497: Modern browsers are much less limiting, and if you can commit to the
1498: user not using Netscape 4, this feature may be used freely with
1499: pretty much any HTML.
1500:
1501: =cut
1502:
1503: sub change_content_javascript {
1504: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1505: if ($env{'browser.type'} eq 'netscape' &&
1506: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1507: return (<<NETSCAPE4);
1508: function change(name, content) {
1509: doc = document.layers[name+"___escape"].layers[0].document;
1510: doc.open();
1511: doc.write(content);
1512: doc.close();
1513: }
1514: NETSCAPE4
1515: } else {
1516: # Otherwise, we need to use semi-standards-compliant code
1517: # (technically, "innerHTML" isn't standard but the equivalent
1518: # is really scary, and every useful browser supports it
1519: return (<<DOMBASED);
1520: function change(name, content) {
1521: element = document.getElementById(name);
1522: element.innerHTML = content;
1523: }
1524: DOMBASED
1525: }
1526: }
1527:
1528: =pod
1529:
1.648 raeburn 1530: =item * &changable_area($name,$origContent):
1.256 matthew 1531:
1532: This provides a "changable area" that can be modified on the fly via
1533: the Javascript code provided in C<change_content_javascript>. $name is
1534: the name you will use to reference the area later; do not repeat the
1535: same name on a given HTML page more then once. $origContent is what
1536: the area will originally contain, which can be left blank.
1537:
1538: =cut
1539:
1540: sub changable_area {
1541: my ($name, $origContent) = @_;
1542:
1.258 albertel 1543: if ($env{'browser.type'} eq 'netscape' &&
1544: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1545: # If this is netscape 4, we need to use the Layer tag
1546: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1547: } else {
1548: return "<span id='$name'>$origContent</span>";
1549: }
1550: }
1551:
1552: =pod
1553:
1.648 raeburn 1554: =item * &viewport_geometry_js
1.590 raeburn 1555:
1556: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1557:
1558: =cut
1559:
1560:
1561: sub viewport_geometry_js {
1562: return <<"GEOMETRY";
1563: var Geometry = {};
1564: function init_geometry() {
1565: if (Geometry.init) { return };
1566: Geometry.init=1;
1567: if (window.innerHeight) {
1568: Geometry.getViewportHeight = function() { return window.innerHeight; };
1569: Geometry.getViewportWidth = function() { return window.innerWidth; };
1570: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1571: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1572: }
1573: else if (document.documentElement && document.documentElement.clientHeight) {
1574: Geometry.getViewportHeight =
1575: function() { return document.documentElement.clientHeight; };
1576: Geometry.getViewportWidth =
1577: function() { return document.documentElement.clientWidth; };
1578:
1579: Geometry.getHorizontalScroll =
1580: function() { return document.documentElement.scrollLeft; };
1581: Geometry.getVerticalScroll =
1582: function() { return document.documentElement.scrollTop; };
1583: }
1584: else if (document.body.clientHeight) {
1585: Geometry.getViewportHeight =
1586: function() { return document.body.clientHeight; };
1587: Geometry.getViewportWidth =
1588: function() { return document.body.clientWidth; };
1589: Geometry.getHorizontalScroll =
1590: function() { return document.body.scrollLeft; };
1591: Geometry.getVerticalScroll =
1592: function() { return document.body.scrollTop; };
1593: }
1594: }
1595:
1596: GEOMETRY
1597: }
1598:
1599: =pod
1600:
1.648 raeburn 1601: =item * &viewport_size_js()
1.590 raeburn 1602:
1603: 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.
1604:
1605: =cut
1606:
1607: sub viewport_size_js {
1608: my $geometry = &viewport_geometry_js();
1609: return <<"DIMS";
1610:
1611: $geometry
1612:
1613: function getViewportDims(width,height) {
1614: init_geometry();
1615: width.value = Geometry.getViewportWidth();
1616: height.value = Geometry.getViewportHeight();
1617: return;
1618: }
1619:
1620: DIMS
1621: }
1622:
1623: =pod
1624:
1.648 raeburn 1625: =item * &resize_textarea_js()
1.565 albertel 1626:
1627: emits the needed javascript to resize a textarea to be as big as possible
1628:
1629: creates a function resize_textrea that takes two IDs first should be
1630: the id of the element to resize, second should be the id of a div that
1631: surrounds everything that comes after the textarea, this routine needs
1632: to be attached to the <body> for the onload and onresize events.
1633:
1.648 raeburn 1634: =back
1.565 albertel 1635:
1636: =cut
1637:
1638: sub resize_textarea_js {
1.590 raeburn 1639: my $geometry = &viewport_geometry_js();
1.565 albertel 1640: return <<"RESIZE";
1641: <script type="text/javascript">
1.824 bisitz 1642: // <![CDATA[
1.590 raeburn 1643: $geometry
1.565 albertel 1644:
1.588 albertel 1645: function getX(element) {
1646: var x = 0;
1647: while (element) {
1648: x += element.offsetLeft;
1649: element = element.offsetParent;
1650: }
1651: return x;
1652: }
1653: function getY(element) {
1654: var y = 0;
1655: while (element) {
1656: y += element.offsetTop;
1657: element = element.offsetParent;
1658: }
1659: return y;
1660: }
1661:
1662:
1.565 albertel 1663: function resize_textarea(textarea_id,bottom_id) {
1664: init_geometry();
1665: var textarea = document.getElementById(textarea_id);
1666: //alert(textarea);
1667:
1.588 albertel 1668: var textarea_top = getY(textarea);
1.565 albertel 1669: var textarea_height = textarea.offsetHeight;
1670: var bottom = document.getElementById(bottom_id);
1.588 albertel 1671: var bottom_top = getY(bottom);
1.565 albertel 1672: var bottom_height = bottom.offsetHeight;
1673: var window_height = Geometry.getViewportHeight();
1.588 albertel 1674: var fudge = 23;
1.565 albertel 1675: var new_height = window_height-fudge-textarea_top-bottom_height;
1676: if (new_height < 300) {
1677: new_height = 300;
1678: }
1679: textarea.style.height=new_height+'px';
1680: }
1.824 bisitz 1681: // ]]>
1.565 albertel 1682: </script>
1683: RESIZE
1684:
1685: }
1686:
1687: =pod
1688:
1.256 matthew 1689: =head1 Excel and CSV file utility routines
1690:
1691: =over 4
1692:
1693: =cut
1694:
1695: ###############################################################
1696: ###############################################################
1697:
1698: =pod
1699:
1.648 raeburn 1700: =item * &csv_translate($text)
1.37 matthew 1701:
1.185 www 1702: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1703: format.
1704:
1705: =cut
1706:
1.180 matthew 1707: ###############################################################
1708: ###############################################################
1.37 matthew 1709: sub csv_translate {
1710: my $text = shift;
1711: $text =~ s/\"/\"\"/g;
1.209 albertel 1712: $text =~ s/\n/ /g;
1.37 matthew 1713: return $text;
1714: }
1.180 matthew 1715:
1716: ###############################################################
1717: ###############################################################
1718:
1719: =pod
1720:
1.648 raeburn 1721: =item * &define_excel_formats()
1.180 matthew 1722:
1723: Define some commonly used Excel cell formats.
1724:
1725: Currently supported formats:
1726:
1727: =over 4
1728:
1729: =item header
1730:
1731: =item bold
1732:
1733: =item h1
1734:
1735: =item h2
1736:
1737: =item h3
1738:
1.256 matthew 1739: =item h4
1740:
1741: =item i
1742:
1.180 matthew 1743: =item date
1744:
1745: =back
1746:
1747: Inputs: $workbook
1748:
1749: Returns: $format, a hash reference.
1750:
1.1057 foxr 1751:
1.180 matthew 1752: =cut
1753:
1754: ###############################################################
1755: ###############################################################
1756: sub define_excel_formats {
1757: my ($workbook) = @_;
1758: my $format;
1759: $format->{'header'} = $workbook->add_format(bold => 1,
1760: bottom => 1,
1761: align => 'center');
1762: $format->{'bold'} = $workbook->add_format(bold=>1);
1763: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1764: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1765: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1766: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1767: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1768: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1769: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1770: return $format;
1771: }
1772:
1773: ###############################################################
1774: ###############################################################
1.113 bowersj2 1775:
1776: =pod
1777:
1.648 raeburn 1778: =item * &create_workbook()
1.255 matthew 1779:
1780: Create an Excel worksheet. If it fails, output message on the
1781: request object and return undefs.
1782:
1783: Inputs: Apache request object
1784:
1785: Returns (undef) on failure,
1786: Excel worksheet object, scalar with filename, and formats
1787: from &Apache::loncommon::define_excel_formats on success
1788:
1789: =cut
1790:
1791: ###############################################################
1792: ###############################################################
1793: sub create_workbook {
1794: my ($r) = @_;
1795: #
1796: # Create the excel spreadsheet
1797: my $filename = '/prtspool/'.
1.258 albertel 1798: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1799: time.'_'.rand(1000000000).'.xls';
1800: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1801: if (! defined($workbook)) {
1802: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1803: $r->print(
1804: '<p class="LC_error">'
1805: .&mt('Problems occurred in creating the new Excel file.')
1806: .' '.&mt('This error has been logged.')
1807: .' '.&mt('Please alert your LON-CAPA administrator.')
1808: .'</p>'
1809: );
1.255 matthew 1810: return (undef);
1811: }
1812: #
1.1014 foxr 1813: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 1814: #
1815: my $format = &Apache::loncommon::define_excel_formats($workbook);
1816: return ($workbook,$filename,$format);
1817: }
1818:
1819: ###############################################################
1820: ###############################################################
1821:
1822: =pod
1823:
1.648 raeburn 1824: =item * &create_text_file()
1.113 bowersj2 1825:
1.542 raeburn 1826: Create a file to write to and eventually make available to the user.
1.256 matthew 1827: If file creation fails, outputs an error message on the request object and
1828: return undefs.
1.113 bowersj2 1829:
1.256 matthew 1830: Inputs: Apache request object, and file suffix
1.113 bowersj2 1831:
1.256 matthew 1832: Returns (undef) on failure,
1833: Filehandle and filename on success.
1.113 bowersj2 1834:
1835: =cut
1836:
1.256 matthew 1837: ###############################################################
1838: ###############################################################
1839: sub create_text_file {
1840: my ($r,$suffix) = @_;
1841: if (! defined($suffix)) { $suffix = 'txt'; };
1842: my $fh;
1843: my $filename = '/prtspool/'.
1.258 albertel 1844: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1845: time.'_'.rand(1000000000).'.'.$suffix;
1846: $fh = Apache::File->new('>/home/httpd'.$filename);
1847: if (! defined($fh)) {
1848: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1849: $r->print(
1850: '<p class="LC_error">'
1851: .&mt('Problems occurred in creating the output file.')
1852: .' '.&mt('This error has been logged.')
1853: .' '.&mt('Please alert your LON-CAPA administrator.')
1854: .'</p>'
1855: );
1.113 bowersj2 1856: }
1.256 matthew 1857: return ($fh,$filename)
1.113 bowersj2 1858: }
1859:
1860:
1.256 matthew 1861: =pod
1.113 bowersj2 1862:
1863: =back
1864:
1865: =cut
1.37 matthew 1866:
1867: ###############################################################
1.33 matthew 1868: ## Home server <option> list generating code ##
1869: ###############################################################
1.35 matthew 1870:
1.169 www 1871: # ------------------------------------------
1872:
1873: sub domain_select {
1874: my ($name,$value,$multiple)=@_;
1875: my %domains=map {
1.514 albertel 1876: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1877: } &Apache::lonnet::all_domains();
1.169 www 1878: if ($multiple) {
1879: $domains{''}=&mt('Any domain');
1.550 albertel 1880: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1881: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1882: } else {
1.550 albertel 1883: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 1884: return &select_form($name,$value,\%domains);
1.169 www 1885: }
1886: }
1887:
1.282 albertel 1888: #-------------------------------------------
1889:
1890: =pod
1891:
1.519 raeburn 1892: =head1 Routines for form select boxes
1893:
1894: =over 4
1895:
1.648 raeburn 1896: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1897:
1898: Returns a string containing a <select> element int multiple mode
1899:
1900:
1901: Args:
1902: $name - name of the <select> element
1.506 raeburn 1903: $value - scalar or array ref of values that should already be selected
1.282 albertel 1904: $size - number of rows long the select element is
1.283 albertel 1905: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1906: (shown text should already have been &mt())
1.506 raeburn 1907: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1908:
1.282 albertel 1909: =cut
1910:
1911: #-------------------------------------------
1.169 www 1912: sub multiple_select_form {
1.284 albertel 1913: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1914: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1915: my $output='';
1.191 matthew 1916: if (! defined($size)) {
1917: $size = 4;
1.283 albertel 1918: if (scalar(keys(%$hash))<4) {
1919: $size = scalar(keys(%$hash));
1.191 matthew 1920: }
1921: }
1.734 bisitz 1922: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1923: my @order;
1.506 raeburn 1924: if (ref($order) eq 'ARRAY') {
1925: @order = @{$order};
1926: } else {
1927: @order = sort(keys(%$hash));
1.501 banghart 1928: }
1929: if (exists($$hash{'select_form_order'})) {
1930: @order = @{$$hash{'select_form_order'}};
1931: }
1932:
1.284 albertel 1933: foreach my $key (@order) {
1.356 albertel 1934: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1935: $output.='selected="selected" ' if ($selected{$key});
1936: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1937: }
1938: $output.="</select>\n";
1939: return $output;
1940: }
1941:
1.88 www 1942: #-------------------------------------------
1943:
1944: =pod
1945:
1.970 raeburn 1946: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1947:
1948: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1949: allow a user to select options from a ref to a hash containing:
1950: option_name => displayed text. An optional $onchange can include
1951: a javascript onchange item, e.g., onchange="this.form.submit();"
1952:
1.88 www 1953: See lonrights.pm for an example invocation and use.
1954:
1955: =cut
1956:
1957: #-------------------------------------------
1958: sub select_form {
1.970 raeburn 1959: my ($def,$name,$hashref,$onchange) = @_;
1960: return unless (ref($hashref) eq 'HASH');
1961: if ($onchange) {
1962: $onchange = ' onchange="'.$onchange.'"';
1963: }
1964: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1965: my @keys;
1.970 raeburn 1966: if (exists($hashref->{'select_form_order'})) {
1967: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1968: } else {
1.970 raeburn 1969: @keys=sort(keys(%{$hashref}));
1.128 albertel 1970: }
1.356 albertel 1971: foreach my $key (@keys) {
1972: $selectform.=
1973: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1974: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1975: ">".$hashref->{$key}."</option>\n";
1.88 www 1976: }
1977: $selectform.="</select>";
1978: return $selectform;
1979: }
1980:
1.475 www 1981: # For display filters
1982:
1983: sub display_filter {
1.1074 raeburn 1984: my ($context) = @_;
1.475 www 1985: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1986: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 1987: my $phraseinput = 'hidden';
1988: my $includeinput = 'hidden';
1989: my ($checked,$includetypestext);
1990: if ($env{'form.displayfilter'} eq 'containing') {
1991: $phraseinput = 'text';
1992: if ($context eq 'parmslog') {
1993: $includeinput = 'checkbox';
1994: if ($env{'form.includetypes'}) {
1995: $checked = ' checked="checked"';
1996: }
1997: $includetypestext = &mt('Include parameter types');
1998: }
1999: } else {
2000: $includetypestext = ' ';
2001: }
2002: my ($additional,$secondid,$thirdid);
2003: if ($context eq 'parmslog') {
2004: $additional =
2005: '<label><input type="'.$includeinput.'" name="includetypes"'.
2006: $checked.' name="includetypes" value="1" id="includetypes" />'.
2007: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2008: '</label>';
2009: $secondid = 'includetypes';
2010: $thirdid = 'includetypestext';
2011: }
2012: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2013: '$secondid','$thirdid')";
2014: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2015: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2016: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2017: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2018: &mt('Filter: [_1]',
1.477 www 2019: &select_form($env{'form.displayfilter'},
2020: 'displayfilter',
1.970 raeburn 2021: {'currentfolder' => 'Current folder/page',
1.477 www 2022: 'containing' => 'Containing phrase',
1.1074 raeburn 2023: 'none' => 'None'},$onchange)).' '.
2024: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2025: &HTML::Entities::encode($env{'form.containingphrase'}).
2026: '" />'.$additional;
2027: }
2028:
2029: sub display_filter_js {
2030: my $includetext = &mt('Include parameter types');
2031: return <<"ENDJS";
2032:
2033: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2034: var firstType = 'hidden';
2035: if (setter.options[setter.selectedIndex].value == 'containing') {
2036: firstType = 'text';
2037: }
2038: firstObject = document.getElementById(firstid);
2039: if (typeof(firstObject) == 'object') {
2040: if (firstObject.type != firstType) {
2041: changeInputType(firstObject,firstType);
2042: }
2043: }
2044: if (context == 'parmslog') {
2045: var secondType = 'hidden';
2046: if (firstType == 'text') {
2047: secondType = 'checkbox';
2048: }
2049: secondObject = document.getElementById(secondid);
2050: if (typeof(secondObject) == 'object') {
2051: if (secondObject.type != secondType) {
2052: changeInputType(secondObject,secondType);
2053: }
2054: }
2055: var textItem = document.getElementById(thirdid);
2056: var currtext = textItem.innerHTML;
2057: var newtext;
2058: if (firstType == 'text') {
2059: newtext = '$includetext';
2060: } else {
2061: newtext = ' ';
2062: }
2063: if (currtext != newtext) {
2064: textItem.innerHTML = newtext;
2065: }
2066: }
2067: return;
2068: }
2069:
2070: function changeInputType(oldObject,newType) {
2071: var newObject = document.createElement('input');
2072: newObject.type = newType;
2073: if (oldObject.size) {
2074: newObject.size = oldObject.size;
2075: }
2076: if (oldObject.value) {
2077: newObject.value = oldObject.value;
2078: }
2079: if (oldObject.name) {
2080: newObject.name = oldObject.name;
2081: }
2082: if (oldObject.id) {
2083: newObject.id = oldObject.id;
2084: }
2085: oldObject.parentNode.replaceChild(newObject,oldObject);
2086: return;
2087: }
2088:
2089: ENDJS
1.475 www 2090: }
2091:
1.167 www 2092: sub gradeleveldescription {
2093: my $gradelevel=shift;
2094: my %gradelevels=(0 => 'Not specified',
2095: 1 => 'Grade 1',
2096: 2 => 'Grade 2',
2097: 3 => 'Grade 3',
2098: 4 => 'Grade 4',
2099: 5 => 'Grade 5',
2100: 6 => 'Grade 6',
2101: 7 => 'Grade 7',
2102: 8 => 'Grade 8',
2103: 9 => 'Grade 9',
2104: 10 => 'Grade 10',
2105: 11 => 'Grade 11',
2106: 12 => 'Grade 12',
2107: 13 => 'Grade 13',
2108: 14 => '100 Level',
2109: 15 => '200 Level',
2110: 16 => '300 Level',
2111: 17 => '400 Level',
2112: 18 => 'Graduate Level');
2113: return &mt($gradelevels{$gradelevel});
2114: }
2115:
1.163 www 2116: sub select_level_form {
2117: my ($deflevel,$name)=@_;
2118: unless ($deflevel) { $deflevel=0; }
1.167 www 2119: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2120: for (my $i=0; $i<=18; $i++) {
2121: $selectform.="<option value=\"$i\" ".
1.253 albertel 2122: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2123: ">".&gradeleveldescription($i)."</option>\n";
2124: }
2125: $selectform.="</select>";
2126: return $selectform;
1.163 www 2127: }
1.167 www 2128:
1.35 matthew 2129: #-------------------------------------------
2130:
1.45 matthew 2131: =pod
2132:
1.910 raeburn 2133: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 2134:
2135: Returns a string containing a <select name='$name' size='1'> form to
2136: allow a user to select the domain to preform an operation in.
2137: See loncreateuser.pm for an example invocation and use.
2138:
1.90 www 2139: If the $includeempty flag is set, it also includes an empty choice ("no domain
2140: selected");
2141:
1.743 raeburn 2142: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2143:
1.910 raeburn 2144: 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.
2145:
2146: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 2147:
1.35 matthew 2148: =cut
2149:
2150: #-------------------------------------------
1.34 matthew 2151: sub select_dom_form {
1.910 raeburn 2152: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 2153: if ($onchange) {
1.874 raeburn 2154: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2155: }
1.910 raeburn 2156: my @domains;
2157: if (ref($incdoms) eq 'ARRAY') {
2158: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2159: } else {
2160: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2161: }
1.90 www 2162: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 2163: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 2164: foreach my $dom (@domains) {
2165: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2166: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2167: if ($showdomdesc) {
2168: if ($dom ne '') {
2169: my $domdesc = &Apache::lonnet::domain($dom,'description');
2170: if ($domdesc ne '') {
2171: $selectdomain .= ' ('.$domdesc.')';
2172: }
2173: }
2174: }
2175: $selectdomain .= "</option>\n";
1.34 matthew 2176: }
2177: $selectdomain.="</select>";
2178: return $selectdomain;
2179: }
2180:
1.35 matthew 2181: #-------------------------------------------
2182:
1.45 matthew 2183: =pod
2184:
1.648 raeburn 2185: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2186:
1.586 raeburn 2187: input: 4 arguments (two required, two optional) -
2188: $domain - domain of new user
2189: $name - name of form element
2190: $default - Value of 'default' causes a default item to be first
2191: option, and selected by default.
2192: $hide - Value of 'hide' causes hiding of the name of the server,
2193: if 1 server found, or default, if 0 found.
1.594 raeburn 2194: output: returns 2 items:
1.586 raeburn 2195: (a) form element which contains either:
2196: (i) <select name="$name">
2197: <option value="$hostid1">$hostid $servers{$hostid}</option>
2198: <option value="$hostid2">$hostid $servers{$hostid}</option>
2199: </select>
2200: form item if there are multiple library servers in $domain, or
2201: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2202: if there is only one library server in $domain.
2203:
2204: (b) number of library servers found.
2205:
2206: See loncreateuser.pm for example of use.
1.35 matthew 2207:
2208: =cut
2209:
2210: #-------------------------------------------
1.586 raeburn 2211: sub home_server_form_item {
2212: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2213: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2214: my $result;
2215: my $numlib = keys(%servers);
2216: if ($numlib > 1) {
2217: $result .= '<select name="'.$name.'" />'."\n";
2218: if ($default) {
1.804 bisitz 2219: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2220: '</option>'."\n";
2221: }
2222: foreach my $hostid (sort(keys(%servers))) {
2223: $result.= '<option value="'.$hostid.'">'.
2224: $hostid.' '.$servers{$hostid}."</option>\n";
2225: }
2226: $result .= '</select>'."\n";
2227: } elsif ($numlib == 1) {
2228: my $hostid;
2229: foreach my $item (keys(%servers)) {
2230: $hostid = $item;
2231: }
2232: $result .= '<input type="hidden" name="'.$name.'" value="'.
2233: $hostid.'" />';
2234: if (!$hide) {
2235: $result .= $hostid.' '.$servers{$hostid};
2236: }
2237: $result .= "\n";
2238: } elsif ($default) {
2239: $result .= '<input type="hidden" name="'.$name.
2240: '" value="default" />';
2241: if (!$hide) {
2242: $result .= &mt('default');
2243: }
2244: $result .= "\n";
1.33 matthew 2245: }
1.586 raeburn 2246: return ($result,$numlib);
1.33 matthew 2247: }
1.112 bowersj2 2248:
2249: =pod
2250:
1.534 albertel 2251: =back
2252:
1.112 bowersj2 2253: =cut
1.87 matthew 2254:
2255: ###############################################################
1.112 bowersj2 2256: ## Decoding User Agent ##
1.87 matthew 2257: ###############################################################
2258:
2259: =pod
2260:
1.112 bowersj2 2261: =head1 Decoding the User Agent
2262:
2263: =over 4
2264:
2265: =item * &decode_user_agent()
1.87 matthew 2266:
2267: Inputs: $r
2268:
2269: Outputs:
2270:
2271: =over 4
2272:
1.112 bowersj2 2273: =item * $httpbrowser
1.87 matthew 2274:
1.112 bowersj2 2275: =item * $clientbrowser
1.87 matthew 2276:
1.112 bowersj2 2277: =item * $clientversion
1.87 matthew 2278:
1.112 bowersj2 2279: =item * $clientmathml
1.87 matthew 2280:
1.112 bowersj2 2281: =item * $clientunicode
1.87 matthew 2282:
1.112 bowersj2 2283: =item * $clientos
1.87 matthew 2284:
2285: =back
2286:
1.157 matthew 2287: =back
2288:
1.87 matthew 2289: =cut
2290:
2291: ###############################################################
2292: ###############################################################
2293: sub decode_user_agent {
1.247 albertel 2294: my ($r)=@_;
1.87 matthew 2295: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2296: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2297: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2298: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2299: my $clientbrowser='unknown';
2300: my $clientversion='0';
2301: my $clientmathml='';
2302: my $clientunicode='0';
2303: for (my $i=0;$i<=$#browsertype;$i++) {
2304: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2305: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2306: $clientbrowser=$bname;
2307: $httpbrowser=~/$vreg/i;
2308: $clientversion=$1;
2309: $clientmathml=($clientversion>=$minv);
2310: $clientunicode=($clientversion>=$univ);
2311: }
2312: }
2313: my $clientos='unknown';
2314: if (($httpbrowser=~/linux/i) ||
2315: ($httpbrowser=~/unix/i) ||
2316: ($httpbrowser=~/ux/i) ||
2317: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2318: if (($httpbrowser=~/vax/i) ||
2319: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2320: if ($httpbrowser=~/next/i) { $clientos='next'; }
2321: if (($httpbrowser=~/mac/i) ||
2322: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2323: if ($httpbrowser=~/win/i) { $clientos='win'; }
2324: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2325: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2326: $clientunicode,$clientos,);
2327: }
2328:
1.32 matthew 2329: ###############################################################
2330: ## Authentication changing form generation subroutines ##
2331: ###############################################################
2332: ##
2333: ## All of the authform_xxxxxxx subroutines take their inputs in a
2334: ## hash, and have reasonable default values.
2335: ##
2336: ## formname = the name given in the <form> tag.
1.35 matthew 2337: #-------------------------------------------
2338:
1.45 matthew 2339: =pod
2340:
1.112 bowersj2 2341: =head1 Authentication Routines
2342:
2343: =over 4
2344:
1.648 raeburn 2345: =item * &authform_xxxxxx()
1.35 matthew 2346:
2347: The authform_xxxxxx subroutines provide javascript and html forms which
2348: handle some of the conveniences required for authentication forms.
2349: This is not an optimal method, but it works.
2350:
2351: =over 4
2352:
1.112 bowersj2 2353: =item * authform_header
1.35 matthew 2354:
1.112 bowersj2 2355: =item * authform_authorwarning
1.35 matthew 2356:
1.112 bowersj2 2357: =item * authform_nochange
1.35 matthew 2358:
1.112 bowersj2 2359: =item * authform_kerberos
1.35 matthew 2360:
1.112 bowersj2 2361: =item * authform_internal
1.35 matthew 2362:
1.112 bowersj2 2363: =item * authform_filesystem
1.35 matthew 2364:
2365: =back
2366:
1.648 raeburn 2367: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2368:
1.35 matthew 2369: =cut
2370:
2371: #-------------------------------------------
1.32 matthew 2372: sub authform_header{
2373: my %in = (
2374: formname => 'cu',
1.80 albertel 2375: kerb_def_dom => '',
1.32 matthew 2376: @_,
2377: );
2378: $in{'formname'} = 'document.' . $in{'formname'};
2379: my $result='';
1.80 albertel 2380:
2381: #---------------------------------------------- Code for upper case translation
2382: my $Javascript_toUpperCase;
2383: unless ($in{kerb_def_dom}) {
2384: $Javascript_toUpperCase =<<"END";
2385: switch (choice) {
2386: case 'krb': currentform.elements[choicearg].value =
2387: currentform.elements[choicearg].value.toUpperCase();
2388: break;
2389: default:
2390: }
2391: END
2392: } else {
2393: $Javascript_toUpperCase = "";
2394: }
2395:
1.165 raeburn 2396: my $radioval = "'nochange'";
1.591 raeburn 2397: if (defined($in{'curr_authtype'})) {
2398: if ($in{'curr_authtype'} ne '') {
2399: $radioval = "'".$in{'curr_authtype'}."arg'";
2400: }
1.174 matthew 2401: }
1.165 raeburn 2402: my $argfield = 'null';
1.591 raeburn 2403: if (defined($in{'mode'})) {
1.165 raeburn 2404: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2405: if (defined($in{'curr_autharg'})) {
2406: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2407: $argfield = "'$in{'curr_autharg'}'";
2408: }
2409: }
2410: }
2411: }
2412:
1.32 matthew 2413: $result.=<<"END";
2414: var current = new Object();
1.165 raeburn 2415: current.radiovalue = $radioval;
2416: current.argfield = $argfield;
1.32 matthew 2417:
2418: function changed_radio(choice,currentform) {
2419: var choicearg = choice + 'arg';
2420: // If a radio button in changed, we need to change the argfield
2421: if (current.radiovalue != choice) {
2422: current.radiovalue = choice;
2423: if (current.argfield != null) {
2424: currentform.elements[current.argfield].value = '';
2425: }
2426: if (choice == 'nochange') {
2427: current.argfield = null;
2428: } else {
2429: current.argfield = choicearg;
2430: switch(choice) {
2431: case 'krb':
2432: currentform.elements[current.argfield].value =
2433: "$in{'kerb_def_dom'}";
2434: break;
2435: default:
2436: break;
2437: }
2438: }
2439: }
2440: return;
2441: }
1.22 www 2442:
1.32 matthew 2443: function changed_text(choice,currentform) {
2444: var choicearg = choice + 'arg';
2445: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2446: $Javascript_toUpperCase
1.32 matthew 2447: // clear old field
2448: if ((current.argfield != choicearg) && (current.argfield != null)) {
2449: currentform.elements[current.argfield].value = '';
2450: }
2451: current.argfield = choicearg;
2452: }
2453: set_auth_radio_buttons(choice,currentform);
2454: return;
1.20 www 2455: }
1.32 matthew 2456:
2457: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2458: var numauthchoices = currentform.login.length;
2459: if (typeof numauthchoices == "undefined") {
2460: return;
2461: }
1.32 matthew 2462: var i=0;
1.986 raeburn 2463: while (i < numauthchoices) {
1.32 matthew 2464: if (currentform.login[i].value == newvalue) { break; }
2465: i++;
2466: }
1.986 raeburn 2467: if (i == numauthchoices) {
1.32 matthew 2468: return;
2469: }
2470: current.radiovalue = newvalue;
2471: currentform.login[i].checked = true;
2472: return;
2473: }
2474: END
2475: return $result;
2476: }
2477:
2478: sub authform_authorwarning{
2479: my $result='';
1.144 matthew 2480: $result='<i>'.
2481: &mt('As a general rule, only authors or co-authors should be '.
2482: 'filesystem authenticated '.
2483: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2484: return $result;
2485: }
2486:
2487: sub authform_nochange{
2488: my %in = (
2489: formname => 'document.cu',
2490: kerb_def_dom => 'MSU.EDU',
2491: @_,
2492: );
1.586 raeburn 2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2494: my $result;
2495: if (keys(%can_assign) == 0) {
2496: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2497: } else {
2498: $result = '<label>'.&mt('[_1] Do not change login data',
2499: '<input type="radio" name="login" value="nochange" '.
2500: 'checked="checked" onclick="'.
1.281 albertel 2501: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2502: '</label>';
1.586 raeburn 2503: }
1.32 matthew 2504: return $result;
2505: }
2506:
1.591 raeburn 2507: sub authform_kerberos {
1.32 matthew 2508: my %in = (
2509: formname => 'document.cu',
2510: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2511: kerb_def_auth => 'krb4',
1.32 matthew 2512: @_,
2513: );
1.586 raeburn 2514: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2515: $autharg,$jscall);
2516: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2517: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2518: $check5 = ' checked="checked"';
1.80 albertel 2519: } else {
1.772 bisitz 2520: $check4 = ' checked="checked"';
1.80 albertel 2521: }
1.165 raeburn 2522: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2523: if (defined($in{'curr_authtype'})) {
2524: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2525: $krbcheck = ' checked="checked"';
1.623 raeburn 2526: if (defined($in{'mode'})) {
2527: if ($in{'mode'} eq 'modifyuser') {
2528: $krbcheck = '';
2529: }
2530: }
1.591 raeburn 2531: if (defined($in{'curr_kerb_ver'})) {
2532: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2533: $check5 = ' checked="checked"';
1.591 raeburn 2534: $check4 = '';
2535: } else {
1.772 bisitz 2536: $check4 = ' checked="checked"';
1.591 raeburn 2537: $check5 = '';
2538: }
1.586 raeburn 2539: }
1.591 raeburn 2540: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2541: $krbarg = $in{'curr_autharg'};
2542: }
1.586 raeburn 2543: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2544: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2545: $result =
2546: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2547: $in{'curr_autharg'},$krbver);
2548: } else {
2549: $result =
2550: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2551: }
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2558: }
2559: }
1.586 raeburn 2560: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="krb" '.
2574: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2575: $krbcheck.' />';
2576: }
2577: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2578: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2579: $in{'curr_authtype'} eq 'krb5') ||
2580: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2581: $in{'curr_authtype'} eq 'krb4')) {
2582: $result .= &mt
1.144 matthew 2583: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2584: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2585: '<label>'.$authtype,
1.281 albertel 2586: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2587: 'value="'.$krbarg.'" '.
1.144 matthew 2588: 'onchange="'.$jscall.'" />',
1.281 albertel 2589: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2590: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2591: '</label>');
1.586 raeburn 2592: } elsif ($can_assign{'krb4'}) {
2593: $result .= &mt
2594: ('[_1] Kerberos authenticated with domain [_2] '.
2595: '[_3] Version 4 [_4]',
2596: '<label>'.$authtype,
2597: '</label><input type="text" size="10" name="krbarg" '.
2598: 'value="'.$krbarg.'" '.
2599: 'onchange="'.$jscall.'" />',
2600: '<label><input type="hidden" name="krbver" value="4" />',
2601: '</label>');
2602: } elsif ($can_assign{'krb5'}) {
2603: $result .= &mt
2604: ('[_1] Kerberos authenticated with domain [_2] '.
2605: '[_3] Version 5 [_4]',
2606: '<label>'.$authtype,
2607: '</label><input type="text" size="10" name="krbarg" '.
2608: 'value="'.$krbarg.'" '.
2609: 'onchange="'.$jscall.'" />',
2610: '<label><input type="hidden" name="krbver" value="5" />',
2611: '</label>');
2612: }
1.32 matthew 2613: return $result;
2614: }
2615:
2616: sub authform_internal{
1.586 raeburn 2617: my %in = (
1.32 matthew 2618: formname => 'document.cu',
2619: kerb_def_dom => 'MSU.EDU',
2620: @_,
2621: );
1.586 raeburn 2622: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2623: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2624: if (defined($in{'curr_authtype'})) {
2625: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2626: if ($can_assign{'int'}) {
1.772 bisitz 2627: $intcheck = 'checked="checked" ';
1.623 raeburn 2628: if (defined($in{'mode'})) {
2629: if ($in{'mode'} eq 'modifyuser') {
2630: $intcheck = '';
2631: }
2632: }
1.591 raeburn 2633: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2634: $intarg = $in{'curr_autharg'};
2635: }
2636: } else {
2637: $result = &mt('Currently internally authenticated.');
2638: return $result;
1.165 raeburn 2639: }
2640: }
1.586 raeburn 2641: } else {
2642: if ($authnum == 1) {
1.784 bisitz 2643: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2644: }
2645: }
2646: if (!$can_assign{'int'}) {
2647: return;
1.587 raeburn 2648: } elsif ($authtype eq '') {
1.591 raeburn 2649: if (defined($in{'mode'})) {
1.587 raeburn 2650: if ($in{'mode'} eq 'modifycourse') {
2651: if ($authnum == 1) {
1.784 bisitz 2652: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2653: }
2654: }
2655: }
1.165 raeburn 2656: }
1.586 raeburn 2657: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2658: if ($authtype eq '') {
2659: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2660: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2661: }
1.605 bisitz 2662: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2663: $intarg.'" onchange="'.$jscall.'" />';
2664: $result = &mt
1.144 matthew 2665: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2666: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2667: $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 2668: return $result;
2669: }
2670:
2671: sub authform_local{
2672: my %in = (
2673: formname => 'document.cu',
2674: kerb_def_dom => 'MSU.EDU',
2675: @_,
2676: );
1.586 raeburn 2677: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2678: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2679: if (defined($in{'curr_authtype'})) {
2680: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2681: if ($can_assign{'loc'}) {
1.772 bisitz 2682: $loccheck = 'checked="checked" ';
1.623 raeburn 2683: if (defined($in{'mode'})) {
2684: if ($in{'mode'} eq 'modifyuser') {
2685: $loccheck = '';
2686: }
2687: }
1.591 raeburn 2688: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2689: $locarg = $in{'curr_autharg'};
2690: }
2691: } else {
2692: $result = &mt('Currently using local (institutional) authentication.');
2693: return $result;
1.165 raeburn 2694: }
2695: }
1.586 raeburn 2696: } else {
2697: if ($authnum == 1) {
1.784 bisitz 2698: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2699: }
2700: }
2701: if (!$can_assign{'loc'}) {
2702: return;
1.587 raeburn 2703: } elsif ($authtype eq '') {
1.591 raeburn 2704: if (defined($in{'mode'})) {
1.587 raeburn 2705: if ($in{'mode'} eq 'modifycourse') {
2706: if ($authnum == 1) {
1.784 bisitz 2707: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2708: }
2709: }
2710: }
1.165 raeburn 2711: }
1.586 raeburn 2712: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2713: if ($authtype eq '') {
2714: $authtype = '<input type="radio" name="login" value="loc" '.
2715: $loccheck.' onchange="'.$jscall.'" onclick="'.
2716: $jscall.'" />';
2717: }
2718: $autharg = '<input type="text" size="10" name="locarg" value="'.
2719: $locarg.'" onchange="'.$jscall.'" />';
2720: $result = &mt('[_1] Local Authentication with argument [_2]',
2721: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2722: return $result;
2723: }
2724:
2725: sub authform_filesystem{
2726: my %in = (
2727: formname => 'document.cu',
2728: kerb_def_dom => 'MSU.EDU',
2729: @_,
2730: );
1.586 raeburn 2731: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2732: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2733: if (defined($in{'curr_authtype'})) {
2734: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2735: if ($can_assign{'fsys'}) {
1.772 bisitz 2736: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2737: if (defined($in{'mode'})) {
2738: if ($in{'mode'} eq 'modifyuser') {
2739: $fsyscheck = '';
2740: }
2741: }
1.586 raeburn 2742: } else {
2743: $result = &mt('Currently Filesystem Authenticated.');
2744: return $result;
2745: }
2746: }
2747: } else {
2748: if ($authnum == 1) {
1.784 bisitz 2749: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2750: }
2751: }
2752: if (!$can_assign{'fsys'}) {
2753: return;
1.587 raeburn 2754: } elsif ($authtype eq '') {
1.591 raeburn 2755: if (defined($in{'mode'})) {
1.587 raeburn 2756: if ($in{'mode'} eq 'modifycourse') {
2757: if ($authnum == 1) {
1.784 bisitz 2758: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2759: }
2760: }
2761: }
1.586 raeburn 2762: }
2763: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2764: if ($authtype eq '') {
2765: $authtype = '<input type="radio" name="login" value="fsys" '.
2766: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2767: $jscall.'" />';
2768: }
2769: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2770: ' onchange="'.$jscall.'" />';
2771: $result = &mt
1.144 matthew 2772: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2773: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2774: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2775: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2776: 'onchange="'.$jscall.'" />');
1.32 matthew 2777: return $result;
2778: }
2779:
1.586 raeburn 2780: sub get_assignable_auth {
2781: my ($dom) = @_;
2782: if ($dom eq '') {
2783: $dom = $env{'request.role.domain'};
2784: }
2785: my %can_assign = (
2786: krb4 => 1,
2787: krb5 => 1,
2788: int => 1,
2789: loc => 1,
2790: );
2791: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2792: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2793: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2794: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2795: my $context;
2796: if ($env{'request.role'} =~ /^au/) {
2797: $context = 'author';
2798: } elsif ($env{'request.role'} =~ /^dc/) {
2799: $context = 'domain';
2800: } elsif ($env{'request.course.id'}) {
2801: $context = 'course';
2802: }
2803: if ($context) {
2804: if (ref($authhash->{$context}) eq 'HASH') {
2805: %can_assign = %{$authhash->{$context}};
2806: }
2807: }
2808: }
2809: }
2810: my $authnum = 0;
2811: foreach my $key (keys(%can_assign)) {
2812: if ($can_assign{$key}) {
2813: $authnum ++;
2814: }
2815: }
2816: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2817: $authnum --;
2818: }
2819: return ($authnum,%can_assign);
2820: }
2821:
1.80 albertel 2822: ###############################################################
2823: ## Get Kerberos Defaults for Domain ##
2824: ###############################################################
2825: ##
2826: ## Returns default kerberos version and an associated argument
2827: ## as listed in file domain.tab. If not listed, provides
2828: ## appropriate default domain and kerberos version.
2829: ##
2830: #-------------------------------------------
2831:
2832: =pod
2833:
1.648 raeburn 2834: =item * &get_kerberos_defaults()
1.80 albertel 2835:
2836: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2837: version and domain. If not found, it defaults to version 4 and the
2838: domain of the server.
1.80 albertel 2839:
1.648 raeburn 2840: =over 4
2841:
1.80 albertel 2842: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2843:
1.648 raeburn 2844: =back
2845:
2846: =back
2847:
1.80 albertel 2848: =cut
2849:
2850: #-------------------------------------------
2851: sub get_kerberos_defaults {
2852: my $domain=shift;
1.641 raeburn 2853: my ($krbdef,$krbdefdom);
2854: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2855: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2856: $krbdef = $domdefaults{'auth_def'};
2857: $krbdefdom = $domdefaults{'auth_arg_def'};
2858: } else {
1.80 albertel 2859: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2860: my $krbdefdom=$1;
2861: $krbdefdom=~tr/a-z/A-Z/;
2862: $krbdef = "krb4";
2863: }
2864: return ($krbdef,$krbdefdom);
2865: }
1.112 bowersj2 2866:
1.32 matthew 2867:
1.46 matthew 2868: ###############################################################
2869: ## Thesaurus Functions ##
2870: ###############################################################
1.20 www 2871:
1.46 matthew 2872: =pod
1.20 www 2873:
1.112 bowersj2 2874: =head1 Thesaurus Functions
2875:
2876: =over 4
2877:
1.648 raeburn 2878: =item * &initialize_keywords()
1.46 matthew 2879:
2880: Initializes the package variable %Keywords if it is empty. Uses the
2881: package variable $thesaurus_db_file.
2882:
2883: =cut
2884:
2885: ###################################################
2886:
2887: sub initialize_keywords {
2888: return 1 if (scalar keys(%Keywords));
2889: # If we are here, %Keywords is empty, so fill it up
2890: # Make sure the file we need exists...
2891: if (! -e $thesaurus_db_file) {
2892: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2893: " failed because it does not exist");
2894: return 0;
2895: }
2896: # Set up the hash as a database
2897: my %thesaurus_db;
2898: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2899: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2900: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2901: $thesaurus_db_file);
2902: return 0;
2903: }
2904: # Get the average number of appearances of a word.
2905: my $avecount = $thesaurus_db{'average.count'};
2906: # Put keywords (those that appear > average) into %Keywords
2907: while (my ($word,$data)=each (%thesaurus_db)) {
2908: my ($count,undef) = split /:/,$data;
2909: $Keywords{$word}++ if ($count > $avecount);
2910: }
2911: untie %thesaurus_db;
2912: # Remove special values from %Keywords.
1.356 albertel 2913: foreach my $value ('total.count','average.count') {
2914: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2915: }
1.46 matthew 2916: return 1;
2917: }
2918:
2919: ###################################################
2920:
2921: =pod
2922:
1.648 raeburn 2923: =item * &keyword($word)
1.46 matthew 2924:
2925: Returns true if $word is a keyword. A keyword is a word that appears more
2926: than the average number of times in the thesaurus database. Calls
2927: &initialize_keywords
2928:
2929: =cut
2930:
2931: ###################################################
1.20 www 2932:
2933: sub keyword {
1.46 matthew 2934: return if (!&initialize_keywords());
2935: my $word=lc(shift());
2936: $word=~s/\W//g;
2937: return exists($Keywords{$word});
1.20 www 2938: }
1.46 matthew 2939:
2940: ###############################################################
2941:
2942: =pod
1.20 www 2943:
1.648 raeburn 2944: =item * &get_related_words()
1.46 matthew 2945:
1.160 matthew 2946: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2947: an array of words. If the keyword is not in the thesaurus, an empty array
2948: will be returned. The order of the words returned is determined by the
2949: database which holds them.
2950:
2951: Uses global $thesaurus_db_file.
2952:
1.1057 foxr 2953:
1.46 matthew 2954: =cut
2955:
2956: ###############################################################
2957: sub get_related_words {
2958: my $keyword = shift;
2959: my %thesaurus_db;
2960: if (! -e $thesaurus_db_file) {
2961: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2962: "failed because the file does not exist");
2963: return ();
2964: }
2965: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2966: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2967: return ();
2968: }
2969: my @Words=();
1.429 www 2970: my $count=0;
1.46 matthew 2971: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2972: # The first element is the number of times
2973: # the word appears. We do not need it now.
1.429 www 2974: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2975: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2976: my $threshold=$mostfrequentcount/10;
2977: foreach my $possibleword (@RelatedWords) {
2978: my ($word,$wordcount)=split(/\,/,$possibleword);
2979: if ($wordcount>$threshold) {
2980: push(@Words,$word);
2981: $count++;
2982: if ($count>10) { last; }
2983: }
1.20 www 2984: }
2985: }
1.46 matthew 2986: untie %thesaurus_db;
2987: return @Words;
1.14 harris41 2988: }
1.46 matthew 2989:
1.112 bowersj2 2990: =pod
2991:
2992: =back
2993:
2994: =cut
1.61 www 2995:
2996: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2997: =pod
2998:
1.112 bowersj2 2999: =head1 User Name Functions
3000:
3001: =over 4
3002:
1.648 raeburn 3003: =item * &plainname($uname,$udom,$first)
1.81 albertel 3004:
1.112 bowersj2 3005: Takes a users logon name and returns it as a string in
1.226 albertel 3006: "first middle last generation" form
3007: if $first is set to 'lastname' then it returns it as
3008: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3009:
3010: =cut
1.61 www 3011:
1.295 www 3012:
1.81 albertel 3013: ###############################################################
1.61 www 3014: sub plainname {
1.226 albertel 3015: my ($uname,$udom,$first)=@_;
1.537 albertel 3016: return if (!defined($uname) || !defined($udom));
1.295 www 3017: my %names=&getnames($uname,$udom);
1.226 albertel 3018: my $name=&Apache::lonnet::format_name($names{'firstname'},
3019: $names{'middlename'},
3020: $names{'lastname'},
3021: $names{'generation'},$first);
3022: $name=~s/^\s+//;
1.62 www 3023: $name=~s/\s+$//;
3024: $name=~s/\s+/ /g;
1.353 albertel 3025: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3026: return $name;
1.61 www 3027: }
1.66 www 3028:
3029: # -------------------------------------------------------------------- Nickname
1.81 albertel 3030: =pod
3031:
1.648 raeburn 3032: =item * &nickname($uname,$udom)
1.81 albertel 3033:
3034: Gets a users name and returns it as a string as
3035:
3036: ""nickname""
1.66 www 3037:
1.81 albertel 3038: if the user has a nickname or
3039:
3040: "first middle last generation"
3041:
3042: if the user does not
3043:
3044: =cut
1.66 www 3045:
3046: sub nickname {
3047: my ($uname,$udom)=@_;
1.537 albertel 3048: return if (!defined($uname) || !defined($udom));
1.295 www 3049: my %names=&getnames($uname,$udom);
1.68 albertel 3050: my $name=$names{'nickname'};
1.66 www 3051: if ($name) {
3052: $name='"'.$name.'"';
3053: } else {
3054: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3055: $names{'lastname'}.' '.$names{'generation'};
3056: $name=~s/\s+$//;
3057: $name=~s/\s+/ /g;
3058: }
3059: return $name;
3060: }
3061:
1.295 www 3062: sub getnames {
3063: my ($uname,$udom)=@_;
1.537 albertel 3064: return if (!defined($uname) || !defined($udom));
1.433 albertel 3065: if ($udom eq 'public' && $uname eq 'public') {
3066: return ('lastname' => &mt('Public'));
3067: }
1.295 www 3068: my $id=$uname.':'.$udom;
3069: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3070: if ($cached) {
3071: return %{$names};
3072: } else {
3073: my %loadnames=&Apache::lonnet::get('environment',
3074: ['firstname','middlename','lastname','generation','nickname'],
3075: $udom,$uname);
3076: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3077: return %loadnames;
3078: }
3079: }
1.61 www 3080:
1.542 raeburn 3081: # -------------------------------------------------------------------- getemails
1.648 raeburn 3082:
1.542 raeburn 3083: =pod
3084:
1.648 raeburn 3085: =item * &getemails($uname,$udom)
1.542 raeburn 3086:
3087: Gets a user's email information and returns it as a hash with keys:
3088: notification, critnotification, permanentemail
3089:
3090: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3091: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3092:
1.648 raeburn 3093:
1.542 raeburn 3094: =cut
3095:
1.648 raeburn 3096:
1.466 albertel 3097: sub getemails {
3098: my ($uname,$udom)=@_;
3099: if ($udom eq 'public' && $uname eq 'public') {
3100: return;
3101: }
1.467 www 3102: if (!$udom) { $udom=$env{'user.domain'}; }
3103: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3104: my $id=$uname.':'.$udom;
3105: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3106: if ($cached) {
3107: return %{$names};
3108: } else {
3109: my %loadnames=&Apache::lonnet::get('environment',
3110: ['notification','critnotification',
3111: 'permanentemail'],
3112: $udom,$uname);
3113: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3114: return %loadnames;
3115: }
3116: }
3117:
1.551 albertel 3118: sub flush_email_cache {
3119: my ($uname,$udom)=@_;
3120: if (!$udom) { $udom =$env{'user.domain'}; }
3121: if (!$uname) { $uname=$env{'user.name'}; }
3122: return if ($udom eq 'public' && $uname eq 'public');
3123: my $id=$uname.':'.$udom;
3124: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3125: }
3126:
1.728 raeburn 3127: # -------------------------------------------------------------------- getlangs
3128:
3129: =pod
3130:
3131: =item * &getlangs($uname,$udom)
3132:
3133: Gets a user's language preference and returns it as a hash with key:
3134: language.
3135:
3136: =cut
3137:
3138:
3139: sub getlangs {
3140: my ($uname,$udom) = @_;
3141: if (!$udom) { $udom =$env{'user.domain'}; }
3142: if (!$uname) { $uname=$env{'user.name'}; }
3143: my $id=$uname.':'.$udom;
3144: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3145: if ($cached) {
3146: return %{$langs};
3147: } else {
3148: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3149: $udom,$uname);
3150: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3151: return %loadlangs;
3152: }
3153: }
3154:
3155: sub flush_langs_cache {
3156: my ($uname,$udom)=@_;
3157: if (!$udom) { $udom =$env{'user.domain'}; }
3158: if (!$uname) { $uname=$env{'user.name'}; }
3159: return if ($udom eq 'public' && $uname eq 'public');
3160: my $id=$uname.':'.$udom;
3161: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3162: }
3163:
1.61 www 3164: # ------------------------------------------------------------------ Screenname
1.81 albertel 3165:
3166: =pod
3167:
1.648 raeburn 3168: =item * &screenname($uname,$udom)
1.81 albertel 3169:
3170: Gets a users screenname and returns it as a string
3171:
3172: =cut
1.61 www 3173:
3174: sub screenname {
3175: my ($uname,$udom)=@_;
1.258 albertel 3176: if ($uname eq $env{'user.name'} &&
3177: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3178: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3179: return $names{'screenname'};
1.62 www 3180: }
3181:
1.212 albertel 3182:
1.802 bisitz 3183: # ------------------------------------------------------------- Confirm Wrapper
3184: =pod
3185:
3186: =item confirmwrapper
3187:
3188: Wrap messages about completion of operation in box
3189:
3190: =cut
3191:
3192: sub confirmwrapper {
3193: my ($message)=@_;
3194: if ($message) {
3195: return "\n".'<div class="LC_confirm_box">'."\n"
3196: .$message."\n"
3197: .'</div>'."\n";
3198: } else {
3199: return $message;
3200: }
3201: }
3202:
1.62 www 3203: # ------------------------------------------------------------- Message Wrapper
3204:
3205: sub messagewrapper {
1.369 www 3206: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3207: return
1.441 albertel 3208: '<a href="/adm/email?compose=individual&'.
3209: 'recname='.$username.'&recdom='.$domain.
3210: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3211: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3212: }
1.802 bisitz 3213:
1.74 www 3214: # --------------------------------------------------------------- Notes Wrapper
3215:
3216: sub noteswrapper {
3217: my ($link,$un,$do)=@_;
3218: return
1.896 amueller 3219: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3220: }
1.802 bisitz 3221:
1.62 www 3222: # ------------------------------------------------------------- Aboutme Wrapper
3223:
3224: sub aboutmewrapper {
1.1070 raeburn 3225: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3226: if (!defined($username) && !defined($domain)) {
3227: return;
3228: }
1.892 amueller 3229: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.1070 raeburn 3230: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3231: }
3232:
3233: # ------------------------------------------------------------ Syllabus Wrapper
3234:
3235: sub syllabuswrapper {
1.707 bisitz 3236: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3237: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3238: }
1.14 harris41 3239:
1.802 bisitz 3240: # -----------------------------------------------------------------------------
3241:
1.208 matthew 3242: sub track_student_link {
1.887 raeburn 3243: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3244: my $link ="/adm/trackstudent?";
1.208 matthew 3245: my $title = 'View recent activity';
3246: if (defined($sname) && $sname !~ /^\s*$/ &&
3247: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3248: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3249: $title .= ' of this student';
1.268 albertel 3250: }
1.208 matthew 3251: if (defined($target) && $target !~ /^\s*$/) {
3252: $target = qq{target="$target"};
3253: } else {
3254: $target = '';
3255: }
1.268 albertel 3256: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3257: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3258: $title = &mt($title);
3259: $linktext = &mt($linktext);
1.448 albertel 3260: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3261: &help_open_topic('View_recent_activity');
1.208 matthew 3262: }
3263:
1.781 raeburn 3264: sub slot_reservations_link {
3265: my ($linktext,$sname,$sdom,$target) = @_;
3266: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3267: my $title = 'View slot reservation history';
3268: if (defined($sname) && $sname !~ /^\s*$/ &&
3269: defined($sdom) && $sdom !~ /^\s*$/) {
3270: $link .= "&uname=$sname&udom=$sdom";
3271: $title .= ' of this student';
3272: }
3273: if (defined($target) && $target !~ /^\s*$/) {
3274: $target = qq{target="$target"};
3275: } else {
3276: $target = '';
3277: }
3278: $title = &mt($title);
3279: $linktext = &mt($linktext);
3280: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3281: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3282:
3283: }
3284:
1.508 www 3285: # ===================================================== Display a student photo
3286:
3287:
1.509 albertel 3288: sub student_image_tag {
1.508 www 3289: my ($domain,$user)=@_;
3290: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3291: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3292: return '<img src="'.$imgsrc.'" align="right" />';
3293: } else {
3294: return '';
3295: }
3296: }
3297:
1.112 bowersj2 3298: =pod
3299:
3300: =back
3301:
3302: =head1 Access .tab File Data
3303:
3304: =over 4
3305:
1.648 raeburn 3306: =item * &languageids()
1.112 bowersj2 3307:
3308: returns list of all language ids
3309:
3310: =cut
3311:
1.14 harris41 3312: sub languageids {
1.16 harris41 3313: return sort(keys(%language));
1.14 harris41 3314: }
3315:
1.112 bowersj2 3316: =pod
3317:
1.648 raeburn 3318: =item * &languagedescription()
1.112 bowersj2 3319:
3320: returns description of a specified language id
3321:
3322: =cut
3323:
1.14 harris41 3324: sub languagedescription {
1.125 www 3325: my $code=shift;
3326: return ($supported_language{$code}?'* ':'').
3327: $language{$code}.
1.126 www 3328: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3329: }
3330:
1.1048 foxr 3331: =pod
3332:
3333: =item * &plainlanguagedescription
3334:
3335: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3336: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3337:
3338: =cut
3339:
1.145 www 3340: sub plainlanguagedescription {
3341: my $code=shift;
3342: return $language{$code};
3343: }
3344:
1.1048 foxr 3345: =pod
3346:
3347: =item * &supportedlanguagecode
3348:
3349: Returns the supported language code (e.g. sptutf maps to pt) given a language
3350: code.
3351:
3352: =cut
3353:
1.145 www 3354: sub supportedlanguagecode {
3355: my $code=shift;
3356: return $supported_language{$code};
1.97 www 3357: }
3358:
1.112 bowersj2 3359: =pod
3360:
1.1048 foxr 3361: =item * &latexlanguage()
3362:
3363: Given a language key code returns the correspondnig language to use
3364: to select the correct hyphenation on LaTeX printouts. This is undef if there
3365: is no supported hyphenation for the language code.
3366:
3367: =cut
3368:
3369: sub latexlanguage {
3370: my $code = shift;
3371: return $latex_language{$code};
3372: }
3373:
3374: =pod
3375:
3376: =item * &latexhyphenation()
3377:
3378: Same as above but what's supplied is the language as it might be stored
3379: in the metadata.
3380:
3381: =cut
3382:
3383: sub latexhyphenation {
3384: my $key = shift;
3385: return $latex_language_bykey{$key};
3386: }
3387:
3388: =pod
3389:
1.648 raeburn 3390: =item * ©rightids()
1.112 bowersj2 3391:
3392: returns list of all copyrights
3393:
3394: =cut
3395:
3396: sub copyrightids {
3397: return sort(keys(%cprtag));
3398: }
3399:
3400: =pod
3401:
1.648 raeburn 3402: =item * ©rightdescription()
1.112 bowersj2 3403:
3404: returns description of a specified copyright id
3405:
3406: =cut
3407:
3408: sub copyrightdescription {
1.166 www 3409: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3410: }
1.197 matthew 3411:
3412: =pod
3413:
1.648 raeburn 3414: =item * &source_copyrightids()
1.192 taceyjo1 3415:
3416: returns list of all source copyrights
3417:
3418: =cut
3419:
3420: sub source_copyrightids {
3421: return sort(keys(%scprtag));
3422: }
3423:
3424: =pod
3425:
1.648 raeburn 3426: =item * &source_copyrightdescription()
1.192 taceyjo1 3427:
3428: returns description of a specified source copyright id
3429:
3430: =cut
3431:
3432: sub source_copyrightdescription {
3433: return &mt($scprtag{shift(@_)});
3434: }
1.112 bowersj2 3435:
3436: =pod
3437:
1.648 raeburn 3438: =item * &filecategories()
1.112 bowersj2 3439:
3440: returns list of all file categories
3441:
3442: =cut
3443:
3444: sub filecategories {
3445: return sort(keys(%category_extensions));
3446: }
3447:
3448: =pod
3449:
1.648 raeburn 3450: =item * &filecategorytypes()
1.112 bowersj2 3451:
3452: returns list of file types belonging to a given file
3453: category
3454:
3455: =cut
3456:
3457: sub filecategorytypes {
1.356 albertel 3458: my ($cat) = @_;
3459: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3460: }
3461:
3462: =pod
3463:
1.648 raeburn 3464: =item * &fileembstyle()
1.112 bowersj2 3465:
3466: returns embedding style for a specified file type
3467:
3468: =cut
3469:
3470: sub fileembstyle {
3471: return $fe{lc(shift(@_))};
1.169 www 3472: }
3473:
1.351 www 3474: sub filemimetype {
3475: return $fm{lc(shift(@_))};
3476: }
3477:
1.169 www 3478:
3479: sub filecategoryselect {
3480: my ($name,$value)=@_;
1.189 matthew 3481: return &select_form($value,$name,
1.970 raeburn 3482: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3483: }
3484:
3485: =pod
3486:
1.648 raeburn 3487: =item * &filedescription()
1.112 bowersj2 3488:
3489: returns description for a specified file type
3490:
3491: =cut
3492:
3493: sub filedescription {
1.188 matthew 3494: my $file_description = $fd{lc(shift())};
3495: $file_description =~ s:([\[\]]):~$1:g;
3496: return &mt($file_description);
1.112 bowersj2 3497: }
3498:
3499: =pod
3500:
1.648 raeburn 3501: =item * &filedescriptionex()
1.112 bowersj2 3502:
3503: returns description for a specified file type with
3504: extra formatting
3505:
3506: =cut
3507:
3508: sub filedescriptionex {
3509: my $ex=shift;
1.188 matthew 3510: my $file_description = $fd{lc($ex)};
3511: $file_description =~ s:([\[\]]):~$1:g;
3512: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3513: }
3514:
3515: # End of .tab access
3516: =pod
3517:
3518: =back
3519:
3520: =cut
3521:
3522: # ------------------------------------------------------------------ File Types
3523: sub fileextensions {
3524: return sort(keys(%fe));
3525: }
3526:
1.97 www 3527: # ----------------------------------------------------------- Display Languages
3528: # returns a hash with all desired display languages
3529: #
3530:
3531: sub display_languages {
3532: my %languages=();
1.695 raeburn 3533: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3534: $languages{$lang}=1;
1.97 www 3535: }
3536: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3537: if ($env{'form.displaylanguage'}) {
1.356 albertel 3538: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3539: $languages{$lang}=1;
1.97 www 3540: }
3541: }
3542: return %languages;
1.14 harris41 3543: }
3544:
1.582 albertel 3545: sub languages {
3546: my ($possible_langs) = @_;
1.695 raeburn 3547: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3548: if (!ref($possible_langs)) {
3549: if( wantarray ) {
3550: return @preferred_langs;
3551: } else {
3552: return $preferred_langs[0];
3553: }
3554: }
3555: my %possibilities = map { $_ => 1 } (@$possible_langs);
3556: my @preferred_possibilities;
3557: foreach my $preferred_lang (@preferred_langs) {
3558: if (exists($possibilities{$preferred_lang})) {
3559: push(@preferred_possibilities, $preferred_lang);
3560: }
3561: }
3562: if( wantarray ) {
3563: return @preferred_possibilities;
3564: }
3565: return $preferred_possibilities[0];
3566: }
3567:
1.742 raeburn 3568: sub user_lang {
3569: my ($touname,$toudom,$fromcid) = @_;
3570: my @userlangs;
3571: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3572: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3573: $env{'course.'.$fromcid.'.languages'}));
3574: } else {
3575: my %langhash = &getlangs($touname,$toudom);
3576: if ($langhash{'languages'} ne '') {
3577: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3578: } else {
3579: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3580: if ($domdefs{'lang_def'} ne '') {
3581: @userlangs = ($domdefs{'lang_def'});
3582: }
3583: }
3584: }
3585: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3586: my $user_lh = Apache::localize->get_handle(@languages);
3587: return $user_lh;
3588: }
3589:
3590:
1.112 bowersj2 3591: ###############################################################
3592: ## Student Answer Attempts ##
3593: ###############################################################
3594:
3595: =pod
3596:
3597: =head1 Alternate Problem Views
3598:
3599: =over 4
3600:
1.648 raeburn 3601: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3602: $getattempt, $regexp, $gradesub)
3603:
3604: Return string with previous attempt on problem. Arguments:
3605:
3606: =over 4
3607:
3608: =item * $symb: Problem, including path
3609:
3610: =item * $username: username of the desired student
3611:
3612: =item * $domain: domain of the desired student
1.14 harris41 3613:
1.112 bowersj2 3614: =item * $course: Course ID
1.14 harris41 3615:
1.112 bowersj2 3616: =item * $getattempt: Leave blank for all attempts, otherwise put
3617: something
1.14 harris41 3618:
1.112 bowersj2 3619: =item * $regexp: if string matches this regexp, the string will be
3620: sent to $gradesub
1.14 harris41 3621:
1.112 bowersj2 3622: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3623:
1.112 bowersj2 3624: =back
1.14 harris41 3625:
1.112 bowersj2 3626: The output string is a table containing all desired attempts, if any.
1.16 harris41 3627:
1.112 bowersj2 3628: =cut
1.1 albertel 3629:
3630: sub get_previous_attempt {
1.43 ng 3631: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3632: my $prevattempts='';
1.43 ng 3633: no strict 'refs';
1.1 albertel 3634: if ($symb) {
1.3 albertel 3635: my (%returnhash)=
3636: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3637: if ($returnhash{'version'}) {
3638: my %lasthash=();
3639: my $version;
3640: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3641: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3642: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3643: }
1.1 albertel 3644: }
1.596 albertel 3645: $prevattempts=&start_data_table().&start_data_table_header_row();
3646: $prevattempts.='<th>'.&mt('History').'</th>';
1.978 raeburn 3647: my (%typeparts,%lasthidden);
1.945 raeburn 3648: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3649: foreach my $key (sort(keys(%lasthash))) {
3650: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3651: if ($#parts > 0) {
1.31 albertel 3652: my $data=$parts[-1];
1.989 raeburn 3653: next if ($data eq 'foilorder');
1.31 albertel 3654: pop(@parts);
1.1010 www 3655: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 3656: if ($data eq 'type') {
3657: unless ($showsurv) {
3658: my $id = join(',',@parts);
3659: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 3660: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
3661: $lasthidden{$ign.'.'.$id} = 1;
3662: }
1.945 raeburn 3663: }
1.1010 www 3664: }
1.31 albertel 3665: } else {
1.41 ng 3666: if ($#parts == 0) {
3667: $prevattempts.='<th>'.$parts[0].'</th>';
3668: } else {
3669: $prevattempts.='<th>'.$ign.'</th>';
3670: }
1.31 albertel 3671: }
1.16 harris41 3672: }
1.596 albertel 3673: $prevattempts.=&end_data_table_header_row();
1.40 ng 3674: if ($getattempt eq '') {
3675: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3676: my @hidden;
3677: if (%typeparts) {
3678: foreach my $id (keys(%typeparts)) {
3679: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3680: push(@hidden,$id);
3681: }
3682: }
3683: }
3684: $prevattempts.=&start_data_table_row().
3685: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3686: if (@hidden) {
3687: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3688: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3689: my $hide;
3690: foreach my $id (@hidden) {
3691: if ($key =~ /^\Q$id\E/) {
3692: $hide = 1;
3693: last;
3694: }
3695: }
3696: if ($hide) {
3697: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3698: if (($data eq 'award') || ($data eq 'awarddetail')) {
3699: my $value = &format_previous_attempt_value($key,
3700: $returnhash{$version.':'.$key});
3701: $prevattempts.='<td>'.$value.' </td>';
3702: } else {
3703: $prevattempts.='<td> </td>';
3704: }
3705: } else {
3706: if ($key =~ /\./) {
3707: my $value = &format_previous_attempt_value($key,
3708: $returnhash{$version.':'.$key});
3709: $prevattempts.='<td>'.$value.' </td>';
3710: } else {
3711: $prevattempts.='<td> </td>';
3712: }
3713: }
3714: }
3715: } else {
3716: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3717: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3718: my $value = &format_previous_attempt_value($key,
3719: $returnhash{$version.':'.$key});
3720: $prevattempts.='<td>'.$value.' </td>';
3721: }
3722: }
3723: $prevattempts.=&end_data_table_row();
1.40 ng 3724: }
1.1 albertel 3725: }
1.945 raeburn 3726: my @currhidden = keys(%lasthidden);
1.596 albertel 3727: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3728: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 3729: next if ($key =~ /\.foilorder$/);
1.945 raeburn 3730: if (%typeparts) {
3731: my $hidden;
3732: foreach my $id (@currhidden) {
3733: if ($key =~ /^\Q$id\E/) {
3734: $hidden = 1;
3735: last;
3736: }
3737: }
3738: if ($hidden) {
3739: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3740: if (($data eq 'award') || ($data eq 'awarddetail')) {
3741: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3742: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3743: $value = &$gradesub($value);
3744: }
3745: $prevattempts.='<td>'.$value.' </td>';
3746: } else {
3747: $prevattempts.='<td> </td>';
3748: }
3749: } else {
3750: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3751: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3752: $value = &$gradesub($value);
3753: }
3754: $prevattempts.='<td>'.$value.' </td>';
3755: }
3756: } else {
3757: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3758: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3759: $value = &$gradesub($value);
3760: }
3761: $prevattempts.='<td>'.$value.' </td>';
3762: }
1.16 harris41 3763: }
1.596 albertel 3764: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3765: } else {
1.596 albertel 3766: $prevattempts=
3767: &start_data_table().&start_data_table_row().
3768: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3769: &end_data_table_row().&end_data_table();
1.1 albertel 3770: }
3771: } else {
1.596 albertel 3772: $prevattempts=
3773: &start_data_table().&start_data_table_row().
3774: '<td>'.&mt('No data.').'</td>'.
3775: &end_data_table_row().&end_data_table();
1.1 albertel 3776: }
1.10 albertel 3777: }
3778:
1.581 albertel 3779: sub format_previous_attempt_value {
3780: my ($key,$value) = @_;
1.1011 www 3781: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 3782: $value = &Apache::lonlocal::locallocaltime($value);
3783: } elsif (ref($value) eq 'ARRAY') {
3784: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 3785: } elsif ($key =~ /answerstring$/) {
3786: my %answers = &Apache::lonnet::str2hash($value);
3787: my @anskeys = sort(keys(%answers));
3788: if (@anskeys == 1) {
3789: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 3790: if ($answer =~ m{\0}) {
3791: $answer =~ s{\0}{,}g;
1.988 raeburn 3792: }
3793: my $tag_internal_answer_name = 'INTERNAL';
3794: if ($anskeys[0] eq $tag_internal_answer_name) {
3795: $value = $answer;
3796: } else {
3797: $value = $anskeys[0].'='.$answer;
3798: }
3799: } else {
3800: foreach my $ans (@anskeys) {
3801: my $answer = $answers{$ans};
1.1001 raeburn 3802: if ($answer =~ m{\0}) {
3803: $answer =~ s{\0}{,}g;
1.988 raeburn 3804: }
3805: $value .= $ans.'='.$answer.'<br />';;
3806: }
3807: }
1.581 albertel 3808: } else {
3809: $value = &unescape($value);
3810: }
3811: return $value;
3812: }
3813:
3814:
1.107 albertel 3815: sub relative_to_absolute {
3816: my ($url,$output)=@_;
3817: my $parser=HTML::TokeParser->new(\$output);
3818: my $token;
3819: my $thisdir=$url;
3820: my @rlinks=();
3821: while ($token=$parser->get_token) {
3822: if ($token->[0] eq 'S') {
3823: if ($token->[1] eq 'a') {
3824: if ($token->[2]->{'href'}) {
3825: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3826: }
3827: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3828: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3829: } elsif ($token->[1] eq 'base') {
3830: $thisdir=$token->[2]->{'href'};
3831: }
3832: }
3833: }
3834: $thisdir=~s-/[^/]*$--;
1.356 albertel 3835: foreach my $link (@rlinks) {
1.726 raeburn 3836: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3837: ($link=~/^\//) ||
3838: ($link=~/^javascript:/i) ||
3839: ($link=~/^mailto:/i) ||
3840: ($link=~/^\#/)) {
3841: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3842: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3843: }
3844: }
3845: # -------------------------------------------------- Deal with Applet codebases
3846: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3847: return $output;
3848: }
3849:
1.112 bowersj2 3850: =pod
3851:
1.648 raeburn 3852: =item * &get_student_view()
1.112 bowersj2 3853:
3854: show a snapshot of what student was looking at
3855:
3856: =cut
3857:
1.10 albertel 3858: sub get_student_view {
1.186 albertel 3859: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3860: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3861: my (%form);
1.10 albertel 3862: my @elements=('symb','courseid','domain','username');
3863: foreach my $element (@elements) {
1.186 albertel 3864: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3865: }
1.186 albertel 3866: if (defined($moreenv)) {
3867: %form=(%form,%{$moreenv});
3868: }
1.236 albertel 3869: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3870: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3871: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3872: $userview=~s/\<body[^\>]*\>//gi;
3873: $userview=~s/\<\/body\>//gi;
3874: $userview=~s/\<html\>//gi;
3875: $userview=~s/\<\/html\>//gi;
3876: $userview=~s/\<head\>//gi;
3877: $userview=~s/\<\/head\>//gi;
3878: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3879: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3880: if (wantarray) {
3881: return ($userview,$response);
3882: } else {
3883: return $userview;
3884: }
3885: }
3886:
3887: sub get_student_view_with_retries {
3888: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3889:
3890: my $ok = 0; # True if we got a good response.
3891: my $content;
3892: my $response;
3893:
3894: # Try to get the student_view done. within the retries count:
3895:
3896: do {
3897: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3898: $ok = $response->is_success;
3899: if (!$ok) {
3900: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3901: }
3902: $retries--;
3903: } while (!$ok && ($retries > 0));
3904:
3905: if (!$ok) {
3906: $content = ''; # On error return an empty content.
3907: }
1.651 www 3908: if (wantarray) {
3909: return ($content, $response);
3910: } else {
3911: return $content;
3912: }
1.11 albertel 3913: }
3914:
1.112 bowersj2 3915: =pod
3916:
1.648 raeburn 3917: =item * &get_student_answers()
1.112 bowersj2 3918:
3919: show a snapshot of how student was answering problem
3920:
3921: =cut
3922:
1.11 albertel 3923: sub get_student_answers {
1.100 sakharuk 3924: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3925: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3926: my (%moreenv);
1.11 albertel 3927: my @elements=('symb','courseid','domain','username');
3928: foreach my $element (@elements) {
1.186 albertel 3929: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3930: }
1.186 albertel 3931: $moreenv{'grade_target'}='answer';
3932: %moreenv=(%form,%moreenv);
1.497 raeburn 3933: $feedurl = &Apache::lonnet::clutter($feedurl);
3934: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3935: return $userview;
1.1 albertel 3936: }
1.116 albertel 3937:
3938: =pod
3939:
3940: =item * &submlink()
3941:
1.242 albertel 3942: Inputs: $text $uname $udom $symb $target
1.116 albertel 3943:
3944: Returns: A link to grades.pm such as to see the SUBM view of a student
3945:
3946: =cut
3947:
3948: ###############################################
3949: sub submlink {
1.242 albertel 3950: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3951: if (!($uname && $udom)) {
3952: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3953: &Apache::lonnet::whichuser($symb);
1.116 albertel 3954: if (!$symb) { $symb=$cursymb; }
3955: }
1.254 matthew 3956: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3957: $symb=&escape($symb);
1.960 bisitz 3958: if ($target) { $target=" target=\"$target\""; }
3959: return
3960: '<a href="/adm/grades?command=submission'.
3961: '&symb='.$symb.
3962: '&student='.$uname.
3963: '&userdom='.$udom.'"'.
3964: $target.'>'.$text.'</a>';
1.242 albertel 3965: }
3966: ##############################################
3967:
3968: =pod
3969:
3970: =item * &pgrdlink()
3971:
3972: Inputs: $text $uname $udom $symb $target
3973:
3974: Returns: A link to grades.pm such as to see the PGRD view of a student
3975:
3976: =cut
3977:
3978: ###############################################
3979: sub pgrdlink {
3980: my $link=&submlink(@_);
3981: $link=~s/(&command=submission)/$1&showgrading=yes/;
3982: return $link;
3983: }
3984: ##############################################
3985:
3986: =pod
3987:
3988: =item * &pprmlink()
3989:
3990: Inputs: $text $uname $udom $symb $target
3991:
3992: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3993: student and a specific resource
1.242 albertel 3994:
3995: =cut
3996:
3997: ###############################################
3998: sub pprmlink {
3999: my ($text,$uname,$udom,$symb,$target)=@_;
4000: if (!($uname && $udom)) {
4001: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4002: &Apache::lonnet::whichuser($symb);
1.242 albertel 4003: if (!$symb) { $symb=$cursymb; }
4004: }
1.254 matthew 4005: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4006: $symb=&escape($symb);
1.242 albertel 4007: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4008: return '<a href="/adm/parmset?command=set&'.
4009: 'symb='.$symb.'&uname='.$uname.
4010: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4011: }
4012: ##############################################
1.37 matthew 4013:
1.112 bowersj2 4014: =pod
4015:
4016: =back
4017:
4018: =cut
4019:
1.37 matthew 4020: ###############################################
1.51 www 4021:
4022:
4023: sub timehash {
1.687 raeburn 4024: my ($thistime) = @_;
4025: my $timezone = &Apache::lonlocal::gettimezone();
4026: my $dt = DateTime->from_epoch(epoch => $thistime)
4027: ->set_time_zone($timezone);
4028: my $wday = $dt->day_of_week();
4029: if ($wday == 7) { $wday = 0; }
4030: return ( 'second' => $dt->second(),
4031: 'minute' => $dt->minute(),
4032: 'hour' => $dt->hour(),
4033: 'day' => $dt->day_of_month(),
4034: 'month' => $dt->month(),
4035: 'year' => $dt->year(),
4036: 'weekday' => $wday,
4037: 'dayyear' => $dt->day_of_year(),
4038: 'dlsav' => $dt->is_dst() );
1.51 www 4039: }
4040:
1.370 www 4041: sub utc_string {
4042: my ($date)=@_;
1.371 www 4043: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4044: }
4045:
1.51 www 4046: sub maketime {
4047: my %th=@_;
1.687 raeburn 4048: my ($epoch_time,$timezone,$dt);
4049: $timezone = &Apache::lonlocal::gettimezone();
4050: eval {
4051: $dt = DateTime->new( year => $th{'year'},
4052: month => $th{'month'},
4053: day => $th{'day'},
4054: hour => $th{'hour'},
4055: minute => $th{'minute'},
4056: second => $th{'second'},
4057: time_zone => $timezone,
4058: );
4059: };
4060: if (!$@) {
4061: $epoch_time = $dt->epoch;
4062: if ($epoch_time) {
4063: return $epoch_time;
4064: }
4065: }
1.51 www 4066: return POSIX::mktime(
4067: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4068: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4069: }
4070:
4071: #########################################
1.51 www 4072:
4073: sub findallcourses {
1.482 raeburn 4074: my ($roles,$uname,$udom) = @_;
1.355 albertel 4075: my %roles;
4076: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4077: my %courses;
1.51 www 4078: my $now=time;
1.482 raeburn 4079: if (!defined($uname)) {
4080: $uname = $env{'user.name'};
4081: }
4082: if (!defined($udom)) {
4083: $udom = $env{'user.domain'};
4084: }
4085: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4086: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4087: if (!%roles) {
4088: %roles = (
4089: cc => 1,
1.907 raeburn 4090: co => 1,
1.482 raeburn 4091: in => 1,
4092: ep => 1,
4093: ta => 1,
4094: cr => 1,
4095: st => 1,
4096: );
4097: }
4098: foreach my $entry (keys(%roleshash)) {
4099: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4100: if ($trole =~ /^cr/) {
4101: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4102: } else {
4103: next if (!exists($roles{$trole}));
4104: }
4105: if ($tend) {
4106: next if ($tend < $now);
4107: }
4108: if ($tstart) {
4109: next if ($tstart > $now);
4110: }
1.1058 raeburn 4111: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4112: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4113: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4114: if ($secpart eq '') {
4115: ($cnum,$role) = split(/_/,$cnumpart);
4116: $sec = 'none';
1.1058 raeburn 4117: $value .= $cnum.'/';
1.482 raeburn 4118: } else {
4119: $cnum = $cnumpart;
4120: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4121: $value .= $cnum.'/'.$sec;
4122: }
4123: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4124: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4125: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4126: }
4127: } else {
4128: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4129: }
1.482 raeburn 4130: }
4131: } else {
4132: foreach my $key (keys(%env)) {
1.483 albertel 4133: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4134: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4135: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4136: next if ($role eq 'ca' || $role eq 'aa');
4137: next if (%roles && !exists($roles{$role}));
4138: my ($starttime,$endtime)=split(/\./,$env{$key});
4139: my $active=1;
4140: if ($starttime) {
4141: if ($now<$starttime) { $active=0; }
4142: }
4143: if ($endtime) {
4144: if ($now>$endtime) { $active=0; }
4145: }
4146: if ($active) {
1.1058 raeburn 4147: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4148: if ($sec eq '') {
4149: $sec = 'none';
1.1058 raeburn 4150: } else {
4151: $value .= $sec;
4152: }
4153: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4154: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4155: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4156: }
4157: } else {
4158: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4159: }
1.474 raeburn 4160: }
4161: }
1.51 www 4162: }
4163: }
1.474 raeburn 4164: return %courses;
1.51 www 4165: }
1.37 matthew 4166:
1.54 www 4167: ###############################################
1.474 raeburn 4168:
4169: sub blockcheck {
1.1062 raeburn 4170: my ($setters,$activity,$uname,$udom,$url) = @_;
1.490 raeburn 4171:
4172: if (!defined($udom)) {
4173: $udom = $env{'user.domain'};
4174: }
4175: if (!defined($uname)) {
4176: $uname = $env{'user.name'};
4177: }
4178:
4179: # If uname and udom are for a course, check for blocks in the course.
4180:
4181: if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062 raeburn 4182: my ($startblock,$endblock,$triggerblock) =
4183: &get_blocks($setters,$activity,$udom,$uname,$url);
4184: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4185: }
1.474 raeburn 4186:
1.502 raeburn 4187: my $startblock = 0;
4188: my $endblock = 0;
1.1062 raeburn 4189: my $triggerblock = '';
1.482 raeburn 4190: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4191:
1.490 raeburn 4192: # If uname is for a user, and activity is course-specific, i.e.,
4193: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4194:
1.490 raeburn 4195: if (($activity eq 'boards' || $activity eq 'chat' ||
4196: $activity eq 'groups') && ($env{'request.course.id'})) {
4197: foreach my $key (keys(%live_courses)) {
4198: if ($key ne $env{'request.course.id'}) {
4199: delete($live_courses{$key});
4200: }
4201: }
4202: }
4203:
4204: my $otheruser = 0;
4205: my %own_courses;
4206: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4207: # Resource belongs to user other than current user.
4208: $otheruser = 1;
4209: # Gather courses for current user
4210: %own_courses =
4211: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4212: }
4213:
4214: # Gather active course roles - course coordinator, instructor,
4215: # exam proctor, ta, student, or custom role.
1.474 raeburn 4216:
4217: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4218: my ($cdom,$cnum);
4219: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4220: $cdom = $env{'course.'.$course.'.domain'};
4221: $cnum = $env{'course.'.$course.'.num'};
4222: } else {
1.490 raeburn 4223: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4224: }
4225: my $no_ownblock = 0;
4226: my $no_userblock = 0;
1.533 raeburn 4227: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4228: # Check if current user has 'evb' priv for this
4229: if (defined($own_courses{$course})) {
4230: foreach my $sec (keys(%{$own_courses{$course}})) {
4231: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4232: if ($sec ne 'none') {
4233: $checkrole .= '/'.$sec;
4234: }
4235: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4236: $no_ownblock = 1;
4237: last;
4238: }
4239: }
4240: }
4241: # if they have 'evb' priv and are currently not playing student
4242: next if (($no_ownblock) &&
4243: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4244: }
1.474 raeburn 4245: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4246: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4247: if ($sec ne 'none') {
1.482 raeburn 4248: $checkrole .= '/'.$sec;
1.474 raeburn 4249: }
1.490 raeburn 4250: if ($otheruser) {
4251: # Resource belongs to user other than current user.
4252: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4253: my (%allroles,%userroles);
4254: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4255: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4256: my ($trole,$tdom,$tnum,$tsec);
4257: if ($entry =~ /^cr/) {
4258: ($trole,$tdom,$tnum,$tsec) =
4259: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4260: } else {
4261: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4262: }
4263: my ($spec,$area,$trest);
4264: $area = '/'.$tdom.'/'.$tnum;
4265: $trest = $tnum;
4266: if ($tsec ne '') {
4267: $area .= '/'.$tsec;
4268: $trest .= '/'.$tsec;
4269: }
4270: $spec = $trole.'.'.$area;
4271: if ($trole =~ /^cr/) {
4272: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4273: $tdom,$spec,$trest,$area);
4274: } else {
4275: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4276: $tdom,$spec,$trest,$area);
4277: }
4278: }
4279: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
4280: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4281: if ($1) {
4282: $no_userblock = 1;
4283: last;
4284: }
1.486 raeburn 4285: }
4286: }
1.490 raeburn 4287: } else {
4288: # Resource belongs to current user
4289: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4290: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4291: $no_ownblock = 1;
4292: last;
4293: }
1.474 raeburn 4294: }
4295: }
4296: # if they have the evb priv and are currently not playing student
1.482 raeburn 4297: next if (($no_ownblock) &&
1.491 albertel 4298: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4299: next if ($no_userblock);
1.474 raeburn 4300:
1.866 kalberla 4301: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4302: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4303:
1.1062 raeburn 4304: my ($start,$end,$trigger) =
4305: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 4306: if (($start != 0) &&
4307: (($startblock == 0) || ($startblock > $start))) {
4308: $startblock = $start;
1.1062 raeburn 4309: if ($trigger ne '') {
4310: $triggerblock = $trigger;
4311: }
1.502 raeburn 4312: }
4313: if (($end != 0) &&
4314: (($endblock == 0) || ($endblock < $end))) {
4315: $endblock = $end;
1.1062 raeburn 4316: if ($trigger ne '') {
4317: $triggerblock = $trigger;
4318: }
1.502 raeburn 4319: }
1.490 raeburn 4320: }
1.1062 raeburn 4321: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4322: }
4323:
4324: sub get_blocks {
1.1062 raeburn 4325: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 4326: my $startblock = 0;
4327: my $endblock = 0;
1.1062 raeburn 4328: my $triggerblock = '';
1.490 raeburn 4329: my $course = $cdom.'_'.$cnum;
4330: $setters->{$course} = {};
4331: $setters->{$course}{'staff'} = [];
4332: $setters->{$course}{'times'} = [];
1.1062 raeburn 4333: $setters->{$course}{'triggers'} = [];
4334: my (@blockers,%triggered);
4335: my $now = time;
4336: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4337: if ($activity eq 'docs') {
4338: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
4339: foreach my $block (@blockers) {
4340: if ($block =~ /^firstaccess____(.+)$/) {
4341: my $item = $1;
4342: my $type = 'map';
4343: my $timersymb = $item;
4344: if ($item eq 'course') {
4345: $type = 'course';
4346: } elsif ($item =~ /___\d+___/) {
4347: $type = 'resource';
4348: } else {
4349: $timersymb = &Apache::lonnet::symbread($item);
4350: }
4351: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4352: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4353: $triggered{$block} = {
4354: start => $start,
4355: end => $end,
4356: type => $type,
4357: };
4358: }
4359: }
4360: } else {
4361: foreach my $block (keys(%commblocks)) {
4362: if ($block =~ m/^(\d+)____(\d+)$/) {
4363: my ($start,$end) = ($1,$2);
4364: if ($start <= time && $end >= time) {
4365: if (ref($commblocks{$block}) eq 'HASH') {
4366: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4367: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4368: unless(grep(/^\Q$block\E$/,@blockers)) {
4369: push(@blockers,$block);
4370: }
4371: }
4372: }
4373: }
4374: }
4375: } elsif ($block =~ /^firstaccess____(.+)$/) {
4376: my $item = $1;
4377: my $timersymb = $item;
4378: my $type = 'map';
4379: if ($item eq 'course') {
4380: $type = 'course';
4381: } elsif ($item =~ /___\d+___/) {
4382: $type = 'resource';
4383: } else {
4384: $timersymb = &Apache::lonnet::symbread($item);
4385: }
4386: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4387: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4388: if ($start && $end) {
4389: if (($start <= time) && ($end >= time)) {
4390: unless (grep(/^\Q$block\E$/,@blockers)) {
4391: push(@blockers,$block);
4392: $triggered{$block} = {
4393: start => $start,
4394: end => $end,
4395: type => $type,
4396: };
4397: }
4398: }
1.490 raeburn 4399: }
1.1062 raeburn 4400: }
4401: }
4402: }
4403: foreach my $blocker (@blockers) {
4404: my ($staff_name,$staff_dom,$title,$blocks) =
4405: &parse_block_record($commblocks{$blocker});
4406: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4407: my ($start,$end,$triggertype);
4408: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4409: ($start,$end) = ($1,$2);
4410: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4411: $start = $triggered{$blocker}{'start'};
4412: $end = $triggered{$blocker}{'end'};
4413: $triggertype = $triggered{$blocker}{'type'};
4414: }
4415: if ($start) {
4416: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4417: if ($triggertype) {
4418: push(@{$$setters{$course}{'triggers'}},$triggertype);
4419: } else {
4420: push(@{$$setters{$course}{'triggers'}},0);
4421: }
4422: if ( ($startblock == 0) || ($startblock > $start) ) {
4423: $startblock = $start;
4424: if ($triggertype) {
4425: $triggerblock = $blocker;
1.474 raeburn 4426: }
4427: }
1.1062 raeburn 4428: if ( ($endblock == 0) || ($endblock < $end) ) {
4429: $endblock = $end;
4430: if ($triggertype) {
4431: $triggerblock = $blocker;
4432: }
4433: }
1.474 raeburn 4434: }
4435: }
1.1062 raeburn 4436: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 4437: }
4438:
4439: sub parse_block_record {
4440: my ($record) = @_;
4441: my ($setuname,$setudom,$title,$blocks);
4442: if (ref($record) eq 'HASH') {
4443: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4444: $title = &unescape($record->{'event'});
4445: $blocks = $record->{'blocks'};
4446: } else {
4447: my @data = split(/:/,$record,3);
4448: if (scalar(@data) eq 2) {
4449: $title = $data[1];
4450: ($setuname,$setudom) = split(/@/,$data[0]);
4451: } else {
4452: ($setuname,$setudom,$title) = @data;
4453: }
4454: $blocks = { 'com' => 'on' };
4455: }
4456: return ($setuname,$setudom,$title,$blocks);
4457: }
4458:
1.854 kalberla 4459: sub blocking_status {
1.1062 raeburn 4460: my ($activity,$uname,$udom,$url) = @_;
1.1061 raeburn 4461: my %setters;
1.890 droeschl 4462:
1.1061 raeburn 4463: # check for active blocking
1.1062 raeburn 4464: my ($startblock,$endblock,$triggerblock) =
4465: &blockcheck(\%setters,$activity,$uname,$udom,$url);
4466: my $blocked = 0;
4467: if ($startblock && $endblock) {
4468: $blocked = 1;
4469: }
1.890 droeschl 4470:
1.1061 raeburn 4471: # caller just wants to know whether a block is active
4472: if (!wantarray) { return $blocked; }
4473:
4474: # build a link to a popup window containing the details
4475: my $querystring = "?activity=$activity";
4476: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062 raeburn 4477: if ($activity eq 'port') {
4478: $querystring .= "&udom=$udom" if $udom;
4479: $querystring .= "&uname=$uname" if $uname;
4480: } elsif ($activity eq 'docs') {
4481: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
4482: }
1.1061 raeburn 4483:
4484: my $output .= <<'END_MYBLOCK';
4485: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4486: var options = "width=" + w + ",height=" + h + ",";
4487: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4488: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4489: var newWin = window.open(url, wdwName, options);
4490: newWin.focus();
4491: }
1.890 droeschl 4492: END_MYBLOCK
1.854 kalberla 4493:
1.1061 raeburn 4494: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 4495:
1.1061 raeburn 4496: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 4497: my $text = &mt('Communication Blocked');
4498: if ($activity eq 'docs') {
4499: $text = &mt('Content Access Blocked');
1.1063 raeburn 4500: } elsif ($activity eq 'printout') {
4501: $text = &mt('Printing Blocked');
1.1062 raeburn 4502: }
1.1061 raeburn 4503: $output .= <<"END_BLOCK";
1.867 kalberla 4504: <div class='LC_comblock'>
1.869 kalberla 4505: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4506: title='$text'>
4507: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4508: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4509: title='$text'>$text</a>
1.867 kalberla 4510: </div>
4511:
4512: END_BLOCK
1.474 raeburn 4513:
1.1061 raeburn 4514: return ($blocked, $output);
1.854 kalberla 4515: }
1.490 raeburn 4516:
1.60 matthew 4517: ###############################################
4518:
1.682 raeburn 4519: sub check_ip_acc {
4520: my ($acc)=@_;
4521: &Apache::lonxml::debug("acc is $acc");
4522: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4523: return 1;
4524: }
4525: my $allowed=0;
4526: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4527:
4528: my $name;
4529: foreach my $pattern (split(',',$acc)) {
4530: $pattern =~ s/^\s*//;
4531: $pattern =~ s/\s*$//;
4532: if ($pattern =~ /\*$/) {
4533: #35.8.*
4534: $pattern=~s/\*//;
4535: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4536: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4537: #35.8.3.[34-56]
4538: my $low=$2;
4539: my $high=$3;
4540: $pattern=$1;
4541: if ($ip =~ /^\Q$pattern\E/) {
4542: my $last=(split(/\./,$ip))[3];
4543: if ($last <=$high && $last >=$low) { $allowed=1; }
4544: }
4545: } elsif ($pattern =~ /^\*/) {
4546: #*.msu.edu
4547: $pattern=~s/\*//;
4548: if (!defined($name)) {
4549: use Socket;
4550: my $netaddr=inet_aton($ip);
4551: ($name)=gethostbyaddr($netaddr,AF_INET);
4552: }
4553: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4554: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4555: #127.0.0.1
4556: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4557: } else {
4558: #some.name.com
4559: if (!defined($name)) {
4560: use Socket;
4561: my $netaddr=inet_aton($ip);
4562: ($name)=gethostbyaddr($netaddr,AF_INET);
4563: }
4564: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4565: }
4566: if ($allowed) { last; }
4567: }
4568: return $allowed;
4569: }
4570:
4571: ###############################################
4572:
1.60 matthew 4573: =pod
4574:
1.112 bowersj2 4575: =head1 Domain Template Functions
4576:
4577: =over 4
4578:
4579: =item * &determinedomain()
1.60 matthew 4580:
4581: Inputs: $domain (usually will be undef)
4582:
1.63 www 4583: Returns: Determines which domain should be used for designs
1.60 matthew 4584:
4585: =cut
1.54 www 4586:
1.60 matthew 4587: ###############################################
1.63 www 4588: sub determinedomain {
4589: my $domain=shift;
1.531 albertel 4590: if (! $domain) {
1.60 matthew 4591: # Determine domain if we have not been given one
1.893 raeburn 4592: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4593: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4594: if ($env{'request.role.domain'}) {
4595: $domain=$env{'request.role.domain'};
1.60 matthew 4596: }
4597: }
1.63 www 4598: return $domain;
4599: }
4600: ###############################################
1.517 raeburn 4601:
1.518 albertel 4602: sub devalidate_domconfig_cache {
4603: my ($udom)=@_;
4604: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4605: }
4606:
4607: # ---------------------- Get domain configuration for a domain
4608: sub get_domainconf {
4609: my ($udom) = @_;
4610: my $cachetime=1800;
4611: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4612: if (defined($cached)) { return %{$result}; }
4613:
4614: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4615: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4616: my (%designhash,%legacy);
1.518 albertel 4617: if (keys(%domconfig) > 0) {
4618: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4619: if (keys(%{$domconfig{'login'}})) {
4620: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4621: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4622: if ($key eq 'loginvia') {
4623: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013 raeburn 4624: foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948 raeburn 4625: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4626: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4627: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4628: $designhash{$udom.'.login.loginvia'} = $server;
4629: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4630:
4631: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4632: } else {
1.1013 raeburn 4633: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948 raeburn 4634: }
4635: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4636: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4637: }
1.946 raeburn 4638: }
4639: }
4640: }
4641: }
4642: } else {
4643: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4644: $designhash{$udom.'.login.'.$key.'_'.$img} =
4645: $domconfig{'login'}{$key}{$img};
4646: }
1.699 raeburn 4647: }
4648: } else {
4649: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4650: }
1.632 raeburn 4651: }
4652: } else {
4653: $legacy{'login'} = 1;
1.518 albertel 4654: }
1.632 raeburn 4655: } else {
4656: $legacy{'login'} = 1;
1.518 albertel 4657: }
4658: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4659: if (keys(%{$domconfig{'rolecolors'}})) {
4660: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4661: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4662: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4663: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4664: }
1.518 albertel 4665: }
4666: }
1.632 raeburn 4667: } else {
4668: $legacy{'rolecolors'} = 1;
1.518 albertel 4669: }
1.632 raeburn 4670: } else {
4671: $legacy{'rolecolors'} = 1;
1.518 albertel 4672: }
1.948 raeburn 4673: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4674: if ($domconfig{'autoenroll'}{'co-owners'}) {
4675: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4676: }
4677: }
1.632 raeburn 4678: if (keys(%legacy) > 0) {
4679: my %legacyhash = &get_legacy_domconf($udom);
4680: foreach my $item (keys(%legacyhash)) {
4681: if ($item =~ /^\Q$udom\E\.login/) {
4682: if ($legacy{'login'}) {
4683: $designhash{$item} = $legacyhash{$item};
4684: }
4685: } else {
4686: if ($legacy{'rolecolors'}) {
4687: $designhash{$item} = $legacyhash{$item};
4688: }
1.518 albertel 4689: }
4690: }
4691: }
1.632 raeburn 4692: } else {
4693: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4694: }
4695: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4696: $cachetime);
4697: return %designhash;
4698: }
4699:
1.632 raeburn 4700: sub get_legacy_domconf {
4701: my ($udom) = @_;
4702: my %legacyhash;
4703: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4704: my $designfile = $designdir.'/'.$udom.'.tab';
4705: if (-e $designfile) {
4706: if ( open (my $fh,"<$designfile") ) {
4707: while (my $line = <$fh>) {
4708: next if ($line =~ /^\#/);
4709: chomp($line);
4710: my ($key,$val)=(split(/\=/,$line));
4711: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4712: }
4713: close($fh);
4714: }
4715: }
1.1026 raeburn 4716: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 4717: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4718: }
4719: return %legacyhash;
4720: }
4721:
1.63 www 4722: =pod
4723:
1.112 bowersj2 4724: =item * &domainlogo()
1.63 www 4725:
4726: Inputs: $domain (usually will be undef)
4727:
4728: Returns: A link to a domain logo, if the domain logo exists.
4729: If the domain logo does not exist, a description of the domain.
4730:
4731: =cut
1.112 bowersj2 4732:
1.63 www 4733: ###############################################
4734: sub domainlogo {
1.517 raeburn 4735: my $domain = &determinedomain(shift);
1.518 albertel 4736: my %designhash = &get_domainconf($domain);
1.517 raeburn 4737: # See if there is a logo
4738: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4739: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4740: if ($imgsrc =~ m{^/(adm|res)/}) {
4741: if ($imgsrc =~ m{^/res/}) {
4742: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4743: &Apache::lonnet::repcopy($local_name);
4744: }
4745: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4746: }
4747: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4748: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4749: return &Apache::lonnet::domain($domain,'description');
1.59 www 4750: } else {
1.60 matthew 4751: return '';
1.59 www 4752: }
4753: }
1.63 www 4754: ##############################################
4755:
4756: =pod
4757:
1.112 bowersj2 4758: =item * &designparm()
1.63 www 4759:
4760: Inputs: $which parameter; $domain (usually will be undef)
4761:
4762: Returns: value of designparamter $which
4763:
4764: =cut
1.112 bowersj2 4765:
1.397 albertel 4766:
1.400 albertel 4767: ##############################################
1.397 albertel 4768: sub designparm {
4769: my ($which,$domain)=@_;
4770: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4771: return $env{'environment.color.'.$which};
1.96 www 4772: }
1.63 www 4773: $domain=&determinedomain($domain);
1.1016 raeburn 4774: my %domdesign;
4775: unless ($domain eq 'public') {
4776: %domdesign = &get_domainconf($domain);
4777: }
1.520 raeburn 4778: my $output;
1.517 raeburn 4779: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4780: $output = $domdesign{$domain.'.'.$which};
1.63 www 4781: } else {
1.520 raeburn 4782: $output = $defaultdesign{$which};
4783: }
4784: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4785: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4786: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4787: if ($output =~ m{^/res/}) {
4788: my $local_name = &Apache::lonnet::filelocation('',$output);
4789: &Apache::lonnet::repcopy($local_name);
4790: }
1.520 raeburn 4791: $output = &lonhttpdurl($output);
4792: }
1.63 www 4793: }
1.520 raeburn 4794: return $output;
1.63 www 4795: }
1.59 www 4796:
1.822 bisitz 4797: ##############################################
4798: =pod
4799:
1.832 bisitz 4800: =item * &authorspace()
4801:
1.1028 raeburn 4802: Inputs: $url (usually will be undef).
1.832 bisitz 4803:
1.1028 raeburn 4804: Returns: Path to Construction Space containing the resource or
4805: directory being viewed (or for which action is being taken).
4806: If $url is provided, and begins /priv/<domain>/<uname>
4807: the path will be that portion of the $context argument.
4808: Otherwise the path will be for the author space of the current
4809: user when the current role is author, or for that of the
4810: co-author/assistant co-author space when the current role
4811: is co-author or assistant co-author.
1.832 bisitz 4812:
4813: =cut
4814:
4815: sub authorspace {
1.1028 raeburn 4816: my ($url) = @_;
4817: if ($url ne '') {
4818: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
4819: return $1;
4820: }
4821: }
1.832 bisitz 4822: my $caname = '';
1.1024 www 4823: my $cadom = '';
1.1028 raeburn 4824: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 4825: ($cadom,$caname) =
1.832 bisitz 4826: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 4827: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 4828: $caname = $env{'user.name'};
1.1024 www 4829: $cadom = $env{'user.domain'};
1.832 bisitz 4830: }
1.1028 raeburn 4831: if (($caname ne '') && ($cadom ne '')) {
4832: return "/priv/$cadom/$caname/";
4833: }
4834: return;
1.832 bisitz 4835: }
4836:
4837: ##############################################
4838: =pod
4839:
1.822 bisitz 4840: =item * &head_subbox()
4841:
4842: Inputs: $content (contains HTML code with page functions, etc.)
4843:
4844: Returns: HTML div with $content
4845: To be included in page header
4846:
4847: =cut
4848:
4849: sub head_subbox {
4850: my ($content)=@_;
4851: my $output =
1.993 raeburn 4852: '<div class="LC_head_subbox">'
1.822 bisitz 4853: .$content
4854: .'</div>'
4855: }
4856:
4857: ##############################################
4858: =pod
4859:
4860: =item * &CSTR_pageheader()
4861:
1.1026 raeburn 4862: Input: (optional) filename from which breadcrumb trail is built.
4863: In most cases no input as needed, as $env{'request.filename'}
4864: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 4865:
4866: Returns: HTML div with CSTR path and recent box
4867: To be included on Construction Space pages
4868:
4869: =cut
4870:
4871: sub CSTR_pageheader {
1.1026 raeburn 4872: my ($trailfile) = @_;
4873: if ($trailfile eq '') {
4874: $trailfile = $env{'request.filename'};
4875: }
4876:
4877: # this is for resources; directories have customtitle, and crumbs
4878: # and select recent are created in lonpubdir.pm
4879:
4880: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 4881: my ($udom,$uname,$thisdisfn)=
1.1026 raeburn 4882: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
4883: my $formaction = "/priv/$udom/$uname/$thisdisfn";
4884: $formaction =~ s{/+}{/}g;
1.822 bisitz 4885:
4886: my $parentpath = '';
4887: my $lastitem = '';
4888: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4889: $parentpath = $1;
4890: $lastitem = $2;
4891: } else {
4892: $lastitem = $thisdisfn;
4893: }
1.921 bisitz 4894:
4895: my $output =
1.822 bisitz 4896: '<div>'
4897: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4898: .'<b>'.&mt('Construction Space:').'</b> '
4899: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4900: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 4901: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 4902:
4903: if ($lastitem) {
4904: $output .=
4905: '<span class="LC_filename">'
4906: .$lastitem
4907: .'</span>';
4908: }
4909: $output .=
4910: '<br />'
1.822 bisitz 4911: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4912: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4913: .'</form>'
4914: .&Apache::lonmenu::constspaceform()
4915: .'</div>';
1.921 bisitz 4916:
4917: return $output;
1.822 bisitz 4918: }
4919:
1.60 matthew 4920: ###############################################
4921: ###############################################
4922:
4923: =pod
4924:
1.112 bowersj2 4925: =back
4926:
1.549 albertel 4927: =head1 HTML Helpers
1.112 bowersj2 4928:
4929: =over 4
4930:
4931: =item * &bodytag()
1.60 matthew 4932:
4933: Returns a uniform header for LON-CAPA web pages.
4934:
4935: Inputs:
4936:
1.112 bowersj2 4937: =over 4
4938:
4939: =item * $title, A title to be displayed on the page.
4940:
4941: =item * $function, the current role (can be undef).
4942:
4943: =item * $addentries, extra parameters for the <body> tag.
4944:
4945: =item * $bodyonly, if defined, only return the <body> tag.
4946:
4947: =item * $domain, if defined, force a given domain.
4948:
4949: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4950: text interface only)
1.60 matthew 4951:
1.814 bisitz 4952: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4953: navigational links
1.317 albertel 4954:
1.338 albertel 4955: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4956:
1.1075.2.12 raeburn 4957: =item * $no_inline_link, if true and in remote mode, don't show the
4958: 'Switch To Inline Menu' link
4959:
1.460 albertel 4960: =item * $args, optional argument valid values are
4961: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4962: inherit_jsmath -> when creating popup window in a page,
4963: should it have jsmath forced on by the
4964: current page
1.460 albertel 4965:
1.112 bowersj2 4966: =back
4967:
1.60 matthew 4968: Returns: A uniform header for LON-CAPA web pages.
4969: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4970: If $bodyonly is undef or zero, an html string containing a <body> tag and
4971: other decorations will be returned.
4972:
4973: =cut
4974:
1.54 www 4975: sub bodytag {
1.831 bisitz 4976: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.12 raeburn 4977: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4978:
1.954 raeburn 4979: my $public;
4980: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4981: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4982: $public = 1;
4983: }
1.460 albertel 4984: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4985:
1.183 matthew 4986: $function = &get_users_function() if (!$function);
1.339 albertel 4987: my $img = &designparm($function.'.img',$domain);
4988: my $font = &designparm($function.'.font',$domain);
4989: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4990:
1.803 bisitz 4991: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4992: 'bgcolor' => $pgbg,
1.339 albertel 4993: 'text' => $font,
4994: 'alink' => &designparm($function.'.alink',$domain),
4995: 'vlink' => &designparm($function.'.vlink',$domain),
4996: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4997: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4998:
1.63 www 4999: # role and realm
1.378 raeburn 5000: my ($role,$realm) = split(/\./,$env{'request.role'},2);
5001: if ($role eq 'ca') {
1.479 albertel 5002: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5003: $realm = &plainname($rname,$rdom);
1.378 raeburn 5004: }
1.55 www 5005: # realm
1.258 albertel 5006: if ($env{'request.course.id'}) {
1.378 raeburn 5007: if ($env{'request.role'} !~ /^cr/) {
5008: $role = &Apache::lonnet::plaintext($role,&course_type());
5009: }
1.898 raeburn 5010: if ($env{'request.course.sec'}) {
5011: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5012: }
1.359 albertel 5013: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5014: } else {
5015: $role = &Apache::lonnet::plaintext($role);
1.54 www 5016: }
1.433 albertel 5017:
1.359 albertel 5018: if (!$realm) { $realm=' '; }
1.1075.2.12 raeburn 5019: # Set messages
5020: my $messages=&domainlogo($domain);
1.330 albertel 5021:
1.438 albertel 5022: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5023:
1.101 www 5024: # construct main body tag
1.359 albertel 5025: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 5026: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 5027:
1.530 albertel 5028: if ($bodyonly) {
1.60 matthew 5029: return $bodytag;
1.798 tempelho 5030: }
1.359 albertel 5031:
1.410 albertel 5032: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 5033: if ($public) {
1.433 albertel 5034: undef($role);
1.434 albertel 5035: } else {
1.1070 raeburn 5036: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5037: undef,'LC_menubuttons_link');
1.433 albertel 5038: }
1.359 albertel 5039:
1.762 bisitz 5040: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5041: #
5042: # Extra info if you are the DC
5043: my $dc_info = '';
5044: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5045: $env{'course.'.$env{'request.course.id'}.
5046: '.domain'}.'/'})) {
5047: my $cid = $env{'request.course.id'};
1.917 raeburn 5048: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5049: $dc_info =~ s/\s+$//;
1.359 albertel 5050: }
5051:
1.898 raeburn 5052: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 5053: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5054:
1.1075.2.13! raeburn 5055: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
! 5056: return $bodytag;
! 5057: }
1.903 droeschl 5058:
1.1075.2.13! raeburn 5059: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
! 5060:
! 5061: unless ($env{'environment.remote'} eq 'on') {
1.903 droeschl 5062:
5063: # if ($env{'request.state'} eq 'construct') {
5064: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5065: # }
5066:
1.359 albertel 5067:
1.1075.2.2 raeburn 5068:
1.916 droeschl 5069: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.1 raeburn 5070: unless ($env{'request.noversionuri'} =~ m{/res/adm/pages/bookmarkmenu/}) {
5071: if ($dc_info) {
5072: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5073: }
5074: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
5075: <em>$realm</em> $dc_info</div>|;
5076: }
1.903 droeschl 5077: return $bodytag;
5078: }
1.894 droeschl 5079:
1.927 raeburn 5080: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
5081: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
5082: }
1.916 droeschl 5083:
1.903 droeschl 5084: $bodytag .= Apache::lonhtmlcommon::scripttag(
5085: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 5086:
1.903 droeschl 5087: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 5088:
1.917 raeburn 5089: if ($dc_info) {
5090: $dc_info = &dc_courseid_toggle($dc_info);
5091: }
5092: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5093:
1.903 droeschl 5094: #don't show menus for public users
1.954 raeburn 5095: if (!$public){
1.903 droeschl 5096: $bodytag .= Apache::lonmenu::secondary_menu();
5097: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5098: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5099: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5100: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 5101: $args->{'bread_crumbs'});
5102: } elsif ($forcereg) {
5103: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
5104: }
1.903 droeschl 5105: }else{
5106: # this is to seperate menu from content when there's no secondary
5107: # menu. Especially needed for public accessible ressources.
5108: $bodytag .= '<hr style="clear:both" />';
5109: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5110: }
1.903 droeschl 5111:
1.235 raeburn 5112: return $bodytag;
1.1075.2.12 raeburn 5113: }
5114:
5115: #
5116: # Top frame rendering, Remote is up
5117: #
5118:
5119: my $imgsrc = $img;
5120: if ($img =~ /^\/adm/) {
5121: $imgsrc = &lonhttpdurl($img);
5122: }
5123: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
5124:
5125: # Explicit link to get inline menu
5126: my $menu= ($no_inline_link?''
5127: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
5128:
5129: if ($dc_info) {
5130: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
5131: }
5132:
5133: unless ($env{'form.inhibitmenu'}) {
5134: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
5135: <ol class="LC_primary_menu LC_right">
5136: <li>$menu</li>
5137: </ol><div id="LC_realm"> $realm $dc_info</div>|;
5138: }
1.1075.2.13! raeburn 5139: my $funclist;
! 5140: if ($env{'request.state'} eq 'construct') {
! 5141: if (!$public){
! 5142: if ($env{'request.state'} eq 'construct') {
! 5143: $funclist = &Apache::lonhtmlcommon::scripttag(
! 5144: &Apache::lonmenu::utilityfunctions(), 'start').
! 5145: &Apache::lonhtmlcommon::scripttag('','end').
! 5146: &Apache::lonmenu::innerregister($forcereg,
! 5147: $args->{'bread_crumbs'});
! 5148: }
! 5149: }
! 5150: }
1.1075.2.12 raeburn 5151: return(<<ENDBODY);
5152: $bodytag
5153: <table id="LC_title_bar" class="LC_with_remote">
5154: <tr><td>$upperleft</td>
5155: <td>$messages </td>
5156: </tr>
5157: <tr><td>$titleinfo $dc_info $menu</td>
5158: </tr>
5159: </table>
1.1075.2.13! raeburn 5160: $funclist
1.1075.2.12 raeburn 5161: ENDBODY
1.182 matthew 5162: }
5163:
1.917 raeburn 5164: sub dc_courseid_toggle {
5165: my ($dc_info) = @_;
1.980 raeburn 5166: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5167: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5168: &mt('(More ...)').'</a></span>'.
5169: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5170: }
5171:
1.330 albertel 5172: sub make_attr_string {
5173: my ($register,$attr_ref) = @_;
5174:
5175: if ($attr_ref && !ref($attr_ref)) {
5176: die("addentries Must be a hash ref ".
5177: join(':',caller(1))." ".
5178: join(':',caller(0))." ");
5179: }
5180:
5181: if ($register) {
1.339 albertel 5182: my ($on_load,$on_unload);
5183: foreach my $key (keys(%{$attr_ref})) {
5184: if (lc($key) eq 'onload') {
5185: $on_load.=$attr_ref->{$key}.';';
5186: delete($attr_ref->{$key});
5187:
5188: } elsif (lc($key) eq 'onunload') {
5189: $on_unload.=$attr_ref->{$key}.';';
5190: delete($attr_ref->{$key});
5191: }
5192: }
1.1075.2.12 raeburn 5193: if ($env{'environment.remote'} eq 'on') {
5194: $attr_ref->{'onload'} =
5195: &Apache::lonmenu::loadevents(). $on_load;
5196: $attr_ref->{'onunload'}=
5197: &Apache::lonmenu::unloadevents().$on_unload;
5198: } else {
5199: $attr_ref->{'onload'} = $on_load;
5200: $attr_ref->{'onunload'}= $on_unload;
5201: }
1.330 albertel 5202: }
1.339 albertel 5203:
1.330 albertel 5204: my $attr_string;
5205: foreach my $attr (keys(%$attr_ref)) {
5206: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5207: }
5208: return $attr_string;
5209: }
5210:
5211:
1.182 matthew 5212: ###############################################
1.251 albertel 5213: ###############################################
5214:
5215: =pod
5216:
5217: =item * &endbodytag()
5218:
5219: Returns a uniform footer for LON-CAPA web pages.
5220:
1.635 raeburn 5221: Inputs: 1 - optional reference to an args hash
5222: If in the hash, key for noredirectlink has a value which evaluates to true,
5223: a 'Continue' link is not displayed if the page contains an
5224: internal redirect in the <head></head> section,
5225: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5226:
5227: =cut
5228:
5229: sub endbodytag {
1.635 raeburn 5230: my ($args) = @_;
1.1075.2.6 raeburn 5231: my $endbodytag;
5232: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5233: $endbodytag='</body>';
5234: }
1.269 albertel 5235: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 5236: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5237: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5238: $endbodytag=
5239: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5240: &mt('Continue').'</a>'.
5241: $endbodytag;
5242: }
1.315 albertel 5243: }
1.251 albertel 5244: return $endbodytag;
5245: }
5246:
1.352 albertel 5247: =pod
5248:
5249: =item * &standard_css()
5250:
5251: Returns a style sheet
5252:
5253: Inputs: (all optional)
5254: domain -> force to color decorate a page for a specific
5255: domain
5256: function -> force usage of a specific rolish color scheme
5257: bgcolor -> override the default page bgcolor
5258:
5259: =cut
5260:
1.343 albertel 5261: sub standard_css {
1.345 albertel 5262: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5263: $function = &get_users_function() if (!$function);
5264: my $img = &designparm($function.'.img', $domain);
5265: my $tabbg = &designparm($function.'.tabbg', $domain);
5266: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5267: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5268: #second colour for later usage
1.345 albertel 5269: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5270: my $pgbg_or_bgcolor =
5271: $bgcolor ||
1.352 albertel 5272: &designparm($function.'.pgbg', $domain);
1.382 albertel 5273: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5274: my $alink = &designparm($function.'.alink', $domain);
5275: my $vlink = &designparm($function.'.vlink', $domain);
5276: my $link = &designparm($function.'.link', $domain);
5277:
1.602 albertel 5278: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5279: my $mono = 'monospace';
1.850 bisitz 5280: my $data_table_head = $sidebg;
5281: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5282: my $data_table_dark = '#E0E0E0';
1.470 banghart 5283: my $data_table_darker = '#CCCCCC';
1.349 albertel 5284: my $data_table_highlight = '#FFFF00';
1.352 albertel 5285: my $mail_new = '#FFBB77';
5286: my $mail_new_hover = '#DD9955';
5287: my $mail_read = '#BBBB77';
5288: my $mail_read_hover = '#999944';
5289: my $mail_replied = '#AAAA88';
5290: my $mail_replied_hover = '#888855';
5291: my $mail_other = '#99BBBB';
5292: my $mail_other_hover = '#669999';
1.391 albertel 5293: my $table_header = '#DDDDDD';
1.489 raeburn 5294: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5295: my $lg_border_color = '#C8C8C8';
1.952 onken 5296: my $button_hover = '#BF2317';
1.392 albertel 5297:
1.608 albertel 5298: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5299: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5300: : '0 3px 0 4px';
1.448 albertel 5301:
1.523 albertel 5302:
1.343 albertel 5303: return <<END;
1.947 droeschl 5304:
5305: /* needed for iframe to allow 100% height in FF */
5306: body, html {
5307: margin: 0;
5308: padding: 0 0.5%;
5309: height: 99%; /* to avoid scrollbars */
5310: }
5311:
1.795 www 5312: body {
1.911 bisitz 5313: font-family: $sans;
5314: line-height:130%;
5315: font-size:0.83em;
5316: color:$font;
1.795 www 5317: }
5318:
1.959 onken 5319: a:focus,
5320: a:focus img {
1.795 www 5321: color: red;
5322: }
1.698 harmsja 5323:
1.911 bisitz 5324: form, .inline {
5325: display: inline;
1.795 www 5326: }
1.721 harmsja 5327:
1.795 www 5328: .LC_right {
1.911 bisitz 5329: text-align:right;
1.795 www 5330: }
5331:
5332: .LC_middle {
1.911 bisitz 5333: vertical-align:middle;
1.795 www 5334: }
1.721 harmsja 5335:
1.911 bisitz 5336: .LC_400Box {
5337: width:400px;
5338: }
1.721 harmsja 5339:
1.947 droeschl 5340: .LC_iframecontainer {
5341: width: 98%;
5342: margin: 0;
5343: position: fixed;
5344: top: 8.5em;
5345: bottom: 0;
5346: }
5347:
5348: .LC_iframecontainer iframe{
5349: border: none;
5350: width: 100%;
5351: height: 100%;
5352: }
5353:
1.778 bisitz 5354: .LC_filename {
5355: font-family: $mono;
5356: white-space:pre;
1.921 bisitz 5357: font-size: 120%;
1.778 bisitz 5358: }
5359:
5360: .LC_fileicon {
5361: border: none;
5362: height: 1.3em;
5363: vertical-align: text-bottom;
5364: margin-right: 0.3em;
5365: text-decoration:none;
5366: }
5367:
1.1008 www 5368: .LC_setting {
5369: text-decoration:underline;
5370: }
5371:
1.350 albertel 5372: .LC_error {
5373: color: red;
5374: font-size: larger;
5375: }
1.795 www 5376:
1.457 albertel 5377: .LC_warning,
5378: .LC_diff_removed {
1.733 bisitz 5379: color: red;
1.394 albertel 5380: }
1.532 albertel 5381:
5382: .LC_info,
1.457 albertel 5383: .LC_success,
5384: .LC_diff_added {
1.350 albertel 5385: color: green;
5386: }
1.795 www 5387:
1.802 bisitz 5388: div.LC_confirm_box {
5389: background-color: #FAFAFA;
5390: border: 1px solid $lg_border_color;
5391: margin-right: 0;
5392: padding: 5px;
5393: }
5394:
5395: div.LC_confirm_box .LC_error img,
5396: div.LC_confirm_box .LC_success img {
5397: vertical-align: middle;
5398: }
5399:
1.440 albertel 5400: .LC_icon {
1.771 droeschl 5401: border: none;
1.790 droeschl 5402: vertical-align: middle;
1.771 droeschl 5403: }
5404:
1.543 albertel 5405: .LC_docs_spacer {
5406: width: 25px;
5407: height: 1px;
1.771 droeschl 5408: border: none;
1.543 albertel 5409: }
1.346 albertel 5410:
1.532 albertel 5411: .LC_internal_info {
1.735 bisitz 5412: color: #999999;
1.532 albertel 5413: }
5414:
1.794 www 5415: .LC_discussion {
1.1050 www 5416: background: $data_table_dark;
1.911 bisitz 5417: border: 1px solid black;
5418: margin: 2px;
1.794 www 5419: }
5420:
5421: .LC_disc_action_left {
1.1050 www 5422: background: $sidebg;
1.911 bisitz 5423: text-align: left;
1.1050 www 5424: padding: 4px;
5425: margin: 2px;
1.794 www 5426: }
5427:
5428: .LC_disc_action_right {
1.1050 www 5429: background: $sidebg;
1.911 bisitz 5430: text-align: right;
1.1050 www 5431: padding: 4px;
5432: margin: 2px;
1.794 www 5433: }
5434:
5435: .LC_disc_new_item {
1.911 bisitz 5436: background: white;
5437: border: 2px solid red;
1.1050 www 5438: margin: 4px;
5439: padding: 4px;
1.794 www 5440: }
5441:
5442: .LC_disc_old_item {
1.911 bisitz 5443: background: white;
1.1050 www 5444: margin: 4px;
5445: padding: 4px;
1.794 www 5446: }
5447:
1.458 albertel 5448: table.LC_pastsubmission {
5449: border: 1px solid black;
5450: margin: 2px;
5451: }
5452:
1.924 bisitz 5453: table#LC_menubuttons {
1.345 albertel 5454: width: 100%;
5455: background: $pgbg;
1.392 albertel 5456: border: 2px;
1.402 albertel 5457: border-collapse: separate;
1.803 bisitz 5458: padding: 0;
1.345 albertel 5459: }
1.392 albertel 5460:
1.801 tempelho 5461: table#LC_title_bar a {
5462: color: $fontmenu;
5463: }
1.836 bisitz 5464:
1.807 droeschl 5465: table#LC_title_bar {
1.819 tempelho 5466: clear: both;
1.836 bisitz 5467: display: none;
1.807 droeschl 5468: }
5469:
1.795 www 5470: table#LC_title_bar,
1.933 droeschl 5471: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 5472: table#LC_title_bar.LC_with_remote {
1.359 albertel 5473: width: 100%;
1.392 albertel 5474: border-color: $pgbg;
5475: border-style: solid;
5476: border-width: $border;
1.379 albertel 5477: background: $pgbg;
1.801 tempelho 5478: color: $fontmenu;
1.392 albertel 5479: border-collapse: collapse;
1.803 bisitz 5480: padding: 0;
1.819 tempelho 5481: margin: 0;
1.359 albertel 5482: }
1.795 www 5483:
1.933 droeschl 5484: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5485: margin: 0;
5486: padding: 0;
1.933 droeschl 5487: position: relative;
5488: list-style: none;
1.913 droeschl 5489: }
1.933 droeschl 5490: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5491: display: inline;
5492: }
1.933 droeschl 5493:
5494: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5495: padding: 0;
1.933 droeschl 5496: margin: 0;
5497: float: left;
1.913 droeschl 5498: }
1.933 droeschl 5499: .LC_breadcrumb_tools_tools {
5500: padding: 0;
5501: margin: 0;
1.913 droeschl 5502: float: right;
5503: }
5504:
1.359 albertel 5505: table#LC_title_bar td {
5506: background: $tabbg;
5507: }
1.795 www 5508:
1.911 bisitz 5509: table#LC_menubuttons img {
1.803 bisitz 5510: border: none;
1.346 albertel 5511: }
1.795 www 5512:
1.842 droeschl 5513: .LC_breadcrumbs_component {
1.911 bisitz 5514: float: right;
5515: margin: 0 1em;
1.357 albertel 5516: }
1.842 droeschl 5517: .LC_breadcrumbs_component img {
1.911 bisitz 5518: vertical-align: middle;
1.777 tempelho 5519: }
1.795 www 5520:
1.383 albertel 5521: td.LC_table_cell_checkbox {
5522: text-align: center;
5523: }
1.795 www 5524:
5525: .LC_fontsize_small {
1.911 bisitz 5526: font-size: 70%;
1.705 tempelho 5527: }
5528:
1.844 bisitz 5529: #LC_breadcrumbs {
1.911 bisitz 5530: clear:both;
5531: background: $sidebg;
5532: border-bottom: 1px solid $lg_border_color;
5533: line-height: 2.5em;
1.933 droeschl 5534: overflow: hidden;
1.911 bisitz 5535: margin: 0;
5536: padding: 0;
1.995 raeburn 5537: text-align: left;
1.819 tempelho 5538: }
1.862 bisitz 5539:
1.993 raeburn 5540: .LC_head_subbox {
1.911 bisitz 5541: clear:both;
5542: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5543: border: 1px solid $sidebg;
5544: margin: 0 0 10px 0;
1.966 bisitz 5545: padding: 3px;
1.995 raeburn 5546: text-align: left;
1.822 bisitz 5547: }
5548:
1.795 www 5549: .LC_fontsize_medium {
1.911 bisitz 5550: font-size: 85%;
1.705 tempelho 5551: }
5552:
1.795 www 5553: .LC_fontsize_large {
1.911 bisitz 5554: font-size: 120%;
1.705 tempelho 5555: }
5556:
1.346 albertel 5557: .LC_menubuttons_inline_text {
5558: color: $font;
1.698 harmsja 5559: font-size: 90%;
1.701 harmsja 5560: padding-left:3px;
1.346 albertel 5561: }
5562:
1.934 droeschl 5563: .LC_menubuttons_inline_text img{
5564: vertical-align: middle;
5565: }
5566:
1.1051 www 5567: li.LC_menubuttons_inline_text img {
1.951 onken 5568: cursor:pointer;
1.1002 droeschl 5569: text-decoration: none;
1.951 onken 5570: }
5571:
1.526 www 5572: .LC_menubuttons_link {
5573: text-decoration: none;
5574: }
1.795 www 5575:
1.522 albertel 5576: .LC_menubuttons_category {
1.521 www 5577: color: $font;
1.526 www 5578: background: $pgbg;
1.521 www 5579: font-size: larger;
5580: font-weight: bold;
5581: }
5582:
1.346 albertel 5583: td.LC_menubuttons_text {
1.911 bisitz 5584: color: $font;
1.346 albertel 5585: }
1.706 harmsja 5586:
1.346 albertel 5587: .LC_current_location {
5588: background: $tabbg;
5589: }
1.795 www 5590:
1.938 bisitz 5591: table.LC_data_table {
1.347 albertel 5592: border: 1px solid #000000;
1.402 albertel 5593: border-collapse: separate;
1.426 albertel 5594: border-spacing: 1px;
1.610 albertel 5595: background: $pgbg;
1.347 albertel 5596: }
1.795 www 5597:
1.422 albertel 5598: .LC_data_table_dense {
5599: font-size: small;
5600: }
1.795 www 5601:
1.507 raeburn 5602: table.LC_nested_outer {
5603: border: 1px solid #000000;
1.589 raeburn 5604: border-collapse: collapse;
1.803 bisitz 5605: border-spacing: 0;
1.507 raeburn 5606: width: 100%;
5607: }
1.795 www 5608:
1.879 raeburn 5609: table.LC_innerpickbox,
1.507 raeburn 5610: table.LC_nested {
1.803 bisitz 5611: border: none;
1.589 raeburn 5612: border-collapse: collapse;
1.803 bisitz 5613: border-spacing: 0;
1.507 raeburn 5614: width: 100%;
5615: }
1.795 www 5616:
1.911 bisitz 5617: table.LC_data_table tr th,
5618: table.LC_calendar tr th,
1.879 raeburn 5619: table.LC_prior_tries tr th,
5620: table.LC_innerpickbox tr th {
1.349 albertel 5621: font-weight: bold;
5622: background-color: $data_table_head;
1.801 tempelho 5623: color:$fontmenu;
1.701 harmsja 5624: font-size:90%;
1.347 albertel 5625: }
1.795 www 5626:
1.879 raeburn 5627: table.LC_innerpickbox tr th,
5628: table.LC_innerpickbox tr td {
5629: vertical-align: top;
5630: }
5631:
1.711 raeburn 5632: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5633: background-color: #CCCCCC;
1.711 raeburn 5634: font-weight: bold;
5635: text-align: left;
5636: }
1.795 www 5637:
1.912 bisitz 5638: table.LC_data_table tr.LC_odd_row > td {
5639: background-color: $data_table_light;
5640: padding: 2px;
5641: vertical-align: top;
5642: }
5643:
1.809 bisitz 5644: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5645: background-color: $data_table_light;
1.912 bisitz 5646: vertical-align: top;
5647: }
5648:
5649: table.LC_data_table tr.LC_even_row > td {
5650: background-color: $data_table_dark;
1.425 albertel 5651: padding: 2px;
1.900 bisitz 5652: vertical-align: top;
1.347 albertel 5653: }
1.795 www 5654:
1.809 bisitz 5655: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5656: background-color: $data_table_dark;
1.900 bisitz 5657: vertical-align: top;
1.347 albertel 5658: }
1.795 www 5659:
1.425 albertel 5660: table.LC_data_table tr.LC_data_table_highlight td {
5661: background-color: $data_table_darker;
5662: }
1.795 www 5663:
1.639 raeburn 5664: table.LC_data_table tr td.LC_leftcol_header {
5665: background-color: $data_table_head;
5666: font-weight: bold;
5667: }
1.795 www 5668:
1.451 albertel 5669: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5670: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5671: font-weight: bold;
5672: font-style: italic;
5673: text-align: center;
5674: padding: 8px;
1.347 albertel 5675: }
1.795 www 5676:
1.940 bisitz 5677: table.LC_data_table tr.LC_empty_row td {
5678: background-color: $sidebg;
5679: }
5680:
5681: table.LC_nested tr.LC_empty_row td {
5682: background-color: #FFFFFF;
5683: }
5684:
1.890 droeschl 5685: table.LC_caption {
5686: }
5687:
1.507 raeburn 5688: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5689: padding: 4ex
5690: }
1.795 www 5691:
1.507 raeburn 5692: table.LC_nested_outer tr th {
5693: font-weight: bold;
1.801 tempelho 5694: color:$fontmenu;
1.507 raeburn 5695: background-color: $data_table_head;
1.701 harmsja 5696: font-size: small;
1.507 raeburn 5697: border-bottom: 1px solid #000000;
5698: }
1.795 www 5699:
1.507 raeburn 5700: table.LC_nested_outer tr td.LC_subheader {
5701: background-color: $data_table_head;
5702: font-weight: bold;
5703: font-size: small;
5704: border-bottom: 1px solid #000000;
5705: text-align: right;
1.451 albertel 5706: }
1.795 www 5707:
1.507 raeburn 5708: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5709: background-color: #CCCCCC;
1.451 albertel 5710: font-weight: bold;
5711: font-size: small;
1.507 raeburn 5712: text-align: center;
5713: }
1.795 www 5714:
1.589 raeburn 5715: table.LC_nested tr.LC_info_row td.LC_left_item,
5716: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5717: text-align: left;
1.451 albertel 5718: }
1.795 www 5719:
1.507 raeburn 5720: table.LC_nested td {
1.735 bisitz 5721: background-color: #FFFFFF;
1.451 albertel 5722: font-size: small;
1.507 raeburn 5723: }
1.795 www 5724:
1.507 raeburn 5725: table.LC_nested_outer tr th.LC_right_item,
5726: table.LC_nested tr.LC_info_row td.LC_right_item,
5727: table.LC_nested tr.LC_odd_row td.LC_right_item,
5728: table.LC_nested tr td.LC_right_item {
1.451 albertel 5729: text-align: right;
5730: }
5731:
1.507 raeburn 5732: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5733: background-color: #EEEEEE;
1.451 albertel 5734: }
5735:
1.473 raeburn 5736: table.LC_createuser {
5737: }
5738:
5739: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5740: font-size: small;
1.473 raeburn 5741: }
5742:
5743: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5744: background-color: #CCCCCC;
1.473 raeburn 5745: font-weight: bold;
5746: text-align: center;
5747: }
5748:
1.349 albertel 5749: table.LC_calendar {
5750: border: 1px solid #000000;
5751: border-collapse: collapse;
1.917 raeburn 5752: width: 98%;
1.349 albertel 5753: }
1.795 www 5754:
1.349 albertel 5755: table.LC_calendar_pickdate {
5756: font-size: xx-small;
5757: }
1.795 www 5758:
1.349 albertel 5759: table.LC_calendar tr td {
5760: border: 1px solid #000000;
5761: vertical-align: top;
1.917 raeburn 5762: width: 14%;
1.349 albertel 5763: }
1.795 www 5764:
1.349 albertel 5765: table.LC_calendar tr td.LC_calendar_day_empty {
5766: background-color: $data_table_dark;
5767: }
1.795 www 5768:
1.779 bisitz 5769: table.LC_calendar tr td.LC_calendar_day_current {
5770: background-color: $data_table_highlight;
1.777 tempelho 5771: }
1.795 www 5772:
1.938 bisitz 5773: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5774: background-color: $mail_new;
5775: }
1.795 www 5776:
1.938 bisitz 5777: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5778: background-color: $mail_new_hover;
5779: }
1.795 www 5780:
1.938 bisitz 5781: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5782: background-color: $mail_read;
5783: }
1.795 www 5784:
1.938 bisitz 5785: /*
5786: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5787: background-color: $mail_read_hover;
5788: }
1.938 bisitz 5789: */
1.795 www 5790:
1.938 bisitz 5791: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5792: background-color: $mail_replied;
5793: }
1.795 www 5794:
1.938 bisitz 5795: /*
5796: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5797: background-color: $mail_replied_hover;
5798: }
1.938 bisitz 5799: */
1.795 www 5800:
1.938 bisitz 5801: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5802: background-color: $mail_other;
5803: }
1.795 www 5804:
1.938 bisitz 5805: /*
5806: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5807: background-color: $mail_other_hover;
5808: }
1.938 bisitz 5809: */
1.494 raeburn 5810:
1.777 tempelho 5811: table.LC_data_table tr > td.LC_browser_file,
5812: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5813: background: #AAEE77;
1.389 albertel 5814: }
1.795 www 5815:
1.777 tempelho 5816: table.LC_data_table tr > td.LC_browser_file_locked,
5817: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5818: background: #FFAA99;
1.387 albertel 5819: }
1.795 www 5820:
1.777 tempelho 5821: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5822: background: #888888;
1.779 bisitz 5823: }
1.795 www 5824:
1.777 tempelho 5825: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5826: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5827: background: #F8F866;
1.777 tempelho 5828: }
1.795 www 5829:
1.696 bisitz 5830: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5831: background: #E0E8FF;
1.387 albertel 5832: }
1.696 bisitz 5833:
1.707 bisitz 5834: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5835: /* background: #77FF77; */
1.707 bisitz 5836: }
1.795 www 5837:
1.707 bisitz 5838: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5839: border-right: 8px solid #FFFF77;
1.707 bisitz 5840: }
1.795 www 5841:
1.707 bisitz 5842: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5843: border-right: 8px solid #FFAA77;
1.707 bisitz 5844: }
1.795 www 5845:
1.707 bisitz 5846: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5847: border-right: 8px solid #FF7777;
1.707 bisitz 5848: }
1.795 www 5849:
1.707 bisitz 5850: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5851: border-right: 8px solid #AAFF77;
1.707 bisitz 5852: }
1.795 www 5853:
1.707 bisitz 5854: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5855: border-right: 8px solid #11CC55;
1.707 bisitz 5856: }
5857:
1.388 albertel 5858: span.LC_current_location {
1.701 harmsja 5859: font-size:larger;
1.388 albertel 5860: background: $pgbg;
5861: }
1.387 albertel 5862:
1.1029 www 5863: span.LC_current_nav_location {
5864: font-weight:bold;
5865: background: $sidebg;
5866: }
5867:
1.395 albertel 5868: span.LC_parm_menu_item {
5869: font-size: larger;
5870: }
1.795 www 5871:
1.395 albertel 5872: span.LC_parm_scope_all {
5873: color: red;
5874: }
1.795 www 5875:
1.395 albertel 5876: span.LC_parm_scope_folder {
5877: color: green;
5878: }
1.795 www 5879:
1.395 albertel 5880: span.LC_parm_scope_resource {
5881: color: orange;
5882: }
1.795 www 5883:
1.395 albertel 5884: span.LC_parm_part {
5885: color: blue;
5886: }
1.795 www 5887:
1.911 bisitz 5888: span.LC_parm_folder,
5889: span.LC_parm_symb {
1.395 albertel 5890: font-size: x-small;
5891: font-family: $mono;
5892: color: #AAAAAA;
5893: }
5894:
1.977 bisitz 5895: ul.LC_parm_parmlist li {
5896: display: inline-block;
5897: padding: 0.3em 0.8em;
5898: vertical-align: top;
5899: width: 150px;
5900: border-top:1px solid $lg_border_color;
5901: }
5902:
1.795 www 5903: td.LC_parm_overview_level_menu,
5904: td.LC_parm_overview_map_menu,
5905: td.LC_parm_overview_parm_selectors,
5906: td.LC_parm_overview_restrictions {
1.396 albertel 5907: border: 1px solid black;
5908: border-collapse: collapse;
5909: }
1.795 www 5910:
1.396 albertel 5911: table.LC_parm_overview_restrictions td {
5912: border-width: 1px 4px 1px 4px;
5913: border-style: solid;
5914: border-color: $pgbg;
5915: text-align: center;
5916: }
1.795 www 5917:
1.396 albertel 5918: table.LC_parm_overview_restrictions th {
5919: background: $tabbg;
5920: border-width: 1px 4px 1px 4px;
5921: border-style: solid;
5922: border-color: $pgbg;
5923: }
1.795 www 5924:
1.398 albertel 5925: table#LC_helpmenu {
1.803 bisitz 5926: border: none;
1.398 albertel 5927: height: 55px;
1.803 bisitz 5928: border-spacing: 0;
1.398 albertel 5929: }
5930:
5931: table#LC_helpmenu fieldset legend {
5932: font-size: larger;
5933: }
1.795 www 5934:
1.397 albertel 5935: table#LC_helpmenu_links {
5936: width: 100%;
5937: border: 1px solid black;
5938: background: $pgbg;
1.803 bisitz 5939: padding: 0;
1.397 albertel 5940: border-spacing: 1px;
5941: }
1.795 www 5942:
1.397 albertel 5943: table#LC_helpmenu_links tr td {
5944: padding: 1px;
5945: background: $tabbg;
1.399 albertel 5946: text-align: center;
5947: font-weight: bold;
1.397 albertel 5948: }
1.396 albertel 5949:
1.795 www 5950: table#LC_helpmenu_links a:link,
5951: table#LC_helpmenu_links a:visited,
1.397 albertel 5952: table#LC_helpmenu_links a:active {
5953: text-decoration: none;
5954: color: $font;
5955: }
1.795 www 5956:
1.397 albertel 5957: table#LC_helpmenu_links a:hover {
5958: text-decoration: underline;
5959: color: $vlink;
5960: }
1.396 albertel 5961:
1.417 albertel 5962: .LC_chrt_popup_exists {
5963: border: 1px solid #339933;
5964: margin: -1px;
5965: }
1.795 www 5966:
1.417 albertel 5967: .LC_chrt_popup_up {
5968: border: 1px solid yellow;
5969: margin: -1px;
5970: }
1.795 www 5971:
1.417 albertel 5972: .LC_chrt_popup {
5973: border: 1px solid #8888FF;
5974: background: #CCCCFF;
5975: }
1.795 www 5976:
1.421 albertel 5977: table.LC_pick_box {
5978: border-collapse: separate;
5979: background: white;
5980: border: 1px solid black;
5981: border-spacing: 1px;
5982: }
1.795 www 5983:
1.421 albertel 5984: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5985: background: $sidebg;
1.421 albertel 5986: font-weight: bold;
1.900 bisitz 5987: text-align: left;
1.740 bisitz 5988: vertical-align: top;
1.421 albertel 5989: width: 184px;
5990: padding: 8px;
5991: }
1.795 www 5992:
1.579 raeburn 5993: table.LC_pick_box td.LC_pick_box_value {
5994: text-align: left;
5995: padding: 8px;
5996: }
1.795 www 5997:
1.579 raeburn 5998: table.LC_pick_box td.LC_pick_box_select {
5999: text-align: left;
6000: padding: 8px;
6001: }
1.795 www 6002:
1.424 albertel 6003: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6004: padding: 0;
1.421 albertel 6005: height: 1px;
6006: background: black;
6007: }
1.795 www 6008:
1.421 albertel 6009: table.LC_pick_box td.LC_pick_box_submit {
6010: text-align: right;
6011: }
1.795 www 6012:
1.579 raeburn 6013: table.LC_pick_box td.LC_evenrow_value {
6014: text-align: left;
6015: padding: 8px;
6016: background-color: $data_table_light;
6017: }
1.795 www 6018:
1.579 raeburn 6019: table.LC_pick_box td.LC_oddrow_value {
6020: text-align: left;
6021: padding: 8px;
6022: background-color: $data_table_light;
6023: }
1.795 www 6024:
1.579 raeburn 6025: span.LC_helpform_receipt_cat {
6026: font-weight: bold;
6027: }
1.795 www 6028:
1.424 albertel 6029: table.LC_group_priv_box {
6030: background: white;
6031: border: 1px solid black;
6032: border-spacing: 1px;
6033: }
1.795 www 6034:
1.424 albertel 6035: table.LC_group_priv_box td.LC_pick_box_title {
6036: background: $tabbg;
6037: font-weight: bold;
6038: text-align: right;
6039: width: 184px;
6040: }
1.795 www 6041:
1.424 albertel 6042: table.LC_group_priv_box td.LC_groups_fixed {
6043: background: $data_table_light;
6044: text-align: center;
6045: }
1.795 www 6046:
1.424 albertel 6047: table.LC_group_priv_box td.LC_groups_optional {
6048: background: $data_table_dark;
6049: text-align: center;
6050: }
1.795 www 6051:
1.424 albertel 6052: table.LC_group_priv_box td.LC_groups_functionality {
6053: background: $data_table_darker;
6054: text-align: center;
6055: font-weight: bold;
6056: }
1.795 www 6057:
1.424 albertel 6058: table.LC_group_priv td {
6059: text-align: left;
1.803 bisitz 6060: padding: 0;
1.424 albertel 6061: }
6062:
6063: .LC_navbuttons {
6064: margin: 2ex 0ex 2ex 0ex;
6065: }
1.795 www 6066:
1.423 albertel 6067: .LC_topic_bar {
6068: font-weight: bold;
6069: background: $tabbg;
1.918 wenzelju 6070: margin: 1em 0em 1em 2em;
1.805 bisitz 6071: padding: 3px;
1.918 wenzelju 6072: font-size: 1.2em;
1.423 albertel 6073: }
1.795 www 6074:
1.423 albertel 6075: .LC_topic_bar span {
1.918 wenzelju 6076: left: 0.5em;
6077: position: absolute;
1.423 albertel 6078: vertical-align: middle;
1.918 wenzelju 6079: font-size: 1.2em;
1.423 albertel 6080: }
1.795 www 6081:
1.423 albertel 6082: table.LC_course_group_status {
6083: margin: 20px;
6084: }
1.795 www 6085:
1.423 albertel 6086: table.LC_status_selector td {
6087: vertical-align: top;
6088: text-align: center;
1.424 albertel 6089: padding: 4px;
6090: }
1.795 www 6091:
1.599 albertel 6092: div.LC_feedback_link {
1.616 albertel 6093: clear: both;
1.829 kalberla 6094: background: $sidebg;
1.779 bisitz 6095: width: 100%;
1.829 kalberla 6096: padding-bottom: 10px;
6097: border: 1px $tabbg solid;
1.833 kalberla 6098: height: 22px;
6099: line-height: 22px;
6100: padding-top: 5px;
6101: }
6102:
6103: div.LC_feedback_link img {
6104: height: 22px;
1.867 kalberla 6105: vertical-align:middle;
1.829 kalberla 6106: }
6107:
1.911 bisitz 6108: div.LC_feedback_link a {
1.829 kalberla 6109: text-decoration: none;
1.489 raeburn 6110: }
1.795 www 6111:
1.867 kalberla 6112: div.LC_comblock {
1.911 bisitz 6113: display:inline;
1.867 kalberla 6114: color:$font;
6115: font-size:90%;
6116: }
6117:
6118: div.LC_feedback_link div.LC_comblock {
6119: padding-left:5px;
6120: }
6121:
6122: div.LC_feedback_link div.LC_comblock a {
6123: color:$font;
6124: }
6125:
1.489 raeburn 6126: span.LC_feedback_link {
1.858 bisitz 6127: /* background: $feedback_link_bg; */
1.599 albertel 6128: font-size: larger;
6129: }
1.795 www 6130:
1.599 albertel 6131: span.LC_message_link {
1.858 bisitz 6132: /* background: $feedback_link_bg; */
1.599 albertel 6133: font-size: larger;
6134: position: absolute;
6135: right: 1em;
1.489 raeburn 6136: }
1.421 albertel 6137:
1.515 albertel 6138: table.LC_prior_tries {
1.524 albertel 6139: border: 1px solid #000000;
6140: border-collapse: separate;
6141: border-spacing: 1px;
1.515 albertel 6142: }
1.523 albertel 6143:
1.515 albertel 6144: table.LC_prior_tries td {
1.524 albertel 6145: padding: 2px;
1.515 albertel 6146: }
1.523 albertel 6147:
6148: .LC_answer_correct {
1.795 www 6149: background: lightgreen;
6150: color: darkgreen;
6151: padding: 6px;
1.523 albertel 6152: }
1.795 www 6153:
1.523 albertel 6154: .LC_answer_charged_try {
1.797 www 6155: background: #FFAAAA;
1.795 www 6156: color: darkred;
6157: padding: 6px;
1.523 albertel 6158: }
1.795 www 6159:
1.779 bisitz 6160: .LC_answer_not_charged_try,
1.523 albertel 6161: .LC_answer_no_grade,
6162: .LC_answer_late {
1.795 www 6163: background: lightyellow;
1.523 albertel 6164: color: black;
1.795 www 6165: padding: 6px;
1.523 albertel 6166: }
1.795 www 6167:
1.523 albertel 6168: .LC_answer_previous {
1.795 www 6169: background: lightblue;
6170: color: darkblue;
6171: padding: 6px;
1.523 albertel 6172: }
1.795 www 6173:
1.779 bisitz 6174: .LC_answer_no_message {
1.777 tempelho 6175: background: #FFFFFF;
6176: color: black;
1.795 www 6177: padding: 6px;
1.779 bisitz 6178: }
1.795 www 6179:
1.779 bisitz 6180: .LC_answer_unknown {
6181: background: orange;
6182: color: black;
1.795 www 6183: padding: 6px;
1.777 tempelho 6184: }
1.795 www 6185:
1.529 albertel 6186: span.LC_prior_numerical,
6187: span.LC_prior_string,
6188: span.LC_prior_custom,
6189: span.LC_prior_reaction,
6190: span.LC_prior_math {
1.925 bisitz 6191: font-family: $mono;
1.523 albertel 6192: white-space: pre;
6193: }
6194:
1.525 albertel 6195: span.LC_prior_string {
1.925 bisitz 6196: font-family: $mono;
1.525 albertel 6197: white-space: pre;
6198: }
6199:
1.523 albertel 6200: table.LC_prior_option {
6201: width: 100%;
6202: border-collapse: collapse;
6203: }
1.795 www 6204:
1.911 bisitz 6205: table.LC_prior_rank,
1.795 www 6206: table.LC_prior_match {
1.528 albertel 6207: border-collapse: collapse;
6208: }
1.795 www 6209:
1.528 albertel 6210: table.LC_prior_option tr td,
6211: table.LC_prior_rank tr td,
6212: table.LC_prior_match tr td {
1.524 albertel 6213: border: 1px solid #000000;
1.515 albertel 6214: }
6215:
1.855 bisitz 6216: .LC_nobreak {
1.544 albertel 6217: white-space: nowrap;
1.519 raeburn 6218: }
6219:
1.576 raeburn 6220: span.LC_cusr_emph {
6221: font-style: italic;
6222: }
6223:
1.633 raeburn 6224: span.LC_cusr_subheading {
6225: font-weight: normal;
6226: font-size: 85%;
6227: }
6228:
1.861 bisitz 6229: div.LC_docs_entry_move {
1.859 bisitz 6230: border: 1px solid #BBBBBB;
1.545 albertel 6231: background: #DDDDDD;
1.861 bisitz 6232: width: 22px;
1.859 bisitz 6233: padding: 1px;
6234: margin: 0;
1.545 albertel 6235: }
6236:
1.861 bisitz 6237: table.LC_data_table tr > td.LC_docs_entry_commands,
6238: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6239: background: #DDDDDD;
6240: font-size: x-small;
6241: }
1.795 www 6242:
1.861 bisitz 6243: .LC_docs_entry_parameter {
6244: white-space: nowrap;
6245: }
6246:
1.544 albertel 6247: .LC_docs_copy {
1.545 albertel 6248: color: #000099;
1.544 albertel 6249: }
1.795 www 6250:
1.544 albertel 6251: .LC_docs_cut {
1.545 albertel 6252: color: #550044;
1.544 albertel 6253: }
1.795 www 6254:
1.544 albertel 6255: .LC_docs_rename {
1.545 albertel 6256: color: #009900;
1.544 albertel 6257: }
1.795 www 6258:
1.544 albertel 6259: .LC_docs_remove {
1.545 albertel 6260: color: #990000;
6261: }
6262:
1.547 albertel 6263: .LC_docs_reinit_warn,
6264: .LC_docs_ext_edit {
6265: font-size: x-small;
6266: }
6267:
1.545 albertel 6268: table.LC_docs_adddocs td,
6269: table.LC_docs_adddocs th {
6270: border: 1px solid #BBBBBB;
6271: padding: 4px;
6272: background: #DDDDDD;
1.543 albertel 6273: }
6274:
1.584 albertel 6275: table.LC_sty_begin {
6276: background: #BBFFBB;
6277: }
1.795 www 6278:
1.584 albertel 6279: table.LC_sty_end {
6280: background: #FFBBBB;
6281: }
6282:
1.589 raeburn 6283: table.LC_double_column {
1.803 bisitz 6284: border-width: 0;
1.589 raeburn 6285: border-collapse: collapse;
6286: width: 100%;
6287: padding: 2px;
6288: }
6289:
6290: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6291: top: 2px;
1.589 raeburn 6292: left: 2px;
6293: width: 47%;
6294: vertical-align: top;
6295: }
6296:
6297: table.LC_double_column tr td.LC_right_col {
6298: top: 2px;
1.779 bisitz 6299: right: 2px;
1.589 raeburn 6300: width: 47%;
6301: vertical-align: top;
6302: }
6303:
1.591 raeburn 6304: div.LC_left_float {
6305: float: left;
6306: padding-right: 5%;
1.597 albertel 6307: padding-bottom: 4px;
1.591 raeburn 6308: }
6309:
6310: div.LC_clear_float_header {
1.597 albertel 6311: padding-bottom: 2px;
1.591 raeburn 6312: }
6313:
6314: div.LC_clear_float_footer {
1.597 albertel 6315: padding-top: 10px;
1.591 raeburn 6316: clear: both;
6317: }
6318:
1.597 albertel 6319: div.LC_grade_show_user {
1.941 bisitz 6320: /* border-left: 5px solid $sidebg; */
6321: border-top: 5px solid #000000;
6322: margin: 50px 0 0 0;
1.936 bisitz 6323: padding: 15px 0 5px 10px;
1.597 albertel 6324: }
1.795 www 6325:
1.936 bisitz 6326: div.LC_grade_show_user_odd_row {
1.941 bisitz 6327: /* border-left: 5px solid #000000; */
6328: }
6329:
6330: div.LC_grade_show_user div.LC_Box {
6331: margin-right: 50px;
1.597 albertel 6332: }
6333:
6334: div.LC_grade_submissions,
6335: div.LC_grade_message_center,
1.936 bisitz 6336: div.LC_grade_info_links {
1.597 albertel 6337: margin: 5px;
6338: width: 99%;
6339: background: #FFFFFF;
6340: }
1.795 www 6341:
1.597 albertel 6342: div.LC_grade_submissions_header,
1.936 bisitz 6343: div.LC_grade_message_center_header {
1.705 tempelho 6344: font-weight: bold;
6345: font-size: large;
1.597 albertel 6346: }
1.795 www 6347:
1.597 albertel 6348: div.LC_grade_submissions_body,
1.936 bisitz 6349: div.LC_grade_message_center_body {
1.597 albertel 6350: border: 1px solid black;
6351: width: 99%;
6352: background: #FFFFFF;
6353: }
1.795 www 6354:
1.613 albertel 6355: table.LC_scantron_action {
6356: width: 100%;
6357: }
1.795 www 6358:
1.613 albertel 6359: table.LC_scantron_action tr th {
1.698 harmsja 6360: font-weight:bold;
6361: font-style:normal;
1.613 albertel 6362: }
1.795 www 6363:
1.779 bisitz 6364: .LC_edit_problem_header,
1.614 albertel 6365: div.LC_edit_problem_footer {
1.705 tempelho 6366: font-weight: normal;
6367: font-size: medium;
1.602 albertel 6368: margin: 2px;
1.1060 bisitz 6369: background-color: $sidebg;
1.600 albertel 6370: }
1.795 www 6371:
1.600 albertel 6372: div.LC_edit_problem_header,
1.602 albertel 6373: div.LC_edit_problem_header div,
1.614 albertel 6374: div.LC_edit_problem_footer,
6375: div.LC_edit_problem_footer div,
1.602 albertel 6376: div.LC_edit_problem_editxml_header,
6377: div.LC_edit_problem_editxml_header div {
1.600 albertel 6378: margin-top: 5px;
6379: }
1.795 www 6380:
1.600 albertel 6381: div.LC_edit_problem_header_title {
1.705 tempelho 6382: font-weight: bold;
6383: font-size: larger;
1.602 albertel 6384: background: $tabbg;
6385: padding: 3px;
1.1060 bisitz 6386: margin: 0 0 5px 0;
1.602 albertel 6387: }
1.795 www 6388:
1.602 albertel 6389: table.LC_edit_problem_header_title {
6390: width: 100%;
1.600 albertel 6391: background: $tabbg;
1.602 albertel 6392: }
6393:
6394: div.LC_edit_problem_discards {
6395: float: left;
6396: padding-bottom: 5px;
6397: }
1.795 www 6398:
1.602 albertel 6399: div.LC_edit_problem_saves {
6400: float: right;
6401: padding-bottom: 5px;
1.600 albertel 6402: }
1.795 www 6403:
1.911 bisitz 6404: img.stift {
1.803 bisitz 6405: border-width: 0;
6406: vertical-align: middle;
1.677 riegler 6407: }
1.680 riegler 6408:
1.923 bisitz 6409: table td.LC_mainmenu_col_fieldset {
1.680 riegler 6410: vertical-align: top;
1.777 tempelho 6411: }
1.795 www 6412:
1.716 raeburn 6413: div.LC_createcourse {
1.911 bisitz 6414: margin: 10px 10px 10px 10px;
1.716 raeburn 6415: }
6416:
1.917 raeburn 6417: .LC_dccid {
6418: margin: 0.2em 0 0 0;
6419: padding: 0;
6420: font-size: 90%;
6421: display:none;
6422: }
6423:
1.897 wenzelju 6424: ol.LC_primary_menu a:hover,
1.721 harmsja 6425: ol#LC_MenuBreadcrumbs a:hover,
6426: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 6427: ul#LC_secondary_menu a:hover,
1.721 harmsja 6428: .LC_FormSectionClearButton input:hover
1.795 www 6429: ul.LC_TabContent li:hover a {
1.952 onken 6430: color:$button_hover;
1.911 bisitz 6431: text-decoration:none;
1.693 droeschl 6432: }
6433:
1.779 bisitz 6434: h1 {
1.911 bisitz 6435: padding: 0;
6436: line-height:130%;
1.693 droeschl 6437: }
1.698 harmsja 6438:
1.911 bisitz 6439: h2,
6440: h3,
6441: h4,
6442: h5,
6443: h6 {
6444: margin: 5px 0 5px 0;
6445: padding: 0;
6446: line-height:130%;
1.693 droeschl 6447: }
1.795 www 6448:
6449: .LC_hcell {
1.911 bisitz 6450: padding:3px 15px 3px 15px;
6451: margin: 0;
6452: background-color:$tabbg;
6453: color:$fontmenu;
6454: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 6455: }
1.795 www 6456:
1.840 bisitz 6457: .LC_Box > .LC_hcell {
1.911 bisitz 6458: margin: 0 -10px 10px -10px;
1.835 bisitz 6459: }
6460:
1.721 harmsja 6461: .LC_noBorder {
1.911 bisitz 6462: border: 0;
1.698 harmsja 6463: }
1.693 droeschl 6464:
1.721 harmsja 6465: .LC_FormSectionClearButton input {
1.911 bisitz 6466: background-color:transparent;
6467: border: none;
6468: cursor:pointer;
6469: text-decoration:underline;
1.693 droeschl 6470: }
1.763 bisitz 6471:
6472: .LC_help_open_topic {
1.911 bisitz 6473: color: #FFFFFF;
6474: background-color: #EEEEFF;
6475: margin: 1px;
6476: padding: 4px;
6477: border: 1px solid #000033;
6478: white-space: nowrap;
6479: /* vertical-align: middle; */
1.759 neumanie 6480: }
1.693 droeschl 6481:
1.911 bisitz 6482: dl,
6483: ul,
6484: div,
6485: fieldset {
6486: margin: 10px 10px 10px 0;
6487: /* overflow: hidden; */
1.693 droeschl 6488: }
1.795 www 6489:
1.838 bisitz 6490: fieldset > legend {
1.911 bisitz 6491: font-weight: bold;
6492: padding: 0 5px 0 5px;
1.838 bisitz 6493: }
6494:
1.813 bisitz 6495: #LC_nav_bar {
1.911 bisitz 6496: float: left;
1.995 raeburn 6497: background-color: $pgbg_or_bgcolor;
1.966 bisitz 6498: margin: 0 0 2px 0;
1.807 droeschl 6499: }
6500:
1.916 droeschl 6501: #LC_realm {
6502: margin: 0.2em 0 0 0;
6503: padding: 0;
6504: font-weight: bold;
6505: text-align: center;
1.995 raeburn 6506: background-color: $pgbg_or_bgcolor;
1.916 droeschl 6507: }
6508:
1.911 bisitz 6509: #LC_nav_bar em {
6510: font-weight: bold;
6511: font-style: normal;
1.807 droeschl 6512: }
6513:
1.897 wenzelju 6514: ol.LC_primary_menu {
1.911 bisitz 6515: float: right;
1.934 droeschl 6516: margin: 0;
1.1075.2.2 raeburn 6517: padding: 0;
1.995 raeburn 6518: background-color: $pgbg_or_bgcolor;
1.807 droeschl 6519: }
6520:
1.852 droeschl 6521: ol#LC_PathBreadcrumbs {
1.911 bisitz 6522: margin: 0;
1.693 droeschl 6523: }
6524:
1.897 wenzelju 6525: ol.LC_primary_menu li {
1.1075.2.2 raeburn 6526: color: RGB(80, 80, 80);
6527: vertical-align: middle;
6528: text-align: left;
6529: list-style: none;
6530: float: left;
6531: }
6532:
6533: ol.LC_primary_menu li a {
6534: display: block;
6535: margin: 0;
6536: padding: 0 5px 0 10px;
6537: text-decoration: none;
6538: }
6539:
6540: ol.LC_primary_menu li ul {
6541: display: none;
6542: width: 10em;
6543: background-color: $data_table_light;
6544: }
6545:
6546: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
6547: display: block;
6548: position: absolute;
6549: margin: 0;
6550: padding: 0;
1.1075.2.5 raeburn 6551: z-index: 2;
1.1075.2.2 raeburn 6552: }
6553:
6554: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
6555: font-size: 90%;
1.911 bisitz 6556: vertical-align: top;
1.1075.2.2 raeburn 6557: float: none;
1.1075.2.5 raeburn 6558: border-left: 1px solid black;
6559: border-right: 1px solid black;
1.1075.2.2 raeburn 6560: }
6561:
6562: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1075.2.5 raeburn 6563: background-color:$data_table_light;
1.1075.2.2 raeburn 6564: }
6565:
6566: ol.LC_primary_menu li li a:hover {
6567: color:$button_hover;
6568: background-color:$data_table_dark;
1.693 droeschl 6569: }
6570:
1.897 wenzelju 6571: ol.LC_primary_menu li img {
1.911 bisitz 6572: vertical-align: bottom;
1.934 droeschl 6573: height: 1.1em;
1.1075.2.3 raeburn 6574: margin: 0.2em 0 0 0;
1.693 droeschl 6575: }
6576:
1.897 wenzelju 6577: ol.LC_primary_menu a {
1.911 bisitz 6578: color: RGB(80, 80, 80);
6579: text-decoration: none;
1.693 droeschl 6580: }
1.795 www 6581:
1.949 droeschl 6582: ol.LC_primary_menu a.LC_new_message {
6583: font-weight:bold;
6584: color: darkred;
6585: }
6586:
1.975 raeburn 6587: ol.LC_docs_parameters {
6588: margin-left: 0;
6589: padding: 0;
6590: list-style: none;
6591: }
6592:
6593: ol.LC_docs_parameters li {
6594: margin: 0;
6595: padding-right: 20px;
6596: display: inline;
6597: }
6598:
1.976 raeburn 6599: ol.LC_docs_parameters li:before {
6600: content: "\\002022 \\0020";
6601: }
6602:
6603: li.LC_docs_parameters_title {
6604: font-weight: bold;
6605: }
6606:
6607: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
6608: content: "";
6609: }
6610:
1.897 wenzelju 6611: ul#LC_secondary_menu {
1.911 bisitz 6612: clear: both;
6613: color: $fontmenu;
6614: background: $tabbg;
6615: list-style: none;
6616: padding: 0;
6617: margin: 0;
6618: width: 100%;
1.995 raeburn 6619: text-align: left;
1.1075.2.4 raeburn 6620: float: left;
1.808 droeschl 6621: }
6622:
1.897 wenzelju 6623: ul#LC_secondary_menu li {
1.911 bisitz 6624: font-weight: bold;
6625: line-height: 1.8em;
6626: border-right: 1px solid black;
6627: vertical-align: middle;
1.1075.2.4 raeburn 6628: float: left;
6629: }
6630:
6631: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
6632: background-color: $data_table_light;
6633: }
6634:
6635: ul#LC_secondary_menu li a {
6636: padding: 0 0.8em;
6637: }
6638:
6639: ul#LC_secondary_menu li ul {
6640: display: none;
6641: }
6642:
6643: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
6644: display: block;
6645: position: absolute;
6646: margin: 0;
6647: padding: 0;
6648: list-style:none;
6649: float: none;
6650: background-color: $data_table_light;
1.1075.2.5 raeburn 6651: z-index: 2;
1.1075.2.10 raeburn 6652: margin-left: -1px;
1.1075.2.4 raeburn 6653: }
6654:
6655: ul#LC_secondary_menu li ul li {
6656: font-size: 90%;
6657: vertical-align: top;
6658: border-left: 1px solid black;
6659: border-right: 1px solid black;
6660: background-color: $data_table_light
6661: list-style:none;
6662: float: none;
6663: }
6664:
6665: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
6666: background-color: $data_table_dark;
1.807 droeschl 6667: }
6668:
1.847 tempelho 6669: ul.LC_TabContent {
1.911 bisitz 6670: display:block;
6671: background: $sidebg;
6672: border-bottom: solid 1px $lg_border_color;
6673: list-style:none;
1.1020 raeburn 6674: margin: -1px -10px 0 -10px;
1.911 bisitz 6675: padding: 0;
1.693 droeschl 6676: }
6677:
1.795 www 6678: ul.LC_TabContent li,
6679: ul.LC_TabContentBigger li {
1.911 bisitz 6680: float:left;
1.741 harmsja 6681: }
1.795 www 6682:
1.897 wenzelju 6683: ul#LC_secondary_menu li a {
1.911 bisitz 6684: color: $fontmenu;
6685: text-decoration: none;
1.693 droeschl 6686: }
1.795 www 6687:
1.721 harmsja 6688: ul.LC_TabContent {
1.952 onken 6689: min-height:20px;
1.721 harmsja 6690: }
1.795 www 6691:
6692: ul.LC_TabContent li {
1.911 bisitz 6693: vertical-align:middle;
1.959 onken 6694: padding: 0 16px 0 10px;
1.911 bisitz 6695: background-color:$tabbg;
6696: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 6697: border-left: solid 1px $font;
1.721 harmsja 6698: }
1.795 www 6699:
1.847 tempelho 6700: ul.LC_TabContent .right {
1.911 bisitz 6701: float:right;
1.847 tempelho 6702: }
6703:
1.911 bisitz 6704: ul.LC_TabContent li a,
6705: ul.LC_TabContent li {
6706: color:rgb(47,47,47);
6707: text-decoration:none;
6708: font-size:95%;
6709: font-weight:bold;
1.952 onken 6710: min-height:20px;
6711: }
6712:
1.959 onken 6713: ul.LC_TabContent li a:hover,
6714: ul.LC_TabContent li a:focus {
1.952 onken 6715: color: $button_hover;
1.959 onken 6716: background:none;
6717: outline:none;
1.952 onken 6718: }
6719:
6720: ul.LC_TabContent li:hover {
6721: color: $button_hover;
6722: cursor:pointer;
1.721 harmsja 6723: }
1.795 www 6724:
1.911 bisitz 6725: ul.LC_TabContent li.active {
1.952 onken 6726: color: $font;
1.911 bisitz 6727: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6728: border-bottom:solid 1px #FFFFFF;
6729: cursor: default;
1.744 ehlerst 6730: }
1.795 www 6731:
1.959 onken 6732: ul.LC_TabContent li.active a {
6733: color:$font;
6734: background:#FFFFFF;
6735: outline: none;
6736: }
1.1047 raeburn 6737:
6738: ul.LC_TabContent li.goback {
6739: float: left;
6740: border-left: none;
6741: }
6742:
1.870 tempelho 6743: #maincoursedoc {
1.911 bisitz 6744: clear:both;
1.870 tempelho 6745: }
6746:
6747: ul.LC_TabContentBigger {
1.911 bisitz 6748: display:block;
6749: list-style:none;
6750: padding: 0;
1.870 tempelho 6751: }
6752:
1.795 www 6753: ul.LC_TabContentBigger li {
1.911 bisitz 6754: vertical-align:bottom;
6755: height: 30px;
6756: font-size:110%;
6757: font-weight:bold;
6758: color: #737373;
1.841 tempelho 6759: }
6760:
1.957 onken 6761: ul.LC_TabContentBigger li.active {
6762: position: relative;
6763: top: 1px;
6764: }
6765:
1.870 tempelho 6766: ul.LC_TabContentBigger li a {
1.911 bisitz 6767: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6768: height: 30px;
6769: line-height: 30px;
6770: text-align: center;
6771: display: block;
6772: text-decoration: none;
1.958 onken 6773: outline: none;
1.741 harmsja 6774: }
1.795 www 6775:
1.870 tempelho 6776: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6777: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6778: color:$font;
1.744 ehlerst 6779: }
1.795 www 6780:
1.870 tempelho 6781: ul.LC_TabContentBigger li b {
1.911 bisitz 6782: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6783: display: block;
6784: float: left;
6785: padding: 0 30px;
1.957 onken 6786: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6787: }
6788:
1.956 onken 6789: ul.LC_TabContentBigger li:hover b {
6790: color:$button_hover;
6791: }
6792:
1.870 tempelho 6793: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6794: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6795: color:$font;
1.957 onken 6796: border: 0;
1.741 harmsja 6797: }
1.693 droeschl 6798:
1.870 tempelho 6799:
1.862 bisitz 6800: ul.LC_CourseBreadcrumbs {
6801: background: $sidebg;
1.1020 raeburn 6802: height: 2em;
1.862 bisitz 6803: padding-left: 10px;
1.1020 raeburn 6804: margin: 0;
1.862 bisitz 6805: list-style-position: inside;
6806: }
6807:
1.911 bisitz 6808: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6809: ol#LC_PathBreadcrumbs {
1.911 bisitz 6810: padding-left: 10px;
6811: margin: 0;
1.933 droeschl 6812: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6813: }
6814:
1.911 bisitz 6815: ol#LC_MenuBreadcrumbs li,
6816: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6817: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6818: display: inline;
1.933 droeschl 6819: white-space: normal;
1.693 droeschl 6820: }
6821:
1.823 bisitz 6822: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6823: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6824: text-decoration: none;
6825: font-size:90%;
1.693 droeschl 6826: }
1.795 www 6827:
1.969 droeschl 6828: ol#LC_MenuBreadcrumbs h1 {
6829: display: inline;
6830: font-size: 90%;
6831: line-height: 2.5em;
6832: margin: 0;
6833: padding: 0;
6834: }
6835:
1.795 www 6836: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6837: text-decoration:none;
6838: font-size:100%;
6839: font-weight:bold;
1.693 droeschl 6840: }
1.795 www 6841:
1.840 bisitz 6842: .LC_Box {
1.911 bisitz 6843: border: solid 1px $lg_border_color;
6844: padding: 0 10px 10px 10px;
1.746 neumanie 6845: }
1.795 www 6846:
1.1020 raeburn 6847: .LC_DocsBox {
6848: border: solid 1px $lg_border_color;
6849: padding: 0 0 10px 10px;
6850: }
6851:
1.795 www 6852: .LC_AboutMe_Image {
1.911 bisitz 6853: float:left;
6854: margin-right:10px;
1.747 neumanie 6855: }
1.795 www 6856:
6857: .LC_Clear_AboutMe_Image {
1.911 bisitz 6858: clear:left;
1.747 neumanie 6859: }
1.795 www 6860:
1.721 harmsja 6861: dl.LC_ListStyleClean dt {
1.911 bisitz 6862: padding-right: 5px;
6863: display: table-header-group;
1.693 droeschl 6864: }
6865:
1.721 harmsja 6866: dl.LC_ListStyleClean dd {
1.911 bisitz 6867: display: table-row;
1.693 droeschl 6868: }
6869:
1.721 harmsja 6870: .LC_ListStyleClean,
6871: .LC_ListStyleSimple,
6872: .LC_ListStyleNormal,
1.795 www 6873: .LC_ListStyleSpecial {
1.911 bisitz 6874: /* display:block; */
6875: list-style-position: inside;
6876: list-style-type: none;
6877: overflow: hidden;
6878: padding: 0;
1.693 droeschl 6879: }
6880:
1.721 harmsja 6881: .LC_ListStyleSimple li,
6882: .LC_ListStyleSimple dd,
6883: .LC_ListStyleNormal li,
6884: .LC_ListStyleNormal dd,
6885: .LC_ListStyleSpecial li,
1.795 www 6886: .LC_ListStyleSpecial dd {
1.911 bisitz 6887: margin: 0;
6888: padding: 5px 5px 5px 10px;
6889: clear: both;
1.693 droeschl 6890: }
6891:
1.721 harmsja 6892: .LC_ListStyleClean li,
6893: .LC_ListStyleClean dd {
1.911 bisitz 6894: padding-top: 0;
6895: padding-bottom: 0;
1.693 droeschl 6896: }
6897:
1.721 harmsja 6898: .LC_ListStyleSimple dd,
1.795 www 6899: .LC_ListStyleSimple li {
1.911 bisitz 6900: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6901: }
6902:
1.721 harmsja 6903: .LC_ListStyleSpecial li,
6904: .LC_ListStyleSpecial dd {
1.911 bisitz 6905: list-style-type: none;
6906: background-color: RGB(220, 220, 220);
6907: margin-bottom: 4px;
1.693 droeschl 6908: }
6909:
1.721 harmsja 6910: table.LC_SimpleTable {
1.911 bisitz 6911: margin:5px;
6912: border:solid 1px $lg_border_color;
1.795 www 6913: }
1.693 droeschl 6914:
1.721 harmsja 6915: table.LC_SimpleTable tr {
1.911 bisitz 6916: padding: 0;
6917: border:solid 1px $lg_border_color;
1.693 droeschl 6918: }
1.795 www 6919:
6920: table.LC_SimpleTable thead {
1.911 bisitz 6921: background:rgb(220,220,220);
1.693 droeschl 6922: }
6923:
1.721 harmsja 6924: div.LC_columnSection {
1.911 bisitz 6925: display: block;
6926: clear: both;
6927: overflow: hidden;
6928: margin: 0;
1.693 droeschl 6929: }
6930:
1.721 harmsja 6931: div.LC_columnSection>* {
1.911 bisitz 6932: float: left;
6933: margin: 10px 20px 10px 0;
6934: overflow:hidden;
1.693 droeschl 6935: }
1.721 harmsja 6936:
1.795 www 6937: table em {
1.911 bisitz 6938: font-weight: bold;
6939: font-style: normal;
1.748 schulted 6940: }
1.795 www 6941:
1.779 bisitz 6942: table.LC_tableBrowseRes,
1.795 www 6943: table.LC_tableOfContent {
1.911 bisitz 6944: border:none;
6945: border-spacing: 1px;
6946: padding: 3px;
6947: background-color: #FFFFFF;
6948: font-size: 90%;
1.753 droeschl 6949: }
1.789 droeschl 6950:
1.911 bisitz 6951: table.LC_tableOfContent {
6952: border-collapse: collapse;
1.789 droeschl 6953: }
6954:
1.771 droeschl 6955: table.LC_tableBrowseRes a,
1.768 schulted 6956: table.LC_tableOfContent a {
1.911 bisitz 6957: background-color: transparent;
6958: text-decoration: none;
1.753 droeschl 6959: }
6960:
1.795 www 6961: table.LC_tableOfContent img {
1.911 bisitz 6962: border: none;
6963: height: 1.3em;
6964: vertical-align: text-bottom;
6965: margin-right: 0.3em;
1.753 droeschl 6966: }
1.757 schulted 6967:
1.795 www 6968: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6969: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6970: }
6971:
1.795 www 6972: a#LC_content_toolbar_everything {
1.911 bisitz 6973: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6974: }
6975:
1.795 www 6976: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6977: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6978: }
6979:
1.795 www 6980: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6981: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6982: }
6983:
1.795 www 6984: a#LC_content_toolbar_changefolder {
1.911 bisitz 6985: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6986: }
6987:
1.795 www 6988: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6989: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6990: }
6991:
1.1043 raeburn 6992: a#LC_content_toolbar_edittoplevel {
6993: background-image:url(/res/adm/pages/edittoplevel.gif);
6994: }
6995:
1.795 www 6996: ul#LC_toolbar li a:hover {
1.911 bisitz 6997: background-position: bottom center;
1.757 schulted 6998: }
6999:
1.795 www 7000: ul#LC_toolbar {
1.911 bisitz 7001: padding: 0;
7002: margin: 2px;
7003: list-style:none;
7004: position:relative;
7005: background-color:white;
1.1075.2.9 raeburn 7006: overflow: auto;
1.757 schulted 7007: }
7008:
1.795 www 7009: ul#LC_toolbar li {
1.911 bisitz 7010: border:1px solid white;
7011: padding: 0;
7012: margin: 0;
7013: float: left;
7014: display:inline;
7015: vertical-align:middle;
1.1075.2.9 raeburn 7016: white-space: nowrap;
1.911 bisitz 7017: }
1.757 schulted 7018:
1.783 amueller 7019:
1.795 www 7020: a.LC_toolbarItem {
1.911 bisitz 7021: display:block;
7022: padding: 0;
7023: margin: 0;
7024: height: 32px;
7025: width: 32px;
7026: color:white;
7027: border: none;
7028: background-repeat:no-repeat;
7029: background-color:transparent;
1.757 schulted 7030: }
7031:
1.915 droeschl 7032: ul.LC_funclist {
7033: margin: 0;
7034: padding: 0.5em 1em 0.5em 0;
7035: }
7036:
1.933 droeschl 7037: ul.LC_funclist > li:first-child {
7038: font-weight:bold;
7039: margin-left:0.8em;
7040: }
7041:
1.915 droeschl 7042: ul.LC_funclist + ul.LC_funclist {
7043: /*
7044: left border as a seperator if we have more than
7045: one list
7046: */
7047: border-left: 1px solid $sidebg;
7048: /*
7049: this hides the left border behind the border of the
7050: outer box if element is wrapped to the next 'line'
7051: */
7052: margin-left: -1px;
7053: }
7054:
1.843 bisitz 7055: ul.LC_funclist li {
1.915 droeschl 7056: display: inline;
1.782 bisitz 7057: white-space: nowrap;
1.915 droeschl 7058: margin: 0 0 0 25px;
7059: line-height: 150%;
1.782 bisitz 7060: }
7061:
1.974 wenzelju 7062: .LC_hidden {
7063: display: none;
7064: }
7065:
1.1030 www 7066: .LCmodal-overlay {
7067: position:fixed;
7068: top:0;
7069: right:0;
7070: bottom:0;
7071: left:0;
7072: height:100%;
7073: width:100%;
7074: margin:0;
7075: padding:0;
7076: background:#999;
7077: opacity:.75;
7078: filter: alpha(opacity=75);
7079: -moz-opacity: 0.75;
7080: z-index:101;
7081: }
7082:
7083: * html .LCmodal-overlay {
7084: position: absolute;
7085: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7086: }
7087:
7088: .LCmodal-window {
7089: position:fixed;
7090: top:50%;
7091: left:50%;
7092: margin:0;
7093: padding:0;
7094: z-index:102;
7095: }
7096:
7097: * html .LCmodal-window {
7098: position:absolute;
7099: }
7100:
7101: .LCclose-window {
7102: position:absolute;
7103: width:32px;
7104: height:32px;
7105: right:8px;
7106: top:8px;
7107: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7108: text-indent:-99999px;
7109: overflow:hidden;
7110: cursor:pointer;
7111: }
7112:
1.343 albertel 7113: END
7114: }
7115:
1.306 albertel 7116: =pod
7117:
7118: =item * &headtag()
7119:
7120: Returns a uniform footer for LON-CAPA web pages.
7121:
1.307 albertel 7122: Inputs: $title - optional title for the head
7123: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7124: $args - optional arguments
1.319 albertel 7125: force_register - if is true call registerurl so the remote is
7126: informed
1.415 albertel 7127: redirect -> array ref of
7128: 1- seconds before redirect occurs
7129: 2- url to redirect to
7130: 3- whether the side effect should occur
1.315 albertel 7131: (side effect of setting
7132: $env{'internal.head.redirect'} to the url
7133: redirected too)
1.352 albertel 7134: domain -> force to color decorate a page for a specific
7135: domain
7136: function -> force usage of a specific rolish color scheme
7137: bgcolor -> override the default page bgcolor
1.460 albertel 7138: no_auto_mt_title
7139: -> prevent &mt()ing the title arg
1.464 albertel 7140:
1.306 albertel 7141: =cut
7142:
7143: sub headtag {
1.313 albertel 7144: my ($title,$head_extra,$args) = @_;
1.306 albertel 7145:
1.363 albertel 7146: my $function = $args->{'function'} || &get_users_function();
7147: my $domain = $args->{'domain'} || &determinedomain();
7148: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 7149: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7150: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7151: #time(),
1.418 albertel 7152: $env{'environment.color.timestamp'},
1.363 albertel 7153: $function,$domain,$bgcolor);
7154:
1.369 www 7155: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7156:
1.308 albertel 7157: my $result =
7158: '<head>'.
1.461 albertel 7159: &font_settings();
1.319 albertel 7160:
1.1064 raeburn 7161: my $inhibitprint = &print_suppression();
7162:
1.461 albertel 7163: if (!$args->{'frameset'}) {
7164: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7165: }
1.1075.2.12 raeburn 7166: if ($args->{'force_register'}) {
7167: $result .= &Apache::lonmenu::registerurl(1);
1.319 albertel 7168: }
1.436 albertel 7169: if (!$args->{'no_nav_bar'}
7170: && !$args->{'only_body'}
7171: && !$args->{'frameset'}) {
7172: $result .= &help_menu_js();
1.1032 www 7173: $result.=&modal_window();
1.1038 www 7174: $result.=&togglebox_script();
1.1034 www 7175: $result.=&wishlist_window();
1.1041 www 7176: $result.=&LCprogressbarUpdate_script();
1.1034 www 7177: } else {
7178: if ($args->{'add_modal'}) {
7179: $result.=&modal_window();
7180: }
7181: if ($args->{'add_wishlist'}) {
7182: $result.=&wishlist_window();
7183: }
1.1038 www 7184: if ($args->{'add_togglebox'}) {
7185: $result.=&togglebox_script();
7186: }
1.1041 www 7187: if ($args->{'add_progressbar'}) {
7188: $result.=&LCprogressbarUpdate_script();
7189: }
1.436 albertel 7190: }
1.314 albertel 7191: if (ref($args->{'redirect'})) {
1.414 albertel 7192: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7193: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7194: if (!$inhibit_continue) {
7195: $env{'internal.head.redirect'} = $url;
7196: }
1.313 albertel 7197: $result.=<<ADDMETA
7198: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7199: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7200: ADDMETA
7201: }
1.306 albertel 7202: if (!defined($title)) {
7203: $title = 'The LearningOnline Network with CAPA';
7204: }
1.460 albertel 7205: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
7206: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 7207: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064 raeburn 7208: .$inhibitprint
1.414 albertel 7209: .$head_extra;
1.962 droeschl 7210: return $result.'</head>';
1.306 albertel 7211: }
7212:
7213: =pod
7214:
1.340 albertel 7215: =item * &font_settings()
7216:
7217: Returns neccessary <meta> to set the proper encoding
7218:
7219: Inputs: none
7220:
7221: =cut
7222:
7223: sub font_settings {
7224: my $headerstring='';
1.647 www 7225: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 7226: $headerstring.=
7227: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
7228: }
7229: return $headerstring;
7230: }
7231:
1.341 albertel 7232: =pod
7233:
1.1064 raeburn 7234: =item * &print_suppression()
7235:
7236: In course context returns css which causes the body to be blank when media="print",
7237: if printout generation is unavailable for the current resource.
7238:
7239: This could be because:
7240:
7241: (a) printstartdate is in the future
7242:
7243: (b) printenddate is in the past
7244:
7245: (c) there is an active exam block with "printout"
7246: functionality blocked
7247:
7248: Users with pav, pfo or evb privileges are exempt.
7249:
7250: Inputs: none
7251:
7252: =cut
7253:
7254:
7255: sub print_suppression {
7256: my $noprint;
7257: if ($env{'request.course.id'}) {
7258: my $scope = $env{'request.course.id'};
7259: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7260: (&Apache::lonnet::allowed('pfo',$scope))) {
7261: return;
7262: }
7263: if ($env{'request.course.sec'} ne '') {
7264: $scope .= "/$env{'request.course.sec'}";
7265: if ((&Apache::lonnet::allowed('pav',$scope)) ||
7266: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 7267: return;
1.1064 raeburn 7268: }
7269: }
7270: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7271: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065 raeburn 7272: my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064 raeburn 7273: if ($blocked) {
7274: my $checkrole = "cm./$cdom/$cnum";
7275: if ($env{'request.course.sec'} ne '') {
7276: $checkrole .= "/$env{'request.course.sec'}";
7277: }
7278: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
7279: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
7280: $noprint = 1;
7281: }
7282: }
7283: unless ($noprint) {
7284: my $symb = &Apache::lonnet::symbread();
7285: if ($symb ne '') {
7286: my $navmap = Apache::lonnavmaps::navmap->new();
7287: if (ref($navmap)) {
7288: my $res = $navmap->getBySymb($symb);
7289: if (ref($res)) {
7290: if (!$res->resprintable()) {
7291: $noprint = 1;
7292: }
7293: }
7294: }
7295: }
7296: }
7297: if ($noprint) {
7298: return <<"ENDSTYLE";
7299: <style type="text/css" media="print">
7300: body { display:none }
7301: </style>
7302: ENDSTYLE
7303: }
7304: }
7305: return;
7306: }
7307:
7308: =pod
7309:
1.341 albertel 7310: =item * &xml_begin()
7311:
7312: Returns the needed doctype and <html>
7313:
7314: Inputs: none
7315:
7316: =cut
7317:
7318: sub xml_begin {
7319: my $output='';
7320:
7321: if ($env{'browser.mathml'}) {
7322: $output='<?xml version="1.0"?>'
7323: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
7324: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
7325:
7326: # .'<!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">] >'
7327: .'<!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">'
7328: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
7329: .'xmlns="http://www.w3.org/1999/xhtml">';
7330: } else {
1.849 bisitz 7331: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
7332: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 7333: }
7334: return $output;
7335: }
1.340 albertel 7336:
7337: =pod
7338:
1.306 albertel 7339: =item * &start_page()
7340:
7341: Returns a complete <html> .. <body> section for LON-CAPA web pages.
7342:
1.648 raeburn 7343: Inputs:
7344:
7345: =over 4
7346:
7347: $title - optional title for the page
7348:
7349: $head_extra - optional extra HTML to incude inside the <head>
7350:
7351: $args - additional optional args supported are:
7352:
7353: =over 8
7354:
7355: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 7356: arg on
1.814 bisitz 7357: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 7358: add_entries -> additional attributes to add to the <body>
7359: domain -> force to color decorate a page for a
1.317 albertel 7360: specific domain
1.648 raeburn 7361: function -> force usage of a specific rolish color
1.317 albertel 7362: scheme
1.648 raeburn 7363: redirect -> see &headtag()
7364: bgcolor -> override the default page bg color
7365: js_ready -> return a string ready for being used in
1.317 albertel 7366: a javascript writeln
1.648 raeburn 7367: html_encode -> return a string ready for being used in
1.320 albertel 7368: a html attribute
1.648 raeburn 7369: force_register -> if is true will turn on the &bodytag()
1.317 albertel 7370: $forcereg arg
1.648 raeburn 7371: frameset -> if true will start with a <frameset>
1.330 albertel 7372: rather than <body>
1.648 raeburn 7373: skip_phases -> hash ref of
1.338 albertel 7374: head -> skip the <html><head> generation
7375: body -> skip all <body> generation
1.1075.2.12 raeburn 7376: no_inline_link -> if true and in remote mode, don't show the
7377: 'Switch To Inline Menu' link
1.648 raeburn 7378: no_auto_mt_title -> prevent &mt()ing the title arg
7379: inherit_jsmath -> when creating popup window in a page,
7380: should it have jsmath forced on by the
7381: current page
1.867 kalberla 7382: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 7383: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 7384:
1.648 raeburn 7385: =back
1.460 albertel 7386:
1.648 raeburn 7387: =back
1.562 albertel 7388:
1.306 albertel 7389: =cut
7390:
7391: sub start_page {
1.309 albertel 7392: my ($title,$head_extra,$args) = @_;
1.318 albertel 7393: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 7394:
1.315 albertel 7395: $env{'internal.start_page'}++;
1.338 albertel 7396: my $result;
1.964 droeschl 7397:
1.338 albertel 7398: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030 www 7399: $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 7400: }
7401:
7402: if (! exists($args->{'skip_phases'}{'body'}) ) {
7403: if ($args->{'frameset'}) {
7404: my $attr_string = &make_attr_string($args->{'force_register'},
7405: $args->{'add_entries'});
7406: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 7407: } else {
7408: $result .=
7409: &bodytag($title,
7410: $args->{'function'}, $args->{'add_entries'},
7411: $args->{'only_body'}, $args->{'domain'},
7412: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12 raeburn 7413: $args->{'bgcolor'}, $args->{'no_inline_link'},
7414: $args);
1.831 bisitz 7415: }
1.330 albertel 7416: }
1.338 albertel 7417:
1.315 albertel 7418: if ($args->{'js_ready'}) {
1.713 kaisler 7419: $result = &js_ready($result);
1.315 albertel 7420: }
1.320 albertel 7421: if ($args->{'html_encode'}) {
1.713 kaisler 7422: $result = &html_encode($result);
7423: }
7424:
1.813 bisitz 7425: # Preparation for new and consistent functionlist at top of screen
7426: # if ($args->{'functionlist'}) {
7427: # $result .= &build_functionlist();
7428: #}
7429:
1.964 droeschl 7430: # Don't add anything more if only_body wanted or in const space
7431: return $result if $args->{'only_body'}
7432: || $env{'request.state'} eq 'construct';
1.813 bisitz 7433:
7434: #Breadcrumbs
1.758 kaisler 7435: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
7436: &Apache::lonhtmlcommon::clear_breadcrumbs();
7437: #if any br links exists, add them to the breadcrumbs
7438: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
7439: foreach my $crumb (@{$args->{'bread_crumbs'}}){
7440: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
7441: }
7442: }
7443:
7444: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
7445: if(exists($args->{'bread_crumbs_component'})){
7446: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
7447: }else{
7448: $result .= &Apache::lonhtmlcommon::breadcrumbs();
7449: }
1.320 albertel 7450: }
1.315 albertel 7451: return $result;
1.306 albertel 7452: }
7453:
7454: sub end_page {
1.315 albertel 7455: my ($args) = @_;
7456: $env{'internal.end_page'}++;
1.330 albertel 7457: my $result;
1.335 albertel 7458: if ($args->{'discussion'}) {
7459: my ($target,$parser);
7460: if (ref($args->{'discussion'})) {
7461: ($target,$parser) =($args->{'discussion'}{'target'},
7462: $args->{'discussion'}{'parser'});
7463: }
7464: $result .= &Apache::lonxml::xmlend($target,$parser);
7465: }
1.330 albertel 7466: if ($args->{'frameset'}) {
7467: $result .= '</frameset>';
7468: } else {
1.635 raeburn 7469: $result .= &endbodytag($args);
1.330 albertel 7470: }
1.1075.2.6 raeburn 7471: unless ($args->{'notbody'}) {
7472: $result .= "\n</html>";
7473: }
1.330 albertel 7474:
1.315 albertel 7475: if ($args->{'js_ready'}) {
1.317 albertel 7476: $result = &js_ready($result);
1.315 albertel 7477: }
1.335 albertel 7478:
1.320 albertel 7479: if ($args->{'html_encode'}) {
7480: $result = &html_encode($result);
7481: }
1.335 albertel 7482:
1.315 albertel 7483: return $result;
7484: }
7485:
1.1034 www 7486: sub wishlist_window {
7487: return(<<'ENDWISHLIST');
1.1046 raeburn 7488: <script type="text/javascript">
1.1034 www 7489: // <![CDATA[
7490: // <!-- BEGIN LON-CAPA Internal
7491: function set_wishlistlink(title, path) {
7492: if (!title) {
7493: title = document.title;
7494: title = title.replace(/^LON-CAPA /,'');
7495: }
7496: if (!path) {
7497: path = location.pathname;
7498: }
7499: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
7500: 'wishlistNewLink','width=560,height=350,scrollbars=0');
7501: }
7502: // END LON-CAPA Internal -->
7503: // ]]>
7504: </script>
7505: ENDWISHLIST
7506: }
7507:
1.1030 www 7508: sub modal_window {
7509: return(<<'ENDMODAL');
1.1046 raeburn 7510: <script type="text/javascript">
1.1030 www 7511: // <![CDATA[
7512: // <!-- BEGIN LON-CAPA Internal
7513: var modalWindow = {
7514: parent:"body",
7515: windowId:null,
7516: content:null,
7517: width:null,
7518: height:null,
7519: close:function()
7520: {
7521: $(".LCmodal-window").remove();
7522: $(".LCmodal-overlay").remove();
7523: },
7524: open:function()
7525: {
7526: var modal = "";
7527: modal += "<div class=\"LCmodal-overlay\"></div>";
7528: 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;\">";
7529: modal += this.content;
7530: modal += "</div>";
7531:
7532: $(this.parent).append(modal);
7533:
7534: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
7535: $(".LCclose-window").click(function(){modalWindow.close();});
7536: $(".LCmodal-overlay").click(function(){modalWindow.close();});
7537: }
7538: };
1.1031 www 7539: var openMyModal = function(source,width,height,scrolling)
1.1030 www 7540: {
7541: modalWindow.windowId = "myModal";
7542: modalWindow.width = width;
7543: modalWindow.height = height;
1.1031 www 7544: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'></iframe>";
1.1030 www 7545: modalWindow.open();
7546: };
7547: // END LON-CAPA Internal -->
7548: // ]]>
7549: </script>
7550: ENDMODAL
7551: }
7552:
7553: sub modal_link {
1.1052 www 7554: my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030 www 7555: unless ($width) { $width=480; }
7556: unless ($height) { $height=400; }
1.1031 www 7557: unless ($scrolling) { $scrolling='yes'; }
1.1074 raeburn 7558: my $target_attr;
7559: if (defined($target)) {
7560: $target_attr = 'target="'.$target.'"';
7561: }
7562: return <<"ENDLINK";
7563: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
7564: $linktext</a>
7565: ENDLINK
1.1030 www 7566: }
7567:
1.1032 www 7568: sub modal_adhoc_script {
7569: my ($funcname,$width,$height,$content)=@_;
7570: return (<<ENDADHOC);
1.1046 raeburn 7571: <script type="text/javascript">
1.1032 www 7572: // <![CDATA[
7573: var $funcname = function()
7574: {
7575: modalWindow.windowId = "myModal";
7576: modalWindow.width = $width;
7577: modalWindow.height = $height;
7578: modalWindow.content = '$content';
7579: modalWindow.open();
7580: };
7581: // ]]>
7582: </script>
7583: ENDADHOC
7584: }
7585:
1.1041 www 7586: sub modal_adhoc_inner {
7587: my ($funcname,$width,$height,$content)=@_;
7588: my $innerwidth=$width-20;
7589: $content=&js_ready(
1.1042 www 7590: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041 www 7591: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
7592: $content.
7593: &end_scrollbox().
7594: &end_page()
7595: );
7596: return &modal_adhoc_script($funcname,$width,$height,$content);
7597: }
7598:
7599: sub modal_adhoc_window {
7600: my ($funcname,$width,$height,$content,$linktext)=@_;
7601: return &modal_adhoc_inner($funcname,$width,$height,$content).
7602: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
7603: }
7604:
7605: sub modal_adhoc_launch {
7606: my ($funcname,$width,$height,$content)=@_;
7607: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
7608: <script type="text/javascript">
7609: // <![CDATA[
7610: $funcname();
7611: // ]]>
7612: </script>
7613: ENDLAUNCH
7614: }
7615:
7616: sub modal_adhoc_close {
7617: return (<<ENDCLOSE);
7618: <script type="text/javascript">
7619: // <![CDATA[
7620: modalWindow.close();
7621: // ]]>
7622: </script>
7623: ENDCLOSE
7624: }
7625:
1.1038 www 7626: sub togglebox_script {
7627: return(<<ENDTOGGLE);
7628: <script type="text/javascript">
7629: // <![CDATA[
7630: function LCtoggleDisplay(id,hidetext,showtext) {
7631: link = document.getElementById(id + "link").childNodes[0];
7632: with (document.getElementById(id).style) {
7633: if (display == "none" ) {
7634: display = "inline";
7635: link.nodeValue = hidetext;
7636: } else {
7637: display = "none";
7638: link.nodeValue = showtext;
7639: }
7640: }
7641: }
7642: // ]]>
7643: </script>
7644: ENDTOGGLE
7645: }
7646:
1.1039 www 7647: sub start_togglebox {
7648: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
7649: unless ($heading) { $heading=''; } else { $heading.=' '; }
7650: unless ($showtext) { $showtext=&mt('show'); }
7651: unless ($hidetext) { $hidetext=&mt('hide'); }
7652: unless ($headerbg) { $headerbg='#FFFFFF'; }
7653: return &start_data_table().
7654: &start_data_table_header_row().
7655: '<td bgcolor="'.$headerbg.'">'.$heading.
7656: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
7657: $showtext.'\')">'.$showtext.'</a>]</td>'.
7658: &end_data_table_header_row().
7659: '<tr id="'.$id.'" style="display:none""><td>';
7660: }
7661:
7662: sub end_togglebox {
7663: return '</td></tr>'.&end_data_table();
7664: }
7665:
1.1041 www 7666: sub LCprogressbar_script {
1.1045 www 7667: my ($id)=@_;
1.1041 www 7668: return(<<ENDPROGRESS);
7669: <script type="text/javascript">
7670: // <![CDATA[
1.1045 www 7671: \$('#progressbar$id').progressbar({
1.1041 www 7672: value: 0,
7673: change: function(event, ui) {
7674: var newVal = \$(this).progressbar('option', 'value');
7675: \$('.pblabel', this).text(LCprogressTxt);
7676: }
7677: });
7678: // ]]>
7679: </script>
7680: ENDPROGRESS
7681: }
7682:
7683: sub LCprogressbarUpdate_script {
7684: return(<<ENDPROGRESSUPDATE);
7685: <style type="text/css">
7686: .ui-progressbar { position:relative; }
7687: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
7688: </style>
7689: <script type="text/javascript">
7690: // <![CDATA[
1.1045 www 7691: var LCprogressTxt='---';
7692:
7693: function LCupdateProgress(percent,progresstext,id) {
1.1041 www 7694: LCprogressTxt=progresstext;
1.1045 www 7695: \$('#progressbar'+id).progressbar('value',percent);
1.1041 www 7696: }
7697: // ]]>
7698: </script>
7699: ENDPROGRESSUPDATE
7700: }
7701:
1.1042 www 7702: my $LClastpercent;
1.1045 www 7703: my $LCidcnt;
7704: my $LCcurrentid;
1.1042 www 7705:
1.1041 www 7706: sub LCprogressbar {
1.1042 www 7707: my ($r)=(@_);
7708: $LClastpercent=0;
1.1045 www 7709: $LCidcnt++;
7710: $LCcurrentid=$$.'_'.$LCidcnt;
1.1041 www 7711: my $starting=&mt('Starting');
7712: my $content=(<<ENDPROGBAR);
7713: <p>
1.1045 www 7714: <div id="progressbar$LCcurrentid">
1.1041 www 7715: <span class="pblabel">$starting</span>
7716: </div>
7717: </p>
7718: ENDPROGBAR
1.1045 www 7719: &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041 www 7720: }
7721:
7722: sub LCprogressbarUpdate {
1.1042 www 7723: my ($r,$val,$text)=@_;
7724: unless ($val) {
7725: if ($LClastpercent) {
7726: $val=$LClastpercent;
7727: } else {
7728: $val=0;
7729: }
7730: }
1.1041 www 7731: if ($val<0) { $val=0; }
7732: if ($val>100) { $val=0; }
1.1042 www 7733: $LClastpercent=$val;
1.1041 www 7734: unless ($text) { $text=$val.'%'; }
7735: $text=&js_ready($text);
1.1044 www 7736: &r_print($r,<<ENDUPDATE);
1.1041 www 7737: <script type="text/javascript">
7738: // <![CDATA[
1.1045 www 7739: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041 www 7740: // ]]>
7741: </script>
7742: ENDUPDATE
1.1035 www 7743: }
7744:
1.1042 www 7745: sub LCprogressbarClose {
7746: my ($r)=@_;
7747: $LClastpercent=0;
1.1044 www 7748: &r_print($r,<<ENDCLOSE);
1.1042 www 7749: <script type="text/javascript">
7750: // <![CDATA[
1.1045 www 7751: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 7752: // ]]>
7753: </script>
7754: ENDCLOSE
1.1044 www 7755: }
7756:
7757: sub r_print {
7758: my ($r,$to_print)=@_;
7759: if ($r) {
7760: $r->print($to_print);
7761: $r->rflush();
7762: } else {
7763: print($to_print);
7764: }
1.1042 www 7765: }
7766:
1.320 albertel 7767: sub html_encode {
7768: my ($result) = @_;
7769:
1.322 albertel 7770: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 7771:
7772: return $result;
7773: }
1.1044 www 7774:
1.317 albertel 7775: sub js_ready {
7776: my ($result) = @_;
7777:
1.323 albertel 7778: $result =~ s/[\n\r]/ /xmsg;
7779: $result =~ s/\\/\\\\/xmsg;
7780: $result =~ s/'/\\'/xmsg;
1.372 albertel 7781: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 7782:
7783: return $result;
7784: }
7785:
1.315 albertel 7786: sub validate_page {
7787: if ( exists($env{'internal.start_page'})
1.316 albertel 7788: && $env{'internal.start_page'} > 1) {
7789: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 7790: $env{'internal.start_page'}.' '.
1.316 albertel 7791: $ENV{'request.filename'});
1.315 albertel 7792: }
7793: if ( exists($env{'internal.end_page'})
1.316 albertel 7794: && $env{'internal.end_page'} > 1) {
7795: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 7796: $env{'internal.end_page'}.' '.
1.316 albertel 7797: $env{'request.filename'});
1.315 albertel 7798: }
7799: if ( exists($env{'internal.start_page'})
7800: && ! exists($env{'internal.end_page'})) {
1.316 albertel 7801: &Apache::lonnet::logthis('start_page called without end_page '.
7802: $env{'request.filename'});
1.315 albertel 7803: }
7804: if ( ! exists($env{'internal.start_page'})
7805: && exists($env{'internal.end_page'})) {
1.316 albertel 7806: &Apache::lonnet::logthis('end_page called without start_page'.
7807: $env{'request.filename'});
1.315 albertel 7808: }
1.306 albertel 7809: }
1.315 albertel 7810:
1.996 www 7811:
7812: sub start_scrollbox {
1.1075 raeburn 7813: my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998 raeburn 7814: unless ($outerwidth) { $outerwidth='520px'; }
7815: unless ($width) { $width='500px'; }
7816: unless ($height) { $height='200px'; }
1.1075 raeburn 7817: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 7818: if ($id ne '') {
1.1020 raeburn 7819: $table_id = " id='table_$id'";
7820: $div_id = " id='div_$id'";
1.1018 raeburn 7821: }
1.1075 raeburn 7822: if ($bgcolor ne '') {
7823: $tdcol = "background-color: $bgcolor;";
7824: }
7825: return <<"END";
7826: <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>
7827: END
1.996 www 7828: }
7829:
7830: sub end_scrollbox {
1.1036 www 7831: return '</div></td></tr></table>';
1.996 www 7832: }
7833:
1.318 albertel 7834: sub simple_error_page {
7835: my ($r,$title,$msg) = @_;
7836: my $page =
7837: &Apache::loncommon::start_page($title).
7838: &mt($msg).
7839: &Apache::loncommon::end_page();
7840: if (ref($r)) {
7841: $r->print($page);
1.327 albertel 7842: return;
1.318 albertel 7843: }
7844: return $page;
7845: }
1.347 albertel 7846:
7847: {
1.610 albertel 7848: my @row_count;
1.961 onken 7849:
7850: sub start_data_table_count {
7851: unshift(@row_count, 0);
7852: return;
7853: }
7854:
7855: sub end_data_table_count {
7856: shift(@row_count);
7857: return;
7858: }
7859:
1.347 albertel 7860: sub start_data_table {
1.1018 raeburn 7861: my ($add_class,$id) = @_;
1.422 albertel 7862: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 7863: my $table_id;
7864: if (defined($id)) {
7865: $table_id = ' id="'.$id.'"';
7866: }
1.961 onken 7867: &start_data_table_count();
1.1018 raeburn 7868: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 7869: }
7870:
7871: sub end_data_table {
1.961 onken 7872: &end_data_table_count();
1.389 albertel 7873: return '</table>'."\n";;
1.347 albertel 7874: }
7875:
7876: sub start_data_table_row {
1.974 wenzelju 7877: my ($add_class, $id) = @_;
1.610 albertel 7878: $row_count[0]++;
7879: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 7880: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 7881: $id = (' id="'.$id.'"') unless ($id eq '');
7882: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 7883: }
1.471 banghart 7884:
7885: sub continue_data_table_row {
1.974 wenzelju 7886: my ($add_class, $id) = @_;
1.610 albertel 7887: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 7888: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
7889: $id = (' id="'.$id.'"') unless ($id eq '');
7890: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 7891: }
1.347 albertel 7892:
7893: sub end_data_table_row {
1.389 albertel 7894: return '</tr>'."\n";;
1.347 albertel 7895: }
1.367 www 7896:
1.421 albertel 7897: sub start_data_table_empty_row {
1.707 bisitz 7898: # $row_count[0]++;
1.421 albertel 7899: return '<tr class="LC_empty_row" >'."\n";;
7900: }
7901:
7902: sub end_data_table_empty_row {
7903: return '</tr>'."\n";;
7904: }
7905:
1.367 www 7906: sub start_data_table_header_row {
1.389 albertel 7907: return '<tr class="LC_header_row">'."\n";;
1.367 www 7908: }
7909:
7910: sub end_data_table_header_row {
1.389 albertel 7911: return '</tr>'."\n";;
1.367 www 7912: }
1.890 droeschl 7913:
7914: sub data_table_caption {
7915: my $caption = shift;
7916: return "<caption class=\"LC_caption\">$caption</caption>";
7917: }
1.347 albertel 7918: }
7919:
1.548 albertel 7920: =pod
7921:
7922: =item * &inhibit_menu_check($arg)
7923:
7924: Checks for a inhibitmenu state and generates output to preserve it
7925:
7926: Inputs: $arg - can be any of
7927: - undef - in which case the return value is a string
7928: to add into arguments list of a uri
7929: - 'input' - in which case the return value is a HTML
7930: <form> <input> field of type hidden to
7931: preserve the value
7932: - a url - in which case the return value is the url with
7933: the neccesary cgi args added to preserve the
7934: inhibitmenu state
7935: - a ref to a url - no return value, but the string is
7936: updated to include the neccessary cgi
7937: args to preserve the inhibitmenu state
7938:
7939: =cut
7940:
7941: sub inhibit_menu_check {
7942: my ($arg) = @_;
7943: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7944: if ($arg eq 'input') {
7945: if ($env{'form.inhibitmenu'}) {
7946: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7947: } else {
7948: return
7949: }
7950: }
7951: if ($env{'form.inhibitmenu'}) {
7952: if (ref($arg)) {
7953: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7954: } elsif ($arg eq '') {
7955: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7956: } else {
7957: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7958: }
7959: }
7960: if (!ref($arg)) {
7961: return $arg;
7962: }
7963: }
7964:
1.251 albertel 7965: ###############################################
1.182 matthew 7966:
7967: =pod
7968:
1.549 albertel 7969: =back
7970:
7971: =head1 User Information Routines
7972:
7973: =over 4
7974:
1.405 albertel 7975: =item * &get_users_function()
1.182 matthew 7976:
7977: Used by &bodytag to determine the current users primary role.
7978: Returns either 'student','coordinator','admin', or 'author'.
7979:
7980: =cut
7981:
7982: ###############################################
7983: sub get_users_function {
1.815 tempelho 7984: my $function = 'norole';
1.818 tempelho 7985: if ($env{'request.role'}=~/^(st)/) {
7986: $function='student';
7987: }
1.907 raeburn 7988: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7989: $function='coordinator';
7990: }
1.258 albertel 7991: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7992: $function='admin';
7993: }
1.826 bisitz 7994: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 7995: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 7996: $function='author';
7997: }
7998: return $function;
1.54 www 7999: }
1.99 www 8000:
8001: ###############################################
8002:
1.233 raeburn 8003: =pod
8004:
1.821 raeburn 8005: =item * &show_course()
8006:
8007: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
8008: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
8009:
8010: Inputs:
8011: None
8012:
8013: Outputs:
8014: Scalar: 1 if 'Course' to be used, 0 otherwise.
8015:
8016: =cut
8017:
8018: ###############################################
8019: sub show_course {
8020: my $course = !$env{'user.adv'};
8021: if (!$env{'user.adv'}) {
8022: foreach my $env (keys(%env)) {
8023: next if ($env !~ m/^user\.priv\./);
8024: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
8025: $course = 0;
8026: last;
8027: }
8028: }
8029: }
8030: return $course;
8031: }
8032:
8033: ###############################################
8034:
8035: =pod
8036:
1.542 raeburn 8037: =item * &check_user_status()
1.274 raeburn 8038:
8039: Determines current status of supplied role for a
8040: specific user. Roles can be active, previous or future.
8041:
8042: Inputs:
8043: user's domain, user's username, course's domain,
1.375 raeburn 8044: course's number, optional section ID.
1.274 raeburn 8045:
8046: Outputs:
8047: role status: active, previous or future.
8048:
8049: =cut
8050:
8051: sub check_user_status {
1.412 raeburn 8052: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 8053: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274 raeburn 8054: my @uroles = keys %userinfo;
8055: my $srchstr;
8056: my $active_chk = 'none';
1.412 raeburn 8057: my $now = time;
1.274 raeburn 8058: if (@uroles > 0) {
1.908 raeburn 8059: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 8060: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
8061: } else {
1.412 raeburn 8062: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
8063: }
8064: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 8065: my $role_end = 0;
8066: my $role_start = 0;
8067: $active_chk = 'active';
1.412 raeburn 8068: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
8069: $role_end = $1;
8070: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
8071: $role_start = $1;
1.274 raeburn 8072: }
8073: }
8074: if ($role_start > 0) {
1.412 raeburn 8075: if ($now < $role_start) {
1.274 raeburn 8076: $active_chk = 'future';
8077: }
8078: }
8079: if ($role_end > 0) {
1.412 raeburn 8080: if ($now > $role_end) {
1.274 raeburn 8081: $active_chk = 'previous';
8082: }
8083: }
8084: }
8085: }
8086: return $active_chk;
8087: }
8088:
8089: ###############################################
8090:
8091: =pod
8092:
1.405 albertel 8093: =item * &get_sections()
1.233 raeburn 8094:
8095: Determines all the sections for a course including
8096: sections with students and sections containing other roles.
1.419 raeburn 8097: Incoming parameters:
8098:
8099: 1. domain
8100: 2. course number
8101: 3. reference to array containing roles for which sections should
8102: be gathered (optional).
8103: 4. reference to array containing status types for which sections
8104: should be gathered (optional).
8105:
8106: If the third argument is undefined, sections are gathered for any role.
8107: If the fourth argument is undefined, sections are gathered for any status.
8108: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 8109:
1.374 raeburn 8110: Returns section hash (keys are section IDs, values are
8111: number of users in each section), subject to the
1.419 raeburn 8112: optional roles filter, optional status filter
1.233 raeburn 8113:
8114: =cut
8115:
8116: ###############################################
8117: sub get_sections {
1.419 raeburn 8118: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 8119: if (!defined($cdom) || !defined($cnum)) {
8120: my $cid = $env{'request.course.id'};
8121:
8122: return if (!defined($cid));
8123:
8124: $cdom = $env{'course.'.$cid.'.domain'};
8125: $cnum = $env{'course.'.$cid.'.num'};
8126: }
8127:
8128: my %sectioncount;
1.419 raeburn 8129: my $now = time;
1.240 albertel 8130:
1.366 albertel 8131: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 8132: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 8133: my $sec_index = &Apache::loncoursedata::CL_SECTION();
8134: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 8135: my $start_index = &Apache::loncoursedata::CL_START();
8136: my $end_index = &Apache::loncoursedata::CL_END();
8137: my $status;
1.366 albertel 8138: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 8139: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
8140: $data->[$status_index],
8141: $data->[$start_index],
8142: $data->[$end_index]);
8143: if ($stu_status eq 'Active') {
8144: $status = 'active';
8145: } elsif ($end < $now) {
8146: $status = 'previous';
8147: } elsif ($start > $now) {
8148: $status = 'future';
8149: }
8150: if ($section ne '-1' && $section !~ /^\s*$/) {
8151: if ((!defined($possible_status)) || (($status ne '') &&
8152: (grep/^\Q$status\E$/,@{$possible_status}))) {
8153: $sectioncount{$section}++;
8154: }
1.240 albertel 8155: }
8156: }
8157: }
8158: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8159: foreach my $user (sort(keys(%courseroles))) {
8160: if ($user !~ /^(\w{2})/) { next; }
8161: my ($role) = ($user =~ /^(\w{2})/);
8162: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 8163: my ($section,$status);
1.240 albertel 8164: if ($role eq 'cr' &&
8165: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
8166: $section=$1;
8167: }
8168: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
8169: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 8170: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
8171: if ($end == -1 && $start == -1) {
8172: next; #deleted role
8173: }
8174: if (!defined($possible_status)) {
8175: $sectioncount{$section}++;
8176: } else {
8177: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
8178: $status = 'active';
8179: } elsif ($end < $now) {
8180: $status = 'future';
8181: } elsif ($start > $now) {
8182: $status = 'previous';
8183: }
8184: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
8185: $sectioncount{$section}++;
8186: }
8187: }
1.233 raeburn 8188: }
1.366 albertel 8189: return %sectioncount;
1.233 raeburn 8190: }
8191:
1.274 raeburn 8192: ###############################################
1.294 raeburn 8193:
8194: =pod
1.405 albertel 8195:
8196: =item * &get_course_users()
8197:
1.275 raeburn 8198: Retrieves usernames:domains for users in the specified course
8199: with specific role(s), and access status.
8200:
8201: Incoming parameters:
1.277 albertel 8202: 1. course domain
8203: 2. course number
8204: 3. access status: users must have - either active,
1.275 raeburn 8205: previous, future, or all.
1.277 albertel 8206: 4. reference to array of permissible roles
1.288 raeburn 8207: 5. reference to array of section restrictions (optional)
8208: 6. reference to results object (hash of hashes).
8209: 7. reference to optional userdata hash
1.609 raeburn 8210: 8. reference to optional statushash
1.630 raeburn 8211: 9. flag if privileged users (except those set to unhide in
8212: course settings) should be excluded
1.609 raeburn 8213: Keys of top level results hash are roles.
1.275 raeburn 8214: Keys of inner hashes are username:domain, with
8215: values set to access type.
1.288 raeburn 8216: Optional userdata hash returns an array with arguments in the
8217: same order as loncoursedata::get_classlist() for student data.
8218:
1.609 raeburn 8219: Optional statushash returns
8220:
1.288 raeburn 8221: Entries for end, start, section and status are blank because
8222: of the possibility of multiple values for non-student roles.
8223:
1.275 raeburn 8224: =cut
1.405 albertel 8225:
1.275 raeburn 8226: ###############################################
1.405 albertel 8227:
1.275 raeburn 8228: sub get_course_users {
1.630 raeburn 8229: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 8230: my %idx = ();
1.419 raeburn 8231: my %seclists;
1.288 raeburn 8232:
8233: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
8234: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
8235: $idx{end} = &Apache::loncoursedata::CL_END();
8236: $idx{start} = &Apache::loncoursedata::CL_START();
8237: $idx{id} = &Apache::loncoursedata::CL_ID();
8238: $idx{section} = &Apache::loncoursedata::CL_SECTION();
8239: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
8240: $idx{status} = &Apache::loncoursedata::CL_STATUS();
8241:
1.290 albertel 8242: if (grep(/^st$/,@{$roles})) {
1.276 albertel 8243: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 8244: my $now = time;
1.277 albertel 8245: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 8246: my $match = 0;
1.412 raeburn 8247: my $secmatch = 0;
1.419 raeburn 8248: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 8249: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 8250: if ($section eq '') {
8251: $section = 'none';
8252: }
1.291 albertel 8253: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8254: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8255: $secmatch = 1;
8256: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 8257: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8258: $secmatch = 1;
8259: }
8260: } else {
1.419 raeburn 8261: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 8262: $secmatch = 1;
8263: }
1.290 albertel 8264: }
1.412 raeburn 8265: if (!$secmatch) {
8266: next;
8267: }
1.419 raeburn 8268: }
1.275 raeburn 8269: if (defined($$types{'active'})) {
1.288 raeburn 8270: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 8271: push(@{$$users{st}{$student}},'active');
1.288 raeburn 8272: $match = 1;
1.275 raeburn 8273: }
8274: }
8275: if (defined($$types{'previous'})) {
1.609 raeburn 8276: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 8277: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 8278: $match = 1;
1.275 raeburn 8279: }
8280: }
8281: if (defined($$types{'future'})) {
1.609 raeburn 8282: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 8283: push(@{$$users{st}{$student}},'future');
1.288 raeburn 8284: $match = 1;
1.275 raeburn 8285: }
8286: }
1.609 raeburn 8287: if ($match) {
8288: push(@{$seclists{$student}},$section);
8289: if (ref($userdata) eq 'HASH') {
8290: $$userdata{$student} = $$classlist{$student};
8291: }
8292: if (ref($statushash) eq 'HASH') {
8293: $statushash->{$student}{'st'}{$section} = $status;
8294: }
1.288 raeburn 8295: }
1.275 raeburn 8296: }
8297: }
1.412 raeburn 8298: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 8299: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8300: my $now = time;
1.609 raeburn 8301: my %displaystatus = ( previous => 'Expired',
8302: active => 'Active',
8303: future => 'Future',
8304: );
1.630 raeburn 8305: my %nothide;
8306: if ($hidepriv) {
8307: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
8308: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
8309: if ($user !~ /:/) {
8310: $nothide{join(':',split(/[\@]/,$user))}=1;
8311: } else {
8312: $nothide{$user} = 1;
8313: }
8314: }
8315: }
1.439 raeburn 8316: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 8317: my $match = 0;
1.412 raeburn 8318: my $secmatch = 0;
1.439 raeburn 8319: my $status;
1.412 raeburn 8320: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 8321: $user =~ s/:$//;
1.439 raeburn 8322: my ($end,$start) = split(/:/,$coursepersonnel{$person});
8323: if ($end == -1 || $start == -1) {
8324: next;
8325: }
8326: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
8327: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 8328: my ($uname,$udom) = split(/:/,$user);
8329: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 8330: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 8331: $secmatch = 1;
8332: } elsif ($usec eq '') {
1.420 albertel 8333: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 8334: $secmatch = 1;
8335: }
8336: } else {
8337: if (grep(/^\Q$usec\E$/,@{$sections})) {
8338: $secmatch = 1;
8339: }
8340: }
8341: if (!$secmatch) {
8342: next;
8343: }
1.288 raeburn 8344: }
1.419 raeburn 8345: if ($usec eq '') {
8346: $usec = 'none';
8347: }
1.275 raeburn 8348: if ($uname ne '' && $udom ne '') {
1.630 raeburn 8349: if ($hidepriv) {
8350: if ((&Apache::lonnet::privileged($uname,$udom)) &&
8351: (!$nothide{$uname.':'.$udom})) {
8352: next;
8353: }
8354: }
1.503 raeburn 8355: if ($end > 0 && $end < $now) {
1.439 raeburn 8356: $status = 'previous';
8357: } elsif ($start > $now) {
8358: $status = 'future';
8359: } else {
8360: $status = 'active';
8361: }
1.277 albertel 8362: foreach my $type (keys(%{$types})) {
1.275 raeburn 8363: if ($status eq $type) {
1.420 albertel 8364: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 8365: push(@{$$users{$role}{$user}},$type);
8366: }
1.288 raeburn 8367: $match = 1;
8368: }
8369: }
1.419 raeburn 8370: if (($match) && (ref($userdata) eq 'HASH')) {
8371: if (!exists($$userdata{$uname.':'.$udom})) {
8372: &get_user_info($udom,$uname,\%idx,$userdata);
8373: }
1.420 albertel 8374: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 8375: push(@{$seclists{$uname.':'.$udom}},$usec);
8376: }
1.609 raeburn 8377: if (ref($statushash) eq 'HASH') {
8378: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
8379: }
1.275 raeburn 8380: }
8381: }
8382: }
8383: }
1.290 albertel 8384: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 8385: if ((defined($cdom)) && (defined($cnum))) {
8386: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
8387: if ( defined($csettings{'internal.courseowner'}) ) {
8388: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 8389: next if ($owner eq '');
8390: my ($ownername,$ownerdom);
8391: if ($owner =~ /^([^:]+):([^:]+)$/) {
8392: $ownername = $1;
8393: $ownerdom = $2;
8394: } else {
8395: $ownername = $owner;
8396: $ownerdom = $cdom;
8397: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 8398: }
8399: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 8400: if (defined($userdata) &&
1.609 raeburn 8401: !exists($$userdata{$owner})) {
8402: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
8403: if (!grep(/^none$/,@{$seclists{$owner}})) {
8404: push(@{$seclists{$owner}},'none');
8405: }
8406: if (ref($statushash) eq 'HASH') {
8407: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 8408: }
1.290 albertel 8409: }
1.279 raeburn 8410: }
8411: }
8412: }
1.419 raeburn 8413: foreach my $user (keys(%seclists)) {
8414: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
8415: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
8416: }
1.275 raeburn 8417: }
8418: return;
8419: }
8420:
1.288 raeburn 8421: sub get_user_info {
8422: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 8423: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
8424: &plainname($uname,$udom,'lastname');
1.291 albertel 8425: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 8426: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 8427: my %idhash = &Apache::lonnet::idrget($udom,($uname));
8428: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 8429: return;
8430: }
1.275 raeburn 8431:
1.472 raeburn 8432: ###############################################
8433:
8434: =pod
8435:
8436: =item * &get_user_quota()
8437:
8438: Retrieves quota assigned for storage of portfolio files for a user
8439:
8440: Incoming parameters:
8441: 1. user's username
8442: 2. user's domain
8443:
8444: Returns:
1.536 raeburn 8445: 1. Disk quota (in Mb) assigned to student.
8446: 2. (Optional) Type of setting: custom or default
8447: (individually assigned or default for user's
8448: institutional status).
8449: 3. (Optional) - User's institutional status (e.g., faculty, staff
8450: or student - types as defined in localenroll::inst_usertypes
8451: for user's domain, which determines default quota for user.
8452: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 8453:
8454: If a value has been stored in the user's environment,
1.536 raeburn 8455: it will return that, otherwise it returns the maximal default
8456: defined for the user's instituional status(es) in the domain.
1.472 raeburn 8457:
8458: =cut
8459:
8460: ###############################################
8461:
8462:
8463: sub get_user_quota {
8464: my ($uname,$udom) = @_;
1.536 raeburn 8465: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 8466: if (!defined($udom)) {
8467: $udom = $env{'user.domain'};
8468: }
8469: if (!defined($uname)) {
8470: $uname = $env{'user.name'};
8471: }
8472: if (($udom eq '' || $uname eq '') ||
8473: ($udom eq 'public') && ($uname eq 'public')) {
8474: $quota = 0;
1.536 raeburn 8475: $quotatype = 'default';
8476: $defquota = 0;
1.472 raeburn 8477: } else {
1.536 raeburn 8478: my $inststatus;
1.472 raeburn 8479: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
8480: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 8481: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 8482: } else {
1.536 raeburn 8483: my %userenv =
8484: &Apache::lonnet::get('environment',['portfolioquota',
8485: 'inststatus'],$udom,$uname);
1.472 raeburn 8486: my ($tmp) = keys(%userenv);
8487: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8488: $quota = $userenv{'portfolioquota'};
1.536 raeburn 8489: $inststatus = $userenv{'inststatus'};
1.472 raeburn 8490: } else {
8491: undef(%userenv);
8492: }
8493: }
1.536 raeburn 8494: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 8495: if ($quota eq '') {
1.536 raeburn 8496: $quota = $defquota;
8497: $quotatype = 'default';
8498: } else {
8499: $quotatype = 'custom';
1.472 raeburn 8500: }
8501: }
1.536 raeburn 8502: if (wantarray) {
8503: return ($quota,$quotatype,$settingstatus,$defquota);
8504: } else {
8505: return $quota;
8506: }
1.472 raeburn 8507: }
8508:
8509: ###############################################
8510:
8511: =pod
8512:
8513: =item * &default_quota()
8514:
1.536 raeburn 8515: Retrieves default quota assigned for storage of user portfolio files,
8516: given an (optional) user's institutional status.
1.472 raeburn 8517:
8518: Incoming parameters:
8519: 1. domain
1.536 raeburn 8520: 2. (Optional) institutional status(es). This is a : separated list of
8521: status types (e.g., faculty, staff, student etc.)
8522: which apply to the user for whom the default is being retrieved.
8523: If the institutional status string in undefined, the domain
8524: default quota will be returned.
1.472 raeburn 8525:
8526: Returns:
8527: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 8528: 2. (Optional) institutional type which determined the value of the
8529: default quota.
1.472 raeburn 8530:
8531: If a value has been stored in the domain's configuration db,
8532: it will return that, otherwise it returns 20 (for backwards
8533: compatibility with domains which have not set up a configuration
8534: db file; the original statically defined portfolio quota was 20 Mb).
8535:
1.536 raeburn 8536: If the user's status includes multiple types (e.g., staff and student),
8537: the largest default quota which applies to the user determines the
8538: default quota returned.
8539:
1.780 raeburn 8540: =back
8541:
1.472 raeburn 8542: =cut
8543:
8544: ###############################################
8545:
8546:
8547: sub default_quota {
1.536 raeburn 8548: my ($udom,$inststatus) = @_;
8549: my ($defquota,$settingstatus);
8550: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 8551: ['quotas'],$udom);
8552: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 8553: if ($inststatus ne '') {
1.765 raeburn 8554: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 8555: foreach my $item (@statuses) {
1.711 raeburn 8556: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8557: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
8558: if ($defquota eq '') {
8559: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8560: $settingstatus = $item;
8561: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
8562: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
8563: $settingstatus = $item;
8564: }
8565: }
8566: } else {
8567: if ($quotahash{'quotas'}{$item} ne '') {
8568: if ($defquota eq '') {
8569: $defquota = $quotahash{'quotas'}{$item};
8570: $settingstatus = $item;
8571: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
8572: $defquota = $quotahash{'quotas'}{$item};
8573: $settingstatus = $item;
8574: }
1.536 raeburn 8575: }
8576: }
8577: }
8578: }
8579: if ($defquota eq '') {
1.711 raeburn 8580: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
8581: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
8582: } else {
8583: $defquota = $quotahash{'quotas'}{'default'};
8584: }
1.536 raeburn 8585: $settingstatus = 'default';
8586: }
8587: } else {
8588: $settingstatus = 'default';
8589: $defquota = 20;
8590: }
8591: if (wantarray) {
8592: return ($defquota,$settingstatus);
1.472 raeburn 8593: } else {
1.536 raeburn 8594: return $defquota;
1.472 raeburn 8595: }
8596: }
8597:
1.384 raeburn 8598: sub get_secgrprole_info {
8599: my ($cdom,$cnum,$needroles,$type) = @_;
8600: my %sections_count = &get_sections($cdom,$cnum);
8601: my @sections = (sort {$a <=> $b} keys(%sections_count));
8602: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
8603: my @groups = sort(keys(%curr_groups));
8604: my $allroles = [];
8605: my $rolehash;
8606: my $accesshash = {
8607: active => 'Currently has access',
8608: future => 'Will have future access',
8609: previous => 'Previously had access',
8610: };
8611: if ($needroles) {
8612: $rolehash = {'all' => 'all'};
1.385 albertel 8613: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
8614: if (&Apache::lonnet::error(%user_roles)) {
8615: undef(%user_roles);
8616: }
8617: foreach my $item (keys(%user_roles)) {
1.384 raeburn 8618: my ($role)=split(/\:/,$item,2);
8619: if ($role eq 'cr') { next; }
8620: if ($role =~ /^cr/) {
8621: $$rolehash{$role} = (split('/',$role))[3];
8622: } else {
8623: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
8624: }
8625: }
8626: foreach my $key (sort(keys(%{$rolehash}))) {
8627: push(@{$allroles},$key);
8628: }
8629: push (@{$allroles},'st');
8630: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
8631: }
8632: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
8633: }
8634:
1.555 raeburn 8635: sub user_picker {
1.994 raeburn 8636: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555 raeburn 8637: my $currdom = $dom;
8638: my %curr_selected = (
8639: srchin => 'dom',
1.580 raeburn 8640: srchby => 'lastname',
1.555 raeburn 8641: );
8642: my $srchterm;
1.625 raeburn 8643: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 8644: if ($srch->{'srchby'} ne '') {
8645: $curr_selected{'srchby'} = $srch->{'srchby'};
8646: }
8647: if ($srch->{'srchin'} ne '') {
8648: $curr_selected{'srchin'} = $srch->{'srchin'};
8649: }
8650: if ($srch->{'srchtype'} ne '') {
8651: $curr_selected{'srchtype'} = $srch->{'srchtype'};
8652: }
8653: if ($srch->{'srchdomain'} ne '') {
8654: $currdom = $srch->{'srchdomain'};
8655: }
8656: $srchterm = $srch->{'srchterm'};
8657: }
8658: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 8659: 'usr' => 'Search criteria',
1.563 raeburn 8660: 'doma' => 'Domain/institution to search',
1.558 albertel 8661: 'uname' => 'username',
8662: 'lastname' => 'last name',
1.555 raeburn 8663: 'lastfirst' => 'last name, first name',
1.558 albertel 8664: 'crs' => 'in this course',
1.576 raeburn 8665: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 8666: 'alc' => 'all LON-CAPA',
1.573 raeburn 8667: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 8668: 'exact' => 'is',
8669: 'contains' => 'contains',
1.569 raeburn 8670: 'begins' => 'begins with',
1.571 raeburn 8671: 'youm' => "You must include some text to search for.",
8672: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
8673: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
8674: 'yomc' => "You must choose a domain when using an institutional directory search.",
8675: 'ymcd' => "You must choose a domain when using a domain search.",
8676: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
8677: 'whse' => "When searching by last,first you must include at least one character in the first name.",
8678: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 8679: );
1.563 raeburn 8680: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
8681: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 8682:
8683: my @srchins = ('crs','dom','alc','instd');
8684:
8685: foreach my $option (@srchins) {
8686: # FIXME 'alc' option unavailable until
8687: # loncreateuser::print_user_query_page()
8688: # has been completed.
8689: next if ($option eq 'alc');
1.880 raeburn 8690: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 8691: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 8692: if ($curr_selected{'srchin'} eq $option) {
8693: $srchinsel .= '
8694: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8695: } else {
8696: $srchinsel .= '
8697: <option value="'.$option.'">'.$lt{$option}.'</option>';
8698: }
1.555 raeburn 8699: }
1.563 raeburn 8700: $srchinsel .= "\n </select>\n";
1.555 raeburn 8701:
8702: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 8703: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 8704: if ($curr_selected{'srchby'} eq $option) {
8705: $srchbysel .= '
8706: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8707: } else {
8708: $srchbysel .= '
8709: <option value="'.$option.'">'.$lt{$option}.'</option>';
8710: }
8711: }
8712: $srchbysel .= "\n </select>\n";
8713:
8714: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 8715: foreach my $option ('begins','contains','exact') {
1.555 raeburn 8716: if ($curr_selected{'srchtype'} eq $option) {
8717: $srchtypesel .= '
8718: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
8719: } else {
8720: $srchtypesel .= '
8721: <option value="'.$option.'">'.$lt{$option}.'</option>';
8722: }
8723: }
8724: $srchtypesel .= "\n </select>\n";
8725:
1.558 albertel 8726: my ($newuserscript,$new_user_create);
1.994 raeburn 8727: my $context_dom = $env{'request.role.domain'};
8728: if ($context eq 'requestcrs') {
8729: if ($env{'form.coursedom'} ne '') {
8730: $context_dom = $env{'form.coursedom'};
8731: }
8732: }
1.556 raeburn 8733: if ($forcenewuser) {
1.576 raeburn 8734: if (ref($srch) eq 'HASH') {
1.994 raeburn 8735: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 8736: if ($cancreate) {
8737: $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>';
8738: } else {
1.799 bisitz 8739: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 8740: my %usertypetext = (
8741: official => 'institutional',
8742: unofficial => 'non-institutional',
8743: );
1.799 bisitz 8744: $new_user_create = '<p class="LC_warning">'
8745: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
8746: .' '
8747: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
8748: ,'<a href="'.$helplink.'">','</a>')
8749: .'</p><br />';
1.627 raeburn 8750: }
1.576 raeburn 8751: }
8752: }
8753:
1.556 raeburn 8754: $newuserscript = <<"ENDSCRIPT";
8755:
1.570 raeburn 8756: function setSearch(createnew,callingForm) {
1.556 raeburn 8757: if (createnew == 1) {
1.570 raeburn 8758: for (var i=0; i<callingForm.srchby.length; i++) {
8759: if (callingForm.srchby.options[i].value == 'uname') {
8760: callingForm.srchby.selectedIndex = i;
1.556 raeburn 8761: }
8762: }
1.570 raeburn 8763: for (var i=0; i<callingForm.srchin.length; i++) {
8764: if ( callingForm.srchin.options[i].value == 'dom') {
8765: callingForm.srchin.selectedIndex = i;
1.556 raeburn 8766: }
8767: }
1.570 raeburn 8768: for (var i=0; i<callingForm.srchtype.length; i++) {
8769: if (callingForm.srchtype.options[i].value == 'exact') {
8770: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 8771: }
8772: }
1.570 raeburn 8773: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 8774: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 8775: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 8776: }
8777: }
8778: }
8779: }
8780: ENDSCRIPT
1.558 albertel 8781:
1.556 raeburn 8782: }
8783:
1.555 raeburn 8784: my $output = <<"END_BLOCK";
1.556 raeburn 8785: <script type="text/javascript">
1.824 bisitz 8786: // <![CDATA[
1.570 raeburn 8787: function validateEntry(callingForm) {
1.558 albertel 8788:
1.556 raeburn 8789: var checkok = 1;
1.558 albertel 8790: var srchin;
1.570 raeburn 8791: for (var i=0; i<callingForm.srchin.length; i++) {
8792: if ( callingForm.srchin[i].checked ) {
8793: srchin = callingForm.srchin[i].value;
1.558 albertel 8794: }
8795: }
8796:
1.570 raeburn 8797: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
8798: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
8799: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
8800: var srchterm = callingForm.srchterm.value;
8801: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 8802: var msg = "";
8803:
8804: if (srchterm == "") {
8805: checkok = 0;
1.571 raeburn 8806: msg += "$lt{'youm'}\\n";
1.556 raeburn 8807: }
8808:
1.569 raeburn 8809: if (srchtype== 'begins') {
8810: if (srchterm.length < 2) {
8811: checkok = 0;
1.571 raeburn 8812: msg += "$lt{'thte'}\\n";
1.569 raeburn 8813: }
8814: }
8815:
1.556 raeburn 8816: if (srchtype== 'contains') {
8817: if (srchterm.length < 3) {
8818: checkok = 0;
1.571 raeburn 8819: msg += "$lt{'thet'}\\n";
1.556 raeburn 8820: }
8821: }
8822: if (srchin == 'instd') {
8823: if (srchdomain == '') {
8824: checkok = 0;
1.571 raeburn 8825: msg += "$lt{'yomc'}\\n";
1.556 raeburn 8826: }
8827: }
8828: if (srchin == 'dom') {
8829: if (srchdomain == '') {
8830: checkok = 0;
1.571 raeburn 8831: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 8832: }
8833: }
8834: if (srchby == 'lastfirst') {
8835: if (srchterm.indexOf(",") == -1) {
8836: checkok = 0;
1.571 raeburn 8837: msg += "$lt{'whus'}\\n";
1.556 raeburn 8838: }
8839: if (srchterm.indexOf(",") == srchterm.length -1) {
8840: checkok = 0;
1.571 raeburn 8841: msg += "$lt{'whse'}\\n";
1.556 raeburn 8842: }
8843: }
8844: if (checkok == 0) {
1.571 raeburn 8845: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 8846: return;
8847: }
8848: if (checkok == 1) {
1.570 raeburn 8849: callingForm.submit();
1.556 raeburn 8850: }
8851: }
8852:
8853: $newuserscript
8854:
1.824 bisitz 8855: // ]]>
1.556 raeburn 8856: </script>
1.558 albertel 8857:
8858: $new_user_create
8859:
1.555 raeburn 8860: END_BLOCK
1.558 albertel 8861:
1.876 raeburn 8862: $output .= &Apache::lonhtmlcommon::start_pick_box().
8863: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
8864: $domform.
8865: &Apache::lonhtmlcommon::row_closure().
8866: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
8867: $srchbysel.
8868: $srchtypesel.
8869: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
8870: $srchinsel.
8871: &Apache::lonhtmlcommon::row_closure(1).
8872: &Apache::lonhtmlcommon::end_pick_box().
8873: '<br />';
1.555 raeburn 8874: return $output;
8875: }
8876:
1.612 raeburn 8877: sub user_rule_check {
1.615 raeburn 8878: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 8879: my $response;
8880: if (ref($usershash) eq 'HASH') {
8881: foreach my $user (keys(%{$usershash})) {
8882: my ($uname,$udom) = split(/:/,$user);
8883: next if ($udom eq '' || $uname eq '');
1.615 raeburn 8884: my ($id,$newuser);
1.612 raeburn 8885: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 8886: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 8887: $id = $usershash->{$user}->{'id'};
8888: }
8889: my $inst_response;
8890: if (ref($checks) eq 'HASH') {
8891: if (defined($checks->{'username'})) {
1.615 raeburn 8892: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8893: &Apache::lonnet::get_instuser($udom,$uname);
8894: } elsif (defined($checks->{'id'})) {
1.615 raeburn 8895: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 8896: &Apache::lonnet::get_instuser($udom,undef,$id);
8897: }
1.615 raeburn 8898: } else {
8899: ($inst_response,%{$inst_results->{$user}}) =
8900: &Apache::lonnet::get_instuser($udom,$uname);
8901: return;
1.612 raeburn 8902: }
1.615 raeburn 8903: if (!$got_rules->{$udom}) {
1.612 raeburn 8904: my %domconfig = &Apache::lonnet::get_dom('configuration',
8905: ['usercreation'],$udom);
8906: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 8907: foreach my $item ('username','id') {
1.612 raeburn 8908: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
8909: $$curr_rules{$udom}{$item} =
8910: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 8911: }
8912: }
8913: }
1.615 raeburn 8914: $got_rules->{$udom} = 1;
1.585 raeburn 8915: }
1.612 raeburn 8916: foreach my $item (keys(%{$checks})) {
8917: if (ref($$curr_rules{$udom}) eq 'HASH') {
8918: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
8919: if (@{$$curr_rules{$udom}{$item}} > 0) {
8920: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
8921: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
8922: if ($rule_check{$rule}) {
8923: $$rulematch{$user}{$item} = $rule;
8924: if ($inst_response eq 'ok') {
1.615 raeburn 8925: if (ref($inst_results) eq 'HASH') {
8926: if (ref($inst_results->{$user}) eq 'HASH') {
8927: if (keys(%{$inst_results->{$user}}) == 0) {
8928: $$alerts{$item}{$udom}{$uname} = 1;
8929: }
1.612 raeburn 8930: }
8931: }
1.615 raeburn 8932: }
8933: last;
1.585 raeburn 8934: }
8935: }
8936: }
8937: }
8938: }
8939: }
8940: }
8941: }
1.612 raeburn 8942: return;
8943: }
8944:
8945: sub user_rule_formats {
8946: my ($domain,$domdesc,$curr_rules,$check) = @_;
8947: my %text = (
8948: 'username' => 'Usernames',
8949: 'id' => 'IDs',
8950: );
8951: my $output;
8952: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8953: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8954: if (@{$ruleorder} > 0) {
8955: $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>';
8956: foreach my $rule (@{$ruleorder}) {
8957: if (ref($curr_rules) eq 'ARRAY') {
8958: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8959: if (ref($rules->{$rule}) eq 'HASH') {
8960: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8961: $rules->{$rule}{'desc'}.'</li>';
8962: }
8963: }
8964: }
8965: }
8966: $output .= '</ul>';
8967: }
8968: }
8969: return $output;
8970: }
8971:
8972: sub instrule_disallow_msg {
1.615 raeburn 8973: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8974: my $response;
8975: my %text = (
8976: item => 'username',
8977: items => 'usernames',
8978: match => 'matches',
8979: do => 'does',
8980: action => 'a username',
8981: one => 'one',
8982: );
8983: if ($count > 1) {
8984: $text{'item'} = 'usernames';
8985: $text{'match'} ='match';
8986: $text{'do'} = 'do';
8987: $text{'action'} = 'usernames',
8988: $text{'one'} = 'ones';
8989: }
8990: if ($checkitem eq 'id') {
8991: $text{'items'} = 'IDs';
8992: $text{'item'} = 'ID';
8993: $text{'action'} = 'an ID';
1.615 raeburn 8994: if ($count > 1) {
8995: $text{'item'} = 'IDs';
8996: $text{'action'} = 'IDs';
8997: }
1.612 raeburn 8998: }
1.674 bisitz 8999: $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 9000: if ($mode eq 'upload') {
9001: if ($checkitem eq 'username') {
9002: $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'}.");
9003: } elsif ($checkitem eq 'id') {
1.674 bisitz 9004: $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 9005: }
1.669 raeburn 9006: } elsif ($mode eq 'selfcreate') {
9007: if ($checkitem eq 'id') {
9008: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
9009: }
1.615 raeburn 9010: } else {
9011: if ($checkitem eq 'username') {
9012: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
9013: } elsif ($checkitem eq 'id') {
9014: $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.");
9015: }
1.612 raeburn 9016: }
9017: return $response;
1.585 raeburn 9018: }
9019:
1.624 raeburn 9020: sub personal_data_fieldtitles {
9021: my %fieldtitles = &Apache::lonlocal::texthash (
9022: id => 'Student/Employee ID',
9023: permanentemail => 'E-mail address',
9024: lastname => 'Last Name',
9025: firstname => 'First Name',
9026: middlename => 'Middle Name',
9027: generation => 'Generation',
9028: gen => 'Generation',
1.765 raeburn 9029: inststatus => 'Affiliation',
1.624 raeburn 9030: );
9031: return %fieldtitles;
9032: }
9033:
1.642 raeburn 9034: sub sorted_inst_types {
9035: my ($dom) = @_;
9036: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
9037: my $othertitle = &mt('All users');
9038: if ($env{'request.course.id'}) {
1.668 raeburn 9039: $othertitle = &mt('Any users');
1.642 raeburn 9040: }
9041: my @types;
9042: if (ref($order) eq 'ARRAY') {
9043: @types = @{$order};
9044: }
9045: if (@types == 0) {
9046: if (ref($usertypes) eq 'HASH') {
9047: @types = sort(keys(%{$usertypes}));
9048: }
9049: }
9050: if (keys(%{$usertypes}) > 0) {
9051: $othertitle = &mt('Other users');
9052: }
9053: return ($othertitle,$usertypes,\@types);
9054: }
9055:
1.645 raeburn 9056: sub get_institutional_codes {
9057: my ($settings,$allcourses,$LC_code) = @_;
9058: # Get complete list of course sections to update
9059: my @currsections = ();
9060: my @currxlists = ();
9061: my $coursecode = $$settings{'internal.coursecode'};
9062:
9063: if ($$settings{'internal.sectionnums'} ne '') {
9064: @currsections = split(/,/,$$settings{'internal.sectionnums'});
9065: }
9066:
9067: if ($$settings{'internal.crosslistings'} ne '') {
9068: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
9069: }
9070:
9071: if (@currxlists > 0) {
9072: foreach (@currxlists) {
9073: if (m/^([^:]+):(\w*)$/) {
9074: unless (grep/^$1$/,@{$allcourses}) {
9075: push @{$allcourses},$1;
9076: $$LC_code{$1} = $2;
9077: }
9078: }
9079: }
9080: }
9081:
9082: if (@currsections > 0) {
9083: foreach (@currsections) {
9084: if (m/^(\w+):(\w*)$/) {
9085: my $sec = $coursecode.$1;
9086: my $lc_sec = $2;
9087: unless (grep/^$sec$/,@{$allcourses}) {
9088: push @{$allcourses},$sec;
9089: $$LC_code{$sec} = $lc_sec;
9090: }
9091: }
9092: }
9093: }
9094: return;
9095: }
9096:
1.971 raeburn 9097: sub get_standard_codeitems {
9098: return ('Year','Semester','Department','Number','Section');
9099: }
9100:
1.112 bowersj2 9101: =pod
9102:
1.780 raeburn 9103: =head1 Slot Helpers
9104:
9105: =over 4
9106:
9107: =item * sorted_slots()
9108:
1.1040 raeburn 9109: Sorts an array of slot names in order of an optional sort key,
9110: default sort is by slot start time (earliest first).
1.780 raeburn 9111:
9112: Inputs:
9113:
9114: =over 4
9115:
9116: slotsarr - Reference to array of unsorted slot names.
9117:
9118: slots - Reference to hash of hash, where outer hash keys are slot names.
9119:
1.1040 raeburn 9120: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
9121:
1.549 albertel 9122: =back
9123:
1.780 raeburn 9124: Returns:
9125:
9126: =over 4
9127:
1.1040 raeburn 9128: sorted - An array of slot names sorted by a specified sort key
9129: (default sort key is start time of the slot).
1.780 raeburn 9130:
9131: =back
9132:
9133: =cut
9134:
9135:
9136: sub sorted_slots {
1.1040 raeburn 9137: my ($slotsarr,$slots,$sortkey) = @_;
9138: if ($sortkey eq '') {
9139: $sortkey = 'starttime';
9140: }
1.780 raeburn 9141: my @sorted;
9142: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
9143: @sorted =
9144: sort {
9145: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 9146: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 9147: }
9148: if (ref($slots->{$a})) { return -1;}
9149: if (ref($slots->{$b})) { return 1;}
9150: return 0;
9151: } @{$slotsarr};
9152: }
9153: return @sorted;
9154: }
9155:
1.1040 raeburn 9156: =pod
9157:
9158: =item * get_future_slots()
9159:
9160: Inputs:
9161:
9162: =over 4
9163:
9164: cnum - course number
9165:
9166: cdom - course domain
9167:
9168: now - current UNIX time
9169:
9170: symb - optional symb
9171:
9172: =back
9173:
9174: Returns:
9175:
9176: =over 4
9177:
9178: sorted_reservable - ref to array of student_schedulable slots currently
9179: reservable, ordered by end date of reservation period.
9180:
9181: reservable_now - ref to hash of student_schedulable slots currently
9182: reservable.
9183:
9184: Keys in inner hash are:
9185: (a) symb: either blank or symb to which slot use is restricted.
9186: (b) endreserve: end date of reservation period.
9187:
9188: sorted_future - ref to array of student_schedulable slots reservable in
9189: the future, ordered by start date of reservation period.
9190:
9191: future_reservable - ref to hash of student_schedulable slots reservable
9192: in the future.
9193:
9194: Keys in inner hash are:
9195: (a) symb: either blank or symb to which slot use is restricted.
9196: (b) startreserve: start date of reservation period.
9197:
9198: =back
9199:
9200: =cut
9201:
9202: sub get_future_slots {
9203: my ($cnum,$cdom,$now,$symb) = @_;
9204: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
9205: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
9206: foreach my $slot (keys(%slots)) {
9207: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
9208: if ($symb) {
9209: next if (($slots{$slot}->{'symb'} ne '') &&
9210: ($slots{$slot}->{'symb'} ne $symb));
9211: }
9212: if (($slots{$slot}->{'starttime'} > $now) &&
9213: ($slots{$slot}->{'endtime'} > $now)) {
9214: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
9215: my $userallowed = 0;
9216: if ($slots{$slot}->{'allowedsections'}) {
9217: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
9218: if (!defined($env{'request.role.sec'})
9219: && grep(/^No section assigned$/,@allowed_sec)) {
9220: $userallowed=1;
9221: } else {
9222: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
9223: $userallowed=1;
9224: }
9225: }
9226: unless ($userallowed) {
9227: if (defined($env{'request.course.groups'})) {
9228: my @groups = split(/:/,$env{'request.course.groups'});
9229: foreach my $group (@groups) {
9230: if (grep(/^\Q$group\E$/,@allowed_sec)) {
9231: $userallowed=1;
9232: last;
9233: }
9234: }
9235: }
9236: }
9237: }
9238: if ($slots{$slot}->{'allowedusers'}) {
9239: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
9240: my $user = $env{'user.name'}.':'.$env{'user.domain'};
9241: if (grep(/^\Q$user\E$/,@allowed_users)) {
9242: $userallowed = 1;
9243: }
9244: }
9245: next unless($userallowed);
9246: }
9247: my $startreserve = $slots{$slot}->{'startreserve'};
9248: my $endreserve = $slots{$slot}->{'endreserve'};
9249: my $symb = $slots{$slot}->{'symb'};
9250: if (($startreserve < $now) &&
9251: (!$endreserve || $endreserve > $now)) {
9252: my $lastres = $endreserve;
9253: if (!$lastres) {
9254: $lastres = $slots{$slot}->{'starttime'};
9255: }
9256: $reservable_now{$slot} = {
9257: symb => $symb,
9258: endreserve => $lastres
9259: };
9260: } elsif (($startreserve > $now) &&
9261: (!$endreserve || $endreserve > $startreserve)) {
9262: $future_reservable{$slot} = {
9263: symb => $symb,
9264: startreserve => $startreserve
9265: };
9266: }
9267: }
9268: }
9269: my @unsorted_reservable = keys(%reservable_now);
9270: if (@unsorted_reservable > 0) {
9271: @sorted_reservable =
9272: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
9273: }
9274: my @unsorted_future = keys(%future_reservable);
9275: if (@unsorted_future > 0) {
9276: @sorted_future =
9277: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
9278: }
9279: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
9280: }
1.780 raeburn 9281:
9282: =pod
9283:
1.1057 foxr 9284: =back
9285:
1.549 albertel 9286: =head1 HTTP Helpers
9287:
9288: =over 4
9289:
1.648 raeburn 9290: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 9291:
1.258 albertel 9292: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 9293: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 9294: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 9295:
9296: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
9297: $possible_names is an ref to an array of form element names. As an example:
9298: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 9299: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 9300:
9301: =cut
1.1 albertel 9302:
1.6 albertel 9303: sub get_unprocessed_cgi {
1.25 albertel 9304: my ($query,$possible_names)= @_;
1.26 matthew 9305: # $Apache::lonxml::debug=1;
1.356 albertel 9306: foreach my $pair (split(/&/,$query)) {
9307: my ($name, $value) = split(/=/,$pair);
1.369 www 9308: $name = &unescape($name);
1.25 albertel 9309: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
9310: $value =~ tr/+/ /;
9311: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 9312: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 9313: }
1.16 harris41 9314: }
1.6 albertel 9315: }
9316:
1.112 bowersj2 9317: =pod
9318:
1.648 raeburn 9319: =item * &cacheheader()
1.112 bowersj2 9320:
9321: returns cache-controlling header code
9322:
9323: =cut
9324:
1.7 albertel 9325: sub cacheheader {
1.258 albertel 9326: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 9327: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
9328: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 9329: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
9330: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 9331: return $output;
1.7 albertel 9332: }
9333:
1.112 bowersj2 9334: =pod
9335:
1.648 raeburn 9336: =item * &no_cache($r)
1.112 bowersj2 9337:
9338: specifies header code to not have cache
9339:
9340: =cut
9341:
1.9 albertel 9342: sub no_cache {
1.216 albertel 9343: my ($r) = @_;
9344: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 9345: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 9346: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
9347: $r->no_cache(1);
9348: $r->header_out("Expires" => $date);
9349: $r->header_out("Pragma" => "no-cache");
1.123 www 9350: }
9351:
9352: sub content_type {
1.181 albertel 9353: my ($r,$type,$charset) = @_;
1.299 foxr 9354: if ($r) {
9355: # Note that printout.pl calls this with undef for $r.
9356: &no_cache($r);
9357: }
1.258 albertel 9358: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 9359: unless ($charset) {
9360: $charset=&Apache::lonlocal::current_encoding;
9361: }
9362: if ($charset) { $type.='; charset='.$charset; }
9363: if ($r) {
9364: $r->content_type($type);
9365: } else {
9366: print("Content-type: $type\n\n");
9367: }
1.9 albertel 9368: }
1.25 albertel 9369:
1.112 bowersj2 9370: =pod
9371:
1.648 raeburn 9372: =item * &add_to_env($name,$value)
1.112 bowersj2 9373:
1.258 albertel 9374: adds $name to the %env hash with value
1.112 bowersj2 9375: $value, if $name already exists, the entry is converted to an array
9376: reference and $value is added to the array.
9377:
9378: =cut
9379:
1.25 albertel 9380: sub add_to_env {
9381: my ($name,$value)=@_;
1.258 albertel 9382: if (defined($env{$name})) {
9383: if (ref($env{$name})) {
1.25 albertel 9384: #already have multiple values
1.258 albertel 9385: push(@{ $env{$name} },$value);
1.25 albertel 9386: } else {
9387: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 9388: my $first=$env{$name};
9389: undef($env{$name});
9390: push(@{ $env{$name} },$first,$value);
1.25 albertel 9391: }
9392: } else {
1.258 albertel 9393: $env{$name}=$value;
1.25 albertel 9394: }
1.31 albertel 9395: }
1.149 albertel 9396:
9397: =pod
9398:
1.648 raeburn 9399: =item * &get_env_multiple($name)
1.149 albertel 9400:
1.258 albertel 9401: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 9402: values may be defined and end up as an array ref.
9403:
9404: returns an array of values
9405:
9406: =cut
9407:
9408: sub get_env_multiple {
9409: my ($name) = @_;
9410: my @values;
1.258 albertel 9411: if (defined($env{$name})) {
1.149 albertel 9412: # exists is it an array
1.258 albertel 9413: if (ref($env{$name})) {
9414: @values=@{ $env{$name} };
1.149 albertel 9415: } else {
1.258 albertel 9416: $values[0]=$env{$name};
1.149 albertel 9417: }
9418: }
9419: return(@values);
9420: }
9421:
1.660 raeburn 9422: sub ask_for_embedded_content {
9423: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 9424: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11 raeburn 9425: %currsubfile,%unused,$rem);
1.1071 raeburn 9426: my $counter = 0;
9427: my $numnew = 0;
1.987 raeburn 9428: my $numremref = 0;
9429: my $numinvalid = 0;
9430: my $numpathchg = 0;
9431: my $numexisting = 0;
1.1071 raeburn 9432: my $numunused = 0;
9433: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
9434: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
9435: my $heading = &mt('Upload embedded files');
9436: my $buttontext = &mt('Upload');
9437:
1.1075.2.11 raeburn 9438: my $navmap;
9439: if ($env{'request.course.id'}) {
9440: $navmap = Apache::lonnavmaps::navmap->new();
9441: }
1.984 raeburn 9442: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9443: my $current_path='/';
9444: if ($env{'form.currentpath'}) {
9445: $current_path = $env{'form.currentpath'};
9446: }
9447: if ($actionurl eq '/adm/coursegrp_portfolio') {
9448: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9449: $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
9450: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
9451: } else {
9452: $udom = $env{'user.domain'};
9453: $uname = $env{'user.name'};
9454: $url = '/userfiles/portfolio';
9455: }
1.987 raeburn 9456: $toplevel = $url.'/';
1.984 raeburn 9457: $url .= $current_path;
9458: $getpropath = 1;
1.987 raeburn 9459: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9460: ($actionurl eq '/adm/imsimport')) {
1.1022 www 9461: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 9462: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 9463: $toplevel = $url;
1.984 raeburn 9464: if ($rest ne '') {
1.987 raeburn 9465: $url .= $rest;
9466: }
9467: } elsif ($actionurl eq '/adm/coursedocs') {
9468: if (ref($args) eq 'HASH') {
1.1071 raeburn 9469: $url = $args->{'docs_url'};
9470: $toplevel = $url;
1.1075.2.11 raeburn 9471: if ($args->{'context'} eq 'paste') {
9472: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
9473: ($path) =
9474: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9475: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9476: $fileloc =~ s{^/}{};
9477: }
1.1071 raeburn 9478: }
9479: } elsif ($actionurl eq '/adm/dependencies') {
9480: if ($env{'request.course.id'} ne '') {
9481: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9482: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9483: if (ref($args) eq 'HASH') {
9484: $url = $args->{'docs_url'};
9485: $title = $args->{'docs_title'};
9486: $toplevel = "/$url";
1.1075.2.11 raeburn 9487: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1071 raeburn 9488: ($path) =
9489: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
9490: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
9491: $fileloc =~ s{^/}{};
9492: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
9493: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
9494: }
1.987 raeburn 9495: }
9496: }
9497: my $now = time();
9498: foreach my $embed_file (keys(%{$allfiles})) {
9499: my $absolutepath;
9500: if ($embed_file =~ m{^\w+://}) {
9501: $newfiles{$embed_file} = 1;
9502: $mapping{$embed_file} = $embed_file;
9503: } else {
9504: if ($embed_file =~ m{^/}) {
9505: $absolutepath = $embed_file;
9506: $embed_file =~ s{^(/+)}{};
9507: }
9508: if ($embed_file =~ m{/}) {
9509: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
9510: $path = &check_for_traversal($path,$url,$toplevel);
9511: my $item = $fname;
9512: if ($path ne '') {
9513: $item = $path.'/'.$fname;
9514: $subdependencies{$path}{$fname} = 1;
9515: } else {
9516: $dependencies{$item} = 1;
9517: }
9518: if ($absolutepath) {
9519: $mapping{$item} = $absolutepath;
9520: } else {
9521: $mapping{$item} = $embed_file;
9522: }
9523: } else {
9524: $dependencies{$embed_file} = 1;
9525: if ($absolutepath) {
9526: $mapping{$embed_file} = $absolutepath;
9527: } else {
9528: $mapping{$embed_file} = $embed_file;
9529: }
9530: }
1.984 raeburn 9531: }
9532: }
1.1071 raeburn 9533: my $dirptr = 16384;
1.984 raeburn 9534: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 9535: $currsubfile{$path} = {};
1.984 raeburn 9536: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9537: my ($sublistref,$listerror) =
9538: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
9539: if (ref($sublistref) eq 'ARRAY') {
9540: foreach my $line (@{$sublistref}) {
9541: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 9542: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 9543: }
1.984 raeburn 9544: }
1.987 raeburn 9545: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9546: if (opendir(my $dir,$url.'/'.$path)) {
9547: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 9548: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
9549: }
1.1075.2.11 raeburn 9550: } elsif (($actionurl eq '/adm/dependencies') ||
9551: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9552: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9553: if ($env{'request.course.id'} ne '') {
9554: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9555: if ($dir ne '') {
9556: my ($sublistref,$listerror) =
9557: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
9558: if (ref($sublistref) eq 'ARRAY') {
9559: foreach my $line (@{$sublistref}) {
9560: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
9561: undef,$mtime)=split(/\&/,$line,12);
9562: unless (($testdir&$dirptr) ||
9563: ($file_name =~ /^\.\.?$/)) {
9564: $currsubfile{$path}{$file_name} = [$size,$mtime];
9565: }
9566: }
9567: }
9568: }
1.984 raeburn 9569: }
9570: }
9571: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 9572: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 9573: my $item = $path.'/'.$file;
9574: unless ($mapping{$item} eq $item) {
9575: $pathchanges{$item} = 1;
9576: }
9577: $existing{$item} = 1;
9578: $numexisting ++;
9579: } else {
9580: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 9581: }
9582: }
1.1071 raeburn 9583: if ($actionurl eq '/adm/dependencies') {
9584: foreach my $path (keys(%currsubfile)) {
9585: if (ref($currsubfile{$path}) eq 'HASH') {
9586: foreach my $file (keys(%{$currsubfile{$path}})) {
9587: unless ($subdependencies{$path}{$file}) {
1.1075.2.11 raeburn 9588: next if (($rem ne '') &&
9589: (($env{"httpref.$rem"."$path/$file"} ne '') ||
9590: (ref($navmap) &&
9591: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
9592: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9593: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 9594: $unused{$path.'/'.$file} = 1;
9595: }
9596: }
9597: }
9598: }
9599: }
1.984 raeburn 9600: }
1.987 raeburn 9601: my %currfile;
1.984 raeburn 9602: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 9603: my ($dirlistref,$listerror) =
9604: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
9605: if (ref($dirlistref) eq 'ARRAY') {
9606: foreach my $line (@{$dirlistref}) {
9607: my ($file_name,$rest) = split(/\&/,$line,2);
9608: $currfile{$file_name} = 1;
9609: }
1.984 raeburn 9610: }
1.987 raeburn 9611: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 9612: if (opendir(my $dir,$url)) {
1.987 raeburn 9613: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 9614: map {$currfile{$_} = 1;} @dir_list;
9615: }
1.1075.2.11 raeburn 9616: } elsif (($actionurl eq '/adm/dependencies') ||
9617: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9618: ($args->{'context'} eq 'paste'))) {
1.1071 raeburn 9619: if ($env{'request.course.id'} ne '') {
9620: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
9621: if ($dir ne '') {
9622: my ($dirlistref,$listerror) =
9623: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
9624: if (ref($dirlistref) eq 'ARRAY') {
9625: foreach my $line (@{$dirlistref}) {
9626: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
9627: $size,undef,$mtime)=split(/\&/,$line,12);
9628: unless (($testdir&$dirptr) ||
9629: ($file_name =~ /^\.\.?$/)) {
9630: $currfile{$file_name} = [$size,$mtime];
9631: }
9632: }
9633: }
9634: }
9635: }
1.984 raeburn 9636: }
9637: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 9638: if (exists($currfile{$file})) {
1.987 raeburn 9639: unless ($mapping{$file} eq $file) {
9640: $pathchanges{$file} = 1;
9641: }
9642: $existing{$file} = 1;
9643: $numexisting ++;
9644: } else {
1.984 raeburn 9645: $newfiles{$file} = 1;
9646: }
9647: }
1.1071 raeburn 9648: foreach my $file (keys(%currfile)) {
9649: unless (($file eq $filename) ||
9650: ($file eq $filename.'.bak') ||
9651: ($dependencies{$file})) {
1.1075.2.11 raeburn 9652: if ($actionurl eq '/adm/dependencies') {
9653: next if (($rem ne '') &&
9654: (($env{"httpref.$rem".$file} ne '') ||
9655: (ref($navmap) &&
9656: (($navmap->getResourceByUrl($rem.$file) ne '') ||
9657: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
9658: ($navmap->getResourceByUrl($rem.$1)))))));
9659: }
1.1071 raeburn 9660: $unused{$file} = 1;
9661: }
9662: }
1.1075.2.11 raeburn 9663: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
9664: ($args->{'context'} eq 'paste')) {
9665: $counter = scalar(keys(%existing));
9666: $numpathchg = scalar(keys(%pathchanges));
9667: return ($output,$counter,$numpathchg,\%existing);
9668: }
1.984 raeburn 9669: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 9670: if ($actionurl eq '/adm/dependencies') {
9671: next if ($embed_file =~ m{^\w+://});
9672: }
1.660 raeburn 9673: $upload_output .= &start_data_table_row().
1.1071 raeburn 9674: '<td><img src="'.&icon($embed_file).'" /> '.
9675: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 9676: unless ($mapping{$embed_file} eq $embed_file) {
9677: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
9678: }
9679: $upload_output .= '</td><td>';
1.1071 raeburn 9680: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.660 raeburn 9681: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987 raeburn 9682: $numremref++;
1.660 raeburn 9683: } elsif ($args->{'error_on_invalid_names'}
9684: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.987 raeburn 9685: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
9686: $numinvalid++;
1.660 raeburn 9687: } else {
1.1071 raeburn 9688: $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 9689: $embed_file,\%mapping,
1.1071 raeburn 9690: $allfiles,$codebase,'upload');
9691: $counter ++;
9692: $numnew ++;
1.987 raeburn 9693: }
9694: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
9695: }
9696: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 9697: if ($actionurl eq '/adm/dependencies') {
9698: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
9699: $modify_output .= &start_data_table_row().
9700: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
9701: '<img src="'.&icon($embed_file).'" border="0" />'.
9702: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
9703: '<td>'.$size.'</td>'.
9704: '<td>'.$mtime.'</td>'.
9705: '<td><label><input type="checkbox" name="mod_upload_dep" '.
9706: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
9707: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
9708: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
9709: &embedded_file_element('upload_embedded',$counter,
9710: $embed_file,\%mapping,
9711: $allfiles,$codebase,'modify').
9712: '</div></td>'.
9713: &end_data_table_row()."\n";
9714: $counter ++;
9715: } else {
9716: $upload_output .= &start_data_table_row().
9717: '<td><span class="LC_filename">'.$embed_file.'</span></td>';
9718: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
9719: &Apache::loncommon::end_data_table_row()."\n";
9720: }
9721: }
9722: my $delidx = $counter;
9723: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
9724: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
9725: $delete_output .= &start_data_table_row().
9726: '<td><img src="'.&icon($oldfile).'" />'.
9727: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
9728: '<td>'.$size.'</td>'.
9729: '<td>'.$mtime.'</td>'.
9730: '<td><label><input type="checkbox" name="del_upload_dep" '.
9731: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
9732: &embedded_file_element('upload_embedded',$delidx,
9733: $oldfile,\%mapping,$allfiles,
9734: $codebase,'delete').'</td>'.
9735: &end_data_table_row()."\n";
9736: $numunused ++;
9737: $delidx ++;
1.987 raeburn 9738: }
9739: if ($upload_output) {
9740: $upload_output = &start_data_table().
9741: $upload_output.
9742: &end_data_table()."\n";
9743: }
1.1071 raeburn 9744: if ($modify_output) {
9745: $modify_output = &start_data_table().
9746: &start_data_table_header_row().
9747: '<th>'.&mt('File').'</th>'.
9748: '<th>'.&mt('Size (KB)').'</th>'.
9749: '<th>'.&mt('Modified').'</th>'.
9750: '<th>'.&mt('Upload replacement?').'</th>'.
9751: &end_data_table_header_row().
9752: $modify_output.
9753: &end_data_table()."\n";
9754: }
9755: if ($delete_output) {
9756: $delete_output = &start_data_table().
9757: &start_data_table_header_row().
9758: '<th>'.&mt('File').'</th>'.
9759: '<th>'.&mt('Size (KB)').'</th>'.
9760: '<th>'.&mt('Modified').'</th>'.
9761: '<th>'.&mt('Delete?').'</th>'.
9762: &end_data_table_header_row().
9763: $delete_output.
9764: &end_data_table()."\n";
9765: }
1.987 raeburn 9766: my $applies = 0;
9767: if ($numremref) {
9768: $applies ++;
9769: }
9770: if ($numinvalid) {
9771: $applies ++;
9772: }
9773: if ($numexisting) {
9774: $applies ++;
9775: }
1.1071 raeburn 9776: if ($counter || $numunused) {
1.987 raeburn 9777: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
9778: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 9779: $state.'<h3>'.$heading.'</h3>';
9780: if ($actionurl eq '/adm/dependencies') {
9781: if ($numnew) {
9782: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
9783: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
9784: $upload_output.'<br />'."\n";
9785: }
9786: if ($numexisting) {
9787: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
9788: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
9789: $modify_output.'<br />'."\n";
9790: $buttontext = &mt('Save changes');
9791: }
9792: if ($numunused) {
9793: $output .= '<h4>'.&mt('Unused files').'</h4>'.
9794: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
9795: $delete_output.'<br />'."\n";
9796: $buttontext = &mt('Save changes');
9797: }
9798: } else {
9799: $output .= $upload_output.'<br />'."\n";
9800: }
9801: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
9802: $counter.'" />'."\n";
9803: if ($actionurl eq '/adm/dependencies') {
9804: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
9805: $numnew.'" />'."\n";
9806: } elsif ($actionurl eq '') {
1.987 raeburn 9807: $output .= '<input type="hidden" name="phase" value="three" />';
9808: }
9809: } elsif ($applies) {
9810: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
9811: if ($applies > 1) {
9812: $output .=
9813: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
9814: if ($numremref) {
9815: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
9816: }
9817: if ($numinvalid) {
9818: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
9819: }
9820: if ($numexisting) {
9821: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
9822: }
9823: $output .= '</ul><br />';
9824: } elsif ($numremref) {
9825: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
9826: } elsif ($numinvalid) {
9827: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
9828: } elsif ($numexisting) {
9829: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
9830: }
9831: $output .= $upload_output.'<br />';
9832: }
9833: my ($pathchange_output,$chgcount);
1.1071 raeburn 9834: $chgcount = $counter;
1.987 raeburn 9835: if (keys(%pathchanges) > 0) {
9836: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 9837: if ($counter) {
1.987 raeburn 9838: $output .= &embedded_file_element('pathchange',$chgcount,
9839: $embed_file,\%mapping,
1.1071 raeburn 9840: $allfiles,$codebase,'change');
1.987 raeburn 9841: } else {
9842: $pathchange_output .=
9843: &start_data_table_row().
9844: '<td><input type ="checkbox" name="namechange" value="'.
9845: $chgcount.'" checked="checked" /></td>'.
9846: '<td>'.$mapping{$embed_file}.'</td>'.
9847: '<td>'.$embed_file.
9848: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 9849: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 9850: '</td>'.&end_data_table_row();
1.660 raeburn 9851: }
1.987 raeburn 9852: $numpathchg ++;
9853: $chgcount ++;
1.660 raeburn 9854: }
9855: }
1.1071 raeburn 9856: if ($counter) {
1.987 raeburn 9857: if ($numpathchg) {
9858: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
9859: $numpathchg.'" />'."\n";
9860: }
9861: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
9862: ($actionurl eq '/adm/imsimport')) {
9863: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
9864: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
9865: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 9866: } elsif ($actionurl eq '/adm/dependencies') {
9867: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 9868: }
1.1071 raeburn 9869: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 9870: } elsif ($numpathchg) {
9871: my %pathchange = ();
9872: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
9873: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
9874: $output .= '<p>'.&mt('or').'</p>';
9875: }
9876: }
1.1071 raeburn 9877: return ($output,$counter,$numpathchg);
1.987 raeburn 9878: }
9879:
9880: sub embedded_file_element {
1.1071 raeburn 9881: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 9882: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
9883: (ref($codebase) eq 'HASH'));
9884: my $output;
1.1071 raeburn 9885: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 9886: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
9887: }
9888: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
9889: &escape($embed_file).'" />';
9890: unless (($context eq 'upload_embedded') &&
9891: ($mapping->{$embed_file} eq $embed_file)) {
9892: $output .='
9893: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
9894: }
9895: my $attrib;
9896: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
9897: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
9898: }
9899: $output .=
9900: "\n\t\t".
9901: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
9902: $attrib.'" />';
9903: if (exists($codebase->{$mapping->{$embed_file}})) {
9904: $output .=
9905: "\n\t\t".
9906: '<input name="codebase_'.$num.'" type="hidden" value="'.
9907: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 9908: }
1.987 raeburn 9909: return $output;
1.660 raeburn 9910: }
9911:
1.1071 raeburn 9912: sub get_dependency_details {
9913: my ($currfile,$currsubfile,$embed_file) = @_;
9914: my ($size,$mtime,$showsize,$showmtime);
9915: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
9916: if ($embed_file =~ m{/}) {
9917: my ($path,$fname) = split(/\//,$embed_file);
9918: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
9919: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
9920: }
9921: } else {
9922: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
9923: ($size,$mtime) = @{$currfile->{$embed_file}};
9924: }
9925: }
9926: $showsize = $size/1024.0;
9927: $showsize = sprintf("%.1f",$showsize);
9928: if ($mtime > 0) {
9929: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
9930: }
9931: }
9932: return ($showsize,$showmtime);
9933: }
9934:
9935: sub ask_embedded_js {
9936: return <<"END";
9937: <script type="text/javascript"">
9938: // <![CDATA[
9939: function toggleBrowse(counter) {
9940: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
9941: var fileid = document.getElementById('embedded_item_'+counter);
9942: var uploaddivid = document.getElementById('moduploaddep_'+counter);
9943: if (chkboxid.checked == true) {
9944: uploaddivid.style.display='block';
9945: } else {
9946: uploaddivid.style.display='none';
9947: fileid.value = '';
9948: }
9949: }
9950: // ]]>
9951: </script>
9952:
9953: END
9954: }
9955:
1.661 raeburn 9956: sub upload_embedded {
9957: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 9958: $current_disk_usage,$hiddenstate,$actionurl) = @_;
9959: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 9960: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
9961: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
9962: my $orig_uploaded_filename =
9963: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 9964: foreach my $type ('orig','ref','attrib','codebase') {
9965: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
9966: $env{'form.embedded_'.$type.'_'.$i} =
9967: &unescape($env{'form.embedded_'.$type.'_'.$i});
9968: }
9969: }
1.661 raeburn 9970: my ($path,$fname) =
9971: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
9972: # no path, whole string is fname
9973: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
9974: $fname = &Apache::lonnet::clean_filename($fname);
9975: # See if there is anything left
9976: next if ($fname eq '');
9977:
9978: # Check if file already exists as a file or directory.
9979: my ($state,$msg);
9980: if ($context eq 'portfolio') {
9981: my $port_path = $dirpath;
9982: if ($group ne '') {
9983: $port_path = "groups/$group/$port_path";
9984: }
1.987 raeburn 9985: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
9986: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 9987: $dir_root,$port_path,$disk_quota,
9988: $current_disk_usage,$uname,$udom);
9989: if ($state eq 'will_exceed_quota'
1.984 raeburn 9990: || $state eq 'file_locked') {
1.661 raeburn 9991: $output .= $msg;
9992: next;
9993: }
9994: } elsif (($context eq 'author') || ($context eq 'testbank')) {
9995: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
9996: if ($state eq 'exists') {
9997: $output .= $msg;
9998: next;
9999: }
10000: }
10001: # Check if extension is valid
10002: if (($fname =~ /\.(\w+)$/) &&
10003: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987 raeburn 10004: $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 10005: next;
10006: } elsif (($fname =~ /\.(\w+)$/) &&
10007: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 10008: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 10009: next;
10010: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987 raeburn 10011: $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 10012: next;
10013: }
10014: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
10015: if ($context eq 'portfolio') {
1.984 raeburn 10016: my $result;
10017: if ($state eq 'existingfile') {
10018: $result=
10019: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987 raeburn 10020: $dirpath.$env{'form.currentpath'}.$path);
1.661 raeburn 10021: } else {
1.984 raeburn 10022: $result=
10023: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 10024: $dirpath.
10025: $env{'form.currentpath'}.$path);
1.984 raeburn 10026: if ($result !~ m|^/uploaded/|) {
10027: $output .= '<span class="LC_error">'
10028: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10029: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10030: .'</span><br />';
10031: next;
10032: } else {
1.987 raeburn 10033: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10034: $path.$fname.'</span>').'<br />';
1.984 raeburn 10035: }
1.661 raeburn 10036: }
1.987 raeburn 10037: } elsif ($context eq 'coursedoc') {
10038: my $result =
10039: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
10040: $dirpath.'/'.$path);
10041: if ($result !~ m|^/uploaded/|) {
10042: $output .= '<span class="LC_error">'
10043: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
10044: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
10045: .'</span><br />';
10046: next;
10047: } else {
10048: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10049: $path.$fname.'</span>').'<br />';
10050: }
1.661 raeburn 10051: } else {
10052: # Save the file
10053: my $target = $env{'form.embedded_item_'.$i};
10054: my $fullpath = $dir_root.$dirpath.'/'.$path;
10055: my $dest = $fullpath.$fname;
10056: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 10057: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 10058: my $count;
10059: my $filepath = $dir_root;
1.1027 raeburn 10060: foreach my $subdir (@parts) {
10061: $filepath .= "/$subdir";
10062: if (!-e $filepath) {
1.661 raeburn 10063: mkdir($filepath,0770);
10064: }
10065: }
10066: my $fh;
10067: if (!open($fh,'>'.$dest)) {
10068: &Apache::lonnet::logthis('Failed to create '.$dest);
10069: $output .= '<span class="LC_error">'.
1.1071 raeburn 10070: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
10071: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10072: '</span><br />';
10073: } else {
10074: if (!print $fh $env{'form.embedded_item_'.$i}) {
10075: &Apache::lonnet::logthis('Failed to write to '.$dest);
10076: $output .= '<span class="LC_error">'.
1.1071 raeburn 10077: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
10078: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 10079: '</span><br />';
10080: } else {
1.987 raeburn 10081: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
10082: $url.'</span>').'<br />';
10083: unless ($context eq 'testbank') {
10084: $footer .= &mt('View embedded file: [_1]',
10085: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
10086: }
10087: }
10088: close($fh);
10089: }
10090: }
10091: if ($env{'form.embedded_ref_'.$i}) {
10092: $pathchange{$i} = 1;
10093: }
10094: }
10095: if ($output) {
10096: $output = '<p>'.$output.'</p>';
10097: }
10098: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
10099: $returnflag = 'ok';
1.1071 raeburn 10100: my $numpathchgs = scalar(keys(%pathchange));
10101: if ($numpathchgs > 0) {
1.987 raeburn 10102: if ($context eq 'portfolio') {
10103: $output .= '<p>'.&mt('or').'</p>';
10104: } elsif ($context eq 'testbank') {
1.1071 raeburn 10105: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
10106: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 10107: $returnflag = 'modify_orightml';
10108: }
10109: }
1.1071 raeburn 10110: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 10111: }
10112:
10113: sub modify_html_form {
10114: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
10115: my $end = 0;
10116: my $modifyform;
10117: if ($context eq 'upload_embedded') {
10118: return unless (ref($pathchange) eq 'HASH');
10119: if ($env{'form.number_embedded_items'}) {
10120: $end += $env{'form.number_embedded_items'};
10121: }
10122: if ($env{'form.number_pathchange_items'}) {
10123: $end += $env{'form.number_pathchange_items'};
10124: }
10125: if ($end) {
10126: for (my $i=0; $i<$end; $i++) {
10127: if ($i < $env{'form.number_embedded_items'}) {
10128: next unless($pathchange->{$i});
10129: }
10130: $modifyform .=
10131: &start_data_table_row().
10132: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
10133: 'checked="checked" /></td>'.
10134: '<td>'.$env{'form.embedded_ref_'.$i}.
10135: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
10136: &escape($env{'form.embedded_ref_'.$i}).'" />'.
10137: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
10138: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
10139: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
10140: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
10141: '<td>'.$env{'form.embedded_orig_'.$i}.
10142: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
10143: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
10144: &end_data_table_row();
1.1071 raeburn 10145: }
1.987 raeburn 10146: }
10147: } else {
10148: $modifyform = $pathchgtable;
10149: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
10150: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
10151: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
10152: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
10153: }
10154: }
10155: if ($modifyform) {
1.1071 raeburn 10156: if ($actionurl eq '/adm/dependencies') {
10157: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
10158: }
1.987 raeburn 10159: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
10160: '<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".
10161: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
10162: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
10163: '</ol></p>'."\n".'<p>'.
10164: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
10165: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
10166: &start_data_table()."\n".
10167: &start_data_table_header_row().
10168: '<th>'.&mt('Change?').'</th>'.
10169: '<th>'.&mt('Current reference').'</th>'.
10170: '<th>'.&mt('Required reference').'</th>'.
10171: &end_data_table_header_row()."\n".
10172: $modifyform.
10173: &end_data_table().'<br />'."\n".$hiddenstate.
10174: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
10175: '</form>'."\n";
10176: }
10177: return;
10178: }
10179:
10180: sub modify_html_refs {
10181: my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
10182: my $container;
10183: if ($context eq 'portfolio') {
10184: $container = $env{'form.container'};
10185: } elsif ($context eq 'coursedoc') {
10186: $container = $env{'form.primaryurl'};
1.1071 raeburn 10187: } elsif ($context eq 'manage_dependencies') {
10188: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
10189: $container = "/$container";
1.987 raeburn 10190: } else {
1.1027 raeburn 10191: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 10192: }
10193: my (%allfiles,%codebase,$output,$content);
10194: my @changes = &get_env_multiple('form.namechange');
1.1071 raeburn 10195: unless (@changes > 0) {
10196: if (wantarray) {
10197: return ('',0,0);
10198: } else {
10199: return;
10200: }
10201: }
10202: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10203: ($context eq 'manage_dependencies')) {
10204: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
10205: if (wantarray) {
10206: return ('',0,0);
10207: } else {
10208: return;
10209: }
10210: }
1.987 raeburn 10211: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 10212: if ($content eq '-1') {
10213: if (wantarray) {
10214: return ('',0,0);
10215: } else {
10216: return;
10217: }
10218: }
1.987 raeburn 10219: } else {
1.1071 raeburn 10220: unless ($container =~ /^\Q$dir_root\E/) {
10221: if (wantarray) {
10222: return ('',0,0);
10223: } else {
10224: return;
10225: }
10226: }
1.987 raeburn 10227: if (open(my $fh,"<$container")) {
10228: $content = join('', <$fh>);
10229: close($fh);
10230: } else {
1.1071 raeburn 10231: if (wantarray) {
10232: return ('',0,0);
10233: } else {
10234: return;
10235: }
1.987 raeburn 10236: }
10237: }
10238: my ($count,$codebasecount) = (0,0);
10239: my $mm = new File::MMagic;
10240: my $mime_type = $mm->checktype_contents($content);
10241: if ($mime_type eq 'text/html') {
10242: my $parse_result =
10243: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
10244: \%codebase,\$content);
10245: if ($parse_result eq 'ok') {
10246: foreach my $i (@changes) {
10247: my $orig = &unescape($env{'form.embedded_orig_'.$i});
10248: my $ref = &unescape($env{'form.embedded_ref_'.$i});
10249: if ($allfiles{$ref}) {
10250: my $newname = $orig;
10251: my ($attrib_regexp,$codebase);
1.1006 raeburn 10252: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 10253: if ($attrib_regexp =~ /:/) {
10254: $attrib_regexp =~ s/\:/|/g;
10255: }
10256: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
10257: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
10258: $count += $numchg;
10259: }
10260: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 10261: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 10262: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
10263: $codebasecount ++;
10264: }
10265: }
10266: }
10267: if ($count || $codebasecount) {
10268: my $saveresult;
1.1071 raeburn 10269: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
10270: ($context eq 'manage_dependencies')) {
1.987 raeburn 10271: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
10272: if ($url eq $container) {
10273: my ($fname) = ($container =~ m{/([^/]+)$});
10274: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10275: $count,'<span class="LC_filename">'.
1.1071 raeburn 10276: $fname.'</span>').'</p>';
1.987 raeburn 10277: } else {
10278: $output = '<p class="LC_error">'.
10279: &mt('Error: update failed for: [_1].',
10280: '<span class="LC_filename">'.
10281: $container.'</span>').'</p>';
10282: }
10283: } else {
10284: if (open(my $fh,">$container")) {
10285: print $fh $content;
10286: close($fh);
10287: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
10288: $count,'<span class="LC_filename">'.
10289: $container.'</span>').'</p>';
1.661 raeburn 10290: } else {
1.987 raeburn 10291: $output = '<p class="LC_error">'.
10292: &mt('Error: could not update [_1].',
10293: '<span class="LC_filename">'.
10294: $container.'</span>').'</p>';
1.661 raeburn 10295: }
10296: }
10297: }
1.987 raeburn 10298: } else {
10299: &logthis('Failed to parse '.$container.
10300: ' to modify references: '.$parse_result);
1.661 raeburn 10301: }
10302: }
1.1071 raeburn 10303: if (wantarray) {
10304: return ($output,$count,$codebasecount);
10305: } else {
10306: return $output;
10307: }
1.661 raeburn 10308: }
10309:
10310: sub check_for_existing {
10311: my ($path,$fname,$element) = @_;
10312: my ($state,$msg);
10313: if (-d $path.'/'.$fname) {
10314: $state = 'exists';
10315: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10316: } elsif (-e $path.'/'.$fname) {
10317: $state = 'exists';
10318: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
10319: }
10320: if ($state eq 'exists') {
10321: $msg = '<span class="LC_error">'.$msg.'</span><br />';
10322: }
10323: return ($state,$msg);
10324: }
10325:
10326: sub check_for_upload {
10327: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
10328: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 10329: my $filesize = length($env{'form.'.$element});
10330: if (!$filesize) {
10331: my $msg = '<span class="LC_error">'.
10332: &mt('Unable to upload [_1]. (size = [_2] bytes)',
10333: '<span class="LC_filename">'.$fname.'</span>',
10334: $filesize).'<br />'.
1.1007 raeburn 10335: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 10336: '</span>';
10337: return ('zero_bytes',$msg);
10338: }
10339: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 10340: my $getpropath = 1;
1.1021 raeburn 10341: my ($dirlistref,$listerror) =
10342: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 10343: my $found_file = 0;
10344: my $locked_file = 0;
1.991 raeburn 10345: my @lockers;
10346: my $navmap;
10347: if ($env{'request.course.id'}) {
10348: $navmap = Apache::lonnavmaps::navmap->new();
10349: }
1.1021 raeburn 10350: if (ref($dirlistref) eq 'ARRAY') {
10351: foreach my $line (@{$dirlistref}) {
10352: my ($file_name,$rest)=split(/\&/,$line,2);
10353: if ($file_name eq $fname){
10354: $file_name = $path.$file_name;
10355: if ($group ne '') {
10356: $file_name = $group.$file_name;
10357: }
10358: $found_file = 1;
10359: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
10360: foreach my $lock (@lockers) {
10361: if (ref($lock) eq 'ARRAY') {
10362: my ($symb,$crsid) = @{$lock};
10363: if ($crsid eq $env{'request.course.id'}) {
10364: if (ref($navmap)) {
10365: my $res = $navmap->getBySymb($symb);
10366: foreach my $part (@{$res->parts()}) {
10367: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
10368: unless (($slot_status == $res->RESERVED) ||
10369: ($slot_status == $res->RESERVED_LOCATION)) {
10370: $locked_file = 1;
10371: }
1.991 raeburn 10372: }
1.1021 raeburn 10373: } else {
10374: $locked_file = 1;
1.991 raeburn 10375: }
10376: } else {
10377: $locked_file = 1;
10378: }
10379: }
1.1021 raeburn 10380: }
10381: } else {
10382: my @info = split(/\&/,$rest);
10383: my $currsize = $info[6]/1000;
10384: if ($currsize < $filesize) {
10385: my $extra = $filesize - $currsize;
10386: if (($current_disk_usage + $extra) > $disk_quota) {
10387: my $msg = '<span class="LC_error">'.
10388: &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.',
10389: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
10390: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
10391: $disk_quota,$current_disk_usage);
10392: return ('will_exceed_quota',$msg);
10393: }
1.984 raeburn 10394: }
10395: }
1.661 raeburn 10396: }
10397: }
10398: }
10399: if (($current_disk_usage + $filesize) > $disk_quota){
10400: my $msg = '<span class="LC_error">'.
10401: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
10402: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
10403: return ('will_exceed_quota',$msg);
10404: } elsif ($found_file) {
10405: if ($locked_file) {
10406: my $msg = '<span class="LC_error">';
10407: $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>');
10408: $msg .= '</span><br />';
10409: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
10410: return ('file_locked',$msg);
10411: } else {
10412: my $msg = '<span class="LC_error">';
1.984 raeburn 10413: $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 10414: $msg .= '</span>';
1.984 raeburn 10415: return ('existingfile',$msg);
1.661 raeburn 10416: }
10417: }
10418: }
10419:
1.987 raeburn 10420: sub check_for_traversal {
10421: my ($path,$url,$toplevel) = @_;
10422: my @parts=split(/\//,$path);
10423: my $cleanpath;
10424: my $fullpath = $url;
10425: for (my $i=0;$i<@parts;$i++) {
10426: next if ($parts[$i] eq '.');
10427: if ($parts[$i] eq '..') {
10428: $fullpath =~ s{([^/]+/)$}{};
10429: } else {
10430: $fullpath .= $parts[$i].'/';
10431: }
10432: }
10433: if ($fullpath =~ /^\Q$url\E(.*)$/) {
10434: $cleanpath = $1;
10435: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
10436: my $curr_toprel = $1;
10437: my @parts = split(/\//,$curr_toprel);
10438: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
10439: my @urlparts = split(/\//,$url_toprel);
10440: my $doubledots;
10441: my $startdiff = -1;
10442: for (my $i=0; $i<@urlparts; $i++) {
10443: if ($startdiff == -1) {
10444: unless ($urlparts[$i] eq $parts[$i]) {
10445: $startdiff = $i;
10446: $doubledots .= '../';
10447: }
10448: } else {
10449: $doubledots .= '../';
10450: }
10451: }
10452: if ($startdiff > -1) {
10453: $cleanpath = $doubledots;
10454: for (my $i=$startdiff; $i<@parts; $i++) {
10455: $cleanpath .= $parts[$i].'/';
10456: }
10457: }
10458: }
10459: $cleanpath =~ s{(/)$}{};
10460: return $cleanpath;
10461: }
1.31 albertel 10462:
1.1053 raeburn 10463: sub is_archive_file {
10464: my ($mimetype) = @_;
10465: if (($mimetype eq 'application/octet-stream') ||
10466: ($mimetype eq 'application/x-stuffit') ||
10467: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
10468: return 1;
10469: }
10470: return;
10471: }
10472:
10473: sub decompress_form {
1.1065 raeburn 10474: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 10475: my %lt = &Apache::lonlocal::texthash (
10476: this => 'This file is an archive file.',
1.1067 raeburn 10477: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 10478: itsc => 'Its contents are as follows:',
1.1053 raeburn 10479: youm => 'You may wish to extract its contents.',
10480: extr => 'Extract contents',
1.1067 raeburn 10481: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
10482: proa => 'Process automatically?',
1.1053 raeburn 10483: yes => 'Yes',
10484: no => 'No',
1.1067 raeburn 10485: fold => 'Title for folder containing movie',
10486: movi => 'Title for page containing embedded movie',
1.1053 raeburn 10487: );
1.1065 raeburn 10488: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 10489: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 10490: my $info = &list_archive_contents($fileloc,\@paths);
10491: if (@paths) {
10492: foreach my $path (@paths) {
10493: $path =~ s{^/}{};
1.1067 raeburn 10494: if ($path =~ m{^([^/]+)/$}) {
10495: $topdir = $1;
10496: }
1.1065 raeburn 10497: if ($path =~ m{^([^/]+)/}) {
10498: $toplevel{$1} = $path;
10499: } else {
10500: $toplevel{$path} = $path;
10501: }
10502: }
10503: }
1.1067 raeburn 10504: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
10505: my @camtasia = ("$topdir/","$topdir/index.html",
10506: "$topdir/media/",
10507: "$topdir/media/$topdir.mp4",
10508: "$topdir/media/FirstFrame.png",
10509: "$topdir/media/player.swf",
10510: "$topdir/media/swfobject.js",
10511: "$topdir/media/expressInstall.swf");
10512: my @diffs = &compare_arrays(\@paths,\@camtasia);
10513: if (@diffs == 0) {
10514: $is_camtasia = 1;
10515: }
10516: }
10517: my $output;
10518: if ($is_camtasia) {
10519: $output = <<"ENDCAM";
10520: <script type="text/javascript" language="Javascript">
10521: // <![CDATA[
10522:
10523: function camtasiaToggle() {
10524: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
10525: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
10526: if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
10527:
10528: document.getElementById('camtasia_titles').style.display='block';
10529: } else {
10530: document.getElementById('camtasia_titles').style.display='none';
10531: }
10532: }
10533: }
10534: return;
10535: }
10536:
10537: // ]]>
10538: </script>
10539: <p>$lt{'camt'}</p>
10540: ENDCAM
1.1065 raeburn 10541: } else {
1.1067 raeburn 10542: $output = '<p>'.$lt{'this'};
10543: if ($info eq '') {
10544: $output .= ' '.$lt{'youm'}.'</p>'."\n";
10545: } else {
10546: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
10547: '<div><pre>'.$info.'</pre></div>';
10548: }
1.1065 raeburn 10549: }
1.1067 raeburn 10550: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 10551: my $duplicates;
10552: my $num = 0;
10553: if (ref($dirlist) eq 'ARRAY') {
10554: foreach my $item (@{$dirlist}) {
10555: if (ref($item) eq 'ARRAY') {
10556: if (exists($toplevel{$item->[0]})) {
10557: $duplicates .=
10558: &start_data_table_row().
10559: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
10560: 'value="0" checked="checked" />'.&mt('No').'</label>'.
10561: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
10562: 'value="1" />'.&mt('Yes').'</label>'.
10563: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
10564: '<td>'.$item->[0].'</td>';
10565: if ($item->[2]) {
10566: $duplicates .= '<td>'.&mt('Directory').'</td>';
10567: } else {
10568: $duplicates .= '<td>'.&mt('File').'</td>';
10569: }
10570: $duplicates .= '<td>'.$item->[3].'</td>'.
10571: '<td>'.
10572: &Apache::lonlocal::locallocaltime($item->[4]).
10573: '</td>'.
10574: &end_data_table_row();
10575: $num ++;
10576: }
10577: }
10578: }
10579: }
10580: my $itemcount;
10581: if (@paths > 0) {
10582: $itemcount = scalar(@paths);
10583: } else {
10584: $itemcount = 1;
10585: }
1.1067 raeburn 10586: if ($is_camtasia) {
10587: $output .= $lt{'auto'}.'<br />'.
10588: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
10589: '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
10590: $lt{'yes'}.'</label> <label>'.
10591: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
10592: $lt{'no'}.'</label></span><br />'.
10593: '<div id="camtasia_titles" style="display:block">'.
10594: &Apache::lonhtmlcommon::start_pick_box().
10595: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
10596: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
10597: &Apache::lonhtmlcommon::row_closure().
10598: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
10599: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
10600: &Apache::lonhtmlcommon::row_closure(1).
10601: &Apache::lonhtmlcommon::end_pick_box().
10602: '</div>';
10603: }
1.1065 raeburn 10604: $output .=
10605: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 10606: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
10607: "\n";
1.1065 raeburn 10608: if ($duplicates ne '') {
10609: $output .= '<p><span class="LC_warning">'.
10610: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
10611: &start_data_table().
10612: &start_data_table_header_row().
10613: '<th>'.&mt('Overwrite?').'</th>'.
10614: '<th>'.&mt('Name').'</th>'.
10615: '<th>'.&mt('Type').'</th>'.
10616: '<th>'.&mt('Size').'</th>'.
10617: '<th>'.&mt('Last modified').'</th>'.
10618: &end_data_table_header_row().
10619: $duplicates.
10620: &end_data_table().
10621: '</p>';
10622: }
1.1067 raeburn 10623: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 10624: if (ref($hiddenelements) eq 'HASH') {
10625: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
10626: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
10627: }
10628: }
10629: $output .= <<"END";
1.1067 raeburn 10630: <br />
1.1053 raeburn 10631: <input type="submit" name="decompress" value="$lt{'extr'}" />
10632: </form>
10633: $noextract
10634: END
10635: return $output;
10636: }
10637:
1.1065 raeburn 10638: sub decompression_utility {
10639: my ($program) = @_;
10640: my @utilities = ('tar','gunzip','bunzip2','unzip');
10641: my $location;
10642: if (grep(/^\Q$program\E$/,@utilities)) {
10643: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
10644: '/usr/sbin/') {
10645: if (-x $dir.$program) {
10646: $location = $dir.$program;
10647: last;
10648: }
10649: }
10650: }
10651: return $location;
10652: }
10653:
10654: sub list_archive_contents {
10655: my ($file,$pathsref) = @_;
10656: my (@cmd,$output);
10657: my $needsregexp;
10658: if ($file =~ /\.zip$/) {
10659: @cmd = (&decompression_utility('unzip'),"-l");
10660: $needsregexp = 1;
10661: } elsif (($file =~ m/\.tar\.gz$/) ||
10662: ($file =~ /\.tgz$/)) {
10663: @cmd = (&decompression_utility('tar'),"-ztf");
10664: } elsif ($file =~ /\.tar\.bz2$/) {
10665: @cmd = (&decompression_utility('tar'),"-jtf");
10666: } elsif ($file =~ m|\.tar$|) {
10667: @cmd = (&decompression_utility('tar'),"-tf");
10668: }
10669: if (@cmd) {
10670: undef($!);
10671: undef($@);
10672: if (open(my $fh,"-|", @cmd, $file)) {
10673: while (my $line = <$fh>) {
10674: $output .= $line;
10675: chomp($line);
10676: my $item;
10677: if ($needsregexp) {
10678: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
10679: } else {
10680: $item = $line;
10681: }
10682: if ($item ne '') {
10683: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
10684: push(@{$pathsref},$item);
10685: }
10686: }
10687: }
10688: close($fh);
10689: }
10690: }
10691: return $output;
10692: }
10693:
1.1053 raeburn 10694: sub decompress_uploaded_file {
10695: my ($file,$dir) = @_;
10696: &Apache::lonnet::appenv({'cgi.file' => $file});
10697: &Apache::lonnet::appenv({'cgi.dir' => $dir});
10698: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
10699: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
10700: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
10701: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
10702: my $decompressed = $env{'cgi.decompressed'};
10703: &Apache::lonnet::delenv('cgi.file');
10704: &Apache::lonnet::delenv('cgi.dir');
10705: &Apache::lonnet::delenv('cgi.decompressed');
10706: return ($decompressed,$result);
10707: }
10708:
1.1055 raeburn 10709: sub process_decompression {
10710: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
10711: my ($dir,$error,$warning,$output);
10712: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
10713: $error = &mt('File name not a supported archive file type.').
10714: '<br />'.&mt('File name should end with one of: [_1].',
10715: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
10716: } else {
10717: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
10718: if ($docuhome eq 'no_host') {
10719: $error = &mt('Could not determine home server for course.');
10720: } else {
10721: my @ids=&Apache::lonnet::current_machine_ids();
10722: my $currdir = "$dir_root/$destination";
10723: if (grep(/^\Q$docuhome\E$/,@ids)) {
10724: $dir = &LONCAPA::propath($docudom,$docuname).
10725: "$dir_root/$destination";
10726: } else {
10727: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
10728: "$dir_root/$docudom/$docuname/$destination";
10729: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
10730: $error = &mt('Archive file not found.');
10731: }
10732: }
1.1065 raeburn 10733: my (@to_overwrite,@to_skip);
10734: if ($env{'form.archive_overwrite_total'} > 0) {
10735: my $total = $env{'form.archive_overwrite_total'};
10736: for (my $i=0; $i<$total; $i++) {
10737: if ($env{'form.archive_overwrite_'.$i} == 1) {
10738: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
10739: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
10740: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
10741: }
10742: }
10743: }
10744: my $numskip = scalar(@to_skip);
10745: if (($numskip > 0) &&
10746: ($numskip == $env{'form.archive_itemcount'})) {
10747: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
10748: } elsif ($dir eq '') {
1.1055 raeburn 10749: $error = &mt('Directory containing archive file unavailable.');
10750: } elsif (!$error) {
1.1065 raeburn 10751: my ($decompressed,$display);
10752: if ($numskip > 0) {
10753: my $tempdir = time.'_'.$$.int(rand(10000));
10754: mkdir("$dir/$tempdir",0755);
10755: system("mv $dir/$file $dir/$tempdir/$file");
10756: ($decompressed,$display) =
10757: &decompress_uploaded_file($file,"$dir/$tempdir");
10758: foreach my $item (@to_skip) {
10759: if (($item ne '') && ($item !~ /\.\./)) {
10760: if (-f "$dir/$tempdir/$item") {
10761: unlink("$dir/$tempdir/$item");
10762: } elsif (-d "$dir/$tempdir/$item") {
10763: system("rm -rf $dir/$tempdir/$item");
10764: }
10765: }
10766: }
10767: system("mv $dir/$tempdir/* $dir");
10768: rmdir("$dir/$tempdir");
10769: } else {
10770: ($decompressed,$display) =
10771: &decompress_uploaded_file($file,$dir);
10772: }
1.1055 raeburn 10773: if ($decompressed eq 'ok') {
1.1065 raeburn 10774: $output = '<p class="LC_info">'.
10775: &mt('Files extracted successfully from archive.').
10776: '</p>'."\n";
1.1055 raeburn 10777: my ($warning,$result,@contents);
10778: my ($newdirlistref,$newlisterror) =
10779: &Apache::lonnet::dirlist($currdir,$docudom,
10780: $docuname,1);
10781: my (%is_dir,%changes,@newitems);
10782: my $dirptr = 16384;
1.1065 raeburn 10783: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 10784: foreach my $dir_line (@{$newdirlistref}) {
10785: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065 raeburn 10786: unless (($item =~ /^\.+$/) || ($item eq $file) ||
10787: ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055 raeburn 10788: push(@newitems,$item);
10789: if ($dirptr&$testdir) {
10790: $is_dir{$item} = 1;
10791: }
10792: $changes{$item} = 1;
10793: }
10794: }
10795: }
10796: if (keys(%changes) > 0) {
10797: foreach my $item (sort(@newitems)) {
10798: if ($changes{$item}) {
10799: push(@contents,$item);
10800: }
10801: }
10802: }
10803: if (@contents > 0) {
1.1067 raeburn 10804: my $wantform;
10805: unless ($env{'form.autoextract_camtasia'}) {
10806: $wantform = 1;
10807: }
1.1056 raeburn 10808: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 10809: my ($count,$datatable) = &get_extracted($docudom,$docuname,
10810: $currdir,\%is_dir,
10811: \%children,\%parent,
1.1056 raeburn 10812: \@contents,\%dirorder,
10813: \%titles,$wantform);
1.1055 raeburn 10814: if ($datatable ne '') {
10815: $output .= &archive_options_form('decompressed',$datatable,
10816: $count,$hiddenelem);
1.1065 raeburn 10817: my $startcount = 6;
1.1055 raeburn 10818: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 10819: \%titles,\%children);
1.1055 raeburn 10820: }
1.1067 raeburn 10821: if ($env{'form.autoextract_camtasia'}) {
10822: my %displayed;
10823: my $total = 1;
10824: $env{'form.archive_directory'} = [];
10825: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
10826: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
10827: $path =~ s{/$}{};
10828: my $item;
10829: if ($path ne '') {
10830: $item = "$path/$titles{$i}";
10831: } else {
10832: $item = $titles{$i};
10833: }
10834: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
10835: if ($item eq $contents[0]) {
10836: push(@{$env{'form.archive_directory'}},$i);
10837: $env{'form.archive_'.$i} = 'display';
10838: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
10839: $displayed{'folder'} = $i;
10840: } elsif ($item eq "$contents[0]/index.html") {
10841: $env{'form.archive_'.$i} = 'display';
10842: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
10843: $displayed{'web'} = $i;
10844: } else {
10845: if ($item eq "$contents[0]/media") {
10846: push(@{$env{'form.archive_directory'}},$i);
10847: }
10848: $env{'form.archive_'.$i} = 'dependency';
10849: }
10850: $total ++;
10851: }
10852: for (my $i=1; $i<$total; $i++) {
10853: next if ($i == $displayed{'web'});
10854: next if ($i == $displayed{'folder'});
10855: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
10856: }
10857: $env{'form.phase'} = 'decompress_cleanup';
10858: $env{'form.archivedelete'} = 1;
10859: $env{'form.archive_count'} = $total-1;
10860: $output .=
10861: &process_extracted_files('coursedocs',$docudom,
10862: $docuname,$destination,
10863: $dir_root,$hiddenelem);
10864: }
1.1055 raeburn 10865: } else {
10866: $warning = &mt('No new items extracted from archive file.');
10867: }
10868: } else {
10869: $output = $display;
10870: $error = &mt('An error occurred during extraction from the archive file.');
10871: }
10872: }
10873: }
10874: }
10875: if ($error) {
10876: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
10877: $error.'</p>'."\n";
10878: }
10879: if ($warning) {
10880: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
10881: }
10882: return $output;
10883: }
10884:
10885: sub get_extracted {
1.1056 raeburn 10886: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
10887: $titles,$wantform) = @_;
1.1055 raeburn 10888: my $count = 0;
10889: my $depth = 0;
10890: my $datatable;
1.1056 raeburn 10891: my @hierarchy;
1.1055 raeburn 10892: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 10893: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
10894: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 10895: foreach my $item (@{$contents}) {
10896: $count ++;
1.1056 raeburn 10897: @{$dirorder->{$count}} = @hierarchy;
10898: $titles->{$count} = $item;
1.1055 raeburn 10899: &archive_hierarchy($depth,$count,$parent,$children);
10900: if ($wantform) {
10901: $datatable .= &archive_row($is_dir->{$item},$item,
10902: $currdir,$depth,$count);
10903: }
10904: if ($is_dir->{$item}) {
10905: $depth ++;
1.1056 raeburn 10906: push(@hierarchy,$count);
10907: $parent->{$depth} = $count;
1.1055 raeburn 10908: $datatable .=
10909: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 10910: \$depth,\$count,\@hierarchy,$dirorder,
10911: $children,$parent,$titles,$wantform);
1.1055 raeburn 10912: $depth --;
1.1056 raeburn 10913: pop(@hierarchy);
1.1055 raeburn 10914: }
10915: }
10916: return ($count,$datatable);
10917: }
10918:
10919: sub recurse_extracted_archive {
1.1056 raeburn 10920: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
10921: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 10922: my $result='';
1.1056 raeburn 10923: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
10924: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
10925: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 10926: return $result;
10927: }
10928: my $dirptr = 16384;
10929: my ($newdirlistref,$newlisterror) =
10930: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
10931: if (ref($newdirlistref) eq 'ARRAY') {
10932: foreach my $dir_line (@{$newdirlistref}) {
10933: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
10934: unless ($item =~ /^\.+$/) {
10935: $$count ++;
1.1056 raeburn 10936: @{$dirorder->{$$count}} = @{$hierarchy};
10937: $titles->{$$count} = $item;
1.1055 raeburn 10938: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 10939:
1.1055 raeburn 10940: my $is_dir;
10941: if ($dirptr&$testdir) {
10942: $is_dir = 1;
10943: }
10944: if ($wantform) {
10945: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
10946: }
10947: if ($is_dir) {
10948: $$depth ++;
1.1056 raeburn 10949: push(@{$hierarchy},$$count);
10950: $parent->{$$depth} = $$count;
1.1055 raeburn 10951: $result .=
10952: &recurse_extracted_archive("$currdir/$item",$docudom,
10953: $docuname,$depth,$count,
1.1056 raeburn 10954: $hierarchy,$dirorder,$children,
10955: $parent,$titles,$wantform);
1.1055 raeburn 10956: $$depth --;
1.1056 raeburn 10957: pop(@{$hierarchy});
1.1055 raeburn 10958: }
10959: }
10960: }
10961: }
10962: return $result;
10963: }
10964:
10965: sub archive_hierarchy {
10966: my ($depth,$count,$parent,$children) =@_;
10967: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
10968: if (exists($parent->{$depth})) {
10969: $children->{$parent->{$depth}} .= $count.':';
10970: }
10971: }
10972: return;
10973: }
10974:
10975: sub archive_row {
10976: my ($is_dir,$item,$currdir,$depth,$count) = @_;
10977: my ($name) = ($item =~ m{([^/]+)$});
10978: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 10979: 'display' => 'Add as file',
1.1055 raeburn 10980: 'dependency' => 'Include as dependency',
10981: 'discard' => 'Discard',
10982: );
10983: if ($is_dir) {
1.1059 raeburn 10984: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 10985: }
1.1056 raeburn 10986: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
10987: my $offset = 0;
1.1055 raeburn 10988: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 10989: $offset ++;
1.1065 raeburn 10990: if ($action ne 'display') {
10991: $offset ++;
10992: }
1.1055 raeburn 10993: $output .= '<td><span class="LC_nobreak">'.
10994: '<label><input type="radio" name="archive_'.$count.
10995: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
10996: my $text = $choices{$action};
10997: if ($is_dir) {
10998: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
10999: if ($action eq 'display') {
1.1059 raeburn 11000: $text = &mt('Add as folder');
1.1055 raeburn 11001: }
1.1056 raeburn 11002: } else {
11003: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
11004:
11005: }
11006: $output .= ' /> '.$choices{$action}.'</label></span>';
11007: if ($action eq 'dependency') {
11008: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
11009: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
11010: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
11011: '<option value=""></option>'."\n".
11012: '</select>'."\n".
11013: '</div>';
1.1059 raeburn 11014: } elsif ($action eq 'display') {
11015: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
11016: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
11017: '</div>';
1.1055 raeburn 11018: }
1.1056 raeburn 11019: $output .= '</td>';
1.1055 raeburn 11020: }
11021: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
11022: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
11023: for (my $i=0; $i<$depth; $i++) {
11024: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
11025: }
11026: if ($is_dir) {
11027: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
11028: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
11029: } else {
11030: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
11031: }
11032: $output .= ' '.$name.'</td>'."\n".
11033: &end_data_table_row();
11034: return $output;
11035: }
11036:
11037: sub archive_options_form {
1.1065 raeburn 11038: my ($form,$display,$count,$hiddenelem) = @_;
11039: my %lt = &Apache::lonlocal::texthash(
11040: perm => 'Permanently remove archive file?',
11041: hows => 'How should each extracted item be incorporated in the course?',
11042: cont => 'Content actions for all',
11043: addf => 'Add as folder/file',
11044: incd => 'Include as dependency for a displayed file',
11045: disc => 'Discard',
11046: no => 'No',
11047: yes => 'Yes',
11048: save => 'Save',
11049: );
11050: my $output = <<"END";
11051: <form name="$form" method="post" action="">
11052: <p><span class="LC_nobreak">$lt{'perm'}
11053: <label>
11054: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
11055: </label>
11056:
11057: <label>
11058: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
11059: </span>
11060: </p>
11061: <input type="hidden" name="phase" value="decompress_cleanup" />
11062: <br />$lt{'hows'}
11063: <div class="LC_columnSection">
11064: <fieldset>
11065: <legend>$lt{'cont'}</legend>
11066: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
11067: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
11068: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
11069: </fieldset>
11070: </div>
11071: END
11072: return $output.
1.1055 raeburn 11073: &start_data_table()."\n".
1.1065 raeburn 11074: $display."\n".
1.1055 raeburn 11075: &end_data_table()."\n".
11076: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
11077: $hiddenelem.
1.1065 raeburn 11078: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 11079: '</form>';
11080: }
11081:
11082: sub archive_javascript {
1.1056 raeburn 11083: my ($startcount,$numitems,$titles,$children) = @_;
11084: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 11085: my $maintitle = $env{'form.comment'};
1.1055 raeburn 11086: my $scripttag = <<START;
11087: <script type="text/javascript">
11088: // <![CDATA[
11089:
11090: function checkAll(form,prefix) {
11091: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
11092: for (var i=0; i < form.elements.length; i++) {
11093: var id = form.elements[i].id;
11094: if ((id != '') && (id != undefined)) {
11095: if (idstr.test(id)) {
11096: if (form.elements[i].type == 'radio') {
11097: form.elements[i].checked = true;
1.1056 raeburn 11098: var nostart = i-$startcount;
1.1059 raeburn 11099: var offset = nostart%7;
11100: var count = (nostart-offset)/7;
1.1056 raeburn 11101: dependencyCheck(form,count,offset);
1.1055 raeburn 11102: }
11103: }
11104: }
11105: }
11106: }
11107:
11108: function propagateCheck(form,count) {
11109: if (count > 0) {
1.1059 raeburn 11110: var startelement = $startcount + ((count-1) * 7);
11111: for (var j=1; j<6; j++) {
11112: if ((j != 2) && (j != 4)) {
1.1056 raeburn 11113: var item = startelement + j;
11114: if (form.elements[item].type == 'radio') {
11115: if (form.elements[item].checked) {
11116: containerCheck(form,count,j);
11117: break;
11118: }
1.1055 raeburn 11119: }
11120: }
11121: }
11122: }
11123: }
11124:
11125: numitems = $numitems
1.1056 raeburn 11126: var titles = new Array(numitems);
11127: var parents = new Array(numitems);
1.1055 raeburn 11128: for (var i=0; i<numitems; i++) {
1.1056 raeburn 11129: parents[i] = new Array;
1.1055 raeburn 11130: }
1.1059 raeburn 11131: var maintitle = '$maintitle';
1.1055 raeburn 11132:
11133: START
11134:
1.1056 raeburn 11135: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
11136: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 11137: for (my $i=0; $i<@contents; $i ++) {
11138: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
11139: }
11140: }
11141:
1.1056 raeburn 11142: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
11143: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
11144: }
11145:
1.1055 raeburn 11146: $scripttag .= <<END;
11147:
11148: function containerCheck(form,count,offset) {
11149: if (count > 0) {
1.1056 raeburn 11150: dependencyCheck(form,count,offset);
1.1059 raeburn 11151: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 11152: form.elements[item].checked = true;
11153: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
11154: if (parents[count].length > 0) {
11155: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 11156: containerCheck(form,parents[count][j],offset);
11157: }
11158: }
11159: }
11160: }
11161: }
11162:
11163: function dependencyCheck(form,count,offset) {
11164: if (count > 0) {
1.1059 raeburn 11165: var chosen = (offset+$startcount)+7*(count-1);
11166: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 11167: var currtype = form.elements[depitem].type;
11168: if (form.elements[chosen].value == 'dependency') {
11169: document.getElementById('arc_depon_'+count).style.display='block';
11170: form.elements[depitem].options.length = 0;
11171: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11 raeburn 11172: for (var i=1; i<=numitems; i++) {
11173: if (i == count) {
11174: continue;
11175: }
1.1059 raeburn 11176: var startelement = $startcount + (i-1) * 7;
11177: for (var j=1; j<6; j++) {
11178: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 11179: var item = startelement + j;
11180: if (form.elements[item].type == 'radio') {
11181: if (form.elements[item].checked) {
11182: if (form.elements[item].value == 'display') {
11183: var n = form.elements[depitem].options.length;
11184: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
11185: }
11186: }
11187: }
11188: }
11189: }
11190: }
11191: } else {
11192: document.getElementById('arc_depon_'+count).style.display='none';
11193: form.elements[depitem].options.length = 0;
11194: form.elements[depitem].options[0] = new Option('Select','',true,true);
11195: }
1.1059 raeburn 11196: titleCheck(form,count,offset);
1.1056 raeburn 11197: }
11198: }
11199:
11200: function propagateSelect(form,count,offset) {
11201: if (count > 0) {
1.1065 raeburn 11202: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 11203: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
11204: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11205: if (parents[count].length > 0) {
11206: for (var j=0; j<parents[count].length; j++) {
11207: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 11208: }
11209: }
11210: }
11211: }
11212: }
1.1056 raeburn 11213:
11214: function containerSelect(form,count,offset,picked) {
11215: if (count > 0) {
1.1065 raeburn 11216: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 11217: if (form.elements[item].type == 'radio') {
11218: if (form.elements[item].value == 'dependency') {
11219: if (form.elements[item+1].type == 'select-one') {
11220: for (var i=0; i<form.elements[item+1].options.length; i++) {
11221: if (form.elements[item+1].options[i].value == picked) {
11222: form.elements[item+1].selectedIndex = i;
11223: break;
11224: }
11225: }
11226: }
11227: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
11228: if (parents[count].length > 0) {
11229: for (var j=0; j<parents[count].length; j++) {
11230: containerSelect(form,parents[count][j],offset,picked);
11231: }
11232: }
11233: }
11234: }
11235: }
11236: }
11237: }
11238:
1.1059 raeburn 11239: function titleCheck(form,count,offset) {
11240: if (count > 0) {
11241: var chosen = (offset+$startcount)+7*(count-1);
11242: var depitem = $startcount + ((count-1) * 7) + 2;
11243: var currtype = form.elements[depitem].type;
11244: if (form.elements[chosen].value == 'display') {
11245: document.getElementById('arc_title_'+count).style.display='block';
11246: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
11247: document.getElementById('archive_title_'+count).value=maintitle;
11248: }
11249: } else {
11250: document.getElementById('arc_title_'+count).style.display='none';
11251: if (currtype == 'text') {
11252: document.getElementById('archive_title_'+count).value='';
11253: }
11254: }
11255: }
11256: return;
11257: }
11258:
1.1055 raeburn 11259: // ]]>
11260: </script>
11261: END
11262: return $scripttag;
11263: }
11264:
11265: sub process_extracted_files {
1.1067 raeburn 11266: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 11267: my $numitems = $env{'form.archive_count'};
11268: return unless ($numitems);
11269: my @ids=&Apache::lonnet::current_machine_ids();
11270: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 11271: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 11272: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
11273: if (grep(/^\Q$docuhome\E$/,@ids)) {
11274: $prefix = &LONCAPA::propath($docudom,$docuname);
11275: $pathtocheck = "$dir_root/$destination";
11276: $dir = $dir_root;
11277: $ishome = 1;
11278: } else {
11279: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
11280: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
11281: $dir = "$dir_root/$docudom/$docuname";
11282: }
11283: my $currdir = "$dir_root/$destination";
11284: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
11285: if ($env{'form.folderpath'}) {
11286: my @items = split('&',$env{'form.folderpath'});
11287: $folders{'0'} = $items[-2];
11288: $containers{'0'}='sequence';
11289: } elsif ($env{'form.pagepath'}) {
11290: my @items = split('&',$env{'form.pagepath'});
11291: $folders{'0'} = $items[-2];
11292: $containers{'0'}='page';
11293: }
11294: my @archdirs = &get_env_multiple('form.archive_directory');
11295: if ($numitems) {
11296: for (my $i=1; $i<=$numitems; $i++) {
11297: my $path = $env{'form.archive_content_'.$i};
11298: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
11299: my $item = $1;
11300: $toplevelitems{$item} = $i;
11301: if (grep(/^\Q$i\E$/,@archdirs)) {
11302: $is_dir{$item} = 1;
11303: }
11304: }
11305: }
11306: }
1.1067 raeburn 11307: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 11308: if (keys(%toplevelitems) > 0) {
11309: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 11310: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
11311: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 11312: }
1.1066 raeburn 11313: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 11314: if ($numitems) {
11315: for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11 raeburn 11316: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 11317: my $path = $env{'form.archive_content_'.$i};
11318: if ($path =~ /^\Q$pathtocheck\E/) {
11319: if ($env{'form.archive_'.$i} eq 'discard') {
11320: if ($prefix ne '' && $path ne '') {
11321: if (-e $prefix.$path) {
1.1066 raeburn 11322: if ((@archdirs > 0) &&
11323: (grep(/^\Q$i\E$/,@archdirs))) {
11324: $todeletedir{$prefix.$path} = 1;
11325: } else {
11326: $todelete{$prefix.$path} = 1;
11327: }
1.1055 raeburn 11328: }
11329: }
11330: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 11331: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 11332: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 11333: $docstitle = $env{'form.archive_title_'.$i};
11334: if ($docstitle eq '') {
11335: $docstitle = $title;
11336: }
1.1055 raeburn 11337: $outer = 0;
1.1056 raeburn 11338: if (ref($dirorder{$i}) eq 'ARRAY') {
11339: if (@{$dirorder{$i}} > 0) {
11340: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 11341: if ($env{'form.archive_'.$item} eq 'display') {
11342: $outer = $item;
11343: last;
11344: }
11345: }
11346: }
11347: }
11348: my ($errtext,$fatal) =
11349: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
11350: '/'.$folders{$outer}.'.'.
11351: $containers{$outer});
11352: next if ($fatal);
11353: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
11354: if ($context eq 'coursedocs') {
1.1056 raeburn 11355: $mapinner{$i} = time;
1.1055 raeburn 11356: $folders{$i} = 'default_'.$mapinner{$i};
11357: $containers{$i} = 'sequence';
11358: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11359: $folders{$i}.'.'.$containers{$i};
11360: my $newidx = &LONCAPA::map::getresidx();
11361: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11362: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11363: push(@LONCAPA::map::order,$newidx);
11364: my ($outtext,$errtext) =
11365: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11366: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 11367: '.'.$containers{$outer},1,1);
1.1056 raeburn 11368: $newseqid{$i} = $newidx;
1.1067 raeburn 11369: unless ($errtext) {
11370: $result .= '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
11371: }
1.1055 raeburn 11372: }
11373: } else {
11374: if ($context eq 'coursedocs') {
11375: my $newidx=&LONCAPA::map::getresidx();
11376: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
11377: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
11378: $title;
11379: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
11380: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
11381: }
11382: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11383: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
11384: }
11385: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
11386: system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056 raeburn 11387: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067 raeburn 11388: unless ($ishome) {
11389: my $fetch = "$newdest{$i}/$title";
11390: $fetch =~ s/^\Q$prefix$dir\E//;
11391: $prompttofetch{$fetch} = 1;
11392: }
1.1055 raeburn 11393: }
11394: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 11395: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 11396: push(@LONCAPA::map::order, $newidx);
11397: my ($outtext,$errtext)=
11398: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
11399: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 11400: '.'.$containers{$outer},1,1);
1.1067 raeburn 11401: unless ($errtext) {
11402: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
11403: $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
11404: }
11405: }
1.1055 raeburn 11406: }
11407: }
1.1075.2.11 raeburn 11408: }
11409: } else {
11410: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
11411: }
11412: }
11413: for (my $i=1; $i<=$numitems; $i++) {
11414: next unless ($env{'form.archive_'.$i} eq 'dependency');
11415: my $path = $env{'form.archive_content_'.$i};
11416: if ($path =~ /^\Q$pathtocheck\E/) {
11417: my ($title) = ($path =~ m{/([^/]+)$});
11418: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
11419: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
11420: if (ref($dirorder{$i}) eq 'ARRAY') {
11421: my ($itemidx,$fullpath,$relpath);
11422: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
11423: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 11424: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11 raeburn 11425: if ($dirorder{$i}->[$j] eq $container) {
11426: $itemidx = $j;
1.1056 raeburn 11427: }
11428: }
1.1075.2.11 raeburn 11429: }
11430: if ($itemidx eq '') {
11431: $itemidx = 0;
11432: }
11433: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
11434: if ($mapinner{$referrer{$i}}) {
11435: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
11436: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11437: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11438: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11439: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11440: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11441: if (!-e $fullpath) {
11442: mkdir($fullpath,0755);
1.1056 raeburn 11443: }
11444: }
1.1075.2.11 raeburn 11445: } else {
11446: last;
1.1056 raeburn 11447: }
1.1075.2.11 raeburn 11448: }
11449: }
11450: } elsif ($newdest{$referrer{$i}}) {
11451: $fullpath = $newdest{$referrer{$i}};
11452: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
11453: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
11454: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
11455: last;
11456: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
11457: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
11458: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
11459: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
11460: if (!-e $fullpath) {
11461: mkdir($fullpath,0755);
1.1056 raeburn 11462: }
11463: }
1.1075.2.11 raeburn 11464: } else {
11465: last;
1.1056 raeburn 11466: }
1.1075.2.11 raeburn 11467: }
11468: }
11469: if ($fullpath ne '') {
11470: if (-e "$prefix$path") {
11471: system("mv $prefix$path $fullpath/$title");
11472: }
11473: if (-e "$fullpath/$title") {
11474: my $showpath;
11475: if ($relpath ne '') {
11476: $showpath = "$relpath/$title";
11477: } else {
11478: $showpath = "/$title";
1.1056 raeburn 11479: }
1.1075.2.11 raeburn 11480: $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
11481: }
11482: unless ($ishome) {
11483: my $fetch = "$fullpath/$title";
11484: $fetch =~ s/^\Q$prefix$dir\E//;
11485: $prompttofetch{$fetch} = 1;
1.1055 raeburn 11486: }
11487: }
11488: }
1.1075.2.11 raeburn 11489: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
11490: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
11491: $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055 raeburn 11492: }
11493: } else {
1.1075.2.11 raeburn 11494: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />';
1.1055 raeburn 11495: }
11496: }
11497: if (keys(%todelete)) {
11498: foreach my $key (keys(%todelete)) {
11499: unlink($key);
1.1066 raeburn 11500: }
11501: }
11502: if (keys(%todeletedir)) {
11503: foreach my $key (keys(%todeletedir)) {
11504: rmdir($key);
11505: }
11506: }
11507: foreach my $dir (sort(keys(%is_dir))) {
11508: if (($pathtocheck ne '') && ($dir ne '')) {
11509: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 11510: }
11511: }
1.1067 raeburn 11512: if ($result ne '') {
11513: $output .= '<ul>'."\n".
11514: $result."\n".
11515: '</ul>';
11516: }
11517: unless ($ishome) {
11518: my $replicationfail;
11519: foreach my $item (keys(%prompttofetch)) {
11520: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
11521: unless ($fetchresult eq 'ok') {
11522: $replicationfail .= '<li>'.$item.'</li>'."\n";
11523: }
11524: }
11525: if ($replicationfail) {
11526: $output .= '<p class="LC_error">'.
11527: &mt('Course home server failed to retrieve:').'<ul>'.
11528: $replicationfail.
11529: '</ul></p>';
11530: }
11531: }
1.1055 raeburn 11532: } else {
11533: $warning = &mt('No items found in archive.');
11534: }
11535: if ($error) {
11536: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
11537: $error.'</p>'."\n";
11538: }
11539: if ($warning) {
11540: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
11541: }
11542: return $output;
11543: }
11544:
1.1066 raeburn 11545: sub cleanup_empty_dirs {
11546: my ($path) = @_;
11547: if (($path ne '') && (-d $path)) {
11548: if (opendir(my $dirh,$path)) {
11549: my @dircontents = grep(!/^\./,readdir($dirh));
11550: my $numitems = 0;
11551: foreach my $item (@dircontents) {
11552: if (-d "$path/$item") {
11553: &recurse_dirs("$path/$item");
11554: if (-e "$path/$item") {
11555: $numitems ++;
11556: }
11557: } else {
11558: $numitems ++;
11559: }
11560: }
11561: if ($numitems == 0) {
11562: rmdir($path);
11563: }
11564: closedir($dirh);
11565: }
11566: }
11567: return;
11568: }
11569:
1.41 ng 11570: =pod
1.45 matthew 11571:
1.1068 raeburn 11572: =item &get_folder_hierarchy()
11573:
11574: Provides hierarchy of names of folders/sub-folders containing the current
11575: item,
11576:
11577: Inputs: 3
11578: - $navmap - navmaps object
11579:
11580: - $map - url for map (either the trigger itself, or map containing
11581: the resource, which is the trigger).
11582:
11583: - $showitem - 1 => show title for map itself; 0 => do not show.
11584:
11585: Outputs: 1 @pathitems - array of folder/subfolder names.
11586:
11587: =cut
11588:
11589: sub get_folder_hierarchy {
11590: my ($navmap,$map,$showitem) = @_;
11591: my @pathitems;
11592: if (ref($navmap)) {
11593: my $mapres = $navmap->getResourceByUrl($map);
11594: if (ref($mapres)) {
11595: my $pcslist = $mapres->map_hierarchy();
11596: if ($pcslist ne '') {
11597: my @pcs = split(/,/,$pcslist);
11598: foreach my $pc (@pcs) {
11599: if ($pc == 1) {
11600: push(@pathitems,&mt('Main Course Documents'));
11601: } else {
11602: my $res = $navmap->getByMapPc($pc);
11603: if (ref($res)) {
11604: my $title = $res->compTitle();
11605: $title =~ s/\W+/_/g;
11606: if ($title ne '') {
11607: push(@pathitems,$title);
11608: }
11609: }
11610: }
11611: }
11612: }
1.1071 raeburn 11613: if ($showitem) {
11614: if ($mapres->{ID} eq '0.0') {
11615: push(@pathitems,&mt('Main Course Documents'));
11616: } else {
11617: my $maptitle = $mapres->compTitle();
11618: $maptitle =~ s/\W+/_/g;
11619: if ($maptitle ne '') {
11620: push(@pathitems,$maptitle);
11621: }
1.1068 raeburn 11622: }
11623: }
11624: }
11625: }
11626: return @pathitems;
11627: }
11628:
11629: =pod
11630:
1.1015 raeburn 11631: =item * &get_turnedin_filepath()
11632:
11633: Determines path in a user's portfolio file for storage of files uploaded
11634: to a specific essayresponse or dropbox item.
11635:
11636: Inputs: 3 required + 1 optional.
11637: $symb is symb for resource, $uname and $udom are for current user (required).
11638: $caller is optional (can be "submission", if routine is called when storing
11639: an upoaded file when "Submit Answer" button was pressed).
11640:
11641: Returns array containing $path and $multiresp.
11642: $path is path in portfolio. $multiresp is 1 if this resource contains more
11643: than one file upload item. Callers of routine should append partid as a
11644: subdirectory to $path in cases where $multiresp is 1.
11645:
11646: Called by: homework/essayresponse.pm and homework/structuretags.pm
11647:
11648: =cut
11649:
11650: sub get_turnedin_filepath {
11651: my ($symb,$uname,$udom,$caller) = @_;
11652: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
11653: my $turnindir;
11654: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
11655: $turnindir = $userhash{'turnindir'};
11656: my ($path,$multiresp);
11657: if ($turnindir eq '') {
11658: if ($caller eq 'submission') {
11659: $turnindir = &mt('turned in');
11660: $turnindir =~ s/\W+/_/g;
11661: my %newhash = (
11662: 'turnindir' => $turnindir,
11663: );
11664: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
11665: }
11666: }
11667: if ($turnindir ne '') {
11668: $path = '/'.$turnindir.'/';
11669: my ($multipart,$turnin,@pathitems);
11670: my $navmap = Apache::lonnavmaps::navmap->new();
11671: if (defined($navmap)) {
11672: my $mapres = $navmap->getResourceByUrl($map);
11673: if (ref($mapres)) {
11674: my $pcslist = $mapres->map_hierarchy();
11675: if ($pcslist ne '') {
11676: foreach my $pc (split(/,/,$pcslist)) {
11677: my $res = $navmap->getByMapPc($pc);
11678: if (ref($res)) {
11679: my $title = $res->compTitle();
11680: $title =~ s/\W+/_/g;
11681: if ($title ne '') {
11682: push(@pathitems,$title);
11683: }
11684: }
11685: }
11686: }
11687: my $maptitle = $mapres->compTitle();
11688: $maptitle =~ s/\W+/_/g;
11689: if ($maptitle ne '') {
11690: push(@pathitems,$maptitle);
11691: }
11692: unless ($env{'request.state'} eq 'construct') {
11693: my $res = $navmap->getBySymb($symb);
11694: if (ref($res)) {
11695: my $partlist = $res->parts();
11696: my $totaluploads = 0;
11697: if (ref($partlist) eq 'ARRAY') {
11698: foreach my $part (@{$partlist}) {
11699: my @types = $res->responseType($part);
11700: my @ids = $res->responseIds($part);
11701: for (my $i=0; $i < scalar(@ids); $i++) {
11702: if ($types[$i] eq 'essay') {
11703: my $partid = $part.'_'.$ids[$i];
11704: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
11705: $totaluploads ++;
11706: }
11707: }
11708: }
11709: }
11710: if ($totaluploads > 1) {
11711: $multiresp = 1;
11712: }
11713: }
11714: }
11715: }
11716: } else {
11717: return;
11718: }
11719: } else {
11720: return;
11721: }
11722: my $restitle=&Apache::lonnet::gettitle($symb);
11723: $restitle =~ s/\W+/_/g;
11724: if ($restitle eq '') {
11725: $restitle = ($resurl =~ m{/[^/]+$});
11726: if ($restitle eq '') {
11727: $restitle = time;
11728: }
11729: }
11730: push(@pathitems,$restitle);
11731: $path .= join('/',@pathitems);
11732: }
11733: return ($path,$multiresp);
11734: }
11735:
11736: =pod
11737:
1.464 albertel 11738: =back
1.41 ng 11739:
1.112 bowersj2 11740: =head1 CSV Upload/Handling functions
1.38 albertel 11741:
1.41 ng 11742: =over 4
11743:
1.648 raeburn 11744: =item * &upfile_store($r)
1.41 ng 11745:
11746: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 11747: needs $env{'form.upfile'}
1.41 ng 11748: returns $datatoken to be put into hidden field
11749:
11750: =cut
1.31 albertel 11751:
11752: sub upfile_store {
11753: my $r=shift;
1.258 albertel 11754: $env{'form.upfile'}=~s/\r/\n/gs;
11755: $env{'form.upfile'}=~s/\f/\n/gs;
11756: $env{'form.upfile'}=~s/\n+/\n/gs;
11757: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 11758:
1.258 albertel 11759: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
11760: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 11761: {
1.158 raeburn 11762: my $datafile = $r->dir_config('lonDaemons').
11763: '/tmp/'.$datatoken.'.tmp';
11764: if ( open(my $fh,">$datafile") ) {
1.258 albertel 11765: print $fh $env{'form.upfile'};
1.158 raeburn 11766: close($fh);
11767: }
1.31 albertel 11768: }
11769: return $datatoken;
11770: }
11771:
1.56 matthew 11772: =pod
11773:
1.648 raeburn 11774: =item * &load_tmp_file($r)
1.41 ng 11775:
11776: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 11777: needs $env{'form.datatoken'},
11778: sets $env{'form.upfile'} to the contents of the file
1.41 ng 11779:
11780: =cut
1.31 albertel 11781:
11782: sub load_tmp_file {
11783: my $r=shift;
11784: my @studentdata=();
11785: {
1.158 raeburn 11786: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 11787: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 11788: if ( open(my $fh,"<$studentfile") ) {
11789: @studentdata=<$fh>;
11790: close($fh);
11791: }
1.31 albertel 11792: }
1.258 albertel 11793: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 11794: }
11795:
1.56 matthew 11796: =pod
11797:
1.648 raeburn 11798: =item * &upfile_record_sep()
1.41 ng 11799:
11800: Separate uploaded file into records
11801: returns array of records,
1.258 albertel 11802: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 11803:
11804: =cut
1.31 albertel 11805:
11806: sub upfile_record_sep {
1.258 albertel 11807: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 11808: } else {
1.248 albertel 11809: my @records;
1.258 albertel 11810: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 11811: if ($line=~/^\s*$/) { next; }
11812: push(@records,$line);
11813: }
11814: return @records;
1.31 albertel 11815: }
11816: }
11817:
1.56 matthew 11818: =pod
11819:
1.648 raeburn 11820: =item * &record_sep($record)
1.41 ng 11821:
1.258 albertel 11822: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 11823:
11824: =cut
11825:
1.263 www 11826: sub takeleft {
11827: my $index=shift;
11828: return substr('0000'.$index,-4,4);
11829: }
11830:
1.31 albertel 11831: sub record_sep {
11832: my $record=shift;
11833: my %components=();
1.258 albertel 11834: if ($env{'form.upfiletype'} eq 'xml') {
11835: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 11836: my $i=0;
1.356 albertel 11837: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 11838: $field=~s/^(\"|\')//;
11839: $field=~s/(\"|\')$//;
1.263 www 11840: $components{&takeleft($i)}=$field;
1.31 albertel 11841: $i++;
11842: }
1.258 albertel 11843: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 11844: my $i=0;
1.356 albertel 11845: foreach my $field (split(/\t/,$record)) {
1.31 albertel 11846: $field=~s/^(\"|\')//;
11847: $field=~s/(\"|\')$//;
1.263 www 11848: $components{&takeleft($i)}=$field;
1.31 albertel 11849: $i++;
11850: }
11851: } else {
1.561 www 11852: my $separator=',';
1.480 banghart 11853: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 11854: $separator=';';
1.480 banghart 11855: }
1.31 albertel 11856: my $i=0;
1.561 www 11857: # the character we are looking for to indicate the end of a quote or a record
11858: my $looking_for=$separator;
11859: # do not add the characters to the fields
11860: my $ignore=0;
11861: # we just encountered a separator (or the beginning of the record)
11862: my $just_found_separator=1;
11863: # store the field we are working on here
11864: my $field='';
11865: # work our way through all characters in record
11866: foreach my $character ($record=~/(.)/g) {
11867: if ($character eq $looking_for) {
11868: if ($character ne $separator) {
11869: # Found the end of a quote, again looking for separator
11870: $looking_for=$separator;
11871: $ignore=1;
11872: } else {
11873: # Found a separator, store away what we got
11874: $components{&takeleft($i)}=$field;
11875: $i++;
11876: $just_found_separator=1;
11877: $ignore=0;
11878: $field='';
11879: }
11880: next;
11881: }
11882: # single or double quotation marks after a separator indicate beginning of a quote
11883: # we are now looking for the end of the quote and need to ignore separators
11884: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
11885: $looking_for=$character;
11886: next;
11887: }
11888: # ignore would be true after we reached the end of a quote
11889: if ($ignore) { next; }
11890: if (($just_found_separator) && ($character=~/\s/)) { next; }
11891: $field.=$character;
11892: $just_found_separator=0;
1.31 albertel 11893: }
1.561 www 11894: # catch the very last entry, since we never encountered the separator
11895: $components{&takeleft($i)}=$field;
1.31 albertel 11896: }
11897: return %components;
11898: }
11899:
1.144 matthew 11900: ######################################################
11901: ######################################################
11902:
1.56 matthew 11903: =pod
11904:
1.648 raeburn 11905: =item * &upfile_select_html()
1.41 ng 11906:
1.144 matthew 11907: Return HTML code to select a file from the users machine and specify
11908: the file type.
1.41 ng 11909:
11910: =cut
11911:
1.144 matthew 11912: ######################################################
11913: ######################################################
1.31 albertel 11914: sub upfile_select_html {
1.144 matthew 11915: my %Types = (
11916: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 11917: semisv => &mt('Semicolon separated values'),
1.144 matthew 11918: space => &mt('Space separated'),
11919: tab => &mt('Tabulator separated'),
11920: # xml => &mt('HTML/XML'),
11921: );
11922: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 11923: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 11924: foreach my $type (sort(keys(%Types))) {
11925: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
11926: }
11927: $Str .= "</select>\n";
11928: return $Str;
1.31 albertel 11929: }
11930:
1.301 albertel 11931: sub get_samples {
11932: my ($records,$toget) = @_;
11933: my @samples=({});
11934: my $got=0;
11935: foreach my $rec (@$records) {
11936: my %temp = &record_sep($rec);
11937: if (! grep(/\S/, values(%temp))) { next; }
11938: if (%temp) {
11939: $samples[$got]=\%temp;
11940: $got++;
11941: if ($got == $toget) { last; }
11942: }
11943: }
11944: return \@samples;
11945: }
11946:
1.144 matthew 11947: ######################################################
11948: ######################################################
11949:
1.56 matthew 11950: =pod
11951:
1.648 raeburn 11952: =item * &csv_print_samples($r,$records)
1.41 ng 11953:
11954: Prints a table of sample values from each column uploaded $r is an
11955: Apache Request ref, $records is an arrayref from
11956: &Apache::loncommon::upfile_record_sep
11957:
11958: =cut
11959:
1.144 matthew 11960: ######################################################
11961: ######################################################
1.31 albertel 11962: sub csv_print_samples {
11963: my ($r,$records) = @_;
1.662 bisitz 11964: my $samples = &get_samples($records,5);
1.301 albertel 11965:
1.594 raeburn 11966: $r->print(&mt('Samples').'<br />'.&start_data_table().
11967: &start_data_table_header_row());
1.356 albertel 11968: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 11969: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 11970: $r->print(&end_data_table_header_row());
1.301 albertel 11971: foreach my $hash (@$samples) {
1.594 raeburn 11972: $r->print(&start_data_table_row());
1.356 albertel 11973: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 11974: $r->print('<td>');
1.356 albertel 11975: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 11976: $r->print('</td>');
11977: }
1.594 raeburn 11978: $r->print(&end_data_table_row());
1.31 albertel 11979: }
1.594 raeburn 11980: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 11981: }
11982:
1.144 matthew 11983: ######################################################
11984: ######################################################
11985:
1.56 matthew 11986: =pod
11987:
1.648 raeburn 11988: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 11989:
11990: Prints a table to create associations between values and table columns.
1.144 matthew 11991:
1.41 ng 11992: $r is an Apache Request ref,
11993: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 11994: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 11995:
11996: =cut
11997:
1.144 matthew 11998: ######################################################
11999: ######################################################
1.31 albertel 12000: sub csv_print_select_table {
12001: my ($r,$records,$d) = @_;
1.301 albertel 12002: my $i=0;
12003: my $samples = &get_samples($records,1);
1.144 matthew 12004: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 12005: &start_data_table().&start_data_table_header_row().
1.144 matthew 12006: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 12007: '<th>'.&mt('Column').'</th>'.
12008: &end_data_table_header_row()."\n");
1.356 albertel 12009: foreach my $array_ref (@$d) {
12010: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 12011: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 12012:
1.875 bisitz 12013: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 12014: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 12015: $r->print('<option value="none"></option>');
1.356 albertel 12016: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
12017: $r->print('<option value="'.$sample.'"'.
12018: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 12019: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 12020: }
1.594 raeburn 12021: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 12022: $i++;
12023: }
1.594 raeburn 12024: $r->print(&end_data_table());
1.31 albertel 12025: $i--;
12026: return $i;
12027: }
1.56 matthew 12028:
1.144 matthew 12029: ######################################################
12030: ######################################################
12031:
1.56 matthew 12032: =pod
1.31 albertel 12033:
1.648 raeburn 12034: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 12035:
12036: Prints a table of sample values from the upload and can make associate samples to internal names.
12037:
12038: $r is an Apache Request ref,
12039: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
12040: $d is an array of 2 element arrays (internal name, displayed name)
12041:
12042: =cut
12043:
1.144 matthew 12044: ######################################################
12045: ######################################################
1.31 albertel 12046: sub csv_samples_select_table {
12047: my ($r,$records,$d) = @_;
12048: my $i=0;
1.144 matthew 12049: #
1.662 bisitz 12050: my $max_samples = 5;
12051: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 12052: $r->print(&start_data_table().
12053: &start_data_table_header_row().'<th>'.
12054: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
12055: &end_data_table_header_row());
1.301 albertel 12056:
12057: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 12058: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 12059: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 12060: foreach my $option (@$d) {
12061: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 12062: $r->print('<option value="'.$value.'"'.
1.253 albertel 12063: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 12064: $display.'</option>');
1.31 albertel 12065: }
12066: $r->print('</select></td><td>');
1.662 bisitz 12067: foreach my $line (0..($max_samples-1)) {
1.301 albertel 12068: if (defined($samples->[$line]{$key})) {
12069: $r->print($samples->[$line]{$key}."<br />\n");
12070: }
12071: }
1.594 raeburn 12072: $r->print('</td>'.&end_data_table_row());
1.31 albertel 12073: $i++;
12074: }
1.594 raeburn 12075: $r->print(&end_data_table());
1.31 albertel 12076: $i--;
12077: return($i);
1.115 matthew 12078: }
12079:
1.144 matthew 12080: ######################################################
12081: ######################################################
12082:
1.115 matthew 12083: =pod
12084:
1.648 raeburn 12085: =item * &clean_excel_name($name)
1.115 matthew 12086:
12087: Returns a replacement for $name which does not contain any illegal characters.
12088:
12089: =cut
12090:
1.144 matthew 12091: ######################################################
12092: ######################################################
1.115 matthew 12093: sub clean_excel_name {
12094: my ($name) = @_;
12095: $name =~ s/[:\*\?\/\\]//g;
12096: if (length($name) > 31) {
12097: $name = substr($name,0,31);
12098: }
12099: return $name;
1.25 albertel 12100: }
1.84 albertel 12101:
1.85 albertel 12102: =pod
12103:
1.648 raeburn 12104: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 12105:
12106: Returns either 1 or undef
12107:
12108: 1 if the part is to be hidden, undef if it is to be shown
12109:
12110: Arguments are:
12111:
12112: $id the id of the part to be checked
12113: $symb, optional the symb of the resource to check
12114: $udom, optional the domain of the user to check for
12115: $uname, optional the username of the user to check for
12116:
12117: =cut
1.84 albertel 12118:
12119: sub check_if_partid_hidden {
12120: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 12121: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 12122: $symb,$udom,$uname);
1.141 albertel 12123: my $truth=1;
12124: #if the string starts with !, then the list is the list to show not hide
12125: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 12126: my @hiddenlist=split(/,/,$hiddenparts);
12127: foreach my $checkid (@hiddenlist) {
1.141 albertel 12128: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 12129: }
1.141 albertel 12130: return !$truth;
1.84 albertel 12131: }
1.127 matthew 12132:
1.138 matthew 12133:
12134: ############################################################
12135: ############################################################
12136:
12137: =pod
12138:
1.157 matthew 12139: =back
12140:
1.138 matthew 12141: =head1 cgi-bin script and graphing routines
12142:
1.157 matthew 12143: =over 4
12144:
1.648 raeburn 12145: =item * &get_cgi_id()
1.138 matthew 12146:
12147: Inputs: none
12148:
12149: Returns an id which can be used to pass environment variables
12150: to various cgi-bin scripts. These environment variables will
12151: be removed from the users environment after a given time by
12152: the routine &Apache::lonnet::transfer_profile_to_env.
12153:
12154: =cut
12155:
12156: ############################################################
12157: ############################################################
1.152 albertel 12158: my $uniq=0;
1.136 matthew 12159: sub get_cgi_id {
1.154 albertel 12160: $uniq=($uniq+1)%100000;
1.280 albertel 12161: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 12162: }
12163:
1.127 matthew 12164: ############################################################
12165: ############################################################
12166:
12167: =pod
12168:
1.648 raeburn 12169: =item * &DrawBarGraph()
1.127 matthew 12170:
1.138 matthew 12171: Facilitates the plotting of data in a (stacked) bar graph.
12172: Puts plot definition data into the users environment in order for
12173: graph.png to plot it. Returns an <img> tag for the plot.
12174: The bars on the plot are labeled '1','2',...,'n'.
12175:
12176: Inputs:
12177:
12178: =over 4
12179:
12180: =item $Title: string, the title of the plot
12181:
12182: =item $xlabel: string, text describing the X-axis of the plot
12183:
12184: =item $ylabel: string, text describing the Y-axis of the plot
12185:
12186: =item $Max: scalar, the maximum Y value to use in the plot
12187: If $Max is < any data point, the graph will not be rendered.
12188:
1.140 matthew 12189: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 12190: they are plotted. If undefined, default values will be used.
12191:
1.178 matthew 12192: =item $labels: array ref holding the labels to use on the x-axis for the bars.
12193:
1.138 matthew 12194: =item @Values: An array of array references. Each array reference holds data
12195: to be plotted in a stacked bar chart.
12196:
1.239 matthew 12197: =item If the final element of @Values is a hash reference the key/value
12198: pairs will be added to the graph definition.
12199:
1.138 matthew 12200: =back
12201:
12202: Returns:
12203:
12204: An <img> tag which references graph.png and the appropriate identifying
12205: information for the plot.
12206:
1.127 matthew 12207: =cut
12208:
12209: ############################################################
12210: ############################################################
1.134 matthew 12211: sub DrawBarGraph {
1.178 matthew 12212: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 12213: #
12214: if (! defined($colors)) {
12215: $colors = ['#33ff00',
12216: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
12217: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
12218: ];
12219: }
1.228 matthew 12220: my $extra_settings = {};
12221: if (ref($Values[-1]) eq 'HASH') {
12222: $extra_settings = pop(@Values);
12223: }
1.127 matthew 12224: #
1.136 matthew 12225: my $identifier = &get_cgi_id();
12226: my $id = 'cgi.'.$identifier;
1.129 matthew 12227: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 12228: return '';
12229: }
1.225 matthew 12230: #
12231: my @Labels;
12232: if (defined($labels)) {
12233: @Labels = @$labels;
12234: } else {
12235: for (my $i=0;$i<@{$Values[0]};$i++) {
12236: push (@Labels,$i+1);
12237: }
12238: }
12239: #
1.129 matthew 12240: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 12241: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 12242: my %ValuesHash;
12243: my $NumSets=1;
12244: foreach my $array (@Values) {
12245: next if (! ref($array));
1.136 matthew 12246: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 12247: join(',',@$array);
1.129 matthew 12248: }
1.127 matthew 12249: #
1.136 matthew 12250: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 12251: if ($NumBars < 3) {
12252: $width = 120+$NumBars*32;
1.220 matthew 12253: $xskip = 1;
1.225 matthew 12254: $bar_width = 30;
12255: } elsif ($NumBars < 5) {
12256: $width = 120+$NumBars*20;
12257: $xskip = 1;
12258: $bar_width = 20;
1.220 matthew 12259: } elsif ($NumBars < 10) {
1.136 matthew 12260: $width = 120+$NumBars*15;
12261: $xskip = 1;
12262: $bar_width = 15;
12263: } elsif ($NumBars <= 25) {
12264: $width = 120+$NumBars*11;
12265: $xskip = 5;
12266: $bar_width = 8;
12267: } elsif ($NumBars <= 50) {
12268: $width = 120+$NumBars*8;
12269: $xskip = 5;
12270: $bar_width = 4;
12271: } else {
12272: $width = 120+$NumBars*8;
12273: $xskip = 5;
12274: $bar_width = 4;
12275: }
12276: #
1.137 matthew 12277: $Max = 1 if ($Max < 1);
12278: if ( int($Max) < $Max ) {
12279: $Max++;
12280: $Max = int($Max);
12281: }
1.127 matthew 12282: $Title = '' if (! defined($Title));
12283: $xlabel = '' if (! defined($xlabel));
12284: $ylabel = '' if (! defined($ylabel));
1.369 www 12285: $ValuesHash{$id.'.title'} = &escape($Title);
12286: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
12287: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 12288: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 12289: $ValuesHash{$id.'.NumBars'} = $NumBars;
12290: $ValuesHash{$id.'.NumSets'} = $NumSets;
12291: $ValuesHash{$id.'.PlotType'} = 'bar';
12292: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12293: $ValuesHash{$id.'.height'} = $height;
12294: $ValuesHash{$id.'.width'} = $width;
12295: $ValuesHash{$id.'.xskip'} = $xskip;
12296: $ValuesHash{$id.'.bar_width'} = $bar_width;
12297: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 12298: #
1.228 matthew 12299: # Deal with other parameters
12300: while (my ($key,$value) = each(%$extra_settings)) {
12301: $ValuesHash{$id.'.'.$key} = $value;
12302: }
12303: #
1.646 raeburn 12304: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 12305: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12306: }
12307:
12308: ############################################################
12309: ############################################################
12310:
12311: =pod
12312:
1.648 raeburn 12313: =item * &DrawXYGraph()
1.137 matthew 12314:
1.138 matthew 12315: Facilitates the plotting of data in an XY graph.
12316: Puts plot definition data into the users environment in order for
12317: graph.png to plot it. Returns an <img> tag for the plot.
12318:
12319: Inputs:
12320:
12321: =over 4
12322:
12323: =item $Title: string, the title of the plot
12324:
12325: =item $xlabel: string, text describing the X-axis of the plot
12326:
12327: =item $ylabel: string, text describing the Y-axis of the plot
12328:
12329: =item $Max: scalar, the maximum Y value to use in the plot
12330: If $Max is < any data point, the graph will not be rendered.
12331:
12332: =item $colors: Array ref containing the hex color codes for the data to be
12333: plotted in. If undefined, default values will be used.
12334:
12335: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12336:
12337: =item $Ydata: Array ref containing Array refs.
1.185 www 12338: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 12339:
12340: =item %Values: hash indicating or overriding any default values which are
12341: passed to graph.png.
12342: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12343:
12344: =back
12345:
12346: Returns:
12347:
12348: An <img> tag which references graph.png and the appropriate identifying
12349: information for the plot.
12350:
1.137 matthew 12351: =cut
12352:
12353: ############################################################
12354: ############################################################
12355: sub DrawXYGraph {
12356: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
12357: #
12358: # Create the identifier for the graph
12359: my $identifier = &get_cgi_id();
12360: my $id = 'cgi.'.$identifier;
12361: #
12362: $Title = '' if (! defined($Title));
12363: $xlabel = '' if (! defined($xlabel));
12364: $ylabel = '' if (! defined($ylabel));
12365: my %ValuesHash =
12366: (
1.369 www 12367: $id.'.title' => &escape($Title),
12368: $id.'.xlabel' => &escape($xlabel),
12369: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 12370: $id.'.y_max_value'=> $Max,
12371: $id.'.labels' => join(',',@$Xlabels),
12372: $id.'.PlotType' => 'XY',
12373: );
12374: #
12375: if (defined($colors) && ref($colors) eq 'ARRAY') {
12376: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12377: }
12378: #
12379: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
12380: return '';
12381: }
12382: my $NumSets=1;
1.138 matthew 12383: foreach my $array (@{$Ydata}){
1.137 matthew 12384: next if (! ref($array));
12385: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
12386: }
1.138 matthew 12387: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 12388: #
12389: # Deal with other parameters
12390: while (my ($key,$value) = each(%Values)) {
12391: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 12392: }
12393: #
1.646 raeburn 12394: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 12395: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
12396: }
12397:
12398: ############################################################
12399: ############################################################
12400:
12401: =pod
12402:
1.648 raeburn 12403: =item * &DrawXYYGraph()
1.138 matthew 12404:
12405: Facilitates the plotting of data in an XY graph with two Y axes.
12406: Puts plot definition data into the users environment in order for
12407: graph.png to plot it. Returns an <img> tag for the plot.
12408:
12409: Inputs:
12410:
12411: =over 4
12412:
12413: =item $Title: string, the title of the plot
12414:
12415: =item $xlabel: string, text describing the X-axis of the plot
12416:
12417: =item $ylabel: string, text describing the Y-axis of the plot
12418:
12419: =item $colors: Array ref containing the hex color codes for the data to be
12420: plotted in. If undefined, default values will be used.
12421:
12422: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
12423:
12424: =item $Ydata1: The first data set
12425:
12426: =item $Min1: The minimum value of the left Y-axis
12427:
12428: =item $Max1: The maximum value of the left Y-axis
12429:
12430: =item $Ydata2: The second data set
12431:
12432: =item $Min2: The minimum value of the right Y-axis
12433:
12434: =item $Max2: The maximum value of the left Y-axis
12435:
12436: =item %Values: hash indicating or overriding any default values which are
12437: passed to graph.png.
12438: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
12439:
12440: =back
12441:
12442: Returns:
12443:
12444: An <img> tag which references graph.png and the appropriate identifying
12445: information for the plot.
1.136 matthew 12446:
12447: =cut
12448:
12449: ############################################################
12450: ############################################################
1.137 matthew 12451: sub DrawXYYGraph {
12452: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
12453: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 12454: #
12455: # Create the identifier for the graph
12456: my $identifier = &get_cgi_id();
12457: my $id = 'cgi.'.$identifier;
12458: #
12459: $Title = '' if (! defined($Title));
12460: $xlabel = '' if (! defined($xlabel));
12461: $ylabel = '' if (! defined($ylabel));
12462: my %ValuesHash =
12463: (
1.369 www 12464: $id.'.title' => &escape($Title),
12465: $id.'.xlabel' => &escape($xlabel),
12466: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 12467: $id.'.labels' => join(',',@$Xlabels),
12468: $id.'.PlotType' => 'XY',
12469: $id.'.NumSets' => 2,
1.137 matthew 12470: $id.'.two_axes' => 1,
12471: $id.'.y1_max_value' => $Max1,
12472: $id.'.y1_min_value' => $Min1,
12473: $id.'.y2_max_value' => $Max2,
12474: $id.'.y2_min_value' => $Min2,
1.136 matthew 12475: );
12476: #
1.137 matthew 12477: if (defined($colors) && ref($colors) eq 'ARRAY') {
12478: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
12479: }
12480: #
12481: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
12482: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 12483: return '';
12484: }
12485: my $NumSets=1;
1.137 matthew 12486: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 12487: next if (! ref($array));
12488: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 12489: }
12490: #
12491: # Deal with other parameters
12492: while (my ($key,$value) = each(%Values)) {
12493: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 12494: }
12495: #
1.646 raeburn 12496: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 12497: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 12498: }
12499:
12500: ############################################################
12501: ############################################################
12502:
12503: =pod
12504:
1.157 matthew 12505: =back
12506:
1.139 matthew 12507: =head1 Statistics helper routines?
12508:
12509: Bad place for them but what the hell.
12510:
1.157 matthew 12511: =over 4
12512:
1.648 raeburn 12513: =item * &chartlink()
1.139 matthew 12514:
12515: Returns a link to the chart for a specific student.
12516:
12517: Inputs:
12518:
12519: =over 4
12520:
12521: =item $linktext: The text of the link
12522:
12523: =item $sname: The students username
12524:
12525: =item $sdomain: The students domain
12526:
12527: =back
12528:
1.157 matthew 12529: =back
12530:
1.139 matthew 12531: =cut
12532:
12533: ############################################################
12534: ############################################################
12535: sub chartlink {
12536: my ($linktext, $sname, $sdomain) = @_;
12537: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 12538: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 12539: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 12540: '">'.$linktext.'</a>';
1.153 matthew 12541: }
12542:
12543: #######################################################
12544: #######################################################
12545:
12546: =pod
12547:
12548: =head1 Course Environment Routines
1.157 matthew 12549:
12550: =over 4
1.153 matthew 12551:
1.648 raeburn 12552: =item * &restore_course_settings()
1.153 matthew 12553:
1.648 raeburn 12554: =item * &store_course_settings()
1.153 matthew 12555:
12556: Restores/Store indicated form parameters from the course environment.
12557: Will not overwrite existing values of the form parameters.
12558:
12559: Inputs:
12560: a scalar describing the data (e.g. 'chart', 'problem_analysis')
12561:
12562: a hash ref describing the data to be stored. For example:
12563:
12564: %Save_Parameters = ('Status' => 'scalar',
12565: 'chartoutputmode' => 'scalar',
12566: 'chartoutputdata' => 'scalar',
12567: 'Section' => 'array',
1.373 raeburn 12568: 'Group' => 'array',
1.153 matthew 12569: 'StudentData' => 'array',
12570: 'Maps' => 'array');
12571:
12572: Returns: both routines return nothing
12573:
1.631 raeburn 12574: =back
12575:
1.153 matthew 12576: =cut
12577:
12578: #######################################################
12579: #######################################################
12580: sub store_course_settings {
1.496 albertel 12581: return &store_settings($env{'request.course.id'},@_);
12582: }
12583:
12584: sub store_settings {
1.153 matthew 12585: # save to the environment
12586: # appenv the same items, just to be safe
1.300 albertel 12587: my $udom = $env{'user.domain'};
12588: my $uname = $env{'user.name'};
1.496 albertel 12589: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12590: my %SaveHash;
12591: my %AppHash;
12592: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 12593: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 12594: my $envname = 'environment.'.$basename;
1.258 albertel 12595: if (exists($env{'form.'.$setting})) {
1.153 matthew 12596: # Save this value away
12597: if ($type eq 'scalar' &&
1.258 albertel 12598: (! exists($env{$envname}) ||
12599: $env{$envname} ne $env{'form.'.$setting})) {
12600: $SaveHash{$basename} = $env{'form.'.$setting};
12601: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 12602: } elsif ($type eq 'array') {
12603: my $stored_form;
1.258 albertel 12604: if (ref($env{'form.'.$setting})) {
1.153 matthew 12605: $stored_form = join(',',
12606: map {
1.369 www 12607: &escape($_);
1.258 albertel 12608: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 12609: } else {
12610: $stored_form =
1.369 www 12611: &escape($env{'form.'.$setting});
1.153 matthew 12612: }
12613: # Determine if the array contents are the same.
1.258 albertel 12614: if ($stored_form ne $env{$envname}) {
1.153 matthew 12615: $SaveHash{$basename} = $stored_form;
12616: $AppHash{$envname} = $stored_form;
12617: }
12618: }
12619: }
12620: }
12621: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 12622: $udom,$uname);
1.153 matthew 12623: if ($put_result !~ /^(ok|delayed)/) {
12624: &Apache::lonnet::logthis('unable to save form parameters, '.
12625: 'got error:'.$put_result);
12626: }
12627: # Make sure these settings stick around in this session, too
1.646 raeburn 12628: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 12629: return;
12630: }
12631:
12632: sub restore_course_settings {
1.499 albertel 12633: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 12634: }
12635:
12636: sub restore_settings {
12637: my ($context,$prefix,$Settings) = @_;
1.153 matthew 12638: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 12639: next if (exists($env{'form.'.$setting}));
1.496 albertel 12640: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 12641: '.'.$setting;
1.258 albertel 12642: if (exists($env{$envname})) {
1.153 matthew 12643: if ($type eq 'scalar') {
1.258 albertel 12644: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 12645: } elsif ($type eq 'array') {
1.258 albertel 12646: $env{'form.'.$setting} = [
1.153 matthew 12647: map {
1.369 www 12648: &unescape($_);
1.258 albertel 12649: } split(',',$env{$envname})
1.153 matthew 12650: ];
12651: }
12652: }
12653: }
1.127 matthew 12654: }
12655:
1.618 raeburn 12656: #######################################################
12657: #######################################################
12658:
12659: =pod
12660:
12661: =head1 Domain E-mail Routines
12662:
12663: =over 4
12664:
1.648 raeburn 12665: =item * &build_recipient_list()
1.618 raeburn 12666:
1.884 raeburn 12667: Build recipient lists for five types of e-mail:
1.766 raeburn 12668: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 12669: (d) Help requests, (e) Course requests needing approval, generated by
12670: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
12671: loncoursequeueadmin.pm respectively.
1.618 raeburn 12672:
12673: Inputs:
1.619 raeburn 12674: defmail (scalar - email address of default recipient),
1.618 raeburn 12675: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 12676: defdom (domain for which to retrieve configuration settings),
12677: origmail (scalar - email address of recipient from loncapa.conf,
12678: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 12679:
1.655 raeburn 12680: Returns: comma separated list of addresses to which to send e-mail.
12681:
12682: =back
1.618 raeburn 12683:
12684: =cut
12685:
12686: ############################################################
12687: ############################################################
12688: sub build_recipient_list {
1.619 raeburn 12689: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 12690: my @recipients;
12691: my $otheremails;
12692: my %domconfig =
12693: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
12694: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 12695: if (exists($domconfig{'contacts'}{$mailing})) {
12696: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
12697: my @contacts = ('adminemail','supportemail');
12698: foreach my $item (@contacts) {
12699: if ($domconfig{'contacts'}{$mailing}{$item}) {
12700: my $addr = $domconfig{'contacts'}{$item};
12701: if (!grep(/^\Q$addr\E$/,@recipients)) {
12702: push(@recipients,$addr);
12703: }
1.619 raeburn 12704: }
1.766 raeburn 12705: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 12706: }
12707: }
1.766 raeburn 12708: } elsif ($origmail ne '') {
12709: push(@recipients,$origmail);
1.618 raeburn 12710: }
1.619 raeburn 12711: } elsif ($origmail ne '') {
12712: push(@recipients,$origmail);
1.618 raeburn 12713: }
1.688 raeburn 12714: if (defined($defmail)) {
12715: if ($defmail ne '') {
12716: push(@recipients,$defmail);
12717: }
1.618 raeburn 12718: }
12719: if ($otheremails) {
1.619 raeburn 12720: my @others;
12721: if ($otheremails =~ /,/) {
12722: @others = split(/,/,$otheremails);
1.618 raeburn 12723: } else {
1.619 raeburn 12724: push(@others,$otheremails);
12725: }
12726: foreach my $addr (@others) {
12727: if (!grep(/^\Q$addr\E$/,@recipients)) {
12728: push(@recipients,$addr);
12729: }
1.618 raeburn 12730: }
12731: }
1.619 raeburn 12732: my $recipientlist = join(',',@recipients);
1.618 raeburn 12733: return $recipientlist;
12734: }
12735:
1.127 matthew 12736: ############################################################
12737: ############################################################
1.154 albertel 12738:
1.655 raeburn 12739: =pod
12740:
12741: =head1 Course Catalog Routines
12742:
12743: =over 4
12744:
12745: =item * &gather_categories()
12746:
12747: Converts category definitions - keys of categories hash stored in
12748: coursecategories in configuration.db on the primary library server in a
12749: domain - to an array. Also generates javascript and idx hash used to
12750: generate Domain Coordinator interface for editing Course Categories.
12751:
12752: Inputs:
1.663 raeburn 12753:
1.655 raeburn 12754: categories (reference to hash of category definitions).
1.663 raeburn 12755:
1.655 raeburn 12756: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12757: categories and subcategories).
1.663 raeburn 12758:
1.655 raeburn 12759: idx (reference to hash of counters used in Domain Coordinator interface for
12760: editing Course Categories).
1.663 raeburn 12761:
1.655 raeburn 12762: jsarray (reference to array of categories used to create Javascript arrays for
12763: Domain Coordinator interface for editing Course Categories).
12764:
12765: Returns: nothing
12766:
12767: Side effects: populates cats, idx and jsarray.
12768:
12769: =cut
12770:
12771: sub gather_categories {
12772: my ($categories,$cats,$idx,$jsarray) = @_;
12773: my %counters;
12774: my $num = 0;
12775: foreach my $item (keys(%{$categories})) {
12776: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
12777: if ($container eq '' && $depth == 0) {
12778: $cats->[$depth][$categories->{$item}] = $cat;
12779: } else {
12780: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
12781: }
12782: my ($escitem,$tail) = split(/:/,$item,2);
12783: if ($counters{$tail} eq '') {
12784: $counters{$tail} = $num;
12785: $num ++;
12786: }
12787: if (ref($idx) eq 'HASH') {
12788: $idx->{$item} = $counters{$tail};
12789: }
12790: if (ref($jsarray) eq 'ARRAY') {
12791: push(@{$jsarray->[$counters{$tail}]},$item);
12792: }
12793: }
12794: return;
12795: }
12796:
12797: =pod
12798:
12799: =item * &extract_categories()
12800:
12801: Used to generate breadcrumb trails for course categories.
12802:
12803: Inputs:
1.663 raeburn 12804:
1.655 raeburn 12805: categories (reference to hash of category definitions).
1.663 raeburn 12806:
1.655 raeburn 12807: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12808: categories and subcategories).
1.663 raeburn 12809:
1.655 raeburn 12810: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 12811:
1.655 raeburn 12812: allitems (reference to hash - key is category key
12813: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12814:
1.655 raeburn 12815: idx (reference to hash of counters used in Domain Coordinator interface for
12816: editing Course Categories).
1.663 raeburn 12817:
1.655 raeburn 12818: jsarray (reference to array of categories used to create Javascript arrays for
12819: Domain Coordinator interface for editing Course Categories).
12820:
1.665 raeburn 12821: subcats (reference to hash of arrays containing all subcategories within each
12822: category, -recursive)
12823:
1.655 raeburn 12824: Returns: nothing
12825:
12826: Side effects: populates trails and allitems hash references.
12827:
12828: =cut
12829:
12830: sub extract_categories {
1.665 raeburn 12831: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 12832: if (ref($categories) eq 'HASH') {
12833: &gather_categories($categories,$cats,$idx,$jsarray);
12834: if (ref($cats->[0]) eq 'ARRAY') {
12835: for (my $i=0; $i<@{$cats->[0]}; $i++) {
12836: my $name = $cats->[0][$i];
12837: my $item = &escape($name).'::0';
12838: my $trailstr;
12839: if ($name eq 'instcode') {
12840: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 12841: } elsif ($name eq 'communities') {
12842: $trailstr = &mt('Communities');
1.655 raeburn 12843: } else {
12844: $trailstr = $name;
12845: }
12846: if ($allitems->{$item} eq '') {
12847: push(@{$trails},$trailstr);
12848: $allitems->{$item} = scalar(@{$trails})-1;
12849: }
12850: my @parents = ($name);
12851: if (ref($cats->[1]{$name}) eq 'ARRAY') {
12852: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
12853: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 12854: if (ref($subcats) eq 'HASH') {
12855: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
12856: }
12857: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
12858: }
12859: } else {
12860: if (ref($subcats) eq 'HASH') {
12861: $subcats->{$item} = [];
1.655 raeburn 12862: }
12863: }
12864: }
12865: }
12866: }
12867: return;
12868: }
12869:
12870: =pod
12871:
12872: =item *&recurse_categories()
12873:
12874: Recursively used to generate breadcrumb trails for course categories.
12875:
12876: Inputs:
1.663 raeburn 12877:
1.655 raeburn 12878: cats (reference to array of arrays/hashes which encapsulates hierarchy of
12879: categories and subcategories).
1.663 raeburn 12880:
1.655 raeburn 12881: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 12882:
12883: category (current course category, for which breadcrumb trail is being generated).
12884:
12885: trails (reference to array of breadcrumb trails for each category).
12886:
1.655 raeburn 12887: allitems (reference to hash - key is category key
12888: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 12889:
1.655 raeburn 12890: parents (array containing containers directories for current category,
12891: back to top level).
12892:
12893: Returns: nothing
12894:
12895: Side effects: populates trails and allitems hash references
12896:
12897: =cut
12898:
12899: sub recurse_categories {
1.665 raeburn 12900: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 12901: my $shallower = $depth - 1;
12902: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
12903: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
12904: my $name = $cats->[$depth]{$category}[$k];
12905: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12906: my $trailstr = join(' -> ',(@{$parents},$category));
12907: if ($allitems->{$item} eq '') {
12908: push(@{$trails},$trailstr);
12909: $allitems->{$item} = scalar(@{$trails})-1;
12910: }
12911: my $deeper = $depth+1;
12912: push(@{$parents},$category);
1.665 raeburn 12913: if (ref($subcats) eq 'HASH') {
12914: my $subcat = &escape($name).':'.$category.':'.$depth;
12915: for (my $j=@{$parents}; $j>=0; $j--) {
12916: my $higher;
12917: if ($j > 0) {
12918: $higher = &escape($parents->[$j]).':'.
12919: &escape($parents->[$j-1]).':'.$j;
12920: } else {
12921: $higher = &escape($parents->[$j]).'::'.$j;
12922: }
12923: push(@{$subcats->{$higher}},$subcat);
12924: }
12925: }
12926: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
12927: $subcats);
1.655 raeburn 12928: pop(@{$parents});
12929: }
12930: } else {
12931: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
12932: my $trailstr = join(' -> ',(@{$parents},$category));
12933: if ($allitems->{$item} eq '') {
12934: push(@{$trails},$trailstr);
12935: $allitems->{$item} = scalar(@{$trails})-1;
12936: }
12937: }
12938: return;
12939: }
12940:
1.663 raeburn 12941: =pod
12942:
12943: =item *&assign_categories_table()
12944:
12945: Create a datatable for display of hierarchical categories in a domain,
12946: with checkboxes to allow a course to be categorized.
12947:
12948: Inputs:
12949:
12950: cathash - reference to hash of categories defined for the domain (from
12951: configuration.db)
12952:
12953: currcat - scalar with an & separated list of categories assigned to a course.
12954:
1.919 raeburn 12955: type - scalar contains course type (Course or Community).
12956:
1.663 raeburn 12957: Returns: $output (markup to be displayed)
12958:
12959: =cut
12960:
12961: sub assign_categories_table {
1.919 raeburn 12962: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 12963: my $output;
12964: if (ref($cathash) eq 'HASH') {
12965: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
12966: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
12967: $maxdepth = scalar(@cats);
12968: if (@cats > 0) {
12969: my $itemcount = 0;
12970: if (ref($cats[0]) eq 'ARRAY') {
12971: my @currcategories;
12972: if ($currcat ne '') {
12973: @currcategories = split('&',$currcat);
12974: }
1.919 raeburn 12975: my $table;
1.663 raeburn 12976: for (my $i=0; $i<@{$cats[0]}; $i++) {
12977: my $parent = $cats[0][$i];
1.919 raeburn 12978: next if ($parent eq 'instcode');
12979: if ($type eq 'Community') {
12980: next unless ($parent eq 'communities');
12981: } else {
12982: next if ($parent eq 'communities');
12983: }
1.663 raeburn 12984: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
12985: my $item = &escape($parent).'::0';
12986: my $checked = '';
12987: if (@currcategories > 0) {
12988: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 12989: $checked = ' checked="checked"';
1.663 raeburn 12990: }
12991: }
1.919 raeburn 12992: my $parent_title = $parent;
12993: if ($parent eq 'communities') {
12994: $parent_title = &mt('Communities');
12995: }
12996: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
12997: '<input type="checkbox" name="usecategory" value="'.
12998: $item.'"'.$checked.' />'.$parent_title.'</span>'.
12999: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 13000: my $depth = 1;
13001: push(@path,$parent);
1.919 raeburn 13002: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 13003: pop(@path);
1.919 raeburn 13004: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 13005: $itemcount ++;
13006: }
1.919 raeburn 13007: if ($itemcount) {
13008: $output = &Apache::loncommon::start_data_table().
13009: $table.
13010: &Apache::loncommon::end_data_table();
13011: }
1.663 raeburn 13012: }
13013: }
13014: }
13015: return $output;
13016: }
13017:
13018: =pod
13019:
13020: =item *&assign_category_rows()
13021:
13022: Create a datatable row for display of nested categories in a domain,
13023: with checkboxes to allow a course to be categorized,called recursively.
13024:
13025: Inputs:
13026:
13027: itemcount - track row number for alternating colors
13028:
13029: cats - reference to array of arrays/hashes which encapsulates hierarchy of
13030: categories and subcategories.
13031:
13032: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
13033:
13034: parent - parent of current category item
13035:
13036: path - Array containing all categories back up through the hierarchy from the
13037: current category to the top level.
13038:
13039: currcategories - reference to array of current categories assigned to the course
13040:
13041: Returns: $output (markup to be displayed).
13042:
13043: =cut
13044:
13045: sub assign_category_rows {
13046: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
13047: my ($text,$name,$item,$chgstr);
13048: if (ref($cats) eq 'ARRAY') {
13049: my $maxdepth = scalar(@{$cats});
13050: if (ref($cats->[$depth]) eq 'HASH') {
13051: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
13052: my $numchildren = @{$cats->[$depth]{$parent}};
13053: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
13054: $text .= '<td><table class="LC_datatable">';
13055: for (my $j=0; $j<$numchildren; $j++) {
13056: $name = $cats->[$depth]{$parent}[$j];
13057: $item = &escape($name).':'.&escape($parent).':'.$depth;
13058: my $deeper = $depth+1;
13059: my $checked = '';
13060: if (ref($currcategories) eq 'ARRAY') {
13061: if (@{$currcategories} > 0) {
13062: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 13063: $checked = ' checked="checked"';
1.663 raeburn 13064: }
13065: }
13066: }
1.664 raeburn 13067: $text .= '<tr><td><span class="LC_nobreak"><label>'.
13068: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 13069: $item.'"'.$checked.' />'.$name.'</label></span>'.
13070: '<input type="hidden" name="catname" value="'.$name.'" />'.
13071: '</td><td>';
1.663 raeburn 13072: if (ref($path) eq 'ARRAY') {
13073: push(@{$path},$name);
13074: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
13075: pop(@{$path});
13076: }
13077: $text .= '</td></tr>';
13078: }
13079: $text .= '</table></td>';
13080: }
13081: }
13082: }
13083: return $text;
13084: }
13085:
1.655 raeburn 13086: ############################################################
13087: ############################################################
13088:
13089:
1.443 albertel 13090: sub commit_customrole {
1.664 raeburn 13091: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 13092: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 13093: ($start?', '.&mt('starting').' '.localtime($start):'').
13094: ($end?', ending '.localtime($end):'').': <b>'.
13095: &Apache::lonnet::assigncustomrole(
1.664 raeburn 13096: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 13097: '</b><br />';
13098: return $output;
13099: }
13100:
13101: sub commit_standardrole {
1.541 raeburn 13102: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
13103: my ($output,$logmsg,$linefeed);
13104: if ($context eq 'auto') {
13105: $linefeed = "\n";
13106: } else {
13107: $linefeed = "<br />\n";
13108: }
1.443 albertel 13109: if ($three eq 'st') {
1.541 raeburn 13110: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
13111: $one,$two,$sec,$context);
13112: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 13113: ($result eq 'unknown_course') || ($result eq 'refused')) {
13114: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 13115: } else {
1.541 raeburn 13116: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 13117: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13118: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
13119: if ($context eq 'auto') {
13120: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
13121: } else {
13122: $output .= '<b>'.$result.'</b>'.$linefeed.
13123: &mt('Add to classlist').': <b>ok</b>';
13124: }
13125: $output .= $linefeed;
1.443 albertel 13126: }
13127: } else {
13128: $output = &mt('Assigning').' '.$three.' in '.$url.
13129: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 13130: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 13131: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 13132: if ($context eq 'auto') {
13133: $output .= $result.$linefeed;
13134: } else {
13135: $output .= '<b>'.$result.'</b>'.$linefeed;
13136: }
1.443 albertel 13137: }
13138: return $output;
13139: }
13140:
13141: sub commit_studentrole {
1.541 raeburn 13142: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 13143: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 13144: if ($context eq 'auto') {
13145: $linefeed = "\n";
13146: } else {
13147: $linefeed = '<br />'."\n";
13148: }
1.443 albertel 13149: if (defined($one) && defined($two)) {
13150: my $cid=$one.'_'.$two;
13151: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
13152: my $secchange = 0;
13153: my $expire_role_result;
13154: my $modify_section_result;
1.628 raeburn 13155: if ($oldsec ne '-1') {
13156: if ($oldsec ne $sec) {
1.443 albertel 13157: $secchange = 1;
1.628 raeburn 13158: my $now = time;
1.443 albertel 13159: my $uurl='/'.$cid;
13160: $uurl=~s/\_/\//g;
13161: if ($oldsec) {
13162: $uurl.='/'.$oldsec;
13163: }
1.626 raeburn 13164: $oldsecurl = $uurl;
1.628 raeburn 13165: $expire_role_result =
1.652 raeburn 13166: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 13167: if ($env{'request.course.sec'} ne '') {
13168: if ($expire_role_result eq 'refused') {
13169: my @roles = ('st');
13170: my @statuses = ('previous');
13171: my @roledoms = ($one);
13172: my $withsec = 1;
13173: my %roleshash =
13174: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
13175: \@statuses,\@roles,\@roledoms,$withsec);
13176: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
13177: my ($oldstart,$oldend) =
13178: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
13179: if ($oldend > 0 && $oldend <= $now) {
13180: $expire_role_result = 'ok';
13181: }
13182: }
13183: }
13184: }
1.443 albertel 13185: $result = $expire_role_result;
13186: }
13187: }
13188: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 13189: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 13190: if ($modify_section_result =~ /^ok/) {
13191: if ($secchange == 1) {
1.628 raeburn 13192: if ($sec eq '') {
13193: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
13194: } else {
13195: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
13196: }
1.443 albertel 13197: } elsif ($oldsec eq '-1') {
1.628 raeburn 13198: if ($sec eq '') {
13199: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
13200: } else {
13201: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13202: }
1.443 albertel 13203: } else {
1.628 raeburn 13204: if ($sec eq '') {
13205: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
13206: } else {
13207: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
13208: }
1.443 albertel 13209: }
13210: } else {
1.628 raeburn 13211: if ($secchange) {
13212: $$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;
13213: } else {
13214: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
13215: }
1.443 albertel 13216: }
13217: $result = $modify_section_result;
13218: } elsif ($secchange == 1) {
1.628 raeburn 13219: if ($oldsec eq '') {
13220: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
13221: } else {
13222: $$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;
13223: }
1.626 raeburn 13224: if ($expire_role_result eq 'refused') {
13225: my $newsecurl = '/'.$cid;
13226: $newsecurl =~ s/\_/\//g;
13227: if ($sec ne '') {
13228: $newsecurl.='/'.$sec;
13229: }
13230: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
13231: if ($sec eq '') {
13232: $$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;
13233: } else {
13234: $$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;
13235: }
13236: }
13237: }
1.443 albertel 13238: }
13239: } else {
1.626 raeburn 13240: $$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 13241: $result = "error: incomplete course id\n";
13242: }
13243: return $result;
13244: }
13245:
13246: ############################################################
13247: ############################################################
13248:
1.566 albertel 13249: sub check_clone {
1.578 raeburn 13250: my ($args,$linefeed) = @_;
1.566 albertel 13251: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
13252: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
13253: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
13254: my $clonemsg;
13255: my $can_clone = 0;
1.944 raeburn 13256: my $lctype = lc($args->{'crstype'});
1.908 raeburn 13257: if ($lctype ne 'community') {
13258: $lctype = 'course';
13259: }
1.566 albertel 13260: if ($clonehome eq 'no_host') {
1.944 raeburn 13261: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13262: $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'});
13263: } else {
13264: $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'});
13265: }
1.566 albertel 13266: } else {
13267: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 13268: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13269: if ($clonedesc{'type'} ne 'Community') {
13270: $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'});
13271: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13272: }
13273: }
1.882 raeburn 13274: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
13275: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 13276: $can_clone = 1;
13277: } else {
13278: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
13279: $args->{'clonedomain'},$args->{'clonecourse'});
13280: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 13281: if (grep(/^\*$/,@cloners)) {
13282: $can_clone = 1;
13283: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
13284: $can_clone = 1;
13285: } else {
1.908 raeburn 13286: my $ccrole = 'cc';
1.944 raeburn 13287: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13288: $ccrole = 'co';
13289: }
1.578 raeburn 13290: my %roleshash =
13291: &Apache::lonnet::get_my_roles($args->{'ccuname'},
13292: $args->{'ccdomain'},
1.908 raeburn 13293: 'userroles',['active'],[$ccrole],
1.578 raeburn 13294: [$args->{'clonedomain'}]);
1.908 raeburn 13295: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 13296: $can_clone = 1;
13297: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
13298: $can_clone = 1;
13299: } else {
1.944 raeburn 13300: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 13301: $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'});
13302: } else {
13303: $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'});
13304: }
1.578 raeburn 13305: }
1.566 albertel 13306: }
1.578 raeburn 13307: }
1.566 albertel 13308: }
13309: return ($can_clone, $clonemsg, $cloneid, $clonehome);
13310: }
13311:
1.444 albertel 13312: sub construct_course {
1.885 raeburn 13313: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 13314: my $outcome;
1.541 raeburn 13315: my $linefeed = '<br />'."\n";
13316: if ($context eq 'auto') {
13317: $linefeed = "\n";
13318: }
1.566 albertel 13319:
13320: #
13321: # Are we cloning?
13322: #
13323: my ($can_clone, $clonemsg, $cloneid, $clonehome);
13324: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 13325: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 13326: if ($context ne 'auto') {
1.578 raeburn 13327: if ($clonemsg ne '') {
13328: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
13329: }
1.566 albertel 13330: }
13331: $outcome .= $clonemsg.$linefeed;
13332:
13333: if (!$can_clone) {
13334: return (0,$outcome);
13335: }
13336: }
13337:
1.444 albertel 13338: #
13339: # Open course
13340: #
13341: my $crstype = lc($args->{'crstype'});
13342: my %cenv=();
13343: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
13344: $args->{'cdescr'},
13345: $args->{'curl'},
13346: $args->{'course_home'},
13347: $args->{'nonstandard'},
13348: $args->{'crscode'},
13349: $args->{'ccuname'}.':'.
13350: $args->{'ccdomain'},
1.882 raeburn 13351: $args->{'crstype'},
1.885 raeburn 13352: $cnum,$context,$category);
1.444 albertel 13353:
13354: # Note: The testing routines depend on this being output; see
13355: # Utils::Course. This needs to at least be output as a comment
13356: # if anyone ever decides to not show this, and Utils::Course::new
13357: # will need to be suitably modified.
1.541 raeburn 13358: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 13359: if ($$courseid =~ /^error:/) {
13360: return (0,$outcome);
13361: }
13362:
1.444 albertel 13363: #
13364: # Check if created correctly
13365: #
1.479 albertel 13366: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 13367: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 13368: if ($crsuhome eq 'no_host') {
13369: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
13370: return (0,$outcome);
13371: }
1.541 raeburn 13372: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 13373:
1.444 albertel 13374: #
1.566 albertel 13375: # Do the cloning
13376: #
13377: if ($can_clone && $cloneid) {
13378: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
13379: if ($context ne 'auto') {
13380: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
13381: }
13382: $outcome .= $clonemsg.$linefeed;
13383: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 13384: # Copy all files
1.637 www 13385: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 13386: # Restore URL
1.566 albertel 13387: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 13388: # Restore title
1.566 albertel 13389: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 13390: # Restore creation date, creator and creation context.
13391: $cenv{'internal.created'}=$oldcenv{'internal.created'};
13392: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
13393: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 13394: # Mark as cloned
1.566 albertel 13395: $cenv{'clonedfrom'}=$cloneid;
1.638 www 13396: # Need to clone grading mode
13397: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
13398: $cenv{'grading'}=$newenv{'grading'};
13399: # Do not clone these environment entries
13400: &Apache::lonnet::del('environment',
13401: ['default_enrollment_start_date',
13402: 'default_enrollment_end_date',
13403: 'question.email',
13404: 'policy.email',
13405: 'comment.email',
13406: 'pch.users.denied',
1.725 raeburn 13407: 'plc.users.denied',
13408: 'hidefromcat',
13409: 'categories'],
1.638 www 13410: $$crsudom,$$crsunum);
1.444 albertel 13411: }
1.566 albertel 13412:
1.444 albertel 13413: #
13414: # Set environment (will override cloned, if existing)
13415: #
13416: my @sections = ();
13417: my @xlists = ();
13418: if ($args->{'crstype'}) {
13419: $cenv{'type'}=$args->{'crstype'};
13420: }
13421: if ($args->{'crsid'}) {
13422: $cenv{'courseid'}=$args->{'crsid'};
13423: }
13424: if ($args->{'crscode'}) {
13425: $cenv{'internal.coursecode'}=$args->{'crscode'};
13426: }
13427: if ($args->{'crsquota'} ne '') {
13428: $cenv{'internal.coursequota'}=$args->{'crsquota'};
13429: } else {
13430: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
13431: }
13432: if ($args->{'ccuname'}) {
13433: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
13434: ':'.$args->{'ccdomain'};
13435: } else {
13436: $cenv{'internal.courseowner'} = $args->{'curruser'};
13437: }
13438: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
13439: if ($args->{'crssections'}) {
13440: $cenv{'internal.sectionnums'} = '';
13441: if ($args->{'crssections'} =~ m/,/) {
13442: @sections = split/,/,$args->{'crssections'};
13443: } else {
13444: $sections[0] = $args->{'crssections'};
13445: }
13446: if (@sections > 0) {
13447: foreach my $item (@sections) {
13448: my ($sec,$gp) = split/:/,$item;
13449: my $class = $args->{'crscode'}.$sec;
13450: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
13451: $cenv{'internal.sectionnums'} .= $item.',';
13452: unless ($addcheck eq 'ok') {
13453: push @badclasses, $class;
13454: }
13455: }
13456: $cenv{'internal.sectionnums'} =~ s/,$//;
13457: }
13458: }
13459: # do not hide course coordinator from staff listing,
13460: # even if privileged
13461: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13462: # add crosslistings
13463: if ($args->{'crsxlist'}) {
13464: $cenv{'internal.crosslistings'}='';
13465: if ($args->{'crsxlist'} =~ m/,/) {
13466: @xlists = split/,/,$args->{'crsxlist'};
13467: } else {
13468: $xlists[0] = $args->{'crsxlist'};
13469: }
13470: if (@xlists > 0) {
13471: foreach my $item (@xlists) {
13472: my ($xl,$gp) = split/:/,$item;
13473: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
13474: $cenv{'internal.crosslistings'} .= $item.',';
13475: unless ($addcheck eq 'ok') {
13476: push @badclasses, $xl;
13477: }
13478: }
13479: $cenv{'internal.crosslistings'} =~ s/,$//;
13480: }
13481: }
13482: if ($args->{'autoadds'}) {
13483: $cenv{'internal.autoadds'}=$args->{'autoadds'};
13484: }
13485: if ($args->{'autodrops'}) {
13486: $cenv{'internal.autodrops'}=$args->{'autodrops'};
13487: }
13488: # check for notification of enrollment changes
13489: my @notified = ();
13490: if ($args->{'notify_owner'}) {
13491: if ($args->{'ccuname'} ne '') {
13492: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
13493: }
13494: }
13495: if ($args->{'notify_dc'}) {
13496: if ($uname ne '') {
1.630 raeburn 13497: push(@notified,$uname.':'.$udom);
1.444 albertel 13498: }
13499: }
13500: if (@notified > 0) {
13501: my $notifylist;
13502: if (@notified > 1) {
13503: $notifylist = join(',',@notified);
13504: } else {
13505: $notifylist = $notified[0];
13506: }
13507: $cenv{'internal.notifylist'} = $notifylist;
13508: }
13509: if (@badclasses > 0) {
13510: my %lt=&Apache::lonlocal::texthash(
13511: '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',
13512: 'dnhr' => 'does not have rights to access enrollment in these classes',
13513: 'adby' => 'as determined by the policies of your institution on access to official classlists'
13514: );
1.541 raeburn 13515: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
13516: ' ('.$lt{'adby'}.')';
13517: if ($context eq 'auto') {
13518: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 13519: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 13520: foreach my $item (@badclasses) {
13521: if ($context eq 'auto') {
13522: $outcome .= " - $item\n";
13523: } else {
13524: $outcome .= "<li>$item</li>\n";
13525: }
13526: }
13527: if ($context eq 'auto') {
13528: $outcome .= $linefeed;
13529: } else {
1.566 albertel 13530: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 13531: }
13532: }
1.444 albertel 13533: }
13534: if ($args->{'no_end_date'}) {
13535: $args->{'endaccess'} = 0;
13536: }
13537: $cenv{'internal.autostart'}=$args->{'enrollstart'};
13538: $cenv{'internal.autoend'}=$args->{'enrollend'};
13539: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
13540: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
13541: if ($args->{'showphotos'}) {
13542: $cenv{'internal.showphotos'}=$args->{'showphotos'};
13543: }
13544: $cenv{'internal.authtype'} = $args->{'authtype'};
13545: $cenv{'internal.autharg'} = $args->{'autharg'};
13546: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
13547: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 13548: 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');
13549: if ($context eq 'auto') {
13550: $outcome .= $krb_msg;
13551: } else {
1.566 albertel 13552: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 13553: }
13554: $outcome .= $linefeed;
1.444 albertel 13555: }
13556: }
13557: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
13558: if ($args->{'setpolicy'}) {
13559: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13560: }
13561: if ($args->{'setcontent'}) {
13562: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
13563: }
13564: }
13565: if ($args->{'reshome'}) {
13566: $cenv{'reshome'}=$args->{'reshome'}.'/';
13567: $cenv{'reshome'}=~s/\/+$/\//;
13568: }
13569: #
13570: # course has keyed access
13571: #
13572: if ($args->{'setkeys'}) {
13573: $cenv{'keyaccess'}='yes';
13574: }
13575: # if specified, key authority is not course, but user
13576: # only active if keyaccess is yes
13577: if ($args->{'keyauth'}) {
1.487 albertel 13578: my ($user,$domain) = split(':',$args->{'keyauth'});
13579: $user = &LONCAPA::clean_username($user);
13580: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 13581: if ($user ne '' && $domain ne '') {
1.487 albertel 13582: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 13583: }
13584: }
13585:
13586: if ($args->{'disresdis'}) {
13587: $cenv{'pch.roles.denied'}='st';
13588: }
13589: if ($args->{'disablechat'}) {
13590: $cenv{'plc.roles.denied'}='st';
13591: }
13592:
13593: # Record we've not yet viewed the Course Initialization Helper for this
13594: # course
13595: $cenv{'course.helper.not.run'} = 1;
13596: #
13597: # Use new Randomseed
13598: #
13599: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
13600: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
13601: #
13602: # The encryption code and receipt prefix for this course
13603: #
13604: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
13605: $cenv{'internal.encpref'}=100+int(9*rand(99));
13606: #
13607: # By default, use standard grading
13608: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
13609:
1.541 raeburn 13610: $outcome .= $linefeed.&mt('Setting environment').': '.
13611: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13612: #
13613: # Open all assignments
13614: #
13615: if ($args->{'openall'}) {
13616: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
13617: my %storecontent = ($storeunder => time,
13618: $storeunder.'.type' => 'date_start');
13619:
13620: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 13621: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 13622: }
13623: #
13624: # Set first page
13625: #
13626: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
13627: || ($cloneid)) {
1.445 albertel 13628: use LONCAPA::map;
1.444 albertel 13629: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 13630:
13631: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
13632: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
13633:
1.444 albertel 13634: $outcome .= ($fatal?$errtext:'read ok').' - ';
13635: my $title; my $url;
13636: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 13637: $title=&mt('Syllabus');
1.444 albertel 13638: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
13639: } else {
1.963 raeburn 13640: $title=&mt('Table of Contents');
1.444 albertel 13641: $url='/adm/navmaps';
13642: }
1.445 albertel 13643:
13644: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
13645: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
13646:
13647: if ($errtext) { $fatal=2; }
1.541 raeburn 13648: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 13649: }
1.566 albertel 13650:
13651: return (1,$outcome);
1.444 albertel 13652: }
13653:
13654: ############################################################
13655: ############################################################
13656:
1.953 droeschl 13657: #SD
13658: # only Community and Course, or anything else?
1.378 raeburn 13659: sub course_type {
13660: my ($cid) = @_;
13661: if (!defined($cid)) {
13662: $cid = $env{'request.course.id'};
13663: }
1.404 albertel 13664: if (defined($env{'course.'.$cid.'.type'})) {
13665: return $env{'course.'.$cid.'.type'};
1.378 raeburn 13666: } else {
13667: return 'Course';
1.377 raeburn 13668: }
13669: }
1.156 albertel 13670:
1.406 raeburn 13671: sub group_term {
13672: my $crstype = &course_type();
13673: my %names = (
13674: 'Course' => 'group',
1.865 raeburn 13675: 'Community' => 'group',
1.406 raeburn 13676: );
13677: return $names{$crstype};
13678: }
13679:
1.902 raeburn 13680: sub course_types {
13681: my @types = ('official','unofficial','community');
13682: my %typename = (
13683: official => 'Official course',
13684: unofficial => 'Unofficial course',
13685: community => 'Community',
13686: );
13687: return (\@types,\%typename);
13688: }
13689:
1.156 albertel 13690: sub icon {
13691: my ($file)=@_;
1.505 albertel 13692: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 13693: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 13694: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 13695: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
13696: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
13697: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13698: $curfext.".gif") {
13699: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
13700: $curfext.".gif";
13701: }
13702: }
1.249 albertel 13703: return &lonhttpdurl($iconname);
1.154 albertel 13704: }
1.84 albertel 13705:
1.575 albertel 13706: sub lonhttpdurl {
1.692 www 13707: #
13708: # Had been used for "small fry" static images on separate port 8080.
13709: # Modify here if lightweight http functionality desired again.
13710: # Currently eliminated due to increasing firewall issues.
13711: #
1.575 albertel 13712: my ($url)=@_;
1.692 www 13713: return $url;
1.215 albertel 13714: }
13715:
1.213 albertel 13716: sub connection_aborted {
13717: my ($r)=@_;
13718: $r->print(" ");$r->rflush();
13719: my $c = $r->connection;
13720: return $c->aborted();
13721: }
13722:
1.221 foxr 13723: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 13724: # strings as 'strings'.
13725: sub escape_single {
1.221 foxr 13726: my ($input) = @_;
1.223 albertel 13727: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 13728: $input =~ s/\'/\\\'/g; # Esacpe the 's....
13729: return $input;
13730: }
1.223 albertel 13731:
1.222 foxr 13732: # Same as escape_single, but escape's "'s This
13733: # can be used for "strings"
13734: sub escape_double {
13735: my ($input) = @_;
13736: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
13737: $input =~ s/\"/\\\"/g; # Esacpe the "s....
13738: return $input;
13739: }
1.223 albertel 13740:
1.222 foxr 13741: # Escapes the last element of a full URL.
13742: sub escape_url {
13743: my ($url) = @_;
1.238 raeburn 13744: my @urlslices = split(/\//, $url,-1);
1.369 www 13745: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 13746: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 13747: }
1.462 albertel 13748:
1.820 raeburn 13749: sub compare_arrays {
13750: my ($arrayref1,$arrayref2) = @_;
13751: my (@difference,%count);
13752: @difference = ();
13753: %count = ();
13754: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
13755: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
13756: foreach my $element (keys(%count)) {
13757: if ($count{$element} == 1) {
13758: push(@difference,$element);
13759: }
13760: }
13761: }
13762: return @difference;
13763: }
13764:
1.817 bisitz 13765: # -------------------------------------------------------- Initialize user login
1.462 albertel 13766: sub init_user_environment {
1.463 albertel 13767: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 13768: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
13769:
13770: my $public=($username eq 'public' && $domain eq 'public');
13771:
13772: # See if old ID present, if so, remove
13773:
1.1062 raeburn 13774: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 13775: my $now=time;
13776:
13777: if ($public) {
13778: my $max_public=100;
13779: my $oldest;
13780: my $oldest_time=0;
13781: for(my $next=1;$next<=$max_public;$next++) {
13782: if (-e $lonids."/publicuser_$next.id") {
13783: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
13784: if ($mtime<$oldest_time || !$oldest_time) {
13785: $oldest_time=$mtime;
13786: $oldest=$next;
13787: }
13788: } else {
13789: $cookie="publicuser_$next";
13790: last;
13791: }
13792: }
13793: if (!$cookie) { $cookie="publicuser_$oldest"; }
13794: } else {
1.463 albertel 13795: # if this isn't a robot, kill any existing non-robot sessions
13796: if (!$args->{'robot'}) {
13797: opendir(DIR,$lonids);
13798: while ($filename=readdir(DIR)) {
13799: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
13800: unlink($lonids.'/'.$filename);
13801: }
1.462 albertel 13802: }
1.463 albertel 13803: closedir(DIR);
1.462 albertel 13804: }
13805: # Give them a new cookie
1.463 albertel 13806: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 13807: : $now.$$.int(rand(10000)));
1.463 albertel 13808: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 13809:
13810: # Initialize roles
13811:
1.1062 raeburn 13812: ($userroles,$firstaccenv,$timerintenv) =
13813: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 13814: }
13815: # ------------------------------------ Check browser type and MathML capability
13816:
13817: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
13818: $clientunicode,$clientos) = &decode_user_agent($r);
13819:
13820: # ------------------------------------------------------------- Get environment
13821:
13822: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
13823: my ($tmp) = keys(%userenv);
13824: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
13825: } else {
13826: undef(%userenv);
13827: }
13828: if (($userenv{'interface'}) && (!$form->{'interface'})) {
13829: $form->{'interface'}=$userenv{'interface'};
13830: }
13831: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
13832:
13833: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 13834: foreach my $option ('interface','localpath','localres') {
13835: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 13836: }
13837: # --------------------------------------------------------- Write first profile
13838:
13839: {
13840: my %initial_env =
13841: ("user.name" => $username,
13842: "user.domain" => $domain,
13843: "user.home" => $authhost,
13844: "browser.type" => $clientbrowser,
13845: "browser.version" => $clientversion,
13846: "browser.mathml" => $clientmathml,
13847: "browser.unicode" => $clientunicode,
13848: "browser.os" => $clientos,
13849: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
13850: "request.course.fn" => '',
13851: "request.course.uri" => '',
13852: "request.course.sec" => '',
13853: "request.role" => 'cm',
13854: "request.role.adv" => $env{'user.adv'},
13855: "request.host" => $ENV{'REMOTE_ADDR'},);
13856:
13857: if ($form->{'localpath'}) {
13858: $initial_env{"browser.localpath"} = $form->{'localpath'};
13859: $initial_env{"browser.localres"} = $form->{'localres'};
13860: }
13861:
13862: if ($form->{'interface'}) {
13863: $form->{'interface'}=~s/\W//gs;
13864: $initial_env{"browser.interface"} = $form->{'interface'};
13865: $env{'browser.interface'}=$form->{'interface'};
13866: }
13867:
1.981 raeburn 13868: my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016 raeburn 13869: my %domdef;
13870: unless ($domain eq 'public') {
13871: %domdef = &Apache::lonnet::get_domain_defaults($domain);
13872: }
1.980 raeburn 13873:
1.1075.2.7 raeburn 13874: foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724 raeburn 13875: $userenv{'availabletools.'.$tool} =
1.980 raeburn 13876: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
13877: undef,\%userenv,\%domdef,\%is_adv);
1.724 raeburn 13878: }
13879:
1.864 raeburn 13880: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 13881: $userenv{'canrequest.'.$crstype} =
13882: &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980 raeburn 13883: 'reload','requestcourses',
13884: \%userenv,\%domdef,\%is_adv);
1.765 raeburn 13885: }
13886:
1.462 albertel 13887: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 13888:
1.462 albertel 13889: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
13890: &GDBM_WRCREAT(),0640)) {
13891: &_add_to_env(\%disk_env,\%initial_env);
13892: &_add_to_env(\%disk_env,\%userenv,'environment.');
13893: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 13894: if (ref($firstaccenv) eq 'HASH') {
13895: &_add_to_env(\%disk_env,$firstaccenv);
13896: }
13897: if (ref($timerintenv) eq 'HASH') {
13898: &_add_to_env(\%disk_env,$timerintenv);
13899: }
1.463 albertel 13900: if (ref($args->{'extra_env'})) {
13901: &_add_to_env(\%disk_env,$args->{'extra_env'});
13902: }
1.462 albertel 13903: untie(%disk_env);
13904: } else {
1.705 tempelho 13905: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
13906: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 13907: return 'error: '.$!;
13908: }
13909: }
13910: $env{'request.role'}='cm';
13911: $env{'request.role.adv'}=$env{'user.adv'};
13912: $env{'browser.type'}=$clientbrowser;
13913:
13914: return $cookie;
13915:
13916: }
13917:
13918: sub _add_to_env {
13919: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 13920: if (ref($env_data) eq 'HASH') {
13921: while (my ($key,$value) = each(%$env_data)) {
13922: $idf->{$prefix.$key} = $value;
13923: $env{$prefix.$key} = $value;
13924: }
1.462 albertel 13925: }
13926: }
13927:
1.685 tempelho 13928: # --- Get the symbolic name of a problem and the url
13929: sub get_symb {
13930: my ($request,$silent) = @_;
1.726 raeburn 13931: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 13932: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
13933: if ($symb eq '') {
13934: if (!$silent) {
1.1071 raeburn 13935: if (ref($request)) {
13936: $request->print("Unable to handle ambiguous references:$url:.");
13937: }
1.685 tempelho 13938: return ();
13939: }
13940: }
13941: &Apache::lonenc::check_decrypt(\$symb);
13942: return ($symb);
13943: }
13944:
13945: # --------------------------------------------------------------Get annotation
13946:
13947: sub get_annotation {
13948: my ($symb,$enc) = @_;
13949:
13950: my $key = $symb;
13951: if (!$enc) {
13952: $key =
13953: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
13954: }
13955: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
13956: return $annotation{$key};
13957: }
13958:
13959: sub clean_symb {
1.731 raeburn 13960: my ($symb,$delete_enc) = @_;
1.685 tempelho 13961:
13962: &Apache::lonenc::check_decrypt(\$symb);
13963: my $enc = $env{'request.enc'};
1.731 raeburn 13964: if ($delete_enc) {
1.730 raeburn 13965: delete($env{'request.enc'});
13966: }
1.685 tempelho 13967:
13968: return ($symb,$enc);
13969: }
1.462 albertel 13970:
1.990 raeburn 13971: sub build_release_hashes {
13972: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
13973: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
13974: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
13975: (ref($randomizetry) eq 'HASH'));
13976: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
13977: my ($item,$name,$value) = split(/:/,$key);
13978: if ($item eq 'parameter') {
13979: if (ref($checkparms->{$name}) eq 'ARRAY') {
13980: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
13981: push(@{$checkparms->{$name}},$value);
13982: }
13983: } else {
13984: push(@{$checkparms->{$name}},$value);
13985: }
13986: } elsif ($item eq 'resourcetag') {
13987: if ($name eq 'responsetype') {
13988: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
13989: }
13990: } elsif ($item eq 'course') {
13991: if ($name eq 'crstype') {
13992: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
13993: }
13994: }
13995: }
13996: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
13997: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
13998: return;
13999: }
14000:
1.1075.2.11 raeburn 14001: sub update_content_constraints {
14002: my ($cdom,$cnum,$chome,$cid) = @_;
14003: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
14004: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
14005: my %checkresponsetypes;
14006: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
14007: my ($item,$name,$value) = split(/:/,$key);
14008: if ($item eq 'resourcetag') {
14009: if ($name eq 'responsetype') {
14010: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
14011: }
14012: }
14013: }
14014: my $navmap = Apache::lonnavmaps::navmap->new();
14015: if (defined($navmap)) {
14016: my %allresponses;
14017: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
14018: my %responses = $res->responseTypes();
14019: foreach my $key (keys(%responses)) {
14020: next unless(exists($checkresponsetypes{$key}));
14021: $allresponses{$key} += $responses{$key};
14022: }
14023: }
14024: foreach my $key (keys(%allresponses)) {
14025: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
14026: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
14027: ($reqdmajor,$reqdminor) = ($major,$minor);
14028: }
14029: }
14030: undef($navmap);
14031: }
14032: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
14033: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
14034: }
14035: return;
14036: }
14037:
14038: sub parse_supplemental_title {
14039: my ($title) = @_;
14040:
14041: my ($foldertitle,$renametitle);
14042: if ($title =~ /&&&/) {
14043: $title = &HTML::Entites::decode($title);
14044: }
14045: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
14046: $renametitle=$4;
14047: my ($time,$uname,$udom) = ($1,$2,$3);
14048: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
14049: my $name = &plainname($uname,$udom);
14050: $name = &HTML::Entities::encode($name,'"<>&\'');
14051: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
14052: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
14053: $name.': <br />'.$foldertitle;
14054: }
14055: if (wantarray) {
14056: return ($title,$foldertitle,$renametitle);
14057: }
14058: return $title;
14059: }
14060:
1.41 ng 14061: =pod
14062:
14063: =back
14064:
1.112 bowersj2 14065: =cut
1.41 ng 14066:
1.112 bowersj2 14067: 1;
14068: __END__;
1.41 ng 14069:
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