Annotation of loncom/interface/loncommon.pm, revision 1.927
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.927 ! raeburn 4: # $Id: loncommon.pm,v 1.926 2009/12/08 14:44:17 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.927 ! raeburn 4548: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
! 4549: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
! 4550: }
1.916 droeschl 4551:
1.903 droeschl 4552: $bodytag .= Apache::lonhtmlcommon::scripttag(
4553: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4554:
1.903 droeschl 4555: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4556:
1.917 raeburn 4557: if ($dc_info) {
4558: $dc_info = &dc_courseid_toggle($dc_info);
4559: }
4560: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4561:
1.903 droeschl 4562: #don't show menus for public users
4563: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4564: $bodytag .= Apache::lonmenu::secondary_menu();
4565: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4566: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4567: if ($env{'request.state'} eq 'construct') {
4568: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4569: $args->{'bread_crumbs'});
4570: } elsif ($forcereg) {
4571: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4572: }
1.903 droeschl 4573: }else{
4574: # this is to seperate menu from content when there's no secondary
4575: # menu. Especially needed for public accessible ressources.
4576: $bodytag .= '<hr style="clear:both" />';
4577: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4578: }
1.903 droeschl 4579:
4580: #SD testing
4581: #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235 raeburn 4582: return $bodytag;
1.94 www 4583: }
1.95 www 4584:
1.93 www 4585: #
1.95 www 4586: # Top frame rendering, Remote is up
1.93 www 4587: #
1.359 albertel 4588:
1.517 raeburn 4589: my $imgsrc = $img;
4590: if ($img =~ /^\/adm/) {
1.575 albertel 4591: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4592: }
4593: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4594:
1.305 www 4595: # Explicit link to get inline menu
1.361 albertel 4596: my $menu= ($no_inline_link?''
1.883 droeschl 4597: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4598:
4599: if ($dc_info) {
4600: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4601: }
4602:
1.916 droeschl 4603: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4604: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4605: <li>$menu</li>
1.917 raeburn 4606: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4607: return(<<ENDBODY);
1.60 matthew 4608: $bodytag
1.359 albertel 4609: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4610: <tr><td>$upperleft</td>
4611: <td>$messages </td>
1.54 www 4612: </tr>
1.359 albertel 4613: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4614: </tr>
1.356 albertel 4615: </table>
1.54 www 4616: ENDBODY
1.182 matthew 4617: }
4618:
1.917 raeburn 4619: sub dc_courseid_toggle {
4620: my ($dc_info) = @_;
4621: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4622: '<a href="javascript:showCourseID();">'.
4623: &mt('(More ...)').'</a></span>'.
4624: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4625: }
4626:
1.330 albertel 4627: sub make_attr_string {
4628: my ($register,$attr_ref) = @_;
4629:
4630: if ($attr_ref && !ref($attr_ref)) {
4631: die("addentries Must be a hash ref ".
4632: join(':',caller(1))." ".
4633: join(':',caller(0))." ");
4634: }
4635:
4636: if ($register) {
1.339 albertel 4637: my ($on_load,$on_unload);
4638: foreach my $key (keys(%{$attr_ref})) {
4639: if (lc($key) eq 'onload') {
4640: $on_load.=$attr_ref->{$key}.';';
4641: delete($attr_ref->{$key});
4642:
4643: } elsif (lc($key) eq 'onunload') {
4644: $on_unload.=$attr_ref->{$key}.';';
4645: delete($attr_ref->{$key});
4646: }
4647: }
4648: $attr_ref->{'onload'} =
4649: &Apache::lonmenu::loadevents(). $on_load;
4650: $attr_ref->{'onunload'}=
4651: &Apache::lonmenu::unloadevents().$on_unload;
4652: }
4653:
4654: # Accessibility font enhance
4655: if ($env{'browser.fontenhance'} eq 'on') {
4656: my $style;
4657: foreach my $key (keys(%{$attr_ref})) {
4658: if (lc($key) eq 'style') {
4659: $style.=$attr_ref->{$key}.';';
4660: delete($attr_ref->{$key});
4661: }
4662: }
4663: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4664: }
1.339 albertel 4665:
1.330 albertel 4666: my $attr_string;
4667: foreach my $attr (keys(%$attr_ref)) {
4668: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4669: }
4670: return $attr_string;
4671: }
4672:
4673:
1.182 matthew 4674: ###############################################
1.251 albertel 4675: ###############################################
4676:
4677: =pod
4678:
4679: =item * &endbodytag()
4680:
4681: Returns a uniform footer for LON-CAPA web pages.
4682:
1.635 raeburn 4683: Inputs: 1 - optional reference to an args hash
4684: If in the hash, key for noredirectlink has a value which evaluates to true,
4685: a 'Continue' link is not displayed if the page contains an
4686: internal redirect in the <head></head> section,
4687: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4688:
4689: =cut
4690:
4691: sub endbodytag {
1.635 raeburn 4692: my ($args) = @_;
1.251 albertel 4693: my $endbodytag='</body>';
1.269 albertel 4694: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4695: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4696: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4697: $endbodytag=
4698: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4699: &mt('Continue').'</a>'.
4700: $endbodytag;
4701: }
1.315 albertel 4702: }
1.251 albertel 4703: return $endbodytag;
4704: }
4705:
1.352 albertel 4706: =pod
4707:
4708: =item * &standard_css()
4709:
4710: Returns a style sheet
4711:
4712: Inputs: (all optional)
4713: domain -> force to color decorate a page for a specific
4714: domain
4715: function -> force usage of a specific rolish color scheme
4716: bgcolor -> override the default page bgcolor
4717:
4718: =cut
4719:
1.343 albertel 4720: sub standard_css {
1.345 albertel 4721: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4722: $function = &get_users_function() if (!$function);
4723: my $img = &designparm($function.'.img', $domain);
4724: my $tabbg = &designparm($function.'.tabbg', $domain);
4725: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4726: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4727: #second colour for later usage
1.345 albertel 4728: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4729: my $pgbg_or_bgcolor =
4730: $bgcolor ||
1.352 albertel 4731: &designparm($function.'.pgbg', $domain);
1.382 albertel 4732: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4733: my $alink = &designparm($function.'.alink', $domain);
4734: my $vlink = &designparm($function.'.vlink', $domain);
4735: my $link = &designparm($function.'.link', $domain);
4736:
1.704 muellerd 4737: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4738: my $bgcol = &designparm('login.bgcol',$domain);
4739: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4740:
1.602 albertel 4741: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4742: my $mono = 'monospace';
1.850 bisitz 4743: my $data_table_head = $sidebg;
4744: my $data_table_light = '#FAFAFA';
4745: my $data_table_dark = '#F0F0F0';
1.470 banghart 4746: my $data_table_darker = '#CCCCCC';
1.349 albertel 4747: my $data_table_highlight = '#FFFF00';
1.352 albertel 4748: my $mail_new = '#FFBB77';
4749: my $mail_new_hover = '#DD9955';
4750: my $mail_read = '#BBBB77';
4751: my $mail_read_hover = '#999944';
4752: my $mail_replied = '#AAAA88';
4753: my $mail_replied_hover = '#888855';
4754: my $mail_other = '#99BBBB';
4755: my $mail_other_hover = '#669999';
1.391 albertel 4756: my $table_header = '#DDDDDD';
1.489 raeburn 4757: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4758: my $lg_border_color = '#C8C8C8';
1.392 albertel 4759:
1.608 albertel 4760: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4761: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4762: : '0 3px 0 4px';
1.448 albertel 4763:
1.523 albertel 4764:
1.343 albertel 4765: return <<END;
1.795 www 4766: body {
1.911 bisitz 4767: font-family: $sans;
4768: line-height:130%;
4769: font-size:0.83em;
4770: color:$font;
1.795 www 4771: }
4772:
1.911 bisitz 4773: a:focus {
1.795 www 4774: color: red;
1.911 bisitz 4775: background: yellow;
1.795 www 4776: }
1.698 harmsja 4777:
1.911 bisitz 4778: form, .inline {
4779: display: inline;
1.795 www 4780: }
1.721 harmsja 4781:
1.795 www 4782: .LC_right {
1.911 bisitz 4783: text-align:right;
1.795 www 4784: }
4785:
4786: .LC_middle {
1.911 bisitz 4787: vertical-align:middle;
1.795 www 4788: }
1.721 harmsja 4789:
4790: /* just for tests */
1.911 bisitz 4791: .LC_400Box {
4792: width:400px;
4793: }
1.721 harmsja 4794: /* end */
4795:
1.778 bisitz 4796: .LC_filename {
4797: font-family: $mono;
4798: white-space:pre;
1.921 bisitz 4799: font-size: 120%;
1.778 bisitz 4800: }
4801:
4802: .LC_fileicon {
4803: border: none;
4804: height: 1.3em;
4805: vertical-align: text-bottom;
4806: margin-right: 0.3em;
4807: text-decoration:none;
4808: }
4809:
1.350 albertel 4810: .LC_error {
4811: color: red;
4812: font-size: larger;
4813: }
1.795 www 4814:
1.457 albertel 4815: .LC_warning,
4816: .LC_diff_removed {
1.733 bisitz 4817: color: red;
1.394 albertel 4818: }
1.532 albertel 4819:
4820: .LC_info,
1.457 albertel 4821: .LC_success,
4822: .LC_diff_added {
1.350 albertel 4823: color: green;
4824: }
1.795 www 4825:
1.802 bisitz 4826: div.LC_confirm_box {
4827: background-color: #FAFAFA;
4828: border: 1px solid $lg_border_color;
4829: margin-right: 0;
4830: padding: 5px;
4831: }
4832:
4833: div.LC_confirm_box .LC_error img,
4834: div.LC_confirm_box .LC_success img {
4835: vertical-align: middle;
4836: }
4837:
1.440 albertel 4838: .LC_icon {
1.771 droeschl 4839: border: none;
1.790 droeschl 4840: vertical-align: middle;
1.771 droeschl 4841: }
4842:
1.543 albertel 4843: .LC_docs_spacer {
4844: width: 25px;
4845: height: 1px;
1.771 droeschl 4846: border: none;
1.543 albertel 4847: }
1.346 albertel 4848:
1.532 albertel 4849: .LC_internal_info {
1.735 bisitz 4850: color: #999999;
1.532 albertel 4851: }
4852:
1.794 www 4853: .LC_discussion {
1.911 bisitz 4854: background: $tabbg;
4855: border: 1px solid black;
4856: margin: 2px;
1.794 www 4857: }
4858:
4859: .LC_disc_action_links_bar {
1.911 bisitz 4860: background: $tabbg;
4861: border: none;
4862: margin: 4px;
1.794 www 4863: }
4864:
4865: .LC_disc_action_left {
1.911 bisitz 4866: text-align: left;
1.794 www 4867: }
4868:
4869: .LC_disc_action_right {
1.911 bisitz 4870: text-align: right;
1.794 www 4871: }
4872:
4873: .LC_disc_new_item {
1.911 bisitz 4874: background: white;
4875: border: 2px solid red;
4876: margin: 2px;
1.794 www 4877: }
4878:
4879: .LC_disc_old_item {
1.911 bisitz 4880: background: white;
4881: border: 1px solid black;
4882: margin: 2px;
1.794 www 4883: }
4884:
1.458 albertel 4885: table.LC_pastsubmission {
4886: border: 1px solid black;
4887: margin: 2px;
4888: }
4889:
1.924 bisitz 4890: table#LC_menubuttons {
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.842 droeschl 4970: .LC_breadcrumbs_component {
1.911 bisitz 4971: float: right;
4972: margin: 0 1em;
1.357 albertel 4973: }
1.842 droeschl 4974: .LC_breadcrumbs_component img {
1.911 bisitz 4975: vertical-align: middle;
1.777 tempelho 4976: }
1.795 www 4977:
1.383 albertel 4978: td.LC_table_cell_checkbox {
4979: text-align: center;
4980: }
1.795 www 4981:
4982: .LC_fontsize_small {
1.911 bisitz 4983: font-size: 70%;
1.705 tempelho 4984: }
4985:
1.844 bisitz 4986: #LC_breadcrumbs {
1.911 bisitz 4987: clear:both;
4988: background: $sidebg;
4989: border-bottom: 1px solid $lg_border_color;
4990: line-height: 2.5em;
1.915 droeschl 4991: /* SD working here
4992: height: 2.5em;
4993: overflow: hidden; */
1.911 bisitz 4994: margin: 0;
4995: padding: 0;
1.819 tempelho 4996: }
1.862 bisitz 4997:
1.839 droeschl 4998: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 4999: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5000: display:none;
1.839 droeschl 5001: }
1.819 tempelho 5002:
1.844 bisitz 5003: #LC_head_subbox {
1.911 bisitz 5004: clear:both;
5005: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5006: border: 1px solid $sidebg;
5007: margin: 0 0 10px 0;
1.822 bisitz 5008: }
5009:
1.795 www 5010: .LC_fontsize_medium {
1.911 bisitz 5011: font-size: 85%;
1.705 tempelho 5012: }
5013:
1.795 www 5014: .LC_fontsize_large {
1.911 bisitz 5015: font-size: 120%;
1.705 tempelho 5016: }
5017:
1.346 albertel 5018: .LC_menubuttons_inline_text {
5019: color: $font;
1.698 harmsja 5020: font-size: 90%;
1.701 harmsja 5021: padding-left:3px;
1.346 albertel 5022: }
5023:
1.526 www 5024: .LC_menubuttons_link {
5025: text-decoration: none;
5026: }
1.795 www 5027:
1.522 albertel 5028: .LC_menubuttons_category {
1.521 www 5029: color: $font;
1.526 www 5030: background: $pgbg;
1.521 www 5031: font-size: larger;
5032: font-weight: bold;
5033: }
5034:
1.346 albertel 5035: td.LC_menubuttons_text {
1.911 bisitz 5036: color: $font;
1.346 albertel 5037: }
1.706 harmsja 5038:
1.346 albertel 5039: .LC_current_location {
5040: background: $tabbg;
5041: }
1.795 www 5042:
5043: table.LC_data_table,
5044: table.LC_mail_list {
1.347 albertel 5045: border: 1px solid #000000;
1.402 albertel 5046: border-collapse: separate;
1.426 albertel 5047: border-spacing: 1px;
1.610 albertel 5048: background: $pgbg;
1.347 albertel 5049: }
1.795 www 5050:
1.422 albertel 5051: .LC_data_table_dense {
5052: font-size: small;
5053: }
1.795 www 5054:
1.507 raeburn 5055: table.LC_nested_outer {
5056: border: 1px solid #000000;
1.589 raeburn 5057: border-collapse: collapse;
1.803 bisitz 5058: border-spacing: 0;
1.507 raeburn 5059: width: 100%;
5060: }
1.795 www 5061:
1.879 raeburn 5062: table.LC_innerpickbox,
1.507 raeburn 5063: table.LC_nested {
1.803 bisitz 5064: border: none;
1.589 raeburn 5065: border-collapse: collapse;
1.803 bisitz 5066: border-spacing: 0;
1.507 raeburn 5067: width: 100%;
5068: }
1.795 www 5069:
1.911 bisitz 5070: table.LC_data_table tr th,
5071: table.LC_calendar tr th,
1.795 www 5072: table.LC_mail_list tr th,
1.879 raeburn 5073: table.LC_prior_tries tr th,
5074: table.LC_innerpickbox tr th {
1.349 albertel 5075: font-weight: bold;
5076: background-color: $data_table_head;
1.801 tempelho 5077: color:$fontmenu;
1.701 harmsja 5078: font-size:90%;
1.347 albertel 5079: }
1.795 www 5080:
1.879 raeburn 5081: table.LC_innerpickbox tr th,
5082: table.LC_innerpickbox tr td {
5083: vertical-align: top;
5084: }
5085:
1.711 raeburn 5086: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5087: background-color: #CCCCCC;
1.711 raeburn 5088: font-weight: bold;
5089: text-align: left;
5090: }
1.795 www 5091:
1.912 bisitz 5092: table.LC_data_table tr.LC_odd_row > td {
5093: background-color: $data_table_light;
5094: padding: 2px;
5095: vertical-align: top;
5096: }
5097:
1.809 bisitz 5098: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5099: background-color: $data_table_light;
1.912 bisitz 5100: vertical-align: top;
5101: }
5102:
5103: table.LC_data_table tr.LC_even_row > td {
5104: background-color: $data_table_dark;
1.425 albertel 5105: padding: 2px;
1.900 bisitz 5106: vertical-align: top;
1.347 albertel 5107: }
1.795 www 5108:
1.809 bisitz 5109: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5110: background-color: $data_table_dark;
1.900 bisitz 5111: vertical-align: top;
1.347 albertel 5112: }
1.795 www 5113:
1.425 albertel 5114: table.LC_data_table tr.LC_data_table_highlight td {
5115: background-color: $data_table_darker;
5116: }
1.795 www 5117:
1.639 raeburn 5118: table.LC_data_table tr td.LC_leftcol_header {
5119: background-color: $data_table_head;
5120: font-weight: bold;
5121: }
1.795 www 5122:
1.451 albertel 5123: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5124: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5125: background-color: #FFFFFF;
1.421 albertel 5126: font-weight: bold;
5127: font-style: italic;
5128: text-align: center;
5129: padding: 8px;
1.347 albertel 5130: }
1.795 www 5131:
1.890 droeschl 5132: table.LC_caption {
5133: }
5134:
1.507 raeburn 5135: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5136: padding: 4ex
5137: }
1.795 www 5138:
1.507 raeburn 5139: table.LC_nested_outer tr th {
5140: font-weight: bold;
1.801 tempelho 5141: color:$fontmenu;
1.507 raeburn 5142: background-color: $data_table_head;
1.701 harmsja 5143: font-size: small;
1.507 raeburn 5144: border-bottom: 1px solid #000000;
5145: }
1.795 www 5146:
1.507 raeburn 5147: table.LC_nested_outer tr td.LC_subheader {
5148: background-color: $data_table_head;
5149: font-weight: bold;
5150: font-size: small;
5151: border-bottom: 1px solid #000000;
5152: text-align: right;
1.451 albertel 5153: }
1.795 www 5154:
1.507 raeburn 5155: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5156: background-color: #CCCCCC;
1.451 albertel 5157: font-weight: bold;
5158: font-size: small;
1.507 raeburn 5159: text-align: center;
5160: }
1.795 www 5161:
1.589 raeburn 5162: table.LC_nested tr.LC_info_row td.LC_left_item,
5163: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5164: text-align: left;
1.451 albertel 5165: }
1.795 www 5166:
1.507 raeburn 5167: table.LC_nested td {
1.735 bisitz 5168: background-color: #FFFFFF;
1.451 albertel 5169: font-size: small;
1.507 raeburn 5170: }
1.795 www 5171:
1.507 raeburn 5172: table.LC_nested_outer tr th.LC_right_item,
5173: table.LC_nested tr.LC_info_row td.LC_right_item,
5174: table.LC_nested tr.LC_odd_row td.LC_right_item,
5175: table.LC_nested tr td.LC_right_item {
1.451 albertel 5176: text-align: right;
5177: }
5178:
1.507 raeburn 5179: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5180: background-color: #EEEEEE;
1.451 albertel 5181: }
5182:
1.473 raeburn 5183: table.LC_createuser {
5184: }
5185:
5186: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5187: font-size: small;
1.473 raeburn 5188: }
5189:
5190: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5191: background-color: #CCCCCC;
1.473 raeburn 5192: font-weight: bold;
5193: text-align: center;
5194: }
5195:
1.349 albertel 5196: table.LC_calendar {
5197: border: 1px solid #000000;
5198: border-collapse: collapse;
1.917 raeburn 5199: width: 98%;
1.349 albertel 5200: }
1.795 www 5201:
1.349 albertel 5202: table.LC_calendar_pickdate {
5203: font-size: xx-small;
5204: }
1.795 www 5205:
1.349 albertel 5206: table.LC_calendar tr td {
5207: border: 1px solid #000000;
5208: vertical-align: top;
1.917 raeburn 5209: width: 14%;
1.349 albertel 5210: }
1.795 www 5211:
1.349 albertel 5212: table.LC_calendar tr td.LC_calendar_day_empty {
5213: background-color: $data_table_dark;
5214: }
1.795 www 5215:
1.779 bisitz 5216: table.LC_calendar tr td.LC_calendar_day_current {
5217: background-color: $data_table_highlight;
1.777 tempelho 5218: }
1.795 www 5219:
1.349 albertel 5220: table.LC_mail_list tr.LC_mail_new {
5221: background-color: $mail_new;
5222: }
1.795 www 5223:
1.349 albertel 5224: table.LC_mail_list tr.LC_mail_new:hover {
5225: background-color: $mail_new_hover;
5226: }
1.795 www 5227:
1.349 albertel 5228: table.LC_mail_list tr.LC_mail_read {
5229: background-color: $mail_read;
5230: }
1.795 www 5231:
1.349 albertel 5232: table.LC_mail_list tr.LC_mail_read:hover {
5233: background-color: $mail_read_hover;
5234: }
1.795 www 5235:
1.349 albertel 5236: table.LC_mail_list tr.LC_mail_replied {
5237: background-color: $mail_replied;
5238: }
1.795 www 5239:
1.349 albertel 5240: table.LC_mail_list tr.LC_mail_replied:hover {
5241: background-color: $mail_replied_hover;
5242: }
1.795 www 5243:
1.349 albertel 5244: table.LC_mail_list tr.LC_mail_other {
5245: background-color: $mail_other;
5246: }
1.795 www 5247:
1.349 albertel 5248: table.LC_mail_list tr.LC_mail_other:hover {
5249: background-color: $mail_other_hover;
5250: }
1.494 raeburn 5251:
1.777 tempelho 5252: table.LC_data_table tr > td.LC_browser_file,
5253: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5254: background: #AAEE77;
1.389 albertel 5255: }
1.795 www 5256:
1.777 tempelho 5257: table.LC_data_table tr > td.LC_browser_file_locked,
5258: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5259: background: #FFAA99;
1.387 albertel 5260: }
1.795 www 5261:
1.777 tempelho 5262: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5263: background: #888888;
1.779 bisitz 5264: }
1.795 www 5265:
1.777 tempelho 5266: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5267: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5268: background: #F8F866;
1.777 tempelho 5269: }
1.795 www 5270:
1.696 bisitz 5271: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5272: background: #E0E8FF;
1.387 albertel 5273: }
1.696 bisitz 5274:
1.707 bisitz 5275: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5276: /* background: #77FF77; */
1.707 bisitz 5277: }
1.795 www 5278:
1.707 bisitz 5279: table.LC_data_table tr > td.LC_roles_future {
5280: background: #FFFF77;
5281: }
1.795 www 5282:
1.707 bisitz 5283: table.LC_data_table tr > td.LC_roles_will {
5284: background: #FFAA77;
5285: }
1.795 www 5286:
1.707 bisitz 5287: table.LC_data_table tr > td.LC_roles_expired {
5288: background: #FF7777;
5289: }
1.795 www 5290:
1.707 bisitz 5291: table.LC_data_table tr > td.LC_roles_will_not {
5292: background: #AAFF77;
5293: }
1.795 www 5294:
1.707 bisitz 5295: table.LC_data_table tr > td.LC_roles_selected {
5296: background: #11CC55;
5297: }
5298:
1.388 albertel 5299: span.LC_current_location {
1.701 harmsja 5300: font-size:larger;
1.388 albertel 5301: background: $pgbg;
5302: }
1.387 albertel 5303:
1.395 albertel 5304: span.LC_parm_menu_item {
5305: font-size: larger;
5306: }
1.795 www 5307:
1.395 albertel 5308: span.LC_parm_scope_all {
5309: color: red;
5310: }
1.795 www 5311:
1.395 albertel 5312: span.LC_parm_scope_folder {
5313: color: green;
5314: }
1.795 www 5315:
1.395 albertel 5316: span.LC_parm_scope_resource {
5317: color: orange;
5318: }
1.795 www 5319:
1.395 albertel 5320: span.LC_parm_part {
5321: color: blue;
5322: }
1.795 www 5323:
1.911 bisitz 5324: span.LC_parm_folder,
5325: span.LC_parm_symb {
1.395 albertel 5326: font-size: x-small;
5327: font-family: $mono;
5328: color: #AAAAAA;
5329: }
5330:
1.795 www 5331: td.LC_parm_overview_level_menu,
5332: td.LC_parm_overview_map_menu,
5333: td.LC_parm_overview_parm_selectors,
5334: td.LC_parm_overview_restrictions {
1.396 albertel 5335: border: 1px solid black;
5336: border-collapse: collapse;
5337: }
1.795 www 5338:
1.396 albertel 5339: table.LC_parm_overview_restrictions td {
5340: border-width: 1px 4px 1px 4px;
5341: border-style: solid;
5342: border-color: $pgbg;
5343: text-align: center;
5344: }
1.795 www 5345:
1.396 albertel 5346: table.LC_parm_overview_restrictions th {
5347: background: $tabbg;
5348: border-width: 1px 4px 1px 4px;
5349: border-style: solid;
5350: border-color: $pgbg;
5351: }
1.795 www 5352:
1.398 albertel 5353: table#LC_helpmenu {
1.803 bisitz 5354: border: none;
1.398 albertel 5355: height: 55px;
1.803 bisitz 5356: border-spacing: 0;
1.398 albertel 5357: }
5358:
5359: table#LC_helpmenu fieldset legend {
5360: font-size: larger;
5361: }
1.795 www 5362:
1.397 albertel 5363: table#LC_helpmenu_links {
5364: width: 100%;
5365: border: 1px solid black;
5366: background: $pgbg;
1.803 bisitz 5367: padding: 0;
1.397 albertel 5368: border-spacing: 1px;
5369: }
1.795 www 5370:
1.397 albertel 5371: table#LC_helpmenu_links tr td {
5372: padding: 1px;
5373: background: $tabbg;
1.399 albertel 5374: text-align: center;
5375: font-weight: bold;
1.397 albertel 5376: }
1.396 albertel 5377:
1.795 www 5378: table#LC_helpmenu_links a:link,
5379: table#LC_helpmenu_links a:visited,
1.397 albertel 5380: table#LC_helpmenu_links a:active {
5381: text-decoration: none;
5382: color: $font;
5383: }
1.795 www 5384:
1.397 albertel 5385: table#LC_helpmenu_links a:hover {
5386: text-decoration: underline;
5387: color: $vlink;
5388: }
1.396 albertel 5389:
1.417 albertel 5390: .LC_chrt_popup_exists {
5391: border: 1px solid #339933;
5392: margin: -1px;
5393: }
1.795 www 5394:
1.417 albertel 5395: .LC_chrt_popup_up {
5396: border: 1px solid yellow;
5397: margin: -1px;
5398: }
1.795 www 5399:
1.417 albertel 5400: .LC_chrt_popup {
5401: border: 1px solid #8888FF;
5402: background: #CCCCFF;
5403: }
1.795 www 5404:
1.421 albertel 5405: table.LC_pick_box {
5406: border-collapse: separate;
5407: background: white;
5408: border: 1px solid black;
5409: border-spacing: 1px;
5410: }
1.795 www 5411:
1.421 albertel 5412: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5413: background: $sidebg;
1.421 albertel 5414: font-weight: bold;
1.900 bisitz 5415: text-align: left;
1.740 bisitz 5416: vertical-align: top;
1.421 albertel 5417: width: 184px;
5418: padding: 8px;
5419: }
1.795 www 5420:
1.579 raeburn 5421: table.LC_pick_box td.LC_pick_box_value {
5422: text-align: left;
5423: padding: 8px;
5424: }
1.795 www 5425:
1.579 raeburn 5426: table.LC_pick_box td.LC_pick_box_select {
5427: text-align: left;
5428: padding: 8px;
5429: }
1.795 www 5430:
1.424 albertel 5431: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5432: padding: 0;
1.421 albertel 5433: height: 1px;
5434: background: black;
5435: }
1.795 www 5436:
1.421 albertel 5437: table.LC_pick_box td.LC_pick_box_submit {
5438: text-align: right;
5439: }
1.795 www 5440:
1.579 raeburn 5441: table.LC_pick_box td.LC_evenrow_value {
5442: text-align: left;
5443: padding: 8px;
5444: background-color: $data_table_light;
5445: }
1.795 www 5446:
1.579 raeburn 5447: table.LC_pick_box td.LC_oddrow_value {
5448: text-align: left;
5449: padding: 8px;
5450: background-color: $data_table_light;
5451: }
1.795 www 5452:
1.579 raeburn 5453: span.LC_helpform_receipt_cat {
5454: font-weight: bold;
5455: }
1.795 www 5456:
1.424 albertel 5457: table.LC_group_priv_box {
5458: background: white;
5459: border: 1px solid black;
5460: border-spacing: 1px;
5461: }
1.795 www 5462:
1.424 albertel 5463: table.LC_group_priv_box td.LC_pick_box_title {
5464: background: $tabbg;
5465: font-weight: bold;
5466: text-align: right;
5467: width: 184px;
5468: }
1.795 www 5469:
1.424 albertel 5470: table.LC_group_priv_box td.LC_groups_fixed {
5471: background: $data_table_light;
5472: text-align: center;
5473: }
1.795 www 5474:
1.424 albertel 5475: table.LC_group_priv_box td.LC_groups_optional {
5476: background: $data_table_dark;
5477: text-align: center;
5478: }
1.795 www 5479:
1.424 albertel 5480: table.LC_group_priv_box td.LC_groups_functionality {
5481: background: $data_table_darker;
5482: text-align: center;
5483: font-weight: bold;
5484: }
1.795 www 5485:
1.424 albertel 5486: table.LC_group_priv td {
5487: text-align: left;
1.803 bisitz 5488: padding: 0;
1.424 albertel 5489: }
5490:
1.421 albertel 5491: table.LC_notify_front_page {
5492: background: white;
5493: border: 1px solid black;
5494: padding: 8px;
5495: }
1.795 www 5496:
1.421 albertel 5497: table.LC_notify_front_page td {
5498: padding: 8px;
5499: }
1.795 www 5500:
1.424 albertel 5501: .LC_navbuttons {
5502: margin: 2ex 0ex 2ex 0ex;
5503: }
1.795 www 5504:
1.423 albertel 5505: .LC_topic_bar {
5506: font-weight: bold;
5507: background: $tabbg;
1.918 wenzelju 5508: margin: 1em 0em 1em 2em;
1.805 bisitz 5509: padding: 3px;
1.918 wenzelju 5510: font-size: 1.2em;
1.423 albertel 5511: }
1.795 www 5512:
1.423 albertel 5513: .LC_topic_bar span {
1.918 wenzelju 5514: left: 0.5em;
5515: position: absolute;
1.423 albertel 5516: vertical-align: middle;
1.918 wenzelju 5517: font-size: 1.2em;
1.423 albertel 5518: }
1.795 www 5519:
1.423 albertel 5520: table.LC_course_group_status {
5521: margin: 20px;
5522: }
1.795 www 5523:
1.423 albertel 5524: table.LC_status_selector td {
5525: vertical-align: top;
5526: text-align: center;
1.424 albertel 5527: padding: 4px;
5528: }
1.795 www 5529:
1.599 albertel 5530: div.LC_feedback_link {
1.616 albertel 5531: clear: both;
1.829 kalberla 5532: background: $sidebg;
1.779 bisitz 5533: width: 100%;
1.829 kalberla 5534: padding-bottom: 10px;
5535: border: 1px $tabbg solid;
1.833 kalberla 5536: height: 22px;
5537: line-height: 22px;
5538: padding-top: 5px;
5539: }
5540:
5541: div.LC_feedback_link img {
5542: height: 22px;
1.867 kalberla 5543: vertical-align:middle;
1.829 kalberla 5544: }
5545:
1.911 bisitz 5546: div.LC_feedback_link a {
1.829 kalberla 5547: text-decoration: none;
1.489 raeburn 5548: }
1.795 www 5549:
1.867 kalberla 5550: div.LC_comblock {
1.911 bisitz 5551: display:inline;
1.867 kalberla 5552: color:$font;
5553: font-size:90%;
5554: }
5555:
5556: div.LC_feedback_link div.LC_comblock {
5557: padding-left:5px;
5558: }
5559:
5560: div.LC_feedback_link div.LC_comblock a {
5561: color:$font;
5562: }
5563:
1.489 raeburn 5564: span.LC_feedback_link {
1.858 bisitz 5565: /* background: $feedback_link_bg; */
1.599 albertel 5566: font-size: larger;
5567: }
1.795 www 5568:
1.599 albertel 5569: span.LC_message_link {
1.858 bisitz 5570: /* background: $feedback_link_bg; */
1.599 albertel 5571: font-size: larger;
5572: position: absolute;
5573: right: 1em;
1.489 raeburn 5574: }
1.421 albertel 5575:
1.515 albertel 5576: table.LC_prior_tries {
1.524 albertel 5577: border: 1px solid #000000;
5578: border-collapse: separate;
5579: border-spacing: 1px;
1.515 albertel 5580: }
1.523 albertel 5581:
1.515 albertel 5582: table.LC_prior_tries td {
1.524 albertel 5583: padding: 2px;
1.515 albertel 5584: }
1.523 albertel 5585:
5586: .LC_answer_correct {
1.795 www 5587: background: lightgreen;
5588: color: darkgreen;
5589: padding: 6px;
1.523 albertel 5590: }
1.795 www 5591:
1.523 albertel 5592: .LC_answer_charged_try {
1.797 www 5593: background: #FFAAAA;
1.795 www 5594: color: darkred;
5595: padding: 6px;
1.523 albertel 5596: }
1.795 www 5597:
1.779 bisitz 5598: .LC_answer_not_charged_try,
1.523 albertel 5599: .LC_answer_no_grade,
5600: .LC_answer_late {
1.795 www 5601: background: lightyellow;
1.523 albertel 5602: color: black;
1.795 www 5603: padding: 6px;
1.523 albertel 5604: }
1.795 www 5605:
1.523 albertel 5606: .LC_answer_previous {
1.795 www 5607: background: lightblue;
5608: color: darkblue;
5609: padding: 6px;
1.523 albertel 5610: }
1.795 www 5611:
1.779 bisitz 5612: .LC_answer_no_message {
1.777 tempelho 5613: background: #FFFFFF;
5614: color: black;
1.795 www 5615: padding: 6px;
1.779 bisitz 5616: }
1.795 www 5617:
1.779 bisitz 5618: .LC_answer_unknown {
5619: background: orange;
5620: color: black;
1.795 www 5621: padding: 6px;
1.777 tempelho 5622: }
1.795 www 5623:
1.529 albertel 5624: span.LC_prior_numerical,
5625: span.LC_prior_string,
5626: span.LC_prior_custom,
5627: span.LC_prior_reaction,
5628: span.LC_prior_math {
1.925 bisitz 5629: font-family: $mono;
1.523 albertel 5630: white-space: pre;
5631: }
5632:
1.525 albertel 5633: span.LC_prior_string {
1.925 bisitz 5634: font-family: $mono;
1.525 albertel 5635: white-space: pre;
5636: }
5637:
1.523 albertel 5638: table.LC_prior_option {
5639: width: 100%;
5640: border-collapse: collapse;
5641: }
1.795 www 5642:
1.911 bisitz 5643: table.LC_prior_rank,
1.795 www 5644: table.LC_prior_match {
1.528 albertel 5645: border-collapse: collapse;
5646: }
1.795 www 5647:
1.528 albertel 5648: table.LC_prior_option tr td,
5649: table.LC_prior_rank tr td,
5650: table.LC_prior_match tr td {
1.524 albertel 5651: border: 1px solid #000000;
1.515 albertel 5652: }
5653:
1.855 bisitz 5654: .LC_nobreak {
1.544 albertel 5655: white-space: nowrap;
1.519 raeburn 5656: }
5657:
1.576 raeburn 5658: span.LC_cusr_emph {
5659: font-style: italic;
5660: }
5661:
1.633 raeburn 5662: span.LC_cusr_subheading {
5663: font-weight: normal;
5664: font-size: 85%;
5665: }
5666:
1.861 bisitz 5667: div.LC_docs_entry_move {
1.859 bisitz 5668: border: 1px solid #BBBBBB;
1.545 albertel 5669: background: #DDDDDD;
1.861 bisitz 5670: width: 22px;
1.859 bisitz 5671: padding: 1px;
5672: margin: 0;
1.545 albertel 5673: }
5674:
1.861 bisitz 5675: table.LC_data_table tr > td.LC_docs_entry_commands,
5676: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5677: background: #DDDDDD;
5678: font-size: x-small;
5679: }
1.795 www 5680:
1.861 bisitz 5681: .LC_docs_entry_parameter {
5682: white-space: nowrap;
5683: }
5684:
1.544 albertel 5685: .LC_docs_copy {
1.545 albertel 5686: color: #000099;
1.544 albertel 5687: }
1.795 www 5688:
1.544 albertel 5689: .LC_docs_cut {
1.545 albertel 5690: color: #550044;
1.544 albertel 5691: }
1.795 www 5692:
1.544 albertel 5693: .LC_docs_rename {
1.545 albertel 5694: color: #009900;
1.544 albertel 5695: }
1.795 www 5696:
1.544 albertel 5697: .LC_docs_remove {
1.545 albertel 5698: color: #990000;
5699: }
5700:
1.547 albertel 5701: .LC_docs_reinit_warn,
5702: .LC_docs_ext_edit {
5703: font-size: x-small;
5704: }
5705:
1.545 albertel 5706: table.LC_docs_adddocs td,
5707: table.LC_docs_adddocs th {
5708: border: 1px solid #BBBBBB;
5709: padding: 4px;
5710: background: #DDDDDD;
1.543 albertel 5711: }
5712:
1.584 albertel 5713: table.LC_sty_begin {
5714: background: #BBFFBB;
5715: }
1.795 www 5716:
1.584 albertel 5717: table.LC_sty_end {
5718: background: #FFBBBB;
5719: }
5720:
1.589 raeburn 5721: table.LC_double_column {
1.803 bisitz 5722: border-width: 0;
1.589 raeburn 5723: border-collapse: collapse;
5724: width: 100%;
5725: padding: 2px;
5726: }
5727:
5728: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5729: top: 2px;
1.589 raeburn 5730: left: 2px;
5731: width: 47%;
5732: vertical-align: top;
5733: }
5734:
5735: table.LC_double_column tr td.LC_right_col {
5736: top: 2px;
1.779 bisitz 5737: right: 2px;
1.589 raeburn 5738: width: 47%;
5739: vertical-align: top;
5740: }
5741:
1.591 raeburn 5742: div.LC_left_float {
5743: float: left;
5744: padding-right: 5%;
1.597 albertel 5745: padding-bottom: 4px;
1.591 raeburn 5746: }
5747:
5748: div.LC_clear_float_header {
1.597 albertel 5749: padding-bottom: 2px;
1.591 raeburn 5750: }
5751:
5752: div.LC_clear_float_footer {
1.597 albertel 5753: padding-top: 10px;
1.591 raeburn 5754: clear: both;
5755: }
5756:
1.597 albertel 5757: div.LC_grade_show_user {
5758: margin-top: 20px;
5759: border: 1px solid black;
5760: }
1.795 www 5761:
1.597 albertel 5762: div.LC_grade_user_name {
5763: background: #DDDDEE;
5764: border-bottom: 1px solid black;
1.705 tempelho 5765: font-weight: bold;
5766: font-size: large;
1.597 albertel 5767: }
1.795 www 5768:
1.597 albertel 5769: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5770: background: #DDEEDD;
5771: }
5772:
5773: div.LC_grade_show_problem,
5774: div.LC_grade_submissions,
5775: div.LC_grade_message_center,
5776: div.LC_grade_info_links,
5777: div.LC_grade_assign {
5778: margin: 5px;
5779: width: 99%;
5780: background: #FFFFFF;
5781: }
1.795 www 5782:
1.597 albertel 5783: div.LC_grade_show_problem_header,
5784: div.LC_grade_submissions_header,
5785: div.LC_grade_message_center_header,
5786: div.LC_grade_assign_header {
1.705 tempelho 5787: font-weight: bold;
5788: font-size: large;
1.597 albertel 5789: }
1.795 www 5790:
1.597 albertel 5791: div.LC_grade_show_problem_problem,
5792: div.LC_grade_submissions_body,
5793: div.LC_grade_message_center_body,
5794: div.LC_grade_assign_body {
5795: border: 1px solid black;
5796: width: 99%;
5797: background: #FFFFFF;
5798: }
1.795 www 5799:
1.598 albertel 5800: span.LC_grade_check_note {
1.705 tempelho 5801: font-weight: normal;
5802: font-size: medium;
1.598 albertel 5803: display: inline;
5804: position: absolute;
5805: right: 1em;
5806: }
1.597 albertel 5807:
1.613 albertel 5808: table.LC_scantron_action {
5809: width: 100%;
5810: }
1.795 www 5811:
1.613 albertel 5812: table.LC_scantron_action tr th {
1.698 harmsja 5813: font-weight:bold;
5814: font-style:normal;
1.613 albertel 5815: }
1.795 www 5816:
1.779 bisitz 5817: .LC_edit_problem_header,
1.614 albertel 5818: div.LC_edit_problem_footer {
1.705 tempelho 5819: font-weight: normal;
5820: font-size: medium;
1.602 albertel 5821: margin: 2px;
1.600 albertel 5822: }
1.795 www 5823:
1.600 albertel 5824: div.LC_edit_problem_header,
1.602 albertel 5825: div.LC_edit_problem_header div,
1.614 albertel 5826: div.LC_edit_problem_footer,
5827: div.LC_edit_problem_footer div,
1.602 albertel 5828: div.LC_edit_problem_editxml_header,
5829: div.LC_edit_problem_editxml_header div {
1.600 albertel 5830: margin-top: 5px;
5831: }
1.795 www 5832:
1.600 albertel 5833: div.LC_edit_problem_header_title {
1.705 tempelho 5834: font-weight: bold;
5835: font-size: larger;
1.602 albertel 5836: background: $tabbg;
5837: padding: 3px;
5838: }
1.795 www 5839:
1.602 albertel 5840: table.LC_edit_problem_header_title {
1.705 tempelho 5841: font-size: larger;
5842: font-weight: bold;
1.602 albertel 5843: width: 100%;
5844: border-color: $pgbg;
5845: border-style: solid;
5846: border-width: $border;
1.600 albertel 5847: background: $tabbg;
1.602 albertel 5848: border-collapse: collapse;
1.803 bisitz 5849: padding: 0;
1.602 albertel 5850: }
5851:
5852: div.LC_edit_problem_discards {
5853: float: left;
5854: padding-bottom: 5px;
5855: }
1.795 www 5856:
1.602 albertel 5857: div.LC_edit_problem_saves {
5858: float: right;
5859: padding-bottom: 5px;
1.600 albertel 5860: }
1.795 www 5861:
1.911 bisitz 5862: img.stift {
1.803 bisitz 5863: border-width: 0;
5864: vertical-align: middle;
1.677 riegler 5865: }
1.680 riegler 5866:
1.923 bisitz 5867: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5868: vertical-align: top;
1.777 tempelho 5869: }
1.795 www 5870:
1.716 raeburn 5871: div.LC_createcourse {
1.911 bisitz 5872: margin: 10px 10px 10px 10px;
1.716 raeburn 5873: }
5874:
1.917 raeburn 5875: .LC_dccid {
5876: margin: 0.2em 0 0 0;
5877: padding: 0;
5878: font-size: 90%;
5879: display:none;
5880: }
5881:
1.693 droeschl 5882: /* ---- Remove when done ----
5883: # The following styles is part of the redesign of LON-CAPA and are
5884: # subject to change during this project.
5885: # Don't rely on their current functionality as they might be
5886: # changed or removed.
5887: # --------------------------*/
5888:
1.698 harmsja 5889: a:hover,
1.897 wenzelju 5890: ol.LC_primary_menu a:hover,
1.721 harmsja 5891: ol#LC_MenuBreadcrumbs a:hover,
5892: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5893: ul#LC_secondary_menu a:hover,
1.721 harmsja 5894: .LC_FormSectionClearButton input:hover
1.795 www 5895: ul.LC_TabContent li:hover a {
1.911 bisitz 5896: color:#BF2317;
5897: text-decoration:none;
1.693 droeschl 5898: }
5899:
1.779 bisitz 5900: h1 {
1.911 bisitz 5901: padding: 0;
5902: line-height:130%;
1.693 droeschl 5903: }
1.698 harmsja 5904:
1.911 bisitz 5905: h2,
5906: h3,
5907: h4,
5908: h5,
5909: h6 {
5910: margin: 5px 0 5px 0;
5911: padding: 0;
5912: line-height:130%;
1.693 droeschl 5913: }
1.795 www 5914:
5915: .LC_hcell {
1.911 bisitz 5916: padding:3px 15px 3px 15px;
5917: margin: 0;
5918: background-color:$tabbg;
5919: color:$fontmenu;
5920: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5921: }
1.795 www 5922:
1.840 bisitz 5923: .LC_Box > .LC_hcell {
1.911 bisitz 5924: margin: 0 -10px 10px -10px;
1.835 bisitz 5925: }
5926:
1.721 harmsja 5927: .LC_noBorder {
1.911 bisitz 5928: border: 0;
1.698 harmsja 5929: }
1.693 droeschl 5930:
1.721 harmsja 5931: .LC_FormSectionClearButton input {
1.911 bisitz 5932: background-color:transparent;
5933: border: none;
5934: cursor:pointer;
5935: text-decoration:underline;
1.693 droeschl 5936: }
1.763 bisitz 5937:
5938: .LC_help_open_topic {
1.911 bisitz 5939: color: #FFFFFF;
5940: background-color: #EEEEFF;
5941: margin: 1px;
5942: padding: 4px;
5943: border: 1px solid #000033;
5944: white-space: nowrap;
5945: /* vertical-align: middle; */
1.759 neumanie 5946: }
1.693 droeschl 5947:
1.911 bisitz 5948: dl,
5949: ul,
5950: div,
5951: fieldset {
5952: margin: 10px 10px 10px 0;
5953: /* overflow: hidden; */
1.693 droeschl 5954: }
1.795 www 5955:
1.838 bisitz 5956: fieldset > legend {
1.911 bisitz 5957: font-weight: bold;
5958: padding: 0 5px 0 5px;
1.838 bisitz 5959: }
5960:
1.813 bisitz 5961: #LC_nav_bar {
1.911 bisitz 5962: float: left;
5963: margin: 0.2em 0 0 0;
1.807 droeschl 5964: }
5965:
1.916 droeschl 5966: #LC_realm {
5967: margin: 0.2em 0 0 0;
5968: padding: 0;
5969: font-weight: bold;
5970: text-align: center;
5971: }
5972:
1.911 bisitz 5973: #LC_nav_bar em {
5974: font-weight: bold;
5975: font-style: normal;
1.807 droeschl 5976: }
5977:
1.897 wenzelju 5978: ol.LC_primary_menu {
1.911 bisitz 5979: float: right;
5980: margin: 0.2em 0 0 0;
1.807 droeschl 5981: }
5982:
1.852 droeschl 5983: ol#LC_PathBreadcrumbs {
1.911 bisitz 5984: margin: 0;
1.693 droeschl 5985: }
5986:
1.897 wenzelju 5987: ol.LC_primary_menu li {
1.911 bisitz 5988: display: inline;
5989: padding: 5px 5px 0 10px;
5990: vertical-align: top;
1.693 droeschl 5991: }
5992:
1.897 wenzelju 5993: ol.LC_primary_menu li img {
1.911 bisitz 5994: vertical-align: bottom;
1.693 droeschl 5995: }
5996:
1.897 wenzelju 5997: ol.LC_primary_menu a {
1.911 bisitz 5998: font-size: 90%;
5999: color: RGB(80, 80, 80);
6000: text-decoration: none;
1.693 droeschl 6001: }
1.795 www 6002:
1.897 wenzelju 6003: ul#LC_secondary_menu {
1.911 bisitz 6004: clear: both;
6005: color: $fontmenu;
6006: background: $tabbg;
6007: list-style: none;
6008: padding: 0;
6009: margin: 0;
6010: width: 100%;
1.808 droeschl 6011: }
6012:
1.897 wenzelju 6013: ul#LC_secondary_menu li {
1.911 bisitz 6014: font-weight: bold;
6015: line-height: 1.8em;
6016: padding: 0 0.8em;
6017: border-right: 1px solid black;
6018: display: inline;
6019: vertical-align: middle;
1.807 droeschl 6020: }
6021:
1.847 tempelho 6022: ul.LC_TabContent {
1.911 bisitz 6023: display:block;
6024: background: $sidebg;
6025: border-bottom: solid 1px $lg_border_color;
6026: list-style:none;
6027: margin: 0 -10px;
6028: padding: 0;
1.693 droeschl 6029: }
6030:
1.795 www 6031: ul.LC_TabContent li,
6032: ul.LC_TabContentBigger li {
1.911 bisitz 6033: float:left;
1.741 harmsja 6034: }
1.795 www 6035:
1.897 wenzelju 6036: ul#LC_secondary_menu li a {
1.911 bisitz 6037: color: $fontmenu;
6038: text-decoration: none;
1.693 droeschl 6039: }
1.795 www 6040:
1.721 harmsja 6041: ul.LC_TabContent {
1.911 bisitz 6042: min-height:1.5em;
1.721 harmsja 6043: }
1.795 www 6044:
6045: ul.LC_TabContent li {
1.911 bisitz 6046: vertical-align:middle;
6047: padding: 0 10px 0 10px;
6048: background-color:$tabbg;
6049: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6050: }
1.795 www 6051:
1.847 tempelho 6052: ul.LC_TabContent .right {
1.911 bisitz 6053: float:right;
1.847 tempelho 6054: }
6055:
1.911 bisitz 6056: ul.LC_TabContent li a,
6057: ul.LC_TabContent li {
6058: color:rgb(47,47,47);
6059: text-decoration:none;
6060: font-size:95%;
6061: font-weight:bold;
6062: padding-right: 16px;
1.721 harmsja 6063: }
1.795 www 6064:
1.911 bisitz 6065: ul.LC_TabContent li:hover,
6066: ul.LC_TabContent li.active {
6067: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6068: border-bottom:solid 2px #FFFFFF;
6069: padding-right: 16px;
1.744 ehlerst 6070: }
1.795 www 6071:
1.870 tempelho 6072: #maincoursedoc {
1.911 bisitz 6073: clear:both;
1.870 tempelho 6074: }
6075:
6076: ul.LC_TabContentBigger {
1.911 bisitz 6077: display:block;
6078: list-style:none;
6079: padding: 0;
1.870 tempelho 6080: }
6081:
1.795 www 6082: ul.LC_TabContentBigger li {
1.911 bisitz 6083: vertical-align:bottom;
6084: height: 30px;
6085: font-size:110%;
6086: font-weight:bold;
6087: color: #737373;
1.841 tempelho 6088: }
6089:
1.870 tempelho 6090:
6091: ul.LC_TabContentBigger li a {
1.911 bisitz 6092: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6093: height: 30px;
6094: line-height: 30px;
6095: text-align: center;
6096: display: block;
6097: text-decoration: none;
1.741 harmsja 6098: }
1.795 www 6099:
1.911 bisitz 6100: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6101: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6102: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6103: color:$font;
6104: text-decoration: underline;
1.744 ehlerst 6105: }
1.795 www 6106:
1.870 tempelho 6107:
6108: ul.LC_TabContentBigger li b {
1.911 bisitz 6109: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6110: display: block;
6111: float: left;
6112: padding: 0 30px;
1.870 tempelho 6113: }
6114:
6115: ul.LC_TabContentBigger li:hover b,
6116: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6117: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6118: color:$font;
6119: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6120: }
1.693 droeschl 6121:
1.870 tempelho 6122:
1.862 bisitz 6123: ul.LC_CourseBreadcrumbs {
6124: background: $sidebg;
6125: line-height: 32px;
6126: padding-left: 10px;
6127: margin: 0 0 10px 0;
6128: list-style-position: inside;
6129:
6130: }
6131:
1.911 bisitz 6132: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6133: ol#LC_PathBreadcrumbs {
1.911 bisitz 6134: padding-left: 10px;
6135: margin: 0;
6136: list-style-position: inside;
1.915 droeschl 6137: /* SD working here
1.904 droeschl 6138: white-space: nowrap; */
1.693 droeschl 6139: }
6140:
1.911 bisitz 6141: ol#LC_MenuBreadcrumbs li,
6142: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6143: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6144: display: inline;
6145: white-space: nowrap;
1.915 droeschl 6146: /* SD working here
6147: white-space: normal; */
1.693 droeschl 6148: }
6149:
1.823 bisitz 6150: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6151: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6152: text-decoration: none;
6153: font-size:90%;
1.693 droeschl 6154: }
1.795 www 6155:
6156: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6157: text-decoration:none;
6158: font-size:100%;
6159: font-weight:bold;
1.693 droeschl 6160: }
1.795 www 6161:
1.840 bisitz 6162: .LC_Box {
1.911 bisitz 6163: border: solid 1px $lg_border_color;
6164: padding: 0 10px 10px 10px;
1.746 neumanie 6165: }
1.795 www 6166:
6167: .LC_AboutMe_Image {
1.911 bisitz 6168: float:left;
6169: margin-right:10px;
1.747 neumanie 6170: }
1.795 www 6171:
6172: .LC_Clear_AboutMe_Image {
1.911 bisitz 6173: clear:left;
1.747 neumanie 6174: }
1.795 www 6175:
1.721 harmsja 6176: dl.LC_ListStyleClean dt {
1.911 bisitz 6177: padding-right: 5px;
6178: display: table-header-group;
1.693 droeschl 6179: }
6180:
1.721 harmsja 6181: dl.LC_ListStyleClean dd {
1.911 bisitz 6182: display: table-row;
1.693 droeschl 6183: }
6184:
1.721 harmsja 6185: .LC_ListStyleClean,
6186: .LC_ListStyleSimple,
6187: .LC_ListStyleNormal,
1.795 www 6188: .LC_ListStyleSpecial {
1.911 bisitz 6189: /* display:block; */
6190: list-style-position: inside;
6191: list-style-type: none;
6192: overflow: hidden;
6193: padding: 0;
1.693 droeschl 6194: }
6195:
1.721 harmsja 6196: .LC_ListStyleSimple li,
6197: .LC_ListStyleSimple dd,
6198: .LC_ListStyleNormal li,
6199: .LC_ListStyleNormal dd,
6200: .LC_ListStyleSpecial li,
1.795 www 6201: .LC_ListStyleSpecial dd {
1.911 bisitz 6202: margin: 0;
6203: padding: 5px 5px 5px 10px;
6204: clear: both;
1.693 droeschl 6205: }
6206:
1.721 harmsja 6207: .LC_ListStyleClean li,
6208: .LC_ListStyleClean dd {
1.911 bisitz 6209: padding-top: 0;
6210: padding-bottom: 0;
1.693 droeschl 6211: }
6212:
1.721 harmsja 6213: .LC_ListStyleSimple dd,
1.795 www 6214: .LC_ListStyleSimple li {
1.911 bisitz 6215: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6216: }
6217:
1.721 harmsja 6218: .LC_ListStyleSpecial li,
6219: .LC_ListStyleSpecial dd {
1.911 bisitz 6220: list-style-type: none;
6221: background-color: RGB(220, 220, 220);
6222: margin-bottom: 4px;
1.693 droeschl 6223: }
6224:
1.721 harmsja 6225: table.LC_SimpleTable {
1.911 bisitz 6226: margin:5px;
6227: border:solid 1px $lg_border_color;
1.795 www 6228: }
1.693 droeschl 6229:
1.721 harmsja 6230: table.LC_SimpleTable tr {
1.911 bisitz 6231: padding: 0;
6232: border:solid 1px $lg_border_color;
1.693 droeschl 6233: }
1.795 www 6234:
6235: table.LC_SimpleTable thead {
1.911 bisitz 6236: background:rgb(220,220,220);
1.693 droeschl 6237: }
6238:
1.721 harmsja 6239: div.LC_columnSection {
1.911 bisitz 6240: display: block;
6241: clear: both;
6242: overflow: hidden;
6243: margin: 0;
1.693 droeschl 6244: }
6245:
1.721 harmsja 6246: div.LC_columnSection>* {
1.911 bisitz 6247: float: left;
6248: margin: 10px 20px 10px 0;
6249: overflow:hidden;
1.693 droeschl 6250: }
1.721 harmsja 6251:
1.694 tempelho 6252: .LC_loginpage_container {
1.911 bisitz 6253: text-align:left;
6254: margin : 0 auto;
6255: width:90%;
6256: padding: 10px;
6257: height: auto;
6258: background-color:#FFFFFF;
6259: border:1px solid #CCCCCC;
1.694 tempelho 6260: }
6261:
6262:
6263: .LC_loginpage_loginContainer {
1.911 bisitz 6264: float:left;
6265: width: 182px;
6266: padding: 2px;
6267: border:1px solid #CCCCCC;
6268: background-color:$loginbg;
1.694 tempelho 6269: }
6270:
1.795 www 6271: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6272: margin-top: 0;
6273: display:block;
6274: background:$bgcol;
6275: color:$textcol;
6276: padding-left:5px;
1.712 muellerd 6277: }
1.785 tempelho 6278:
1.694 tempelho 6279: .LC_loginpage_loginInfo {
1.911 bisitz 6280: float:left;
6281: width:182px;
6282: border:1px solid #CCCCCC;
6283: padding:2px;
1.712 muellerd 6284: }
6285:
1.694 tempelho 6286: .LC_loginpage_space {
1.911 bisitz 6287: clear: both;
6288: margin-bottom: 20px;
6289: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6290: }
6291:
1.785 tempelho 6292: .LC_loginpage_floatLeft {
1.911 bisitz 6293: float: left;
6294: width: 200px;
6295: margin: 0;
1.785 tempelho 6296: }
6297:
1.795 www 6298: table em {
1.911 bisitz 6299: font-weight: bold;
6300: font-style: normal;
1.748 schulted 6301: }
1.795 www 6302:
1.779 bisitz 6303: table.LC_tableBrowseRes,
1.795 www 6304: table.LC_tableOfContent {
1.911 bisitz 6305: border:none;
6306: border-spacing: 1px;
6307: padding: 3px;
6308: background-color: #FFFFFF;
6309: font-size: 90%;
1.753 droeschl 6310: }
1.789 droeschl 6311:
1.911 bisitz 6312: table.LC_tableOfContent {
6313: border-collapse: collapse;
1.789 droeschl 6314: }
6315:
1.771 droeschl 6316: table.LC_tableBrowseRes a,
1.768 schulted 6317: table.LC_tableOfContent a {
1.911 bisitz 6318: background-color: transparent;
6319: text-decoration: none;
1.753 droeschl 6320: }
6321:
1.795 www 6322: table.LC_tableOfContent img {
1.911 bisitz 6323: border: none;
6324: height: 1.3em;
6325: vertical-align: text-bottom;
6326: margin-right: 0.3em;
1.753 droeschl 6327: }
1.757 schulted 6328:
1.795 www 6329: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6330: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6331: }
6332:
1.795 www 6333: a#LC_content_toolbar_launchnav {
1.911 bisitz 6334: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6335: }
6336:
1.795 www 6337: a#LC_content_toolbar_closenav {
1.911 bisitz 6338: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6339: }
6340:
1.795 www 6341: a#LC_content_toolbar_everything {
1.911 bisitz 6342: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6343: }
6344:
1.795 www 6345: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6346: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6347: }
6348:
1.795 www 6349: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6350: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6351: }
6352:
1.795 www 6353: a#LC_content_toolbar_changefolder {
1.911 bisitz 6354: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6355: }
6356:
1.795 www 6357: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6358: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6359: }
6360:
1.795 www 6361: ul#LC_toolbar li a:hover {
1.911 bisitz 6362: background-position: bottom center;
1.757 schulted 6363: }
6364:
1.795 www 6365: ul#LC_toolbar {
1.911 bisitz 6366: padding: 0;
6367: margin: 2px;
6368: list-style:none;
6369: position:relative;
6370: background-color:white;
1.757 schulted 6371: }
6372:
1.795 www 6373: ul#LC_toolbar li {
1.911 bisitz 6374: border:1px solid white;
6375: padding: 0;
6376: margin: 0;
6377: float: left;
6378: display:inline;
6379: vertical-align:middle;
6380: }
1.757 schulted 6381:
1.783 amueller 6382:
1.795 www 6383: a.LC_toolbarItem {
1.911 bisitz 6384: display:block;
6385: padding: 0;
6386: margin: 0;
6387: height: 32px;
6388: width: 32px;
6389: color:white;
6390: border: none;
6391: background-repeat:no-repeat;
6392: background-color:transparent;
1.757 schulted 6393: }
6394:
1.915 droeschl 6395: ul.LC_funclist {
6396: margin: 0;
6397: padding: 0.5em 1em 0.5em 0;
6398: }
6399:
6400: ul.LC_funclist + ul.LC_funclist {
6401: /*
6402: left border as a seperator if we have more than
6403: one list
6404: */
6405: border-left: 1px solid $sidebg;
6406: /*
6407: this hides the left border behind the border of the
6408: outer box if element is wrapped to the next 'line'
6409: */
6410: margin-left: -1px;
6411: }
6412:
1.843 bisitz 6413: ul.LC_funclist li {
1.915 droeschl 6414: display: inline;
1.782 bisitz 6415: white-space: nowrap;
1.915 droeschl 6416: margin: 0 0 0 25px;
6417: line-height: 150%;
1.782 bisitz 6418: }
6419:
1.757 schulted 6420:
1.343 albertel 6421: END
6422: }
6423:
1.306 albertel 6424: =pod
6425:
6426: =item * &headtag()
6427:
6428: Returns a uniform footer for LON-CAPA web pages.
6429:
1.307 albertel 6430: Inputs: $title - optional title for the head
6431: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6432: $args - optional arguments
1.319 albertel 6433: force_register - if is true call registerurl so the remote is
6434: informed
1.415 albertel 6435: redirect -> array ref of
6436: 1- seconds before redirect occurs
6437: 2- url to redirect to
6438: 3- whether the side effect should occur
1.315 albertel 6439: (side effect of setting
6440: $env{'internal.head.redirect'} to the url
6441: redirected too)
1.352 albertel 6442: domain -> force to color decorate a page for a specific
6443: domain
6444: function -> force usage of a specific rolish color scheme
6445: bgcolor -> override the default page bgcolor
1.460 albertel 6446: no_auto_mt_title
6447: -> prevent &mt()ing the title arg
1.464 albertel 6448:
1.306 albertel 6449: =cut
6450:
6451: sub headtag {
1.313 albertel 6452: my ($title,$head_extra,$args) = @_;
1.306 albertel 6453:
1.363 albertel 6454: my $function = $args->{'function'} || &get_users_function();
6455: my $domain = $args->{'domain'} || &determinedomain();
6456: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6457: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6458: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6459: #time(),
1.418 albertel 6460: $env{'environment.color.timestamp'},
1.363 albertel 6461: $function,$domain,$bgcolor);
6462:
1.369 www 6463: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6464:
1.308 albertel 6465: my $result =
6466: '<head>'.
1.461 albertel 6467: &font_settings();
1.319 albertel 6468:
1.461 albertel 6469: if (!$args->{'frameset'}) {
6470: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6471: }
1.319 albertel 6472: if ($args->{'force_register'}) {
6473: $result .= &Apache::lonmenu::registerurl(1);
6474: }
1.436 albertel 6475: if (!$args->{'no_nav_bar'}
6476: && !$args->{'only_body'}
6477: && !$args->{'frameset'}) {
6478: $result .= &help_menu_js();
6479: }
1.319 albertel 6480:
1.314 albertel 6481: if (ref($args->{'redirect'})) {
1.414 albertel 6482: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6483: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6484: if (!$inhibit_continue) {
6485: $env{'internal.head.redirect'} = $url;
6486: }
1.313 albertel 6487: $result.=<<ADDMETA
6488: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6489: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6490: ADDMETA
6491: }
1.306 albertel 6492: if (!defined($title)) {
6493: $title = 'The LearningOnline Network with CAPA';
6494: }
1.460 albertel 6495: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6496: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6497: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6498: .$head_extra;
1.306 albertel 6499: return $result;
6500: }
6501:
6502: =pod
6503:
1.340 albertel 6504: =item * &font_settings()
6505:
6506: Returns neccessary <meta> to set the proper encoding
6507:
6508: Inputs: none
6509:
6510: =cut
6511:
6512: sub font_settings {
6513: my $headerstring='';
1.647 www 6514: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6515: $headerstring.=
6516: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6517: }
6518: return $headerstring;
6519: }
6520:
1.341 albertel 6521: =pod
6522:
6523: =item * &xml_begin()
6524:
6525: Returns the needed doctype and <html>
6526:
6527: Inputs: none
6528:
6529: =cut
6530:
6531: sub xml_begin {
6532: my $output='';
6533:
1.592 albertel 6534: if ($env{'internal.start_page'}==1) {
6535: &Apache::lonhtmlcommon::init_htmlareafields();
6536: }
1.342 albertel 6537:
1.341 albertel 6538: if ($env{'browser.mathml'}) {
6539: $output='<?xml version="1.0"?>'
6540: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6541: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6542:
6543: # .'<!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">] >'
6544: .'<!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">'
6545: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6546: .'xmlns="http://www.w3.org/1999/xhtml">';
6547: } else {
1.849 bisitz 6548: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6549: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6550: }
6551: return $output;
6552: }
1.340 albertel 6553:
6554: =pod
6555:
1.306 albertel 6556: =item * &endheadtag()
6557:
6558: Returns a uniform </head> for LON-CAPA web pages.
6559:
6560: Inputs: none
6561:
6562: =cut
6563:
6564: sub endheadtag {
6565: return '</head>';
6566: }
6567:
6568: =pod
6569:
6570: =item * &head()
6571:
6572: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6573:
1.648 raeburn 6574: Inputs:
6575:
6576: =over 4
6577:
6578: $title - optional title for the page
6579:
6580: $head_extra - optional extra HTML to put inside the <head>
6581:
6582: =back
1.405 albertel 6583:
1.306 albertel 6584: =cut
6585:
6586: sub head {
1.325 albertel 6587: my ($title,$head_extra,$args) = @_;
6588: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6589: }
6590:
6591: =pod
6592:
6593: =item * &start_page()
6594:
6595: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6596:
1.648 raeburn 6597: Inputs:
6598:
6599: =over 4
6600:
6601: $title - optional title for the page
6602:
6603: $head_extra - optional extra HTML to incude inside the <head>
6604:
6605: $args - additional optional args supported are:
6606:
6607: =over 8
6608:
6609: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6610: arg on
1.814 bisitz 6611: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6612: add_entries -> additional attributes to add to the <body>
6613: domain -> force to color decorate a page for a
1.317 albertel 6614: specific domain
1.648 raeburn 6615: function -> force usage of a specific rolish color
1.317 albertel 6616: scheme
1.648 raeburn 6617: redirect -> see &headtag()
6618: bgcolor -> override the default page bg color
6619: js_ready -> return a string ready for being used in
1.317 albertel 6620: a javascript writeln
1.648 raeburn 6621: html_encode -> return a string ready for being used in
1.320 albertel 6622: a html attribute
1.648 raeburn 6623: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6624: $forcereg arg
1.648 raeburn 6625: frameset -> if true will start with a <frameset>
1.330 albertel 6626: rather than <body>
1.648 raeburn 6627: skip_phases -> hash ref of
1.338 albertel 6628: head -> skip the <html><head> generation
6629: body -> skip all <body> generation
1.648 raeburn 6630: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6631: 'Switch To Inline Menu' link
1.648 raeburn 6632: no_auto_mt_title -> prevent &mt()ing the title arg
6633: inherit_jsmath -> when creating popup window in a page,
6634: should it have jsmath forced on by the
6635: current page
1.867 kalberla 6636: bread_crumbs -> Array containing breadcrumbs
6637: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6638:
1.648 raeburn 6639: =back
1.460 albertel 6640:
1.648 raeburn 6641: =back
1.562 albertel 6642:
1.306 albertel 6643: =cut
6644:
6645: sub start_page {
1.309 albertel 6646: my ($title,$head_extra,$args) = @_;
1.318 albertel 6647: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6648: my %head_args;
1.352 albertel 6649: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6650: 'bgcolor','frameset','no_nav_bar','only_body',
6651: 'no_auto_mt_title') {
1.319 albertel 6652: if (defined($args->{$arg})) {
1.324 raeburn 6653: $head_args{$arg} = $args->{$arg};
1.319 albertel 6654: }
1.313 albertel 6655: }
1.319 albertel 6656:
1.315 albertel 6657: $env{'internal.start_page'}++;
1.338 albertel 6658: my $result;
6659: if (! exists($args->{'skip_phases'}{'head'}) ) {
6660: $result.=
1.341 albertel 6661: &xml_begin().
1.338 albertel 6662: &headtag($title,$head_extra,\%head_args).&endheadtag();
6663: }
6664:
6665: if (! exists($args->{'skip_phases'}{'body'}) ) {
6666: if ($args->{'frameset'}) {
6667: my $attr_string = &make_attr_string($args->{'force_register'},
6668: $args->{'add_entries'});
6669: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6670: } else {
6671: $result .=
6672: &bodytag($title,
6673: $args->{'function'}, $args->{'add_entries'},
6674: $args->{'only_body'}, $args->{'domain'},
6675: $args->{'force_register'}, $args->{'no_nav_bar'},
6676: $args->{'bgcolor'}, $args->{'no_inline_link'},
6677: $args);
6678: }
1.330 albertel 6679: }
1.338 albertel 6680:
1.315 albertel 6681: if ($args->{'js_ready'}) {
1.713 kaisler 6682: $result = &js_ready($result);
1.315 albertel 6683: }
1.320 albertel 6684: if ($args->{'html_encode'}) {
1.713 kaisler 6685: $result = &html_encode($result);
6686: }
6687:
1.813 bisitz 6688: # Preparation for new and consistent functionlist at top of screen
6689: # if ($args->{'functionlist'}) {
6690: # $result .= &build_functionlist();
6691: #}
6692:
6693: # Don't add anything more if only_body wanted
6694: return $result if $args->{'only_body'};
6695:
1.920 raeburn 6696: #Breadcrumbs for Construction Space provided by &bodytag.
6697: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6698: return $result;
6699: }
6700:
1.813 bisitz 6701: #Breadcrumbs
1.758 kaisler 6702: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6703: &Apache::lonhtmlcommon::clear_breadcrumbs();
6704: #if any br links exists, add them to the breadcrumbs
6705: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6706: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6707: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6708: }
6709: }
6710:
6711: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6712: if(exists($args->{'bread_crumbs_component'})){
6713: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6714: }else{
6715: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6716: }
1.320 albertel 6717: }
1.315 albertel 6718: return $result;
1.306 albertel 6719: }
6720:
1.330 albertel 6721:
1.306 albertel 6722: =pod
6723:
6724: =item * &head()
6725:
6726: Returns a complete </body></html> section for LON-CAPA web pages.
6727:
1.315 albertel 6728: Inputs: $args - additional optional args supported are:
6729: js_ready -> return a string ready for being used in
6730: a javascript writeln
1.320 albertel 6731: html_encode -> return a string ready for being used in
6732: a html attribute
1.330 albertel 6733: frameset -> if true will start with a <frameset>
6734: rather than <body>
1.493 albertel 6735: dicsussion -> if true will get discussion from
6736: lonxml::xmlend
6737: (you can pass the target and parser arguments
6738: through optional 'target' and 'parser' args
6739: to this routine)
1.306 albertel 6740:
6741: =cut
6742:
6743: sub end_page {
1.315 albertel 6744: my ($args) = @_;
6745: $env{'internal.end_page'}++;
1.330 albertel 6746: my $result;
1.335 albertel 6747: if ($args->{'discussion'}) {
6748: my ($target,$parser);
6749: if (ref($args->{'discussion'})) {
6750: ($target,$parser) =($args->{'discussion'}{'target'},
6751: $args->{'discussion'}{'parser'});
6752: }
6753: $result .= &Apache::lonxml::xmlend($target,$parser);
6754: }
6755:
1.330 albertel 6756: if ($args->{'frameset'}) {
6757: $result .= '</frameset>';
6758: } else {
1.635 raeburn 6759: $result .= &endbodytag($args);
1.330 albertel 6760: }
6761: $result .= "\n</html>";
6762:
1.315 albertel 6763: if ($args->{'js_ready'}) {
1.317 albertel 6764: $result = &js_ready($result);
1.315 albertel 6765: }
1.335 albertel 6766:
1.320 albertel 6767: if ($args->{'html_encode'}) {
6768: $result = &html_encode($result);
6769: }
1.335 albertel 6770:
1.315 albertel 6771: return $result;
6772: }
6773:
1.320 albertel 6774: sub html_encode {
6775: my ($result) = @_;
6776:
1.322 albertel 6777: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6778:
6779: return $result;
6780: }
1.317 albertel 6781: sub js_ready {
6782: my ($result) = @_;
6783:
1.323 albertel 6784: $result =~ s/[\n\r]/ /xmsg;
6785: $result =~ s/\\/\\\\/xmsg;
6786: $result =~ s/'/\\'/xmsg;
1.372 albertel 6787: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6788:
6789: return $result;
6790: }
6791:
1.315 albertel 6792: sub validate_page {
6793: if ( exists($env{'internal.start_page'})
1.316 albertel 6794: && $env{'internal.start_page'} > 1) {
6795: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6796: $env{'internal.start_page'}.' '.
1.316 albertel 6797: $ENV{'request.filename'});
1.315 albertel 6798: }
6799: if ( exists($env{'internal.end_page'})
1.316 albertel 6800: && $env{'internal.end_page'} > 1) {
6801: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6802: $env{'internal.end_page'}.' '.
1.316 albertel 6803: $env{'request.filename'});
1.315 albertel 6804: }
6805: if ( exists($env{'internal.start_page'})
6806: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6807: &Apache::lonnet::logthis('start_page called without end_page '.
6808: $env{'request.filename'});
1.315 albertel 6809: }
6810: if ( ! exists($env{'internal.start_page'})
6811: && exists($env{'internal.end_page'})) {
1.316 albertel 6812: &Apache::lonnet::logthis('end_page called without start_page'.
6813: $env{'request.filename'});
1.315 albertel 6814: }
1.306 albertel 6815: }
1.315 albertel 6816:
1.318 albertel 6817: sub simple_error_page {
6818: my ($r,$title,$msg) = @_;
6819: my $page =
6820: &Apache::loncommon::start_page($title).
6821: &mt($msg).
6822: &Apache::loncommon::end_page();
6823: if (ref($r)) {
6824: $r->print($page);
1.327 albertel 6825: return;
1.318 albertel 6826: }
6827: return $page;
6828: }
1.347 albertel 6829:
6830: {
1.610 albertel 6831: my @row_count;
1.347 albertel 6832: sub start_data_table {
1.422 albertel 6833: my ($add_class) = @_;
6834: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6835: unshift(@row_count,0);
1.422 albertel 6836: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6837: }
6838:
6839: sub end_data_table {
1.610 albertel 6840: shift(@row_count);
1.389 albertel 6841: return '</table>'."\n";;
1.347 albertel 6842: }
6843:
6844: sub start_data_table_row {
1.422 albertel 6845: my ($add_class) = @_;
1.610 albertel 6846: $row_count[0]++;
6847: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6848: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6849: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6850: }
1.471 banghart 6851:
6852: sub continue_data_table_row {
6853: my ($add_class) = @_;
1.610 albertel 6854: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6855: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6856: return '<tr class="'.$css_class.'">'."\n";;
6857: }
1.347 albertel 6858:
6859: sub end_data_table_row {
1.389 albertel 6860: return '</tr>'."\n";;
1.347 albertel 6861: }
1.367 www 6862:
1.421 albertel 6863: sub start_data_table_empty_row {
1.707 bisitz 6864: # $row_count[0]++;
1.421 albertel 6865: return '<tr class="LC_empty_row" >'."\n";;
6866: }
6867:
6868: sub end_data_table_empty_row {
6869: return '</tr>'."\n";;
6870: }
6871:
1.367 www 6872: sub start_data_table_header_row {
1.389 albertel 6873: return '<tr class="LC_header_row">'."\n";;
1.367 www 6874: }
6875:
6876: sub end_data_table_header_row {
1.389 albertel 6877: return '</tr>'."\n";;
1.367 www 6878: }
1.890 droeschl 6879:
6880: sub data_table_caption {
6881: my $caption = shift;
6882: return "<caption class=\"LC_caption\">$caption</caption>";
6883: }
1.347 albertel 6884: }
6885:
1.548 albertel 6886: =pod
6887:
6888: =item * &inhibit_menu_check($arg)
6889:
6890: Checks for a inhibitmenu state and generates output to preserve it
6891:
6892: Inputs: $arg - can be any of
6893: - undef - in which case the return value is a string
6894: to add into arguments list of a uri
6895: - 'input' - in which case the return value is a HTML
6896: <form> <input> field of type hidden to
6897: preserve the value
6898: - a url - in which case the return value is the url with
6899: the neccesary cgi args added to preserve the
6900: inhibitmenu state
6901: - a ref to a url - no return value, but the string is
6902: updated to include the neccessary cgi
6903: args to preserve the inhibitmenu state
6904:
6905: =cut
6906:
6907: sub inhibit_menu_check {
6908: my ($arg) = @_;
6909: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6910: if ($arg eq 'input') {
6911: if ($env{'form.inhibitmenu'}) {
6912: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6913: } else {
6914: return
6915: }
6916: }
6917: if ($env{'form.inhibitmenu'}) {
6918: if (ref($arg)) {
6919: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6920: } elsif ($arg eq '') {
6921: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6922: } else {
6923: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6924: }
6925: }
6926: if (!ref($arg)) {
6927: return $arg;
6928: }
6929: }
6930:
1.251 albertel 6931: ###############################################
1.182 matthew 6932:
6933: =pod
6934:
1.549 albertel 6935: =back
6936:
6937: =head1 User Information Routines
6938:
6939: =over 4
6940:
1.405 albertel 6941: =item * &get_users_function()
1.182 matthew 6942:
6943: Used by &bodytag to determine the current users primary role.
6944: Returns either 'student','coordinator','admin', or 'author'.
6945:
6946: =cut
6947:
6948: ###############################################
6949: sub get_users_function {
1.815 tempelho 6950: my $function = 'norole';
1.818 tempelho 6951: if ($env{'request.role'}=~/^(st)/) {
6952: $function='student';
6953: }
1.907 raeburn 6954: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6955: $function='coordinator';
6956: }
1.258 albertel 6957: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6958: $function='admin';
6959: }
1.826 bisitz 6960: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6961: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6962: $function='author';
6963: }
6964: return $function;
1.54 www 6965: }
1.99 www 6966:
6967: ###############################################
6968:
1.233 raeburn 6969: =pod
6970:
1.821 raeburn 6971: =item * &show_course()
6972:
6973: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6974: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6975:
6976: Inputs:
6977: None
6978:
6979: Outputs:
6980: Scalar: 1 if 'Course' to be used, 0 otherwise.
6981:
6982: =cut
6983:
6984: ###############################################
6985: sub show_course {
6986: my $course = !$env{'user.adv'};
6987: if (!$env{'user.adv'}) {
6988: foreach my $env (keys(%env)) {
6989: next if ($env !~ m/^user\.priv\./);
6990: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
6991: $course = 0;
6992: last;
6993: }
6994: }
6995: }
6996: return $course;
6997: }
6998:
6999: ###############################################
7000:
7001: =pod
7002:
1.542 raeburn 7003: =item * &check_user_status()
1.274 raeburn 7004:
7005: Determines current status of supplied role for a
7006: specific user. Roles can be active, previous or future.
7007:
7008: Inputs:
7009: user's domain, user's username, course's domain,
1.375 raeburn 7010: course's number, optional section ID.
1.274 raeburn 7011:
7012: Outputs:
7013: role status: active, previous or future.
7014:
7015: =cut
7016:
7017: sub check_user_status {
1.412 raeburn 7018: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7019: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7020: my @uroles = keys %userinfo;
7021: my $srchstr;
7022: my $active_chk = 'none';
1.412 raeburn 7023: my $now = time;
1.274 raeburn 7024: if (@uroles > 0) {
1.908 raeburn 7025: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7026: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7027: } else {
1.412 raeburn 7028: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7029: }
7030: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7031: my $role_end = 0;
7032: my $role_start = 0;
7033: $active_chk = 'active';
1.412 raeburn 7034: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7035: $role_end = $1;
7036: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7037: $role_start = $1;
1.274 raeburn 7038: }
7039: }
7040: if ($role_start > 0) {
1.412 raeburn 7041: if ($now < $role_start) {
1.274 raeburn 7042: $active_chk = 'future';
7043: }
7044: }
7045: if ($role_end > 0) {
1.412 raeburn 7046: if ($now > $role_end) {
1.274 raeburn 7047: $active_chk = 'previous';
7048: }
7049: }
7050: }
7051: }
7052: return $active_chk;
7053: }
7054:
7055: ###############################################
7056:
7057: =pod
7058:
1.405 albertel 7059: =item * &get_sections()
1.233 raeburn 7060:
7061: Determines all the sections for a course including
7062: sections with students and sections containing other roles.
1.419 raeburn 7063: Incoming parameters:
7064:
7065: 1. domain
7066: 2. course number
7067: 3. reference to array containing roles for which sections should
7068: be gathered (optional).
7069: 4. reference to array containing status types for which sections
7070: should be gathered (optional).
7071:
7072: If the third argument is undefined, sections are gathered for any role.
7073: If the fourth argument is undefined, sections are gathered for any status.
7074: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7075:
1.374 raeburn 7076: Returns section hash (keys are section IDs, values are
7077: number of users in each section), subject to the
1.419 raeburn 7078: optional roles filter, optional status filter
1.233 raeburn 7079:
7080: =cut
7081:
7082: ###############################################
7083: sub get_sections {
1.419 raeburn 7084: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7085: if (!defined($cdom) || !defined($cnum)) {
7086: my $cid = $env{'request.course.id'};
7087:
7088: return if (!defined($cid));
7089:
7090: $cdom = $env{'course.'.$cid.'.domain'};
7091: $cnum = $env{'course.'.$cid.'.num'};
7092: }
7093:
7094: my %sectioncount;
1.419 raeburn 7095: my $now = time;
1.240 albertel 7096:
1.366 albertel 7097: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7098: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7099: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7100: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7101: my $start_index = &Apache::loncoursedata::CL_START();
7102: my $end_index = &Apache::loncoursedata::CL_END();
7103: my $status;
1.366 albertel 7104: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7105: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7106: $data->[$status_index],
7107: $data->[$start_index],
7108: $data->[$end_index]);
7109: if ($stu_status eq 'Active') {
7110: $status = 'active';
7111: } elsif ($end < $now) {
7112: $status = 'previous';
7113: } elsif ($start > $now) {
7114: $status = 'future';
7115: }
7116: if ($section ne '-1' && $section !~ /^\s*$/) {
7117: if ((!defined($possible_status)) || (($status ne '') &&
7118: (grep/^\Q$status\E$/,@{$possible_status}))) {
7119: $sectioncount{$section}++;
7120: }
1.240 albertel 7121: }
7122: }
7123: }
7124: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7125: foreach my $user (sort(keys(%courseroles))) {
7126: if ($user !~ /^(\w{2})/) { next; }
7127: my ($role) = ($user =~ /^(\w{2})/);
7128: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7129: my ($section,$status);
1.240 albertel 7130: if ($role eq 'cr' &&
7131: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7132: $section=$1;
7133: }
7134: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7135: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7136: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7137: if ($end == -1 && $start == -1) {
7138: next; #deleted role
7139: }
7140: if (!defined($possible_status)) {
7141: $sectioncount{$section}++;
7142: } else {
7143: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7144: $status = 'active';
7145: } elsif ($end < $now) {
7146: $status = 'future';
7147: } elsif ($start > $now) {
7148: $status = 'previous';
7149: }
7150: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7151: $sectioncount{$section}++;
7152: }
7153: }
1.233 raeburn 7154: }
1.366 albertel 7155: return %sectioncount;
1.233 raeburn 7156: }
7157:
1.274 raeburn 7158: ###############################################
1.294 raeburn 7159:
7160: =pod
1.405 albertel 7161:
7162: =item * &get_course_users()
7163:
1.275 raeburn 7164: Retrieves usernames:domains for users in the specified course
7165: with specific role(s), and access status.
7166:
7167: Incoming parameters:
1.277 albertel 7168: 1. course domain
7169: 2. course number
7170: 3. access status: users must have - either active,
1.275 raeburn 7171: previous, future, or all.
1.277 albertel 7172: 4. reference to array of permissible roles
1.288 raeburn 7173: 5. reference to array of section restrictions (optional)
7174: 6. reference to results object (hash of hashes).
7175: 7. reference to optional userdata hash
1.609 raeburn 7176: 8. reference to optional statushash
1.630 raeburn 7177: 9. flag if privileged users (except those set to unhide in
7178: course settings) should be excluded
1.609 raeburn 7179: Keys of top level results hash are roles.
1.275 raeburn 7180: Keys of inner hashes are username:domain, with
7181: values set to access type.
1.288 raeburn 7182: Optional userdata hash returns an array with arguments in the
7183: same order as loncoursedata::get_classlist() for student data.
7184:
1.609 raeburn 7185: Optional statushash returns
7186:
1.288 raeburn 7187: Entries for end, start, section and status are blank because
7188: of the possibility of multiple values for non-student roles.
7189:
1.275 raeburn 7190: =cut
1.405 albertel 7191:
1.275 raeburn 7192: ###############################################
1.405 albertel 7193:
1.275 raeburn 7194: sub get_course_users {
1.630 raeburn 7195: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7196: my %idx = ();
1.419 raeburn 7197: my %seclists;
1.288 raeburn 7198:
7199: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7200: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7201: $idx{end} = &Apache::loncoursedata::CL_END();
7202: $idx{start} = &Apache::loncoursedata::CL_START();
7203: $idx{id} = &Apache::loncoursedata::CL_ID();
7204: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7205: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7206: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7207:
1.290 albertel 7208: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7209: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7210: my $now = time;
1.277 albertel 7211: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7212: my $match = 0;
1.412 raeburn 7213: my $secmatch = 0;
1.419 raeburn 7214: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7215: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7216: if ($section eq '') {
7217: $section = 'none';
7218: }
1.291 albertel 7219: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7220: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7221: $secmatch = 1;
7222: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7223: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7224: $secmatch = 1;
7225: }
7226: } else {
1.419 raeburn 7227: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7228: $secmatch = 1;
7229: }
1.290 albertel 7230: }
1.412 raeburn 7231: if (!$secmatch) {
7232: next;
7233: }
1.419 raeburn 7234: }
1.275 raeburn 7235: if (defined($$types{'active'})) {
1.288 raeburn 7236: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7237: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7238: $match = 1;
1.275 raeburn 7239: }
7240: }
7241: if (defined($$types{'previous'})) {
1.609 raeburn 7242: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7243: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7244: $match = 1;
1.275 raeburn 7245: }
7246: }
7247: if (defined($$types{'future'})) {
1.609 raeburn 7248: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7249: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7250: $match = 1;
1.275 raeburn 7251: }
7252: }
1.609 raeburn 7253: if ($match) {
7254: push(@{$seclists{$student}},$section);
7255: if (ref($userdata) eq 'HASH') {
7256: $$userdata{$student} = $$classlist{$student};
7257: }
7258: if (ref($statushash) eq 'HASH') {
7259: $statushash->{$student}{'st'}{$section} = $status;
7260: }
1.288 raeburn 7261: }
1.275 raeburn 7262: }
7263: }
1.412 raeburn 7264: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7265: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7266: my $now = time;
1.609 raeburn 7267: my %displaystatus = ( previous => 'Expired',
7268: active => 'Active',
7269: future => 'Future',
7270: );
1.630 raeburn 7271: my %nothide;
7272: if ($hidepriv) {
7273: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7274: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7275: if ($user !~ /:/) {
7276: $nothide{join(':',split(/[\@]/,$user))}=1;
7277: } else {
7278: $nothide{$user} = 1;
7279: }
7280: }
7281: }
1.439 raeburn 7282: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7283: my $match = 0;
1.412 raeburn 7284: my $secmatch = 0;
1.439 raeburn 7285: my $status;
1.412 raeburn 7286: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7287: $user =~ s/:$//;
1.439 raeburn 7288: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7289: if ($end == -1 || $start == -1) {
7290: next;
7291: }
7292: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7293: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7294: my ($uname,$udom) = split(/:/,$user);
7295: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7296: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7297: $secmatch = 1;
7298: } elsif ($usec eq '') {
1.420 albertel 7299: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7300: $secmatch = 1;
7301: }
7302: } else {
7303: if (grep(/^\Q$usec\E$/,@{$sections})) {
7304: $secmatch = 1;
7305: }
7306: }
7307: if (!$secmatch) {
7308: next;
7309: }
1.288 raeburn 7310: }
1.419 raeburn 7311: if ($usec eq '') {
7312: $usec = 'none';
7313: }
1.275 raeburn 7314: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7315: if ($hidepriv) {
7316: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7317: (!$nothide{$uname.':'.$udom})) {
7318: next;
7319: }
7320: }
1.503 raeburn 7321: if ($end > 0 && $end < $now) {
1.439 raeburn 7322: $status = 'previous';
7323: } elsif ($start > $now) {
7324: $status = 'future';
7325: } else {
7326: $status = 'active';
7327: }
1.277 albertel 7328: foreach my $type (keys(%{$types})) {
1.275 raeburn 7329: if ($status eq $type) {
1.420 albertel 7330: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7331: push(@{$$users{$role}{$user}},$type);
7332: }
1.288 raeburn 7333: $match = 1;
7334: }
7335: }
1.419 raeburn 7336: if (($match) && (ref($userdata) eq 'HASH')) {
7337: if (!exists($$userdata{$uname.':'.$udom})) {
7338: &get_user_info($udom,$uname,\%idx,$userdata);
7339: }
1.420 albertel 7340: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7341: push(@{$seclists{$uname.':'.$udom}},$usec);
7342: }
1.609 raeburn 7343: if (ref($statushash) eq 'HASH') {
7344: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7345: }
1.275 raeburn 7346: }
7347: }
7348: }
7349: }
1.290 albertel 7350: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7351: if ((defined($cdom)) && (defined($cnum))) {
7352: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7353: if ( defined($csettings{'internal.courseowner'}) ) {
7354: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7355: next if ($owner eq '');
7356: my ($ownername,$ownerdom);
7357: if ($owner =~ /^([^:]+):([^:]+)$/) {
7358: $ownername = $1;
7359: $ownerdom = $2;
7360: } else {
7361: $ownername = $owner;
7362: $ownerdom = $cdom;
7363: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7364: }
7365: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7366: if (defined($userdata) &&
1.609 raeburn 7367: !exists($$userdata{$owner})) {
7368: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7369: if (!grep(/^none$/,@{$seclists{$owner}})) {
7370: push(@{$seclists{$owner}},'none');
7371: }
7372: if (ref($statushash) eq 'HASH') {
7373: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7374: }
1.290 albertel 7375: }
1.279 raeburn 7376: }
7377: }
7378: }
1.419 raeburn 7379: foreach my $user (keys(%seclists)) {
7380: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7381: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7382: }
1.275 raeburn 7383: }
7384: return;
7385: }
7386:
1.288 raeburn 7387: sub get_user_info {
7388: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7389: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7390: &plainname($uname,$udom,'lastname');
1.291 albertel 7391: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7392: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7393: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7394: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7395: return;
7396: }
1.275 raeburn 7397:
1.472 raeburn 7398: ###############################################
7399:
7400: =pod
7401:
7402: =item * &get_user_quota()
7403:
7404: Retrieves quota assigned for storage of portfolio files for a user
7405:
7406: Incoming parameters:
7407: 1. user's username
7408: 2. user's domain
7409:
7410: Returns:
1.536 raeburn 7411: 1. Disk quota (in Mb) assigned to student.
7412: 2. (Optional) Type of setting: custom or default
7413: (individually assigned or default for user's
7414: institutional status).
7415: 3. (Optional) - User's institutional status (e.g., faculty, staff
7416: or student - types as defined in localenroll::inst_usertypes
7417: for user's domain, which determines default quota for user.
7418: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7419:
7420: If a value has been stored in the user's environment,
1.536 raeburn 7421: it will return that, otherwise it returns the maximal default
7422: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7423:
7424: =cut
7425:
7426: ###############################################
7427:
7428:
7429: sub get_user_quota {
7430: my ($uname,$udom) = @_;
1.536 raeburn 7431: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7432: if (!defined($udom)) {
7433: $udom = $env{'user.domain'};
7434: }
7435: if (!defined($uname)) {
7436: $uname = $env{'user.name'};
7437: }
7438: if (($udom eq '' || $uname eq '') ||
7439: ($udom eq 'public') && ($uname eq 'public')) {
7440: $quota = 0;
1.536 raeburn 7441: $quotatype = 'default';
7442: $defquota = 0;
1.472 raeburn 7443: } else {
1.536 raeburn 7444: my $inststatus;
1.472 raeburn 7445: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7446: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7447: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7448: } else {
1.536 raeburn 7449: my %userenv =
7450: &Apache::lonnet::get('environment',['portfolioquota',
7451: 'inststatus'],$udom,$uname);
1.472 raeburn 7452: my ($tmp) = keys(%userenv);
7453: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7454: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7455: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7456: } else {
7457: undef(%userenv);
7458: }
7459: }
1.536 raeburn 7460: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7461: if ($quota eq '') {
1.536 raeburn 7462: $quota = $defquota;
7463: $quotatype = 'default';
7464: } else {
7465: $quotatype = 'custom';
1.472 raeburn 7466: }
7467: }
1.536 raeburn 7468: if (wantarray) {
7469: return ($quota,$quotatype,$settingstatus,$defquota);
7470: } else {
7471: return $quota;
7472: }
1.472 raeburn 7473: }
7474:
7475: ###############################################
7476:
7477: =pod
7478:
7479: =item * &default_quota()
7480:
1.536 raeburn 7481: Retrieves default quota assigned for storage of user portfolio files,
7482: given an (optional) user's institutional status.
1.472 raeburn 7483:
7484: Incoming parameters:
7485: 1. domain
1.536 raeburn 7486: 2. (Optional) institutional status(es). This is a : separated list of
7487: status types (e.g., faculty, staff, student etc.)
7488: which apply to the user for whom the default is being retrieved.
7489: If the institutional status string in undefined, the domain
7490: default quota will be returned.
1.472 raeburn 7491:
7492: Returns:
7493: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7494: 2. (Optional) institutional type which determined the value of the
7495: default quota.
1.472 raeburn 7496:
7497: If a value has been stored in the domain's configuration db,
7498: it will return that, otherwise it returns 20 (for backwards
7499: compatibility with domains which have not set up a configuration
7500: db file; the original statically defined portfolio quota was 20 Mb).
7501:
1.536 raeburn 7502: If the user's status includes multiple types (e.g., staff and student),
7503: the largest default quota which applies to the user determines the
7504: default quota returned.
7505:
1.780 raeburn 7506: =back
7507:
1.472 raeburn 7508: =cut
7509:
7510: ###############################################
7511:
7512:
7513: sub default_quota {
1.536 raeburn 7514: my ($udom,$inststatus) = @_;
7515: my ($defquota,$settingstatus);
7516: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7517: ['quotas'],$udom);
7518: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7519: if ($inststatus ne '') {
1.765 raeburn 7520: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7521: foreach my $item (@statuses) {
1.711 raeburn 7522: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7523: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7524: if ($defquota eq '') {
7525: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7526: $settingstatus = $item;
7527: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7528: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7529: $settingstatus = $item;
7530: }
7531: }
7532: } else {
7533: if ($quotahash{'quotas'}{$item} ne '') {
7534: if ($defquota eq '') {
7535: $defquota = $quotahash{'quotas'}{$item};
7536: $settingstatus = $item;
7537: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7538: $defquota = $quotahash{'quotas'}{$item};
7539: $settingstatus = $item;
7540: }
1.536 raeburn 7541: }
7542: }
7543: }
7544: }
7545: if ($defquota eq '') {
1.711 raeburn 7546: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7547: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7548: } else {
7549: $defquota = $quotahash{'quotas'}{'default'};
7550: }
1.536 raeburn 7551: $settingstatus = 'default';
7552: }
7553: } else {
7554: $settingstatus = 'default';
7555: $defquota = 20;
7556: }
7557: if (wantarray) {
7558: return ($defquota,$settingstatus);
1.472 raeburn 7559: } else {
1.536 raeburn 7560: return $defquota;
1.472 raeburn 7561: }
7562: }
7563:
1.384 raeburn 7564: sub get_secgrprole_info {
7565: my ($cdom,$cnum,$needroles,$type) = @_;
7566: my %sections_count = &get_sections($cdom,$cnum);
7567: my @sections = (sort {$a <=> $b} keys(%sections_count));
7568: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7569: my @groups = sort(keys(%curr_groups));
7570: my $allroles = [];
7571: my $rolehash;
7572: my $accesshash = {
7573: active => 'Currently has access',
7574: future => 'Will have future access',
7575: previous => 'Previously had access',
7576: };
7577: if ($needroles) {
7578: $rolehash = {'all' => 'all'};
1.385 albertel 7579: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7580: if (&Apache::lonnet::error(%user_roles)) {
7581: undef(%user_roles);
7582: }
7583: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7584: my ($role)=split(/\:/,$item,2);
7585: if ($role eq 'cr') { next; }
7586: if ($role =~ /^cr/) {
7587: $$rolehash{$role} = (split('/',$role))[3];
7588: } else {
7589: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7590: }
7591: }
7592: foreach my $key (sort(keys(%{$rolehash}))) {
7593: push(@{$allroles},$key);
7594: }
7595: push (@{$allroles},'st');
7596: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7597: }
7598: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7599: }
7600:
1.555 raeburn 7601: sub user_picker {
1.627 raeburn 7602: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7603: my $currdom = $dom;
7604: my %curr_selected = (
7605: srchin => 'dom',
1.580 raeburn 7606: srchby => 'lastname',
1.555 raeburn 7607: );
7608: my $srchterm;
1.625 raeburn 7609: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7610: if ($srch->{'srchby'} ne '') {
7611: $curr_selected{'srchby'} = $srch->{'srchby'};
7612: }
7613: if ($srch->{'srchin'} ne '') {
7614: $curr_selected{'srchin'} = $srch->{'srchin'};
7615: }
7616: if ($srch->{'srchtype'} ne '') {
7617: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7618: }
7619: if ($srch->{'srchdomain'} ne '') {
7620: $currdom = $srch->{'srchdomain'};
7621: }
7622: $srchterm = $srch->{'srchterm'};
7623: }
7624: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7625: 'usr' => 'Search criteria',
1.563 raeburn 7626: 'doma' => 'Domain/institution to search',
1.558 albertel 7627: 'uname' => 'username',
7628: 'lastname' => 'last name',
1.555 raeburn 7629: 'lastfirst' => 'last name, first name',
1.558 albertel 7630: 'crs' => 'in this course',
1.576 raeburn 7631: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7632: 'alc' => 'all LON-CAPA',
1.573 raeburn 7633: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7634: 'exact' => 'is',
7635: 'contains' => 'contains',
1.569 raeburn 7636: 'begins' => 'begins with',
1.571 raeburn 7637: 'youm' => "You must include some text to search for.",
7638: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7639: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7640: 'yomc' => "You must choose a domain when using an institutional directory search.",
7641: 'ymcd' => "You must choose a domain when using a domain search.",
7642: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7643: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7644: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7645: );
1.563 raeburn 7646: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7647: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7648:
7649: my @srchins = ('crs','dom','alc','instd');
7650:
7651: foreach my $option (@srchins) {
7652: # FIXME 'alc' option unavailable until
7653: # loncreateuser::print_user_query_page()
7654: # has been completed.
7655: next if ($option eq 'alc');
1.880 raeburn 7656: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7657: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7658: if ($curr_selected{'srchin'} eq $option) {
7659: $srchinsel .= '
7660: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7661: } else {
7662: $srchinsel .= '
7663: <option value="'.$option.'">'.$lt{$option}.'</option>';
7664: }
1.555 raeburn 7665: }
1.563 raeburn 7666: $srchinsel .= "\n </select>\n";
1.555 raeburn 7667:
7668: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7669: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7670: if ($curr_selected{'srchby'} eq $option) {
7671: $srchbysel .= '
7672: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7673: } else {
7674: $srchbysel .= '
7675: <option value="'.$option.'">'.$lt{$option}.'</option>';
7676: }
7677: }
7678: $srchbysel .= "\n </select>\n";
7679:
7680: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7681: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7682: if ($curr_selected{'srchtype'} eq $option) {
7683: $srchtypesel .= '
7684: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7685: } else {
7686: $srchtypesel .= '
7687: <option value="'.$option.'">'.$lt{$option}.'</option>';
7688: }
7689: }
7690: $srchtypesel .= "\n </select>\n";
7691:
1.558 albertel 7692: my ($newuserscript,$new_user_create);
1.556 raeburn 7693:
7694: if ($forcenewuser) {
1.576 raeburn 7695: if (ref($srch) eq 'HASH') {
7696: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7697: if ($cancreate) {
7698: $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>';
7699: } else {
1.799 bisitz 7700: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7701: my %usertypetext = (
7702: official => 'institutional',
7703: unofficial => 'non-institutional',
7704: );
1.799 bisitz 7705: $new_user_create = '<p class="LC_warning">'
7706: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7707: .' '
7708: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7709: ,'<a href="'.$helplink.'">','</a>')
7710: .'</p><br />';
1.627 raeburn 7711: }
1.576 raeburn 7712: }
7713: }
7714:
1.556 raeburn 7715: $newuserscript = <<"ENDSCRIPT";
7716:
1.570 raeburn 7717: function setSearch(createnew,callingForm) {
1.556 raeburn 7718: if (createnew == 1) {
1.570 raeburn 7719: for (var i=0; i<callingForm.srchby.length; i++) {
7720: if (callingForm.srchby.options[i].value == 'uname') {
7721: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7722: }
7723: }
1.570 raeburn 7724: for (var i=0; i<callingForm.srchin.length; i++) {
7725: if ( callingForm.srchin.options[i].value == 'dom') {
7726: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7727: }
7728: }
1.570 raeburn 7729: for (var i=0; i<callingForm.srchtype.length; i++) {
7730: if (callingForm.srchtype.options[i].value == 'exact') {
7731: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7732: }
7733: }
1.570 raeburn 7734: for (var i=0; i<callingForm.srchdomain.length; i++) {
7735: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7736: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7737: }
7738: }
7739: }
7740: }
7741: ENDSCRIPT
1.558 albertel 7742:
1.556 raeburn 7743: }
7744:
1.555 raeburn 7745: my $output = <<"END_BLOCK";
1.556 raeburn 7746: <script type="text/javascript">
1.824 bisitz 7747: // <![CDATA[
1.570 raeburn 7748: function validateEntry(callingForm) {
1.558 albertel 7749:
1.556 raeburn 7750: var checkok = 1;
1.558 albertel 7751: var srchin;
1.570 raeburn 7752: for (var i=0; i<callingForm.srchin.length; i++) {
7753: if ( callingForm.srchin[i].checked ) {
7754: srchin = callingForm.srchin[i].value;
1.558 albertel 7755: }
7756: }
7757:
1.570 raeburn 7758: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7759: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7760: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7761: var srchterm = callingForm.srchterm.value;
7762: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7763: var msg = "";
7764:
7765: if (srchterm == "") {
7766: checkok = 0;
1.571 raeburn 7767: msg += "$lt{'youm'}\\n";
1.556 raeburn 7768: }
7769:
1.569 raeburn 7770: if (srchtype== 'begins') {
7771: if (srchterm.length < 2) {
7772: checkok = 0;
1.571 raeburn 7773: msg += "$lt{'thte'}\\n";
1.569 raeburn 7774: }
7775: }
7776:
1.556 raeburn 7777: if (srchtype== 'contains') {
7778: if (srchterm.length < 3) {
7779: checkok = 0;
1.571 raeburn 7780: msg += "$lt{'thet'}\\n";
1.556 raeburn 7781: }
7782: }
7783: if (srchin == 'instd') {
7784: if (srchdomain == '') {
7785: checkok = 0;
1.571 raeburn 7786: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7787: }
7788: }
7789: if (srchin == 'dom') {
7790: if (srchdomain == '') {
7791: checkok = 0;
1.571 raeburn 7792: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7793: }
7794: }
7795: if (srchby == 'lastfirst') {
7796: if (srchterm.indexOf(",") == -1) {
7797: checkok = 0;
1.571 raeburn 7798: msg += "$lt{'whus'}\\n";
1.556 raeburn 7799: }
7800: if (srchterm.indexOf(",") == srchterm.length -1) {
7801: checkok = 0;
1.571 raeburn 7802: msg += "$lt{'whse'}\\n";
1.556 raeburn 7803: }
7804: }
7805: if (checkok == 0) {
1.571 raeburn 7806: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7807: return;
7808: }
7809: if (checkok == 1) {
1.570 raeburn 7810: callingForm.submit();
1.556 raeburn 7811: }
7812: }
7813:
7814: $newuserscript
7815:
1.824 bisitz 7816: // ]]>
1.556 raeburn 7817: </script>
1.558 albertel 7818:
7819: $new_user_create
7820:
1.555 raeburn 7821: END_BLOCK
1.558 albertel 7822:
1.876 raeburn 7823: $output .= &Apache::lonhtmlcommon::start_pick_box().
7824: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7825: $domform.
7826: &Apache::lonhtmlcommon::row_closure().
7827: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7828: $srchbysel.
7829: $srchtypesel.
7830: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7831: $srchinsel.
7832: &Apache::lonhtmlcommon::row_closure(1).
7833: &Apache::lonhtmlcommon::end_pick_box().
7834: '<br />';
1.555 raeburn 7835: return $output;
7836: }
7837:
1.612 raeburn 7838: sub user_rule_check {
1.615 raeburn 7839: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7840: my $response;
7841: if (ref($usershash) eq 'HASH') {
7842: foreach my $user (keys(%{$usershash})) {
7843: my ($uname,$udom) = split(/:/,$user);
7844: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7845: my ($id,$newuser);
1.612 raeburn 7846: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7847: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7848: $id = $usershash->{$user}->{'id'};
7849: }
7850: my $inst_response;
7851: if (ref($checks) eq 'HASH') {
7852: if (defined($checks->{'username'})) {
1.615 raeburn 7853: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7854: &Apache::lonnet::get_instuser($udom,$uname);
7855: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7856: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7857: &Apache::lonnet::get_instuser($udom,undef,$id);
7858: }
1.615 raeburn 7859: } else {
7860: ($inst_response,%{$inst_results->{$user}}) =
7861: &Apache::lonnet::get_instuser($udom,$uname);
7862: return;
1.612 raeburn 7863: }
1.615 raeburn 7864: if (!$got_rules->{$udom}) {
1.612 raeburn 7865: my %domconfig = &Apache::lonnet::get_dom('configuration',
7866: ['usercreation'],$udom);
7867: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7868: foreach my $item ('username','id') {
1.612 raeburn 7869: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7870: $$curr_rules{$udom}{$item} =
7871: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7872: }
7873: }
7874: }
1.615 raeburn 7875: $got_rules->{$udom} = 1;
1.585 raeburn 7876: }
1.612 raeburn 7877: foreach my $item (keys(%{$checks})) {
7878: if (ref($$curr_rules{$udom}) eq 'HASH') {
7879: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7880: if (@{$$curr_rules{$udom}{$item}} > 0) {
7881: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7882: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7883: if ($rule_check{$rule}) {
7884: $$rulematch{$user}{$item} = $rule;
7885: if ($inst_response eq 'ok') {
1.615 raeburn 7886: if (ref($inst_results) eq 'HASH') {
7887: if (ref($inst_results->{$user}) eq 'HASH') {
7888: if (keys(%{$inst_results->{$user}}) == 0) {
7889: $$alerts{$item}{$udom}{$uname} = 1;
7890: }
1.612 raeburn 7891: }
7892: }
1.615 raeburn 7893: }
7894: last;
1.585 raeburn 7895: }
7896: }
7897: }
7898: }
7899: }
7900: }
7901: }
7902: }
1.612 raeburn 7903: return;
7904: }
7905:
7906: sub user_rule_formats {
7907: my ($domain,$domdesc,$curr_rules,$check) = @_;
7908: my %text = (
7909: 'username' => 'Usernames',
7910: 'id' => 'IDs',
7911: );
7912: my $output;
7913: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7914: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7915: if (@{$ruleorder} > 0) {
7916: $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>';
7917: foreach my $rule (@{$ruleorder}) {
7918: if (ref($curr_rules) eq 'ARRAY') {
7919: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7920: if (ref($rules->{$rule}) eq 'HASH') {
7921: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7922: $rules->{$rule}{'desc'}.'</li>';
7923: }
7924: }
7925: }
7926: }
7927: $output .= '</ul>';
7928: }
7929: }
7930: return $output;
7931: }
7932:
7933: sub instrule_disallow_msg {
1.615 raeburn 7934: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7935: my $response;
7936: my %text = (
7937: item => 'username',
7938: items => 'usernames',
7939: match => 'matches',
7940: do => 'does',
7941: action => 'a username',
7942: one => 'one',
7943: );
7944: if ($count > 1) {
7945: $text{'item'} = 'usernames';
7946: $text{'match'} ='match';
7947: $text{'do'} = 'do';
7948: $text{'action'} = 'usernames',
7949: $text{'one'} = 'ones';
7950: }
7951: if ($checkitem eq 'id') {
7952: $text{'items'} = 'IDs';
7953: $text{'item'} = 'ID';
7954: $text{'action'} = 'an ID';
1.615 raeburn 7955: if ($count > 1) {
7956: $text{'item'} = 'IDs';
7957: $text{'action'} = 'IDs';
7958: }
1.612 raeburn 7959: }
1.674 bisitz 7960: $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 7961: if ($mode eq 'upload') {
7962: if ($checkitem eq 'username') {
7963: $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'}.");
7964: } elsif ($checkitem eq 'id') {
1.674 bisitz 7965: $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 7966: }
1.669 raeburn 7967: } elsif ($mode eq 'selfcreate') {
7968: if ($checkitem eq 'id') {
7969: $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.");
7970: }
1.615 raeburn 7971: } else {
7972: if ($checkitem eq 'username') {
7973: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7974: } elsif ($checkitem eq 'id') {
7975: $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.");
7976: }
1.612 raeburn 7977: }
7978: return $response;
1.585 raeburn 7979: }
7980:
1.624 raeburn 7981: sub personal_data_fieldtitles {
7982: my %fieldtitles = &Apache::lonlocal::texthash (
7983: id => 'Student/Employee ID',
7984: permanentemail => 'E-mail address',
7985: lastname => 'Last Name',
7986: firstname => 'First Name',
7987: middlename => 'Middle Name',
7988: generation => 'Generation',
7989: gen => 'Generation',
1.765 raeburn 7990: inststatus => 'Affiliation',
1.624 raeburn 7991: );
7992: return %fieldtitles;
7993: }
7994:
1.642 raeburn 7995: sub sorted_inst_types {
7996: my ($dom) = @_;
7997: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7998: my $othertitle = &mt('All users');
7999: if ($env{'request.course.id'}) {
1.668 raeburn 8000: $othertitle = &mt('Any users');
1.642 raeburn 8001: }
8002: my @types;
8003: if (ref($order) eq 'ARRAY') {
8004: @types = @{$order};
8005: }
8006: if (@types == 0) {
8007: if (ref($usertypes) eq 'HASH') {
8008: @types = sort(keys(%{$usertypes}));
8009: }
8010: }
8011: if (keys(%{$usertypes}) > 0) {
8012: $othertitle = &mt('Other users');
8013: }
8014: return ($othertitle,$usertypes,\@types);
8015: }
8016:
1.645 raeburn 8017: sub get_institutional_codes {
8018: my ($settings,$allcourses,$LC_code) = @_;
8019: # Get complete list of course sections to update
8020: my @currsections = ();
8021: my @currxlists = ();
8022: my $coursecode = $$settings{'internal.coursecode'};
8023:
8024: if ($$settings{'internal.sectionnums'} ne '') {
8025: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8026: }
8027:
8028: if ($$settings{'internal.crosslistings'} ne '') {
8029: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8030: }
8031:
8032: if (@currxlists > 0) {
8033: foreach (@currxlists) {
8034: if (m/^([^:]+):(\w*)$/) {
8035: unless (grep/^$1$/,@{$allcourses}) {
8036: push @{$allcourses},$1;
8037: $$LC_code{$1} = $2;
8038: }
8039: }
8040: }
8041: }
8042:
8043: if (@currsections > 0) {
8044: foreach (@currsections) {
8045: if (m/^(\w+):(\w*)$/) {
8046: my $sec = $coursecode.$1;
8047: my $lc_sec = $2;
8048: unless (grep/^$sec$/,@{$allcourses}) {
8049: push @{$allcourses},$sec;
8050: $$LC_code{$sec} = $lc_sec;
8051: }
8052: }
8053: }
8054: }
8055: return;
8056: }
8057:
1.112 bowersj2 8058: =pod
8059:
1.780 raeburn 8060: =head1 Slot Helpers
8061:
8062: =over 4
8063:
8064: =item * sorted_slots()
8065:
8066: Sorts an array of slot names in order of slot start time (earliest first).
8067:
8068: Inputs:
8069:
8070: =over 4
8071:
8072: slotsarr - Reference to array of unsorted slot names.
8073:
8074: slots - Reference to hash of hash, where outer hash keys are slot names.
8075:
1.549 albertel 8076: =back
8077:
1.780 raeburn 8078: Returns:
8079:
8080: =over 4
8081:
8082: sorted - An array of slot names sorted by the start time of the slot.
8083:
8084: =back
8085:
8086: =back
8087:
8088: =cut
8089:
8090:
8091: sub sorted_slots {
8092: my ($slotsarr,$slots) = @_;
8093: my @sorted;
8094: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8095: @sorted =
8096: sort {
8097: if (ref($slots->{$a}) && ref($slots->{$b})) {
8098: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8099: }
8100: if (ref($slots->{$a})) { return -1;}
8101: if (ref($slots->{$b})) { return 1;}
8102: return 0;
8103: } @{$slotsarr};
8104: }
8105: return @sorted;
8106: }
8107:
8108:
8109: =pod
8110:
1.549 albertel 8111: =head1 HTTP Helpers
8112:
8113: =over 4
8114:
1.648 raeburn 8115: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8116:
1.258 albertel 8117: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8118: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8119: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8120:
8121: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8122: $possible_names is an ref to an array of form element names. As an example:
8123: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8124: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8125:
8126: =cut
1.1 albertel 8127:
1.6 albertel 8128: sub get_unprocessed_cgi {
1.25 albertel 8129: my ($query,$possible_names)= @_;
1.26 matthew 8130: # $Apache::lonxml::debug=1;
1.356 albertel 8131: foreach my $pair (split(/&/,$query)) {
8132: my ($name, $value) = split(/=/,$pair);
1.369 www 8133: $name = &unescape($name);
1.25 albertel 8134: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8135: $value =~ tr/+/ /;
8136: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8137: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8138: }
1.16 harris41 8139: }
1.6 albertel 8140: }
8141:
1.112 bowersj2 8142: =pod
8143:
1.648 raeburn 8144: =item * &cacheheader()
1.112 bowersj2 8145:
8146: returns cache-controlling header code
8147:
8148: =cut
8149:
1.7 albertel 8150: sub cacheheader {
1.258 albertel 8151: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8152: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8153: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8154: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8155: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8156: return $output;
1.7 albertel 8157: }
8158:
1.112 bowersj2 8159: =pod
8160:
1.648 raeburn 8161: =item * &no_cache($r)
1.112 bowersj2 8162:
8163: specifies header code to not have cache
8164:
8165: =cut
8166:
1.9 albertel 8167: sub no_cache {
1.216 albertel 8168: my ($r) = @_;
8169: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8170: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8171: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8172: $r->no_cache(1);
8173: $r->header_out("Expires" => $date);
8174: $r->header_out("Pragma" => "no-cache");
1.123 www 8175: }
8176:
8177: sub content_type {
1.181 albertel 8178: my ($r,$type,$charset) = @_;
1.299 foxr 8179: if ($r) {
8180: # Note that printout.pl calls this with undef for $r.
8181: &no_cache($r);
8182: }
1.258 albertel 8183: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8184: unless ($charset) {
8185: $charset=&Apache::lonlocal::current_encoding;
8186: }
8187: if ($charset) { $type.='; charset='.$charset; }
8188: if ($r) {
8189: $r->content_type($type);
8190: } else {
8191: print("Content-type: $type\n\n");
8192: }
1.9 albertel 8193: }
1.25 albertel 8194:
1.112 bowersj2 8195: =pod
8196:
1.648 raeburn 8197: =item * &add_to_env($name,$value)
1.112 bowersj2 8198:
1.258 albertel 8199: adds $name to the %env hash with value
1.112 bowersj2 8200: $value, if $name already exists, the entry is converted to an array
8201: reference and $value is added to the array.
8202:
8203: =cut
8204:
1.25 albertel 8205: sub add_to_env {
8206: my ($name,$value)=@_;
1.258 albertel 8207: if (defined($env{$name})) {
8208: if (ref($env{$name})) {
1.25 albertel 8209: #already have multiple values
1.258 albertel 8210: push(@{ $env{$name} },$value);
1.25 albertel 8211: } else {
8212: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8213: my $first=$env{$name};
8214: undef($env{$name});
8215: push(@{ $env{$name} },$first,$value);
1.25 albertel 8216: }
8217: } else {
1.258 albertel 8218: $env{$name}=$value;
1.25 albertel 8219: }
1.31 albertel 8220: }
1.149 albertel 8221:
8222: =pod
8223:
1.648 raeburn 8224: =item * &get_env_multiple($name)
1.149 albertel 8225:
1.258 albertel 8226: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8227: values may be defined and end up as an array ref.
8228:
8229: returns an array of values
8230:
8231: =cut
8232:
8233: sub get_env_multiple {
8234: my ($name) = @_;
8235: my @values;
1.258 albertel 8236: if (defined($env{$name})) {
1.149 albertel 8237: # exists is it an array
1.258 albertel 8238: if (ref($env{$name})) {
8239: @values=@{ $env{$name} };
1.149 albertel 8240: } else {
1.258 albertel 8241: $values[0]=$env{$name};
1.149 albertel 8242: }
8243: }
8244: return(@values);
8245: }
8246:
1.660 raeburn 8247: sub ask_for_embedded_content {
8248: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8249: my $upload_output = '
8250: <form name="upload_embedded" action="'.$actionurl.'"
8251: method="post" enctype="multipart/form-data">';
8252: $upload_output .= $state;
1.661 raeburn 8253: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8254:
8255: my $num = 0;
8256: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8257: $upload_output .= &start_data_table_row().
8258: '<td>'.$embed_file.'</td><td>';
8259: if ($args->{'ignore_remote_references'}
8260: && $embed_file =~ m{^\w+://}) {
8261: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8262: } elsif ($args->{'error_on_invalid_names'}
8263: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8264:
8265: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8266:
8267: } else {
8268: $upload_output .='
1.661 raeburn 8269: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8270: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8271: my $attrib = join(':',@{$$allfiles{$embed_file}});
8272: $upload_output .=
8273: "\n\t\t".
8274: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8275: $attrib.'" />';
8276: if (exists($$codebase{$embed_file})) {
8277: $upload_output .=
8278: "\n\t\t".
8279: '<input name="codebase_'.$num.'" type="hidden" value="'.
8280: &escape($$codebase{$embed_file}).'" />';
8281: }
8282: }
8283: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8284: $num++;
8285: }
8286: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8287: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8288: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8289: '.&mt('(only files for which a location has been provided will be uploaded)').'
8290: </form>';
8291: return $upload_output;
8292: }
8293:
1.661 raeburn 8294: sub upload_embedded {
8295: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8296: $current_disk_usage) = @_;
8297: my $output;
8298: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8299: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8300: my $orig_uploaded_filename =
8301: $env{'form.embedded_item_'.$i.'.filename'};
8302:
8303: $env{'form.embedded_orig_'.$i} =
8304: &unescape($env{'form.embedded_orig_'.$i});
8305: my ($path,$fname) =
8306: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8307: # no path, whole string is fname
8308: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8309:
8310: $path = $env{'form.currentpath'}.$path;
8311: $fname = &Apache::lonnet::clean_filename($fname);
8312: # See if there is anything left
8313: next if ($fname eq '');
8314:
8315: # Check if file already exists as a file or directory.
8316: my ($state,$msg);
8317: if ($context eq 'portfolio') {
8318: my $port_path = $dirpath;
8319: if ($group ne '') {
8320: $port_path = "groups/$group/$port_path";
8321: }
8322: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8323: $dir_root,$port_path,$disk_quota,
8324: $current_disk_usage,$uname,$udom);
8325: if ($state eq 'will_exceed_quota'
8326: || $state eq 'file_locked'
8327: || $state eq 'file_exists' ) {
8328: $output .= $msg;
8329: next;
8330: }
8331: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8332: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8333: if ($state eq 'exists') {
8334: $output .= $msg;
8335: next;
8336: }
8337: }
8338: # Check if extension is valid
8339: if (($fname =~ /\.(\w+)$/) &&
8340: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8341: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8342: next;
8343: } elsif (($fname =~ /\.(\w+)$/) &&
8344: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8345: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8346: next;
8347: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8348: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8349: next;
8350: }
8351:
8352: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8353: if ($context eq 'portfolio') {
8354: my $result=
8355: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8356: $dirpath.$path);
8357: if ($result !~ m|^/uploaded/|) {
8358: $output .= '<span class="LC_error">'
8359: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8360: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8361: .'</span><br />';
8362: next;
8363: } else {
8364: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8365: $path.$fname.'</span>').'</p>';
8366: }
8367: } else {
8368: # Save the file
8369: my $target = $env{'form.embedded_item_'.$i};
8370: my $fullpath = $dir_root.$dirpath.'/'.$path;
8371: my $dest = $fullpath.$fname;
8372: my $url = $url_root.$dirpath.'/'.$path.$fname;
8373: my @parts=split(/\//,$fullpath);
8374: my $count;
8375: my $filepath = $dir_root;
8376: for ($count=4;$count<=$#parts;$count++) {
8377: $filepath .= "/$parts[$count]";
8378: if ((-e $filepath)!=1) {
8379: mkdir($filepath,0770);
8380: }
8381: }
8382: my $fh;
8383: if (!open($fh,'>'.$dest)) {
8384: &Apache::lonnet::logthis('Failed to create '.$dest);
8385: $output .= '<span class="LC_error">'.
8386: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8387: '</span><br />';
8388: } else {
8389: if (!print $fh $env{'form.embedded_item_'.$i}) {
8390: &Apache::lonnet::logthis('Failed to write to '.$dest);
8391: $output .= '<span class="LC_error">'.
8392: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8393: '</span><br />';
8394: } else {
8395: if ($context eq 'testbank') {
8396: $output .= &mt('Embedded file uploaded successfully:').
8397: ' <a href="'.$url.'">'.
8398: $orig_uploaded_filename.'</a><br />';
8399: } else {
1.705 tempelho 8400: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8401: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8402: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8403: }
8404: }
8405: close($fh);
8406: }
8407: }
8408: }
8409: return $output;
8410: }
8411:
8412: sub check_for_existing {
8413: my ($path,$fname,$element) = @_;
8414: my ($state,$msg);
8415: if (-d $path.'/'.$fname) {
8416: $state = 'exists';
8417: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8418: } elsif (-e $path.'/'.$fname) {
8419: $state = 'exists';
8420: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8421: }
8422: if ($state eq 'exists') {
8423: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8424: }
8425: return ($state,$msg);
8426: }
8427:
8428: sub check_for_upload {
8429: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8430: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8431: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8432: my $getpropath = 1;
8433: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8434: $getpropath);
8435: my $found_file = 0;
8436: my $locked_file = 0;
8437: foreach my $line (@dir_list) {
8438: my ($file_name)=split(/\&/,$line,2);
8439: if ($file_name eq $fname){
8440: $file_name = $path.$file_name;
8441: if ($group ne '') {
8442: $file_name = $group.$file_name;
8443: }
8444: $found_file = 1;
8445: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8446: $locked_file = 1;
8447: }
8448: }
8449: }
8450: if (($current_disk_usage + $filesize) > $disk_quota){
8451: my $msg = '<span class="LC_error">'.
8452: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8453: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8454: return ('will_exceed_quota',$msg);
8455: } elsif ($found_file) {
8456: if ($locked_file) {
8457: my $msg = '<span class="LC_error">';
8458: $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>');
8459: $msg .= '</span><br />';
8460: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8461: return ('file_locked',$msg);
8462: } else {
8463: my $msg = '<span class="LC_error">';
8464: $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'});
8465: $msg .= '</span>';
8466: $msg .= '<br />';
8467: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8468: return ('file_exists',$msg);
8469: }
8470: }
8471: }
8472:
1.31 albertel 8473:
1.41 ng 8474: =pod
1.45 matthew 8475:
1.464 albertel 8476: =back
1.41 ng 8477:
1.112 bowersj2 8478: =head1 CSV Upload/Handling functions
1.38 albertel 8479:
1.41 ng 8480: =over 4
8481:
1.648 raeburn 8482: =item * &upfile_store($r)
1.41 ng 8483:
8484: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8485: needs $env{'form.upfile'}
1.41 ng 8486: returns $datatoken to be put into hidden field
8487:
8488: =cut
1.31 albertel 8489:
8490: sub upfile_store {
8491: my $r=shift;
1.258 albertel 8492: $env{'form.upfile'}=~s/\r/\n/gs;
8493: $env{'form.upfile'}=~s/\f/\n/gs;
8494: $env{'form.upfile'}=~s/\n+/\n/gs;
8495: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8496:
1.258 albertel 8497: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8498: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8499: {
1.158 raeburn 8500: my $datafile = $r->dir_config('lonDaemons').
8501: '/tmp/'.$datatoken.'.tmp';
8502: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8503: print $fh $env{'form.upfile'};
1.158 raeburn 8504: close($fh);
8505: }
1.31 albertel 8506: }
8507: return $datatoken;
8508: }
8509:
1.56 matthew 8510: =pod
8511:
1.648 raeburn 8512: =item * &load_tmp_file($r)
1.41 ng 8513:
8514: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8515: needs $env{'form.datatoken'},
8516: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8517:
8518: =cut
1.31 albertel 8519:
8520: sub load_tmp_file {
8521: my $r=shift;
8522: my @studentdata=();
8523: {
1.158 raeburn 8524: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8525: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8526: if ( open(my $fh,"<$studentfile") ) {
8527: @studentdata=<$fh>;
8528: close($fh);
8529: }
1.31 albertel 8530: }
1.258 albertel 8531: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8532: }
8533:
1.56 matthew 8534: =pod
8535:
1.648 raeburn 8536: =item * &upfile_record_sep()
1.41 ng 8537:
8538: Separate uploaded file into records
8539: returns array of records,
1.258 albertel 8540: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8541:
8542: =cut
1.31 albertel 8543:
8544: sub upfile_record_sep {
1.258 albertel 8545: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8546: } else {
1.248 albertel 8547: my @records;
1.258 albertel 8548: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8549: if ($line=~/^\s*$/) { next; }
8550: push(@records,$line);
8551: }
8552: return @records;
1.31 albertel 8553: }
8554: }
8555:
1.56 matthew 8556: =pod
8557:
1.648 raeburn 8558: =item * &record_sep($record)
1.41 ng 8559:
1.258 albertel 8560: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8561:
8562: =cut
8563:
1.263 www 8564: sub takeleft {
8565: my $index=shift;
8566: return substr('0000'.$index,-4,4);
8567: }
8568:
1.31 albertel 8569: sub record_sep {
8570: my $record=shift;
8571: my %components=();
1.258 albertel 8572: if ($env{'form.upfiletype'} eq 'xml') {
8573: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8574: my $i=0;
1.356 albertel 8575: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8576: $field=~s/^(\"|\')//;
8577: $field=~s/(\"|\')$//;
1.263 www 8578: $components{&takeleft($i)}=$field;
1.31 albertel 8579: $i++;
8580: }
1.258 albertel 8581: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8582: my $i=0;
1.356 albertel 8583: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8584: $field=~s/^(\"|\')//;
8585: $field=~s/(\"|\')$//;
1.263 www 8586: $components{&takeleft($i)}=$field;
1.31 albertel 8587: $i++;
8588: }
8589: } else {
1.561 www 8590: my $separator=',';
1.480 banghart 8591: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8592: $separator=';';
1.480 banghart 8593: }
1.31 albertel 8594: my $i=0;
1.561 www 8595: # the character we are looking for to indicate the end of a quote or a record
8596: my $looking_for=$separator;
8597: # do not add the characters to the fields
8598: my $ignore=0;
8599: # we just encountered a separator (or the beginning of the record)
8600: my $just_found_separator=1;
8601: # store the field we are working on here
8602: my $field='';
8603: # work our way through all characters in record
8604: foreach my $character ($record=~/(.)/g) {
8605: if ($character eq $looking_for) {
8606: if ($character ne $separator) {
8607: # Found the end of a quote, again looking for separator
8608: $looking_for=$separator;
8609: $ignore=1;
8610: } else {
8611: # Found a separator, store away what we got
8612: $components{&takeleft($i)}=$field;
8613: $i++;
8614: $just_found_separator=1;
8615: $ignore=0;
8616: $field='';
8617: }
8618: next;
8619: }
8620: # single or double quotation marks after a separator indicate beginning of a quote
8621: # we are now looking for the end of the quote and need to ignore separators
8622: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8623: $looking_for=$character;
8624: next;
8625: }
8626: # ignore would be true after we reached the end of a quote
8627: if ($ignore) { next; }
8628: if (($just_found_separator) && ($character=~/\s/)) { next; }
8629: $field.=$character;
8630: $just_found_separator=0;
1.31 albertel 8631: }
1.561 www 8632: # catch the very last entry, since we never encountered the separator
8633: $components{&takeleft($i)}=$field;
1.31 albertel 8634: }
8635: return %components;
8636: }
8637:
1.144 matthew 8638: ######################################################
8639: ######################################################
8640:
1.56 matthew 8641: =pod
8642:
1.648 raeburn 8643: =item * &upfile_select_html()
1.41 ng 8644:
1.144 matthew 8645: Return HTML code to select a file from the users machine and specify
8646: the file type.
1.41 ng 8647:
8648: =cut
8649:
1.144 matthew 8650: ######################################################
8651: ######################################################
1.31 albertel 8652: sub upfile_select_html {
1.144 matthew 8653: my %Types = (
8654: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8655: semisv => &mt('Semicolon separated values'),
1.144 matthew 8656: space => &mt('Space separated'),
8657: tab => &mt('Tabulator separated'),
8658: # xml => &mt('HTML/XML'),
8659: );
8660: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8661: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8662: foreach my $type (sort(keys(%Types))) {
8663: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8664: }
8665: $Str .= "</select>\n";
8666: return $Str;
1.31 albertel 8667: }
8668:
1.301 albertel 8669: sub get_samples {
8670: my ($records,$toget) = @_;
8671: my @samples=({});
8672: my $got=0;
8673: foreach my $rec (@$records) {
8674: my %temp = &record_sep($rec);
8675: if (! grep(/\S/, values(%temp))) { next; }
8676: if (%temp) {
8677: $samples[$got]=\%temp;
8678: $got++;
8679: if ($got == $toget) { last; }
8680: }
8681: }
8682: return \@samples;
8683: }
8684:
1.144 matthew 8685: ######################################################
8686: ######################################################
8687:
1.56 matthew 8688: =pod
8689:
1.648 raeburn 8690: =item * &csv_print_samples($r,$records)
1.41 ng 8691:
8692: Prints a table of sample values from each column uploaded $r is an
8693: Apache Request ref, $records is an arrayref from
8694: &Apache::loncommon::upfile_record_sep
8695:
8696: =cut
8697:
1.144 matthew 8698: ######################################################
8699: ######################################################
1.31 albertel 8700: sub csv_print_samples {
8701: my ($r,$records) = @_;
1.662 bisitz 8702: my $samples = &get_samples($records,5);
1.301 albertel 8703:
1.594 raeburn 8704: $r->print(&mt('Samples').'<br />'.&start_data_table().
8705: &start_data_table_header_row());
1.356 albertel 8706: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8707: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8708: $r->print(&end_data_table_header_row());
1.301 albertel 8709: foreach my $hash (@$samples) {
1.594 raeburn 8710: $r->print(&start_data_table_row());
1.356 albertel 8711: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8712: $r->print('<td>');
1.356 albertel 8713: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8714: $r->print('</td>');
8715: }
1.594 raeburn 8716: $r->print(&end_data_table_row());
1.31 albertel 8717: }
1.594 raeburn 8718: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8719: }
8720:
1.144 matthew 8721: ######################################################
8722: ######################################################
8723:
1.56 matthew 8724: =pod
8725:
1.648 raeburn 8726: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8727:
8728: Prints a table to create associations between values and table columns.
1.144 matthew 8729:
1.41 ng 8730: $r is an Apache Request ref,
8731: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8732: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8733:
8734: =cut
8735:
1.144 matthew 8736: ######################################################
8737: ######################################################
1.31 albertel 8738: sub csv_print_select_table {
8739: my ($r,$records,$d) = @_;
1.301 albertel 8740: my $i=0;
8741: my $samples = &get_samples($records,1);
1.144 matthew 8742: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8743: &start_data_table().&start_data_table_header_row().
1.144 matthew 8744: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8745: '<th>'.&mt('Column').'</th>'.
8746: &end_data_table_header_row()."\n");
1.356 albertel 8747: foreach my $array_ref (@$d) {
8748: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8749: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8750:
1.875 bisitz 8751: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8752: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8753: $r->print('<option value="none"></option>');
1.356 albertel 8754: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8755: $r->print('<option value="'.$sample.'"'.
8756: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8757: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8758: }
1.594 raeburn 8759: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8760: $i++;
8761: }
1.594 raeburn 8762: $r->print(&end_data_table());
1.31 albertel 8763: $i--;
8764: return $i;
8765: }
1.56 matthew 8766:
1.144 matthew 8767: ######################################################
8768: ######################################################
8769:
1.56 matthew 8770: =pod
1.31 albertel 8771:
1.648 raeburn 8772: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8773:
8774: Prints a table of sample values from the upload and can make associate samples to internal names.
8775:
8776: $r is an Apache Request ref,
8777: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8778: $d is an array of 2 element arrays (internal name, displayed name)
8779:
8780: =cut
8781:
1.144 matthew 8782: ######################################################
8783: ######################################################
1.31 albertel 8784: sub csv_samples_select_table {
8785: my ($r,$records,$d) = @_;
8786: my $i=0;
1.144 matthew 8787: #
1.662 bisitz 8788: my $max_samples = 5;
8789: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8790: $r->print(&start_data_table().
8791: &start_data_table_header_row().'<th>'.
8792: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8793: &end_data_table_header_row());
1.301 albertel 8794:
8795: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8796: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8797: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8798: foreach my $option (@$d) {
8799: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8800: $r->print('<option value="'.$value.'"'.
1.253 albertel 8801: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8802: $display.'</option>');
1.31 albertel 8803: }
8804: $r->print('</select></td><td>');
1.662 bisitz 8805: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8806: if (defined($samples->[$line]{$key})) {
8807: $r->print($samples->[$line]{$key}."<br />\n");
8808: }
8809: }
1.594 raeburn 8810: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8811: $i++;
8812: }
1.594 raeburn 8813: $r->print(&end_data_table());
1.31 albertel 8814: $i--;
8815: return($i);
1.115 matthew 8816: }
8817:
1.144 matthew 8818: ######################################################
8819: ######################################################
8820:
1.115 matthew 8821: =pod
8822:
1.648 raeburn 8823: =item * &clean_excel_name($name)
1.115 matthew 8824:
8825: Returns a replacement for $name which does not contain any illegal characters.
8826:
8827: =cut
8828:
1.144 matthew 8829: ######################################################
8830: ######################################################
1.115 matthew 8831: sub clean_excel_name {
8832: my ($name) = @_;
8833: $name =~ s/[:\*\?\/\\]//g;
8834: if (length($name) > 31) {
8835: $name = substr($name,0,31);
8836: }
8837: return $name;
1.25 albertel 8838: }
1.84 albertel 8839:
1.85 albertel 8840: =pod
8841:
1.648 raeburn 8842: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8843:
8844: Returns either 1 or undef
8845:
8846: 1 if the part is to be hidden, undef if it is to be shown
8847:
8848: Arguments are:
8849:
8850: $id the id of the part to be checked
8851: $symb, optional the symb of the resource to check
8852: $udom, optional the domain of the user to check for
8853: $uname, optional the username of the user to check for
8854:
8855: =cut
1.84 albertel 8856:
8857: sub check_if_partid_hidden {
8858: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8859: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8860: $symb,$udom,$uname);
1.141 albertel 8861: my $truth=1;
8862: #if the string starts with !, then the list is the list to show not hide
8863: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8864: my @hiddenlist=split(/,/,$hiddenparts);
8865: foreach my $checkid (@hiddenlist) {
1.141 albertel 8866: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8867: }
1.141 albertel 8868: return !$truth;
1.84 albertel 8869: }
1.127 matthew 8870:
1.138 matthew 8871:
8872: ############################################################
8873: ############################################################
8874:
8875: =pod
8876:
1.157 matthew 8877: =back
8878:
1.138 matthew 8879: =head1 cgi-bin script and graphing routines
8880:
1.157 matthew 8881: =over 4
8882:
1.648 raeburn 8883: =item * &get_cgi_id()
1.138 matthew 8884:
8885: Inputs: none
8886:
8887: Returns an id which can be used to pass environment variables
8888: to various cgi-bin scripts. These environment variables will
8889: be removed from the users environment after a given time by
8890: the routine &Apache::lonnet::transfer_profile_to_env.
8891:
8892: =cut
8893:
8894: ############################################################
8895: ############################################################
1.152 albertel 8896: my $uniq=0;
1.136 matthew 8897: sub get_cgi_id {
1.154 albertel 8898: $uniq=($uniq+1)%100000;
1.280 albertel 8899: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8900: }
8901:
1.127 matthew 8902: ############################################################
8903: ############################################################
8904:
8905: =pod
8906:
1.648 raeburn 8907: =item * &DrawBarGraph()
1.127 matthew 8908:
1.138 matthew 8909: Facilitates the plotting of data in a (stacked) bar graph.
8910: Puts plot definition data into the users environment in order for
8911: graph.png to plot it. Returns an <img> tag for the plot.
8912: The bars on the plot are labeled '1','2',...,'n'.
8913:
8914: Inputs:
8915:
8916: =over 4
8917:
8918: =item $Title: string, the title of the plot
8919:
8920: =item $xlabel: string, text describing the X-axis of the plot
8921:
8922: =item $ylabel: string, text describing the Y-axis of the plot
8923:
8924: =item $Max: scalar, the maximum Y value to use in the plot
8925: If $Max is < any data point, the graph will not be rendered.
8926:
1.140 matthew 8927: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8928: they are plotted. If undefined, default values will be used.
8929:
1.178 matthew 8930: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8931:
1.138 matthew 8932: =item @Values: An array of array references. Each array reference holds data
8933: to be plotted in a stacked bar chart.
8934:
1.239 matthew 8935: =item If the final element of @Values is a hash reference the key/value
8936: pairs will be added to the graph definition.
8937:
1.138 matthew 8938: =back
8939:
8940: Returns:
8941:
8942: An <img> tag which references graph.png and the appropriate identifying
8943: information for the plot.
8944:
1.127 matthew 8945: =cut
8946:
8947: ############################################################
8948: ############################################################
1.134 matthew 8949: sub DrawBarGraph {
1.178 matthew 8950: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8951: #
8952: if (! defined($colors)) {
8953: $colors = ['#33ff00',
8954: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8955: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8956: ];
8957: }
1.228 matthew 8958: my $extra_settings = {};
8959: if (ref($Values[-1]) eq 'HASH') {
8960: $extra_settings = pop(@Values);
8961: }
1.127 matthew 8962: #
1.136 matthew 8963: my $identifier = &get_cgi_id();
8964: my $id = 'cgi.'.$identifier;
1.129 matthew 8965: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8966: return '';
8967: }
1.225 matthew 8968: #
8969: my @Labels;
8970: if (defined($labels)) {
8971: @Labels = @$labels;
8972: } else {
8973: for (my $i=0;$i<@{$Values[0]};$i++) {
8974: push (@Labels,$i+1);
8975: }
8976: }
8977: #
1.129 matthew 8978: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8979: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8980: my %ValuesHash;
8981: my $NumSets=1;
8982: foreach my $array (@Values) {
8983: next if (! ref($array));
1.136 matthew 8984: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8985: join(',',@$array);
1.129 matthew 8986: }
1.127 matthew 8987: #
1.136 matthew 8988: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8989: if ($NumBars < 3) {
8990: $width = 120+$NumBars*32;
1.220 matthew 8991: $xskip = 1;
1.225 matthew 8992: $bar_width = 30;
8993: } elsif ($NumBars < 5) {
8994: $width = 120+$NumBars*20;
8995: $xskip = 1;
8996: $bar_width = 20;
1.220 matthew 8997: } elsif ($NumBars < 10) {
1.136 matthew 8998: $width = 120+$NumBars*15;
8999: $xskip = 1;
9000: $bar_width = 15;
9001: } elsif ($NumBars <= 25) {
9002: $width = 120+$NumBars*11;
9003: $xskip = 5;
9004: $bar_width = 8;
9005: } elsif ($NumBars <= 50) {
9006: $width = 120+$NumBars*8;
9007: $xskip = 5;
9008: $bar_width = 4;
9009: } else {
9010: $width = 120+$NumBars*8;
9011: $xskip = 5;
9012: $bar_width = 4;
9013: }
9014: #
1.137 matthew 9015: $Max = 1 if ($Max < 1);
9016: if ( int($Max) < $Max ) {
9017: $Max++;
9018: $Max = int($Max);
9019: }
1.127 matthew 9020: $Title = '' if (! defined($Title));
9021: $xlabel = '' if (! defined($xlabel));
9022: $ylabel = '' if (! defined($ylabel));
1.369 www 9023: $ValuesHash{$id.'.title'} = &escape($Title);
9024: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9025: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9026: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9027: $ValuesHash{$id.'.NumBars'} = $NumBars;
9028: $ValuesHash{$id.'.NumSets'} = $NumSets;
9029: $ValuesHash{$id.'.PlotType'} = 'bar';
9030: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9031: $ValuesHash{$id.'.height'} = $height;
9032: $ValuesHash{$id.'.width'} = $width;
9033: $ValuesHash{$id.'.xskip'} = $xskip;
9034: $ValuesHash{$id.'.bar_width'} = $bar_width;
9035: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9036: #
1.228 matthew 9037: # Deal with other parameters
9038: while (my ($key,$value) = each(%$extra_settings)) {
9039: $ValuesHash{$id.'.'.$key} = $value;
9040: }
9041: #
1.646 raeburn 9042: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9043: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9044: }
9045:
9046: ############################################################
9047: ############################################################
9048:
9049: =pod
9050:
1.648 raeburn 9051: =item * &DrawXYGraph()
1.137 matthew 9052:
1.138 matthew 9053: Facilitates the plotting of data in an XY graph.
9054: Puts plot definition data into the users environment in order for
9055: graph.png to plot it. Returns an <img> tag for the plot.
9056:
9057: Inputs:
9058:
9059: =over 4
9060:
9061: =item $Title: string, the title of the plot
9062:
9063: =item $xlabel: string, text describing the X-axis of the plot
9064:
9065: =item $ylabel: string, text describing the Y-axis of the plot
9066:
9067: =item $Max: scalar, the maximum Y value to use in the plot
9068: If $Max is < any data point, the graph will not be rendered.
9069:
9070: =item $colors: Array ref containing the hex color codes for the data to be
9071: plotted in. If undefined, default values will be used.
9072:
9073: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9074:
9075: =item $Ydata: Array ref containing Array refs.
1.185 www 9076: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9077:
9078: =item %Values: hash indicating or overriding any default values which are
9079: passed to graph.png.
9080: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9081:
9082: =back
9083:
9084: Returns:
9085:
9086: An <img> tag which references graph.png and the appropriate identifying
9087: information for the plot.
9088:
1.137 matthew 9089: =cut
9090:
9091: ############################################################
9092: ############################################################
9093: sub DrawXYGraph {
9094: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9095: #
9096: # Create the identifier for the graph
9097: my $identifier = &get_cgi_id();
9098: my $id = 'cgi.'.$identifier;
9099: #
9100: $Title = '' if (! defined($Title));
9101: $xlabel = '' if (! defined($xlabel));
9102: $ylabel = '' if (! defined($ylabel));
9103: my %ValuesHash =
9104: (
1.369 www 9105: $id.'.title' => &escape($Title),
9106: $id.'.xlabel' => &escape($xlabel),
9107: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9108: $id.'.y_max_value'=> $Max,
9109: $id.'.labels' => join(',',@$Xlabels),
9110: $id.'.PlotType' => 'XY',
9111: );
9112: #
9113: if (defined($colors) && ref($colors) eq 'ARRAY') {
9114: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9115: }
9116: #
9117: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9118: return '';
9119: }
9120: my $NumSets=1;
1.138 matthew 9121: foreach my $array (@{$Ydata}){
1.137 matthew 9122: next if (! ref($array));
9123: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9124: }
1.138 matthew 9125: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9126: #
9127: # Deal with other parameters
9128: while (my ($key,$value) = each(%Values)) {
9129: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9130: }
9131: #
1.646 raeburn 9132: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9133: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9134: }
9135:
9136: ############################################################
9137: ############################################################
9138:
9139: =pod
9140:
1.648 raeburn 9141: =item * &DrawXYYGraph()
1.138 matthew 9142:
9143: Facilitates the plotting of data in an XY graph with two Y axes.
9144: Puts plot definition data into the users environment in order for
9145: graph.png to plot it. Returns an <img> tag for the plot.
9146:
9147: Inputs:
9148:
9149: =over 4
9150:
9151: =item $Title: string, the title of the plot
9152:
9153: =item $xlabel: string, text describing the X-axis of the plot
9154:
9155: =item $ylabel: string, text describing the Y-axis of the plot
9156:
9157: =item $colors: Array ref containing the hex color codes for the data to be
9158: plotted in. If undefined, default values will be used.
9159:
9160: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9161:
9162: =item $Ydata1: The first data set
9163:
9164: =item $Min1: The minimum value of the left Y-axis
9165:
9166: =item $Max1: The maximum value of the left Y-axis
9167:
9168: =item $Ydata2: The second data set
9169:
9170: =item $Min2: The minimum value of the right Y-axis
9171:
9172: =item $Max2: The maximum value of the left Y-axis
9173:
9174: =item %Values: hash indicating or overriding any default values which are
9175: passed to graph.png.
9176: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9177:
9178: =back
9179:
9180: Returns:
9181:
9182: An <img> tag which references graph.png and the appropriate identifying
9183: information for the plot.
1.136 matthew 9184:
9185: =cut
9186:
9187: ############################################################
9188: ############################################################
1.137 matthew 9189: sub DrawXYYGraph {
9190: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9191: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9192: #
9193: # Create the identifier for the graph
9194: my $identifier = &get_cgi_id();
9195: my $id = 'cgi.'.$identifier;
9196: #
9197: $Title = '' if (! defined($Title));
9198: $xlabel = '' if (! defined($xlabel));
9199: $ylabel = '' if (! defined($ylabel));
9200: my %ValuesHash =
9201: (
1.369 www 9202: $id.'.title' => &escape($Title),
9203: $id.'.xlabel' => &escape($xlabel),
9204: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9205: $id.'.labels' => join(',',@$Xlabels),
9206: $id.'.PlotType' => 'XY',
9207: $id.'.NumSets' => 2,
1.137 matthew 9208: $id.'.two_axes' => 1,
9209: $id.'.y1_max_value' => $Max1,
9210: $id.'.y1_min_value' => $Min1,
9211: $id.'.y2_max_value' => $Max2,
9212: $id.'.y2_min_value' => $Min2,
1.136 matthew 9213: );
9214: #
1.137 matthew 9215: if (defined($colors) && ref($colors) eq 'ARRAY') {
9216: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9217: }
9218: #
9219: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9220: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9221: return '';
9222: }
9223: my $NumSets=1;
1.137 matthew 9224: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9225: next if (! ref($array));
9226: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9227: }
9228: #
9229: # Deal with other parameters
9230: while (my ($key,$value) = each(%Values)) {
9231: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9232: }
9233: #
1.646 raeburn 9234: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9235: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9236: }
9237:
9238: ############################################################
9239: ############################################################
9240:
9241: =pod
9242:
1.157 matthew 9243: =back
9244:
1.139 matthew 9245: =head1 Statistics helper routines?
9246:
9247: Bad place for them but what the hell.
9248:
1.157 matthew 9249: =over 4
9250:
1.648 raeburn 9251: =item * &chartlink()
1.139 matthew 9252:
9253: Returns a link to the chart for a specific student.
9254:
9255: Inputs:
9256:
9257: =over 4
9258:
9259: =item $linktext: The text of the link
9260:
9261: =item $sname: The students username
9262:
9263: =item $sdomain: The students domain
9264:
9265: =back
9266:
1.157 matthew 9267: =back
9268:
1.139 matthew 9269: =cut
9270:
9271: ############################################################
9272: ############################################################
9273: sub chartlink {
9274: my ($linktext, $sname, $sdomain) = @_;
9275: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9276: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9277: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9278: '">'.$linktext.'</a>';
1.153 matthew 9279: }
9280:
9281: #######################################################
9282: #######################################################
9283:
9284: =pod
9285:
9286: =head1 Course Environment Routines
1.157 matthew 9287:
9288: =over 4
1.153 matthew 9289:
1.648 raeburn 9290: =item * &restore_course_settings()
1.153 matthew 9291:
1.648 raeburn 9292: =item * &store_course_settings()
1.153 matthew 9293:
9294: Restores/Store indicated form parameters from the course environment.
9295: Will not overwrite existing values of the form parameters.
9296:
9297: Inputs:
9298: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9299:
9300: a hash ref describing the data to be stored. For example:
9301:
9302: %Save_Parameters = ('Status' => 'scalar',
9303: 'chartoutputmode' => 'scalar',
9304: 'chartoutputdata' => 'scalar',
9305: 'Section' => 'array',
1.373 raeburn 9306: 'Group' => 'array',
1.153 matthew 9307: 'StudentData' => 'array',
9308: 'Maps' => 'array');
9309:
9310: Returns: both routines return nothing
9311:
1.631 raeburn 9312: =back
9313:
1.153 matthew 9314: =cut
9315:
9316: #######################################################
9317: #######################################################
9318: sub store_course_settings {
1.496 albertel 9319: return &store_settings($env{'request.course.id'},@_);
9320: }
9321:
9322: sub store_settings {
1.153 matthew 9323: # save to the environment
9324: # appenv the same items, just to be safe
1.300 albertel 9325: my $udom = $env{'user.domain'};
9326: my $uname = $env{'user.name'};
1.496 albertel 9327: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9328: my %SaveHash;
9329: my %AppHash;
9330: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9331: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9332: my $envname = 'environment.'.$basename;
1.258 albertel 9333: if (exists($env{'form.'.$setting})) {
1.153 matthew 9334: # Save this value away
9335: if ($type eq 'scalar' &&
1.258 albertel 9336: (! exists($env{$envname}) ||
9337: $env{$envname} ne $env{'form.'.$setting})) {
9338: $SaveHash{$basename} = $env{'form.'.$setting};
9339: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9340: } elsif ($type eq 'array') {
9341: my $stored_form;
1.258 albertel 9342: if (ref($env{'form.'.$setting})) {
1.153 matthew 9343: $stored_form = join(',',
9344: map {
1.369 www 9345: &escape($_);
1.258 albertel 9346: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9347: } else {
9348: $stored_form =
1.369 www 9349: &escape($env{'form.'.$setting});
1.153 matthew 9350: }
9351: # Determine if the array contents are the same.
1.258 albertel 9352: if ($stored_form ne $env{$envname}) {
1.153 matthew 9353: $SaveHash{$basename} = $stored_form;
9354: $AppHash{$envname} = $stored_form;
9355: }
9356: }
9357: }
9358: }
9359: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9360: $udom,$uname);
1.153 matthew 9361: if ($put_result !~ /^(ok|delayed)/) {
9362: &Apache::lonnet::logthis('unable to save form parameters, '.
9363: 'got error:'.$put_result);
9364: }
9365: # Make sure these settings stick around in this session, too
1.646 raeburn 9366: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9367: return;
9368: }
9369:
9370: sub restore_course_settings {
1.499 albertel 9371: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9372: }
9373:
9374: sub restore_settings {
9375: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9376: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9377: next if (exists($env{'form.'.$setting}));
1.496 albertel 9378: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9379: '.'.$setting;
1.258 albertel 9380: if (exists($env{$envname})) {
1.153 matthew 9381: if ($type eq 'scalar') {
1.258 albertel 9382: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9383: } elsif ($type eq 'array') {
1.258 albertel 9384: $env{'form.'.$setting} = [
1.153 matthew 9385: map {
1.369 www 9386: &unescape($_);
1.258 albertel 9387: } split(',',$env{$envname})
1.153 matthew 9388: ];
9389: }
9390: }
9391: }
1.127 matthew 9392: }
9393:
1.618 raeburn 9394: #######################################################
9395: #######################################################
9396:
9397: =pod
9398:
9399: =head1 Domain E-mail Routines
9400:
9401: =over 4
9402:
1.648 raeburn 9403: =item * &build_recipient_list()
1.618 raeburn 9404:
1.884 raeburn 9405: Build recipient lists for five types of e-mail:
1.766 raeburn 9406: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9407: (d) Help requests, (e) Course requests needing approval, generated by
9408: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9409: loncoursequeueadmin.pm respectively.
1.618 raeburn 9410:
9411: Inputs:
1.619 raeburn 9412: defmail (scalar - email address of default recipient),
1.618 raeburn 9413: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9414: defdom (domain for which to retrieve configuration settings),
9415: origmail (scalar - email address of recipient from loncapa.conf,
9416: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9417:
1.655 raeburn 9418: Returns: comma separated list of addresses to which to send e-mail.
9419:
9420: =back
1.618 raeburn 9421:
9422: =cut
9423:
9424: ############################################################
9425: ############################################################
9426: sub build_recipient_list {
1.619 raeburn 9427: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9428: my @recipients;
9429: my $otheremails;
9430: my %domconfig =
9431: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9432: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9433: if (exists($domconfig{'contacts'}{$mailing})) {
9434: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9435: my @contacts = ('adminemail','supportemail');
9436: foreach my $item (@contacts) {
9437: if ($domconfig{'contacts'}{$mailing}{$item}) {
9438: my $addr = $domconfig{'contacts'}{$item};
9439: if (!grep(/^\Q$addr\E$/,@recipients)) {
9440: push(@recipients,$addr);
9441: }
1.619 raeburn 9442: }
1.766 raeburn 9443: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9444: }
9445: }
1.766 raeburn 9446: } elsif ($origmail ne '') {
9447: push(@recipients,$origmail);
1.618 raeburn 9448: }
1.619 raeburn 9449: } elsif ($origmail ne '') {
9450: push(@recipients,$origmail);
1.618 raeburn 9451: }
1.688 raeburn 9452: if (defined($defmail)) {
9453: if ($defmail ne '') {
9454: push(@recipients,$defmail);
9455: }
1.618 raeburn 9456: }
9457: if ($otheremails) {
1.619 raeburn 9458: my @others;
9459: if ($otheremails =~ /,/) {
9460: @others = split(/,/,$otheremails);
1.618 raeburn 9461: } else {
1.619 raeburn 9462: push(@others,$otheremails);
9463: }
9464: foreach my $addr (@others) {
9465: if (!grep(/^\Q$addr\E$/,@recipients)) {
9466: push(@recipients,$addr);
9467: }
1.618 raeburn 9468: }
9469: }
1.619 raeburn 9470: my $recipientlist = join(',',@recipients);
1.618 raeburn 9471: return $recipientlist;
9472: }
9473:
1.127 matthew 9474: ############################################################
9475: ############################################################
1.154 albertel 9476:
1.655 raeburn 9477: =pod
9478:
9479: =head1 Course Catalog Routines
9480:
9481: =over 4
9482:
9483: =item * &gather_categories()
9484:
9485: Converts category definitions - keys of categories hash stored in
9486: coursecategories in configuration.db on the primary library server in a
9487: domain - to an array. Also generates javascript and idx hash used to
9488: generate Domain Coordinator interface for editing Course Categories.
9489:
9490: Inputs:
1.663 raeburn 9491:
1.655 raeburn 9492: categories (reference to hash of category definitions).
1.663 raeburn 9493:
1.655 raeburn 9494: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9495: categories and subcategories).
1.663 raeburn 9496:
1.655 raeburn 9497: idx (reference to hash of counters used in Domain Coordinator interface for
9498: editing Course Categories).
1.663 raeburn 9499:
1.655 raeburn 9500: jsarray (reference to array of categories used to create Javascript arrays for
9501: Domain Coordinator interface for editing Course Categories).
9502:
9503: Returns: nothing
9504:
9505: Side effects: populates cats, idx and jsarray.
9506:
9507: =cut
9508:
9509: sub gather_categories {
9510: my ($categories,$cats,$idx,$jsarray) = @_;
9511: my %counters;
9512: my $num = 0;
9513: foreach my $item (keys(%{$categories})) {
9514: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9515: if ($container eq '' && $depth == 0) {
9516: $cats->[$depth][$categories->{$item}] = $cat;
9517: } else {
9518: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9519: }
9520: my ($escitem,$tail) = split(/:/,$item,2);
9521: if ($counters{$tail} eq '') {
9522: $counters{$tail} = $num;
9523: $num ++;
9524: }
9525: if (ref($idx) eq 'HASH') {
9526: $idx->{$item} = $counters{$tail};
9527: }
9528: if (ref($jsarray) eq 'ARRAY') {
9529: push(@{$jsarray->[$counters{$tail}]},$item);
9530: }
9531: }
9532: return;
9533: }
9534:
9535: =pod
9536:
9537: =item * &extract_categories()
9538:
9539: Used to generate breadcrumb trails for course categories.
9540:
9541: Inputs:
1.663 raeburn 9542:
1.655 raeburn 9543: categories (reference to hash of category definitions).
1.663 raeburn 9544:
1.655 raeburn 9545: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9546: categories and subcategories).
1.663 raeburn 9547:
1.655 raeburn 9548: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9549:
1.655 raeburn 9550: allitems (reference to hash - key is category key
9551: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9552:
1.655 raeburn 9553: idx (reference to hash of counters used in Domain Coordinator interface for
9554: editing Course Categories).
1.663 raeburn 9555:
1.655 raeburn 9556: jsarray (reference to array of categories used to create Javascript arrays for
9557: Domain Coordinator interface for editing Course Categories).
9558:
1.665 raeburn 9559: subcats (reference to hash of arrays containing all subcategories within each
9560: category, -recursive)
9561:
1.655 raeburn 9562: Returns: nothing
9563:
9564: Side effects: populates trails and allitems hash references.
9565:
9566: =cut
9567:
9568: sub extract_categories {
1.665 raeburn 9569: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9570: if (ref($categories) eq 'HASH') {
9571: &gather_categories($categories,$cats,$idx,$jsarray);
9572: if (ref($cats->[0]) eq 'ARRAY') {
9573: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9574: my $name = $cats->[0][$i];
9575: my $item = &escape($name).'::0';
9576: my $trailstr;
9577: if ($name eq 'instcode') {
9578: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9579: } elsif ($name eq 'communities') {
9580: $trailstr = &mt('Communities');
1.655 raeburn 9581: } else {
9582: $trailstr = $name;
9583: }
9584: if ($allitems->{$item} eq '') {
9585: push(@{$trails},$trailstr);
9586: $allitems->{$item} = scalar(@{$trails})-1;
9587: }
9588: my @parents = ($name);
9589: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9590: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9591: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9592: if (ref($subcats) eq 'HASH') {
9593: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9594: }
9595: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9596: }
9597: } else {
9598: if (ref($subcats) eq 'HASH') {
9599: $subcats->{$item} = [];
1.655 raeburn 9600: }
9601: }
9602: }
9603: }
9604: }
9605: return;
9606: }
9607:
9608: =pod
9609:
9610: =item *&recurse_categories()
9611:
9612: Recursively used to generate breadcrumb trails for course categories.
9613:
9614: Inputs:
1.663 raeburn 9615:
1.655 raeburn 9616: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9617: categories and subcategories).
1.663 raeburn 9618:
1.655 raeburn 9619: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9620:
9621: category (current course category, for which breadcrumb trail is being generated).
9622:
9623: trails (reference to array of breadcrumb trails for each category).
9624:
1.655 raeburn 9625: allitems (reference to hash - key is category key
9626: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9627:
1.655 raeburn 9628: parents (array containing containers directories for current category,
9629: back to top level).
9630:
9631: Returns: nothing
9632:
9633: Side effects: populates trails and allitems hash references
9634:
9635: =cut
9636:
9637: sub recurse_categories {
1.665 raeburn 9638: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9639: my $shallower = $depth - 1;
9640: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9641: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9642: my $name = $cats->[$depth]{$category}[$k];
9643: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9644: my $trailstr = join(' -> ',(@{$parents},$category));
9645: if ($allitems->{$item} eq '') {
9646: push(@{$trails},$trailstr);
9647: $allitems->{$item} = scalar(@{$trails})-1;
9648: }
9649: my $deeper = $depth+1;
9650: push(@{$parents},$category);
1.665 raeburn 9651: if (ref($subcats) eq 'HASH') {
9652: my $subcat = &escape($name).':'.$category.':'.$depth;
9653: for (my $j=@{$parents}; $j>=0; $j--) {
9654: my $higher;
9655: if ($j > 0) {
9656: $higher = &escape($parents->[$j]).':'.
9657: &escape($parents->[$j-1]).':'.$j;
9658: } else {
9659: $higher = &escape($parents->[$j]).'::'.$j;
9660: }
9661: push(@{$subcats->{$higher}},$subcat);
9662: }
9663: }
9664: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9665: $subcats);
1.655 raeburn 9666: pop(@{$parents});
9667: }
9668: } else {
9669: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9670: my $trailstr = join(' -> ',(@{$parents},$category));
9671: if ($allitems->{$item} eq '') {
9672: push(@{$trails},$trailstr);
9673: $allitems->{$item} = scalar(@{$trails})-1;
9674: }
9675: }
9676: return;
9677: }
9678:
1.663 raeburn 9679: =pod
9680:
9681: =item *&assign_categories_table()
9682:
9683: Create a datatable for display of hierarchical categories in a domain,
9684: with checkboxes to allow a course to be categorized.
9685:
9686: Inputs:
9687:
9688: cathash - reference to hash of categories defined for the domain (from
9689: configuration.db)
9690:
9691: currcat - scalar with an & separated list of categories assigned to a course.
9692:
1.919 raeburn 9693: type - scalar contains course type (Course or Community).
9694:
1.663 raeburn 9695: Returns: $output (markup to be displayed)
9696:
9697: =cut
9698:
9699: sub assign_categories_table {
1.919 raeburn 9700: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9701: my $output;
9702: if (ref($cathash) eq 'HASH') {
9703: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9704: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9705: $maxdepth = scalar(@cats);
9706: if (@cats > 0) {
9707: my $itemcount = 0;
9708: if (ref($cats[0]) eq 'ARRAY') {
9709: my @currcategories;
9710: if ($currcat ne '') {
9711: @currcategories = split('&',$currcat);
9712: }
1.919 raeburn 9713: my $table;
1.663 raeburn 9714: for (my $i=0; $i<@{$cats[0]}; $i++) {
9715: my $parent = $cats[0][$i];
1.919 raeburn 9716: next if ($parent eq 'instcode');
9717: if ($type eq 'Community') {
9718: next unless ($parent eq 'communities');
9719: } else {
9720: next if ($parent eq 'communities');
9721: }
1.663 raeburn 9722: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9723: my $item = &escape($parent).'::0';
9724: my $checked = '';
9725: if (@currcategories > 0) {
9726: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9727: $checked = ' checked="checked"';
1.663 raeburn 9728: }
9729: }
1.919 raeburn 9730: my $parent_title = $parent;
9731: if ($parent eq 'communities') {
9732: $parent_title = &mt('Communities');
9733: }
9734: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9735: '<input type="checkbox" name="usecategory" value="'.
9736: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9737: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9738: my $depth = 1;
9739: push(@path,$parent);
1.919 raeburn 9740: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9741: pop(@path);
1.919 raeburn 9742: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9743: $itemcount ++;
9744: }
1.919 raeburn 9745: if ($itemcount) {
9746: $output = &Apache::loncommon::start_data_table().
9747: $table.
9748: &Apache::loncommon::end_data_table();
9749: }
1.663 raeburn 9750: }
9751: }
9752: }
9753: return $output;
9754: }
9755:
9756: =pod
9757:
9758: =item *&assign_category_rows()
9759:
9760: Create a datatable row for display of nested categories in a domain,
9761: with checkboxes to allow a course to be categorized,called recursively.
9762:
9763: Inputs:
9764:
9765: itemcount - track row number for alternating colors
9766:
9767: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9768: categories and subcategories.
9769:
9770: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9771:
9772: parent - parent of current category item
9773:
9774: path - Array containing all categories back up through the hierarchy from the
9775: current category to the top level.
9776:
9777: currcategories - reference to array of current categories assigned to the course
9778:
9779: Returns: $output (markup to be displayed).
9780:
9781: =cut
9782:
9783: sub assign_category_rows {
9784: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9785: my ($text,$name,$item,$chgstr);
9786: if (ref($cats) eq 'ARRAY') {
9787: my $maxdepth = scalar(@{$cats});
9788: if (ref($cats->[$depth]) eq 'HASH') {
9789: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9790: my $numchildren = @{$cats->[$depth]{$parent}};
9791: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9792: $text .= '<td><table class="LC_datatable">';
9793: for (my $j=0; $j<$numchildren; $j++) {
9794: $name = $cats->[$depth]{$parent}[$j];
9795: $item = &escape($name).':'.&escape($parent).':'.$depth;
9796: my $deeper = $depth+1;
9797: my $checked = '';
9798: if (ref($currcategories) eq 'ARRAY') {
9799: if (@{$currcategories} > 0) {
9800: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9801: $checked = ' checked="checked"';
1.663 raeburn 9802: }
9803: }
9804: }
1.664 raeburn 9805: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9806: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9807: $item.'"'.$checked.' />'.$name.'</label></span>'.
9808: '<input type="hidden" name="catname" value="'.$name.'" />'.
9809: '</td><td>';
1.663 raeburn 9810: if (ref($path) eq 'ARRAY') {
9811: push(@{$path},$name);
9812: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9813: pop(@{$path});
9814: }
9815: $text .= '</td></tr>';
9816: }
9817: $text .= '</table></td>';
9818: }
9819: }
9820: }
9821: return $text;
9822: }
9823:
1.655 raeburn 9824: ############################################################
9825: ############################################################
9826:
9827:
1.443 albertel 9828: sub commit_customrole {
1.664 raeburn 9829: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9830: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9831: ($start?', '.&mt('starting').' '.localtime($start):'').
9832: ($end?', ending '.localtime($end):'').': <b>'.
9833: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9834: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9835: '</b><br />';
9836: return $output;
9837: }
9838:
9839: sub commit_standardrole {
1.541 raeburn 9840: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9841: my ($output,$logmsg,$linefeed);
9842: if ($context eq 'auto') {
9843: $linefeed = "\n";
9844: } else {
9845: $linefeed = "<br />\n";
9846: }
1.443 albertel 9847: if ($three eq 'st') {
1.541 raeburn 9848: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9849: $one,$two,$sec,$context);
9850: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9851: ($result eq 'unknown_course') || ($result eq 'refused')) {
9852: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9853: } else {
1.541 raeburn 9854: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9855: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9856: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9857: if ($context eq 'auto') {
9858: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9859: } else {
9860: $output .= '<b>'.$result.'</b>'.$linefeed.
9861: &mt('Add to classlist').': <b>ok</b>';
9862: }
9863: $output .= $linefeed;
1.443 albertel 9864: }
9865: } else {
9866: $output = &mt('Assigning').' '.$three.' in '.$url.
9867: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9868: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9869: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9870: if ($context eq 'auto') {
9871: $output .= $result.$linefeed;
9872: } else {
9873: $output .= '<b>'.$result.'</b>'.$linefeed;
9874: }
1.443 albertel 9875: }
9876: return $output;
9877: }
9878:
9879: sub commit_studentrole {
1.541 raeburn 9880: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9881: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9882: if ($context eq 'auto') {
9883: $linefeed = "\n";
9884: } else {
9885: $linefeed = '<br />'."\n";
9886: }
1.443 albertel 9887: if (defined($one) && defined($two)) {
9888: my $cid=$one.'_'.$two;
9889: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9890: my $secchange = 0;
9891: my $expire_role_result;
9892: my $modify_section_result;
1.628 raeburn 9893: if ($oldsec ne '-1') {
9894: if ($oldsec ne $sec) {
1.443 albertel 9895: $secchange = 1;
1.628 raeburn 9896: my $now = time;
1.443 albertel 9897: my $uurl='/'.$cid;
9898: $uurl=~s/\_/\//g;
9899: if ($oldsec) {
9900: $uurl.='/'.$oldsec;
9901: }
1.626 raeburn 9902: $oldsecurl = $uurl;
1.628 raeburn 9903: $expire_role_result =
1.652 raeburn 9904: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9905: if ($env{'request.course.sec'} ne '') {
9906: if ($expire_role_result eq 'refused') {
9907: my @roles = ('st');
9908: my @statuses = ('previous');
9909: my @roledoms = ($one);
9910: my $withsec = 1;
9911: my %roleshash =
9912: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9913: \@statuses,\@roles,\@roledoms,$withsec);
9914: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9915: my ($oldstart,$oldend) =
9916: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9917: if ($oldend > 0 && $oldend <= $now) {
9918: $expire_role_result = 'ok';
9919: }
9920: }
9921: }
9922: }
1.443 albertel 9923: $result = $expire_role_result;
9924: }
9925: }
9926: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9927: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9928: if ($modify_section_result =~ /^ok/) {
9929: if ($secchange == 1) {
1.628 raeburn 9930: if ($sec eq '') {
9931: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9932: } else {
9933: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9934: }
1.443 albertel 9935: } elsif ($oldsec eq '-1') {
1.628 raeburn 9936: if ($sec eq '') {
9937: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9938: } else {
9939: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9940: }
1.443 albertel 9941: } else {
1.628 raeburn 9942: if ($sec eq '') {
9943: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9944: } else {
9945: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9946: }
1.443 albertel 9947: }
9948: } else {
1.628 raeburn 9949: if ($secchange) {
9950: $$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;
9951: } else {
9952: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9953: }
1.443 albertel 9954: }
9955: $result = $modify_section_result;
9956: } elsif ($secchange == 1) {
1.628 raeburn 9957: if ($oldsec eq '') {
9958: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9959: } else {
9960: $$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;
9961: }
1.626 raeburn 9962: if ($expire_role_result eq 'refused') {
9963: my $newsecurl = '/'.$cid;
9964: $newsecurl =~ s/\_/\//g;
9965: if ($sec ne '') {
9966: $newsecurl.='/'.$sec;
9967: }
9968: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9969: if ($sec eq '') {
9970: $$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;
9971: } else {
9972: $$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;
9973: }
9974: }
9975: }
1.443 albertel 9976: }
9977: } else {
1.626 raeburn 9978: $$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 9979: $result = "error: incomplete course id\n";
9980: }
9981: return $result;
9982: }
9983:
9984: ############################################################
9985: ############################################################
9986:
1.566 albertel 9987: sub check_clone {
1.578 raeburn 9988: my ($args,$linefeed) = @_;
1.566 albertel 9989: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9990: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9991: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9992: my $clonemsg;
9993: my $can_clone = 0;
1.908 raeburn 9994: my $lctype = lc($args->{'type'});
9995: if ($lctype ne 'community') {
9996: $lctype = 'course';
9997: }
1.566 albertel 9998: if ($clonehome eq 'no_host') {
1.908 raeburn 9999: if ($args->{'type'} eq 'Community') {
10000: $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'});
10001: } else {
10002: $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'});
10003: }
1.566 albertel 10004: } else {
10005: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10006: if ($args->{'type'} eq 'Community') {
10007: if ($clonedesc{'type'} ne 'Community') {
10008: $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'});
10009: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10010: }
10011: }
1.882 raeburn 10012: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10013: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10014: $can_clone = 1;
10015: } else {
10016: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10017: $args->{'clonedomain'},$args->{'clonecourse'});
10018: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10019: if (grep(/^\*$/,@cloners)) {
10020: $can_clone = 1;
10021: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10022: $can_clone = 1;
10023: } else {
1.908 raeburn 10024: my $ccrole = 'cc';
10025: if ($args->{'type'} eq 'Community') {
10026: $ccrole = 'co';
10027: }
1.578 raeburn 10028: my %roleshash =
10029: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10030: $args->{'ccdomain'},
1.908 raeburn 10031: 'userroles',['active'],[$ccrole],
1.578 raeburn 10032: [$args->{'clonedomain'}]);
1.908 raeburn 10033: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10034: $can_clone = 1;
10035: } else {
1.908 raeburn 10036: if ($args->{'type'} eq 'Community') {
10037: $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'});
10038: } else {
10039: $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'});
10040: }
1.578 raeburn 10041: }
1.566 albertel 10042: }
1.578 raeburn 10043: }
1.566 albertel 10044: }
10045: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10046: }
10047:
1.444 albertel 10048: sub construct_course {
1.885 raeburn 10049: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10050: my $outcome;
1.541 raeburn 10051: my $linefeed = '<br />'."\n";
10052: if ($context eq 'auto') {
10053: $linefeed = "\n";
10054: }
1.566 albertel 10055:
10056: #
10057: # Are we cloning?
10058: #
10059: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10060: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10061: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10062: if ($context ne 'auto') {
1.578 raeburn 10063: if ($clonemsg ne '') {
10064: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10065: }
1.566 albertel 10066: }
10067: $outcome .= $clonemsg.$linefeed;
10068:
10069: if (!$can_clone) {
10070: return (0,$outcome);
10071: }
10072: }
10073:
1.444 albertel 10074: #
10075: # Open course
10076: #
10077: my $crstype = lc($args->{'crstype'});
10078: my %cenv=();
10079: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10080: $args->{'cdescr'},
10081: $args->{'curl'},
10082: $args->{'course_home'},
10083: $args->{'nonstandard'},
10084: $args->{'crscode'},
10085: $args->{'ccuname'}.':'.
10086: $args->{'ccdomain'},
1.882 raeburn 10087: $args->{'crstype'},
1.885 raeburn 10088: $cnum,$context,$category);
1.444 albertel 10089:
10090: # Note: The testing routines depend on this being output; see
10091: # Utils::Course. This needs to at least be output as a comment
10092: # if anyone ever decides to not show this, and Utils::Course::new
10093: # will need to be suitably modified.
1.541 raeburn 10094: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10095: #
10096: # Check if created correctly
10097: #
1.479 albertel 10098: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10099: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10100: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10101:
1.444 albertel 10102: #
1.566 albertel 10103: # Do the cloning
10104: #
10105: if ($can_clone && $cloneid) {
10106: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10107: if ($context ne 'auto') {
10108: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10109: }
10110: $outcome .= $clonemsg.$linefeed;
10111: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10112: # Copy all files
1.637 www 10113: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10114: # Restore URL
1.566 albertel 10115: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10116: # Restore title
1.566 albertel 10117: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10118: # Mark as cloned
1.566 albertel 10119: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10120: # Need to clone grading mode
10121: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10122: $cenv{'grading'}=$newenv{'grading'};
10123: # Do not clone these environment entries
10124: &Apache::lonnet::del('environment',
10125: ['default_enrollment_start_date',
10126: 'default_enrollment_end_date',
10127: 'question.email',
10128: 'policy.email',
10129: 'comment.email',
10130: 'pch.users.denied',
1.725 raeburn 10131: 'plc.users.denied',
10132: 'hidefromcat',
10133: 'categories'],
1.638 www 10134: $$crsudom,$$crsunum);
1.444 albertel 10135: }
1.566 albertel 10136:
1.444 albertel 10137: #
10138: # Set environment (will override cloned, if existing)
10139: #
10140: my @sections = ();
10141: my @xlists = ();
10142: if ($args->{'crstype'}) {
10143: $cenv{'type'}=$args->{'crstype'};
10144: }
10145: if ($args->{'crsid'}) {
10146: $cenv{'courseid'}=$args->{'crsid'};
10147: }
10148: if ($args->{'crscode'}) {
10149: $cenv{'internal.coursecode'}=$args->{'crscode'};
10150: }
10151: if ($args->{'crsquota'} ne '') {
10152: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10153: } else {
10154: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10155: }
10156: if ($args->{'ccuname'}) {
10157: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10158: ':'.$args->{'ccdomain'};
10159: } else {
10160: $cenv{'internal.courseowner'} = $args->{'curruser'};
10161: }
10162: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10163: if ($args->{'crssections'}) {
10164: $cenv{'internal.sectionnums'} = '';
10165: if ($args->{'crssections'} =~ m/,/) {
10166: @sections = split/,/,$args->{'crssections'};
10167: } else {
10168: $sections[0] = $args->{'crssections'};
10169: }
10170: if (@sections > 0) {
10171: foreach my $item (@sections) {
10172: my ($sec,$gp) = split/:/,$item;
10173: my $class = $args->{'crscode'}.$sec;
10174: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10175: $cenv{'internal.sectionnums'} .= $item.',';
10176: unless ($addcheck eq 'ok') {
10177: push @badclasses, $class;
10178: }
10179: }
10180: $cenv{'internal.sectionnums'} =~ s/,$//;
10181: }
10182: }
10183: # do not hide course coordinator from staff listing,
10184: # even if privileged
10185: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10186: # add crosslistings
10187: if ($args->{'crsxlist'}) {
10188: $cenv{'internal.crosslistings'}='';
10189: if ($args->{'crsxlist'} =~ m/,/) {
10190: @xlists = split/,/,$args->{'crsxlist'};
10191: } else {
10192: $xlists[0] = $args->{'crsxlist'};
10193: }
10194: if (@xlists > 0) {
10195: foreach my $item (@xlists) {
10196: my ($xl,$gp) = split/:/,$item;
10197: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10198: $cenv{'internal.crosslistings'} .= $item.',';
10199: unless ($addcheck eq 'ok') {
10200: push @badclasses, $xl;
10201: }
10202: }
10203: $cenv{'internal.crosslistings'} =~ s/,$//;
10204: }
10205: }
10206: if ($args->{'autoadds'}) {
10207: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10208: }
10209: if ($args->{'autodrops'}) {
10210: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10211: }
10212: # check for notification of enrollment changes
10213: my @notified = ();
10214: if ($args->{'notify_owner'}) {
10215: if ($args->{'ccuname'} ne '') {
10216: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10217: }
10218: }
10219: if ($args->{'notify_dc'}) {
10220: if ($uname ne '') {
1.630 raeburn 10221: push(@notified,$uname.':'.$udom);
1.444 albertel 10222: }
10223: }
10224: if (@notified > 0) {
10225: my $notifylist;
10226: if (@notified > 1) {
10227: $notifylist = join(',',@notified);
10228: } else {
10229: $notifylist = $notified[0];
10230: }
10231: $cenv{'internal.notifylist'} = $notifylist;
10232: }
10233: if (@badclasses > 0) {
10234: my %lt=&Apache::lonlocal::texthash(
10235: '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',
10236: 'dnhr' => 'does not have rights to access enrollment in these classes',
10237: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10238: );
1.541 raeburn 10239: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10240: ' ('.$lt{'adby'}.')';
10241: if ($context eq 'auto') {
10242: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10243: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10244: foreach my $item (@badclasses) {
10245: if ($context eq 'auto') {
10246: $outcome .= " - $item\n";
10247: } else {
10248: $outcome .= "<li>$item</li>\n";
10249: }
10250: }
10251: if ($context eq 'auto') {
10252: $outcome .= $linefeed;
10253: } else {
1.566 albertel 10254: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10255: }
10256: }
1.444 albertel 10257: }
10258: if ($args->{'no_end_date'}) {
10259: $args->{'endaccess'} = 0;
10260: }
10261: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10262: $cenv{'internal.autoend'}=$args->{'enrollend'};
10263: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10264: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10265: if ($args->{'showphotos'}) {
10266: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10267: }
10268: $cenv{'internal.authtype'} = $args->{'authtype'};
10269: $cenv{'internal.autharg'} = $args->{'autharg'};
10270: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10271: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10272: 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');
10273: if ($context eq 'auto') {
10274: $outcome .= $krb_msg;
10275: } else {
1.566 albertel 10276: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10277: }
10278: $outcome .= $linefeed;
1.444 albertel 10279: }
10280: }
10281: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10282: if ($args->{'setpolicy'}) {
10283: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10284: }
10285: if ($args->{'setcontent'}) {
10286: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10287: }
10288: }
10289: if ($args->{'reshome'}) {
10290: $cenv{'reshome'}=$args->{'reshome'}.'/';
10291: $cenv{'reshome'}=~s/\/+$/\//;
10292: }
10293: #
10294: # course has keyed access
10295: #
10296: if ($args->{'setkeys'}) {
10297: $cenv{'keyaccess'}='yes';
10298: }
10299: # if specified, key authority is not course, but user
10300: # only active if keyaccess is yes
10301: if ($args->{'keyauth'}) {
1.487 albertel 10302: my ($user,$domain) = split(':',$args->{'keyauth'});
10303: $user = &LONCAPA::clean_username($user);
10304: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10305: if ($user ne '' && $domain ne '') {
1.487 albertel 10306: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10307: }
10308: }
10309:
10310: if ($args->{'disresdis'}) {
10311: $cenv{'pch.roles.denied'}='st';
10312: }
10313: if ($args->{'disablechat'}) {
10314: $cenv{'plc.roles.denied'}='st';
10315: }
10316:
10317: # Record we've not yet viewed the Course Initialization Helper for this
10318: # course
10319: $cenv{'course.helper.not.run'} = 1;
10320: #
10321: # Use new Randomseed
10322: #
10323: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10324: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10325: #
10326: # The encryption code and receipt prefix for this course
10327: #
10328: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10329: $cenv{'internal.encpref'}=100+int(9*rand(99));
10330: #
10331: # By default, use standard grading
10332: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10333:
1.541 raeburn 10334: $outcome .= $linefeed.&mt('Setting environment').': '.
10335: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10336: #
10337: # Open all assignments
10338: #
10339: if ($args->{'openall'}) {
10340: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10341: my %storecontent = ($storeunder => time,
10342: $storeunder.'.type' => 'date_start');
10343:
10344: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10345: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10346: }
10347: #
10348: # Set first page
10349: #
10350: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10351: || ($cloneid)) {
1.445 albertel 10352: use LONCAPA::map;
1.444 albertel 10353: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10354:
10355: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10356: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10357:
1.444 albertel 10358: $outcome .= ($fatal?$errtext:'read ok').' - ';
10359: my $title; my $url;
10360: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10361: $title=&mt('Syllabus');
1.444 albertel 10362: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10363: } else {
1.690 bisitz 10364: $title=&mt('Navigate Contents');
1.444 albertel 10365: $url='/adm/navmaps';
10366: }
1.445 albertel 10367:
10368: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10369: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10370:
10371: if ($errtext) { $fatal=2; }
1.541 raeburn 10372: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10373: }
1.566 albertel 10374:
10375: return (1,$outcome);
1.444 albertel 10376: }
10377:
10378: ############################################################
10379: ############################################################
10380:
1.378 raeburn 10381: sub course_type {
10382: my ($cid) = @_;
10383: if (!defined($cid)) {
10384: $cid = $env{'request.course.id'};
10385: }
1.404 albertel 10386: if (defined($env{'course.'.$cid.'.type'})) {
10387: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10388: } else {
10389: return 'Course';
1.377 raeburn 10390: }
10391: }
1.156 albertel 10392:
1.406 raeburn 10393: sub group_term {
10394: my $crstype = &course_type();
10395: my %names = (
10396: 'Course' => 'group',
1.865 raeburn 10397: 'Community' => 'group',
1.406 raeburn 10398: );
10399: return $names{$crstype};
10400: }
10401:
1.902 raeburn 10402: sub course_types {
10403: my @types = ('official','unofficial','community');
10404: my %typename = (
10405: official => 'Official course',
10406: unofficial => 'Unofficial course',
10407: community => 'Community',
10408: );
10409: return (\@types,\%typename);
10410: }
10411:
1.156 albertel 10412: sub icon {
10413: my ($file)=@_;
1.505 albertel 10414: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10415: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10416: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10417: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10418: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10419: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10420: $curfext.".gif") {
10421: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10422: $curfext.".gif";
10423: }
10424: }
1.249 albertel 10425: return &lonhttpdurl($iconname);
1.154 albertel 10426: }
1.84 albertel 10427:
1.575 albertel 10428: sub lonhttpdurl {
1.692 www 10429: #
10430: # Had been used for "small fry" static images on separate port 8080.
10431: # Modify here if lightweight http functionality desired again.
10432: # Currently eliminated due to increasing firewall issues.
10433: #
1.575 albertel 10434: my ($url)=@_;
1.692 www 10435: return $url;
1.215 albertel 10436: }
10437:
1.213 albertel 10438: sub connection_aborted {
10439: my ($r)=@_;
10440: $r->print(" ");$r->rflush();
10441: my $c = $r->connection;
10442: return $c->aborted();
10443: }
10444:
1.221 foxr 10445: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10446: # strings as 'strings'.
10447: sub escape_single {
1.221 foxr 10448: my ($input) = @_;
1.223 albertel 10449: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10450: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10451: return $input;
10452: }
1.223 albertel 10453:
1.222 foxr 10454: # Same as escape_single, but escape's "'s This
10455: # can be used for "strings"
10456: sub escape_double {
10457: my ($input) = @_;
10458: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10459: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10460: return $input;
10461: }
1.223 albertel 10462:
1.222 foxr 10463: # Escapes the last element of a full URL.
10464: sub escape_url {
10465: my ($url) = @_;
1.238 raeburn 10466: my @urlslices = split(/\//, $url,-1);
1.369 www 10467: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10468: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10469: }
1.462 albertel 10470:
1.820 raeburn 10471: sub compare_arrays {
10472: my ($arrayref1,$arrayref2) = @_;
10473: my (@difference,%count);
10474: @difference = ();
10475: %count = ();
10476: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10477: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10478: foreach my $element (keys(%count)) {
10479: if ($count{$element} == 1) {
10480: push(@difference,$element);
10481: }
10482: }
10483: }
10484: return @difference;
10485: }
10486:
1.817 bisitz 10487: # -------------------------------------------------------- Initialize user login
1.462 albertel 10488: sub init_user_environment {
1.463 albertel 10489: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10490: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10491:
10492: my $public=($username eq 'public' && $domain eq 'public');
10493:
10494: # See if old ID present, if so, remove
10495:
10496: my ($filename,$cookie,$userroles);
10497: my $now=time;
10498:
10499: if ($public) {
10500: my $max_public=100;
10501: my $oldest;
10502: my $oldest_time=0;
10503: for(my $next=1;$next<=$max_public;$next++) {
10504: if (-e $lonids."/publicuser_$next.id") {
10505: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10506: if ($mtime<$oldest_time || !$oldest_time) {
10507: $oldest_time=$mtime;
10508: $oldest=$next;
10509: }
10510: } else {
10511: $cookie="publicuser_$next";
10512: last;
10513: }
10514: }
10515: if (!$cookie) { $cookie="publicuser_$oldest"; }
10516: } else {
1.463 albertel 10517: # if this isn't a robot, kill any existing non-robot sessions
10518: if (!$args->{'robot'}) {
10519: opendir(DIR,$lonids);
10520: while ($filename=readdir(DIR)) {
10521: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10522: unlink($lonids.'/'.$filename);
10523: }
1.462 albertel 10524: }
1.463 albertel 10525: closedir(DIR);
1.462 albertel 10526: }
10527: # Give them a new cookie
1.463 albertel 10528: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10529: : $now.$$.int(rand(10000)));
1.463 albertel 10530: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10531:
10532: # Initialize roles
10533:
10534: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10535: }
10536: # ------------------------------------ Check browser type and MathML capability
10537:
10538: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10539: $clientunicode,$clientos) = &decode_user_agent($r);
10540:
10541: # ------------------------------------------------------------- Get environment
10542:
10543: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10544: my ($tmp) = keys(%userenv);
10545: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10546: # default remote control to off
10547: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10548: } else {
10549: undef(%userenv);
10550: }
10551: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10552: $form->{'interface'}=$userenv{'interface'};
10553: }
10554: $env{'environment.remote'}=$userenv{'remote'};
10555: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10556:
10557: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10558: foreach my $option ('interface','localpath','localres') {
10559: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10560: }
10561: # --------------------------------------------------------- Write first profile
10562:
10563: {
10564: my %initial_env =
10565: ("user.name" => $username,
10566: "user.domain" => $domain,
10567: "user.home" => $authhost,
10568: "browser.type" => $clientbrowser,
10569: "browser.version" => $clientversion,
10570: "browser.mathml" => $clientmathml,
10571: "browser.unicode" => $clientunicode,
10572: "browser.os" => $clientos,
10573: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10574: "request.course.fn" => '',
10575: "request.course.uri" => '',
10576: "request.course.sec" => '',
10577: "request.role" => 'cm',
10578: "request.role.adv" => $env{'user.adv'},
10579: "request.host" => $ENV{'REMOTE_ADDR'},);
10580:
10581: if ($form->{'localpath'}) {
10582: $initial_env{"browser.localpath"} = $form->{'localpath'};
10583: $initial_env{"browser.localres"} = $form->{'localres'};
10584: }
10585:
10586: if ($public) {
10587: $initial_env{"environment.remote"} = "off";
10588: }
10589: if ($form->{'interface'}) {
10590: $form->{'interface'}=~s/\W//gs;
10591: $initial_env{"browser.interface"} = $form->{'interface'};
10592: $env{'browser.interface'}=$form->{'interface'};
10593: }
10594:
1.724 raeburn 10595: foreach my $tool ('aboutme','blog','portfolio') {
10596: $userenv{'availabletools.'.$tool} =
10597: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10598: }
10599:
1.864 raeburn 10600: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10601: $userenv{'canrequest.'.$crstype} =
10602: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10603: 'reload','requestcourses');
10604: }
10605:
1.462 albertel 10606: $env{'user.environment'} = "$lonids/$cookie.id";
10607:
10608: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10609: &GDBM_WRCREAT(),0640)) {
10610: &_add_to_env(\%disk_env,\%initial_env);
10611: &_add_to_env(\%disk_env,\%userenv,'environment.');
10612: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10613: if (ref($args->{'extra_env'})) {
10614: &_add_to_env(\%disk_env,$args->{'extra_env'});
10615: }
1.462 albertel 10616: untie(%disk_env);
10617: } else {
1.705 tempelho 10618: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10619: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10620: return 'error: '.$!;
10621: }
10622: }
10623: $env{'request.role'}='cm';
10624: $env{'request.role.adv'}=$env{'user.adv'};
10625: $env{'browser.type'}=$clientbrowser;
10626:
10627: return $cookie;
10628:
10629: }
10630:
10631: sub _add_to_env {
10632: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10633: if (ref($env_data) eq 'HASH') {
10634: while (my ($key,$value) = each(%$env_data)) {
10635: $idf->{$prefix.$key} = $value;
10636: $env{$prefix.$key} = $value;
10637: }
1.462 albertel 10638: }
10639: }
10640:
1.685 tempelho 10641: # --- Get the symbolic name of a problem and the url
10642: sub get_symb {
10643: my ($request,$silent) = @_;
1.726 raeburn 10644: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10645: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10646: if ($symb eq '') {
10647: if (!$silent) {
10648: $request->print("Unable to handle ambiguous references:$url:.");
10649: return ();
10650: }
10651: }
10652: &Apache::lonenc::check_decrypt(\$symb);
10653: return ($symb);
10654: }
10655:
10656: # --------------------------------------------------------------Get annotation
10657:
10658: sub get_annotation {
10659: my ($symb,$enc) = @_;
10660:
10661: my $key = $symb;
10662: if (!$enc) {
10663: $key =
10664: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10665: }
10666: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10667: return $annotation{$key};
10668: }
10669:
10670: sub clean_symb {
1.731 raeburn 10671: my ($symb,$delete_enc) = @_;
1.685 tempelho 10672:
10673: &Apache::lonenc::check_decrypt(\$symb);
10674: my $enc = $env{'request.enc'};
1.731 raeburn 10675: if ($delete_enc) {
1.730 raeburn 10676: delete($env{'request.enc'});
10677: }
1.685 tempelho 10678:
10679: return ($symb,$enc);
10680: }
1.462 albertel 10681:
1.41 ng 10682: =pod
10683:
10684: =back
10685:
1.112 bowersj2 10686: =cut
1.41 ng 10687:
1.112 bowersj2 10688: 1;
10689: __END__;
1.41 ng 10690:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>