Annotation of loncom/interface/loncommon.pm, revision 1.923
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.923 ! bisitz 4: # $Id: loncommon.pm,v 1.922 2009/12/02 18:33:27 bisitz Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.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.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
486: my $wintitle = &mt('Course Browser');
487: if ($crstype ne '') {
488: $wintitle = &mt($crstype);
489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $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 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 1130: .' title="'.$title.'"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: 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.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1722: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1723: "This error has been logged. ".
1724: "Please alert your LON-CAPA administrator").
1725: '</p>');
1726: return (undef);
1727: }
1728: #
1729: $workbook->set_tempdir('/home/httpd/perl/tmp');
1730: #
1731: my $format = &Apache::loncommon::define_excel_formats($workbook);
1732: return ($workbook,$filename,$format);
1733: }
1734:
1735: ###############################################################
1736: ###############################################################
1737:
1738: =pod
1739:
1.648 raeburn 1740: =item * &create_text_file()
1.113 bowersj2 1741:
1.542 raeburn 1742: Create a file to write to and eventually make available to the user.
1.256 matthew 1743: If file creation fails, outputs an error message on the request object and
1744: return undefs.
1.113 bowersj2 1745:
1.256 matthew 1746: Inputs: Apache request object, and file suffix
1.113 bowersj2 1747:
1.256 matthew 1748: Returns (undef) on failure,
1749: Filehandle and filename on success.
1.113 bowersj2 1750:
1751: =cut
1752:
1.256 matthew 1753: ###############################################################
1754: ###############################################################
1755: sub create_text_file {
1756: my ($r,$suffix) = @_;
1757: if (! defined($suffix)) { $suffix = 'txt'; };
1758: my $fh;
1759: my $filename = '/prtspool/'.
1.258 albertel 1760: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1761: time.'_'.rand(1000000000).'.'.$suffix;
1762: $fh = Apache::File->new('>/home/httpd'.$filename);
1763: if (! defined($fh)) {
1764: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1765: $r->print(&mt('Problems occurred in creating the output file. '
1766: .'This error has been logged. '
1767: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1768: }
1.256 matthew 1769: return ($fh,$filename)
1.113 bowersj2 1770: }
1771:
1772:
1.256 matthew 1773: =pod
1.113 bowersj2 1774:
1775: =back
1776:
1777: =cut
1.37 matthew 1778:
1779: ###############################################################
1.33 matthew 1780: ## Home server <option> list generating code ##
1781: ###############################################################
1.35 matthew 1782:
1.169 www 1783: # ------------------------------------------
1784:
1785: sub domain_select {
1786: my ($name,$value,$multiple)=@_;
1787: my %domains=map {
1.514 albertel 1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1789: } &Apache::lonnet::all_domains();
1.169 www 1790: if ($multiple) {
1791: $domains{''}=&mt('Any domain');
1.550 albertel 1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1793: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1794: } else {
1.550 albertel 1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1796: return &select_form($name,$value,%domains);
1797: }
1798: }
1799:
1.282 albertel 1800: #-------------------------------------------
1801:
1802: =pod
1803:
1.519 raeburn 1804: =head1 Routines for form select boxes
1805:
1806: =over 4
1807:
1.648 raeburn 1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1809:
1810: Returns a string containing a <select> element int multiple mode
1811:
1812:
1813: Args:
1814: $name - name of the <select> element
1.506 raeburn 1815: $value - scalar or array ref of values that should already be selected
1.282 albertel 1816: $size - number of rows long the select element is
1.283 albertel 1817: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1818: (shown text should already have been &mt())
1.506 raeburn 1819: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1820:
1.282 albertel 1821: =cut
1822:
1823: #-------------------------------------------
1.169 www 1824: sub multiple_select_form {
1.284 albertel 1825: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1827: my $output='';
1.191 matthew 1828: if (! defined($size)) {
1829: $size = 4;
1.283 albertel 1830: if (scalar(keys(%$hash))<4) {
1831: $size = scalar(keys(%$hash));
1.191 matthew 1832: }
1833: }
1.734 bisitz 1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1835: my @order;
1.506 raeburn 1836: if (ref($order) eq 'ARRAY') {
1837: @order = @{$order};
1838: } else {
1839: @order = sort(keys(%$hash));
1.501 banghart 1840: }
1841: if (exists($$hash{'select_form_order'})) {
1842: @order = @{$$hash{'select_form_order'}};
1843: }
1844:
1.284 albertel 1845: foreach my $key (@order) {
1.356 albertel 1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1847: $output.='selected="selected" ' if ($selected{$key});
1848: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1849: }
1850: $output.="</select>\n";
1851: return $output;
1852: }
1853:
1.88 www 1854: #-------------------------------------------
1855:
1856: =pod
1857:
1.648 raeburn 1858: =item * &select_form($defdom,$name,%hash)
1.88 www 1859:
1860: Returns a string containing a <select name='$name' size='1'> form to
1861: allow a user to select options from a hash option_name => displayed text.
1862: See lonrights.pm for an example invocation and use.
1863:
1864: =cut
1865:
1866: #-------------------------------------------
1867: sub select_form {
1868: my ($def,$name,%hash) = @_;
1869: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1870: my @keys;
1871: if (exists($hash{'select_form_order'})) {
1872: @keys=@{$hash{'select_form_order'}};
1873: } else {
1874: @keys=sort(keys(%hash));
1875: }
1.356 albertel 1876: foreach my $key (@keys) {
1877: $selectform.=
1878: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1879: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1880: ">".$hash{$key}."</option>\n";
1.88 www 1881: }
1882: $selectform.="</select>";
1883: return $selectform;
1884: }
1885:
1.475 www 1886: # For display filters
1887:
1888: sub display_filter {
1889: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1890: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1891: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1892: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1893: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1894: '</label></span> <span class="LC_nobreak">'.
1.475 www 1895: &mt('Filter [_1]',
1.477 www 1896: &select_form($env{'form.displayfilter'},
1897: 'displayfilter',
1898: ('currentfolder' => 'Current folder/page',
1899: 'containing' => 'Containing phrase',
1900: 'none' => 'None'))).
1.714 bisitz 1901: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1902: }
1903:
1.167 www 1904: sub gradeleveldescription {
1905: my $gradelevel=shift;
1906: my %gradelevels=(0 => 'Not specified',
1907: 1 => 'Grade 1',
1908: 2 => 'Grade 2',
1909: 3 => 'Grade 3',
1910: 4 => 'Grade 4',
1911: 5 => 'Grade 5',
1912: 6 => 'Grade 6',
1913: 7 => 'Grade 7',
1914: 8 => 'Grade 8',
1915: 9 => 'Grade 9',
1916: 10 => 'Grade 10',
1917: 11 => 'Grade 11',
1918: 12 => 'Grade 12',
1919: 13 => 'Grade 13',
1920: 14 => '100 Level',
1921: 15 => '200 Level',
1922: 16 => '300 Level',
1923: 17 => '400 Level',
1924: 18 => 'Graduate Level');
1925: return &mt($gradelevels{$gradelevel});
1926: }
1927:
1.163 www 1928: sub select_level_form {
1929: my ($deflevel,$name)=@_;
1930: unless ($deflevel) { $deflevel=0; }
1.167 www 1931: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1932: for (my $i=0; $i<=18; $i++) {
1933: $selectform.="<option value=\"$i\" ".
1.253 albertel 1934: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1935: ">".&gradeleveldescription($i)."</option>\n";
1936: }
1937: $selectform.="</select>";
1938: return $selectform;
1.163 www 1939: }
1.167 www 1940:
1.35 matthew 1941: #-------------------------------------------
1942:
1.45 matthew 1943: =pod
1944:
1.910 raeburn 1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1946:
1947: Returns a string containing a <select name='$name' size='1'> form to
1948: allow a user to select the domain to preform an operation in.
1949: See loncreateuser.pm for an example invocation and use.
1950:
1.90 www 1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
1952: selected");
1953:
1.743 raeburn 1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1955:
1.910 raeburn 1956: 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.
1957:
1958: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1959:
1.35 matthew 1960: =cut
1961:
1962: #-------------------------------------------
1.34 matthew 1963: sub select_dom_form {
1.910 raeburn 1964: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1965: if ($onchange) {
1.874 raeburn 1966: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1967: }
1.910 raeburn 1968: my @domains;
1969: if (ref($incdoms) eq 'ARRAY') {
1970: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1971: } else {
1972: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1973: }
1.90 www 1974: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1975: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1976: foreach my $dom (@domains) {
1977: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1978: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1979: if ($showdomdesc) {
1980: if ($dom ne '') {
1981: my $domdesc = &Apache::lonnet::domain($dom,'description');
1982: if ($domdesc ne '') {
1983: $selectdomain .= ' ('.$domdesc.')';
1984: }
1985: }
1986: }
1987: $selectdomain .= "</option>\n";
1.34 matthew 1988: }
1989: $selectdomain.="</select>";
1990: return $selectdomain;
1991: }
1992:
1.35 matthew 1993: #-------------------------------------------
1994:
1.45 matthew 1995: =pod
1996:
1.648 raeburn 1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1998:
1.586 raeburn 1999: input: 4 arguments (two required, two optional) -
2000: $domain - domain of new user
2001: $name - name of form element
2002: $default - Value of 'default' causes a default item to be first
2003: option, and selected by default.
2004: $hide - Value of 'hide' causes hiding of the name of the server,
2005: if 1 server found, or default, if 0 found.
1.594 raeburn 2006: output: returns 2 items:
1.586 raeburn 2007: (a) form element which contains either:
2008: (i) <select name="$name">
2009: <option value="$hostid1">$hostid $servers{$hostid}</option>
2010: <option value="$hostid2">$hostid $servers{$hostid}</option>
2011: </select>
2012: form item if there are multiple library servers in $domain, or
2013: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2014: if there is only one library server in $domain.
2015:
2016: (b) number of library servers found.
2017:
2018: See loncreateuser.pm for example of use.
1.35 matthew 2019:
2020: =cut
2021:
2022: #-------------------------------------------
1.586 raeburn 2023: sub home_server_form_item {
2024: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2025: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2026: my $result;
2027: my $numlib = keys(%servers);
2028: if ($numlib > 1) {
2029: $result .= '<select name="'.$name.'" />'."\n";
2030: if ($default) {
1.804 bisitz 2031: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2032: '</option>'."\n";
2033: }
2034: foreach my $hostid (sort(keys(%servers))) {
2035: $result.= '<option value="'.$hostid.'">'.
2036: $hostid.' '.$servers{$hostid}."</option>\n";
2037: }
2038: $result .= '</select>'."\n";
2039: } elsif ($numlib == 1) {
2040: my $hostid;
2041: foreach my $item (keys(%servers)) {
2042: $hostid = $item;
2043: }
2044: $result .= '<input type="hidden" name="'.$name.'" value="'.
2045: $hostid.'" />';
2046: if (!$hide) {
2047: $result .= $hostid.' '.$servers{$hostid};
2048: }
2049: $result .= "\n";
2050: } elsif ($default) {
2051: $result .= '<input type="hidden" name="'.$name.
2052: '" value="default" />';
2053: if (!$hide) {
2054: $result .= &mt('default');
2055: }
2056: $result .= "\n";
1.33 matthew 2057: }
1.586 raeburn 2058: return ($result,$numlib);
1.33 matthew 2059: }
1.112 bowersj2 2060:
2061: =pod
2062:
1.534 albertel 2063: =back
2064:
1.112 bowersj2 2065: =cut
1.87 matthew 2066:
2067: ###############################################################
1.112 bowersj2 2068: ## Decoding User Agent ##
1.87 matthew 2069: ###############################################################
2070:
2071: =pod
2072:
1.112 bowersj2 2073: =head1 Decoding the User Agent
2074:
2075: =over 4
2076:
2077: =item * &decode_user_agent()
1.87 matthew 2078:
2079: Inputs: $r
2080:
2081: Outputs:
2082:
2083: =over 4
2084:
1.112 bowersj2 2085: =item * $httpbrowser
1.87 matthew 2086:
1.112 bowersj2 2087: =item * $clientbrowser
1.87 matthew 2088:
1.112 bowersj2 2089: =item * $clientversion
1.87 matthew 2090:
1.112 bowersj2 2091: =item * $clientmathml
1.87 matthew 2092:
1.112 bowersj2 2093: =item * $clientunicode
1.87 matthew 2094:
1.112 bowersj2 2095: =item * $clientos
1.87 matthew 2096:
2097: =back
2098:
1.157 matthew 2099: =back
2100:
1.87 matthew 2101: =cut
2102:
2103: ###############################################################
2104: ###############################################################
2105: sub decode_user_agent {
1.247 albertel 2106: my ($r)=@_;
1.87 matthew 2107: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2108: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2109: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2110: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2111: my $clientbrowser='unknown';
2112: my $clientversion='0';
2113: my $clientmathml='';
2114: my $clientunicode='0';
2115: for (my $i=0;$i<=$#browsertype;$i++) {
2116: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2117: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2118: $clientbrowser=$bname;
2119: $httpbrowser=~/$vreg/i;
2120: $clientversion=$1;
2121: $clientmathml=($clientversion>=$minv);
2122: $clientunicode=($clientversion>=$univ);
2123: }
2124: }
2125: my $clientos='unknown';
2126: if (($httpbrowser=~/linux/i) ||
2127: ($httpbrowser=~/unix/i) ||
2128: ($httpbrowser=~/ux/i) ||
2129: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2130: if (($httpbrowser=~/vax/i) ||
2131: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2132: if ($httpbrowser=~/next/i) { $clientos='next'; }
2133: if (($httpbrowser=~/mac/i) ||
2134: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2135: if ($httpbrowser=~/win/i) { $clientos='win'; }
2136: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2137: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2138: $clientunicode,$clientos,);
2139: }
2140:
1.32 matthew 2141: ###############################################################
2142: ## Authentication changing form generation subroutines ##
2143: ###############################################################
2144: ##
2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
2146: ## hash, and have reasonable default values.
2147: ##
2148: ## formname = the name given in the <form> tag.
1.35 matthew 2149: #-------------------------------------------
2150:
1.45 matthew 2151: =pod
2152:
1.112 bowersj2 2153: =head1 Authentication Routines
2154:
2155: =over 4
2156:
1.648 raeburn 2157: =item * &authform_xxxxxx()
1.35 matthew 2158:
2159: The authform_xxxxxx subroutines provide javascript and html forms which
2160: handle some of the conveniences required for authentication forms.
2161: This is not an optimal method, but it works.
2162:
2163: =over 4
2164:
1.112 bowersj2 2165: =item * authform_header
1.35 matthew 2166:
1.112 bowersj2 2167: =item * authform_authorwarning
1.35 matthew 2168:
1.112 bowersj2 2169: =item * authform_nochange
1.35 matthew 2170:
1.112 bowersj2 2171: =item * authform_kerberos
1.35 matthew 2172:
1.112 bowersj2 2173: =item * authform_internal
1.35 matthew 2174:
1.112 bowersj2 2175: =item * authform_filesystem
1.35 matthew 2176:
2177: =back
2178:
1.648 raeburn 2179: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2180:
1.35 matthew 2181: =cut
2182:
2183: #-------------------------------------------
1.32 matthew 2184: sub authform_header{
2185: my %in = (
2186: formname => 'cu',
1.80 albertel 2187: kerb_def_dom => '',
1.32 matthew 2188: @_,
2189: );
2190: $in{'formname'} = 'document.' . $in{'formname'};
2191: my $result='';
1.80 albertel 2192:
2193: #---------------------------------------------- Code for upper case translation
2194: my $Javascript_toUpperCase;
2195: unless ($in{kerb_def_dom}) {
2196: $Javascript_toUpperCase =<<"END";
2197: switch (choice) {
2198: case 'krb': currentform.elements[choicearg].value =
2199: currentform.elements[choicearg].value.toUpperCase();
2200: break;
2201: default:
2202: }
2203: END
2204: } else {
2205: $Javascript_toUpperCase = "";
2206: }
2207:
1.165 raeburn 2208: my $radioval = "'nochange'";
1.591 raeburn 2209: if (defined($in{'curr_authtype'})) {
2210: if ($in{'curr_authtype'} ne '') {
2211: $radioval = "'".$in{'curr_authtype'}."arg'";
2212: }
1.174 matthew 2213: }
1.165 raeburn 2214: my $argfield = 'null';
1.591 raeburn 2215: if (defined($in{'mode'})) {
1.165 raeburn 2216: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2217: if (defined($in{'curr_autharg'})) {
2218: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2219: $argfield = "'$in{'curr_autharg'}'";
2220: }
2221: }
2222: }
2223: }
2224:
1.32 matthew 2225: $result.=<<"END";
2226: var current = new Object();
1.165 raeburn 2227: current.radiovalue = $radioval;
2228: current.argfield = $argfield;
1.32 matthew 2229:
2230: function changed_radio(choice,currentform) {
2231: var choicearg = choice + 'arg';
2232: // If a radio button in changed, we need to change the argfield
2233: if (current.radiovalue != choice) {
2234: current.radiovalue = choice;
2235: if (current.argfield != null) {
2236: currentform.elements[current.argfield].value = '';
2237: }
2238: if (choice == 'nochange') {
2239: current.argfield = null;
2240: } else {
2241: current.argfield = choicearg;
2242: switch(choice) {
2243: case 'krb':
2244: currentform.elements[current.argfield].value =
2245: "$in{'kerb_def_dom'}";
2246: break;
2247: default:
2248: break;
2249: }
2250: }
2251: }
2252: return;
2253: }
1.22 www 2254:
1.32 matthew 2255: function changed_text(choice,currentform) {
2256: var choicearg = choice + 'arg';
2257: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2258: $Javascript_toUpperCase
1.32 matthew 2259: // clear old field
2260: if ((current.argfield != choicearg) && (current.argfield != null)) {
2261: currentform.elements[current.argfield].value = '';
2262: }
2263: current.argfield = choicearg;
2264: }
2265: set_auth_radio_buttons(choice,currentform);
2266: return;
1.20 www 2267: }
1.32 matthew 2268:
2269: function set_auth_radio_buttons(newvalue,currentform) {
2270: var i=0;
2271: while (i < currentform.login.length) {
2272: if (currentform.login[i].value == newvalue) { break; }
2273: i++;
2274: }
2275: if (i == currentform.login.length) {
2276: return;
2277: }
2278: current.radiovalue = newvalue;
2279: currentform.login[i].checked = true;
2280: return;
2281: }
2282: END
2283: return $result;
2284: }
2285:
2286: sub authform_authorwarning{
2287: my $result='';
1.144 matthew 2288: $result='<i>'.
2289: &mt('As a general rule, only authors or co-authors should be '.
2290: 'filesystem authenticated '.
2291: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2292: return $result;
2293: }
2294:
2295: sub authform_nochange{
2296: my %in = (
2297: formname => 'document.cu',
2298: kerb_def_dom => 'MSU.EDU',
2299: @_,
2300: );
1.586 raeburn 2301: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2302: my $result;
2303: if (keys(%can_assign) == 0) {
2304: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2305: } else {
2306: $result = '<label>'.&mt('[_1] Do not change login data',
2307: '<input type="radio" name="login" value="nochange" '.
2308: 'checked="checked" onclick="'.
1.281 albertel 2309: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2310: '</label>';
1.586 raeburn 2311: }
1.32 matthew 2312: return $result;
2313: }
2314:
1.591 raeburn 2315: sub authform_kerberos {
1.32 matthew 2316: my %in = (
2317: formname => 'document.cu',
2318: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2319: kerb_def_auth => 'krb4',
1.32 matthew 2320: @_,
2321: );
1.586 raeburn 2322: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2323: $autharg,$jscall);
2324: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2325: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2326: $check5 = ' checked="checked"';
1.80 albertel 2327: } else {
1.772 bisitz 2328: $check4 = ' checked="checked"';
1.80 albertel 2329: }
1.165 raeburn 2330: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2331: if (defined($in{'curr_authtype'})) {
2332: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2333: $krbcheck = ' checked="checked"';
1.623 raeburn 2334: if (defined($in{'mode'})) {
2335: if ($in{'mode'} eq 'modifyuser') {
2336: $krbcheck = '';
2337: }
2338: }
1.591 raeburn 2339: if (defined($in{'curr_kerb_ver'})) {
2340: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2341: $check5 = ' checked="checked"';
1.591 raeburn 2342: $check4 = '';
2343: } else {
1.772 bisitz 2344: $check4 = ' checked="checked"';
1.591 raeburn 2345: $check5 = '';
2346: }
1.586 raeburn 2347: }
1.591 raeburn 2348: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2349: $krbarg = $in{'curr_autharg'};
2350: }
1.586 raeburn 2351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2352: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2353: $result =
2354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2355: $in{'curr_autharg'},$krbver);
2356: } else {
2357: $result =
2358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2359: }
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
1.784 bisitz 2365: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2366: }
2367: }
1.586 raeburn 2368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2369: return;
1.587 raeburn 2370: } elsif ($authtype eq '') {
1.591 raeburn 2371: if (defined($in{'mode'})) {
1.587 raeburn 2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
1.784 bisitz 2374: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2375: }
2376: }
2377: }
1.586 raeburn 2378: }
2379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="krb" '.
2382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2383: $krbcheck.' />';
2384: }
2385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2387: $in{'curr_authtype'} eq 'krb5') ||
2388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2389: $in{'curr_authtype'} eq 'krb4')) {
2390: $result .= &mt
1.144 matthew 2391: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2392: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2393: '<label>'.$authtype,
1.281 albertel 2394: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2395: 'value="'.$krbarg.'" '.
1.144 matthew 2396: 'onchange="'.$jscall.'" />',
1.281 albertel 2397: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2399: '</label>');
1.586 raeburn 2400: } elsif ($can_assign{'krb4'}) {
2401: $result .= &mt
2402: ('[_1] Kerberos authenticated with domain [_2] '.
2403: '[_3] Version 4 [_4]',
2404: '<label>'.$authtype,
2405: '</label><input type="text" size="10" name="krbarg" '.
2406: 'value="'.$krbarg.'" '.
2407: 'onchange="'.$jscall.'" />',
2408: '<label><input type="hidden" name="krbver" value="4" />',
2409: '</label>');
2410: } elsif ($can_assign{'krb5'}) {
2411: $result .= &mt
2412: ('[_1] Kerberos authenticated with domain [_2] '.
2413: '[_3] Version 5 [_4]',
2414: '<label>'.$authtype,
2415: '</label><input type="text" size="10" name="krbarg" '.
2416: 'value="'.$krbarg.'" '.
2417: 'onchange="'.$jscall.'" />',
2418: '<label><input type="hidden" name="krbver" value="5" />',
2419: '</label>');
2420: }
1.32 matthew 2421: return $result;
2422: }
2423:
2424: sub authform_internal{
1.586 raeburn 2425: my %in = (
1.32 matthew 2426: formname => 'document.cu',
2427: kerb_def_dom => 'MSU.EDU',
2428: @_,
2429: );
1.586 raeburn 2430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2432: if (defined($in{'curr_authtype'})) {
2433: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2434: if ($can_assign{'int'}) {
1.772 bisitz 2435: $intcheck = 'checked="checked" ';
1.623 raeburn 2436: if (defined($in{'mode'})) {
2437: if ($in{'mode'} eq 'modifyuser') {
2438: $intcheck = '';
2439: }
2440: }
1.591 raeburn 2441: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2442: $intarg = $in{'curr_autharg'};
2443: }
2444: } else {
2445: $result = &mt('Currently internally authenticated.');
2446: return $result;
1.165 raeburn 2447: }
2448: }
1.586 raeburn 2449: } else {
2450: if ($authnum == 1) {
1.784 bisitz 2451: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2452: }
2453: }
2454: if (!$can_assign{'int'}) {
2455: return;
1.587 raeburn 2456: } elsif ($authtype eq '') {
1.591 raeburn 2457: if (defined($in{'mode'})) {
1.587 raeburn 2458: if ($in{'mode'} eq 'modifycourse') {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2461: }
2462: }
2463: }
1.165 raeburn 2464: }
1.586 raeburn 2465: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2466: if ($authtype eq '') {
2467: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2468: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2469: }
1.605 bisitz 2470: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2471: $intarg.'" onchange="'.$jscall.'" />';
2472: $result = &mt
1.144 matthew 2473: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2474: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2475: $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 2476: return $result;
2477: }
2478:
2479: sub authform_local{
2480: my %in = (
2481: formname => 'document.cu',
2482: kerb_def_dom => 'MSU.EDU',
2483: @_,
2484: );
1.586 raeburn 2485: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2486: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2487: if (defined($in{'curr_authtype'})) {
2488: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2489: if ($can_assign{'loc'}) {
1.772 bisitz 2490: $loccheck = 'checked="checked" ';
1.623 raeburn 2491: if (defined($in{'mode'})) {
2492: if ($in{'mode'} eq 'modifyuser') {
2493: $loccheck = '';
2494: }
2495: }
1.591 raeburn 2496: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2497: $locarg = $in{'curr_autharg'};
2498: }
2499: } else {
2500: $result = &mt('Currently using local (institutional) authentication.');
2501: return $result;
1.165 raeburn 2502: }
2503: }
1.586 raeburn 2504: } else {
2505: if ($authnum == 1) {
1.784 bisitz 2506: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2507: }
2508: }
2509: if (!$can_assign{'loc'}) {
2510: return;
1.587 raeburn 2511: } elsif ($authtype eq '') {
1.591 raeburn 2512: if (defined($in{'mode'})) {
1.587 raeburn 2513: if ($in{'mode'} eq 'modifycourse') {
2514: if ($authnum == 1) {
1.784 bisitz 2515: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2516: }
2517: }
2518: }
1.165 raeburn 2519: }
1.586 raeburn 2520: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2521: if ($authtype eq '') {
2522: $authtype = '<input type="radio" name="login" value="loc" '.
2523: $loccheck.' onchange="'.$jscall.'" onclick="'.
2524: $jscall.'" />';
2525: }
2526: $autharg = '<input type="text" size="10" name="locarg" value="'.
2527: $locarg.'" onchange="'.$jscall.'" />';
2528: $result = &mt('[_1] Local Authentication with argument [_2]',
2529: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2530: return $result;
2531: }
2532:
2533: sub authform_filesystem{
2534: my %in = (
2535: formname => 'document.cu',
2536: kerb_def_dom => 'MSU.EDU',
2537: @_,
2538: );
1.586 raeburn 2539: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2540: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2541: if (defined($in{'curr_authtype'})) {
2542: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2543: if ($can_assign{'fsys'}) {
1.772 bisitz 2544: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2545: if (defined($in{'mode'})) {
2546: if ($in{'mode'} eq 'modifyuser') {
2547: $fsyscheck = '';
2548: }
2549: }
1.586 raeburn 2550: } else {
2551: $result = &mt('Currently Filesystem Authenticated.');
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2558: }
2559: }
2560: if (!$can_assign{'fsys'}) {
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="fsys" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="fsys" '.
2574: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2575: $jscall.'" />';
2576: }
2577: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2578: ' onchange="'.$jscall.'" />';
2579: $result = &mt
1.144 matthew 2580: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2581: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2582: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2583: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2584: 'onchange="'.$jscall.'" />');
1.32 matthew 2585: return $result;
2586: }
2587:
1.586 raeburn 2588: sub get_assignable_auth {
2589: my ($dom) = @_;
2590: if ($dom eq '') {
2591: $dom = $env{'request.role.domain'};
2592: }
2593: my %can_assign = (
2594: krb4 => 1,
2595: krb5 => 1,
2596: int => 1,
2597: loc => 1,
2598: );
2599: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2600: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2601: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2602: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2603: my $context;
2604: if ($env{'request.role'} =~ /^au/) {
2605: $context = 'author';
2606: } elsif ($env{'request.role'} =~ /^dc/) {
2607: $context = 'domain';
2608: } elsif ($env{'request.course.id'}) {
2609: $context = 'course';
2610: }
2611: if ($context) {
2612: if (ref($authhash->{$context}) eq 'HASH') {
2613: %can_assign = %{$authhash->{$context}};
2614: }
2615: }
2616: }
2617: }
2618: my $authnum = 0;
2619: foreach my $key (keys(%can_assign)) {
2620: if ($can_assign{$key}) {
2621: $authnum ++;
2622: }
2623: }
2624: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2625: $authnum --;
2626: }
2627: return ($authnum,%can_assign);
2628: }
2629:
1.80 albertel 2630: ###############################################################
2631: ## Get Kerberos Defaults for Domain ##
2632: ###############################################################
2633: ##
2634: ## Returns default kerberos version and an associated argument
2635: ## as listed in file domain.tab. If not listed, provides
2636: ## appropriate default domain and kerberos version.
2637: ##
2638: #-------------------------------------------
2639:
2640: =pod
2641:
1.648 raeburn 2642: =item * &get_kerberos_defaults()
1.80 albertel 2643:
2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2645: version and domain. If not found, it defaults to version 4 and the
2646: domain of the server.
1.80 albertel 2647:
1.648 raeburn 2648: =over 4
2649:
1.80 albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2651:
1.648 raeburn 2652: =back
2653:
2654: =back
2655:
1.80 albertel 2656: =cut
2657:
2658: #-------------------------------------------
2659: sub get_kerberos_defaults {
2660: my $domain=shift;
1.641 raeburn 2661: my ($krbdef,$krbdefdom);
2662: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2663: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2664: $krbdef = $domdefaults{'auth_def'};
2665: $krbdefdom = $domdefaults{'auth_arg_def'};
2666: } else {
1.80 albertel 2667: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2668: my $krbdefdom=$1;
2669: $krbdefdom=~tr/a-z/A-Z/;
2670: $krbdef = "krb4";
2671: }
2672: return ($krbdef,$krbdefdom);
2673: }
1.112 bowersj2 2674:
1.32 matthew 2675:
1.46 matthew 2676: ###############################################################
2677: ## Thesaurus Functions ##
2678: ###############################################################
1.20 www 2679:
1.46 matthew 2680: =pod
1.20 www 2681:
1.112 bowersj2 2682: =head1 Thesaurus Functions
2683:
2684: =over 4
2685:
1.648 raeburn 2686: =item * &initialize_keywords()
1.46 matthew 2687:
2688: Initializes the package variable %Keywords if it is empty. Uses the
2689: package variable $thesaurus_db_file.
2690:
2691: =cut
2692:
2693: ###################################################
2694:
2695: sub initialize_keywords {
2696: return 1 if (scalar keys(%Keywords));
2697: # If we are here, %Keywords is empty, so fill it up
2698: # Make sure the file we need exists...
2699: if (! -e $thesaurus_db_file) {
2700: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2701: " failed because it does not exist");
2702: return 0;
2703: }
2704: # Set up the hash as a database
2705: my %thesaurus_db;
2706: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2707: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2708: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2709: $thesaurus_db_file);
2710: return 0;
2711: }
2712: # Get the average number of appearances of a word.
2713: my $avecount = $thesaurus_db{'average.count'};
2714: # Put keywords (those that appear > average) into %Keywords
2715: while (my ($word,$data)=each (%thesaurus_db)) {
2716: my ($count,undef) = split /:/,$data;
2717: $Keywords{$word}++ if ($count > $avecount);
2718: }
2719: untie %thesaurus_db;
2720: # Remove special values from %Keywords.
1.356 albertel 2721: foreach my $value ('total.count','average.count') {
2722: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2723: }
1.46 matthew 2724: return 1;
2725: }
2726:
2727: ###################################################
2728:
2729: =pod
2730:
1.648 raeburn 2731: =item * &keyword($word)
1.46 matthew 2732:
2733: Returns true if $word is a keyword. A keyword is a word that appears more
2734: than the average number of times in the thesaurus database. Calls
2735: &initialize_keywords
2736:
2737: =cut
2738:
2739: ###################################################
1.20 www 2740:
2741: sub keyword {
1.46 matthew 2742: return if (!&initialize_keywords());
2743: my $word=lc(shift());
2744: $word=~s/\W//g;
2745: return exists($Keywords{$word});
1.20 www 2746: }
1.46 matthew 2747:
2748: ###############################################################
2749:
2750: =pod
1.20 www 2751:
1.648 raeburn 2752: =item * &get_related_words()
1.46 matthew 2753:
1.160 matthew 2754: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2755: an array of words. If the keyword is not in the thesaurus, an empty array
2756: will be returned. The order of the words returned is determined by the
2757: database which holds them.
2758:
2759: Uses global $thesaurus_db_file.
2760:
2761: =cut
2762:
2763: ###############################################################
2764: sub get_related_words {
2765: my $keyword = shift;
2766: my %thesaurus_db;
2767: if (! -e $thesaurus_db_file) {
2768: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2769: "failed because the file does not exist");
2770: return ();
2771: }
2772: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2773: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2774: return ();
2775: }
2776: my @Words=();
1.429 www 2777: my $count=0;
1.46 matthew 2778: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2779: # The first element is the number of times
2780: # the word appears. We do not need it now.
1.429 www 2781: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2782: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2783: my $threshold=$mostfrequentcount/10;
2784: foreach my $possibleword (@RelatedWords) {
2785: my ($word,$wordcount)=split(/\,/,$possibleword);
2786: if ($wordcount>$threshold) {
2787: push(@Words,$word);
2788: $count++;
2789: if ($count>10) { last; }
2790: }
1.20 www 2791: }
2792: }
1.46 matthew 2793: untie %thesaurus_db;
2794: return @Words;
1.14 harris41 2795: }
1.46 matthew 2796:
1.112 bowersj2 2797: =pod
2798:
2799: =back
2800:
2801: =cut
1.61 www 2802:
2803: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2804: =pod
2805:
1.112 bowersj2 2806: =head1 User Name Functions
2807:
2808: =over 4
2809:
1.648 raeburn 2810: =item * &plainname($uname,$udom,$first)
1.81 albertel 2811:
1.112 bowersj2 2812: Takes a users logon name and returns it as a string in
1.226 albertel 2813: "first middle last generation" form
2814: if $first is set to 'lastname' then it returns it as
2815: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2816:
2817: =cut
1.61 www 2818:
1.295 www 2819:
1.81 albertel 2820: ###############################################################
1.61 www 2821: sub plainname {
1.226 albertel 2822: my ($uname,$udom,$first)=@_;
1.537 albertel 2823: return if (!defined($uname) || !defined($udom));
1.295 www 2824: my %names=&getnames($uname,$udom);
1.226 albertel 2825: my $name=&Apache::lonnet::format_name($names{'firstname'},
2826: $names{'middlename'},
2827: $names{'lastname'},
2828: $names{'generation'},$first);
2829: $name=~s/^\s+//;
1.62 www 2830: $name=~s/\s+$//;
2831: $name=~s/\s+/ /g;
1.353 albertel 2832: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2833: return $name;
1.61 www 2834: }
1.66 www 2835:
2836: # -------------------------------------------------------------------- Nickname
1.81 albertel 2837: =pod
2838:
1.648 raeburn 2839: =item * &nickname($uname,$udom)
1.81 albertel 2840:
2841: Gets a users name and returns it as a string as
2842:
2843: ""nickname""
1.66 www 2844:
1.81 albertel 2845: if the user has a nickname or
2846:
2847: "first middle last generation"
2848:
2849: if the user does not
2850:
2851: =cut
1.66 www 2852:
2853: sub nickname {
2854: my ($uname,$udom)=@_;
1.537 albertel 2855: return if (!defined($uname) || !defined($udom));
1.295 www 2856: my %names=&getnames($uname,$udom);
1.68 albertel 2857: my $name=$names{'nickname'};
1.66 www 2858: if ($name) {
2859: $name='"'.$name.'"';
2860: } else {
2861: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2862: $names{'lastname'}.' '.$names{'generation'};
2863: $name=~s/\s+$//;
2864: $name=~s/\s+/ /g;
2865: }
2866: return $name;
2867: }
2868:
1.295 www 2869: sub getnames {
2870: my ($uname,$udom)=@_;
1.537 albertel 2871: return if (!defined($uname) || !defined($udom));
1.433 albertel 2872: if ($udom eq 'public' && $uname eq 'public') {
2873: return ('lastname' => &mt('Public'));
2874: }
1.295 www 2875: my $id=$uname.':'.$udom;
2876: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2877: if ($cached) {
2878: return %{$names};
2879: } else {
2880: my %loadnames=&Apache::lonnet::get('environment',
2881: ['firstname','middlename','lastname','generation','nickname'],
2882: $udom,$uname);
2883: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2884: return %loadnames;
2885: }
2886: }
1.61 www 2887:
1.542 raeburn 2888: # -------------------------------------------------------------------- getemails
1.648 raeburn 2889:
1.542 raeburn 2890: =pod
2891:
1.648 raeburn 2892: =item * &getemails($uname,$udom)
1.542 raeburn 2893:
2894: Gets a user's email information and returns it as a hash with keys:
2895: notification, critnotification, permanentemail
2896:
2897: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2899:
1.648 raeburn 2900:
1.542 raeburn 2901: =cut
2902:
1.648 raeburn 2903:
1.466 albertel 2904: sub getemails {
2905: my ($uname,$udom)=@_;
2906: if ($udom eq 'public' && $uname eq 'public') {
2907: return;
2908: }
1.467 www 2909: if (!$udom) { $udom=$env{'user.domain'}; }
2910: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2911: my $id=$uname.':'.$udom;
2912: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2913: if ($cached) {
2914: return %{$names};
2915: } else {
2916: my %loadnames=&Apache::lonnet::get('environment',
2917: ['notification','critnotification',
2918: 'permanentemail'],
2919: $udom,$uname);
2920: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2921: return %loadnames;
2922: }
2923: }
2924:
1.551 albertel 2925: sub flush_email_cache {
2926: my ($uname,$udom)=@_;
2927: if (!$udom) { $udom =$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: return if ($udom eq 'public' && $uname eq 'public');
2930: my $id=$uname.':'.$udom;
2931: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2932: }
2933:
1.728 raeburn 2934: # -------------------------------------------------------------------- getlangs
2935:
2936: =pod
2937:
2938: =item * &getlangs($uname,$udom)
2939:
2940: Gets a user's language preference and returns it as a hash with key:
2941: language.
2942:
2943: =cut
2944:
2945:
2946: sub getlangs {
2947: my ($uname,$udom) = @_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: my $id=$uname.':'.$udom;
2951: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2952: if ($cached) {
2953: return %{$langs};
2954: } else {
2955: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2956: $udom,$uname);
2957: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2958: return %loadlangs;
2959: }
2960: }
2961:
2962: sub flush_langs_cache {
2963: my ($uname,$udom)=@_;
2964: if (!$udom) { $udom =$env{'user.domain'}; }
2965: if (!$uname) { $uname=$env{'user.name'}; }
2966: return if ($udom eq 'public' && $uname eq 'public');
2967: my $id=$uname.':'.$udom;
2968: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2969: }
2970:
1.61 www 2971: # ------------------------------------------------------------------ Screenname
1.81 albertel 2972:
2973: =pod
2974:
1.648 raeburn 2975: =item * &screenname($uname,$udom)
1.81 albertel 2976:
2977: Gets a users screenname and returns it as a string
2978:
2979: =cut
1.61 www 2980:
2981: sub screenname {
2982: my ($uname,$udom)=@_;
1.258 albertel 2983: if ($uname eq $env{'user.name'} &&
2984: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2985: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2986: return $names{'screenname'};
1.62 www 2987: }
2988:
1.212 albertel 2989:
1.802 bisitz 2990: # ------------------------------------------------------------- Confirm Wrapper
2991: =pod
2992:
2993: =item confirmwrapper
2994:
2995: Wrap messages about completion of operation in box
2996:
2997: =cut
2998:
2999: sub confirmwrapper {
3000: my ($message)=@_;
3001: if ($message) {
3002: return "\n".'<div class="LC_confirm_box">'."\n"
3003: .$message."\n"
3004: .'</div>'."\n";
3005: } else {
3006: return $message;
3007: }
3008: }
3009:
1.62 www 3010: # ------------------------------------------------------------- Message Wrapper
3011:
3012: sub messagewrapper {
1.369 www 3013: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3014: return
1.441 albertel 3015: '<a href="/adm/email?compose=individual&'.
3016: 'recname='.$username.'&recdom='.$domain.
3017: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3018: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3019: }
1.802 bisitz 3020:
1.74 www 3021: # --------------------------------------------------------------- Notes Wrapper
3022:
3023: sub noteswrapper {
3024: my ($link,$un,$do)=@_;
3025: return
1.896 amueller 3026: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3027: }
1.802 bisitz 3028:
1.62 www 3029: # ------------------------------------------------------------- Aboutme Wrapper
3030:
3031: sub aboutmewrapper {
1.166 www 3032: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3033: if (!defined($username) && !defined($domain)) {
3034: return;
3035: }
1.892 amueller 3036: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3037: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3038: }
3039:
3040: # ------------------------------------------------------------ Syllabus Wrapper
3041:
3042: sub syllabuswrapper {
1.707 bisitz 3043: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3044: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3045: }
1.14 harris41 3046:
1.802 bisitz 3047: # -----------------------------------------------------------------------------
3048:
1.208 matthew 3049: sub track_student_link {
1.887 raeburn 3050: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3051: my $link ="/adm/trackstudent?";
1.208 matthew 3052: my $title = 'View recent activity';
3053: if (defined($sname) && $sname !~ /^\s*$/ &&
3054: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3055: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3056: $title .= ' of this student';
1.268 albertel 3057: }
1.208 matthew 3058: if (defined($target) && $target !~ /^\s*$/) {
3059: $target = qq{target="$target"};
3060: } else {
3061: $target = '';
3062: }
1.268 albertel 3063: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3064: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3065: $title = &mt($title);
3066: $linktext = &mt($linktext);
1.448 albertel 3067: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3068: &help_open_topic('View_recent_activity');
1.208 matthew 3069: }
3070:
1.781 raeburn 3071: sub slot_reservations_link {
3072: my ($linktext,$sname,$sdom,$target) = @_;
3073: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3074: my $title = 'View slot reservation history';
3075: if (defined($sname) && $sname !~ /^\s*$/ &&
3076: defined($sdom) && $sdom !~ /^\s*$/) {
3077: $link .= "&uname=$sname&udom=$sdom";
3078: $title .= ' of this student';
3079: }
3080: if (defined($target) && $target !~ /^\s*$/) {
3081: $target = qq{target="$target"};
3082: } else {
3083: $target = '';
3084: }
3085: $title = &mt($title);
3086: $linktext = &mt($linktext);
3087: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3089:
3090: }
3091:
1.508 www 3092: # ===================================================== Display a student photo
3093:
3094:
1.509 albertel 3095: sub student_image_tag {
1.508 www 3096: my ($domain,$user)=@_;
3097: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3098: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3099: return '<img src="'.$imgsrc.'" align="right" />';
3100: } else {
3101: return '';
3102: }
3103: }
3104:
1.112 bowersj2 3105: =pod
3106:
3107: =back
3108:
3109: =head1 Access .tab File Data
3110:
3111: =over 4
3112:
1.648 raeburn 3113: =item * &languageids()
1.112 bowersj2 3114:
3115: returns list of all language ids
3116:
3117: =cut
3118:
1.14 harris41 3119: sub languageids {
1.16 harris41 3120: return sort(keys(%language));
1.14 harris41 3121: }
3122:
1.112 bowersj2 3123: =pod
3124:
1.648 raeburn 3125: =item * &languagedescription()
1.112 bowersj2 3126:
3127: returns description of a specified language id
3128:
3129: =cut
3130:
1.14 harris41 3131: sub languagedescription {
1.125 www 3132: my $code=shift;
3133: return ($supported_language{$code}?'* ':'').
3134: $language{$code}.
1.126 www 3135: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3136: }
3137:
3138: sub plainlanguagedescription {
3139: my $code=shift;
3140: return $language{$code};
3141: }
3142:
3143: sub supportedlanguagecode {
3144: my $code=shift;
3145: return $supported_language{$code};
1.97 www 3146: }
3147:
1.112 bowersj2 3148: =pod
3149:
1.648 raeburn 3150: =item * ©rightids()
1.112 bowersj2 3151:
3152: returns list of all copyrights
3153:
3154: =cut
3155:
3156: sub copyrightids {
3157: return sort(keys(%cprtag));
3158: }
3159:
3160: =pod
3161:
1.648 raeburn 3162: =item * ©rightdescription()
1.112 bowersj2 3163:
3164: returns description of a specified copyright id
3165:
3166: =cut
3167:
3168: sub copyrightdescription {
1.166 www 3169: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3170: }
1.197 matthew 3171:
3172: =pod
3173:
1.648 raeburn 3174: =item * &source_copyrightids()
1.192 taceyjo1 3175:
3176: returns list of all source copyrights
3177:
3178: =cut
3179:
3180: sub source_copyrightids {
3181: return sort(keys(%scprtag));
3182: }
3183:
3184: =pod
3185:
1.648 raeburn 3186: =item * &source_copyrightdescription()
1.192 taceyjo1 3187:
3188: returns description of a specified source copyright id
3189:
3190: =cut
3191:
3192: sub source_copyrightdescription {
3193: return &mt($scprtag{shift(@_)});
3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.648 raeburn 3198: =item * &filecategories()
1.112 bowersj2 3199:
3200: returns list of all file categories
3201:
3202: =cut
3203:
3204: sub filecategories {
3205: return sort(keys(%category_extensions));
3206: }
3207:
3208: =pod
3209:
1.648 raeburn 3210: =item * &filecategorytypes()
1.112 bowersj2 3211:
3212: returns list of file types belonging to a given file
3213: category
3214:
3215: =cut
3216:
3217: sub filecategorytypes {
1.356 albertel 3218: my ($cat) = @_;
3219: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3220: }
3221:
3222: =pod
3223:
1.648 raeburn 3224: =item * &fileembstyle()
1.112 bowersj2 3225:
3226: returns embedding style for a specified file type
3227:
3228: =cut
3229:
3230: sub fileembstyle {
3231: return $fe{lc(shift(@_))};
1.169 www 3232: }
3233:
1.351 www 3234: sub filemimetype {
3235: return $fm{lc(shift(@_))};
3236: }
3237:
1.169 www 3238:
3239: sub filecategoryselect {
3240: my ($name,$value)=@_;
1.189 matthew 3241: return &select_form($value,$name,
1.169 www 3242: '' => &mt('Any category'),
3243: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3244: }
3245:
3246: =pod
3247:
1.648 raeburn 3248: =item * &filedescription()
1.112 bowersj2 3249:
3250: returns description for a specified file type
3251:
3252: =cut
3253:
3254: sub filedescription {
1.188 matthew 3255: my $file_description = $fd{lc(shift())};
3256: $file_description =~ s:([\[\]]):~$1:g;
3257: return &mt($file_description);
1.112 bowersj2 3258: }
3259:
3260: =pod
3261:
1.648 raeburn 3262: =item * &filedescriptionex()
1.112 bowersj2 3263:
3264: returns description for a specified file type with
3265: extra formatting
3266:
3267: =cut
3268:
3269: sub filedescriptionex {
3270: my $ex=shift;
1.188 matthew 3271: my $file_description = $fd{lc($ex)};
3272: $file_description =~ s:([\[\]]):~$1:g;
3273: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3274: }
3275:
3276: # End of .tab access
3277: =pod
3278:
3279: =back
3280:
3281: =cut
3282:
3283: # ------------------------------------------------------------------ File Types
3284: sub fileextensions {
3285: return sort(keys(%fe));
3286: }
3287:
1.97 www 3288: # ----------------------------------------------------------- Display Languages
3289: # returns a hash with all desired display languages
3290: #
3291:
3292: sub display_languages {
3293: my %languages=();
1.695 raeburn 3294: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3295: $languages{$lang}=1;
1.97 www 3296: }
3297: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3298: if ($env{'form.displaylanguage'}) {
1.356 albertel 3299: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3300: $languages{$lang}=1;
1.97 www 3301: }
3302: }
3303: return %languages;
1.14 harris41 3304: }
3305:
1.582 albertel 3306: sub languages {
3307: my ($possible_langs) = @_;
1.695 raeburn 3308: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3309: if (!ref($possible_langs)) {
3310: if( wantarray ) {
3311: return @preferred_langs;
3312: } else {
3313: return $preferred_langs[0];
3314: }
3315: }
3316: my %possibilities = map { $_ => 1 } (@$possible_langs);
3317: my @preferred_possibilities;
3318: foreach my $preferred_lang (@preferred_langs) {
3319: if (exists($possibilities{$preferred_lang})) {
3320: push(@preferred_possibilities, $preferred_lang);
3321: }
3322: }
3323: if( wantarray ) {
3324: return @preferred_possibilities;
3325: }
3326: return $preferred_possibilities[0];
3327: }
3328:
1.742 raeburn 3329: sub user_lang {
3330: my ($touname,$toudom,$fromcid) = @_;
3331: my @userlangs;
3332: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3333: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3334: $env{'course.'.$fromcid.'.languages'}));
3335: } else {
3336: my %langhash = &getlangs($touname,$toudom);
3337: if ($langhash{'languages'} ne '') {
3338: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3339: } else {
3340: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3341: if ($domdefs{'lang_def'} ne '') {
3342: @userlangs = ($domdefs{'lang_def'});
3343: }
3344: }
3345: }
3346: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3347: my $user_lh = Apache::localize->get_handle(@languages);
3348: return $user_lh;
3349: }
3350:
3351:
1.112 bowersj2 3352: ###############################################################
3353: ## Student Answer Attempts ##
3354: ###############################################################
3355:
3356: =pod
3357:
3358: =head1 Alternate Problem Views
3359:
3360: =over 4
3361:
1.648 raeburn 3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3363: $getattempt, $regexp, $gradesub)
3364:
3365: Return string with previous attempt on problem. Arguments:
3366:
3367: =over 4
3368:
3369: =item * $symb: Problem, including path
3370:
3371: =item * $username: username of the desired student
3372:
3373: =item * $domain: domain of the desired student
1.14 harris41 3374:
1.112 bowersj2 3375: =item * $course: Course ID
1.14 harris41 3376:
1.112 bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
3378: something
1.14 harris41 3379:
1.112 bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
3381: sent to $gradesub
1.14 harris41 3382:
1.112 bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3384:
1.112 bowersj2 3385: =back
1.14 harris41 3386:
1.112 bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16 harris41 3388:
1.112 bowersj2 3389: =cut
1.1 albertel 3390:
3391: sub get_previous_attempt {
1.43 ng 3392: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3393: my $prevattempts='';
1.43 ng 3394: no strict 'refs';
1.1 albertel 3395: if ($symb) {
1.3 albertel 3396: my (%returnhash)=
3397: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3398: if ($returnhash{'version'}) {
3399: my %lasthash=();
3400: my $version;
3401: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3402: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3403: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3404: }
1.1 albertel 3405: }
1.596 albertel 3406: $prevattempts=&start_data_table().&start_data_table_header_row();
3407: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3408: foreach my $key (sort(keys(%lasthash))) {
3409: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3410: if ($#parts > 0) {
1.31 albertel 3411: my $data=$parts[-1];
3412: pop(@parts);
1.596 albertel 3413: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3414: } else {
1.41 ng 3415: if ($#parts == 0) {
3416: $prevattempts.='<th>'.$parts[0].'</th>';
3417: } else {
3418: $prevattempts.='<th>'.$ign.'</th>';
3419: }
1.31 albertel 3420: }
1.16 harris41 3421: }
1.596 albertel 3422: $prevattempts.=&end_data_table_header_row();
1.40 ng 3423: if ($getattempt eq '') {
3424: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3425: $prevattempts.=&start_data_table_row().
3426: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3427: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3428: my $value = &format_previous_attempt_value($key,
3429: $returnhash{$version.':'.$key});
3430: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3431: }
1.596 albertel 3432: $prevattempts.=&end_data_table_row();
1.40 ng 3433: }
1.1 albertel 3434: }
1.596 albertel 3435: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3436: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3437: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3438: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3439: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3440: }
1.596 albertel 3441: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3442: } else {
1.596 albertel 3443: $prevattempts=
3444: &start_data_table().&start_data_table_row().
3445: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3446: &end_data_table_row().&end_data_table();
1.1 albertel 3447: }
3448: } else {
1.596 albertel 3449: $prevattempts=
3450: &start_data_table().&start_data_table_row().
3451: '<td>'.&mt('No data.').'</td>'.
3452: &end_data_table_row().&end_data_table();
1.1 albertel 3453: }
1.10 albertel 3454: }
3455:
1.581 albertel 3456: sub format_previous_attempt_value {
3457: my ($key,$value) = @_;
3458: if ($key =~ /timestamp/) {
3459: $value = &Apache::lonlocal::locallocaltime($value);
3460: } elsif (ref($value) eq 'ARRAY') {
3461: $value = '('.join(', ', @{ $value }).')';
3462: } else {
3463: $value = &unescape($value);
3464: }
3465: return $value;
3466: }
3467:
3468:
1.107 albertel 3469: sub relative_to_absolute {
3470: my ($url,$output)=@_;
3471: my $parser=HTML::TokeParser->new(\$output);
3472: my $token;
3473: my $thisdir=$url;
3474: my @rlinks=();
3475: while ($token=$parser->get_token) {
3476: if ($token->[0] eq 'S') {
3477: if ($token->[1] eq 'a') {
3478: if ($token->[2]->{'href'}) {
3479: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3480: }
3481: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3482: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3483: } elsif ($token->[1] eq 'base') {
3484: $thisdir=$token->[2]->{'href'};
3485: }
3486: }
3487: }
3488: $thisdir=~s-/[^/]*$--;
1.356 albertel 3489: foreach my $link (@rlinks) {
1.726 raeburn 3490: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3491: ($link=~/^\//) ||
3492: ($link=~/^javascript:/i) ||
3493: ($link=~/^mailto:/i) ||
3494: ($link=~/^\#/)) {
3495: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3496: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3497: }
3498: }
3499: # -------------------------------------------------- Deal with Applet codebases
3500: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3501: return $output;
3502: }
3503:
1.112 bowersj2 3504: =pod
3505:
1.648 raeburn 3506: =item * &get_student_view()
1.112 bowersj2 3507:
3508: show a snapshot of what student was looking at
3509:
3510: =cut
3511:
1.10 albertel 3512: sub get_student_view {
1.186 albertel 3513: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3514: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3515: my (%form);
1.10 albertel 3516: my @elements=('symb','courseid','domain','username');
3517: foreach my $element (@elements) {
1.186 albertel 3518: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3519: }
1.186 albertel 3520: if (defined($moreenv)) {
3521: %form=(%form,%{$moreenv});
3522: }
1.236 albertel 3523: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3524: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3525: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3526: $userview=~s/\<body[^\>]*\>//gi;
3527: $userview=~s/\<\/body\>//gi;
3528: $userview=~s/\<html\>//gi;
3529: $userview=~s/\<\/html\>//gi;
3530: $userview=~s/\<head\>//gi;
3531: $userview=~s/\<\/head\>//gi;
3532: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3533: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3534: if (wantarray) {
3535: return ($userview,$response);
3536: } else {
3537: return $userview;
3538: }
3539: }
3540:
3541: sub get_student_view_with_retries {
3542: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3543:
3544: my $ok = 0; # True if we got a good response.
3545: my $content;
3546: my $response;
3547:
3548: # Try to get the student_view done. within the retries count:
3549:
3550: do {
3551: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3552: $ok = $response->is_success;
3553: if (!$ok) {
3554: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3555: }
3556: $retries--;
3557: } while (!$ok && ($retries > 0));
3558:
3559: if (!$ok) {
3560: $content = ''; # On error return an empty content.
3561: }
1.651 www 3562: if (wantarray) {
3563: return ($content, $response);
3564: } else {
3565: return $content;
3566: }
1.11 albertel 3567: }
3568:
1.112 bowersj2 3569: =pod
3570:
1.648 raeburn 3571: =item * &get_student_answers()
1.112 bowersj2 3572:
3573: show a snapshot of how student was answering problem
3574:
3575: =cut
3576:
1.11 albertel 3577: sub get_student_answers {
1.100 sakharuk 3578: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3579: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3580: my (%moreenv);
1.11 albertel 3581: my @elements=('symb','courseid','domain','username');
3582: foreach my $element (@elements) {
1.186 albertel 3583: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3584: }
1.186 albertel 3585: $moreenv{'grade_target'}='answer';
3586: %moreenv=(%form,%moreenv);
1.497 raeburn 3587: $feedurl = &Apache::lonnet::clutter($feedurl);
3588: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3589: return $userview;
1.1 albertel 3590: }
1.116 albertel 3591:
3592: =pod
3593:
3594: =item * &submlink()
3595:
1.242 albertel 3596: Inputs: $text $uname $udom $symb $target
1.116 albertel 3597:
3598: Returns: A link to grades.pm such as to see the SUBM view of a student
3599:
3600: =cut
3601:
3602: ###############################################
3603: sub submlink {
1.242 albertel 3604: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3605: if (!($uname && $udom)) {
3606: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3607: &Apache::lonnet::whichuser($symb);
1.116 albertel 3608: if (!$symb) { $symb=$cursymb; }
3609: }
1.254 matthew 3610: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3611: $symb=&escape($symb);
1.242 albertel 3612: if ($target) { $target="target=\"$target\""; }
3613: return '<a href="/adm/grades?&command=submission&'.
3614: 'symb='.$symb.'&student='.$uname.
3615: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3616: }
3617: ##############################################
3618:
3619: =pod
3620:
3621: =item * &pgrdlink()
3622:
3623: Inputs: $text $uname $udom $symb $target
3624:
3625: Returns: A link to grades.pm such as to see the PGRD view of a student
3626:
3627: =cut
3628:
3629: ###############################################
3630: sub pgrdlink {
3631: my $link=&submlink(@_);
3632: $link=~s/(&command=submission)/$1&showgrading=yes/;
3633: return $link;
3634: }
3635: ##############################################
3636:
3637: =pod
3638:
3639: =item * &pprmlink()
3640:
3641: Inputs: $text $uname $udom $symb $target
3642:
3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3644: student and a specific resource
1.242 albertel 3645:
3646: =cut
3647:
3648: ###############################################
3649: sub pprmlink {
3650: my ($text,$uname,$udom,$symb,$target)=@_;
3651: if (!($uname && $udom)) {
3652: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3653: &Apache::lonnet::whichuser($symb);
1.242 albertel 3654: if (!$symb) { $symb=$cursymb; }
3655: }
1.254 matthew 3656: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3657: $symb=&escape($symb);
1.242 albertel 3658: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3659: return '<a href="/adm/parmset?command=set&'.
3660: 'symb='.$symb.'&uname='.$uname.
3661: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3662: }
3663: ##############################################
1.37 matthew 3664:
1.112 bowersj2 3665: =pod
3666:
3667: =back
3668:
3669: =cut
3670:
1.37 matthew 3671: ###############################################
1.51 www 3672:
3673:
3674: sub timehash {
1.687 raeburn 3675: my ($thistime) = @_;
3676: my $timezone = &Apache::lonlocal::gettimezone();
3677: my $dt = DateTime->from_epoch(epoch => $thistime)
3678: ->set_time_zone($timezone);
3679: my $wday = $dt->day_of_week();
3680: if ($wday == 7) { $wday = 0; }
3681: return ( 'second' => $dt->second(),
3682: 'minute' => $dt->minute(),
3683: 'hour' => $dt->hour(),
3684: 'day' => $dt->day_of_month(),
3685: 'month' => $dt->month(),
3686: 'year' => $dt->year(),
3687: 'weekday' => $wday,
3688: 'dayyear' => $dt->day_of_year(),
3689: 'dlsav' => $dt->is_dst() );
1.51 www 3690: }
3691:
1.370 www 3692: sub utc_string {
3693: my ($date)=@_;
1.371 www 3694: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3695: }
3696:
1.51 www 3697: sub maketime {
3698: my %th=@_;
1.687 raeburn 3699: my ($epoch_time,$timezone,$dt);
3700: $timezone = &Apache::lonlocal::gettimezone();
3701: eval {
3702: $dt = DateTime->new( year => $th{'year'},
3703: month => $th{'month'},
3704: day => $th{'day'},
3705: hour => $th{'hour'},
3706: minute => $th{'minute'},
3707: second => $th{'second'},
3708: time_zone => $timezone,
3709: );
3710: };
3711: if (!$@) {
3712: $epoch_time = $dt->epoch;
3713: if ($epoch_time) {
3714: return $epoch_time;
3715: }
3716: }
1.51 www 3717: return POSIX::mktime(
3718: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3719: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3720: }
3721:
3722: #########################################
1.51 www 3723:
3724: sub findallcourses {
1.482 raeburn 3725: my ($roles,$uname,$udom) = @_;
1.355 albertel 3726: my %roles;
3727: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3728: my %courses;
1.51 www 3729: my $now=time;
1.482 raeburn 3730: if (!defined($uname)) {
3731: $uname = $env{'user.name'};
3732: }
3733: if (!defined($udom)) {
3734: $udom = $env{'user.domain'};
3735: }
3736: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3737: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3738: if (!%roles) {
3739: %roles = (
3740: cc => 1,
1.907 raeburn 3741: co => 1,
1.482 raeburn 3742: in => 1,
3743: ep => 1,
3744: ta => 1,
3745: cr => 1,
3746: st => 1,
3747: );
3748: }
3749: foreach my $entry (keys(%roleshash)) {
3750: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3751: if ($trole =~ /^cr/) {
3752: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3753: } else {
3754: next if (!exists($roles{$trole}));
3755: }
3756: if ($tend) {
3757: next if ($tend < $now);
3758: }
3759: if ($tstart) {
3760: next if ($tstart > $now);
3761: }
3762: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3763: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3764: if ($secpart eq '') {
3765: ($cnum,$role) = split(/_/,$cnumpart);
3766: $sec = 'none';
3767: $realsec = '';
3768: } else {
3769: $cnum = $cnumpart;
3770: ($sec,$role) = split(/_/,$secpart);
3771: $realsec = $sec;
1.490 raeburn 3772: }
1.482 raeburn 3773: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3774: }
3775: } else {
3776: foreach my $key (keys(%env)) {
1.483 albertel 3777: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3778: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3779: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3780: next if ($role eq 'ca' || $role eq 'aa');
3781: next if (%roles && !exists($roles{$role}));
3782: my ($starttime,$endtime)=split(/\./,$env{$key});
3783: my $active=1;
3784: if ($starttime) {
3785: if ($now<$starttime) { $active=0; }
3786: }
3787: if ($endtime) {
3788: if ($now>$endtime) { $active=0; }
3789: }
3790: if ($active) {
3791: if ($sec eq '') {
3792: $sec = 'none';
3793: }
3794: $courses{$cdom.'_'.$cnum}{$sec} =
3795: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3796: }
3797: }
1.51 www 3798: }
3799: }
1.474 raeburn 3800: return %courses;
1.51 www 3801: }
1.37 matthew 3802:
1.54 www 3803: ###############################################
1.474 raeburn 3804:
3805: sub blockcheck {
1.482 raeburn 3806: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3807:
3808: if (!defined($udom)) {
3809: $udom = $env{'user.domain'};
3810: }
3811: if (!defined($uname)) {
3812: $uname = $env{'user.name'};
3813: }
3814:
3815: # If uname and udom are for a course, check for blocks in the course.
3816:
3817: if (&Apache::lonnet::is_course($udom,$uname)) {
3818: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3819: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3820: return ($startblock,$endblock);
3821: }
1.474 raeburn 3822:
1.502 raeburn 3823: my $startblock = 0;
3824: my $endblock = 0;
1.482 raeburn 3825: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3826:
1.490 raeburn 3827: # If uname is for a user, and activity is course-specific, i.e.,
3828: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3829:
1.490 raeburn 3830: if (($activity eq 'boards' || $activity eq 'chat' ||
3831: $activity eq 'groups') && ($env{'request.course.id'})) {
3832: foreach my $key (keys(%live_courses)) {
3833: if ($key ne $env{'request.course.id'}) {
3834: delete($live_courses{$key});
3835: }
3836: }
3837: }
3838:
3839: my $otheruser = 0;
3840: my %own_courses;
3841: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3842: # Resource belongs to user other than current user.
3843: $otheruser = 1;
3844: # Gather courses for current user
3845: %own_courses =
3846: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3847: }
3848:
3849: # Gather active course roles - course coordinator, instructor,
3850: # exam proctor, ta, student, or custom role.
1.474 raeburn 3851:
3852: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3853: my ($cdom,$cnum);
3854: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3855: $cdom = $env{'course.'.$course.'.domain'};
3856: $cnum = $env{'course.'.$course.'.num'};
3857: } else {
1.490 raeburn 3858: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3859: }
3860: my $no_ownblock = 0;
3861: my $no_userblock = 0;
1.533 raeburn 3862: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3863: # Check if current user has 'evb' priv for this
3864: if (defined($own_courses{$course})) {
3865: foreach my $sec (keys(%{$own_courses{$course}})) {
3866: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3867: if ($sec ne 'none') {
3868: $checkrole .= '/'.$sec;
3869: }
3870: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3871: $no_ownblock = 1;
3872: last;
3873: }
3874: }
3875: }
3876: # if they have 'evb' priv and are currently not playing student
3877: next if (($no_ownblock) &&
3878: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3879: }
1.474 raeburn 3880: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3881: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3882: if ($sec ne 'none') {
1.482 raeburn 3883: $checkrole .= '/'.$sec;
1.474 raeburn 3884: }
1.490 raeburn 3885: if ($otheruser) {
3886: # Resource belongs to user other than current user.
3887: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3888: my ($trole,$tdom,$tnum,$tsec);
3889: my $entry = $live_courses{$course}{$sec};
3890: if ($entry =~ /^cr/) {
3891: ($trole,$tdom,$tnum,$tsec) =
3892: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3893: } else {
3894: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3895: }
3896: my ($spec,$area,$trest,%allroles,%userroles);
3897: $area = '/'.$tdom.'/'.$tnum;
3898: $trest = $tnum;
3899: if ($tsec ne '') {
3900: $area .= '/'.$tsec;
3901: $trest .= '/'.$tsec;
3902: }
3903: $spec = $trole.'.'.$area;
3904: if ($trole =~ /^cr/) {
3905: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3906: $tdom,$spec,$trest,$area);
3907: } else {
3908: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3909: $tdom,$spec,$trest,$area);
3910: }
3911: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3912: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3913: if ($1) {
3914: $no_userblock = 1;
3915: last;
3916: }
3917: }
1.490 raeburn 3918: } else {
3919: # Resource belongs to current user
3920: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3921: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3922: $no_ownblock = 1;
3923: last;
3924: }
1.474 raeburn 3925: }
3926: }
3927: # if they have the evb priv and are currently not playing student
1.482 raeburn 3928: next if (($no_ownblock) &&
1.491 albertel 3929: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3930: next if ($no_userblock);
1.474 raeburn 3931:
1.866 kalberla 3932: # Retrieve blocking times and identity of locker for course
1.490 raeburn 3933: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3934:
3935: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3936: if (($start != 0) &&
3937: (($startblock == 0) || ($startblock > $start))) {
3938: $startblock = $start;
3939: }
3940: if (($end != 0) &&
3941: (($endblock == 0) || ($endblock < $end))) {
3942: $endblock = $end;
3943: }
1.490 raeburn 3944: }
3945: return ($startblock,$endblock);
3946: }
3947:
3948: sub get_blocks {
3949: my ($setters,$activity,$cdom,$cnum) = @_;
3950: my $startblock = 0;
3951: my $endblock = 0;
3952: my $course = $cdom.'_'.$cnum;
3953: $setters->{$course} = {};
3954: $setters->{$course}{'staff'} = [];
3955: $setters->{$course}{'times'} = [];
3956: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3957: foreach my $record (keys(%records)) {
3958: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3959: if ($start <= time && $end >= time) {
3960: my ($staff_name,$staff_dom,$title,$blocks) =
3961: &parse_block_record($records{$record});
3962: if ($blocks->{$activity} eq 'on') {
3963: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3964: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3965: if ( ($startblock == 0) || ($startblock > $start) ) {
3966: $startblock = $start;
1.490 raeburn 3967: }
1.491 albertel 3968: if ( ($endblock == 0) || ($endblock < $end) ) {
3969: $endblock = $end;
1.474 raeburn 3970: }
3971: }
3972: }
3973: }
3974: return ($startblock,$endblock);
3975: }
3976:
3977: sub parse_block_record {
3978: my ($record) = @_;
3979: my ($setuname,$setudom,$title,$blocks);
3980: if (ref($record) eq 'HASH') {
3981: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3982: $title = &unescape($record->{'event'});
3983: $blocks = $record->{'blocks'};
3984: } else {
3985: my @data = split(/:/,$record,3);
3986: if (scalar(@data) eq 2) {
3987: $title = $data[1];
3988: ($setuname,$setudom) = split(/@/,$data[0]);
3989: } else {
3990: ($setuname,$setudom,$title) = @data;
3991: }
3992: $blocks = { 'com' => 'on' };
3993: }
3994: return ($setuname,$setudom,$title,$blocks);
3995: }
3996:
1.854 kalberla 3997: sub blocking_status {
3998: my ($activity,$uname,$udom) = @_;
1.867 kalberla 3999: my %setters;
1.890 droeschl 4000:
4001: # check for active blocking
1.867 kalberla 4002: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4003:
1.890 droeschl 4004: my $blocked = $startblock && $endblock ? 1 : 0;
4005:
4006: # caller just wants to know whether a block is active
4007: if (!wantarray) { return $blocked; }
4008:
4009: # build a link to a popup window containing the details
4010: my $querystring = "?activity=$activity";
4011: # $uname and $udom decide whose portfolio the user is trying to look at
4012: $querystring .= "&udom=$udom" if $udom;
4013: $querystring .= "&uname=$uname" if $uname;
4014:
4015: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4016: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4017: var options = "width=" + w + ",height=" + h + ",";
4018: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4019: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4020: var newWin = window.open(url, wdwName, options);
4021: newWin.focus();
4022: }
1.890 droeschl 4023: END_MYBLOCK
1.854 kalberla 4024:
1.890 droeschl 4025: $output = Apache::lonhtmlcommon::scripttag($output);
4026:
1.854 kalberla 4027: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4028: my $text = mt('Communication Blocked');
4029:
1.867 kalberla 4030: $output .= <<"END_BLOCK";
4031: <div class='LC_comblock'>
1.869 kalberla 4032: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4033: title='$text'>
4034: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4035: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4036: title='$text'>$text</a>
1.867 kalberla 4037: </div>
4038:
4039: END_BLOCK
1.474 raeburn 4040:
1.854 kalberla 4041: return ($blocked, $output);
4042: }
1.490 raeburn 4043:
1.60 matthew 4044: ###############################################
4045:
1.682 raeburn 4046: sub check_ip_acc {
4047: my ($acc)=@_;
4048: &Apache::lonxml::debug("acc is $acc");
4049: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4050: return 1;
4051: }
4052: my $allowed=0;
4053: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4054:
4055: my $name;
4056: foreach my $pattern (split(',',$acc)) {
4057: $pattern =~ s/^\s*//;
4058: $pattern =~ s/\s*$//;
4059: if ($pattern =~ /\*$/) {
4060: #35.8.*
4061: $pattern=~s/\*//;
4062: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4063: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4064: #35.8.3.[34-56]
4065: my $low=$2;
4066: my $high=$3;
4067: $pattern=$1;
4068: if ($ip =~ /^\Q$pattern\E/) {
4069: my $last=(split(/\./,$ip))[3];
4070: if ($last <=$high && $last >=$low) { $allowed=1; }
4071: }
4072: } elsif ($pattern =~ /^\*/) {
4073: #*.msu.edu
4074: $pattern=~s/\*//;
4075: if (!defined($name)) {
4076: use Socket;
4077: my $netaddr=inet_aton($ip);
4078: ($name)=gethostbyaddr($netaddr,AF_INET);
4079: }
4080: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4081: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4082: #127.0.0.1
4083: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4084: } else {
4085: #some.name.com
4086: if (!defined($name)) {
4087: use Socket;
4088: my $netaddr=inet_aton($ip);
4089: ($name)=gethostbyaddr($netaddr,AF_INET);
4090: }
4091: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4092: }
4093: if ($allowed) { last; }
4094: }
4095: return $allowed;
4096: }
4097:
4098: ###############################################
4099:
1.60 matthew 4100: =pod
4101:
1.112 bowersj2 4102: =head1 Domain Template Functions
4103:
4104: =over 4
4105:
4106: =item * &determinedomain()
1.60 matthew 4107:
4108: Inputs: $domain (usually will be undef)
4109:
1.63 www 4110: Returns: Determines which domain should be used for designs
1.60 matthew 4111:
4112: =cut
1.54 www 4113:
1.60 matthew 4114: ###############################################
1.63 www 4115: sub determinedomain {
4116: my $domain=shift;
1.531 albertel 4117: if (! $domain) {
1.60 matthew 4118: # Determine domain if we have not been given one
1.893 raeburn 4119: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4120: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4121: if ($env{'request.role.domain'}) {
4122: $domain=$env{'request.role.domain'};
1.60 matthew 4123: }
4124: }
1.63 www 4125: return $domain;
4126: }
4127: ###############################################
1.517 raeburn 4128:
1.518 albertel 4129: sub devalidate_domconfig_cache {
4130: my ($udom)=@_;
4131: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4132: }
4133:
4134: # ---------------------- Get domain configuration for a domain
4135: sub get_domainconf {
4136: my ($udom) = @_;
4137: my $cachetime=1800;
4138: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4139: if (defined($cached)) { return %{$result}; }
4140:
4141: my %domconfig = &Apache::lonnet::get_dom('configuration',
4142: ['login','rolecolors'],$udom);
1.632 raeburn 4143: my (%designhash,%legacy);
1.518 albertel 4144: if (keys(%domconfig) > 0) {
4145: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4146: if (keys(%{$domconfig{'login'}})) {
4147: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4148: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4149: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4150: $designhash{$udom.'.login.'.$key.'_'.$img} =
4151: $domconfig{'login'}{$key}{$img};
4152: }
4153: } else {
4154: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4155: }
1.632 raeburn 4156: }
4157: } else {
4158: $legacy{'login'} = 1;
1.518 albertel 4159: }
1.632 raeburn 4160: } else {
4161: $legacy{'login'} = 1;
1.518 albertel 4162: }
4163: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4164: if (keys(%{$domconfig{'rolecolors'}})) {
4165: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4166: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4167: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4168: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4169: }
1.518 albertel 4170: }
4171: }
1.632 raeburn 4172: } else {
4173: $legacy{'rolecolors'} = 1;
1.518 albertel 4174: }
1.632 raeburn 4175: } else {
4176: $legacy{'rolecolors'} = 1;
1.518 albertel 4177: }
1.632 raeburn 4178: if (keys(%legacy) > 0) {
4179: my %legacyhash = &get_legacy_domconf($udom);
4180: foreach my $item (keys(%legacyhash)) {
4181: if ($item =~ /^\Q$udom\E\.login/) {
4182: if ($legacy{'login'}) {
4183: $designhash{$item} = $legacyhash{$item};
4184: }
4185: } else {
4186: if ($legacy{'rolecolors'}) {
4187: $designhash{$item} = $legacyhash{$item};
4188: }
1.518 albertel 4189: }
4190: }
4191: }
1.632 raeburn 4192: } else {
4193: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4194: }
4195: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4196: $cachetime);
4197: return %designhash;
4198: }
4199:
1.632 raeburn 4200: sub get_legacy_domconf {
4201: my ($udom) = @_;
4202: my %legacyhash;
4203: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4204: my $designfile = $designdir.'/'.$udom.'.tab';
4205: if (-e $designfile) {
4206: if ( open (my $fh,"<$designfile") ) {
4207: while (my $line = <$fh>) {
4208: next if ($line =~ /^\#/);
4209: chomp($line);
4210: my ($key,$val)=(split(/\=/,$line));
4211: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4212: }
4213: close($fh);
4214: }
4215: }
4216: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4217: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4218: }
4219: return %legacyhash;
4220: }
4221:
1.63 www 4222: =pod
4223:
1.112 bowersj2 4224: =item * &domainlogo()
1.63 www 4225:
4226: Inputs: $domain (usually will be undef)
4227:
4228: Returns: A link to a domain logo, if the domain logo exists.
4229: If the domain logo does not exist, a description of the domain.
4230:
4231: =cut
1.112 bowersj2 4232:
1.63 www 4233: ###############################################
4234: sub domainlogo {
1.517 raeburn 4235: my $domain = &determinedomain(shift);
1.518 albertel 4236: my %designhash = &get_domainconf($domain);
1.517 raeburn 4237: # See if there is a logo
4238: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4239: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4240: if ($imgsrc =~ m{^/(adm|res)/}) {
4241: if ($imgsrc =~ m{^/res/}) {
4242: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4243: &Apache::lonnet::repcopy($local_name);
4244: }
4245: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4246: }
4247: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4248: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4249: return &Apache::lonnet::domain($domain,'description');
1.59 www 4250: } else {
1.60 matthew 4251: return '';
1.59 www 4252: }
4253: }
1.63 www 4254: ##############################################
4255:
4256: =pod
4257:
1.112 bowersj2 4258: =item * &designparm()
1.63 www 4259:
4260: Inputs: $which parameter; $domain (usually will be undef)
4261:
4262: Returns: value of designparamter $which
4263:
4264: =cut
1.112 bowersj2 4265:
1.397 albertel 4266:
1.400 albertel 4267: ##############################################
1.397 albertel 4268: sub designparm {
4269: my ($which,$domain)=@_;
4270: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4271: return $env{'environment.color.'.$which};
1.96 www 4272: }
1.63 www 4273: $domain=&determinedomain($domain);
1.518 albertel 4274: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4275: my $output;
1.517 raeburn 4276: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4277: $output = $domdesign{$domain.'.'.$which};
1.63 www 4278: } else {
1.520 raeburn 4279: $output = $defaultdesign{$which};
4280: }
4281: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4282: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4283: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4284: if ($output =~ m{^/res/}) {
4285: my $local_name = &Apache::lonnet::filelocation('',$output);
4286: &Apache::lonnet::repcopy($local_name);
4287: }
1.520 raeburn 4288: $output = &lonhttpdurl($output);
4289: }
1.63 www 4290: }
1.520 raeburn 4291: return $output;
1.63 www 4292: }
1.59 www 4293:
1.822 bisitz 4294: ##############################################
4295: =pod
4296:
1.832 bisitz 4297: =item * &authorspace()
4298:
4299: Inputs: ./.
4300:
4301: Returns: Path to the Construction Space of the current user's
4302: accessed author space
4303: The author space will be that of the current user
4304: when accessing the own author space
4305: and that of the co-author/assistent co-author
4306: when accessing the co-author's/assistent co-author's
4307: space
4308:
4309: =cut
4310:
4311: sub authorspace {
4312: my $caname = '';
4313: if ($env{'request.role'} =~ /^ca|^aa/) {
4314: (undef,$caname) =
4315: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4316: } else {
4317: $caname = $env{'user.name'};
4318: }
4319: return '/priv/'.$caname.'/';
4320: }
4321:
4322: ##############################################
4323: =pod
4324:
1.822 bisitz 4325: =item * &head_subbox()
4326:
4327: Inputs: $content (contains HTML code with page functions, etc.)
4328:
4329: Returns: HTML div with $content
4330: To be included in page header
4331:
4332: =cut
4333:
4334: sub head_subbox {
4335: my ($content)=@_;
4336: my $output =
1.844 bisitz 4337: '<div id="LC_head_subbox">'
1.822 bisitz 4338: .$content
4339: .'</div>'
4340: }
4341:
4342: ##############################################
4343: =pod
4344:
4345: =item * &CSTR_pageheader()
4346:
4347: Inputs: ./.
4348:
4349: Returns: HTML div with CSTR path and recent box
4350: To be included on Construction Space pages
4351:
4352: =cut
4353:
4354: sub CSTR_pageheader {
4355: # this is for resources; directories have customtitle, and crumbs
4356: # and select recent are created in lonpubdir.pm
4357: my ($uname,$thisdisfn)=
4358: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4359: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4360: $formaction=~s/\/+/\//g;
4361:
4362: my $parentpath = '';
4363: my $lastitem = '';
4364: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4365: $parentpath = $1;
4366: $lastitem = $2;
4367: } else {
4368: $lastitem = $thisdisfn;
4369: }
1.921 bisitz 4370:
4371: my $output =
1.822 bisitz 4372: '<div>'
4373: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4374: .'<b>'.&mt('Construction Space:').'</b> '
4375: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4376: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4377: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4378:
4379: if ($lastitem) {
4380: $output .=
4381: '<span class="LC_filename">'
4382: .$lastitem
4383: .'</span>';
4384: }
4385: $output .=
4386: '<br />'
1.822 bisitz 4387: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4388: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4389: .'</form>'
4390: .&Apache::lonmenu::constspaceform()
4391: .'</div>';
1.921 bisitz 4392:
4393: return $output;
1.822 bisitz 4394: }
4395:
1.60 matthew 4396: ###############################################
4397: ###############################################
4398:
4399: =pod
4400:
1.112 bowersj2 4401: =back
4402:
1.549 albertel 4403: =head1 HTML Helpers
1.112 bowersj2 4404:
4405: =over 4
4406:
4407: =item * &bodytag()
1.60 matthew 4408:
4409: Returns a uniform header for LON-CAPA web pages.
4410:
4411: Inputs:
4412:
1.112 bowersj2 4413: =over 4
4414:
4415: =item * $title, A title to be displayed on the page.
4416:
4417: =item * $function, the current role (can be undef).
4418:
4419: =item * $addentries, extra parameters for the <body> tag.
4420:
4421: =item * $bodyonly, if defined, only return the <body> tag.
4422:
4423: =item * $domain, if defined, force a given domain.
4424:
4425: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4426: text interface only)
1.60 matthew 4427:
1.814 bisitz 4428: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4429: navigational links
1.317 albertel 4430:
1.338 albertel 4431: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4432:
1.361 albertel 4433: =item * $no_inline_link, if true and in remote mode, don't show the
4434: 'Switch To Inline Menu' link
4435:
1.460 albertel 4436: =item * $args, optional argument valid values are
4437: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4438: inherit_jsmath -> when creating popup window in a page,
4439: should it have jsmath forced on by the
4440: current page
1.460 albertel 4441:
1.112 bowersj2 4442: =back
4443:
1.60 matthew 4444: Returns: A uniform header for LON-CAPA web pages.
4445: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4446: If $bodyonly is undef or zero, an html string containing a <body> tag and
4447: other decorations will be returned.
4448:
4449: =cut
4450:
1.54 www 4451: sub bodytag {
1.831 bisitz 4452: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4453: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4454:
1.460 albertel 4455: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4456:
1.183 matthew 4457: $function = &get_users_function() if (!$function);
1.339 albertel 4458: my $img = &designparm($function.'.img',$domain);
4459: my $font = &designparm($function.'.font',$domain);
4460: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4461:
1.803 bisitz 4462: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4463: 'bgcolor' => $pgbg,
1.339 albertel 4464: 'text' => $font,
4465: 'alink' => &designparm($function.'.alink',$domain),
4466: 'vlink' => &designparm($function.'.vlink',$domain),
4467: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4468: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4469:
1.63 www 4470: # role and realm
1.378 raeburn 4471: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4472: if ($role eq 'ca') {
1.479 albertel 4473: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4474: $realm = &plainname($rname,$rdom);
1.378 raeburn 4475: }
1.55 www 4476: # realm
1.258 albertel 4477: if ($env{'request.course.id'}) {
1.378 raeburn 4478: if ($env{'request.role'} !~ /^cr/) {
4479: $role = &Apache::lonnet::plaintext($role,&course_type());
4480: }
1.898 raeburn 4481: if ($env{'request.course.sec'}) {
4482: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4483: }
1.359 albertel 4484: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4485: } else {
4486: $role = &Apache::lonnet::plaintext($role);
1.54 www 4487: }
1.433 albertel 4488:
1.359 albertel 4489: if (!$realm) { $realm=' '; }
1.55 www 4490: # Set messages
1.60 matthew 4491: my $messages=&domainlogo($domain);
1.330 albertel 4492:
1.438 albertel 4493: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4494:
1.101 www 4495: # construct main body tag
1.359 albertel 4496: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4497: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4498:
1.530 albertel 4499: if ($bodyonly) {
1.60 matthew 4500: return $bodytag;
1.798 tempelho 4501: }
1.359 albertel 4502:
1.410 albertel 4503: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4504: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4505: undef($role);
1.434 albertel 4506: } else {
4507: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4508: }
1.359 albertel 4509:
1.762 bisitz 4510: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4511: #
4512: # Extra info if you are the DC
4513: my $dc_info = '';
4514: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4515: $env{'course.'.$env{'request.course.id'}.
4516: '.domain'}.'/'})) {
4517: my $cid = $env{'request.course.id'};
1.917 raeburn 4518: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4519: $dc_info =~ s/\s+$//;
1.359 albertel 4520: }
4521:
1.898 raeburn 4522: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4523: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4524:
1.837 bisitz 4525: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4526: # No Remote
1.916 droeschl 4527: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4528: return $bodytag;
4529: }
1.903 droeschl 4530:
4531: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4532:
4533: # if ($env{'request.state'} eq 'construct') {
4534: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4535: # }
4536:
1.359 albertel 4537:
4538:
1.916 droeschl 4539: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4540: if ($dc_info) {
4541: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4542: }
1.916 droeschl 4543: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4544: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4545: return $bodytag;
4546: }
1.894 droeschl 4547:
1.916 droeschl 4548: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4549:
1.903 droeschl 4550: $bodytag .= Apache::lonhtmlcommon::scripttag(
4551: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4552:
1.903 droeschl 4553: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4554:
1.917 raeburn 4555: if ($dc_info) {
4556: $dc_info = &dc_courseid_toggle($dc_info);
4557: }
4558: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4559:
1.903 droeschl 4560: #don't show menus for public users
4561: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4562: $bodytag .= Apache::lonmenu::secondary_menu();
4563: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4564: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4565: if ($env{'request.state'} eq 'construct') {
4566: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4567: $args->{'bread_crumbs'});
4568: } elsif ($forcereg) {
4569: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4570: }
1.903 droeschl 4571: }else{
4572: # this is to seperate menu from content when there's no secondary
4573: # menu. Especially needed for public accessible ressources.
4574: $bodytag .= '<hr style="clear:both" />';
4575: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4576: }
1.903 droeschl 4577:
4578: #SD testing
4579: #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235 raeburn 4580: return $bodytag;
1.94 www 4581: }
1.95 www 4582:
1.93 www 4583: #
1.95 www 4584: # Top frame rendering, Remote is up
1.93 www 4585: #
1.359 albertel 4586:
1.517 raeburn 4587: my $imgsrc = $img;
4588: if ($img =~ /^\/adm/) {
1.575 albertel 4589: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4590: }
4591: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4592:
1.305 www 4593: # Explicit link to get inline menu
1.361 albertel 4594: my $menu= ($no_inline_link?''
1.883 droeschl 4595: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4596:
4597: if ($dc_info) {
4598: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4599: }
4600:
1.916 droeschl 4601: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4602: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4603: <li>$menu</li>
1.917 raeburn 4604: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4605: return(<<ENDBODY);
1.60 matthew 4606: $bodytag
1.359 albertel 4607: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4608: <tr><td>$upperleft</td>
4609: <td>$messages </td>
1.54 www 4610: </tr>
1.359 albertel 4611: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4612: </tr>
1.356 albertel 4613: </table>
1.54 www 4614: ENDBODY
1.182 matthew 4615: }
4616:
1.917 raeburn 4617: sub dc_courseid_toggle {
4618: my ($dc_info) = @_;
4619: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4620: '<a href="javascript:showCourseID();">'.
4621: &mt('(More ...)').'</a></span>'.
4622: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4623: }
4624:
1.330 albertel 4625: sub make_attr_string {
4626: my ($register,$attr_ref) = @_;
4627:
4628: if ($attr_ref && !ref($attr_ref)) {
4629: die("addentries Must be a hash ref ".
4630: join(':',caller(1))." ".
4631: join(':',caller(0))." ");
4632: }
4633:
4634: if ($register) {
1.339 albertel 4635: my ($on_load,$on_unload);
4636: foreach my $key (keys(%{$attr_ref})) {
4637: if (lc($key) eq 'onload') {
4638: $on_load.=$attr_ref->{$key}.';';
4639: delete($attr_ref->{$key});
4640:
4641: } elsif (lc($key) eq 'onunload') {
4642: $on_unload.=$attr_ref->{$key}.';';
4643: delete($attr_ref->{$key});
4644: }
4645: }
4646: $attr_ref->{'onload'} =
4647: &Apache::lonmenu::loadevents(). $on_load;
4648: $attr_ref->{'onunload'}=
4649: &Apache::lonmenu::unloadevents().$on_unload;
4650: }
4651:
4652: # Accessibility font enhance
4653: if ($env{'browser.fontenhance'} eq 'on') {
4654: my $style;
4655: foreach my $key (keys(%{$attr_ref})) {
4656: if (lc($key) eq 'style') {
4657: $style.=$attr_ref->{$key}.';';
4658: delete($attr_ref->{$key});
4659: }
4660: }
4661: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4662: }
1.339 albertel 4663:
1.330 albertel 4664: my $attr_string;
4665: foreach my $attr (keys(%$attr_ref)) {
4666: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4667: }
4668: return $attr_string;
4669: }
4670:
4671:
1.182 matthew 4672: ###############################################
1.251 albertel 4673: ###############################################
4674:
4675: =pod
4676:
4677: =item * &endbodytag()
4678:
4679: Returns a uniform footer for LON-CAPA web pages.
4680:
1.635 raeburn 4681: Inputs: 1 - optional reference to an args hash
4682: If in the hash, key for noredirectlink has a value which evaluates to true,
4683: a 'Continue' link is not displayed if the page contains an
4684: internal redirect in the <head></head> section,
4685: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4686:
4687: =cut
4688:
4689: sub endbodytag {
1.635 raeburn 4690: my ($args) = @_;
1.251 albertel 4691: my $endbodytag='</body>';
1.269 albertel 4692: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4693: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4694: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4695: $endbodytag=
4696: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4697: &mt('Continue').'</a>'.
4698: $endbodytag;
4699: }
1.315 albertel 4700: }
1.251 albertel 4701: return $endbodytag;
4702: }
4703:
1.352 albertel 4704: =pod
4705:
4706: =item * &standard_css()
4707:
4708: Returns a style sheet
4709:
4710: Inputs: (all optional)
4711: domain -> force to color decorate a page for a specific
4712: domain
4713: function -> force usage of a specific rolish color scheme
4714: bgcolor -> override the default page bgcolor
4715:
4716: =cut
4717:
1.343 albertel 4718: sub standard_css {
1.345 albertel 4719: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4720: $function = &get_users_function() if (!$function);
4721: my $img = &designparm($function.'.img', $domain);
4722: my $tabbg = &designparm($function.'.tabbg', $domain);
4723: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4724: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4725: #second colour for later usage
1.345 albertel 4726: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4727: my $pgbg_or_bgcolor =
4728: $bgcolor ||
1.352 albertel 4729: &designparm($function.'.pgbg', $domain);
1.382 albertel 4730: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4731: my $alink = &designparm($function.'.alink', $domain);
4732: my $vlink = &designparm($function.'.vlink', $domain);
4733: my $link = &designparm($function.'.link', $domain);
4734:
1.704 muellerd 4735: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4736: my $bgcol = &designparm('login.bgcol',$domain);
4737: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4738:
1.602 albertel 4739: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4740: my $mono = 'monospace';
1.850 bisitz 4741: my $data_table_head = $sidebg;
4742: my $data_table_light = '#FAFAFA';
4743: my $data_table_dark = '#F0F0F0';
1.470 banghart 4744: my $data_table_darker = '#CCCCCC';
1.349 albertel 4745: my $data_table_highlight = '#FFFF00';
1.352 albertel 4746: my $mail_new = '#FFBB77';
4747: my $mail_new_hover = '#DD9955';
4748: my $mail_read = '#BBBB77';
4749: my $mail_read_hover = '#999944';
4750: my $mail_replied = '#AAAA88';
4751: my $mail_replied_hover = '#888855';
4752: my $mail_other = '#99BBBB';
4753: my $mail_other_hover = '#669999';
1.391 albertel 4754: my $table_header = '#DDDDDD';
1.489 raeburn 4755: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4756: my $lg_border_color = '#C8C8C8';
1.392 albertel 4757:
1.608 albertel 4758: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4759: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4760: : '0 3px 0 4px';
1.448 albertel 4761:
1.523 albertel 4762:
1.343 albertel 4763: return <<END;
1.795 www 4764: body {
1.911 bisitz 4765: font-family: $sans;
4766: line-height:130%;
4767: font-size:0.83em;
4768: color:$font;
1.795 www 4769: }
4770:
1.911 bisitz 4771: a:focus {
1.795 www 4772: color: red;
1.911 bisitz 4773: background: yellow;
1.795 www 4774: }
1.698 harmsja 4775:
1.911 bisitz 4776: form, .inline {
4777: display: inline;
1.795 www 4778: }
1.721 harmsja 4779:
1.795 www 4780: .LC_right {
1.911 bisitz 4781: text-align:right;
1.795 www 4782: }
4783:
4784: .LC_middle {
1.911 bisitz 4785: vertical-align:middle;
1.795 www 4786: }
1.721 harmsja 4787:
4788: /* just for tests */
1.911 bisitz 4789: .LC_400Box {
4790: width:400px;
4791: }
1.721 harmsja 4792: /* end */
4793:
1.778 bisitz 4794: .LC_filename {
4795: font-family: $mono;
4796: white-space:pre;
1.921 bisitz 4797: font-size: 120%;
1.778 bisitz 4798: }
4799:
4800: .LC_fileicon {
4801: border: none;
4802: height: 1.3em;
4803: vertical-align: text-bottom;
4804: margin-right: 0.3em;
4805: text-decoration:none;
4806: }
4807:
1.350 albertel 4808: .LC_error {
4809: color: red;
4810: font-size: larger;
4811: }
1.795 www 4812:
1.457 albertel 4813: .LC_warning,
4814: .LC_diff_removed {
1.733 bisitz 4815: color: red;
1.394 albertel 4816: }
1.532 albertel 4817:
4818: .LC_info,
1.457 albertel 4819: .LC_success,
4820: .LC_diff_added {
1.350 albertel 4821: color: green;
4822: }
1.795 www 4823:
1.802 bisitz 4824: div.LC_confirm_box {
4825: background-color: #FAFAFA;
4826: border: 1px solid $lg_border_color;
4827: margin-right: 0;
4828: padding: 5px;
4829: }
4830:
4831: div.LC_confirm_box .LC_error img,
4832: div.LC_confirm_box .LC_success img {
4833: vertical-align: middle;
4834: }
4835:
1.440 albertel 4836: .LC_icon {
1.771 droeschl 4837: border: none;
1.790 droeschl 4838: vertical-align: middle;
1.771 droeschl 4839: }
4840:
1.543 albertel 4841: .LC_docs_spacer {
4842: width: 25px;
4843: height: 1px;
1.771 droeschl 4844: border: none;
1.543 albertel 4845: }
1.346 albertel 4846:
1.532 albertel 4847: .LC_internal_info {
1.735 bisitz 4848: color: #999999;
1.532 albertel 4849: }
4850:
1.794 www 4851: .LC_discussion {
1.911 bisitz 4852: background: $tabbg;
4853: border: 1px solid black;
4854: margin: 2px;
1.794 www 4855: }
4856:
4857: .LC_disc_action_links_bar {
1.911 bisitz 4858: background: $tabbg;
4859: border: none;
4860: margin: 4px;
1.794 www 4861: }
4862:
4863: .LC_disc_action_left {
1.911 bisitz 4864: text-align: left;
1.794 www 4865: }
4866:
4867: .LC_disc_action_right {
1.911 bisitz 4868: text-align: right;
1.794 www 4869: }
4870:
4871: .LC_disc_new_item {
1.911 bisitz 4872: background: white;
4873: border: 2px solid red;
4874: margin: 2px;
1.794 www 4875: }
4876:
4877: .LC_disc_old_item {
1.911 bisitz 4878: background: white;
4879: border: 1px solid black;
4880: margin: 2px;
1.794 www 4881: }
4882:
1.458 albertel 4883: table.LC_pastsubmission {
4884: border: 1px solid black;
4885: margin: 2px;
4886: }
4887:
1.795 www 4888: table#LC_top_nav,
4889: table#LC_menubuttons,
4890: table#LC_nav_location {
1.345 albertel 4891: width: 100%;
4892: background: $pgbg;
1.392 albertel 4893: border: 2px;
1.402 albertel 4894: border-collapse: separate;
1.803 bisitz 4895: padding: 0;
1.345 albertel 4896: }
1.392 albertel 4897:
1.801 tempelho 4898: table#LC_title_bar a {
4899: color: $fontmenu;
4900: }
1.836 bisitz 4901:
1.807 droeschl 4902: table#LC_title_bar {
1.819 tempelho 4903: clear: both;
1.836 bisitz 4904: display: none;
1.807 droeschl 4905: }
4906:
1.795 www 4907: table#LC_title_bar,
4908: table.LC_breadcrumbs,
1.393 albertel 4909: table#LC_title_bar.LC_with_remote {
1.359 albertel 4910: width: 100%;
1.392 albertel 4911: border-color: $pgbg;
4912: border-style: solid;
4913: border-width: $border;
1.379 albertel 4914: background: $pgbg;
1.801 tempelho 4915: color: $fontmenu;
1.392 albertel 4916: border-collapse: collapse;
1.803 bisitz 4917: padding: 0;
1.819 tempelho 4918: margin: 0;
1.359 albertel 4919: }
1.795 www 4920:
1.913 droeschl 4921: /* #SD START (work in progress)*/
4922:
4923: ul.LC_bct {
4924: margin: 0;
4925: padding: 0;
4926: }
4927: ul.LC_bct ol {
4928: display: inline;
4929: }
4930: ul.LC_bct ul {
4931: display: inline;
4932: padding: 0;
4933: }
4934: ul.LC_bct li {
4935: list-style-type: none;
4936: display: inline;
4937: }
4938:
4939:
4940: ul.LC_breadcrumb_tools {
4941: }
4942:
4943: li.LC_breadcrumb_tools {
4944: }
4945: li.LC_breadcrumb_tools img{
4946: vertical-align: middle;
4947: }
4948:
4949: .LC_breadcrumb_tools_A {
4950: margin: 0 0 0 1em;
4951: }
4952: .LC_breadcrumb_tools_B {
4953: float: right;
4954: margin-top: 0.4em;
4955: }
4956: .LC_breadcrumb_tools_C {
4957: margin: 0 1em 0 0;
4958: float: right;
4959: }
4960: /* #SD END */
4961:
1.359 albertel 4962: table#LC_title_bar td {
4963: background: $tabbg;
4964: }
1.795 www 4965:
1.911 bisitz 4966: table#LC_menubuttons img {
1.803 bisitz 4967: border: none;
1.346 albertel 4968: }
1.795 www 4969:
1.345 albertel 4970: table#LC_top_nav td {
4971: background: $tabbg;
1.803 bisitz 4972: border: none;
1.407 albertel 4973: font-size: small;
1.706 harmsja 4974: vertical-align:top;
4975: padding:2px 5px 2px 5px;
1.345 albertel 4976: }
1.795 www 4977:
4978: table#LC_top_nav td a,
4979: div#LC_top_nav a {
1.345 albertel 4980: color: $font;
4981: }
1.795 www 4982:
1.364 albertel 4983: table#LC_top_nav td.LC_top_nav_logo {
4984: background: $tabbg;
1.432 albertel 4985: text-align: left;
1.408 albertel 4986: white-space: nowrap;
1.432 albertel 4987: width: 31px;
1.408 albertel 4988: }
1.795 www 4989:
1.408 albertel 4990: table#LC_top_nav td.LC_top_nav_logo img {
1.803 bisitz 4991: border: none;
1.408 albertel 4992: vertical-align: bottom;
1.364 albertel 4993: }
1.795 www 4994:
1.777 tempelho 4995: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4996: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4997: width: 2.0em;
4998: }
1.795 www 4999:
1.442 albertel 5000: table#LC_top_nav td.LC_top_nav_login {
5001: width: 4.0em;
5002: text-align: center;
5003: }
1.795 www 5004:
1.842 droeschl 5005: .LC_breadcrumbs_component {
1.911 bisitz 5006: float: right;
5007: margin: 0 1em;
1.357 albertel 5008: }
1.842 droeschl 5009: .LC_breadcrumbs_component img {
1.911 bisitz 5010: vertical-align: middle;
1.777 tempelho 5011: }
1.795 www 5012:
1.383 albertel 5013: td.LC_table_cell_checkbox {
5014: text-align: center;
5015: }
1.795 www 5016:
5017: .LC_fontsize_small {
1.911 bisitz 5018: font-size: 70%;
1.705 tempelho 5019: }
5020:
1.844 bisitz 5021: #LC_breadcrumbs {
1.911 bisitz 5022: clear:both;
5023: background: $sidebg;
5024: border-bottom: 1px solid $lg_border_color;
5025: line-height: 2.5em;
1.915 droeschl 5026: /* SD working here
5027: height: 2.5em;
5028: overflow: hidden; */
1.911 bisitz 5029: margin: 0;
5030: padding: 0;
1.819 tempelho 5031: }
1.862 bisitz 5032:
1.839 droeschl 5033: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5034: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5035: display:none;
1.839 droeschl 5036: }
1.819 tempelho 5037:
1.844 bisitz 5038: #LC_head_subbox {
1.911 bisitz 5039: clear:both;
5040: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5041: border: 1px solid $sidebg;
5042: margin: 0 0 10px 0;
1.822 bisitz 5043: }
5044:
1.795 www 5045: .LC_fontsize_medium {
1.911 bisitz 5046: font-size: 85%;
1.705 tempelho 5047: }
5048:
1.795 www 5049: .LC_fontsize_large {
1.911 bisitz 5050: font-size: 120%;
1.705 tempelho 5051: }
5052:
1.346 albertel 5053: .LC_menubuttons_inline_text {
5054: color: $font;
1.698 harmsja 5055: font-size: 90%;
1.701 harmsja 5056: padding-left:3px;
1.346 albertel 5057: }
5058:
1.526 www 5059: .LC_menubuttons_link {
5060: text-decoration: none;
5061: }
1.795 www 5062:
1.522 albertel 5063: .LC_menubuttons_category {
1.521 www 5064: color: $font;
1.526 www 5065: background: $pgbg;
1.521 www 5066: font-size: larger;
5067: font-weight: bold;
5068: }
5069:
1.346 albertel 5070: td.LC_menubuttons_text {
1.911 bisitz 5071: color: $font;
1.346 albertel 5072: }
1.706 harmsja 5073:
1.346 albertel 5074: .LC_current_location {
5075: background: $tabbg;
5076: }
1.795 www 5077:
1.346 albertel 5078: .LC_new_mail {
1.634 www 5079: background: $tabbg;
1.346 albertel 5080: font-weight: bold;
5081: }
1.347 albertel 5082:
1.795 www 5083: table.LC_data_table,
5084: table.LC_mail_list {
1.347 albertel 5085: border: 1px solid #000000;
1.402 albertel 5086: border-collapse: separate;
1.426 albertel 5087: border-spacing: 1px;
1.610 albertel 5088: background: $pgbg;
1.347 albertel 5089: }
1.795 www 5090:
1.422 albertel 5091: .LC_data_table_dense {
5092: font-size: small;
5093: }
1.795 www 5094:
1.507 raeburn 5095: table.LC_nested_outer {
5096: border: 1px solid #000000;
1.589 raeburn 5097: border-collapse: collapse;
1.803 bisitz 5098: border-spacing: 0;
1.507 raeburn 5099: width: 100%;
5100: }
1.795 www 5101:
1.879 raeburn 5102: table.LC_innerpickbox,
1.507 raeburn 5103: table.LC_nested {
1.803 bisitz 5104: border: none;
1.589 raeburn 5105: border-collapse: collapse;
1.803 bisitz 5106: border-spacing: 0;
1.507 raeburn 5107: width: 100%;
5108: }
1.795 www 5109:
1.911 bisitz 5110: table.LC_data_table tr th,
5111: table.LC_calendar tr th,
1.795 www 5112: table.LC_mail_list tr th,
1.879 raeburn 5113: table.LC_prior_tries tr th,
5114: table.LC_innerpickbox tr th {
1.349 albertel 5115: font-weight: bold;
5116: background-color: $data_table_head;
1.801 tempelho 5117: color:$fontmenu;
1.701 harmsja 5118: font-size:90%;
1.347 albertel 5119: }
1.795 www 5120:
1.879 raeburn 5121: table.LC_innerpickbox tr th,
5122: table.LC_innerpickbox tr td {
5123: vertical-align: top;
5124: }
5125:
1.711 raeburn 5126: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5127: background-color: #CCCCCC;
1.711 raeburn 5128: font-weight: bold;
5129: text-align: left;
5130: }
1.795 www 5131:
1.912 bisitz 5132: table.LC_data_table tr.LC_odd_row > td {
5133: background-color: $data_table_light;
5134: padding: 2px;
5135: vertical-align: top;
5136: }
5137:
1.809 bisitz 5138: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5139: background-color: $data_table_light;
1.912 bisitz 5140: vertical-align: top;
5141: }
5142:
5143: table.LC_data_table tr.LC_even_row > td {
5144: background-color: $data_table_dark;
1.425 albertel 5145: padding: 2px;
1.900 bisitz 5146: vertical-align: top;
1.347 albertel 5147: }
1.795 www 5148:
1.809 bisitz 5149: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5150: background-color: $data_table_dark;
1.900 bisitz 5151: vertical-align: top;
1.347 albertel 5152: }
1.795 www 5153:
1.425 albertel 5154: table.LC_data_table tr.LC_data_table_highlight td {
5155: background-color: $data_table_darker;
5156: }
1.795 www 5157:
1.639 raeburn 5158: table.LC_data_table tr td.LC_leftcol_header {
5159: background-color: $data_table_head;
5160: font-weight: bold;
5161: }
1.795 www 5162:
1.451 albertel 5163: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5164: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5165: background-color: #FFFFFF;
1.421 albertel 5166: font-weight: bold;
5167: font-style: italic;
5168: text-align: center;
5169: padding: 8px;
1.347 albertel 5170: }
1.795 www 5171:
1.890 droeschl 5172: table.LC_caption {
5173: }
5174:
1.507 raeburn 5175: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5176: padding: 4ex
5177: }
1.795 www 5178:
1.507 raeburn 5179: table.LC_nested_outer tr th {
5180: font-weight: bold;
1.801 tempelho 5181: color:$fontmenu;
1.507 raeburn 5182: background-color: $data_table_head;
1.701 harmsja 5183: font-size: small;
1.507 raeburn 5184: border-bottom: 1px solid #000000;
5185: }
1.795 www 5186:
1.507 raeburn 5187: table.LC_nested_outer tr td.LC_subheader {
5188: background-color: $data_table_head;
5189: font-weight: bold;
5190: font-size: small;
5191: border-bottom: 1px solid #000000;
5192: text-align: right;
1.451 albertel 5193: }
1.795 www 5194:
1.507 raeburn 5195: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5196: background-color: #CCCCCC;
1.451 albertel 5197: font-weight: bold;
5198: font-size: small;
1.507 raeburn 5199: text-align: center;
5200: }
1.795 www 5201:
1.589 raeburn 5202: table.LC_nested tr.LC_info_row td.LC_left_item,
5203: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5204: text-align: left;
1.451 albertel 5205: }
1.795 www 5206:
1.507 raeburn 5207: table.LC_nested td {
1.735 bisitz 5208: background-color: #FFFFFF;
1.451 albertel 5209: font-size: small;
1.507 raeburn 5210: }
1.795 www 5211:
1.507 raeburn 5212: table.LC_nested_outer tr th.LC_right_item,
5213: table.LC_nested tr.LC_info_row td.LC_right_item,
5214: table.LC_nested tr.LC_odd_row td.LC_right_item,
5215: table.LC_nested tr td.LC_right_item {
1.451 albertel 5216: text-align: right;
5217: }
5218:
1.507 raeburn 5219: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5220: background-color: #EEEEEE;
1.451 albertel 5221: }
5222:
1.473 raeburn 5223: table.LC_createuser {
5224: }
5225:
5226: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5227: font-size: small;
1.473 raeburn 5228: }
5229:
5230: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5231: background-color: #CCCCCC;
1.473 raeburn 5232: font-weight: bold;
5233: text-align: center;
5234: }
5235:
1.349 albertel 5236: table.LC_calendar {
5237: border: 1px solid #000000;
5238: border-collapse: collapse;
1.917 raeburn 5239: width: 98%;
1.349 albertel 5240: }
1.795 www 5241:
1.349 albertel 5242: table.LC_calendar_pickdate {
5243: font-size: xx-small;
5244: }
1.795 www 5245:
1.349 albertel 5246: table.LC_calendar tr td {
5247: border: 1px solid #000000;
5248: vertical-align: top;
1.917 raeburn 5249: width: 14%;
1.349 albertel 5250: }
1.795 www 5251:
1.349 albertel 5252: table.LC_calendar tr td.LC_calendar_day_empty {
5253: background-color: $data_table_dark;
5254: }
1.795 www 5255:
1.779 bisitz 5256: table.LC_calendar tr td.LC_calendar_day_current {
5257: background-color: $data_table_highlight;
1.777 tempelho 5258: }
1.795 www 5259:
1.349 albertel 5260: table.LC_mail_list tr.LC_mail_new {
5261: background-color: $mail_new;
5262: }
1.795 www 5263:
1.349 albertel 5264: table.LC_mail_list tr.LC_mail_new:hover {
5265: background-color: $mail_new_hover;
5266: }
1.795 www 5267:
5268: table.LC_mail_list tr.LC_mail_even {
1.777 tempelho 5269: }
1.795 www 5270:
5271: table.LC_mail_list tr.LC_mail_odd {
1.777 tempelho 5272: }
1.795 www 5273:
1.349 albertel 5274: table.LC_mail_list tr.LC_mail_read {
5275: background-color: $mail_read;
5276: }
1.795 www 5277:
1.349 albertel 5278: table.LC_mail_list tr.LC_mail_read:hover {
5279: background-color: $mail_read_hover;
5280: }
1.795 www 5281:
1.349 albertel 5282: table.LC_mail_list tr.LC_mail_replied {
5283: background-color: $mail_replied;
5284: }
1.795 www 5285:
1.349 albertel 5286: table.LC_mail_list tr.LC_mail_replied:hover {
5287: background-color: $mail_replied_hover;
5288: }
1.795 www 5289:
1.349 albertel 5290: table.LC_mail_list tr.LC_mail_other {
5291: background-color: $mail_other;
5292: }
1.795 www 5293:
1.349 albertel 5294: table.LC_mail_list tr.LC_mail_other:hover {
5295: background-color: $mail_other_hover;
5296: }
1.494 raeburn 5297:
1.777 tempelho 5298: table.LC_data_table tr > td.LC_browser_file,
5299: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5300: background: #AAEE77;
1.389 albertel 5301: }
1.795 www 5302:
1.777 tempelho 5303: table.LC_data_table tr > td.LC_browser_file_locked,
5304: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5305: background: #FFAA99;
1.387 albertel 5306: }
1.795 www 5307:
1.777 tempelho 5308: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5309: background: #888888;
1.779 bisitz 5310: }
1.795 www 5311:
1.777 tempelho 5312: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5313: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5314: background: #F8F866;
1.777 tempelho 5315: }
1.795 www 5316:
1.696 bisitz 5317: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5318: background: #E0E8FF;
1.387 albertel 5319: }
1.696 bisitz 5320:
1.707 bisitz 5321: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5322: /* background: #77FF77; */
1.707 bisitz 5323: }
1.795 www 5324:
1.707 bisitz 5325: table.LC_data_table tr > td.LC_roles_future {
5326: background: #FFFF77;
5327: }
1.795 www 5328:
1.707 bisitz 5329: table.LC_data_table tr > td.LC_roles_will {
5330: background: #FFAA77;
5331: }
1.795 www 5332:
1.707 bisitz 5333: table.LC_data_table tr > td.LC_roles_expired {
5334: background: #FF7777;
5335: }
1.795 www 5336:
1.707 bisitz 5337: table.LC_data_table tr > td.LC_roles_will_not {
5338: background: #AAFF77;
5339: }
1.795 www 5340:
1.707 bisitz 5341: table.LC_data_table tr > td.LC_roles_selected {
5342: background: #11CC55;
5343: }
5344:
1.388 albertel 5345: span.LC_current_location {
1.701 harmsja 5346: font-size:larger;
1.388 albertel 5347: background: $pgbg;
5348: }
1.387 albertel 5349:
1.395 albertel 5350: span.LC_parm_menu_item {
5351: font-size: larger;
5352: }
1.795 www 5353:
1.395 albertel 5354: span.LC_parm_scope_all {
5355: color: red;
5356: }
1.795 www 5357:
1.395 albertel 5358: span.LC_parm_scope_folder {
5359: color: green;
5360: }
1.795 www 5361:
1.395 albertel 5362: span.LC_parm_scope_resource {
5363: color: orange;
5364: }
1.795 www 5365:
1.395 albertel 5366: span.LC_parm_part {
5367: color: blue;
5368: }
1.795 www 5369:
1.911 bisitz 5370: span.LC_parm_folder,
5371: span.LC_parm_symb {
1.395 albertel 5372: font-size: x-small;
5373: font-family: $mono;
5374: color: #AAAAAA;
5375: }
5376:
1.795 www 5377: td.LC_parm_overview_level_menu,
5378: td.LC_parm_overview_map_menu,
5379: td.LC_parm_overview_parm_selectors,
5380: td.LC_parm_overview_restrictions {
1.396 albertel 5381: border: 1px solid black;
5382: border-collapse: collapse;
5383: }
1.795 www 5384:
1.396 albertel 5385: table.LC_parm_overview_restrictions td {
5386: border-width: 1px 4px 1px 4px;
5387: border-style: solid;
5388: border-color: $pgbg;
5389: text-align: center;
5390: }
1.795 www 5391:
1.396 albertel 5392: table.LC_parm_overview_restrictions th {
5393: background: $tabbg;
5394: border-width: 1px 4px 1px 4px;
5395: border-style: solid;
5396: border-color: $pgbg;
5397: }
1.795 www 5398:
1.398 albertel 5399: table#LC_helpmenu {
1.803 bisitz 5400: border: none;
1.398 albertel 5401: height: 55px;
1.803 bisitz 5402: border-spacing: 0;
1.398 albertel 5403: }
5404:
5405: table#LC_helpmenu fieldset legend {
5406: font-size: larger;
5407: }
1.795 www 5408:
1.397 albertel 5409: table#LC_helpmenu_links {
5410: width: 100%;
5411: border: 1px solid black;
5412: background: $pgbg;
1.803 bisitz 5413: padding: 0;
1.397 albertel 5414: border-spacing: 1px;
5415: }
1.795 www 5416:
1.397 albertel 5417: table#LC_helpmenu_links tr td {
5418: padding: 1px;
5419: background: $tabbg;
1.399 albertel 5420: text-align: center;
5421: font-weight: bold;
1.397 albertel 5422: }
1.396 albertel 5423:
1.795 www 5424: table#LC_helpmenu_links a:link,
5425: table#LC_helpmenu_links a:visited,
1.397 albertel 5426: table#LC_helpmenu_links a:active {
5427: text-decoration: none;
5428: color: $font;
5429: }
1.795 www 5430:
1.397 albertel 5431: table#LC_helpmenu_links a:hover {
5432: text-decoration: underline;
5433: color: $vlink;
5434: }
1.396 albertel 5435:
1.417 albertel 5436: .LC_chrt_popup_exists {
5437: border: 1px solid #339933;
5438: margin: -1px;
5439: }
1.795 www 5440:
1.417 albertel 5441: .LC_chrt_popup_up {
5442: border: 1px solid yellow;
5443: margin: -1px;
5444: }
1.795 www 5445:
1.417 albertel 5446: .LC_chrt_popup {
5447: border: 1px solid #8888FF;
5448: background: #CCCCFF;
5449: }
1.795 www 5450:
1.421 albertel 5451: table.LC_pick_box {
5452: border-collapse: separate;
5453: background: white;
5454: border: 1px solid black;
5455: border-spacing: 1px;
5456: }
1.795 www 5457:
1.421 albertel 5458: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5459: background: $sidebg;
1.421 albertel 5460: font-weight: bold;
1.900 bisitz 5461: text-align: left;
1.740 bisitz 5462: vertical-align: top;
1.421 albertel 5463: width: 184px;
5464: padding: 8px;
5465: }
1.795 www 5466:
1.579 raeburn 5467: table.LC_pick_box td.LC_pick_box_value {
5468: text-align: left;
5469: padding: 8px;
5470: }
1.795 www 5471:
1.579 raeburn 5472: table.LC_pick_box td.LC_pick_box_select {
5473: text-align: left;
5474: padding: 8px;
5475: }
1.795 www 5476:
1.424 albertel 5477: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5478: padding: 0;
1.421 albertel 5479: height: 1px;
5480: background: black;
5481: }
1.795 www 5482:
1.421 albertel 5483: table.LC_pick_box td.LC_pick_box_submit {
5484: text-align: right;
5485: }
1.795 www 5486:
1.579 raeburn 5487: table.LC_pick_box td.LC_evenrow_value {
5488: text-align: left;
5489: padding: 8px;
5490: background-color: $data_table_light;
5491: }
1.795 www 5492:
1.579 raeburn 5493: table.LC_pick_box td.LC_oddrow_value {
5494: text-align: left;
5495: padding: 8px;
5496: background-color: $data_table_light;
5497: }
1.795 www 5498:
1.579 raeburn 5499: span.LC_helpform_receipt_cat {
5500: font-weight: bold;
5501: }
1.795 www 5502:
1.424 albertel 5503: table.LC_group_priv_box {
5504: background: white;
5505: border: 1px solid black;
5506: border-spacing: 1px;
5507: }
1.795 www 5508:
1.424 albertel 5509: table.LC_group_priv_box td.LC_pick_box_title {
5510: background: $tabbg;
5511: font-weight: bold;
5512: text-align: right;
5513: width: 184px;
5514: }
1.795 www 5515:
1.424 albertel 5516: table.LC_group_priv_box td.LC_groups_fixed {
5517: background: $data_table_light;
5518: text-align: center;
5519: }
1.795 www 5520:
1.424 albertel 5521: table.LC_group_priv_box td.LC_groups_optional {
5522: background: $data_table_dark;
5523: text-align: center;
5524: }
1.795 www 5525:
1.424 albertel 5526: table.LC_group_priv_box td.LC_groups_functionality {
5527: background: $data_table_darker;
5528: text-align: center;
5529: font-weight: bold;
5530: }
1.795 www 5531:
1.424 albertel 5532: table.LC_group_priv td {
5533: text-align: left;
1.803 bisitz 5534: padding: 0;
1.424 albertel 5535: }
5536:
1.421 albertel 5537: table.LC_notify_front_page {
5538: background: white;
5539: border: 1px solid black;
5540: padding: 8px;
5541: }
1.795 www 5542:
1.421 albertel 5543: table.LC_notify_front_page td {
5544: padding: 8px;
5545: }
1.795 www 5546:
1.424 albertel 5547: .LC_navbuttons {
5548: margin: 2ex 0ex 2ex 0ex;
5549: }
1.795 www 5550:
1.423 albertel 5551: .LC_topic_bar {
5552: font-weight: bold;
5553: background: $tabbg;
1.918 wenzelju 5554: margin: 1em 0em 1em 2em;
1.805 bisitz 5555: padding: 3px;
1.918 wenzelju 5556: font-size: 1.2em;
1.423 albertel 5557: }
1.795 www 5558:
1.423 albertel 5559: .LC_topic_bar span {
1.918 wenzelju 5560: left: 0.5em;
5561: position: absolute;
1.423 albertel 5562: vertical-align: middle;
1.918 wenzelju 5563: font-size: 1.2em;
1.423 albertel 5564: }
1.795 www 5565:
1.423 albertel 5566: .LC_topic_bar img {
5567: vertical-align: bottom;
5568: }
1.795 www 5569:
1.423 albertel 5570: table.LC_course_group_status {
5571: margin: 20px;
5572: }
1.795 www 5573:
1.423 albertel 5574: table.LC_status_selector td {
5575: vertical-align: top;
5576: text-align: center;
1.424 albertel 5577: padding: 4px;
5578: }
1.795 www 5579:
1.599 albertel 5580: div.LC_feedback_link {
1.616 albertel 5581: clear: both;
1.829 kalberla 5582: background: $sidebg;
1.779 bisitz 5583: width: 100%;
1.829 kalberla 5584: padding-bottom: 10px;
5585: border: 1px $tabbg solid;
1.833 kalberla 5586: height: 22px;
5587: line-height: 22px;
5588: padding-top: 5px;
5589: }
5590:
5591: div.LC_feedback_link img {
5592: height: 22px;
1.867 kalberla 5593: vertical-align:middle;
1.829 kalberla 5594: }
5595:
1.911 bisitz 5596: div.LC_feedback_link a {
1.829 kalberla 5597: text-decoration: none;
1.489 raeburn 5598: }
1.795 www 5599:
1.867 kalberla 5600: div.LC_comblock {
1.911 bisitz 5601: display:inline;
1.867 kalberla 5602: color:$font;
5603: font-size:90%;
5604: }
5605:
5606: div.LC_feedback_link div.LC_comblock {
5607: padding-left:5px;
5608: }
5609:
5610: div.LC_feedback_link div.LC_comblock a {
5611: color:$font;
5612: }
5613:
1.489 raeburn 5614: span.LC_feedback_link {
1.858 bisitz 5615: /* background: $feedback_link_bg; */
1.599 albertel 5616: font-size: larger;
5617: }
1.795 www 5618:
1.599 albertel 5619: span.LC_message_link {
1.858 bisitz 5620: /* background: $feedback_link_bg; */
1.599 albertel 5621: font-size: larger;
5622: position: absolute;
5623: right: 1em;
1.489 raeburn 5624: }
1.421 albertel 5625:
1.515 albertel 5626: table.LC_prior_tries {
1.524 albertel 5627: border: 1px solid #000000;
5628: border-collapse: separate;
5629: border-spacing: 1px;
1.515 albertel 5630: }
1.523 albertel 5631:
1.515 albertel 5632: table.LC_prior_tries td {
1.524 albertel 5633: padding: 2px;
1.515 albertel 5634: }
1.523 albertel 5635:
5636: .LC_answer_correct {
1.795 www 5637: background: lightgreen;
5638: color: darkgreen;
5639: padding: 6px;
1.523 albertel 5640: }
1.795 www 5641:
1.523 albertel 5642: .LC_answer_charged_try {
1.797 www 5643: background: #FFAAAA;
1.795 www 5644: color: darkred;
5645: padding: 6px;
1.523 albertel 5646: }
1.795 www 5647:
1.779 bisitz 5648: .LC_answer_not_charged_try,
1.523 albertel 5649: .LC_answer_no_grade,
5650: .LC_answer_late {
1.795 www 5651: background: lightyellow;
1.523 albertel 5652: color: black;
1.795 www 5653: padding: 6px;
1.523 albertel 5654: }
1.795 www 5655:
1.523 albertel 5656: .LC_answer_previous {
1.795 www 5657: background: lightblue;
5658: color: darkblue;
5659: padding: 6px;
1.523 albertel 5660: }
1.795 www 5661:
1.779 bisitz 5662: .LC_answer_no_message {
1.777 tempelho 5663: background: #FFFFFF;
5664: color: black;
1.795 www 5665: padding: 6px;
1.779 bisitz 5666: }
1.795 www 5667:
1.779 bisitz 5668: .LC_answer_unknown {
5669: background: orange;
5670: color: black;
1.795 www 5671: padding: 6px;
1.777 tempelho 5672: }
1.795 www 5673:
1.529 albertel 5674: span.LC_prior_numerical,
5675: span.LC_prior_string,
5676: span.LC_prior_custom,
5677: span.LC_prior_reaction,
5678: span.LC_prior_math {
1.523 albertel 5679: font-family: monospace;
5680: white-space: pre;
5681: }
5682:
1.525 albertel 5683: span.LC_prior_string {
5684: font-family: monospace;
5685: white-space: pre;
5686: }
5687:
1.523 albertel 5688: table.LC_prior_option {
5689: width: 100%;
5690: border-collapse: collapse;
5691: }
1.795 www 5692:
1.911 bisitz 5693: table.LC_prior_rank,
1.795 www 5694: table.LC_prior_match {
1.528 albertel 5695: border-collapse: collapse;
5696: }
1.795 www 5697:
1.528 albertel 5698: table.LC_prior_option tr td,
5699: table.LC_prior_rank tr td,
5700: table.LC_prior_match tr td {
1.524 albertel 5701: border: 1px solid #000000;
1.515 albertel 5702: }
5703:
1.855 bisitz 5704: .LC_nobreak {
1.544 albertel 5705: white-space: nowrap;
1.519 raeburn 5706: }
5707:
1.576 raeburn 5708: span.LC_cusr_emph {
5709: font-style: italic;
5710: }
5711:
1.633 raeburn 5712: span.LC_cusr_subheading {
5713: font-weight: normal;
5714: font-size: 85%;
5715: }
5716:
1.545 albertel 5717: table.LC_docs_documents {
5718: background: #BBBBBB;
1.803 bisitz 5719: border-width: 0;
1.545 albertel 5720: border-collapse: collapse;
5721: }
1.795 www 5722:
1.777 tempelho 5723: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5724: border: 2px solid black;
5725: padding: 4px;
1.777 tempelho 5726: }
1.795 www 5727:
1.861 bisitz 5728: div.LC_docs_entry_move {
1.859 bisitz 5729: border: 1px solid #BBBBBB;
1.545 albertel 5730: background: #DDDDDD;
1.861 bisitz 5731: width: 22px;
1.859 bisitz 5732: padding: 1px;
5733: margin: 0;
1.545 albertel 5734: }
5735:
1.861 bisitz 5736: table.LC_data_table tr > td.LC_docs_entry_commands,
5737: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5738: background: #DDDDDD;
5739: font-size: x-small;
5740: }
1.795 www 5741:
1.861 bisitz 5742: .LC_docs_entry_parameter {
5743: white-space: nowrap;
5744: }
5745:
1.544 albertel 5746: .LC_docs_copy {
1.545 albertel 5747: color: #000099;
1.544 albertel 5748: }
1.795 www 5749:
1.544 albertel 5750: .LC_docs_cut {
1.545 albertel 5751: color: #550044;
1.544 albertel 5752: }
1.795 www 5753:
1.544 albertel 5754: .LC_docs_rename {
1.545 albertel 5755: color: #009900;
1.544 albertel 5756: }
1.795 www 5757:
1.544 albertel 5758: .LC_docs_remove {
1.545 albertel 5759: color: #990000;
5760: }
5761:
1.547 albertel 5762: .LC_docs_reinit_warn,
5763: .LC_docs_ext_edit {
5764: font-size: x-small;
5765: }
5766:
1.545 albertel 5767: table.LC_docs_adddocs td,
5768: table.LC_docs_adddocs th {
5769: border: 1px solid #BBBBBB;
5770: padding: 4px;
5771: background: #DDDDDD;
1.543 albertel 5772: }
5773:
1.584 albertel 5774: table.LC_sty_begin {
5775: background: #BBFFBB;
5776: }
1.795 www 5777:
1.584 albertel 5778: table.LC_sty_end {
5779: background: #FFBBBB;
5780: }
5781:
1.589 raeburn 5782: table.LC_double_column {
1.803 bisitz 5783: border-width: 0;
1.589 raeburn 5784: border-collapse: collapse;
5785: width: 100%;
5786: padding: 2px;
5787: }
5788:
5789: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5790: top: 2px;
1.589 raeburn 5791: left: 2px;
5792: width: 47%;
5793: vertical-align: top;
5794: }
5795:
5796: table.LC_double_column tr td.LC_right_col {
5797: top: 2px;
1.779 bisitz 5798: right: 2px;
1.589 raeburn 5799: width: 47%;
5800: vertical-align: top;
5801: }
5802:
1.591 raeburn 5803: div.LC_left_float {
5804: float: left;
5805: padding-right: 5%;
1.597 albertel 5806: padding-bottom: 4px;
1.591 raeburn 5807: }
5808:
5809: div.LC_clear_float_header {
1.597 albertel 5810: padding-bottom: 2px;
1.591 raeburn 5811: }
5812:
5813: div.LC_clear_float_footer {
1.597 albertel 5814: padding-top: 10px;
1.591 raeburn 5815: clear: both;
5816: }
5817:
1.597 albertel 5818: div.LC_grade_show_user {
5819: margin-top: 20px;
5820: border: 1px solid black;
5821: }
1.795 www 5822:
1.597 albertel 5823: div.LC_grade_user_name {
5824: background: #DDDDEE;
5825: border-bottom: 1px solid black;
1.705 tempelho 5826: font-weight: bold;
5827: font-size: large;
1.597 albertel 5828: }
1.795 www 5829:
1.597 albertel 5830: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5831: background: #DDEEDD;
5832: }
5833:
5834: div.LC_grade_show_problem,
5835: div.LC_grade_submissions,
5836: div.LC_grade_message_center,
5837: div.LC_grade_info_links,
5838: div.LC_grade_assign {
5839: margin: 5px;
5840: width: 99%;
5841: background: #FFFFFF;
5842: }
1.795 www 5843:
1.597 albertel 5844: div.LC_grade_show_problem_header,
5845: div.LC_grade_submissions_header,
5846: div.LC_grade_message_center_header,
5847: div.LC_grade_assign_header {
1.705 tempelho 5848: font-weight: bold;
5849: font-size: large;
1.597 albertel 5850: }
1.795 www 5851:
1.597 albertel 5852: div.LC_grade_show_problem_problem,
5853: div.LC_grade_submissions_body,
5854: div.LC_grade_message_center_body,
5855: div.LC_grade_assign_body {
5856: border: 1px solid black;
5857: width: 99%;
5858: background: #FFFFFF;
5859: }
1.795 www 5860:
1.598 albertel 5861: span.LC_grade_check_note {
1.705 tempelho 5862: font-weight: normal;
5863: font-size: medium;
1.598 albertel 5864: display: inline;
5865: position: absolute;
5866: right: 1em;
5867: }
1.597 albertel 5868:
1.613 albertel 5869: table.LC_scantron_action {
5870: width: 100%;
5871: }
1.795 www 5872:
1.613 albertel 5873: table.LC_scantron_action tr th {
1.698 harmsja 5874: font-weight:bold;
5875: font-style:normal;
1.613 albertel 5876: }
1.795 www 5877:
1.779 bisitz 5878: .LC_edit_problem_header,
1.614 albertel 5879: div.LC_edit_problem_footer {
1.705 tempelho 5880: font-weight: normal;
5881: font-size: medium;
1.602 albertel 5882: margin: 2px;
1.600 albertel 5883: }
1.795 www 5884:
1.600 albertel 5885: div.LC_edit_problem_header,
1.602 albertel 5886: div.LC_edit_problem_header div,
1.614 albertel 5887: div.LC_edit_problem_footer,
5888: div.LC_edit_problem_footer div,
1.602 albertel 5889: div.LC_edit_problem_editxml_header,
5890: div.LC_edit_problem_editxml_header div {
1.600 albertel 5891: margin-top: 5px;
5892: }
1.795 www 5893:
1.600 albertel 5894: div.LC_edit_problem_header_title {
1.705 tempelho 5895: font-weight: bold;
5896: font-size: larger;
1.602 albertel 5897: background: $tabbg;
5898: padding: 3px;
5899: }
1.795 www 5900:
1.602 albertel 5901: table.LC_edit_problem_header_title {
1.705 tempelho 5902: font-size: larger;
5903: font-weight: bold;
1.602 albertel 5904: width: 100%;
5905: border-color: $pgbg;
5906: border-style: solid;
5907: border-width: $border;
1.600 albertel 5908: background: $tabbg;
1.602 albertel 5909: border-collapse: collapse;
1.803 bisitz 5910: padding: 0;
1.602 albertel 5911: }
5912:
5913: div.LC_edit_problem_discards {
5914: float: left;
5915: padding-bottom: 5px;
5916: }
1.795 www 5917:
1.602 albertel 5918: div.LC_edit_problem_saves {
5919: float: right;
5920: padding-bottom: 5px;
1.600 albertel 5921: }
1.795 www 5922:
1.911 bisitz 5923: img.stift {
1.803 bisitz 5924: border-width: 0;
5925: vertical-align: middle;
1.677 riegler 5926: }
1.680 riegler 5927:
1.923 ! bisitz 5928: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5929: vertical-align: top;
1.777 tempelho 5930: }
1.795 www 5931:
1.716 raeburn 5932: div.LC_createcourse {
1.911 bisitz 5933: margin: 10px 10px 10px 10px;
1.716 raeburn 5934: }
5935:
1.917 raeburn 5936: .LC_dccid {
5937: margin: 0.2em 0 0 0;
5938: padding: 0;
5939: font-size: 90%;
5940: display:none;
5941: }
5942:
1.693 droeschl 5943: /* ---- Remove when done ----
5944: # The following styles is part of the redesign of LON-CAPA and are
5945: # subject to change during this project.
5946: # Don't rely on their current functionality as they might be
5947: # changed or removed.
5948: # --------------------------*/
5949:
1.698 harmsja 5950: a:hover,
1.897 wenzelju 5951: ol.LC_primary_menu a:hover,
1.721 harmsja 5952: ol#LC_MenuBreadcrumbs a:hover,
5953: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5954: ul#LC_secondary_menu a:hover,
1.721 harmsja 5955: .LC_FormSectionClearButton input:hover
1.795 www 5956: ul.LC_TabContent li:hover a {
1.911 bisitz 5957: color:#BF2317;
5958: text-decoration:none;
1.693 droeschl 5959: }
5960:
1.779 bisitz 5961: h1 {
1.911 bisitz 5962: padding: 0;
5963: line-height:130%;
1.693 droeschl 5964: }
1.698 harmsja 5965:
1.911 bisitz 5966: h2,
5967: h3,
5968: h4,
5969: h5,
5970: h6 {
5971: margin: 5px 0 5px 0;
5972: padding: 0;
5973: line-height:130%;
1.693 droeschl 5974: }
1.795 www 5975:
5976: .LC_hcell {
1.911 bisitz 5977: padding:3px 15px 3px 15px;
5978: margin: 0;
5979: background-color:$tabbg;
5980: color:$fontmenu;
5981: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5982: }
1.795 www 5983:
1.840 bisitz 5984: .LC_Box > .LC_hcell {
1.911 bisitz 5985: margin: 0 -10px 10px -10px;
1.835 bisitz 5986: }
5987:
1.721 harmsja 5988: .LC_noBorder {
1.911 bisitz 5989: border: 0;
1.698 harmsja 5990: }
1.693 droeschl 5991:
1.761 tempelho 5992: .LC_Right {
1.911 bisitz 5993: float: right;
5994: margin: 0;
5995: padding: 0;
1.761 tempelho 5996: }
5997:
1.721 harmsja 5998: .LC_FormSectionClearButton input {
1.911 bisitz 5999: background-color:transparent;
6000: border: none;
6001: cursor:pointer;
6002: text-decoration:underline;
1.693 droeschl 6003: }
1.763 bisitz 6004:
6005: .LC_help_open_topic {
1.911 bisitz 6006: color: #FFFFFF;
6007: background-color: #EEEEFF;
6008: margin: 1px;
6009: padding: 4px;
6010: border: 1px solid #000033;
6011: white-space: nowrap;
6012: /* vertical-align: middle; */
1.759 neumanie 6013: }
1.693 droeschl 6014:
1.911 bisitz 6015: dl,
6016: ul,
6017: div,
6018: fieldset {
6019: margin: 10px 10px 10px 0;
6020: /* overflow: hidden; */
1.693 droeschl 6021: }
1.795 www 6022:
1.838 bisitz 6023: fieldset > legend {
1.911 bisitz 6024: font-weight: bold;
6025: padding: 0 5px 0 5px;
1.838 bisitz 6026: }
6027:
1.813 bisitz 6028: #LC_nav_bar {
1.911 bisitz 6029: float: left;
6030: margin: 0.2em 0 0 0;
1.807 droeschl 6031: }
6032:
1.916 droeschl 6033: #LC_realm {
6034: margin: 0.2em 0 0 0;
6035: padding: 0;
6036: font-weight: bold;
6037: text-align: center;
6038: }
6039:
1.911 bisitz 6040: #LC_nav_bar em {
6041: font-weight: bold;
6042: font-style: normal;
1.807 droeschl 6043: }
6044:
1.897 wenzelju 6045: ol.LC_primary_menu {
1.911 bisitz 6046: float: right;
6047: margin: 0.2em 0 0 0;
1.807 droeschl 6048: }
6049:
1.852 droeschl 6050: ol#LC_PathBreadcrumbs {
1.911 bisitz 6051: margin: 0;
1.693 droeschl 6052: }
6053:
1.897 wenzelju 6054: ol.LC_primary_menu li {
1.911 bisitz 6055: display: inline;
6056: padding: 5px 5px 0 10px;
6057: vertical-align: top;
1.693 droeschl 6058: }
6059:
1.897 wenzelju 6060: ol.LC_primary_menu li img {
1.911 bisitz 6061: vertical-align: bottom;
1.693 droeschl 6062: }
6063:
1.897 wenzelju 6064: ol.LC_primary_menu a {
1.911 bisitz 6065: font-size: 90%;
6066: color: RGB(80, 80, 80);
6067: text-decoration: none;
1.693 droeschl 6068: }
1.795 www 6069:
1.897 wenzelju 6070: ul#LC_secondary_menu {
1.911 bisitz 6071: clear: both;
6072: color: $fontmenu;
6073: background: $tabbg;
6074: list-style: none;
6075: padding: 0;
6076: margin: 0;
6077: width: 100%;
1.808 droeschl 6078: }
6079:
1.897 wenzelju 6080: ul#LC_secondary_menu li {
1.911 bisitz 6081: font-weight: bold;
6082: line-height: 1.8em;
6083: padding: 0 0.8em;
6084: border-right: 1px solid black;
6085: display: inline;
6086: vertical-align: middle;
1.807 droeschl 6087: }
6088:
1.847 tempelho 6089: ul.LC_TabContent {
1.911 bisitz 6090: display:block;
6091: background: $sidebg;
6092: border-bottom: solid 1px $lg_border_color;
6093: list-style:none;
6094: margin: 0 -10px;
6095: padding: 0;
1.693 droeschl 6096: }
6097:
1.795 www 6098: ul.LC_TabContent li,
6099: ul.LC_TabContentBigger li {
1.911 bisitz 6100: float:left;
1.741 harmsja 6101: }
1.795 www 6102:
1.897 wenzelju 6103: ul#LC_secondary_menu li a {
1.911 bisitz 6104: color: $fontmenu;
6105: text-decoration: none;
1.693 droeschl 6106: }
1.795 www 6107:
1.721 harmsja 6108: ul.LC_TabContent {
1.911 bisitz 6109: min-height:1.5em;
1.721 harmsja 6110: }
1.795 www 6111:
6112: ul.LC_TabContent li {
1.911 bisitz 6113: vertical-align:middle;
6114: padding: 0 10px 0 10px;
6115: background-color:$tabbg;
6116: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6117: }
1.795 www 6118:
1.847 tempelho 6119: ul.LC_TabContent .right {
1.911 bisitz 6120: float:right;
1.847 tempelho 6121: }
6122:
1.911 bisitz 6123: ul.LC_TabContent li a,
6124: ul.LC_TabContent li {
6125: color:rgb(47,47,47);
6126: text-decoration:none;
6127: font-size:95%;
6128: font-weight:bold;
6129: padding-right: 16px;
1.721 harmsja 6130: }
1.795 www 6131:
1.911 bisitz 6132: ul.LC_TabContent li:hover,
6133: ul.LC_TabContent li.active {
6134: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6135: border-bottom:solid 2px #FFFFFF;
6136: padding-right: 16px;
1.744 ehlerst 6137: }
1.795 www 6138:
1.870 tempelho 6139: #maincoursedoc {
1.911 bisitz 6140: clear:both;
1.870 tempelho 6141: }
6142:
6143: ul.LC_TabContentBigger {
1.911 bisitz 6144: display:block;
6145: list-style:none;
6146: padding: 0;
1.870 tempelho 6147: }
6148:
1.795 www 6149: ul.LC_TabContentBigger li {
1.911 bisitz 6150: vertical-align:bottom;
6151: height: 30px;
6152: font-size:110%;
6153: font-weight:bold;
6154: color: #737373;
1.841 tempelho 6155: }
6156:
1.870 tempelho 6157:
6158: ul.LC_TabContentBigger li a {
1.911 bisitz 6159: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6160: height: 30px;
6161: line-height: 30px;
6162: text-align: center;
6163: display: block;
6164: text-decoration: none;
1.741 harmsja 6165: }
1.795 www 6166:
1.911 bisitz 6167: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6168: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6169: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6170: color:$font;
6171: text-decoration: underline;
1.744 ehlerst 6172: }
1.795 www 6173:
1.870 tempelho 6174:
6175: ul.LC_TabContentBigger li b {
1.911 bisitz 6176: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6177: display: block;
6178: float: left;
6179: padding: 0 30px;
1.870 tempelho 6180: }
6181:
6182: ul.LC_TabContentBigger li:hover b,
6183: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6184: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6185: color:$font;
6186: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6187: }
1.693 droeschl 6188:
1.870 tempelho 6189:
1.862 bisitz 6190: ul.LC_CourseBreadcrumbs {
6191: background: $sidebg;
6192: line-height: 32px;
6193: padding-left: 10px;
6194: margin: 0 0 10px 0;
6195: list-style-position: inside;
6196:
6197: }
6198:
1.911 bisitz 6199: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6200: ol#LC_PathBreadcrumbs {
1.911 bisitz 6201: padding-left: 10px;
6202: margin: 0;
6203: list-style-position: inside;
1.915 droeschl 6204: /* SD working here
1.904 droeschl 6205: white-space: nowrap; */
1.693 droeschl 6206: }
6207:
1.911 bisitz 6208: ol#LC_MenuBreadcrumbs li,
6209: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6210: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6211: display: inline;
6212: white-space: nowrap;
1.915 droeschl 6213: /* SD working here
6214: white-space: normal; */
1.693 droeschl 6215: }
6216:
1.823 bisitz 6217: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6218: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6219: text-decoration: none;
6220: font-size:90%;
1.693 droeschl 6221: }
1.795 www 6222:
6223: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6224: text-decoration:none;
6225: font-size:100%;
6226: font-weight:bold;
1.693 droeschl 6227: }
1.795 www 6228:
1.840 bisitz 6229: .LC_Box {
1.911 bisitz 6230: border: solid 1px $lg_border_color;
6231: padding: 0 10px 10px 10px;
1.746 neumanie 6232: }
1.795 www 6233:
6234: .LC_AboutMe_Image {
1.911 bisitz 6235: float:left;
6236: margin-right:10px;
1.747 neumanie 6237: }
1.795 www 6238:
6239: .LC_Clear_AboutMe_Image {
1.911 bisitz 6240: clear:left;
1.747 neumanie 6241: }
1.795 www 6242:
1.721 harmsja 6243: dl.LC_ListStyleClean dt {
1.911 bisitz 6244: padding-right: 5px;
6245: display: table-header-group;
1.693 droeschl 6246: }
6247:
1.721 harmsja 6248: dl.LC_ListStyleClean dd {
1.911 bisitz 6249: display: table-row;
1.693 droeschl 6250: }
6251:
1.721 harmsja 6252: .LC_ListStyleClean,
6253: .LC_ListStyleSimple,
6254: .LC_ListStyleNormal,
1.777 tempelho 6255: .LC_ListStyle_Border,
1.795 www 6256: .LC_ListStyleSpecial {
1.911 bisitz 6257: /* display:block; */
6258: list-style-position: inside;
6259: list-style-type: none;
6260: overflow: hidden;
6261: padding: 0;
1.693 droeschl 6262: }
6263:
1.721 harmsja 6264: .LC_ListStyleSimple li,
6265: .LC_ListStyleSimple dd,
6266: .LC_ListStyleNormal li,
6267: .LC_ListStyleNormal dd,
6268: .LC_ListStyleSpecial li,
1.795 www 6269: .LC_ListStyleSpecial dd {
1.911 bisitz 6270: margin: 0;
6271: padding: 5px 5px 5px 10px;
6272: clear: both;
1.693 droeschl 6273: }
6274:
1.721 harmsja 6275: .LC_ListStyleClean li,
6276: .LC_ListStyleClean dd {
1.911 bisitz 6277: padding-top: 0;
6278: padding-bottom: 0;
1.693 droeschl 6279: }
6280:
1.721 harmsja 6281: .LC_ListStyleSimple dd,
1.795 www 6282: .LC_ListStyleSimple li {
1.911 bisitz 6283: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6284: }
6285:
1.721 harmsja 6286: .LC_ListStyleSpecial li,
6287: .LC_ListStyleSpecial dd {
1.911 bisitz 6288: list-style-type: none;
6289: background-color: RGB(220, 220, 220);
6290: margin-bottom: 4px;
1.693 droeschl 6291: }
6292:
1.721 harmsja 6293: table.LC_SimpleTable {
1.911 bisitz 6294: margin:5px;
6295: border:solid 1px $lg_border_color;
1.795 www 6296: }
1.693 droeschl 6297:
1.721 harmsja 6298: table.LC_SimpleTable tr {
1.911 bisitz 6299: padding: 0;
6300: border:solid 1px $lg_border_color;
1.693 droeschl 6301: }
1.795 www 6302:
6303: table.LC_SimpleTable thead {
1.911 bisitz 6304: background:rgb(220,220,220);
1.693 droeschl 6305: }
6306:
1.721 harmsja 6307: div.LC_columnSection {
1.911 bisitz 6308: display: block;
6309: clear: both;
6310: overflow: hidden;
6311: margin: 0;
1.693 droeschl 6312: }
6313:
1.721 harmsja 6314: div.LC_columnSection>* {
1.911 bisitz 6315: float: left;
6316: margin: 10px 20px 10px 0;
6317: overflow:hidden;
1.693 droeschl 6318: }
1.721 harmsja 6319:
1.694 tempelho 6320: .LC_loginpage_container {
1.911 bisitz 6321: text-align:left;
6322: margin : 0 auto;
6323: width:90%;
6324: padding: 10px;
6325: height: auto;
6326: background-color:#FFFFFF;
6327: border:1px solid #CCCCCC;
1.694 tempelho 6328: }
6329:
6330:
6331: .LC_loginpage_loginContainer {
1.911 bisitz 6332: float:left;
6333: width: 182px;
6334: padding: 2px;
6335: border:1px solid #CCCCCC;
6336: background-color:$loginbg;
1.694 tempelho 6337: }
6338:
1.795 www 6339: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6340: margin-top: 0;
6341: display:block;
6342: background:$bgcol;
6343: color:$textcol;
6344: padding-left:5px;
1.712 muellerd 6345: }
1.785 tempelho 6346:
1.694 tempelho 6347: .LC_loginpage_loginInfo {
1.911 bisitz 6348: float:left;
6349: width:182px;
6350: border:1px solid #CCCCCC;
6351: padding:2px;
1.712 muellerd 6352: }
6353:
1.694 tempelho 6354: .LC_loginpage_space {
1.911 bisitz 6355: clear: both;
6356: margin-bottom: 20px;
6357: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6358: }
6359:
1.785 tempelho 6360: .LC_loginpage_floatLeft {
1.911 bisitz 6361: float: left;
6362: width: 200px;
6363: margin: 0;
1.785 tempelho 6364: }
6365:
1.795 www 6366: table em {
1.911 bisitz 6367: font-weight: bold;
6368: font-style: normal;
1.748 schulted 6369: }
1.795 www 6370:
1.779 bisitz 6371: table.LC_tableBrowseRes,
1.795 www 6372: table.LC_tableOfContent {
1.911 bisitz 6373: border:none;
6374: border-spacing: 1px;
6375: padding: 3px;
6376: background-color: #FFFFFF;
6377: font-size: 90%;
1.753 droeschl 6378: }
1.789 droeschl 6379:
1.911 bisitz 6380: table.LC_tableOfContent {
6381: border-collapse: collapse;
1.789 droeschl 6382: }
6383:
1.771 droeschl 6384: table.LC_tableBrowseRes a,
1.768 schulted 6385: table.LC_tableOfContent a {
1.911 bisitz 6386: background-color: transparent;
6387: text-decoration: none;
1.753 droeschl 6388: }
6389:
1.771 droeschl 6390: table.LC_tableBrowseRes tr.LC_trOdd,
1.911 bisitz 6391: table.LC_tableOfContent tr.LC_trOdd {
6392: background-color: #EEEEEE;
1.753 droeschl 6393: }
6394:
1.795 www 6395: table.LC_tableOfContent img {
1.911 bisitz 6396: border: none;
6397: height: 1.3em;
6398: vertical-align: text-bottom;
6399: margin-right: 0.3em;
1.753 droeschl 6400: }
1.757 schulted 6401:
1.795 www 6402: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6403: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6404: }
6405:
1.795 www 6406: a#LC_content_toolbar_launchnav {
1.911 bisitz 6407: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6408: }
6409:
1.795 www 6410: a#LC_content_toolbar_closenav {
1.911 bisitz 6411: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6412: }
6413:
1.795 www 6414: a#LC_content_toolbar_everything {
1.911 bisitz 6415: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6416: }
6417:
1.795 www 6418: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6419: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6420: }
6421:
1.795 www 6422: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6423: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6424: }
6425:
1.795 www 6426: a#LC_content_toolbar_changefolder {
1.911 bisitz 6427: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6428: }
6429:
1.795 www 6430: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6431: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6432: }
6433:
1.795 www 6434: ul#LC_toolbar li a:hover {
1.911 bisitz 6435: background-position: bottom center;
1.757 schulted 6436: }
6437:
1.795 www 6438: ul#LC_toolbar {
1.911 bisitz 6439: padding: 0;
6440: margin: 2px;
6441: list-style:none;
6442: position:relative;
6443: background-color:white;
1.757 schulted 6444: }
6445:
1.795 www 6446: ul#LC_toolbar li {
1.911 bisitz 6447: border:1px solid white;
6448: padding: 0;
6449: margin: 0;
6450: float: left;
6451: display:inline;
6452: vertical-align:middle;
6453: }
1.757 schulted 6454:
1.783 amueller 6455:
1.795 www 6456: a.LC_toolbarItem {
1.911 bisitz 6457: display:block;
6458: padding: 0;
6459: margin: 0;
6460: height: 32px;
6461: width: 32px;
6462: color:white;
6463: border: none;
6464: background-repeat:no-repeat;
6465: background-color:transparent;
1.757 schulted 6466: }
6467:
1.915 droeschl 6468: ul.LC_funclist {
6469: margin: 0;
6470: padding: 0.5em 1em 0.5em 0;
6471: }
6472:
6473: ul.LC_funclist + ul.LC_funclist {
6474: /*
6475: left border as a seperator if we have more than
6476: one list
6477: */
6478: border-left: 1px solid $sidebg;
6479: /*
6480: this hides the left border behind the border of the
6481: outer box if element is wrapped to the next 'line'
6482: */
6483: margin-left: -1px;
6484: }
6485:
1.843 bisitz 6486: ul.LC_funclist li {
1.915 droeschl 6487: display: inline;
1.782 bisitz 6488: white-space: nowrap;
1.915 droeschl 6489: margin: 0 0 0 25px;
6490: line-height: 150%;
1.782 bisitz 6491: }
6492:
1.757 schulted 6493:
1.343 albertel 6494: END
6495: }
6496:
1.306 albertel 6497: =pod
6498:
6499: =item * &headtag()
6500:
6501: Returns a uniform footer for LON-CAPA web pages.
6502:
1.307 albertel 6503: Inputs: $title - optional title for the head
6504: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6505: $args - optional arguments
1.319 albertel 6506: force_register - if is true call registerurl so the remote is
6507: informed
1.415 albertel 6508: redirect -> array ref of
6509: 1- seconds before redirect occurs
6510: 2- url to redirect to
6511: 3- whether the side effect should occur
1.315 albertel 6512: (side effect of setting
6513: $env{'internal.head.redirect'} to the url
6514: redirected too)
1.352 albertel 6515: domain -> force to color decorate a page for a specific
6516: domain
6517: function -> force usage of a specific rolish color scheme
6518: bgcolor -> override the default page bgcolor
1.460 albertel 6519: no_auto_mt_title
6520: -> prevent &mt()ing the title arg
1.464 albertel 6521:
1.306 albertel 6522: =cut
6523:
6524: sub headtag {
1.313 albertel 6525: my ($title,$head_extra,$args) = @_;
1.306 albertel 6526:
1.363 albertel 6527: my $function = $args->{'function'} || &get_users_function();
6528: my $domain = $args->{'domain'} || &determinedomain();
6529: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6530: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6531: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6532: #time(),
1.418 albertel 6533: $env{'environment.color.timestamp'},
1.363 albertel 6534: $function,$domain,$bgcolor);
6535:
1.369 www 6536: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6537:
1.308 albertel 6538: my $result =
6539: '<head>'.
1.461 albertel 6540: &font_settings();
1.319 albertel 6541:
1.461 albertel 6542: if (!$args->{'frameset'}) {
6543: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6544: }
1.319 albertel 6545: if ($args->{'force_register'}) {
6546: $result .= &Apache::lonmenu::registerurl(1);
6547: }
1.436 albertel 6548: if (!$args->{'no_nav_bar'}
6549: && !$args->{'only_body'}
6550: && !$args->{'frameset'}) {
6551: $result .= &help_menu_js();
6552: }
1.319 albertel 6553:
1.314 albertel 6554: if (ref($args->{'redirect'})) {
1.414 albertel 6555: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6556: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6557: if (!$inhibit_continue) {
6558: $env{'internal.head.redirect'} = $url;
6559: }
1.313 albertel 6560: $result.=<<ADDMETA
6561: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6562: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6563: ADDMETA
6564: }
1.306 albertel 6565: if (!defined($title)) {
6566: $title = 'The LearningOnline Network with CAPA';
6567: }
1.460 albertel 6568: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6569: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6570: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6571: .$head_extra;
1.306 albertel 6572: return $result;
6573: }
6574:
6575: =pod
6576:
1.340 albertel 6577: =item * &font_settings()
6578:
6579: Returns neccessary <meta> to set the proper encoding
6580:
6581: Inputs: none
6582:
6583: =cut
6584:
6585: sub font_settings {
6586: my $headerstring='';
1.647 www 6587: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6588: $headerstring.=
6589: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6590: }
6591: return $headerstring;
6592: }
6593:
1.341 albertel 6594: =pod
6595:
6596: =item * &xml_begin()
6597:
6598: Returns the needed doctype and <html>
6599:
6600: Inputs: none
6601:
6602: =cut
6603:
6604: sub xml_begin {
6605: my $output='';
6606:
1.592 albertel 6607: if ($env{'internal.start_page'}==1) {
6608: &Apache::lonhtmlcommon::init_htmlareafields();
6609: }
1.342 albertel 6610:
1.341 albertel 6611: if ($env{'browser.mathml'}) {
6612: $output='<?xml version="1.0"?>'
6613: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6614: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6615:
6616: # .'<!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">] >'
6617: .'<!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">'
6618: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6619: .'xmlns="http://www.w3.org/1999/xhtml">';
6620: } else {
1.849 bisitz 6621: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6622: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6623: }
6624: return $output;
6625: }
1.340 albertel 6626:
6627: =pod
6628:
1.306 albertel 6629: =item * &endheadtag()
6630:
6631: Returns a uniform </head> for LON-CAPA web pages.
6632:
6633: Inputs: none
6634:
6635: =cut
6636:
6637: sub endheadtag {
6638: return '</head>';
6639: }
6640:
6641: =pod
6642:
6643: =item * &head()
6644:
6645: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6646:
1.648 raeburn 6647: Inputs:
6648:
6649: =over 4
6650:
6651: $title - optional title for the page
6652:
6653: $head_extra - optional extra HTML to put inside the <head>
6654:
6655: =back
1.405 albertel 6656:
1.306 albertel 6657: =cut
6658:
6659: sub head {
1.325 albertel 6660: my ($title,$head_extra,$args) = @_;
6661: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6662: }
6663:
6664: =pod
6665:
6666: =item * &start_page()
6667:
6668: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6669:
1.648 raeburn 6670: Inputs:
6671:
6672: =over 4
6673:
6674: $title - optional title for the page
6675:
6676: $head_extra - optional extra HTML to incude inside the <head>
6677:
6678: $args - additional optional args supported are:
6679:
6680: =over 8
6681:
6682: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6683: arg on
1.814 bisitz 6684: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6685: add_entries -> additional attributes to add to the <body>
6686: domain -> force to color decorate a page for a
1.317 albertel 6687: specific domain
1.648 raeburn 6688: function -> force usage of a specific rolish color
1.317 albertel 6689: scheme
1.648 raeburn 6690: redirect -> see &headtag()
6691: bgcolor -> override the default page bg color
6692: js_ready -> return a string ready for being used in
1.317 albertel 6693: a javascript writeln
1.648 raeburn 6694: html_encode -> return a string ready for being used in
1.320 albertel 6695: a html attribute
1.648 raeburn 6696: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6697: $forcereg arg
1.648 raeburn 6698: frameset -> if true will start with a <frameset>
1.330 albertel 6699: rather than <body>
1.648 raeburn 6700: skip_phases -> hash ref of
1.338 albertel 6701: head -> skip the <html><head> generation
6702: body -> skip all <body> generation
1.648 raeburn 6703: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6704: 'Switch To Inline Menu' link
1.648 raeburn 6705: no_auto_mt_title -> prevent &mt()ing the title arg
6706: inherit_jsmath -> when creating popup window in a page,
6707: should it have jsmath forced on by the
6708: current page
1.867 kalberla 6709: bread_crumbs -> Array containing breadcrumbs
6710: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6711:
1.648 raeburn 6712: =back
1.460 albertel 6713:
1.648 raeburn 6714: =back
1.562 albertel 6715:
1.306 albertel 6716: =cut
6717:
6718: sub start_page {
1.309 albertel 6719: my ($title,$head_extra,$args) = @_;
1.318 albertel 6720: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6721: my %head_args;
1.352 albertel 6722: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6723: 'bgcolor','frameset','no_nav_bar','only_body',
6724: 'no_auto_mt_title') {
1.319 albertel 6725: if (defined($args->{$arg})) {
1.324 raeburn 6726: $head_args{$arg} = $args->{$arg};
1.319 albertel 6727: }
1.313 albertel 6728: }
1.319 albertel 6729:
1.315 albertel 6730: $env{'internal.start_page'}++;
1.338 albertel 6731: my $result;
6732: if (! exists($args->{'skip_phases'}{'head'}) ) {
6733: $result.=
1.341 albertel 6734: &xml_begin().
1.338 albertel 6735: &headtag($title,$head_extra,\%head_args).&endheadtag();
6736: }
6737:
6738: if (! exists($args->{'skip_phases'}{'body'}) ) {
6739: if ($args->{'frameset'}) {
6740: my $attr_string = &make_attr_string($args->{'force_register'},
6741: $args->{'add_entries'});
6742: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6743: } else {
6744: $result .=
6745: &bodytag($title,
6746: $args->{'function'}, $args->{'add_entries'},
6747: $args->{'only_body'}, $args->{'domain'},
6748: $args->{'force_register'}, $args->{'no_nav_bar'},
6749: $args->{'bgcolor'}, $args->{'no_inline_link'},
6750: $args);
6751: }
1.330 albertel 6752: }
1.338 albertel 6753:
1.315 albertel 6754: if ($args->{'js_ready'}) {
1.713 kaisler 6755: $result = &js_ready($result);
1.315 albertel 6756: }
1.320 albertel 6757: if ($args->{'html_encode'}) {
1.713 kaisler 6758: $result = &html_encode($result);
6759: }
6760:
1.813 bisitz 6761: # Preparation for new and consistent functionlist at top of screen
6762: # if ($args->{'functionlist'}) {
6763: # $result .= &build_functionlist();
6764: #}
6765:
6766: # Don't add anything more if only_body wanted
6767: return $result if $args->{'only_body'};
6768:
1.920 raeburn 6769: #Breadcrumbs for Construction Space provided by &bodytag.
6770: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6771: return $result;
6772: }
6773:
1.813 bisitz 6774: #Breadcrumbs
1.758 kaisler 6775: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6776: &Apache::lonhtmlcommon::clear_breadcrumbs();
6777: #if any br links exists, add them to the breadcrumbs
6778: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6779: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6780: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6781: }
6782: }
6783:
6784: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6785: if(exists($args->{'bread_crumbs_component'})){
6786: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6787: }else{
6788: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6789: }
1.320 albertel 6790: }
1.315 albertel 6791: return $result;
1.306 albertel 6792: }
6793:
1.330 albertel 6794:
1.306 albertel 6795: =pod
6796:
6797: =item * &head()
6798:
6799: Returns a complete </body></html> section for LON-CAPA web pages.
6800:
1.315 albertel 6801: Inputs: $args - additional optional args supported are:
6802: js_ready -> return a string ready for being used in
6803: a javascript writeln
1.320 albertel 6804: html_encode -> return a string ready for being used in
6805: a html attribute
1.330 albertel 6806: frameset -> if true will start with a <frameset>
6807: rather than <body>
1.493 albertel 6808: dicsussion -> if true will get discussion from
6809: lonxml::xmlend
6810: (you can pass the target and parser arguments
6811: through optional 'target' and 'parser' args
6812: to this routine)
1.306 albertel 6813:
6814: =cut
6815:
6816: sub end_page {
1.315 albertel 6817: my ($args) = @_;
6818: $env{'internal.end_page'}++;
1.330 albertel 6819: my $result;
1.335 albertel 6820: if ($args->{'discussion'}) {
6821: my ($target,$parser);
6822: if (ref($args->{'discussion'})) {
6823: ($target,$parser) =($args->{'discussion'}{'target'},
6824: $args->{'discussion'}{'parser'});
6825: }
6826: $result .= &Apache::lonxml::xmlend($target,$parser);
6827: }
6828:
1.330 albertel 6829: if ($args->{'frameset'}) {
6830: $result .= '</frameset>';
6831: } else {
1.635 raeburn 6832: $result .= &endbodytag($args);
1.330 albertel 6833: }
6834: $result .= "\n</html>";
6835:
1.315 albertel 6836: if ($args->{'js_ready'}) {
1.317 albertel 6837: $result = &js_ready($result);
1.315 albertel 6838: }
1.335 albertel 6839:
1.320 albertel 6840: if ($args->{'html_encode'}) {
6841: $result = &html_encode($result);
6842: }
1.335 albertel 6843:
1.315 albertel 6844: return $result;
6845: }
6846:
1.320 albertel 6847: sub html_encode {
6848: my ($result) = @_;
6849:
1.322 albertel 6850: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6851:
6852: return $result;
6853: }
1.317 albertel 6854: sub js_ready {
6855: my ($result) = @_;
6856:
1.323 albertel 6857: $result =~ s/[\n\r]/ /xmsg;
6858: $result =~ s/\\/\\\\/xmsg;
6859: $result =~ s/'/\\'/xmsg;
1.372 albertel 6860: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6861:
6862: return $result;
6863: }
6864:
1.315 albertel 6865: sub validate_page {
6866: if ( exists($env{'internal.start_page'})
1.316 albertel 6867: && $env{'internal.start_page'} > 1) {
6868: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6869: $env{'internal.start_page'}.' '.
1.316 albertel 6870: $ENV{'request.filename'});
1.315 albertel 6871: }
6872: if ( exists($env{'internal.end_page'})
1.316 albertel 6873: && $env{'internal.end_page'} > 1) {
6874: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6875: $env{'internal.end_page'}.' '.
1.316 albertel 6876: $env{'request.filename'});
1.315 albertel 6877: }
6878: if ( exists($env{'internal.start_page'})
6879: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6880: &Apache::lonnet::logthis('start_page called without end_page '.
6881: $env{'request.filename'});
1.315 albertel 6882: }
6883: if ( ! exists($env{'internal.start_page'})
6884: && exists($env{'internal.end_page'})) {
1.316 albertel 6885: &Apache::lonnet::logthis('end_page called without start_page'.
6886: $env{'request.filename'});
1.315 albertel 6887: }
1.306 albertel 6888: }
1.315 albertel 6889:
1.318 albertel 6890: sub simple_error_page {
6891: my ($r,$title,$msg) = @_;
6892: my $page =
6893: &Apache::loncommon::start_page($title).
6894: &mt($msg).
6895: &Apache::loncommon::end_page();
6896: if (ref($r)) {
6897: $r->print($page);
1.327 albertel 6898: return;
1.318 albertel 6899: }
6900: return $page;
6901: }
1.347 albertel 6902:
6903: {
1.610 albertel 6904: my @row_count;
1.347 albertel 6905: sub start_data_table {
1.422 albertel 6906: my ($add_class) = @_;
6907: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6908: unshift(@row_count,0);
1.422 albertel 6909: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6910: }
6911:
6912: sub end_data_table {
1.610 albertel 6913: shift(@row_count);
1.389 albertel 6914: return '</table>'."\n";;
1.347 albertel 6915: }
6916:
6917: sub start_data_table_row {
1.422 albertel 6918: my ($add_class) = @_;
1.610 albertel 6919: $row_count[0]++;
6920: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6921: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6922: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6923: }
1.471 banghart 6924:
6925: sub continue_data_table_row {
6926: my ($add_class) = @_;
1.610 albertel 6927: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6928: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6929: return '<tr class="'.$css_class.'">'."\n";;
6930: }
1.347 albertel 6931:
6932: sub end_data_table_row {
1.389 albertel 6933: return '</tr>'."\n";;
1.347 albertel 6934: }
1.367 www 6935:
1.421 albertel 6936: sub start_data_table_empty_row {
1.707 bisitz 6937: # $row_count[0]++;
1.421 albertel 6938: return '<tr class="LC_empty_row" >'."\n";;
6939: }
6940:
6941: sub end_data_table_empty_row {
6942: return '</tr>'."\n";;
6943: }
6944:
1.367 www 6945: sub start_data_table_header_row {
1.389 albertel 6946: return '<tr class="LC_header_row">'."\n";;
1.367 www 6947: }
6948:
6949: sub end_data_table_header_row {
1.389 albertel 6950: return '</tr>'."\n";;
1.367 www 6951: }
1.890 droeschl 6952:
6953: sub data_table_caption {
6954: my $caption = shift;
6955: return "<caption class=\"LC_caption\">$caption</caption>";
6956: }
1.347 albertel 6957: }
6958:
1.548 albertel 6959: =pod
6960:
6961: =item * &inhibit_menu_check($arg)
6962:
6963: Checks for a inhibitmenu state and generates output to preserve it
6964:
6965: Inputs: $arg - can be any of
6966: - undef - in which case the return value is a string
6967: to add into arguments list of a uri
6968: - 'input' - in which case the return value is a HTML
6969: <form> <input> field of type hidden to
6970: preserve the value
6971: - a url - in which case the return value is the url with
6972: the neccesary cgi args added to preserve the
6973: inhibitmenu state
6974: - a ref to a url - no return value, but the string is
6975: updated to include the neccessary cgi
6976: args to preserve the inhibitmenu state
6977:
6978: =cut
6979:
6980: sub inhibit_menu_check {
6981: my ($arg) = @_;
6982: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6983: if ($arg eq 'input') {
6984: if ($env{'form.inhibitmenu'}) {
6985: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6986: } else {
6987: return
6988: }
6989: }
6990: if ($env{'form.inhibitmenu'}) {
6991: if (ref($arg)) {
6992: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6993: } elsif ($arg eq '') {
6994: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6995: } else {
6996: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6997: }
6998: }
6999: if (!ref($arg)) {
7000: return $arg;
7001: }
7002: }
7003:
1.251 albertel 7004: ###############################################
1.182 matthew 7005:
7006: =pod
7007:
1.549 albertel 7008: =back
7009:
7010: =head1 User Information Routines
7011:
7012: =over 4
7013:
1.405 albertel 7014: =item * &get_users_function()
1.182 matthew 7015:
7016: Used by &bodytag to determine the current users primary role.
7017: Returns either 'student','coordinator','admin', or 'author'.
7018:
7019: =cut
7020:
7021: ###############################################
7022: sub get_users_function {
1.815 tempelho 7023: my $function = 'norole';
1.818 tempelho 7024: if ($env{'request.role'}=~/^(st)/) {
7025: $function='student';
7026: }
1.907 raeburn 7027: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7028: $function='coordinator';
7029: }
1.258 albertel 7030: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7031: $function='admin';
7032: }
1.826 bisitz 7033: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7034: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7035: $function='author';
7036: }
7037: return $function;
1.54 www 7038: }
1.99 www 7039:
7040: ###############################################
7041:
1.233 raeburn 7042: =pod
7043:
1.821 raeburn 7044: =item * &show_course()
7045:
7046: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7047: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7048:
7049: Inputs:
7050: None
7051:
7052: Outputs:
7053: Scalar: 1 if 'Course' to be used, 0 otherwise.
7054:
7055: =cut
7056:
7057: ###############################################
7058: sub show_course {
7059: my $course = !$env{'user.adv'};
7060: if (!$env{'user.adv'}) {
7061: foreach my $env (keys(%env)) {
7062: next if ($env !~ m/^user\.priv\./);
7063: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7064: $course = 0;
7065: last;
7066: }
7067: }
7068: }
7069: return $course;
7070: }
7071:
7072: ###############################################
7073:
7074: =pod
7075:
1.542 raeburn 7076: =item * &check_user_status()
1.274 raeburn 7077:
7078: Determines current status of supplied role for a
7079: specific user. Roles can be active, previous or future.
7080:
7081: Inputs:
7082: user's domain, user's username, course's domain,
1.375 raeburn 7083: course's number, optional section ID.
1.274 raeburn 7084:
7085: Outputs:
7086: role status: active, previous or future.
7087:
7088: =cut
7089:
7090: sub check_user_status {
1.412 raeburn 7091: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7092: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7093: my @uroles = keys %userinfo;
7094: my $srchstr;
7095: my $active_chk = 'none';
1.412 raeburn 7096: my $now = time;
1.274 raeburn 7097: if (@uroles > 0) {
1.908 raeburn 7098: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7099: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7100: } else {
1.412 raeburn 7101: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7102: }
7103: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7104: my $role_end = 0;
7105: my $role_start = 0;
7106: $active_chk = 'active';
1.412 raeburn 7107: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7108: $role_end = $1;
7109: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7110: $role_start = $1;
1.274 raeburn 7111: }
7112: }
7113: if ($role_start > 0) {
1.412 raeburn 7114: if ($now < $role_start) {
1.274 raeburn 7115: $active_chk = 'future';
7116: }
7117: }
7118: if ($role_end > 0) {
1.412 raeburn 7119: if ($now > $role_end) {
1.274 raeburn 7120: $active_chk = 'previous';
7121: }
7122: }
7123: }
7124: }
7125: return $active_chk;
7126: }
7127:
7128: ###############################################
7129:
7130: =pod
7131:
1.405 albertel 7132: =item * &get_sections()
1.233 raeburn 7133:
7134: Determines all the sections for a course including
7135: sections with students and sections containing other roles.
1.419 raeburn 7136: Incoming parameters:
7137:
7138: 1. domain
7139: 2. course number
7140: 3. reference to array containing roles for which sections should
7141: be gathered (optional).
7142: 4. reference to array containing status types for which sections
7143: should be gathered (optional).
7144:
7145: If the third argument is undefined, sections are gathered for any role.
7146: If the fourth argument is undefined, sections are gathered for any status.
7147: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7148:
1.374 raeburn 7149: Returns section hash (keys are section IDs, values are
7150: number of users in each section), subject to the
1.419 raeburn 7151: optional roles filter, optional status filter
1.233 raeburn 7152:
7153: =cut
7154:
7155: ###############################################
7156: sub get_sections {
1.419 raeburn 7157: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7158: if (!defined($cdom) || !defined($cnum)) {
7159: my $cid = $env{'request.course.id'};
7160:
7161: return if (!defined($cid));
7162:
7163: $cdom = $env{'course.'.$cid.'.domain'};
7164: $cnum = $env{'course.'.$cid.'.num'};
7165: }
7166:
7167: my %sectioncount;
1.419 raeburn 7168: my $now = time;
1.240 albertel 7169:
1.366 albertel 7170: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7171: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7172: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7173: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7174: my $start_index = &Apache::loncoursedata::CL_START();
7175: my $end_index = &Apache::loncoursedata::CL_END();
7176: my $status;
1.366 albertel 7177: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7178: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7179: $data->[$status_index],
7180: $data->[$start_index],
7181: $data->[$end_index]);
7182: if ($stu_status eq 'Active') {
7183: $status = 'active';
7184: } elsif ($end < $now) {
7185: $status = 'previous';
7186: } elsif ($start > $now) {
7187: $status = 'future';
7188: }
7189: if ($section ne '-1' && $section !~ /^\s*$/) {
7190: if ((!defined($possible_status)) || (($status ne '') &&
7191: (grep/^\Q$status\E$/,@{$possible_status}))) {
7192: $sectioncount{$section}++;
7193: }
1.240 albertel 7194: }
7195: }
7196: }
7197: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7198: foreach my $user (sort(keys(%courseroles))) {
7199: if ($user !~ /^(\w{2})/) { next; }
7200: my ($role) = ($user =~ /^(\w{2})/);
7201: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7202: my ($section,$status);
1.240 albertel 7203: if ($role eq 'cr' &&
7204: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7205: $section=$1;
7206: }
7207: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7208: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7209: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7210: if ($end == -1 && $start == -1) {
7211: next; #deleted role
7212: }
7213: if (!defined($possible_status)) {
7214: $sectioncount{$section}++;
7215: } else {
7216: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7217: $status = 'active';
7218: } elsif ($end < $now) {
7219: $status = 'future';
7220: } elsif ($start > $now) {
7221: $status = 'previous';
7222: }
7223: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7224: $sectioncount{$section}++;
7225: }
7226: }
1.233 raeburn 7227: }
1.366 albertel 7228: return %sectioncount;
1.233 raeburn 7229: }
7230:
1.274 raeburn 7231: ###############################################
1.294 raeburn 7232:
7233: =pod
1.405 albertel 7234:
7235: =item * &get_course_users()
7236:
1.275 raeburn 7237: Retrieves usernames:domains for users in the specified course
7238: with specific role(s), and access status.
7239:
7240: Incoming parameters:
1.277 albertel 7241: 1. course domain
7242: 2. course number
7243: 3. access status: users must have - either active,
1.275 raeburn 7244: previous, future, or all.
1.277 albertel 7245: 4. reference to array of permissible roles
1.288 raeburn 7246: 5. reference to array of section restrictions (optional)
7247: 6. reference to results object (hash of hashes).
7248: 7. reference to optional userdata hash
1.609 raeburn 7249: 8. reference to optional statushash
1.630 raeburn 7250: 9. flag if privileged users (except those set to unhide in
7251: course settings) should be excluded
1.609 raeburn 7252: Keys of top level results hash are roles.
1.275 raeburn 7253: Keys of inner hashes are username:domain, with
7254: values set to access type.
1.288 raeburn 7255: Optional userdata hash returns an array with arguments in the
7256: same order as loncoursedata::get_classlist() for student data.
7257:
1.609 raeburn 7258: Optional statushash returns
7259:
1.288 raeburn 7260: Entries for end, start, section and status are blank because
7261: of the possibility of multiple values for non-student roles.
7262:
1.275 raeburn 7263: =cut
1.405 albertel 7264:
1.275 raeburn 7265: ###############################################
1.405 albertel 7266:
1.275 raeburn 7267: sub get_course_users {
1.630 raeburn 7268: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7269: my %idx = ();
1.419 raeburn 7270: my %seclists;
1.288 raeburn 7271:
7272: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7273: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7274: $idx{end} = &Apache::loncoursedata::CL_END();
7275: $idx{start} = &Apache::loncoursedata::CL_START();
7276: $idx{id} = &Apache::loncoursedata::CL_ID();
7277: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7278: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7279: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7280:
1.290 albertel 7281: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7282: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7283: my $now = time;
1.277 albertel 7284: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7285: my $match = 0;
1.412 raeburn 7286: my $secmatch = 0;
1.419 raeburn 7287: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7288: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7289: if ($section eq '') {
7290: $section = 'none';
7291: }
1.291 albertel 7292: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7293: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7294: $secmatch = 1;
7295: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7296: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7297: $secmatch = 1;
7298: }
7299: } else {
1.419 raeburn 7300: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7301: $secmatch = 1;
7302: }
1.290 albertel 7303: }
1.412 raeburn 7304: if (!$secmatch) {
7305: next;
7306: }
1.419 raeburn 7307: }
1.275 raeburn 7308: if (defined($$types{'active'})) {
1.288 raeburn 7309: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7310: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7311: $match = 1;
1.275 raeburn 7312: }
7313: }
7314: if (defined($$types{'previous'})) {
1.609 raeburn 7315: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7316: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7317: $match = 1;
1.275 raeburn 7318: }
7319: }
7320: if (defined($$types{'future'})) {
1.609 raeburn 7321: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7322: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7323: $match = 1;
1.275 raeburn 7324: }
7325: }
1.609 raeburn 7326: if ($match) {
7327: push(@{$seclists{$student}},$section);
7328: if (ref($userdata) eq 'HASH') {
7329: $$userdata{$student} = $$classlist{$student};
7330: }
7331: if (ref($statushash) eq 'HASH') {
7332: $statushash->{$student}{'st'}{$section} = $status;
7333: }
1.288 raeburn 7334: }
1.275 raeburn 7335: }
7336: }
1.412 raeburn 7337: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7338: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7339: my $now = time;
1.609 raeburn 7340: my %displaystatus = ( previous => 'Expired',
7341: active => 'Active',
7342: future => 'Future',
7343: );
1.630 raeburn 7344: my %nothide;
7345: if ($hidepriv) {
7346: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7347: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7348: if ($user !~ /:/) {
7349: $nothide{join(':',split(/[\@]/,$user))}=1;
7350: } else {
7351: $nothide{$user} = 1;
7352: }
7353: }
7354: }
1.439 raeburn 7355: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7356: my $match = 0;
1.412 raeburn 7357: my $secmatch = 0;
1.439 raeburn 7358: my $status;
1.412 raeburn 7359: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7360: $user =~ s/:$//;
1.439 raeburn 7361: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7362: if ($end == -1 || $start == -1) {
7363: next;
7364: }
7365: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7366: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7367: my ($uname,$udom) = split(/:/,$user);
7368: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7369: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7370: $secmatch = 1;
7371: } elsif ($usec eq '') {
1.420 albertel 7372: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7373: $secmatch = 1;
7374: }
7375: } else {
7376: if (grep(/^\Q$usec\E$/,@{$sections})) {
7377: $secmatch = 1;
7378: }
7379: }
7380: if (!$secmatch) {
7381: next;
7382: }
1.288 raeburn 7383: }
1.419 raeburn 7384: if ($usec eq '') {
7385: $usec = 'none';
7386: }
1.275 raeburn 7387: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7388: if ($hidepriv) {
7389: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7390: (!$nothide{$uname.':'.$udom})) {
7391: next;
7392: }
7393: }
1.503 raeburn 7394: if ($end > 0 && $end < $now) {
1.439 raeburn 7395: $status = 'previous';
7396: } elsif ($start > $now) {
7397: $status = 'future';
7398: } else {
7399: $status = 'active';
7400: }
1.277 albertel 7401: foreach my $type (keys(%{$types})) {
1.275 raeburn 7402: if ($status eq $type) {
1.420 albertel 7403: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7404: push(@{$$users{$role}{$user}},$type);
7405: }
1.288 raeburn 7406: $match = 1;
7407: }
7408: }
1.419 raeburn 7409: if (($match) && (ref($userdata) eq 'HASH')) {
7410: if (!exists($$userdata{$uname.':'.$udom})) {
7411: &get_user_info($udom,$uname,\%idx,$userdata);
7412: }
1.420 albertel 7413: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7414: push(@{$seclists{$uname.':'.$udom}},$usec);
7415: }
1.609 raeburn 7416: if (ref($statushash) eq 'HASH') {
7417: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7418: }
1.275 raeburn 7419: }
7420: }
7421: }
7422: }
1.290 albertel 7423: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7424: if ((defined($cdom)) && (defined($cnum))) {
7425: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7426: if ( defined($csettings{'internal.courseowner'}) ) {
7427: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7428: next if ($owner eq '');
7429: my ($ownername,$ownerdom);
7430: if ($owner =~ /^([^:]+):([^:]+)$/) {
7431: $ownername = $1;
7432: $ownerdom = $2;
7433: } else {
7434: $ownername = $owner;
7435: $ownerdom = $cdom;
7436: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7437: }
7438: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7439: if (defined($userdata) &&
1.609 raeburn 7440: !exists($$userdata{$owner})) {
7441: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7442: if (!grep(/^none$/,@{$seclists{$owner}})) {
7443: push(@{$seclists{$owner}},'none');
7444: }
7445: if (ref($statushash) eq 'HASH') {
7446: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7447: }
1.290 albertel 7448: }
1.279 raeburn 7449: }
7450: }
7451: }
1.419 raeburn 7452: foreach my $user (keys(%seclists)) {
7453: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7454: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7455: }
1.275 raeburn 7456: }
7457: return;
7458: }
7459:
1.288 raeburn 7460: sub get_user_info {
7461: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7462: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7463: &plainname($uname,$udom,'lastname');
1.291 albertel 7464: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7465: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7466: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7467: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7468: return;
7469: }
1.275 raeburn 7470:
1.472 raeburn 7471: ###############################################
7472:
7473: =pod
7474:
7475: =item * &get_user_quota()
7476:
7477: Retrieves quota assigned for storage of portfolio files for a user
7478:
7479: Incoming parameters:
7480: 1. user's username
7481: 2. user's domain
7482:
7483: Returns:
1.536 raeburn 7484: 1. Disk quota (in Mb) assigned to student.
7485: 2. (Optional) Type of setting: custom or default
7486: (individually assigned or default for user's
7487: institutional status).
7488: 3. (Optional) - User's institutional status (e.g., faculty, staff
7489: or student - types as defined in localenroll::inst_usertypes
7490: for user's domain, which determines default quota for user.
7491: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7492:
7493: If a value has been stored in the user's environment,
1.536 raeburn 7494: it will return that, otherwise it returns the maximal default
7495: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7496:
7497: =cut
7498:
7499: ###############################################
7500:
7501:
7502: sub get_user_quota {
7503: my ($uname,$udom) = @_;
1.536 raeburn 7504: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7505: if (!defined($udom)) {
7506: $udom = $env{'user.domain'};
7507: }
7508: if (!defined($uname)) {
7509: $uname = $env{'user.name'};
7510: }
7511: if (($udom eq '' || $uname eq '') ||
7512: ($udom eq 'public') && ($uname eq 'public')) {
7513: $quota = 0;
1.536 raeburn 7514: $quotatype = 'default';
7515: $defquota = 0;
1.472 raeburn 7516: } else {
1.536 raeburn 7517: my $inststatus;
1.472 raeburn 7518: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7519: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7520: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7521: } else {
1.536 raeburn 7522: my %userenv =
7523: &Apache::lonnet::get('environment',['portfolioquota',
7524: 'inststatus'],$udom,$uname);
1.472 raeburn 7525: my ($tmp) = keys(%userenv);
7526: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7527: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7528: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7529: } else {
7530: undef(%userenv);
7531: }
7532: }
1.536 raeburn 7533: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7534: if ($quota eq '') {
1.536 raeburn 7535: $quota = $defquota;
7536: $quotatype = 'default';
7537: } else {
7538: $quotatype = 'custom';
1.472 raeburn 7539: }
7540: }
1.536 raeburn 7541: if (wantarray) {
7542: return ($quota,$quotatype,$settingstatus,$defquota);
7543: } else {
7544: return $quota;
7545: }
1.472 raeburn 7546: }
7547:
7548: ###############################################
7549:
7550: =pod
7551:
7552: =item * &default_quota()
7553:
1.536 raeburn 7554: Retrieves default quota assigned for storage of user portfolio files,
7555: given an (optional) user's institutional status.
1.472 raeburn 7556:
7557: Incoming parameters:
7558: 1. domain
1.536 raeburn 7559: 2. (Optional) institutional status(es). This is a : separated list of
7560: status types (e.g., faculty, staff, student etc.)
7561: which apply to the user for whom the default is being retrieved.
7562: If the institutional status string in undefined, the domain
7563: default quota will be returned.
1.472 raeburn 7564:
7565: Returns:
7566: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7567: 2. (Optional) institutional type which determined the value of the
7568: default quota.
1.472 raeburn 7569:
7570: If a value has been stored in the domain's configuration db,
7571: it will return that, otherwise it returns 20 (for backwards
7572: compatibility with domains which have not set up a configuration
7573: db file; the original statically defined portfolio quota was 20 Mb).
7574:
1.536 raeburn 7575: If the user's status includes multiple types (e.g., staff and student),
7576: the largest default quota which applies to the user determines the
7577: default quota returned.
7578:
1.780 raeburn 7579: =back
7580:
1.472 raeburn 7581: =cut
7582:
7583: ###############################################
7584:
7585:
7586: sub default_quota {
1.536 raeburn 7587: my ($udom,$inststatus) = @_;
7588: my ($defquota,$settingstatus);
7589: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7590: ['quotas'],$udom);
7591: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7592: if ($inststatus ne '') {
1.765 raeburn 7593: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7594: foreach my $item (@statuses) {
1.711 raeburn 7595: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7596: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7597: if ($defquota eq '') {
7598: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7599: $settingstatus = $item;
7600: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7601: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7602: $settingstatus = $item;
7603: }
7604: }
7605: } else {
7606: if ($quotahash{'quotas'}{$item} ne '') {
7607: if ($defquota eq '') {
7608: $defquota = $quotahash{'quotas'}{$item};
7609: $settingstatus = $item;
7610: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7611: $defquota = $quotahash{'quotas'}{$item};
7612: $settingstatus = $item;
7613: }
1.536 raeburn 7614: }
7615: }
7616: }
7617: }
7618: if ($defquota eq '') {
1.711 raeburn 7619: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7620: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7621: } else {
7622: $defquota = $quotahash{'quotas'}{'default'};
7623: }
1.536 raeburn 7624: $settingstatus = 'default';
7625: }
7626: } else {
7627: $settingstatus = 'default';
7628: $defquota = 20;
7629: }
7630: if (wantarray) {
7631: return ($defquota,$settingstatus);
1.472 raeburn 7632: } else {
1.536 raeburn 7633: return $defquota;
1.472 raeburn 7634: }
7635: }
7636:
1.384 raeburn 7637: sub get_secgrprole_info {
7638: my ($cdom,$cnum,$needroles,$type) = @_;
7639: my %sections_count = &get_sections($cdom,$cnum);
7640: my @sections = (sort {$a <=> $b} keys(%sections_count));
7641: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7642: my @groups = sort(keys(%curr_groups));
7643: my $allroles = [];
7644: my $rolehash;
7645: my $accesshash = {
7646: active => 'Currently has access',
7647: future => 'Will have future access',
7648: previous => 'Previously had access',
7649: };
7650: if ($needroles) {
7651: $rolehash = {'all' => 'all'};
1.385 albertel 7652: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7653: if (&Apache::lonnet::error(%user_roles)) {
7654: undef(%user_roles);
7655: }
7656: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7657: my ($role)=split(/\:/,$item,2);
7658: if ($role eq 'cr') { next; }
7659: if ($role =~ /^cr/) {
7660: $$rolehash{$role} = (split('/',$role))[3];
7661: } else {
7662: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7663: }
7664: }
7665: foreach my $key (sort(keys(%{$rolehash}))) {
7666: push(@{$allroles},$key);
7667: }
7668: push (@{$allroles},'st');
7669: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7670: }
7671: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7672: }
7673:
1.555 raeburn 7674: sub user_picker {
1.627 raeburn 7675: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7676: my $currdom = $dom;
7677: my %curr_selected = (
7678: srchin => 'dom',
1.580 raeburn 7679: srchby => 'lastname',
1.555 raeburn 7680: );
7681: my $srchterm;
1.625 raeburn 7682: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7683: if ($srch->{'srchby'} ne '') {
7684: $curr_selected{'srchby'} = $srch->{'srchby'};
7685: }
7686: if ($srch->{'srchin'} ne '') {
7687: $curr_selected{'srchin'} = $srch->{'srchin'};
7688: }
7689: if ($srch->{'srchtype'} ne '') {
7690: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7691: }
7692: if ($srch->{'srchdomain'} ne '') {
7693: $currdom = $srch->{'srchdomain'};
7694: }
7695: $srchterm = $srch->{'srchterm'};
7696: }
7697: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7698: 'usr' => 'Search criteria',
1.563 raeburn 7699: 'doma' => 'Domain/institution to search',
1.558 albertel 7700: 'uname' => 'username',
7701: 'lastname' => 'last name',
1.555 raeburn 7702: 'lastfirst' => 'last name, first name',
1.558 albertel 7703: 'crs' => 'in this course',
1.576 raeburn 7704: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7705: 'alc' => 'all LON-CAPA',
1.573 raeburn 7706: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7707: 'exact' => 'is',
7708: 'contains' => 'contains',
1.569 raeburn 7709: 'begins' => 'begins with',
1.571 raeburn 7710: 'youm' => "You must include some text to search for.",
7711: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7712: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7713: 'yomc' => "You must choose a domain when using an institutional directory search.",
7714: 'ymcd' => "You must choose a domain when using a domain search.",
7715: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7716: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7717: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7718: );
1.563 raeburn 7719: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7720: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7721:
7722: my @srchins = ('crs','dom','alc','instd');
7723:
7724: foreach my $option (@srchins) {
7725: # FIXME 'alc' option unavailable until
7726: # loncreateuser::print_user_query_page()
7727: # has been completed.
7728: next if ($option eq 'alc');
1.880 raeburn 7729: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7730: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7731: if ($curr_selected{'srchin'} eq $option) {
7732: $srchinsel .= '
7733: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7734: } else {
7735: $srchinsel .= '
7736: <option value="'.$option.'">'.$lt{$option}.'</option>';
7737: }
1.555 raeburn 7738: }
1.563 raeburn 7739: $srchinsel .= "\n </select>\n";
1.555 raeburn 7740:
7741: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7742: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7743: if ($curr_selected{'srchby'} eq $option) {
7744: $srchbysel .= '
7745: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7746: } else {
7747: $srchbysel .= '
7748: <option value="'.$option.'">'.$lt{$option}.'</option>';
7749: }
7750: }
7751: $srchbysel .= "\n </select>\n";
7752:
7753: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7754: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7755: if ($curr_selected{'srchtype'} eq $option) {
7756: $srchtypesel .= '
7757: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7758: } else {
7759: $srchtypesel .= '
7760: <option value="'.$option.'">'.$lt{$option}.'</option>';
7761: }
7762: }
7763: $srchtypesel .= "\n </select>\n";
7764:
1.558 albertel 7765: my ($newuserscript,$new_user_create);
1.556 raeburn 7766:
7767: if ($forcenewuser) {
1.576 raeburn 7768: if (ref($srch) eq 'HASH') {
7769: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7770: if ($cancreate) {
7771: $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>';
7772: } else {
1.799 bisitz 7773: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7774: my %usertypetext = (
7775: official => 'institutional',
7776: unofficial => 'non-institutional',
7777: );
1.799 bisitz 7778: $new_user_create = '<p class="LC_warning">'
7779: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7780: .' '
7781: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7782: ,'<a href="'.$helplink.'">','</a>')
7783: .'</p><br />';
1.627 raeburn 7784: }
1.576 raeburn 7785: }
7786: }
7787:
1.556 raeburn 7788: $newuserscript = <<"ENDSCRIPT";
7789:
1.570 raeburn 7790: function setSearch(createnew,callingForm) {
1.556 raeburn 7791: if (createnew == 1) {
1.570 raeburn 7792: for (var i=0; i<callingForm.srchby.length; i++) {
7793: if (callingForm.srchby.options[i].value == 'uname') {
7794: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7795: }
7796: }
1.570 raeburn 7797: for (var i=0; i<callingForm.srchin.length; i++) {
7798: if ( callingForm.srchin.options[i].value == 'dom') {
7799: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7800: }
7801: }
1.570 raeburn 7802: for (var i=0; i<callingForm.srchtype.length; i++) {
7803: if (callingForm.srchtype.options[i].value == 'exact') {
7804: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7805: }
7806: }
1.570 raeburn 7807: for (var i=0; i<callingForm.srchdomain.length; i++) {
7808: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7809: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7810: }
7811: }
7812: }
7813: }
7814: ENDSCRIPT
1.558 albertel 7815:
1.556 raeburn 7816: }
7817:
1.555 raeburn 7818: my $output = <<"END_BLOCK";
1.556 raeburn 7819: <script type="text/javascript">
1.824 bisitz 7820: // <![CDATA[
1.570 raeburn 7821: function validateEntry(callingForm) {
1.558 albertel 7822:
1.556 raeburn 7823: var checkok = 1;
1.558 albertel 7824: var srchin;
1.570 raeburn 7825: for (var i=0; i<callingForm.srchin.length; i++) {
7826: if ( callingForm.srchin[i].checked ) {
7827: srchin = callingForm.srchin[i].value;
1.558 albertel 7828: }
7829: }
7830:
1.570 raeburn 7831: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7832: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7833: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7834: var srchterm = callingForm.srchterm.value;
7835: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7836: var msg = "";
7837:
7838: if (srchterm == "") {
7839: checkok = 0;
1.571 raeburn 7840: msg += "$lt{'youm'}\\n";
1.556 raeburn 7841: }
7842:
1.569 raeburn 7843: if (srchtype== 'begins') {
7844: if (srchterm.length < 2) {
7845: checkok = 0;
1.571 raeburn 7846: msg += "$lt{'thte'}\\n";
1.569 raeburn 7847: }
7848: }
7849:
1.556 raeburn 7850: if (srchtype== 'contains') {
7851: if (srchterm.length < 3) {
7852: checkok = 0;
1.571 raeburn 7853: msg += "$lt{'thet'}\\n";
1.556 raeburn 7854: }
7855: }
7856: if (srchin == 'instd') {
7857: if (srchdomain == '') {
7858: checkok = 0;
1.571 raeburn 7859: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7860: }
7861: }
7862: if (srchin == 'dom') {
7863: if (srchdomain == '') {
7864: checkok = 0;
1.571 raeburn 7865: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7866: }
7867: }
7868: if (srchby == 'lastfirst') {
7869: if (srchterm.indexOf(",") == -1) {
7870: checkok = 0;
1.571 raeburn 7871: msg += "$lt{'whus'}\\n";
1.556 raeburn 7872: }
7873: if (srchterm.indexOf(",") == srchterm.length -1) {
7874: checkok = 0;
1.571 raeburn 7875: msg += "$lt{'whse'}\\n";
1.556 raeburn 7876: }
7877: }
7878: if (checkok == 0) {
1.571 raeburn 7879: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7880: return;
7881: }
7882: if (checkok == 1) {
1.570 raeburn 7883: callingForm.submit();
1.556 raeburn 7884: }
7885: }
7886:
7887: $newuserscript
7888:
1.824 bisitz 7889: // ]]>
1.556 raeburn 7890: </script>
1.558 albertel 7891:
7892: $new_user_create
7893:
1.555 raeburn 7894: END_BLOCK
1.558 albertel 7895:
1.876 raeburn 7896: $output .= &Apache::lonhtmlcommon::start_pick_box().
7897: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7898: $domform.
7899: &Apache::lonhtmlcommon::row_closure().
7900: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7901: $srchbysel.
7902: $srchtypesel.
7903: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7904: $srchinsel.
7905: &Apache::lonhtmlcommon::row_closure(1).
7906: &Apache::lonhtmlcommon::end_pick_box().
7907: '<br />';
1.555 raeburn 7908: return $output;
7909: }
7910:
1.612 raeburn 7911: sub user_rule_check {
1.615 raeburn 7912: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7913: my $response;
7914: if (ref($usershash) eq 'HASH') {
7915: foreach my $user (keys(%{$usershash})) {
7916: my ($uname,$udom) = split(/:/,$user);
7917: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7918: my ($id,$newuser);
1.612 raeburn 7919: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7920: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7921: $id = $usershash->{$user}->{'id'};
7922: }
7923: my $inst_response;
7924: if (ref($checks) eq 'HASH') {
7925: if (defined($checks->{'username'})) {
1.615 raeburn 7926: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7927: &Apache::lonnet::get_instuser($udom,$uname);
7928: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7929: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7930: &Apache::lonnet::get_instuser($udom,undef,$id);
7931: }
1.615 raeburn 7932: } else {
7933: ($inst_response,%{$inst_results->{$user}}) =
7934: &Apache::lonnet::get_instuser($udom,$uname);
7935: return;
1.612 raeburn 7936: }
1.615 raeburn 7937: if (!$got_rules->{$udom}) {
1.612 raeburn 7938: my %domconfig = &Apache::lonnet::get_dom('configuration',
7939: ['usercreation'],$udom);
7940: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7941: foreach my $item ('username','id') {
1.612 raeburn 7942: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7943: $$curr_rules{$udom}{$item} =
7944: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7945: }
7946: }
7947: }
1.615 raeburn 7948: $got_rules->{$udom} = 1;
1.585 raeburn 7949: }
1.612 raeburn 7950: foreach my $item (keys(%{$checks})) {
7951: if (ref($$curr_rules{$udom}) eq 'HASH') {
7952: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7953: if (@{$$curr_rules{$udom}{$item}} > 0) {
7954: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7955: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7956: if ($rule_check{$rule}) {
7957: $$rulematch{$user}{$item} = $rule;
7958: if ($inst_response eq 'ok') {
1.615 raeburn 7959: if (ref($inst_results) eq 'HASH') {
7960: if (ref($inst_results->{$user}) eq 'HASH') {
7961: if (keys(%{$inst_results->{$user}}) == 0) {
7962: $$alerts{$item}{$udom}{$uname} = 1;
7963: }
1.612 raeburn 7964: }
7965: }
1.615 raeburn 7966: }
7967: last;
1.585 raeburn 7968: }
7969: }
7970: }
7971: }
7972: }
7973: }
7974: }
7975: }
1.612 raeburn 7976: return;
7977: }
7978:
7979: sub user_rule_formats {
7980: my ($domain,$domdesc,$curr_rules,$check) = @_;
7981: my %text = (
7982: 'username' => 'Usernames',
7983: 'id' => 'IDs',
7984: );
7985: my $output;
7986: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7987: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7988: if (@{$ruleorder} > 0) {
7989: $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>';
7990: foreach my $rule (@{$ruleorder}) {
7991: if (ref($curr_rules) eq 'ARRAY') {
7992: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7993: if (ref($rules->{$rule}) eq 'HASH') {
7994: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7995: $rules->{$rule}{'desc'}.'</li>';
7996: }
7997: }
7998: }
7999: }
8000: $output .= '</ul>';
8001: }
8002: }
8003: return $output;
8004: }
8005:
8006: sub instrule_disallow_msg {
1.615 raeburn 8007: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8008: my $response;
8009: my %text = (
8010: item => 'username',
8011: items => 'usernames',
8012: match => 'matches',
8013: do => 'does',
8014: action => 'a username',
8015: one => 'one',
8016: );
8017: if ($count > 1) {
8018: $text{'item'} = 'usernames';
8019: $text{'match'} ='match';
8020: $text{'do'} = 'do';
8021: $text{'action'} = 'usernames',
8022: $text{'one'} = 'ones';
8023: }
8024: if ($checkitem eq 'id') {
8025: $text{'items'} = 'IDs';
8026: $text{'item'} = 'ID';
8027: $text{'action'} = 'an ID';
1.615 raeburn 8028: if ($count > 1) {
8029: $text{'item'} = 'IDs';
8030: $text{'action'} = 'IDs';
8031: }
1.612 raeburn 8032: }
1.674 bisitz 8033: $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 8034: if ($mode eq 'upload') {
8035: if ($checkitem eq 'username') {
8036: $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'}.");
8037: } elsif ($checkitem eq 'id') {
1.674 bisitz 8038: $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 8039: }
1.669 raeburn 8040: } elsif ($mode eq 'selfcreate') {
8041: if ($checkitem eq 'id') {
8042: $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.");
8043: }
1.615 raeburn 8044: } else {
8045: if ($checkitem eq 'username') {
8046: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8047: } elsif ($checkitem eq 'id') {
8048: $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.");
8049: }
1.612 raeburn 8050: }
8051: return $response;
1.585 raeburn 8052: }
8053:
1.624 raeburn 8054: sub personal_data_fieldtitles {
8055: my %fieldtitles = &Apache::lonlocal::texthash (
8056: id => 'Student/Employee ID',
8057: permanentemail => 'E-mail address',
8058: lastname => 'Last Name',
8059: firstname => 'First Name',
8060: middlename => 'Middle Name',
8061: generation => 'Generation',
8062: gen => 'Generation',
1.765 raeburn 8063: inststatus => 'Affiliation',
1.624 raeburn 8064: );
8065: return %fieldtitles;
8066: }
8067:
1.642 raeburn 8068: sub sorted_inst_types {
8069: my ($dom) = @_;
8070: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8071: my $othertitle = &mt('All users');
8072: if ($env{'request.course.id'}) {
1.668 raeburn 8073: $othertitle = &mt('Any users');
1.642 raeburn 8074: }
8075: my @types;
8076: if (ref($order) eq 'ARRAY') {
8077: @types = @{$order};
8078: }
8079: if (@types == 0) {
8080: if (ref($usertypes) eq 'HASH') {
8081: @types = sort(keys(%{$usertypes}));
8082: }
8083: }
8084: if (keys(%{$usertypes}) > 0) {
8085: $othertitle = &mt('Other users');
8086: }
8087: return ($othertitle,$usertypes,\@types);
8088: }
8089:
1.645 raeburn 8090: sub get_institutional_codes {
8091: my ($settings,$allcourses,$LC_code) = @_;
8092: # Get complete list of course sections to update
8093: my @currsections = ();
8094: my @currxlists = ();
8095: my $coursecode = $$settings{'internal.coursecode'};
8096:
8097: if ($$settings{'internal.sectionnums'} ne '') {
8098: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8099: }
8100:
8101: if ($$settings{'internal.crosslistings'} ne '') {
8102: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8103: }
8104:
8105: if (@currxlists > 0) {
8106: foreach (@currxlists) {
8107: if (m/^([^:]+):(\w*)$/) {
8108: unless (grep/^$1$/,@{$allcourses}) {
8109: push @{$allcourses},$1;
8110: $$LC_code{$1} = $2;
8111: }
8112: }
8113: }
8114: }
8115:
8116: if (@currsections > 0) {
8117: foreach (@currsections) {
8118: if (m/^(\w+):(\w*)$/) {
8119: my $sec = $coursecode.$1;
8120: my $lc_sec = $2;
8121: unless (grep/^$sec$/,@{$allcourses}) {
8122: push @{$allcourses},$sec;
8123: $$LC_code{$sec} = $lc_sec;
8124: }
8125: }
8126: }
8127: }
8128: return;
8129: }
8130:
1.112 bowersj2 8131: =pod
8132:
1.780 raeburn 8133: =head1 Slot Helpers
8134:
8135: =over 4
8136:
8137: =item * sorted_slots()
8138:
8139: Sorts an array of slot names in order of slot start time (earliest first).
8140:
8141: Inputs:
8142:
8143: =over 4
8144:
8145: slotsarr - Reference to array of unsorted slot names.
8146:
8147: slots - Reference to hash of hash, where outer hash keys are slot names.
8148:
1.549 albertel 8149: =back
8150:
1.780 raeburn 8151: Returns:
8152:
8153: =over 4
8154:
8155: sorted - An array of slot names sorted by the start time of the slot.
8156:
8157: =back
8158:
8159: =back
8160:
8161: =cut
8162:
8163:
8164: sub sorted_slots {
8165: my ($slotsarr,$slots) = @_;
8166: my @sorted;
8167: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8168: @sorted =
8169: sort {
8170: if (ref($slots->{$a}) && ref($slots->{$b})) {
8171: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8172: }
8173: if (ref($slots->{$a})) { return -1;}
8174: if (ref($slots->{$b})) { return 1;}
8175: return 0;
8176: } @{$slotsarr};
8177: }
8178: return @sorted;
8179: }
8180:
8181:
8182: =pod
8183:
1.549 albertel 8184: =head1 HTTP Helpers
8185:
8186: =over 4
8187:
1.648 raeburn 8188: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8189:
1.258 albertel 8190: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8191: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8192: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8193:
8194: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8195: $possible_names is an ref to an array of form element names. As an example:
8196: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8197: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8198:
8199: =cut
1.1 albertel 8200:
1.6 albertel 8201: sub get_unprocessed_cgi {
1.25 albertel 8202: my ($query,$possible_names)= @_;
1.26 matthew 8203: # $Apache::lonxml::debug=1;
1.356 albertel 8204: foreach my $pair (split(/&/,$query)) {
8205: my ($name, $value) = split(/=/,$pair);
1.369 www 8206: $name = &unescape($name);
1.25 albertel 8207: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8208: $value =~ tr/+/ /;
8209: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8210: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8211: }
1.16 harris41 8212: }
1.6 albertel 8213: }
8214:
1.112 bowersj2 8215: =pod
8216:
1.648 raeburn 8217: =item * &cacheheader()
1.112 bowersj2 8218:
8219: returns cache-controlling header code
8220:
8221: =cut
8222:
1.7 albertel 8223: sub cacheheader {
1.258 albertel 8224: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8225: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8226: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8227: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8228: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8229: return $output;
1.7 albertel 8230: }
8231:
1.112 bowersj2 8232: =pod
8233:
1.648 raeburn 8234: =item * &no_cache($r)
1.112 bowersj2 8235:
8236: specifies header code to not have cache
8237:
8238: =cut
8239:
1.9 albertel 8240: sub no_cache {
1.216 albertel 8241: my ($r) = @_;
8242: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8243: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8244: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8245: $r->no_cache(1);
8246: $r->header_out("Expires" => $date);
8247: $r->header_out("Pragma" => "no-cache");
1.123 www 8248: }
8249:
8250: sub content_type {
1.181 albertel 8251: my ($r,$type,$charset) = @_;
1.299 foxr 8252: if ($r) {
8253: # Note that printout.pl calls this with undef for $r.
8254: &no_cache($r);
8255: }
1.258 albertel 8256: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8257: unless ($charset) {
8258: $charset=&Apache::lonlocal::current_encoding;
8259: }
8260: if ($charset) { $type.='; charset='.$charset; }
8261: if ($r) {
8262: $r->content_type($type);
8263: } else {
8264: print("Content-type: $type\n\n");
8265: }
1.9 albertel 8266: }
1.25 albertel 8267:
1.112 bowersj2 8268: =pod
8269:
1.648 raeburn 8270: =item * &add_to_env($name,$value)
1.112 bowersj2 8271:
1.258 albertel 8272: adds $name to the %env hash with value
1.112 bowersj2 8273: $value, if $name already exists, the entry is converted to an array
8274: reference and $value is added to the array.
8275:
8276: =cut
8277:
1.25 albertel 8278: sub add_to_env {
8279: my ($name,$value)=@_;
1.258 albertel 8280: if (defined($env{$name})) {
8281: if (ref($env{$name})) {
1.25 albertel 8282: #already have multiple values
1.258 albertel 8283: push(@{ $env{$name} },$value);
1.25 albertel 8284: } else {
8285: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8286: my $first=$env{$name};
8287: undef($env{$name});
8288: push(@{ $env{$name} },$first,$value);
1.25 albertel 8289: }
8290: } else {
1.258 albertel 8291: $env{$name}=$value;
1.25 albertel 8292: }
1.31 albertel 8293: }
1.149 albertel 8294:
8295: =pod
8296:
1.648 raeburn 8297: =item * &get_env_multiple($name)
1.149 albertel 8298:
1.258 albertel 8299: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8300: values may be defined and end up as an array ref.
8301:
8302: returns an array of values
8303:
8304: =cut
8305:
8306: sub get_env_multiple {
8307: my ($name) = @_;
8308: my @values;
1.258 albertel 8309: if (defined($env{$name})) {
1.149 albertel 8310: # exists is it an array
1.258 albertel 8311: if (ref($env{$name})) {
8312: @values=@{ $env{$name} };
1.149 albertel 8313: } else {
1.258 albertel 8314: $values[0]=$env{$name};
1.149 albertel 8315: }
8316: }
8317: return(@values);
8318: }
8319:
1.660 raeburn 8320: sub ask_for_embedded_content {
8321: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8322: my $upload_output = '
8323: <form name="upload_embedded" action="'.$actionurl.'"
8324: method="post" enctype="multipart/form-data">';
8325: $upload_output .= $state;
1.661 raeburn 8326: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8327:
8328: my $num = 0;
8329: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8330: $upload_output .= &start_data_table_row().
8331: '<td>'.$embed_file.'</td><td>';
8332: if ($args->{'ignore_remote_references'}
8333: && $embed_file =~ m{^\w+://}) {
8334: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8335: } elsif ($args->{'error_on_invalid_names'}
8336: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8337:
8338: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8339:
8340: } else {
8341: $upload_output .='
1.661 raeburn 8342: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8343: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8344: my $attrib = join(':',@{$$allfiles{$embed_file}});
8345: $upload_output .=
8346: "\n\t\t".
8347: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8348: $attrib.'" />';
8349: if (exists($$codebase{$embed_file})) {
8350: $upload_output .=
8351: "\n\t\t".
8352: '<input name="codebase_'.$num.'" type="hidden" value="'.
8353: &escape($$codebase{$embed_file}).'" />';
8354: }
8355: }
8356: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8357: $num++;
8358: }
8359: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8360: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8361: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8362: '.&mt('(only files for which a location has been provided will be uploaded)').'
8363: </form>';
8364: return $upload_output;
8365: }
8366:
1.661 raeburn 8367: sub upload_embedded {
8368: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8369: $current_disk_usage) = @_;
8370: my $output;
8371: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8372: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8373: my $orig_uploaded_filename =
8374: $env{'form.embedded_item_'.$i.'.filename'};
8375:
8376: $env{'form.embedded_orig_'.$i} =
8377: &unescape($env{'form.embedded_orig_'.$i});
8378: my ($path,$fname) =
8379: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8380: # no path, whole string is fname
8381: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8382:
8383: $path = $env{'form.currentpath'}.$path;
8384: $fname = &Apache::lonnet::clean_filename($fname);
8385: # See if there is anything left
8386: next if ($fname eq '');
8387:
8388: # Check if file already exists as a file or directory.
8389: my ($state,$msg);
8390: if ($context eq 'portfolio') {
8391: my $port_path = $dirpath;
8392: if ($group ne '') {
8393: $port_path = "groups/$group/$port_path";
8394: }
8395: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8396: $dir_root,$port_path,$disk_quota,
8397: $current_disk_usage,$uname,$udom);
8398: if ($state eq 'will_exceed_quota'
8399: || $state eq 'file_locked'
8400: || $state eq 'file_exists' ) {
8401: $output .= $msg;
8402: next;
8403: }
8404: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8405: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8406: if ($state eq 'exists') {
8407: $output .= $msg;
8408: next;
8409: }
8410: }
8411: # Check if extension is valid
8412: if (($fname =~ /\.(\w+)$/) &&
8413: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8414: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8415: next;
8416: } elsif (($fname =~ /\.(\w+)$/) &&
8417: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8418: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8419: next;
8420: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8421: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8422: next;
8423: }
8424:
8425: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8426: if ($context eq 'portfolio') {
8427: my $result=
8428: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8429: $dirpath.$path);
8430: if ($result !~ m|^/uploaded/|) {
8431: $output .= '<span class="LC_error">'
8432: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8433: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8434: .'</span><br />';
8435: next;
8436: } else {
8437: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8438: $path.$fname.'</span>').'</p>';
8439: }
8440: } else {
8441: # Save the file
8442: my $target = $env{'form.embedded_item_'.$i};
8443: my $fullpath = $dir_root.$dirpath.'/'.$path;
8444: my $dest = $fullpath.$fname;
8445: my $url = $url_root.$dirpath.'/'.$path.$fname;
8446: my @parts=split(/\//,$fullpath);
8447: my $count;
8448: my $filepath = $dir_root;
8449: for ($count=4;$count<=$#parts;$count++) {
8450: $filepath .= "/$parts[$count]";
8451: if ((-e $filepath)!=1) {
8452: mkdir($filepath,0770);
8453: }
8454: }
8455: my $fh;
8456: if (!open($fh,'>'.$dest)) {
8457: &Apache::lonnet::logthis('Failed to create '.$dest);
8458: $output .= '<span class="LC_error">'.
8459: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8460: '</span><br />';
8461: } else {
8462: if (!print $fh $env{'form.embedded_item_'.$i}) {
8463: &Apache::lonnet::logthis('Failed to write to '.$dest);
8464: $output .= '<span class="LC_error">'.
8465: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8466: '</span><br />';
8467: } else {
8468: if ($context eq 'testbank') {
8469: $output .= &mt('Embedded file uploaded successfully:').
8470: ' <a href="'.$url.'">'.
8471: $orig_uploaded_filename.'</a><br />';
8472: } else {
1.705 tempelho 8473: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8474: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8475: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8476: }
8477: }
8478: close($fh);
8479: }
8480: }
8481: }
8482: return $output;
8483: }
8484:
8485: sub check_for_existing {
8486: my ($path,$fname,$element) = @_;
8487: my ($state,$msg);
8488: if (-d $path.'/'.$fname) {
8489: $state = 'exists';
8490: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8491: } elsif (-e $path.'/'.$fname) {
8492: $state = 'exists';
8493: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8494: }
8495: if ($state eq 'exists') {
8496: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8497: }
8498: return ($state,$msg);
8499: }
8500:
8501: sub check_for_upload {
8502: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8503: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8504: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8505: my $getpropath = 1;
8506: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8507: $getpropath);
8508: my $found_file = 0;
8509: my $locked_file = 0;
8510: foreach my $line (@dir_list) {
8511: my ($file_name)=split(/\&/,$line,2);
8512: if ($file_name eq $fname){
8513: $file_name = $path.$file_name;
8514: if ($group ne '') {
8515: $file_name = $group.$file_name;
8516: }
8517: $found_file = 1;
8518: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8519: $locked_file = 1;
8520: }
8521: }
8522: }
8523: if (($current_disk_usage + $filesize) > $disk_quota){
8524: my $msg = '<span class="LC_error">'.
8525: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8526: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8527: return ('will_exceed_quota',$msg);
8528: } elsif ($found_file) {
8529: if ($locked_file) {
8530: my $msg = '<span class="LC_error">';
8531: $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>');
8532: $msg .= '</span><br />';
8533: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8534: return ('file_locked',$msg);
8535: } else {
8536: my $msg = '<span class="LC_error">';
8537: $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
8538: $msg .= '</span>';
8539: $msg .= '<br />';
8540: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8541: return ('file_exists',$msg);
8542: }
8543: }
8544: }
8545:
1.31 albertel 8546:
1.41 ng 8547: =pod
1.45 matthew 8548:
1.464 albertel 8549: =back
1.41 ng 8550:
1.112 bowersj2 8551: =head1 CSV Upload/Handling functions
1.38 albertel 8552:
1.41 ng 8553: =over 4
8554:
1.648 raeburn 8555: =item * &upfile_store($r)
1.41 ng 8556:
8557: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8558: needs $env{'form.upfile'}
1.41 ng 8559: returns $datatoken to be put into hidden field
8560:
8561: =cut
1.31 albertel 8562:
8563: sub upfile_store {
8564: my $r=shift;
1.258 albertel 8565: $env{'form.upfile'}=~s/\r/\n/gs;
8566: $env{'form.upfile'}=~s/\f/\n/gs;
8567: $env{'form.upfile'}=~s/\n+/\n/gs;
8568: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8569:
1.258 albertel 8570: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8571: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8572: {
1.158 raeburn 8573: my $datafile = $r->dir_config('lonDaemons').
8574: '/tmp/'.$datatoken.'.tmp';
8575: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8576: print $fh $env{'form.upfile'};
1.158 raeburn 8577: close($fh);
8578: }
1.31 albertel 8579: }
8580: return $datatoken;
8581: }
8582:
1.56 matthew 8583: =pod
8584:
1.648 raeburn 8585: =item * &load_tmp_file($r)
1.41 ng 8586:
8587: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8588: needs $env{'form.datatoken'},
8589: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8590:
8591: =cut
1.31 albertel 8592:
8593: sub load_tmp_file {
8594: my $r=shift;
8595: my @studentdata=();
8596: {
1.158 raeburn 8597: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8598: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8599: if ( open(my $fh,"<$studentfile") ) {
8600: @studentdata=<$fh>;
8601: close($fh);
8602: }
1.31 albertel 8603: }
1.258 albertel 8604: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8605: }
8606:
1.56 matthew 8607: =pod
8608:
1.648 raeburn 8609: =item * &upfile_record_sep()
1.41 ng 8610:
8611: Separate uploaded file into records
8612: returns array of records,
1.258 albertel 8613: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8614:
8615: =cut
1.31 albertel 8616:
8617: sub upfile_record_sep {
1.258 albertel 8618: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8619: } else {
1.248 albertel 8620: my @records;
1.258 albertel 8621: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8622: if ($line=~/^\s*$/) { next; }
8623: push(@records,$line);
8624: }
8625: return @records;
1.31 albertel 8626: }
8627: }
8628:
1.56 matthew 8629: =pod
8630:
1.648 raeburn 8631: =item * &record_sep($record)
1.41 ng 8632:
1.258 albertel 8633: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8634:
8635: =cut
8636:
1.263 www 8637: sub takeleft {
8638: my $index=shift;
8639: return substr('0000'.$index,-4,4);
8640: }
8641:
1.31 albertel 8642: sub record_sep {
8643: my $record=shift;
8644: my %components=();
1.258 albertel 8645: if ($env{'form.upfiletype'} eq 'xml') {
8646: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8647: my $i=0;
1.356 albertel 8648: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8649: $field=~s/^(\"|\')//;
8650: $field=~s/(\"|\')$//;
1.263 www 8651: $components{&takeleft($i)}=$field;
1.31 albertel 8652: $i++;
8653: }
1.258 albertel 8654: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8655: my $i=0;
1.356 albertel 8656: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8657: $field=~s/^(\"|\')//;
8658: $field=~s/(\"|\')$//;
1.263 www 8659: $components{&takeleft($i)}=$field;
1.31 albertel 8660: $i++;
8661: }
8662: } else {
1.561 www 8663: my $separator=',';
1.480 banghart 8664: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8665: $separator=';';
1.480 banghart 8666: }
1.31 albertel 8667: my $i=0;
1.561 www 8668: # the character we are looking for to indicate the end of a quote or a record
8669: my $looking_for=$separator;
8670: # do not add the characters to the fields
8671: my $ignore=0;
8672: # we just encountered a separator (or the beginning of the record)
8673: my $just_found_separator=1;
8674: # store the field we are working on here
8675: my $field='';
8676: # work our way through all characters in record
8677: foreach my $character ($record=~/(.)/g) {
8678: if ($character eq $looking_for) {
8679: if ($character ne $separator) {
8680: # Found the end of a quote, again looking for separator
8681: $looking_for=$separator;
8682: $ignore=1;
8683: } else {
8684: # Found a separator, store away what we got
8685: $components{&takeleft($i)}=$field;
8686: $i++;
8687: $just_found_separator=1;
8688: $ignore=0;
8689: $field='';
8690: }
8691: next;
8692: }
8693: # single or double quotation marks after a separator indicate beginning of a quote
8694: # we are now looking for the end of the quote and need to ignore separators
8695: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8696: $looking_for=$character;
8697: next;
8698: }
8699: # ignore would be true after we reached the end of a quote
8700: if ($ignore) { next; }
8701: if (($just_found_separator) && ($character=~/\s/)) { next; }
8702: $field.=$character;
8703: $just_found_separator=0;
1.31 albertel 8704: }
1.561 www 8705: # catch the very last entry, since we never encountered the separator
8706: $components{&takeleft($i)}=$field;
1.31 albertel 8707: }
8708: return %components;
8709: }
8710:
1.144 matthew 8711: ######################################################
8712: ######################################################
8713:
1.56 matthew 8714: =pod
8715:
1.648 raeburn 8716: =item * &upfile_select_html()
1.41 ng 8717:
1.144 matthew 8718: Return HTML code to select a file from the users machine and specify
8719: the file type.
1.41 ng 8720:
8721: =cut
8722:
1.144 matthew 8723: ######################################################
8724: ######################################################
1.31 albertel 8725: sub upfile_select_html {
1.144 matthew 8726: my %Types = (
8727: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8728: semisv => &mt('Semicolon separated values'),
1.144 matthew 8729: space => &mt('Space separated'),
8730: tab => &mt('Tabulator separated'),
8731: # xml => &mt('HTML/XML'),
8732: );
8733: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8734: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8735: foreach my $type (sort(keys(%Types))) {
8736: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8737: }
8738: $Str .= "</select>\n";
8739: return $Str;
1.31 albertel 8740: }
8741:
1.301 albertel 8742: sub get_samples {
8743: my ($records,$toget) = @_;
8744: my @samples=({});
8745: my $got=0;
8746: foreach my $rec (@$records) {
8747: my %temp = &record_sep($rec);
8748: if (! grep(/\S/, values(%temp))) { next; }
8749: if (%temp) {
8750: $samples[$got]=\%temp;
8751: $got++;
8752: if ($got == $toget) { last; }
8753: }
8754: }
8755: return \@samples;
8756: }
8757:
1.144 matthew 8758: ######################################################
8759: ######################################################
8760:
1.56 matthew 8761: =pod
8762:
1.648 raeburn 8763: =item * &csv_print_samples($r,$records)
1.41 ng 8764:
8765: Prints a table of sample values from each column uploaded $r is an
8766: Apache Request ref, $records is an arrayref from
8767: &Apache::loncommon::upfile_record_sep
8768:
8769: =cut
8770:
1.144 matthew 8771: ######################################################
8772: ######################################################
1.31 albertel 8773: sub csv_print_samples {
8774: my ($r,$records) = @_;
1.662 bisitz 8775: my $samples = &get_samples($records,5);
1.301 albertel 8776:
1.594 raeburn 8777: $r->print(&mt('Samples').'<br />'.&start_data_table().
8778: &start_data_table_header_row());
1.356 albertel 8779: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8780: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8781: $r->print(&end_data_table_header_row());
1.301 albertel 8782: foreach my $hash (@$samples) {
1.594 raeburn 8783: $r->print(&start_data_table_row());
1.356 albertel 8784: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8785: $r->print('<td>');
1.356 albertel 8786: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8787: $r->print('</td>');
8788: }
1.594 raeburn 8789: $r->print(&end_data_table_row());
1.31 albertel 8790: }
1.594 raeburn 8791: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8792: }
8793:
1.144 matthew 8794: ######################################################
8795: ######################################################
8796:
1.56 matthew 8797: =pod
8798:
1.648 raeburn 8799: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8800:
8801: Prints a table to create associations between values and table columns.
1.144 matthew 8802:
1.41 ng 8803: $r is an Apache Request ref,
8804: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8805: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8806:
8807: =cut
8808:
1.144 matthew 8809: ######################################################
8810: ######################################################
1.31 albertel 8811: sub csv_print_select_table {
8812: my ($r,$records,$d) = @_;
1.301 albertel 8813: my $i=0;
8814: my $samples = &get_samples($records,1);
1.144 matthew 8815: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8816: &start_data_table().&start_data_table_header_row().
1.144 matthew 8817: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8818: '<th>'.&mt('Column').'</th>'.
8819: &end_data_table_header_row()."\n");
1.356 albertel 8820: foreach my $array_ref (@$d) {
8821: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8822: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8823:
1.875 bisitz 8824: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8825: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8826: $r->print('<option value="none"></option>');
1.356 albertel 8827: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8828: $r->print('<option value="'.$sample.'"'.
8829: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8830: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8831: }
1.594 raeburn 8832: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8833: $i++;
8834: }
1.594 raeburn 8835: $r->print(&end_data_table());
1.31 albertel 8836: $i--;
8837: return $i;
8838: }
1.56 matthew 8839:
1.144 matthew 8840: ######################################################
8841: ######################################################
8842:
1.56 matthew 8843: =pod
1.31 albertel 8844:
1.648 raeburn 8845: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8846:
8847: Prints a table of sample values from the upload and can make associate samples to internal names.
8848:
8849: $r is an Apache Request ref,
8850: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8851: $d is an array of 2 element arrays (internal name, displayed name)
8852:
8853: =cut
8854:
1.144 matthew 8855: ######################################################
8856: ######################################################
1.31 albertel 8857: sub csv_samples_select_table {
8858: my ($r,$records,$d) = @_;
8859: my $i=0;
1.144 matthew 8860: #
1.662 bisitz 8861: my $max_samples = 5;
8862: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8863: $r->print(&start_data_table().
8864: &start_data_table_header_row().'<th>'.
8865: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8866: &end_data_table_header_row());
1.301 albertel 8867:
8868: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8869: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8870: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8871: foreach my $option (@$d) {
8872: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8873: $r->print('<option value="'.$value.'"'.
1.253 albertel 8874: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8875: $display.'</option>');
1.31 albertel 8876: }
8877: $r->print('</select></td><td>');
1.662 bisitz 8878: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8879: if (defined($samples->[$line]{$key})) {
8880: $r->print($samples->[$line]{$key}."<br />\n");
8881: }
8882: }
1.594 raeburn 8883: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8884: $i++;
8885: }
1.594 raeburn 8886: $r->print(&end_data_table());
1.31 albertel 8887: $i--;
8888: return($i);
1.115 matthew 8889: }
8890:
1.144 matthew 8891: ######################################################
8892: ######################################################
8893:
1.115 matthew 8894: =pod
8895:
1.648 raeburn 8896: =item * &clean_excel_name($name)
1.115 matthew 8897:
8898: Returns a replacement for $name which does not contain any illegal characters.
8899:
8900: =cut
8901:
1.144 matthew 8902: ######################################################
8903: ######################################################
1.115 matthew 8904: sub clean_excel_name {
8905: my ($name) = @_;
8906: $name =~ s/[:\*\?\/\\]//g;
8907: if (length($name) > 31) {
8908: $name = substr($name,0,31);
8909: }
8910: return $name;
1.25 albertel 8911: }
1.84 albertel 8912:
1.85 albertel 8913: =pod
8914:
1.648 raeburn 8915: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8916:
8917: Returns either 1 or undef
8918:
8919: 1 if the part is to be hidden, undef if it is to be shown
8920:
8921: Arguments are:
8922:
8923: $id the id of the part to be checked
8924: $symb, optional the symb of the resource to check
8925: $udom, optional the domain of the user to check for
8926: $uname, optional the username of the user to check for
8927:
8928: =cut
1.84 albertel 8929:
8930: sub check_if_partid_hidden {
8931: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8932: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8933: $symb,$udom,$uname);
1.141 albertel 8934: my $truth=1;
8935: #if the string starts with !, then the list is the list to show not hide
8936: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8937: my @hiddenlist=split(/,/,$hiddenparts);
8938: foreach my $checkid (@hiddenlist) {
1.141 albertel 8939: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8940: }
1.141 albertel 8941: return !$truth;
1.84 albertel 8942: }
1.127 matthew 8943:
1.138 matthew 8944:
8945: ############################################################
8946: ############################################################
8947:
8948: =pod
8949:
1.157 matthew 8950: =back
8951:
1.138 matthew 8952: =head1 cgi-bin script and graphing routines
8953:
1.157 matthew 8954: =over 4
8955:
1.648 raeburn 8956: =item * &get_cgi_id()
1.138 matthew 8957:
8958: Inputs: none
8959:
8960: Returns an id which can be used to pass environment variables
8961: to various cgi-bin scripts. These environment variables will
8962: be removed from the users environment after a given time by
8963: the routine &Apache::lonnet::transfer_profile_to_env.
8964:
8965: =cut
8966:
8967: ############################################################
8968: ############################################################
1.152 albertel 8969: my $uniq=0;
1.136 matthew 8970: sub get_cgi_id {
1.154 albertel 8971: $uniq=($uniq+1)%100000;
1.280 albertel 8972: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8973: }
8974:
1.127 matthew 8975: ############################################################
8976: ############################################################
8977:
8978: =pod
8979:
1.648 raeburn 8980: =item * &DrawBarGraph()
1.127 matthew 8981:
1.138 matthew 8982: Facilitates the plotting of data in a (stacked) bar graph.
8983: Puts plot definition data into the users environment in order for
8984: graph.png to plot it. Returns an <img> tag for the plot.
8985: The bars on the plot are labeled '1','2',...,'n'.
8986:
8987: Inputs:
8988:
8989: =over 4
8990:
8991: =item $Title: string, the title of the plot
8992:
8993: =item $xlabel: string, text describing the X-axis of the plot
8994:
8995: =item $ylabel: string, text describing the Y-axis of the plot
8996:
8997: =item $Max: scalar, the maximum Y value to use in the plot
8998: If $Max is < any data point, the graph will not be rendered.
8999:
1.140 matthew 9000: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9001: they are plotted. If undefined, default values will be used.
9002:
1.178 matthew 9003: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9004:
1.138 matthew 9005: =item @Values: An array of array references. Each array reference holds data
9006: to be plotted in a stacked bar chart.
9007:
1.239 matthew 9008: =item If the final element of @Values is a hash reference the key/value
9009: pairs will be added to the graph definition.
9010:
1.138 matthew 9011: =back
9012:
9013: Returns:
9014:
9015: An <img> tag which references graph.png and the appropriate identifying
9016: information for the plot.
9017:
1.127 matthew 9018: =cut
9019:
9020: ############################################################
9021: ############################################################
1.134 matthew 9022: sub DrawBarGraph {
1.178 matthew 9023: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9024: #
9025: if (! defined($colors)) {
9026: $colors = ['#33ff00',
9027: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9028: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9029: ];
9030: }
1.228 matthew 9031: my $extra_settings = {};
9032: if (ref($Values[-1]) eq 'HASH') {
9033: $extra_settings = pop(@Values);
9034: }
1.127 matthew 9035: #
1.136 matthew 9036: my $identifier = &get_cgi_id();
9037: my $id = 'cgi.'.$identifier;
1.129 matthew 9038: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9039: return '';
9040: }
1.225 matthew 9041: #
9042: my @Labels;
9043: if (defined($labels)) {
9044: @Labels = @$labels;
9045: } else {
9046: for (my $i=0;$i<@{$Values[0]};$i++) {
9047: push (@Labels,$i+1);
9048: }
9049: }
9050: #
1.129 matthew 9051: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9052: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9053: my %ValuesHash;
9054: my $NumSets=1;
9055: foreach my $array (@Values) {
9056: next if (! ref($array));
1.136 matthew 9057: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9058: join(',',@$array);
1.129 matthew 9059: }
1.127 matthew 9060: #
1.136 matthew 9061: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9062: if ($NumBars < 3) {
9063: $width = 120+$NumBars*32;
1.220 matthew 9064: $xskip = 1;
1.225 matthew 9065: $bar_width = 30;
9066: } elsif ($NumBars < 5) {
9067: $width = 120+$NumBars*20;
9068: $xskip = 1;
9069: $bar_width = 20;
1.220 matthew 9070: } elsif ($NumBars < 10) {
1.136 matthew 9071: $width = 120+$NumBars*15;
9072: $xskip = 1;
9073: $bar_width = 15;
9074: } elsif ($NumBars <= 25) {
9075: $width = 120+$NumBars*11;
9076: $xskip = 5;
9077: $bar_width = 8;
9078: } elsif ($NumBars <= 50) {
9079: $width = 120+$NumBars*8;
9080: $xskip = 5;
9081: $bar_width = 4;
9082: } else {
9083: $width = 120+$NumBars*8;
9084: $xskip = 5;
9085: $bar_width = 4;
9086: }
9087: #
1.137 matthew 9088: $Max = 1 if ($Max < 1);
9089: if ( int($Max) < $Max ) {
9090: $Max++;
9091: $Max = int($Max);
9092: }
1.127 matthew 9093: $Title = '' if (! defined($Title));
9094: $xlabel = '' if (! defined($xlabel));
9095: $ylabel = '' if (! defined($ylabel));
1.369 www 9096: $ValuesHash{$id.'.title'} = &escape($Title);
9097: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9098: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9099: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9100: $ValuesHash{$id.'.NumBars'} = $NumBars;
9101: $ValuesHash{$id.'.NumSets'} = $NumSets;
9102: $ValuesHash{$id.'.PlotType'} = 'bar';
9103: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9104: $ValuesHash{$id.'.height'} = $height;
9105: $ValuesHash{$id.'.width'} = $width;
9106: $ValuesHash{$id.'.xskip'} = $xskip;
9107: $ValuesHash{$id.'.bar_width'} = $bar_width;
9108: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9109: #
1.228 matthew 9110: # Deal with other parameters
9111: while (my ($key,$value) = each(%$extra_settings)) {
9112: $ValuesHash{$id.'.'.$key} = $value;
9113: }
9114: #
1.646 raeburn 9115: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9116: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9117: }
9118:
9119: ############################################################
9120: ############################################################
9121:
9122: =pod
9123:
1.648 raeburn 9124: =item * &DrawXYGraph()
1.137 matthew 9125:
1.138 matthew 9126: Facilitates the plotting of data in an XY graph.
9127: Puts plot definition data into the users environment in order for
9128: graph.png to plot it. Returns an <img> tag for the plot.
9129:
9130: Inputs:
9131:
9132: =over 4
9133:
9134: =item $Title: string, the title of the plot
9135:
9136: =item $xlabel: string, text describing the X-axis of the plot
9137:
9138: =item $ylabel: string, text describing the Y-axis of the plot
9139:
9140: =item $Max: scalar, the maximum Y value to use in the plot
9141: If $Max is < any data point, the graph will not be rendered.
9142:
9143: =item $colors: Array ref containing the hex color codes for the data to be
9144: plotted in. If undefined, default values will be used.
9145:
9146: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9147:
9148: =item $Ydata: Array ref containing Array refs.
1.185 www 9149: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9150:
9151: =item %Values: hash indicating or overriding any default values which are
9152: passed to graph.png.
9153: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9154:
9155: =back
9156:
9157: Returns:
9158:
9159: An <img> tag which references graph.png and the appropriate identifying
9160: information for the plot.
9161:
1.137 matthew 9162: =cut
9163:
9164: ############################################################
9165: ############################################################
9166: sub DrawXYGraph {
9167: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9168: #
9169: # Create the identifier for the graph
9170: my $identifier = &get_cgi_id();
9171: my $id = 'cgi.'.$identifier;
9172: #
9173: $Title = '' if (! defined($Title));
9174: $xlabel = '' if (! defined($xlabel));
9175: $ylabel = '' if (! defined($ylabel));
9176: my %ValuesHash =
9177: (
1.369 www 9178: $id.'.title' => &escape($Title),
9179: $id.'.xlabel' => &escape($xlabel),
9180: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9181: $id.'.y_max_value'=> $Max,
9182: $id.'.labels' => join(',',@$Xlabels),
9183: $id.'.PlotType' => 'XY',
9184: );
9185: #
9186: if (defined($colors) && ref($colors) eq 'ARRAY') {
9187: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9188: }
9189: #
9190: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9191: return '';
9192: }
9193: my $NumSets=1;
1.138 matthew 9194: foreach my $array (@{$Ydata}){
1.137 matthew 9195: next if (! ref($array));
9196: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9197: }
1.138 matthew 9198: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9199: #
9200: # Deal with other parameters
9201: while (my ($key,$value) = each(%Values)) {
9202: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9203: }
9204: #
1.646 raeburn 9205: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9206: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9207: }
9208:
9209: ############################################################
9210: ############################################################
9211:
9212: =pod
9213:
1.648 raeburn 9214: =item * &DrawXYYGraph()
1.138 matthew 9215:
9216: Facilitates the plotting of data in an XY graph with two Y axes.
9217: Puts plot definition data into the users environment in order for
9218: graph.png to plot it. Returns an <img> tag for the plot.
9219:
9220: Inputs:
9221:
9222: =over 4
9223:
9224: =item $Title: string, the title of the plot
9225:
9226: =item $xlabel: string, text describing the X-axis of the plot
9227:
9228: =item $ylabel: string, text describing the Y-axis of the plot
9229:
9230: =item $colors: Array ref containing the hex color codes for the data to be
9231: plotted in. If undefined, default values will be used.
9232:
9233: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9234:
9235: =item $Ydata1: The first data set
9236:
9237: =item $Min1: The minimum value of the left Y-axis
9238:
9239: =item $Max1: The maximum value of the left Y-axis
9240:
9241: =item $Ydata2: The second data set
9242:
9243: =item $Min2: The minimum value of the right Y-axis
9244:
9245: =item $Max2: The maximum value of the left Y-axis
9246:
9247: =item %Values: hash indicating or overriding any default values which are
9248: passed to graph.png.
9249: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9250:
9251: =back
9252:
9253: Returns:
9254:
9255: An <img> tag which references graph.png and the appropriate identifying
9256: information for the plot.
1.136 matthew 9257:
9258: =cut
9259:
9260: ############################################################
9261: ############################################################
1.137 matthew 9262: sub DrawXYYGraph {
9263: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9264: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9265: #
9266: # Create the identifier for the graph
9267: my $identifier = &get_cgi_id();
9268: my $id = 'cgi.'.$identifier;
9269: #
9270: $Title = '' if (! defined($Title));
9271: $xlabel = '' if (! defined($xlabel));
9272: $ylabel = '' if (! defined($ylabel));
9273: my %ValuesHash =
9274: (
1.369 www 9275: $id.'.title' => &escape($Title),
9276: $id.'.xlabel' => &escape($xlabel),
9277: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9278: $id.'.labels' => join(',',@$Xlabels),
9279: $id.'.PlotType' => 'XY',
9280: $id.'.NumSets' => 2,
1.137 matthew 9281: $id.'.two_axes' => 1,
9282: $id.'.y1_max_value' => $Max1,
9283: $id.'.y1_min_value' => $Min1,
9284: $id.'.y2_max_value' => $Max2,
9285: $id.'.y2_min_value' => $Min2,
1.136 matthew 9286: );
9287: #
1.137 matthew 9288: if (defined($colors) && ref($colors) eq 'ARRAY') {
9289: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9290: }
9291: #
9292: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9293: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9294: return '';
9295: }
9296: my $NumSets=1;
1.137 matthew 9297: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9298: next if (! ref($array));
9299: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9300: }
9301: #
9302: # Deal with other parameters
9303: while (my ($key,$value) = each(%Values)) {
9304: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9305: }
9306: #
1.646 raeburn 9307: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9308: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9309: }
9310:
9311: ############################################################
9312: ############################################################
9313:
9314: =pod
9315:
1.157 matthew 9316: =back
9317:
1.139 matthew 9318: =head1 Statistics helper routines?
9319:
9320: Bad place for them but what the hell.
9321:
1.157 matthew 9322: =over 4
9323:
1.648 raeburn 9324: =item * &chartlink()
1.139 matthew 9325:
9326: Returns a link to the chart for a specific student.
9327:
9328: Inputs:
9329:
9330: =over 4
9331:
9332: =item $linktext: The text of the link
9333:
9334: =item $sname: The students username
9335:
9336: =item $sdomain: The students domain
9337:
9338: =back
9339:
1.157 matthew 9340: =back
9341:
1.139 matthew 9342: =cut
9343:
9344: ############################################################
9345: ############################################################
9346: sub chartlink {
9347: my ($linktext, $sname, $sdomain) = @_;
9348: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9349: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9350: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9351: '">'.$linktext.'</a>';
1.153 matthew 9352: }
9353:
9354: #######################################################
9355: #######################################################
9356:
9357: =pod
9358:
9359: =head1 Course Environment Routines
1.157 matthew 9360:
9361: =over 4
1.153 matthew 9362:
1.648 raeburn 9363: =item * &restore_course_settings()
1.153 matthew 9364:
1.648 raeburn 9365: =item * &store_course_settings()
1.153 matthew 9366:
9367: Restores/Store indicated form parameters from the course environment.
9368: Will not overwrite existing values of the form parameters.
9369:
9370: Inputs:
9371: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9372:
9373: a hash ref describing the data to be stored. For example:
9374:
9375: %Save_Parameters = ('Status' => 'scalar',
9376: 'chartoutputmode' => 'scalar',
9377: 'chartoutputdata' => 'scalar',
9378: 'Section' => 'array',
1.373 raeburn 9379: 'Group' => 'array',
1.153 matthew 9380: 'StudentData' => 'array',
9381: 'Maps' => 'array');
9382:
9383: Returns: both routines return nothing
9384:
1.631 raeburn 9385: =back
9386:
1.153 matthew 9387: =cut
9388:
9389: #######################################################
9390: #######################################################
9391: sub store_course_settings {
1.496 albertel 9392: return &store_settings($env{'request.course.id'},@_);
9393: }
9394:
9395: sub store_settings {
1.153 matthew 9396: # save to the environment
9397: # appenv the same items, just to be safe
1.300 albertel 9398: my $udom = $env{'user.domain'};
9399: my $uname = $env{'user.name'};
1.496 albertel 9400: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9401: my %SaveHash;
9402: my %AppHash;
9403: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9404: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9405: my $envname = 'environment.'.$basename;
1.258 albertel 9406: if (exists($env{'form.'.$setting})) {
1.153 matthew 9407: # Save this value away
9408: if ($type eq 'scalar' &&
1.258 albertel 9409: (! exists($env{$envname}) ||
9410: $env{$envname} ne $env{'form.'.$setting})) {
9411: $SaveHash{$basename} = $env{'form.'.$setting};
9412: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9413: } elsif ($type eq 'array') {
9414: my $stored_form;
1.258 albertel 9415: if (ref($env{'form.'.$setting})) {
1.153 matthew 9416: $stored_form = join(',',
9417: map {
1.369 www 9418: &escape($_);
1.258 albertel 9419: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9420: } else {
9421: $stored_form =
1.369 www 9422: &escape($env{'form.'.$setting});
1.153 matthew 9423: }
9424: # Determine if the array contents are the same.
1.258 albertel 9425: if ($stored_form ne $env{$envname}) {
1.153 matthew 9426: $SaveHash{$basename} = $stored_form;
9427: $AppHash{$envname} = $stored_form;
9428: }
9429: }
9430: }
9431: }
9432: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9433: $udom,$uname);
1.153 matthew 9434: if ($put_result !~ /^(ok|delayed)/) {
9435: &Apache::lonnet::logthis('unable to save form parameters, '.
9436: 'got error:'.$put_result);
9437: }
9438: # Make sure these settings stick around in this session, too
1.646 raeburn 9439: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9440: return;
9441: }
9442:
9443: sub restore_course_settings {
1.499 albertel 9444: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9445: }
9446:
9447: sub restore_settings {
9448: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9449: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9450: next if (exists($env{'form.'.$setting}));
1.496 albertel 9451: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9452: '.'.$setting;
1.258 albertel 9453: if (exists($env{$envname})) {
1.153 matthew 9454: if ($type eq 'scalar') {
1.258 albertel 9455: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9456: } elsif ($type eq 'array') {
1.258 albertel 9457: $env{'form.'.$setting} = [
1.153 matthew 9458: map {
1.369 www 9459: &unescape($_);
1.258 albertel 9460: } split(',',$env{$envname})
1.153 matthew 9461: ];
9462: }
9463: }
9464: }
1.127 matthew 9465: }
9466:
1.618 raeburn 9467: #######################################################
9468: #######################################################
9469:
9470: =pod
9471:
9472: =head1 Domain E-mail Routines
9473:
9474: =over 4
9475:
1.648 raeburn 9476: =item * &build_recipient_list()
1.618 raeburn 9477:
1.884 raeburn 9478: Build recipient lists for five types of e-mail:
1.766 raeburn 9479: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9480: (d) Help requests, (e) Course requests needing approval, generated by
9481: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9482: loncoursequeueadmin.pm respectively.
1.618 raeburn 9483:
9484: Inputs:
1.619 raeburn 9485: defmail (scalar - email address of default recipient),
1.618 raeburn 9486: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9487: defdom (domain for which to retrieve configuration settings),
9488: origmail (scalar - email address of recipient from loncapa.conf,
9489: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9490:
1.655 raeburn 9491: Returns: comma separated list of addresses to which to send e-mail.
9492:
9493: =back
1.618 raeburn 9494:
9495: =cut
9496:
9497: ############################################################
9498: ############################################################
9499: sub build_recipient_list {
1.619 raeburn 9500: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9501: my @recipients;
9502: my $otheremails;
9503: my %domconfig =
9504: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9505: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9506: if (exists($domconfig{'contacts'}{$mailing})) {
9507: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9508: my @contacts = ('adminemail','supportemail');
9509: foreach my $item (@contacts) {
9510: if ($domconfig{'contacts'}{$mailing}{$item}) {
9511: my $addr = $domconfig{'contacts'}{$item};
9512: if (!grep(/^\Q$addr\E$/,@recipients)) {
9513: push(@recipients,$addr);
9514: }
1.619 raeburn 9515: }
1.766 raeburn 9516: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9517: }
9518: }
1.766 raeburn 9519: } elsif ($origmail ne '') {
9520: push(@recipients,$origmail);
1.618 raeburn 9521: }
1.619 raeburn 9522: } elsif ($origmail ne '') {
9523: push(@recipients,$origmail);
1.618 raeburn 9524: }
1.688 raeburn 9525: if (defined($defmail)) {
9526: if ($defmail ne '') {
9527: push(@recipients,$defmail);
9528: }
1.618 raeburn 9529: }
9530: if ($otheremails) {
1.619 raeburn 9531: my @others;
9532: if ($otheremails =~ /,/) {
9533: @others = split(/,/,$otheremails);
1.618 raeburn 9534: } else {
1.619 raeburn 9535: push(@others,$otheremails);
9536: }
9537: foreach my $addr (@others) {
9538: if (!grep(/^\Q$addr\E$/,@recipients)) {
9539: push(@recipients,$addr);
9540: }
1.618 raeburn 9541: }
9542: }
1.619 raeburn 9543: my $recipientlist = join(',',@recipients);
1.618 raeburn 9544: return $recipientlist;
9545: }
9546:
1.127 matthew 9547: ############################################################
9548: ############################################################
1.154 albertel 9549:
1.655 raeburn 9550: =pod
9551:
9552: =head1 Course Catalog Routines
9553:
9554: =over 4
9555:
9556: =item * &gather_categories()
9557:
9558: Converts category definitions - keys of categories hash stored in
9559: coursecategories in configuration.db on the primary library server in a
9560: domain - to an array. Also generates javascript and idx hash used to
9561: generate Domain Coordinator interface for editing Course Categories.
9562:
9563: Inputs:
1.663 raeburn 9564:
1.655 raeburn 9565: categories (reference to hash of category definitions).
1.663 raeburn 9566:
1.655 raeburn 9567: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9568: categories and subcategories).
1.663 raeburn 9569:
1.655 raeburn 9570: idx (reference to hash of counters used in Domain Coordinator interface for
9571: editing Course Categories).
1.663 raeburn 9572:
1.655 raeburn 9573: jsarray (reference to array of categories used to create Javascript arrays for
9574: Domain Coordinator interface for editing Course Categories).
9575:
9576: Returns: nothing
9577:
9578: Side effects: populates cats, idx and jsarray.
9579:
9580: =cut
9581:
9582: sub gather_categories {
9583: my ($categories,$cats,$idx,$jsarray) = @_;
9584: my %counters;
9585: my $num = 0;
9586: foreach my $item (keys(%{$categories})) {
9587: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9588: if ($container eq '' && $depth == 0) {
9589: $cats->[$depth][$categories->{$item}] = $cat;
9590: } else {
9591: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9592: }
9593: my ($escitem,$tail) = split(/:/,$item,2);
9594: if ($counters{$tail} eq '') {
9595: $counters{$tail} = $num;
9596: $num ++;
9597: }
9598: if (ref($idx) eq 'HASH') {
9599: $idx->{$item} = $counters{$tail};
9600: }
9601: if (ref($jsarray) eq 'ARRAY') {
9602: push(@{$jsarray->[$counters{$tail}]},$item);
9603: }
9604: }
9605: return;
9606: }
9607:
9608: =pod
9609:
9610: =item * &extract_categories()
9611:
9612: Used to generate breadcrumb trails for course categories.
9613:
9614: Inputs:
1.663 raeburn 9615:
1.655 raeburn 9616: categories (reference to hash of category definitions).
1.663 raeburn 9617:
1.655 raeburn 9618: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9619: categories and subcategories).
1.663 raeburn 9620:
1.655 raeburn 9621: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9622:
1.655 raeburn 9623: allitems (reference to hash - key is category key
9624: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9625:
1.655 raeburn 9626: idx (reference to hash of counters used in Domain Coordinator interface for
9627: editing Course Categories).
1.663 raeburn 9628:
1.655 raeburn 9629: jsarray (reference to array of categories used to create Javascript arrays for
9630: Domain Coordinator interface for editing Course Categories).
9631:
1.665 raeburn 9632: subcats (reference to hash of arrays containing all subcategories within each
9633: category, -recursive)
9634:
1.655 raeburn 9635: Returns: nothing
9636:
9637: Side effects: populates trails and allitems hash references.
9638:
9639: =cut
9640:
9641: sub extract_categories {
1.665 raeburn 9642: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9643: if (ref($categories) eq 'HASH') {
9644: &gather_categories($categories,$cats,$idx,$jsarray);
9645: if (ref($cats->[0]) eq 'ARRAY') {
9646: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9647: my $name = $cats->[0][$i];
9648: my $item = &escape($name).'::0';
9649: my $trailstr;
9650: if ($name eq 'instcode') {
9651: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9652: } elsif ($name eq 'communities') {
9653: $trailstr = &mt('Communities');
1.655 raeburn 9654: } else {
9655: $trailstr = $name;
9656: }
9657: if ($allitems->{$item} eq '') {
9658: push(@{$trails},$trailstr);
9659: $allitems->{$item} = scalar(@{$trails})-1;
9660: }
9661: my @parents = ($name);
9662: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9663: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9664: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9665: if (ref($subcats) eq 'HASH') {
9666: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9667: }
9668: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9669: }
9670: } else {
9671: if (ref($subcats) eq 'HASH') {
9672: $subcats->{$item} = [];
1.655 raeburn 9673: }
9674: }
9675: }
9676: }
9677: }
9678: return;
9679: }
9680:
9681: =pod
9682:
9683: =item *&recurse_categories()
9684:
9685: Recursively used to generate breadcrumb trails for course categories.
9686:
9687: Inputs:
1.663 raeburn 9688:
1.655 raeburn 9689: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9690: categories and subcategories).
1.663 raeburn 9691:
1.655 raeburn 9692: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9693:
9694: category (current course category, for which breadcrumb trail is being generated).
9695:
9696: trails (reference to array of breadcrumb trails for each category).
9697:
1.655 raeburn 9698: allitems (reference to hash - key is category key
9699: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9700:
1.655 raeburn 9701: parents (array containing containers directories for current category,
9702: back to top level).
9703:
9704: Returns: nothing
9705:
9706: Side effects: populates trails and allitems hash references
9707:
9708: =cut
9709:
9710: sub recurse_categories {
1.665 raeburn 9711: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9712: my $shallower = $depth - 1;
9713: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9714: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9715: my $name = $cats->[$depth]{$category}[$k];
9716: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9717: my $trailstr = join(' -> ',(@{$parents},$category));
9718: if ($allitems->{$item} eq '') {
9719: push(@{$trails},$trailstr);
9720: $allitems->{$item} = scalar(@{$trails})-1;
9721: }
9722: my $deeper = $depth+1;
9723: push(@{$parents},$category);
1.665 raeburn 9724: if (ref($subcats) eq 'HASH') {
9725: my $subcat = &escape($name).':'.$category.':'.$depth;
9726: for (my $j=@{$parents}; $j>=0; $j--) {
9727: my $higher;
9728: if ($j > 0) {
9729: $higher = &escape($parents->[$j]).':'.
9730: &escape($parents->[$j-1]).':'.$j;
9731: } else {
9732: $higher = &escape($parents->[$j]).'::'.$j;
9733: }
9734: push(@{$subcats->{$higher}},$subcat);
9735: }
9736: }
9737: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9738: $subcats);
1.655 raeburn 9739: pop(@{$parents});
9740: }
9741: } else {
9742: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9743: my $trailstr = join(' -> ',(@{$parents},$category));
9744: if ($allitems->{$item} eq '') {
9745: push(@{$trails},$trailstr);
9746: $allitems->{$item} = scalar(@{$trails})-1;
9747: }
9748: }
9749: return;
9750: }
9751:
1.663 raeburn 9752: =pod
9753:
9754: =item *&assign_categories_table()
9755:
9756: Create a datatable for display of hierarchical categories in a domain,
9757: with checkboxes to allow a course to be categorized.
9758:
9759: Inputs:
9760:
9761: cathash - reference to hash of categories defined for the domain (from
9762: configuration.db)
9763:
9764: currcat - scalar with an & separated list of categories assigned to a course.
9765:
1.919 raeburn 9766: type - scalar contains course type (Course or Community).
9767:
1.663 raeburn 9768: Returns: $output (markup to be displayed)
9769:
9770: =cut
9771:
9772: sub assign_categories_table {
1.919 raeburn 9773: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9774: my $output;
9775: if (ref($cathash) eq 'HASH') {
9776: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9777: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9778: $maxdepth = scalar(@cats);
9779: if (@cats > 0) {
9780: my $itemcount = 0;
9781: if (ref($cats[0]) eq 'ARRAY') {
9782: my @currcategories;
9783: if ($currcat ne '') {
9784: @currcategories = split('&',$currcat);
9785: }
1.919 raeburn 9786: my $table;
1.663 raeburn 9787: for (my $i=0; $i<@{$cats[0]}; $i++) {
9788: my $parent = $cats[0][$i];
1.919 raeburn 9789: next if ($parent eq 'instcode');
9790: if ($type eq 'Community') {
9791: next unless ($parent eq 'communities');
9792: } else {
9793: next if ($parent eq 'communities');
9794: }
1.663 raeburn 9795: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9796: my $item = &escape($parent).'::0';
9797: my $checked = '';
9798: if (@currcategories > 0) {
9799: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9800: $checked = ' checked="checked"';
1.663 raeburn 9801: }
9802: }
1.919 raeburn 9803: my $parent_title = $parent;
9804: if ($parent eq 'communities') {
9805: $parent_title = &mt('Communities');
9806: }
9807: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9808: '<input type="checkbox" name="usecategory" value="'.
9809: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9810: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9811: my $depth = 1;
9812: push(@path,$parent);
1.919 raeburn 9813: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9814: pop(@path);
1.919 raeburn 9815: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9816: $itemcount ++;
9817: }
1.919 raeburn 9818: if ($itemcount) {
9819: $output = &Apache::loncommon::start_data_table().
9820: $table.
9821: &Apache::loncommon::end_data_table();
9822: }
1.663 raeburn 9823: }
9824: }
9825: }
9826: return $output;
9827: }
9828:
9829: =pod
9830:
9831: =item *&assign_category_rows()
9832:
9833: Create a datatable row for display of nested categories in a domain,
9834: with checkboxes to allow a course to be categorized,called recursively.
9835:
9836: Inputs:
9837:
9838: itemcount - track row number for alternating colors
9839:
9840: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9841: categories and subcategories.
9842:
9843: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9844:
9845: parent - parent of current category item
9846:
9847: path - Array containing all categories back up through the hierarchy from the
9848: current category to the top level.
9849:
9850: currcategories - reference to array of current categories assigned to the course
9851:
9852: Returns: $output (markup to be displayed).
9853:
9854: =cut
9855:
9856: sub assign_category_rows {
9857: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9858: my ($text,$name,$item,$chgstr);
9859: if (ref($cats) eq 'ARRAY') {
9860: my $maxdepth = scalar(@{$cats});
9861: if (ref($cats->[$depth]) eq 'HASH') {
9862: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9863: my $numchildren = @{$cats->[$depth]{$parent}};
9864: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9865: $text .= '<td><table class="LC_datatable">';
9866: for (my $j=0; $j<$numchildren; $j++) {
9867: $name = $cats->[$depth]{$parent}[$j];
9868: $item = &escape($name).':'.&escape($parent).':'.$depth;
9869: my $deeper = $depth+1;
9870: my $checked = '';
9871: if (ref($currcategories) eq 'ARRAY') {
9872: if (@{$currcategories} > 0) {
9873: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9874: $checked = ' checked="checked"';
1.663 raeburn 9875: }
9876: }
9877: }
1.664 raeburn 9878: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9879: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9880: $item.'"'.$checked.' />'.$name.'</label></span>'.
9881: '<input type="hidden" name="catname" value="'.$name.'" />'.
9882: '</td><td>';
1.663 raeburn 9883: if (ref($path) eq 'ARRAY') {
9884: push(@{$path},$name);
9885: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9886: pop(@{$path});
9887: }
9888: $text .= '</td></tr>';
9889: }
9890: $text .= '</table></td>';
9891: }
9892: }
9893: }
9894: return $text;
9895: }
9896:
1.655 raeburn 9897: ############################################################
9898: ############################################################
9899:
9900:
1.443 albertel 9901: sub commit_customrole {
1.664 raeburn 9902: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9903: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9904: ($start?', '.&mt('starting').' '.localtime($start):'').
9905: ($end?', ending '.localtime($end):'').': <b>'.
9906: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9907: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9908: '</b><br />';
9909: return $output;
9910: }
9911:
9912: sub commit_standardrole {
1.541 raeburn 9913: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9914: my ($output,$logmsg,$linefeed);
9915: if ($context eq 'auto') {
9916: $linefeed = "\n";
9917: } else {
9918: $linefeed = "<br />\n";
9919: }
1.443 albertel 9920: if ($three eq 'st') {
1.541 raeburn 9921: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9922: $one,$two,$sec,$context);
9923: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9924: ($result eq 'unknown_course') || ($result eq 'refused')) {
9925: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9926: } else {
1.541 raeburn 9927: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9928: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9929: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9930: if ($context eq 'auto') {
9931: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9932: } else {
9933: $output .= '<b>'.$result.'</b>'.$linefeed.
9934: &mt('Add to classlist').': <b>ok</b>';
9935: }
9936: $output .= $linefeed;
1.443 albertel 9937: }
9938: } else {
9939: $output = &mt('Assigning').' '.$three.' in '.$url.
9940: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9941: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9942: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9943: if ($context eq 'auto') {
9944: $output .= $result.$linefeed;
9945: } else {
9946: $output .= '<b>'.$result.'</b>'.$linefeed;
9947: }
1.443 albertel 9948: }
9949: return $output;
9950: }
9951:
9952: sub commit_studentrole {
1.541 raeburn 9953: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9954: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9955: if ($context eq 'auto') {
9956: $linefeed = "\n";
9957: } else {
9958: $linefeed = '<br />'."\n";
9959: }
1.443 albertel 9960: if (defined($one) && defined($two)) {
9961: my $cid=$one.'_'.$two;
9962: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9963: my $secchange = 0;
9964: my $expire_role_result;
9965: my $modify_section_result;
1.628 raeburn 9966: if ($oldsec ne '-1') {
9967: if ($oldsec ne $sec) {
1.443 albertel 9968: $secchange = 1;
1.628 raeburn 9969: my $now = time;
1.443 albertel 9970: my $uurl='/'.$cid;
9971: $uurl=~s/\_/\//g;
9972: if ($oldsec) {
9973: $uurl.='/'.$oldsec;
9974: }
1.626 raeburn 9975: $oldsecurl = $uurl;
1.628 raeburn 9976: $expire_role_result =
1.652 raeburn 9977: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9978: if ($env{'request.course.sec'} ne '') {
9979: if ($expire_role_result eq 'refused') {
9980: my @roles = ('st');
9981: my @statuses = ('previous');
9982: my @roledoms = ($one);
9983: my $withsec = 1;
9984: my %roleshash =
9985: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9986: \@statuses,\@roles,\@roledoms,$withsec);
9987: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9988: my ($oldstart,$oldend) =
9989: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9990: if ($oldend > 0 && $oldend <= $now) {
9991: $expire_role_result = 'ok';
9992: }
9993: }
9994: }
9995: }
1.443 albertel 9996: $result = $expire_role_result;
9997: }
9998: }
9999: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10000: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10001: if ($modify_section_result =~ /^ok/) {
10002: if ($secchange == 1) {
1.628 raeburn 10003: if ($sec eq '') {
10004: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10005: } else {
10006: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10007: }
1.443 albertel 10008: } elsif ($oldsec eq '-1') {
1.628 raeburn 10009: if ($sec eq '') {
10010: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10011: } else {
10012: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10013: }
1.443 albertel 10014: } else {
1.628 raeburn 10015: if ($sec eq '') {
10016: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10017: } else {
10018: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10019: }
1.443 albertel 10020: }
10021: } else {
1.628 raeburn 10022: if ($secchange) {
10023: $$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;
10024: } else {
10025: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10026: }
1.443 albertel 10027: }
10028: $result = $modify_section_result;
10029: } elsif ($secchange == 1) {
1.628 raeburn 10030: if ($oldsec eq '') {
10031: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10032: } else {
10033: $$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;
10034: }
1.626 raeburn 10035: if ($expire_role_result eq 'refused') {
10036: my $newsecurl = '/'.$cid;
10037: $newsecurl =~ s/\_/\//g;
10038: if ($sec ne '') {
10039: $newsecurl.='/'.$sec;
10040: }
10041: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10042: if ($sec eq '') {
10043: $$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;
10044: } else {
10045: $$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;
10046: }
10047: }
10048: }
1.443 albertel 10049: }
10050: } else {
1.626 raeburn 10051: $$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 10052: $result = "error: incomplete course id\n";
10053: }
10054: return $result;
10055: }
10056:
10057: ############################################################
10058: ############################################################
10059:
1.566 albertel 10060: sub check_clone {
1.578 raeburn 10061: my ($args,$linefeed) = @_;
1.566 albertel 10062: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10063: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10064: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10065: my $clonemsg;
10066: my $can_clone = 0;
1.908 raeburn 10067: my $lctype = lc($args->{'type'});
10068: if ($lctype ne 'community') {
10069: $lctype = 'course';
10070: }
1.566 albertel 10071: if ($clonehome eq 'no_host') {
1.908 raeburn 10072: if ($args->{'type'} eq 'Community') {
10073: $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'});
10074: } else {
10075: $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'});
10076: }
1.566 albertel 10077: } else {
10078: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10079: if ($args->{'type'} eq 'Community') {
10080: if ($clonedesc{'type'} ne 'Community') {
10081: $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'});
10082: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10083: }
10084: }
1.882 raeburn 10085: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10086: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10087: $can_clone = 1;
10088: } else {
10089: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10090: $args->{'clonedomain'},$args->{'clonecourse'});
10091: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10092: if (grep(/^\*$/,@cloners)) {
10093: $can_clone = 1;
10094: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10095: $can_clone = 1;
10096: } else {
1.908 raeburn 10097: my $ccrole = 'cc';
10098: if ($args->{'type'} eq 'Community') {
10099: $ccrole = 'co';
10100: }
1.578 raeburn 10101: my %roleshash =
10102: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10103: $args->{'ccdomain'},
1.908 raeburn 10104: 'userroles',['active'],[$ccrole],
1.578 raeburn 10105: [$args->{'clonedomain'}]);
1.908 raeburn 10106: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10107: $can_clone = 1;
10108: } else {
1.908 raeburn 10109: if ($args->{'type'} eq 'Community') {
10110: $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'});
10111: } else {
10112: $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'});
10113: }
1.578 raeburn 10114: }
1.566 albertel 10115: }
1.578 raeburn 10116: }
1.566 albertel 10117: }
10118: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10119: }
10120:
1.444 albertel 10121: sub construct_course {
1.885 raeburn 10122: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10123: my $outcome;
1.541 raeburn 10124: my $linefeed = '<br />'."\n";
10125: if ($context eq 'auto') {
10126: $linefeed = "\n";
10127: }
1.566 albertel 10128:
10129: #
10130: # Are we cloning?
10131: #
10132: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10133: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10134: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10135: if ($context ne 'auto') {
1.578 raeburn 10136: if ($clonemsg ne '') {
10137: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10138: }
1.566 albertel 10139: }
10140: $outcome .= $clonemsg.$linefeed;
10141:
10142: if (!$can_clone) {
10143: return (0,$outcome);
10144: }
10145: }
10146:
1.444 albertel 10147: #
10148: # Open course
10149: #
10150: my $crstype = lc($args->{'crstype'});
10151: my %cenv=();
10152: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10153: $args->{'cdescr'},
10154: $args->{'curl'},
10155: $args->{'course_home'},
10156: $args->{'nonstandard'},
10157: $args->{'crscode'},
10158: $args->{'ccuname'}.':'.
10159: $args->{'ccdomain'},
1.882 raeburn 10160: $args->{'crstype'},
1.885 raeburn 10161: $cnum,$context,$category);
1.444 albertel 10162:
10163: # Note: The testing routines depend on this being output; see
10164: # Utils::Course. This needs to at least be output as a comment
10165: # if anyone ever decides to not show this, and Utils::Course::new
10166: # will need to be suitably modified.
1.541 raeburn 10167: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10168: #
10169: # Check if created correctly
10170: #
1.479 albertel 10171: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10172: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10173: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10174:
1.444 albertel 10175: #
1.566 albertel 10176: # Do the cloning
10177: #
10178: if ($can_clone && $cloneid) {
10179: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10180: if ($context ne 'auto') {
10181: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10182: }
10183: $outcome .= $clonemsg.$linefeed;
10184: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10185: # Copy all files
1.637 www 10186: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10187: # Restore URL
1.566 albertel 10188: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10189: # Restore title
1.566 albertel 10190: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10191: # Mark as cloned
1.566 albertel 10192: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10193: # Need to clone grading mode
10194: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10195: $cenv{'grading'}=$newenv{'grading'};
10196: # Do not clone these environment entries
10197: &Apache::lonnet::del('environment',
10198: ['default_enrollment_start_date',
10199: 'default_enrollment_end_date',
10200: 'question.email',
10201: 'policy.email',
10202: 'comment.email',
10203: 'pch.users.denied',
1.725 raeburn 10204: 'plc.users.denied',
10205: 'hidefromcat',
10206: 'categories'],
1.638 www 10207: $$crsudom,$$crsunum);
1.444 albertel 10208: }
1.566 albertel 10209:
1.444 albertel 10210: #
10211: # Set environment (will override cloned, if existing)
10212: #
10213: my @sections = ();
10214: my @xlists = ();
10215: if ($args->{'crstype'}) {
10216: $cenv{'type'}=$args->{'crstype'};
10217: }
10218: if ($args->{'crsid'}) {
10219: $cenv{'courseid'}=$args->{'crsid'};
10220: }
10221: if ($args->{'crscode'}) {
10222: $cenv{'internal.coursecode'}=$args->{'crscode'};
10223: }
10224: if ($args->{'crsquota'} ne '') {
10225: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10226: } else {
10227: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10228: }
10229: if ($args->{'ccuname'}) {
10230: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10231: ':'.$args->{'ccdomain'};
10232: } else {
10233: $cenv{'internal.courseowner'} = $args->{'curruser'};
10234: }
10235: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10236: if ($args->{'crssections'}) {
10237: $cenv{'internal.sectionnums'} = '';
10238: if ($args->{'crssections'} =~ m/,/) {
10239: @sections = split/,/,$args->{'crssections'};
10240: } else {
10241: $sections[0] = $args->{'crssections'};
10242: }
10243: if (@sections > 0) {
10244: foreach my $item (@sections) {
10245: my ($sec,$gp) = split/:/,$item;
10246: my $class = $args->{'crscode'}.$sec;
10247: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10248: $cenv{'internal.sectionnums'} .= $item.',';
10249: unless ($addcheck eq 'ok') {
10250: push @badclasses, $class;
10251: }
10252: }
10253: $cenv{'internal.sectionnums'} =~ s/,$//;
10254: }
10255: }
10256: # do not hide course coordinator from staff listing,
10257: # even if privileged
10258: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10259: # add crosslistings
10260: if ($args->{'crsxlist'}) {
10261: $cenv{'internal.crosslistings'}='';
10262: if ($args->{'crsxlist'} =~ m/,/) {
10263: @xlists = split/,/,$args->{'crsxlist'};
10264: } else {
10265: $xlists[0] = $args->{'crsxlist'};
10266: }
10267: if (@xlists > 0) {
10268: foreach my $item (@xlists) {
10269: my ($xl,$gp) = split/:/,$item;
10270: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10271: $cenv{'internal.crosslistings'} .= $item.',';
10272: unless ($addcheck eq 'ok') {
10273: push @badclasses, $xl;
10274: }
10275: }
10276: $cenv{'internal.crosslistings'} =~ s/,$//;
10277: }
10278: }
10279: if ($args->{'autoadds'}) {
10280: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10281: }
10282: if ($args->{'autodrops'}) {
10283: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10284: }
10285: # check for notification of enrollment changes
10286: my @notified = ();
10287: if ($args->{'notify_owner'}) {
10288: if ($args->{'ccuname'} ne '') {
10289: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10290: }
10291: }
10292: if ($args->{'notify_dc'}) {
10293: if ($uname ne '') {
1.630 raeburn 10294: push(@notified,$uname.':'.$udom);
1.444 albertel 10295: }
10296: }
10297: if (@notified > 0) {
10298: my $notifylist;
10299: if (@notified > 1) {
10300: $notifylist = join(',',@notified);
10301: } else {
10302: $notifylist = $notified[0];
10303: }
10304: $cenv{'internal.notifylist'} = $notifylist;
10305: }
10306: if (@badclasses > 0) {
10307: my %lt=&Apache::lonlocal::texthash(
10308: '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',
10309: 'dnhr' => 'does not have rights to access enrollment in these classes',
10310: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10311: );
1.541 raeburn 10312: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10313: ' ('.$lt{'adby'}.')';
10314: if ($context eq 'auto') {
10315: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10316: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10317: foreach my $item (@badclasses) {
10318: if ($context eq 'auto') {
10319: $outcome .= " - $item\n";
10320: } else {
10321: $outcome .= "<li>$item</li>\n";
10322: }
10323: }
10324: if ($context eq 'auto') {
10325: $outcome .= $linefeed;
10326: } else {
1.566 albertel 10327: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10328: }
10329: }
1.444 albertel 10330: }
10331: if ($args->{'no_end_date'}) {
10332: $args->{'endaccess'} = 0;
10333: }
10334: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10335: $cenv{'internal.autoend'}=$args->{'enrollend'};
10336: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10337: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10338: if ($args->{'showphotos'}) {
10339: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10340: }
10341: $cenv{'internal.authtype'} = $args->{'authtype'};
10342: $cenv{'internal.autharg'} = $args->{'autharg'};
10343: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10344: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10345: 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');
10346: if ($context eq 'auto') {
10347: $outcome .= $krb_msg;
10348: } else {
1.566 albertel 10349: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10350: }
10351: $outcome .= $linefeed;
1.444 albertel 10352: }
10353: }
10354: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10355: if ($args->{'setpolicy'}) {
10356: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10357: }
10358: if ($args->{'setcontent'}) {
10359: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10360: }
10361: }
10362: if ($args->{'reshome'}) {
10363: $cenv{'reshome'}=$args->{'reshome'}.'/';
10364: $cenv{'reshome'}=~s/\/+$/\//;
10365: }
10366: #
10367: # course has keyed access
10368: #
10369: if ($args->{'setkeys'}) {
10370: $cenv{'keyaccess'}='yes';
10371: }
10372: # if specified, key authority is not course, but user
10373: # only active if keyaccess is yes
10374: if ($args->{'keyauth'}) {
1.487 albertel 10375: my ($user,$domain) = split(':',$args->{'keyauth'});
10376: $user = &LONCAPA::clean_username($user);
10377: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10378: if ($user ne '' && $domain ne '') {
1.487 albertel 10379: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10380: }
10381: }
10382:
10383: if ($args->{'disresdis'}) {
10384: $cenv{'pch.roles.denied'}='st';
10385: }
10386: if ($args->{'disablechat'}) {
10387: $cenv{'plc.roles.denied'}='st';
10388: }
10389:
10390: # Record we've not yet viewed the Course Initialization Helper for this
10391: # course
10392: $cenv{'course.helper.not.run'} = 1;
10393: #
10394: # Use new Randomseed
10395: #
10396: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10397: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10398: #
10399: # The encryption code and receipt prefix for this course
10400: #
10401: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10402: $cenv{'internal.encpref'}=100+int(9*rand(99));
10403: #
10404: # By default, use standard grading
10405: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10406:
1.541 raeburn 10407: $outcome .= $linefeed.&mt('Setting environment').': '.
10408: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10409: #
10410: # Open all assignments
10411: #
10412: if ($args->{'openall'}) {
10413: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10414: my %storecontent = ($storeunder => time,
10415: $storeunder.'.type' => 'date_start');
10416:
10417: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10418: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10419: }
10420: #
10421: # Set first page
10422: #
10423: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10424: || ($cloneid)) {
1.445 albertel 10425: use LONCAPA::map;
1.444 albertel 10426: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10427:
10428: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10429: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10430:
1.444 albertel 10431: $outcome .= ($fatal?$errtext:'read ok').' - ';
10432: my $title; my $url;
10433: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10434: $title=&mt('Syllabus');
1.444 albertel 10435: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10436: } else {
1.690 bisitz 10437: $title=&mt('Navigate Contents');
1.444 albertel 10438: $url='/adm/navmaps';
10439: }
1.445 albertel 10440:
10441: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10442: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10443:
10444: if ($errtext) { $fatal=2; }
1.541 raeburn 10445: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10446: }
1.566 albertel 10447:
10448: return (1,$outcome);
1.444 albertel 10449: }
10450:
10451: ############################################################
10452: ############################################################
10453:
1.378 raeburn 10454: sub course_type {
10455: my ($cid) = @_;
10456: if (!defined($cid)) {
10457: $cid = $env{'request.course.id'};
10458: }
1.404 albertel 10459: if (defined($env{'course.'.$cid.'.type'})) {
10460: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10461: } else {
10462: return 'Course';
1.377 raeburn 10463: }
10464: }
1.156 albertel 10465:
1.406 raeburn 10466: sub group_term {
10467: my $crstype = &course_type();
10468: my %names = (
10469: 'Course' => 'group',
1.865 raeburn 10470: 'Community' => 'group',
1.406 raeburn 10471: );
10472: return $names{$crstype};
10473: }
10474:
1.902 raeburn 10475: sub course_types {
10476: my @types = ('official','unofficial','community');
10477: my %typename = (
10478: official => 'Official course',
10479: unofficial => 'Unofficial course',
10480: community => 'Community',
10481: );
10482: return (\@types,\%typename);
10483: }
10484:
1.156 albertel 10485: sub icon {
10486: my ($file)=@_;
1.505 albertel 10487: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10488: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10489: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10490: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10491: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10492: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10493: $curfext.".gif") {
10494: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10495: $curfext.".gif";
10496: }
10497: }
1.249 albertel 10498: return &lonhttpdurl($iconname);
1.154 albertel 10499: }
1.84 albertel 10500:
1.575 albertel 10501: sub lonhttpdurl {
1.692 www 10502: #
10503: # Had been used for "small fry" static images on separate port 8080.
10504: # Modify here if lightweight http functionality desired again.
10505: # Currently eliminated due to increasing firewall issues.
10506: #
1.575 albertel 10507: my ($url)=@_;
1.692 www 10508: return $url;
1.215 albertel 10509: }
10510:
1.213 albertel 10511: sub connection_aborted {
10512: my ($r)=@_;
10513: $r->print(" ");$r->rflush();
10514: my $c = $r->connection;
10515: return $c->aborted();
10516: }
10517:
1.221 foxr 10518: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10519: # strings as 'strings'.
10520: sub escape_single {
1.221 foxr 10521: my ($input) = @_;
1.223 albertel 10522: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10523: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10524: return $input;
10525: }
1.223 albertel 10526:
1.222 foxr 10527: # Same as escape_single, but escape's "'s This
10528: # can be used for "strings"
10529: sub escape_double {
10530: my ($input) = @_;
10531: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10532: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10533: return $input;
10534: }
1.223 albertel 10535:
1.222 foxr 10536: # Escapes the last element of a full URL.
10537: sub escape_url {
10538: my ($url) = @_;
1.238 raeburn 10539: my @urlslices = split(/\//, $url,-1);
1.369 www 10540: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10541: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10542: }
1.462 albertel 10543:
1.820 raeburn 10544: sub compare_arrays {
10545: my ($arrayref1,$arrayref2) = @_;
10546: my (@difference,%count);
10547: @difference = ();
10548: %count = ();
10549: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10550: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10551: foreach my $element (keys(%count)) {
10552: if ($count{$element} == 1) {
10553: push(@difference,$element);
10554: }
10555: }
10556: }
10557: return @difference;
10558: }
10559:
1.817 bisitz 10560: # -------------------------------------------------------- Initialize user login
1.462 albertel 10561: sub init_user_environment {
1.463 albertel 10562: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10563: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10564:
10565: my $public=($username eq 'public' && $domain eq 'public');
10566:
10567: # See if old ID present, if so, remove
10568:
10569: my ($filename,$cookie,$userroles);
10570: my $now=time;
10571:
10572: if ($public) {
10573: my $max_public=100;
10574: my $oldest;
10575: my $oldest_time=0;
10576: for(my $next=1;$next<=$max_public;$next++) {
10577: if (-e $lonids."/publicuser_$next.id") {
10578: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10579: if ($mtime<$oldest_time || !$oldest_time) {
10580: $oldest_time=$mtime;
10581: $oldest=$next;
10582: }
10583: } else {
10584: $cookie="publicuser_$next";
10585: last;
10586: }
10587: }
10588: if (!$cookie) { $cookie="publicuser_$oldest"; }
10589: } else {
1.463 albertel 10590: # if this isn't a robot, kill any existing non-robot sessions
10591: if (!$args->{'robot'}) {
10592: opendir(DIR,$lonids);
10593: while ($filename=readdir(DIR)) {
10594: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10595: unlink($lonids.'/'.$filename);
10596: }
1.462 albertel 10597: }
1.463 albertel 10598: closedir(DIR);
1.462 albertel 10599: }
10600: # Give them a new cookie
1.463 albertel 10601: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10602: : $now.$$.int(rand(10000)));
1.463 albertel 10603: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10604:
10605: # Initialize roles
10606:
10607: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10608: }
10609: # ------------------------------------ Check browser type and MathML capability
10610:
10611: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10612: $clientunicode,$clientos) = &decode_user_agent($r);
10613:
10614: # ------------------------------------------------------------- Get environment
10615:
10616: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10617: my ($tmp) = keys(%userenv);
10618: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10619: # default remote control to off
10620: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10621: } else {
10622: undef(%userenv);
10623: }
10624: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10625: $form->{'interface'}=$userenv{'interface'};
10626: }
10627: $env{'environment.remote'}=$userenv{'remote'};
10628: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10629:
10630: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10631: foreach my $option ('interface','localpath','localres') {
10632: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10633: }
10634: # --------------------------------------------------------- Write first profile
10635:
10636: {
10637: my %initial_env =
10638: ("user.name" => $username,
10639: "user.domain" => $domain,
10640: "user.home" => $authhost,
10641: "browser.type" => $clientbrowser,
10642: "browser.version" => $clientversion,
10643: "browser.mathml" => $clientmathml,
10644: "browser.unicode" => $clientunicode,
10645: "browser.os" => $clientos,
10646: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10647: "request.course.fn" => '',
10648: "request.course.uri" => '',
10649: "request.course.sec" => '',
10650: "request.role" => 'cm',
10651: "request.role.adv" => $env{'user.adv'},
10652: "request.host" => $ENV{'REMOTE_ADDR'},);
10653:
10654: if ($form->{'localpath'}) {
10655: $initial_env{"browser.localpath"} = $form->{'localpath'};
10656: $initial_env{"browser.localres"} = $form->{'localres'};
10657: }
10658:
10659: if ($public) {
10660: $initial_env{"environment.remote"} = "off";
10661: }
10662: if ($form->{'interface'}) {
10663: $form->{'interface'}=~s/\W//gs;
10664: $initial_env{"browser.interface"} = $form->{'interface'};
10665: $env{'browser.interface'}=$form->{'interface'};
10666: }
10667:
1.724 raeburn 10668: foreach my $tool ('aboutme','blog','portfolio') {
10669: $userenv{'availabletools.'.$tool} =
10670: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10671: }
10672:
1.864 raeburn 10673: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10674: $userenv{'canrequest.'.$crstype} =
10675: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10676: 'reload','requestcourses');
10677: }
10678:
1.462 albertel 10679: $env{'user.environment'} = "$lonids/$cookie.id";
10680:
10681: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10682: &GDBM_WRCREAT(),0640)) {
10683: &_add_to_env(\%disk_env,\%initial_env);
10684: &_add_to_env(\%disk_env,\%userenv,'environment.');
10685: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10686: if (ref($args->{'extra_env'})) {
10687: &_add_to_env(\%disk_env,$args->{'extra_env'});
10688: }
1.462 albertel 10689: untie(%disk_env);
10690: } else {
1.705 tempelho 10691: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10692: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10693: return 'error: '.$!;
10694: }
10695: }
10696: $env{'request.role'}='cm';
10697: $env{'request.role.adv'}=$env{'user.adv'};
10698: $env{'browser.type'}=$clientbrowser;
10699:
10700: return $cookie;
10701:
10702: }
10703:
10704: sub _add_to_env {
10705: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10706: if (ref($env_data) eq 'HASH') {
10707: while (my ($key,$value) = each(%$env_data)) {
10708: $idf->{$prefix.$key} = $value;
10709: $env{$prefix.$key} = $value;
10710: }
1.462 albertel 10711: }
10712: }
10713:
1.685 tempelho 10714: # --- Get the symbolic name of a problem and the url
10715: sub get_symb {
10716: my ($request,$silent) = @_;
1.726 raeburn 10717: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10718: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10719: if ($symb eq '') {
10720: if (!$silent) {
10721: $request->print("Unable to handle ambiguous references:$url:.");
10722: return ();
10723: }
10724: }
10725: &Apache::lonenc::check_decrypt(\$symb);
10726: return ($symb);
10727: }
10728:
10729: # --------------------------------------------------------------Get annotation
10730:
10731: sub get_annotation {
10732: my ($symb,$enc) = @_;
10733:
10734: my $key = $symb;
10735: if (!$enc) {
10736: $key =
10737: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10738: }
10739: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10740: return $annotation{$key};
10741: }
10742:
10743: sub clean_symb {
1.731 raeburn 10744: my ($symb,$delete_enc) = @_;
1.685 tempelho 10745:
10746: &Apache::lonenc::check_decrypt(\$symb);
10747: my $enc = $env{'request.enc'};
1.731 raeburn 10748: if ($delete_enc) {
1.730 raeburn 10749: delete($env{'request.enc'});
10750: }
1.685 tempelho 10751:
10752: return ($symb,$enc);
10753: }
1.462 albertel 10754:
1.41 ng 10755: =pod
10756:
10757: =back
10758:
1.112 bowersj2 10759: =cut
1.41 ng 10760:
1.112 bowersj2 10761: 1;
10762: __END__;
1.41 ng 10763:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>