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