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