Annotation of loncom/interface/loncommon.pm, revision 1.952
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.952 ! onken 4: # $Id: loncommon.pm,v 1.951 2010/03/16 13:16:15 onken 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.949 droeschl 1205: $stayOnPage = 1;
1.430 albertel 1206: my $output;
1207: if ($component_help) {
1208: if (!$text) {
1209: $output=&help_open_topic($component_help,undef,$stayOnPage,
1210: $width,$height);
1211: } else {
1212: my $help_text;
1213: $help_text=&unescape($topic);
1214: $output='<table><tr><td>'.
1215: &help_open_topic($component_help,$help_text,$stayOnPage,
1216: $width,$height).'</td></tr></table>';
1217: }
1218: }
1219: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1220: return $output.$banner_link;
1221: }
1222:
1223: sub top_nav_help {
1224: my ($text) = @_;
1.436 albertel 1225: $text = &mt($text);
1.949 droeschl 1226: my $stay_on_page = 1;
1227:
1.572 banghart 1228: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1229: : "javascript:helpMenu('open')";
1.572 banghart 1230: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1231:
1.201 raeburn 1232: my $title = &mt('Get help');
1.436 albertel 1233:
1234: return <<"END";
1235: $banner_link
1236: <a href="$link" title="$title">$text</a>
1237: END
1238: }
1239:
1240: sub help_menu_js {
1241: my ($text) = @_;
1.949 droeschl 1242: my $stayOnPage = 1;
1.436 albertel 1243: my $width = 620;
1244: my $height = 600;
1.430 albertel 1245: my $helptopic=&general_help();
1246: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1247: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1248: my $start_page =
1249: &Apache::loncommon::start_page('Help Menu', undef,
1250: {'frameset' => 1,
1251: 'js_ready' => 1,
1252: 'add_entries' => {
1253: 'border' => '0',
1.579 raeburn 1254: 'rows' => "110,*",},});
1.331 albertel 1255: my $end_page =
1256: &Apache::loncommon::end_page({'frameset' => 1,
1257: 'js_ready' => 1,});
1258:
1.436 albertel 1259: my $template .= <<"ENDTEMPLATE";
1260: <script type="text/javascript">
1.877 bisitz 1261: // <![CDATA[
1.253 albertel 1262: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1263: var banner_link = '';
1.243 raeburn 1264: function helpMenu(target) {
1265: var caller = this;
1266: if (target == 'open') {
1267: var newWindow = null;
1268: try {
1.262 albertel 1269: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1270: }
1271: catch(error) {
1272: writeHelp(caller);
1273: return;
1274: }
1275: if (newWindow) {
1276: caller = newWindow;
1277: }
1.193 raeburn 1278: }
1.243 raeburn 1279: writeHelp(caller);
1280: return;
1281: }
1282: function writeHelp(caller) {
1.430 albertel 1283: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1284: caller.document.close()
1285: caller.focus()
1.193 raeburn 1286: }
1.877 bisitz 1287: // END LON-CAPA Internal -->
1.253 albertel 1288: // ]]>
1.436 albertel 1289: </script>
1.193 raeburn 1290: ENDTEMPLATE
1291: return $template;
1292: }
1293:
1.172 www 1294: sub help_open_bug {
1295: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1296: unless ($env{'user.adv'}) { return ''; }
1.172 www 1297: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1298: $text = "" if (not defined $text);
1299: $stayOnPage=1;
1.184 albertel 1300: $width = 600 if (not defined $width);
1301: $height = 600 if (not defined $height);
1.172 www 1302:
1303: $topic=~s/\W+/\+/g;
1304: my $link='';
1305: my $template='';
1.379 albertel 1306: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1307: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1308: if (!$stayOnPage)
1309: {
1310: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1311: }
1312: else
1313: {
1314: $link = $url;
1315: }
1316: # Add the text
1317: if ($text ne "")
1318: {
1319: $template .=
1320: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1321: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1322: }
1323:
1324: # Add the graphic
1.179 matthew 1325: my $title = &mt('Report a Bug');
1.215 albertel 1326: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1327: $template .= <<"ENDTEMPLATE";
1.436 albertel 1328: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1329: ENDTEMPLATE
1330: if ($text ne '') { $template.='</td></tr></table>' };
1331: return $template;
1332:
1333: }
1334:
1335: sub help_open_faq {
1336: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1337: unless ($env{'user.adv'}) { return ''; }
1.172 www 1338: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1339: $text = "" if (not defined $text);
1340: $stayOnPage=1;
1341: $width = 350 if (not defined $width);
1342: $height = 400 if (not defined $height);
1343:
1344: $topic=~s/\W+/\+/g;
1345: my $link='';
1346: my $template='';
1347: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1348: if (!$stayOnPage)
1349: {
1350: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1351: }
1352: else
1353: {
1354: $link = $url;
1355: }
1356:
1357: # Add the text
1358: if ($text ne "")
1359: {
1360: $template .=
1.173 www 1361: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1362: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1363: }
1364:
1365: # Add the graphic
1.179 matthew 1366: my $title = &mt('View the FAQ');
1.215 albertel 1367: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1368: $template .= <<"ENDTEMPLATE";
1.436 albertel 1369: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1370: ENDTEMPLATE
1371: if ($text ne '') { $template.='</td></tr></table>' };
1372: return $template;
1373:
1.44 bowersj2 1374: }
1.37 matthew 1375:
1.180 matthew 1376: ###############################################################
1377: ###############################################################
1378:
1.45 matthew 1379: =pod
1380:
1.648 raeburn 1381: =item * &change_content_javascript():
1.256 matthew 1382:
1383: This and the next function allow you to create small sections of an
1384: otherwise static HTML page that you can update on the fly with
1385: Javascript, even in Netscape 4.
1386:
1387: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1388: must be written to the HTML page once. It will prove the Javascript
1389: function "change(name, content)". Calling the change function with the
1390: name of the section
1391: you want to update, matching the name passed to C<changable_area>, and
1392: the new content you want to put in there, will put the content into
1393: that area.
1394:
1395: B<Note>: Netscape 4 only reserves enough space for the changable area
1396: to contain room for the original contents. You need to "make space"
1397: for whatever changes you wish to make, and be B<sure> to check your
1398: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1399: it's adequate for updating a one-line status display, but little more.
1400: This script will set the space to 100% width, so you only need to
1401: worry about height in Netscape 4.
1402:
1403: Modern browsers are much less limiting, and if you can commit to the
1404: user not using Netscape 4, this feature may be used freely with
1405: pretty much any HTML.
1406:
1407: =cut
1408:
1409: sub change_content_javascript {
1410: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1411: if ($env{'browser.type'} eq 'netscape' &&
1412: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1413: return (<<NETSCAPE4);
1414: function change(name, content) {
1415: doc = document.layers[name+"___escape"].layers[0].document;
1416: doc.open();
1417: doc.write(content);
1418: doc.close();
1419: }
1420: NETSCAPE4
1421: } else {
1422: # Otherwise, we need to use semi-standards-compliant code
1423: # (technically, "innerHTML" isn't standard but the equivalent
1424: # is really scary, and every useful browser supports it
1425: return (<<DOMBASED);
1426: function change(name, content) {
1427: element = document.getElementById(name);
1428: element.innerHTML = content;
1429: }
1430: DOMBASED
1431: }
1432: }
1433:
1434: =pod
1435:
1.648 raeburn 1436: =item * &changable_area($name,$origContent):
1.256 matthew 1437:
1438: This provides a "changable area" that can be modified on the fly via
1439: the Javascript code provided in C<change_content_javascript>. $name is
1440: the name you will use to reference the area later; do not repeat the
1441: same name on a given HTML page more then once. $origContent is what
1442: the area will originally contain, which can be left blank.
1443:
1444: =cut
1445:
1446: sub changable_area {
1447: my ($name, $origContent) = @_;
1448:
1.258 albertel 1449: if ($env{'browser.type'} eq 'netscape' &&
1450: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1451: # If this is netscape 4, we need to use the Layer tag
1452: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1453: } else {
1454: return "<span id='$name'>$origContent</span>";
1455: }
1456: }
1457:
1458: =pod
1459:
1.648 raeburn 1460: =item * &viewport_geometry_js
1.590 raeburn 1461:
1462: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1463:
1464: =cut
1465:
1466:
1467: sub viewport_geometry_js {
1468: return <<"GEOMETRY";
1469: var Geometry = {};
1470: function init_geometry() {
1471: if (Geometry.init) { return };
1472: Geometry.init=1;
1473: if (window.innerHeight) {
1474: Geometry.getViewportHeight = function() { return window.innerHeight; };
1475: Geometry.getViewportWidth = function() { return window.innerWidth; };
1476: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1477: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1478: }
1479: else if (document.documentElement && document.documentElement.clientHeight) {
1480: Geometry.getViewportHeight =
1481: function() { return document.documentElement.clientHeight; };
1482: Geometry.getViewportWidth =
1483: function() { return document.documentElement.clientWidth; };
1484:
1485: Geometry.getHorizontalScroll =
1486: function() { return document.documentElement.scrollLeft; };
1487: Geometry.getVerticalScroll =
1488: function() { return document.documentElement.scrollTop; };
1489: }
1490: else if (document.body.clientHeight) {
1491: Geometry.getViewportHeight =
1492: function() { return document.body.clientHeight; };
1493: Geometry.getViewportWidth =
1494: function() { return document.body.clientWidth; };
1495: Geometry.getHorizontalScroll =
1496: function() { return document.body.scrollLeft; };
1497: Geometry.getVerticalScroll =
1498: function() { return document.body.scrollTop; };
1499: }
1500: }
1501:
1502: GEOMETRY
1503: }
1504:
1505: =pod
1506:
1.648 raeburn 1507: =item * &viewport_size_js()
1.590 raeburn 1508:
1509: 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.
1510:
1511: =cut
1512:
1513: sub viewport_size_js {
1514: my $geometry = &viewport_geometry_js();
1515: return <<"DIMS";
1516:
1517: $geometry
1518:
1519: function getViewportDims(width,height) {
1520: init_geometry();
1521: width.value = Geometry.getViewportWidth();
1522: height.value = Geometry.getViewportHeight();
1523: return;
1524: }
1525:
1526: DIMS
1527: }
1528:
1529: =pod
1530:
1.648 raeburn 1531: =item * &resize_textarea_js()
1.565 albertel 1532:
1533: emits the needed javascript to resize a textarea to be as big as possible
1534:
1535: creates a function resize_textrea that takes two IDs first should be
1536: the id of the element to resize, second should be the id of a div that
1537: surrounds everything that comes after the textarea, this routine needs
1538: to be attached to the <body> for the onload and onresize events.
1539:
1.648 raeburn 1540: =back
1.565 albertel 1541:
1542: =cut
1543:
1544: sub resize_textarea_js {
1.590 raeburn 1545: my $geometry = &viewport_geometry_js();
1.565 albertel 1546: return <<"RESIZE";
1547: <script type="text/javascript">
1.824 bisitz 1548: // <![CDATA[
1.590 raeburn 1549: $geometry
1.565 albertel 1550:
1.588 albertel 1551: function getX(element) {
1552: var x = 0;
1553: while (element) {
1554: x += element.offsetLeft;
1555: element = element.offsetParent;
1556: }
1557: return x;
1558: }
1559: function getY(element) {
1560: var y = 0;
1561: while (element) {
1562: y += element.offsetTop;
1563: element = element.offsetParent;
1564: }
1565: return y;
1566: }
1567:
1568:
1.565 albertel 1569: function resize_textarea(textarea_id,bottom_id) {
1570: init_geometry();
1571: var textarea = document.getElementById(textarea_id);
1572: //alert(textarea);
1573:
1.588 albertel 1574: var textarea_top = getY(textarea);
1.565 albertel 1575: var textarea_height = textarea.offsetHeight;
1576: var bottom = document.getElementById(bottom_id);
1.588 albertel 1577: var bottom_top = getY(bottom);
1.565 albertel 1578: var bottom_height = bottom.offsetHeight;
1579: var window_height = Geometry.getViewportHeight();
1.588 albertel 1580: var fudge = 23;
1.565 albertel 1581: var new_height = window_height-fudge-textarea_top-bottom_height;
1582: if (new_height < 300) {
1583: new_height = 300;
1584: }
1585: textarea.style.height=new_height+'px';
1586: }
1.824 bisitz 1587: // ]]>
1.565 albertel 1588: </script>
1589: RESIZE
1590:
1591: }
1592:
1593: =pod
1594:
1.256 matthew 1595: =head1 Excel and CSV file utility routines
1596:
1597: =over 4
1598:
1599: =cut
1600:
1601: ###############################################################
1602: ###############################################################
1603:
1604: =pod
1605:
1.648 raeburn 1606: =item * &csv_translate($text)
1.37 matthew 1607:
1.185 www 1608: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1609: format.
1610:
1611: =cut
1612:
1.180 matthew 1613: ###############################################################
1614: ###############################################################
1.37 matthew 1615: sub csv_translate {
1616: my $text = shift;
1617: $text =~ s/\"/\"\"/g;
1.209 albertel 1618: $text =~ s/\n/ /g;
1.37 matthew 1619: return $text;
1620: }
1.180 matthew 1621:
1622: ###############################################################
1623: ###############################################################
1624:
1625: =pod
1626:
1.648 raeburn 1627: =item * &define_excel_formats()
1.180 matthew 1628:
1629: Define some commonly used Excel cell formats.
1630:
1631: Currently supported formats:
1632:
1633: =over 4
1634:
1635: =item header
1636:
1637: =item bold
1638:
1639: =item h1
1640:
1641: =item h2
1642:
1643: =item h3
1644:
1.256 matthew 1645: =item h4
1646:
1647: =item i
1648:
1.180 matthew 1649: =item date
1650:
1651: =back
1652:
1653: Inputs: $workbook
1654:
1655: Returns: $format, a hash reference.
1656:
1657: =cut
1658:
1659: ###############################################################
1660: ###############################################################
1661: sub define_excel_formats {
1662: my ($workbook) = @_;
1663: my $format;
1664: $format->{'header'} = $workbook->add_format(bold => 1,
1665: bottom => 1,
1666: align => 'center');
1667: $format->{'bold'} = $workbook->add_format(bold=>1);
1668: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1669: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1670: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1671: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1672: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1673: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1674: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1675: return $format;
1676: }
1677:
1678: ###############################################################
1679: ###############################################################
1.113 bowersj2 1680:
1681: =pod
1682:
1.648 raeburn 1683: =item * &create_workbook()
1.255 matthew 1684:
1685: Create an Excel worksheet. If it fails, output message on the
1686: request object and return undefs.
1687:
1688: Inputs: Apache request object
1689:
1690: Returns (undef) on failure,
1691: Excel worksheet object, scalar with filename, and formats
1692: from &Apache::loncommon::define_excel_formats on success
1693:
1694: =cut
1695:
1696: ###############################################################
1697: ###############################################################
1698: sub create_workbook {
1699: my ($r) = @_;
1700: #
1701: # Create the excel spreadsheet
1702: my $filename = '/prtspool/'.
1.258 albertel 1703: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1704: time.'_'.rand(1000000000).'.xls';
1705: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1706: if (! defined($workbook)) {
1707: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1708: $r->print(
1709: '<p class="LC_error">'
1710: .&mt('Problems occurred in creating the new Excel file.')
1711: .' '.&mt('This error has been logged.')
1712: .' '.&mt('Please alert your LON-CAPA administrator.')
1713: .'</p>'
1714: );
1.255 matthew 1715: return (undef);
1716: }
1717: #
1718: $workbook->set_tempdir('/home/httpd/perl/tmp');
1719: #
1720: my $format = &Apache::loncommon::define_excel_formats($workbook);
1721: return ($workbook,$filename,$format);
1722: }
1723:
1724: ###############################################################
1725: ###############################################################
1726:
1727: =pod
1728:
1.648 raeburn 1729: =item * &create_text_file()
1.113 bowersj2 1730:
1.542 raeburn 1731: Create a file to write to and eventually make available to the user.
1.256 matthew 1732: If file creation fails, outputs an error message on the request object and
1733: return undefs.
1.113 bowersj2 1734:
1.256 matthew 1735: Inputs: Apache request object, and file suffix
1.113 bowersj2 1736:
1.256 matthew 1737: Returns (undef) on failure,
1738: Filehandle and filename on success.
1.113 bowersj2 1739:
1740: =cut
1741:
1.256 matthew 1742: ###############################################################
1743: ###############################################################
1744: sub create_text_file {
1745: my ($r,$suffix) = @_;
1746: if (! defined($suffix)) { $suffix = 'txt'; };
1747: my $fh;
1748: my $filename = '/prtspool/'.
1.258 albertel 1749: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1750: time.'_'.rand(1000000000).'.'.$suffix;
1751: $fh = Apache::File->new('>/home/httpd'.$filename);
1752: if (! defined($fh)) {
1753: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1754: $r->print(
1755: '<p class="LC_error">'
1756: .&mt('Problems occurred in creating the output file.')
1757: .' '.&mt('This error has been logged.')
1758: .' '.&mt('Please alert your LON-CAPA administrator.')
1759: .'</p>'
1760: );
1.113 bowersj2 1761: }
1.256 matthew 1762: return ($fh,$filename)
1.113 bowersj2 1763: }
1764:
1765:
1.256 matthew 1766: =pod
1.113 bowersj2 1767:
1768: =back
1769:
1770: =cut
1.37 matthew 1771:
1772: ###############################################################
1.33 matthew 1773: ## Home server <option> list generating code ##
1774: ###############################################################
1.35 matthew 1775:
1.169 www 1776: # ------------------------------------------
1777:
1778: sub domain_select {
1779: my ($name,$value,$multiple)=@_;
1780: my %domains=map {
1.514 albertel 1781: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1782: } &Apache::lonnet::all_domains();
1.169 www 1783: if ($multiple) {
1784: $domains{''}=&mt('Any domain');
1.550 albertel 1785: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1786: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1787: } else {
1.550 albertel 1788: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1789: return &select_form($name,$value,%domains);
1790: }
1791: }
1792:
1.282 albertel 1793: #-------------------------------------------
1794:
1795: =pod
1796:
1.519 raeburn 1797: =head1 Routines for form select boxes
1798:
1799: =over 4
1800:
1.648 raeburn 1801: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1802:
1803: Returns a string containing a <select> element int multiple mode
1804:
1805:
1806: Args:
1807: $name - name of the <select> element
1.506 raeburn 1808: $value - scalar or array ref of values that should already be selected
1.282 albertel 1809: $size - number of rows long the select element is
1.283 albertel 1810: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1811: (shown text should already have been &mt())
1.506 raeburn 1812: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1813:
1.282 albertel 1814: =cut
1815:
1816: #-------------------------------------------
1.169 www 1817: sub multiple_select_form {
1.284 albertel 1818: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1819: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1820: my $output='';
1.191 matthew 1821: if (! defined($size)) {
1822: $size = 4;
1.283 albertel 1823: if (scalar(keys(%$hash))<4) {
1824: $size = scalar(keys(%$hash));
1.191 matthew 1825: }
1826: }
1.734 bisitz 1827: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1828: my @order;
1.506 raeburn 1829: if (ref($order) eq 'ARRAY') {
1830: @order = @{$order};
1831: } else {
1832: @order = sort(keys(%$hash));
1.501 banghart 1833: }
1834: if (exists($$hash{'select_form_order'})) {
1835: @order = @{$$hash{'select_form_order'}};
1836: }
1837:
1.284 albertel 1838: foreach my $key (@order) {
1.356 albertel 1839: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1840: $output.='selected="selected" ' if ($selected{$key});
1841: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1842: }
1843: $output.="</select>\n";
1844: return $output;
1845: }
1846:
1.88 www 1847: #-------------------------------------------
1848:
1849: =pod
1850:
1.648 raeburn 1851: =item * &select_form($defdom,$name,%hash)
1.88 www 1852:
1853: Returns a string containing a <select name='$name' size='1'> form to
1854: allow a user to select options from a hash option_name => displayed text.
1855: See lonrights.pm for an example invocation and use.
1856:
1857: =cut
1858:
1859: #-------------------------------------------
1860: sub select_form {
1861: my ($def,$name,%hash) = @_;
1862: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1863: my @keys;
1864: if (exists($hash{'select_form_order'})) {
1865: @keys=@{$hash{'select_form_order'}};
1866: } else {
1867: @keys=sort(keys(%hash));
1868: }
1.356 albertel 1869: foreach my $key (@keys) {
1870: $selectform.=
1871: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1872: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1873: ">".$hash{$key}."</option>\n";
1.88 www 1874: }
1875: $selectform.="</select>";
1876: return $selectform;
1877: }
1878:
1.475 www 1879: # For display filters
1880:
1881: sub display_filter {
1882: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1883: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1884: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1885: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1886: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1887: '</label></span> <span class="LC_nobreak">'.
1.475 www 1888: &mt('Filter [_1]',
1.477 www 1889: &select_form($env{'form.displayfilter'},
1890: 'displayfilter',
1891: ('currentfolder' => 'Current folder/page',
1892: 'containing' => 'Containing phrase',
1893: 'none' => 'None'))).
1.714 bisitz 1894: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1895: }
1896:
1.167 www 1897: sub gradeleveldescription {
1898: my $gradelevel=shift;
1899: my %gradelevels=(0 => 'Not specified',
1900: 1 => 'Grade 1',
1901: 2 => 'Grade 2',
1902: 3 => 'Grade 3',
1903: 4 => 'Grade 4',
1904: 5 => 'Grade 5',
1905: 6 => 'Grade 6',
1906: 7 => 'Grade 7',
1907: 8 => 'Grade 8',
1908: 9 => 'Grade 9',
1909: 10 => 'Grade 10',
1910: 11 => 'Grade 11',
1911: 12 => 'Grade 12',
1912: 13 => 'Grade 13',
1913: 14 => '100 Level',
1914: 15 => '200 Level',
1915: 16 => '300 Level',
1916: 17 => '400 Level',
1917: 18 => 'Graduate Level');
1918: return &mt($gradelevels{$gradelevel});
1919: }
1920:
1.163 www 1921: sub select_level_form {
1922: my ($deflevel,$name)=@_;
1923: unless ($deflevel) { $deflevel=0; }
1.167 www 1924: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1925: for (my $i=0; $i<=18; $i++) {
1926: $selectform.="<option value=\"$i\" ".
1.253 albertel 1927: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1928: ">".&gradeleveldescription($i)."</option>\n";
1929: }
1930: $selectform.="</select>";
1931: return $selectform;
1.163 www 1932: }
1.167 www 1933:
1.35 matthew 1934: #-------------------------------------------
1935:
1.45 matthew 1936: =pod
1937:
1.910 raeburn 1938: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1939:
1940: Returns a string containing a <select name='$name' size='1'> form to
1941: allow a user to select the domain to preform an operation in.
1942: See loncreateuser.pm for an example invocation and use.
1943:
1.90 www 1944: If the $includeempty flag is set, it also includes an empty choice ("no domain
1945: selected");
1946:
1.743 raeburn 1947: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1948:
1.910 raeburn 1949: 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.
1950:
1951: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1952:
1.35 matthew 1953: =cut
1954:
1955: #-------------------------------------------
1.34 matthew 1956: sub select_dom_form {
1.910 raeburn 1957: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1958: if ($onchange) {
1.874 raeburn 1959: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1960: }
1.910 raeburn 1961: my @domains;
1962: if (ref($incdoms) eq 'ARRAY') {
1963: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1964: } else {
1965: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1966: }
1.90 www 1967: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1968: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1969: foreach my $dom (@domains) {
1970: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1971: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1972: if ($showdomdesc) {
1973: if ($dom ne '') {
1974: my $domdesc = &Apache::lonnet::domain($dom,'description');
1975: if ($domdesc ne '') {
1976: $selectdomain .= ' ('.$domdesc.')';
1977: }
1978: }
1979: }
1980: $selectdomain .= "</option>\n";
1.34 matthew 1981: }
1982: $selectdomain.="</select>";
1983: return $selectdomain;
1984: }
1985:
1.35 matthew 1986: #-------------------------------------------
1987:
1.45 matthew 1988: =pod
1989:
1.648 raeburn 1990: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1991:
1.586 raeburn 1992: input: 4 arguments (two required, two optional) -
1993: $domain - domain of new user
1994: $name - name of form element
1995: $default - Value of 'default' causes a default item to be first
1996: option, and selected by default.
1997: $hide - Value of 'hide' causes hiding of the name of the server,
1998: if 1 server found, or default, if 0 found.
1.594 raeburn 1999: output: returns 2 items:
1.586 raeburn 2000: (a) form element which contains either:
2001: (i) <select name="$name">
2002: <option value="$hostid1">$hostid $servers{$hostid}</option>
2003: <option value="$hostid2">$hostid $servers{$hostid}</option>
2004: </select>
2005: form item if there are multiple library servers in $domain, or
2006: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2007: if there is only one library server in $domain.
2008:
2009: (b) number of library servers found.
2010:
2011: See loncreateuser.pm for example of use.
1.35 matthew 2012:
2013: =cut
2014:
2015: #-------------------------------------------
1.586 raeburn 2016: sub home_server_form_item {
2017: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2018: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2019: my $result;
2020: my $numlib = keys(%servers);
2021: if ($numlib > 1) {
2022: $result .= '<select name="'.$name.'" />'."\n";
2023: if ($default) {
1.804 bisitz 2024: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2025: '</option>'."\n";
2026: }
2027: foreach my $hostid (sort(keys(%servers))) {
2028: $result.= '<option value="'.$hostid.'">'.
2029: $hostid.' '.$servers{$hostid}."</option>\n";
2030: }
2031: $result .= '</select>'."\n";
2032: } elsif ($numlib == 1) {
2033: my $hostid;
2034: foreach my $item (keys(%servers)) {
2035: $hostid = $item;
2036: }
2037: $result .= '<input type="hidden" name="'.$name.'" value="'.
2038: $hostid.'" />';
2039: if (!$hide) {
2040: $result .= $hostid.' '.$servers{$hostid};
2041: }
2042: $result .= "\n";
2043: } elsif ($default) {
2044: $result .= '<input type="hidden" name="'.$name.
2045: '" value="default" />';
2046: if (!$hide) {
2047: $result .= &mt('default');
2048: }
2049: $result .= "\n";
1.33 matthew 2050: }
1.586 raeburn 2051: return ($result,$numlib);
1.33 matthew 2052: }
1.112 bowersj2 2053:
2054: =pod
2055:
1.534 albertel 2056: =back
2057:
1.112 bowersj2 2058: =cut
1.87 matthew 2059:
2060: ###############################################################
1.112 bowersj2 2061: ## Decoding User Agent ##
1.87 matthew 2062: ###############################################################
2063:
2064: =pod
2065:
1.112 bowersj2 2066: =head1 Decoding the User Agent
2067:
2068: =over 4
2069:
2070: =item * &decode_user_agent()
1.87 matthew 2071:
2072: Inputs: $r
2073:
2074: Outputs:
2075:
2076: =over 4
2077:
1.112 bowersj2 2078: =item * $httpbrowser
1.87 matthew 2079:
1.112 bowersj2 2080: =item * $clientbrowser
1.87 matthew 2081:
1.112 bowersj2 2082: =item * $clientversion
1.87 matthew 2083:
1.112 bowersj2 2084: =item * $clientmathml
1.87 matthew 2085:
1.112 bowersj2 2086: =item * $clientunicode
1.87 matthew 2087:
1.112 bowersj2 2088: =item * $clientos
1.87 matthew 2089:
2090: =back
2091:
1.157 matthew 2092: =back
2093:
1.87 matthew 2094: =cut
2095:
2096: ###############################################################
2097: ###############################################################
2098: sub decode_user_agent {
1.247 albertel 2099: my ($r)=@_;
1.87 matthew 2100: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2101: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2102: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2103: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2104: my $clientbrowser='unknown';
2105: my $clientversion='0';
2106: my $clientmathml='';
2107: my $clientunicode='0';
2108: for (my $i=0;$i<=$#browsertype;$i++) {
2109: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2110: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2111: $clientbrowser=$bname;
2112: $httpbrowser=~/$vreg/i;
2113: $clientversion=$1;
2114: $clientmathml=($clientversion>=$minv);
2115: $clientunicode=($clientversion>=$univ);
2116: }
2117: }
2118: my $clientos='unknown';
2119: if (($httpbrowser=~/linux/i) ||
2120: ($httpbrowser=~/unix/i) ||
2121: ($httpbrowser=~/ux/i) ||
2122: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2123: if (($httpbrowser=~/vax/i) ||
2124: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2125: if ($httpbrowser=~/next/i) { $clientos='next'; }
2126: if (($httpbrowser=~/mac/i) ||
2127: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2128: if ($httpbrowser=~/win/i) { $clientos='win'; }
2129: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2130: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2131: $clientunicode,$clientos,);
2132: }
2133:
1.32 matthew 2134: ###############################################################
2135: ## Authentication changing form generation subroutines ##
2136: ###############################################################
2137: ##
2138: ## All of the authform_xxxxxxx subroutines take their inputs in a
2139: ## hash, and have reasonable default values.
2140: ##
2141: ## formname = the name given in the <form> tag.
1.35 matthew 2142: #-------------------------------------------
2143:
1.45 matthew 2144: =pod
2145:
1.112 bowersj2 2146: =head1 Authentication Routines
2147:
2148: =over 4
2149:
1.648 raeburn 2150: =item * &authform_xxxxxx()
1.35 matthew 2151:
2152: The authform_xxxxxx subroutines provide javascript and html forms which
2153: handle some of the conveniences required for authentication forms.
2154: This is not an optimal method, but it works.
2155:
2156: =over 4
2157:
1.112 bowersj2 2158: =item * authform_header
1.35 matthew 2159:
1.112 bowersj2 2160: =item * authform_authorwarning
1.35 matthew 2161:
1.112 bowersj2 2162: =item * authform_nochange
1.35 matthew 2163:
1.112 bowersj2 2164: =item * authform_kerberos
1.35 matthew 2165:
1.112 bowersj2 2166: =item * authform_internal
1.35 matthew 2167:
1.112 bowersj2 2168: =item * authform_filesystem
1.35 matthew 2169:
2170: =back
2171:
1.648 raeburn 2172: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2173:
1.35 matthew 2174: =cut
2175:
2176: #-------------------------------------------
1.32 matthew 2177: sub authform_header{
2178: my %in = (
2179: formname => 'cu',
1.80 albertel 2180: kerb_def_dom => '',
1.32 matthew 2181: @_,
2182: );
2183: $in{'formname'} = 'document.' . $in{'formname'};
2184: my $result='';
1.80 albertel 2185:
2186: #---------------------------------------------- Code for upper case translation
2187: my $Javascript_toUpperCase;
2188: unless ($in{kerb_def_dom}) {
2189: $Javascript_toUpperCase =<<"END";
2190: switch (choice) {
2191: case 'krb': currentform.elements[choicearg].value =
2192: currentform.elements[choicearg].value.toUpperCase();
2193: break;
2194: default:
2195: }
2196: END
2197: } else {
2198: $Javascript_toUpperCase = "";
2199: }
2200:
1.165 raeburn 2201: my $radioval = "'nochange'";
1.591 raeburn 2202: if (defined($in{'curr_authtype'})) {
2203: if ($in{'curr_authtype'} ne '') {
2204: $radioval = "'".$in{'curr_authtype'}."arg'";
2205: }
1.174 matthew 2206: }
1.165 raeburn 2207: my $argfield = 'null';
1.591 raeburn 2208: if (defined($in{'mode'})) {
1.165 raeburn 2209: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2210: if (defined($in{'curr_autharg'})) {
2211: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2212: $argfield = "'$in{'curr_autharg'}'";
2213: }
2214: }
2215: }
2216: }
2217:
1.32 matthew 2218: $result.=<<"END";
2219: var current = new Object();
1.165 raeburn 2220: current.radiovalue = $radioval;
2221: current.argfield = $argfield;
1.32 matthew 2222:
2223: function changed_radio(choice,currentform) {
2224: var choicearg = choice + 'arg';
2225: // If a radio button in changed, we need to change the argfield
2226: if (current.radiovalue != choice) {
2227: current.radiovalue = choice;
2228: if (current.argfield != null) {
2229: currentform.elements[current.argfield].value = '';
2230: }
2231: if (choice == 'nochange') {
2232: current.argfield = null;
2233: } else {
2234: current.argfield = choicearg;
2235: switch(choice) {
2236: case 'krb':
2237: currentform.elements[current.argfield].value =
2238: "$in{'kerb_def_dom'}";
2239: break;
2240: default:
2241: break;
2242: }
2243: }
2244: }
2245: return;
2246: }
1.22 www 2247:
1.32 matthew 2248: function changed_text(choice,currentform) {
2249: var choicearg = choice + 'arg';
2250: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2251: $Javascript_toUpperCase
1.32 matthew 2252: // clear old field
2253: if ((current.argfield != choicearg) && (current.argfield != null)) {
2254: currentform.elements[current.argfield].value = '';
2255: }
2256: current.argfield = choicearg;
2257: }
2258: set_auth_radio_buttons(choice,currentform);
2259: return;
1.20 www 2260: }
1.32 matthew 2261:
2262: function set_auth_radio_buttons(newvalue,currentform) {
2263: var i=0;
2264: while (i < currentform.login.length) {
2265: if (currentform.login[i].value == newvalue) { break; }
2266: i++;
2267: }
2268: if (i == currentform.login.length) {
2269: return;
2270: }
2271: current.radiovalue = newvalue;
2272: currentform.login[i].checked = true;
2273: return;
2274: }
2275: END
2276: return $result;
2277: }
2278:
2279: sub authform_authorwarning{
2280: my $result='';
1.144 matthew 2281: $result='<i>'.
2282: &mt('As a general rule, only authors or co-authors should be '.
2283: 'filesystem authenticated '.
2284: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2285: return $result;
2286: }
2287:
2288: sub authform_nochange{
2289: my %in = (
2290: formname => 'document.cu',
2291: kerb_def_dom => 'MSU.EDU',
2292: @_,
2293: );
1.586 raeburn 2294: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2295: my $result;
2296: if (keys(%can_assign) == 0) {
2297: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2298: } else {
2299: $result = '<label>'.&mt('[_1] Do not change login data',
2300: '<input type="radio" name="login" value="nochange" '.
2301: 'checked="checked" onclick="'.
1.281 albertel 2302: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2303: '</label>';
1.586 raeburn 2304: }
1.32 matthew 2305: return $result;
2306: }
2307:
1.591 raeburn 2308: sub authform_kerberos {
1.32 matthew 2309: my %in = (
2310: formname => 'document.cu',
2311: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2312: kerb_def_auth => 'krb4',
1.32 matthew 2313: @_,
2314: );
1.586 raeburn 2315: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2316: $autharg,$jscall);
2317: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2318: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2319: $check5 = ' checked="checked"';
1.80 albertel 2320: } else {
1.772 bisitz 2321: $check4 = ' checked="checked"';
1.80 albertel 2322: }
1.165 raeburn 2323: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2324: if (defined($in{'curr_authtype'})) {
2325: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2326: $krbcheck = ' checked="checked"';
1.623 raeburn 2327: if (defined($in{'mode'})) {
2328: if ($in{'mode'} eq 'modifyuser') {
2329: $krbcheck = '';
2330: }
2331: }
1.591 raeburn 2332: if (defined($in{'curr_kerb_ver'})) {
2333: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2334: $check5 = ' checked="checked"';
1.591 raeburn 2335: $check4 = '';
2336: } else {
1.772 bisitz 2337: $check4 = ' checked="checked"';
1.591 raeburn 2338: $check5 = '';
2339: }
1.586 raeburn 2340: }
1.591 raeburn 2341: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2342: $krbarg = $in{'curr_autharg'};
2343: }
1.586 raeburn 2344: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2345: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2346: $result =
2347: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2348: $in{'curr_autharg'},$krbver);
2349: } else {
2350: $result =
2351: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2352: }
2353: return $result;
2354: }
2355: }
2356: } else {
2357: if ($authnum == 1) {
1.784 bisitz 2358: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2359: }
2360: }
1.586 raeburn 2361: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2362: return;
1.587 raeburn 2363: } elsif ($authtype eq '') {
1.591 raeburn 2364: if (defined($in{'mode'})) {
1.587 raeburn 2365: if ($in{'mode'} eq 'modifycourse') {
2366: if ($authnum == 1) {
1.784 bisitz 2367: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2368: }
2369: }
2370: }
1.586 raeburn 2371: }
2372: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2373: if ($authtype eq '') {
2374: $authtype = '<input type="radio" name="login" value="krb" '.
2375: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2376: $krbcheck.' />';
2377: }
2378: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2379: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2380: $in{'curr_authtype'} eq 'krb5') ||
2381: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2382: $in{'curr_authtype'} eq 'krb4')) {
2383: $result .= &mt
1.144 matthew 2384: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2385: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2386: '<label>'.$authtype,
1.281 albertel 2387: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2388: 'value="'.$krbarg.'" '.
1.144 matthew 2389: 'onchange="'.$jscall.'" />',
1.281 albertel 2390: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2391: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2392: '</label>');
1.586 raeburn 2393: } elsif ($can_assign{'krb4'}) {
2394: $result .= &mt
2395: ('[_1] Kerberos authenticated with domain [_2] '.
2396: '[_3] Version 4 [_4]',
2397: '<label>'.$authtype,
2398: '</label><input type="text" size="10" name="krbarg" '.
2399: 'value="'.$krbarg.'" '.
2400: 'onchange="'.$jscall.'" />',
2401: '<label><input type="hidden" name="krbver" value="4" />',
2402: '</label>');
2403: } elsif ($can_assign{'krb5'}) {
2404: $result .= &mt
2405: ('[_1] Kerberos authenticated with domain [_2] '.
2406: '[_3] Version 5 [_4]',
2407: '<label>'.$authtype,
2408: '</label><input type="text" size="10" name="krbarg" '.
2409: 'value="'.$krbarg.'" '.
2410: 'onchange="'.$jscall.'" />',
2411: '<label><input type="hidden" name="krbver" value="5" />',
2412: '</label>');
2413: }
1.32 matthew 2414: return $result;
2415: }
2416:
2417: sub authform_internal{
1.586 raeburn 2418: my %in = (
1.32 matthew 2419: formname => 'document.cu',
2420: kerb_def_dom => 'MSU.EDU',
2421: @_,
2422: );
1.586 raeburn 2423: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2424: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2425: if (defined($in{'curr_authtype'})) {
2426: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2427: if ($can_assign{'int'}) {
1.772 bisitz 2428: $intcheck = 'checked="checked" ';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $intcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2435: $intarg = $in{'curr_autharg'};
2436: }
2437: } else {
2438: $result = &mt('Currently internally authenticated.');
2439: return $result;
1.165 raeburn 2440: }
2441: }
1.586 raeburn 2442: } else {
2443: if ($authnum == 1) {
1.784 bisitz 2444: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2445: }
2446: }
2447: if (!$can_assign{'int'}) {
2448: return;
1.587 raeburn 2449: } elsif ($authtype eq '') {
1.591 raeburn 2450: if (defined($in{'mode'})) {
1.587 raeburn 2451: if ($in{'mode'} eq 'modifycourse') {
2452: if ($authnum == 1) {
1.784 bisitz 2453: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2454: }
2455: }
2456: }
1.165 raeburn 2457: }
1.586 raeburn 2458: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2459: if ($authtype eq '') {
2460: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2461: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2462: }
1.605 bisitz 2463: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2464: $intarg.'" onchange="'.$jscall.'" />';
2465: $result = &mt
1.144 matthew 2466: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2467: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2468: $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 2469: return $result;
2470: }
2471:
2472: sub authform_local{
2473: my %in = (
2474: formname => 'document.cu',
2475: kerb_def_dom => 'MSU.EDU',
2476: @_,
2477: );
1.586 raeburn 2478: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2479: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2480: if (defined($in{'curr_authtype'})) {
2481: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2482: if ($can_assign{'loc'}) {
1.772 bisitz 2483: $loccheck = 'checked="checked" ';
1.623 raeburn 2484: if (defined($in{'mode'})) {
2485: if ($in{'mode'} eq 'modifyuser') {
2486: $loccheck = '';
2487: }
2488: }
1.591 raeburn 2489: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2490: $locarg = $in{'curr_autharg'};
2491: }
2492: } else {
2493: $result = &mt('Currently using local (institutional) authentication.');
2494: return $result;
1.165 raeburn 2495: }
2496: }
1.586 raeburn 2497: } else {
2498: if ($authnum == 1) {
1.784 bisitz 2499: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2500: }
2501: }
2502: if (!$can_assign{'loc'}) {
2503: return;
1.587 raeburn 2504: } elsif ($authtype eq '') {
1.591 raeburn 2505: if (defined($in{'mode'})) {
1.587 raeburn 2506: if ($in{'mode'} eq 'modifycourse') {
2507: if ($authnum == 1) {
1.784 bisitz 2508: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2509: }
2510: }
2511: }
1.165 raeburn 2512: }
1.586 raeburn 2513: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2514: if ($authtype eq '') {
2515: $authtype = '<input type="radio" name="login" value="loc" '.
2516: $loccheck.' onchange="'.$jscall.'" onclick="'.
2517: $jscall.'" />';
2518: }
2519: $autharg = '<input type="text" size="10" name="locarg" value="'.
2520: $locarg.'" onchange="'.$jscall.'" />';
2521: $result = &mt('[_1] Local Authentication with argument [_2]',
2522: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2523: return $result;
2524: }
2525:
2526: sub authform_filesystem{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2533: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2534: if (defined($in{'curr_authtype'})) {
2535: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2536: if ($can_assign{'fsys'}) {
1.772 bisitz 2537: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $fsyscheck = '';
2541: }
2542: }
1.586 raeburn 2543: } else {
2544: $result = &mt('Currently Filesystem Authenticated.');
2545: return $result;
2546: }
2547: }
2548: } else {
2549: if ($authnum == 1) {
1.784 bisitz 2550: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2551: }
2552: }
2553: if (!$can_assign{'fsys'}) {
2554: return;
1.587 raeburn 2555: } elsif ($authtype eq '') {
1.591 raeburn 2556: if (defined($in{'mode'})) {
1.587 raeburn 2557: if ($in{'mode'} eq 'modifycourse') {
2558: if ($authnum == 1) {
1.784 bisitz 2559: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2560: }
2561: }
2562: }
1.586 raeburn 2563: }
2564: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2565: if ($authtype eq '') {
2566: $authtype = '<input type="radio" name="login" value="fsys" '.
2567: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2568: $jscall.'" />';
2569: }
2570: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2571: ' onchange="'.$jscall.'" />';
2572: $result = &mt
1.144 matthew 2573: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2574: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2575: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2576: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2577: 'onchange="'.$jscall.'" />');
1.32 matthew 2578: return $result;
2579: }
2580:
1.586 raeburn 2581: sub get_assignable_auth {
2582: my ($dom) = @_;
2583: if ($dom eq '') {
2584: $dom = $env{'request.role.domain'};
2585: }
2586: my %can_assign = (
2587: krb4 => 1,
2588: krb5 => 1,
2589: int => 1,
2590: loc => 1,
2591: );
2592: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2593: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2594: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2595: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2596: my $context;
2597: if ($env{'request.role'} =~ /^au/) {
2598: $context = 'author';
2599: } elsif ($env{'request.role'} =~ /^dc/) {
2600: $context = 'domain';
2601: } elsif ($env{'request.course.id'}) {
2602: $context = 'course';
2603: }
2604: if ($context) {
2605: if (ref($authhash->{$context}) eq 'HASH') {
2606: %can_assign = %{$authhash->{$context}};
2607: }
2608: }
2609: }
2610: }
2611: my $authnum = 0;
2612: foreach my $key (keys(%can_assign)) {
2613: if ($can_assign{$key}) {
2614: $authnum ++;
2615: }
2616: }
2617: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2618: $authnum --;
2619: }
2620: return ($authnum,%can_assign);
2621: }
2622:
1.80 albertel 2623: ###############################################################
2624: ## Get Kerberos Defaults for Domain ##
2625: ###############################################################
2626: ##
2627: ## Returns default kerberos version and an associated argument
2628: ## as listed in file domain.tab. If not listed, provides
2629: ## appropriate default domain and kerberos version.
2630: ##
2631: #-------------------------------------------
2632:
2633: =pod
2634:
1.648 raeburn 2635: =item * &get_kerberos_defaults()
1.80 albertel 2636:
2637: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2638: version and domain. If not found, it defaults to version 4 and the
2639: domain of the server.
1.80 albertel 2640:
1.648 raeburn 2641: =over 4
2642:
1.80 albertel 2643: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2644:
1.648 raeburn 2645: =back
2646:
2647: =back
2648:
1.80 albertel 2649: =cut
2650:
2651: #-------------------------------------------
2652: sub get_kerberos_defaults {
2653: my $domain=shift;
1.641 raeburn 2654: my ($krbdef,$krbdefdom);
2655: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2656: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2657: $krbdef = $domdefaults{'auth_def'};
2658: $krbdefdom = $domdefaults{'auth_arg_def'};
2659: } else {
1.80 albertel 2660: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2661: my $krbdefdom=$1;
2662: $krbdefdom=~tr/a-z/A-Z/;
2663: $krbdef = "krb4";
2664: }
2665: return ($krbdef,$krbdefdom);
2666: }
1.112 bowersj2 2667:
1.32 matthew 2668:
1.46 matthew 2669: ###############################################################
2670: ## Thesaurus Functions ##
2671: ###############################################################
1.20 www 2672:
1.46 matthew 2673: =pod
1.20 www 2674:
1.112 bowersj2 2675: =head1 Thesaurus Functions
2676:
2677: =over 4
2678:
1.648 raeburn 2679: =item * &initialize_keywords()
1.46 matthew 2680:
2681: Initializes the package variable %Keywords if it is empty. Uses the
2682: package variable $thesaurus_db_file.
2683:
2684: =cut
2685:
2686: ###################################################
2687:
2688: sub initialize_keywords {
2689: return 1 if (scalar keys(%Keywords));
2690: # If we are here, %Keywords is empty, so fill it up
2691: # Make sure the file we need exists...
2692: if (! -e $thesaurus_db_file) {
2693: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2694: " failed because it does not exist");
2695: return 0;
2696: }
2697: # Set up the hash as a database
2698: my %thesaurus_db;
2699: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2700: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2701: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2702: $thesaurus_db_file);
2703: return 0;
2704: }
2705: # Get the average number of appearances of a word.
2706: my $avecount = $thesaurus_db{'average.count'};
2707: # Put keywords (those that appear > average) into %Keywords
2708: while (my ($word,$data)=each (%thesaurus_db)) {
2709: my ($count,undef) = split /:/,$data;
2710: $Keywords{$word}++ if ($count > $avecount);
2711: }
2712: untie %thesaurus_db;
2713: # Remove special values from %Keywords.
1.356 albertel 2714: foreach my $value ('total.count','average.count') {
2715: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2716: }
1.46 matthew 2717: return 1;
2718: }
2719:
2720: ###################################################
2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &keyword($word)
1.46 matthew 2725:
2726: Returns true if $word is a keyword. A keyword is a word that appears more
2727: than the average number of times in the thesaurus database. Calls
2728: &initialize_keywords
2729:
2730: =cut
2731:
2732: ###################################################
1.20 www 2733:
2734: sub keyword {
1.46 matthew 2735: return if (!&initialize_keywords());
2736: my $word=lc(shift());
2737: $word=~s/\W//g;
2738: return exists($Keywords{$word});
1.20 www 2739: }
1.46 matthew 2740:
2741: ###############################################################
2742:
2743: =pod
1.20 www 2744:
1.648 raeburn 2745: =item * &get_related_words()
1.46 matthew 2746:
1.160 matthew 2747: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2748: an array of words. If the keyword is not in the thesaurus, an empty array
2749: will be returned. The order of the words returned is determined by the
2750: database which holds them.
2751:
2752: Uses global $thesaurus_db_file.
2753:
2754: =cut
2755:
2756: ###############################################################
2757: sub get_related_words {
2758: my $keyword = shift;
2759: my %thesaurus_db;
2760: if (! -e $thesaurus_db_file) {
2761: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2762: "failed because the file does not exist");
2763: return ();
2764: }
2765: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2766: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2767: return ();
2768: }
2769: my @Words=();
1.429 www 2770: my $count=0;
1.46 matthew 2771: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2772: # The first element is the number of times
2773: # the word appears. We do not need it now.
1.429 www 2774: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2775: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2776: my $threshold=$mostfrequentcount/10;
2777: foreach my $possibleword (@RelatedWords) {
2778: my ($word,$wordcount)=split(/\,/,$possibleword);
2779: if ($wordcount>$threshold) {
2780: push(@Words,$word);
2781: $count++;
2782: if ($count>10) { last; }
2783: }
1.20 www 2784: }
2785: }
1.46 matthew 2786: untie %thesaurus_db;
2787: return @Words;
1.14 harris41 2788: }
1.46 matthew 2789:
1.112 bowersj2 2790: =pod
2791:
2792: =back
2793:
2794: =cut
1.61 www 2795:
2796: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2797: =pod
2798:
1.112 bowersj2 2799: =head1 User Name Functions
2800:
2801: =over 4
2802:
1.648 raeburn 2803: =item * &plainname($uname,$udom,$first)
1.81 albertel 2804:
1.112 bowersj2 2805: Takes a users logon name and returns it as a string in
1.226 albertel 2806: "first middle last generation" form
2807: if $first is set to 'lastname' then it returns it as
2808: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2809:
2810: =cut
1.61 www 2811:
1.295 www 2812:
1.81 albertel 2813: ###############################################################
1.61 www 2814: sub plainname {
1.226 albertel 2815: my ($uname,$udom,$first)=@_;
1.537 albertel 2816: return if (!defined($uname) || !defined($udom));
1.295 www 2817: my %names=&getnames($uname,$udom);
1.226 albertel 2818: my $name=&Apache::lonnet::format_name($names{'firstname'},
2819: $names{'middlename'},
2820: $names{'lastname'},
2821: $names{'generation'},$first);
2822: $name=~s/^\s+//;
1.62 www 2823: $name=~s/\s+$//;
2824: $name=~s/\s+/ /g;
1.353 albertel 2825: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2826: return $name;
1.61 www 2827: }
1.66 www 2828:
2829: # -------------------------------------------------------------------- Nickname
1.81 albertel 2830: =pod
2831:
1.648 raeburn 2832: =item * &nickname($uname,$udom)
1.81 albertel 2833:
2834: Gets a users name and returns it as a string as
2835:
2836: ""nickname""
1.66 www 2837:
1.81 albertel 2838: if the user has a nickname or
2839:
2840: "first middle last generation"
2841:
2842: if the user does not
2843:
2844: =cut
1.66 www 2845:
2846: sub nickname {
2847: my ($uname,$udom)=@_;
1.537 albertel 2848: return if (!defined($uname) || !defined($udom));
1.295 www 2849: my %names=&getnames($uname,$udom);
1.68 albertel 2850: my $name=$names{'nickname'};
1.66 www 2851: if ($name) {
2852: $name='"'.$name.'"';
2853: } else {
2854: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2855: $names{'lastname'}.' '.$names{'generation'};
2856: $name=~s/\s+$//;
2857: $name=~s/\s+/ /g;
2858: }
2859: return $name;
2860: }
2861:
1.295 www 2862: sub getnames {
2863: my ($uname,$udom)=@_;
1.537 albertel 2864: return if (!defined($uname) || !defined($udom));
1.433 albertel 2865: if ($udom eq 'public' && $uname eq 'public') {
2866: return ('lastname' => &mt('Public'));
2867: }
1.295 www 2868: my $id=$uname.':'.$udom;
2869: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2870: if ($cached) {
2871: return %{$names};
2872: } else {
2873: my %loadnames=&Apache::lonnet::get('environment',
2874: ['firstname','middlename','lastname','generation','nickname'],
2875: $udom,$uname);
2876: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2877: return %loadnames;
2878: }
2879: }
1.61 www 2880:
1.542 raeburn 2881: # -------------------------------------------------------------------- getemails
1.648 raeburn 2882:
1.542 raeburn 2883: =pod
2884:
1.648 raeburn 2885: =item * &getemails($uname,$udom)
1.542 raeburn 2886:
2887: Gets a user's email information and returns it as a hash with keys:
2888: notification, critnotification, permanentemail
2889:
2890: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2891: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2892:
1.648 raeburn 2893:
1.542 raeburn 2894: =cut
2895:
1.648 raeburn 2896:
1.466 albertel 2897: sub getemails {
2898: my ($uname,$udom)=@_;
2899: if ($udom eq 'public' && $uname eq 'public') {
2900: return;
2901: }
1.467 www 2902: if (!$udom) { $udom=$env{'user.domain'}; }
2903: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2904: my $id=$uname.':'.$udom;
2905: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2906: if ($cached) {
2907: return %{$names};
2908: } else {
2909: my %loadnames=&Apache::lonnet::get('environment',
2910: ['notification','critnotification',
2911: 'permanentemail'],
2912: $udom,$uname);
2913: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2914: return %loadnames;
2915: }
2916: }
2917:
1.551 albertel 2918: sub flush_email_cache {
2919: my ($uname,$udom)=@_;
2920: if (!$udom) { $udom =$env{'user.domain'}; }
2921: if (!$uname) { $uname=$env{'user.name'}; }
2922: return if ($udom eq 'public' && $uname eq 'public');
2923: my $id=$uname.':'.$udom;
2924: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2925: }
2926:
1.728 raeburn 2927: # -------------------------------------------------------------------- getlangs
2928:
2929: =pod
2930:
2931: =item * &getlangs($uname,$udom)
2932:
2933: Gets a user's language preference and returns it as a hash with key:
2934: language.
2935:
2936: =cut
2937:
2938:
2939: sub getlangs {
2940: my ($uname,$udom) = @_;
2941: if (!$udom) { $udom =$env{'user.domain'}; }
2942: if (!$uname) { $uname=$env{'user.name'}; }
2943: my $id=$uname.':'.$udom;
2944: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2945: if ($cached) {
2946: return %{$langs};
2947: } else {
2948: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2949: $udom,$uname);
2950: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2951: return %loadlangs;
2952: }
2953: }
2954:
2955: sub flush_langs_cache {
2956: my ($uname,$udom)=@_;
2957: if (!$udom) { $udom =$env{'user.domain'}; }
2958: if (!$uname) { $uname=$env{'user.name'}; }
2959: return if ($udom eq 'public' && $uname eq 'public');
2960: my $id=$uname.':'.$udom;
2961: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2962: }
2963:
1.61 www 2964: # ------------------------------------------------------------------ Screenname
1.81 albertel 2965:
2966: =pod
2967:
1.648 raeburn 2968: =item * &screenname($uname,$udom)
1.81 albertel 2969:
2970: Gets a users screenname and returns it as a string
2971:
2972: =cut
1.61 www 2973:
2974: sub screenname {
2975: my ($uname,$udom)=@_;
1.258 albertel 2976: if ($uname eq $env{'user.name'} &&
2977: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2978: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2979: return $names{'screenname'};
1.62 www 2980: }
2981:
1.212 albertel 2982:
1.802 bisitz 2983: # ------------------------------------------------------------- Confirm Wrapper
2984: =pod
2985:
2986: =item confirmwrapper
2987:
2988: Wrap messages about completion of operation in box
2989:
2990: =cut
2991:
2992: sub confirmwrapper {
2993: my ($message)=@_;
2994: if ($message) {
2995: return "\n".'<div class="LC_confirm_box">'."\n"
2996: .$message."\n"
2997: .'</div>'."\n";
2998: } else {
2999: return $message;
3000: }
3001: }
3002:
1.62 www 3003: # ------------------------------------------------------------- Message Wrapper
3004:
3005: sub messagewrapper {
1.369 www 3006: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3007: return
1.441 albertel 3008: '<a href="/adm/email?compose=individual&'.
3009: 'recname='.$username.'&recdom='.$domain.
3010: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3011: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3012: }
1.802 bisitz 3013:
1.74 www 3014: # --------------------------------------------------------------- Notes Wrapper
3015:
3016: sub noteswrapper {
3017: my ($link,$un,$do)=@_;
3018: return
1.896 amueller 3019: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3020: }
1.802 bisitz 3021:
1.62 www 3022: # ------------------------------------------------------------- Aboutme Wrapper
3023:
3024: sub aboutmewrapper {
1.166 www 3025: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3026: if (!defined($username) && !defined($domain)) {
3027: return;
3028: }
1.892 amueller 3029: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3030: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3031: }
3032:
3033: # ------------------------------------------------------------ Syllabus Wrapper
3034:
3035: sub syllabuswrapper {
1.707 bisitz 3036: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3037: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3038: }
1.14 harris41 3039:
1.802 bisitz 3040: # -----------------------------------------------------------------------------
3041:
1.208 matthew 3042: sub track_student_link {
1.887 raeburn 3043: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3044: my $link ="/adm/trackstudent?";
1.208 matthew 3045: my $title = 'View recent activity';
3046: if (defined($sname) && $sname !~ /^\s*$/ &&
3047: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3048: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3049: $title .= ' of this student';
1.268 albertel 3050: }
1.208 matthew 3051: if (defined($target) && $target !~ /^\s*$/) {
3052: $target = qq{target="$target"};
3053: } else {
3054: $target = '';
3055: }
1.268 albertel 3056: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3057: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3058: $title = &mt($title);
3059: $linktext = &mt($linktext);
1.448 albertel 3060: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3061: &help_open_topic('View_recent_activity');
1.208 matthew 3062: }
3063:
1.781 raeburn 3064: sub slot_reservations_link {
3065: my ($linktext,$sname,$sdom,$target) = @_;
3066: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3067: my $title = 'View slot reservation history';
3068: if (defined($sname) && $sname !~ /^\s*$/ &&
3069: defined($sdom) && $sdom !~ /^\s*$/) {
3070: $link .= "&uname=$sname&udom=$sdom";
3071: $title .= ' of this student';
3072: }
3073: if (defined($target) && $target !~ /^\s*$/) {
3074: $target = qq{target="$target"};
3075: } else {
3076: $target = '';
3077: }
3078: $title = &mt($title);
3079: $linktext = &mt($linktext);
3080: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3081: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3082:
3083: }
3084:
1.508 www 3085: # ===================================================== Display a student photo
3086:
3087:
1.509 albertel 3088: sub student_image_tag {
1.508 www 3089: my ($domain,$user)=@_;
3090: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3091: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3092: return '<img src="'.$imgsrc.'" align="right" />';
3093: } else {
3094: return '';
3095: }
3096: }
3097:
1.112 bowersj2 3098: =pod
3099:
3100: =back
3101:
3102: =head1 Access .tab File Data
3103:
3104: =over 4
3105:
1.648 raeburn 3106: =item * &languageids()
1.112 bowersj2 3107:
3108: returns list of all language ids
3109:
3110: =cut
3111:
1.14 harris41 3112: sub languageids {
1.16 harris41 3113: return sort(keys(%language));
1.14 harris41 3114: }
3115:
1.112 bowersj2 3116: =pod
3117:
1.648 raeburn 3118: =item * &languagedescription()
1.112 bowersj2 3119:
3120: returns description of a specified language id
3121:
3122: =cut
3123:
1.14 harris41 3124: sub languagedescription {
1.125 www 3125: my $code=shift;
3126: return ($supported_language{$code}?'* ':'').
3127: $language{$code}.
1.126 www 3128: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3129: }
3130:
3131: sub plainlanguagedescription {
3132: my $code=shift;
3133: return $language{$code};
3134: }
3135:
3136: sub supportedlanguagecode {
3137: my $code=shift;
3138: return $supported_language{$code};
1.97 www 3139: }
3140:
1.112 bowersj2 3141: =pod
3142:
1.648 raeburn 3143: =item * ©rightids()
1.112 bowersj2 3144:
3145: returns list of all copyrights
3146:
3147: =cut
3148:
3149: sub copyrightids {
3150: return sort(keys(%cprtag));
3151: }
3152:
3153: =pod
3154:
1.648 raeburn 3155: =item * ©rightdescription()
1.112 bowersj2 3156:
3157: returns description of a specified copyright id
3158:
3159: =cut
3160:
3161: sub copyrightdescription {
1.166 www 3162: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3163: }
1.197 matthew 3164:
3165: =pod
3166:
1.648 raeburn 3167: =item * &source_copyrightids()
1.192 taceyjo1 3168:
3169: returns list of all source copyrights
3170:
3171: =cut
3172:
3173: sub source_copyrightids {
3174: return sort(keys(%scprtag));
3175: }
3176:
3177: =pod
3178:
1.648 raeburn 3179: =item * &source_copyrightdescription()
1.192 taceyjo1 3180:
3181: returns description of a specified source copyright id
3182:
3183: =cut
3184:
3185: sub source_copyrightdescription {
3186: return &mt($scprtag{shift(@_)});
3187: }
1.112 bowersj2 3188:
3189: =pod
3190:
1.648 raeburn 3191: =item * &filecategories()
1.112 bowersj2 3192:
3193: returns list of all file categories
3194:
3195: =cut
3196:
3197: sub filecategories {
3198: return sort(keys(%category_extensions));
3199: }
3200:
3201: =pod
3202:
1.648 raeburn 3203: =item * &filecategorytypes()
1.112 bowersj2 3204:
3205: returns list of file types belonging to a given file
3206: category
3207:
3208: =cut
3209:
3210: sub filecategorytypes {
1.356 albertel 3211: my ($cat) = @_;
3212: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &fileembstyle()
1.112 bowersj2 3218:
3219: returns embedding style for a specified file type
3220:
3221: =cut
3222:
3223: sub fileembstyle {
3224: return $fe{lc(shift(@_))};
1.169 www 3225: }
3226:
1.351 www 3227: sub filemimetype {
3228: return $fm{lc(shift(@_))};
3229: }
3230:
1.169 www 3231:
3232: sub filecategoryselect {
3233: my ($name,$value)=@_;
1.189 matthew 3234: return &select_form($value,$name,
1.169 www 3235: '' => &mt('Any category'),
3236: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3237: }
3238:
3239: =pod
3240:
1.648 raeburn 3241: =item * &filedescription()
1.112 bowersj2 3242:
3243: returns description for a specified file type
3244:
3245: =cut
3246:
3247: sub filedescription {
1.188 matthew 3248: my $file_description = $fd{lc(shift())};
3249: $file_description =~ s:([\[\]]):~$1:g;
3250: return &mt($file_description);
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescriptionex()
1.112 bowersj2 3256:
3257: returns description for a specified file type with
3258: extra formatting
3259:
3260: =cut
3261:
3262: sub filedescriptionex {
3263: my $ex=shift;
1.188 matthew 3264: my $file_description = $fd{lc($ex)};
3265: $file_description =~ s:([\[\]]):~$1:g;
3266: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3267: }
3268:
3269: # End of .tab access
3270: =pod
3271:
3272: =back
3273:
3274: =cut
3275:
3276: # ------------------------------------------------------------------ File Types
3277: sub fileextensions {
3278: return sort(keys(%fe));
3279: }
3280:
1.97 www 3281: # ----------------------------------------------------------- Display Languages
3282: # returns a hash with all desired display languages
3283: #
3284:
3285: sub display_languages {
3286: my %languages=();
1.695 raeburn 3287: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3288: $languages{$lang}=1;
1.97 www 3289: }
3290: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3291: if ($env{'form.displaylanguage'}) {
1.356 albertel 3292: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3293: $languages{$lang}=1;
1.97 www 3294: }
3295: }
3296: return %languages;
1.14 harris41 3297: }
3298:
1.582 albertel 3299: sub languages {
3300: my ($possible_langs) = @_;
1.695 raeburn 3301: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3302: if (!ref($possible_langs)) {
3303: if( wantarray ) {
3304: return @preferred_langs;
3305: } else {
3306: return $preferred_langs[0];
3307: }
3308: }
3309: my %possibilities = map { $_ => 1 } (@$possible_langs);
3310: my @preferred_possibilities;
3311: foreach my $preferred_lang (@preferred_langs) {
3312: if (exists($possibilities{$preferred_lang})) {
3313: push(@preferred_possibilities, $preferred_lang);
3314: }
3315: }
3316: if( wantarray ) {
3317: return @preferred_possibilities;
3318: }
3319: return $preferred_possibilities[0];
3320: }
3321:
1.742 raeburn 3322: sub user_lang {
3323: my ($touname,$toudom,$fromcid) = @_;
3324: my @userlangs;
3325: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3326: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3327: $env{'course.'.$fromcid.'.languages'}));
3328: } else {
3329: my %langhash = &getlangs($touname,$toudom);
3330: if ($langhash{'languages'} ne '') {
3331: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3332: } else {
3333: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3334: if ($domdefs{'lang_def'} ne '') {
3335: @userlangs = ($domdefs{'lang_def'});
3336: }
3337: }
3338: }
3339: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3340: my $user_lh = Apache::localize->get_handle(@languages);
3341: return $user_lh;
3342: }
3343:
3344:
1.112 bowersj2 3345: ###############################################################
3346: ## Student Answer Attempts ##
3347: ###############################################################
3348:
3349: =pod
3350:
3351: =head1 Alternate Problem Views
3352:
3353: =over 4
3354:
1.648 raeburn 3355: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3356: $getattempt, $regexp, $gradesub)
3357:
3358: Return string with previous attempt on problem. Arguments:
3359:
3360: =over 4
3361:
3362: =item * $symb: Problem, including path
3363:
3364: =item * $username: username of the desired student
3365:
3366: =item * $domain: domain of the desired student
1.14 harris41 3367:
1.112 bowersj2 3368: =item * $course: Course ID
1.14 harris41 3369:
1.112 bowersj2 3370: =item * $getattempt: Leave blank for all attempts, otherwise put
3371: something
1.14 harris41 3372:
1.112 bowersj2 3373: =item * $regexp: if string matches this regexp, the string will be
3374: sent to $gradesub
1.14 harris41 3375:
1.112 bowersj2 3376: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3377:
1.112 bowersj2 3378: =back
1.14 harris41 3379:
1.112 bowersj2 3380: The output string is a table containing all desired attempts, if any.
1.16 harris41 3381:
1.112 bowersj2 3382: =cut
1.1 albertel 3383:
3384: sub get_previous_attempt {
1.43 ng 3385: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3386: my $prevattempts='';
1.43 ng 3387: no strict 'refs';
1.1 albertel 3388: if ($symb) {
1.3 albertel 3389: my (%returnhash)=
3390: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3391: if ($returnhash{'version'}) {
3392: my %lasthash=();
3393: my $version;
3394: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3395: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3396: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3397: }
1.1 albertel 3398: }
1.596 albertel 3399: $prevattempts=&start_data_table().&start_data_table_header_row();
3400: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3401: my %typeparts;
3402: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3403: foreach my $key (sort(keys(%lasthash))) {
3404: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3405: if ($#parts > 0) {
1.31 albertel 3406: my $data=$parts[-1];
3407: pop(@parts);
1.945 raeburn 3408: if ($data eq 'type') {
3409: unless ($showsurv) {
3410: my $id = join(',',@parts);
3411: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3412: }
3413: delete($lasthash{$key});
3414: } else {
3415: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3416: }
1.31 albertel 3417: } else {
1.41 ng 3418: if ($#parts == 0) {
3419: $prevattempts.='<th>'.$parts[0].'</th>';
3420: } else {
3421: $prevattempts.='<th>'.$ign.'</th>';
3422: }
1.31 albertel 3423: }
1.16 harris41 3424: }
1.596 albertel 3425: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3426: my %lasthidden;
1.40 ng 3427: if ($getattempt eq '') {
3428: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3429: my @hidden;
3430: if (%typeparts) {
3431: foreach my $id (keys(%typeparts)) {
3432: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3433: push(@hidden,$id);
3434: $lasthidden{$id} = 1;
3435: } elsif ($lasthidden{$id}) {
3436: if (exists($returnhash{$version.':'.$id.'.award'})) {
3437: delete($lasthidden{$id});
3438: }
3439: }
3440: }
3441: }
3442: $prevattempts.=&start_data_table_row().
3443: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3444: if (@hidden) {
3445: foreach my $key (sort(keys(%lasthash))) {
3446: my $hide;
3447: foreach my $id (@hidden) {
3448: if ($key =~ /^\Q$id\E/) {
3449: $hide = 1;
3450: last;
3451: }
3452: }
3453: if ($hide) {
3454: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3455: if (($data eq 'award') || ($data eq 'awarddetail')) {
3456: my $value = &format_previous_attempt_value($key,
3457: $returnhash{$version.':'.$key});
3458: $prevattempts.='<td>'.$value.' </td>';
3459: } else {
3460: $prevattempts.='<td> </td>';
3461: }
3462: } else {
3463: if ($key =~ /\./) {
3464: my $value = &format_previous_attempt_value($key,
3465: $returnhash{$version.':'.$key});
3466: $prevattempts.='<td>'.$value.' </td>';
3467: } else {
3468: $prevattempts.='<td> </td>';
3469: }
3470: }
3471: }
3472: } else {
3473: foreach my $key (sort(keys(%lasthash))) {
3474: my $value = &format_previous_attempt_value($key,
3475: $returnhash{$version.':'.$key});
3476: $prevattempts.='<td>'.$value.' </td>';
3477: }
3478: }
3479: $prevattempts.=&end_data_table_row();
1.40 ng 3480: }
1.1 albertel 3481: }
1.945 raeburn 3482: my @currhidden = keys(%lasthidden);
1.596 albertel 3483: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3484: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3485: if (%typeparts) {
3486: my $hidden;
3487: foreach my $id (@currhidden) {
3488: if ($key =~ /^\Q$id\E/) {
3489: $hidden = 1;
3490: last;
3491: }
3492: }
3493: if ($hidden) {
3494: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3495: if (($data eq 'award') || ($data eq 'awarddetail')) {
3496: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3497: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3498: $value = &$gradesub($value);
3499: }
3500: $prevattempts.='<td>'.$value.' </td>';
3501: } else {
3502: $prevattempts.='<td> </td>';
3503: }
3504: } else {
3505: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3506: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3507: $value = &$gradesub($value);
3508: }
3509: $prevattempts.='<td>'.$value.' </td>';
3510: }
3511: } else {
3512: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3513: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3514: $value = &$gradesub($value);
3515: }
3516: $prevattempts.='<td>'.$value.' </td>';
3517: }
1.16 harris41 3518: }
1.596 albertel 3519: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3520: } else {
1.596 albertel 3521: $prevattempts=
3522: &start_data_table().&start_data_table_row().
3523: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3524: &end_data_table_row().&end_data_table();
1.1 albertel 3525: }
3526: } else {
1.596 albertel 3527: $prevattempts=
3528: &start_data_table().&start_data_table_row().
3529: '<td>'.&mt('No data.').'</td>'.
3530: &end_data_table_row().&end_data_table();
1.1 albertel 3531: }
1.10 albertel 3532: }
3533:
1.581 albertel 3534: sub format_previous_attempt_value {
3535: my ($key,$value) = @_;
3536: if ($key =~ /timestamp/) {
3537: $value = &Apache::lonlocal::locallocaltime($value);
3538: } elsif (ref($value) eq 'ARRAY') {
3539: $value = '('.join(', ', @{ $value }).')';
3540: } else {
3541: $value = &unescape($value);
3542: }
3543: return $value;
3544: }
3545:
3546:
1.107 albertel 3547: sub relative_to_absolute {
3548: my ($url,$output)=@_;
3549: my $parser=HTML::TokeParser->new(\$output);
3550: my $token;
3551: my $thisdir=$url;
3552: my @rlinks=();
3553: while ($token=$parser->get_token) {
3554: if ($token->[0] eq 'S') {
3555: if ($token->[1] eq 'a') {
3556: if ($token->[2]->{'href'}) {
3557: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3558: }
3559: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3560: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3561: } elsif ($token->[1] eq 'base') {
3562: $thisdir=$token->[2]->{'href'};
3563: }
3564: }
3565: }
3566: $thisdir=~s-/[^/]*$--;
1.356 albertel 3567: foreach my $link (@rlinks) {
1.726 raeburn 3568: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3569: ($link=~/^\//) ||
3570: ($link=~/^javascript:/i) ||
3571: ($link=~/^mailto:/i) ||
3572: ($link=~/^\#/)) {
3573: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3574: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3575: }
3576: }
3577: # -------------------------------------------------- Deal with Applet codebases
3578: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3579: return $output;
3580: }
3581:
1.112 bowersj2 3582: =pod
3583:
1.648 raeburn 3584: =item * &get_student_view()
1.112 bowersj2 3585:
3586: show a snapshot of what student was looking at
3587:
3588: =cut
3589:
1.10 albertel 3590: sub get_student_view {
1.186 albertel 3591: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3592: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3593: my (%form);
1.10 albertel 3594: my @elements=('symb','courseid','domain','username');
3595: foreach my $element (@elements) {
1.186 albertel 3596: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3597: }
1.186 albertel 3598: if (defined($moreenv)) {
3599: %form=(%form,%{$moreenv});
3600: }
1.236 albertel 3601: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3602: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3603: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3604: $userview=~s/\<body[^\>]*\>//gi;
3605: $userview=~s/\<\/body\>//gi;
3606: $userview=~s/\<html\>//gi;
3607: $userview=~s/\<\/html\>//gi;
3608: $userview=~s/\<head\>//gi;
3609: $userview=~s/\<\/head\>//gi;
3610: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3611: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3612: if (wantarray) {
3613: return ($userview,$response);
3614: } else {
3615: return $userview;
3616: }
3617: }
3618:
3619: sub get_student_view_with_retries {
3620: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3621:
3622: my $ok = 0; # True if we got a good response.
3623: my $content;
3624: my $response;
3625:
3626: # Try to get the student_view done. within the retries count:
3627:
3628: do {
3629: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3630: $ok = $response->is_success;
3631: if (!$ok) {
3632: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3633: }
3634: $retries--;
3635: } while (!$ok && ($retries > 0));
3636:
3637: if (!$ok) {
3638: $content = ''; # On error return an empty content.
3639: }
1.651 www 3640: if (wantarray) {
3641: return ($content, $response);
3642: } else {
3643: return $content;
3644: }
1.11 albertel 3645: }
3646:
1.112 bowersj2 3647: =pod
3648:
1.648 raeburn 3649: =item * &get_student_answers()
1.112 bowersj2 3650:
3651: show a snapshot of how student was answering problem
3652:
3653: =cut
3654:
1.11 albertel 3655: sub get_student_answers {
1.100 sakharuk 3656: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3657: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3658: my (%moreenv);
1.11 albertel 3659: my @elements=('symb','courseid','domain','username');
3660: foreach my $element (@elements) {
1.186 albertel 3661: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3662: }
1.186 albertel 3663: $moreenv{'grade_target'}='answer';
3664: %moreenv=(%form,%moreenv);
1.497 raeburn 3665: $feedurl = &Apache::lonnet::clutter($feedurl);
3666: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3667: return $userview;
1.1 albertel 3668: }
1.116 albertel 3669:
3670: =pod
3671:
3672: =item * &submlink()
3673:
1.242 albertel 3674: Inputs: $text $uname $udom $symb $target
1.116 albertel 3675:
3676: Returns: A link to grades.pm such as to see the SUBM view of a student
3677:
3678: =cut
3679:
3680: ###############################################
3681: sub submlink {
1.242 albertel 3682: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3683: if (!($uname && $udom)) {
3684: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3685: &Apache::lonnet::whichuser($symb);
1.116 albertel 3686: if (!$symb) { $symb=$cursymb; }
3687: }
1.254 matthew 3688: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3689: $symb=&escape($symb);
1.242 albertel 3690: if ($target) { $target="target=\"$target\""; }
3691: return '<a href="/adm/grades?&command=submission&'.
3692: 'symb='.$symb.'&student='.$uname.
3693: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3694: }
3695: ##############################################
3696:
3697: =pod
3698:
3699: =item * &pgrdlink()
3700:
3701: Inputs: $text $uname $udom $symb $target
3702:
3703: Returns: A link to grades.pm such as to see the PGRD view of a student
3704:
3705: =cut
3706:
3707: ###############################################
3708: sub pgrdlink {
3709: my $link=&submlink(@_);
3710: $link=~s/(&command=submission)/$1&showgrading=yes/;
3711: return $link;
3712: }
3713: ##############################################
3714:
3715: =pod
3716:
3717: =item * &pprmlink()
3718:
3719: Inputs: $text $uname $udom $symb $target
3720:
3721: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3722: student and a specific resource
1.242 albertel 3723:
3724: =cut
3725:
3726: ###############################################
3727: sub pprmlink {
3728: my ($text,$uname,$udom,$symb,$target)=@_;
3729: if (!($uname && $udom)) {
3730: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3731: &Apache::lonnet::whichuser($symb);
1.242 albertel 3732: if (!$symb) { $symb=$cursymb; }
3733: }
1.254 matthew 3734: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3735: $symb=&escape($symb);
1.242 albertel 3736: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3737: return '<a href="/adm/parmset?command=set&'.
3738: 'symb='.$symb.'&uname='.$uname.
3739: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3740: }
3741: ##############################################
1.37 matthew 3742:
1.112 bowersj2 3743: =pod
3744:
3745: =back
3746:
3747: =cut
3748:
1.37 matthew 3749: ###############################################
1.51 www 3750:
3751:
3752: sub timehash {
1.687 raeburn 3753: my ($thistime) = @_;
3754: my $timezone = &Apache::lonlocal::gettimezone();
3755: my $dt = DateTime->from_epoch(epoch => $thistime)
3756: ->set_time_zone($timezone);
3757: my $wday = $dt->day_of_week();
3758: if ($wday == 7) { $wday = 0; }
3759: return ( 'second' => $dt->second(),
3760: 'minute' => $dt->minute(),
3761: 'hour' => $dt->hour(),
3762: 'day' => $dt->day_of_month(),
3763: 'month' => $dt->month(),
3764: 'year' => $dt->year(),
3765: 'weekday' => $wday,
3766: 'dayyear' => $dt->day_of_year(),
3767: 'dlsav' => $dt->is_dst() );
1.51 www 3768: }
3769:
1.370 www 3770: sub utc_string {
3771: my ($date)=@_;
1.371 www 3772: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3773: }
3774:
1.51 www 3775: sub maketime {
3776: my %th=@_;
1.687 raeburn 3777: my ($epoch_time,$timezone,$dt);
3778: $timezone = &Apache::lonlocal::gettimezone();
3779: eval {
3780: $dt = DateTime->new( year => $th{'year'},
3781: month => $th{'month'},
3782: day => $th{'day'},
3783: hour => $th{'hour'},
3784: minute => $th{'minute'},
3785: second => $th{'second'},
3786: time_zone => $timezone,
3787: );
3788: };
3789: if (!$@) {
3790: $epoch_time = $dt->epoch;
3791: if ($epoch_time) {
3792: return $epoch_time;
3793: }
3794: }
1.51 www 3795: return POSIX::mktime(
3796: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3797: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3798: }
3799:
3800: #########################################
1.51 www 3801:
3802: sub findallcourses {
1.482 raeburn 3803: my ($roles,$uname,$udom) = @_;
1.355 albertel 3804: my %roles;
3805: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3806: my %courses;
1.51 www 3807: my $now=time;
1.482 raeburn 3808: if (!defined($uname)) {
3809: $uname = $env{'user.name'};
3810: }
3811: if (!defined($udom)) {
3812: $udom = $env{'user.domain'};
3813: }
3814: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3815: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3816: if (!%roles) {
3817: %roles = (
3818: cc => 1,
1.907 raeburn 3819: co => 1,
1.482 raeburn 3820: in => 1,
3821: ep => 1,
3822: ta => 1,
3823: cr => 1,
3824: st => 1,
3825: );
3826: }
3827: foreach my $entry (keys(%roleshash)) {
3828: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3829: if ($trole =~ /^cr/) {
3830: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3831: } else {
3832: next if (!exists($roles{$trole}));
3833: }
3834: if ($tend) {
3835: next if ($tend < $now);
3836: }
3837: if ($tstart) {
3838: next if ($tstart > $now);
3839: }
3840: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3841: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3842: if ($secpart eq '') {
3843: ($cnum,$role) = split(/_/,$cnumpart);
3844: $sec = 'none';
3845: $realsec = '';
3846: } else {
3847: $cnum = $cnumpart;
3848: ($sec,$role) = split(/_/,$secpart);
3849: $realsec = $sec;
1.490 raeburn 3850: }
1.482 raeburn 3851: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3852: }
3853: } else {
3854: foreach my $key (keys(%env)) {
1.483 albertel 3855: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3856: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3857: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3858: next if ($role eq 'ca' || $role eq 'aa');
3859: next if (%roles && !exists($roles{$role}));
3860: my ($starttime,$endtime)=split(/\./,$env{$key});
3861: my $active=1;
3862: if ($starttime) {
3863: if ($now<$starttime) { $active=0; }
3864: }
3865: if ($endtime) {
3866: if ($now>$endtime) { $active=0; }
3867: }
3868: if ($active) {
3869: if ($sec eq '') {
3870: $sec = 'none';
3871: }
3872: $courses{$cdom.'_'.$cnum}{$sec} =
3873: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3874: }
3875: }
1.51 www 3876: }
3877: }
1.474 raeburn 3878: return %courses;
1.51 www 3879: }
1.37 matthew 3880:
1.54 www 3881: ###############################################
1.474 raeburn 3882:
3883: sub blockcheck {
1.482 raeburn 3884: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3885:
3886: if (!defined($udom)) {
3887: $udom = $env{'user.domain'};
3888: }
3889: if (!defined($uname)) {
3890: $uname = $env{'user.name'};
3891: }
3892:
3893: # If uname and udom are for a course, check for blocks in the course.
3894:
3895: if (&Apache::lonnet::is_course($udom,$uname)) {
3896: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3897: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3898: return ($startblock,$endblock);
3899: }
1.474 raeburn 3900:
1.502 raeburn 3901: my $startblock = 0;
3902: my $endblock = 0;
1.482 raeburn 3903: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3904:
1.490 raeburn 3905: # If uname is for a user, and activity is course-specific, i.e.,
3906: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3907:
1.490 raeburn 3908: if (($activity eq 'boards' || $activity eq 'chat' ||
3909: $activity eq 'groups') && ($env{'request.course.id'})) {
3910: foreach my $key (keys(%live_courses)) {
3911: if ($key ne $env{'request.course.id'}) {
3912: delete($live_courses{$key});
3913: }
3914: }
3915: }
3916:
3917: my $otheruser = 0;
3918: my %own_courses;
3919: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3920: # Resource belongs to user other than current user.
3921: $otheruser = 1;
3922: # Gather courses for current user
3923: %own_courses =
3924: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3925: }
3926:
3927: # Gather active course roles - course coordinator, instructor,
3928: # exam proctor, ta, student, or custom role.
1.474 raeburn 3929:
3930: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3931: my ($cdom,$cnum);
3932: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3933: $cdom = $env{'course.'.$course.'.domain'};
3934: $cnum = $env{'course.'.$course.'.num'};
3935: } else {
1.490 raeburn 3936: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3937: }
3938: my $no_ownblock = 0;
3939: my $no_userblock = 0;
1.533 raeburn 3940: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3941: # Check if current user has 'evb' priv for this
3942: if (defined($own_courses{$course})) {
3943: foreach my $sec (keys(%{$own_courses{$course}})) {
3944: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3945: if ($sec ne 'none') {
3946: $checkrole .= '/'.$sec;
3947: }
3948: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3949: $no_ownblock = 1;
3950: last;
3951: }
3952: }
3953: }
3954: # if they have 'evb' priv and are currently not playing student
3955: next if (($no_ownblock) &&
3956: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3957: }
1.474 raeburn 3958: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3959: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3960: if ($sec ne 'none') {
1.482 raeburn 3961: $checkrole .= '/'.$sec;
1.474 raeburn 3962: }
1.490 raeburn 3963: if ($otheruser) {
3964: # Resource belongs to user other than current user.
3965: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3966: my ($trole,$tdom,$tnum,$tsec);
3967: my $entry = $live_courses{$course}{$sec};
3968: if ($entry =~ /^cr/) {
3969: ($trole,$tdom,$tnum,$tsec) =
3970: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3971: } else {
3972: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3973: }
3974: my ($spec,$area,$trest,%allroles,%userroles);
3975: $area = '/'.$tdom.'/'.$tnum;
3976: $trest = $tnum;
3977: if ($tsec ne '') {
3978: $area .= '/'.$tsec;
3979: $trest .= '/'.$tsec;
3980: }
3981: $spec = $trole.'.'.$area;
3982: if ($trole =~ /^cr/) {
3983: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3984: $tdom,$spec,$trest,$area);
3985: } else {
3986: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3987: $tdom,$spec,$trest,$area);
3988: }
3989: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3990: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3991: if ($1) {
3992: $no_userblock = 1;
3993: last;
3994: }
3995: }
1.490 raeburn 3996: } else {
3997: # Resource belongs to current user
3998: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3999: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4000: $no_ownblock = 1;
4001: last;
4002: }
1.474 raeburn 4003: }
4004: }
4005: # if they have the evb priv and are currently not playing student
1.482 raeburn 4006: next if (($no_ownblock) &&
1.491 albertel 4007: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4008: next if ($no_userblock);
1.474 raeburn 4009:
1.866 kalberla 4010: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4011: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4012:
4013: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4014: if (($start != 0) &&
4015: (($startblock == 0) || ($startblock > $start))) {
4016: $startblock = $start;
4017: }
4018: if (($end != 0) &&
4019: (($endblock == 0) || ($endblock < $end))) {
4020: $endblock = $end;
4021: }
1.490 raeburn 4022: }
4023: return ($startblock,$endblock);
4024: }
4025:
4026: sub get_blocks {
4027: my ($setters,$activity,$cdom,$cnum) = @_;
4028: my $startblock = 0;
4029: my $endblock = 0;
4030: my $course = $cdom.'_'.$cnum;
4031: $setters->{$course} = {};
4032: $setters->{$course}{'staff'} = [];
4033: $setters->{$course}{'times'} = [];
4034: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4035: foreach my $record (keys(%records)) {
4036: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4037: if ($start <= time && $end >= time) {
4038: my ($staff_name,$staff_dom,$title,$blocks) =
4039: &parse_block_record($records{$record});
4040: if ($blocks->{$activity} eq 'on') {
4041: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4042: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4043: if ( ($startblock == 0) || ($startblock > $start) ) {
4044: $startblock = $start;
1.490 raeburn 4045: }
1.491 albertel 4046: if ( ($endblock == 0) || ($endblock < $end) ) {
4047: $endblock = $end;
1.474 raeburn 4048: }
4049: }
4050: }
4051: }
4052: return ($startblock,$endblock);
4053: }
4054:
4055: sub parse_block_record {
4056: my ($record) = @_;
4057: my ($setuname,$setudom,$title,$blocks);
4058: if (ref($record) eq 'HASH') {
4059: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4060: $title = &unescape($record->{'event'});
4061: $blocks = $record->{'blocks'};
4062: } else {
4063: my @data = split(/:/,$record,3);
4064: if (scalar(@data) eq 2) {
4065: $title = $data[1];
4066: ($setuname,$setudom) = split(/@/,$data[0]);
4067: } else {
4068: ($setuname,$setudom,$title) = @data;
4069: }
4070: $blocks = { 'com' => 'on' };
4071: }
4072: return ($setuname,$setudom,$title,$blocks);
4073: }
4074:
1.854 kalberla 4075: sub blocking_status {
4076: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4077: my %setters;
1.890 droeschl 4078:
4079: # check for active blocking
1.867 kalberla 4080: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4081:
1.890 droeschl 4082: my $blocked = $startblock && $endblock ? 1 : 0;
4083:
4084: # caller just wants to know whether a block is active
4085: if (!wantarray) { return $blocked; }
4086:
4087: # build a link to a popup window containing the details
4088: my $querystring = "?activity=$activity";
4089: # $uname and $udom decide whose portfolio the user is trying to look at
4090: $querystring .= "&udom=$udom" if $udom;
4091: $querystring .= "&uname=$uname" if $uname;
4092:
4093: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4094: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4095: var options = "width=" + w + ",height=" + h + ",";
4096: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4097: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4098: var newWin = window.open(url, wdwName, options);
4099: newWin.focus();
4100: }
1.890 droeschl 4101: END_MYBLOCK
1.854 kalberla 4102:
1.890 droeschl 4103: $output = Apache::lonhtmlcommon::scripttag($output);
4104:
1.854 kalberla 4105: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4106: my $text = mt('Communication Blocked');
4107:
1.867 kalberla 4108: $output .= <<"END_BLOCK";
4109: <div class='LC_comblock'>
1.869 kalberla 4110: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4111: title='$text'>
4112: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4113: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4114: title='$text'>$text</a>
1.867 kalberla 4115: </div>
4116:
4117: END_BLOCK
1.474 raeburn 4118:
1.854 kalberla 4119: return ($blocked, $output);
4120: }
1.490 raeburn 4121:
1.60 matthew 4122: ###############################################
4123:
1.682 raeburn 4124: sub check_ip_acc {
4125: my ($acc)=@_;
4126: &Apache::lonxml::debug("acc is $acc");
4127: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4128: return 1;
4129: }
4130: my $allowed=0;
4131: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4132:
4133: my $name;
4134: foreach my $pattern (split(',',$acc)) {
4135: $pattern =~ s/^\s*//;
4136: $pattern =~ s/\s*$//;
4137: if ($pattern =~ /\*$/) {
4138: #35.8.*
4139: $pattern=~s/\*//;
4140: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4141: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4142: #35.8.3.[34-56]
4143: my $low=$2;
4144: my $high=$3;
4145: $pattern=$1;
4146: if ($ip =~ /^\Q$pattern\E/) {
4147: my $last=(split(/\./,$ip))[3];
4148: if ($last <=$high && $last >=$low) { $allowed=1; }
4149: }
4150: } elsif ($pattern =~ /^\*/) {
4151: #*.msu.edu
4152: $pattern=~s/\*//;
4153: if (!defined($name)) {
4154: use Socket;
4155: my $netaddr=inet_aton($ip);
4156: ($name)=gethostbyaddr($netaddr,AF_INET);
4157: }
4158: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4159: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4160: #127.0.0.1
4161: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4162: } else {
4163: #some.name.com
4164: if (!defined($name)) {
4165: use Socket;
4166: my $netaddr=inet_aton($ip);
4167: ($name)=gethostbyaddr($netaddr,AF_INET);
4168: }
4169: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4170: }
4171: if ($allowed) { last; }
4172: }
4173: return $allowed;
4174: }
4175:
4176: ###############################################
4177:
1.60 matthew 4178: =pod
4179:
1.112 bowersj2 4180: =head1 Domain Template Functions
4181:
4182: =over 4
4183:
4184: =item * &determinedomain()
1.60 matthew 4185:
4186: Inputs: $domain (usually will be undef)
4187:
1.63 www 4188: Returns: Determines which domain should be used for designs
1.60 matthew 4189:
4190: =cut
1.54 www 4191:
1.60 matthew 4192: ###############################################
1.63 www 4193: sub determinedomain {
4194: my $domain=shift;
1.531 albertel 4195: if (! $domain) {
1.60 matthew 4196: # Determine domain if we have not been given one
1.893 raeburn 4197: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4198: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4199: if ($env{'request.role.domain'}) {
4200: $domain=$env{'request.role.domain'};
1.60 matthew 4201: }
4202: }
1.63 www 4203: return $domain;
4204: }
4205: ###############################################
1.517 raeburn 4206:
1.518 albertel 4207: sub devalidate_domconfig_cache {
4208: my ($udom)=@_;
4209: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4210: }
4211:
4212: # ---------------------- Get domain configuration for a domain
4213: sub get_domainconf {
4214: my ($udom) = @_;
4215: my $cachetime=1800;
4216: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4217: if (defined($cached)) { return %{$result}; }
4218:
4219: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4220: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4221: my (%designhash,%legacy);
1.518 albertel 4222: if (keys(%domconfig) > 0) {
4223: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4224: if (keys(%{$domconfig{'login'}})) {
4225: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4226: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4227: if ($key eq 'loginvia') {
4228: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4229: my @ids = &Apache::lonnet::current_machine_ids();
4230: foreach my $hostname (@ids) {
1.948 raeburn 4231: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4232: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4233: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4234: $designhash{$udom.'.login.loginvia'} = $server;
4235: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4236:
4237: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4238: } else {
4239: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4240: }
4241: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4242: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4243: }
1.946 raeburn 4244: }
4245: }
4246: }
4247: }
4248: } else {
4249: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4250: $designhash{$udom.'.login.'.$key.'_'.$img} =
4251: $domconfig{'login'}{$key}{$img};
4252: }
1.699 raeburn 4253: }
4254: } else {
4255: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4256: }
1.632 raeburn 4257: }
4258: } else {
4259: $legacy{'login'} = 1;
1.518 albertel 4260: }
1.632 raeburn 4261: } else {
4262: $legacy{'login'} = 1;
1.518 albertel 4263: }
4264: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4265: if (keys(%{$domconfig{'rolecolors'}})) {
4266: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4267: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4268: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4269: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4270: }
1.518 albertel 4271: }
4272: }
1.632 raeburn 4273: } else {
4274: $legacy{'rolecolors'} = 1;
1.518 albertel 4275: }
1.632 raeburn 4276: } else {
4277: $legacy{'rolecolors'} = 1;
1.518 albertel 4278: }
1.948 raeburn 4279: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4280: if ($domconfig{'autoenroll'}{'co-owners'}) {
4281: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4282: }
4283: }
1.632 raeburn 4284: if (keys(%legacy) > 0) {
4285: my %legacyhash = &get_legacy_domconf($udom);
4286: foreach my $item (keys(%legacyhash)) {
4287: if ($item =~ /^\Q$udom\E\.login/) {
4288: if ($legacy{'login'}) {
4289: $designhash{$item} = $legacyhash{$item};
4290: }
4291: } else {
4292: if ($legacy{'rolecolors'}) {
4293: $designhash{$item} = $legacyhash{$item};
4294: }
1.518 albertel 4295: }
4296: }
4297: }
1.632 raeburn 4298: } else {
4299: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4300: }
4301: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4302: $cachetime);
4303: return %designhash;
4304: }
4305:
1.632 raeburn 4306: sub get_legacy_domconf {
4307: my ($udom) = @_;
4308: my %legacyhash;
4309: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4310: my $designfile = $designdir.'/'.$udom.'.tab';
4311: if (-e $designfile) {
4312: if ( open (my $fh,"<$designfile") ) {
4313: while (my $line = <$fh>) {
4314: next if ($line =~ /^\#/);
4315: chomp($line);
4316: my ($key,$val)=(split(/\=/,$line));
4317: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4318: }
4319: close($fh);
4320: }
4321: }
4322: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4323: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4324: }
4325: return %legacyhash;
4326: }
4327:
1.63 www 4328: =pod
4329:
1.112 bowersj2 4330: =item * &domainlogo()
1.63 www 4331:
4332: Inputs: $domain (usually will be undef)
4333:
4334: Returns: A link to a domain logo, if the domain logo exists.
4335: If the domain logo does not exist, a description of the domain.
4336:
4337: =cut
1.112 bowersj2 4338:
1.63 www 4339: ###############################################
4340: sub domainlogo {
1.517 raeburn 4341: my $domain = &determinedomain(shift);
1.518 albertel 4342: my %designhash = &get_domainconf($domain);
1.517 raeburn 4343: # See if there is a logo
4344: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4345: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4346: if ($imgsrc =~ m{^/(adm|res)/}) {
4347: if ($imgsrc =~ m{^/res/}) {
4348: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4349: &Apache::lonnet::repcopy($local_name);
4350: }
4351: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4352: }
4353: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4354: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4355: return &Apache::lonnet::domain($domain,'description');
1.59 www 4356: } else {
1.60 matthew 4357: return '';
1.59 www 4358: }
4359: }
1.63 www 4360: ##############################################
4361:
4362: =pod
4363:
1.112 bowersj2 4364: =item * &designparm()
1.63 www 4365:
4366: Inputs: $which parameter; $domain (usually will be undef)
4367:
4368: Returns: value of designparamter $which
4369:
4370: =cut
1.112 bowersj2 4371:
1.397 albertel 4372:
1.400 albertel 4373: ##############################################
1.397 albertel 4374: sub designparm {
4375: my ($which,$domain)=@_;
4376: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4377: return $env{'environment.color.'.$which};
1.96 www 4378: }
1.63 www 4379: $domain=&determinedomain($domain);
1.518 albertel 4380: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4381: my $output;
1.517 raeburn 4382: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4383: $output = $domdesign{$domain.'.'.$which};
1.63 www 4384: } else {
1.520 raeburn 4385: $output = $defaultdesign{$which};
4386: }
4387: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4388: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4389: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4390: if ($output =~ m{^/res/}) {
4391: my $local_name = &Apache::lonnet::filelocation('',$output);
4392: &Apache::lonnet::repcopy($local_name);
4393: }
1.520 raeburn 4394: $output = &lonhttpdurl($output);
4395: }
1.63 www 4396: }
1.520 raeburn 4397: return $output;
1.63 www 4398: }
1.59 www 4399:
1.822 bisitz 4400: ##############################################
4401: =pod
4402:
1.832 bisitz 4403: =item * &authorspace()
4404:
4405: Inputs: ./.
4406:
4407: Returns: Path to the Construction Space of the current user's
4408: accessed author space
4409: The author space will be that of the current user
4410: when accessing the own author space
4411: and that of the co-author/assistent co-author
4412: when accessing the co-author's/assistent co-author's
4413: space
4414:
4415: =cut
4416:
4417: sub authorspace {
4418: my $caname = '';
4419: if ($env{'request.role'} =~ /^ca|^aa/) {
4420: (undef,$caname) =
4421: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4422: } else {
4423: $caname = $env{'user.name'};
4424: }
4425: return '/priv/'.$caname.'/';
4426: }
4427:
4428: ##############################################
4429: =pod
4430:
1.822 bisitz 4431: =item * &head_subbox()
4432:
4433: Inputs: $content (contains HTML code with page functions, etc.)
4434:
4435: Returns: HTML div with $content
4436: To be included in page header
4437:
4438: =cut
4439:
4440: sub head_subbox {
4441: my ($content)=@_;
4442: my $output =
1.844 bisitz 4443: '<div id="LC_head_subbox">'
1.822 bisitz 4444: .$content
4445: .'</div>'
4446: }
4447:
4448: ##############################################
4449: =pod
4450:
4451: =item * &CSTR_pageheader()
4452:
4453: Inputs: ./.
4454:
4455: Returns: HTML div with CSTR path and recent box
4456: To be included on Construction Space pages
4457:
4458: =cut
4459:
4460: sub CSTR_pageheader {
4461: # this is for resources; directories have customtitle, and crumbs
4462: # and select recent are created in lonpubdir.pm
4463: my ($uname,$thisdisfn)=
4464: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4465: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4466: $formaction=~s/\/+/\//g;
4467:
4468: my $parentpath = '';
4469: my $lastitem = '';
4470: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4471: $parentpath = $1;
4472: $lastitem = $2;
4473: } else {
4474: $lastitem = $thisdisfn;
4475: }
1.921 bisitz 4476:
4477: my $output =
1.822 bisitz 4478: '<div>'
4479: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4480: .'<b>'.&mt('Construction Space:').'</b> '
4481: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4482: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4483: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4484:
4485: if ($lastitem) {
4486: $output .=
4487: '<span class="LC_filename">'
4488: .$lastitem
4489: .'</span>';
4490: }
4491: $output .=
4492: '<br />'
1.822 bisitz 4493: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4494: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4495: .'</form>'
4496: .&Apache::lonmenu::constspaceform()
4497: .'</div>';
1.921 bisitz 4498:
4499: return $output;
1.822 bisitz 4500: }
4501:
1.60 matthew 4502: ###############################################
4503: ###############################################
4504:
4505: =pod
4506:
1.112 bowersj2 4507: =back
4508:
1.549 albertel 4509: =head1 HTML Helpers
1.112 bowersj2 4510:
4511: =over 4
4512:
4513: =item * &bodytag()
1.60 matthew 4514:
4515: Returns a uniform header for LON-CAPA web pages.
4516:
4517: Inputs:
4518:
1.112 bowersj2 4519: =over 4
4520:
4521: =item * $title, A title to be displayed on the page.
4522:
4523: =item * $function, the current role (can be undef).
4524:
4525: =item * $addentries, extra parameters for the <body> tag.
4526:
4527: =item * $bodyonly, if defined, only return the <body> tag.
4528:
4529: =item * $domain, if defined, force a given domain.
4530:
4531: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4532: text interface only)
1.60 matthew 4533:
1.814 bisitz 4534: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4535: navigational links
1.317 albertel 4536:
1.338 albertel 4537: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4538:
1.949 droeschl 4539: #RC =item * $no_inline_link, if true and in remote mode, don't show the
4540: #RC 'Switch To Inline Menu' link
4541: #RC
1.460 albertel 4542: =item * $args, optional argument valid values are
4543: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4544: inherit_jsmath -> when creating popup window in a page,
4545: should it have jsmath forced on by the
4546: current page
1.460 albertel 4547:
1.112 bowersj2 4548: =back
4549:
1.60 matthew 4550: Returns: A uniform header for LON-CAPA web pages.
4551: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4552: If $bodyonly is undef or zero, an html string containing a <body> tag and
4553: other decorations will be returned.
4554:
4555: =cut
4556:
1.54 www 4557: sub bodytag {
1.831 bisitz 4558: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4559: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4560:
1.460 albertel 4561: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4562:
1.183 matthew 4563: $function = &get_users_function() if (!$function);
1.339 albertel 4564: my $img = &designparm($function.'.img',$domain);
4565: my $font = &designparm($function.'.font',$domain);
4566: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4567:
1.803 bisitz 4568: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4569: 'bgcolor' => $pgbg,
1.339 albertel 4570: 'text' => $font,
4571: 'alink' => &designparm($function.'.alink',$domain),
4572: 'vlink' => &designparm($function.'.vlink',$domain),
4573: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4574: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4575:
1.63 www 4576: # role and realm
1.378 raeburn 4577: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4578: if ($role eq 'ca') {
1.479 albertel 4579: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4580: $realm = &plainname($rname,$rdom);
1.378 raeburn 4581: }
1.55 www 4582: # realm
1.258 albertel 4583: if ($env{'request.course.id'}) {
1.378 raeburn 4584: if ($env{'request.role'} !~ /^cr/) {
4585: $role = &Apache::lonnet::plaintext($role,&course_type());
4586: }
1.898 raeburn 4587: if ($env{'request.course.sec'}) {
4588: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4589: }
1.359 albertel 4590: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4591: } else {
4592: $role = &Apache::lonnet::plaintext($role);
1.54 www 4593: }
1.433 albertel 4594:
1.359 albertel 4595: if (!$realm) { $realm=' '; }
1.55 www 4596: # Set messages
1.60 matthew 4597: my $messages=&domainlogo($domain);
1.330 albertel 4598:
1.438 albertel 4599: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4600:
1.101 www 4601: # construct main body tag
1.359 albertel 4602: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4603: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4604:
1.530 albertel 4605: if ($bodyonly) {
1.60 matthew 4606: return $bodytag;
1.798 tempelho 4607: }
1.359 albertel 4608:
1.410 albertel 4609: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4610: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4611: undef($role);
1.434 albertel 4612: } else {
4613: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4614: }
1.359 albertel 4615:
1.762 bisitz 4616: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4617: #
4618: # Extra info if you are the DC
4619: my $dc_info = '';
4620: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4621: $env{'course.'.$env{'request.course.id'}.
4622: '.domain'}.'/'})) {
4623: my $cid = $env{'request.course.id'};
1.917 raeburn 4624: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4625: $dc_info =~ s/\s+$//;
1.359 albertel 4626: }
4627:
1.898 raeburn 4628: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4629: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4630:
1.359 albertel 4631: # No Remote
1.916 droeschl 4632: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4633: return $bodytag;
4634: }
1.903 droeschl 4635:
4636: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4637:
4638: # if ($env{'request.state'} eq 'construct') {
4639: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4640: # }
4641:
1.359 albertel 4642:
4643:
1.916 droeschl 4644: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4645: if ($dc_info) {
4646: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4647: }
1.916 droeschl 4648: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4649: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4650: return $bodytag;
4651: }
1.894 droeschl 4652:
1.927 raeburn 4653: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4654: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4655: }
1.916 droeschl 4656:
1.903 droeschl 4657: $bodytag .= Apache::lonhtmlcommon::scripttag(
4658: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4659:
1.903 droeschl 4660: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4661:
1.917 raeburn 4662: if ($dc_info) {
4663: $dc_info = &dc_courseid_toggle($dc_info);
4664: }
4665: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4666:
1.903 droeschl 4667: #don't show menus for public users
4668: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4669: $bodytag .= Apache::lonmenu::secondary_menu();
4670: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4671: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4672: if ($env{'request.state'} eq 'construct') {
4673: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4674: $args->{'bread_crumbs'});
4675: } elsif ($forcereg) {
4676: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4677: }
1.903 droeschl 4678: }else{
4679: # this is to seperate menu from content when there's no secondary
4680: # menu. Especially needed for public accessible ressources.
4681: $bodytag .= '<hr style="clear:both" />';
4682: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4683: }
1.903 droeschl 4684:
1.235 raeburn 4685: return $bodytag;
1.182 matthew 4686: }
4687:
1.917 raeburn 4688: sub dc_courseid_toggle {
4689: my ($dc_info) = @_;
4690: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4691: '<a href="javascript:showCourseID();">'.
4692: &mt('(More ...)').'</a></span>'.
4693: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4694: }
4695:
1.330 albertel 4696: sub make_attr_string {
4697: my ($register,$attr_ref) = @_;
4698:
4699: if ($attr_ref && !ref($attr_ref)) {
4700: die("addentries Must be a hash ref ".
4701: join(':',caller(1))." ".
4702: join(':',caller(0))." ");
4703: }
4704:
4705: if ($register) {
1.339 albertel 4706: my ($on_load,$on_unload);
4707: foreach my $key (keys(%{$attr_ref})) {
4708: if (lc($key) eq 'onload') {
4709: $on_load.=$attr_ref->{$key}.';';
4710: delete($attr_ref->{$key});
4711:
4712: } elsif (lc($key) eq 'onunload') {
4713: $on_unload.=$attr_ref->{$key}.';';
4714: delete($attr_ref->{$key});
4715: }
4716: }
4717: $attr_ref->{'onload'} =
4718: &Apache::lonmenu::loadevents(). $on_load;
4719: $attr_ref->{'onunload'}=
4720: &Apache::lonmenu::unloadevents().$on_unload;
4721: }
4722:
4723: # Accessibility font enhance
4724: if ($env{'browser.fontenhance'} eq 'on') {
4725: my $style;
4726: foreach my $key (keys(%{$attr_ref})) {
4727: if (lc($key) eq 'style') {
4728: $style.=$attr_ref->{$key}.';';
4729: delete($attr_ref->{$key});
4730: }
4731: }
4732: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4733: }
1.339 albertel 4734:
1.330 albertel 4735: my $attr_string;
4736: foreach my $attr (keys(%$attr_ref)) {
4737: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4738: }
4739: return $attr_string;
4740: }
4741:
4742:
1.182 matthew 4743: ###############################################
1.251 albertel 4744: ###############################################
4745:
4746: =pod
4747:
4748: =item * &endbodytag()
4749:
4750: Returns a uniform footer for LON-CAPA web pages.
4751:
1.635 raeburn 4752: Inputs: 1 - optional reference to an args hash
4753: If in the hash, key for noredirectlink has a value which evaluates to true,
4754: a 'Continue' link is not displayed if the page contains an
4755: internal redirect in the <head></head> section,
4756: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4757:
4758: =cut
4759:
4760: sub endbodytag {
1.635 raeburn 4761: my ($args) = @_;
1.251 albertel 4762: my $endbodytag='</body>';
1.269 albertel 4763: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4764: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4765: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4766: $endbodytag=
4767: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4768: &mt('Continue').'</a>'.
4769: $endbodytag;
4770: }
1.315 albertel 4771: }
1.251 albertel 4772: return $endbodytag;
4773: }
4774:
1.352 albertel 4775: =pod
4776:
4777: =item * &standard_css()
4778:
4779: Returns a style sheet
4780:
4781: Inputs: (all optional)
4782: domain -> force to color decorate a page for a specific
4783: domain
4784: function -> force usage of a specific rolish color scheme
4785: bgcolor -> override the default page bgcolor
4786:
4787: =cut
4788:
1.343 albertel 4789: sub standard_css {
1.345 albertel 4790: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4791: $function = &get_users_function() if (!$function);
4792: my $img = &designparm($function.'.img', $domain);
4793: my $tabbg = &designparm($function.'.tabbg', $domain);
4794: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4795: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4796: #second colour for later usage
1.345 albertel 4797: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4798: my $pgbg_or_bgcolor =
4799: $bgcolor ||
1.352 albertel 4800: &designparm($function.'.pgbg', $domain);
1.382 albertel 4801: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4802: my $alink = &designparm($function.'.alink', $domain);
4803: my $vlink = &designparm($function.'.vlink', $domain);
4804: my $link = &designparm($function.'.link', $domain);
4805:
1.704 muellerd 4806: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4807: my $bgcol = &designparm('login.bgcol',$domain);
4808: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4809:
1.602 albertel 4810: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4811: my $mono = 'monospace';
1.850 bisitz 4812: my $data_table_head = $sidebg;
4813: my $data_table_light = '#FAFAFA';
4814: my $data_table_dark = '#F0F0F0';
1.470 banghart 4815: my $data_table_darker = '#CCCCCC';
1.349 albertel 4816: my $data_table_highlight = '#FFFF00';
1.352 albertel 4817: my $mail_new = '#FFBB77';
4818: my $mail_new_hover = '#DD9955';
4819: my $mail_read = '#BBBB77';
4820: my $mail_read_hover = '#999944';
4821: my $mail_replied = '#AAAA88';
4822: my $mail_replied_hover = '#888855';
4823: my $mail_other = '#99BBBB';
4824: my $mail_other_hover = '#669999';
1.391 albertel 4825: my $table_header = '#DDDDDD';
1.489 raeburn 4826: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4827: my $lg_border_color = '#C8C8C8';
1.952 ! onken 4828: my $button_hover = '#BF2317';
1.392 albertel 4829:
1.608 albertel 4830: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4831: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4832: : '0 3px 0 4px';
1.448 albertel 4833:
1.523 albertel 4834:
1.343 albertel 4835: return <<END;
1.947 droeschl 4836:
4837: /* needed for iframe to allow 100% height in FF */
4838: body, html {
4839: margin: 0;
4840: padding: 0 0.5%;
4841: height: 99%; /* to avoid scrollbars */
4842: }
4843:
1.795 www 4844: body {
1.911 bisitz 4845: font-family: $sans;
4846: line-height:130%;
4847: font-size:0.83em;
4848: color:$font;
1.795 www 4849: }
4850:
1.911 bisitz 4851: a:focus {
1.795 www 4852: color: red;
1.911 bisitz 4853: background: yellow;
1.795 www 4854: }
1.698 harmsja 4855:
1.911 bisitz 4856: form, .inline {
4857: display: inline;
1.795 www 4858: }
1.721 harmsja 4859:
1.795 www 4860: .LC_right {
1.911 bisitz 4861: text-align:right;
1.795 www 4862: }
4863:
4864: .LC_middle {
1.911 bisitz 4865: vertical-align:middle;
1.795 www 4866: }
1.721 harmsja 4867:
1.911 bisitz 4868: .LC_400Box {
4869: width:400px;
4870: }
1.721 harmsja 4871:
1.947 droeschl 4872: .LC_iframecontainer {
4873: width: 98%;
4874: margin: 0;
4875: position: fixed;
4876: top: 8.5em;
4877: bottom: 0;
4878: }
4879:
4880: .LC_iframecontainer iframe{
4881: border: none;
4882: width: 100%;
4883: height: 100%;
4884: }
4885:
1.778 bisitz 4886: .LC_filename {
4887: font-family: $mono;
4888: white-space:pre;
1.921 bisitz 4889: font-size: 120%;
1.778 bisitz 4890: }
4891:
4892: .LC_fileicon {
4893: border: none;
4894: height: 1.3em;
4895: vertical-align: text-bottom;
4896: margin-right: 0.3em;
4897: text-decoration:none;
4898: }
4899:
1.350 albertel 4900: .LC_error {
4901: color: red;
4902: font-size: larger;
4903: }
1.795 www 4904:
1.457 albertel 4905: .LC_warning,
4906: .LC_diff_removed {
1.733 bisitz 4907: color: red;
1.394 albertel 4908: }
1.532 albertel 4909:
4910: .LC_info,
1.457 albertel 4911: .LC_success,
4912: .LC_diff_added {
1.350 albertel 4913: color: green;
4914: }
1.795 www 4915:
1.802 bisitz 4916: div.LC_confirm_box {
4917: background-color: #FAFAFA;
4918: border: 1px solid $lg_border_color;
4919: margin-right: 0;
4920: padding: 5px;
4921: }
4922:
4923: div.LC_confirm_box .LC_error img,
4924: div.LC_confirm_box .LC_success img {
4925: vertical-align: middle;
4926: }
4927:
1.440 albertel 4928: .LC_icon {
1.771 droeschl 4929: border: none;
1.790 droeschl 4930: vertical-align: middle;
1.771 droeschl 4931: }
4932:
1.543 albertel 4933: .LC_docs_spacer {
4934: width: 25px;
4935: height: 1px;
1.771 droeschl 4936: border: none;
1.543 albertel 4937: }
1.346 albertel 4938:
1.532 albertel 4939: .LC_internal_info {
1.735 bisitz 4940: color: #999999;
1.532 albertel 4941: }
4942:
1.794 www 4943: .LC_discussion {
1.911 bisitz 4944: background: $tabbg;
4945: border: 1px solid black;
4946: margin: 2px;
1.794 www 4947: }
4948:
4949: .LC_disc_action_links_bar {
1.911 bisitz 4950: background: $tabbg;
4951: border: none;
4952: margin: 4px;
1.794 www 4953: }
4954:
4955: .LC_disc_action_left {
1.911 bisitz 4956: text-align: left;
1.794 www 4957: }
4958:
4959: .LC_disc_action_right {
1.911 bisitz 4960: text-align: right;
1.794 www 4961: }
4962:
4963: .LC_disc_new_item {
1.911 bisitz 4964: background: white;
4965: border: 2px solid red;
4966: margin: 2px;
1.794 www 4967: }
4968:
4969: .LC_disc_old_item {
1.911 bisitz 4970: background: white;
4971: border: 1px solid black;
4972: margin: 2px;
1.794 www 4973: }
4974:
1.458 albertel 4975: table.LC_pastsubmission {
4976: border: 1px solid black;
4977: margin: 2px;
4978: }
4979:
1.924 bisitz 4980: table#LC_menubuttons {
1.345 albertel 4981: width: 100%;
4982: background: $pgbg;
1.392 albertel 4983: border: 2px;
1.402 albertel 4984: border-collapse: separate;
1.803 bisitz 4985: padding: 0;
1.345 albertel 4986: }
1.392 albertel 4987:
1.801 tempelho 4988: table#LC_title_bar a {
4989: color: $fontmenu;
4990: }
1.836 bisitz 4991:
1.807 droeschl 4992: table#LC_title_bar {
1.819 tempelho 4993: clear: both;
1.836 bisitz 4994: display: none;
1.807 droeschl 4995: }
4996:
1.795 www 4997: table#LC_title_bar,
1.933 droeschl 4998: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4999: table#LC_title_bar.LC_with_remote {
1.359 albertel 5000: width: 100%;
1.392 albertel 5001: border-color: $pgbg;
5002: border-style: solid;
5003: border-width: $border;
1.379 albertel 5004: background: $pgbg;
1.801 tempelho 5005: color: $fontmenu;
1.392 albertel 5006: border-collapse: collapse;
1.803 bisitz 5007: padding: 0;
1.819 tempelho 5008: margin: 0;
1.359 albertel 5009: }
1.795 www 5010:
1.933 droeschl 5011: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5012: margin: 0;
5013: padding: 0;
1.933 droeschl 5014: position: relative;
5015: list-style: none;
1.913 droeschl 5016: }
1.933 droeschl 5017: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5018: display: inline;
5019: }
1.933 droeschl 5020:
5021: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5022: padding: 0;
1.933 droeschl 5023: margin: 0;
5024: float: left;
1.913 droeschl 5025: }
1.933 droeschl 5026: .LC_breadcrumb_tools_tools {
5027: padding: 0;
5028: margin: 0;
1.913 droeschl 5029: float: right;
5030: }
5031:
1.359 albertel 5032: table#LC_title_bar td {
5033: background: $tabbg;
5034: }
1.795 www 5035:
1.911 bisitz 5036: table#LC_menubuttons img {
1.803 bisitz 5037: border: none;
1.346 albertel 5038: }
1.795 www 5039:
1.842 droeschl 5040: .LC_breadcrumbs_component {
1.911 bisitz 5041: float: right;
5042: margin: 0 1em;
1.357 albertel 5043: }
1.842 droeschl 5044: .LC_breadcrumbs_component img {
1.911 bisitz 5045: vertical-align: middle;
1.777 tempelho 5046: }
1.795 www 5047:
1.383 albertel 5048: td.LC_table_cell_checkbox {
5049: text-align: center;
5050: }
1.795 www 5051:
5052: .LC_fontsize_small {
1.911 bisitz 5053: font-size: 70%;
1.705 tempelho 5054: }
5055:
1.844 bisitz 5056: #LC_breadcrumbs {
1.911 bisitz 5057: clear:both;
5058: background: $sidebg;
5059: border-bottom: 1px solid $lg_border_color;
5060: line-height: 2.5em;
1.933 droeschl 5061: overflow: hidden;
1.911 bisitz 5062: margin: 0;
5063: padding: 0;
1.819 tempelho 5064: }
1.862 bisitz 5065:
1.844 bisitz 5066: #LC_head_subbox {
1.911 bisitz 5067: clear:both;
5068: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5069: border: 1px solid $sidebg;
5070: margin: 0 0 10px 0;
1.822 bisitz 5071: }
5072:
1.795 www 5073: .LC_fontsize_medium {
1.911 bisitz 5074: font-size: 85%;
1.705 tempelho 5075: }
5076:
1.795 www 5077: .LC_fontsize_large {
1.911 bisitz 5078: font-size: 120%;
1.705 tempelho 5079: }
5080:
1.346 albertel 5081: .LC_menubuttons_inline_text {
5082: color: $font;
1.698 harmsja 5083: font-size: 90%;
1.701 harmsja 5084: padding-left:3px;
1.346 albertel 5085: }
5086:
1.934 droeschl 5087: .LC_menubuttons_inline_text img{
5088: vertical-align: middle;
5089: }
5090:
1.951 onken 5091: li.LC_menubuttons_inline_text img,a {
5092: cursor:pointer;
5093: }
5094:
1.526 www 5095: .LC_menubuttons_link {
5096: text-decoration: none;
5097: }
1.795 www 5098:
1.522 albertel 5099: .LC_menubuttons_category {
1.521 www 5100: color: $font;
1.526 www 5101: background: $pgbg;
1.521 www 5102: font-size: larger;
5103: font-weight: bold;
5104: }
5105:
1.346 albertel 5106: td.LC_menubuttons_text {
1.911 bisitz 5107: color: $font;
1.346 albertel 5108: }
1.706 harmsja 5109:
1.346 albertel 5110: .LC_current_location {
5111: background: $tabbg;
5112: }
1.795 www 5113:
1.938 bisitz 5114: table.LC_data_table {
1.347 albertel 5115: border: 1px solid #000000;
1.402 albertel 5116: border-collapse: separate;
1.426 albertel 5117: border-spacing: 1px;
1.610 albertel 5118: background: $pgbg;
1.347 albertel 5119: }
1.795 www 5120:
1.422 albertel 5121: .LC_data_table_dense {
5122: font-size: small;
5123: }
1.795 www 5124:
1.507 raeburn 5125: table.LC_nested_outer {
5126: border: 1px solid #000000;
1.589 raeburn 5127: border-collapse: collapse;
1.803 bisitz 5128: border-spacing: 0;
1.507 raeburn 5129: width: 100%;
5130: }
1.795 www 5131:
1.879 raeburn 5132: table.LC_innerpickbox,
1.507 raeburn 5133: table.LC_nested {
1.803 bisitz 5134: border: none;
1.589 raeburn 5135: border-collapse: collapse;
1.803 bisitz 5136: border-spacing: 0;
1.507 raeburn 5137: width: 100%;
5138: }
1.795 www 5139:
1.930 faziophi 5140: .ui-accordion,
5141: .ui-accordion table.LC_data_table,
5142: .ui-accordion table.LC_nested_outer{
5143: border: 0px;
5144: border-spacing: 0px;
5145: margin: 3px;
5146: }
5147:
1.911 bisitz 5148: table.LC_data_table tr th,
5149: table.LC_calendar tr th,
1.879 raeburn 5150: table.LC_prior_tries tr th,
5151: table.LC_innerpickbox tr th {
1.349 albertel 5152: font-weight: bold;
5153: background-color: $data_table_head;
1.801 tempelho 5154: color:$fontmenu;
1.701 harmsja 5155: font-size:90%;
1.347 albertel 5156: }
1.795 www 5157:
1.879 raeburn 5158: table.LC_innerpickbox tr th,
5159: table.LC_innerpickbox tr td {
5160: vertical-align: top;
5161: }
5162:
1.711 raeburn 5163: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5164: background-color: #CCCCCC;
1.711 raeburn 5165: font-weight: bold;
5166: text-align: left;
5167: }
1.795 www 5168:
1.912 bisitz 5169: table.LC_data_table tr.LC_odd_row > td {
5170: background-color: $data_table_light;
5171: padding: 2px;
5172: vertical-align: top;
5173: }
5174:
1.809 bisitz 5175: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5176: background-color: $data_table_light;
1.912 bisitz 5177: vertical-align: top;
5178: }
5179:
5180: table.LC_data_table tr.LC_even_row > td {
5181: background-color: $data_table_dark;
1.425 albertel 5182: padding: 2px;
1.900 bisitz 5183: vertical-align: top;
1.347 albertel 5184: }
1.795 www 5185:
1.809 bisitz 5186: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5187: background-color: $data_table_dark;
1.900 bisitz 5188: vertical-align: top;
1.347 albertel 5189: }
1.795 www 5190:
1.425 albertel 5191: table.LC_data_table tr.LC_data_table_highlight td {
5192: background-color: $data_table_darker;
5193: }
1.795 www 5194:
1.639 raeburn 5195: table.LC_data_table tr td.LC_leftcol_header {
5196: background-color: $data_table_head;
5197: font-weight: bold;
5198: }
1.795 www 5199:
1.451 albertel 5200: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5201: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5202: font-weight: bold;
5203: font-style: italic;
5204: text-align: center;
5205: padding: 8px;
1.347 albertel 5206: }
1.795 www 5207:
1.940 bisitz 5208: table.LC_data_table tr.LC_empty_row td {
5209: background-color: $sidebg;
5210: }
5211:
5212: table.LC_nested tr.LC_empty_row td {
5213: background-color: #FFFFFF;
5214: }
5215:
1.890 droeschl 5216: table.LC_caption {
5217: }
5218:
1.507 raeburn 5219: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5220: padding: 4ex
5221: }
1.795 www 5222:
1.507 raeburn 5223: table.LC_nested_outer tr th {
5224: font-weight: bold;
1.801 tempelho 5225: color:$fontmenu;
1.507 raeburn 5226: background-color: $data_table_head;
1.701 harmsja 5227: font-size: small;
1.507 raeburn 5228: border-bottom: 1px solid #000000;
5229: }
1.795 www 5230:
1.507 raeburn 5231: table.LC_nested_outer tr td.LC_subheader {
5232: background-color: $data_table_head;
5233: font-weight: bold;
5234: font-size: small;
5235: border-bottom: 1px solid #000000;
5236: text-align: right;
1.451 albertel 5237: }
1.795 www 5238:
1.507 raeburn 5239: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5240: background-color: #CCCCCC;
1.451 albertel 5241: font-weight: bold;
5242: font-size: small;
1.507 raeburn 5243: text-align: center;
5244: }
1.795 www 5245:
1.589 raeburn 5246: table.LC_nested tr.LC_info_row td.LC_left_item,
5247: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5248: text-align: left;
1.451 albertel 5249: }
1.795 www 5250:
1.507 raeburn 5251: table.LC_nested td {
1.735 bisitz 5252: background-color: #FFFFFF;
1.451 albertel 5253: font-size: small;
1.507 raeburn 5254: }
1.795 www 5255:
1.507 raeburn 5256: table.LC_nested_outer tr th.LC_right_item,
5257: table.LC_nested tr.LC_info_row td.LC_right_item,
5258: table.LC_nested tr.LC_odd_row td.LC_right_item,
5259: table.LC_nested tr td.LC_right_item {
1.451 albertel 5260: text-align: right;
5261: }
5262:
1.930 faziophi 5263: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5264: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5265: text-align: right;
5266: width: 40%;
5267: padding-right:10px;
5268: vertical-align: top;
5269: padding: 5px;
5270: }
5271:
5272: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5273: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5274: text-align: left;
5275: width: 60%;
5276: padding: 2px 4px;
5277: }
5278:
1.507 raeburn 5279: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5280: background-color: #EEEEEE;
1.451 albertel 5281: }
5282:
1.473 raeburn 5283: table.LC_createuser {
5284: }
5285:
5286: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5287: font-size: small;
1.473 raeburn 5288: }
5289:
5290: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5291: background-color: #CCCCCC;
1.473 raeburn 5292: font-weight: bold;
5293: text-align: center;
5294: }
5295:
1.349 albertel 5296: table.LC_calendar {
5297: border: 1px solid #000000;
5298: border-collapse: collapse;
1.917 raeburn 5299: width: 98%;
1.349 albertel 5300: }
1.795 www 5301:
1.349 albertel 5302: table.LC_calendar_pickdate {
5303: font-size: xx-small;
5304: }
1.795 www 5305:
1.349 albertel 5306: table.LC_calendar tr td {
5307: border: 1px solid #000000;
5308: vertical-align: top;
1.917 raeburn 5309: width: 14%;
1.349 albertel 5310: }
1.795 www 5311:
1.349 albertel 5312: table.LC_calendar tr td.LC_calendar_day_empty {
5313: background-color: $data_table_dark;
5314: }
1.795 www 5315:
1.779 bisitz 5316: table.LC_calendar tr td.LC_calendar_day_current {
5317: background-color: $data_table_highlight;
1.777 tempelho 5318: }
1.795 www 5319:
1.938 bisitz 5320: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5321: background-color: $mail_new;
5322: }
1.795 www 5323:
1.938 bisitz 5324: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5325: background-color: $mail_new_hover;
5326: }
1.795 www 5327:
1.938 bisitz 5328: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5329: background-color: $mail_read;
5330: }
1.795 www 5331:
1.938 bisitz 5332: /*
5333: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5334: background-color: $mail_read_hover;
5335: }
1.938 bisitz 5336: */
1.795 www 5337:
1.938 bisitz 5338: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5339: background-color: $mail_replied;
5340: }
1.795 www 5341:
1.938 bisitz 5342: /*
5343: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5344: background-color: $mail_replied_hover;
5345: }
1.938 bisitz 5346: */
1.795 www 5347:
1.938 bisitz 5348: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5349: background-color: $mail_other;
5350: }
1.795 www 5351:
1.938 bisitz 5352: /*
5353: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5354: background-color: $mail_other_hover;
5355: }
1.938 bisitz 5356: */
1.494 raeburn 5357:
1.777 tempelho 5358: table.LC_data_table tr > td.LC_browser_file,
5359: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5360: background: #AAEE77;
1.389 albertel 5361: }
1.795 www 5362:
1.777 tempelho 5363: table.LC_data_table tr > td.LC_browser_file_locked,
5364: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5365: background: #FFAA99;
1.387 albertel 5366: }
1.795 www 5367:
1.777 tempelho 5368: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5369: background: #888888;
1.779 bisitz 5370: }
1.795 www 5371:
1.777 tempelho 5372: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5373: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5374: background: #F8F866;
1.777 tempelho 5375: }
1.795 www 5376:
1.696 bisitz 5377: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5378: background: #E0E8FF;
1.387 albertel 5379: }
1.696 bisitz 5380:
1.707 bisitz 5381: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5382: /* background: #77FF77; */
1.707 bisitz 5383: }
1.795 www 5384:
1.707 bisitz 5385: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5386: border-right: 8px solid #FFFF77;
1.707 bisitz 5387: }
1.795 www 5388:
1.707 bisitz 5389: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5390: border-right: 8px solid #FFAA77;
1.707 bisitz 5391: }
1.795 www 5392:
1.707 bisitz 5393: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5394: border-right: 8px solid #FF7777;
1.707 bisitz 5395: }
1.795 www 5396:
1.707 bisitz 5397: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5398: border-right: 8px solid #AAFF77;
1.707 bisitz 5399: }
1.795 www 5400:
1.707 bisitz 5401: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5402: border-right: 8px solid #11CC55;
1.707 bisitz 5403: }
5404:
1.388 albertel 5405: span.LC_current_location {
1.701 harmsja 5406: font-size:larger;
1.388 albertel 5407: background: $pgbg;
5408: }
1.387 albertel 5409:
1.395 albertel 5410: span.LC_parm_menu_item {
5411: font-size: larger;
5412: }
1.795 www 5413:
1.395 albertel 5414: span.LC_parm_scope_all {
5415: color: red;
5416: }
1.795 www 5417:
1.395 albertel 5418: span.LC_parm_scope_folder {
5419: color: green;
5420: }
1.795 www 5421:
1.395 albertel 5422: span.LC_parm_scope_resource {
5423: color: orange;
5424: }
1.795 www 5425:
1.395 albertel 5426: span.LC_parm_part {
5427: color: blue;
5428: }
1.795 www 5429:
1.911 bisitz 5430: span.LC_parm_folder,
5431: span.LC_parm_symb {
1.395 albertel 5432: font-size: x-small;
5433: font-family: $mono;
5434: color: #AAAAAA;
5435: }
5436:
1.795 www 5437: td.LC_parm_overview_level_menu,
5438: td.LC_parm_overview_map_menu,
5439: td.LC_parm_overview_parm_selectors,
5440: td.LC_parm_overview_restrictions {
1.396 albertel 5441: border: 1px solid black;
5442: border-collapse: collapse;
5443: }
1.795 www 5444:
1.396 albertel 5445: table.LC_parm_overview_restrictions td {
5446: border-width: 1px 4px 1px 4px;
5447: border-style: solid;
5448: border-color: $pgbg;
5449: text-align: center;
5450: }
1.795 www 5451:
1.396 albertel 5452: table.LC_parm_overview_restrictions th {
5453: background: $tabbg;
5454: border-width: 1px 4px 1px 4px;
5455: border-style: solid;
5456: border-color: $pgbg;
5457: }
1.795 www 5458:
1.398 albertel 5459: table#LC_helpmenu {
1.803 bisitz 5460: border: none;
1.398 albertel 5461: height: 55px;
1.803 bisitz 5462: border-spacing: 0;
1.398 albertel 5463: }
5464:
5465: table#LC_helpmenu fieldset legend {
5466: font-size: larger;
5467: }
1.795 www 5468:
1.397 albertel 5469: table#LC_helpmenu_links {
5470: width: 100%;
5471: border: 1px solid black;
5472: background: $pgbg;
1.803 bisitz 5473: padding: 0;
1.397 albertel 5474: border-spacing: 1px;
5475: }
1.795 www 5476:
1.397 albertel 5477: table#LC_helpmenu_links tr td {
5478: padding: 1px;
5479: background: $tabbg;
1.399 albertel 5480: text-align: center;
5481: font-weight: bold;
1.397 albertel 5482: }
1.396 albertel 5483:
1.795 www 5484: table#LC_helpmenu_links a:link,
5485: table#LC_helpmenu_links a:visited,
1.397 albertel 5486: table#LC_helpmenu_links a:active {
5487: text-decoration: none;
5488: color: $font;
5489: }
1.795 www 5490:
1.397 albertel 5491: table#LC_helpmenu_links a:hover {
5492: text-decoration: underline;
5493: color: $vlink;
5494: }
1.396 albertel 5495:
1.417 albertel 5496: .LC_chrt_popup_exists {
5497: border: 1px solid #339933;
5498: margin: -1px;
5499: }
1.795 www 5500:
1.417 albertel 5501: .LC_chrt_popup_up {
5502: border: 1px solid yellow;
5503: margin: -1px;
5504: }
1.795 www 5505:
1.417 albertel 5506: .LC_chrt_popup {
5507: border: 1px solid #8888FF;
5508: background: #CCCCFF;
5509: }
1.795 www 5510:
1.421 albertel 5511: table.LC_pick_box {
5512: border-collapse: separate;
5513: background: white;
5514: border: 1px solid black;
5515: border-spacing: 1px;
5516: }
1.795 www 5517:
1.421 albertel 5518: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5519: background: $sidebg;
1.421 albertel 5520: font-weight: bold;
1.900 bisitz 5521: text-align: left;
1.740 bisitz 5522: vertical-align: top;
1.421 albertel 5523: width: 184px;
5524: padding: 8px;
5525: }
1.795 www 5526:
1.579 raeburn 5527: table.LC_pick_box td.LC_pick_box_value {
5528: text-align: left;
5529: padding: 8px;
5530: }
1.795 www 5531:
1.579 raeburn 5532: table.LC_pick_box td.LC_pick_box_select {
5533: text-align: left;
5534: padding: 8px;
5535: }
1.795 www 5536:
1.424 albertel 5537: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5538: padding: 0;
1.421 albertel 5539: height: 1px;
5540: background: black;
5541: }
1.795 www 5542:
1.421 albertel 5543: table.LC_pick_box td.LC_pick_box_submit {
5544: text-align: right;
5545: }
1.795 www 5546:
1.579 raeburn 5547: table.LC_pick_box td.LC_evenrow_value {
5548: text-align: left;
5549: padding: 8px;
5550: background-color: $data_table_light;
5551: }
1.795 www 5552:
1.579 raeburn 5553: table.LC_pick_box td.LC_oddrow_value {
5554: text-align: left;
5555: padding: 8px;
5556: background-color: $data_table_light;
5557: }
1.795 www 5558:
1.579 raeburn 5559: span.LC_helpform_receipt_cat {
5560: font-weight: bold;
5561: }
1.795 www 5562:
1.424 albertel 5563: table.LC_group_priv_box {
5564: background: white;
5565: border: 1px solid black;
5566: border-spacing: 1px;
5567: }
1.795 www 5568:
1.424 albertel 5569: table.LC_group_priv_box td.LC_pick_box_title {
5570: background: $tabbg;
5571: font-weight: bold;
5572: text-align: right;
5573: width: 184px;
5574: }
1.795 www 5575:
1.424 albertel 5576: table.LC_group_priv_box td.LC_groups_fixed {
5577: background: $data_table_light;
5578: text-align: center;
5579: }
1.795 www 5580:
1.424 albertel 5581: table.LC_group_priv_box td.LC_groups_optional {
5582: background: $data_table_dark;
5583: text-align: center;
5584: }
1.795 www 5585:
1.424 albertel 5586: table.LC_group_priv_box td.LC_groups_functionality {
5587: background: $data_table_darker;
5588: text-align: center;
5589: font-weight: bold;
5590: }
1.795 www 5591:
1.424 albertel 5592: table.LC_group_priv td {
5593: text-align: left;
1.803 bisitz 5594: padding: 0;
1.424 albertel 5595: }
5596:
1.421 albertel 5597: table.LC_notify_front_page {
5598: background: white;
5599: border: 1px solid black;
5600: padding: 8px;
5601: }
1.795 www 5602:
1.421 albertel 5603: table.LC_notify_front_page td {
5604: padding: 8px;
5605: }
1.795 www 5606:
1.424 albertel 5607: .LC_navbuttons {
5608: margin: 2ex 0ex 2ex 0ex;
5609: }
1.795 www 5610:
1.423 albertel 5611: .LC_topic_bar {
5612: font-weight: bold;
5613: background: $tabbg;
1.918 wenzelju 5614: margin: 1em 0em 1em 2em;
1.805 bisitz 5615: padding: 3px;
1.918 wenzelju 5616: font-size: 1.2em;
1.423 albertel 5617: }
1.795 www 5618:
1.423 albertel 5619: .LC_topic_bar span {
1.918 wenzelju 5620: left: 0.5em;
5621: position: absolute;
1.423 albertel 5622: vertical-align: middle;
1.918 wenzelju 5623: font-size: 1.2em;
1.423 albertel 5624: }
1.795 www 5625:
1.423 albertel 5626: table.LC_course_group_status {
5627: margin: 20px;
5628: }
1.795 www 5629:
1.423 albertel 5630: table.LC_status_selector td {
5631: vertical-align: top;
5632: text-align: center;
1.424 albertel 5633: padding: 4px;
5634: }
1.795 www 5635:
1.599 albertel 5636: div.LC_feedback_link {
1.616 albertel 5637: clear: both;
1.829 kalberla 5638: background: $sidebg;
1.779 bisitz 5639: width: 100%;
1.829 kalberla 5640: padding-bottom: 10px;
5641: border: 1px $tabbg solid;
1.833 kalberla 5642: height: 22px;
5643: line-height: 22px;
5644: padding-top: 5px;
5645: }
5646:
5647: div.LC_feedback_link img {
5648: height: 22px;
1.867 kalberla 5649: vertical-align:middle;
1.829 kalberla 5650: }
5651:
1.911 bisitz 5652: div.LC_feedback_link a {
1.829 kalberla 5653: text-decoration: none;
1.489 raeburn 5654: }
1.795 www 5655:
1.867 kalberla 5656: div.LC_comblock {
1.911 bisitz 5657: display:inline;
1.867 kalberla 5658: color:$font;
5659: font-size:90%;
5660: }
5661:
5662: div.LC_feedback_link div.LC_comblock {
5663: padding-left:5px;
5664: }
5665:
5666: div.LC_feedback_link div.LC_comblock a {
5667: color:$font;
5668: }
5669:
1.489 raeburn 5670: span.LC_feedback_link {
1.858 bisitz 5671: /* background: $feedback_link_bg; */
1.599 albertel 5672: font-size: larger;
5673: }
1.795 www 5674:
1.599 albertel 5675: span.LC_message_link {
1.858 bisitz 5676: /* background: $feedback_link_bg; */
1.599 albertel 5677: font-size: larger;
5678: position: absolute;
5679: right: 1em;
1.489 raeburn 5680: }
1.421 albertel 5681:
1.515 albertel 5682: table.LC_prior_tries {
1.524 albertel 5683: border: 1px solid #000000;
5684: border-collapse: separate;
5685: border-spacing: 1px;
1.515 albertel 5686: }
1.523 albertel 5687:
1.515 albertel 5688: table.LC_prior_tries td {
1.524 albertel 5689: padding: 2px;
1.515 albertel 5690: }
1.523 albertel 5691:
5692: .LC_answer_correct {
1.795 www 5693: background: lightgreen;
5694: color: darkgreen;
5695: padding: 6px;
1.523 albertel 5696: }
1.795 www 5697:
1.523 albertel 5698: .LC_answer_charged_try {
1.797 www 5699: background: #FFAAAA;
1.795 www 5700: color: darkred;
5701: padding: 6px;
1.523 albertel 5702: }
1.795 www 5703:
1.779 bisitz 5704: .LC_answer_not_charged_try,
1.523 albertel 5705: .LC_answer_no_grade,
5706: .LC_answer_late {
1.795 www 5707: background: lightyellow;
1.523 albertel 5708: color: black;
1.795 www 5709: padding: 6px;
1.523 albertel 5710: }
1.795 www 5711:
1.523 albertel 5712: .LC_answer_previous {
1.795 www 5713: background: lightblue;
5714: color: darkblue;
5715: padding: 6px;
1.523 albertel 5716: }
1.795 www 5717:
1.779 bisitz 5718: .LC_answer_no_message {
1.777 tempelho 5719: background: #FFFFFF;
5720: color: black;
1.795 www 5721: padding: 6px;
1.779 bisitz 5722: }
1.795 www 5723:
1.779 bisitz 5724: .LC_answer_unknown {
5725: background: orange;
5726: color: black;
1.795 www 5727: padding: 6px;
1.777 tempelho 5728: }
1.795 www 5729:
1.529 albertel 5730: span.LC_prior_numerical,
5731: span.LC_prior_string,
5732: span.LC_prior_custom,
5733: span.LC_prior_reaction,
5734: span.LC_prior_math {
1.925 bisitz 5735: font-family: $mono;
1.523 albertel 5736: white-space: pre;
5737: }
5738:
1.525 albertel 5739: span.LC_prior_string {
1.925 bisitz 5740: font-family: $mono;
1.525 albertel 5741: white-space: pre;
5742: }
5743:
1.523 albertel 5744: table.LC_prior_option {
5745: width: 100%;
5746: border-collapse: collapse;
5747: }
1.795 www 5748:
1.911 bisitz 5749: table.LC_prior_rank,
1.795 www 5750: table.LC_prior_match {
1.528 albertel 5751: border-collapse: collapse;
5752: }
1.795 www 5753:
1.528 albertel 5754: table.LC_prior_option tr td,
5755: table.LC_prior_rank tr td,
5756: table.LC_prior_match tr td {
1.524 albertel 5757: border: 1px solid #000000;
1.515 albertel 5758: }
5759:
1.855 bisitz 5760: .LC_nobreak {
1.544 albertel 5761: white-space: nowrap;
1.519 raeburn 5762: }
5763:
1.576 raeburn 5764: span.LC_cusr_emph {
5765: font-style: italic;
5766: }
5767:
1.633 raeburn 5768: span.LC_cusr_subheading {
5769: font-weight: normal;
5770: font-size: 85%;
5771: }
5772:
1.861 bisitz 5773: div.LC_docs_entry_move {
1.859 bisitz 5774: border: 1px solid #BBBBBB;
1.545 albertel 5775: background: #DDDDDD;
1.861 bisitz 5776: width: 22px;
1.859 bisitz 5777: padding: 1px;
5778: margin: 0;
1.545 albertel 5779: }
5780:
1.861 bisitz 5781: table.LC_data_table tr > td.LC_docs_entry_commands,
5782: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5783: background: #DDDDDD;
5784: font-size: x-small;
5785: }
1.795 www 5786:
1.861 bisitz 5787: .LC_docs_entry_parameter {
5788: white-space: nowrap;
5789: }
5790:
1.544 albertel 5791: .LC_docs_copy {
1.545 albertel 5792: color: #000099;
1.544 albertel 5793: }
1.795 www 5794:
1.544 albertel 5795: .LC_docs_cut {
1.545 albertel 5796: color: #550044;
1.544 albertel 5797: }
1.795 www 5798:
1.544 albertel 5799: .LC_docs_rename {
1.545 albertel 5800: color: #009900;
1.544 albertel 5801: }
1.795 www 5802:
1.544 albertel 5803: .LC_docs_remove {
1.545 albertel 5804: color: #990000;
5805: }
5806:
1.547 albertel 5807: .LC_docs_reinit_warn,
5808: .LC_docs_ext_edit {
5809: font-size: x-small;
5810: }
5811:
1.545 albertel 5812: table.LC_docs_adddocs td,
5813: table.LC_docs_adddocs th {
5814: border: 1px solid #BBBBBB;
5815: padding: 4px;
5816: background: #DDDDDD;
1.543 albertel 5817: }
5818:
1.584 albertel 5819: table.LC_sty_begin {
5820: background: #BBFFBB;
5821: }
1.795 www 5822:
1.584 albertel 5823: table.LC_sty_end {
5824: background: #FFBBBB;
5825: }
5826:
1.589 raeburn 5827: table.LC_double_column {
1.803 bisitz 5828: border-width: 0;
1.589 raeburn 5829: border-collapse: collapse;
5830: width: 100%;
5831: padding: 2px;
5832: }
5833:
5834: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5835: top: 2px;
1.589 raeburn 5836: left: 2px;
5837: width: 47%;
5838: vertical-align: top;
5839: }
5840:
5841: table.LC_double_column tr td.LC_right_col {
5842: top: 2px;
1.779 bisitz 5843: right: 2px;
1.589 raeburn 5844: width: 47%;
5845: vertical-align: top;
5846: }
5847:
1.591 raeburn 5848: div.LC_left_float {
5849: float: left;
5850: padding-right: 5%;
1.597 albertel 5851: padding-bottom: 4px;
1.591 raeburn 5852: }
5853:
5854: div.LC_clear_float_header {
1.597 albertel 5855: padding-bottom: 2px;
1.591 raeburn 5856: }
5857:
5858: div.LC_clear_float_footer {
1.597 albertel 5859: padding-top: 10px;
1.591 raeburn 5860: clear: both;
5861: }
5862:
1.597 albertel 5863: div.LC_grade_show_user {
1.941 bisitz 5864: /* border-left: 5px solid $sidebg; */
5865: border-top: 5px solid #000000;
5866: margin: 50px 0 0 0;
1.936 bisitz 5867: padding: 15px 0 5px 10px;
1.597 albertel 5868: }
1.795 www 5869:
1.936 bisitz 5870: div.LC_grade_show_user_odd_row {
1.941 bisitz 5871: /* border-left: 5px solid #000000; */
5872: }
5873:
5874: div.LC_grade_show_user div.LC_Box {
5875: margin-right: 50px;
1.597 albertel 5876: }
5877:
5878: div.LC_grade_submissions,
5879: div.LC_grade_message_center,
1.936 bisitz 5880: div.LC_grade_info_links {
1.597 albertel 5881: margin: 5px;
5882: width: 99%;
5883: background: #FFFFFF;
5884: }
1.795 www 5885:
1.597 albertel 5886: div.LC_grade_submissions_header,
1.936 bisitz 5887: div.LC_grade_message_center_header {
1.705 tempelho 5888: font-weight: bold;
5889: font-size: large;
1.597 albertel 5890: }
1.795 www 5891:
1.597 albertel 5892: div.LC_grade_submissions_body,
1.936 bisitz 5893: div.LC_grade_message_center_body {
1.597 albertel 5894: border: 1px solid black;
5895: width: 99%;
5896: background: #FFFFFF;
5897: }
1.795 www 5898:
1.613 albertel 5899: table.LC_scantron_action {
5900: width: 100%;
5901: }
1.795 www 5902:
1.613 albertel 5903: table.LC_scantron_action tr th {
1.698 harmsja 5904: font-weight:bold;
5905: font-style:normal;
1.613 albertel 5906: }
1.795 www 5907:
1.779 bisitz 5908: .LC_edit_problem_header,
1.614 albertel 5909: div.LC_edit_problem_footer {
1.705 tempelho 5910: font-weight: normal;
5911: font-size: medium;
1.602 albertel 5912: margin: 2px;
1.600 albertel 5913: }
1.795 www 5914:
1.600 albertel 5915: div.LC_edit_problem_header,
1.602 albertel 5916: div.LC_edit_problem_header div,
1.614 albertel 5917: div.LC_edit_problem_footer,
5918: div.LC_edit_problem_footer div,
1.602 albertel 5919: div.LC_edit_problem_editxml_header,
5920: div.LC_edit_problem_editxml_header div {
1.600 albertel 5921: margin-top: 5px;
5922: }
1.795 www 5923:
1.600 albertel 5924: div.LC_edit_problem_header_title {
1.705 tempelho 5925: font-weight: bold;
5926: font-size: larger;
1.602 albertel 5927: background: $tabbg;
5928: padding: 3px;
5929: }
1.795 www 5930:
1.602 albertel 5931: table.LC_edit_problem_header_title {
5932: width: 100%;
1.600 albertel 5933: background: $tabbg;
1.602 albertel 5934: }
5935:
5936: div.LC_edit_problem_discards {
5937: float: left;
5938: padding-bottom: 5px;
5939: }
1.795 www 5940:
1.602 albertel 5941: div.LC_edit_problem_saves {
5942: float: right;
5943: padding-bottom: 5px;
1.600 albertel 5944: }
1.795 www 5945:
1.911 bisitz 5946: img.stift {
1.803 bisitz 5947: border-width: 0;
5948: vertical-align: middle;
1.677 riegler 5949: }
1.680 riegler 5950:
1.923 bisitz 5951: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5952: vertical-align: top;
1.777 tempelho 5953: }
1.795 www 5954:
1.716 raeburn 5955: div.LC_createcourse {
1.911 bisitz 5956: margin: 10px 10px 10px 10px;
1.716 raeburn 5957: }
5958:
1.917 raeburn 5959: .LC_dccid {
5960: margin: 0.2em 0 0 0;
5961: padding: 0;
5962: font-size: 90%;
5963: display:none;
5964: }
5965:
1.698 harmsja 5966: a:hover,
1.897 wenzelju 5967: ol.LC_primary_menu a:hover,
1.721 harmsja 5968: ol#LC_MenuBreadcrumbs a:hover,
5969: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5970: ul#LC_secondary_menu a:hover,
1.721 harmsja 5971: .LC_FormSectionClearButton input:hover
1.795 www 5972: ul.LC_TabContent li:hover a {
1.952 ! onken 5973: color:$button_hover;
1.911 bisitz 5974: text-decoration:none;
1.693 droeschl 5975: }
5976:
1.779 bisitz 5977: h1 {
1.911 bisitz 5978: padding: 0;
5979: line-height:130%;
1.693 droeschl 5980: }
1.698 harmsja 5981:
1.911 bisitz 5982: h2,
5983: h3,
5984: h4,
5985: h5,
5986: h6 {
5987: margin: 5px 0 5px 0;
5988: padding: 0;
5989: line-height:130%;
1.693 droeschl 5990: }
1.795 www 5991:
5992: .LC_hcell {
1.911 bisitz 5993: padding:3px 15px 3px 15px;
5994: margin: 0;
5995: background-color:$tabbg;
5996: color:$fontmenu;
5997: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5998: }
1.795 www 5999:
1.840 bisitz 6000: .LC_Box > .LC_hcell {
1.911 bisitz 6001: margin: 0 -10px 10px -10px;
1.835 bisitz 6002: }
6003:
1.721 harmsja 6004: .LC_noBorder {
1.911 bisitz 6005: border: 0;
1.698 harmsja 6006: }
1.693 droeschl 6007:
1.721 harmsja 6008: .LC_FormSectionClearButton input {
1.911 bisitz 6009: background-color:transparent;
6010: border: none;
6011: cursor:pointer;
6012: text-decoration:underline;
1.693 droeschl 6013: }
1.763 bisitz 6014:
6015: .LC_help_open_topic {
1.911 bisitz 6016: color: #FFFFFF;
6017: background-color: #EEEEFF;
6018: margin: 1px;
6019: padding: 4px;
6020: border: 1px solid #000033;
6021: white-space: nowrap;
6022: /* vertical-align: middle; */
1.759 neumanie 6023: }
1.693 droeschl 6024:
1.911 bisitz 6025: dl,
6026: ul,
6027: div,
6028: fieldset {
6029: margin: 10px 10px 10px 0;
6030: /* overflow: hidden; */
1.693 droeschl 6031: }
1.795 www 6032:
1.838 bisitz 6033: fieldset > legend {
1.911 bisitz 6034: font-weight: bold;
6035: padding: 0 5px 0 5px;
1.838 bisitz 6036: }
6037:
1.813 bisitz 6038: #LC_nav_bar {
1.911 bisitz 6039: float: left;
1.934 droeschl 6040: margin: 0;
1.807 droeschl 6041: }
6042:
1.916 droeschl 6043: #LC_realm {
6044: margin: 0.2em 0 0 0;
6045: padding: 0;
6046: font-weight: bold;
6047: text-align: center;
6048: }
6049:
1.911 bisitz 6050: #LC_nav_bar em {
6051: font-weight: bold;
6052: font-style: normal;
1.807 droeschl 6053: }
6054:
1.897 wenzelju 6055: ol.LC_primary_menu {
1.911 bisitz 6056: float: right;
1.934 droeschl 6057: margin: 0;
1.807 droeschl 6058: }
6059:
1.852 droeschl 6060: ol#LC_PathBreadcrumbs {
1.911 bisitz 6061: margin: 0;
1.693 droeschl 6062: }
6063:
1.897 wenzelju 6064: ol.LC_primary_menu li {
1.911 bisitz 6065: display: inline;
6066: padding: 5px 5px 0 10px;
6067: vertical-align: top;
1.693 droeschl 6068: }
6069:
1.897 wenzelju 6070: ol.LC_primary_menu li img {
1.911 bisitz 6071: vertical-align: bottom;
1.934 droeschl 6072: height: 1.1em;
1.693 droeschl 6073: }
6074:
1.897 wenzelju 6075: ol.LC_primary_menu a {
1.911 bisitz 6076: color: RGB(80, 80, 80);
6077: text-decoration: none;
1.693 droeschl 6078: }
1.795 www 6079:
1.949 droeschl 6080: ol.LC_primary_menu a.LC_new_message {
6081: font-weight:bold;
6082: color: darkred;
6083: }
6084:
1.897 wenzelju 6085: ul#LC_secondary_menu {
1.911 bisitz 6086: clear: both;
6087: color: $fontmenu;
6088: background: $tabbg;
6089: list-style: none;
6090: padding: 0;
6091: margin: 0;
6092: width: 100%;
1.808 droeschl 6093: }
6094:
1.897 wenzelju 6095: ul#LC_secondary_menu li {
1.911 bisitz 6096: font-weight: bold;
6097: line-height: 1.8em;
6098: padding: 0 0.8em;
6099: border-right: 1px solid black;
6100: display: inline;
6101: vertical-align: middle;
1.807 droeschl 6102: }
6103:
1.847 tempelho 6104: ul.LC_TabContent {
1.911 bisitz 6105: display:block;
6106: background: $sidebg;
6107: border-bottom: solid 1px $lg_border_color;
6108: list-style:none;
6109: margin: 0 -10px;
6110: padding: 0;
1.693 droeschl 6111: }
6112:
1.795 www 6113: ul.LC_TabContent li,
6114: ul.LC_TabContentBigger li {
1.911 bisitz 6115: float:left;
1.741 harmsja 6116: }
1.795 www 6117:
1.897 wenzelju 6118: ul#LC_secondary_menu li a {
1.911 bisitz 6119: color: $fontmenu;
6120: text-decoration: none;
1.693 droeschl 6121: }
1.795 www 6122:
1.721 harmsja 6123: ul.LC_TabContent {
1.952 ! onken 6124: min-height:20px;
1.721 harmsja 6125: }
1.795 www 6126:
6127: ul.LC_TabContent li {
1.911 bisitz 6128: vertical-align:middle;
6129: padding: 0 10px 0 10px;
6130: background-color:$tabbg;
6131: border-bottom:solid 1px $lg_border_color;
1.952 ! onken 6132: border-right: solid 1px $font;
1.721 harmsja 6133: }
1.795 www 6134:
1.847 tempelho 6135: ul.LC_TabContent .right {
1.911 bisitz 6136: float:right;
1.847 tempelho 6137: }
6138:
1.911 bisitz 6139: ul.LC_TabContent li a,
6140: ul.LC_TabContent li {
6141: color:rgb(47,47,47);
6142: text-decoration:none;
6143: font-size:95%;
6144: font-weight:bold;
6145: padding-right: 16px;
1.952 ! onken 6146: min-height:20px;
! 6147: }
! 6148:
! 6149: ul.LC_TabContent li a:hover {
! 6150: color: $button_hover;
! 6151: }
! 6152:
! 6153: ul.LC_TabContent li:hover {
! 6154: color: $button_hover;
! 6155: cursor:pointer;
1.721 harmsja 6156: }
1.795 www 6157:
1.911 bisitz 6158: ul.LC_TabContent li.active {
1.952 ! onken 6159: color: $font;
1.911 bisitz 6160: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 ! onken 6161: border-bottom:solid 1px #FFFFFF;
! 6162: cursor: default;
1.744 ehlerst 6163: }
1.795 www 6164:
1.870 tempelho 6165: #maincoursedoc {
1.911 bisitz 6166: clear:both;
1.870 tempelho 6167: }
6168:
6169: ul.LC_TabContentBigger {
1.911 bisitz 6170: display:block;
6171: list-style:none;
6172: padding: 0;
1.870 tempelho 6173: }
6174:
1.795 www 6175: ul.LC_TabContentBigger li {
1.911 bisitz 6176: vertical-align:bottom;
6177: height: 30px;
6178: font-size:110%;
6179: font-weight:bold;
6180: color: #737373;
1.841 tempelho 6181: }
6182:
1.870 tempelho 6183:
6184: ul.LC_TabContentBigger li a {
1.911 bisitz 6185: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6186: height: 30px;
6187: line-height: 30px;
6188: text-align: center;
6189: display: block;
6190: text-decoration: none;
1.741 harmsja 6191: }
1.795 www 6192:
1.911 bisitz 6193: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6194: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6195: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6196: color:$font;
6197: text-decoration: underline;
1.744 ehlerst 6198: }
1.795 www 6199:
1.870 tempelho 6200:
6201: ul.LC_TabContentBigger li b {
1.911 bisitz 6202: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6203: display: block;
6204: float: left;
6205: padding: 0 30px;
1.870 tempelho 6206: }
6207:
6208: ul.LC_TabContentBigger li:hover b,
6209: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6210: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6211: color:$font;
6212: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6213: }
1.693 droeschl 6214:
1.870 tempelho 6215:
1.862 bisitz 6216: ul.LC_CourseBreadcrumbs {
6217: background: $sidebg;
6218: line-height: 32px;
6219: padding-left: 10px;
6220: margin: 0 0 10px 0;
6221: list-style-position: inside;
6222:
6223: }
6224:
1.911 bisitz 6225: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6226: ol#LC_PathBreadcrumbs {
1.911 bisitz 6227: padding-left: 10px;
6228: margin: 0;
1.933 droeschl 6229: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6230: }
6231:
1.911 bisitz 6232: ol#LC_MenuBreadcrumbs li,
6233: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6234: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6235: display: inline;
1.933 droeschl 6236: white-space: normal;
1.693 droeschl 6237: }
6238:
1.823 bisitz 6239: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6240: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6241: text-decoration: none;
6242: font-size:90%;
1.693 droeschl 6243: }
1.795 www 6244:
6245: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6246: text-decoration:none;
6247: font-size:100%;
6248: font-weight:bold;
1.693 droeschl 6249: }
1.795 www 6250:
1.840 bisitz 6251: .LC_Box {
1.911 bisitz 6252: border: solid 1px $lg_border_color;
6253: padding: 0 10px 10px 10px;
1.746 neumanie 6254: }
1.795 www 6255:
6256: .LC_AboutMe_Image {
1.911 bisitz 6257: float:left;
6258: margin-right:10px;
1.747 neumanie 6259: }
1.795 www 6260:
6261: .LC_Clear_AboutMe_Image {
1.911 bisitz 6262: clear:left;
1.747 neumanie 6263: }
1.795 www 6264:
1.721 harmsja 6265: dl.LC_ListStyleClean dt {
1.911 bisitz 6266: padding-right: 5px;
6267: display: table-header-group;
1.693 droeschl 6268: }
6269:
1.721 harmsja 6270: dl.LC_ListStyleClean dd {
1.911 bisitz 6271: display: table-row;
1.693 droeschl 6272: }
6273:
1.721 harmsja 6274: .LC_ListStyleClean,
6275: .LC_ListStyleSimple,
6276: .LC_ListStyleNormal,
1.795 www 6277: .LC_ListStyleSpecial {
1.911 bisitz 6278: /* display:block; */
6279: list-style-position: inside;
6280: list-style-type: none;
6281: overflow: hidden;
6282: padding: 0;
1.693 droeschl 6283: }
6284:
1.721 harmsja 6285: .LC_ListStyleSimple li,
6286: .LC_ListStyleSimple dd,
6287: .LC_ListStyleNormal li,
6288: .LC_ListStyleNormal dd,
6289: .LC_ListStyleSpecial li,
1.795 www 6290: .LC_ListStyleSpecial dd {
1.911 bisitz 6291: margin: 0;
6292: padding: 5px 5px 5px 10px;
6293: clear: both;
1.693 droeschl 6294: }
6295:
1.721 harmsja 6296: .LC_ListStyleClean li,
6297: .LC_ListStyleClean dd {
1.911 bisitz 6298: padding-top: 0;
6299: padding-bottom: 0;
1.693 droeschl 6300: }
6301:
1.721 harmsja 6302: .LC_ListStyleSimple dd,
1.795 www 6303: .LC_ListStyleSimple li {
1.911 bisitz 6304: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6305: }
6306:
1.721 harmsja 6307: .LC_ListStyleSpecial li,
6308: .LC_ListStyleSpecial dd {
1.911 bisitz 6309: list-style-type: none;
6310: background-color: RGB(220, 220, 220);
6311: margin-bottom: 4px;
1.693 droeschl 6312: }
6313:
1.721 harmsja 6314: table.LC_SimpleTable {
1.911 bisitz 6315: margin:5px;
6316: border:solid 1px $lg_border_color;
1.795 www 6317: }
1.693 droeschl 6318:
1.721 harmsja 6319: table.LC_SimpleTable tr {
1.911 bisitz 6320: padding: 0;
6321: border:solid 1px $lg_border_color;
1.693 droeschl 6322: }
1.795 www 6323:
6324: table.LC_SimpleTable thead {
1.911 bisitz 6325: background:rgb(220,220,220);
1.693 droeschl 6326: }
6327:
1.721 harmsja 6328: div.LC_columnSection {
1.911 bisitz 6329: display: block;
6330: clear: both;
6331: overflow: hidden;
6332: margin: 0;
1.693 droeschl 6333: }
6334:
1.721 harmsja 6335: div.LC_columnSection>* {
1.911 bisitz 6336: float: left;
6337: margin: 10px 20px 10px 0;
6338: overflow:hidden;
1.693 droeschl 6339: }
1.721 harmsja 6340:
1.694 tempelho 6341: .LC_loginpage_container {
1.911 bisitz 6342: text-align:left;
6343: margin : 0 auto;
6344: width:90%;
6345: padding: 10px;
6346: height: auto;
6347: background-color:#FFFFFF;
6348: border:1px solid #CCCCCC;
1.694 tempelho 6349: }
6350:
6351:
6352: .LC_loginpage_loginContainer {
1.911 bisitz 6353: float:left;
6354: width: 182px;
6355: padding: 2px;
6356: border:1px solid #CCCCCC;
6357: background-color:$loginbg;
1.694 tempelho 6358: }
6359:
1.795 www 6360: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6361: margin-top: 0;
6362: display:block;
6363: background:$bgcol;
6364: color:$textcol;
6365: padding-left:5px;
1.712 muellerd 6366: }
1.785 tempelho 6367:
1.694 tempelho 6368: .LC_loginpage_loginInfo {
1.911 bisitz 6369: float:left;
6370: width:182px;
6371: border:1px solid #CCCCCC;
6372: padding:2px;
1.712 muellerd 6373: }
6374:
1.694 tempelho 6375: .LC_loginpage_space {
1.911 bisitz 6376: clear: both;
6377: margin-bottom: 20px;
6378: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6379: }
6380:
1.785 tempelho 6381: .LC_loginpage_floatLeft {
1.911 bisitz 6382: float: left;
6383: width: 200px;
6384: margin: 0;
1.785 tempelho 6385: }
6386:
1.795 www 6387: table em {
1.911 bisitz 6388: font-weight: bold;
6389: font-style: normal;
1.748 schulted 6390: }
1.795 www 6391:
1.779 bisitz 6392: table.LC_tableBrowseRes,
1.795 www 6393: table.LC_tableOfContent {
1.911 bisitz 6394: border:none;
6395: border-spacing: 1px;
6396: padding: 3px;
6397: background-color: #FFFFFF;
6398: font-size: 90%;
1.753 droeschl 6399: }
1.789 droeschl 6400:
1.911 bisitz 6401: table.LC_tableOfContent {
6402: border-collapse: collapse;
1.789 droeschl 6403: }
6404:
1.771 droeschl 6405: table.LC_tableBrowseRes a,
1.768 schulted 6406: table.LC_tableOfContent a {
1.911 bisitz 6407: background-color: transparent;
6408: text-decoration: none;
1.753 droeschl 6409: }
6410:
1.795 www 6411: table.LC_tableOfContent img {
1.911 bisitz 6412: border: none;
6413: height: 1.3em;
6414: vertical-align: text-bottom;
6415: margin-right: 0.3em;
1.753 droeschl 6416: }
1.757 schulted 6417:
1.795 www 6418: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6419: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6420: }
6421:
1.795 www 6422: a#LC_content_toolbar_launchnav {
1.911 bisitz 6423: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6424: }
6425:
1.795 www 6426: a#LC_content_toolbar_closenav {
1.911 bisitz 6427: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6428: }
6429:
1.795 www 6430: a#LC_content_toolbar_everything {
1.911 bisitz 6431: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6432: }
6433:
1.795 www 6434: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6435: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6436: }
6437:
1.795 www 6438: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6439: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6440: }
6441:
1.795 www 6442: a#LC_content_toolbar_changefolder {
1.911 bisitz 6443: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6444: }
6445:
1.795 www 6446: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6447: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6448: }
6449:
1.795 www 6450: ul#LC_toolbar li a:hover {
1.911 bisitz 6451: background-position: bottom center;
1.757 schulted 6452: }
6453:
1.795 www 6454: ul#LC_toolbar {
1.911 bisitz 6455: padding: 0;
6456: margin: 2px;
6457: list-style:none;
6458: position:relative;
6459: background-color:white;
1.757 schulted 6460: }
6461:
1.795 www 6462: ul#LC_toolbar li {
1.911 bisitz 6463: border:1px solid white;
6464: padding: 0;
6465: margin: 0;
6466: float: left;
6467: display:inline;
6468: vertical-align:middle;
6469: }
1.757 schulted 6470:
1.783 amueller 6471:
1.795 www 6472: a.LC_toolbarItem {
1.911 bisitz 6473: display:block;
6474: padding: 0;
6475: margin: 0;
6476: height: 32px;
6477: width: 32px;
6478: color:white;
6479: border: none;
6480: background-repeat:no-repeat;
6481: background-color:transparent;
1.757 schulted 6482: }
6483:
1.915 droeschl 6484: ul.LC_funclist {
6485: margin: 0;
6486: padding: 0.5em 1em 0.5em 0;
6487: }
6488:
1.933 droeschl 6489: ul.LC_funclist > li:first-child {
6490: font-weight:bold;
6491: margin-left:0.8em;
6492: }
6493:
1.915 droeschl 6494: ul.LC_funclist + ul.LC_funclist {
6495: /*
6496: left border as a seperator if we have more than
6497: one list
6498: */
6499: border-left: 1px solid $sidebg;
6500: /*
6501: this hides the left border behind the border of the
6502: outer box if element is wrapped to the next 'line'
6503: */
6504: margin-left: -1px;
6505: }
6506:
1.843 bisitz 6507: ul.LC_funclist li {
1.915 droeschl 6508: display: inline;
1.782 bisitz 6509: white-space: nowrap;
1.915 droeschl 6510: margin: 0 0 0 25px;
6511: line-height: 150%;
1.782 bisitz 6512: }
6513:
1.930 faziophi 6514: .ui-accordion .LC_advanced_toggle {
6515: float: right;
6516: font-size: 90%;
6517: padding: 0px 4px
6518: }
1.757 schulted 6519:
1.343 albertel 6520: END
6521: }
6522:
1.306 albertel 6523: =pod
6524:
6525: =item * &headtag()
6526:
6527: Returns a uniform footer for LON-CAPA web pages.
6528:
1.307 albertel 6529: Inputs: $title - optional title for the head
6530: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6531: $args - optional arguments
1.319 albertel 6532: force_register - if is true call registerurl so the remote is
6533: informed
1.415 albertel 6534: redirect -> array ref of
6535: 1- seconds before redirect occurs
6536: 2- url to redirect to
6537: 3- whether the side effect should occur
1.315 albertel 6538: (side effect of setting
6539: $env{'internal.head.redirect'} to the url
6540: redirected too)
1.352 albertel 6541: domain -> force to color decorate a page for a specific
6542: domain
6543: function -> force usage of a specific rolish color scheme
6544: bgcolor -> override the default page bgcolor
1.460 albertel 6545: no_auto_mt_title
6546: -> prevent &mt()ing the title arg
1.464 albertel 6547:
1.306 albertel 6548: =cut
6549:
6550: sub headtag {
1.313 albertel 6551: my ($title,$head_extra,$args) = @_;
1.306 albertel 6552:
1.363 albertel 6553: my $function = $args->{'function'} || &get_users_function();
6554: my $domain = $args->{'domain'} || &determinedomain();
6555: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6556: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6557: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6558: #time(),
1.418 albertel 6559: $env{'environment.color.timestamp'},
1.363 albertel 6560: $function,$domain,$bgcolor);
6561:
1.369 www 6562: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6563:
1.308 albertel 6564: my $result =
6565: '<head>'.
1.461 albertel 6566: &font_settings();
1.319 albertel 6567:
1.461 albertel 6568: if (!$args->{'frameset'}) {
6569: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6570: }
1.319 albertel 6571: if ($args->{'force_register'}) {
6572: $result .= &Apache::lonmenu::registerurl(1);
6573: }
1.436 albertel 6574: if (!$args->{'no_nav_bar'}
6575: && !$args->{'only_body'}
6576: && !$args->{'frameset'}) {
6577: $result .= &help_menu_js();
6578: }
1.319 albertel 6579:
1.314 albertel 6580: if (ref($args->{'redirect'})) {
1.414 albertel 6581: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6582: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6583: if (!$inhibit_continue) {
6584: $env{'internal.head.redirect'} = $url;
6585: }
1.313 albertel 6586: $result.=<<ADDMETA
6587: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6588: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6589: ADDMETA
6590: }
1.306 albertel 6591: if (!defined($title)) {
6592: $title = 'The LearningOnline Network with CAPA';
6593: }
1.460 albertel 6594: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6595: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6596: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6597: .$head_extra;
1.306 albertel 6598: return $result;
6599: }
6600:
6601: =pod
6602:
1.340 albertel 6603: =item * &font_settings()
6604:
6605: Returns neccessary <meta> to set the proper encoding
6606:
6607: Inputs: none
6608:
6609: =cut
6610:
6611: sub font_settings {
6612: my $headerstring='';
1.647 www 6613: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6614: $headerstring.=
6615: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6616: }
6617: return $headerstring;
6618: }
6619:
1.341 albertel 6620: =pod
6621:
6622: =item * &xml_begin()
6623:
6624: Returns the needed doctype and <html>
6625:
6626: Inputs: none
6627:
6628: =cut
6629:
6630: sub xml_begin {
6631: my $output='';
6632:
1.592 albertel 6633: if ($env{'internal.start_page'}==1) {
6634: &Apache::lonhtmlcommon::init_htmlareafields();
6635: }
1.342 albertel 6636:
1.341 albertel 6637: if ($env{'browser.mathml'}) {
6638: $output='<?xml version="1.0"?>'
6639: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6640: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6641:
6642: # .'<!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">] >'
6643: .'<!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">'
6644: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6645: .'xmlns="http://www.w3.org/1999/xhtml">';
6646: } else {
1.849 bisitz 6647: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6648: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6649: }
6650: return $output;
6651: }
1.340 albertel 6652:
6653: =pod
6654:
1.306 albertel 6655: =item * &endheadtag()
6656:
6657: Returns a uniform </head> for LON-CAPA web pages.
6658:
6659: Inputs: none
6660:
6661: =cut
6662:
6663: sub endheadtag {
6664: return '</head>';
6665: }
6666:
6667: =pod
6668:
6669: =item * &head()
6670:
6671: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6672:
1.648 raeburn 6673: Inputs:
6674:
6675: =over 4
6676:
6677: $title - optional title for the page
6678:
6679: $head_extra - optional extra HTML to put inside the <head>
6680:
6681: =back
1.405 albertel 6682:
1.306 albertel 6683: =cut
6684:
6685: sub head {
1.325 albertel 6686: my ($title,$head_extra,$args) = @_;
6687: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6688: }
6689:
6690: =pod
6691:
6692: =item * &start_page()
6693:
6694: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6695:
1.648 raeburn 6696: Inputs:
6697:
6698: =over 4
6699:
6700: $title - optional title for the page
6701:
6702: $head_extra - optional extra HTML to incude inside the <head>
6703:
6704: $args - additional optional args supported are:
6705:
6706: =over 8
6707:
6708: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6709: arg on
1.814 bisitz 6710: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6711: add_entries -> additional attributes to add to the <body>
6712: domain -> force to color decorate a page for a
1.317 albertel 6713: specific domain
1.648 raeburn 6714: function -> force usage of a specific rolish color
1.317 albertel 6715: scheme
1.648 raeburn 6716: redirect -> see &headtag()
6717: bgcolor -> override the default page bg color
6718: js_ready -> return a string ready for being used in
1.317 albertel 6719: a javascript writeln
1.648 raeburn 6720: html_encode -> return a string ready for being used in
1.320 albertel 6721: a html attribute
1.648 raeburn 6722: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6723: $forcereg arg
1.648 raeburn 6724: frameset -> if true will start with a <frameset>
1.330 albertel 6725: rather than <body>
1.648 raeburn 6726: skip_phases -> hash ref of
1.338 albertel 6727: head -> skip the <html><head> generation
6728: body -> skip all <body> generation
1.949 droeschl 6729: #RC no_inline_link -> if true and in remote mode, don't show the
6730: #RC 'Switch To Inline Menu' link
1.648 raeburn 6731: no_auto_mt_title -> prevent &mt()ing the title arg
6732: inherit_jsmath -> when creating popup window in a page,
6733: should it have jsmath forced on by the
6734: current page
1.867 kalberla 6735: bread_crumbs -> Array containing breadcrumbs
6736: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6737:
1.648 raeburn 6738: =back
1.460 albertel 6739:
1.648 raeburn 6740: =back
1.562 albertel 6741:
1.306 albertel 6742: =cut
6743:
6744: sub start_page {
1.309 albertel 6745: my ($title,$head_extra,$args) = @_;
1.318 albertel 6746: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6747: my %head_args;
1.352 albertel 6748: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6749: 'bgcolor','frameset','no_nav_bar','only_body',
6750: 'no_auto_mt_title') {
1.319 albertel 6751: if (defined($args->{$arg})) {
1.324 raeburn 6752: $head_args{$arg} = $args->{$arg};
1.319 albertel 6753: }
1.313 albertel 6754: }
1.319 albertel 6755:
1.315 albertel 6756: $env{'internal.start_page'}++;
1.338 albertel 6757: my $result;
6758: if (! exists($args->{'skip_phases'}{'head'}) ) {
6759: $result.=
1.341 albertel 6760: &xml_begin().
1.338 albertel 6761: &headtag($title,$head_extra,\%head_args).&endheadtag();
6762: }
6763:
6764: if (! exists($args->{'skip_phases'}{'body'}) ) {
6765: if ($args->{'frameset'}) {
6766: my $attr_string = &make_attr_string($args->{'force_register'},
6767: $args->{'add_entries'});
6768: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6769: } else {
6770: $result .=
6771: &bodytag($title,
6772: $args->{'function'}, $args->{'add_entries'},
6773: $args->{'only_body'}, $args->{'domain'},
6774: $args->{'force_register'}, $args->{'no_nav_bar'},
6775: $args->{'bgcolor'}, $args->{'no_inline_link'},
6776: $args);
6777: }
1.330 albertel 6778: }
1.338 albertel 6779:
1.315 albertel 6780: if ($args->{'js_ready'}) {
1.713 kaisler 6781: $result = &js_ready($result);
1.315 albertel 6782: }
1.320 albertel 6783: if ($args->{'html_encode'}) {
1.713 kaisler 6784: $result = &html_encode($result);
6785: }
6786:
1.813 bisitz 6787: # Preparation for new and consistent functionlist at top of screen
6788: # if ($args->{'functionlist'}) {
6789: # $result .= &build_functionlist();
6790: #}
6791:
6792: # Don't add anything more if only_body wanted
6793: return $result if $args->{'only_body'};
6794:
1.920 raeburn 6795: #Breadcrumbs for Construction Space provided by &bodytag.
1.949 droeschl 6796: if (
6797: $env{'request.state'} eq 'construct') {
1.920 raeburn 6798: return $result;
6799: }
6800:
1.813 bisitz 6801: #Breadcrumbs
1.758 kaisler 6802: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6803: &Apache::lonhtmlcommon::clear_breadcrumbs();
6804: #if any br links exists, add them to the breadcrumbs
6805: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6806: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6807: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6808: }
6809: }
6810:
6811: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6812: if(exists($args->{'bread_crumbs_component'})){
6813: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6814: }else{
6815: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6816: }
1.320 albertel 6817: }
1.315 albertel 6818: return $result;
1.306 albertel 6819: }
6820:
1.330 albertel 6821:
1.306 albertel 6822: =pod
6823:
6824: =item * &head()
6825:
6826: Returns a complete </body></html> section for LON-CAPA web pages.
6827:
1.315 albertel 6828: Inputs: $args - additional optional args supported are:
6829: js_ready -> return a string ready for being used in
6830: a javascript writeln
1.320 albertel 6831: html_encode -> return a string ready for being used in
6832: a html attribute
1.330 albertel 6833: frameset -> if true will start with a <frameset>
6834: rather than <body>
1.493 albertel 6835: dicsussion -> if true will get discussion from
6836: lonxml::xmlend
6837: (you can pass the target and parser arguments
6838: through optional 'target' and 'parser' args
6839: to this routine)
1.306 albertel 6840:
6841: =cut
6842:
6843: sub end_page {
1.315 albertel 6844: my ($args) = @_;
6845: $env{'internal.end_page'}++;
1.330 albertel 6846: my $result;
1.335 albertel 6847: if ($args->{'discussion'}) {
6848: my ($target,$parser);
6849: if (ref($args->{'discussion'})) {
6850: ($target,$parser) =($args->{'discussion'}{'target'},
6851: $args->{'discussion'}{'parser'});
6852: }
6853: $result .= &Apache::lonxml::xmlend($target,$parser);
6854: }
6855:
1.330 albertel 6856: if ($args->{'frameset'}) {
6857: $result .= '</frameset>';
6858: } else {
1.635 raeburn 6859: $result .= &endbodytag($args);
1.330 albertel 6860: }
6861: $result .= "\n</html>";
6862:
1.315 albertel 6863: if ($args->{'js_ready'}) {
1.317 albertel 6864: $result = &js_ready($result);
1.315 albertel 6865: }
1.335 albertel 6866:
1.320 albertel 6867: if ($args->{'html_encode'}) {
6868: $result = &html_encode($result);
6869: }
1.335 albertel 6870:
1.315 albertel 6871: return $result;
6872: }
6873:
1.320 albertel 6874: sub html_encode {
6875: my ($result) = @_;
6876:
1.322 albertel 6877: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6878:
6879: return $result;
6880: }
1.317 albertel 6881: sub js_ready {
6882: my ($result) = @_;
6883:
1.323 albertel 6884: $result =~ s/[\n\r]/ /xmsg;
6885: $result =~ s/\\/\\\\/xmsg;
6886: $result =~ s/'/\\'/xmsg;
1.372 albertel 6887: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6888:
6889: return $result;
6890: }
6891:
1.315 albertel 6892: sub validate_page {
6893: if ( exists($env{'internal.start_page'})
1.316 albertel 6894: && $env{'internal.start_page'} > 1) {
6895: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6896: $env{'internal.start_page'}.' '.
1.316 albertel 6897: $ENV{'request.filename'});
1.315 albertel 6898: }
6899: if ( exists($env{'internal.end_page'})
1.316 albertel 6900: && $env{'internal.end_page'} > 1) {
6901: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6902: $env{'internal.end_page'}.' '.
1.316 albertel 6903: $env{'request.filename'});
1.315 albertel 6904: }
6905: if ( exists($env{'internal.start_page'})
6906: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6907: &Apache::lonnet::logthis('start_page called without end_page '.
6908: $env{'request.filename'});
1.315 albertel 6909: }
6910: if ( ! exists($env{'internal.start_page'})
6911: && exists($env{'internal.end_page'})) {
1.316 albertel 6912: &Apache::lonnet::logthis('end_page called without start_page'.
6913: $env{'request.filename'});
1.315 albertel 6914: }
1.306 albertel 6915: }
1.315 albertel 6916:
1.318 albertel 6917: sub simple_error_page {
6918: my ($r,$title,$msg) = @_;
6919: my $page =
6920: &Apache::loncommon::start_page($title).
6921: &mt($msg).
6922: &Apache::loncommon::end_page();
6923: if (ref($r)) {
6924: $r->print($page);
1.327 albertel 6925: return;
1.318 albertel 6926: }
6927: return $page;
6928: }
1.347 albertel 6929:
6930: {
1.610 albertel 6931: my @row_count;
1.347 albertel 6932: sub start_data_table {
1.422 albertel 6933: my ($add_class) = @_;
6934: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6935: unshift(@row_count,0);
1.422 albertel 6936: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6937: }
6938:
6939: sub end_data_table {
1.610 albertel 6940: shift(@row_count);
1.389 albertel 6941: return '</table>'."\n";;
1.347 albertel 6942: }
6943:
6944: sub start_data_table_row {
1.422 albertel 6945: my ($add_class) = @_;
1.610 albertel 6946: $row_count[0]++;
6947: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6948: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6949: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6950: }
1.471 banghart 6951:
6952: sub continue_data_table_row {
6953: my ($add_class) = @_;
1.610 albertel 6954: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6955: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6956: return '<tr class="'.$css_class.'">'."\n";;
6957: }
1.347 albertel 6958:
6959: sub end_data_table_row {
1.389 albertel 6960: return '</tr>'."\n";;
1.347 albertel 6961: }
1.367 www 6962:
1.421 albertel 6963: sub start_data_table_empty_row {
1.707 bisitz 6964: # $row_count[0]++;
1.421 albertel 6965: return '<tr class="LC_empty_row" >'."\n";;
6966: }
6967:
6968: sub end_data_table_empty_row {
6969: return '</tr>'."\n";;
6970: }
6971:
1.367 www 6972: sub start_data_table_header_row {
1.389 albertel 6973: return '<tr class="LC_header_row">'."\n";;
1.367 www 6974: }
6975:
6976: sub end_data_table_header_row {
1.389 albertel 6977: return '</tr>'."\n";;
1.367 www 6978: }
1.890 droeschl 6979:
6980: sub data_table_caption {
6981: my $caption = shift;
6982: return "<caption class=\"LC_caption\">$caption</caption>";
6983: }
1.347 albertel 6984: }
6985:
1.548 albertel 6986: =pod
6987:
6988: =item * &inhibit_menu_check($arg)
6989:
6990: Checks for a inhibitmenu state and generates output to preserve it
6991:
6992: Inputs: $arg - can be any of
6993: - undef - in which case the return value is a string
6994: to add into arguments list of a uri
6995: - 'input' - in which case the return value is a HTML
6996: <form> <input> field of type hidden to
6997: preserve the value
6998: - a url - in which case the return value is the url with
6999: the neccesary cgi args added to preserve the
7000: inhibitmenu state
7001: - a ref to a url - no return value, but the string is
7002: updated to include the neccessary cgi
7003: args to preserve the inhibitmenu state
7004:
7005: =cut
7006:
7007: sub inhibit_menu_check {
7008: my ($arg) = @_;
7009: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
7010: if ($arg eq 'input') {
7011: if ($env{'form.inhibitmenu'}) {
7012: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7013: } else {
7014: return
7015: }
7016: }
7017: if ($env{'form.inhibitmenu'}) {
7018: if (ref($arg)) {
7019: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7020: } elsif ($arg eq '') {
7021: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7022: } else {
7023: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7024: }
7025: }
7026: if (!ref($arg)) {
7027: return $arg;
7028: }
7029: }
7030:
1.251 albertel 7031: ###############################################
1.182 matthew 7032:
7033: =pod
7034:
1.549 albertel 7035: =back
7036:
7037: =head1 User Information Routines
7038:
7039: =over 4
7040:
1.405 albertel 7041: =item * &get_users_function()
1.182 matthew 7042:
7043: Used by &bodytag to determine the current users primary role.
7044: Returns either 'student','coordinator','admin', or 'author'.
7045:
7046: =cut
7047:
7048: ###############################################
7049: sub get_users_function {
1.815 tempelho 7050: my $function = 'norole';
1.818 tempelho 7051: if ($env{'request.role'}=~/^(st)/) {
7052: $function='student';
7053: }
1.907 raeburn 7054: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7055: $function='coordinator';
7056: }
1.258 albertel 7057: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7058: $function='admin';
7059: }
1.826 bisitz 7060: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7061: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7062: $function='author';
7063: }
7064: return $function;
1.54 www 7065: }
1.99 www 7066:
7067: ###############################################
7068:
1.233 raeburn 7069: =pod
7070:
1.821 raeburn 7071: =item * &show_course()
7072:
7073: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7074: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7075:
7076: Inputs:
7077: None
7078:
7079: Outputs:
7080: Scalar: 1 if 'Course' to be used, 0 otherwise.
7081:
7082: =cut
7083:
7084: ###############################################
7085: sub show_course {
7086: my $course = !$env{'user.adv'};
7087: if (!$env{'user.adv'}) {
7088: foreach my $env (keys(%env)) {
7089: next if ($env !~ m/^user\.priv\./);
7090: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7091: $course = 0;
7092: last;
7093: }
7094: }
7095: }
7096: return $course;
7097: }
7098:
7099: ###############################################
7100:
7101: =pod
7102:
1.542 raeburn 7103: =item * &check_user_status()
1.274 raeburn 7104:
7105: Determines current status of supplied role for a
7106: specific user. Roles can be active, previous or future.
7107:
7108: Inputs:
7109: user's domain, user's username, course's domain,
1.375 raeburn 7110: course's number, optional section ID.
1.274 raeburn 7111:
7112: Outputs:
7113: role status: active, previous or future.
7114:
7115: =cut
7116:
7117: sub check_user_status {
1.412 raeburn 7118: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7119: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7120: my @uroles = keys %userinfo;
7121: my $srchstr;
7122: my $active_chk = 'none';
1.412 raeburn 7123: my $now = time;
1.274 raeburn 7124: if (@uroles > 0) {
1.908 raeburn 7125: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7126: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7127: } else {
1.412 raeburn 7128: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7129: }
7130: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7131: my $role_end = 0;
7132: my $role_start = 0;
7133: $active_chk = 'active';
1.412 raeburn 7134: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7135: $role_end = $1;
7136: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7137: $role_start = $1;
1.274 raeburn 7138: }
7139: }
7140: if ($role_start > 0) {
1.412 raeburn 7141: if ($now < $role_start) {
1.274 raeburn 7142: $active_chk = 'future';
7143: }
7144: }
7145: if ($role_end > 0) {
1.412 raeburn 7146: if ($now > $role_end) {
1.274 raeburn 7147: $active_chk = 'previous';
7148: }
7149: }
7150: }
7151: }
7152: return $active_chk;
7153: }
7154:
7155: ###############################################
7156:
7157: =pod
7158:
1.405 albertel 7159: =item * &get_sections()
1.233 raeburn 7160:
7161: Determines all the sections for a course including
7162: sections with students and sections containing other roles.
1.419 raeburn 7163: Incoming parameters:
7164:
7165: 1. domain
7166: 2. course number
7167: 3. reference to array containing roles for which sections should
7168: be gathered (optional).
7169: 4. reference to array containing status types for which sections
7170: should be gathered (optional).
7171:
7172: If the third argument is undefined, sections are gathered for any role.
7173: If the fourth argument is undefined, sections are gathered for any status.
7174: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7175:
1.374 raeburn 7176: Returns section hash (keys are section IDs, values are
7177: number of users in each section), subject to the
1.419 raeburn 7178: optional roles filter, optional status filter
1.233 raeburn 7179:
7180: =cut
7181:
7182: ###############################################
7183: sub get_sections {
1.419 raeburn 7184: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7185: if (!defined($cdom) || !defined($cnum)) {
7186: my $cid = $env{'request.course.id'};
7187:
7188: return if (!defined($cid));
7189:
7190: $cdom = $env{'course.'.$cid.'.domain'};
7191: $cnum = $env{'course.'.$cid.'.num'};
7192: }
7193:
7194: my %sectioncount;
1.419 raeburn 7195: my $now = time;
1.240 albertel 7196:
1.366 albertel 7197: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7198: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7199: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7200: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7201: my $start_index = &Apache::loncoursedata::CL_START();
7202: my $end_index = &Apache::loncoursedata::CL_END();
7203: my $status;
1.366 albertel 7204: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7205: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7206: $data->[$status_index],
7207: $data->[$start_index],
7208: $data->[$end_index]);
7209: if ($stu_status eq 'Active') {
7210: $status = 'active';
7211: } elsif ($end < $now) {
7212: $status = 'previous';
7213: } elsif ($start > $now) {
7214: $status = 'future';
7215: }
7216: if ($section ne '-1' && $section !~ /^\s*$/) {
7217: if ((!defined($possible_status)) || (($status ne '') &&
7218: (grep/^\Q$status\E$/,@{$possible_status}))) {
7219: $sectioncount{$section}++;
7220: }
1.240 albertel 7221: }
7222: }
7223: }
7224: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7225: foreach my $user (sort(keys(%courseroles))) {
7226: if ($user !~ /^(\w{2})/) { next; }
7227: my ($role) = ($user =~ /^(\w{2})/);
7228: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7229: my ($section,$status);
1.240 albertel 7230: if ($role eq 'cr' &&
7231: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7232: $section=$1;
7233: }
7234: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7235: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7236: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7237: if ($end == -1 && $start == -1) {
7238: next; #deleted role
7239: }
7240: if (!defined($possible_status)) {
7241: $sectioncount{$section}++;
7242: } else {
7243: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7244: $status = 'active';
7245: } elsif ($end < $now) {
7246: $status = 'future';
7247: } elsif ($start > $now) {
7248: $status = 'previous';
7249: }
7250: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7251: $sectioncount{$section}++;
7252: }
7253: }
1.233 raeburn 7254: }
1.366 albertel 7255: return %sectioncount;
1.233 raeburn 7256: }
7257:
1.274 raeburn 7258: ###############################################
1.294 raeburn 7259:
7260: =pod
1.405 albertel 7261:
7262: =item * &get_course_users()
7263:
1.275 raeburn 7264: Retrieves usernames:domains for users in the specified course
7265: with specific role(s), and access status.
7266:
7267: Incoming parameters:
1.277 albertel 7268: 1. course domain
7269: 2. course number
7270: 3. access status: users must have - either active,
1.275 raeburn 7271: previous, future, or all.
1.277 albertel 7272: 4. reference to array of permissible roles
1.288 raeburn 7273: 5. reference to array of section restrictions (optional)
7274: 6. reference to results object (hash of hashes).
7275: 7. reference to optional userdata hash
1.609 raeburn 7276: 8. reference to optional statushash
1.630 raeburn 7277: 9. flag if privileged users (except those set to unhide in
7278: course settings) should be excluded
1.609 raeburn 7279: Keys of top level results hash are roles.
1.275 raeburn 7280: Keys of inner hashes are username:domain, with
7281: values set to access type.
1.288 raeburn 7282: Optional userdata hash returns an array with arguments in the
7283: same order as loncoursedata::get_classlist() for student data.
7284:
1.609 raeburn 7285: Optional statushash returns
7286:
1.288 raeburn 7287: Entries for end, start, section and status are blank because
7288: of the possibility of multiple values for non-student roles.
7289:
1.275 raeburn 7290: =cut
1.405 albertel 7291:
1.275 raeburn 7292: ###############################################
1.405 albertel 7293:
1.275 raeburn 7294: sub get_course_users {
1.630 raeburn 7295: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7296: my %idx = ();
1.419 raeburn 7297: my %seclists;
1.288 raeburn 7298:
7299: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7300: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7301: $idx{end} = &Apache::loncoursedata::CL_END();
7302: $idx{start} = &Apache::loncoursedata::CL_START();
7303: $idx{id} = &Apache::loncoursedata::CL_ID();
7304: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7305: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7306: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7307:
1.290 albertel 7308: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7309: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7310: my $now = time;
1.277 albertel 7311: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7312: my $match = 0;
1.412 raeburn 7313: my $secmatch = 0;
1.419 raeburn 7314: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7315: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7316: if ($section eq '') {
7317: $section = 'none';
7318: }
1.291 albertel 7319: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7320: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7321: $secmatch = 1;
7322: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7323: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7324: $secmatch = 1;
7325: }
7326: } else {
1.419 raeburn 7327: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7328: $secmatch = 1;
7329: }
1.290 albertel 7330: }
1.412 raeburn 7331: if (!$secmatch) {
7332: next;
7333: }
1.419 raeburn 7334: }
1.275 raeburn 7335: if (defined($$types{'active'})) {
1.288 raeburn 7336: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7337: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7338: $match = 1;
1.275 raeburn 7339: }
7340: }
7341: if (defined($$types{'previous'})) {
1.609 raeburn 7342: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7343: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7344: $match = 1;
1.275 raeburn 7345: }
7346: }
7347: if (defined($$types{'future'})) {
1.609 raeburn 7348: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7349: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7350: $match = 1;
1.275 raeburn 7351: }
7352: }
1.609 raeburn 7353: if ($match) {
7354: push(@{$seclists{$student}},$section);
7355: if (ref($userdata) eq 'HASH') {
7356: $$userdata{$student} = $$classlist{$student};
7357: }
7358: if (ref($statushash) eq 'HASH') {
7359: $statushash->{$student}{'st'}{$section} = $status;
7360: }
1.288 raeburn 7361: }
1.275 raeburn 7362: }
7363: }
1.412 raeburn 7364: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7365: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7366: my $now = time;
1.609 raeburn 7367: my %displaystatus = ( previous => 'Expired',
7368: active => 'Active',
7369: future => 'Future',
7370: );
1.630 raeburn 7371: my %nothide;
7372: if ($hidepriv) {
7373: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7374: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7375: if ($user !~ /:/) {
7376: $nothide{join(':',split(/[\@]/,$user))}=1;
7377: } else {
7378: $nothide{$user} = 1;
7379: }
7380: }
7381: }
1.439 raeburn 7382: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7383: my $match = 0;
1.412 raeburn 7384: my $secmatch = 0;
1.439 raeburn 7385: my $status;
1.412 raeburn 7386: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7387: $user =~ s/:$//;
1.439 raeburn 7388: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7389: if ($end == -1 || $start == -1) {
7390: next;
7391: }
7392: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7393: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7394: my ($uname,$udom) = split(/:/,$user);
7395: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7396: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7397: $secmatch = 1;
7398: } elsif ($usec eq '') {
1.420 albertel 7399: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7400: $secmatch = 1;
7401: }
7402: } else {
7403: if (grep(/^\Q$usec\E$/,@{$sections})) {
7404: $secmatch = 1;
7405: }
7406: }
7407: if (!$secmatch) {
7408: next;
7409: }
1.288 raeburn 7410: }
1.419 raeburn 7411: if ($usec eq '') {
7412: $usec = 'none';
7413: }
1.275 raeburn 7414: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7415: if ($hidepriv) {
7416: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7417: (!$nothide{$uname.':'.$udom})) {
7418: next;
7419: }
7420: }
1.503 raeburn 7421: if ($end > 0 && $end < $now) {
1.439 raeburn 7422: $status = 'previous';
7423: } elsif ($start > $now) {
7424: $status = 'future';
7425: } else {
7426: $status = 'active';
7427: }
1.277 albertel 7428: foreach my $type (keys(%{$types})) {
1.275 raeburn 7429: if ($status eq $type) {
1.420 albertel 7430: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7431: push(@{$$users{$role}{$user}},$type);
7432: }
1.288 raeburn 7433: $match = 1;
7434: }
7435: }
1.419 raeburn 7436: if (($match) && (ref($userdata) eq 'HASH')) {
7437: if (!exists($$userdata{$uname.':'.$udom})) {
7438: &get_user_info($udom,$uname,\%idx,$userdata);
7439: }
1.420 albertel 7440: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7441: push(@{$seclists{$uname.':'.$udom}},$usec);
7442: }
1.609 raeburn 7443: if (ref($statushash) eq 'HASH') {
7444: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7445: }
1.275 raeburn 7446: }
7447: }
7448: }
7449: }
1.290 albertel 7450: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7451: if ((defined($cdom)) && (defined($cnum))) {
7452: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7453: if ( defined($csettings{'internal.courseowner'}) ) {
7454: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7455: next if ($owner eq '');
7456: my ($ownername,$ownerdom);
7457: if ($owner =~ /^([^:]+):([^:]+)$/) {
7458: $ownername = $1;
7459: $ownerdom = $2;
7460: } else {
7461: $ownername = $owner;
7462: $ownerdom = $cdom;
7463: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7464: }
7465: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7466: if (defined($userdata) &&
1.609 raeburn 7467: !exists($$userdata{$owner})) {
7468: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7469: if (!grep(/^none$/,@{$seclists{$owner}})) {
7470: push(@{$seclists{$owner}},'none');
7471: }
7472: if (ref($statushash) eq 'HASH') {
7473: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7474: }
1.290 albertel 7475: }
1.279 raeburn 7476: }
7477: }
7478: }
1.419 raeburn 7479: foreach my $user (keys(%seclists)) {
7480: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7481: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7482: }
1.275 raeburn 7483: }
7484: return;
7485: }
7486:
1.288 raeburn 7487: sub get_user_info {
7488: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7489: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7490: &plainname($uname,$udom,'lastname');
1.291 albertel 7491: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7492: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7493: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7494: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7495: return;
7496: }
1.275 raeburn 7497:
1.472 raeburn 7498: ###############################################
7499:
7500: =pod
7501:
7502: =item * &get_user_quota()
7503:
7504: Retrieves quota assigned for storage of portfolio files for a user
7505:
7506: Incoming parameters:
7507: 1. user's username
7508: 2. user's domain
7509:
7510: Returns:
1.536 raeburn 7511: 1. Disk quota (in Mb) assigned to student.
7512: 2. (Optional) Type of setting: custom or default
7513: (individually assigned or default for user's
7514: institutional status).
7515: 3. (Optional) - User's institutional status (e.g., faculty, staff
7516: or student - types as defined in localenroll::inst_usertypes
7517: for user's domain, which determines default quota for user.
7518: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7519:
7520: If a value has been stored in the user's environment,
1.536 raeburn 7521: it will return that, otherwise it returns the maximal default
7522: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7523:
7524: =cut
7525:
7526: ###############################################
7527:
7528:
7529: sub get_user_quota {
7530: my ($uname,$udom) = @_;
1.536 raeburn 7531: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7532: if (!defined($udom)) {
7533: $udom = $env{'user.domain'};
7534: }
7535: if (!defined($uname)) {
7536: $uname = $env{'user.name'};
7537: }
7538: if (($udom eq '' || $uname eq '') ||
7539: ($udom eq 'public') && ($uname eq 'public')) {
7540: $quota = 0;
1.536 raeburn 7541: $quotatype = 'default';
7542: $defquota = 0;
1.472 raeburn 7543: } else {
1.536 raeburn 7544: my $inststatus;
1.472 raeburn 7545: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7546: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7547: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7548: } else {
1.536 raeburn 7549: my %userenv =
7550: &Apache::lonnet::get('environment',['portfolioquota',
7551: 'inststatus'],$udom,$uname);
1.472 raeburn 7552: my ($tmp) = keys(%userenv);
7553: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7554: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7555: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7556: } else {
7557: undef(%userenv);
7558: }
7559: }
1.536 raeburn 7560: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7561: if ($quota eq '') {
1.536 raeburn 7562: $quota = $defquota;
7563: $quotatype = 'default';
7564: } else {
7565: $quotatype = 'custom';
1.472 raeburn 7566: }
7567: }
1.536 raeburn 7568: if (wantarray) {
7569: return ($quota,$quotatype,$settingstatus,$defquota);
7570: } else {
7571: return $quota;
7572: }
1.472 raeburn 7573: }
7574:
7575: ###############################################
7576:
7577: =pod
7578:
7579: =item * &default_quota()
7580:
1.536 raeburn 7581: Retrieves default quota assigned for storage of user portfolio files,
7582: given an (optional) user's institutional status.
1.472 raeburn 7583:
7584: Incoming parameters:
7585: 1. domain
1.536 raeburn 7586: 2. (Optional) institutional status(es). This is a : separated list of
7587: status types (e.g., faculty, staff, student etc.)
7588: which apply to the user for whom the default is being retrieved.
7589: If the institutional status string in undefined, the domain
7590: default quota will be returned.
1.472 raeburn 7591:
7592: Returns:
7593: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7594: 2. (Optional) institutional type which determined the value of the
7595: default quota.
1.472 raeburn 7596:
7597: If a value has been stored in the domain's configuration db,
7598: it will return that, otherwise it returns 20 (for backwards
7599: compatibility with domains which have not set up a configuration
7600: db file; the original statically defined portfolio quota was 20 Mb).
7601:
1.536 raeburn 7602: If the user's status includes multiple types (e.g., staff and student),
7603: the largest default quota which applies to the user determines the
7604: default quota returned.
7605:
1.780 raeburn 7606: =back
7607:
1.472 raeburn 7608: =cut
7609:
7610: ###############################################
7611:
7612:
7613: sub default_quota {
1.536 raeburn 7614: my ($udom,$inststatus) = @_;
7615: my ($defquota,$settingstatus);
7616: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7617: ['quotas'],$udom);
7618: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7619: if ($inststatus ne '') {
1.765 raeburn 7620: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7621: foreach my $item (@statuses) {
1.711 raeburn 7622: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7623: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7624: if ($defquota eq '') {
7625: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7626: $settingstatus = $item;
7627: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7628: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7629: $settingstatus = $item;
7630: }
7631: }
7632: } else {
7633: if ($quotahash{'quotas'}{$item} ne '') {
7634: if ($defquota eq '') {
7635: $defquota = $quotahash{'quotas'}{$item};
7636: $settingstatus = $item;
7637: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7638: $defquota = $quotahash{'quotas'}{$item};
7639: $settingstatus = $item;
7640: }
1.536 raeburn 7641: }
7642: }
7643: }
7644: }
7645: if ($defquota eq '') {
1.711 raeburn 7646: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7647: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7648: } else {
7649: $defquota = $quotahash{'quotas'}{'default'};
7650: }
1.536 raeburn 7651: $settingstatus = 'default';
7652: }
7653: } else {
7654: $settingstatus = 'default';
7655: $defquota = 20;
7656: }
7657: if (wantarray) {
7658: return ($defquota,$settingstatus);
1.472 raeburn 7659: } else {
1.536 raeburn 7660: return $defquota;
1.472 raeburn 7661: }
7662: }
7663:
1.384 raeburn 7664: sub get_secgrprole_info {
7665: my ($cdom,$cnum,$needroles,$type) = @_;
7666: my %sections_count = &get_sections($cdom,$cnum);
7667: my @sections = (sort {$a <=> $b} keys(%sections_count));
7668: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7669: my @groups = sort(keys(%curr_groups));
7670: my $allroles = [];
7671: my $rolehash;
7672: my $accesshash = {
7673: active => 'Currently has access',
7674: future => 'Will have future access',
7675: previous => 'Previously had access',
7676: };
7677: if ($needroles) {
7678: $rolehash = {'all' => 'all'};
1.385 albertel 7679: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7680: if (&Apache::lonnet::error(%user_roles)) {
7681: undef(%user_roles);
7682: }
7683: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7684: my ($role)=split(/\:/,$item,2);
7685: if ($role eq 'cr') { next; }
7686: if ($role =~ /^cr/) {
7687: $$rolehash{$role} = (split('/',$role))[3];
7688: } else {
7689: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7690: }
7691: }
7692: foreach my $key (sort(keys(%{$rolehash}))) {
7693: push(@{$allroles},$key);
7694: }
7695: push (@{$allroles},'st');
7696: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7697: }
7698: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7699: }
7700:
1.555 raeburn 7701: sub user_picker {
1.627 raeburn 7702: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7703: my $currdom = $dom;
7704: my %curr_selected = (
7705: srchin => 'dom',
1.580 raeburn 7706: srchby => 'lastname',
1.555 raeburn 7707: );
7708: my $srchterm;
1.625 raeburn 7709: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7710: if ($srch->{'srchby'} ne '') {
7711: $curr_selected{'srchby'} = $srch->{'srchby'};
7712: }
7713: if ($srch->{'srchin'} ne '') {
7714: $curr_selected{'srchin'} = $srch->{'srchin'};
7715: }
7716: if ($srch->{'srchtype'} ne '') {
7717: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7718: }
7719: if ($srch->{'srchdomain'} ne '') {
7720: $currdom = $srch->{'srchdomain'};
7721: }
7722: $srchterm = $srch->{'srchterm'};
7723: }
7724: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7725: 'usr' => 'Search criteria',
1.563 raeburn 7726: 'doma' => 'Domain/institution to search',
1.558 albertel 7727: 'uname' => 'username',
7728: 'lastname' => 'last name',
1.555 raeburn 7729: 'lastfirst' => 'last name, first name',
1.558 albertel 7730: 'crs' => 'in this course',
1.576 raeburn 7731: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7732: 'alc' => 'all LON-CAPA',
1.573 raeburn 7733: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7734: 'exact' => 'is',
7735: 'contains' => 'contains',
1.569 raeburn 7736: 'begins' => 'begins with',
1.571 raeburn 7737: 'youm' => "You must include some text to search for.",
7738: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7739: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7740: 'yomc' => "You must choose a domain when using an institutional directory search.",
7741: 'ymcd' => "You must choose a domain when using a domain search.",
7742: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7743: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7744: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7745: );
1.563 raeburn 7746: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7747: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7748:
7749: my @srchins = ('crs','dom','alc','instd');
7750:
7751: foreach my $option (@srchins) {
7752: # FIXME 'alc' option unavailable until
7753: # loncreateuser::print_user_query_page()
7754: # has been completed.
7755: next if ($option eq 'alc');
1.880 raeburn 7756: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7757: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7758: if ($curr_selected{'srchin'} eq $option) {
7759: $srchinsel .= '
7760: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7761: } else {
7762: $srchinsel .= '
7763: <option value="'.$option.'">'.$lt{$option}.'</option>';
7764: }
1.555 raeburn 7765: }
1.563 raeburn 7766: $srchinsel .= "\n </select>\n";
1.555 raeburn 7767:
7768: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7769: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7770: if ($curr_selected{'srchby'} eq $option) {
7771: $srchbysel .= '
7772: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7773: } else {
7774: $srchbysel .= '
7775: <option value="'.$option.'">'.$lt{$option}.'</option>';
7776: }
7777: }
7778: $srchbysel .= "\n </select>\n";
7779:
7780: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7781: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7782: if ($curr_selected{'srchtype'} eq $option) {
7783: $srchtypesel .= '
7784: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7785: } else {
7786: $srchtypesel .= '
7787: <option value="'.$option.'">'.$lt{$option}.'</option>';
7788: }
7789: }
7790: $srchtypesel .= "\n </select>\n";
7791:
1.558 albertel 7792: my ($newuserscript,$new_user_create);
1.556 raeburn 7793:
7794: if ($forcenewuser) {
1.576 raeburn 7795: if (ref($srch) eq 'HASH') {
7796: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7797: if ($cancreate) {
7798: $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>';
7799: } else {
1.799 bisitz 7800: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7801: my %usertypetext = (
7802: official => 'institutional',
7803: unofficial => 'non-institutional',
7804: );
1.799 bisitz 7805: $new_user_create = '<p class="LC_warning">'
7806: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7807: .' '
7808: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7809: ,'<a href="'.$helplink.'">','</a>')
7810: .'</p><br />';
1.627 raeburn 7811: }
1.576 raeburn 7812: }
7813: }
7814:
1.556 raeburn 7815: $newuserscript = <<"ENDSCRIPT";
7816:
1.570 raeburn 7817: function setSearch(createnew,callingForm) {
1.556 raeburn 7818: if (createnew == 1) {
1.570 raeburn 7819: for (var i=0; i<callingForm.srchby.length; i++) {
7820: if (callingForm.srchby.options[i].value == 'uname') {
7821: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7822: }
7823: }
1.570 raeburn 7824: for (var i=0; i<callingForm.srchin.length; i++) {
7825: if ( callingForm.srchin.options[i].value == 'dom') {
7826: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7827: }
7828: }
1.570 raeburn 7829: for (var i=0; i<callingForm.srchtype.length; i++) {
7830: if (callingForm.srchtype.options[i].value == 'exact') {
7831: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7832: }
7833: }
1.570 raeburn 7834: for (var i=0; i<callingForm.srchdomain.length; i++) {
7835: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7836: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7837: }
7838: }
7839: }
7840: }
7841: ENDSCRIPT
1.558 albertel 7842:
1.556 raeburn 7843: }
7844:
1.555 raeburn 7845: my $output = <<"END_BLOCK";
1.556 raeburn 7846: <script type="text/javascript">
1.824 bisitz 7847: // <![CDATA[
1.570 raeburn 7848: function validateEntry(callingForm) {
1.558 albertel 7849:
1.556 raeburn 7850: var checkok = 1;
1.558 albertel 7851: var srchin;
1.570 raeburn 7852: for (var i=0; i<callingForm.srchin.length; i++) {
7853: if ( callingForm.srchin[i].checked ) {
7854: srchin = callingForm.srchin[i].value;
1.558 albertel 7855: }
7856: }
7857:
1.570 raeburn 7858: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7859: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7860: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7861: var srchterm = callingForm.srchterm.value;
7862: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7863: var msg = "";
7864:
7865: if (srchterm == "") {
7866: checkok = 0;
1.571 raeburn 7867: msg += "$lt{'youm'}\\n";
1.556 raeburn 7868: }
7869:
1.569 raeburn 7870: if (srchtype== 'begins') {
7871: if (srchterm.length < 2) {
7872: checkok = 0;
1.571 raeburn 7873: msg += "$lt{'thte'}\\n";
1.569 raeburn 7874: }
7875: }
7876:
1.556 raeburn 7877: if (srchtype== 'contains') {
7878: if (srchterm.length < 3) {
7879: checkok = 0;
1.571 raeburn 7880: msg += "$lt{'thet'}\\n";
1.556 raeburn 7881: }
7882: }
7883: if (srchin == 'instd') {
7884: if (srchdomain == '') {
7885: checkok = 0;
1.571 raeburn 7886: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7887: }
7888: }
7889: if (srchin == 'dom') {
7890: if (srchdomain == '') {
7891: checkok = 0;
1.571 raeburn 7892: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7893: }
7894: }
7895: if (srchby == 'lastfirst') {
7896: if (srchterm.indexOf(",") == -1) {
7897: checkok = 0;
1.571 raeburn 7898: msg += "$lt{'whus'}\\n";
1.556 raeburn 7899: }
7900: if (srchterm.indexOf(",") == srchterm.length -1) {
7901: checkok = 0;
1.571 raeburn 7902: msg += "$lt{'whse'}\\n";
1.556 raeburn 7903: }
7904: }
7905: if (checkok == 0) {
1.571 raeburn 7906: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7907: return;
7908: }
7909: if (checkok == 1) {
1.570 raeburn 7910: callingForm.submit();
1.556 raeburn 7911: }
7912: }
7913:
7914: $newuserscript
7915:
1.824 bisitz 7916: // ]]>
1.556 raeburn 7917: </script>
1.558 albertel 7918:
7919: $new_user_create
7920:
1.555 raeburn 7921: END_BLOCK
1.558 albertel 7922:
1.876 raeburn 7923: $output .= &Apache::lonhtmlcommon::start_pick_box().
7924: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7925: $domform.
7926: &Apache::lonhtmlcommon::row_closure().
7927: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7928: $srchbysel.
7929: $srchtypesel.
7930: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7931: $srchinsel.
7932: &Apache::lonhtmlcommon::row_closure(1).
7933: &Apache::lonhtmlcommon::end_pick_box().
7934: '<br />';
1.555 raeburn 7935: return $output;
7936: }
7937:
1.612 raeburn 7938: sub user_rule_check {
1.615 raeburn 7939: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7940: my $response;
7941: if (ref($usershash) eq 'HASH') {
7942: foreach my $user (keys(%{$usershash})) {
7943: my ($uname,$udom) = split(/:/,$user);
7944: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7945: my ($id,$newuser);
1.612 raeburn 7946: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7947: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7948: $id = $usershash->{$user}->{'id'};
7949: }
7950: my $inst_response;
7951: if (ref($checks) eq 'HASH') {
7952: if (defined($checks->{'username'})) {
1.615 raeburn 7953: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7954: &Apache::lonnet::get_instuser($udom,$uname);
7955: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7956: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7957: &Apache::lonnet::get_instuser($udom,undef,$id);
7958: }
1.615 raeburn 7959: } else {
7960: ($inst_response,%{$inst_results->{$user}}) =
7961: &Apache::lonnet::get_instuser($udom,$uname);
7962: return;
1.612 raeburn 7963: }
1.615 raeburn 7964: if (!$got_rules->{$udom}) {
1.612 raeburn 7965: my %domconfig = &Apache::lonnet::get_dom('configuration',
7966: ['usercreation'],$udom);
7967: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7968: foreach my $item ('username','id') {
1.612 raeburn 7969: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7970: $$curr_rules{$udom}{$item} =
7971: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7972: }
7973: }
7974: }
1.615 raeburn 7975: $got_rules->{$udom} = 1;
1.585 raeburn 7976: }
1.612 raeburn 7977: foreach my $item (keys(%{$checks})) {
7978: if (ref($$curr_rules{$udom}) eq 'HASH') {
7979: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7980: if (@{$$curr_rules{$udom}{$item}} > 0) {
7981: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7982: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7983: if ($rule_check{$rule}) {
7984: $$rulematch{$user}{$item} = $rule;
7985: if ($inst_response eq 'ok') {
1.615 raeburn 7986: if (ref($inst_results) eq 'HASH') {
7987: if (ref($inst_results->{$user}) eq 'HASH') {
7988: if (keys(%{$inst_results->{$user}}) == 0) {
7989: $$alerts{$item}{$udom}{$uname} = 1;
7990: }
1.612 raeburn 7991: }
7992: }
1.615 raeburn 7993: }
7994: last;
1.585 raeburn 7995: }
7996: }
7997: }
7998: }
7999: }
8000: }
8001: }
8002: }
1.612 raeburn 8003: return;
8004: }
8005:
8006: sub user_rule_formats {
8007: my ($domain,$domdesc,$curr_rules,$check) = @_;
8008: my %text = (
8009: 'username' => 'Usernames',
8010: 'id' => 'IDs',
8011: );
8012: my $output;
8013: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8014: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8015: if (@{$ruleorder} > 0) {
8016: $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>';
8017: foreach my $rule (@{$ruleorder}) {
8018: if (ref($curr_rules) eq 'ARRAY') {
8019: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8020: if (ref($rules->{$rule}) eq 'HASH') {
8021: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8022: $rules->{$rule}{'desc'}.'</li>';
8023: }
8024: }
8025: }
8026: }
8027: $output .= '</ul>';
8028: }
8029: }
8030: return $output;
8031: }
8032:
8033: sub instrule_disallow_msg {
1.615 raeburn 8034: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8035: my $response;
8036: my %text = (
8037: item => 'username',
8038: items => 'usernames',
8039: match => 'matches',
8040: do => 'does',
8041: action => 'a username',
8042: one => 'one',
8043: );
8044: if ($count > 1) {
8045: $text{'item'} = 'usernames';
8046: $text{'match'} ='match';
8047: $text{'do'} = 'do';
8048: $text{'action'} = 'usernames',
8049: $text{'one'} = 'ones';
8050: }
8051: if ($checkitem eq 'id') {
8052: $text{'items'} = 'IDs';
8053: $text{'item'} = 'ID';
8054: $text{'action'} = 'an ID';
1.615 raeburn 8055: if ($count > 1) {
8056: $text{'item'} = 'IDs';
8057: $text{'action'} = 'IDs';
8058: }
1.612 raeburn 8059: }
1.674 bisitz 8060: $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 8061: if ($mode eq 'upload') {
8062: if ($checkitem eq 'username') {
8063: $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'}.");
8064: } elsif ($checkitem eq 'id') {
1.674 bisitz 8065: $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 8066: }
1.669 raeburn 8067: } elsif ($mode eq 'selfcreate') {
8068: if ($checkitem eq 'id') {
8069: $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.");
8070: }
1.615 raeburn 8071: } else {
8072: if ($checkitem eq 'username') {
8073: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8074: } elsif ($checkitem eq 'id') {
8075: $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.");
8076: }
1.612 raeburn 8077: }
8078: return $response;
1.585 raeburn 8079: }
8080:
1.624 raeburn 8081: sub personal_data_fieldtitles {
8082: my %fieldtitles = &Apache::lonlocal::texthash (
8083: id => 'Student/Employee ID',
8084: permanentemail => 'E-mail address',
8085: lastname => 'Last Name',
8086: firstname => 'First Name',
8087: middlename => 'Middle Name',
8088: generation => 'Generation',
8089: gen => 'Generation',
1.765 raeburn 8090: inststatus => 'Affiliation',
1.624 raeburn 8091: );
8092: return %fieldtitles;
8093: }
8094:
1.642 raeburn 8095: sub sorted_inst_types {
8096: my ($dom) = @_;
8097: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8098: my $othertitle = &mt('All users');
8099: if ($env{'request.course.id'}) {
1.668 raeburn 8100: $othertitle = &mt('Any users');
1.642 raeburn 8101: }
8102: my @types;
8103: if (ref($order) eq 'ARRAY') {
8104: @types = @{$order};
8105: }
8106: if (@types == 0) {
8107: if (ref($usertypes) eq 'HASH') {
8108: @types = sort(keys(%{$usertypes}));
8109: }
8110: }
8111: if (keys(%{$usertypes}) > 0) {
8112: $othertitle = &mt('Other users');
8113: }
8114: return ($othertitle,$usertypes,\@types);
8115: }
8116:
1.645 raeburn 8117: sub get_institutional_codes {
8118: my ($settings,$allcourses,$LC_code) = @_;
8119: # Get complete list of course sections to update
8120: my @currsections = ();
8121: my @currxlists = ();
8122: my $coursecode = $$settings{'internal.coursecode'};
8123:
8124: if ($$settings{'internal.sectionnums'} ne '') {
8125: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8126: }
8127:
8128: if ($$settings{'internal.crosslistings'} ne '') {
8129: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8130: }
8131:
8132: if (@currxlists > 0) {
8133: foreach (@currxlists) {
8134: if (m/^([^:]+):(\w*)$/) {
8135: unless (grep/^$1$/,@{$allcourses}) {
8136: push @{$allcourses},$1;
8137: $$LC_code{$1} = $2;
8138: }
8139: }
8140: }
8141: }
8142:
8143: if (@currsections > 0) {
8144: foreach (@currsections) {
8145: if (m/^(\w+):(\w*)$/) {
8146: my $sec = $coursecode.$1;
8147: my $lc_sec = $2;
8148: unless (grep/^$sec$/,@{$allcourses}) {
8149: push @{$allcourses},$sec;
8150: $$LC_code{$sec} = $lc_sec;
8151: }
8152: }
8153: }
8154: }
8155: return;
8156: }
8157:
1.112 bowersj2 8158: =pod
8159:
1.780 raeburn 8160: =head1 Slot Helpers
8161:
8162: =over 4
8163:
8164: =item * sorted_slots()
8165:
8166: Sorts an array of slot names in order of slot start time (earliest first).
8167:
8168: Inputs:
8169:
8170: =over 4
8171:
8172: slotsarr - Reference to array of unsorted slot names.
8173:
8174: slots - Reference to hash of hash, where outer hash keys are slot names.
8175:
1.549 albertel 8176: =back
8177:
1.780 raeburn 8178: Returns:
8179:
8180: =over 4
8181:
8182: sorted - An array of slot names sorted by the start time of the slot.
8183:
8184: =back
8185:
8186: =back
8187:
8188: =cut
8189:
8190:
8191: sub sorted_slots {
8192: my ($slotsarr,$slots) = @_;
8193: my @sorted;
8194: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8195: @sorted =
8196: sort {
8197: if (ref($slots->{$a}) && ref($slots->{$b})) {
8198: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8199: }
8200: if (ref($slots->{$a})) { return -1;}
8201: if (ref($slots->{$b})) { return 1;}
8202: return 0;
8203: } @{$slotsarr};
8204: }
8205: return @sorted;
8206: }
8207:
8208:
8209: =pod
8210:
1.549 albertel 8211: =head1 HTTP Helpers
8212:
8213: =over 4
8214:
1.648 raeburn 8215: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8216:
1.258 albertel 8217: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8218: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8219: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8220:
8221: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8222: $possible_names is an ref to an array of form element names. As an example:
8223: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8224: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8225:
8226: =cut
1.1 albertel 8227:
1.6 albertel 8228: sub get_unprocessed_cgi {
1.25 albertel 8229: my ($query,$possible_names)= @_;
1.26 matthew 8230: # $Apache::lonxml::debug=1;
1.356 albertel 8231: foreach my $pair (split(/&/,$query)) {
8232: my ($name, $value) = split(/=/,$pair);
1.369 www 8233: $name = &unescape($name);
1.25 albertel 8234: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8235: $value =~ tr/+/ /;
8236: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8237: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8238: }
1.16 harris41 8239: }
1.6 albertel 8240: }
8241:
1.112 bowersj2 8242: =pod
8243:
1.648 raeburn 8244: =item * &cacheheader()
1.112 bowersj2 8245:
8246: returns cache-controlling header code
8247:
8248: =cut
8249:
1.7 albertel 8250: sub cacheheader {
1.258 albertel 8251: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8252: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8253: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8254: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8255: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8256: return $output;
1.7 albertel 8257: }
8258:
1.112 bowersj2 8259: =pod
8260:
1.648 raeburn 8261: =item * &no_cache($r)
1.112 bowersj2 8262:
8263: specifies header code to not have cache
8264:
8265: =cut
8266:
1.9 albertel 8267: sub no_cache {
1.216 albertel 8268: my ($r) = @_;
8269: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8270: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8271: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8272: $r->no_cache(1);
8273: $r->header_out("Expires" => $date);
8274: $r->header_out("Pragma" => "no-cache");
1.123 www 8275: }
8276:
8277: sub content_type {
1.181 albertel 8278: my ($r,$type,$charset) = @_;
1.299 foxr 8279: if ($r) {
8280: # Note that printout.pl calls this with undef for $r.
8281: &no_cache($r);
8282: }
1.258 albertel 8283: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8284: unless ($charset) {
8285: $charset=&Apache::lonlocal::current_encoding;
8286: }
8287: if ($charset) { $type.='; charset='.$charset; }
8288: if ($r) {
8289: $r->content_type($type);
8290: } else {
8291: print("Content-type: $type\n\n");
8292: }
1.9 albertel 8293: }
1.25 albertel 8294:
1.112 bowersj2 8295: =pod
8296:
1.648 raeburn 8297: =item * &add_to_env($name,$value)
1.112 bowersj2 8298:
1.258 albertel 8299: adds $name to the %env hash with value
1.112 bowersj2 8300: $value, if $name already exists, the entry is converted to an array
8301: reference and $value is added to the array.
8302:
8303: =cut
8304:
1.25 albertel 8305: sub add_to_env {
8306: my ($name,$value)=@_;
1.258 albertel 8307: if (defined($env{$name})) {
8308: if (ref($env{$name})) {
1.25 albertel 8309: #already have multiple values
1.258 albertel 8310: push(@{ $env{$name} },$value);
1.25 albertel 8311: } else {
8312: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8313: my $first=$env{$name};
8314: undef($env{$name});
8315: push(@{ $env{$name} },$first,$value);
1.25 albertel 8316: }
8317: } else {
1.258 albertel 8318: $env{$name}=$value;
1.25 albertel 8319: }
1.31 albertel 8320: }
1.149 albertel 8321:
8322: =pod
8323:
1.648 raeburn 8324: =item * &get_env_multiple($name)
1.149 albertel 8325:
1.258 albertel 8326: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8327: values may be defined and end up as an array ref.
8328:
8329: returns an array of values
8330:
8331: =cut
8332:
8333: sub get_env_multiple {
8334: my ($name) = @_;
8335: my @values;
1.258 albertel 8336: if (defined($env{$name})) {
1.149 albertel 8337: # exists is it an array
1.258 albertel 8338: if (ref($env{$name})) {
8339: @values=@{ $env{$name} };
1.149 albertel 8340: } else {
1.258 albertel 8341: $values[0]=$env{$name};
1.149 albertel 8342: }
8343: }
8344: return(@values);
8345: }
8346:
1.660 raeburn 8347: sub ask_for_embedded_content {
8348: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8349: my $upload_output = '
8350: <form name="upload_embedded" action="'.$actionurl.'"
8351: method="post" enctype="multipart/form-data">';
8352: $upload_output .= $state;
1.661 raeburn 8353: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8354:
8355: my $num = 0;
8356: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8357: $upload_output .= &start_data_table_row().
8358: '<td>'.$embed_file.'</td><td>';
8359: if ($args->{'ignore_remote_references'}
8360: && $embed_file =~ m{^\w+://}) {
8361: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8362: } elsif ($args->{'error_on_invalid_names'}
8363: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8364:
8365: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8366:
8367: } else {
8368: $upload_output .='
1.661 raeburn 8369: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8370: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8371: my $attrib = join(':',@{$$allfiles{$embed_file}});
8372: $upload_output .=
8373: "\n\t\t".
8374: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8375: $attrib.'" />';
8376: if (exists($$codebase{$embed_file})) {
8377: $upload_output .=
8378: "\n\t\t".
8379: '<input name="codebase_'.$num.'" type="hidden" value="'.
8380: &escape($$codebase{$embed_file}).'" />';
8381: }
8382: }
8383: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8384: $num++;
8385: }
8386: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8387: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8388: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8389: '.&mt('(only files for which a location has been provided will be uploaded)').'
8390: </form>';
8391: return $upload_output;
8392: }
8393:
1.661 raeburn 8394: sub upload_embedded {
8395: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8396: $current_disk_usage) = @_;
8397: my $output;
8398: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8399: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8400: my $orig_uploaded_filename =
8401: $env{'form.embedded_item_'.$i.'.filename'};
8402:
8403: $env{'form.embedded_orig_'.$i} =
8404: &unescape($env{'form.embedded_orig_'.$i});
8405: my ($path,$fname) =
8406: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8407: # no path, whole string is fname
8408: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8409:
8410: $path = $env{'form.currentpath'}.$path;
8411: $fname = &Apache::lonnet::clean_filename($fname);
8412: # See if there is anything left
8413: next if ($fname eq '');
8414:
8415: # Check if file already exists as a file or directory.
8416: my ($state,$msg);
8417: if ($context eq 'portfolio') {
8418: my $port_path = $dirpath;
8419: if ($group ne '') {
8420: $port_path = "groups/$group/$port_path";
8421: }
8422: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8423: $dir_root,$port_path,$disk_quota,
8424: $current_disk_usage,$uname,$udom);
8425: if ($state eq 'will_exceed_quota'
8426: || $state eq 'file_locked'
8427: || $state eq 'file_exists' ) {
8428: $output .= $msg;
8429: next;
8430: }
8431: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8432: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8433: if ($state eq 'exists') {
8434: $output .= $msg;
8435: next;
8436: }
8437: }
8438: # Check if extension is valid
8439: if (($fname =~ /\.(\w+)$/) &&
8440: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8441: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8442: next;
8443: } elsif (($fname =~ /\.(\w+)$/) &&
8444: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8445: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8446: next;
8447: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8448: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8449: next;
8450: }
8451:
8452: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8453: if ($context eq 'portfolio') {
8454: my $result=
8455: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8456: $dirpath.$path);
8457: if ($result !~ m|^/uploaded/|) {
8458: $output .= '<span class="LC_error">'
8459: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8460: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8461: .'</span><br />';
8462: next;
8463: } else {
8464: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8465: $path.$fname.'</span>').'</p>';
8466: }
8467: } else {
8468: # Save the file
8469: my $target = $env{'form.embedded_item_'.$i};
8470: my $fullpath = $dir_root.$dirpath.'/'.$path;
8471: my $dest = $fullpath.$fname;
8472: my $url = $url_root.$dirpath.'/'.$path.$fname;
8473: my @parts=split(/\//,$fullpath);
8474: my $count;
8475: my $filepath = $dir_root;
8476: for ($count=4;$count<=$#parts;$count++) {
8477: $filepath .= "/$parts[$count]";
8478: if ((-e $filepath)!=1) {
8479: mkdir($filepath,0770);
8480: }
8481: }
8482: my $fh;
8483: if (!open($fh,'>'.$dest)) {
8484: &Apache::lonnet::logthis('Failed to create '.$dest);
8485: $output .= '<span class="LC_error">'.
8486: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8487: '</span><br />';
8488: } else {
8489: if (!print $fh $env{'form.embedded_item_'.$i}) {
8490: &Apache::lonnet::logthis('Failed to write to '.$dest);
8491: $output .= '<span class="LC_error">'.
8492: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8493: '</span><br />';
8494: } else {
8495: if ($context eq 'testbank') {
8496: $output .= &mt('Embedded file uploaded successfully:').
8497: ' <a href="'.$url.'">'.
8498: $orig_uploaded_filename.'</a><br />';
8499: } else {
1.705 tempelho 8500: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8501: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8502: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8503: }
8504: }
8505: close($fh);
8506: }
8507: }
8508: }
8509: return $output;
8510: }
8511:
8512: sub check_for_existing {
8513: my ($path,$fname,$element) = @_;
8514: my ($state,$msg);
8515: if (-d $path.'/'.$fname) {
8516: $state = 'exists';
8517: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8518: } elsif (-e $path.'/'.$fname) {
8519: $state = 'exists';
8520: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8521: }
8522: if ($state eq 'exists') {
8523: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8524: }
8525: return ($state,$msg);
8526: }
8527:
8528: sub check_for_upload {
8529: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8530: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8531: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8532: my $getpropath = 1;
8533: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8534: $getpropath);
8535: my $found_file = 0;
8536: my $locked_file = 0;
8537: foreach my $line (@dir_list) {
8538: my ($file_name)=split(/\&/,$line,2);
8539: if ($file_name eq $fname){
8540: $file_name = $path.$file_name;
8541: if ($group ne '') {
8542: $file_name = $group.$file_name;
8543: }
8544: $found_file = 1;
8545: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8546: $locked_file = 1;
8547: }
8548: }
8549: }
8550: if (($current_disk_usage + $filesize) > $disk_quota){
8551: my $msg = '<span class="LC_error">'.
8552: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8553: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8554: return ('will_exceed_quota',$msg);
8555: } elsif ($found_file) {
8556: if ($locked_file) {
8557: my $msg = '<span class="LC_error">';
8558: $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>');
8559: $msg .= '</span><br />';
8560: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8561: return ('file_locked',$msg);
8562: } else {
8563: my $msg = '<span class="LC_error">';
8564: $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'});
8565: $msg .= '</span>';
8566: $msg .= '<br />';
8567: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8568: return ('file_exists',$msg);
8569: }
8570: }
8571: }
8572:
1.31 albertel 8573:
1.41 ng 8574: =pod
1.45 matthew 8575:
1.464 albertel 8576: =back
1.41 ng 8577:
1.112 bowersj2 8578: =head1 CSV Upload/Handling functions
1.38 albertel 8579:
1.41 ng 8580: =over 4
8581:
1.648 raeburn 8582: =item * &upfile_store($r)
1.41 ng 8583:
8584: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8585: needs $env{'form.upfile'}
1.41 ng 8586: returns $datatoken to be put into hidden field
8587:
8588: =cut
1.31 albertel 8589:
8590: sub upfile_store {
8591: my $r=shift;
1.258 albertel 8592: $env{'form.upfile'}=~s/\r/\n/gs;
8593: $env{'form.upfile'}=~s/\f/\n/gs;
8594: $env{'form.upfile'}=~s/\n+/\n/gs;
8595: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8596:
1.258 albertel 8597: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8598: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8599: {
1.158 raeburn 8600: my $datafile = $r->dir_config('lonDaemons').
8601: '/tmp/'.$datatoken.'.tmp';
8602: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8603: print $fh $env{'form.upfile'};
1.158 raeburn 8604: close($fh);
8605: }
1.31 albertel 8606: }
8607: return $datatoken;
8608: }
8609:
1.56 matthew 8610: =pod
8611:
1.648 raeburn 8612: =item * &load_tmp_file($r)
1.41 ng 8613:
8614: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8615: needs $env{'form.datatoken'},
8616: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8617:
8618: =cut
1.31 albertel 8619:
8620: sub load_tmp_file {
8621: my $r=shift;
8622: my @studentdata=();
8623: {
1.158 raeburn 8624: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8625: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8626: if ( open(my $fh,"<$studentfile") ) {
8627: @studentdata=<$fh>;
8628: close($fh);
8629: }
1.31 albertel 8630: }
1.258 albertel 8631: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8632: }
8633:
1.56 matthew 8634: =pod
8635:
1.648 raeburn 8636: =item * &upfile_record_sep()
1.41 ng 8637:
8638: Separate uploaded file into records
8639: returns array of records,
1.258 albertel 8640: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8641:
8642: =cut
1.31 albertel 8643:
8644: sub upfile_record_sep {
1.258 albertel 8645: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8646: } else {
1.248 albertel 8647: my @records;
1.258 albertel 8648: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8649: if ($line=~/^\s*$/) { next; }
8650: push(@records,$line);
8651: }
8652: return @records;
1.31 albertel 8653: }
8654: }
8655:
1.56 matthew 8656: =pod
8657:
1.648 raeburn 8658: =item * &record_sep($record)
1.41 ng 8659:
1.258 albertel 8660: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8661:
8662: =cut
8663:
1.263 www 8664: sub takeleft {
8665: my $index=shift;
8666: return substr('0000'.$index,-4,4);
8667: }
8668:
1.31 albertel 8669: sub record_sep {
8670: my $record=shift;
8671: my %components=();
1.258 albertel 8672: if ($env{'form.upfiletype'} eq 'xml') {
8673: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8674: my $i=0;
1.356 albertel 8675: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8676: $field=~s/^(\"|\')//;
8677: $field=~s/(\"|\')$//;
1.263 www 8678: $components{&takeleft($i)}=$field;
1.31 albertel 8679: $i++;
8680: }
1.258 albertel 8681: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8682: my $i=0;
1.356 albertel 8683: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8684: $field=~s/^(\"|\')//;
8685: $field=~s/(\"|\')$//;
1.263 www 8686: $components{&takeleft($i)}=$field;
1.31 albertel 8687: $i++;
8688: }
8689: } else {
1.561 www 8690: my $separator=',';
1.480 banghart 8691: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8692: $separator=';';
1.480 banghart 8693: }
1.31 albertel 8694: my $i=0;
1.561 www 8695: # the character we are looking for to indicate the end of a quote or a record
8696: my $looking_for=$separator;
8697: # do not add the characters to the fields
8698: my $ignore=0;
8699: # we just encountered a separator (or the beginning of the record)
8700: my $just_found_separator=1;
8701: # store the field we are working on here
8702: my $field='';
8703: # work our way through all characters in record
8704: foreach my $character ($record=~/(.)/g) {
8705: if ($character eq $looking_for) {
8706: if ($character ne $separator) {
8707: # Found the end of a quote, again looking for separator
8708: $looking_for=$separator;
8709: $ignore=1;
8710: } else {
8711: # Found a separator, store away what we got
8712: $components{&takeleft($i)}=$field;
8713: $i++;
8714: $just_found_separator=1;
8715: $ignore=0;
8716: $field='';
8717: }
8718: next;
8719: }
8720: # single or double quotation marks after a separator indicate beginning of a quote
8721: # we are now looking for the end of the quote and need to ignore separators
8722: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8723: $looking_for=$character;
8724: next;
8725: }
8726: # ignore would be true after we reached the end of a quote
8727: if ($ignore) { next; }
8728: if (($just_found_separator) && ($character=~/\s/)) { next; }
8729: $field.=$character;
8730: $just_found_separator=0;
1.31 albertel 8731: }
1.561 www 8732: # catch the very last entry, since we never encountered the separator
8733: $components{&takeleft($i)}=$field;
1.31 albertel 8734: }
8735: return %components;
8736: }
8737:
1.144 matthew 8738: ######################################################
8739: ######################################################
8740:
1.56 matthew 8741: =pod
8742:
1.648 raeburn 8743: =item * &upfile_select_html()
1.41 ng 8744:
1.144 matthew 8745: Return HTML code to select a file from the users machine and specify
8746: the file type.
1.41 ng 8747:
8748: =cut
8749:
1.144 matthew 8750: ######################################################
8751: ######################################################
1.31 albertel 8752: sub upfile_select_html {
1.144 matthew 8753: my %Types = (
8754: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8755: semisv => &mt('Semicolon separated values'),
1.144 matthew 8756: space => &mt('Space separated'),
8757: tab => &mt('Tabulator separated'),
8758: # xml => &mt('HTML/XML'),
8759: );
8760: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8761: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8762: foreach my $type (sort(keys(%Types))) {
8763: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8764: }
8765: $Str .= "</select>\n";
8766: return $Str;
1.31 albertel 8767: }
8768:
1.301 albertel 8769: sub get_samples {
8770: my ($records,$toget) = @_;
8771: my @samples=({});
8772: my $got=0;
8773: foreach my $rec (@$records) {
8774: my %temp = &record_sep($rec);
8775: if (! grep(/\S/, values(%temp))) { next; }
8776: if (%temp) {
8777: $samples[$got]=\%temp;
8778: $got++;
8779: if ($got == $toget) { last; }
8780: }
8781: }
8782: return \@samples;
8783: }
8784:
1.144 matthew 8785: ######################################################
8786: ######################################################
8787:
1.56 matthew 8788: =pod
8789:
1.648 raeburn 8790: =item * &csv_print_samples($r,$records)
1.41 ng 8791:
8792: Prints a table of sample values from each column uploaded $r is an
8793: Apache Request ref, $records is an arrayref from
8794: &Apache::loncommon::upfile_record_sep
8795:
8796: =cut
8797:
1.144 matthew 8798: ######################################################
8799: ######################################################
1.31 albertel 8800: sub csv_print_samples {
8801: my ($r,$records) = @_;
1.662 bisitz 8802: my $samples = &get_samples($records,5);
1.301 albertel 8803:
1.594 raeburn 8804: $r->print(&mt('Samples').'<br />'.&start_data_table().
8805: &start_data_table_header_row());
1.356 albertel 8806: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8807: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8808: $r->print(&end_data_table_header_row());
1.301 albertel 8809: foreach my $hash (@$samples) {
1.594 raeburn 8810: $r->print(&start_data_table_row());
1.356 albertel 8811: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8812: $r->print('<td>');
1.356 albertel 8813: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8814: $r->print('</td>');
8815: }
1.594 raeburn 8816: $r->print(&end_data_table_row());
1.31 albertel 8817: }
1.594 raeburn 8818: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8819: }
8820:
1.144 matthew 8821: ######################################################
8822: ######################################################
8823:
1.56 matthew 8824: =pod
8825:
1.648 raeburn 8826: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8827:
8828: Prints a table to create associations between values and table columns.
1.144 matthew 8829:
1.41 ng 8830: $r is an Apache Request ref,
8831: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8832: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8833:
8834: =cut
8835:
1.144 matthew 8836: ######################################################
8837: ######################################################
1.31 albertel 8838: sub csv_print_select_table {
8839: my ($r,$records,$d) = @_;
1.301 albertel 8840: my $i=0;
8841: my $samples = &get_samples($records,1);
1.144 matthew 8842: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8843: &start_data_table().&start_data_table_header_row().
1.144 matthew 8844: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8845: '<th>'.&mt('Column').'</th>'.
8846: &end_data_table_header_row()."\n");
1.356 albertel 8847: foreach my $array_ref (@$d) {
8848: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8849: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8850:
1.875 bisitz 8851: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8852: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8853: $r->print('<option value="none"></option>');
1.356 albertel 8854: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8855: $r->print('<option value="'.$sample.'"'.
8856: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8857: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8858: }
1.594 raeburn 8859: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8860: $i++;
8861: }
1.594 raeburn 8862: $r->print(&end_data_table());
1.31 albertel 8863: $i--;
8864: return $i;
8865: }
1.56 matthew 8866:
1.144 matthew 8867: ######################################################
8868: ######################################################
8869:
1.56 matthew 8870: =pod
1.31 albertel 8871:
1.648 raeburn 8872: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8873:
8874: Prints a table of sample values from the upload and can make associate samples to internal names.
8875:
8876: $r is an Apache Request ref,
8877: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8878: $d is an array of 2 element arrays (internal name, displayed name)
8879:
8880: =cut
8881:
1.144 matthew 8882: ######################################################
8883: ######################################################
1.31 albertel 8884: sub csv_samples_select_table {
8885: my ($r,$records,$d) = @_;
8886: my $i=0;
1.144 matthew 8887: #
1.662 bisitz 8888: my $max_samples = 5;
8889: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8890: $r->print(&start_data_table().
8891: &start_data_table_header_row().'<th>'.
8892: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8893: &end_data_table_header_row());
1.301 albertel 8894:
8895: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8896: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8897: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8898: foreach my $option (@$d) {
8899: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8900: $r->print('<option value="'.$value.'"'.
1.253 albertel 8901: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8902: $display.'</option>');
1.31 albertel 8903: }
8904: $r->print('</select></td><td>');
1.662 bisitz 8905: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8906: if (defined($samples->[$line]{$key})) {
8907: $r->print($samples->[$line]{$key}."<br />\n");
8908: }
8909: }
1.594 raeburn 8910: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8911: $i++;
8912: }
1.594 raeburn 8913: $r->print(&end_data_table());
1.31 albertel 8914: $i--;
8915: return($i);
1.115 matthew 8916: }
8917:
1.144 matthew 8918: ######################################################
8919: ######################################################
8920:
1.115 matthew 8921: =pod
8922:
1.648 raeburn 8923: =item * &clean_excel_name($name)
1.115 matthew 8924:
8925: Returns a replacement for $name which does not contain any illegal characters.
8926:
8927: =cut
8928:
1.144 matthew 8929: ######################################################
8930: ######################################################
1.115 matthew 8931: sub clean_excel_name {
8932: my ($name) = @_;
8933: $name =~ s/[:\*\?\/\\]//g;
8934: if (length($name) > 31) {
8935: $name = substr($name,0,31);
8936: }
8937: return $name;
1.25 albertel 8938: }
1.84 albertel 8939:
1.85 albertel 8940: =pod
8941:
1.648 raeburn 8942: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8943:
8944: Returns either 1 or undef
8945:
8946: 1 if the part is to be hidden, undef if it is to be shown
8947:
8948: Arguments are:
8949:
8950: $id the id of the part to be checked
8951: $symb, optional the symb of the resource to check
8952: $udom, optional the domain of the user to check for
8953: $uname, optional the username of the user to check for
8954:
8955: =cut
1.84 albertel 8956:
8957: sub check_if_partid_hidden {
8958: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8959: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8960: $symb,$udom,$uname);
1.141 albertel 8961: my $truth=1;
8962: #if the string starts with !, then the list is the list to show not hide
8963: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8964: my @hiddenlist=split(/,/,$hiddenparts);
8965: foreach my $checkid (@hiddenlist) {
1.141 albertel 8966: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8967: }
1.141 albertel 8968: return !$truth;
1.84 albertel 8969: }
1.127 matthew 8970:
1.138 matthew 8971:
8972: ############################################################
8973: ############################################################
8974:
8975: =pod
8976:
1.157 matthew 8977: =back
8978:
1.138 matthew 8979: =head1 cgi-bin script and graphing routines
8980:
1.157 matthew 8981: =over 4
8982:
1.648 raeburn 8983: =item * &get_cgi_id()
1.138 matthew 8984:
8985: Inputs: none
8986:
8987: Returns an id which can be used to pass environment variables
8988: to various cgi-bin scripts. These environment variables will
8989: be removed from the users environment after a given time by
8990: the routine &Apache::lonnet::transfer_profile_to_env.
8991:
8992: =cut
8993:
8994: ############################################################
8995: ############################################################
1.152 albertel 8996: my $uniq=0;
1.136 matthew 8997: sub get_cgi_id {
1.154 albertel 8998: $uniq=($uniq+1)%100000;
1.280 albertel 8999: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 9000: }
9001:
1.127 matthew 9002: ############################################################
9003: ############################################################
9004:
9005: =pod
9006:
1.648 raeburn 9007: =item * &DrawBarGraph()
1.127 matthew 9008:
1.138 matthew 9009: Facilitates the plotting of data in a (stacked) bar graph.
9010: Puts plot definition data into the users environment in order for
9011: graph.png to plot it. Returns an <img> tag for the plot.
9012: The bars on the plot are labeled '1','2',...,'n'.
9013:
9014: Inputs:
9015:
9016: =over 4
9017:
9018: =item $Title: string, the title of the plot
9019:
9020: =item $xlabel: string, text describing the X-axis of the plot
9021:
9022: =item $ylabel: string, text describing the Y-axis of the plot
9023:
9024: =item $Max: scalar, the maximum Y value to use in the plot
9025: If $Max is < any data point, the graph will not be rendered.
9026:
1.140 matthew 9027: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9028: they are plotted. If undefined, default values will be used.
9029:
1.178 matthew 9030: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9031:
1.138 matthew 9032: =item @Values: An array of array references. Each array reference holds data
9033: to be plotted in a stacked bar chart.
9034:
1.239 matthew 9035: =item If the final element of @Values is a hash reference the key/value
9036: pairs will be added to the graph definition.
9037:
1.138 matthew 9038: =back
9039:
9040: Returns:
9041:
9042: An <img> tag which references graph.png and the appropriate identifying
9043: information for the plot.
9044:
1.127 matthew 9045: =cut
9046:
9047: ############################################################
9048: ############################################################
1.134 matthew 9049: sub DrawBarGraph {
1.178 matthew 9050: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9051: #
9052: if (! defined($colors)) {
9053: $colors = ['#33ff00',
9054: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9055: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9056: ];
9057: }
1.228 matthew 9058: my $extra_settings = {};
9059: if (ref($Values[-1]) eq 'HASH') {
9060: $extra_settings = pop(@Values);
9061: }
1.127 matthew 9062: #
1.136 matthew 9063: my $identifier = &get_cgi_id();
9064: my $id = 'cgi.'.$identifier;
1.129 matthew 9065: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9066: return '';
9067: }
1.225 matthew 9068: #
9069: my @Labels;
9070: if (defined($labels)) {
9071: @Labels = @$labels;
9072: } else {
9073: for (my $i=0;$i<@{$Values[0]};$i++) {
9074: push (@Labels,$i+1);
9075: }
9076: }
9077: #
1.129 matthew 9078: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9079: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9080: my %ValuesHash;
9081: my $NumSets=1;
9082: foreach my $array (@Values) {
9083: next if (! ref($array));
1.136 matthew 9084: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9085: join(',',@$array);
1.129 matthew 9086: }
1.127 matthew 9087: #
1.136 matthew 9088: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9089: if ($NumBars < 3) {
9090: $width = 120+$NumBars*32;
1.220 matthew 9091: $xskip = 1;
1.225 matthew 9092: $bar_width = 30;
9093: } elsif ($NumBars < 5) {
9094: $width = 120+$NumBars*20;
9095: $xskip = 1;
9096: $bar_width = 20;
1.220 matthew 9097: } elsif ($NumBars < 10) {
1.136 matthew 9098: $width = 120+$NumBars*15;
9099: $xskip = 1;
9100: $bar_width = 15;
9101: } elsif ($NumBars <= 25) {
9102: $width = 120+$NumBars*11;
9103: $xskip = 5;
9104: $bar_width = 8;
9105: } elsif ($NumBars <= 50) {
9106: $width = 120+$NumBars*8;
9107: $xskip = 5;
9108: $bar_width = 4;
9109: } else {
9110: $width = 120+$NumBars*8;
9111: $xskip = 5;
9112: $bar_width = 4;
9113: }
9114: #
1.137 matthew 9115: $Max = 1 if ($Max < 1);
9116: if ( int($Max) < $Max ) {
9117: $Max++;
9118: $Max = int($Max);
9119: }
1.127 matthew 9120: $Title = '' if (! defined($Title));
9121: $xlabel = '' if (! defined($xlabel));
9122: $ylabel = '' if (! defined($ylabel));
1.369 www 9123: $ValuesHash{$id.'.title'} = &escape($Title);
9124: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9125: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9126: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9127: $ValuesHash{$id.'.NumBars'} = $NumBars;
9128: $ValuesHash{$id.'.NumSets'} = $NumSets;
9129: $ValuesHash{$id.'.PlotType'} = 'bar';
9130: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9131: $ValuesHash{$id.'.height'} = $height;
9132: $ValuesHash{$id.'.width'} = $width;
9133: $ValuesHash{$id.'.xskip'} = $xskip;
9134: $ValuesHash{$id.'.bar_width'} = $bar_width;
9135: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9136: #
1.228 matthew 9137: # Deal with other parameters
9138: while (my ($key,$value) = each(%$extra_settings)) {
9139: $ValuesHash{$id.'.'.$key} = $value;
9140: }
9141: #
1.646 raeburn 9142: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9143: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9144: }
9145:
9146: ############################################################
9147: ############################################################
9148:
9149: =pod
9150:
1.648 raeburn 9151: =item * &DrawXYGraph()
1.137 matthew 9152:
1.138 matthew 9153: Facilitates the plotting of data in an XY graph.
9154: Puts plot definition data into the users environment in order for
9155: graph.png to plot it. Returns an <img> tag for the plot.
9156:
9157: Inputs:
9158:
9159: =over 4
9160:
9161: =item $Title: string, the title of the plot
9162:
9163: =item $xlabel: string, text describing the X-axis of the plot
9164:
9165: =item $ylabel: string, text describing the Y-axis of the plot
9166:
9167: =item $Max: scalar, the maximum Y value to use in the plot
9168: If $Max is < any data point, the graph will not be rendered.
9169:
9170: =item $colors: Array ref containing the hex color codes for the data to be
9171: plotted in. If undefined, default values will be used.
9172:
9173: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9174:
9175: =item $Ydata: Array ref containing Array refs.
1.185 www 9176: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9177:
9178: =item %Values: hash indicating or overriding any default values which are
9179: passed to graph.png.
9180: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9181:
9182: =back
9183:
9184: Returns:
9185:
9186: An <img> tag which references graph.png and the appropriate identifying
9187: information for the plot.
9188:
1.137 matthew 9189: =cut
9190:
9191: ############################################################
9192: ############################################################
9193: sub DrawXYGraph {
9194: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9195: #
9196: # Create the identifier for the graph
9197: my $identifier = &get_cgi_id();
9198: my $id = 'cgi.'.$identifier;
9199: #
9200: $Title = '' if (! defined($Title));
9201: $xlabel = '' if (! defined($xlabel));
9202: $ylabel = '' if (! defined($ylabel));
9203: my %ValuesHash =
9204: (
1.369 www 9205: $id.'.title' => &escape($Title),
9206: $id.'.xlabel' => &escape($xlabel),
9207: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9208: $id.'.y_max_value'=> $Max,
9209: $id.'.labels' => join(',',@$Xlabels),
9210: $id.'.PlotType' => 'XY',
9211: );
9212: #
9213: if (defined($colors) && ref($colors) eq 'ARRAY') {
9214: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9215: }
9216: #
9217: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9218: return '';
9219: }
9220: my $NumSets=1;
1.138 matthew 9221: foreach my $array (@{$Ydata}){
1.137 matthew 9222: next if (! ref($array));
9223: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9224: }
1.138 matthew 9225: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9226: #
9227: # Deal with other parameters
9228: while (my ($key,$value) = each(%Values)) {
9229: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9230: }
9231: #
1.646 raeburn 9232: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9233: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9234: }
9235:
9236: ############################################################
9237: ############################################################
9238:
9239: =pod
9240:
1.648 raeburn 9241: =item * &DrawXYYGraph()
1.138 matthew 9242:
9243: Facilitates the plotting of data in an XY graph with two Y axes.
9244: Puts plot definition data into the users environment in order for
9245: graph.png to plot it. Returns an <img> tag for the plot.
9246:
9247: Inputs:
9248:
9249: =over 4
9250:
9251: =item $Title: string, the title of the plot
9252:
9253: =item $xlabel: string, text describing the X-axis of the plot
9254:
9255: =item $ylabel: string, text describing the Y-axis of the plot
9256:
9257: =item $colors: Array ref containing the hex color codes for the data to be
9258: plotted in. If undefined, default values will be used.
9259:
9260: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9261:
9262: =item $Ydata1: The first data set
9263:
9264: =item $Min1: The minimum value of the left Y-axis
9265:
9266: =item $Max1: The maximum value of the left Y-axis
9267:
9268: =item $Ydata2: The second data set
9269:
9270: =item $Min2: The minimum value of the right Y-axis
9271:
9272: =item $Max2: The maximum value of the left Y-axis
9273:
9274: =item %Values: hash indicating or overriding any default values which are
9275: passed to graph.png.
9276: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9277:
9278: =back
9279:
9280: Returns:
9281:
9282: An <img> tag which references graph.png and the appropriate identifying
9283: information for the plot.
1.136 matthew 9284:
9285: =cut
9286:
9287: ############################################################
9288: ############################################################
1.137 matthew 9289: sub DrawXYYGraph {
9290: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9291: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9292: #
9293: # Create the identifier for the graph
9294: my $identifier = &get_cgi_id();
9295: my $id = 'cgi.'.$identifier;
9296: #
9297: $Title = '' if (! defined($Title));
9298: $xlabel = '' if (! defined($xlabel));
9299: $ylabel = '' if (! defined($ylabel));
9300: my %ValuesHash =
9301: (
1.369 www 9302: $id.'.title' => &escape($Title),
9303: $id.'.xlabel' => &escape($xlabel),
9304: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9305: $id.'.labels' => join(',',@$Xlabels),
9306: $id.'.PlotType' => 'XY',
9307: $id.'.NumSets' => 2,
1.137 matthew 9308: $id.'.two_axes' => 1,
9309: $id.'.y1_max_value' => $Max1,
9310: $id.'.y1_min_value' => $Min1,
9311: $id.'.y2_max_value' => $Max2,
9312: $id.'.y2_min_value' => $Min2,
1.136 matthew 9313: );
9314: #
1.137 matthew 9315: if (defined($colors) && ref($colors) eq 'ARRAY') {
9316: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9317: }
9318: #
9319: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9320: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9321: return '';
9322: }
9323: my $NumSets=1;
1.137 matthew 9324: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9325: next if (! ref($array));
9326: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9327: }
9328: #
9329: # Deal with other parameters
9330: while (my ($key,$value) = each(%Values)) {
9331: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9332: }
9333: #
1.646 raeburn 9334: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9335: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9336: }
9337:
9338: ############################################################
9339: ############################################################
9340:
9341: =pod
9342:
1.157 matthew 9343: =back
9344:
1.139 matthew 9345: =head1 Statistics helper routines?
9346:
9347: Bad place for them but what the hell.
9348:
1.157 matthew 9349: =over 4
9350:
1.648 raeburn 9351: =item * &chartlink()
1.139 matthew 9352:
9353: Returns a link to the chart for a specific student.
9354:
9355: Inputs:
9356:
9357: =over 4
9358:
9359: =item $linktext: The text of the link
9360:
9361: =item $sname: The students username
9362:
9363: =item $sdomain: The students domain
9364:
9365: =back
9366:
1.157 matthew 9367: =back
9368:
1.139 matthew 9369: =cut
9370:
9371: ############################################################
9372: ############################################################
9373: sub chartlink {
9374: my ($linktext, $sname, $sdomain) = @_;
9375: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9376: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9377: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9378: '">'.$linktext.'</a>';
1.153 matthew 9379: }
9380:
9381: #######################################################
9382: #######################################################
9383:
9384: =pod
9385:
9386: =head1 Course Environment Routines
1.157 matthew 9387:
9388: =over 4
1.153 matthew 9389:
1.648 raeburn 9390: =item * &restore_course_settings()
1.153 matthew 9391:
1.648 raeburn 9392: =item * &store_course_settings()
1.153 matthew 9393:
9394: Restores/Store indicated form parameters from the course environment.
9395: Will not overwrite existing values of the form parameters.
9396:
9397: Inputs:
9398: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9399:
9400: a hash ref describing the data to be stored. For example:
9401:
9402: %Save_Parameters = ('Status' => 'scalar',
9403: 'chartoutputmode' => 'scalar',
9404: 'chartoutputdata' => 'scalar',
9405: 'Section' => 'array',
1.373 raeburn 9406: 'Group' => 'array',
1.153 matthew 9407: 'StudentData' => 'array',
9408: 'Maps' => 'array');
9409:
9410: Returns: both routines return nothing
9411:
1.631 raeburn 9412: =back
9413:
1.153 matthew 9414: =cut
9415:
9416: #######################################################
9417: #######################################################
9418: sub store_course_settings {
1.496 albertel 9419: return &store_settings($env{'request.course.id'},@_);
9420: }
9421:
9422: sub store_settings {
1.153 matthew 9423: # save to the environment
9424: # appenv the same items, just to be safe
1.300 albertel 9425: my $udom = $env{'user.domain'};
9426: my $uname = $env{'user.name'};
1.496 albertel 9427: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9428: my %SaveHash;
9429: my %AppHash;
9430: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9431: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9432: my $envname = 'environment.'.$basename;
1.258 albertel 9433: if (exists($env{'form.'.$setting})) {
1.153 matthew 9434: # Save this value away
9435: if ($type eq 'scalar' &&
1.258 albertel 9436: (! exists($env{$envname}) ||
9437: $env{$envname} ne $env{'form.'.$setting})) {
9438: $SaveHash{$basename} = $env{'form.'.$setting};
9439: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9440: } elsif ($type eq 'array') {
9441: my $stored_form;
1.258 albertel 9442: if (ref($env{'form.'.$setting})) {
1.153 matthew 9443: $stored_form = join(',',
9444: map {
1.369 www 9445: &escape($_);
1.258 albertel 9446: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9447: } else {
9448: $stored_form =
1.369 www 9449: &escape($env{'form.'.$setting});
1.153 matthew 9450: }
9451: # Determine if the array contents are the same.
1.258 albertel 9452: if ($stored_form ne $env{$envname}) {
1.153 matthew 9453: $SaveHash{$basename} = $stored_form;
9454: $AppHash{$envname} = $stored_form;
9455: }
9456: }
9457: }
9458: }
9459: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9460: $udom,$uname);
1.153 matthew 9461: if ($put_result !~ /^(ok|delayed)/) {
9462: &Apache::lonnet::logthis('unable to save form parameters, '.
9463: 'got error:'.$put_result);
9464: }
9465: # Make sure these settings stick around in this session, too
1.646 raeburn 9466: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9467: return;
9468: }
9469:
9470: sub restore_course_settings {
1.499 albertel 9471: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9472: }
9473:
9474: sub restore_settings {
9475: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9476: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9477: next if (exists($env{'form.'.$setting}));
1.496 albertel 9478: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9479: '.'.$setting;
1.258 albertel 9480: if (exists($env{$envname})) {
1.153 matthew 9481: if ($type eq 'scalar') {
1.258 albertel 9482: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9483: } elsif ($type eq 'array') {
1.258 albertel 9484: $env{'form.'.$setting} = [
1.153 matthew 9485: map {
1.369 www 9486: &unescape($_);
1.258 albertel 9487: } split(',',$env{$envname})
1.153 matthew 9488: ];
9489: }
9490: }
9491: }
1.127 matthew 9492: }
9493:
1.618 raeburn 9494: #######################################################
9495: #######################################################
9496:
9497: =pod
9498:
9499: =head1 Domain E-mail Routines
9500:
9501: =over 4
9502:
1.648 raeburn 9503: =item * &build_recipient_list()
1.618 raeburn 9504:
1.884 raeburn 9505: Build recipient lists for five types of e-mail:
1.766 raeburn 9506: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9507: (d) Help requests, (e) Course requests needing approval, generated by
9508: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9509: loncoursequeueadmin.pm respectively.
1.618 raeburn 9510:
9511: Inputs:
1.619 raeburn 9512: defmail (scalar - email address of default recipient),
1.618 raeburn 9513: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9514: defdom (domain for which to retrieve configuration settings),
9515: origmail (scalar - email address of recipient from loncapa.conf,
9516: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9517:
1.655 raeburn 9518: Returns: comma separated list of addresses to which to send e-mail.
9519:
9520: =back
1.618 raeburn 9521:
9522: =cut
9523:
9524: ############################################################
9525: ############################################################
9526: sub build_recipient_list {
1.619 raeburn 9527: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9528: my @recipients;
9529: my $otheremails;
9530: my %domconfig =
9531: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9532: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9533: if (exists($domconfig{'contacts'}{$mailing})) {
9534: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9535: my @contacts = ('adminemail','supportemail');
9536: foreach my $item (@contacts) {
9537: if ($domconfig{'contacts'}{$mailing}{$item}) {
9538: my $addr = $domconfig{'contacts'}{$item};
9539: if (!grep(/^\Q$addr\E$/,@recipients)) {
9540: push(@recipients,$addr);
9541: }
1.619 raeburn 9542: }
1.766 raeburn 9543: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9544: }
9545: }
1.766 raeburn 9546: } elsif ($origmail ne '') {
9547: push(@recipients,$origmail);
1.618 raeburn 9548: }
1.619 raeburn 9549: } elsif ($origmail ne '') {
9550: push(@recipients,$origmail);
1.618 raeburn 9551: }
1.688 raeburn 9552: if (defined($defmail)) {
9553: if ($defmail ne '') {
9554: push(@recipients,$defmail);
9555: }
1.618 raeburn 9556: }
9557: if ($otheremails) {
1.619 raeburn 9558: my @others;
9559: if ($otheremails =~ /,/) {
9560: @others = split(/,/,$otheremails);
1.618 raeburn 9561: } else {
1.619 raeburn 9562: push(@others,$otheremails);
9563: }
9564: foreach my $addr (@others) {
9565: if (!grep(/^\Q$addr\E$/,@recipients)) {
9566: push(@recipients,$addr);
9567: }
1.618 raeburn 9568: }
9569: }
1.619 raeburn 9570: my $recipientlist = join(',',@recipients);
1.618 raeburn 9571: return $recipientlist;
9572: }
9573:
1.127 matthew 9574: ############################################################
9575: ############################################################
1.154 albertel 9576:
1.655 raeburn 9577: =pod
9578:
9579: =head1 Course Catalog Routines
9580:
9581: =over 4
9582:
9583: =item * &gather_categories()
9584:
9585: Converts category definitions - keys of categories hash stored in
9586: coursecategories in configuration.db on the primary library server in a
9587: domain - to an array. Also generates javascript and idx hash used to
9588: generate Domain Coordinator interface for editing Course Categories.
9589:
9590: Inputs:
1.663 raeburn 9591:
1.655 raeburn 9592: categories (reference to hash of category definitions).
1.663 raeburn 9593:
1.655 raeburn 9594: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9595: categories and subcategories).
1.663 raeburn 9596:
1.655 raeburn 9597: idx (reference to hash of counters used in Domain Coordinator interface for
9598: editing Course Categories).
1.663 raeburn 9599:
1.655 raeburn 9600: jsarray (reference to array of categories used to create Javascript arrays for
9601: Domain Coordinator interface for editing Course Categories).
9602:
9603: Returns: nothing
9604:
9605: Side effects: populates cats, idx and jsarray.
9606:
9607: =cut
9608:
9609: sub gather_categories {
9610: my ($categories,$cats,$idx,$jsarray) = @_;
9611: my %counters;
9612: my $num = 0;
9613: foreach my $item (keys(%{$categories})) {
9614: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9615: if ($container eq '' && $depth == 0) {
9616: $cats->[$depth][$categories->{$item}] = $cat;
9617: } else {
9618: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9619: }
9620: my ($escitem,$tail) = split(/:/,$item,2);
9621: if ($counters{$tail} eq '') {
9622: $counters{$tail} = $num;
9623: $num ++;
9624: }
9625: if (ref($idx) eq 'HASH') {
9626: $idx->{$item} = $counters{$tail};
9627: }
9628: if (ref($jsarray) eq 'ARRAY') {
9629: push(@{$jsarray->[$counters{$tail}]},$item);
9630: }
9631: }
9632: return;
9633: }
9634:
9635: =pod
9636:
9637: =item * &extract_categories()
9638:
9639: Used to generate breadcrumb trails for course categories.
9640:
9641: Inputs:
1.663 raeburn 9642:
1.655 raeburn 9643: categories (reference to hash of category definitions).
1.663 raeburn 9644:
1.655 raeburn 9645: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9646: categories and subcategories).
1.663 raeburn 9647:
1.655 raeburn 9648: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9649:
1.655 raeburn 9650: allitems (reference to hash - key is category key
9651: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9652:
1.655 raeburn 9653: idx (reference to hash of counters used in Domain Coordinator interface for
9654: editing Course Categories).
1.663 raeburn 9655:
1.655 raeburn 9656: jsarray (reference to array of categories used to create Javascript arrays for
9657: Domain Coordinator interface for editing Course Categories).
9658:
1.665 raeburn 9659: subcats (reference to hash of arrays containing all subcategories within each
9660: category, -recursive)
9661:
1.655 raeburn 9662: Returns: nothing
9663:
9664: Side effects: populates trails and allitems hash references.
9665:
9666: =cut
9667:
9668: sub extract_categories {
1.665 raeburn 9669: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9670: if (ref($categories) eq 'HASH') {
9671: &gather_categories($categories,$cats,$idx,$jsarray);
9672: if (ref($cats->[0]) eq 'ARRAY') {
9673: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9674: my $name = $cats->[0][$i];
9675: my $item = &escape($name).'::0';
9676: my $trailstr;
9677: if ($name eq 'instcode') {
9678: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9679: } elsif ($name eq 'communities') {
9680: $trailstr = &mt('Communities');
1.655 raeburn 9681: } else {
9682: $trailstr = $name;
9683: }
9684: if ($allitems->{$item} eq '') {
9685: push(@{$trails},$trailstr);
9686: $allitems->{$item} = scalar(@{$trails})-1;
9687: }
9688: my @parents = ($name);
9689: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9690: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9691: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9692: if (ref($subcats) eq 'HASH') {
9693: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9694: }
9695: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9696: }
9697: } else {
9698: if (ref($subcats) eq 'HASH') {
9699: $subcats->{$item} = [];
1.655 raeburn 9700: }
9701: }
9702: }
9703: }
9704: }
9705: return;
9706: }
9707:
9708: =pod
9709:
9710: =item *&recurse_categories()
9711:
9712: Recursively used to generate breadcrumb trails for course categories.
9713:
9714: Inputs:
1.663 raeburn 9715:
1.655 raeburn 9716: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9717: categories and subcategories).
1.663 raeburn 9718:
1.655 raeburn 9719: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9720:
9721: category (current course category, for which breadcrumb trail is being generated).
9722:
9723: trails (reference to array of breadcrumb trails for each category).
9724:
1.655 raeburn 9725: allitems (reference to hash - key is category key
9726: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9727:
1.655 raeburn 9728: parents (array containing containers directories for current category,
9729: back to top level).
9730:
9731: Returns: nothing
9732:
9733: Side effects: populates trails and allitems hash references
9734:
9735: =cut
9736:
9737: sub recurse_categories {
1.665 raeburn 9738: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9739: my $shallower = $depth - 1;
9740: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9741: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9742: my $name = $cats->[$depth]{$category}[$k];
9743: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9744: my $trailstr = join(' -> ',(@{$parents},$category));
9745: if ($allitems->{$item} eq '') {
9746: push(@{$trails},$trailstr);
9747: $allitems->{$item} = scalar(@{$trails})-1;
9748: }
9749: my $deeper = $depth+1;
9750: push(@{$parents},$category);
1.665 raeburn 9751: if (ref($subcats) eq 'HASH') {
9752: my $subcat = &escape($name).':'.$category.':'.$depth;
9753: for (my $j=@{$parents}; $j>=0; $j--) {
9754: my $higher;
9755: if ($j > 0) {
9756: $higher = &escape($parents->[$j]).':'.
9757: &escape($parents->[$j-1]).':'.$j;
9758: } else {
9759: $higher = &escape($parents->[$j]).'::'.$j;
9760: }
9761: push(@{$subcats->{$higher}},$subcat);
9762: }
9763: }
9764: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9765: $subcats);
1.655 raeburn 9766: pop(@{$parents});
9767: }
9768: } else {
9769: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9770: my $trailstr = join(' -> ',(@{$parents},$category));
9771: if ($allitems->{$item} eq '') {
9772: push(@{$trails},$trailstr);
9773: $allitems->{$item} = scalar(@{$trails})-1;
9774: }
9775: }
9776: return;
9777: }
9778:
1.663 raeburn 9779: =pod
9780:
9781: =item *&assign_categories_table()
9782:
9783: Create a datatable for display of hierarchical categories in a domain,
9784: with checkboxes to allow a course to be categorized.
9785:
9786: Inputs:
9787:
9788: cathash - reference to hash of categories defined for the domain (from
9789: configuration.db)
9790:
9791: currcat - scalar with an & separated list of categories assigned to a course.
9792:
1.919 raeburn 9793: type - scalar contains course type (Course or Community).
9794:
1.663 raeburn 9795: Returns: $output (markup to be displayed)
9796:
9797: =cut
9798:
9799: sub assign_categories_table {
1.919 raeburn 9800: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9801: my $output;
9802: if (ref($cathash) eq 'HASH') {
9803: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9804: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9805: $maxdepth = scalar(@cats);
9806: if (@cats > 0) {
9807: my $itemcount = 0;
9808: if (ref($cats[0]) eq 'ARRAY') {
9809: my @currcategories;
9810: if ($currcat ne '') {
9811: @currcategories = split('&',$currcat);
9812: }
1.919 raeburn 9813: my $table;
1.663 raeburn 9814: for (my $i=0; $i<@{$cats[0]}; $i++) {
9815: my $parent = $cats[0][$i];
1.919 raeburn 9816: next if ($parent eq 'instcode');
9817: if ($type eq 'Community') {
9818: next unless ($parent eq 'communities');
9819: } else {
9820: next if ($parent eq 'communities');
9821: }
1.663 raeburn 9822: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9823: my $item = &escape($parent).'::0';
9824: my $checked = '';
9825: if (@currcategories > 0) {
9826: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9827: $checked = ' checked="checked"';
1.663 raeburn 9828: }
9829: }
1.919 raeburn 9830: my $parent_title = $parent;
9831: if ($parent eq 'communities') {
9832: $parent_title = &mt('Communities');
9833: }
9834: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9835: '<input type="checkbox" name="usecategory" value="'.
9836: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9837: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9838: my $depth = 1;
9839: push(@path,$parent);
1.919 raeburn 9840: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9841: pop(@path);
1.919 raeburn 9842: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9843: $itemcount ++;
9844: }
1.919 raeburn 9845: if ($itemcount) {
9846: $output = &Apache::loncommon::start_data_table().
9847: $table.
9848: &Apache::loncommon::end_data_table();
9849: }
1.663 raeburn 9850: }
9851: }
9852: }
9853: return $output;
9854: }
9855:
9856: =pod
9857:
9858: =item *&assign_category_rows()
9859:
9860: Create a datatable row for display of nested categories in a domain,
9861: with checkboxes to allow a course to be categorized,called recursively.
9862:
9863: Inputs:
9864:
9865: itemcount - track row number for alternating colors
9866:
9867: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9868: categories and subcategories.
9869:
9870: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9871:
9872: parent - parent of current category item
9873:
9874: path - Array containing all categories back up through the hierarchy from the
9875: current category to the top level.
9876:
9877: currcategories - reference to array of current categories assigned to the course
9878:
9879: Returns: $output (markup to be displayed).
9880:
9881: =cut
9882:
9883: sub assign_category_rows {
9884: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9885: my ($text,$name,$item,$chgstr);
9886: if (ref($cats) eq 'ARRAY') {
9887: my $maxdepth = scalar(@{$cats});
9888: if (ref($cats->[$depth]) eq 'HASH') {
9889: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9890: my $numchildren = @{$cats->[$depth]{$parent}};
9891: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9892: $text .= '<td><table class="LC_datatable">';
9893: for (my $j=0; $j<$numchildren; $j++) {
9894: $name = $cats->[$depth]{$parent}[$j];
9895: $item = &escape($name).':'.&escape($parent).':'.$depth;
9896: my $deeper = $depth+1;
9897: my $checked = '';
9898: if (ref($currcategories) eq 'ARRAY') {
9899: if (@{$currcategories} > 0) {
9900: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9901: $checked = ' checked="checked"';
1.663 raeburn 9902: }
9903: }
9904: }
1.664 raeburn 9905: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9906: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9907: $item.'"'.$checked.' />'.$name.'</label></span>'.
9908: '<input type="hidden" name="catname" value="'.$name.'" />'.
9909: '</td><td>';
1.663 raeburn 9910: if (ref($path) eq 'ARRAY') {
9911: push(@{$path},$name);
9912: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9913: pop(@{$path});
9914: }
9915: $text .= '</td></tr>';
9916: }
9917: $text .= '</table></td>';
9918: }
9919: }
9920: }
9921: return $text;
9922: }
9923:
1.655 raeburn 9924: ############################################################
9925: ############################################################
9926:
9927:
1.443 albertel 9928: sub commit_customrole {
1.664 raeburn 9929: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9930: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9931: ($start?', '.&mt('starting').' '.localtime($start):'').
9932: ($end?', ending '.localtime($end):'').': <b>'.
9933: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9934: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9935: '</b><br />';
9936: return $output;
9937: }
9938:
9939: sub commit_standardrole {
1.541 raeburn 9940: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9941: my ($output,$logmsg,$linefeed);
9942: if ($context eq 'auto') {
9943: $linefeed = "\n";
9944: } else {
9945: $linefeed = "<br />\n";
9946: }
1.443 albertel 9947: if ($three eq 'st') {
1.541 raeburn 9948: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9949: $one,$two,$sec,$context);
9950: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9951: ($result eq 'unknown_course') || ($result eq 'refused')) {
9952: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9953: } else {
1.541 raeburn 9954: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9955: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9956: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9957: if ($context eq 'auto') {
9958: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9959: } else {
9960: $output .= '<b>'.$result.'</b>'.$linefeed.
9961: &mt('Add to classlist').': <b>ok</b>';
9962: }
9963: $output .= $linefeed;
1.443 albertel 9964: }
9965: } else {
9966: $output = &mt('Assigning').' '.$three.' in '.$url.
9967: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9968: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9969: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9970: if ($context eq 'auto') {
9971: $output .= $result.$linefeed;
9972: } else {
9973: $output .= '<b>'.$result.'</b>'.$linefeed;
9974: }
1.443 albertel 9975: }
9976: return $output;
9977: }
9978:
9979: sub commit_studentrole {
1.541 raeburn 9980: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9981: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9982: if ($context eq 'auto') {
9983: $linefeed = "\n";
9984: } else {
9985: $linefeed = '<br />'."\n";
9986: }
1.443 albertel 9987: if (defined($one) && defined($two)) {
9988: my $cid=$one.'_'.$two;
9989: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9990: my $secchange = 0;
9991: my $expire_role_result;
9992: my $modify_section_result;
1.628 raeburn 9993: if ($oldsec ne '-1') {
9994: if ($oldsec ne $sec) {
1.443 albertel 9995: $secchange = 1;
1.628 raeburn 9996: my $now = time;
1.443 albertel 9997: my $uurl='/'.$cid;
9998: $uurl=~s/\_/\//g;
9999: if ($oldsec) {
10000: $uurl.='/'.$oldsec;
10001: }
1.626 raeburn 10002: $oldsecurl = $uurl;
1.628 raeburn 10003: $expire_role_result =
1.652 raeburn 10004: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 10005: if ($env{'request.course.sec'} ne '') {
10006: if ($expire_role_result eq 'refused') {
10007: my @roles = ('st');
10008: my @statuses = ('previous');
10009: my @roledoms = ($one);
10010: my $withsec = 1;
10011: my %roleshash =
10012: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10013: \@statuses,\@roles,\@roledoms,$withsec);
10014: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10015: my ($oldstart,$oldend) =
10016: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10017: if ($oldend > 0 && $oldend <= $now) {
10018: $expire_role_result = 'ok';
10019: }
10020: }
10021: }
10022: }
1.443 albertel 10023: $result = $expire_role_result;
10024: }
10025: }
10026: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10027: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10028: if ($modify_section_result =~ /^ok/) {
10029: if ($secchange == 1) {
1.628 raeburn 10030: if ($sec eq '') {
10031: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10032: } else {
10033: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10034: }
1.443 albertel 10035: } elsif ($oldsec eq '-1') {
1.628 raeburn 10036: if ($sec eq '') {
10037: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10038: } else {
10039: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10040: }
1.443 albertel 10041: } else {
1.628 raeburn 10042: if ($sec eq '') {
10043: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10044: } else {
10045: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10046: }
1.443 albertel 10047: }
10048: } else {
1.628 raeburn 10049: if ($secchange) {
10050: $$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;
10051: } else {
10052: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10053: }
1.443 albertel 10054: }
10055: $result = $modify_section_result;
10056: } elsif ($secchange == 1) {
1.628 raeburn 10057: if ($oldsec eq '') {
10058: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10059: } else {
10060: $$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;
10061: }
1.626 raeburn 10062: if ($expire_role_result eq 'refused') {
10063: my $newsecurl = '/'.$cid;
10064: $newsecurl =~ s/\_/\//g;
10065: if ($sec ne '') {
10066: $newsecurl.='/'.$sec;
10067: }
10068: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10069: if ($sec eq '') {
10070: $$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;
10071: } else {
10072: $$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;
10073: }
10074: }
10075: }
1.443 albertel 10076: }
10077: } else {
1.626 raeburn 10078: $$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 10079: $result = "error: incomplete course id\n";
10080: }
10081: return $result;
10082: }
10083:
10084: ############################################################
10085: ############################################################
10086:
1.566 albertel 10087: sub check_clone {
1.578 raeburn 10088: my ($args,$linefeed) = @_;
1.566 albertel 10089: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10090: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10091: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10092: my $clonemsg;
10093: my $can_clone = 0;
1.944 raeburn 10094: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10095: if ($lctype ne 'community') {
10096: $lctype = 'course';
10097: }
1.566 albertel 10098: if ($clonehome eq 'no_host') {
1.944 raeburn 10099: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10100: $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'});
10101: } else {
10102: $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'});
10103: }
1.566 albertel 10104: } else {
10105: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10106: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10107: if ($clonedesc{'type'} ne 'Community') {
10108: $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'});
10109: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10110: }
10111: }
1.882 raeburn 10112: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10113: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10114: $can_clone = 1;
10115: } else {
10116: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10117: $args->{'clonedomain'},$args->{'clonecourse'});
10118: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10119: if (grep(/^\*$/,@cloners)) {
10120: $can_clone = 1;
10121: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10122: $can_clone = 1;
10123: } else {
1.908 raeburn 10124: my $ccrole = 'cc';
1.944 raeburn 10125: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10126: $ccrole = 'co';
10127: }
1.578 raeburn 10128: my %roleshash =
10129: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10130: $args->{'ccdomain'},
1.908 raeburn 10131: 'userroles',['active'],[$ccrole],
1.578 raeburn 10132: [$args->{'clonedomain'}]);
1.908 raeburn 10133: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10134: $can_clone = 1;
10135: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10136: $can_clone = 1;
10137: } else {
1.944 raeburn 10138: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10139: $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'});
10140: } else {
10141: $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'});
10142: }
1.578 raeburn 10143: }
1.566 albertel 10144: }
1.578 raeburn 10145: }
1.566 albertel 10146: }
10147: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10148: }
10149:
1.444 albertel 10150: sub construct_course {
1.885 raeburn 10151: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10152: my $outcome;
1.541 raeburn 10153: my $linefeed = '<br />'."\n";
10154: if ($context eq 'auto') {
10155: $linefeed = "\n";
10156: }
1.566 albertel 10157:
10158: #
10159: # Are we cloning?
10160: #
10161: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10162: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10163: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10164: if ($context ne 'auto') {
1.578 raeburn 10165: if ($clonemsg ne '') {
10166: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10167: }
1.566 albertel 10168: }
10169: $outcome .= $clonemsg.$linefeed;
10170:
10171: if (!$can_clone) {
10172: return (0,$outcome);
10173: }
10174: }
10175:
1.444 albertel 10176: #
10177: # Open course
10178: #
10179: my $crstype = lc($args->{'crstype'});
10180: my %cenv=();
10181: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10182: $args->{'cdescr'},
10183: $args->{'curl'},
10184: $args->{'course_home'},
10185: $args->{'nonstandard'},
10186: $args->{'crscode'},
10187: $args->{'ccuname'}.':'.
10188: $args->{'ccdomain'},
1.882 raeburn 10189: $args->{'crstype'},
1.885 raeburn 10190: $cnum,$context,$category);
1.444 albertel 10191:
10192: # Note: The testing routines depend on this being output; see
10193: # Utils::Course. This needs to at least be output as a comment
10194: # if anyone ever decides to not show this, and Utils::Course::new
10195: # will need to be suitably modified.
1.541 raeburn 10196: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10197: if ($$courseid =~ /^error:/) {
10198: return (0,$outcome);
10199: }
10200:
1.444 albertel 10201: #
10202: # Check if created correctly
10203: #
1.479 albertel 10204: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10205: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10206: if ($crsuhome eq 'no_host') {
10207: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10208: return (0,$outcome);
10209: }
1.541 raeburn 10210: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10211:
1.444 albertel 10212: #
1.566 albertel 10213: # Do the cloning
10214: #
10215: if ($can_clone && $cloneid) {
10216: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10217: if ($context ne 'auto') {
10218: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10219: }
10220: $outcome .= $clonemsg.$linefeed;
10221: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10222: # Copy all files
1.637 www 10223: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10224: # Restore URL
1.566 albertel 10225: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10226: # Restore title
1.566 albertel 10227: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10228: # Mark as cloned
1.566 albertel 10229: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10230: # Need to clone grading mode
10231: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10232: $cenv{'grading'}=$newenv{'grading'};
10233: # Do not clone these environment entries
10234: &Apache::lonnet::del('environment',
10235: ['default_enrollment_start_date',
10236: 'default_enrollment_end_date',
10237: 'question.email',
10238: 'policy.email',
10239: 'comment.email',
10240: 'pch.users.denied',
1.725 raeburn 10241: 'plc.users.denied',
10242: 'hidefromcat',
10243: 'categories'],
1.638 www 10244: $$crsudom,$$crsunum);
1.444 albertel 10245: }
1.566 albertel 10246:
1.444 albertel 10247: #
10248: # Set environment (will override cloned, if existing)
10249: #
10250: my @sections = ();
10251: my @xlists = ();
10252: if ($args->{'crstype'}) {
10253: $cenv{'type'}=$args->{'crstype'};
10254: }
10255: if ($args->{'crsid'}) {
10256: $cenv{'courseid'}=$args->{'crsid'};
10257: }
10258: if ($args->{'crscode'}) {
10259: $cenv{'internal.coursecode'}=$args->{'crscode'};
10260: }
10261: if ($args->{'crsquota'} ne '') {
10262: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10263: } else {
10264: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10265: }
10266: if ($args->{'ccuname'}) {
10267: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10268: ':'.$args->{'ccdomain'};
10269: } else {
10270: $cenv{'internal.courseowner'} = $args->{'curruser'};
10271: }
10272: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10273: if ($args->{'crssections'}) {
10274: $cenv{'internal.sectionnums'} = '';
10275: if ($args->{'crssections'} =~ m/,/) {
10276: @sections = split/,/,$args->{'crssections'};
10277: } else {
10278: $sections[0] = $args->{'crssections'};
10279: }
10280: if (@sections > 0) {
10281: foreach my $item (@sections) {
10282: my ($sec,$gp) = split/:/,$item;
10283: my $class = $args->{'crscode'}.$sec;
10284: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10285: $cenv{'internal.sectionnums'} .= $item.',';
10286: unless ($addcheck eq 'ok') {
10287: push @badclasses, $class;
10288: }
10289: }
10290: $cenv{'internal.sectionnums'} =~ s/,$//;
10291: }
10292: }
10293: # do not hide course coordinator from staff listing,
10294: # even if privileged
10295: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10296: # add crosslistings
10297: if ($args->{'crsxlist'}) {
10298: $cenv{'internal.crosslistings'}='';
10299: if ($args->{'crsxlist'} =~ m/,/) {
10300: @xlists = split/,/,$args->{'crsxlist'};
10301: } else {
10302: $xlists[0] = $args->{'crsxlist'};
10303: }
10304: if (@xlists > 0) {
10305: foreach my $item (@xlists) {
10306: my ($xl,$gp) = split/:/,$item;
10307: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10308: $cenv{'internal.crosslistings'} .= $item.',';
10309: unless ($addcheck eq 'ok') {
10310: push @badclasses, $xl;
10311: }
10312: }
10313: $cenv{'internal.crosslistings'} =~ s/,$//;
10314: }
10315: }
10316: if ($args->{'autoadds'}) {
10317: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10318: }
10319: if ($args->{'autodrops'}) {
10320: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10321: }
10322: # check for notification of enrollment changes
10323: my @notified = ();
10324: if ($args->{'notify_owner'}) {
10325: if ($args->{'ccuname'} ne '') {
10326: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10327: }
10328: }
10329: if ($args->{'notify_dc'}) {
10330: if ($uname ne '') {
1.630 raeburn 10331: push(@notified,$uname.':'.$udom);
1.444 albertel 10332: }
10333: }
10334: if (@notified > 0) {
10335: my $notifylist;
10336: if (@notified > 1) {
10337: $notifylist = join(',',@notified);
10338: } else {
10339: $notifylist = $notified[0];
10340: }
10341: $cenv{'internal.notifylist'} = $notifylist;
10342: }
10343: if (@badclasses > 0) {
10344: my %lt=&Apache::lonlocal::texthash(
10345: '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',
10346: 'dnhr' => 'does not have rights to access enrollment in these classes',
10347: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10348: );
1.541 raeburn 10349: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10350: ' ('.$lt{'adby'}.')';
10351: if ($context eq 'auto') {
10352: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10353: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10354: foreach my $item (@badclasses) {
10355: if ($context eq 'auto') {
10356: $outcome .= " - $item\n";
10357: } else {
10358: $outcome .= "<li>$item</li>\n";
10359: }
10360: }
10361: if ($context eq 'auto') {
10362: $outcome .= $linefeed;
10363: } else {
1.566 albertel 10364: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10365: }
10366: }
1.444 albertel 10367: }
10368: if ($args->{'no_end_date'}) {
10369: $args->{'endaccess'} = 0;
10370: }
10371: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10372: $cenv{'internal.autoend'}=$args->{'enrollend'};
10373: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10374: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10375: if ($args->{'showphotos'}) {
10376: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10377: }
10378: $cenv{'internal.authtype'} = $args->{'authtype'};
10379: $cenv{'internal.autharg'} = $args->{'autharg'};
10380: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10381: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10382: 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');
10383: if ($context eq 'auto') {
10384: $outcome .= $krb_msg;
10385: } else {
1.566 albertel 10386: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10387: }
10388: $outcome .= $linefeed;
1.444 albertel 10389: }
10390: }
10391: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10392: if ($args->{'setpolicy'}) {
10393: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10394: }
10395: if ($args->{'setcontent'}) {
10396: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10397: }
10398: }
10399: if ($args->{'reshome'}) {
10400: $cenv{'reshome'}=$args->{'reshome'}.'/';
10401: $cenv{'reshome'}=~s/\/+$/\//;
10402: }
10403: #
10404: # course has keyed access
10405: #
10406: if ($args->{'setkeys'}) {
10407: $cenv{'keyaccess'}='yes';
10408: }
10409: # if specified, key authority is not course, but user
10410: # only active if keyaccess is yes
10411: if ($args->{'keyauth'}) {
1.487 albertel 10412: my ($user,$domain) = split(':',$args->{'keyauth'});
10413: $user = &LONCAPA::clean_username($user);
10414: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10415: if ($user ne '' && $domain ne '') {
1.487 albertel 10416: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10417: }
10418: }
10419:
10420: if ($args->{'disresdis'}) {
10421: $cenv{'pch.roles.denied'}='st';
10422: }
10423: if ($args->{'disablechat'}) {
10424: $cenv{'plc.roles.denied'}='st';
10425: }
10426:
10427: # Record we've not yet viewed the Course Initialization Helper for this
10428: # course
10429: $cenv{'course.helper.not.run'} = 1;
10430: #
10431: # Use new Randomseed
10432: #
10433: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10434: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10435: #
10436: # The encryption code and receipt prefix for this course
10437: #
10438: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10439: $cenv{'internal.encpref'}=100+int(9*rand(99));
10440: #
10441: # By default, use standard grading
10442: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10443:
1.541 raeburn 10444: $outcome .= $linefeed.&mt('Setting environment').': '.
10445: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10446: #
10447: # Open all assignments
10448: #
10449: if ($args->{'openall'}) {
10450: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10451: my %storecontent = ($storeunder => time,
10452: $storeunder.'.type' => 'date_start');
10453:
10454: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10455: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10456: }
10457: #
10458: # Set first page
10459: #
10460: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10461: || ($cloneid)) {
1.445 albertel 10462: use LONCAPA::map;
1.444 albertel 10463: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10464:
10465: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10466: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10467:
1.444 albertel 10468: $outcome .= ($fatal?$errtext:'read ok').' - ';
10469: my $title; my $url;
10470: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10471: $title=&mt('Syllabus');
1.444 albertel 10472: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10473: } else {
1.690 bisitz 10474: $title=&mt('Navigate Contents');
1.444 albertel 10475: $url='/adm/navmaps';
10476: }
1.445 albertel 10477:
10478: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10479: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10480:
10481: if ($errtext) { $fatal=2; }
1.541 raeburn 10482: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10483: }
1.566 albertel 10484:
10485: return (1,$outcome);
1.444 albertel 10486: }
10487:
10488: ############################################################
10489: ############################################################
10490:
1.378 raeburn 10491: sub course_type {
10492: my ($cid) = @_;
10493: if (!defined($cid)) {
10494: $cid = $env{'request.course.id'};
10495: }
1.404 albertel 10496: if (defined($env{'course.'.$cid.'.type'})) {
10497: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10498: } else {
10499: return 'Course';
1.377 raeburn 10500: }
10501: }
1.156 albertel 10502:
1.406 raeburn 10503: sub group_term {
10504: my $crstype = &course_type();
10505: my %names = (
10506: 'Course' => 'group',
1.865 raeburn 10507: 'Community' => 'group',
1.406 raeburn 10508: );
10509: return $names{$crstype};
10510: }
10511:
1.902 raeburn 10512: sub course_types {
10513: my @types = ('official','unofficial','community');
10514: my %typename = (
10515: official => 'Official course',
10516: unofficial => 'Unofficial course',
10517: community => 'Community',
10518: );
10519: return (\@types,\%typename);
10520: }
10521:
1.156 albertel 10522: sub icon {
10523: my ($file)=@_;
1.505 albertel 10524: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10525: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10526: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10527: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10528: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10529: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10530: $curfext.".gif") {
10531: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10532: $curfext.".gif";
10533: }
10534: }
1.249 albertel 10535: return &lonhttpdurl($iconname);
1.154 albertel 10536: }
1.84 albertel 10537:
1.575 albertel 10538: sub lonhttpdurl {
1.692 www 10539: #
10540: # Had been used for "small fry" static images on separate port 8080.
10541: # Modify here if lightweight http functionality desired again.
10542: # Currently eliminated due to increasing firewall issues.
10543: #
1.575 albertel 10544: my ($url)=@_;
1.692 www 10545: return $url;
1.215 albertel 10546: }
10547:
1.213 albertel 10548: sub connection_aborted {
10549: my ($r)=@_;
10550: $r->print(" ");$r->rflush();
10551: my $c = $r->connection;
10552: return $c->aborted();
10553: }
10554:
1.221 foxr 10555: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10556: # strings as 'strings'.
10557: sub escape_single {
1.221 foxr 10558: my ($input) = @_;
1.223 albertel 10559: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10560: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10561: return $input;
10562: }
1.223 albertel 10563:
1.222 foxr 10564: # Same as escape_single, but escape's "'s This
10565: # can be used for "strings"
10566: sub escape_double {
10567: my ($input) = @_;
10568: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10569: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10570: return $input;
10571: }
1.223 albertel 10572:
1.222 foxr 10573: # Escapes the last element of a full URL.
10574: sub escape_url {
10575: my ($url) = @_;
1.238 raeburn 10576: my @urlslices = split(/\//, $url,-1);
1.369 www 10577: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10578: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10579: }
1.462 albertel 10580:
1.820 raeburn 10581: sub compare_arrays {
10582: my ($arrayref1,$arrayref2) = @_;
10583: my (@difference,%count);
10584: @difference = ();
10585: %count = ();
10586: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10587: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10588: foreach my $element (keys(%count)) {
10589: if ($count{$element} == 1) {
10590: push(@difference,$element);
10591: }
10592: }
10593: }
10594: return @difference;
10595: }
10596:
1.817 bisitz 10597: # -------------------------------------------------------- Initialize user login
1.462 albertel 10598: sub init_user_environment {
1.463 albertel 10599: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10600: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10601:
10602: my $public=($username eq 'public' && $domain eq 'public');
10603:
10604: # See if old ID present, if so, remove
10605:
10606: my ($filename,$cookie,$userroles);
10607: my $now=time;
10608:
10609: if ($public) {
10610: my $max_public=100;
10611: my $oldest;
10612: my $oldest_time=0;
10613: for(my $next=1;$next<=$max_public;$next++) {
10614: if (-e $lonids."/publicuser_$next.id") {
10615: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10616: if ($mtime<$oldest_time || !$oldest_time) {
10617: $oldest_time=$mtime;
10618: $oldest=$next;
10619: }
10620: } else {
10621: $cookie="publicuser_$next";
10622: last;
10623: }
10624: }
10625: if (!$cookie) { $cookie="publicuser_$oldest"; }
10626: } else {
1.463 albertel 10627: # if this isn't a robot, kill any existing non-robot sessions
10628: if (!$args->{'robot'}) {
10629: opendir(DIR,$lonids);
10630: while ($filename=readdir(DIR)) {
10631: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10632: unlink($lonids.'/'.$filename);
10633: }
1.462 albertel 10634: }
1.463 albertel 10635: closedir(DIR);
1.462 albertel 10636: }
10637: # Give them a new cookie
1.463 albertel 10638: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10639: : $now.$$.int(rand(10000)));
1.463 albertel 10640: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10641:
10642: # Initialize roles
10643:
10644: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10645: }
10646: # ------------------------------------ Check browser type and MathML capability
10647:
10648: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10649: $clientunicode,$clientos) = &decode_user_agent($r);
10650:
10651: # ------------------------------------------------------------- Get environment
10652:
10653: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10654: my ($tmp) = keys(%userenv);
10655: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10656: } else {
10657: undef(%userenv);
10658: }
10659: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10660: $form->{'interface'}=$userenv{'interface'};
10661: }
10662: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10663:
10664: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10665: foreach my $option ('interface','localpath','localres') {
10666: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10667: }
10668: # --------------------------------------------------------- Write first profile
10669:
10670: {
10671: my %initial_env =
10672: ("user.name" => $username,
10673: "user.domain" => $domain,
10674: "user.home" => $authhost,
10675: "browser.type" => $clientbrowser,
10676: "browser.version" => $clientversion,
10677: "browser.mathml" => $clientmathml,
10678: "browser.unicode" => $clientunicode,
10679: "browser.os" => $clientos,
10680: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10681: "request.course.fn" => '',
10682: "request.course.uri" => '',
10683: "request.course.sec" => '',
10684: "request.role" => 'cm',
10685: "request.role.adv" => $env{'user.adv'},
10686: "request.host" => $ENV{'REMOTE_ADDR'},);
10687:
10688: if ($form->{'localpath'}) {
10689: $initial_env{"browser.localpath"} = $form->{'localpath'};
10690: $initial_env{"browser.localres"} = $form->{'localres'};
10691: }
10692:
10693: if ($form->{'interface'}) {
10694: $form->{'interface'}=~s/\W//gs;
10695: $initial_env{"browser.interface"} = $form->{'interface'};
10696: $env{'browser.interface'}=$form->{'interface'};
10697: }
10698:
1.724 raeburn 10699: foreach my $tool ('aboutme','blog','portfolio') {
10700: $userenv{'availabletools.'.$tool} =
10701: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10702: }
10703:
1.864 raeburn 10704: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10705: $userenv{'canrequest.'.$crstype} =
10706: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10707: 'reload','requestcourses');
10708: }
10709:
1.462 albertel 10710: $env{'user.environment'} = "$lonids/$cookie.id";
10711:
10712: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10713: &GDBM_WRCREAT(),0640)) {
10714: &_add_to_env(\%disk_env,\%initial_env);
10715: &_add_to_env(\%disk_env,\%userenv,'environment.');
10716: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10717: if (ref($args->{'extra_env'})) {
10718: &_add_to_env(\%disk_env,$args->{'extra_env'});
10719: }
1.462 albertel 10720: untie(%disk_env);
10721: } else {
1.705 tempelho 10722: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10723: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10724: return 'error: '.$!;
10725: }
10726: }
10727: $env{'request.role'}='cm';
10728: $env{'request.role.adv'}=$env{'user.adv'};
10729: $env{'browser.type'}=$clientbrowser;
10730:
10731: return $cookie;
10732:
10733: }
10734:
10735: sub _add_to_env {
10736: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10737: if (ref($env_data) eq 'HASH') {
10738: while (my ($key,$value) = each(%$env_data)) {
10739: $idf->{$prefix.$key} = $value;
10740: $env{$prefix.$key} = $value;
10741: }
1.462 albertel 10742: }
10743: }
10744:
1.685 tempelho 10745: # --- Get the symbolic name of a problem and the url
10746: sub get_symb {
10747: my ($request,$silent) = @_;
1.726 raeburn 10748: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10749: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10750: if ($symb eq '') {
10751: if (!$silent) {
10752: $request->print("Unable to handle ambiguous references:$url:.");
10753: return ();
10754: }
10755: }
10756: &Apache::lonenc::check_decrypt(\$symb);
10757: return ($symb);
10758: }
10759:
10760: # --------------------------------------------------------------Get annotation
10761:
10762: sub get_annotation {
10763: my ($symb,$enc) = @_;
10764:
10765: my $key = $symb;
10766: if (!$enc) {
10767: $key =
10768: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10769: }
10770: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10771: return $annotation{$key};
10772: }
10773:
10774: sub clean_symb {
1.731 raeburn 10775: my ($symb,$delete_enc) = @_;
1.685 tempelho 10776:
10777: &Apache::lonenc::check_decrypt(\$symb);
10778: my $enc = $env{'request.enc'};
1.731 raeburn 10779: if ($delete_enc) {
1.730 raeburn 10780: delete($env{'request.enc'});
10781: }
1.685 tempelho 10782:
10783: return ($symb,$enc);
10784: }
1.462 albertel 10785:
1.41 ng 10786: =pod
10787:
10788: =back
10789:
1.112 bowersj2 10790: =cut
1.41 ng 10791:
1.112 bowersj2 10792: 1;
10793: __END__;
1.41 ng 10794:
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