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