Annotation of loncom/interface/loncommon.pm, revision 1.936
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.936 ! bisitz 4: # $Id: loncommon.pm,v 1.935 2010/01/30 22:40:43 bisitz Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 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.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
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: $!");
1.928 bisitz 1722: $r->print(
1723: '<p class="LC_error">'
1724: .&mt('Problems occurred in creating the new Excel file.')
1725: .' '.&mt('This error has been logged.')
1726: .' '.&mt('Please alert your LON-CAPA administrator.')
1727: .'</p>'
1728: );
1.255 matthew 1729: return (undef);
1730: }
1731: #
1732: $workbook->set_tempdir('/home/httpd/perl/tmp');
1733: #
1734: my $format = &Apache::loncommon::define_excel_formats($workbook);
1735: return ($workbook,$filename,$format);
1736: }
1737:
1738: ###############################################################
1739: ###############################################################
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &create_text_file()
1.113 bowersj2 1744:
1.542 raeburn 1745: Create a file to write to and eventually make available to the user.
1.256 matthew 1746: If file creation fails, outputs an error message on the request object and
1747: return undefs.
1.113 bowersj2 1748:
1.256 matthew 1749: Inputs: Apache request object, and file suffix
1.113 bowersj2 1750:
1.256 matthew 1751: Returns (undef) on failure,
1752: Filehandle and filename on success.
1.113 bowersj2 1753:
1754: =cut
1755:
1.256 matthew 1756: ###############################################################
1757: ###############################################################
1758: sub create_text_file {
1759: my ($r,$suffix) = @_;
1760: if (! defined($suffix)) { $suffix = 'txt'; };
1761: my $fh;
1762: my $filename = '/prtspool/'.
1.258 albertel 1763: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1764: time.'_'.rand(1000000000).'.'.$suffix;
1765: $fh = Apache::File->new('>/home/httpd'.$filename);
1766: if (! defined($fh)) {
1767: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1768: $r->print(
1769: '<p class="LC_error">'
1770: .&mt('Problems occurred in creating the output file.')
1771: .' '.&mt('This error has been logged.')
1772: .' '.&mt('Please alert your LON-CAPA administrator.')
1773: .'</p>'
1774: );
1.113 bowersj2 1775: }
1.256 matthew 1776: return ($fh,$filename)
1.113 bowersj2 1777: }
1778:
1779:
1.256 matthew 1780: =pod
1.113 bowersj2 1781:
1782: =back
1783:
1784: =cut
1.37 matthew 1785:
1786: ###############################################################
1.33 matthew 1787: ## Home server <option> list generating code ##
1788: ###############################################################
1.35 matthew 1789:
1.169 www 1790: # ------------------------------------------
1791:
1792: sub domain_select {
1793: my ($name,$value,$multiple)=@_;
1794: my %domains=map {
1.514 albertel 1795: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1796: } &Apache::lonnet::all_domains();
1.169 www 1797: if ($multiple) {
1798: $domains{''}=&mt('Any domain');
1.550 albertel 1799: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1800: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1801: } else {
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1803: return &select_form($name,$value,%domains);
1804: }
1805: }
1806:
1.282 albertel 1807: #-------------------------------------------
1808:
1809: =pod
1810:
1.519 raeburn 1811: =head1 Routines for form select boxes
1812:
1813: =over 4
1814:
1.648 raeburn 1815: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1816:
1817: Returns a string containing a <select> element int multiple mode
1818:
1819:
1820: Args:
1821: $name - name of the <select> element
1.506 raeburn 1822: $value - scalar or array ref of values that should already be selected
1.282 albertel 1823: $size - number of rows long the select element is
1.283 albertel 1824: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1825: (shown text should already have been &mt())
1.506 raeburn 1826: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1827:
1.282 albertel 1828: =cut
1829:
1830: #-------------------------------------------
1.169 www 1831: sub multiple_select_form {
1.284 albertel 1832: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1833: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1834: my $output='';
1.191 matthew 1835: if (! defined($size)) {
1836: $size = 4;
1.283 albertel 1837: if (scalar(keys(%$hash))<4) {
1838: $size = scalar(keys(%$hash));
1.191 matthew 1839: }
1840: }
1.734 bisitz 1841: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1842: my @order;
1.506 raeburn 1843: if (ref($order) eq 'ARRAY') {
1844: @order = @{$order};
1845: } else {
1846: @order = sort(keys(%$hash));
1.501 banghart 1847: }
1848: if (exists($$hash{'select_form_order'})) {
1849: @order = @{$$hash{'select_form_order'}};
1850: }
1851:
1.284 albertel 1852: foreach my $key (@order) {
1.356 albertel 1853: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1854: $output.='selected="selected" ' if ($selected{$key});
1855: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1856: }
1857: $output.="</select>\n";
1858: return $output;
1859: }
1860:
1.88 www 1861: #-------------------------------------------
1862:
1863: =pod
1864:
1.648 raeburn 1865: =item * &select_form($defdom,$name,%hash)
1.88 www 1866:
1867: Returns a string containing a <select name='$name' size='1'> form to
1868: allow a user to select options from a hash option_name => displayed text.
1869: See lonrights.pm for an example invocation and use.
1870:
1871: =cut
1872:
1873: #-------------------------------------------
1874: sub select_form {
1875: my ($def,$name,%hash) = @_;
1876: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1877: my @keys;
1878: if (exists($hash{'select_form_order'})) {
1879: @keys=@{$hash{'select_form_order'}};
1880: } else {
1881: @keys=sort(keys(%hash));
1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1887: ">".$hash{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1905: ('currentfolder' => 'Current folder/page',
1906: 'containing' => 'Containing phrase',
1907: 'none' => 'None'))).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: 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.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
2277: var i=0;
2278: while (i < currentform.login.length) {
2279: if (currentform.login[i].value == newvalue) { break; }
2280: i++;
2281: }
2282: if (i == currentform.login.length) {
2283: return;
2284: }
2285: current.radiovalue = newvalue;
2286: currentform.login[i].checked = true;
2287: return;
2288: }
2289: END
2290: return $result;
2291: }
2292:
2293: sub authform_authorwarning{
2294: my $result='';
1.144 matthew 2295: $result='<i>'.
2296: &mt('As a general rule, only authors or co-authors should be '.
2297: 'filesystem authenticated '.
2298: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2299: return $result;
2300: }
2301:
2302: sub authform_nochange{
2303: my %in = (
2304: formname => 'document.cu',
2305: kerb_def_dom => 'MSU.EDU',
2306: @_,
2307: );
1.586 raeburn 2308: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2309: my $result;
2310: if (keys(%can_assign) == 0) {
2311: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2312: } else {
2313: $result = '<label>'.&mt('[_1] Do not change login data',
2314: '<input type="radio" name="login" value="nochange" '.
2315: 'checked="checked" onclick="'.
1.281 albertel 2316: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2317: '</label>';
1.586 raeburn 2318: }
1.32 matthew 2319: return $result;
2320: }
2321:
1.591 raeburn 2322: sub authform_kerberos {
1.32 matthew 2323: my %in = (
2324: formname => 'document.cu',
2325: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2326: kerb_def_auth => 'krb4',
1.32 matthew 2327: @_,
2328: );
1.586 raeburn 2329: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2330: $autharg,$jscall);
2331: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2332: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2333: $check5 = ' checked="checked"';
1.80 albertel 2334: } else {
1.772 bisitz 2335: $check4 = ' checked="checked"';
1.80 albertel 2336: }
1.165 raeburn 2337: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2338: if (defined($in{'curr_authtype'})) {
2339: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2340: $krbcheck = ' checked="checked"';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $krbcheck = '';
2344: }
2345: }
1.591 raeburn 2346: if (defined($in{'curr_kerb_ver'})) {
2347: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2348: $check5 = ' checked="checked"';
1.591 raeburn 2349: $check4 = '';
2350: } else {
1.772 bisitz 2351: $check4 = ' checked="checked"';
1.591 raeburn 2352: $check5 = '';
2353: }
1.586 raeburn 2354: }
1.591 raeburn 2355: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2356: $krbarg = $in{'curr_autharg'};
2357: }
1.586 raeburn 2358: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2360: $result =
2361: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2362: $in{'curr_autharg'},$krbver);
2363: } else {
2364: $result =
2365: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2366: }
2367: return $result;
2368: }
2369: }
2370: } else {
2371: if ($authnum == 1) {
1.784 bisitz 2372: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2373: }
2374: }
1.586 raeburn 2375: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2376: return;
1.587 raeburn 2377: } elsif ($authtype eq '') {
1.591 raeburn 2378: if (defined($in{'mode'})) {
1.587 raeburn 2379: if ($in{'mode'} eq 'modifycourse') {
2380: if ($authnum == 1) {
1.784 bisitz 2381: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2382: }
2383: }
2384: }
1.586 raeburn 2385: }
2386: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2387: if ($authtype eq '') {
2388: $authtype = '<input type="radio" name="login" value="krb" '.
2389: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2390: $krbcheck.' />';
2391: }
2392: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2393: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb5') ||
2395: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2396: $in{'curr_authtype'} eq 'krb4')) {
2397: $result .= &mt
1.144 matthew 2398: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2399: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2400: '<label>'.$authtype,
1.281 albertel 2401: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2402: 'value="'.$krbarg.'" '.
1.144 matthew 2403: 'onchange="'.$jscall.'" />',
1.281 albertel 2404: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2405: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2406: '</label>');
1.586 raeburn 2407: } elsif ($can_assign{'krb4'}) {
2408: $result .= &mt
2409: ('[_1] Kerberos authenticated with domain [_2] '.
2410: '[_3] Version 4 [_4]',
2411: '<label>'.$authtype,
2412: '</label><input type="text" size="10" name="krbarg" '.
2413: 'value="'.$krbarg.'" '.
2414: 'onchange="'.$jscall.'" />',
2415: '<label><input type="hidden" name="krbver" value="4" />',
2416: '</label>');
2417: } elsif ($can_assign{'krb5'}) {
2418: $result .= &mt
2419: ('[_1] Kerberos authenticated with domain [_2] '.
2420: '[_3] Version 5 [_4]',
2421: '<label>'.$authtype,
2422: '</label><input type="text" size="10" name="krbarg" '.
2423: 'value="'.$krbarg.'" '.
2424: 'onchange="'.$jscall.'" />',
2425: '<label><input type="hidden" name="krbver" value="5" />',
2426: '</label>');
2427: }
1.32 matthew 2428: return $result;
2429: }
2430:
2431: sub authform_internal{
1.586 raeburn 2432: my %in = (
1.32 matthew 2433: formname => 'document.cu',
2434: kerb_def_dom => 'MSU.EDU',
2435: @_,
2436: );
1.586 raeburn 2437: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2438: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2439: if (defined($in{'curr_authtype'})) {
2440: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2441: if ($can_assign{'int'}) {
1.772 bisitz 2442: $intcheck = 'checked="checked" ';
1.623 raeburn 2443: if (defined($in{'mode'})) {
2444: if ($in{'mode'} eq 'modifyuser') {
2445: $intcheck = '';
2446: }
2447: }
1.591 raeburn 2448: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2449: $intarg = $in{'curr_autharg'};
2450: }
2451: } else {
2452: $result = &mt('Currently internally authenticated.');
2453: return $result;
1.165 raeburn 2454: }
2455: }
1.586 raeburn 2456: } else {
2457: if ($authnum == 1) {
1.784 bisitz 2458: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2459: }
2460: }
2461: if (!$can_assign{'int'}) {
2462: return;
1.587 raeburn 2463: } elsif ($authtype eq '') {
1.591 raeburn 2464: if (defined($in{'mode'})) {
1.587 raeburn 2465: if ($in{'mode'} eq 'modifycourse') {
2466: if ($authnum == 1) {
1.784 bisitz 2467: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2468: }
2469: }
2470: }
1.165 raeburn 2471: }
1.586 raeburn 2472: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2473: if ($authtype eq '') {
2474: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2475: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2476: }
1.605 bisitz 2477: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2478: $intarg.'" onchange="'.$jscall.'" />';
2479: $result = &mt
1.144 matthew 2480: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2481: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2482: $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 2483: return $result;
2484: }
2485:
2486: sub authform_local{
2487: my %in = (
2488: formname => 'document.cu',
2489: kerb_def_dom => 'MSU.EDU',
2490: @_,
2491: );
1.586 raeburn 2492: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2494: if (defined($in{'curr_authtype'})) {
2495: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2496: if ($can_assign{'loc'}) {
1.772 bisitz 2497: $loccheck = 'checked="checked" ';
1.623 raeburn 2498: if (defined($in{'mode'})) {
2499: if ($in{'mode'} eq 'modifyuser') {
2500: $loccheck = '';
2501: }
2502: }
1.591 raeburn 2503: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2504: $locarg = $in{'curr_autharg'};
2505: }
2506: } else {
2507: $result = &mt('Currently using local (institutional) authentication.');
2508: return $result;
1.165 raeburn 2509: }
2510: }
1.586 raeburn 2511: } else {
2512: if ($authnum == 1) {
1.784 bisitz 2513: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2514: }
2515: }
2516: if (!$can_assign{'loc'}) {
2517: return;
1.587 raeburn 2518: } elsif ($authtype eq '') {
1.591 raeburn 2519: if (defined($in{'mode'})) {
1.587 raeburn 2520: if ($in{'mode'} eq 'modifycourse') {
2521: if ($authnum == 1) {
1.784 bisitz 2522: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2523: }
2524: }
2525: }
1.165 raeburn 2526: }
1.586 raeburn 2527: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2528: if ($authtype eq '') {
2529: $authtype = '<input type="radio" name="login" value="loc" '.
2530: $loccheck.' onchange="'.$jscall.'" onclick="'.
2531: $jscall.'" />';
2532: }
2533: $autharg = '<input type="text" size="10" name="locarg" value="'.
2534: $locarg.'" onchange="'.$jscall.'" />';
2535: $result = &mt('[_1] Local Authentication with argument [_2]',
2536: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2537: return $result;
2538: }
2539:
2540: sub authform_filesystem{
2541: my %in = (
2542: formname => 'document.cu',
2543: kerb_def_dom => 'MSU.EDU',
2544: @_,
2545: );
1.586 raeburn 2546: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2547: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2548: if (defined($in{'curr_authtype'})) {
2549: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2550: if ($can_assign{'fsys'}) {
1.772 bisitz 2551: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2552: if (defined($in{'mode'})) {
2553: if ($in{'mode'} eq 'modifyuser') {
2554: $fsyscheck = '';
2555: }
2556: }
1.586 raeburn 2557: } else {
2558: $result = &mt('Currently Filesystem Authenticated.');
2559: return $result;
2560: }
2561: }
2562: } else {
2563: if ($authnum == 1) {
1.784 bisitz 2564: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2565: }
2566: }
2567: if (!$can_assign{'fsys'}) {
2568: return;
1.587 raeburn 2569: } elsif ($authtype eq '') {
1.591 raeburn 2570: if (defined($in{'mode'})) {
1.587 raeburn 2571: if ($in{'mode'} eq 'modifycourse') {
2572: if ($authnum == 1) {
1.784 bisitz 2573: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2574: }
2575: }
2576: }
1.586 raeburn 2577: }
2578: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2579: if ($authtype eq '') {
2580: $authtype = '<input type="radio" name="login" value="fsys" '.
2581: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2582: $jscall.'" />';
2583: }
2584: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2585: ' onchange="'.$jscall.'" />';
2586: $result = &mt
1.144 matthew 2587: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2588: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2589: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2590: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2591: 'onchange="'.$jscall.'" />');
1.32 matthew 2592: return $result;
2593: }
2594:
1.586 raeburn 2595: sub get_assignable_auth {
2596: my ($dom) = @_;
2597: if ($dom eq '') {
2598: $dom = $env{'request.role.domain'};
2599: }
2600: my %can_assign = (
2601: krb4 => 1,
2602: krb5 => 1,
2603: int => 1,
2604: loc => 1,
2605: );
2606: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2607: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2608: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2609: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2610: my $context;
2611: if ($env{'request.role'} =~ /^au/) {
2612: $context = 'author';
2613: } elsif ($env{'request.role'} =~ /^dc/) {
2614: $context = 'domain';
2615: } elsif ($env{'request.course.id'}) {
2616: $context = 'course';
2617: }
2618: if ($context) {
2619: if (ref($authhash->{$context}) eq 'HASH') {
2620: %can_assign = %{$authhash->{$context}};
2621: }
2622: }
2623: }
2624: }
2625: my $authnum = 0;
2626: foreach my $key (keys(%can_assign)) {
2627: if ($can_assign{$key}) {
2628: $authnum ++;
2629: }
2630: }
2631: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2632: $authnum --;
2633: }
2634: return ($authnum,%can_assign);
2635: }
2636:
1.80 albertel 2637: ###############################################################
2638: ## Get Kerberos Defaults for Domain ##
2639: ###############################################################
2640: ##
2641: ## Returns default kerberos version and an associated argument
2642: ## as listed in file domain.tab. If not listed, provides
2643: ## appropriate default domain and kerberos version.
2644: ##
2645: #-------------------------------------------
2646:
2647: =pod
2648:
1.648 raeburn 2649: =item * &get_kerberos_defaults()
1.80 albertel 2650:
2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2652: version and domain. If not found, it defaults to version 4 and the
2653: domain of the server.
1.80 albertel 2654:
1.648 raeburn 2655: =over 4
2656:
1.80 albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2658:
1.648 raeburn 2659: =back
2660:
2661: =back
2662:
1.80 albertel 2663: =cut
2664:
2665: #-------------------------------------------
2666: sub get_kerberos_defaults {
2667: my $domain=shift;
1.641 raeburn 2668: my ($krbdef,$krbdefdom);
2669: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2670: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2671: $krbdef = $domdefaults{'auth_def'};
2672: $krbdefdom = $domdefaults{'auth_arg_def'};
2673: } else {
1.80 albertel 2674: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2675: my $krbdefdom=$1;
2676: $krbdefdom=~tr/a-z/A-Z/;
2677: $krbdef = "krb4";
2678: }
2679: return ($krbdef,$krbdefdom);
2680: }
1.112 bowersj2 2681:
1.32 matthew 2682:
1.46 matthew 2683: ###############################################################
2684: ## Thesaurus Functions ##
2685: ###############################################################
1.20 www 2686:
1.46 matthew 2687: =pod
1.20 www 2688:
1.112 bowersj2 2689: =head1 Thesaurus Functions
2690:
2691: =over 4
2692:
1.648 raeburn 2693: =item * &initialize_keywords()
1.46 matthew 2694:
2695: Initializes the package variable %Keywords if it is empty. Uses the
2696: package variable $thesaurus_db_file.
2697:
2698: =cut
2699:
2700: ###################################################
2701:
2702: sub initialize_keywords {
2703: return 1 if (scalar keys(%Keywords));
2704: # If we are here, %Keywords is empty, so fill it up
2705: # Make sure the file we need exists...
2706: if (! -e $thesaurus_db_file) {
2707: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2708: " failed because it does not exist");
2709: return 0;
2710: }
2711: # Set up the hash as a database
2712: my %thesaurus_db;
2713: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2714: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2715: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2716: $thesaurus_db_file);
2717: return 0;
2718: }
2719: # Get the average number of appearances of a word.
2720: my $avecount = $thesaurus_db{'average.count'};
2721: # Put keywords (those that appear > average) into %Keywords
2722: while (my ($word,$data)=each (%thesaurus_db)) {
2723: my ($count,undef) = split /:/,$data;
2724: $Keywords{$word}++ if ($count > $avecount);
2725: }
2726: untie %thesaurus_db;
2727: # Remove special values from %Keywords.
1.356 albertel 2728: foreach my $value ('total.count','average.count') {
2729: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2730: }
1.46 matthew 2731: return 1;
2732: }
2733:
2734: ###################################################
2735:
2736: =pod
2737:
1.648 raeburn 2738: =item * &keyword($word)
1.46 matthew 2739:
2740: Returns true if $word is a keyword. A keyword is a word that appears more
2741: than the average number of times in the thesaurus database. Calls
2742: &initialize_keywords
2743:
2744: =cut
2745:
2746: ###################################################
1.20 www 2747:
2748: sub keyword {
1.46 matthew 2749: return if (!&initialize_keywords());
2750: my $word=lc(shift());
2751: $word=~s/\W//g;
2752: return exists($Keywords{$word});
1.20 www 2753: }
1.46 matthew 2754:
2755: ###############################################################
2756:
2757: =pod
1.20 www 2758:
1.648 raeburn 2759: =item * &get_related_words()
1.46 matthew 2760:
1.160 matthew 2761: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2762: an array of words. If the keyword is not in the thesaurus, an empty array
2763: will be returned. The order of the words returned is determined by the
2764: database which holds them.
2765:
2766: Uses global $thesaurus_db_file.
2767:
2768: =cut
2769:
2770: ###############################################################
2771: sub get_related_words {
2772: my $keyword = shift;
2773: my %thesaurus_db;
2774: if (! -e $thesaurus_db_file) {
2775: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2776: "failed because the file does not exist");
2777: return ();
2778: }
2779: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2780: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2781: return ();
2782: }
2783: my @Words=();
1.429 www 2784: my $count=0;
1.46 matthew 2785: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2786: # The first element is the number of times
2787: # the word appears. We do not need it now.
1.429 www 2788: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2789: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2790: my $threshold=$mostfrequentcount/10;
2791: foreach my $possibleword (@RelatedWords) {
2792: my ($word,$wordcount)=split(/\,/,$possibleword);
2793: if ($wordcount>$threshold) {
2794: push(@Words,$word);
2795: $count++;
2796: if ($count>10) { last; }
2797: }
1.20 www 2798: }
2799: }
1.46 matthew 2800: untie %thesaurus_db;
2801: return @Words;
1.14 harris41 2802: }
1.46 matthew 2803:
1.112 bowersj2 2804: =pod
2805:
2806: =back
2807:
2808: =cut
1.61 www 2809:
2810: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2811: =pod
2812:
1.112 bowersj2 2813: =head1 User Name Functions
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &plainname($uname,$udom,$first)
1.81 albertel 2818:
1.112 bowersj2 2819: Takes a users logon name and returns it as a string in
1.226 albertel 2820: "first middle last generation" form
2821: if $first is set to 'lastname' then it returns it as
2822: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2823:
2824: =cut
1.61 www 2825:
1.295 www 2826:
1.81 albertel 2827: ###############################################################
1.61 www 2828: sub plainname {
1.226 albertel 2829: my ($uname,$udom,$first)=@_;
1.537 albertel 2830: return if (!defined($uname) || !defined($udom));
1.295 www 2831: my %names=&getnames($uname,$udom);
1.226 albertel 2832: my $name=&Apache::lonnet::format_name($names{'firstname'},
2833: $names{'middlename'},
2834: $names{'lastname'},
2835: $names{'generation'},$first);
2836: $name=~s/^\s+//;
1.62 www 2837: $name=~s/\s+$//;
2838: $name=~s/\s+/ /g;
1.353 albertel 2839: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2840: return $name;
1.61 www 2841: }
1.66 www 2842:
2843: # -------------------------------------------------------------------- Nickname
1.81 albertel 2844: =pod
2845:
1.648 raeburn 2846: =item * &nickname($uname,$udom)
1.81 albertel 2847:
2848: Gets a users name and returns it as a string as
2849:
2850: ""nickname""
1.66 www 2851:
1.81 albertel 2852: if the user has a nickname or
2853:
2854: "first middle last generation"
2855:
2856: if the user does not
2857:
2858: =cut
1.66 www 2859:
2860: sub nickname {
2861: my ($uname,$udom)=@_;
1.537 albertel 2862: return if (!defined($uname) || !defined($udom));
1.295 www 2863: my %names=&getnames($uname,$udom);
1.68 albertel 2864: my $name=$names{'nickname'};
1.66 www 2865: if ($name) {
2866: $name='"'.$name.'"';
2867: } else {
2868: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2869: $names{'lastname'}.' '.$names{'generation'};
2870: $name=~s/\s+$//;
2871: $name=~s/\s+/ /g;
2872: }
2873: return $name;
2874: }
2875:
1.295 www 2876: sub getnames {
2877: my ($uname,$udom)=@_;
1.537 albertel 2878: return if (!defined($uname) || !defined($udom));
1.433 albertel 2879: if ($udom eq 'public' && $uname eq 'public') {
2880: return ('lastname' => &mt('Public'));
2881: }
1.295 www 2882: my $id=$uname.':'.$udom;
2883: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2884: if ($cached) {
2885: return %{$names};
2886: } else {
2887: my %loadnames=&Apache::lonnet::get('environment',
2888: ['firstname','middlename','lastname','generation','nickname'],
2889: $udom,$uname);
2890: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2891: return %loadnames;
2892: }
2893: }
1.61 www 2894:
1.542 raeburn 2895: # -------------------------------------------------------------------- getemails
1.648 raeburn 2896:
1.542 raeburn 2897: =pod
2898:
1.648 raeburn 2899: =item * &getemails($uname,$udom)
1.542 raeburn 2900:
2901: Gets a user's email information and returns it as a hash with keys:
2902: notification, critnotification, permanentemail
2903:
2904: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2906:
1.648 raeburn 2907:
1.542 raeburn 2908: =cut
2909:
1.648 raeburn 2910:
1.466 albertel 2911: sub getemails {
2912: my ($uname,$udom)=@_;
2913: if ($udom eq 'public' && $uname eq 'public') {
2914: return;
2915: }
1.467 www 2916: if (!$udom) { $udom=$env{'user.domain'}; }
2917: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2918: my $id=$uname.':'.$udom;
2919: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2920: if ($cached) {
2921: return %{$names};
2922: } else {
2923: my %loadnames=&Apache::lonnet::get('environment',
2924: ['notification','critnotification',
2925: 'permanentemail'],
2926: $udom,$uname);
2927: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2928: return %loadnames;
2929: }
2930: }
2931:
1.551 albertel 2932: sub flush_email_cache {
2933: my ($uname,$udom)=@_;
2934: if (!$udom) { $udom =$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: return if ($udom eq 'public' && $uname eq 'public');
2937: my $id=$uname.':'.$udom;
2938: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2939: }
2940:
1.728 raeburn 2941: # -------------------------------------------------------------------- getlangs
2942:
2943: =pod
2944:
2945: =item * &getlangs($uname,$udom)
2946:
2947: Gets a user's language preference and returns it as a hash with key:
2948: language.
2949:
2950: =cut
2951:
2952:
2953: sub getlangs {
2954: my ($uname,$udom) = @_;
2955: if (!$udom) { $udom =$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $id=$uname.':'.$udom;
2958: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2959: if ($cached) {
2960: return %{$langs};
2961: } else {
2962: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2963: $udom,$uname);
2964: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2965: return %loadlangs;
2966: }
2967: }
2968:
2969: sub flush_langs_cache {
2970: my ($uname,$udom)=@_;
2971: if (!$udom) { $udom =$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: return if ($udom eq 'public' && $uname eq 'public');
2974: my $id=$uname.':'.$udom;
2975: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2976: }
2977:
1.61 www 2978: # ------------------------------------------------------------------ Screenname
1.81 albertel 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &screenname($uname,$udom)
1.81 albertel 2983:
2984: Gets a users screenname and returns it as a string
2985:
2986: =cut
1.61 www 2987:
2988: sub screenname {
2989: my ($uname,$udom)=@_;
1.258 albertel 2990: if ($uname eq $env{'user.name'} &&
2991: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2992: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2993: return $names{'screenname'};
1.62 www 2994: }
2995:
1.212 albertel 2996:
1.802 bisitz 2997: # ------------------------------------------------------------- Confirm Wrapper
2998: =pod
2999:
3000: =item confirmwrapper
3001:
3002: Wrap messages about completion of operation in box
3003:
3004: =cut
3005:
3006: sub confirmwrapper {
3007: my ($message)=@_;
3008: if ($message) {
3009: return "\n".'<div class="LC_confirm_box">'."\n"
3010: .$message."\n"
3011: .'</div>'."\n";
3012: } else {
3013: return $message;
3014: }
3015: }
3016:
1.62 www 3017: # ------------------------------------------------------------- Message Wrapper
3018:
3019: sub messagewrapper {
1.369 www 3020: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3021: return
1.441 albertel 3022: '<a href="/adm/email?compose=individual&'.
3023: 'recname='.$username.'&recdom='.$domain.
3024: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3025: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3026: }
1.802 bisitz 3027:
1.74 www 3028: # --------------------------------------------------------------- Notes Wrapper
3029:
3030: sub noteswrapper {
3031: my ($link,$un,$do)=@_;
3032: return
1.896 amueller 3033: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3034: }
1.802 bisitz 3035:
1.62 www 3036: # ------------------------------------------------------------- Aboutme Wrapper
3037:
3038: sub aboutmewrapper {
1.166 www 3039: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3040: if (!defined($username) && !defined($domain)) {
3041: return;
3042: }
1.892 amueller 3043: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3044: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3045: }
3046:
3047: # ------------------------------------------------------------ Syllabus Wrapper
3048:
3049: sub syllabuswrapper {
1.707 bisitz 3050: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3051: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3052: }
1.14 harris41 3053:
1.802 bisitz 3054: # -----------------------------------------------------------------------------
3055:
1.208 matthew 3056: sub track_student_link {
1.887 raeburn 3057: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3058: my $link ="/adm/trackstudent?";
1.208 matthew 3059: my $title = 'View recent activity';
3060: if (defined($sname) && $sname !~ /^\s*$/ &&
3061: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3062: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3063: $title .= ' of this student';
1.268 albertel 3064: }
1.208 matthew 3065: if (defined($target) && $target !~ /^\s*$/) {
3066: $target = qq{target="$target"};
3067: } else {
3068: $target = '';
3069: }
1.268 albertel 3070: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3071: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3072: $title = &mt($title);
3073: $linktext = &mt($linktext);
1.448 albertel 3074: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3075: &help_open_topic('View_recent_activity');
1.208 matthew 3076: }
3077:
1.781 raeburn 3078: sub slot_reservations_link {
3079: my ($linktext,$sname,$sdom,$target) = @_;
3080: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3081: my $title = 'View slot reservation history';
3082: if (defined($sname) && $sname !~ /^\s*$/ &&
3083: defined($sdom) && $sdom !~ /^\s*$/) {
3084: $link .= "&uname=$sname&udom=$sdom";
3085: $title .= ' of this student';
3086: }
3087: if (defined($target) && $target !~ /^\s*$/) {
3088: $target = qq{target="$target"};
3089: } else {
3090: $target = '';
3091: }
3092: $title = &mt($title);
3093: $linktext = &mt($linktext);
3094: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3096:
3097: }
3098:
1.508 www 3099: # ===================================================== Display a student photo
3100:
3101:
1.509 albertel 3102: sub student_image_tag {
1.508 www 3103: my ($domain,$user)=@_;
3104: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3105: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3106: return '<img src="'.$imgsrc.'" align="right" />';
3107: } else {
3108: return '';
3109: }
3110: }
3111:
1.112 bowersj2 3112: =pod
3113:
3114: =back
3115:
3116: =head1 Access .tab File Data
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &languageids()
1.112 bowersj2 3121:
3122: returns list of all language ids
3123:
3124: =cut
3125:
1.14 harris41 3126: sub languageids {
1.16 harris41 3127: return sort(keys(%language));
1.14 harris41 3128: }
3129:
1.112 bowersj2 3130: =pod
3131:
1.648 raeburn 3132: =item * &languagedescription()
1.112 bowersj2 3133:
3134: returns description of a specified language id
3135:
3136: =cut
3137:
1.14 harris41 3138: sub languagedescription {
1.125 www 3139: my $code=shift;
3140: return ($supported_language{$code}?'* ':'').
3141: $language{$code}.
1.126 www 3142: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3143: }
3144:
3145: sub plainlanguagedescription {
3146: my $code=shift;
3147: return $language{$code};
3148: }
3149:
3150: sub supportedlanguagecode {
3151: my $code=shift;
3152: return $supported_language{$code};
1.97 www 3153: }
3154:
1.112 bowersj2 3155: =pod
3156:
1.648 raeburn 3157: =item * ©rightids()
1.112 bowersj2 3158:
3159: returns list of all copyrights
3160:
3161: =cut
3162:
3163: sub copyrightids {
3164: return sort(keys(%cprtag));
3165: }
3166:
3167: =pod
3168:
1.648 raeburn 3169: =item * ©rightdescription()
1.112 bowersj2 3170:
3171: returns description of a specified copyright id
3172:
3173: =cut
3174:
3175: sub copyrightdescription {
1.166 www 3176: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3177: }
1.197 matthew 3178:
3179: =pod
3180:
1.648 raeburn 3181: =item * &source_copyrightids()
1.192 taceyjo1 3182:
3183: returns list of all source copyrights
3184:
3185: =cut
3186:
3187: sub source_copyrightids {
3188: return sort(keys(%scprtag));
3189: }
3190:
3191: =pod
3192:
1.648 raeburn 3193: =item * &source_copyrightdescription()
1.192 taceyjo1 3194:
3195: returns description of a specified source copyright id
3196:
3197: =cut
3198:
3199: sub source_copyrightdescription {
3200: return &mt($scprtag{shift(@_)});
3201: }
1.112 bowersj2 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &filecategories()
1.112 bowersj2 3206:
3207: returns list of all file categories
3208:
3209: =cut
3210:
3211: sub filecategories {
3212: return sort(keys(%category_extensions));
3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &filecategorytypes()
1.112 bowersj2 3218:
3219: returns list of file types belonging to a given file
3220: category
3221:
3222: =cut
3223:
3224: sub filecategorytypes {
1.356 albertel 3225: my ($cat) = @_;
3226: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &fileembstyle()
1.112 bowersj2 3232:
3233: returns embedding style for a specified file type
3234:
3235: =cut
3236:
3237: sub fileembstyle {
3238: return $fe{lc(shift(@_))};
1.169 www 3239: }
3240:
1.351 www 3241: sub filemimetype {
3242: return $fm{lc(shift(@_))};
3243: }
3244:
1.169 www 3245:
3246: sub filecategoryselect {
3247: my ($name,$value)=@_;
1.189 matthew 3248: return &select_form($value,$name,
1.169 www 3249: '' => &mt('Any category'),
3250: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescription()
1.112 bowersj2 3256:
3257: returns description for a specified file type
3258:
3259: =cut
3260:
3261: sub filedescription {
1.188 matthew 3262: my $file_description = $fd{lc(shift())};
3263: $file_description =~ s:([\[\]]):~$1:g;
3264: return &mt($file_description);
1.112 bowersj2 3265: }
3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &filedescriptionex()
1.112 bowersj2 3270:
3271: returns description for a specified file type with
3272: extra formatting
3273:
3274: =cut
3275:
3276: sub filedescriptionex {
3277: my $ex=shift;
1.188 matthew 3278: my $file_description = $fd{lc($ex)};
3279: $file_description =~ s:([\[\]]):~$1:g;
3280: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3281: }
3282:
3283: # End of .tab access
3284: =pod
3285:
3286: =back
3287:
3288: =cut
3289:
3290: # ------------------------------------------------------------------ File Types
3291: sub fileextensions {
3292: return sort(keys(%fe));
3293: }
3294:
1.97 www 3295: # ----------------------------------------------------------- Display Languages
3296: # returns a hash with all desired display languages
3297: #
3298:
3299: sub display_languages {
3300: my %languages=();
1.695 raeburn 3301: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3302: $languages{$lang}=1;
1.97 www 3303: }
3304: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3305: if ($env{'form.displaylanguage'}) {
1.356 albertel 3306: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3307: $languages{$lang}=1;
1.97 www 3308: }
3309: }
3310: return %languages;
1.14 harris41 3311: }
3312:
1.582 albertel 3313: sub languages {
3314: my ($possible_langs) = @_;
1.695 raeburn 3315: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3316: if (!ref($possible_langs)) {
3317: if( wantarray ) {
3318: return @preferred_langs;
3319: } else {
3320: return $preferred_langs[0];
3321: }
3322: }
3323: my %possibilities = map { $_ => 1 } (@$possible_langs);
3324: my @preferred_possibilities;
3325: foreach my $preferred_lang (@preferred_langs) {
3326: if (exists($possibilities{$preferred_lang})) {
3327: push(@preferred_possibilities, $preferred_lang);
3328: }
3329: }
3330: if( wantarray ) {
3331: return @preferred_possibilities;
3332: }
3333: return $preferred_possibilities[0];
3334: }
3335:
1.742 raeburn 3336: sub user_lang {
3337: my ($touname,$toudom,$fromcid) = @_;
3338: my @userlangs;
3339: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3340: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3341: $env{'course.'.$fromcid.'.languages'}));
3342: } else {
3343: my %langhash = &getlangs($touname,$toudom);
3344: if ($langhash{'languages'} ne '') {
3345: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3346: } else {
3347: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3348: if ($domdefs{'lang_def'} ne '') {
3349: @userlangs = ($domdefs{'lang_def'});
3350: }
3351: }
3352: }
3353: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3354: my $user_lh = Apache::localize->get_handle(@languages);
3355: return $user_lh;
3356: }
3357:
3358:
1.112 bowersj2 3359: ###############################################################
3360: ## Student Answer Attempts ##
3361: ###############################################################
3362:
3363: =pod
3364:
3365: =head1 Alternate Problem Views
3366:
3367: =over 4
3368:
1.648 raeburn 3369: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3370: $getattempt, $regexp, $gradesub)
3371:
3372: Return string with previous attempt on problem. Arguments:
3373:
3374: =over 4
3375:
3376: =item * $symb: Problem, including path
3377:
3378: =item * $username: username of the desired student
3379:
3380: =item * $domain: domain of the desired student
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $course: Course ID
1.14 harris41 3383:
1.112 bowersj2 3384: =item * $getattempt: Leave blank for all attempts, otherwise put
3385: something
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $regexp: if string matches this regexp, the string will be
3388: sent to $gradesub
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3391:
1.112 bowersj2 3392: =back
1.14 harris41 3393:
1.112 bowersj2 3394: The output string is a table containing all desired attempts, if any.
1.16 harris41 3395:
1.112 bowersj2 3396: =cut
1.1 albertel 3397:
3398: sub get_previous_attempt {
1.43 ng 3399: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3400: my $prevattempts='';
1.43 ng 3401: no strict 'refs';
1.1 albertel 3402: if ($symb) {
1.3 albertel 3403: my (%returnhash)=
3404: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3405: if ($returnhash{'version'}) {
3406: my %lasthash=();
3407: my $version;
3408: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3409: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3410: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3411: }
1.1 albertel 3412: }
1.596 albertel 3413: $prevattempts=&start_data_table().&start_data_table_header_row();
3414: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3415: foreach my $key (sort(keys(%lasthash))) {
3416: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3417: if ($#parts > 0) {
1.31 albertel 3418: my $data=$parts[-1];
3419: pop(@parts);
1.596 albertel 3420: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3421: } else {
1.41 ng 3422: if ($#parts == 0) {
3423: $prevattempts.='<th>'.$parts[0].'</th>';
3424: } else {
3425: $prevattempts.='<th>'.$ign.'</th>';
3426: }
1.31 albertel 3427: }
1.16 harris41 3428: }
1.596 albertel 3429: $prevattempts.=&end_data_table_header_row();
1.40 ng 3430: if ($getattempt eq '') {
3431: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3432: $prevattempts.=&start_data_table_row().
3433: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3434: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3435: my $value = &format_previous_attempt_value($key,
3436: $returnhash{$version.':'.$key});
3437: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3438: }
1.596 albertel 3439: $prevattempts.=&end_data_table_row();
1.40 ng 3440: }
1.1 albertel 3441: }
1.596 albertel 3442: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3443: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3444: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3445: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3446: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3447: }
1.596 albertel 3448: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3449: } else {
1.596 albertel 3450: $prevattempts=
3451: &start_data_table().&start_data_table_row().
3452: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3453: &end_data_table_row().&end_data_table();
1.1 albertel 3454: }
3455: } else {
1.596 albertel 3456: $prevattempts=
3457: &start_data_table().&start_data_table_row().
3458: '<td>'.&mt('No data.').'</td>'.
3459: &end_data_table_row().&end_data_table();
1.1 albertel 3460: }
1.10 albertel 3461: }
3462:
1.581 albertel 3463: sub format_previous_attempt_value {
3464: my ($key,$value) = @_;
3465: if ($key =~ /timestamp/) {
3466: $value = &Apache::lonlocal::locallocaltime($value);
3467: } elsif (ref($value) eq 'ARRAY') {
3468: $value = '('.join(', ', @{ $value }).')';
3469: } else {
3470: $value = &unescape($value);
3471: }
3472: return $value;
3473: }
3474:
3475:
1.107 albertel 3476: sub relative_to_absolute {
3477: my ($url,$output)=@_;
3478: my $parser=HTML::TokeParser->new(\$output);
3479: my $token;
3480: my $thisdir=$url;
3481: my @rlinks=();
3482: while ($token=$parser->get_token) {
3483: if ($token->[0] eq 'S') {
3484: if ($token->[1] eq 'a') {
3485: if ($token->[2]->{'href'}) {
3486: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3487: }
3488: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3489: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3490: } elsif ($token->[1] eq 'base') {
3491: $thisdir=$token->[2]->{'href'};
3492: }
3493: }
3494: }
3495: $thisdir=~s-/[^/]*$--;
1.356 albertel 3496: foreach my $link (@rlinks) {
1.726 raeburn 3497: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3498: ($link=~/^\//) ||
3499: ($link=~/^javascript:/i) ||
3500: ($link=~/^mailto:/i) ||
3501: ($link=~/^\#/)) {
3502: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3503: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3504: }
3505: }
3506: # -------------------------------------------------- Deal with Applet codebases
3507: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3508: return $output;
3509: }
3510:
1.112 bowersj2 3511: =pod
3512:
1.648 raeburn 3513: =item * &get_student_view()
1.112 bowersj2 3514:
3515: show a snapshot of what student was looking at
3516:
3517: =cut
3518:
1.10 albertel 3519: sub get_student_view {
1.186 albertel 3520: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3521: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3522: my (%form);
1.10 albertel 3523: my @elements=('symb','courseid','domain','username');
3524: foreach my $element (@elements) {
1.186 albertel 3525: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3526: }
1.186 albertel 3527: if (defined($moreenv)) {
3528: %form=(%form,%{$moreenv});
3529: }
1.236 albertel 3530: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3531: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3532: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3533: $userview=~s/\<body[^\>]*\>//gi;
3534: $userview=~s/\<\/body\>//gi;
3535: $userview=~s/\<html\>//gi;
3536: $userview=~s/\<\/html\>//gi;
3537: $userview=~s/\<head\>//gi;
3538: $userview=~s/\<\/head\>//gi;
3539: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3540: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3541: if (wantarray) {
3542: return ($userview,$response);
3543: } else {
3544: return $userview;
3545: }
3546: }
3547:
3548: sub get_student_view_with_retries {
3549: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3550:
3551: my $ok = 0; # True if we got a good response.
3552: my $content;
3553: my $response;
3554:
3555: # Try to get the student_view done. within the retries count:
3556:
3557: do {
3558: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3559: $ok = $response->is_success;
3560: if (!$ok) {
3561: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3562: }
3563: $retries--;
3564: } while (!$ok && ($retries > 0));
3565:
3566: if (!$ok) {
3567: $content = ''; # On error return an empty content.
3568: }
1.651 www 3569: if (wantarray) {
3570: return ($content, $response);
3571: } else {
3572: return $content;
3573: }
1.11 albertel 3574: }
3575:
1.112 bowersj2 3576: =pod
3577:
1.648 raeburn 3578: =item * &get_student_answers()
1.112 bowersj2 3579:
3580: show a snapshot of how student was answering problem
3581:
3582: =cut
3583:
1.11 albertel 3584: sub get_student_answers {
1.100 sakharuk 3585: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3586: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3587: my (%moreenv);
1.11 albertel 3588: my @elements=('symb','courseid','domain','username');
3589: foreach my $element (@elements) {
1.186 albertel 3590: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3591: }
1.186 albertel 3592: $moreenv{'grade_target'}='answer';
3593: %moreenv=(%form,%moreenv);
1.497 raeburn 3594: $feedurl = &Apache::lonnet::clutter($feedurl);
3595: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3596: return $userview;
1.1 albertel 3597: }
1.116 albertel 3598:
3599: =pod
3600:
3601: =item * &submlink()
3602:
1.242 albertel 3603: Inputs: $text $uname $udom $symb $target
1.116 albertel 3604:
3605: Returns: A link to grades.pm such as to see the SUBM view of a student
3606:
3607: =cut
3608:
3609: ###############################################
3610: sub submlink {
1.242 albertel 3611: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3612: if (!($uname && $udom)) {
3613: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3614: &Apache::lonnet::whichuser($symb);
1.116 albertel 3615: if (!$symb) { $symb=$cursymb; }
3616: }
1.254 matthew 3617: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3618: $symb=&escape($symb);
1.242 albertel 3619: if ($target) { $target="target=\"$target\""; }
3620: return '<a href="/adm/grades?&command=submission&'.
3621: 'symb='.$symb.'&student='.$uname.
3622: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3623: }
3624: ##############################################
3625:
3626: =pod
3627:
3628: =item * &pgrdlink()
3629:
3630: Inputs: $text $uname $udom $symb $target
3631:
3632: Returns: A link to grades.pm such as to see the PGRD view of a student
3633:
3634: =cut
3635:
3636: ###############################################
3637: sub pgrdlink {
3638: my $link=&submlink(@_);
3639: $link=~s/(&command=submission)/$1&showgrading=yes/;
3640: return $link;
3641: }
3642: ##############################################
3643:
3644: =pod
3645:
3646: =item * &pprmlink()
3647:
3648: Inputs: $text $uname $udom $symb $target
3649:
3650: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3651: student and a specific resource
1.242 albertel 3652:
3653: =cut
3654:
3655: ###############################################
3656: sub pprmlink {
3657: my ($text,$uname,$udom,$symb,$target)=@_;
3658: if (!($uname && $udom)) {
3659: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3660: &Apache::lonnet::whichuser($symb);
1.242 albertel 3661: if (!$symb) { $symb=$cursymb; }
3662: }
1.254 matthew 3663: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3664: $symb=&escape($symb);
1.242 albertel 3665: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3666: return '<a href="/adm/parmset?command=set&'.
3667: 'symb='.$symb.'&uname='.$uname.
3668: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3669: }
3670: ##############################################
1.37 matthew 3671:
1.112 bowersj2 3672: =pod
3673:
3674: =back
3675:
3676: =cut
3677:
1.37 matthew 3678: ###############################################
1.51 www 3679:
3680:
3681: sub timehash {
1.687 raeburn 3682: my ($thistime) = @_;
3683: my $timezone = &Apache::lonlocal::gettimezone();
3684: my $dt = DateTime->from_epoch(epoch => $thistime)
3685: ->set_time_zone($timezone);
3686: my $wday = $dt->day_of_week();
3687: if ($wday == 7) { $wday = 0; }
3688: return ( 'second' => $dt->second(),
3689: 'minute' => $dt->minute(),
3690: 'hour' => $dt->hour(),
3691: 'day' => $dt->day_of_month(),
3692: 'month' => $dt->month(),
3693: 'year' => $dt->year(),
3694: 'weekday' => $wday,
3695: 'dayyear' => $dt->day_of_year(),
3696: 'dlsav' => $dt->is_dst() );
1.51 www 3697: }
3698:
1.370 www 3699: sub utc_string {
3700: my ($date)=@_;
1.371 www 3701: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3702: }
3703:
1.51 www 3704: sub maketime {
3705: my %th=@_;
1.687 raeburn 3706: my ($epoch_time,$timezone,$dt);
3707: $timezone = &Apache::lonlocal::gettimezone();
3708: eval {
3709: $dt = DateTime->new( year => $th{'year'},
3710: month => $th{'month'},
3711: day => $th{'day'},
3712: hour => $th{'hour'},
3713: minute => $th{'minute'},
3714: second => $th{'second'},
3715: time_zone => $timezone,
3716: );
3717: };
3718: if (!$@) {
3719: $epoch_time = $dt->epoch;
3720: if ($epoch_time) {
3721: return $epoch_time;
3722: }
3723: }
1.51 www 3724: return POSIX::mktime(
3725: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3726: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3727: }
3728:
3729: #########################################
1.51 www 3730:
3731: sub findallcourses {
1.482 raeburn 3732: my ($roles,$uname,$udom) = @_;
1.355 albertel 3733: my %roles;
3734: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3735: my %courses;
1.51 www 3736: my $now=time;
1.482 raeburn 3737: if (!defined($uname)) {
3738: $uname = $env{'user.name'};
3739: }
3740: if (!defined($udom)) {
3741: $udom = $env{'user.domain'};
3742: }
3743: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3744: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3745: if (!%roles) {
3746: %roles = (
3747: cc => 1,
1.907 raeburn 3748: co => 1,
1.482 raeburn 3749: in => 1,
3750: ep => 1,
3751: ta => 1,
3752: cr => 1,
3753: st => 1,
3754: );
3755: }
3756: foreach my $entry (keys(%roleshash)) {
3757: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3758: if ($trole =~ /^cr/) {
3759: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3760: } else {
3761: next if (!exists($roles{$trole}));
3762: }
3763: if ($tend) {
3764: next if ($tend < $now);
3765: }
3766: if ($tstart) {
3767: next if ($tstart > $now);
3768: }
3769: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3770: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3771: if ($secpart eq '') {
3772: ($cnum,$role) = split(/_/,$cnumpart);
3773: $sec = 'none';
3774: $realsec = '';
3775: } else {
3776: $cnum = $cnumpart;
3777: ($sec,$role) = split(/_/,$secpart);
3778: $realsec = $sec;
1.490 raeburn 3779: }
1.482 raeburn 3780: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3781: }
3782: } else {
3783: foreach my $key (keys(%env)) {
1.483 albertel 3784: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3785: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3786: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3787: next if ($role eq 'ca' || $role eq 'aa');
3788: next if (%roles && !exists($roles{$role}));
3789: my ($starttime,$endtime)=split(/\./,$env{$key});
3790: my $active=1;
3791: if ($starttime) {
3792: if ($now<$starttime) { $active=0; }
3793: }
3794: if ($endtime) {
3795: if ($now>$endtime) { $active=0; }
3796: }
3797: if ($active) {
3798: if ($sec eq '') {
3799: $sec = 'none';
3800: }
3801: $courses{$cdom.'_'.$cnum}{$sec} =
3802: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3803: }
3804: }
1.51 www 3805: }
3806: }
1.474 raeburn 3807: return %courses;
1.51 www 3808: }
1.37 matthew 3809:
1.54 www 3810: ###############################################
1.474 raeburn 3811:
3812: sub blockcheck {
1.482 raeburn 3813: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3814:
3815: if (!defined($udom)) {
3816: $udom = $env{'user.domain'};
3817: }
3818: if (!defined($uname)) {
3819: $uname = $env{'user.name'};
3820: }
3821:
3822: # If uname and udom are for a course, check for blocks in the course.
3823:
3824: if (&Apache::lonnet::is_course($udom,$uname)) {
3825: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3826: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3827: return ($startblock,$endblock);
3828: }
1.474 raeburn 3829:
1.502 raeburn 3830: my $startblock = 0;
3831: my $endblock = 0;
1.482 raeburn 3832: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3833:
1.490 raeburn 3834: # If uname is for a user, and activity is course-specific, i.e.,
3835: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3836:
1.490 raeburn 3837: if (($activity eq 'boards' || $activity eq 'chat' ||
3838: $activity eq 'groups') && ($env{'request.course.id'})) {
3839: foreach my $key (keys(%live_courses)) {
3840: if ($key ne $env{'request.course.id'}) {
3841: delete($live_courses{$key});
3842: }
3843: }
3844: }
3845:
3846: my $otheruser = 0;
3847: my %own_courses;
3848: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3849: # Resource belongs to user other than current user.
3850: $otheruser = 1;
3851: # Gather courses for current user
3852: %own_courses =
3853: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3854: }
3855:
3856: # Gather active course roles - course coordinator, instructor,
3857: # exam proctor, ta, student, or custom role.
1.474 raeburn 3858:
3859: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3860: my ($cdom,$cnum);
3861: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3862: $cdom = $env{'course.'.$course.'.domain'};
3863: $cnum = $env{'course.'.$course.'.num'};
3864: } else {
1.490 raeburn 3865: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3866: }
3867: my $no_ownblock = 0;
3868: my $no_userblock = 0;
1.533 raeburn 3869: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3870: # Check if current user has 'evb' priv for this
3871: if (defined($own_courses{$course})) {
3872: foreach my $sec (keys(%{$own_courses{$course}})) {
3873: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3874: if ($sec ne 'none') {
3875: $checkrole .= '/'.$sec;
3876: }
3877: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3878: $no_ownblock = 1;
3879: last;
3880: }
3881: }
3882: }
3883: # if they have 'evb' priv and are currently not playing student
3884: next if (($no_ownblock) &&
3885: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3886: }
1.474 raeburn 3887: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3888: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3889: if ($sec ne 'none') {
1.482 raeburn 3890: $checkrole .= '/'.$sec;
1.474 raeburn 3891: }
1.490 raeburn 3892: if ($otheruser) {
3893: # Resource belongs to user other than current user.
3894: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3895: my ($trole,$tdom,$tnum,$tsec);
3896: my $entry = $live_courses{$course}{$sec};
3897: if ($entry =~ /^cr/) {
3898: ($trole,$tdom,$tnum,$tsec) =
3899: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3900: } else {
3901: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3902: }
3903: my ($spec,$area,$trest,%allroles,%userroles);
3904: $area = '/'.$tdom.'/'.$tnum;
3905: $trest = $tnum;
3906: if ($tsec ne '') {
3907: $area .= '/'.$tsec;
3908: $trest .= '/'.$tsec;
3909: }
3910: $spec = $trole.'.'.$area;
3911: if ($trole =~ /^cr/) {
3912: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3913: $tdom,$spec,$trest,$area);
3914: } else {
3915: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3916: $tdom,$spec,$trest,$area);
3917: }
3918: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3919: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3920: if ($1) {
3921: $no_userblock = 1;
3922: last;
3923: }
3924: }
1.490 raeburn 3925: } else {
3926: # Resource belongs to current user
3927: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3928: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3929: $no_ownblock = 1;
3930: last;
3931: }
1.474 raeburn 3932: }
3933: }
3934: # if they have the evb priv and are currently not playing student
1.482 raeburn 3935: next if (($no_ownblock) &&
1.491 albertel 3936: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3937: next if ($no_userblock);
1.474 raeburn 3938:
1.866 kalberla 3939: # Retrieve blocking times and identity of locker for course
1.490 raeburn 3940: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3941:
3942: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3943: if (($start != 0) &&
3944: (($startblock == 0) || ($startblock > $start))) {
3945: $startblock = $start;
3946: }
3947: if (($end != 0) &&
3948: (($endblock == 0) || ($endblock < $end))) {
3949: $endblock = $end;
3950: }
1.490 raeburn 3951: }
3952: return ($startblock,$endblock);
3953: }
3954:
3955: sub get_blocks {
3956: my ($setters,$activity,$cdom,$cnum) = @_;
3957: my $startblock = 0;
3958: my $endblock = 0;
3959: my $course = $cdom.'_'.$cnum;
3960: $setters->{$course} = {};
3961: $setters->{$course}{'staff'} = [];
3962: $setters->{$course}{'times'} = [];
3963: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3964: foreach my $record (keys(%records)) {
3965: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3966: if ($start <= time && $end >= time) {
3967: my ($staff_name,$staff_dom,$title,$blocks) =
3968: &parse_block_record($records{$record});
3969: if ($blocks->{$activity} eq 'on') {
3970: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3971: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3972: if ( ($startblock == 0) || ($startblock > $start) ) {
3973: $startblock = $start;
1.490 raeburn 3974: }
1.491 albertel 3975: if ( ($endblock == 0) || ($endblock < $end) ) {
3976: $endblock = $end;
1.474 raeburn 3977: }
3978: }
3979: }
3980: }
3981: return ($startblock,$endblock);
3982: }
3983:
3984: sub parse_block_record {
3985: my ($record) = @_;
3986: my ($setuname,$setudom,$title,$blocks);
3987: if (ref($record) eq 'HASH') {
3988: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3989: $title = &unescape($record->{'event'});
3990: $blocks = $record->{'blocks'};
3991: } else {
3992: my @data = split(/:/,$record,3);
3993: if (scalar(@data) eq 2) {
3994: $title = $data[1];
3995: ($setuname,$setudom) = split(/@/,$data[0]);
3996: } else {
3997: ($setuname,$setudom,$title) = @data;
3998: }
3999: $blocks = { 'com' => 'on' };
4000: }
4001: return ($setuname,$setudom,$title,$blocks);
4002: }
4003:
1.854 kalberla 4004: sub blocking_status {
4005: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4006: my %setters;
1.890 droeschl 4007:
4008: # check for active blocking
1.867 kalberla 4009: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4010:
1.890 droeschl 4011: my $blocked = $startblock && $endblock ? 1 : 0;
4012:
4013: # caller just wants to know whether a block is active
4014: if (!wantarray) { return $blocked; }
4015:
4016: # build a link to a popup window containing the details
4017: my $querystring = "?activity=$activity";
4018: # $uname and $udom decide whose portfolio the user is trying to look at
4019: $querystring .= "&udom=$udom" if $udom;
4020: $querystring .= "&uname=$uname" if $uname;
4021:
4022: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4023: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4024: var options = "width=" + w + ",height=" + h + ",";
4025: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4026: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4027: var newWin = window.open(url, wdwName, options);
4028: newWin.focus();
4029: }
1.890 droeschl 4030: END_MYBLOCK
1.854 kalberla 4031:
1.890 droeschl 4032: $output = Apache::lonhtmlcommon::scripttag($output);
4033:
1.854 kalberla 4034: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4035: my $text = mt('Communication Blocked');
4036:
1.867 kalberla 4037: $output .= <<"END_BLOCK";
4038: <div class='LC_comblock'>
1.869 kalberla 4039: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4040: title='$text'>
4041: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4042: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4043: title='$text'>$text</a>
1.867 kalberla 4044: </div>
4045:
4046: END_BLOCK
1.474 raeburn 4047:
1.854 kalberla 4048: return ($blocked, $output);
4049: }
1.490 raeburn 4050:
1.60 matthew 4051: ###############################################
4052:
1.682 raeburn 4053: sub check_ip_acc {
4054: my ($acc)=@_;
4055: &Apache::lonxml::debug("acc is $acc");
4056: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4057: return 1;
4058: }
4059: my $allowed=0;
4060: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4061:
4062: my $name;
4063: foreach my $pattern (split(',',$acc)) {
4064: $pattern =~ s/^\s*//;
4065: $pattern =~ s/\s*$//;
4066: if ($pattern =~ /\*$/) {
4067: #35.8.*
4068: $pattern=~s/\*//;
4069: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4070: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4071: #35.8.3.[34-56]
4072: my $low=$2;
4073: my $high=$3;
4074: $pattern=$1;
4075: if ($ip =~ /^\Q$pattern\E/) {
4076: my $last=(split(/\./,$ip))[3];
4077: if ($last <=$high && $last >=$low) { $allowed=1; }
4078: }
4079: } elsif ($pattern =~ /^\*/) {
4080: #*.msu.edu
4081: $pattern=~s/\*//;
4082: if (!defined($name)) {
4083: use Socket;
4084: my $netaddr=inet_aton($ip);
4085: ($name)=gethostbyaddr($netaddr,AF_INET);
4086: }
4087: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4088: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4089: #127.0.0.1
4090: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4091: } else {
4092: #some.name.com
4093: if (!defined($name)) {
4094: use Socket;
4095: my $netaddr=inet_aton($ip);
4096: ($name)=gethostbyaddr($netaddr,AF_INET);
4097: }
4098: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4099: }
4100: if ($allowed) { last; }
4101: }
4102: return $allowed;
4103: }
4104:
4105: ###############################################
4106:
1.60 matthew 4107: =pod
4108:
1.112 bowersj2 4109: =head1 Domain Template Functions
4110:
4111: =over 4
4112:
4113: =item * &determinedomain()
1.60 matthew 4114:
4115: Inputs: $domain (usually will be undef)
4116:
1.63 www 4117: Returns: Determines which domain should be used for designs
1.60 matthew 4118:
4119: =cut
1.54 www 4120:
1.60 matthew 4121: ###############################################
1.63 www 4122: sub determinedomain {
4123: my $domain=shift;
1.531 albertel 4124: if (! $domain) {
1.60 matthew 4125: # Determine domain if we have not been given one
1.893 raeburn 4126: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4127: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4128: if ($env{'request.role.domain'}) {
4129: $domain=$env{'request.role.domain'};
1.60 matthew 4130: }
4131: }
1.63 www 4132: return $domain;
4133: }
4134: ###############################################
1.517 raeburn 4135:
1.518 albertel 4136: sub devalidate_domconfig_cache {
4137: my ($udom)=@_;
4138: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4139: }
4140:
4141: # ---------------------- Get domain configuration for a domain
4142: sub get_domainconf {
4143: my ($udom) = @_;
4144: my $cachetime=1800;
4145: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4146: if (defined($cached)) { return %{$result}; }
4147:
4148: my %domconfig = &Apache::lonnet::get_dom('configuration',
4149: ['login','rolecolors'],$udom);
1.632 raeburn 4150: my (%designhash,%legacy);
1.518 albertel 4151: if (keys(%domconfig) > 0) {
4152: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4153: if (keys(%{$domconfig{'login'}})) {
4154: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4155: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4156: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4157: $designhash{$udom.'.login.'.$key.'_'.$img} =
4158: $domconfig{'login'}{$key}{$img};
4159: }
4160: } else {
4161: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4162: }
1.632 raeburn 4163: }
4164: } else {
4165: $legacy{'login'} = 1;
1.518 albertel 4166: }
1.632 raeburn 4167: } else {
4168: $legacy{'login'} = 1;
1.518 albertel 4169: }
4170: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4171: if (keys(%{$domconfig{'rolecolors'}})) {
4172: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4173: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4174: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4175: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4176: }
1.518 albertel 4177: }
4178: }
1.632 raeburn 4179: } else {
4180: $legacy{'rolecolors'} = 1;
1.518 albertel 4181: }
1.632 raeburn 4182: } else {
4183: $legacy{'rolecolors'} = 1;
1.518 albertel 4184: }
1.632 raeburn 4185: if (keys(%legacy) > 0) {
4186: my %legacyhash = &get_legacy_domconf($udom);
4187: foreach my $item (keys(%legacyhash)) {
4188: if ($item =~ /^\Q$udom\E\.login/) {
4189: if ($legacy{'login'}) {
4190: $designhash{$item} = $legacyhash{$item};
4191: }
4192: } else {
4193: if ($legacy{'rolecolors'}) {
4194: $designhash{$item} = $legacyhash{$item};
4195: }
1.518 albertel 4196: }
4197: }
4198: }
1.632 raeburn 4199: } else {
4200: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4201: }
4202: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4203: $cachetime);
4204: return %designhash;
4205: }
4206:
1.632 raeburn 4207: sub get_legacy_domconf {
4208: my ($udom) = @_;
4209: my %legacyhash;
4210: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4211: my $designfile = $designdir.'/'.$udom.'.tab';
4212: if (-e $designfile) {
4213: if ( open (my $fh,"<$designfile") ) {
4214: while (my $line = <$fh>) {
4215: next if ($line =~ /^\#/);
4216: chomp($line);
4217: my ($key,$val)=(split(/\=/,$line));
4218: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4219: }
4220: close($fh);
4221: }
4222: }
4223: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4224: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4225: }
4226: return %legacyhash;
4227: }
4228:
1.63 www 4229: =pod
4230:
1.112 bowersj2 4231: =item * &domainlogo()
1.63 www 4232:
4233: Inputs: $domain (usually will be undef)
4234:
4235: Returns: A link to a domain logo, if the domain logo exists.
4236: If the domain logo does not exist, a description of the domain.
4237:
4238: =cut
1.112 bowersj2 4239:
1.63 www 4240: ###############################################
4241: sub domainlogo {
1.517 raeburn 4242: my $domain = &determinedomain(shift);
1.518 albertel 4243: my %designhash = &get_domainconf($domain);
1.517 raeburn 4244: # See if there is a logo
4245: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4246: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4247: if ($imgsrc =~ m{^/(adm|res)/}) {
4248: if ($imgsrc =~ m{^/res/}) {
4249: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4250: &Apache::lonnet::repcopy($local_name);
4251: }
4252: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4253: }
4254: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4255: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4256: return &Apache::lonnet::domain($domain,'description');
1.59 www 4257: } else {
1.60 matthew 4258: return '';
1.59 www 4259: }
4260: }
1.63 www 4261: ##############################################
4262:
4263: =pod
4264:
1.112 bowersj2 4265: =item * &designparm()
1.63 www 4266:
4267: Inputs: $which parameter; $domain (usually will be undef)
4268:
4269: Returns: value of designparamter $which
4270:
4271: =cut
1.112 bowersj2 4272:
1.397 albertel 4273:
1.400 albertel 4274: ##############################################
1.397 albertel 4275: sub designparm {
4276: my ($which,$domain)=@_;
4277: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4278: return $env{'environment.color.'.$which};
1.96 www 4279: }
1.63 www 4280: $domain=&determinedomain($domain);
1.518 albertel 4281: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4282: my $output;
1.517 raeburn 4283: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4284: $output = $domdesign{$domain.'.'.$which};
1.63 www 4285: } else {
1.520 raeburn 4286: $output = $defaultdesign{$which};
4287: }
4288: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4289: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4290: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4291: if ($output =~ m{^/res/}) {
4292: my $local_name = &Apache::lonnet::filelocation('',$output);
4293: &Apache::lonnet::repcopy($local_name);
4294: }
1.520 raeburn 4295: $output = &lonhttpdurl($output);
4296: }
1.63 www 4297: }
1.520 raeburn 4298: return $output;
1.63 www 4299: }
1.59 www 4300:
1.822 bisitz 4301: ##############################################
4302: =pod
4303:
1.832 bisitz 4304: =item * &authorspace()
4305:
4306: Inputs: ./.
4307:
4308: Returns: Path to the Construction Space of the current user's
4309: accessed author space
4310: The author space will be that of the current user
4311: when accessing the own author space
4312: and that of the co-author/assistent co-author
4313: when accessing the co-author's/assistent co-author's
4314: space
4315:
4316: =cut
4317:
4318: sub authorspace {
4319: my $caname = '';
4320: if ($env{'request.role'} =~ /^ca|^aa/) {
4321: (undef,$caname) =
4322: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4323: } else {
4324: $caname = $env{'user.name'};
4325: }
4326: return '/priv/'.$caname.'/';
4327: }
4328:
4329: ##############################################
4330: =pod
4331:
1.822 bisitz 4332: =item * &head_subbox()
4333:
4334: Inputs: $content (contains HTML code with page functions, etc.)
4335:
4336: Returns: HTML div with $content
4337: To be included in page header
4338:
4339: =cut
4340:
4341: sub head_subbox {
4342: my ($content)=@_;
4343: my $output =
1.844 bisitz 4344: '<div id="LC_head_subbox">'
1.822 bisitz 4345: .$content
4346: .'</div>'
4347: }
4348:
4349: ##############################################
4350: =pod
4351:
4352: =item * &CSTR_pageheader()
4353:
4354: Inputs: ./.
4355:
4356: Returns: HTML div with CSTR path and recent box
4357: To be included on Construction Space pages
4358:
4359: =cut
4360:
4361: sub CSTR_pageheader {
4362: # this is for resources; directories have customtitle, and crumbs
4363: # and select recent are created in lonpubdir.pm
4364: my ($uname,$thisdisfn)=
4365: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4366: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4367: $formaction=~s/\/+/\//g;
4368:
4369: my $parentpath = '';
4370: my $lastitem = '';
4371: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4372: $parentpath = $1;
4373: $lastitem = $2;
4374: } else {
4375: $lastitem = $thisdisfn;
4376: }
1.921 bisitz 4377:
4378: my $output =
1.822 bisitz 4379: '<div>'
4380: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4381: .'<b>'.&mt('Construction Space:').'</b> '
4382: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4383: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4384: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4385:
4386: if ($lastitem) {
4387: $output .=
4388: '<span class="LC_filename">'
4389: .$lastitem
4390: .'</span>';
4391: }
4392: $output .=
4393: '<br />'
1.822 bisitz 4394: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4395: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4396: .'</form>'
4397: .&Apache::lonmenu::constspaceform()
4398: .'</div>';
1.921 bisitz 4399:
4400: return $output;
1.822 bisitz 4401: }
4402:
1.60 matthew 4403: ###############################################
4404: ###############################################
4405:
4406: =pod
4407:
1.112 bowersj2 4408: =back
4409:
1.549 albertel 4410: =head1 HTML Helpers
1.112 bowersj2 4411:
4412: =over 4
4413:
4414: =item * &bodytag()
1.60 matthew 4415:
4416: Returns a uniform header for LON-CAPA web pages.
4417:
4418: Inputs:
4419:
1.112 bowersj2 4420: =over 4
4421:
4422: =item * $title, A title to be displayed on the page.
4423:
4424: =item * $function, the current role (can be undef).
4425:
4426: =item * $addentries, extra parameters for the <body> tag.
4427:
4428: =item * $bodyonly, if defined, only return the <body> tag.
4429:
4430: =item * $domain, if defined, force a given domain.
4431:
4432: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4433: text interface only)
1.60 matthew 4434:
1.814 bisitz 4435: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4436: navigational links
1.317 albertel 4437:
1.338 albertel 4438: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4439:
1.361 albertel 4440: =item * $no_inline_link, if true and in remote mode, don't show the
4441: 'Switch To Inline Menu' link
4442:
1.460 albertel 4443: =item * $args, optional argument valid values are
4444: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4445: inherit_jsmath -> when creating popup window in a page,
4446: should it have jsmath forced on by the
4447: current page
1.460 albertel 4448:
1.112 bowersj2 4449: =back
4450:
1.60 matthew 4451: Returns: A uniform header for LON-CAPA web pages.
4452: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4453: If $bodyonly is undef or zero, an html string containing a <body> tag and
4454: other decorations will be returned.
4455:
4456: =cut
4457:
1.54 www 4458: sub bodytag {
1.831 bisitz 4459: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4460: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4461:
1.460 albertel 4462: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4463:
1.183 matthew 4464: $function = &get_users_function() if (!$function);
1.339 albertel 4465: my $img = &designparm($function.'.img',$domain);
4466: my $font = &designparm($function.'.font',$domain);
4467: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4468:
1.803 bisitz 4469: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4470: 'bgcolor' => $pgbg,
1.339 albertel 4471: 'text' => $font,
4472: 'alink' => &designparm($function.'.alink',$domain),
4473: 'vlink' => &designparm($function.'.vlink',$domain),
4474: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4475: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4476:
1.63 www 4477: # role and realm
1.378 raeburn 4478: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4479: if ($role eq 'ca') {
1.479 albertel 4480: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4481: $realm = &plainname($rname,$rdom);
1.378 raeburn 4482: }
1.55 www 4483: # realm
1.258 albertel 4484: if ($env{'request.course.id'}) {
1.378 raeburn 4485: if ($env{'request.role'} !~ /^cr/) {
4486: $role = &Apache::lonnet::plaintext($role,&course_type());
4487: }
1.898 raeburn 4488: if ($env{'request.course.sec'}) {
4489: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4490: }
1.359 albertel 4491: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4492: } else {
4493: $role = &Apache::lonnet::plaintext($role);
1.54 www 4494: }
1.433 albertel 4495:
1.359 albertel 4496: if (!$realm) { $realm=' '; }
1.55 www 4497: # Set messages
1.60 matthew 4498: my $messages=&domainlogo($domain);
1.330 albertel 4499:
1.438 albertel 4500: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4501:
1.101 www 4502: # construct main body tag
1.359 albertel 4503: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4504: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4505:
1.530 albertel 4506: if ($bodyonly) {
1.60 matthew 4507: return $bodytag;
1.798 tempelho 4508: }
1.359 albertel 4509:
1.410 albertel 4510: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4511: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4512: undef($role);
1.434 albertel 4513: } else {
4514: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4515: }
1.359 albertel 4516:
1.762 bisitz 4517: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4518: #
4519: # Extra info if you are the DC
4520: my $dc_info = '';
4521: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4522: $env{'course.'.$env{'request.course.id'}.
4523: '.domain'}.'/'})) {
4524: my $cid = $env{'request.course.id'};
1.917 raeburn 4525: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4526: $dc_info =~ s/\s+$//;
1.359 albertel 4527: }
4528:
1.898 raeburn 4529: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4530: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4531:
1.837 bisitz 4532: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4533: # No Remote
1.916 droeschl 4534: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4535: return $bodytag;
4536: }
1.903 droeschl 4537:
4538: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4539:
4540: # if ($env{'request.state'} eq 'construct') {
4541: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4542: # }
4543:
1.359 albertel 4544:
4545:
1.916 droeschl 4546: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4547: if ($dc_info) {
4548: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4549: }
1.916 droeschl 4550: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4551: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4552: return $bodytag;
4553: }
1.894 droeschl 4554:
1.927 raeburn 4555: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4556: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4557: }
1.916 droeschl 4558:
1.903 droeschl 4559: $bodytag .= Apache::lonhtmlcommon::scripttag(
4560: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4561:
1.903 droeschl 4562: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4563:
1.917 raeburn 4564: if ($dc_info) {
4565: $dc_info = &dc_courseid_toggle($dc_info);
4566: }
4567: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4568:
1.903 droeschl 4569: #don't show menus for public users
4570: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4571: $bodytag .= Apache::lonmenu::secondary_menu();
4572: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4573: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4574: if ($env{'request.state'} eq 'construct') {
4575: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4576: $args->{'bread_crumbs'});
4577: } elsif ($forcereg) {
4578: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4579: }
1.903 droeschl 4580: }else{
4581: # this is to seperate menu from content when there's no secondary
4582: # menu. Especially needed for public accessible ressources.
4583: $bodytag .= '<hr style="clear:both" />';
4584: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4585: }
1.903 droeschl 4586:
1.235 raeburn 4587: return $bodytag;
1.94 www 4588: }
1.95 www 4589:
1.93 www 4590: #
1.95 www 4591: # Top frame rendering, Remote is up
1.93 www 4592: #
1.359 albertel 4593:
1.517 raeburn 4594: my $imgsrc = $img;
4595: if ($img =~ /^\/adm/) {
1.575 albertel 4596: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4597: }
4598: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4599:
1.305 www 4600: # Explicit link to get inline menu
1.361 albertel 4601: my $menu= ($no_inline_link?''
1.883 droeschl 4602: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4603:
4604: if ($dc_info) {
4605: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4606: }
4607:
1.916 droeschl 4608: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4609: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4610: <li>$menu</li>
1.917 raeburn 4611: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4612: return(<<ENDBODY);
1.60 matthew 4613: $bodytag
1.359 albertel 4614: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4615: <tr><td>$upperleft</td>
4616: <td>$messages </td>
1.54 www 4617: </tr>
1.359 albertel 4618: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4619: </tr>
1.356 albertel 4620: </table>
1.54 www 4621: ENDBODY
1.182 matthew 4622: }
4623:
1.917 raeburn 4624: sub dc_courseid_toggle {
4625: my ($dc_info) = @_;
4626: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4627: '<a href="javascript:showCourseID();">'.
4628: &mt('(More ...)').'</a></span>'.
4629: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4630: }
4631:
1.330 albertel 4632: sub make_attr_string {
4633: my ($register,$attr_ref) = @_;
4634:
4635: if ($attr_ref && !ref($attr_ref)) {
4636: die("addentries Must be a hash ref ".
4637: join(':',caller(1))." ".
4638: join(':',caller(0))." ");
4639: }
4640:
4641: if ($register) {
1.339 albertel 4642: my ($on_load,$on_unload);
4643: foreach my $key (keys(%{$attr_ref})) {
4644: if (lc($key) eq 'onload') {
4645: $on_load.=$attr_ref->{$key}.';';
4646: delete($attr_ref->{$key});
4647:
4648: } elsif (lc($key) eq 'onunload') {
4649: $on_unload.=$attr_ref->{$key}.';';
4650: delete($attr_ref->{$key});
4651: }
4652: }
4653: $attr_ref->{'onload'} =
4654: &Apache::lonmenu::loadevents(). $on_load;
4655: $attr_ref->{'onunload'}=
4656: &Apache::lonmenu::unloadevents().$on_unload;
4657: }
4658:
4659: # Accessibility font enhance
4660: if ($env{'browser.fontenhance'} eq 'on') {
4661: my $style;
4662: foreach my $key (keys(%{$attr_ref})) {
4663: if (lc($key) eq 'style') {
4664: $style.=$attr_ref->{$key}.';';
4665: delete($attr_ref->{$key});
4666: }
4667: }
4668: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4669: }
1.339 albertel 4670:
1.330 albertel 4671: my $attr_string;
4672: foreach my $attr (keys(%$attr_ref)) {
4673: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4674: }
4675: return $attr_string;
4676: }
4677:
4678:
1.182 matthew 4679: ###############################################
1.251 albertel 4680: ###############################################
4681:
4682: =pod
4683:
4684: =item * &endbodytag()
4685:
4686: Returns a uniform footer for LON-CAPA web pages.
4687:
1.635 raeburn 4688: Inputs: 1 - optional reference to an args hash
4689: If in the hash, key for noredirectlink has a value which evaluates to true,
4690: a 'Continue' link is not displayed if the page contains an
4691: internal redirect in the <head></head> section,
4692: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4693:
4694: =cut
4695:
4696: sub endbodytag {
1.635 raeburn 4697: my ($args) = @_;
1.251 albertel 4698: my $endbodytag='</body>';
1.269 albertel 4699: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4700: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4701: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4702: $endbodytag=
4703: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4704: &mt('Continue').'</a>'.
4705: $endbodytag;
4706: }
1.315 albertel 4707: }
1.251 albertel 4708: return $endbodytag;
4709: }
4710:
1.352 albertel 4711: =pod
4712:
4713: =item * &standard_css()
4714:
4715: Returns a style sheet
4716:
4717: Inputs: (all optional)
4718: domain -> force to color decorate a page for a specific
4719: domain
4720: function -> force usage of a specific rolish color scheme
4721: bgcolor -> override the default page bgcolor
4722:
4723: =cut
4724:
1.343 albertel 4725: sub standard_css {
1.345 albertel 4726: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4727: $function = &get_users_function() if (!$function);
4728: my $img = &designparm($function.'.img', $domain);
4729: my $tabbg = &designparm($function.'.tabbg', $domain);
4730: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4731: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4732: #second colour for later usage
1.345 albertel 4733: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4734: my $pgbg_or_bgcolor =
4735: $bgcolor ||
1.352 albertel 4736: &designparm($function.'.pgbg', $domain);
1.382 albertel 4737: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4738: my $alink = &designparm($function.'.alink', $domain);
4739: my $vlink = &designparm($function.'.vlink', $domain);
4740: my $link = &designparm($function.'.link', $domain);
4741:
1.704 muellerd 4742: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4743: my $bgcol = &designparm('login.bgcol',$domain);
4744: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4745:
1.602 albertel 4746: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4747: my $mono = 'monospace';
1.850 bisitz 4748: my $data_table_head = $sidebg;
4749: my $data_table_light = '#FAFAFA';
4750: my $data_table_dark = '#F0F0F0';
1.470 banghart 4751: my $data_table_darker = '#CCCCCC';
1.349 albertel 4752: my $data_table_highlight = '#FFFF00';
1.352 albertel 4753: my $mail_new = '#FFBB77';
4754: my $mail_new_hover = '#DD9955';
4755: my $mail_read = '#BBBB77';
4756: my $mail_read_hover = '#999944';
4757: my $mail_replied = '#AAAA88';
4758: my $mail_replied_hover = '#888855';
4759: my $mail_other = '#99BBBB';
4760: my $mail_other_hover = '#669999';
1.391 albertel 4761: my $table_header = '#DDDDDD';
1.489 raeburn 4762: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4763: my $lg_border_color = '#C8C8C8';
1.392 albertel 4764:
1.608 albertel 4765: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4766: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4767: : '0 3px 0 4px';
1.448 albertel 4768:
1.523 albertel 4769:
1.343 albertel 4770: return <<END;
1.795 www 4771: body {
1.911 bisitz 4772: font-family: $sans;
4773: line-height:130%;
4774: font-size:0.83em;
4775: color:$font;
1.795 www 4776: }
4777:
1.911 bisitz 4778: a:focus {
1.795 www 4779: color: red;
1.911 bisitz 4780: background: yellow;
1.795 www 4781: }
1.698 harmsja 4782:
1.911 bisitz 4783: form, .inline {
4784: display: inline;
1.795 www 4785: }
1.721 harmsja 4786:
1.795 www 4787: .LC_right {
1.911 bisitz 4788: text-align:right;
1.795 www 4789: }
4790:
4791: .LC_middle {
1.911 bisitz 4792: vertical-align:middle;
1.795 www 4793: }
1.721 harmsja 4794:
4795: /* just for tests */
1.911 bisitz 4796: .LC_400Box {
4797: width:400px;
4798: }
1.721 harmsja 4799: /* end */
4800:
1.778 bisitz 4801: .LC_filename {
4802: font-family: $mono;
4803: white-space:pre;
1.921 bisitz 4804: font-size: 120%;
1.778 bisitz 4805: }
4806:
4807: .LC_fileicon {
4808: border: none;
4809: height: 1.3em;
4810: vertical-align: text-bottom;
4811: margin-right: 0.3em;
4812: text-decoration:none;
4813: }
4814:
1.350 albertel 4815: .LC_error {
4816: color: red;
4817: font-size: larger;
4818: }
1.795 www 4819:
1.457 albertel 4820: .LC_warning,
4821: .LC_diff_removed {
1.733 bisitz 4822: color: red;
1.394 albertel 4823: }
1.532 albertel 4824:
4825: .LC_info,
1.457 albertel 4826: .LC_success,
4827: .LC_diff_added {
1.350 albertel 4828: color: green;
4829: }
1.795 www 4830:
1.802 bisitz 4831: div.LC_confirm_box {
4832: background-color: #FAFAFA;
4833: border: 1px solid $lg_border_color;
4834: margin-right: 0;
4835: padding: 5px;
4836: }
4837:
4838: div.LC_confirm_box .LC_error img,
4839: div.LC_confirm_box .LC_success img {
4840: vertical-align: middle;
4841: }
4842:
1.440 albertel 4843: .LC_icon {
1.771 droeschl 4844: border: none;
1.790 droeschl 4845: vertical-align: middle;
1.771 droeschl 4846: }
4847:
1.543 albertel 4848: .LC_docs_spacer {
4849: width: 25px;
4850: height: 1px;
1.771 droeschl 4851: border: none;
1.543 albertel 4852: }
1.346 albertel 4853:
1.532 albertel 4854: .LC_internal_info {
1.735 bisitz 4855: color: #999999;
1.532 albertel 4856: }
4857:
1.794 www 4858: .LC_discussion {
1.911 bisitz 4859: background: $tabbg;
4860: border: 1px solid black;
4861: margin: 2px;
1.794 www 4862: }
4863:
4864: .LC_disc_action_links_bar {
1.911 bisitz 4865: background: $tabbg;
4866: border: none;
4867: margin: 4px;
1.794 www 4868: }
4869:
4870: .LC_disc_action_left {
1.911 bisitz 4871: text-align: left;
1.794 www 4872: }
4873:
4874: .LC_disc_action_right {
1.911 bisitz 4875: text-align: right;
1.794 www 4876: }
4877:
4878: .LC_disc_new_item {
1.911 bisitz 4879: background: white;
4880: border: 2px solid red;
4881: margin: 2px;
1.794 www 4882: }
4883:
4884: .LC_disc_old_item {
1.911 bisitz 4885: background: white;
4886: border: 1px solid black;
4887: margin: 2px;
1.794 www 4888: }
4889:
1.458 albertel 4890: table.LC_pastsubmission {
4891: border: 1px solid black;
4892: margin: 2px;
4893: }
4894:
1.924 bisitz 4895: table#LC_menubuttons {
1.345 albertel 4896: width: 100%;
4897: background: $pgbg;
1.392 albertel 4898: border: 2px;
1.402 albertel 4899: border-collapse: separate;
1.803 bisitz 4900: padding: 0;
1.345 albertel 4901: }
1.392 albertel 4902:
1.801 tempelho 4903: table#LC_title_bar a {
4904: color: $fontmenu;
4905: }
1.836 bisitz 4906:
1.807 droeschl 4907: table#LC_title_bar {
1.819 tempelho 4908: clear: both;
1.836 bisitz 4909: display: none;
1.807 droeschl 4910: }
4911:
1.795 www 4912: table#LC_title_bar,
1.933 droeschl 4913: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4914: table#LC_title_bar.LC_with_remote {
1.359 albertel 4915: width: 100%;
1.392 albertel 4916: border-color: $pgbg;
4917: border-style: solid;
4918: border-width: $border;
1.379 albertel 4919: background: $pgbg;
1.801 tempelho 4920: color: $fontmenu;
1.392 albertel 4921: border-collapse: collapse;
1.803 bisitz 4922: padding: 0;
1.819 tempelho 4923: margin: 0;
1.359 albertel 4924: }
1.795 www 4925:
1.933 droeschl 4926: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 4927: margin: 0;
4928: padding: 0;
1.933 droeschl 4929: position: relative;
4930: list-style: none;
1.913 droeschl 4931: }
1.933 droeschl 4932: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 4933: display: inline;
4934: }
1.933 droeschl 4935:
4936: .LC_breadcrumb_tools_navigation {
1.913 droeschl 4937: padding: 0;
1.933 droeschl 4938: margin: 0;
4939: float: left;
1.913 droeschl 4940: }
1.933 droeschl 4941: .LC_breadcrumb_tools_tools {
4942: padding: 0;
4943: margin: 0;
1.913 droeschl 4944: float: right;
4945: }
4946:
1.359 albertel 4947: table#LC_title_bar td {
4948: background: $tabbg;
4949: }
1.795 www 4950:
1.911 bisitz 4951: table#LC_menubuttons img {
1.803 bisitz 4952: border: none;
1.346 albertel 4953: }
1.795 www 4954:
1.842 droeschl 4955: .LC_breadcrumbs_component {
1.911 bisitz 4956: float: right;
4957: margin: 0 1em;
1.357 albertel 4958: }
1.842 droeschl 4959: .LC_breadcrumbs_component img {
1.911 bisitz 4960: vertical-align: middle;
1.777 tempelho 4961: }
1.795 www 4962:
1.383 albertel 4963: td.LC_table_cell_checkbox {
4964: text-align: center;
4965: }
1.795 www 4966:
4967: .LC_fontsize_small {
1.911 bisitz 4968: font-size: 70%;
1.705 tempelho 4969: }
4970:
1.844 bisitz 4971: #LC_breadcrumbs {
1.911 bisitz 4972: clear:both;
4973: background: $sidebg;
4974: border-bottom: 1px solid $lg_border_color;
4975: line-height: 2.5em;
1.933 droeschl 4976: overflow: hidden;
1.911 bisitz 4977: margin: 0;
4978: padding: 0;
1.819 tempelho 4979: }
1.862 bisitz 4980:
1.839 droeschl 4981: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 4982: #LC_remote #LC_breadcrumbs {
1.911 bisitz 4983: display:none;
1.839 droeschl 4984: }
1.819 tempelho 4985:
1.844 bisitz 4986: #LC_head_subbox {
1.911 bisitz 4987: clear:both;
4988: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 4989: border: 1px solid $sidebg;
4990: margin: 0 0 10px 0;
1.822 bisitz 4991: }
4992:
1.795 www 4993: .LC_fontsize_medium {
1.911 bisitz 4994: font-size: 85%;
1.705 tempelho 4995: }
4996:
1.795 www 4997: .LC_fontsize_large {
1.911 bisitz 4998: font-size: 120%;
1.705 tempelho 4999: }
5000:
1.346 albertel 5001: .LC_menubuttons_inline_text {
5002: color: $font;
1.698 harmsja 5003: font-size: 90%;
1.701 harmsja 5004: padding-left:3px;
1.346 albertel 5005: }
5006:
1.934 droeschl 5007: .LC_menubuttons_inline_text img{
5008: vertical-align: middle;
5009: }
5010:
1.526 www 5011: .LC_menubuttons_link {
5012: text-decoration: none;
5013: }
1.795 www 5014:
1.522 albertel 5015: .LC_menubuttons_category {
1.521 www 5016: color: $font;
1.526 www 5017: background: $pgbg;
1.521 www 5018: font-size: larger;
5019: font-weight: bold;
5020: }
5021:
1.346 albertel 5022: td.LC_menubuttons_text {
1.911 bisitz 5023: color: $font;
1.346 albertel 5024: }
1.706 harmsja 5025:
1.346 albertel 5026: .LC_current_location {
5027: background: $tabbg;
5028: }
1.795 www 5029:
5030: table.LC_data_table,
5031: table.LC_mail_list {
1.347 albertel 5032: border: 1px solid #000000;
1.402 albertel 5033: border-collapse: separate;
1.426 albertel 5034: border-spacing: 1px;
1.610 albertel 5035: background: $pgbg;
1.347 albertel 5036: }
1.795 www 5037:
1.422 albertel 5038: .LC_data_table_dense {
5039: font-size: small;
5040: }
1.795 www 5041:
1.507 raeburn 5042: table.LC_nested_outer {
5043: border: 1px solid #000000;
1.589 raeburn 5044: border-collapse: collapse;
1.803 bisitz 5045: border-spacing: 0;
1.507 raeburn 5046: width: 100%;
5047: }
1.795 www 5048:
1.879 raeburn 5049: table.LC_innerpickbox,
1.507 raeburn 5050: table.LC_nested {
1.803 bisitz 5051: border: none;
1.589 raeburn 5052: border-collapse: collapse;
1.803 bisitz 5053: border-spacing: 0;
1.507 raeburn 5054: width: 100%;
5055: }
1.795 www 5056:
1.930 faziophi 5057: .ui-accordion,
5058: .ui-accordion table.LC_data_table,
5059: .ui-accordion table.LC_nested_outer{
5060: border: 0px;
5061: border-spacing: 0px;
5062: margin: 3px;
5063: }
5064:
1.911 bisitz 5065: table.LC_data_table tr th,
5066: table.LC_calendar tr th,
1.795 www 5067: table.LC_mail_list tr th,
1.879 raeburn 5068: table.LC_prior_tries tr th,
5069: table.LC_innerpickbox tr th {
1.349 albertel 5070: font-weight: bold;
5071: background-color: $data_table_head;
1.801 tempelho 5072: color:$fontmenu;
1.701 harmsja 5073: font-size:90%;
1.347 albertel 5074: }
1.795 www 5075:
1.879 raeburn 5076: table.LC_innerpickbox tr th,
5077: table.LC_innerpickbox tr td {
5078: vertical-align: top;
5079: }
5080:
1.711 raeburn 5081: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5082: background-color: #CCCCCC;
1.711 raeburn 5083: font-weight: bold;
5084: text-align: left;
5085: }
1.795 www 5086:
1.912 bisitz 5087: table.LC_data_table tr.LC_odd_row > td {
5088: background-color: $data_table_light;
5089: padding: 2px;
5090: vertical-align: top;
5091: }
5092:
1.809 bisitz 5093: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5094: background-color: $data_table_light;
1.912 bisitz 5095: vertical-align: top;
5096: }
5097:
5098: table.LC_data_table tr.LC_even_row > td {
5099: background-color: $data_table_dark;
1.425 albertel 5100: padding: 2px;
1.900 bisitz 5101: vertical-align: top;
1.347 albertel 5102: }
1.795 www 5103:
1.809 bisitz 5104: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5105: background-color: $data_table_dark;
1.900 bisitz 5106: vertical-align: top;
1.347 albertel 5107: }
1.795 www 5108:
1.425 albertel 5109: table.LC_data_table tr.LC_data_table_highlight td {
5110: background-color: $data_table_darker;
5111: }
1.795 www 5112:
1.639 raeburn 5113: table.LC_data_table tr td.LC_leftcol_header {
5114: background-color: $data_table_head;
5115: font-weight: bold;
5116: }
1.795 www 5117:
1.451 albertel 5118: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5119: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5120: background-color: #FFFFFF;
1.421 albertel 5121: font-weight: bold;
5122: font-style: italic;
5123: text-align: center;
5124: padding: 8px;
1.347 albertel 5125: }
1.795 www 5126:
1.890 droeschl 5127: table.LC_caption {
5128: }
5129:
1.507 raeburn 5130: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5131: padding: 4ex
5132: }
1.795 www 5133:
1.507 raeburn 5134: table.LC_nested_outer tr th {
5135: font-weight: bold;
1.801 tempelho 5136: color:$fontmenu;
1.507 raeburn 5137: background-color: $data_table_head;
1.701 harmsja 5138: font-size: small;
1.507 raeburn 5139: border-bottom: 1px solid #000000;
5140: }
1.795 www 5141:
1.507 raeburn 5142: table.LC_nested_outer tr td.LC_subheader {
5143: background-color: $data_table_head;
5144: font-weight: bold;
5145: font-size: small;
5146: border-bottom: 1px solid #000000;
5147: text-align: right;
1.451 albertel 5148: }
1.795 www 5149:
1.507 raeburn 5150: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5151: background-color: #CCCCCC;
1.451 albertel 5152: font-weight: bold;
5153: font-size: small;
1.507 raeburn 5154: text-align: center;
5155: }
1.795 www 5156:
1.589 raeburn 5157: table.LC_nested tr.LC_info_row td.LC_left_item,
5158: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5159: text-align: left;
1.451 albertel 5160: }
1.795 www 5161:
1.507 raeburn 5162: table.LC_nested td {
1.735 bisitz 5163: background-color: #FFFFFF;
1.451 albertel 5164: font-size: small;
1.507 raeburn 5165: }
1.795 www 5166:
1.507 raeburn 5167: table.LC_nested_outer tr th.LC_right_item,
5168: table.LC_nested tr.LC_info_row td.LC_right_item,
5169: table.LC_nested tr.LC_odd_row td.LC_right_item,
5170: table.LC_nested tr td.LC_right_item {
1.451 albertel 5171: text-align: right;
5172: }
5173:
1.930 faziophi 5174: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5175: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5176: text-align: right;
5177: width: 40%;
5178: padding-right:10px;
5179: vertical-align: top;
5180: padding: 5px;
5181: }
5182:
5183: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5184: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5185: text-align: left;
5186: width: 60%;
5187: padding: 2px 4px;
5188: }
5189:
1.507 raeburn 5190: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5191: background-color: #EEEEEE;
1.451 albertel 5192: }
5193:
1.473 raeburn 5194: table.LC_createuser {
5195: }
5196:
5197: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5198: font-size: small;
1.473 raeburn 5199: }
5200:
5201: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5202: background-color: #CCCCCC;
1.473 raeburn 5203: font-weight: bold;
5204: text-align: center;
5205: }
5206:
1.349 albertel 5207: table.LC_calendar {
5208: border: 1px solid #000000;
5209: border-collapse: collapse;
1.917 raeburn 5210: width: 98%;
1.349 albertel 5211: }
1.795 www 5212:
1.349 albertel 5213: table.LC_calendar_pickdate {
5214: font-size: xx-small;
5215: }
1.795 www 5216:
1.349 albertel 5217: table.LC_calendar tr td {
5218: border: 1px solid #000000;
5219: vertical-align: top;
1.917 raeburn 5220: width: 14%;
1.349 albertel 5221: }
1.795 www 5222:
1.349 albertel 5223: table.LC_calendar tr td.LC_calendar_day_empty {
5224: background-color: $data_table_dark;
5225: }
1.795 www 5226:
1.779 bisitz 5227: table.LC_calendar tr td.LC_calendar_day_current {
5228: background-color: $data_table_highlight;
1.777 tempelho 5229: }
1.795 www 5230:
1.349 albertel 5231: table.LC_mail_list tr.LC_mail_new {
5232: background-color: $mail_new;
5233: }
1.795 www 5234:
1.349 albertel 5235: table.LC_mail_list tr.LC_mail_new:hover {
5236: background-color: $mail_new_hover;
5237: }
1.795 www 5238:
1.349 albertel 5239: table.LC_mail_list tr.LC_mail_read {
5240: background-color: $mail_read;
5241: }
1.795 www 5242:
1.349 albertel 5243: table.LC_mail_list tr.LC_mail_read:hover {
5244: background-color: $mail_read_hover;
5245: }
1.795 www 5246:
1.349 albertel 5247: table.LC_mail_list tr.LC_mail_replied {
5248: background-color: $mail_replied;
5249: }
1.795 www 5250:
1.349 albertel 5251: table.LC_mail_list tr.LC_mail_replied:hover {
5252: background-color: $mail_replied_hover;
5253: }
1.795 www 5254:
1.349 albertel 5255: table.LC_mail_list tr.LC_mail_other {
5256: background-color: $mail_other;
5257: }
1.795 www 5258:
1.349 albertel 5259: table.LC_mail_list tr.LC_mail_other:hover {
5260: background-color: $mail_other_hover;
5261: }
1.494 raeburn 5262:
1.777 tempelho 5263: table.LC_data_table tr > td.LC_browser_file,
5264: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5265: background: #AAEE77;
1.389 albertel 5266: }
1.795 www 5267:
1.777 tempelho 5268: table.LC_data_table tr > td.LC_browser_file_locked,
5269: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5270: background: #FFAA99;
1.387 albertel 5271: }
1.795 www 5272:
1.777 tempelho 5273: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5274: background: #888888;
1.779 bisitz 5275: }
1.795 www 5276:
1.777 tempelho 5277: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5278: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5279: background: #F8F866;
1.777 tempelho 5280: }
1.795 www 5281:
1.696 bisitz 5282: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5283: background: #E0E8FF;
1.387 albertel 5284: }
1.696 bisitz 5285:
1.707 bisitz 5286: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5287: /* background: #77FF77; */
1.707 bisitz 5288: }
1.795 www 5289:
1.707 bisitz 5290: table.LC_data_table tr > td.LC_roles_future {
5291: background: #FFFF77;
5292: }
1.795 www 5293:
1.707 bisitz 5294: table.LC_data_table tr > td.LC_roles_will {
5295: background: #FFAA77;
5296: }
1.795 www 5297:
1.707 bisitz 5298: table.LC_data_table tr > td.LC_roles_expired {
5299: background: #FF7777;
5300: }
1.795 www 5301:
1.707 bisitz 5302: table.LC_data_table tr > td.LC_roles_will_not {
5303: background: #AAFF77;
5304: }
1.795 www 5305:
1.707 bisitz 5306: table.LC_data_table tr > td.LC_roles_selected {
5307: background: #11CC55;
5308: }
5309:
1.388 albertel 5310: span.LC_current_location {
1.701 harmsja 5311: font-size:larger;
1.388 albertel 5312: background: $pgbg;
5313: }
1.387 albertel 5314:
1.395 albertel 5315: span.LC_parm_menu_item {
5316: font-size: larger;
5317: }
1.795 www 5318:
1.395 albertel 5319: span.LC_parm_scope_all {
5320: color: red;
5321: }
1.795 www 5322:
1.395 albertel 5323: span.LC_parm_scope_folder {
5324: color: green;
5325: }
1.795 www 5326:
1.395 albertel 5327: span.LC_parm_scope_resource {
5328: color: orange;
5329: }
1.795 www 5330:
1.395 albertel 5331: span.LC_parm_part {
5332: color: blue;
5333: }
1.795 www 5334:
1.911 bisitz 5335: span.LC_parm_folder,
5336: span.LC_parm_symb {
1.395 albertel 5337: font-size: x-small;
5338: font-family: $mono;
5339: color: #AAAAAA;
5340: }
5341:
1.795 www 5342: td.LC_parm_overview_level_menu,
5343: td.LC_parm_overview_map_menu,
5344: td.LC_parm_overview_parm_selectors,
5345: td.LC_parm_overview_restrictions {
1.396 albertel 5346: border: 1px solid black;
5347: border-collapse: collapse;
5348: }
1.795 www 5349:
1.396 albertel 5350: table.LC_parm_overview_restrictions td {
5351: border-width: 1px 4px 1px 4px;
5352: border-style: solid;
5353: border-color: $pgbg;
5354: text-align: center;
5355: }
1.795 www 5356:
1.396 albertel 5357: table.LC_parm_overview_restrictions th {
5358: background: $tabbg;
5359: border-width: 1px 4px 1px 4px;
5360: border-style: solid;
5361: border-color: $pgbg;
5362: }
1.795 www 5363:
1.398 albertel 5364: table#LC_helpmenu {
1.803 bisitz 5365: border: none;
1.398 albertel 5366: height: 55px;
1.803 bisitz 5367: border-spacing: 0;
1.398 albertel 5368: }
5369:
5370: table#LC_helpmenu fieldset legend {
5371: font-size: larger;
5372: }
1.795 www 5373:
1.397 albertel 5374: table#LC_helpmenu_links {
5375: width: 100%;
5376: border: 1px solid black;
5377: background: $pgbg;
1.803 bisitz 5378: padding: 0;
1.397 albertel 5379: border-spacing: 1px;
5380: }
1.795 www 5381:
1.397 albertel 5382: table#LC_helpmenu_links tr td {
5383: padding: 1px;
5384: background: $tabbg;
1.399 albertel 5385: text-align: center;
5386: font-weight: bold;
1.397 albertel 5387: }
1.396 albertel 5388:
1.795 www 5389: table#LC_helpmenu_links a:link,
5390: table#LC_helpmenu_links a:visited,
1.397 albertel 5391: table#LC_helpmenu_links a:active {
5392: text-decoration: none;
5393: color: $font;
5394: }
1.795 www 5395:
1.397 albertel 5396: table#LC_helpmenu_links a:hover {
5397: text-decoration: underline;
5398: color: $vlink;
5399: }
1.396 albertel 5400:
1.417 albertel 5401: .LC_chrt_popup_exists {
5402: border: 1px solid #339933;
5403: margin: -1px;
5404: }
1.795 www 5405:
1.417 albertel 5406: .LC_chrt_popup_up {
5407: border: 1px solid yellow;
5408: margin: -1px;
5409: }
1.795 www 5410:
1.417 albertel 5411: .LC_chrt_popup {
5412: border: 1px solid #8888FF;
5413: background: #CCCCFF;
5414: }
1.795 www 5415:
1.421 albertel 5416: table.LC_pick_box {
5417: border-collapse: separate;
5418: background: white;
5419: border: 1px solid black;
5420: border-spacing: 1px;
5421: }
1.795 www 5422:
1.421 albertel 5423: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5424: background: $sidebg;
1.421 albertel 5425: font-weight: bold;
1.900 bisitz 5426: text-align: left;
1.740 bisitz 5427: vertical-align: top;
1.421 albertel 5428: width: 184px;
5429: padding: 8px;
5430: }
1.795 www 5431:
1.579 raeburn 5432: table.LC_pick_box td.LC_pick_box_value {
5433: text-align: left;
5434: padding: 8px;
5435: }
1.795 www 5436:
1.579 raeburn 5437: table.LC_pick_box td.LC_pick_box_select {
5438: text-align: left;
5439: padding: 8px;
5440: }
1.795 www 5441:
1.424 albertel 5442: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5443: padding: 0;
1.421 albertel 5444: height: 1px;
5445: background: black;
5446: }
1.795 www 5447:
1.421 albertel 5448: table.LC_pick_box td.LC_pick_box_submit {
5449: text-align: right;
5450: }
1.795 www 5451:
1.579 raeburn 5452: table.LC_pick_box td.LC_evenrow_value {
5453: text-align: left;
5454: padding: 8px;
5455: background-color: $data_table_light;
5456: }
1.795 www 5457:
1.579 raeburn 5458: table.LC_pick_box td.LC_oddrow_value {
5459: text-align: left;
5460: padding: 8px;
5461: background-color: $data_table_light;
5462: }
1.795 www 5463:
1.579 raeburn 5464: span.LC_helpform_receipt_cat {
5465: font-weight: bold;
5466: }
1.795 www 5467:
1.424 albertel 5468: table.LC_group_priv_box {
5469: background: white;
5470: border: 1px solid black;
5471: border-spacing: 1px;
5472: }
1.795 www 5473:
1.424 albertel 5474: table.LC_group_priv_box td.LC_pick_box_title {
5475: background: $tabbg;
5476: font-weight: bold;
5477: text-align: right;
5478: width: 184px;
5479: }
1.795 www 5480:
1.424 albertel 5481: table.LC_group_priv_box td.LC_groups_fixed {
5482: background: $data_table_light;
5483: text-align: center;
5484: }
1.795 www 5485:
1.424 albertel 5486: table.LC_group_priv_box td.LC_groups_optional {
5487: background: $data_table_dark;
5488: text-align: center;
5489: }
1.795 www 5490:
1.424 albertel 5491: table.LC_group_priv_box td.LC_groups_functionality {
5492: background: $data_table_darker;
5493: text-align: center;
5494: font-weight: bold;
5495: }
1.795 www 5496:
1.424 albertel 5497: table.LC_group_priv td {
5498: text-align: left;
1.803 bisitz 5499: padding: 0;
1.424 albertel 5500: }
5501:
1.421 albertel 5502: table.LC_notify_front_page {
5503: background: white;
5504: border: 1px solid black;
5505: padding: 8px;
5506: }
1.795 www 5507:
1.421 albertel 5508: table.LC_notify_front_page td {
5509: padding: 8px;
5510: }
1.795 www 5511:
1.424 albertel 5512: .LC_navbuttons {
5513: margin: 2ex 0ex 2ex 0ex;
5514: }
1.795 www 5515:
1.423 albertel 5516: .LC_topic_bar {
5517: font-weight: bold;
5518: background: $tabbg;
1.918 wenzelju 5519: margin: 1em 0em 1em 2em;
1.805 bisitz 5520: padding: 3px;
1.918 wenzelju 5521: font-size: 1.2em;
1.423 albertel 5522: }
1.795 www 5523:
1.423 albertel 5524: .LC_topic_bar span {
1.918 wenzelju 5525: left: 0.5em;
5526: position: absolute;
1.423 albertel 5527: vertical-align: middle;
1.918 wenzelju 5528: font-size: 1.2em;
1.423 albertel 5529: }
1.795 www 5530:
1.423 albertel 5531: table.LC_course_group_status {
5532: margin: 20px;
5533: }
1.795 www 5534:
1.423 albertel 5535: table.LC_status_selector td {
5536: vertical-align: top;
5537: text-align: center;
1.424 albertel 5538: padding: 4px;
5539: }
1.795 www 5540:
1.599 albertel 5541: div.LC_feedback_link {
1.616 albertel 5542: clear: both;
1.829 kalberla 5543: background: $sidebg;
1.779 bisitz 5544: width: 100%;
1.829 kalberla 5545: padding-bottom: 10px;
5546: border: 1px $tabbg solid;
1.833 kalberla 5547: height: 22px;
5548: line-height: 22px;
5549: padding-top: 5px;
5550: }
5551:
5552: div.LC_feedback_link img {
5553: height: 22px;
1.867 kalberla 5554: vertical-align:middle;
1.829 kalberla 5555: }
5556:
1.911 bisitz 5557: div.LC_feedback_link a {
1.829 kalberla 5558: text-decoration: none;
1.489 raeburn 5559: }
1.795 www 5560:
1.867 kalberla 5561: div.LC_comblock {
1.911 bisitz 5562: display:inline;
1.867 kalberla 5563: color:$font;
5564: font-size:90%;
5565: }
5566:
5567: div.LC_feedback_link div.LC_comblock {
5568: padding-left:5px;
5569: }
5570:
5571: div.LC_feedback_link div.LC_comblock a {
5572: color:$font;
5573: }
5574:
1.489 raeburn 5575: span.LC_feedback_link {
1.858 bisitz 5576: /* background: $feedback_link_bg; */
1.599 albertel 5577: font-size: larger;
5578: }
1.795 www 5579:
1.599 albertel 5580: span.LC_message_link {
1.858 bisitz 5581: /* background: $feedback_link_bg; */
1.599 albertel 5582: font-size: larger;
5583: position: absolute;
5584: right: 1em;
1.489 raeburn 5585: }
1.421 albertel 5586:
1.515 albertel 5587: table.LC_prior_tries {
1.524 albertel 5588: border: 1px solid #000000;
5589: border-collapse: separate;
5590: border-spacing: 1px;
1.515 albertel 5591: }
1.523 albertel 5592:
1.515 albertel 5593: table.LC_prior_tries td {
1.524 albertel 5594: padding: 2px;
1.515 albertel 5595: }
1.523 albertel 5596:
5597: .LC_answer_correct {
1.795 www 5598: background: lightgreen;
5599: color: darkgreen;
5600: padding: 6px;
1.523 albertel 5601: }
1.795 www 5602:
1.523 albertel 5603: .LC_answer_charged_try {
1.797 www 5604: background: #FFAAAA;
1.795 www 5605: color: darkred;
5606: padding: 6px;
1.523 albertel 5607: }
1.795 www 5608:
1.779 bisitz 5609: .LC_answer_not_charged_try,
1.523 albertel 5610: .LC_answer_no_grade,
5611: .LC_answer_late {
1.795 www 5612: background: lightyellow;
1.523 albertel 5613: color: black;
1.795 www 5614: padding: 6px;
1.523 albertel 5615: }
1.795 www 5616:
1.523 albertel 5617: .LC_answer_previous {
1.795 www 5618: background: lightblue;
5619: color: darkblue;
5620: padding: 6px;
1.523 albertel 5621: }
1.795 www 5622:
1.779 bisitz 5623: .LC_answer_no_message {
1.777 tempelho 5624: background: #FFFFFF;
5625: color: black;
1.795 www 5626: padding: 6px;
1.779 bisitz 5627: }
1.795 www 5628:
1.779 bisitz 5629: .LC_answer_unknown {
5630: background: orange;
5631: color: black;
1.795 www 5632: padding: 6px;
1.777 tempelho 5633: }
1.795 www 5634:
1.529 albertel 5635: span.LC_prior_numerical,
5636: span.LC_prior_string,
5637: span.LC_prior_custom,
5638: span.LC_prior_reaction,
5639: span.LC_prior_math {
1.925 bisitz 5640: font-family: $mono;
1.523 albertel 5641: white-space: pre;
5642: }
5643:
1.525 albertel 5644: span.LC_prior_string {
1.925 bisitz 5645: font-family: $mono;
1.525 albertel 5646: white-space: pre;
5647: }
5648:
1.523 albertel 5649: table.LC_prior_option {
5650: width: 100%;
5651: border-collapse: collapse;
5652: }
1.795 www 5653:
1.911 bisitz 5654: table.LC_prior_rank,
1.795 www 5655: table.LC_prior_match {
1.528 albertel 5656: border-collapse: collapse;
5657: }
1.795 www 5658:
1.528 albertel 5659: table.LC_prior_option tr td,
5660: table.LC_prior_rank tr td,
5661: table.LC_prior_match tr td {
1.524 albertel 5662: border: 1px solid #000000;
1.515 albertel 5663: }
5664:
1.855 bisitz 5665: .LC_nobreak {
1.544 albertel 5666: white-space: nowrap;
1.519 raeburn 5667: }
5668:
1.576 raeburn 5669: span.LC_cusr_emph {
5670: font-style: italic;
5671: }
5672:
1.633 raeburn 5673: span.LC_cusr_subheading {
5674: font-weight: normal;
5675: font-size: 85%;
5676: }
5677:
1.861 bisitz 5678: div.LC_docs_entry_move {
1.859 bisitz 5679: border: 1px solid #BBBBBB;
1.545 albertel 5680: background: #DDDDDD;
1.861 bisitz 5681: width: 22px;
1.859 bisitz 5682: padding: 1px;
5683: margin: 0;
1.545 albertel 5684: }
5685:
1.861 bisitz 5686: table.LC_data_table tr > td.LC_docs_entry_commands,
5687: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5688: background: #DDDDDD;
5689: font-size: x-small;
5690: }
1.795 www 5691:
1.861 bisitz 5692: .LC_docs_entry_parameter {
5693: white-space: nowrap;
5694: }
5695:
1.544 albertel 5696: .LC_docs_copy {
1.545 albertel 5697: color: #000099;
1.544 albertel 5698: }
1.795 www 5699:
1.544 albertel 5700: .LC_docs_cut {
1.545 albertel 5701: color: #550044;
1.544 albertel 5702: }
1.795 www 5703:
1.544 albertel 5704: .LC_docs_rename {
1.545 albertel 5705: color: #009900;
1.544 albertel 5706: }
1.795 www 5707:
1.544 albertel 5708: .LC_docs_remove {
1.545 albertel 5709: color: #990000;
5710: }
5711:
1.547 albertel 5712: .LC_docs_reinit_warn,
5713: .LC_docs_ext_edit {
5714: font-size: x-small;
5715: }
5716:
1.545 albertel 5717: table.LC_docs_adddocs td,
5718: table.LC_docs_adddocs th {
5719: border: 1px solid #BBBBBB;
5720: padding: 4px;
5721: background: #DDDDDD;
1.543 albertel 5722: }
5723:
1.584 albertel 5724: table.LC_sty_begin {
5725: background: #BBFFBB;
5726: }
1.795 www 5727:
1.584 albertel 5728: table.LC_sty_end {
5729: background: #FFBBBB;
5730: }
5731:
1.589 raeburn 5732: table.LC_double_column {
1.803 bisitz 5733: border-width: 0;
1.589 raeburn 5734: border-collapse: collapse;
5735: width: 100%;
5736: padding: 2px;
5737: }
5738:
5739: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5740: top: 2px;
1.589 raeburn 5741: left: 2px;
5742: width: 47%;
5743: vertical-align: top;
5744: }
5745:
5746: table.LC_double_column tr td.LC_right_col {
5747: top: 2px;
1.779 bisitz 5748: right: 2px;
1.589 raeburn 5749: width: 47%;
5750: vertical-align: top;
5751: }
5752:
1.591 raeburn 5753: div.LC_left_float {
5754: float: left;
5755: padding-right: 5%;
1.597 albertel 5756: padding-bottom: 4px;
1.591 raeburn 5757: }
5758:
5759: div.LC_clear_float_header {
1.597 albertel 5760: padding-bottom: 2px;
1.591 raeburn 5761: }
5762:
5763: div.LC_clear_float_footer {
1.597 albertel 5764: padding-top: 10px;
1.591 raeburn 5765: clear: both;
5766: }
5767:
1.597 albertel 5768: div.LC_grade_show_user {
1.936 ! bisitz 5769: border-left: 5px solid $sidebg;
! 5770: margin: 0;
! 5771: padding: 15px 0 5px 10px;
1.597 albertel 5772: }
1.795 www 5773:
1.936 ! bisitz 5774: div.LC_grade_show_user_odd_row {
! 5775: border-left: 5px solid #000000;
1.597 albertel 5776: }
5777:
5778: div.LC_grade_submissions,
5779: div.LC_grade_message_center,
1.936 ! bisitz 5780: div.LC_grade_info_links {
1.597 albertel 5781: margin: 5px;
5782: width: 99%;
5783: background: #FFFFFF;
5784: }
1.795 www 5785:
1.597 albertel 5786: div.LC_grade_submissions_header,
1.936 ! bisitz 5787: div.LC_grade_message_center_header {
1.705 tempelho 5788: font-weight: bold;
5789: font-size: large;
1.597 albertel 5790: }
1.795 www 5791:
1.597 albertel 5792: div.LC_grade_submissions_body,
1.936 ! bisitz 5793: div.LC_grade_message_center_body {
1.597 albertel 5794: border: 1px solid black;
5795: width: 99%;
5796: background: #FFFFFF;
5797: }
1.795 www 5798:
1.613 albertel 5799: table.LC_scantron_action {
5800: width: 100%;
5801: }
1.795 www 5802:
1.613 albertel 5803: table.LC_scantron_action tr th {
1.698 harmsja 5804: font-weight:bold;
5805: font-style:normal;
1.613 albertel 5806: }
1.795 www 5807:
1.779 bisitz 5808: .LC_edit_problem_header,
1.614 albertel 5809: div.LC_edit_problem_footer {
1.705 tempelho 5810: font-weight: normal;
5811: font-size: medium;
1.602 albertel 5812: margin: 2px;
1.600 albertel 5813: }
1.795 www 5814:
1.600 albertel 5815: div.LC_edit_problem_header,
1.602 albertel 5816: div.LC_edit_problem_header div,
1.614 albertel 5817: div.LC_edit_problem_footer,
5818: div.LC_edit_problem_footer div,
1.602 albertel 5819: div.LC_edit_problem_editxml_header,
5820: div.LC_edit_problem_editxml_header div {
1.600 albertel 5821: margin-top: 5px;
5822: }
1.795 www 5823:
1.600 albertel 5824: div.LC_edit_problem_header_title {
1.705 tempelho 5825: font-weight: bold;
5826: font-size: larger;
1.602 albertel 5827: background: $tabbg;
5828: padding: 3px;
5829: }
1.795 www 5830:
1.602 albertel 5831: table.LC_edit_problem_header_title {
5832: width: 100%;
1.600 albertel 5833: background: $tabbg;
1.602 albertel 5834: }
5835:
5836: div.LC_edit_problem_discards {
5837: float: left;
5838: padding-bottom: 5px;
5839: }
1.795 www 5840:
1.602 albertel 5841: div.LC_edit_problem_saves {
5842: float: right;
5843: padding-bottom: 5px;
1.600 albertel 5844: }
1.795 www 5845:
1.911 bisitz 5846: img.stift {
1.803 bisitz 5847: border-width: 0;
5848: vertical-align: middle;
1.677 riegler 5849: }
1.680 riegler 5850:
1.923 bisitz 5851: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5852: vertical-align: top;
1.777 tempelho 5853: }
1.795 www 5854:
1.716 raeburn 5855: div.LC_createcourse {
1.911 bisitz 5856: margin: 10px 10px 10px 10px;
1.716 raeburn 5857: }
5858:
1.917 raeburn 5859: .LC_dccid {
5860: margin: 0.2em 0 0 0;
5861: padding: 0;
5862: font-size: 90%;
5863: display:none;
5864: }
5865:
1.693 droeschl 5866: /* ---- Remove when done ----
5867: # The following styles is part of the redesign of LON-CAPA and are
5868: # subject to change during this project.
5869: # Don't rely on their current functionality as they might be
5870: # changed or removed.
5871: # --------------------------*/
5872:
1.698 harmsja 5873: a:hover,
1.897 wenzelju 5874: ol.LC_primary_menu a:hover,
1.721 harmsja 5875: ol#LC_MenuBreadcrumbs a:hover,
5876: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5877: ul#LC_secondary_menu a:hover,
1.721 harmsja 5878: .LC_FormSectionClearButton input:hover
1.795 www 5879: ul.LC_TabContent li:hover a {
1.911 bisitz 5880: color:#BF2317;
5881: text-decoration:none;
1.693 droeschl 5882: }
5883:
1.779 bisitz 5884: h1 {
1.911 bisitz 5885: padding: 0;
5886: line-height:130%;
1.693 droeschl 5887: }
1.698 harmsja 5888:
1.911 bisitz 5889: h2,
5890: h3,
5891: h4,
5892: h5,
5893: h6 {
5894: margin: 5px 0 5px 0;
5895: padding: 0;
5896: line-height:130%;
1.693 droeschl 5897: }
1.795 www 5898:
5899: .LC_hcell {
1.911 bisitz 5900: padding:3px 15px 3px 15px;
5901: margin: 0;
5902: background-color:$tabbg;
5903: color:$fontmenu;
5904: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5905: }
1.795 www 5906:
1.840 bisitz 5907: .LC_Box > .LC_hcell {
1.911 bisitz 5908: margin: 0 -10px 10px -10px;
1.835 bisitz 5909: }
5910:
1.721 harmsja 5911: .LC_noBorder {
1.911 bisitz 5912: border: 0;
1.698 harmsja 5913: }
1.693 droeschl 5914:
1.721 harmsja 5915: .LC_FormSectionClearButton input {
1.911 bisitz 5916: background-color:transparent;
5917: border: none;
5918: cursor:pointer;
5919: text-decoration:underline;
1.693 droeschl 5920: }
1.763 bisitz 5921:
5922: .LC_help_open_topic {
1.911 bisitz 5923: color: #FFFFFF;
5924: background-color: #EEEEFF;
5925: margin: 1px;
5926: padding: 4px;
5927: border: 1px solid #000033;
5928: white-space: nowrap;
5929: /* vertical-align: middle; */
1.759 neumanie 5930: }
1.693 droeschl 5931:
1.911 bisitz 5932: dl,
5933: ul,
5934: div,
5935: fieldset {
5936: margin: 10px 10px 10px 0;
5937: /* overflow: hidden; */
1.693 droeschl 5938: }
1.795 www 5939:
1.838 bisitz 5940: fieldset > legend {
1.911 bisitz 5941: font-weight: bold;
5942: padding: 0 5px 0 5px;
1.838 bisitz 5943: }
5944:
1.813 bisitz 5945: #LC_nav_bar {
1.911 bisitz 5946: float: left;
1.934 droeschl 5947: margin: 0;
1.807 droeschl 5948: }
5949:
1.916 droeschl 5950: #LC_realm {
5951: margin: 0.2em 0 0 0;
5952: padding: 0;
5953: font-weight: bold;
5954: text-align: center;
5955: }
5956:
1.911 bisitz 5957: #LC_nav_bar em {
5958: font-weight: bold;
5959: font-style: normal;
1.807 droeschl 5960: }
5961:
1.897 wenzelju 5962: ol.LC_primary_menu {
1.911 bisitz 5963: float: right;
1.934 droeschl 5964: margin: 0;
1.807 droeschl 5965: }
5966:
1.929 wenzelju 5967: span.LC_new_message{
5968: font-weight:bold;
5969: color: darkred;
5970: }
5971:
1.852 droeschl 5972: ol#LC_PathBreadcrumbs {
1.911 bisitz 5973: margin: 0;
1.693 droeschl 5974: }
5975:
1.897 wenzelju 5976: ol.LC_primary_menu li {
1.911 bisitz 5977: display: inline;
5978: padding: 5px 5px 0 10px;
5979: vertical-align: top;
1.693 droeschl 5980: }
5981:
1.897 wenzelju 5982: ol.LC_primary_menu li img {
1.911 bisitz 5983: vertical-align: bottom;
1.934 droeschl 5984: height: 1.1em;
1.693 droeschl 5985: }
5986:
1.897 wenzelju 5987: ol.LC_primary_menu a {
1.911 bisitz 5988: color: RGB(80, 80, 80);
5989: text-decoration: none;
1.693 droeschl 5990: }
1.795 www 5991:
1.897 wenzelju 5992: ul#LC_secondary_menu {
1.911 bisitz 5993: clear: both;
5994: color: $fontmenu;
5995: background: $tabbg;
5996: list-style: none;
5997: padding: 0;
5998: margin: 0;
5999: width: 100%;
1.808 droeschl 6000: }
6001:
1.897 wenzelju 6002: ul#LC_secondary_menu li {
1.911 bisitz 6003: font-weight: bold;
6004: line-height: 1.8em;
6005: padding: 0 0.8em;
6006: border-right: 1px solid black;
6007: display: inline;
6008: vertical-align: middle;
1.807 droeschl 6009: }
6010:
1.847 tempelho 6011: ul.LC_TabContent {
1.911 bisitz 6012: display:block;
6013: background: $sidebg;
6014: border-bottom: solid 1px $lg_border_color;
6015: list-style:none;
6016: margin: 0 -10px;
6017: padding: 0;
1.693 droeschl 6018: }
6019:
1.795 www 6020: ul.LC_TabContent li,
6021: ul.LC_TabContentBigger li {
1.911 bisitz 6022: float:left;
1.741 harmsja 6023: }
1.795 www 6024:
1.897 wenzelju 6025: ul#LC_secondary_menu li a {
1.911 bisitz 6026: color: $fontmenu;
6027: text-decoration: none;
1.693 droeschl 6028: }
1.795 www 6029:
1.721 harmsja 6030: ul.LC_TabContent {
1.911 bisitz 6031: min-height:1.5em;
1.721 harmsja 6032: }
1.795 www 6033:
6034: ul.LC_TabContent li {
1.911 bisitz 6035: vertical-align:middle;
6036: padding: 0 10px 0 10px;
6037: background-color:$tabbg;
6038: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6039: }
1.795 www 6040:
1.847 tempelho 6041: ul.LC_TabContent .right {
1.911 bisitz 6042: float:right;
1.847 tempelho 6043: }
6044:
1.911 bisitz 6045: ul.LC_TabContent li a,
6046: ul.LC_TabContent li {
6047: color:rgb(47,47,47);
6048: text-decoration:none;
6049: font-size:95%;
6050: font-weight:bold;
6051: padding-right: 16px;
1.721 harmsja 6052: }
1.795 www 6053:
1.911 bisitz 6054: ul.LC_TabContent li:hover,
6055: ul.LC_TabContent li.active {
6056: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6057: border-bottom:solid 2px #FFFFFF;
6058: padding-right: 16px;
1.744 ehlerst 6059: }
1.795 www 6060:
1.870 tempelho 6061: #maincoursedoc {
1.911 bisitz 6062: clear:both;
1.870 tempelho 6063: }
6064:
6065: ul.LC_TabContentBigger {
1.911 bisitz 6066: display:block;
6067: list-style:none;
6068: padding: 0;
1.870 tempelho 6069: }
6070:
1.795 www 6071: ul.LC_TabContentBigger li {
1.911 bisitz 6072: vertical-align:bottom;
6073: height: 30px;
6074: font-size:110%;
6075: font-weight:bold;
6076: color: #737373;
1.841 tempelho 6077: }
6078:
1.870 tempelho 6079:
6080: ul.LC_TabContentBigger li a {
1.911 bisitz 6081: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6082: height: 30px;
6083: line-height: 30px;
6084: text-align: center;
6085: display: block;
6086: text-decoration: none;
1.741 harmsja 6087: }
1.795 www 6088:
1.911 bisitz 6089: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6090: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6091: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6092: color:$font;
6093: text-decoration: underline;
1.744 ehlerst 6094: }
1.795 www 6095:
1.870 tempelho 6096:
6097: ul.LC_TabContentBigger li b {
1.911 bisitz 6098: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6099: display: block;
6100: float: left;
6101: padding: 0 30px;
1.870 tempelho 6102: }
6103:
6104: ul.LC_TabContentBigger li:hover b,
6105: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6106: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6107: color:$font;
6108: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6109: }
1.693 droeschl 6110:
1.870 tempelho 6111:
1.862 bisitz 6112: ul.LC_CourseBreadcrumbs {
6113: background: $sidebg;
6114: line-height: 32px;
6115: padding-left: 10px;
6116: margin: 0 0 10px 0;
6117: list-style-position: inside;
6118:
6119: }
6120:
1.911 bisitz 6121: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6122: ol#LC_PathBreadcrumbs {
1.911 bisitz 6123: padding-left: 10px;
6124: margin: 0;
1.933 droeschl 6125: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6126: }
6127:
1.911 bisitz 6128: ol#LC_MenuBreadcrumbs li,
6129: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6130: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6131: display: inline;
1.933 droeschl 6132: white-space: normal;
1.693 droeschl 6133: }
6134:
1.823 bisitz 6135: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6136: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6137: text-decoration: none;
6138: font-size:90%;
1.693 droeschl 6139: }
1.795 www 6140:
6141: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6142: text-decoration:none;
6143: font-size:100%;
6144: font-weight:bold;
1.693 droeschl 6145: }
1.795 www 6146:
1.840 bisitz 6147: .LC_Box {
1.911 bisitz 6148: border: solid 1px $lg_border_color;
6149: padding: 0 10px 10px 10px;
1.746 neumanie 6150: }
1.795 www 6151:
6152: .LC_AboutMe_Image {
1.911 bisitz 6153: float:left;
6154: margin-right:10px;
1.747 neumanie 6155: }
1.795 www 6156:
6157: .LC_Clear_AboutMe_Image {
1.911 bisitz 6158: clear:left;
1.747 neumanie 6159: }
1.795 www 6160:
1.721 harmsja 6161: dl.LC_ListStyleClean dt {
1.911 bisitz 6162: padding-right: 5px;
6163: display: table-header-group;
1.693 droeschl 6164: }
6165:
1.721 harmsja 6166: dl.LC_ListStyleClean dd {
1.911 bisitz 6167: display: table-row;
1.693 droeschl 6168: }
6169:
1.721 harmsja 6170: .LC_ListStyleClean,
6171: .LC_ListStyleSimple,
6172: .LC_ListStyleNormal,
1.795 www 6173: .LC_ListStyleSpecial {
1.911 bisitz 6174: /* display:block; */
6175: list-style-position: inside;
6176: list-style-type: none;
6177: overflow: hidden;
6178: padding: 0;
1.693 droeschl 6179: }
6180:
1.721 harmsja 6181: .LC_ListStyleSimple li,
6182: .LC_ListStyleSimple dd,
6183: .LC_ListStyleNormal li,
6184: .LC_ListStyleNormal dd,
6185: .LC_ListStyleSpecial li,
1.795 www 6186: .LC_ListStyleSpecial dd {
1.911 bisitz 6187: margin: 0;
6188: padding: 5px 5px 5px 10px;
6189: clear: both;
1.693 droeschl 6190: }
6191:
1.721 harmsja 6192: .LC_ListStyleClean li,
6193: .LC_ListStyleClean dd {
1.911 bisitz 6194: padding-top: 0;
6195: padding-bottom: 0;
1.693 droeschl 6196: }
6197:
1.721 harmsja 6198: .LC_ListStyleSimple dd,
1.795 www 6199: .LC_ListStyleSimple li {
1.911 bisitz 6200: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6201: }
6202:
1.721 harmsja 6203: .LC_ListStyleSpecial li,
6204: .LC_ListStyleSpecial dd {
1.911 bisitz 6205: list-style-type: none;
6206: background-color: RGB(220, 220, 220);
6207: margin-bottom: 4px;
1.693 droeschl 6208: }
6209:
1.721 harmsja 6210: table.LC_SimpleTable {
1.911 bisitz 6211: margin:5px;
6212: border:solid 1px $lg_border_color;
1.795 www 6213: }
1.693 droeschl 6214:
1.721 harmsja 6215: table.LC_SimpleTable tr {
1.911 bisitz 6216: padding: 0;
6217: border:solid 1px $lg_border_color;
1.693 droeschl 6218: }
1.795 www 6219:
6220: table.LC_SimpleTable thead {
1.911 bisitz 6221: background:rgb(220,220,220);
1.693 droeschl 6222: }
6223:
1.721 harmsja 6224: div.LC_columnSection {
1.911 bisitz 6225: display: block;
6226: clear: both;
6227: overflow: hidden;
6228: margin: 0;
1.693 droeschl 6229: }
6230:
1.721 harmsja 6231: div.LC_columnSection>* {
1.911 bisitz 6232: float: left;
6233: margin: 10px 20px 10px 0;
6234: overflow:hidden;
1.693 droeschl 6235: }
1.721 harmsja 6236:
1.694 tempelho 6237: .LC_loginpage_container {
1.911 bisitz 6238: text-align:left;
6239: margin : 0 auto;
6240: width:90%;
6241: padding: 10px;
6242: height: auto;
6243: background-color:#FFFFFF;
6244: border:1px solid #CCCCCC;
1.694 tempelho 6245: }
6246:
6247:
6248: .LC_loginpage_loginContainer {
1.911 bisitz 6249: float:left;
6250: width: 182px;
6251: padding: 2px;
6252: border:1px solid #CCCCCC;
6253: background-color:$loginbg;
1.694 tempelho 6254: }
6255:
1.795 www 6256: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6257: margin-top: 0;
6258: display:block;
6259: background:$bgcol;
6260: color:$textcol;
6261: padding-left:5px;
1.712 muellerd 6262: }
1.785 tempelho 6263:
1.694 tempelho 6264: .LC_loginpage_loginInfo {
1.911 bisitz 6265: float:left;
6266: width:182px;
6267: border:1px solid #CCCCCC;
6268: padding:2px;
1.712 muellerd 6269: }
6270:
1.694 tempelho 6271: .LC_loginpage_space {
1.911 bisitz 6272: clear: both;
6273: margin-bottom: 20px;
6274: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6275: }
6276:
1.785 tempelho 6277: .LC_loginpage_floatLeft {
1.911 bisitz 6278: float: left;
6279: width: 200px;
6280: margin: 0;
1.785 tempelho 6281: }
6282:
1.795 www 6283: table em {
1.911 bisitz 6284: font-weight: bold;
6285: font-style: normal;
1.748 schulted 6286: }
1.795 www 6287:
1.779 bisitz 6288: table.LC_tableBrowseRes,
1.795 www 6289: table.LC_tableOfContent {
1.911 bisitz 6290: border:none;
6291: border-spacing: 1px;
6292: padding: 3px;
6293: background-color: #FFFFFF;
6294: font-size: 90%;
1.753 droeschl 6295: }
1.789 droeschl 6296:
1.911 bisitz 6297: table.LC_tableOfContent {
6298: border-collapse: collapse;
1.789 droeschl 6299: }
6300:
1.771 droeschl 6301: table.LC_tableBrowseRes a,
1.768 schulted 6302: table.LC_tableOfContent a {
1.911 bisitz 6303: background-color: transparent;
6304: text-decoration: none;
1.753 droeschl 6305: }
6306:
1.795 www 6307: table.LC_tableOfContent img {
1.911 bisitz 6308: border: none;
6309: height: 1.3em;
6310: vertical-align: text-bottom;
6311: margin-right: 0.3em;
1.753 droeschl 6312: }
1.757 schulted 6313:
1.795 www 6314: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6315: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6316: }
6317:
1.795 www 6318: a#LC_content_toolbar_launchnav {
1.911 bisitz 6319: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6320: }
6321:
1.795 www 6322: a#LC_content_toolbar_closenav {
1.911 bisitz 6323: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6324: }
6325:
1.795 www 6326: a#LC_content_toolbar_everything {
1.911 bisitz 6327: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6328: }
6329:
1.795 www 6330: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6331: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6332: }
6333:
1.795 www 6334: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6335: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6336: }
6337:
1.795 www 6338: a#LC_content_toolbar_changefolder {
1.911 bisitz 6339: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6340: }
6341:
1.795 www 6342: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6343: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6344: }
6345:
1.795 www 6346: ul#LC_toolbar li a:hover {
1.911 bisitz 6347: background-position: bottom center;
1.757 schulted 6348: }
6349:
1.795 www 6350: ul#LC_toolbar {
1.911 bisitz 6351: padding: 0;
6352: margin: 2px;
6353: list-style:none;
6354: position:relative;
6355: background-color:white;
1.757 schulted 6356: }
6357:
1.795 www 6358: ul#LC_toolbar li {
1.911 bisitz 6359: border:1px solid white;
6360: padding: 0;
6361: margin: 0;
6362: float: left;
6363: display:inline;
6364: vertical-align:middle;
6365: }
1.757 schulted 6366:
1.783 amueller 6367:
1.795 www 6368: a.LC_toolbarItem {
1.911 bisitz 6369: display:block;
6370: padding: 0;
6371: margin: 0;
6372: height: 32px;
6373: width: 32px;
6374: color:white;
6375: border: none;
6376: background-repeat:no-repeat;
6377: background-color:transparent;
1.757 schulted 6378: }
6379:
1.915 droeschl 6380: ul.LC_funclist {
6381: margin: 0;
6382: padding: 0.5em 1em 0.5em 0;
6383: }
6384:
1.933 droeschl 6385: ul.LC_funclist > li:first-child {
6386: font-weight:bold;
6387: margin-left:0.8em;
6388: }
6389:
1.915 droeschl 6390: ul.LC_funclist + ul.LC_funclist {
6391: /*
6392: left border as a seperator if we have more than
6393: one list
6394: */
6395: border-left: 1px solid $sidebg;
6396: /*
6397: this hides the left border behind the border of the
6398: outer box if element is wrapped to the next 'line'
6399: */
6400: margin-left: -1px;
6401: }
6402:
1.843 bisitz 6403: ul.LC_funclist li {
1.915 droeschl 6404: display: inline;
1.782 bisitz 6405: white-space: nowrap;
1.915 droeschl 6406: margin: 0 0 0 25px;
6407: line-height: 150%;
1.782 bisitz 6408: }
6409:
1.930 faziophi 6410: .ui-accordion .LC_advanced_toggle {
6411: float: right;
6412: font-size: 90%;
6413: padding: 0px 4px
6414: }
1.757 schulted 6415:
1.343 albertel 6416: END
6417: }
6418:
1.306 albertel 6419: =pod
6420:
6421: =item * &headtag()
6422:
6423: Returns a uniform footer for LON-CAPA web pages.
6424:
1.307 albertel 6425: Inputs: $title - optional title for the head
6426: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6427: $args - optional arguments
1.319 albertel 6428: force_register - if is true call registerurl so the remote is
6429: informed
1.415 albertel 6430: redirect -> array ref of
6431: 1- seconds before redirect occurs
6432: 2- url to redirect to
6433: 3- whether the side effect should occur
1.315 albertel 6434: (side effect of setting
6435: $env{'internal.head.redirect'} to the url
6436: redirected too)
1.352 albertel 6437: domain -> force to color decorate a page for a specific
6438: domain
6439: function -> force usage of a specific rolish color scheme
6440: bgcolor -> override the default page bgcolor
1.460 albertel 6441: no_auto_mt_title
6442: -> prevent &mt()ing the title arg
1.464 albertel 6443:
1.306 albertel 6444: =cut
6445:
6446: sub headtag {
1.313 albertel 6447: my ($title,$head_extra,$args) = @_;
1.306 albertel 6448:
1.363 albertel 6449: my $function = $args->{'function'} || &get_users_function();
6450: my $domain = $args->{'domain'} || &determinedomain();
6451: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6452: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6453: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6454: #time(),
1.418 albertel 6455: $env{'environment.color.timestamp'},
1.363 albertel 6456: $function,$domain,$bgcolor);
6457:
1.369 www 6458: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6459:
1.308 albertel 6460: my $result =
6461: '<head>'.
1.461 albertel 6462: &font_settings();
1.319 albertel 6463:
1.461 albertel 6464: if (!$args->{'frameset'}) {
6465: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6466: }
1.319 albertel 6467: if ($args->{'force_register'}) {
6468: $result .= &Apache::lonmenu::registerurl(1);
6469: }
1.436 albertel 6470: if (!$args->{'no_nav_bar'}
6471: && !$args->{'only_body'}
6472: && !$args->{'frameset'}) {
6473: $result .= &help_menu_js();
6474: }
1.319 albertel 6475:
1.314 albertel 6476: if (ref($args->{'redirect'})) {
1.414 albertel 6477: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6478: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6479: if (!$inhibit_continue) {
6480: $env{'internal.head.redirect'} = $url;
6481: }
1.313 albertel 6482: $result.=<<ADDMETA
6483: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6484: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6485: ADDMETA
6486: }
1.306 albertel 6487: if (!defined($title)) {
6488: $title = 'The LearningOnline Network with CAPA';
6489: }
1.460 albertel 6490: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6491: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6492: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6493: .$head_extra;
1.306 albertel 6494: return $result;
6495: }
6496:
6497: =pod
6498:
1.340 albertel 6499: =item * &font_settings()
6500:
6501: Returns neccessary <meta> to set the proper encoding
6502:
6503: Inputs: none
6504:
6505: =cut
6506:
6507: sub font_settings {
6508: my $headerstring='';
1.647 www 6509: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6510: $headerstring.=
6511: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6512: }
6513: return $headerstring;
6514: }
6515:
1.341 albertel 6516: =pod
6517:
6518: =item * &xml_begin()
6519:
6520: Returns the needed doctype and <html>
6521:
6522: Inputs: none
6523:
6524: =cut
6525:
6526: sub xml_begin {
6527: my $output='';
6528:
1.592 albertel 6529: if ($env{'internal.start_page'}==1) {
6530: &Apache::lonhtmlcommon::init_htmlareafields();
6531: }
1.342 albertel 6532:
1.341 albertel 6533: if ($env{'browser.mathml'}) {
6534: $output='<?xml version="1.0"?>'
6535: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6536: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6537:
6538: # .'<!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">] >'
6539: .'<!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">'
6540: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6541: .'xmlns="http://www.w3.org/1999/xhtml">';
6542: } else {
1.849 bisitz 6543: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6544: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6545: }
6546: return $output;
6547: }
1.340 albertel 6548:
6549: =pod
6550:
1.306 albertel 6551: =item * &endheadtag()
6552:
6553: Returns a uniform </head> for LON-CAPA web pages.
6554:
6555: Inputs: none
6556:
6557: =cut
6558:
6559: sub endheadtag {
6560: return '</head>';
6561: }
6562:
6563: =pod
6564:
6565: =item * &head()
6566:
6567: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6568:
1.648 raeburn 6569: Inputs:
6570:
6571: =over 4
6572:
6573: $title - optional title for the page
6574:
6575: $head_extra - optional extra HTML to put inside the <head>
6576:
6577: =back
1.405 albertel 6578:
1.306 albertel 6579: =cut
6580:
6581: sub head {
1.325 albertel 6582: my ($title,$head_extra,$args) = @_;
6583: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6584: }
6585:
6586: =pod
6587:
6588: =item * &start_page()
6589:
6590: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6591:
1.648 raeburn 6592: Inputs:
6593:
6594: =over 4
6595:
6596: $title - optional title for the page
6597:
6598: $head_extra - optional extra HTML to incude inside the <head>
6599:
6600: $args - additional optional args supported are:
6601:
6602: =over 8
6603:
6604: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6605: arg on
1.814 bisitz 6606: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6607: add_entries -> additional attributes to add to the <body>
6608: domain -> force to color decorate a page for a
1.317 albertel 6609: specific domain
1.648 raeburn 6610: function -> force usage of a specific rolish color
1.317 albertel 6611: scheme
1.648 raeburn 6612: redirect -> see &headtag()
6613: bgcolor -> override the default page bg color
6614: js_ready -> return a string ready for being used in
1.317 albertel 6615: a javascript writeln
1.648 raeburn 6616: html_encode -> return a string ready for being used in
1.320 albertel 6617: a html attribute
1.648 raeburn 6618: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6619: $forcereg arg
1.648 raeburn 6620: frameset -> if true will start with a <frameset>
1.330 albertel 6621: rather than <body>
1.648 raeburn 6622: skip_phases -> hash ref of
1.338 albertel 6623: head -> skip the <html><head> generation
6624: body -> skip all <body> generation
1.648 raeburn 6625: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6626: 'Switch To Inline Menu' link
1.648 raeburn 6627: no_auto_mt_title -> prevent &mt()ing the title arg
6628: inherit_jsmath -> when creating popup window in a page,
6629: should it have jsmath forced on by the
6630: current page
1.867 kalberla 6631: bread_crumbs -> Array containing breadcrumbs
6632: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6633:
1.648 raeburn 6634: =back
1.460 albertel 6635:
1.648 raeburn 6636: =back
1.562 albertel 6637:
1.306 albertel 6638: =cut
6639:
6640: sub start_page {
1.309 albertel 6641: my ($title,$head_extra,$args) = @_;
1.318 albertel 6642: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6643: my %head_args;
1.352 albertel 6644: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6645: 'bgcolor','frameset','no_nav_bar','only_body',
6646: 'no_auto_mt_title') {
1.319 albertel 6647: if (defined($args->{$arg})) {
1.324 raeburn 6648: $head_args{$arg} = $args->{$arg};
1.319 albertel 6649: }
1.313 albertel 6650: }
1.319 albertel 6651:
1.315 albertel 6652: $env{'internal.start_page'}++;
1.338 albertel 6653: my $result;
6654: if (! exists($args->{'skip_phases'}{'head'}) ) {
6655: $result.=
1.341 albertel 6656: &xml_begin().
1.338 albertel 6657: &headtag($title,$head_extra,\%head_args).&endheadtag();
6658: }
6659:
6660: if (! exists($args->{'skip_phases'}{'body'}) ) {
6661: if ($args->{'frameset'}) {
6662: my $attr_string = &make_attr_string($args->{'force_register'},
6663: $args->{'add_entries'});
6664: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6665: } else {
6666: $result .=
6667: &bodytag($title,
6668: $args->{'function'}, $args->{'add_entries'},
6669: $args->{'only_body'}, $args->{'domain'},
6670: $args->{'force_register'}, $args->{'no_nav_bar'},
6671: $args->{'bgcolor'}, $args->{'no_inline_link'},
6672: $args);
6673: }
1.330 albertel 6674: }
1.338 albertel 6675:
1.315 albertel 6676: if ($args->{'js_ready'}) {
1.713 kaisler 6677: $result = &js_ready($result);
1.315 albertel 6678: }
1.320 albertel 6679: if ($args->{'html_encode'}) {
1.713 kaisler 6680: $result = &html_encode($result);
6681: }
6682:
1.813 bisitz 6683: # Preparation for new and consistent functionlist at top of screen
6684: # if ($args->{'functionlist'}) {
6685: # $result .= &build_functionlist();
6686: #}
6687:
6688: # Don't add anything more if only_body wanted
6689: return $result if $args->{'only_body'};
6690:
1.920 raeburn 6691: #Breadcrumbs for Construction Space provided by &bodytag.
6692: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6693: return $result;
6694: }
6695:
1.813 bisitz 6696: #Breadcrumbs
1.758 kaisler 6697: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6698: &Apache::lonhtmlcommon::clear_breadcrumbs();
6699: #if any br links exists, add them to the breadcrumbs
6700: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6701: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6702: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6703: }
6704: }
6705:
6706: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6707: if(exists($args->{'bread_crumbs_component'})){
6708: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6709: }else{
6710: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6711: }
1.320 albertel 6712: }
1.315 albertel 6713: return $result;
1.306 albertel 6714: }
6715:
1.330 albertel 6716:
1.306 albertel 6717: =pod
6718:
6719: =item * &head()
6720:
6721: Returns a complete </body></html> section for LON-CAPA web pages.
6722:
1.315 albertel 6723: Inputs: $args - additional optional args supported are:
6724: js_ready -> return a string ready for being used in
6725: a javascript writeln
1.320 albertel 6726: html_encode -> return a string ready for being used in
6727: a html attribute
1.330 albertel 6728: frameset -> if true will start with a <frameset>
6729: rather than <body>
1.493 albertel 6730: dicsussion -> if true will get discussion from
6731: lonxml::xmlend
6732: (you can pass the target and parser arguments
6733: through optional 'target' and 'parser' args
6734: to this routine)
1.306 albertel 6735:
6736: =cut
6737:
6738: sub end_page {
1.315 albertel 6739: my ($args) = @_;
6740: $env{'internal.end_page'}++;
1.330 albertel 6741: my $result;
1.335 albertel 6742: if ($args->{'discussion'}) {
6743: my ($target,$parser);
6744: if (ref($args->{'discussion'})) {
6745: ($target,$parser) =($args->{'discussion'}{'target'},
6746: $args->{'discussion'}{'parser'});
6747: }
6748: $result .= &Apache::lonxml::xmlend($target,$parser);
6749: }
6750:
1.330 albertel 6751: if ($args->{'frameset'}) {
6752: $result .= '</frameset>';
6753: } else {
1.635 raeburn 6754: $result .= &endbodytag($args);
1.330 albertel 6755: }
6756: $result .= "\n</html>";
6757:
1.315 albertel 6758: if ($args->{'js_ready'}) {
1.317 albertel 6759: $result = &js_ready($result);
1.315 albertel 6760: }
1.335 albertel 6761:
1.320 albertel 6762: if ($args->{'html_encode'}) {
6763: $result = &html_encode($result);
6764: }
1.335 albertel 6765:
1.315 albertel 6766: return $result;
6767: }
6768:
1.320 albertel 6769: sub html_encode {
6770: my ($result) = @_;
6771:
1.322 albertel 6772: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6773:
6774: return $result;
6775: }
1.317 albertel 6776: sub js_ready {
6777: my ($result) = @_;
6778:
1.323 albertel 6779: $result =~ s/[\n\r]/ /xmsg;
6780: $result =~ s/\\/\\\\/xmsg;
6781: $result =~ s/'/\\'/xmsg;
1.372 albertel 6782: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6783:
6784: return $result;
6785: }
6786:
1.315 albertel 6787: sub validate_page {
6788: if ( exists($env{'internal.start_page'})
1.316 albertel 6789: && $env{'internal.start_page'} > 1) {
6790: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6791: $env{'internal.start_page'}.' '.
1.316 albertel 6792: $ENV{'request.filename'});
1.315 albertel 6793: }
6794: if ( exists($env{'internal.end_page'})
1.316 albertel 6795: && $env{'internal.end_page'} > 1) {
6796: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6797: $env{'internal.end_page'}.' '.
1.316 albertel 6798: $env{'request.filename'});
1.315 albertel 6799: }
6800: if ( exists($env{'internal.start_page'})
6801: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6802: &Apache::lonnet::logthis('start_page called without end_page '.
6803: $env{'request.filename'});
1.315 albertel 6804: }
6805: if ( ! exists($env{'internal.start_page'})
6806: && exists($env{'internal.end_page'})) {
1.316 albertel 6807: &Apache::lonnet::logthis('end_page called without start_page'.
6808: $env{'request.filename'});
1.315 albertel 6809: }
1.306 albertel 6810: }
1.315 albertel 6811:
1.318 albertel 6812: sub simple_error_page {
6813: my ($r,$title,$msg) = @_;
6814: my $page =
6815: &Apache::loncommon::start_page($title).
6816: &mt($msg).
6817: &Apache::loncommon::end_page();
6818: if (ref($r)) {
6819: $r->print($page);
1.327 albertel 6820: return;
1.318 albertel 6821: }
6822: return $page;
6823: }
1.347 albertel 6824:
6825: {
1.610 albertel 6826: my @row_count;
1.347 albertel 6827: sub start_data_table {
1.422 albertel 6828: my ($add_class) = @_;
6829: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6830: unshift(@row_count,0);
1.422 albertel 6831: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6832: }
6833:
6834: sub end_data_table {
1.610 albertel 6835: shift(@row_count);
1.389 albertel 6836: return '</table>'."\n";;
1.347 albertel 6837: }
6838:
6839: sub start_data_table_row {
1.422 albertel 6840: my ($add_class) = @_;
1.610 albertel 6841: $row_count[0]++;
6842: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6843: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6844: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6845: }
1.471 banghart 6846:
6847: sub continue_data_table_row {
6848: my ($add_class) = @_;
1.610 albertel 6849: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6850: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6851: return '<tr class="'.$css_class.'">'."\n";;
6852: }
1.347 albertel 6853:
6854: sub end_data_table_row {
1.389 albertel 6855: return '</tr>'."\n";;
1.347 albertel 6856: }
1.367 www 6857:
1.421 albertel 6858: sub start_data_table_empty_row {
1.707 bisitz 6859: # $row_count[0]++;
1.421 albertel 6860: return '<tr class="LC_empty_row" >'."\n";;
6861: }
6862:
6863: sub end_data_table_empty_row {
6864: return '</tr>'."\n";;
6865: }
6866:
1.367 www 6867: sub start_data_table_header_row {
1.389 albertel 6868: return '<tr class="LC_header_row">'."\n";;
1.367 www 6869: }
6870:
6871: sub end_data_table_header_row {
1.389 albertel 6872: return '</tr>'."\n";;
1.367 www 6873: }
1.890 droeschl 6874:
6875: sub data_table_caption {
6876: my $caption = shift;
6877: return "<caption class=\"LC_caption\">$caption</caption>";
6878: }
1.347 albertel 6879: }
6880:
1.548 albertel 6881: =pod
6882:
6883: =item * &inhibit_menu_check($arg)
6884:
6885: Checks for a inhibitmenu state and generates output to preserve it
6886:
6887: Inputs: $arg - can be any of
6888: - undef - in which case the return value is a string
6889: to add into arguments list of a uri
6890: - 'input' - in which case the return value is a HTML
6891: <form> <input> field of type hidden to
6892: preserve the value
6893: - a url - in which case the return value is the url with
6894: the neccesary cgi args added to preserve the
6895: inhibitmenu state
6896: - a ref to a url - no return value, but the string is
6897: updated to include the neccessary cgi
6898: args to preserve the inhibitmenu state
6899:
6900: =cut
6901:
6902: sub inhibit_menu_check {
6903: my ($arg) = @_;
6904: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6905: if ($arg eq 'input') {
6906: if ($env{'form.inhibitmenu'}) {
6907: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6908: } else {
6909: return
6910: }
6911: }
6912: if ($env{'form.inhibitmenu'}) {
6913: if (ref($arg)) {
6914: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6915: } elsif ($arg eq '') {
6916: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6917: } else {
6918: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6919: }
6920: }
6921: if (!ref($arg)) {
6922: return $arg;
6923: }
6924: }
6925:
1.251 albertel 6926: ###############################################
1.182 matthew 6927:
6928: =pod
6929:
1.549 albertel 6930: =back
6931:
6932: =head1 User Information Routines
6933:
6934: =over 4
6935:
1.405 albertel 6936: =item * &get_users_function()
1.182 matthew 6937:
6938: Used by &bodytag to determine the current users primary role.
6939: Returns either 'student','coordinator','admin', or 'author'.
6940:
6941: =cut
6942:
6943: ###############################################
6944: sub get_users_function {
1.815 tempelho 6945: my $function = 'norole';
1.818 tempelho 6946: if ($env{'request.role'}=~/^(st)/) {
6947: $function='student';
6948: }
1.907 raeburn 6949: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6950: $function='coordinator';
6951: }
1.258 albertel 6952: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6953: $function='admin';
6954: }
1.826 bisitz 6955: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6956: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6957: $function='author';
6958: }
6959: return $function;
1.54 www 6960: }
1.99 www 6961:
6962: ###############################################
6963:
1.233 raeburn 6964: =pod
6965:
1.821 raeburn 6966: =item * &show_course()
6967:
6968: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6969: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6970:
6971: Inputs:
6972: None
6973:
6974: Outputs:
6975: Scalar: 1 if 'Course' to be used, 0 otherwise.
6976:
6977: =cut
6978:
6979: ###############################################
6980: sub show_course {
6981: my $course = !$env{'user.adv'};
6982: if (!$env{'user.adv'}) {
6983: foreach my $env (keys(%env)) {
6984: next if ($env !~ m/^user\.priv\./);
6985: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
6986: $course = 0;
6987: last;
6988: }
6989: }
6990: }
6991: return $course;
6992: }
6993:
6994: ###############################################
6995:
6996: =pod
6997:
1.542 raeburn 6998: =item * &check_user_status()
1.274 raeburn 6999:
7000: Determines current status of supplied role for a
7001: specific user. Roles can be active, previous or future.
7002:
7003: Inputs:
7004: user's domain, user's username, course's domain,
1.375 raeburn 7005: course's number, optional section ID.
1.274 raeburn 7006:
7007: Outputs:
7008: role status: active, previous or future.
7009:
7010: =cut
7011:
7012: sub check_user_status {
1.412 raeburn 7013: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7014: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7015: my @uroles = keys %userinfo;
7016: my $srchstr;
7017: my $active_chk = 'none';
1.412 raeburn 7018: my $now = time;
1.274 raeburn 7019: if (@uroles > 0) {
1.908 raeburn 7020: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7021: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7022: } else {
1.412 raeburn 7023: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7024: }
7025: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7026: my $role_end = 0;
7027: my $role_start = 0;
7028: $active_chk = 'active';
1.412 raeburn 7029: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7030: $role_end = $1;
7031: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7032: $role_start = $1;
1.274 raeburn 7033: }
7034: }
7035: if ($role_start > 0) {
1.412 raeburn 7036: if ($now < $role_start) {
1.274 raeburn 7037: $active_chk = 'future';
7038: }
7039: }
7040: if ($role_end > 0) {
1.412 raeburn 7041: if ($now > $role_end) {
1.274 raeburn 7042: $active_chk = 'previous';
7043: }
7044: }
7045: }
7046: }
7047: return $active_chk;
7048: }
7049:
7050: ###############################################
7051:
7052: =pod
7053:
1.405 albertel 7054: =item * &get_sections()
1.233 raeburn 7055:
7056: Determines all the sections for a course including
7057: sections with students and sections containing other roles.
1.419 raeburn 7058: Incoming parameters:
7059:
7060: 1. domain
7061: 2. course number
7062: 3. reference to array containing roles for which sections should
7063: be gathered (optional).
7064: 4. reference to array containing status types for which sections
7065: should be gathered (optional).
7066:
7067: If the third argument is undefined, sections are gathered for any role.
7068: If the fourth argument is undefined, sections are gathered for any status.
7069: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7070:
1.374 raeburn 7071: Returns section hash (keys are section IDs, values are
7072: number of users in each section), subject to the
1.419 raeburn 7073: optional roles filter, optional status filter
1.233 raeburn 7074:
7075: =cut
7076:
7077: ###############################################
7078: sub get_sections {
1.419 raeburn 7079: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7080: if (!defined($cdom) || !defined($cnum)) {
7081: my $cid = $env{'request.course.id'};
7082:
7083: return if (!defined($cid));
7084:
7085: $cdom = $env{'course.'.$cid.'.domain'};
7086: $cnum = $env{'course.'.$cid.'.num'};
7087: }
7088:
7089: my %sectioncount;
1.419 raeburn 7090: my $now = time;
1.240 albertel 7091:
1.366 albertel 7092: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7093: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7094: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7095: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7096: my $start_index = &Apache::loncoursedata::CL_START();
7097: my $end_index = &Apache::loncoursedata::CL_END();
7098: my $status;
1.366 albertel 7099: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7100: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7101: $data->[$status_index],
7102: $data->[$start_index],
7103: $data->[$end_index]);
7104: if ($stu_status eq 'Active') {
7105: $status = 'active';
7106: } elsif ($end < $now) {
7107: $status = 'previous';
7108: } elsif ($start > $now) {
7109: $status = 'future';
7110: }
7111: if ($section ne '-1' && $section !~ /^\s*$/) {
7112: if ((!defined($possible_status)) || (($status ne '') &&
7113: (grep/^\Q$status\E$/,@{$possible_status}))) {
7114: $sectioncount{$section}++;
7115: }
1.240 albertel 7116: }
7117: }
7118: }
7119: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7120: foreach my $user (sort(keys(%courseroles))) {
7121: if ($user !~ /^(\w{2})/) { next; }
7122: my ($role) = ($user =~ /^(\w{2})/);
7123: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7124: my ($section,$status);
1.240 albertel 7125: if ($role eq 'cr' &&
7126: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7127: $section=$1;
7128: }
7129: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7130: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7131: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7132: if ($end == -1 && $start == -1) {
7133: next; #deleted role
7134: }
7135: if (!defined($possible_status)) {
7136: $sectioncount{$section}++;
7137: } else {
7138: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7139: $status = 'active';
7140: } elsif ($end < $now) {
7141: $status = 'future';
7142: } elsif ($start > $now) {
7143: $status = 'previous';
7144: }
7145: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7146: $sectioncount{$section}++;
7147: }
7148: }
1.233 raeburn 7149: }
1.366 albertel 7150: return %sectioncount;
1.233 raeburn 7151: }
7152:
1.274 raeburn 7153: ###############################################
1.294 raeburn 7154:
7155: =pod
1.405 albertel 7156:
7157: =item * &get_course_users()
7158:
1.275 raeburn 7159: Retrieves usernames:domains for users in the specified course
7160: with specific role(s), and access status.
7161:
7162: Incoming parameters:
1.277 albertel 7163: 1. course domain
7164: 2. course number
7165: 3. access status: users must have - either active,
1.275 raeburn 7166: previous, future, or all.
1.277 albertel 7167: 4. reference to array of permissible roles
1.288 raeburn 7168: 5. reference to array of section restrictions (optional)
7169: 6. reference to results object (hash of hashes).
7170: 7. reference to optional userdata hash
1.609 raeburn 7171: 8. reference to optional statushash
1.630 raeburn 7172: 9. flag if privileged users (except those set to unhide in
7173: course settings) should be excluded
1.609 raeburn 7174: Keys of top level results hash are roles.
1.275 raeburn 7175: Keys of inner hashes are username:domain, with
7176: values set to access type.
1.288 raeburn 7177: Optional userdata hash returns an array with arguments in the
7178: same order as loncoursedata::get_classlist() for student data.
7179:
1.609 raeburn 7180: Optional statushash returns
7181:
1.288 raeburn 7182: Entries for end, start, section and status are blank because
7183: of the possibility of multiple values for non-student roles.
7184:
1.275 raeburn 7185: =cut
1.405 albertel 7186:
1.275 raeburn 7187: ###############################################
1.405 albertel 7188:
1.275 raeburn 7189: sub get_course_users {
1.630 raeburn 7190: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7191: my %idx = ();
1.419 raeburn 7192: my %seclists;
1.288 raeburn 7193:
7194: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7195: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7196: $idx{end} = &Apache::loncoursedata::CL_END();
7197: $idx{start} = &Apache::loncoursedata::CL_START();
7198: $idx{id} = &Apache::loncoursedata::CL_ID();
7199: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7200: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7201: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7202:
1.290 albertel 7203: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7204: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7205: my $now = time;
1.277 albertel 7206: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7207: my $match = 0;
1.412 raeburn 7208: my $secmatch = 0;
1.419 raeburn 7209: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7210: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7211: if ($section eq '') {
7212: $section = 'none';
7213: }
1.291 albertel 7214: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7215: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7216: $secmatch = 1;
7217: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7218: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7219: $secmatch = 1;
7220: }
7221: } else {
1.419 raeburn 7222: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7223: $secmatch = 1;
7224: }
1.290 albertel 7225: }
1.412 raeburn 7226: if (!$secmatch) {
7227: next;
7228: }
1.419 raeburn 7229: }
1.275 raeburn 7230: if (defined($$types{'active'})) {
1.288 raeburn 7231: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7232: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7233: $match = 1;
1.275 raeburn 7234: }
7235: }
7236: if (defined($$types{'previous'})) {
1.609 raeburn 7237: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7238: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7239: $match = 1;
1.275 raeburn 7240: }
7241: }
7242: if (defined($$types{'future'})) {
1.609 raeburn 7243: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7244: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7245: $match = 1;
1.275 raeburn 7246: }
7247: }
1.609 raeburn 7248: if ($match) {
7249: push(@{$seclists{$student}},$section);
7250: if (ref($userdata) eq 'HASH') {
7251: $$userdata{$student} = $$classlist{$student};
7252: }
7253: if (ref($statushash) eq 'HASH') {
7254: $statushash->{$student}{'st'}{$section} = $status;
7255: }
1.288 raeburn 7256: }
1.275 raeburn 7257: }
7258: }
1.412 raeburn 7259: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7260: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7261: my $now = time;
1.609 raeburn 7262: my %displaystatus = ( previous => 'Expired',
7263: active => 'Active',
7264: future => 'Future',
7265: );
1.630 raeburn 7266: my %nothide;
7267: if ($hidepriv) {
7268: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7269: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7270: if ($user !~ /:/) {
7271: $nothide{join(':',split(/[\@]/,$user))}=1;
7272: } else {
7273: $nothide{$user} = 1;
7274: }
7275: }
7276: }
1.439 raeburn 7277: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7278: my $match = 0;
1.412 raeburn 7279: my $secmatch = 0;
1.439 raeburn 7280: my $status;
1.412 raeburn 7281: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7282: $user =~ s/:$//;
1.439 raeburn 7283: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7284: if ($end == -1 || $start == -1) {
7285: next;
7286: }
7287: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7288: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7289: my ($uname,$udom) = split(/:/,$user);
7290: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7291: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7292: $secmatch = 1;
7293: } elsif ($usec eq '') {
1.420 albertel 7294: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7295: $secmatch = 1;
7296: }
7297: } else {
7298: if (grep(/^\Q$usec\E$/,@{$sections})) {
7299: $secmatch = 1;
7300: }
7301: }
7302: if (!$secmatch) {
7303: next;
7304: }
1.288 raeburn 7305: }
1.419 raeburn 7306: if ($usec eq '') {
7307: $usec = 'none';
7308: }
1.275 raeburn 7309: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7310: if ($hidepriv) {
7311: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7312: (!$nothide{$uname.':'.$udom})) {
7313: next;
7314: }
7315: }
1.503 raeburn 7316: if ($end > 0 && $end < $now) {
1.439 raeburn 7317: $status = 'previous';
7318: } elsif ($start > $now) {
7319: $status = 'future';
7320: } else {
7321: $status = 'active';
7322: }
1.277 albertel 7323: foreach my $type (keys(%{$types})) {
1.275 raeburn 7324: if ($status eq $type) {
1.420 albertel 7325: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7326: push(@{$$users{$role}{$user}},$type);
7327: }
1.288 raeburn 7328: $match = 1;
7329: }
7330: }
1.419 raeburn 7331: if (($match) && (ref($userdata) eq 'HASH')) {
7332: if (!exists($$userdata{$uname.':'.$udom})) {
7333: &get_user_info($udom,$uname,\%idx,$userdata);
7334: }
1.420 albertel 7335: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7336: push(@{$seclists{$uname.':'.$udom}},$usec);
7337: }
1.609 raeburn 7338: if (ref($statushash) eq 'HASH') {
7339: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7340: }
1.275 raeburn 7341: }
7342: }
7343: }
7344: }
1.290 albertel 7345: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7346: if ((defined($cdom)) && (defined($cnum))) {
7347: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7348: if ( defined($csettings{'internal.courseowner'}) ) {
7349: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7350: next if ($owner eq '');
7351: my ($ownername,$ownerdom);
7352: if ($owner =~ /^([^:]+):([^:]+)$/) {
7353: $ownername = $1;
7354: $ownerdom = $2;
7355: } else {
7356: $ownername = $owner;
7357: $ownerdom = $cdom;
7358: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7359: }
7360: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7361: if (defined($userdata) &&
1.609 raeburn 7362: !exists($$userdata{$owner})) {
7363: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7364: if (!grep(/^none$/,@{$seclists{$owner}})) {
7365: push(@{$seclists{$owner}},'none');
7366: }
7367: if (ref($statushash) eq 'HASH') {
7368: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7369: }
1.290 albertel 7370: }
1.279 raeburn 7371: }
7372: }
7373: }
1.419 raeburn 7374: foreach my $user (keys(%seclists)) {
7375: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7376: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7377: }
1.275 raeburn 7378: }
7379: return;
7380: }
7381:
1.288 raeburn 7382: sub get_user_info {
7383: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7384: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7385: &plainname($uname,$udom,'lastname');
1.291 albertel 7386: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7387: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7388: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7389: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7390: return;
7391: }
1.275 raeburn 7392:
1.472 raeburn 7393: ###############################################
7394:
7395: =pod
7396:
7397: =item * &get_user_quota()
7398:
7399: Retrieves quota assigned for storage of portfolio files for a user
7400:
7401: Incoming parameters:
7402: 1. user's username
7403: 2. user's domain
7404:
7405: Returns:
1.536 raeburn 7406: 1. Disk quota (in Mb) assigned to student.
7407: 2. (Optional) Type of setting: custom or default
7408: (individually assigned or default for user's
7409: institutional status).
7410: 3. (Optional) - User's institutional status (e.g., faculty, staff
7411: or student - types as defined in localenroll::inst_usertypes
7412: for user's domain, which determines default quota for user.
7413: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7414:
7415: If a value has been stored in the user's environment,
1.536 raeburn 7416: it will return that, otherwise it returns the maximal default
7417: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7418:
7419: =cut
7420:
7421: ###############################################
7422:
7423:
7424: sub get_user_quota {
7425: my ($uname,$udom) = @_;
1.536 raeburn 7426: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7427: if (!defined($udom)) {
7428: $udom = $env{'user.domain'};
7429: }
7430: if (!defined($uname)) {
7431: $uname = $env{'user.name'};
7432: }
7433: if (($udom eq '' || $uname eq '') ||
7434: ($udom eq 'public') && ($uname eq 'public')) {
7435: $quota = 0;
1.536 raeburn 7436: $quotatype = 'default';
7437: $defquota = 0;
1.472 raeburn 7438: } else {
1.536 raeburn 7439: my $inststatus;
1.472 raeburn 7440: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7441: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7442: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7443: } else {
1.536 raeburn 7444: my %userenv =
7445: &Apache::lonnet::get('environment',['portfolioquota',
7446: 'inststatus'],$udom,$uname);
1.472 raeburn 7447: my ($tmp) = keys(%userenv);
7448: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7449: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7450: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7451: } else {
7452: undef(%userenv);
7453: }
7454: }
1.536 raeburn 7455: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7456: if ($quota eq '') {
1.536 raeburn 7457: $quota = $defquota;
7458: $quotatype = 'default';
7459: } else {
7460: $quotatype = 'custom';
1.472 raeburn 7461: }
7462: }
1.536 raeburn 7463: if (wantarray) {
7464: return ($quota,$quotatype,$settingstatus,$defquota);
7465: } else {
7466: return $quota;
7467: }
1.472 raeburn 7468: }
7469:
7470: ###############################################
7471:
7472: =pod
7473:
7474: =item * &default_quota()
7475:
1.536 raeburn 7476: Retrieves default quota assigned for storage of user portfolio files,
7477: given an (optional) user's institutional status.
1.472 raeburn 7478:
7479: Incoming parameters:
7480: 1. domain
1.536 raeburn 7481: 2. (Optional) institutional status(es). This is a : separated list of
7482: status types (e.g., faculty, staff, student etc.)
7483: which apply to the user for whom the default is being retrieved.
7484: If the institutional status string in undefined, the domain
7485: default quota will be returned.
1.472 raeburn 7486:
7487: Returns:
7488: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7489: 2. (Optional) institutional type which determined the value of the
7490: default quota.
1.472 raeburn 7491:
7492: If a value has been stored in the domain's configuration db,
7493: it will return that, otherwise it returns 20 (for backwards
7494: compatibility with domains which have not set up a configuration
7495: db file; the original statically defined portfolio quota was 20 Mb).
7496:
1.536 raeburn 7497: If the user's status includes multiple types (e.g., staff and student),
7498: the largest default quota which applies to the user determines the
7499: default quota returned.
7500:
1.780 raeburn 7501: =back
7502:
1.472 raeburn 7503: =cut
7504:
7505: ###############################################
7506:
7507:
7508: sub default_quota {
1.536 raeburn 7509: my ($udom,$inststatus) = @_;
7510: my ($defquota,$settingstatus);
7511: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7512: ['quotas'],$udom);
7513: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7514: if ($inststatus ne '') {
1.765 raeburn 7515: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7516: foreach my $item (@statuses) {
1.711 raeburn 7517: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7518: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7519: if ($defquota eq '') {
7520: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7521: $settingstatus = $item;
7522: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7523: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7524: $settingstatus = $item;
7525: }
7526: }
7527: } else {
7528: if ($quotahash{'quotas'}{$item} ne '') {
7529: if ($defquota eq '') {
7530: $defquota = $quotahash{'quotas'}{$item};
7531: $settingstatus = $item;
7532: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7533: $defquota = $quotahash{'quotas'}{$item};
7534: $settingstatus = $item;
7535: }
1.536 raeburn 7536: }
7537: }
7538: }
7539: }
7540: if ($defquota eq '') {
1.711 raeburn 7541: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7542: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7543: } else {
7544: $defquota = $quotahash{'quotas'}{'default'};
7545: }
1.536 raeburn 7546: $settingstatus = 'default';
7547: }
7548: } else {
7549: $settingstatus = 'default';
7550: $defquota = 20;
7551: }
7552: if (wantarray) {
7553: return ($defquota,$settingstatus);
1.472 raeburn 7554: } else {
1.536 raeburn 7555: return $defquota;
1.472 raeburn 7556: }
7557: }
7558:
1.384 raeburn 7559: sub get_secgrprole_info {
7560: my ($cdom,$cnum,$needroles,$type) = @_;
7561: my %sections_count = &get_sections($cdom,$cnum);
7562: my @sections = (sort {$a <=> $b} keys(%sections_count));
7563: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7564: my @groups = sort(keys(%curr_groups));
7565: my $allroles = [];
7566: my $rolehash;
7567: my $accesshash = {
7568: active => 'Currently has access',
7569: future => 'Will have future access',
7570: previous => 'Previously had access',
7571: };
7572: if ($needroles) {
7573: $rolehash = {'all' => 'all'};
1.385 albertel 7574: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7575: if (&Apache::lonnet::error(%user_roles)) {
7576: undef(%user_roles);
7577: }
7578: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7579: my ($role)=split(/\:/,$item,2);
7580: if ($role eq 'cr') { next; }
7581: if ($role =~ /^cr/) {
7582: $$rolehash{$role} = (split('/',$role))[3];
7583: } else {
7584: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7585: }
7586: }
7587: foreach my $key (sort(keys(%{$rolehash}))) {
7588: push(@{$allroles},$key);
7589: }
7590: push (@{$allroles},'st');
7591: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7592: }
7593: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7594: }
7595:
1.555 raeburn 7596: sub user_picker {
1.627 raeburn 7597: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7598: my $currdom = $dom;
7599: my %curr_selected = (
7600: srchin => 'dom',
1.580 raeburn 7601: srchby => 'lastname',
1.555 raeburn 7602: );
7603: my $srchterm;
1.625 raeburn 7604: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7605: if ($srch->{'srchby'} ne '') {
7606: $curr_selected{'srchby'} = $srch->{'srchby'};
7607: }
7608: if ($srch->{'srchin'} ne '') {
7609: $curr_selected{'srchin'} = $srch->{'srchin'};
7610: }
7611: if ($srch->{'srchtype'} ne '') {
7612: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7613: }
7614: if ($srch->{'srchdomain'} ne '') {
7615: $currdom = $srch->{'srchdomain'};
7616: }
7617: $srchterm = $srch->{'srchterm'};
7618: }
7619: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7620: 'usr' => 'Search criteria',
1.563 raeburn 7621: 'doma' => 'Domain/institution to search',
1.558 albertel 7622: 'uname' => 'username',
7623: 'lastname' => 'last name',
1.555 raeburn 7624: 'lastfirst' => 'last name, first name',
1.558 albertel 7625: 'crs' => 'in this course',
1.576 raeburn 7626: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7627: 'alc' => 'all LON-CAPA',
1.573 raeburn 7628: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7629: 'exact' => 'is',
7630: 'contains' => 'contains',
1.569 raeburn 7631: 'begins' => 'begins with',
1.571 raeburn 7632: 'youm' => "You must include some text to search for.",
7633: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7634: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7635: 'yomc' => "You must choose a domain when using an institutional directory search.",
7636: 'ymcd' => "You must choose a domain when using a domain search.",
7637: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7638: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7639: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7640: );
1.563 raeburn 7641: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7642: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7643:
7644: my @srchins = ('crs','dom','alc','instd');
7645:
7646: foreach my $option (@srchins) {
7647: # FIXME 'alc' option unavailable until
7648: # loncreateuser::print_user_query_page()
7649: # has been completed.
7650: next if ($option eq 'alc');
1.880 raeburn 7651: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7652: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7653: if ($curr_selected{'srchin'} eq $option) {
7654: $srchinsel .= '
7655: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7656: } else {
7657: $srchinsel .= '
7658: <option value="'.$option.'">'.$lt{$option}.'</option>';
7659: }
1.555 raeburn 7660: }
1.563 raeburn 7661: $srchinsel .= "\n </select>\n";
1.555 raeburn 7662:
7663: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7664: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7665: if ($curr_selected{'srchby'} eq $option) {
7666: $srchbysel .= '
7667: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7668: } else {
7669: $srchbysel .= '
7670: <option value="'.$option.'">'.$lt{$option}.'</option>';
7671: }
7672: }
7673: $srchbysel .= "\n </select>\n";
7674:
7675: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7676: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7677: if ($curr_selected{'srchtype'} eq $option) {
7678: $srchtypesel .= '
7679: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7680: } else {
7681: $srchtypesel .= '
7682: <option value="'.$option.'">'.$lt{$option}.'</option>';
7683: }
7684: }
7685: $srchtypesel .= "\n </select>\n";
7686:
1.558 albertel 7687: my ($newuserscript,$new_user_create);
1.556 raeburn 7688:
7689: if ($forcenewuser) {
1.576 raeburn 7690: if (ref($srch) eq 'HASH') {
7691: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7692: if ($cancreate) {
7693: $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>';
7694: } else {
1.799 bisitz 7695: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7696: my %usertypetext = (
7697: official => 'institutional',
7698: unofficial => 'non-institutional',
7699: );
1.799 bisitz 7700: $new_user_create = '<p class="LC_warning">'
7701: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7702: .' '
7703: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7704: ,'<a href="'.$helplink.'">','</a>')
7705: .'</p><br />';
1.627 raeburn 7706: }
1.576 raeburn 7707: }
7708: }
7709:
1.556 raeburn 7710: $newuserscript = <<"ENDSCRIPT";
7711:
1.570 raeburn 7712: function setSearch(createnew,callingForm) {
1.556 raeburn 7713: if (createnew == 1) {
1.570 raeburn 7714: for (var i=0; i<callingForm.srchby.length; i++) {
7715: if (callingForm.srchby.options[i].value == 'uname') {
7716: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7717: }
7718: }
1.570 raeburn 7719: for (var i=0; i<callingForm.srchin.length; i++) {
7720: if ( callingForm.srchin.options[i].value == 'dom') {
7721: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7722: }
7723: }
1.570 raeburn 7724: for (var i=0; i<callingForm.srchtype.length; i++) {
7725: if (callingForm.srchtype.options[i].value == 'exact') {
7726: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7727: }
7728: }
1.570 raeburn 7729: for (var i=0; i<callingForm.srchdomain.length; i++) {
7730: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7731: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7732: }
7733: }
7734: }
7735: }
7736: ENDSCRIPT
1.558 albertel 7737:
1.556 raeburn 7738: }
7739:
1.555 raeburn 7740: my $output = <<"END_BLOCK";
1.556 raeburn 7741: <script type="text/javascript">
1.824 bisitz 7742: // <![CDATA[
1.570 raeburn 7743: function validateEntry(callingForm) {
1.558 albertel 7744:
1.556 raeburn 7745: var checkok = 1;
1.558 albertel 7746: var srchin;
1.570 raeburn 7747: for (var i=0; i<callingForm.srchin.length; i++) {
7748: if ( callingForm.srchin[i].checked ) {
7749: srchin = callingForm.srchin[i].value;
1.558 albertel 7750: }
7751: }
7752:
1.570 raeburn 7753: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7754: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7755: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7756: var srchterm = callingForm.srchterm.value;
7757: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7758: var msg = "";
7759:
7760: if (srchterm == "") {
7761: checkok = 0;
1.571 raeburn 7762: msg += "$lt{'youm'}\\n";
1.556 raeburn 7763: }
7764:
1.569 raeburn 7765: if (srchtype== 'begins') {
7766: if (srchterm.length < 2) {
7767: checkok = 0;
1.571 raeburn 7768: msg += "$lt{'thte'}\\n";
1.569 raeburn 7769: }
7770: }
7771:
1.556 raeburn 7772: if (srchtype== 'contains') {
7773: if (srchterm.length < 3) {
7774: checkok = 0;
1.571 raeburn 7775: msg += "$lt{'thet'}\\n";
1.556 raeburn 7776: }
7777: }
7778: if (srchin == 'instd') {
7779: if (srchdomain == '') {
7780: checkok = 0;
1.571 raeburn 7781: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7782: }
7783: }
7784: if (srchin == 'dom') {
7785: if (srchdomain == '') {
7786: checkok = 0;
1.571 raeburn 7787: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7788: }
7789: }
7790: if (srchby == 'lastfirst') {
7791: if (srchterm.indexOf(",") == -1) {
7792: checkok = 0;
1.571 raeburn 7793: msg += "$lt{'whus'}\\n";
1.556 raeburn 7794: }
7795: if (srchterm.indexOf(",") == srchterm.length -1) {
7796: checkok = 0;
1.571 raeburn 7797: msg += "$lt{'whse'}\\n";
1.556 raeburn 7798: }
7799: }
7800: if (checkok == 0) {
1.571 raeburn 7801: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7802: return;
7803: }
7804: if (checkok == 1) {
1.570 raeburn 7805: callingForm.submit();
1.556 raeburn 7806: }
7807: }
7808:
7809: $newuserscript
7810:
1.824 bisitz 7811: // ]]>
1.556 raeburn 7812: </script>
1.558 albertel 7813:
7814: $new_user_create
7815:
1.555 raeburn 7816: END_BLOCK
1.558 albertel 7817:
1.876 raeburn 7818: $output .= &Apache::lonhtmlcommon::start_pick_box().
7819: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7820: $domform.
7821: &Apache::lonhtmlcommon::row_closure().
7822: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7823: $srchbysel.
7824: $srchtypesel.
7825: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7826: $srchinsel.
7827: &Apache::lonhtmlcommon::row_closure(1).
7828: &Apache::lonhtmlcommon::end_pick_box().
7829: '<br />';
1.555 raeburn 7830: return $output;
7831: }
7832:
1.612 raeburn 7833: sub user_rule_check {
1.615 raeburn 7834: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7835: my $response;
7836: if (ref($usershash) eq 'HASH') {
7837: foreach my $user (keys(%{$usershash})) {
7838: my ($uname,$udom) = split(/:/,$user);
7839: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7840: my ($id,$newuser);
1.612 raeburn 7841: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7842: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7843: $id = $usershash->{$user}->{'id'};
7844: }
7845: my $inst_response;
7846: if (ref($checks) eq 'HASH') {
7847: if (defined($checks->{'username'})) {
1.615 raeburn 7848: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7849: &Apache::lonnet::get_instuser($udom,$uname);
7850: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7851: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7852: &Apache::lonnet::get_instuser($udom,undef,$id);
7853: }
1.615 raeburn 7854: } else {
7855: ($inst_response,%{$inst_results->{$user}}) =
7856: &Apache::lonnet::get_instuser($udom,$uname);
7857: return;
1.612 raeburn 7858: }
1.615 raeburn 7859: if (!$got_rules->{$udom}) {
1.612 raeburn 7860: my %domconfig = &Apache::lonnet::get_dom('configuration',
7861: ['usercreation'],$udom);
7862: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7863: foreach my $item ('username','id') {
1.612 raeburn 7864: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7865: $$curr_rules{$udom}{$item} =
7866: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7867: }
7868: }
7869: }
1.615 raeburn 7870: $got_rules->{$udom} = 1;
1.585 raeburn 7871: }
1.612 raeburn 7872: foreach my $item (keys(%{$checks})) {
7873: if (ref($$curr_rules{$udom}) eq 'HASH') {
7874: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7875: if (@{$$curr_rules{$udom}{$item}} > 0) {
7876: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7877: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7878: if ($rule_check{$rule}) {
7879: $$rulematch{$user}{$item} = $rule;
7880: if ($inst_response eq 'ok') {
1.615 raeburn 7881: if (ref($inst_results) eq 'HASH') {
7882: if (ref($inst_results->{$user}) eq 'HASH') {
7883: if (keys(%{$inst_results->{$user}}) == 0) {
7884: $$alerts{$item}{$udom}{$uname} = 1;
7885: }
1.612 raeburn 7886: }
7887: }
1.615 raeburn 7888: }
7889: last;
1.585 raeburn 7890: }
7891: }
7892: }
7893: }
7894: }
7895: }
7896: }
7897: }
1.612 raeburn 7898: return;
7899: }
7900:
7901: sub user_rule_formats {
7902: my ($domain,$domdesc,$curr_rules,$check) = @_;
7903: my %text = (
7904: 'username' => 'Usernames',
7905: 'id' => 'IDs',
7906: );
7907: my $output;
7908: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7909: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7910: if (@{$ruleorder} > 0) {
7911: $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>';
7912: foreach my $rule (@{$ruleorder}) {
7913: if (ref($curr_rules) eq 'ARRAY') {
7914: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7915: if (ref($rules->{$rule}) eq 'HASH') {
7916: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7917: $rules->{$rule}{'desc'}.'</li>';
7918: }
7919: }
7920: }
7921: }
7922: $output .= '</ul>';
7923: }
7924: }
7925: return $output;
7926: }
7927:
7928: sub instrule_disallow_msg {
1.615 raeburn 7929: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7930: my $response;
7931: my %text = (
7932: item => 'username',
7933: items => 'usernames',
7934: match => 'matches',
7935: do => 'does',
7936: action => 'a username',
7937: one => 'one',
7938: );
7939: if ($count > 1) {
7940: $text{'item'} = 'usernames';
7941: $text{'match'} ='match';
7942: $text{'do'} = 'do';
7943: $text{'action'} = 'usernames',
7944: $text{'one'} = 'ones';
7945: }
7946: if ($checkitem eq 'id') {
7947: $text{'items'} = 'IDs';
7948: $text{'item'} = 'ID';
7949: $text{'action'} = 'an ID';
1.615 raeburn 7950: if ($count > 1) {
7951: $text{'item'} = 'IDs';
7952: $text{'action'} = 'IDs';
7953: }
1.612 raeburn 7954: }
1.674 bisitz 7955: $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 7956: if ($mode eq 'upload') {
7957: if ($checkitem eq 'username') {
7958: $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'}.");
7959: } elsif ($checkitem eq 'id') {
1.674 bisitz 7960: $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 7961: }
1.669 raeburn 7962: } elsif ($mode eq 'selfcreate') {
7963: if ($checkitem eq 'id') {
7964: $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.");
7965: }
1.615 raeburn 7966: } else {
7967: if ($checkitem eq 'username') {
7968: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7969: } elsif ($checkitem eq 'id') {
7970: $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.");
7971: }
1.612 raeburn 7972: }
7973: return $response;
1.585 raeburn 7974: }
7975:
1.624 raeburn 7976: sub personal_data_fieldtitles {
7977: my %fieldtitles = &Apache::lonlocal::texthash (
7978: id => 'Student/Employee ID',
7979: permanentemail => 'E-mail address',
7980: lastname => 'Last Name',
7981: firstname => 'First Name',
7982: middlename => 'Middle Name',
7983: generation => 'Generation',
7984: gen => 'Generation',
1.765 raeburn 7985: inststatus => 'Affiliation',
1.624 raeburn 7986: );
7987: return %fieldtitles;
7988: }
7989:
1.642 raeburn 7990: sub sorted_inst_types {
7991: my ($dom) = @_;
7992: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7993: my $othertitle = &mt('All users');
7994: if ($env{'request.course.id'}) {
1.668 raeburn 7995: $othertitle = &mt('Any users');
1.642 raeburn 7996: }
7997: my @types;
7998: if (ref($order) eq 'ARRAY') {
7999: @types = @{$order};
8000: }
8001: if (@types == 0) {
8002: if (ref($usertypes) eq 'HASH') {
8003: @types = sort(keys(%{$usertypes}));
8004: }
8005: }
8006: if (keys(%{$usertypes}) > 0) {
8007: $othertitle = &mt('Other users');
8008: }
8009: return ($othertitle,$usertypes,\@types);
8010: }
8011:
1.645 raeburn 8012: sub get_institutional_codes {
8013: my ($settings,$allcourses,$LC_code) = @_;
8014: # Get complete list of course sections to update
8015: my @currsections = ();
8016: my @currxlists = ();
8017: my $coursecode = $$settings{'internal.coursecode'};
8018:
8019: if ($$settings{'internal.sectionnums'} ne '') {
8020: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8021: }
8022:
8023: if ($$settings{'internal.crosslistings'} ne '') {
8024: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8025: }
8026:
8027: if (@currxlists > 0) {
8028: foreach (@currxlists) {
8029: if (m/^([^:]+):(\w*)$/) {
8030: unless (grep/^$1$/,@{$allcourses}) {
8031: push @{$allcourses},$1;
8032: $$LC_code{$1} = $2;
8033: }
8034: }
8035: }
8036: }
8037:
8038: if (@currsections > 0) {
8039: foreach (@currsections) {
8040: if (m/^(\w+):(\w*)$/) {
8041: my $sec = $coursecode.$1;
8042: my $lc_sec = $2;
8043: unless (grep/^$sec$/,@{$allcourses}) {
8044: push @{$allcourses},$sec;
8045: $$LC_code{$sec} = $lc_sec;
8046: }
8047: }
8048: }
8049: }
8050: return;
8051: }
8052:
1.112 bowersj2 8053: =pod
8054:
1.780 raeburn 8055: =head1 Slot Helpers
8056:
8057: =over 4
8058:
8059: =item * sorted_slots()
8060:
8061: Sorts an array of slot names in order of slot start time (earliest first).
8062:
8063: Inputs:
8064:
8065: =over 4
8066:
8067: slotsarr - Reference to array of unsorted slot names.
8068:
8069: slots - Reference to hash of hash, where outer hash keys are slot names.
8070:
1.549 albertel 8071: =back
8072:
1.780 raeburn 8073: Returns:
8074:
8075: =over 4
8076:
8077: sorted - An array of slot names sorted by the start time of the slot.
8078:
8079: =back
8080:
8081: =back
8082:
8083: =cut
8084:
8085:
8086: sub sorted_slots {
8087: my ($slotsarr,$slots) = @_;
8088: my @sorted;
8089: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8090: @sorted =
8091: sort {
8092: if (ref($slots->{$a}) && ref($slots->{$b})) {
8093: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8094: }
8095: if (ref($slots->{$a})) { return -1;}
8096: if (ref($slots->{$b})) { return 1;}
8097: return 0;
8098: } @{$slotsarr};
8099: }
8100: return @sorted;
8101: }
8102:
8103:
8104: =pod
8105:
1.549 albertel 8106: =head1 HTTP Helpers
8107:
8108: =over 4
8109:
1.648 raeburn 8110: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8111:
1.258 albertel 8112: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8113: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8114: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8115:
8116: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8117: $possible_names is an ref to an array of form element names. As an example:
8118: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8119: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8120:
8121: =cut
1.1 albertel 8122:
1.6 albertel 8123: sub get_unprocessed_cgi {
1.25 albertel 8124: my ($query,$possible_names)= @_;
1.26 matthew 8125: # $Apache::lonxml::debug=1;
1.356 albertel 8126: foreach my $pair (split(/&/,$query)) {
8127: my ($name, $value) = split(/=/,$pair);
1.369 www 8128: $name = &unescape($name);
1.25 albertel 8129: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8130: $value =~ tr/+/ /;
8131: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8132: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8133: }
1.16 harris41 8134: }
1.6 albertel 8135: }
8136:
1.112 bowersj2 8137: =pod
8138:
1.648 raeburn 8139: =item * &cacheheader()
1.112 bowersj2 8140:
8141: returns cache-controlling header code
8142:
8143: =cut
8144:
1.7 albertel 8145: sub cacheheader {
1.258 albertel 8146: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8147: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8148: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8149: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8150: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8151: return $output;
1.7 albertel 8152: }
8153:
1.112 bowersj2 8154: =pod
8155:
1.648 raeburn 8156: =item * &no_cache($r)
1.112 bowersj2 8157:
8158: specifies header code to not have cache
8159:
8160: =cut
8161:
1.9 albertel 8162: sub no_cache {
1.216 albertel 8163: my ($r) = @_;
8164: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8165: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8166: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8167: $r->no_cache(1);
8168: $r->header_out("Expires" => $date);
8169: $r->header_out("Pragma" => "no-cache");
1.123 www 8170: }
8171:
8172: sub content_type {
1.181 albertel 8173: my ($r,$type,$charset) = @_;
1.299 foxr 8174: if ($r) {
8175: # Note that printout.pl calls this with undef for $r.
8176: &no_cache($r);
8177: }
1.258 albertel 8178: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8179: unless ($charset) {
8180: $charset=&Apache::lonlocal::current_encoding;
8181: }
8182: if ($charset) { $type.='; charset='.$charset; }
8183: if ($r) {
8184: $r->content_type($type);
8185: } else {
8186: print("Content-type: $type\n\n");
8187: }
1.9 albertel 8188: }
1.25 albertel 8189:
1.112 bowersj2 8190: =pod
8191:
1.648 raeburn 8192: =item * &add_to_env($name,$value)
1.112 bowersj2 8193:
1.258 albertel 8194: adds $name to the %env hash with value
1.112 bowersj2 8195: $value, if $name already exists, the entry is converted to an array
8196: reference and $value is added to the array.
8197:
8198: =cut
8199:
1.25 albertel 8200: sub add_to_env {
8201: my ($name,$value)=@_;
1.258 albertel 8202: if (defined($env{$name})) {
8203: if (ref($env{$name})) {
1.25 albertel 8204: #already have multiple values
1.258 albertel 8205: push(@{ $env{$name} },$value);
1.25 albertel 8206: } else {
8207: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8208: my $first=$env{$name};
8209: undef($env{$name});
8210: push(@{ $env{$name} },$first,$value);
1.25 albertel 8211: }
8212: } else {
1.258 albertel 8213: $env{$name}=$value;
1.25 albertel 8214: }
1.31 albertel 8215: }
1.149 albertel 8216:
8217: =pod
8218:
1.648 raeburn 8219: =item * &get_env_multiple($name)
1.149 albertel 8220:
1.258 albertel 8221: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8222: values may be defined and end up as an array ref.
8223:
8224: returns an array of values
8225:
8226: =cut
8227:
8228: sub get_env_multiple {
8229: my ($name) = @_;
8230: my @values;
1.258 albertel 8231: if (defined($env{$name})) {
1.149 albertel 8232: # exists is it an array
1.258 albertel 8233: if (ref($env{$name})) {
8234: @values=@{ $env{$name} };
1.149 albertel 8235: } else {
1.258 albertel 8236: $values[0]=$env{$name};
1.149 albertel 8237: }
8238: }
8239: return(@values);
8240: }
8241:
1.660 raeburn 8242: sub ask_for_embedded_content {
8243: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8244: my $upload_output = '
8245: <form name="upload_embedded" action="'.$actionurl.'"
8246: method="post" enctype="multipart/form-data">';
8247: $upload_output .= $state;
1.661 raeburn 8248: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8249:
8250: my $num = 0;
8251: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8252: $upload_output .= &start_data_table_row().
8253: '<td>'.$embed_file.'</td><td>';
8254: if ($args->{'ignore_remote_references'}
8255: && $embed_file =~ m{^\w+://}) {
8256: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8257: } elsif ($args->{'error_on_invalid_names'}
8258: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8259:
8260: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8261:
8262: } else {
8263: $upload_output .='
1.661 raeburn 8264: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8265: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8266: my $attrib = join(':',@{$$allfiles{$embed_file}});
8267: $upload_output .=
8268: "\n\t\t".
8269: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8270: $attrib.'" />';
8271: if (exists($$codebase{$embed_file})) {
8272: $upload_output .=
8273: "\n\t\t".
8274: '<input name="codebase_'.$num.'" type="hidden" value="'.
8275: &escape($$codebase{$embed_file}).'" />';
8276: }
8277: }
8278: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8279: $num++;
8280: }
8281: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8282: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8283: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8284: '.&mt('(only files for which a location has been provided will be uploaded)').'
8285: </form>';
8286: return $upload_output;
8287: }
8288:
1.661 raeburn 8289: sub upload_embedded {
8290: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8291: $current_disk_usage) = @_;
8292: my $output;
8293: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8294: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8295: my $orig_uploaded_filename =
8296: $env{'form.embedded_item_'.$i.'.filename'};
8297:
8298: $env{'form.embedded_orig_'.$i} =
8299: &unescape($env{'form.embedded_orig_'.$i});
8300: my ($path,$fname) =
8301: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8302: # no path, whole string is fname
8303: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8304:
8305: $path = $env{'form.currentpath'}.$path;
8306: $fname = &Apache::lonnet::clean_filename($fname);
8307: # See if there is anything left
8308: next if ($fname eq '');
8309:
8310: # Check if file already exists as a file or directory.
8311: my ($state,$msg);
8312: if ($context eq 'portfolio') {
8313: my $port_path = $dirpath;
8314: if ($group ne '') {
8315: $port_path = "groups/$group/$port_path";
8316: }
8317: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8318: $dir_root,$port_path,$disk_quota,
8319: $current_disk_usage,$uname,$udom);
8320: if ($state eq 'will_exceed_quota'
8321: || $state eq 'file_locked'
8322: || $state eq 'file_exists' ) {
8323: $output .= $msg;
8324: next;
8325: }
8326: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8327: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8328: if ($state eq 'exists') {
8329: $output .= $msg;
8330: next;
8331: }
8332: }
8333: # Check if extension is valid
8334: if (($fname =~ /\.(\w+)$/) &&
8335: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8336: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8337: next;
8338: } elsif (($fname =~ /\.(\w+)$/) &&
8339: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8340: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8341: next;
8342: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8343: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8344: next;
8345: }
8346:
8347: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8348: if ($context eq 'portfolio') {
8349: my $result=
8350: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8351: $dirpath.$path);
8352: if ($result !~ m|^/uploaded/|) {
8353: $output .= '<span class="LC_error">'
8354: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8355: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8356: .'</span><br />';
8357: next;
8358: } else {
8359: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8360: $path.$fname.'</span>').'</p>';
8361: }
8362: } else {
8363: # Save the file
8364: my $target = $env{'form.embedded_item_'.$i};
8365: my $fullpath = $dir_root.$dirpath.'/'.$path;
8366: my $dest = $fullpath.$fname;
8367: my $url = $url_root.$dirpath.'/'.$path.$fname;
8368: my @parts=split(/\//,$fullpath);
8369: my $count;
8370: my $filepath = $dir_root;
8371: for ($count=4;$count<=$#parts;$count++) {
8372: $filepath .= "/$parts[$count]";
8373: if ((-e $filepath)!=1) {
8374: mkdir($filepath,0770);
8375: }
8376: }
8377: my $fh;
8378: if (!open($fh,'>'.$dest)) {
8379: &Apache::lonnet::logthis('Failed to create '.$dest);
8380: $output .= '<span class="LC_error">'.
8381: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8382: '</span><br />';
8383: } else {
8384: if (!print $fh $env{'form.embedded_item_'.$i}) {
8385: &Apache::lonnet::logthis('Failed to write to '.$dest);
8386: $output .= '<span class="LC_error">'.
8387: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8388: '</span><br />';
8389: } else {
8390: if ($context eq 'testbank') {
8391: $output .= &mt('Embedded file uploaded successfully:').
8392: ' <a href="'.$url.'">'.
8393: $orig_uploaded_filename.'</a><br />';
8394: } else {
1.705 tempelho 8395: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8396: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8397: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8398: }
8399: }
8400: close($fh);
8401: }
8402: }
8403: }
8404: return $output;
8405: }
8406:
8407: sub check_for_existing {
8408: my ($path,$fname,$element) = @_;
8409: my ($state,$msg);
8410: if (-d $path.'/'.$fname) {
8411: $state = 'exists';
8412: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8413: } elsif (-e $path.'/'.$fname) {
8414: $state = 'exists';
8415: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8416: }
8417: if ($state eq 'exists') {
8418: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8419: }
8420: return ($state,$msg);
8421: }
8422:
8423: sub check_for_upload {
8424: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8425: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8426: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8427: my $getpropath = 1;
8428: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8429: $getpropath);
8430: my $found_file = 0;
8431: my $locked_file = 0;
8432: foreach my $line (@dir_list) {
8433: my ($file_name)=split(/\&/,$line,2);
8434: if ($file_name eq $fname){
8435: $file_name = $path.$file_name;
8436: if ($group ne '') {
8437: $file_name = $group.$file_name;
8438: }
8439: $found_file = 1;
8440: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8441: $locked_file = 1;
8442: }
8443: }
8444: }
8445: if (($current_disk_usage + $filesize) > $disk_quota){
8446: my $msg = '<span class="LC_error">'.
8447: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8448: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8449: return ('will_exceed_quota',$msg);
8450: } elsif ($found_file) {
8451: if ($locked_file) {
8452: my $msg = '<span class="LC_error">';
8453: $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>');
8454: $msg .= '</span><br />';
8455: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8456: return ('file_locked',$msg);
8457: } else {
8458: my $msg = '<span class="LC_error">';
8459: $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'});
8460: $msg .= '</span>';
8461: $msg .= '<br />';
8462: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8463: return ('file_exists',$msg);
8464: }
8465: }
8466: }
8467:
1.31 albertel 8468:
1.41 ng 8469: =pod
1.45 matthew 8470:
1.464 albertel 8471: =back
1.41 ng 8472:
1.112 bowersj2 8473: =head1 CSV Upload/Handling functions
1.38 albertel 8474:
1.41 ng 8475: =over 4
8476:
1.648 raeburn 8477: =item * &upfile_store($r)
1.41 ng 8478:
8479: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8480: needs $env{'form.upfile'}
1.41 ng 8481: returns $datatoken to be put into hidden field
8482:
8483: =cut
1.31 albertel 8484:
8485: sub upfile_store {
8486: my $r=shift;
1.258 albertel 8487: $env{'form.upfile'}=~s/\r/\n/gs;
8488: $env{'form.upfile'}=~s/\f/\n/gs;
8489: $env{'form.upfile'}=~s/\n+/\n/gs;
8490: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8491:
1.258 albertel 8492: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8493: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8494: {
1.158 raeburn 8495: my $datafile = $r->dir_config('lonDaemons').
8496: '/tmp/'.$datatoken.'.tmp';
8497: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8498: print $fh $env{'form.upfile'};
1.158 raeburn 8499: close($fh);
8500: }
1.31 albertel 8501: }
8502: return $datatoken;
8503: }
8504:
1.56 matthew 8505: =pod
8506:
1.648 raeburn 8507: =item * &load_tmp_file($r)
1.41 ng 8508:
8509: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8510: needs $env{'form.datatoken'},
8511: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8512:
8513: =cut
1.31 albertel 8514:
8515: sub load_tmp_file {
8516: my $r=shift;
8517: my @studentdata=();
8518: {
1.158 raeburn 8519: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8520: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8521: if ( open(my $fh,"<$studentfile") ) {
8522: @studentdata=<$fh>;
8523: close($fh);
8524: }
1.31 albertel 8525: }
1.258 albertel 8526: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8527: }
8528:
1.56 matthew 8529: =pod
8530:
1.648 raeburn 8531: =item * &upfile_record_sep()
1.41 ng 8532:
8533: Separate uploaded file into records
8534: returns array of records,
1.258 albertel 8535: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8536:
8537: =cut
1.31 albertel 8538:
8539: sub upfile_record_sep {
1.258 albertel 8540: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8541: } else {
1.248 albertel 8542: my @records;
1.258 albertel 8543: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8544: if ($line=~/^\s*$/) { next; }
8545: push(@records,$line);
8546: }
8547: return @records;
1.31 albertel 8548: }
8549: }
8550:
1.56 matthew 8551: =pod
8552:
1.648 raeburn 8553: =item * &record_sep($record)
1.41 ng 8554:
1.258 albertel 8555: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8556:
8557: =cut
8558:
1.263 www 8559: sub takeleft {
8560: my $index=shift;
8561: return substr('0000'.$index,-4,4);
8562: }
8563:
1.31 albertel 8564: sub record_sep {
8565: my $record=shift;
8566: my %components=();
1.258 albertel 8567: if ($env{'form.upfiletype'} eq 'xml') {
8568: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8569: my $i=0;
1.356 albertel 8570: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8571: $field=~s/^(\"|\')//;
8572: $field=~s/(\"|\')$//;
1.263 www 8573: $components{&takeleft($i)}=$field;
1.31 albertel 8574: $i++;
8575: }
1.258 albertel 8576: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8577: my $i=0;
1.356 albertel 8578: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8579: $field=~s/^(\"|\')//;
8580: $field=~s/(\"|\')$//;
1.263 www 8581: $components{&takeleft($i)}=$field;
1.31 albertel 8582: $i++;
8583: }
8584: } else {
1.561 www 8585: my $separator=',';
1.480 banghart 8586: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8587: $separator=';';
1.480 banghart 8588: }
1.31 albertel 8589: my $i=0;
1.561 www 8590: # the character we are looking for to indicate the end of a quote or a record
8591: my $looking_for=$separator;
8592: # do not add the characters to the fields
8593: my $ignore=0;
8594: # we just encountered a separator (or the beginning of the record)
8595: my $just_found_separator=1;
8596: # store the field we are working on here
8597: my $field='';
8598: # work our way through all characters in record
8599: foreach my $character ($record=~/(.)/g) {
8600: if ($character eq $looking_for) {
8601: if ($character ne $separator) {
8602: # Found the end of a quote, again looking for separator
8603: $looking_for=$separator;
8604: $ignore=1;
8605: } else {
8606: # Found a separator, store away what we got
8607: $components{&takeleft($i)}=$field;
8608: $i++;
8609: $just_found_separator=1;
8610: $ignore=0;
8611: $field='';
8612: }
8613: next;
8614: }
8615: # single or double quotation marks after a separator indicate beginning of a quote
8616: # we are now looking for the end of the quote and need to ignore separators
8617: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8618: $looking_for=$character;
8619: next;
8620: }
8621: # ignore would be true after we reached the end of a quote
8622: if ($ignore) { next; }
8623: if (($just_found_separator) && ($character=~/\s/)) { next; }
8624: $field.=$character;
8625: $just_found_separator=0;
1.31 albertel 8626: }
1.561 www 8627: # catch the very last entry, since we never encountered the separator
8628: $components{&takeleft($i)}=$field;
1.31 albertel 8629: }
8630: return %components;
8631: }
8632:
1.144 matthew 8633: ######################################################
8634: ######################################################
8635:
1.56 matthew 8636: =pod
8637:
1.648 raeburn 8638: =item * &upfile_select_html()
1.41 ng 8639:
1.144 matthew 8640: Return HTML code to select a file from the users machine and specify
8641: the file type.
1.41 ng 8642:
8643: =cut
8644:
1.144 matthew 8645: ######################################################
8646: ######################################################
1.31 albertel 8647: sub upfile_select_html {
1.144 matthew 8648: my %Types = (
8649: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8650: semisv => &mt('Semicolon separated values'),
1.144 matthew 8651: space => &mt('Space separated'),
8652: tab => &mt('Tabulator separated'),
8653: # xml => &mt('HTML/XML'),
8654: );
8655: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8656: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8657: foreach my $type (sort(keys(%Types))) {
8658: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8659: }
8660: $Str .= "</select>\n";
8661: return $Str;
1.31 albertel 8662: }
8663:
1.301 albertel 8664: sub get_samples {
8665: my ($records,$toget) = @_;
8666: my @samples=({});
8667: my $got=0;
8668: foreach my $rec (@$records) {
8669: my %temp = &record_sep($rec);
8670: if (! grep(/\S/, values(%temp))) { next; }
8671: if (%temp) {
8672: $samples[$got]=\%temp;
8673: $got++;
8674: if ($got == $toget) { last; }
8675: }
8676: }
8677: return \@samples;
8678: }
8679:
1.144 matthew 8680: ######################################################
8681: ######################################################
8682:
1.56 matthew 8683: =pod
8684:
1.648 raeburn 8685: =item * &csv_print_samples($r,$records)
1.41 ng 8686:
8687: Prints a table of sample values from each column uploaded $r is an
8688: Apache Request ref, $records is an arrayref from
8689: &Apache::loncommon::upfile_record_sep
8690:
8691: =cut
8692:
1.144 matthew 8693: ######################################################
8694: ######################################################
1.31 albertel 8695: sub csv_print_samples {
8696: my ($r,$records) = @_;
1.662 bisitz 8697: my $samples = &get_samples($records,5);
1.301 albertel 8698:
1.594 raeburn 8699: $r->print(&mt('Samples').'<br />'.&start_data_table().
8700: &start_data_table_header_row());
1.356 albertel 8701: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8702: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8703: $r->print(&end_data_table_header_row());
1.301 albertel 8704: foreach my $hash (@$samples) {
1.594 raeburn 8705: $r->print(&start_data_table_row());
1.356 albertel 8706: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8707: $r->print('<td>');
1.356 albertel 8708: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8709: $r->print('</td>');
8710: }
1.594 raeburn 8711: $r->print(&end_data_table_row());
1.31 albertel 8712: }
1.594 raeburn 8713: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8714: }
8715:
1.144 matthew 8716: ######################################################
8717: ######################################################
8718:
1.56 matthew 8719: =pod
8720:
1.648 raeburn 8721: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8722:
8723: Prints a table to create associations between values and table columns.
1.144 matthew 8724:
1.41 ng 8725: $r is an Apache Request ref,
8726: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8727: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8728:
8729: =cut
8730:
1.144 matthew 8731: ######################################################
8732: ######################################################
1.31 albertel 8733: sub csv_print_select_table {
8734: my ($r,$records,$d) = @_;
1.301 albertel 8735: my $i=0;
8736: my $samples = &get_samples($records,1);
1.144 matthew 8737: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8738: &start_data_table().&start_data_table_header_row().
1.144 matthew 8739: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8740: '<th>'.&mt('Column').'</th>'.
8741: &end_data_table_header_row()."\n");
1.356 albertel 8742: foreach my $array_ref (@$d) {
8743: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8744: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8745:
1.875 bisitz 8746: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8747: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8748: $r->print('<option value="none"></option>');
1.356 albertel 8749: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8750: $r->print('<option value="'.$sample.'"'.
8751: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8752: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8753: }
1.594 raeburn 8754: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8755: $i++;
8756: }
1.594 raeburn 8757: $r->print(&end_data_table());
1.31 albertel 8758: $i--;
8759: return $i;
8760: }
1.56 matthew 8761:
1.144 matthew 8762: ######################################################
8763: ######################################################
8764:
1.56 matthew 8765: =pod
1.31 albertel 8766:
1.648 raeburn 8767: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8768:
8769: Prints a table of sample values from the upload and can make associate samples to internal names.
8770:
8771: $r is an Apache Request ref,
8772: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8773: $d is an array of 2 element arrays (internal name, displayed name)
8774:
8775: =cut
8776:
1.144 matthew 8777: ######################################################
8778: ######################################################
1.31 albertel 8779: sub csv_samples_select_table {
8780: my ($r,$records,$d) = @_;
8781: my $i=0;
1.144 matthew 8782: #
1.662 bisitz 8783: my $max_samples = 5;
8784: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8785: $r->print(&start_data_table().
8786: &start_data_table_header_row().'<th>'.
8787: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8788: &end_data_table_header_row());
1.301 albertel 8789:
8790: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8791: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8792: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8793: foreach my $option (@$d) {
8794: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8795: $r->print('<option value="'.$value.'"'.
1.253 albertel 8796: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8797: $display.'</option>');
1.31 albertel 8798: }
8799: $r->print('</select></td><td>');
1.662 bisitz 8800: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8801: if (defined($samples->[$line]{$key})) {
8802: $r->print($samples->[$line]{$key}."<br />\n");
8803: }
8804: }
1.594 raeburn 8805: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8806: $i++;
8807: }
1.594 raeburn 8808: $r->print(&end_data_table());
1.31 albertel 8809: $i--;
8810: return($i);
1.115 matthew 8811: }
8812:
1.144 matthew 8813: ######################################################
8814: ######################################################
8815:
1.115 matthew 8816: =pod
8817:
1.648 raeburn 8818: =item * &clean_excel_name($name)
1.115 matthew 8819:
8820: Returns a replacement for $name which does not contain any illegal characters.
8821:
8822: =cut
8823:
1.144 matthew 8824: ######################################################
8825: ######################################################
1.115 matthew 8826: sub clean_excel_name {
8827: my ($name) = @_;
8828: $name =~ s/[:\*\?\/\\]//g;
8829: if (length($name) > 31) {
8830: $name = substr($name,0,31);
8831: }
8832: return $name;
1.25 albertel 8833: }
1.84 albertel 8834:
1.85 albertel 8835: =pod
8836:
1.648 raeburn 8837: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8838:
8839: Returns either 1 or undef
8840:
8841: 1 if the part is to be hidden, undef if it is to be shown
8842:
8843: Arguments are:
8844:
8845: $id the id of the part to be checked
8846: $symb, optional the symb of the resource to check
8847: $udom, optional the domain of the user to check for
8848: $uname, optional the username of the user to check for
8849:
8850: =cut
1.84 albertel 8851:
8852: sub check_if_partid_hidden {
8853: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8854: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8855: $symb,$udom,$uname);
1.141 albertel 8856: my $truth=1;
8857: #if the string starts with !, then the list is the list to show not hide
8858: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8859: my @hiddenlist=split(/,/,$hiddenparts);
8860: foreach my $checkid (@hiddenlist) {
1.141 albertel 8861: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8862: }
1.141 albertel 8863: return !$truth;
1.84 albertel 8864: }
1.127 matthew 8865:
1.138 matthew 8866:
8867: ############################################################
8868: ############################################################
8869:
8870: =pod
8871:
1.157 matthew 8872: =back
8873:
1.138 matthew 8874: =head1 cgi-bin script and graphing routines
8875:
1.157 matthew 8876: =over 4
8877:
1.648 raeburn 8878: =item * &get_cgi_id()
1.138 matthew 8879:
8880: Inputs: none
8881:
8882: Returns an id which can be used to pass environment variables
8883: to various cgi-bin scripts. These environment variables will
8884: be removed from the users environment after a given time by
8885: the routine &Apache::lonnet::transfer_profile_to_env.
8886:
8887: =cut
8888:
8889: ############################################################
8890: ############################################################
1.152 albertel 8891: my $uniq=0;
1.136 matthew 8892: sub get_cgi_id {
1.154 albertel 8893: $uniq=($uniq+1)%100000;
1.280 albertel 8894: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8895: }
8896:
1.127 matthew 8897: ############################################################
8898: ############################################################
8899:
8900: =pod
8901:
1.648 raeburn 8902: =item * &DrawBarGraph()
1.127 matthew 8903:
1.138 matthew 8904: Facilitates the plotting of data in a (stacked) bar graph.
8905: Puts plot definition data into the users environment in order for
8906: graph.png to plot it. Returns an <img> tag for the plot.
8907: The bars on the plot are labeled '1','2',...,'n'.
8908:
8909: Inputs:
8910:
8911: =over 4
8912:
8913: =item $Title: string, the title of the plot
8914:
8915: =item $xlabel: string, text describing the X-axis of the plot
8916:
8917: =item $ylabel: string, text describing the Y-axis of the plot
8918:
8919: =item $Max: scalar, the maximum Y value to use in the plot
8920: If $Max is < any data point, the graph will not be rendered.
8921:
1.140 matthew 8922: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8923: they are plotted. If undefined, default values will be used.
8924:
1.178 matthew 8925: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8926:
1.138 matthew 8927: =item @Values: An array of array references. Each array reference holds data
8928: to be plotted in a stacked bar chart.
8929:
1.239 matthew 8930: =item If the final element of @Values is a hash reference the key/value
8931: pairs will be added to the graph definition.
8932:
1.138 matthew 8933: =back
8934:
8935: Returns:
8936:
8937: An <img> tag which references graph.png and the appropriate identifying
8938: information for the plot.
8939:
1.127 matthew 8940: =cut
8941:
8942: ############################################################
8943: ############################################################
1.134 matthew 8944: sub DrawBarGraph {
1.178 matthew 8945: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8946: #
8947: if (! defined($colors)) {
8948: $colors = ['#33ff00',
8949: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8950: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8951: ];
8952: }
1.228 matthew 8953: my $extra_settings = {};
8954: if (ref($Values[-1]) eq 'HASH') {
8955: $extra_settings = pop(@Values);
8956: }
1.127 matthew 8957: #
1.136 matthew 8958: my $identifier = &get_cgi_id();
8959: my $id = 'cgi.'.$identifier;
1.129 matthew 8960: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8961: return '';
8962: }
1.225 matthew 8963: #
8964: my @Labels;
8965: if (defined($labels)) {
8966: @Labels = @$labels;
8967: } else {
8968: for (my $i=0;$i<@{$Values[0]};$i++) {
8969: push (@Labels,$i+1);
8970: }
8971: }
8972: #
1.129 matthew 8973: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8974: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8975: my %ValuesHash;
8976: my $NumSets=1;
8977: foreach my $array (@Values) {
8978: next if (! ref($array));
1.136 matthew 8979: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8980: join(',',@$array);
1.129 matthew 8981: }
1.127 matthew 8982: #
1.136 matthew 8983: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8984: if ($NumBars < 3) {
8985: $width = 120+$NumBars*32;
1.220 matthew 8986: $xskip = 1;
1.225 matthew 8987: $bar_width = 30;
8988: } elsif ($NumBars < 5) {
8989: $width = 120+$NumBars*20;
8990: $xskip = 1;
8991: $bar_width = 20;
1.220 matthew 8992: } elsif ($NumBars < 10) {
1.136 matthew 8993: $width = 120+$NumBars*15;
8994: $xskip = 1;
8995: $bar_width = 15;
8996: } elsif ($NumBars <= 25) {
8997: $width = 120+$NumBars*11;
8998: $xskip = 5;
8999: $bar_width = 8;
9000: } elsif ($NumBars <= 50) {
9001: $width = 120+$NumBars*8;
9002: $xskip = 5;
9003: $bar_width = 4;
9004: } else {
9005: $width = 120+$NumBars*8;
9006: $xskip = 5;
9007: $bar_width = 4;
9008: }
9009: #
1.137 matthew 9010: $Max = 1 if ($Max < 1);
9011: if ( int($Max) < $Max ) {
9012: $Max++;
9013: $Max = int($Max);
9014: }
1.127 matthew 9015: $Title = '' if (! defined($Title));
9016: $xlabel = '' if (! defined($xlabel));
9017: $ylabel = '' if (! defined($ylabel));
1.369 www 9018: $ValuesHash{$id.'.title'} = &escape($Title);
9019: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9020: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9021: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9022: $ValuesHash{$id.'.NumBars'} = $NumBars;
9023: $ValuesHash{$id.'.NumSets'} = $NumSets;
9024: $ValuesHash{$id.'.PlotType'} = 'bar';
9025: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9026: $ValuesHash{$id.'.height'} = $height;
9027: $ValuesHash{$id.'.width'} = $width;
9028: $ValuesHash{$id.'.xskip'} = $xskip;
9029: $ValuesHash{$id.'.bar_width'} = $bar_width;
9030: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9031: #
1.228 matthew 9032: # Deal with other parameters
9033: while (my ($key,$value) = each(%$extra_settings)) {
9034: $ValuesHash{$id.'.'.$key} = $value;
9035: }
9036: #
1.646 raeburn 9037: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9038: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9039: }
9040:
9041: ############################################################
9042: ############################################################
9043:
9044: =pod
9045:
1.648 raeburn 9046: =item * &DrawXYGraph()
1.137 matthew 9047:
1.138 matthew 9048: Facilitates the plotting of data in an XY graph.
9049: Puts plot definition data into the users environment in order for
9050: graph.png to plot it. Returns an <img> tag for the plot.
9051:
9052: Inputs:
9053:
9054: =over 4
9055:
9056: =item $Title: string, the title of the plot
9057:
9058: =item $xlabel: string, text describing the X-axis of the plot
9059:
9060: =item $ylabel: string, text describing the Y-axis of the plot
9061:
9062: =item $Max: scalar, the maximum Y value to use in the plot
9063: If $Max is < any data point, the graph will not be rendered.
9064:
9065: =item $colors: Array ref containing the hex color codes for the data to be
9066: plotted in. If undefined, default values will be used.
9067:
9068: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9069:
9070: =item $Ydata: Array ref containing Array refs.
1.185 www 9071: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9072:
9073: =item %Values: hash indicating or overriding any default values which are
9074: passed to graph.png.
9075: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9076:
9077: =back
9078:
9079: Returns:
9080:
9081: An <img> tag which references graph.png and the appropriate identifying
9082: information for the plot.
9083:
1.137 matthew 9084: =cut
9085:
9086: ############################################################
9087: ############################################################
9088: sub DrawXYGraph {
9089: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9090: #
9091: # Create the identifier for the graph
9092: my $identifier = &get_cgi_id();
9093: my $id = 'cgi.'.$identifier;
9094: #
9095: $Title = '' if (! defined($Title));
9096: $xlabel = '' if (! defined($xlabel));
9097: $ylabel = '' if (! defined($ylabel));
9098: my %ValuesHash =
9099: (
1.369 www 9100: $id.'.title' => &escape($Title),
9101: $id.'.xlabel' => &escape($xlabel),
9102: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9103: $id.'.y_max_value'=> $Max,
9104: $id.'.labels' => join(',',@$Xlabels),
9105: $id.'.PlotType' => 'XY',
9106: );
9107: #
9108: if (defined($colors) && ref($colors) eq 'ARRAY') {
9109: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9110: }
9111: #
9112: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9113: return '';
9114: }
9115: my $NumSets=1;
1.138 matthew 9116: foreach my $array (@{$Ydata}){
1.137 matthew 9117: next if (! ref($array));
9118: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9119: }
1.138 matthew 9120: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9121: #
9122: # Deal with other parameters
9123: while (my ($key,$value) = each(%Values)) {
9124: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9125: }
9126: #
1.646 raeburn 9127: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9128: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9129: }
9130:
9131: ############################################################
9132: ############################################################
9133:
9134: =pod
9135:
1.648 raeburn 9136: =item * &DrawXYYGraph()
1.138 matthew 9137:
9138: Facilitates the plotting of data in an XY graph with two Y axes.
9139: Puts plot definition data into the users environment in order for
9140: graph.png to plot it. Returns an <img> tag for the plot.
9141:
9142: Inputs:
9143:
9144: =over 4
9145:
9146: =item $Title: string, the title of the plot
9147:
9148: =item $xlabel: string, text describing the X-axis of the plot
9149:
9150: =item $ylabel: string, text describing the Y-axis of the plot
9151:
9152: =item $colors: Array ref containing the hex color codes for the data to be
9153: plotted in. If undefined, default values will be used.
9154:
9155: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9156:
9157: =item $Ydata1: The first data set
9158:
9159: =item $Min1: The minimum value of the left Y-axis
9160:
9161: =item $Max1: The maximum value of the left Y-axis
9162:
9163: =item $Ydata2: The second data set
9164:
9165: =item $Min2: The minimum value of the right Y-axis
9166:
9167: =item $Max2: The maximum value of the left Y-axis
9168:
9169: =item %Values: hash indicating or overriding any default values which are
9170: passed to graph.png.
9171: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9172:
9173: =back
9174:
9175: Returns:
9176:
9177: An <img> tag which references graph.png and the appropriate identifying
9178: information for the plot.
1.136 matthew 9179:
9180: =cut
9181:
9182: ############################################################
9183: ############################################################
1.137 matthew 9184: sub DrawXYYGraph {
9185: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9186: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9187: #
9188: # Create the identifier for the graph
9189: my $identifier = &get_cgi_id();
9190: my $id = 'cgi.'.$identifier;
9191: #
9192: $Title = '' if (! defined($Title));
9193: $xlabel = '' if (! defined($xlabel));
9194: $ylabel = '' if (! defined($ylabel));
9195: my %ValuesHash =
9196: (
1.369 www 9197: $id.'.title' => &escape($Title),
9198: $id.'.xlabel' => &escape($xlabel),
9199: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9200: $id.'.labels' => join(',',@$Xlabels),
9201: $id.'.PlotType' => 'XY',
9202: $id.'.NumSets' => 2,
1.137 matthew 9203: $id.'.two_axes' => 1,
9204: $id.'.y1_max_value' => $Max1,
9205: $id.'.y1_min_value' => $Min1,
9206: $id.'.y2_max_value' => $Max2,
9207: $id.'.y2_min_value' => $Min2,
1.136 matthew 9208: );
9209: #
1.137 matthew 9210: if (defined($colors) && ref($colors) eq 'ARRAY') {
9211: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9212: }
9213: #
9214: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9215: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9216: return '';
9217: }
9218: my $NumSets=1;
1.137 matthew 9219: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9220: next if (! ref($array));
9221: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9222: }
9223: #
9224: # Deal with other parameters
9225: while (my ($key,$value) = each(%Values)) {
9226: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9227: }
9228: #
1.646 raeburn 9229: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9230: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9231: }
9232:
9233: ############################################################
9234: ############################################################
9235:
9236: =pod
9237:
1.157 matthew 9238: =back
9239:
1.139 matthew 9240: =head1 Statistics helper routines?
9241:
9242: Bad place for them but what the hell.
9243:
1.157 matthew 9244: =over 4
9245:
1.648 raeburn 9246: =item * &chartlink()
1.139 matthew 9247:
9248: Returns a link to the chart for a specific student.
9249:
9250: Inputs:
9251:
9252: =over 4
9253:
9254: =item $linktext: The text of the link
9255:
9256: =item $sname: The students username
9257:
9258: =item $sdomain: The students domain
9259:
9260: =back
9261:
1.157 matthew 9262: =back
9263:
1.139 matthew 9264: =cut
9265:
9266: ############################################################
9267: ############################################################
9268: sub chartlink {
9269: my ($linktext, $sname, $sdomain) = @_;
9270: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9271: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9272: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9273: '">'.$linktext.'</a>';
1.153 matthew 9274: }
9275:
9276: #######################################################
9277: #######################################################
9278:
9279: =pod
9280:
9281: =head1 Course Environment Routines
1.157 matthew 9282:
9283: =over 4
1.153 matthew 9284:
1.648 raeburn 9285: =item * &restore_course_settings()
1.153 matthew 9286:
1.648 raeburn 9287: =item * &store_course_settings()
1.153 matthew 9288:
9289: Restores/Store indicated form parameters from the course environment.
9290: Will not overwrite existing values of the form parameters.
9291:
9292: Inputs:
9293: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9294:
9295: a hash ref describing the data to be stored. For example:
9296:
9297: %Save_Parameters = ('Status' => 'scalar',
9298: 'chartoutputmode' => 'scalar',
9299: 'chartoutputdata' => 'scalar',
9300: 'Section' => 'array',
1.373 raeburn 9301: 'Group' => 'array',
1.153 matthew 9302: 'StudentData' => 'array',
9303: 'Maps' => 'array');
9304:
9305: Returns: both routines return nothing
9306:
1.631 raeburn 9307: =back
9308:
1.153 matthew 9309: =cut
9310:
9311: #######################################################
9312: #######################################################
9313: sub store_course_settings {
1.496 albertel 9314: return &store_settings($env{'request.course.id'},@_);
9315: }
9316:
9317: sub store_settings {
1.153 matthew 9318: # save to the environment
9319: # appenv the same items, just to be safe
1.300 albertel 9320: my $udom = $env{'user.domain'};
9321: my $uname = $env{'user.name'};
1.496 albertel 9322: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9323: my %SaveHash;
9324: my %AppHash;
9325: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9326: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9327: my $envname = 'environment.'.$basename;
1.258 albertel 9328: if (exists($env{'form.'.$setting})) {
1.153 matthew 9329: # Save this value away
9330: if ($type eq 'scalar' &&
1.258 albertel 9331: (! exists($env{$envname}) ||
9332: $env{$envname} ne $env{'form.'.$setting})) {
9333: $SaveHash{$basename} = $env{'form.'.$setting};
9334: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9335: } elsif ($type eq 'array') {
9336: my $stored_form;
1.258 albertel 9337: if (ref($env{'form.'.$setting})) {
1.153 matthew 9338: $stored_form = join(',',
9339: map {
1.369 www 9340: &escape($_);
1.258 albertel 9341: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9342: } else {
9343: $stored_form =
1.369 www 9344: &escape($env{'form.'.$setting});
1.153 matthew 9345: }
9346: # Determine if the array contents are the same.
1.258 albertel 9347: if ($stored_form ne $env{$envname}) {
1.153 matthew 9348: $SaveHash{$basename} = $stored_form;
9349: $AppHash{$envname} = $stored_form;
9350: }
9351: }
9352: }
9353: }
9354: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9355: $udom,$uname);
1.153 matthew 9356: if ($put_result !~ /^(ok|delayed)/) {
9357: &Apache::lonnet::logthis('unable to save form parameters, '.
9358: 'got error:'.$put_result);
9359: }
9360: # Make sure these settings stick around in this session, too
1.646 raeburn 9361: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9362: return;
9363: }
9364:
9365: sub restore_course_settings {
1.499 albertel 9366: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9367: }
9368:
9369: sub restore_settings {
9370: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9371: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9372: next if (exists($env{'form.'.$setting}));
1.496 albertel 9373: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9374: '.'.$setting;
1.258 albertel 9375: if (exists($env{$envname})) {
1.153 matthew 9376: if ($type eq 'scalar') {
1.258 albertel 9377: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9378: } elsif ($type eq 'array') {
1.258 albertel 9379: $env{'form.'.$setting} = [
1.153 matthew 9380: map {
1.369 www 9381: &unescape($_);
1.258 albertel 9382: } split(',',$env{$envname})
1.153 matthew 9383: ];
9384: }
9385: }
9386: }
1.127 matthew 9387: }
9388:
1.618 raeburn 9389: #######################################################
9390: #######################################################
9391:
9392: =pod
9393:
9394: =head1 Domain E-mail Routines
9395:
9396: =over 4
9397:
1.648 raeburn 9398: =item * &build_recipient_list()
1.618 raeburn 9399:
1.884 raeburn 9400: Build recipient lists for five types of e-mail:
1.766 raeburn 9401: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9402: (d) Help requests, (e) Course requests needing approval, generated by
9403: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9404: loncoursequeueadmin.pm respectively.
1.618 raeburn 9405:
9406: Inputs:
1.619 raeburn 9407: defmail (scalar - email address of default recipient),
1.618 raeburn 9408: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9409: defdom (domain for which to retrieve configuration settings),
9410: origmail (scalar - email address of recipient from loncapa.conf,
9411: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9412:
1.655 raeburn 9413: Returns: comma separated list of addresses to which to send e-mail.
9414:
9415: =back
1.618 raeburn 9416:
9417: =cut
9418:
9419: ############################################################
9420: ############################################################
9421: sub build_recipient_list {
1.619 raeburn 9422: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9423: my @recipients;
9424: my $otheremails;
9425: my %domconfig =
9426: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9427: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9428: if (exists($domconfig{'contacts'}{$mailing})) {
9429: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9430: my @contacts = ('adminemail','supportemail');
9431: foreach my $item (@contacts) {
9432: if ($domconfig{'contacts'}{$mailing}{$item}) {
9433: my $addr = $domconfig{'contacts'}{$item};
9434: if (!grep(/^\Q$addr\E$/,@recipients)) {
9435: push(@recipients,$addr);
9436: }
1.619 raeburn 9437: }
1.766 raeburn 9438: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9439: }
9440: }
1.766 raeburn 9441: } elsif ($origmail ne '') {
9442: push(@recipients,$origmail);
1.618 raeburn 9443: }
1.619 raeburn 9444: } elsif ($origmail ne '') {
9445: push(@recipients,$origmail);
1.618 raeburn 9446: }
1.688 raeburn 9447: if (defined($defmail)) {
9448: if ($defmail ne '') {
9449: push(@recipients,$defmail);
9450: }
1.618 raeburn 9451: }
9452: if ($otheremails) {
1.619 raeburn 9453: my @others;
9454: if ($otheremails =~ /,/) {
9455: @others = split(/,/,$otheremails);
1.618 raeburn 9456: } else {
1.619 raeburn 9457: push(@others,$otheremails);
9458: }
9459: foreach my $addr (@others) {
9460: if (!grep(/^\Q$addr\E$/,@recipients)) {
9461: push(@recipients,$addr);
9462: }
1.618 raeburn 9463: }
9464: }
1.619 raeburn 9465: my $recipientlist = join(',',@recipients);
1.618 raeburn 9466: return $recipientlist;
9467: }
9468:
1.127 matthew 9469: ############################################################
9470: ############################################################
1.154 albertel 9471:
1.655 raeburn 9472: =pod
9473:
9474: =head1 Course Catalog Routines
9475:
9476: =over 4
9477:
9478: =item * &gather_categories()
9479:
9480: Converts category definitions - keys of categories hash stored in
9481: coursecategories in configuration.db on the primary library server in a
9482: domain - to an array. Also generates javascript and idx hash used to
9483: generate Domain Coordinator interface for editing Course Categories.
9484:
9485: Inputs:
1.663 raeburn 9486:
1.655 raeburn 9487: categories (reference to hash of category definitions).
1.663 raeburn 9488:
1.655 raeburn 9489: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9490: categories and subcategories).
1.663 raeburn 9491:
1.655 raeburn 9492: idx (reference to hash of counters used in Domain Coordinator interface for
9493: editing Course Categories).
1.663 raeburn 9494:
1.655 raeburn 9495: jsarray (reference to array of categories used to create Javascript arrays for
9496: Domain Coordinator interface for editing Course Categories).
9497:
9498: Returns: nothing
9499:
9500: Side effects: populates cats, idx and jsarray.
9501:
9502: =cut
9503:
9504: sub gather_categories {
9505: my ($categories,$cats,$idx,$jsarray) = @_;
9506: my %counters;
9507: my $num = 0;
9508: foreach my $item (keys(%{$categories})) {
9509: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9510: if ($container eq '' && $depth == 0) {
9511: $cats->[$depth][$categories->{$item}] = $cat;
9512: } else {
9513: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9514: }
9515: my ($escitem,$tail) = split(/:/,$item,2);
9516: if ($counters{$tail} eq '') {
9517: $counters{$tail} = $num;
9518: $num ++;
9519: }
9520: if (ref($idx) eq 'HASH') {
9521: $idx->{$item} = $counters{$tail};
9522: }
9523: if (ref($jsarray) eq 'ARRAY') {
9524: push(@{$jsarray->[$counters{$tail}]},$item);
9525: }
9526: }
9527: return;
9528: }
9529:
9530: =pod
9531:
9532: =item * &extract_categories()
9533:
9534: Used to generate breadcrumb trails for course categories.
9535:
9536: Inputs:
1.663 raeburn 9537:
1.655 raeburn 9538: categories (reference to hash of category definitions).
1.663 raeburn 9539:
1.655 raeburn 9540: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9541: categories and subcategories).
1.663 raeburn 9542:
1.655 raeburn 9543: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9544:
1.655 raeburn 9545: allitems (reference to hash - key is category key
9546: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9547:
1.655 raeburn 9548: idx (reference to hash of counters used in Domain Coordinator interface for
9549: editing Course Categories).
1.663 raeburn 9550:
1.655 raeburn 9551: jsarray (reference to array of categories used to create Javascript arrays for
9552: Domain Coordinator interface for editing Course Categories).
9553:
1.665 raeburn 9554: subcats (reference to hash of arrays containing all subcategories within each
9555: category, -recursive)
9556:
1.655 raeburn 9557: Returns: nothing
9558:
9559: Side effects: populates trails and allitems hash references.
9560:
9561: =cut
9562:
9563: sub extract_categories {
1.665 raeburn 9564: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9565: if (ref($categories) eq 'HASH') {
9566: &gather_categories($categories,$cats,$idx,$jsarray);
9567: if (ref($cats->[0]) eq 'ARRAY') {
9568: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9569: my $name = $cats->[0][$i];
9570: my $item = &escape($name).'::0';
9571: my $trailstr;
9572: if ($name eq 'instcode') {
9573: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9574: } elsif ($name eq 'communities') {
9575: $trailstr = &mt('Communities');
1.655 raeburn 9576: } else {
9577: $trailstr = $name;
9578: }
9579: if ($allitems->{$item} eq '') {
9580: push(@{$trails},$trailstr);
9581: $allitems->{$item} = scalar(@{$trails})-1;
9582: }
9583: my @parents = ($name);
9584: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9585: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9586: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9587: if (ref($subcats) eq 'HASH') {
9588: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9589: }
9590: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9591: }
9592: } else {
9593: if (ref($subcats) eq 'HASH') {
9594: $subcats->{$item} = [];
1.655 raeburn 9595: }
9596: }
9597: }
9598: }
9599: }
9600: return;
9601: }
9602:
9603: =pod
9604:
9605: =item *&recurse_categories()
9606:
9607: Recursively used to generate breadcrumb trails for course categories.
9608:
9609: Inputs:
1.663 raeburn 9610:
1.655 raeburn 9611: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9612: categories and subcategories).
1.663 raeburn 9613:
1.655 raeburn 9614: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9615:
9616: category (current course category, for which breadcrumb trail is being generated).
9617:
9618: trails (reference to array of breadcrumb trails for each category).
9619:
1.655 raeburn 9620: allitems (reference to hash - key is category key
9621: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9622:
1.655 raeburn 9623: parents (array containing containers directories for current category,
9624: back to top level).
9625:
9626: Returns: nothing
9627:
9628: Side effects: populates trails and allitems hash references
9629:
9630: =cut
9631:
9632: sub recurse_categories {
1.665 raeburn 9633: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9634: my $shallower = $depth - 1;
9635: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9636: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9637: my $name = $cats->[$depth]{$category}[$k];
9638: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9639: my $trailstr = join(' -> ',(@{$parents},$category));
9640: if ($allitems->{$item} eq '') {
9641: push(@{$trails},$trailstr);
9642: $allitems->{$item} = scalar(@{$trails})-1;
9643: }
9644: my $deeper = $depth+1;
9645: push(@{$parents},$category);
1.665 raeburn 9646: if (ref($subcats) eq 'HASH') {
9647: my $subcat = &escape($name).':'.$category.':'.$depth;
9648: for (my $j=@{$parents}; $j>=0; $j--) {
9649: my $higher;
9650: if ($j > 0) {
9651: $higher = &escape($parents->[$j]).':'.
9652: &escape($parents->[$j-1]).':'.$j;
9653: } else {
9654: $higher = &escape($parents->[$j]).'::'.$j;
9655: }
9656: push(@{$subcats->{$higher}},$subcat);
9657: }
9658: }
9659: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9660: $subcats);
1.655 raeburn 9661: pop(@{$parents});
9662: }
9663: } else {
9664: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9665: my $trailstr = join(' -> ',(@{$parents},$category));
9666: if ($allitems->{$item} eq '') {
9667: push(@{$trails},$trailstr);
9668: $allitems->{$item} = scalar(@{$trails})-1;
9669: }
9670: }
9671: return;
9672: }
9673:
1.663 raeburn 9674: =pod
9675:
9676: =item *&assign_categories_table()
9677:
9678: Create a datatable for display of hierarchical categories in a domain,
9679: with checkboxes to allow a course to be categorized.
9680:
9681: Inputs:
9682:
9683: cathash - reference to hash of categories defined for the domain (from
9684: configuration.db)
9685:
9686: currcat - scalar with an & separated list of categories assigned to a course.
9687:
1.919 raeburn 9688: type - scalar contains course type (Course or Community).
9689:
1.663 raeburn 9690: Returns: $output (markup to be displayed)
9691:
9692: =cut
9693:
9694: sub assign_categories_table {
1.919 raeburn 9695: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9696: my $output;
9697: if (ref($cathash) eq 'HASH') {
9698: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9699: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9700: $maxdepth = scalar(@cats);
9701: if (@cats > 0) {
9702: my $itemcount = 0;
9703: if (ref($cats[0]) eq 'ARRAY') {
9704: my @currcategories;
9705: if ($currcat ne '') {
9706: @currcategories = split('&',$currcat);
9707: }
1.919 raeburn 9708: my $table;
1.663 raeburn 9709: for (my $i=0; $i<@{$cats[0]}; $i++) {
9710: my $parent = $cats[0][$i];
1.919 raeburn 9711: next if ($parent eq 'instcode');
9712: if ($type eq 'Community') {
9713: next unless ($parent eq 'communities');
9714: } else {
9715: next if ($parent eq 'communities');
9716: }
1.663 raeburn 9717: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9718: my $item = &escape($parent).'::0';
9719: my $checked = '';
9720: if (@currcategories > 0) {
9721: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9722: $checked = ' checked="checked"';
1.663 raeburn 9723: }
9724: }
1.919 raeburn 9725: my $parent_title = $parent;
9726: if ($parent eq 'communities') {
9727: $parent_title = &mt('Communities');
9728: }
9729: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9730: '<input type="checkbox" name="usecategory" value="'.
9731: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9732: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9733: my $depth = 1;
9734: push(@path,$parent);
1.919 raeburn 9735: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9736: pop(@path);
1.919 raeburn 9737: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9738: $itemcount ++;
9739: }
1.919 raeburn 9740: if ($itemcount) {
9741: $output = &Apache::loncommon::start_data_table().
9742: $table.
9743: &Apache::loncommon::end_data_table();
9744: }
1.663 raeburn 9745: }
9746: }
9747: }
9748: return $output;
9749: }
9750:
9751: =pod
9752:
9753: =item *&assign_category_rows()
9754:
9755: Create a datatable row for display of nested categories in a domain,
9756: with checkboxes to allow a course to be categorized,called recursively.
9757:
9758: Inputs:
9759:
9760: itemcount - track row number for alternating colors
9761:
9762: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9763: categories and subcategories.
9764:
9765: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9766:
9767: parent - parent of current category item
9768:
9769: path - Array containing all categories back up through the hierarchy from the
9770: current category to the top level.
9771:
9772: currcategories - reference to array of current categories assigned to the course
9773:
9774: Returns: $output (markup to be displayed).
9775:
9776: =cut
9777:
9778: sub assign_category_rows {
9779: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9780: my ($text,$name,$item,$chgstr);
9781: if (ref($cats) eq 'ARRAY') {
9782: my $maxdepth = scalar(@{$cats});
9783: if (ref($cats->[$depth]) eq 'HASH') {
9784: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9785: my $numchildren = @{$cats->[$depth]{$parent}};
9786: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9787: $text .= '<td><table class="LC_datatable">';
9788: for (my $j=0; $j<$numchildren; $j++) {
9789: $name = $cats->[$depth]{$parent}[$j];
9790: $item = &escape($name).':'.&escape($parent).':'.$depth;
9791: my $deeper = $depth+1;
9792: my $checked = '';
9793: if (ref($currcategories) eq 'ARRAY') {
9794: if (@{$currcategories} > 0) {
9795: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9796: $checked = ' checked="checked"';
1.663 raeburn 9797: }
9798: }
9799: }
1.664 raeburn 9800: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9801: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9802: $item.'"'.$checked.' />'.$name.'</label></span>'.
9803: '<input type="hidden" name="catname" value="'.$name.'" />'.
9804: '</td><td>';
1.663 raeburn 9805: if (ref($path) eq 'ARRAY') {
9806: push(@{$path},$name);
9807: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9808: pop(@{$path});
9809: }
9810: $text .= '</td></tr>';
9811: }
9812: $text .= '</table></td>';
9813: }
9814: }
9815: }
9816: return $text;
9817: }
9818:
1.655 raeburn 9819: ############################################################
9820: ############################################################
9821:
9822:
1.443 albertel 9823: sub commit_customrole {
1.664 raeburn 9824: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9825: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9826: ($start?', '.&mt('starting').' '.localtime($start):'').
9827: ($end?', ending '.localtime($end):'').': <b>'.
9828: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9829: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9830: '</b><br />';
9831: return $output;
9832: }
9833:
9834: sub commit_standardrole {
1.541 raeburn 9835: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9836: my ($output,$logmsg,$linefeed);
9837: if ($context eq 'auto') {
9838: $linefeed = "\n";
9839: } else {
9840: $linefeed = "<br />\n";
9841: }
1.443 albertel 9842: if ($three eq 'st') {
1.541 raeburn 9843: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9844: $one,$two,$sec,$context);
9845: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9846: ($result eq 'unknown_course') || ($result eq 'refused')) {
9847: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9848: } else {
1.541 raeburn 9849: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9850: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9851: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9852: if ($context eq 'auto') {
9853: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9854: } else {
9855: $output .= '<b>'.$result.'</b>'.$linefeed.
9856: &mt('Add to classlist').': <b>ok</b>';
9857: }
9858: $output .= $linefeed;
1.443 albertel 9859: }
9860: } else {
9861: $output = &mt('Assigning').' '.$three.' in '.$url.
9862: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9863: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9864: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9865: if ($context eq 'auto') {
9866: $output .= $result.$linefeed;
9867: } else {
9868: $output .= '<b>'.$result.'</b>'.$linefeed;
9869: }
1.443 albertel 9870: }
9871: return $output;
9872: }
9873:
9874: sub commit_studentrole {
1.541 raeburn 9875: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9876: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9877: if ($context eq 'auto') {
9878: $linefeed = "\n";
9879: } else {
9880: $linefeed = '<br />'."\n";
9881: }
1.443 albertel 9882: if (defined($one) && defined($two)) {
9883: my $cid=$one.'_'.$two;
9884: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9885: my $secchange = 0;
9886: my $expire_role_result;
9887: my $modify_section_result;
1.628 raeburn 9888: if ($oldsec ne '-1') {
9889: if ($oldsec ne $sec) {
1.443 albertel 9890: $secchange = 1;
1.628 raeburn 9891: my $now = time;
1.443 albertel 9892: my $uurl='/'.$cid;
9893: $uurl=~s/\_/\//g;
9894: if ($oldsec) {
9895: $uurl.='/'.$oldsec;
9896: }
1.626 raeburn 9897: $oldsecurl = $uurl;
1.628 raeburn 9898: $expire_role_result =
1.652 raeburn 9899: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9900: if ($env{'request.course.sec'} ne '') {
9901: if ($expire_role_result eq 'refused') {
9902: my @roles = ('st');
9903: my @statuses = ('previous');
9904: my @roledoms = ($one);
9905: my $withsec = 1;
9906: my %roleshash =
9907: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9908: \@statuses,\@roles,\@roledoms,$withsec);
9909: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9910: my ($oldstart,$oldend) =
9911: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9912: if ($oldend > 0 && $oldend <= $now) {
9913: $expire_role_result = 'ok';
9914: }
9915: }
9916: }
9917: }
1.443 albertel 9918: $result = $expire_role_result;
9919: }
9920: }
9921: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9922: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9923: if ($modify_section_result =~ /^ok/) {
9924: if ($secchange == 1) {
1.628 raeburn 9925: if ($sec eq '') {
9926: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9927: } else {
9928: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9929: }
1.443 albertel 9930: } elsif ($oldsec eq '-1') {
1.628 raeburn 9931: if ($sec eq '') {
9932: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9933: } else {
9934: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9935: }
1.443 albertel 9936: } else {
1.628 raeburn 9937: if ($sec eq '') {
9938: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9939: } else {
9940: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9941: }
1.443 albertel 9942: }
9943: } else {
1.628 raeburn 9944: if ($secchange) {
9945: $$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;
9946: } else {
9947: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9948: }
1.443 albertel 9949: }
9950: $result = $modify_section_result;
9951: } elsif ($secchange == 1) {
1.628 raeburn 9952: if ($oldsec eq '') {
9953: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9954: } else {
9955: $$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;
9956: }
1.626 raeburn 9957: if ($expire_role_result eq 'refused') {
9958: my $newsecurl = '/'.$cid;
9959: $newsecurl =~ s/\_/\//g;
9960: if ($sec ne '') {
9961: $newsecurl.='/'.$sec;
9962: }
9963: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9964: if ($sec eq '') {
9965: $$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;
9966: } else {
9967: $$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;
9968: }
9969: }
9970: }
1.443 albertel 9971: }
9972: } else {
1.626 raeburn 9973: $$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 9974: $result = "error: incomplete course id\n";
9975: }
9976: return $result;
9977: }
9978:
9979: ############################################################
9980: ############################################################
9981:
1.566 albertel 9982: sub check_clone {
1.578 raeburn 9983: my ($args,$linefeed) = @_;
1.566 albertel 9984: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9985: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9986: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9987: my $clonemsg;
9988: my $can_clone = 0;
1.908 raeburn 9989: my $lctype = lc($args->{'type'});
9990: if ($lctype ne 'community') {
9991: $lctype = 'course';
9992: }
1.566 albertel 9993: if ($clonehome eq 'no_host') {
1.908 raeburn 9994: if ($args->{'type'} eq 'Community') {
9995: $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'});
9996: } else {
9997: $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'});
9998: }
1.566 albertel 9999: } else {
10000: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10001: if ($args->{'type'} eq 'Community') {
10002: if ($clonedesc{'type'} ne 'Community') {
10003: $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'});
10004: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10005: }
10006: }
1.882 raeburn 10007: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10008: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10009: $can_clone = 1;
10010: } else {
10011: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10012: $args->{'clonedomain'},$args->{'clonecourse'});
10013: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10014: if (grep(/^\*$/,@cloners)) {
10015: $can_clone = 1;
10016: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10017: $can_clone = 1;
10018: } else {
1.908 raeburn 10019: my $ccrole = 'cc';
10020: if ($args->{'type'} eq 'Community') {
10021: $ccrole = 'co';
10022: }
1.578 raeburn 10023: my %roleshash =
10024: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10025: $args->{'ccdomain'},
1.908 raeburn 10026: 'userroles',['active'],[$ccrole],
1.578 raeburn 10027: [$args->{'clonedomain'}]);
1.908 raeburn 10028: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10029: $can_clone = 1;
10030: } else {
1.908 raeburn 10031: if ($args->{'type'} eq 'Community') {
10032: $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'});
10033: } else {
10034: $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'});
10035: }
1.578 raeburn 10036: }
1.566 albertel 10037: }
1.578 raeburn 10038: }
1.566 albertel 10039: }
10040: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10041: }
10042:
1.444 albertel 10043: sub construct_course {
1.885 raeburn 10044: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10045: my $outcome;
1.541 raeburn 10046: my $linefeed = '<br />'."\n";
10047: if ($context eq 'auto') {
10048: $linefeed = "\n";
10049: }
1.566 albertel 10050:
10051: #
10052: # Are we cloning?
10053: #
10054: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10055: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10056: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10057: if ($context ne 'auto') {
1.578 raeburn 10058: if ($clonemsg ne '') {
10059: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10060: }
1.566 albertel 10061: }
10062: $outcome .= $clonemsg.$linefeed;
10063:
10064: if (!$can_clone) {
10065: return (0,$outcome);
10066: }
10067: }
10068:
1.444 albertel 10069: #
10070: # Open course
10071: #
10072: my $crstype = lc($args->{'crstype'});
10073: my %cenv=();
10074: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10075: $args->{'cdescr'},
10076: $args->{'curl'},
10077: $args->{'course_home'},
10078: $args->{'nonstandard'},
10079: $args->{'crscode'},
10080: $args->{'ccuname'}.':'.
10081: $args->{'ccdomain'},
1.882 raeburn 10082: $args->{'crstype'},
1.885 raeburn 10083: $cnum,$context,$category);
1.444 albertel 10084:
10085: # Note: The testing routines depend on this being output; see
10086: # Utils::Course. This needs to at least be output as a comment
10087: # if anyone ever decides to not show this, and Utils::Course::new
10088: # will need to be suitably modified.
1.541 raeburn 10089: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10090: #
10091: # Check if created correctly
10092: #
1.479 albertel 10093: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10094: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10095: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10096:
1.444 albertel 10097: #
1.566 albertel 10098: # Do the cloning
10099: #
10100: if ($can_clone && $cloneid) {
10101: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10102: if ($context ne 'auto') {
10103: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10104: }
10105: $outcome .= $clonemsg.$linefeed;
10106: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10107: # Copy all files
1.637 www 10108: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10109: # Restore URL
1.566 albertel 10110: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10111: # Restore title
1.566 albertel 10112: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10113: # Mark as cloned
1.566 albertel 10114: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10115: # Need to clone grading mode
10116: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10117: $cenv{'grading'}=$newenv{'grading'};
10118: # Do not clone these environment entries
10119: &Apache::lonnet::del('environment',
10120: ['default_enrollment_start_date',
10121: 'default_enrollment_end_date',
10122: 'question.email',
10123: 'policy.email',
10124: 'comment.email',
10125: 'pch.users.denied',
1.725 raeburn 10126: 'plc.users.denied',
10127: 'hidefromcat',
10128: 'categories'],
1.638 www 10129: $$crsudom,$$crsunum);
1.444 albertel 10130: }
1.566 albertel 10131:
1.444 albertel 10132: #
10133: # Set environment (will override cloned, if existing)
10134: #
10135: my @sections = ();
10136: my @xlists = ();
10137: if ($args->{'crstype'}) {
10138: $cenv{'type'}=$args->{'crstype'};
10139: }
10140: if ($args->{'crsid'}) {
10141: $cenv{'courseid'}=$args->{'crsid'};
10142: }
10143: if ($args->{'crscode'}) {
10144: $cenv{'internal.coursecode'}=$args->{'crscode'};
10145: }
10146: if ($args->{'crsquota'} ne '') {
10147: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10148: } else {
10149: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10150: }
10151: if ($args->{'ccuname'}) {
10152: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10153: ':'.$args->{'ccdomain'};
10154: } else {
10155: $cenv{'internal.courseowner'} = $args->{'curruser'};
10156: }
10157: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10158: if ($args->{'crssections'}) {
10159: $cenv{'internal.sectionnums'} = '';
10160: if ($args->{'crssections'} =~ m/,/) {
10161: @sections = split/,/,$args->{'crssections'};
10162: } else {
10163: $sections[0] = $args->{'crssections'};
10164: }
10165: if (@sections > 0) {
10166: foreach my $item (@sections) {
10167: my ($sec,$gp) = split/:/,$item;
10168: my $class = $args->{'crscode'}.$sec;
10169: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10170: $cenv{'internal.sectionnums'} .= $item.',';
10171: unless ($addcheck eq 'ok') {
10172: push @badclasses, $class;
10173: }
10174: }
10175: $cenv{'internal.sectionnums'} =~ s/,$//;
10176: }
10177: }
10178: # do not hide course coordinator from staff listing,
10179: # even if privileged
10180: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10181: # add crosslistings
10182: if ($args->{'crsxlist'}) {
10183: $cenv{'internal.crosslistings'}='';
10184: if ($args->{'crsxlist'} =~ m/,/) {
10185: @xlists = split/,/,$args->{'crsxlist'};
10186: } else {
10187: $xlists[0] = $args->{'crsxlist'};
10188: }
10189: if (@xlists > 0) {
10190: foreach my $item (@xlists) {
10191: my ($xl,$gp) = split/:/,$item;
10192: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10193: $cenv{'internal.crosslistings'} .= $item.',';
10194: unless ($addcheck eq 'ok') {
10195: push @badclasses, $xl;
10196: }
10197: }
10198: $cenv{'internal.crosslistings'} =~ s/,$//;
10199: }
10200: }
10201: if ($args->{'autoadds'}) {
10202: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10203: }
10204: if ($args->{'autodrops'}) {
10205: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10206: }
10207: # check for notification of enrollment changes
10208: my @notified = ();
10209: if ($args->{'notify_owner'}) {
10210: if ($args->{'ccuname'} ne '') {
10211: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10212: }
10213: }
10214: if ($args->{'notify_dc'}) {
10215: if ($uname ne '') {
1.630 raeburn 10216: push(@notified,$uname.':'.$udom);
1.444 albertel 10217: }
10218: }
10219: if (@notified > 0) {
10220: my $notifylist;
10221: if (@notified > 1) {
10222: $notifylist = join(',',@notified);
10223: } else {
10224: $notifylist = $notified[0];
10225: }
10226: $cenv{'internal.notifylist'} = $notifylist;
10227: }
10228: if (@badclasses > 0) {
10229: my %lt=&Apache::lonlocal::texthash(
10230: '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',
10231: 'dnhr' => 'does not have rights to access enrollment in these classes',
10232: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10233: );
1.541 raeburn 10234: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10235: ' ('.$lt{'adby'}.')';
10236: if ($context eq 'auto') {
10237: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10238: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10239: foreach my $item (@badclasses) {
10240: if ($context eq 'auto') {
10241: $outcome .= " - $item\n";
10242: } else {
10243: $outcome .= "<li>$item</li>\n";
10244: }
10245: }
10246: if ($context eq 'auto') {
10247: $outcome .= $linefeed;
10248: } else {
1.566 albertel 10249: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10250: }
10251: }
1.444 albertel 10252: }
10253: if ($args->{'no_end_date'}) {
10254: $args->{'endaccess'} = 0;
10255: }
10256: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10257: $cenv{'internal.autoend'}=$args->{'enrollend'};
10258: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10259: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10260: if ($args->{'showphotos'}) {
10261: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10262: }
10263: $cenv{'internal.authtype'} = $args->{'authtype'};
10264: $cenv{'internal.autharg'} = $args->{'autharg'};
10265: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10266: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10267: 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');
10268: if ($context eq 'auto') {
10269: $outcome .= $krb_msg;
10270: } else {
1.566 albertel 10271: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10272: }
10273: $outcome .= $linefeed;
1.444 albertel 10274: }
10275: }
10276: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10277: if ($args->{'setpolicy'}) {
10278: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10279: }
10280: if ($args->{'setcontent'}) {
10281: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10282: }
10283: }
10284: if ($args->{'reshome'}) {
10285: $cenv{'reshome'}=$args->{'reshome'}.'/';
10286: $cenv{'reshome'}=~s/\/+$/\//;
10287: }
10288: #
10289: # course has keyed access
10290: #
10291: if ($args->{'setkeys'}) {
10292: $cenv{'keyaccess'}='yes';
10293: }
10294: # if specified, key authority is not course, but user
10295: # only active if keyaccess is yes
10296: if ($args->{'keyauth'}) {
1.487 albertel 10297: my ($user,$domain) = split(':',$args->{'keyauth'});
10298: $user = &LONCAPA::clean_username($user);
10299: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10300: if ($user ne '' && $domain ne '') {
1.487 albertel 10301: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10302: }
10303: }
10304:
10305: if ($args->{'disresdis'}) {
10306: $cenv{'pch.roles.denied'}='st';
10307: }
10308: if ($args->{'disablechat'}) {
10309: $cenv{'plc.roles.denied'}='st';
10310: }
10311:
10312: # Record we've not yet viewed the Course Initialization Helper for this
10313: # course
10314: $cenv{'course.helper.not.run'} = 1;
10315: #
10316: # Use new Randomseed
10317: #
10318: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10319: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10320: #
10321: # The encryption code and receipt prefix for this course
10322: #
10323: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10324: $cenv{'internal.encpref'}=100+int(9*rand(99));
10325: #
10326: # By default, use standard grading
10327: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10328:
1.541 raeburn 10329: $outcome .= $linefeed.&mt('Setting environment').': '.
10330: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10331: #
10332: # Open all assignments
10333: #
10334: if ($args->{'openall'}) {
10335: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10336: my %storecontent = ($storeunder => time,
10337: $storeunder.'.type' => 'date_start');
10338:
10339: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10340: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10341: }
10342: #
10343: # Set first page
10344: #
10345: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10346: || ($cloneid)) {
1.445 albertel 10347: use LONCAPA::map;
1.444 albertel 10348: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10349:
10350: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10351: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10352:
1.444 albertel 10353: $outcome .= ($fatal?$errtext:'read ok').' - ';
10354: my $title; my $url;
10355: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10356: $title=&mt('Syllabus');
1.444 albertel 10357: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10358: } else {
1.690 bisitz 10359: $title=&mt('Navigate Contents');
1.444 albertel 10360: $url='/adm/navmaps';
10361: }
1.445 albertel 10362:
10363: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10364: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10365:
10366: if ($errtext) { $fatal=2; }
1.541 raeburn 10367: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10368: }
1.566 albertel 10369:
10370: return (1,$outcome);
1.444 albertel 10371: }
10372:
10373: ############################################################
10374: ############################################################
10375:
1.378 raeburn 10376: sub course_type {
10377: my ($cid) = @_;
10378: if (!defined($cid)) {
10379: $cid = $env{'request.course.id'};
10380: }
1.404 albertel 10381: if (defined($env{'course.'.$cid.'.type'})) {
10382: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10383: } else {
10384: return 'Course';
1.377 raeburn 10385: }
10386: }
1.156 albertel 10387:
1.406 raeburn 10388: sub group_term {
10389: my $crstype = &course_type();
10390: my %names = (
10391: 'Course' => 'group',
1.865 raeburn 10392: 'Community' => 'group',
1.406 raeburn 10393: );
10394: return $names{$crstype};
10395: }
10396:
1.902 raeburn 10397: sub course_types {
10398: my @types = ('official','unofficial','community');
10399: my %typename = (
10400: official => 'Official course',
10401: unofficial => 'Unofficial course',
10402: community => 'Community',
10403: );
10404: return (\@types,\%typename);
10405: }
10406:
1.156 albertel 10407: sub icon {
10408: my ($file)=@_;
1.505 albertel 10409: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10410: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10411: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10412: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10413: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10414: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10415: $curfext.".gif") {
10416: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10417: $curfext.".gif";
10418: }
10419: }
1.249 albertel 10420: return &lonhttpdurl($iconname);
1.154 albertel 10421: }
1.84 albertel 10422:
1.575 albertel 10423: sub lonhttpdurl {
1.692 www 10424: #
10425: # Had been used for "small fry" static images on separate port 8080.
10426: # Modify here if lightweight http functionality desired again.
10427: # Currently eliminated due to increasing firewall issues.
10428: #
1.575 albertel 10429: my ($url)=@_;
1.692 www 10430: return $url;
1.215 albertel 10431: }
10432:
1.213 albertel 10433: sub connection_aborted {
10434: my ($r)=@_;
10435: $r->print(" ");$r->rflush();
10436: my $c = $r->connection;
10437: return $c->aborted();
10438: }
10439:
1.221 foxr 10440: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10441: # strings as 'strings'.
10442: sub escape_single {
1.221 foxr 10443: my ($input) = @_;
1.223 albertel 10444: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10445: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10446: return $input;
10447: }
1.223 albertel 10448:
1.222 foxr 10449: # Same as escape_single, but escape's "'s This
10450: # can be used for "strings"
10451: sub escape_double {
10452: my ($input) = @_;
10453: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10454: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10455: return $input;
10456: }
1.223 albertel 10457:
1.222 foxr 10458: # Escapes the last element of a full URL.
10459: sub escape_url {
10460: my ($url) = @_;
1.238 raeburn 10461: my @urlslices = split(/\//, $url,-1);
1.369 www 10462: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10463: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10464: }
1.462 albertel 10465:
1.820 raeburn 10466: sub compare_arrays {
10467: my ($arrayref1,$arrayref2) = @_;
10468: my (@difference,%count);
10469: @difference = ();
10470: %count = ();
10471: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10472: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10473: foreach my $element (keys(%count)) {
10474: if ($count{$element} == 1) {
10475: push(@difference,$element);
10476: }
10477: }
10478: }
10479: return @difference;
10480: }
10481:
1.817 bisitz 10482: # -------------------------------------------------------- Initialize user login
1.462 albertel 10483: sub init_user_environment {
1.463 albertel 10484: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10485: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10486:
10487: my $public=($username eq 'public' && $domain eq 'public');
10488:
10489: # See if old ID present, if so, remove
10490:
10491: my ($filename,$cookie,$userroles);
10492: my $now=time;
10493:
10494: if ($public) {
10495: my $max_public=100;
10496: my $oldest;
10497: my $oldest_time=0;
10498: for(my $next=1;$next<=$max_public;$next++) {
10499: if (-e $lonids."/publicuser_$next.id") {
10500: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10501: if ($mtime<$oldest_time || !$oldest_time) {
10502: $oldest_time=$mtime;
10503: $oldest=$next;
10504: }
10505: } else {
10506: $cookie="publicuser_$next";
10507: last;
10508: }
10509: }
10510: if (!$cookie) { $cookie="publicuser_$oldest"; }
10511: } else {
1.463 albertel 10512: # if this isn't a robot, kill any existing non-robot sessions
10513: if (!$args->{'robot'}) {
10514: opendir(DIR,$lonids);
10515: while ($filename=readdir(DIR)) {
10516: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10517: unlink($lonids.'/'.$filename);
10518: }
1.462 albertel 10519: }
1.463 albertel 10520: closedir(DIR);
1.462 albertel 10521: }
10522: # Give them a new cookie
1.463 albertel 10523: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10524: : $now.$$.int(rand(10000)));
1.463 albertel 10525: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10526:
10527: # Initialize roles
10528:
10529: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10530: }
10531: # ------------------------------------ Check browser type and MathML capability
10532:
10533: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10534: $clientunicode,$clientos) = &decode_user_agent($r);
10535:
10536: # ------------------------------------------------------------- Get environment
10537:
10538: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10539: my ($tmp) = keys(%userenv);
10540: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10541: # default remote control to off
10542: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10543: } else {
10544: undef(%userenv);
10545: }
10546: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10547: $form->{'interface'}=$userenv{'interface'};
10548: }
10549: $env{'environment.remote'}=$userenv{'remote'};
10550: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10551:
10552: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10553: foreach my $option ('interface','localpath','localres') {
10554: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10555: }
10556: # --------------------------------------------------------- Write first profile
10557:
10558: {
10559: my %initial_env =
10560: ("user.name" => $username,
10561: "user.domain" => $domain,
10562: "user.home" => $authhost,
10563: "browser.type" => $clientbrowser,
10564: "browser.version" => $clientversion,
10565: "browser.mathml" => $clientmathml,
10566: "browser.unicode" => $clientunicode,
10567: "browser.os" => $clientos,
10568: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10569: "request.course.fn" => '',
10570: "request.course.uri" => '',
10571: "request.course.sec" => '',
10572: "request.role" => 'cm',
10573: "request.role.adv" => $env{'user.adv'},
10574: "request.host" => $ENV{'REMOTE_ADDR'},);
10575:
10576: if ($form->{'localpath'}) {
10577: $initial_env{"browser.localpath"} = $form->{'localpath'};
10578: $initial_env{"browser.localres"} = $form->{'localres'};
10579: }
10580:
10581: if ($public) {
10582: $initial_env{"environment.remote"} = "off";
10583: }
10584: if ($form->{'interface'}) {
10585: $form->{'interface'}=~s/\W//gs;
10586: $initial_env{"browser.interface"} = $form->{'interface'};
10587: $env{'browser.interface'}=$form->{'interface'};
10588: }
10589:
1.724 raeburn 10590: foreach my $tool ('aboutme','blog','portfolio') {
10591: $userenv{'availabletools.'.$tool} =
10592: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10593: }
10594:
1.864 raeburn 10595: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10596: $userenv{'canrequest.'.$crstype} =
10597: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10598: 'reload','requestcourses');
10599: }
10600:
1.462 albertel 10601: $env{'user.environment'} = "$lonids/$cookie.id";
10602:
10603: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10604: &GDBM_WRCREAT(),0640)) {
10605: &_add_to_env(\%disk_env,\%initial_env);
10606: &_add_to_env(\%disk_env,\%userenv,'environment.');
10607: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10608: if (ref($args->{'extra_env'})) {
10609: &_add_to_env(\%disk_env,$args->{'extra_env'});
10610: }
1.462 albertel 10611: untie(%disk_env);
10612: } else {
1.705 tempelho 10613: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10614: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10615: return 'error: '.$!;
10616: }
10617: }
10618: $env{'request.role'}='cm';
10619: $env{'request.role.adv'}=$env{'user.adv'};
10620: $env{'browser.type'}=$clientbrowser;
10621:
10622: return $cookie;
10623:
10624: }
10625:
10626: sub _add_to_env {
10627: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10628: if (ref($env_data) eq 'HASH') {
10629: while (my ($key,$value) = each(%$env_data)) {
10630: $idf->{$prefix.$key} = $value;
10631: $env{$prefix.$key} = $value;
10632: }
1.462 albertel 10633: }
10634: }
10635:
1.685 tempelho 10636: # --- Get the symbolic name of a problem and the url
10637: sub get_symb {
10638: my ($request,$silent) = @_;
1.726 raeburn 10639: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10640: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10641: if ($symb eq '') {
10642: if (!$silent) {
10643: $request->print("Unable to handle ambiguous references:$url:.");
10644: return ();
10645: }
10646: }
10647: &Apache::lonenc::check_decrypt(\$symb);
10648: return ($symb);
10649: }
10650:
10651: # --------------------------------------------------------------Get annotation
10652:
10653: sub get_annotation {
10654: my ($symb,$enc) = @_;
10655:
10656: my $key = $symb;
10657: if (!$enc) {
10658: $key =
10659: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10660: }
10661: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10662: return $annotation{$key};
10663: }
10664:
10665: sub clean_symb {
1.731 raeburn 10666: my ($symb,$delete_enc) = @_;
1.685 tempelho 10667:
10668: &Apache::lonenc::check_decrypt(\$symb);
10669: my $enc = $env{'request.enc'};
1.731 raeburn 10670: if ($delete_enc) {
1.730 raeburn 10671: delete($env{'request.enc'});
10672: }
1.685 tempelho 10673:
10674: return ($symb,$enc);
10675: }
1.462 albertel 10676:
1.41 ng 10677: =pod
10678:
10679: =back
10680:
1.112 bowersj2 10681: =cut
1.41 ng 10682:
1.112 bowersj2 10683: 1;
10684: __END__;
1.41 ng 10685:
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