Annotation of loncom/interface/loncommon.pm, revision 1.951
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.951 ! onken 4: # $Id: loncommon.pm,v 1.950 2010/03/16 13:04:54 onken Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.949 droeschl 1205: $stayOnPage = 1;
1.430 albertel 1206: my $output;
1207: if ($component_help) {
1208: if (!$text) {
1209: $output=&help_open_topic($component_help,undef,$stayOnPage,
1210: $width,$height);
1211: } else {
1212: my $help_text;
1213: $help_text=&unescape($topic);
1214: $output='<table><tr><td>'.
1215: &help_open_topic($component_help,$help_text,$stayOnPage,
1216: $width,$height).'</td></tr></table>';
1217: }
1218: }
1219: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1220: return $output.$banner_link;
1221: }
1222:
1223: sub top_nav_help {
1224: my ($text) = @_;
1.436 albertel 1225: $text = &mt($text);
1.949 droeschl 1226: my $stay_on_page = 1;
1227:
1.572 banghart 1228: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1229: : "javascript:helpMenu('open')";
1.572 banghart 1230: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1231:
1.201 raeburn 1232: my $title = &mt('Get help');
1.436 albertel 1233:
1234: return <<"END";
1235: $banner_link
1236: <a href="$link" title="$title">$text</a>
1237: END
1238: }
1239:
1240: sub help_menu_js {
1241: my ($text) = @_;
1.949 droeschl 1242: my $stayOnPage = 1;
1.436 albertel 1243: my $width = 620;
1244: my $height = 600;
1.430 albertel 1245: my $helptopic=&general_help();
1246: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1247: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1248: my $start_page =
1249: &Apache::loncommon::start_page('Help Menu', undef,
1250: {'frameset' => 1,
1251: 'js_ready' => 1,
1252: 'add_entries' => {
1253: 'border' => '0',
1.579 raeburn 1254: 'rows' => "110,*",},});
1.331 albertel 1255: my $end_page =
1256: &Apache::loncommon::end_page({'frameset' => 1,
1257: 'js_ready' => 1,});
1258:
1.436 albertel 1259: my $template .= <<"ENDTEMPLATE";
1260: <script type="text/javascript">
1.877 bisitz 1261: // <![CDATA[
1.253 albertel 1262: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1263: var banner_link = '';
1.243 raeburn 1264: function helpMenu(target) {
1265: var caller = this;
1266: if (target == 'open') {
1267: var newWindow = null;
1268: try {
1.262 albertel 1269: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1270: }
1271: catch(error) {
1272: writeHelp(caller);
1273: return;
1274: }
1275: if (newWindow) {
1276: caller = newWindow;
1277: }
1.193 raeburn 1278: }
1.243 raeburn 1279: writeHelp(caller);
1280: return;
1281: }
1282: function writeHelp(caller) {
1.430 albertel 1283: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1284: caller.document.close()
1285: caller.focus()
1.193 raeburn 1286: }
1.877 bisitz 1287: // END LON-CAPA Internal -->
1.253 albertel 1288: // ]]>
1.436 albertel 1289: </script>
1.193 raeburn 1290: ENDTEMPLATE
1291: return $template;
1292: }
1293:
1.172 www 1294: sub help_open_bug {
1295: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1296: unless ($env{'user.adv'}) { return ''; }
1.172 www 1297: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1298: $text = "" if (not defined $text);
1299: $stayOnPage=1;
1.184 albertel 1300: $width = 600 if (not defined $width);
1301: $height = 600 if (not defined $height);
1.172 www 1302:
1303: $topic=~s/\W+/\+/g;
1304: my $link='';
1305: my $template='';
1.379 albertel 1306: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1307: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1308: if (!$stayOnPage)
1309: {
1310: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1311: }
1312: else
1313: {
1314: $link = $url;
1315: }
1316: # Add the text
1317: if ($text ne "")
1318: {
1319: $template .=
1320: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1321: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1322: }
1323:
1324: # Add the graphic
1.179 matthew 1325: my $title = &mt('Report a Bug');
1.215 albertel 1326: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1327: $template .= <<"ENDTEMPLATE";
1.436 albertel 1328: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1329: ENDTEMPLATE
1330: if ($text ne '') { $template.='</td></tr></table>' };
1331: return $template;
1332:
1333: }
1334:
1335: sub help_open_faq {
1336: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1337: unless ($env{'user.adv'}) { return ''; }
1.172 www 1338: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1339: $text = "" if (not defined $text);
1340: $stayOnPage=1;
1341: $width = 350 if (not defined $width);
1342: $height = 400 if (not defined $height);
1343:
1344: $topic=~s/\W+/\+/g;
1345: my $link='';
1346: my $template='';
1347: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1348: if (!$stayOnPage)
1349: {
1350: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1351: }
1352: else
1353: {
1354: $link = $url;
1355: }
1356:
1357: # Add the text
1358: if ($text ne "")
1359: {
1360: $template .=
1.173 www 1361: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1362: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1363: }
1364:
1365: # Add the graphic
1.179 matthew 1366: my $title = &mt('View the FAQ');
1.215 albertel 1367: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1368: $template .= <<"ENDTEMPLATE";
1.436 albertel 1369: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1370: ENDTEMPLATE
1371: if ($text ne '') { $template.='</td></tr></table>' };
1372: return $template;
1373:
1.44 bowersj2 1374: }
1.37 matthew 1375:
1.180 matthew 1376: ###############################################################
1377: ###############################################################
1378:
1.45 matthew 1379: =pod
1380:
1.648 raeburn 1381: =item * &change_content_javascript():
1.256 matthew 1382:
1383: This and the next function allow you to create small sections of an
1384: otherwise static HTML page that you can update on the fly with
1385: Javascript, even in Netscape 4.
1386:
1387: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1388: must be written to the HTML page once. It will prove the Javascript
1389: function "change(name, content)". Calling the change function with the
1390: name of the section
1391: you want to update, matching the name passed to C<changable_area>, and
1392: the new content you want to put in there, will put the content into
1393: that area.
1394:
1395: B<Note>: Netscape 4 only reserves enough space for the changable area
1396: to contain room for the original contents. You need to "make space"
1397: for whatever changes you wish to make, and be B<sure> to check your
1398: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1399: it's adequate for updating a one-line status display, but little more.
1400: This script will set the space to 100% width, so you only need to
1401: worry about height in Netscape 4.
1402:
1403: Modern browsers are much less limiting, and if you can commit to the
1404: user not using Netscape 4, this feature may be used freely with
1405: pretty much any HTML.
1406:
1407: =cut
1408:
1409: sub change_content_javascript {
1410: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1411: if ($env{'browser.type'} eq 'netscape' &&
1412: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1413: return (<<NETSCAPE4);
1414: function change(name, content) {
1415: doc = document.layers[name+"___escape"].layers[0].document;
1416: doc.open();
1417: doc.write(content);
1418: doc.close();
1419: }
1420: NETSCAPE4
1421: } else {
1422: # Otherwise, we need to use semi-standards-compliant code
1423: # (technically, "innerHTML" isn't standard but the equivalent
1424: # is really scary, and every useful browser supports it
1425: return (<<DOMBASED);
1426: function change(name, content) {
1427: element = document.getElementById(name);
1428: element.innerHTML = content;
1429: }
1430: DOMBASED
1431: }
1432: }
1433:
1434: =pod
1435:
1.648 raeburn 1436: =item * &changable_area($name,$origContent):
1.256 matthew 1437:
1438: This provides a "changable area" that can be modified on the fly via
1439: the Javascript code provided in C<change_content_javascript>. $name is
1440: the name you will use to reference the area later; do not repeat the
1441: same name on a given HTML page more then once. $origContent is what
1442: the area will originally contain, which can be left blank.
1443:
1444: =cut
1445:
1446: sub changable_area {
1447: my ($name, $origContent) = @_;
1448:
1.258 albertel 1449: if ($env{'browser.type'} eq 'netscape' &&
1450: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1451: # If this is netscape 4, we need to use the Layer tag
1452: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1453: } else {
1454: return "<span id='$name'>$origContent</span>";
1455: }
1456: }
1457:
1458: =pod
1459:
1.648 raeburn 1460: =item * &viewport_geometry_js
1.590 raeburn 1461:
1462: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1463:
1464: =cut
1465:
1466:
1467: sub viewport_geometry_js {
1468: return <<"GEOMETRY";
1469: var Geometry = {};
1470: function init_geometry() {
1471: if (Geometry.init) { return };
1472: Geometry.init=1;
1473: if (window.innerHeight) {
1474: Geometry.getViewportHeight = function() { return window.innerHeight; };
1475: Geometry.getViewportWidth = function() { return window.innerWidth; };
1476: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1477: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1478: }
1479: else if (document.documentElement && document.documentElement.clientHeight) {
1480: Geometry.getViewportHeight =
1481: function() { return document.documentElement.clientHeight; };
1482: Geometry.getViewportWidth =
1483: function() { return document.documentElement.clientWidth; };
1484:
1485: Geometry.getHorizontalScroll =
1486: function() { return document.documentElement.scrollLeft; };
1487: Geometry.getVerticalScroll =
1488: function() { return document.documentElement.scrollTop; };
1489: }
1490: else if (document.body.clientHeight) {
1491: Geometry.getViewportHeight =
1492: function() { return document.body.clientHeight; };
1493: Geometry.getViewportWidth =
1494: function() { return document.body.clientWidth; };
1495: Geometry.getHorizontalScroll =
1496: function() { return document.body.scrollLeft; };
1497: Geometry.getVerticalScroll =
1498: function() { return document.body.scrollTop; };
1499: }
1500: }
1501:
1502: GEOMETRY
1503: }
1504:
1505: =pod
1506:
1.648 raeburn 1507: =item * &viewport_size_js()
1.590 raeburn 1508:
1509: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1510:
1511: =cut
1512:
1513: sub viewport_size_js {
1514: my $geometry = &viewport_geometry_js();
1515: return <<"DIMS";
1516:
1517: $geometry
1518:
1519: function getViewportDims(width,height) {
1520: init_geometry();
1521: width.value = Geometry.getViewportWidth();
1522: height.value = Geometry.getViewportHeight();
1523: return;
1524: }
1525:
1526: DIMS
1527: }
1528:
1529: =pod
1530:
1.648 raeburn 1531: =item * &resize_textarea_js()
1.565 albertel 1532:
1533: emits the needed javascript to resize a textarea to be as big as possible
1534:
1535: creates a function resize_textrea that takes two IDs first should be
1536: the id of the element to resize, second should be the id of a div that
1537: surrounds everything that comes after the textarea, this routine needs
1538: to be attached to the <body> for the onload and onresize events.
1539:
1.648 raeburn 1540: =back
1.565 albertel 1541:
1542: =cut
1543:
1544: sub resize_textarea_js {
1.590 raeburn 1545: my $geometry = &viewport_geometry_js();
1.565 albertel 1546: return <<"RESIZE";
1547: <script type="text/javascript">
1.824 bisitz 1548: // <![CDATA[
1.590 raeburn 1549: $geometry
1.565 albertel 1550:
1.588 albertel 1551: function getX(element) {
1552: var x = 0;
1553: while (element) {
1554: x += element.offsetLeft;
1555: element = element.offsetParent;
1556: }
1557: return x;
1558: }
1559: function getY(element) {
1560: var y = 0;
1561: while (element) {
1562: y += element.offsetTop;
1563: element = element.offsetParent;
1564: }
1565: return y;
1566: }
1567:
1568:
1.565 albertel 1569: function resize_textarea(textarea_id,bottom_id) {
1570: init_geometry();
1571: var textarea = document.getElementById(textarea_id);
1572: //alert(textarea);
1573:
1.588 albertel 1574: var textarea_top = getY(textarea);
1.565 albertel 1575: var textarea_height = textarea.offsetHeight;
1576: var bottom = document.getElementById(bottom_id);
1.588 albertel 1577: var bottom_top = getY(bottom);
1.565 albertel 1578: var bottom_height = bottom.offsetHeight;
1579: var window_height = Geometry.getViewportHeight();
1.588 albertel 1580: var fudge = 23;
1.565 albertel 1581: var new_height = window_height-fudge-textarea_top-bottom_height;
1582: if (new_height < 300) {
1583: new_height = 300;
1584: }
1585: textarea.style.height=new_height+'px';
1586: }
1.824 bisitz 1587: // ]]>
1.565 albertel 1588: </script>
1589: RESIZE
1590:
1591: }
1592:
1593: =pod
1594:
1.256 matthew 1595: =head1 Excel and CSV file utility routines
1596:
1597: =over 4
1598:
1599: =cut
1600:
1601: ###############################################################
1602: ###############################################################
1603:
1604: =pod
1605:
1.648 raeburn 1606: =item * &csv_translate($text)
1.37 matthew 1607:
1.185 www 1608: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1609: format.
1610:
1611: =cut
1612:
1.180 matthew 1613: ###############################################################
1614: ###############################################################
1.37 matthew 1615: sub csv_translate {
1616: my $text = shift;
1617: $text =~ s/\"/\"\"/g;
1.209 albertel 1618: $text =~ s/\n/ /g;
1.37 matthew 1619: return $text;
1620: }
1.180 matthew 1621:
1622: ###############################################################
1623: ###############################################################
1624:
1625: =pod
1626:
1.648 raeburn 1627: =item * &define_excel_formats()
1.180 matthew 1628:
1629: Define some commonly used Excel cell formats.
1630:
1631: Currently supported formats:
1632:
1633: =over 4
1634:
1635: =item header
1636:
1637: =item bold
1638:
1639: =item h1
1640:
1641: =item h2
1642:
1643: =item h3
1644:
1.256 matthew 1645: =item h4
1646:
1647: =item i
1648:
1.180 matthew 1649: =item date
1650:
1651: =back
1652:
1653: Inputs: $workbook
1654:
1655: Returns: $format, a hash reference.
1656:
1657: =cut
1658:
1659: ###############################################################
1660: ###############################################################
1661: sub define_excel_formats {
1662: my ($workbook) = @_;
1663: my $format;
1664: $format->{'header'} = $workbook->add_format(bold => 1,
1665: bottom => 1,
1666: align => 'center');
1667: $format->{'bold'} = $workbook->add_format(bold=>1);
1668: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1669: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1670: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1671: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1672: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1673: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1674: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1675: return $format;
1676: }
1677:
1678: ###############################################################
1679: ###############################################################
1.113 bowersj2 1680:
1681: =pod
1682:
1.648 raeburn 1683: =item * &create_workbook()
1.255 matthew 1684:
1685: Create an Excel worksheet. If it fails, output message on the
1686: request object and return undefs.
1687:
1688: Inputs: Apache request object
1689:
1690: Returns (undef) on failure,
1691: Excel worksheet object, scalar with filename, and formats
1692: from &Apache::loncommon::define_excel_formats on success
1693:
1694: =cut
1695:
1696: ###############################################################
1697: ###############################################################
1698: sub create_workbook {
1699: my ($r) = @_;
1700: #
1701: # Create the excel spreadsheet
1702: my $filename = '/prtspool/'.
1.258 albertel 1703: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1704: time.'_'.rand(1000000000).'.xls';
1705: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1706: if (! defined($workbook)) {
1707: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1708: $r->print(
1709: '<p class="LC_error">'
1710: .&mt('Problems occurred in creating the new Excel file.')
1711: .' '.&mt('This error has been logged.')
1712: .' '.&mt('Please alert your LON-CAPA administrator.')
1713: .'</p>'
1714: );
1.255 matthew 1715: return (undef);
1716: }
1717: #
1718: $workbook->set_tempdir('/home/httpd/perl/tmp');
1719: #
1720: my $format = &Apache::loncommon::define_excel_formats($workbook);
1721: return ($workbook,$filename,$format);
1722: }
1723:
1724: ###############################################################
1725: ###############################################################
1726:
1727: =pod
1728:
1.648 raeburn 1729: =item * &create_text_file()
1.113 bowersj2 1730:
1.542 raeburn 1731: Create a file to write to and eventually make available to the user.
1.256 matthew 1732: If file creation fails, outputs an error message on the request object and
1733: return undefs.
1.113 bowersj2 1734:
1.256 matthew 1735: Inputs: Apache request object, and file suffix
1.113 bowersj2 1736:
1.256 matthew 1737: Returns (undef) on failure,
1738: Filehandle and filename on success.
1.113 bowersj2 1739:
1740: =cut
1741:
1.256 matthew 1742: ###############################################################
1743: ###############################################################
1744: sub create_text_file {
1745: my ($r,$suffix) = @_;
1746: if (! defined($suffix)) { $suffix = 'txt'; };
1747: my $fh;
1748: my $filename = '/prtspool/'.
1.258 albertel 1749: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1750: time.'_'.rand(1000000000).'.'.$suffix;
1751: $fh = Apache::File->new('>/home/httpd'.$filename);
1752: if (! defined($fh)) {
1753: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1754: $r->print(
1755: '<p class="LC_error">'
1756: .&mt('Problems occurred in creating the output file.')
1757: .' '.&mt('This error has been logged.')
1758: .' '.&mt('Please alert your LON-CAPA administrator.')
1759: .'</p>'
1760: );
1.113 bowersj2 1761: }
1.256 matthew 1762: return ($fh,$filename)
1.113 bowersj2 1763: }
1764:
1765:
1.256 matthew 1766: =pod
1.113 bowersj2 1767:
1768: =back
1769:
1770: =cut
1.37 matthew 1771:
1772: ###############################################################
1.33 matthew 1773: ## Home server <option> list generating code ##
1774: ###############################################################
1.35 matthew 1775:
1.169 www 1776: # ------------------------------------------
1777:
1778: sub domain_select {
1779: my ($name,$value,$multiple)=@_;
1780: my %domains=map {
1.514 albertel 1781: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1782: } &Apache::lonnet::all_domains();
1.169 www 1783: if ($multiple) {
1784: $domains{''}=&mt('Any domain');
1.550 albertel 1785: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1786: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1787: } else {
1.550 albertel 1788: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1789: return &select_form($name,$value,%domains);
1790: }
1791: }
1792:
1.282 albertel 1793: #-------------------------------------------
1794:
1795: =pod
1796:
1.519 raeburn 1797: =head1 Routines for form select boxes
1798:
1799: =over 4
1800:
1.648 raeburn 1801: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1802:
1803: Returns a string containing a <select> element int multiple mode
1804:
1805:
1806: Args:
1807: $name - name of the <select> element
1.506 raeburn 1808: $value - scalar or array ref of values that should already be selected
1.282 albertel 1809: $size - number of rows long the select element is
1.283 albertel 1810: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1811: (shown text should already have been &mt())
1.506 raeburn 1812: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1813:
1.282 albertel 1814: =cut
1815:
1816: #-------------------------------------------
1.169 www 1817: sub multiple_select_form {
1.284 albertel 1818: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1819: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1820: my $output='';
1.191 matthew 1821: if (! defined($size)) {
1822: $size = 4;
1.283 albertel 1823: if (scalar(keys(%$hash))<4) {
1824: $size = scalar(keys(%$hash));
1.191 matthew 1825: }
1826: }
1.734 bisitz 1827: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1828: my @order;
1.506 raeburn 1829: if (ref($order) eq 'ARRAY') {
1830: @order = @{$order};
1831: } else {
1832: @order = sort(keys(%$hash));
1.501 banghart 1833: }
1834: if (exists($$hash{'select_form_order'})) {
1835: @order = @{$$hash{'select_form_order'}};
1836: }
1837:
1.284 albertel 1838: foreach my $key (@order) {
1.356 albertel 1839: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1840: $output.='selected="selected" ' if ($selected{$key});
1841: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1842: }
1843: $output.="</select>\n";
1844: return $output;
1845: }
1846:
1.88 www 1847: #-------------------------------------------
1848:
1849: =pod
1850:
1.648 raeburn 1851: =item * &select_form($defdom,$name,%hash)
1.88 www 1852:
1853: Returns a string containing a <select name='$name' size='1'> form to
1854: allow a user to select options from a hash option_name => displayed text.
1855: See lonrights.pm for an example invocation and use.
1856:
1857: =cut
1858:
1859: #-------------------------------------------
1860: sub select_form {
1861: my ($def,$name,%hash) = @_;
1862: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1863: my @keys;
1864: if (exists($hash{'select_form_order'})) {
1865: @keys=@{$hash{'select_form_order'}};
1866: } else {
1867: @keys=sort(keys(%hash));
1868: }
1.356 albertel 1869: foreach my $key (@keys) {
1870: $selectform.=
1871: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1872: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1873: ">".$hash{$key}."</option>\n";
1.88 www 1874: }
1875: $selectform.="</select>";
1876: return $selectform;
1877: }
1878:
1.475 www 1879: # For display filters
1880:
1881: sub display_filter {
1882: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1883: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1884: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1885: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1886: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1887: '</label></span> <span class="LC_nobreak">'.
1.475 www 1888: &mt('Filter [_1]',
1.477 www 1889: &select_form($env{'form.displayfilter'},
1890: 'displayfilter',
1891: ('currentfolder' => 'Current folder/page',
1892: 'containing' => 'Containing phrase',
1893: 'none' => 'None'))).
1.714 bisitz 1894: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1895: }
1896:
1.167 www 1897: sub gradeleveldescription {
1898: my $gradelevel=shift;
1899: my %gradelevels=(0 => 'Not specified',
1900: 1 => 'Grade 1',
1901: 2 => 'Grade 2',
1902: 3 => 'Grade 3',
1903: 4 => 'Grade 4',
1904: 5 => 'Grade 5',
1905: 6 => 'Grade 6',
1906: 7 => 'Grade 7',
1907: 8 => 'Grade 8',
1908: 9 => 'Grade 9',
1909: 10 => 'Grade 10',
1910: 11 => 'Grade 11',
1911: 12 => 'Grade 12',
1912: 13 => 'Grade 13',
1913: 14 => '100 Level',
1914: 15 => '200 Level',
1915: 16 => '300 Level',
1916: 17 => '400 Level',
1917: 18 => 'Graduate Level');
1918: return &mt($gradelevels{$gradelevel});
1919: }
1920:
1.163 www 1921: sub select_level_form {
1922: my ($deflevel,$name)=@_;
1923: unless ($deflevel) { $deflevel=0; }
1.167 www 1924: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1925: for (my $i=0; $i<=18; $i++) {
1926: $selectform.="<option value=\"$i\" ".
1.253 albertel 1927: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1928: ">".&gradeleveldescription($i)."</option>\n";
1929: }
1930: $selectform.="</select>";
1931: return $selectform;
1.163 www 1932: }
1.167 www 1933:
1.35 matthew 1934: #-------------------------------------------
1935:
1.45 matthew 1936: =pod
1937:
1.910 raeburn 1938: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1939:
1940: Returns a string containing a <select name='$name' size='1'> form to
1941: allow a user to select the domain to preform an operation in.
1942: See loncreateuser.pm for an example invocation and use.
1943:
1.90 www 1944: If the $includeempty flag is set, it also includes an empty choice ("no domain
1945: selected");
1946:
1.743 raeburn 1947: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1948:
1.910 raeburn 1949: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1950:
1951: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1952:
1.35 matthew 1953: =cut
1954:
1955: #-------------------------------------------
1.34 matthew 1956: sub select_dom_form {
1.910 raeburn 1957: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1958: if ($onchange) {
1.874 raeburn 1959: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1960: }
1.910 raeburn 1961: my @domains;
1962: if (ref($incdoms) eq 'ARRAY') {
1963: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1964: } else {
1965: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1966: }
1.90 www 1967: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1968: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1969: foreach my $dom (@domains) {
1970: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1971: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1972: if ($showdomdesc) {
1973: if ($dom ne '') {
1974: my $domdesc = &Apache::lonnet::domain($dom,'description');
1975: if ($domdesc ne '') {
1976: $selectdomain .= ' ('.$domdesc.')';
1977: }
1978: }
1979: }
1980: $selectdomain .= "</option>\n";
1.34 matthew 1981: }
1982: $selectdomain.="</select>";
1983: return $selectdomain;
1984: }
1985:
1.35 matthew 1986: #-------------------------------------------
1987:
1.45 matthew 1988: =pod
1989:
1.648 raeburn 1990: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1991:
1.586 raeburn 1992: input: 4 arguments (two required, two optional) -
1993: $domain - domain of new user
1994: $name - name of form element
1995: $default - Value of 'default' causes a default item to be first
1996: option, and selected by default.
1997: $hide - Value of 'hide' causes hiding of the name of the server,
1998: if 1 server found, or default, if 0 found.
1.594 raeburn 1999: output: returns 2 items:
1.586 raeburn 2000: (a) form element which contains either:
2001: (i) <select name="$name">
2002: <option value="$hostid1">$hostid $servers{$hostid}</option>
2003: <option value="$hostid2">$hostid $servers{$hostid}</option>
2004: </select>
2005: form item if there are multiple library servers in $domain, or
2006: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2007: if there is only one library server in $domain.
2008:
2009: (b) number of library servers found.
2010:
2011: See loncreateuser.pm for example of use.
1.35 matthew 2012:
2013: =cut
2014:
2015: #-------------------------------------------
1.586 raeburn 2016: sub home_server_form_item {
2017: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2018: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2019: my $result;
2020: my $numlib = keys(%servers);
2021: if ($numlib > 1) {
2022: $result .= '<select name="'.$name.'" />'."\n";
2023: if ($default) {
1.804 bisitz 2024: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2025: '</option>'."\n";
2026: }
2027: foreach my $hostid (sort(keys(%servers))) {
2028: $result.= '<option value="'.$hostid.'">'.
2029: $hostid.' '.$servers{$hostid}."</option>\n";
2030: }
2031: $result .= '</select>'."\n";
2032: } elsif ($numlib == 1) {
2033: my $hostid;
2034: foreach my $item (keys(%servers)) {
2035: $hostid = $item;
2036: }
2037: $result .= '<input type="hidden" name="'.$name.'" value="'.
2038: $hostid.'" />';
2039: if (!$hide) {
2040: $result .= $hostid.' '.$servers{$hostid};
2041: }
2042: $result .= "\n";
2043: } elsif ($default) {
2044: $result .= '<input type="hidden" name="'.$name.
2045: '" value="default" />';
2046: if (!$hide) {
2047: $result .= &mt('default');
2048: }
2049: $result .= "\n";
1.33 matthew 2050: }
1.586 raeburn 2051: return ($result,$numlib);
1.33 matthew 2052: }
1.112 bowersj2 2053:
2054: =pod
2055:
1.534 albertel 2056: =back
2057:
1.112 bowersj2 2058: =cut
1.87 matthew 2059:
2060: ###############################################################
1.112 bowersj2 2061: ## Decoding User Agent ##
1.87 matthew 2062: ###############################################################
2063:
2064: =pod
2065:
1.112 bowersj2 2066: =head1 Decoding the User Agent
2067:
2068: =over 4
2069:
2070: =item * &decode_user_agent()
1.87 matthew 2071:
2072: Inputs: $r
2073:
2074: Outputs:
2075:
2076: =over 4
2077:
1.112 bowersj2 2078: =item * $httpbrowser
1.87 matthew 2079:
1.112 bowersj2 2080: =item * $clientbrowser
1.87 matthew 2081:
1.112 bowersj2 2082: =item * $clientversion
1.87 matthew 2083:
1.112 bowersj2 2084: =item * $clientmathml
1.87 matthew 2085:
1.112 bowersj2 2086: =item * $clientunicode
1.87 matthew 2087:
1.112 bowersj2 2088: =item * $clientos
1.87 matthew 2089:
2090: =back
2091:
1.157 matthew 2092: =back
2093:
1.87 matthew 2094: =cut
2095:
2096: ###############################################################
2097: ###############################################################
2098: sub decode_user_agent {
1.247 albertel 2099: my ($r)=@_;
1.87 matthew 2100: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2101: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2102: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2103: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2104: my $clientbrowser='unknown';
2105: my $clientversion='0';
2106: my $clientmathml='';
2107: my $clientunicode='0';
2108: for (my $i=0;$i<=$#browsertype;$i++) {
2109: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2110: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2111: $clientbrowser=$bname;
2112: $httpbrowser=~/$vreg/i;
2113: $clientversion=$1;
2114: $clientmathml=($clientversion>=$minv);
2115: $clientunicode=($clientversion>=$univ);
2116: }
2117: }
2118: my $clientos='unknown';
2119: if (($httpbrowser=~/linux/i) ||
2120: ($httpbrowser=~/unix/i) ||
2121: ($httpbrowser=~/ux/i) ||
2122: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2123: if (($httpbrowser=~/vax/i) ||
2124: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2125: if ($httpbrowser=~/next/i) { $clientos='next'; }
2126: if (($httpbrowser=~/mac/i) ||
2127: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2128: if ($httpbrowser=~/win/i) { $clientos='win'; }
2129: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2130: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2131: $clientunicode,$clientos,);
2132: }
2133:
1.32 matthew 2134: ###############################################################
2135: ## Authentication changing form generation subroutines ##
2136: ###############################################################
2137: ##
2138: ## All of the authform_xxxxxxx subroutines take their inputs in a
2139: ## hash, and have reasonable default values.
2140: ##
2141: ## formname = the name given in the <form> tag.
1.35 matthew 2142: #-------------------------------------------
2143:
1.45 matthew 2144: =pod
2145:
1.112 bowersj2 2146: =head1 Authentication Routines
2147:
2148: =over 4
2149:
1.648 raeburn 2150: =item * &authform_xxxxxx()
1.35 matthew 2151:
2152: The authform_xxxxxx subroutines provide javascript and html forms which
2153: handle some of the conveniences required for authentication forms.
2154: This is not an optimal method, but it works.
2155:
2156: =over 4
2157:
1.112 bowersj2 2158: =item * authform_header
1.35 matthew 2159:
1.112 bowersj2 2160: =item * authform_authorwarning
1.35 matthew 2161:
1.112 bowersj2 2162: =item * authform_nochange
1.35 matthew 2163:
1.112 bowersj2 2164: =item * authform_kerberos
1.35 matthew 2165:
1.112 bowersj2 2166: =item * authform_internal
1.35 matthew 2167:
1.112 bowersj2 2168: =item * authform_filesystem
1.35 matthew 2169:
2170: =back
2171:
1.648 raeburn 2172: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2173:
1.35 matthew 2174: =cut
2175:
2176: #-------------------------------------------
1.32 matthew 2177: sub authform_header{
2178: my %in = (
2179: formname => 'cu',
1.80 albertel 2180: kerb_def_dom => '',
1.32 matthew 2181: @_,
2182: );
2183: $in{'formname'} = 'document.' . $in{'formname'};
2184: my $result='';
1.80 albertel 2185:
2186: #---------------------------------------------- Code for upper case translation
2187: my $Javascript_toUpperCase;
2188: unless ($in{kerb_def_dom}) {
2189: $Javascript_toUpperCase =<<"END";
2190: switch (choice) {
2191: case 'krb': currentform.elements[choicearg].value =
2192: currentform.elements[choicearg].value.toUpperCase();
2193: break;
2194: default:
2195: }
2196: END
2197: } else {
2198: $Javascript_toUpperCase = "";
2199: }
2200:
1.165 raeburn 2201: my $radioval = "'nochange'";
1.591 raeburn 2202: if (defined($in{'curr_authtype'})) {
2203: if ($in{'curr_authtype'} ne '') {
2204: $radioval = "'".$in{'curr_authtype'}."arg'";
2205: }
1.174 matthew 2206: }
1.165 raeburn 2207: my $argfield = 'null';
1.591 raeburn 2208: if (defined($in{'mode'})) {
1.165 raeburn 2209: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2210: if (defined($in{'curr_autharg'})) {
2211: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2212: $argfield = "'$in{'curr_autharg'}'";
2213: }
2214: }
2215: }
2216: }
2217:
1.32 matthew 2218: $result.=<<"END";
2219: var current = new Object();
1.165 raeburn 2220: current.radiovalue = $radioval;
2221: current.argfield = $argfield;
1.32 matthew 2222:
2223: function changed_radio(choice,currentform) {
2224: var choicearg = choice + 'arg';
2225: // If a radio button in changed, we need to change the argfield
2226: if (current.radiovalue != choice) {
2227: current.radiovalue = choice;
2228: if (current.argfield != null) {
2229: currentform.elements[current.argfield].value = '';
2230: }
2231: if (choice == 'nochange') {
2232: current.argfield = null;
2233: } else {
2234: current.argfield = choicearg;
2235: switch(choice) {
2236: case 'krb':
2237: currentform.elements[current.argfield].value =
2238: "$in{'kerb_def_dom'}";
2239: break;
2240: default:
2241: break;
2242: }
2243: }
2244: }
2245: return;
2246: }
1.22 www 2247:
1.32 matthew 2248: function changed_text(choice,currentform) {
2249: var choicearg = choice + 'arg';
2250: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2251: $Javascript_toUpperCase
1.32 matthew 2252: // clear old field
2253: if ((current.argfield != choicearg) && (current.argfield != null)) {
2254: currentform.elements[current.argfield].value = '';
2255: }
2256: current.argfield = choicearg;
2257: }
2258: set_auth_radio_buttons(choice,currentform);
2259: return;
1.20 www 2260: }
1.32 matthew 2261:
2262: function set_auth_radio_buttons(newvalue,currentform) {
2263: var i=0;
2264: while (i < currentform.login.length) {
2265: if (currentform.login[i].value == newvalue) { break; }
2266: i++;
2267: }
2268: if (i == currentform.login.length) {
2269: return;
2270: }
2271: current.radiovalue = newvalue;
2272: currentform.login[i].checked = true;
2273: return;
2274: }
2275: END
2276: return $result;
2277: }
2278:
2279: sub authform_authorwarning{
2280: my $result='';
1.144 matthew 2281: $result='<i>'.
2282: &mt('As a general rule, only authors or co-authors should be '.
2283: 'filesystem authenticated '.
2284: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2285: return $result;
2286: }
2287:
2288: sub authform_nochange{
2289: my %in = (
2290: formname => 'document.cu',
2291: kerb_def_dom => 'MSU.EDU',
2292: @_,
2293: );
1.586 raeburn 2294: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2295: my $result;
2296: if (keys(%can_assign) == 0) {
2297: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2298: } else {
2299: $result = '<label>'.&mt('[_1] Do not change login data',
2300: '<input type="radio" name="login" value="nochange" '.
2301: 'checked="checked" onclick="'.
1.281 albertel 2302: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2303: '</label>';
1.586 raeburn 2304: }
1.32 matthew 2305: return $result;
2306: }
2307:
1.591 raeburn 2308: sub authform_kerberos {
1.32 matthew 2309: my %in = (
2310: formname => 'document.cu',
2311: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2312: kerb_def_auth => 'krb4',
1.32 matthew 2313: @_,
2314: );
1.586 raeburn 2315: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2316: $autharg,$jscall);
2317: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2318: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2319: $check5 = ' checked="checked"';
1.80 albertel 2320: } else {
1.772 bisitz 2321: $check4 = ' checked="checked"';
1.80 albertel 2322: }
1.165 raeburn 2323: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2324: if (defined($in{'curr_authtype'})) {
2325: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2326: $krbcheck = ' checked="checked"';
1.623 raeburn 2327: if (defined($in{'mode'})) {
2328: if ($in{'mode'} eq 'modifyuser') {
2329: $krbcheck = '';
2330: }
2331: }
1.591 raeburn 2332: if (defined($in{'curr_kerb_ver'})) {
2333: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2334: $check5 = ' checked="checked"';
1.591 raeburn 2335: $check4 = '';
2336: } else {
1.772 bisitz 2337: $check4 = ' checked="checked"';
1.591 raeburn 2338: $check5 = '';
2339: }
1.586 raeburn 2340: }
1.591 raeburn 2341: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2342: $krbarg = $in{'curr_autharg'};
2343: }
1.586 raeburn 2344: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2345: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2346: $result =
2347: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2348: $in{'curr_autharg'},$krbver);
2349: } else {
2350: $result =
2351: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2352: }
2353: return $result;
2354: }
2355: }
2356: } else {
2357: if ($authnum == 1) {
1.784 bisitz 2358: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2359: }
2360: }
1.586 raeburn 2361: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2362: return;
1.587 raeburn 2363: } elsif ($authtype eq '') {
1.591 raeburn 2364: if (defined($in{'mode'})) {
1.587 raeburn 2365: if ($in{'mode'} eq 'modifycourse') {
2366: if ($authnum == 1) {
1.784 bisitz 2367: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2368: }
2369: }
2370: }
1.586 raeburn 2371: }
2372: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2373: if ($authtype eq '') {
2374: $authtype = '<input type="radio" name="login" value="krb" '.
2375: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2376: $krbcheck.' />';
2377: }
2378: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2379: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2380: $in{'curr_authtype'} eq 'krb5') ||
2381: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2382: $in{'curr_authtype'} eq 'krb4')) {
2383: $result .= &mt
1.144 matthew 2384: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2385: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2386: '<label>'.$authtype,
1.281 albertel 2387: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2388: 'value="'.$krbarg.'" '.
1.144 matthew 2389: 'onchange="'.$jscall.'" />',
1.281 albertel 2390: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2391: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2392: '</label>');
1.586 raeburn 2393: } elsif ($can_assign{'krb4'}) {
2394: $result .= &mt
2395: ('[_1] Kerberos authenticated with domain [_2] '.
2396: '[_3] Version 4 [_4]',
2397: '<label>'.$authtype,
2398: '</label><input type="text" size="10" name="krbarg" '.
2399: 'value="'.$krbarg.'" '.
2400: 'onchange="'.$jscall.'" />',
2401: '<label><input type="hidden" name="krbver" value="4" />',
2402: '</label>');
2403: } elsif ($can_assign{'krb5'}) {
2404: $result .= &mt
2405: ('[_1] Kerberos authenticated with domain [_2] '.
2406: '[_3] Version 5 [_4]',
2407: '<label>'.$authtype,
2408: '</label><input type="text" size="10" name="krbarg" '.
2409: 'value="'.$krbarg.'" '.
2410: 'onchange="'.$jscall.'" />',
2411: '<label><input type="hidden" name="krbver" value="5" />',
2412: '</label>');
2413: }
1.32 matthew 2414: return $result;
2415: }
2416:
2417: sub authform_internal{
1.586 raeburn 2418: my %in = (
1.32 matthew 2419: formname => 'document.cu',
2420: kerb_def_dom => 'MSU.EDU',
2421: @_,
2422: );
1.586 raeburn 2423: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2424: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2425: if (defined($in{'curr_authtype'})) {
2426: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2427: if ($can_assign{'int'}) {
1.772 bisitz 2428: $intcheck = 'checked="checked" ';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $intcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2435: $intarg = $in{'curr_autharg'};
2436: }
2437: } else {
2438: $result = &mt('Currently internally authenticated.');
2439: return $result;
1.165 raeburn 2440: }
2441: }
1.586 raeburn 2442: } else {
2443: if ($authnum == 1) {
1.784 bisitz 2444: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2445: }
2446: }
2447: if (!$can_assign{'int'}) {
2448: return;
1.587 raeburn 2449: } elsif ($authtype eq '') {
1.591 raeburn 2450: if (defined($in{'mode'})) {
1.587 raeburn 2451: if ($in{'mode'} eq 'modifycourse') {
2452: if ($authnum == 1) {
1.784 bisitz 2453: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2454: }
2455: }
2456: }
1.165 raeburn 2457: }
1.586 raeburn 2458: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2459: if ($authtype eq '') {
2460: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2461: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2462: }
1.605 bisitz 2463: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2464: $intarg.'" onchange="'.$jscall.'" />';
2465: $result = &mt
1.144 matthew 2466: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2467: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2468: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2469: return $result;
2470: }
2471:
2472: sub authform_local{
2473: my %in = (
2474: formname => 'document.cu',
2475: kerb_def_dom => 'MSU.EDU',
2476: @_,
2477: );
1.586 raeburn 2478: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2479: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2480: if (defined($in{'curr_authtype'})) {
2481: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2482: if ($can_assign{'loc'}) {
1.772 bisitz 2483: $loccheck = 'checked="checked" ';
1.623 raeburn 2484: if (defined($in{'mode'})) {
2485: if ($in{'mode'} eq 'modifyuser') {
2486: $loccheck = '';
2487: }
2488: }
1.591 raeburn 2489: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2490: $locarg = $in{'curr_autharg'};
2491: }
2492: } else {
2493: $result = &mt('Currently using local (institutional) authentication.');
2494: return $result;
1.165 raeburn 2495: }
2496: }
1.586 raeburn 2497: } else {
2498: if ($authnum == 1) {
1.784 bisitz 2499: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2500: }
2501: }
2502: if (!$can_assign{'loc'}) {
2503: return;
1.587 raeburn 2504: } elsif ($authtype eq '') {
1.591 raeburn 2505: if (defined($in{'mode'})) {
1.587 raeburn 2506: if ($in{'mode'} eq 'modifycourse') {
2507: if ($authnum == 1) {
1.784 bisitz 2508: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2509: }
2510: }
2511: }
1.165 raeburn 2512: }
1.586 raeburn 2513: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2514: if ($authtype eq '') {
2515: $authtype = '<input type="radio" name="login" value="loc" '.
2516: $loccheck.' onchange="'.$jscall.'" onclick="'.
2517: $jscall.'" />';
2518: }
2519: $autharg = '<input type="text" size="10" name="locarg" value="'.
2520: $locarg.'" onchange="'.$jscall.'" />';
2521: $result = &mt('[_1] Local Authentication with argument [_2]',
2522: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2523: return $result;
2524: }
2525:
2526: sub authform_filesystem{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2533: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2534: if (defined($in{'curr_authtype'})) {
2535: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2536: if ($can_assign{'fsys'}) {
1.772 bisitz 2537: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $fsyscheck = '';
2541: }
2542: }
1.586 raeburn 2543: } else {
2544: $result = &mt('Currently Filesystem Authenticated.');
2545: return $result;
2546: }
2547: }
2548: } else {
2549: if ($authnum == 1) {
1.784 bisitz 2550: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2551: }
2552: }
2553: if (!$can_assign{'fsys'}) {
2554: return;
1.587 raeburn 2555: } elsif ($authtype eq '') {
1.591 raeburn 2556: if (defined($in{'mode'})) {
1.587 raeburn 2557: if ($in{'mode'} eq 'modifycourse') {
2558: if ($authnum == 1) {
1.784 bisitz 2559: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2560: }
2561: }
2562: }
1.586 raeburn 2563: }
2564: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2565: if ($authtype eq '') {
2566: $authtype = '<input type="radio" name="login" value="fsys" '.
2567: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2568: $jscall.'" />';
2569: }
2570: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2571: ' onchange="'.$jscall.'" />';
2572: $result = &mt
1.144 matthew 2573: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2574: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2575: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2576: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2577: 'onchange="'.$jscall.'" />');
1.32 matthew 2578: return $result;
2579: }
2580:
1.586 raeburn 2581: sub get_assignable_auth {
2582: my ($dom) = @_;
2583: if ($dom eq '') {
2584: $dom = $env{'request.role.domain'};
2585: }
2586: my %can_assign = (
2587: krb4 => 1,
2588: krb5 => 1,
2589: int => 1,
2590: loc => 1,
2591: );
2592: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2593: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2594: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2595: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2596: my $context;
2597: if ($env{'request.role'} =~ /^au/) {
2598: $context = 'author';
2599: } elsif ($env{'request.role'} =~ /^dc/) {
2600: $context = 'domain';
2601: } elsif ($env{'request.course.id'}) {
2602: $context = 'course';
2603: }
2604: if ($context) {
2605: if (ref($authhash->{$context}) eq 'HASH') {
2606: %can_assign = %{$authhash->{$context}};
2607: }
2608: }
2609: }
2610: }
2611: my $authnum = 0;
2612: foreach my $key (keys(%can_assign)) {
2613: if ($can_assign{$key}) {
2614: $authnum ++;
2615: }
2616: }
2617: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2618: $authnum --;
2619: }
2620: return ($authnum,%can_assign);
2621: }
2622:
1.80 albertel 2623: ###############################################################
2624: ## Get Kerberos Defaults for Domain ##
2625: ###############################################################
2626: ##
2627: ## Returns default kerberos version and an associated argument
2628: ## as listed in file domain.tab. If not listed, provides
2629: ## appropriate default domain and kerberos version.
2630: ##
2631: #-------------------------------------------
2632:
2633: =pod
2634:
1.648 raeburn 2635: =item * &get_kerberos_defaults()
1.80 albertel 2636:
2637: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2638: version and domain. If not found, it defaults to version 4 and the
2639: domain of the server.
1.80 albertel 2640:
1.648 raeburn 2641: =over 4
2642:
1.80 albertel 2643: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2644:
1.648 raeburn 2645: =back
2646:
2647: =back
2648:
1.80 albertel 2649: =cut
2650:
2651: #-------------------------------------------
2652: sub get_kerberos_defaults {
2653: my $domain=shift;
1.641 raeburn 2654: my ($krbdef,$krbdefdom);
2655: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2656: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2657: $krbdef = $domdefaults{'auth_def'};
2658: $krbdefdom = $domdefaults{'auth_arg_def'};
2659: } else {
1.80 albertel 2660: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2661: my $krbdefdom=$1;
2662: $krbdefdom=~tr/a-z/A-Z/;
2663: $krbdef = "krb4";
2664: }
2665: return ($krbdef,$krbdefdom);
2666: }
1.112 bowersj2 2667:
1.32 matthew 2668:
1.46 matthew 2669: ###############################################################
2670: ## Thesaurus Functions ##
2671: ###############################################################
1.20 www 2672:
1.46 matthew 2673: =pod
1.20 www 2674:
1.112 bowersj2 2675: =head1 Thesaurus Functions
2676:
2677: =over 4
2678:
1.648 raeburn 2679: =item * &initialize_keywords()
1.46 matthew 2680:
2681: Initializes the package variable %Keywords if it is empty. Uses the
2682: package variable $thesaurus_db_file.
2683:
2684: =cut
2685:
2686: ###################################################
2687:
2688: sub initialize_keywords {
2689: return 1 if (scalar keys(%Keywords));
2690: # If we are here, %Keywords is empty, so fill it up
2691: # Make sure the file we need exists...
2692: if (! -e $thesaurus_db_file) {
2693: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2694: " failed because it does not exist");
2695: return 0;
2696: }
2697: # Set up the hash as a database
2698: my %thesaurus_db;
2699: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2700: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2701: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2702: $thesaurus_db_file);
2703: return 0;
2704: }
2705: # Get the average number of appearances of a word.
2706: my $avecount = $thesaurus_db{'average.count'};
2707: # Put keywords (those that appear > average) into %Keywords
2708: while (my ($word,$data)=each (%thesaurus_db)) {
2709: my ($count,undef) = split /:/,$data;
2710: $Keywords{$word}++ if ($count > $avecount);
2711: }
2712: untie %thesaurus_db;
2713: # Remove special values from %Keywords.
1.356 albertel 2714: foreach my $value ('total.count','average.count') {
2715: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2716: }
1.46 matthew 2717: return 1;
2718: }
2719:
2720: ###################################################
2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &keyword($word)
1.46 matthew 2725:
2726: Returns true if $word is a keyword. A keyword is a word that appears more
2727: than the average number of times in the thesaurus database. Calls
2728: &initialize_keywords
2729:
2730: =cut
2731:
2732: ###################################################
1.20 www 2733:
2734: sub keyword {
1.46 matthew 2735: return if (!&initialize_keywords());
2736: my $word=lc(shift());
2737: $word=~s/\W//g;
2738: return exists($Keywords{$word});
1.20 www 2739: }
1.46 matthew 2740:
2741: ###############################################################
2742:
2743: =pod
1.20 www 2744:
1.648 raeburn 2745: =item * &get_related_words()
1.46 matthew 2746:
1.160 matthew 2747: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2748: an array of words. If the keyword is not in the thesaurus, an empty array
2749: will be returned. The order of the words returned is determined by the
2750: database which holds them.
2751:
2752: Uses global $thesaurus_db_file.
2753:
2754: =cut
2755:
2756: ###############################################################
2757: sub get_related_words {
2758: my $keyword = shift;
2759: my %thesaurus_db;
2760: if (! -e $thesaurus_db_file) {
2761: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2762: "failed because the file does not exist");
2763: return ();
2764: }
2765: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2766: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2767: return ();
2768: }
2769: my @Words=();
1.429 www 2770: my $count=0;
1.46 matthew 2771: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2772: # The first element is the number of times
2773: # the word appears. We do not need it now.
1.429 www 2774: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2775: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2776: my $threshold=$mostfrequentcount/10;
2777: foreach my $possibleword (@RelatedWords) {
2778: my ($word,$wordcount)=split(/\,/,$possibleword);
2779: if ($wordcount>$threshold) {
2780: push(@Words,$word);
2781: $count++;
2782: if ($count>10) { last; }
2783: }
1.20 www 2784: }
2785: }
1.46 matthew 2786: untie %thesaurus_db;
2787: return @Words;
1.14 harris41 2788: }
1.46 matthew 2789:
1.112 bowersj2 2790: =pod
2791:
2792: =back
2793:
2794: =cut
1.61 www 2795:
2796: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2797: =pod
2798:
1.112 bowersj2 2799: =head1 User Name Functions
2800:
2801: =over 4
2802:
1.648 raeburn 2803: =item * &plainname($uname,$udom,$first)
1.81 albertel 2804:
1.112 bowersj2 2805: Takes a users logon name and returns it as a string in
1.226 albertel 2806: "first middle last generation" form
2807: if $first is set to 'lastname' then it returns it as
2808: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2809:
2810: =cut
1.61 www 2811:
1.295 www 2812:
1.81 albertel 2813: ###############################################################
1.61 www 2814: sub plainname {
1.226 albertel 2815: my ($uname,$udom,$first)=@_;
1.537 albertel 2816: return if (!defined($uname) || !defined($udom));
1.295 www 2817: my %names=&getnames($uname,$udom);
1.226 albertel 2818: my $name=&Apache::lonnet::format_name($names{'firstname'},
2819: $names{'middlename'},
2820: $names{'lastname'},
2821: $names{'generation'},$first);
2822: $name=~s/^\s+//;
1.62 www 2823: $name=~s/\s+$//;
2824: $name=~s/\s+/ /g;
1.353 albertel 2825: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2826: return $name;
1.61 www 2827: }
1.66 www 2828:
2829: # -------------------------------------------------------------------- Nickname
1.81 albertel 2830: =pod
2831:
1.648 raeburn 2832: =item * &nickname($uname,$udom)
1.81 albertel 2833:
2834: Gets a users name and returns it as a string as
2835:
2836: ""nickname""
1.66 www 2837:
1.81 albertel 2838: if the user has a nickname or
2839:
2840: "first middle last generation"
2841:
2842: if the user does not
2843:
2844: =cut
1.66 www 2845:
2846: sub nickname {
2847: my ($uname,$udom)=@_;
1.537 albertel 2848: return if (!defined($uname) || !defined($udom));
1.295 www 2849: my %names=&getnames($uname,$udom);
1.68 albertel 2850: my $name=$names{'nickname'};
1.66 www 2851: if ($name) {
2852: $name='"'.$name.'"';
2853: } else {
2854: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2855: $names{'lastname'}.' '.$names{'generation'};
2856: $name=~s/\s+$//;
2857: $name=~s/\s+/ /g;
2858: }
2859: return $name;
2860: }
2861:
1.295 www 2862: sub getnames {
2863: my ($uname,$udom)=@_;
1.537 albertel 2864: return if (!defined($uname) || !defined($udom));
1.433 albertel 2865: if ($udom eq 'public' && $uname eq 'public') {
2866: return ('lastname' => &mt('Public'));
2867: }
1.295 www 2868: my $id=$uname.':'.$udom;
2869: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2870: if ($cached) {
2871: return %{$names};
2872: } else {
2873: my %loadnames=&Apache::lonnet::get('environment',
2874: ['firstname','middlename','lastname','generation','nickname'],
2875: $udom,$uname);
2876: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2877: return %loadnames;
2878: }
2879: }
1.61 www 2880:
1.542 raeburn 2881: # -------------------------------------------------------------------- getemails
1.648 raeburn 2882:
1.542 raeburn 2883: =pod
2884:
1.648 raeburn 2885: =item * &getemails($uname,$udom)
1.542 raeburn 2886:
2887: Gets a user's email information and returns it as a hash with keys:
2888: notification, critnotification, permanentemail
2889:
2890: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2891: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2892:
1.648 raeburn 2893:
1.542 raeburn 2894: =cut
2895:
1.648 raeburn 2896:
1.466 albertel 2897: sub getemails {
2898: my ($uname,$udom)=@_;
2899: if ($udom eq 'public' && $uname eq 'public') {
2900: return;
2901: }
1.467 www 2902: if (!$udom) { $udom=$env{'user.domain'}; }
2903: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2904: my $id=$uname.':'.$udom;
2905: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2906: if ($cached) {
2907: return %{$names};
2908: } else {
2909: my %loadnames=&Apache::lonnet::get('environment',
2910: ['notification','critnotification',
2911: 'permanentemail'],
2912: $udom,$uname);
2913: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2914: return %loadnames;
2915: }
2916: }
2917:
1.551 albertel 2918: sub flush_email_cache {
2919: my ($uname,$udom)=@_;
2920: if (!$udom) { $udom =$env{'user.domain'}; }
2921: if (!$uname) { $uname=$env{'user.name'}; }
2922: return if ($udom eq 'public' && $uname eq 'public');
2923: my $id=$uname.':'.$udom;
2924: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2925: }
2926:
1.728 raeburn 2927: # -------------------------------------------------------------------- getlangs
2928:
2929: =pod
2930:
2931: =item * &getlangs($uname,$udom)
2932:
2933: Gets a user's language preference and returns it as a hash with key:
2934: language.
2935:
2936: =cut
2937:
2938:
2939: sub getlangs {
2940: my ($uname,$udom) = @_;
2941: if (!$udom) { $udom =$env{'user.domain'}; }
2942: if (!$uname) { $uname=$env{'user.name'}; }
2943: my $id=$uname.':'.$udom;
2944: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2945: if ($cached) {
2946: return %{$langs};
2947: } else {
2948: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2949: $udom,$uname);
2950: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2951: return %loadlangs;
2952: }
2953: }
2954:
2955: sub flush_langs_cache {
2956: my ($uname,$udom)=@_;
2957: if (!$udom) { $udom =$env{'user.domain'}; }
2958: if (!$uname) { $uname=$env{'user.name'}; }
2959: return if ($udom eq 'public' && $uname eq 'public');
2960: my $id=$uname.':'.$udom;
2961: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2962: }
2963:
1.61 www 2964: # ------------------------------------------------------------------ Screenname
1.81 albertel 2965:
2966: =pod
2967:
1.648 raeburn 2968: =item * &screenname($uname,$udom)
1.81 albertel 2969:
2970: Gets a users screenname and returns it as a string
2971:
2972: =cut
1.61 www 2973:
2974: sub screenname {
2975: my ($uname,$udom)=@_;
1.258 albertel 2976: if ($uname eq $env{'user.name'} &&
2977: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2978: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2979: return $names{'screenname'};
1.62 www 2980: }
2981:
1.212 albertel 2982:
1.802 bisitz 2983: # ------------------------------------------------------------- Confirm Wrapper
2984: =pod
2985:
2986: =item confirmwrapper
2987:
2988: Wrap messages about completion of operation in box
2989:
2990: =cut
2991:
2992: sub confirmwrapper {
2993: my ($message)=@_;
2994: if ($message) {
2995: return "\n".'<div class="LC_confirm_box">'."\n"
2996: .$message."\n"
2997: .'</div>'."\n";
2998: } else {
2999: return $message;
3000: }
3001: }
3002:
1.62 www 3003: # ------------------------------------------------------------- Message Wrapper
3004:
3005: sub messagewrapper {
1.369 www 3006: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3007: return
1.441 albertel 3008: '<a href="/adm/email?compose=individual&'.
3009: 'recname='.$username.'&recdom='.$domain.
3010: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3011: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3012: }
1.802 bisitz 3013:
1.74 www 3014: # --------------------------------------------------------------- Notes Wrapper
3015:
3016: sub noteswrapper {
3017: my ($link,$un,$do)=@_;
3018: return
1.896 amueller 3019: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3020: }
1.802 bisitz 3021:
1.62 www 3022: # ------------------------------------------------------------- Aboutme Wrapper
3023:
3024: sub aboutmewrapper {
1.166 www 3025: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3026: if (!defined($username) && !defined($domain)) {
3027: return;
3028: }
1.892 amueller 3029: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3030: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3031: }
3032:
3033: # ------------------------------------------------------------ Syllabus Wrapper
3034:
3035: sub syllabuswrapper {
1.707 bisitz 3036: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3037: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3038: }
1.14 harris41 3039:
1.802 bisitz 3040: # -----------------------------------------------------------------------------
3041:
1.208 matthew 3042: sub track_student_link {
1.887 raeburn 3043: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3044: my $link ="/adm/trackstudent?";
1.208 matthew 3045: my $title = 'View recent activity';
3046: if (defined($sname) && $sname !~ /^\s*$/ &&
3047: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3048: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3049: $title .= ' of this student';
1.268 albertel 3050: }
1.208 matthew 3051: if (defined($target) && $target !~ /^\s*$/) {
3052: $target = qq{target="$target"};
3053: } else {
3054: $target = '';
3055: }
1.268 albertel 3056: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3057: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3058: $title = &mt($title);
3059: $linktext = &mt($linktext);
1.448 albertel 3060: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3061: &help_open_topic('View_recent_activity');
1.208 matthew 3062: }
3063:
1.781 raeburn 3064: sub slot_reservations_link {
3065: my ($linktext,$sname,$sdom,$target) = @_;
3066: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3067: my $title = 'View slot reservation history';
3068: if (defined($sname) && $sname !~ /^\s*$/ &&
3069: defined($sdom) && $sdom !~ /^\s*$/) {
3070: $link .= "&uname=$sname&udom=$sdom";
3071: $title .= ' of this student';
3072: }
3073: if (defined($target) && $target !~ /^\s*$/) {
3074: $target = qq{target="$target"};
3075: } else {
3076: $target = '';
3077: }
3078: $title = &mt($title);
3079: $linktext = &mt($linktext);
3080: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3081: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3082:
3083: }
3084:
1.508 www 3085: # ===================================================== Display a student photo
3086:
3087:
1.509 albertel 3088: sub student_image_tag {
1.508 www 3089: my ($domain,$user)=@_;
3090: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3091: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3092: return '<img src="'.$imgsrc.'" align="right" />';
3093: } else {
3094: return '';
3095: }
3096: }
3097:
1.112 bowersj2 3098: =pod
3099:
3100: =back
3101:
3102: =head1 Access .tab File Data
3103:
3104: =over 4
3105:
1.648 raeburn 3106: =item * &languageids()
1.112 bowersj2 3107:
3108: returns list of all language ids
3109:
3110: =cut
3111:
1.14 harris41 3112: sub languageids {
1.16 harris41 3113: return sort(keys(%language));
1.14 harris41 3114: }
3115:
1.112 bowersj2 3116: =pod
3117:
1.648 raeburn 3118: =item * &languagedescription()
1.112 bowersj2 3119:
3120: returns description of a specified language id
3121:
3122: =cut
3123:
1.14 harris41 3124: sub languagedescription {
1.125 www 3125: my $code=shift;
3126: return ($supported_language{$code}?'* ':'').
3127: $language{$code}.
1.126 www 3128: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3129: }
3130:
3131: sub plainlanguagedescription {
3132: my $code=shift;
3133: return $language{$code};
3134: }
3135:
3136: sub supportedlanguagecode {
3137: my $code=shift;
3138: return $supported_language{$code};
1.97 www 3139: }
3140:
1.112 bowersj2 3141: =pod
3142:
1.648 raeburn 3143: =item * ©rightids()
1.112 bowersj2 3144:
3145: returns list of all copyrights
3146:
3147: =cut
3148:
3149: sub copyrightids {
3150: return sort(keys(%cprtag));
3151: }
3152:
3153: =pod
3154:
1.648 raeburn 3155: =item * ©rightdescription()
1.112 bowersj2 3156:
3157: returns description of a specified copyright id
3158:
3159: =cut
3160:
3161: sub copyrightdescription {
1.166 www 3162: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3163: }
1.197 matthew 3164:
3165: =pod
3166:
1.648 raeburn 3167: =item * &source_copyrightids()
1.192 taceyjo1 3168:
3169: returns list of all source copyrights
3170:
3171: =cut
3172:
3173: sub source_copyrightids {
3174: return sort(keys(%scprtag));
3175: }
3176:
3177: =pod
3178:
1.648 raeburn 3179: =item * &source_copyrightdescription()
1.192 taceyjo1 3180:
3181: returns description of a specified source copyright id
3182:
3183: =cut
3184:
3185: sub source_copyrightdescription {
3186: return &mt($scprtag{shift(@_)});
3187: }
1.112 bowersj2 3188:
3189: =pod
3190:
1.648 raeburn 3191: =item * &filecategories()
1.112 bowersj2 3192:
3193: returns list of all file categories
3194:
3195: =cut
3196:
3197: sub filecategories {
3198: return sort(keys(%category_extensions));
3199: }
3200:
3201: =pod
3202:
1.648 raeburn 3203: =item * &filecategorytypes()
1.112 bowersj2 3204:
3205: returns list of file types belonging to a given file
3206: category
3207:
3208: =cut
3209:
3210: sub filecategorytypes {
1.356 albertel 3211: my ($cat) = @_;
3212: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &fileembstyle()
1.112 bowersj2 3218:
3219: returns embedding style for a specified file type
3220:
3221: =cut
3222:
3223: sub fileembstyle {
3224: return $fe{lc(shift(@_))};
1.169 www 3225: }
3226:
1.351 www 3227: sub filemimetype {
3228: return $fm{lc(shift(@_))};
3229: }
3230:
1.169 www 3231:
3232: sub filecategoryselect {
3233: my ($name,$value)=@_;
1.189 matthew 3234: return &select_form($value,$name,
1.169 www 3235: '' => &mt('Any category'),
3236: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3237: }
3238:
3239: =pod
3240:
1.648 raeburn 3241: =item * &filedescription()
1.112 bowersj2 3242:
3243: returns description for a specified file type
3244:
3245: =cut
3246:
3247: sub filedescription {
1.188 matthew 3248: my $file_description = $fd{lc(shift())};
3249: $file_description =~ s:([\[\]]):~$1:g;
3250: return &mt($file_description);
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescriptionex()
1.112 bowersj2 3256:
3257: returns description for a specified file type with
3258: extra formatting
3259:
3260: =cut
3261:
3262: sub filedescriptionex {
3263: my $ex=shift;
1.188 matthew 3264: my $file_description = $fd{lc($ex)};
3265: $file_description =~ s:([\[\]]):~$1:g;
3266: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3267: }
3268:
3269: # End of .tab access
3270: =pod
3271:
3272: =back
3273:
3274: =cut
3275:
3276: # ------------------------------------------------------------------ File Types
3277: sub fileextensions {
3278: return sort(keys(%fe));
3279: }
3280:
1.97 www 3281: # ----------------------------------------------------------- Display Languages
3282: # returns a hash with all desired display languages
3283: #
3284:
3285: sub display_languages {
3286: my %languages=();
1.695 raeburn 3287: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3288: $languages{$lang}=1;
1.97 www 3289: }
3290: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3291: if ($env{'form.displaylanguage'}) {
1.356 albertel 3292: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3293: $languages{$lang}=1;
1.97 www 3294: }
3295: }
3296: return %languages;
1.14 harris41 3297: }
3298:
1.582 albertel 3299: sub languages {
3300: my ($possible_langs) = @_;
1.695 raeburn 3301: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3302: if (!ref($possible_langs)) {
3303: if( wantarray ) {
3304: return @preferred_langs;
3305: } else {
3306: return $preferred_langs[0];
3307: }
3308: }
3309: my %possibilities = map { $_ => 1 } (@$possible_langs);
3310: my @preferred_possibilities;
3311: foreach my $preferred_lang (@preferred_langs) {
3312: if (exists($possibilities{$preferred_lang})) {
3313: push(@preferred_possibilities, $preferred_lang);
3314: }
3315: }
3316: if( wantarray ) {
3317: return @preferred_possibilities;
3318: }
3319: return $preferred_possibilities[0];
3320: }
3321:
1.742 raeburn 3322: sub user_lang {
3323: my ($touname,$toudom,$fromcid) = @_;
3324: my @userlangs;
3325: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3326: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3327: $env{'course.'.$fromcid.'.languages'}));
3328: } else {
3329: my %langhash = &getlangs($touname,$toudom);
3330: if ($langhash{'languages'} ne '') {
3331: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3332: } else {
3333: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3334: if ($domdefs{'lang_def'} ne '') {
3335: @userlangs = ($domdefs{'lang_def'});
3336: }
3337: }
3338: }
3339: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3340: my $user_lh = Apache::localize->get_handle(@languages);
3341: return $user_lh;
3342: }
3343:
3344:
1.112 bowersj2 3345: ###############################################################
3346: ## Student Answer Attempts ##
3347: ###############################################################
3348:
3349: =pod
3350:
3351: =head1 Alternate Problem Views
3352:
3353: =over 4
3354:
1.648 raeburn 3355: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3356: $getattempt, $regexp, $gradesub)
3357:
3358: Return string with previous attempt on problem. Arguments:
3359:
3360: =over 4
3361:
3362: =item * $symb: Problem, including path
3363:
3364: =item * $username: username of the desired student
3365:
3366: =item * $domain: domain of the desired student
1.14 harris41 3367:
1.112 bowersj2 3368: =item * $course: Course ID
1.14 harris41 3369:
1.112 bowersj2 3370: =item * $getattempt: Leave blank for all attempts, otherwise put
3371: something
1.14 harris41 3372:
1.112 bowersj2 3373: =item * $regexp: if string matches this regexp, the string will be
3374: sent to $gradesub
1.14 harris41 3375:
1.112 bowersj2 3376: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3377:
1.112 bowersj2 3378: =back
1.14 harris41 3379:
1.112 bowersj2 3380: The output string is a table containing all desired attempts, if any.
1.16 harris41 3381:
1.112 bowersj2 3382: =cut
1.1 albertel 3383:
3384: sub get_previous_attempt {
1.43 ng 3385: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3386: my $prevattempts='';
1.43 ng 3387: no strict 'refs';
1.1 albertel 3388: if ($symb) {
1.3 albertel 3389: my (%returnhash)=
3390: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3391: if ($returnhash{'version'}) {
3392: my %lasthash=();
3393: my $version;
3394: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3395: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3396: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3397: }
1.1 albertel 3398: }
1.596 albertel 3399: $prevattempts=&start_data_table().&start_data_table_header_row();
3400: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3401: my %typeparts;
3402: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3403: foreach my $key (sort(keys(%lasthash))) {
3404: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3405: if ($#parts > 0) {
1.31 albertel 3406: my $data=$parts[-1];
3407: pop(@parts);
1.945 raeburn 3408: if ($data eq 'type') {
3409: unless ($showsurv) {
3410: my $id = join(',',@parts);
3411: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3412: }
3413: delete($lasthash{$key});
3414: } else {
3415: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3416: }
1.31 albertel 3417: } else {
1.41 ng 3418: if ($#parts == 0) {
3419: $prevattempts.='<th>'.$parts[0].'</th>';
3420: } else {
3421: $prevattempts.='<th>'.$ign.'</th>';
3422: }
1.31 albertel 3423: }
1.16 harris41 3424: }
1.596 albertel 3425: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3426: my %lasthidden;
1.40 ng 3427: if ($getattempt eq '') {
3428: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3429: my @hidden;
3430: if (%typeparts) {
3431: foreach my $id (keys(%typeparts)) {
3432: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3433: push(@hidden,$id);
3434: $lasthidden{$id} = 1;
3435: } elsif ($lasthidden{$id}) {
3436: if (exists($returnhash{$version.':'.$id.'.award'})) {
3437: delete($lasthidden{$id});
3438: }
3439: }
3440: }
3441: }
3442: $prevattempts.=&start_data_table_row().
3443: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3444: if (@hidden) {
3445: foreach my $key (sort(keys(%lasthash))) {
3446: my $hide;
3447: foreach my $id (@hidden) {
3448: if ($key =~ /^\Q$id\E/) {
3449: $hide = 1;
3450: last;
3451: }
3452: }
3453: if ($hide) {
3454: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3455: if (($data eq 'award') || ($data eq 'awarddetail')) {
3456: my $value = &format_previous_attempt_value($key,
3457: $returnhash{$version.':'.$key});
3458: $prevattempts.='<td>'.$value.' </td>';
3459: } else {
3460: $prevattempts.='<td> </td>';
3461: }
3462: } else {
3463: if ($key =~ /\./) {
3464: my $value = &format_previous_attempt_value($key,
3465: $returnhash{$version.':'.$key});
3466: $prevattempts.='<td>'.$value.' </td>';
3467: } else {
3468: $prevattempts.='<td> </td>';
3469: }
3470: }
3471: }
3472: } else {
3473: foreach my $key (sort(keys(%lasthash))) {
3474: my $value = &format_previous_attempt_value($key,
3475: $returnhash{$version.':'.$key});
3476: $prevattempts.='<td>'.$value.' </td>';
3477: }
3478: }
3479: $prevattempts.=&end_data_table_row();
1.40 ng 3480: }
1.1 albertel 3481: }
1.945 raeburn 3482: my @currhidden = keys(%lasthidden);
1.596 albertel 3483: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3484: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3485: if (%typeparts) {
3486: my $hidden;
3487: foreach my $id (@currhidden) {
3488: if ($key =~ /^\Q$id\E/) {
3489: $hidden = 1;
3490: last;
3491: }
3492: }
3493: if ($hidden) {
3494: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3495: if (($data eq 'award') || ($data eq 'awarddetail')) {
3496: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3497: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3498: $value = &$gradesub($value);
3499: }
3500: $prevattempts.='<td>'.$value.' </td>';
3501: } else {
3502: $prevattempts.='<td> </td>';
3503: }
3504: } else {
3505: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3506: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3507: $value = &$gradesub($value);
3508: }
3509: $prevattempts.='<td>'.$value.' </td>';
3510: }
3511: } else {
3512: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3513: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3514: $value = &$gradesub($value);
3515: }
3516: $prevattempts.='<td>'.$value.' </td>';
3517: }
1.16 harris41 3518: }
1.596 albertel 3519: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3520: } else {
1.596 albertel 3521: $prevattempts=
3522: &start_data_table().&start_data_table_row().
3523: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3524: &end_data_table_row().&end_data_table();
1.1 albertel 3525: }
3526: } else {
1.596 albertel 3527: $prevattempts=
3528: &start_data_table().&start_data_table_row().
3529: '<td>'.&mt('No data.').'</td>'.
3530: &end_data_table_row().&end_data_table();
1.1 albertel 3531: }
1.10 albertel 3532: }
3533:
1.581 albertel 3534: sub format_previous_attempt_value {
3535: my ($key,$value) = @_;
3536: if ($key =~ /timestamp/) {
3537: $value = &Apache::lonlocal::locallocaltime($value);
3538: } elsif (ref($value) eq 'ARRAY') {
3539: $value = '('.join(', ', @{ $value }).')';
3540: } else {
3541: $value = &unescape($value);
3542: }
3543: return $value;
3544: }
3545:
3546:
1.107 albertel 3547: sub relative_to_absolute {
3548: my ($url,$output)=@_;
3549: my $parser=HTML::TokeParser->new(\$output);
3550: my $token;
3551: my $thisdir=$url;
3552: my @rlinks=();
3553: while ($token=$parser->get_token) {
3554: if ($token->[0] eq 'S') {
3555: if ($token->[1] eq 'a') {
3556: if ($token->[2]->{'href'}) {
3557: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3558: }
3559: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3560: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3561: } elsif ($token->[1] eq 'base') {
3562: $thisdir=$token->[2]->{'href'};
3563: }
3564: }
3565: }
3566: $thisdir=~s-/[^/]*$--;
1.356 albertel 3567: foreach my $link (@rlinks) {
1.726 raeburn 3568: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3569: ($link=~/^\//) ||
3570: ($link=~/^javascript:/i) ||
3571: ($link=~/^mailto:/i) ||
3572: ($link=~/^\#/)) {
3573: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3574: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3575: }
3576: }
3577: # -------------------------------------------------- Deal with Applet codebases
3578: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3579: return $output;
3580: }
3581:
1.112 bowersj2 3582: =pod
3583:
1.648 raeburn 3584: =item * &get_student_view()
1.112 bowersj2 3585:
3586: show a snapshot of what student was looking at
3587:
3588: =cut
3589:
1.10 albertel 3590: sub get_student_view {
1.186 albertel 3591: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3592: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3593: my (%form);
1.10 albertel 3594: my @elements=('symb','courseid','domain','username');
3595: foreach my $element (@elements) {
1.186 albertel 3596: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3597: }
1.186 albertel 3598: if (defined($moreenv)) {
3599: %form=(%form,%{$moreenv});
3600: }
1.236 albertel 3601: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3602: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3603: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3604: $userview=~s/\<body[^\>]*\>//gi;
3605: $userview=~s/\<\/body\>//gi;
3606: $userview=~s/\<html\>//gi;
3607: $userview=~s/\<\/html\>//gi;
3608: $userview=~s/\<head\>//gi;
3609: $userview=~s/\<\/head\>//gi;
3610: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3611: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3612: if (wantarray) {
3613: return ($userview,$response);
3614: } else {
3615: return $userview;
3616: }
3617: }
3618:
3619: sub get_student_view_with_retries {
3620: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3621:
3622: my $ok = 0; # True if we got a good response.
3623: my $content;
3624: my $response;
3625:
3626: # Try to get the student_view done. within the retries count:
3627:
3628: do {
3629: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3630: $ok = $response->is_success;
3631: if (!$ok) {
3632: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3633: }
3634: $retries--;
3635: } while (!$ok && ($retries > 0));
3636:
3637: if (!$ok) {
3638: $content = ''; # On error return an empty content.
3639: }
1.651 www 3640: if (wantarray) {
3641: return ($content, $response);
3642: } else {
3643: return $content;
3644: }
1.11 albertel 3645: }
3646:
1.112 bowersj2 3647: =pod
3648:
1.648 raeburn 3649: =item * &get_student_answers()
1.112 bowersj2 3650:
3651: show a snapshot of how student was answering problem
3652:
3653: =cut
3654:
1.11 albertel 3655: sub get_student_answers {
1.100 sakharuk 3656: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3657: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3658: my (%moreenv);
1.11 albertel 3659: my @elements=('symb','courseid','domain','username');
3660: foreach my $element (@elements) {
1.186 albertel 3661: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3662: }
1.186 albertel 3663: $moreenv{'grade_target'}='answer';
3664: %moreenv=(%form,%moreenv);
1.497 raeburn 3665: $feedurl = &Apache::lonnet::clutter($feedurl);
3666: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3667: return $userview;
1.1 albertel 3668: }
1.116 albertel 3669:
3670: =pod
3671:
3672: =item * &submlink()
3673:
1.242 albertel 3674: Inputs: $text $uname $udom $symb $target
1.116 albertel 3675:
3676: Returns: A link to grades.pm such as to see the SUBM view of a student
3677:
3678: =cut
3679:
3680: ###############################################
3681: sub submlink {
1.242 albertel 3682: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3683: if (!($uname && $udom)) {
3684: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3685: &Apache::lonnet::whichuser($symb);
1.116 albertel 3686: if (!$symb) { $symb=$cursymb; }
3687: }
1.254 matthew 3688: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3689: $symb=&escape($symb);
1.242 albertel 3690: if ($target) { $target="target=\"$target\""; }
3691: return '<a href="/adm/grades?&command=submission&'.
3692: 'symb='.$symb.'&student='.$uname.
3693: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3694: }
3695: ##############################################
3696:
3697: =pod
3698:
3699: =item * &pgrdlink()
3700:
3701: Inputs: $text $uname $udom $symb $target
3702:
3703: Returns: A link to grades.pm such as to see the PGRD view of a student
3704:
3705: =cut
3706:
3707: ###############################################
3708: sub pgrdlink {
3709: my $link=&submlink(@_);
3710: $link=~s/(&command=submission)/$1&showgrading=yes/;
3711: return $link;
3712: }
3713: ##############################################
3714:
3715: =pod
3716:
3717: =item * &pprmlink()
3718:
3719: Inputs: $text $uname $udom $symb $target
3720:
3721: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3722: student and a specific resource
1.242 albertel 3723:
3724: =cut
3725:
3726: ###############################################
3727: sub pprmlink {
3728: my ($text,$uname,$udom,$symb,$target)=@_;
3729: if (!($uname && $udom)) {
3730: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3731: &Apache::lonnet::whichuser($symb);
1.242 albertel 3732: if (!$symb) { $symb=$cursymb; }
3733: }
1.254 matthew 3734: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3735: $symb=&escape($symb);
1.242 albertel 3736: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3737: return '<a href="/adm/parmset?command=set&'.
3738: 'symb='.$symb.'&uname='.$uname.
3739: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3740: }
3741: ##############################################
1.37 matthew 3742:
1.112 bowersj2 3743: =pod
3744:
3745: =back
3746:
3747: =cut
3748:
1.37 matthew 3749: ###############################################
1.51 www 3750:
3751:
3752: sub timehash {
1.687 raeburn 3753: my ($thistime) = @_;
3754: my $timezone = &Apache::lonlocal::gettimezone();
3755: my $dt = DateTime->from_epoch(epoch => $thistime)
3756: ->set_time_zone($timezone);
3757: my $wday = $dt->day_of_week();
3758: if ($wday == 7) { $wday = 0; }
3759: return ( 'second' => $dt->second(),
3760: 'minute' => $dt->minute(),
3761: 'hour' => $dt->hour(),
3762: 'day' => $dt->day_of_month(),
3763: 'month' => $dt->month(),
3764: 'year' => $dt->year(),
3765: 'weekday' => $wday,
3766: 'dayyear' => $dt->day_of_year(),
3767: 'dlsav' => $dt->is_dst() );
1.51 www 3768: }
3769:
1.370 www 3770: sub utc_string {
3771: my ($date)=@_;
1.371 www 3772: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3773: }
3774:
1.51 www 3775: sub maketime {
3776: my %th=@_;
1.687 raeburn 3777: my ($epoch_time,$timezone,$dt);
3778: $timezone = &Apache::lonlocal::gettimezone();
3779: eval {
3780: $dt = DateTime->new( year => $th{'year'},
3781: month => $th{'month'},
3782: day => $th{'day'},
3783: hour => $th{'hour'},
3784: minute => $th{'minute'},
3785: second => $th{'second'},
3786: time_zone => $timezone,
3787: );
3788: };
3789: if (!$@) {
3790: $epoch_time = $dt->epoch;
3791: if ($epoch_time) {
3792: return $epoch_time;
3793: }
3794: }
1.51 www 3795: return POSIX::mktime(
3796: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3797: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3798: }
3799:
3800: #########################################
1.51 www 3801:
3802: sub findallcourses {
1.482 raeburn 3803: my ($roles,$uname,$udom) = @_;
1.355 albertel 3804: my %roles;
3805: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3806: my %courses;
1.51 www 3807: my $now=time;
1.482 raeburn 3808: if (!defined($uname)) {
3809: $uname = $env{'user.name'};
3810: }
3811: if (!defined($udom)) {
3812: $udom = $env{'user.domain'};
3813: }
3814: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3815: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3816: if (!%roles) {
3817: %roles = (
3818: cc => 1,
1.907 raeburn 3819: co => 1,
1.482 raeburn 3820: in => 1,
3821: ep => 1,
3822: ta => 1,
3823: cr => 1,
3824: st => 1,
3825: );
3826: }
3827: foreach my $entry (keys(%roleshash)) {
3828: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3829: if ($trole =~ /^cr/) {
3830: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3831: } else {
3832: next if (!exists($roles{$trole}));
3833: }
3834: if ($tend) {
3835: next if ($tend < $now);
3836: }
3837: if ($tstart) {
3838: next if ($tstart > $now);
3839: }
3840: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3841: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3842: if ($secpart eq '') {
3843: ($cnum,$role) = split(/_/,$cnumpart);
3844: $sec = 'none';
3845: $realsec = '';
3846: } else {
3847: $cnum = $cnumpart;
3848: ($sec,$role) = split(/_/,$secpart);
3849: $realsec = $sec;
1.490 raeburn 3850: }
1.482 raeburn 3851: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3852: }
3853: } else {
3854: foreach my $key (keys(%env)) {
1.483 albertel 3855: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3856: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3857: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3858: next if ($role eq 'ca' || $role eq 'aa');
3859: next if (%roles && !exists($roles{$role}));
3860: my ($starttime,$endtime)=split(/\./,$env{$key});
3861: my $active=1;
3862: if ($starttime) {
3863: if ($now<$starttime) { $active=0; }
3864: }
3865: if ($endtime) {
3866: if ($now>$endtime) { $active=0; }
3867: }
3868: if ($active) {
3869: if ($sec eq '') {
3870: $sec = 'none';
3871: }
3872: $courses{$cdom.'_'.$cnum}{$sec} =
3873: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3874: }
3875: }
1.51 www 3876: }
3877: }
1.474 raeburn 3878: return %courses;
1.51 www 3879: }
1.37 matthew 3880:
1.54 www 3881: ###############################################
1.474 raeburn 3882:
3883: sub blockcheck {
1.482 raeburn 3884: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3885:
3886: if (!defined($udom)) {
3887: $udom = $env{'user.domain'};
3888: }
3889: if (!defined($uname)) {
3890: $uname = $env{'user.name'};
3891: }
3892:
3893: # If uname and udom are for a course, check for blocks in the course.
3894:
3895: if (&Apache::lonnet::is_course($udom,$uname)) {
3896: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3897: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3898: return ($startblock,$endblock);
3899: }
1.474 raeburn 3900:
1.502 raeburn 3901: my $startblock = 0;
3902: my $endblock = 0;
1.482 raeburn 3903: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3904:
1.490 raeburn 3905: # If uname is for a user, and activity is course-specific, i.e.,
3906: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3907:
1.490 raeburn 3908: if (($activity eq 'boards' || $activity eq 'chat' ||
3909: $activity eq 'groups') && ($env{'request.course.id'})) {
3910: foreach my $key (keys(%live_courses)) {
3911: if ($key ne $env{'request.course.id'}) {
3912: delete($live_courses{$key});
3913: }
3914: }
3915: }
3916:
3917: my $otheruser = 0;
3918: my %own_courses;
3919: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3920: # Resource belongs to user other than current user.
3921: $otheruser = 1;
3922: # Gather courses for current user
3923: %own_courses =
3924: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3925: }
3926:
3927: # Gather active course roles - course coordinator, instructor,
3928: # exam proctor, ta, student, or custom role.
1.474 raeburn 3929:
3930: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3931: my ($cdom,$cnum);
3932: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3933: $cdom = $env{'course.'.$course.'.domain'};
3934: $cnum = $env{'course.'.$course.'.num'};
3935: } else {
1.490 raeburn 3936: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3937: }
3938: my $no_ownblock = 0;
3939: my $no_userblock = 0;
1.533 raeburn 3940: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3941: # Check if current user has 'evb' priv for this
3942: if (defined($own_courses{$course})) {
3943: foreach my $sec (keys(%{$own_courses{$course}})) {
3944: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3945: if ($sec ne 'none') {
3946: $checkrole .= '/'.$sec;
3947: }
3948: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3949: $no_ownblock = 1;
3950: last;
3951: }
3952: }
3953: }
3954: # if they have 'evb' priv and are currently not playing student
3955: next if (($no_ownblock) &&
3956: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3957: }
1.474 raeburn 3958: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3959: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3960: if ($sec ne 'none') {
1.482 raeburn 3961: $checkrole .= '/'.$sec;
1.474 raeburn 3962: }
1.490 raeburn 3963: if ($otheruser) {
3964: # Resource belongs to user other than current user.
3965: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3966: my ($trole,$tdom,$tnum,$tsec);
3967: my $entry = $live_courses{$course}{$sec};
3968: if ($entry =~ /^cr/) {
3969: ($trole,$tdom,$tnum,$tsec) =
3970: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3971: } else {
3972: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3973: }
3974: my ($spec,$area,$trest,%allroles,%userroles);
3975: $area = '/'.$tdom.'/'.$tnum;
3976: $trest = $tnum;
3977: if ($tsec ne '') {
3978: $area .= '/'.$tsec;
3979: $trest .= '/'.$tsec;
3980: }
3981: $spec = $trole.'.'.$area;
3982: if ($trole =~ /^cr/) {
3983: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3984: $tdom,$spec,$trest,$area);
3985: } else {
3986: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3987: $tdom,$spec,$trest,$area);
3988: }
3989: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3990: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3991: if ($1) {
3992: $no_userblock = 1;
3993: last;
3994: }
3995: }
1.490 raeburn 3996: } else {
3997: # Resource belongs to current user
3998: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3999: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4000: $no_ownblock = 1;
4001: last;
4002: }
1.474 raeburn 4003: }
4004: }
4005: # if they have the evb priv and are currently not playing student
1.482 raeburn 4006: next if (($no_ownblock) &&
1.491 albertel 4007: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4008: next if ($no_userblock);
1.474 raeburn 4009:
1.866 kalberla 4010: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4011: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4012:
4013: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4014: if (($start != 0) &&
4015: (($startblock == 0) || ($startblock > $start))) {
4016: $startblock = $start;
4017: }
4018: if (($end != 0) &&
4019: (($endblock == 0) || ($endblock < $end))) {
4020: $endblock = $end;
4021: }
1.490 raeburn 4022: }
4023: return ($startblock,$endblock);
4024: }
4025:
4026: sub get_blocks {
4027: my ($setters,$activity,$cdom,$cnum) = @_;
4028: my $startblock = 0;
4029: my $endblock = 0;
4030: my $course = $cdom.'_'.$cnum;
4031: $setters->{$course} = {};
4032: $setters->{$course}{'staff'} = [];
4033: $setters->{$course}{'times'} = [];
4034: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4035: foreach my $record (keys(%records)) {
4036: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4037: if ($start <= time && $end >= time) {
4038: my ($staff_name,$staff_dom,$title,$blocks) =
4039: &parse_block_record($records{$record});
4040: if ($blocks->{$activity} eq 'on') {
4041: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4042: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4043: if ( ($startblock == 0) || ($startblock > $start) ) {
4044: $startblock = $start;
1.490 raeburn 4045: }
1.491 albertel 4046: if ( ($endblock == 0) || ($endblock < $end) ) {
4047: $endblock = $end;
1.474 raeburn 4048: }
4049: }
4050: }
4051: }
4052: return ($startblock,$endblock);
4053: }
4054:
4055: sub parse_block_record {
4056: my ($record) = @_;
4057: my ($setuname,$setudom,$title,$blocks);
4058: if (ref($record) eq 'HASH') {
4059: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4060: $title = &unescape($record->{'event'});
4061: $blocks = $record->{'blocks'};
4062: } else {
4063: my @data = split(/:/,$record,3);
4064: if (scalar(@data) eq 2) {
4065: $title = $data[1];
4066: ($setuname,$setudom) = split(/@/,$data[0]);
4067: } else {
4068: ($setuname,$setudom,$title) = @data;
4069: }
4070: $blocks = { 'com' => 'on' };
4071: }
4072: return ($setuname,$setudom,$title,$blocks);
4073: }
4074:
1.854 kalberla 4075: sub blocking_status {
4076: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4077: my %setters;
1.890 droeschl 4078:
4079: # check for active blocking
1.867 kalberla 4080: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4081:
1.890 droeschl 4082: my $blocked = $startblock && $endblock ? 1 : 0;
4083:
4084: # caller just wants to know whether a block is active
4085: if (!wantarray) { return $blocked; }
4086:
4087: # build a link to a popup window containing the details
4088: my $querystring = "?activity=$activity";
4089: # $uname and $udom decide whose portfolio the user is trying to look at
4090: $querystring .= "&udom=$udom" if $udom;
4091: $querystring .= "&uname=$uname" if $uname;
4092:
4093: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4094: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4095: var options = "width=" + w + ",height=" + h + ",";
4096: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4097: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4098: var newWin = window.open(url, wdwName, options);
4099: newWin.focus();
4100: }
1.890 droeschl 4101: END_MYBLOCK
1.854 kalberla 4102:
1.890 droeschl 4103: $output = Apache::lonhtmlcommon::scripttag($output);
4104:
1.854 kalberla 4105: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4106: my $text = mt('Communication Blocked');
4107:
1.867 kalberla 4108: $output .= <<"END_BLOCK";
4109: <div class='LC_comblock'>
1.869 kalberla 4110: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4111: title='$text'>
4112: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4113: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4114: title='$text'>$text</a>
1.867 kalberla 4115: </div>
4116:
4117: END_BLOCK
1.474 raeburn 4118:
1.854 kalberla 4119: return ($blocked, $output);
4120: }
1.490 raeburn 4121:
1.60 matthew 4122: ###############################################
4123:
1.682 raeburn 4124: sub check_ip_acc {
4125: my ($acc)=@_;
4126: &Apache::lonxml::debug("acc is $acc");
4127: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4128: return 1;
4129: }
4130: my $allowed=0;
4131: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4132:
4133: my $name;
4134: foreach my $pattern (split(',',$acc)) {
4135: $pattern =~ s/^\s*//;
4136: $pattern =~ s/\s*$//;
4137: if ($pattern =~ /\*$/) {
4138: #35.8.*
4139: $pattern=~s/\*//;
4140: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4141: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4142: #35.8.3.[34-56]
4143: my $low=$2;
4144: my $high=$3;
4145: $pattern=$1;
4146: if ($ip =~ /^\Q$pattern\E/) {
4147: my $last=(split(/\./,$ip))[3];
4148: if ($last <=$high && $last >=$low) { $allowed=1; }
4149: }
4150: } elsif ($pattern =~ /^\*/) {
4151: #*.msu.edu
4152: $pattern=~s/\*//;
4153: if (!defined($name)) {
4154: use Socket;
4155: my $netaddr=inet_aton($ip);
4156: ($name)=gethostbyaddr($netaddr,AF_INET);
4157: }
4158: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4159: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4160: #127.0.0.1
4161: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4162: } else {
4163: #some.name.com
4164: if (!defined($name)) {
4165: use Socket;
4166: my $netaddr=inet_aton($ip);
4167: ($name)=gethostbyaddr($netaddr,AF_INET);
4168: }
4169: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4170: }
4171: if ($allowed) { last; }
4172: }
4173: return $allowed;
4174: }
4175:
4176: ###############################################
4177:
1.60 matthew 4178: =pod
4179:
1.112 bowersj2 4180: =head1 Domain Template Functions
4181:
4182: =over 4
4183:
4184: =item * &determinedomain()
1.60 matthew 4185:
4186: Inputs: $domain (usually will be undef)
4187:
1.63 www 4188: Returns: Determines which domain should be used for designs
1.60 matthew 4189:
4190: =cut
1.54 www 4191:
1.60 matthew 4192: ###############################################
1.63 www 4193: sub determinedomain {
4194: my $domain=shift;
1.531 albertel 4195: if (! $domain) {
1.60 matthew 4196: # Determine domain if we have not been given one
1.893 raeburn 4197: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4198: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4199: if ($env{'request.role.domain'}) {
4200: $domain=$env{'request.role.domain'};
1.60 matthew 4201: }
4202: }
1.63 www 4203: return $domain;
4204: }
4205: ###############################################
1.517 raeburn 4206:
1.518 albertel 4207: sub devalidate_domconfig_cache {
4208: my ($udom)=@_;
4209: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4210: }
4211:
4212: # ---------------------- Get domain configuration for a domain
4213: sub get_domainconf {
4214: my ($udom) = @_;
4215: my $cachetime=1800;
4216: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4217: if (defined($cached)) { return %{$result}; }
4218:
4219: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4220: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4221: my (%designhash,%legacy);
1.518 albertel 4222: if (keys(%domconfig) > 0) {
4223: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4224: if (keys(%{$domconfig{'login'}})) {
4225: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4226: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4227: if ($key eq 'loginvia') {
4228: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4229: my @ids = &Apache::lonnet::current_machine_ids();
4230: foreach my $hostname (@ids) {
1.948 raeburn 4231: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4232: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4233: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4234: $designhash{$udom.'.login.loginvia'} = $server;
4235: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4236:
4237: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4238: } else {
4239: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4240: }
4241: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4242: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4243: }
1.946 raeburn 4244: }
4245: }
4246: }
4247: }
4248: } else {
4249: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4250: $designhash{$udom.'.login.'.$key.'_'.$img} =
4251: $domconfig{'login'}{$key}{$img};
4252: }
1.699 raeburn 4253: }
4254: } else {
4255: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4256: }
1.632 raeburn 4257: }
4258: } else {
4259: $legacy{'login'} = 1;
1.518 albertel 4260: }
1.632 raeburn 4261: } else {
4262: $legacy{'login'} = 1;
1.518 albertel 4263: }
4264: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4265: if (keys(%{$domconfig{'rolecolors'}})) {
4266: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4267: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4268: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4269: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4270: }
1.518 albertel 4271: }
4272: }
1.632 raeburn 4273: } else {
4274: $legacy{'rolecolors'} = 1;
1.518 albertel 4275: }
1.632 raeburn 4276: } else {
4277: $legacy{'rolecolors'} = 1;
1.518 albertel 4278: }
1.948 raeburn 4279: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4280: if ($domconfig{'autoenroll'}{'co-owners'}) {
4281: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4282: }
4283: }
1.632 raeburn 4284: if (keys(%legacy) > 0) {
4285: my %legacyhash = &get_legacy_domconf($udom);
4286: foreach my $item (keys(%legacyhash)) {
4287: if ($item =~ /^\Q$udom\E\.login/) {
4288: if ($legacy{'login'}) {
4289: $designhash{$item} = $legacyhash{$item};
4290: }
4291: } else {
4292: if ($legacy{'rolecolors'}) {
4293: $designhash{$item} = $legacyhash{$item};
4294: }
1.518 albertel 4295: }
4296: }
4297: }
1.632 raeburn 4298: } else {
4299: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4300: }
4301: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4302: $cachetime);
4303: return %designhash;
4304: }
4305:
1.632 raeburn 4306: sub get_legacy_domconf {
4307: my ($udom) = @_;
4308: my %legacyhash;
4309: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4310: my $designfile = $designdir.'/'.$udom.'.tab';
4311: if (-e $designfile) {
4312: if ( open (my $fh,"<$designfile") ) {
4313: while (my $line = <$fh>) {
4314: next if ($line =~ /^\#/);
4315: chomp($line);
4316: my ($key,$val)=(split(/\=/,$line));
4317: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4318: }
4319: close($fh);
4320: }
4321: }
4322: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4323: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4324: }
4325: return %legacyhash;
4326: }
4327:
1.63 www 4328: =pod
4329:
1.112 bowersj2 4330: =item * &domainlogo()
1.63 www 4331:
4332: Inputs: $domain (usually will be undef)
4333:
4334: Returns: A link to a domain logo, if the domain logo exists.
4335: If the domain logo does not exist, a description of the domain.
4336:
4337: =cut
1.112 bowersj2 4338:
1.63 www 4339: ###############################################
4340: sub domainlogo {
1.517 raeburn 4341: my $domain = &determinedomain(shift);
1.518 albertel 4342: my %designhash = &get_domainconf($domain);
1.517 raeburn 4343: # See if there is a logo
4344: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4345: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4346: if ($imgsrc =~ m{^/(adm|res)/}) {
4347: if ($imgsrc =~ m{^/res/}) {
4348: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4349: &Apache::lonnet::repcopy($local_name);
4350: }
4351: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4352: }
4353: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4354: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4355: return &Apache::lonnet::domain($domain,'description');
1.59 www 4356: } else {
1.60 matthew 4357: return '';
1.59 www 4358: }
4359: }
1.63 www 4360: ##############################################
4361:
4362: =pod
4363:
1.112 bowersj2 4364: =item * &designparm()
1.63 www 4365:
4366: Inputs: $which parameter; $domain (usually will be undef)
4367:
4368: Returns: value of designparamter $which
4369:
4370: =cut
1.112 bowersj2 4371:
1.397 albertel 4372:
1.400 albertel 4373: ##############################################
1.397 albertel 4374: sub designparm {
4375: my ($which,$domain)=@_;
4376: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4377: return $env{'environment.color.'.$which};
1.96 www 4378: }
1.63 www 4379: $domain=&determinedomain($domain);
1.518 albertel 4380: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4381: my $output;
1.517 raeburn 4382: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4383: $output = $domdesign{$domain.'.'.$which};
1.63 www 4384: } else {
1.520 raeburn 4385: $output = $defaultdesign{$which};
4386: }
4387: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4388: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4389: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4390: if ($output =~ m{^/res/}) {
4391: my $local_name = &Apache::lonnet::filelocation('',$output);
4392: &Apache::lonnet::repcopy($local_name);
4393: }
1.520 raeburn 4394: $output = &lonhttpdurl($output);
4395: }
1.63 www 4396: }
1.520 raeburn 4397: return $output;
1.63 www 4398: }
1.59 www 4399:
1.822 bisitz 4400: ##############################################
4401: =pod
4402:
1.832 bisitz 4403: =item * &authorspace()
4404:
4405: Inputs: ./.
4406:
4407: Returns: Path to the Construction Space of the current user's
4408: accessed author space
4409: The author space will be that of the current user
4410: when accessing the own author space
4411: and that of the co-author/assistent co-author
4412: when accessing the co-author's/assistent co-author's
4413: space
4414:
4415: =cut
4416:
4417: sub authorspace {
4418: my $caname = '';
4419: if ($env{'request.role'} =~ /^ca|^aa/) {
4420: (undef,$caname) =
4421: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4422: } else {
4423: $caname = $env{'user.name'};
4424: }
4425: return '/priv/'.$caname.'/';
4426: }
4427:
4428: ##############################################
4429: =pod
4430:
1.822 bisitz 4431: =item * &head_subbox()
4432:
4433: Inputs: $content (contains HTML code with page functions, etc.)
4434:
4435: Returns: HTML div with $content
4436: To be included in page header
4437:
4438: =cut
4439:
4440: sub head_subbox {
4441: my ($content)=@_;
4442: my $output =
1.844 bisitz 4443: '<div id="LC_head_subbox">'
1.822 bisitz 4444: .$content
4445: .'</div>'
4446: }
4447:
4448: ##############################################
4449: =pod
4450:
4451: =item * &CSTR_pageheader()
4452:
4453: Inputs: ./.
4454:
4455: Returns: HTML div with CSTR path and recent box
4456: To be included on Construction Space pages
4457:
4458: =cut
4459:
4460: sub CSTR_pageheader {
4461: # this is for resources; directories have customtitle, and crumbs
4462: # and select recent are created in lonpubdir.pm
4463: my ($uname,$thisdisfn)=
4464: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4465: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4466: $formaction=~s/\/+/\//g;
4467:
4468: my $parentpath = '';
4469: my $lastitem = '';
4470: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4471: $parentpath = $1;
4472: $lastitem = $2;
4473: } else {
4474: $lastitem = $thisdisfn;
4475: }
1.921 bisitz 4476:
4477: my $output =
1.822 bisitz 4478: '<div>'
4479: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4480: .'<b>'.&mt('Construction Space:').'</b> '
4481: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4482: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4483: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4484:
4485: if ($lastitem) {
4486: $output .=
4487: '<span class="LC_filename">'
4488: .$lastitem
4489: .'</span>';
4490: }
4491: $output .=
4492: '<br />'
1.822 bisitz 4493: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4494: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4495: .'</form>'
4496: .&Apache::lonmenu::constspaceform()
4497: .'</div>';
1.921 bisitz 4498:
4499: return $output;
1.822 bisitz 4500: }
4501:
1.60 matthew 4502: ###############################################
4503: ###############################################
4504:
4505: =pod
4506:
1.112 bowersj2 4507: =back
4508:
1.549 albertel 4509: =head1 HTML Helpers
1.112 bowersj2 4510:
4511: =over 4
4512:
4513: =item * &bodytag()
1.60 matthew 4514:
4515: Returns a uniform header for LON-CAPA web pages.
4516:
4517: Inputs:
4518:
1.112 bowersj2 4519: =over 4
4520:
4521: =item * $title, A title to be displayed on the page.
4522:
4523: =item * $function, the current role (can be undef).
4524:
4525: =item * $addentries, extra parameters for the <body> tag.
4526:
4527: =item * $bodyonly, if defined, only return the <body> tag.
4528:
4529: =item * $domain, if defined, force a given domain.
4530:
4531: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4532: text interface only)
1.60 matthew 4533:
1.814 bisitz 4534: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4535: navigational links
1.317 albertel 4536:
1.338 albertel 4537: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4538:
1.949 droeschl 4539: #RC =item * $no_inline_link, if true and in remote mode, don't show the
4540: #RC 'Switch To Inline Menu' link
4541: #RC
1.460 albertel 4542: =item * $args, optional argument valid values are
4543: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4544: inherit_jsmath -> when creating popup window in a page,
4545: should it have jsmath forced on by the
4546: current page
1.460 albertel 4547:
1.112 bowersj2 4548: =back
4549:
1.60 matthew 4550: Returns: A uniform header for LON-CAPA web pages.
4551: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4552: If $bodyonly is undef or zero, an html string containing a <body> tag and
4553: other decorations will be returned.
4554:
4555: =cut
4556:
1.54 www 4557: sub bodytag {
1.831 bisitz 4558: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4559: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4560:
1.460 albertel 4561: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4562:
1.183 matthew 4563: $function = &get_users_function() if (!$function);
1.339 albertel 4564: my $img = &designparm($function.'.img',$domain);
4565: my $font = &designparm($function.'.font',$domain);
4566: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4567:
1.803 bisitz 4568: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4569: 'bgcolor' => $pgbg,
1.339 albertel 4570: 'text' => $font,
4571: 'alink' => &designparm($function.'.alink',$domain),
4572: 'vlink' => &designparm($function.'.vlink',$domain),
4573: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4574: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4575:
1.63 www 4576: # role and realm
1.378 raeburn 4577: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4578: if ($role eq 'ca') {
1.479 albertel 4579: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4580: $realm = &plainname($rname,$rdom);
1.378 raeburn 4581: }
1.55 www 4582: # realm
1.258 albertel 4583: if ($env{'request.course.id'}) {
1.378 raeburn 4584: if ($env{'request.role'} !~ /^cr/) {
4585: $role = &Apache::lonnet::plaintext($role,&course_type());
4586: }
1.898 raeburn 4587: if ($env{'request.course.sec'}) {
4588: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4589: }
1.359 albertel 4590: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4591: } else {
4592: $role = &Apache::lonnet::plaintext($role);
1.54 www 4593: }
1.433 albertel 4594:
1.359 albertel 4595: if (!$realm) { $realm=' '; }
1.55 www 4596: # Set messages
1.60 matthew 4597: my $messages=&domainlogo($domain);
1.330 albertel 4598:
1.438 albertel 4599: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4600:
1.101 www 4601: # construct main body tag
1.359 albertel 4602: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4603: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4604:
1.530 albertel 4605: if ($bodyonly) {
1.60 matthew 4606: return $bodytag;
1.798 tempelho 4607: }
1.359 albertel 4608:
1.410 albertel 4609: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4610: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4611: undef($role);
1.434 albertel 4612: } else {
4613: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4614: }
1.359 albertel 4615:
1.762 bisitz 4616: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4617: #
4618: # Extra info if you are the DC
4619: my $dc_info = '';
4620: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4621: $env{'course.'.$env{'request.course.id'}.
4622: '.domain'}.'/'})) {
4623: my $cid = $env{'request.course.id'};
1.917 raeburn 4624: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4625: $dc_info =~ s/\s+$//;
1.359 albertel 4626: }
4627:
1.898 raeburn 4628: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4629: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4630:
1.359 albertel 4631: # No Remote
1.916 droeschl 4632: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4633: return $bodytag;
4634: }
1.903 droeschl 4635:
4636: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4637:
4638: # if ($env{'request.state'} eq 'construct') {
4639: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4640: # }
4641:
1.359 albertel 4642:
4643:
1.916 droeschl 4644: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4645: if ($dc_info) {
4646: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4647: }
1.916 droeschl 4648: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4649: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4650: return $bodytag;
4651: }
1.894 droeschl 4652:
1.927 raeburn 4653: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4654: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4655: }
1.916 droeschl 4656:
1.903 droeschl 4657: $bodytag .= Apache::lonhtmlcommon::scripttag(
4658: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4659:
1.903 droeschl 4660: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4661:
1.917 raeburn 4662: if ($dc_info) {
4663: $dc_info = &dc_courseid_toggle($dc_info);
4664: }
4665: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4666:
1.903 droeschl 4667: #don't show menus for public users
4668: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4669: $bodytag .= Apache::lonmenu::secondary_menu();
4670: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4671: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4672: if ($env{'request.state'} eq 'construct') {
4673: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4674: $args->{'bread_crumbs'});
4675: } elsif ($forcereg) {
4676: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4677: }
1.903 droeschl 4678: }else{
4679: # this is to seperate menu from content when there's no secondary
4680: # menu. Especially needed for public accessible ressources.
4681: $bodytag .= '<hr style="clear:both" />';
4682: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4683: }
1.903 droeschl 4684:
1.235 raeburn 4685: return $bodytag;
1.182 matthew 4686: }
4687:
1.917 raeburn 4688: sub dc_courseid_toggle {
4689: my ($dc_info) = @_;
4690: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4691: '<a href="javascript:showCourseID();">'.
4692: &mt('(More ...)').'</a></span>'.
4693: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4694: }
4695:
1.330 albertel 4696: sub make_attr_string {
4697: my ($register,$attr_ref) = @_;
4698:
4699: if ($attr_ref && !ref($attr_ref)) {
4700: die("addentries Must be a hash ref ".
4701: join(':',caller(1))." ".
4702: join(':',caller(0))." ");
4703: }
4704:
4705: if ($register) {
1.339 albertel 4706: my ($on_load,$on_unload);
4707: foreach my $key (keys(%{$attr_ref})) {
4708: if (lc($key) eq 'onload') {
4709: $on_load.=$attr_ref->{$key}.';';
4710: delete($attr_ref->{$key});
4711:
4712: } elsif (lc($key) eq 'onunload') {
4713: $on_unload.=$attr_ref->{$key}.';';
4714: delete($attr_ref->{$key});
4715: }
4716: }
4717: $attr_ref->{'onload'} =
4718: &Apache::lonmenu::loadevents(). $on_load;
4719: $attr_ref->{'onunload'}=
4720: &Apache::lonmenu::unloadevents().$on_unload;
4721: }
4722:
4723: # Accessibility font enhance
4724: if ($env{'browser.fontenhance'} eq 'on') {
4725: my $style;
4726: foreach my $key (keys(%{$attr_ref})) {
4727: if (lc($key) eq 'style') {
4728: $style.=$attr_ref->{$key}.';';
4729: delete($attr_ref->{$key});
4730: }
4731: }
4732: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4733: }
1.339 albertel 4734:
1.330 albertel 4735: my $attr_string;
4736: foreach my $attr (keys(%$attr_ref)) {
4737: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4738: }
4739: return $attr_string;
4740: }
4741:
4742:
1.182 matthew 4743: ###############################################
1.251 albertel 4744: ###############################################
4745:
4746: =pod
4747:
4748: =item * &endbodytag()
4749:
4750: Returns a uniform footer for LON-CAPA web pages.
4751:
1.635 raeburn 4752: Inputs: 1 - optional reference to an args hash
4753: If in the hash, key for noredirectlink has a value which evaluates to true,
4754: a 'Continue' link is not displayed if the page contains an
4755: internal redirect in the <head></head> section,
4756: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4757:
4758: =cut
4759:
4760: sub endbodytag {
1.635 raeburn 4761: my ($args) = @_;
1.251 albertel 4762: my $endbodytag='</body>';
1.269 albertel 4763: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4764: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4765: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4766: $endbodytag=
4767: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4768: &mt('Continue').'</a>'.
4769: $endbodytag;
4770: }
1.315 albertel 4771: }
1.251 albertel 4772: return $endbodytag;
4773: }
4774:
1.352 albertel 4775: =pod
4776:
4777: =item * &standard_css()
4778:
4779: Returns a style sheet
4780:
4781: Inputs: (all optional)
4782: domain -> force to color decorate a page for a specific
4783: domain
4784: function -> force usage of a specific rolish color scheme
4785: bgcolor -> override the default page bgcolor
4786:
4787: =cut
4788:
1.343 albertel 4789: sub standard_css {
1.345 albertel 4790: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4791: $function = &get_users_function() if (!$function);
4792: my $img = &designparm($function.'.img', $domain);
4793: my $tabbg = &designparm($function.'.tabbg', $domain);
4794: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4795: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4796: #second colour for later usage
1.345 albertel 4797: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4798: my $pgbg_or_bgcolor =
4799: $bgcolor ||
1.352 albertel 4800: &designparm($function.'.pgbg', $domain);
1.382 albertel 4801: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4802: my $alink = &designparm($function.'.alink', $domain);
4803: my $vlink = &designparm($function.'.vlink', $domain);
4804: my $link = &designparm($function.'.link', $domain);
4805:
1.704 muellerd 4806: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4807: my $bgcol = &designparm('login.bgcol',$domain);
4808: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4809:
1.602 albertel 4810: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4811: my $mono = 'monospace';
1.850 bisitz 4812: my $data_table_head = $sidebg;
4813: my $data_table_light = '#FAFAFA';
4814: my $data_table_dark = '#F0F0F0';
1.470 banghart 4815: my $data_table_darker = '#CCCCCC';
1.349 albertel 4816: my $data_table_highlight = '#FFFF00';
1.352 albertel 4817: my $mail_new = '#FFBB77';
4818: my $mail_new_hover = '#DD9955';
4819: my $mail_read = '#BBBB77';
4820: my $mail_read_hover = '#999944';
4821: my $mail_replied = '#AAAA88';
4822: my $mail_replied_hover = '#888855';
4823: my $mail_other = '#99BBBB';
4824: my $mail_other_hover = '#669999';
1.391 albertel 4825: my $table_header = '#DDDDDD';
1.489 raeburn 4826: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4827: my $lg_border_color = '#C8C8C8';
1.392 albertel 4828:
1.608 albertel 4829: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4830: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4831: : '0 3px 0 4px';
1.448 albertel 4832:
1.523 albertel 4833:
1.343 albertel 4834: return <<END;
1.947 droeschl 4835:
4836: /* needed for iframe to allow 100% height in FF */
4837: body, html {
4838: margin: 0;
4839: padding: 0 0.5%;
4840: height: 99%; /* to avoid scrollbars */
4841: }
4842:
1.795 www 4843: body {
1.911 bisitz 4844: font-family: $sans;
4845: line-height:130%;
4846: font-size:0.83em;
4847: color:$font;
1.795 www 4848: }
4849:
1.911 bisitz 4850: a:focus {
1.795 www 4851: color: red;
1.911 bisitz 4852: background: yellow;
1.795 www 4853: }
1.698 harmsja 4854:
1.911 bisitz 4855: form, .inline {
4856: display: inline;
1.795 www 4857: }
1.721 harmsja 4858:
1.795 www 4859: .LC_right {
1.911 bisitz 4860: text-align:right;
1.795 www 4861: }
4862:
4863: .LC_middle {
1.911 bisitz 4864: vertical-align:middle;
1.795 www 4865: }
1.721 harmsja 4866:
1.911 bisitz 4867: .LC_400Box {
4868: width:400px;
4869: }
1.721 harmsja 4870:
1.947 droeschl 4871: .LC_iframecontainer {
4872: width: 98%;
4873: margin: 0;
4874: position: fixed;
4875: top: 8.5em;
4876: bottom: 0;
4877: }
4878:
4879: .LC_iframecontainer iframe{
4880: border: none;
4881: width: 100%;
4882: height: 100%;
4883: }
4884:
1.778 bisitz 4885: .LC_filename {
4886: font-family: $mono;
4887: white-space:pre;
1.921 bisitz 4888: font-size: 120%;
1.778 bisitz 4889: }
4890:
4891: .LC_fileicon {
4892: border: none;
4893: height: 1.3em;
4894: vertical-align: text-bottom;
4895: margin-right: 0.3em;
4896: text-decoration:none;
4897: }
4898:
1.350 albertel 4899: .LC_error {
4900: color: red;
4901: font-size: larger;
4902: }
1.795 www 4903:
1.457 albertel 4904: .LC_warning,
4905: .LC_diff_removed {
1.733 bisitz 4906: color: red;
1.394 albertel 4907: }
1.532 albertel 4908:
4909: .LC_info,
1.457 albertel 4910: .LC_success,
4911: .LC_diff_added {
1.350 albertel 4912: color: green;
4913: }
1.795 www 4914:
1.802 bisitz 4915: div.LC_confirm_box {
4916: background-color: #FAFAFA;
4917: border: 1px solid $lg_border_color;
4918: margin-right: 0;
4919: padding: 5px;
4920: }
4921:
4922: div.LC_confirm_box .LC_error img,
4923: div.LC_confirm_box .LC_success img {
4924: vertical-align: middle;
4925: }
4926:
1.440 albertel 4927: .LC_icon {
1.771 droeschl 4928: border: none;
1.790 droeschl 4929: vertical-align: middle;
1.771 droeschl 4930: }
4931:
1.543 albertel 4932: .LC_docs_spacer {
4933: width: 25px;
4934: height: 1px;
1.771 droeschl 4935: border: none;
1.543 albertel 4936: }
1.346 albertel 4937:
1.532 albertel 4938: .LC_internal_info {
1.735 bisitz 4939: color: #999999;
1.532 albertel 4940: }
4941:
1.794 www 4942: .LC_discussion {
1.911 bisitz 4943: background: $tabbg;
4944: border: 1px solid black;
4945: margin: 2px;
1.794 www 4946: }
4947:
4948: .LC_disc_action_links_bar {
1.911 bisitz 4949: background: $tabbg;
4950: border: none;
4951: margin: 4px;
1.794 www 4952: }
4953:
4954: .LC_disc_action_left {
1.911 bisitz 4955: text-align: left;
1.794 www 4956: }
4957:
4958: .LC_disc_action_right {
1.911 bisitz 4959: text-align: right;
1.794 www 4960: }
4961:
4962: .LC_disc_new_item {
1.911 bisitz 4963: background: white;
4964: border: 2px solid red;
4965: margin: 2px;
1.794 www 4966: }
4967:
4968: .LC_disc_old_item {
1.911 bisitz 4969: background: white;
4970: border: 1px solid black;
4971: margin: 2px;
1.794 www 4972: }
4973:
1.458 albertel 4974: table.LC_pastsubmission {
4975: border: 1px solid black;
4976: margin: 2px;
4977: }
4978:
1.924 bisitz 4979: table#LC_menubuttons {
1.345 albertel 4980: width: 100%;
4981: background: $pgbg;
1.392 albertel 4982: border: 2px;
1.402 albertel 4983: border-collapse: separate;
1.803 bisitz 4984: padding: 0;
1.345 albertel 4985: }
1.392 albertel 4986:
1.801 tempelho 4987: table#LC_title_bar a {
4988: color: $fontmenu;
4989: }
1.836 bisitz 4990:
1.807 droeschl 4991: table#LC_title_bar {
1.819 tempelho 4992: clear: both;
1.836 bisitz 4993: display: none;
1.807 droeschl 4994: }
4995:
1.795 www 4996: table#LC_title_bar,
1.933 droeschl 4997: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4998: table#LC_title_bar.LC_with_remote {
1.359 albertel 4999: width: 100%;
1.392 albertel 5000: border-color: $pgbg;
5001: border-style: solid;
5002: border-width: $border;
1.379 albertel 5003: background: $pgbg;
1.801 tempelho 5004: color: $fontmenu;
1.392 albertel 5005: border-collapse: collapse;
1.803 bisitz 5006: padding: 0;
1.819 tempelho 5007: margin: 0;
1.359 albertel 5008: }
1.795 www 5009:
1.933 droeschl 5010: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5011: margin: 0;
5012: padding: 0;
1.933 droeschl 5013: position: relative;
5014: list-style: none;
1.913 droeschl 5015: }
1.933 droeschl 5016: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5017: display: inline;
5018: }
1.933 droeschl 5019:
5020: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5021: padding: 0;
1.933 droeschl 5022: margin: 0;
5023: float: left;
1.913 droeschl 5024: }
1.933 droeschl 5025: .LC_breadcrumb_tools_tools {
5026: padding: 0;
5027: margin: 0;
1.913 droeschl 5028: float: right;
5029: }
5030:
1.359 albertel 5031: table#LC_title_bar td {
5032: background: $tabbg;
5033: }
1.795 www 5034:
1.911 bisitz 5035: table#LC_menubuttons img {
1.803 bisitz 5036: border: none;
1.346 albertel 5037: }
1.795 www 5038:
1.842 droeschl 5039: .LC_breadcrumbs_component {
1.911 bisitz 5040: float: right;
5041: margin: 0 1em;
1.357 albertel 5042: }
1.842 droeschl 5043: .LC_breadcrumbs_component img {
1.911 bisitz 5044: vertical-align: middle;
1.777 tempelho 5045: }
1.795 www 5046:
1.383 albertel 5047: td.LC_table_cell_checkbox {
5048: text-align: center;
5049: }
1.795 www 5050:
5051: .LC_fontsize_small {
1.911 bisitz 5052: font-size: 70%;
1.705 tempelho 5053: }
5054:
1.844 bisitz 5055: #LC_breadcrumbs {
1.911 bisitz 5056: clear:both;
5057: background: $sidebg;
5058: border-bottom: 1px solid $lg_border_color;
5059: line-height: 2.5em;
1.933 droeschl 5060: overflow: hidden;
1.911 bisitz 5061: margin: 0;
5062: padding: 0;
1.819 tempelho 5063: }
1.862 bisitz 5064:
1.844 bisitz 5065: #LC_head_subbox {
1.911 bisitz 5066: clear:both;
5067: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5068: border: 1px solid $sidebg;
5069: margin: 0 0 10px 0;
1.822 bisitz 5070: }
5071:
1.795 www 5072: .LC_fontsize_medium {
1.911 bisitz 5073: font-size: 85%;
1.705 tempelho 5074: }
5075:
1.795 www 5076: .LC_fontsize_large {
1.911 bisitz 5077: font-size: 120%;
1.705 tempelho 5078: }
5079:
1.346 albertel 5080: .LC_menubuttons_inline_text {
5081: color: $font;
1.698 harmsja 5082: font-size: 90%;
1.701 harmsja 5083: padding-left:3px;
1.346 albertel 5084: }
5085:
1.934 droeschl 5086: .LC_menubuttons_inline_text img{
5087: vertical-align: middle;
5088: }
5089:
1.951 ! onken 5090: li.LC_menubuttons_inline_text img,a {
! 5091: cursor:pointer;
! 5092: }
! 5093:
1.526 www 5094: .LC_menubuttons_link {
5095: text-decoration: none;
5096: }
1.795 www 5097:
1.522 albertel 5098: .LC_menubuttons_category {
1.521 www 5099: color: $font;
1.526 www 5100: background: $pgbg;
1.521 www 5101: font-size: larger;
5102: font-weight: bold;
5103: }
5104:
1.346 albertel 5105: td.LC_menubuttons_text {
1.911 bisitz 5106: color: $font;
1.346 albertel 5107: }
1.706 harmsja 5108:
1.346 albertel 5109: .LC_current_location {
5110: background: $tabbg;
5111: }
1.795 www 5112:
1.938 bisitz 5113: table.LC_data_table {
1.347 albertel 5114: border: 1px solid #000000;
1.402 albertel 5115: border-collapse: separate;
1.426 albertel 5116: border-spacing: 1px;
1.610 albertel 5117: background: $pgbg;
1.347 albertel 5118: }
1.795 www 5119:
1.422 albertel 5120: .LC_data_table_dense {
5121: font-size: small;
5122: }
1.795 www 5123:
1.507 raeburn 5124: table.LC_nested_outer {
5125: border: 1px solid #000000;
1.589 raeburn 5126: border-collapse: collapse;
1.803 bisitz 5127: border-spacing: 0;
1.507 raeburn 5128: width: 100%;
5129: }
1.795 www 5130:
1.879 raeburn 5131: table.LC_innerpickbox,
1.507 raeburn 5132: table.LC_nested {
1.803 bisitz 5133: border: none;
1.589 raeburn 5134: border-collapse: collapse;
1.803 bisitz 5135: border-spacing: 0;
1.507 raeburn 5136: width: 100%;
5137: }
1.795 www 5138:
1.930 faziophi 5139: .ui-accordion,
5140: .ui-accordion table.LC_data_table,
5141: .ui-accordion table.LC_nested_outer{
5142: border: 0px;
5143: border-spacing: 0px;
5144: margin: 3px;
5145: }
5146:
1.911 bisitz 5147: table.LC_data_table tr th,
5148: table.LC_calendar tr th,
1.879 raeburn 5149: table.LC_prior_tries tr th,
5150: table.LC_innerpickbox tr th {
1.349 albertel 5151: font-weight: bold;
5152: background-color: $data_table_head;
1.801 tempelho 5153: color:$fontmenu;
1.701 harmsja 5154: font-size:90%;
1.347 albertel 5155: }
1.795 www 5156:
1.879 raeburn 5157: table.LC_innerpickbox tr th,
5158: table.LC_innerpickbox tr td {
5159: vertical-align: top;
5160: }
5161:
1.711 raeburn 5162: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5163: background-color: #CCCCCC;
1.711 raeburn 5164: font-weight: bold;
5165: text-align: left;
5166: }
1.795 www 5167:
1.912 bisitz 5168: table.LC_data_table tr.LC_odd_row > td {
5169: background-color: $data_table_light;
5170: padding: 2px;
5171: vertical-align: top;
5172: }
5173:
1.809 bisitz 5174: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5175: background-color: $data_table_light;
1.912 bisitz 5176: vertical-align: top;
5177: }
5178:
5179: table.LC_data_table tr.LC_even_row > td {
5180: background-color: $data_table_dark;
1.425 albertel 5181: padding: 2px;
1.900 bisitz 5182: vertical-align: top;
1.347 albertel 5183: }
1.795 www 5184:
1.809 bisitz 5185: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5186: background-color: $data_table_dark;
1.900 bisitz 5187: vertical-align: top;
1.347 albertel 5188: }
1.795 www 5189:
1.425 albertel 5190: table.LC_data_table tr.LC_data_table_highlight td {
5191: background-color: $data_table_darker;
5192: }
1.795 www 5193:
1.639 raeburn 5194: table.LC_data_table tr td.LC_leftcol_header {
5195: background-color: $data_table_head;
5196: font-weight: bold;
5197: }
1.795 www 5198:
1.451 albertel 5199: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5200: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5201: font-weight: bold;
5202: font-style: italic;
5203: text-align: center;
5204: padding: 8px;
1.347 albertel 5205: }
1.795 www 5206:
1.940 bisitz 5207: table.LC_data_table tr.LC_empty_row td {
5208: background-color: $sidebg;
5209: }
5210:
5211: table.LC_nested tr.LC_empty_row td {
5212: background-color: #FFFFFF;
5213: }
5214:
1.890 droeschl 5215: table.LC_caption {
5216: }
5217:
1.507 raeburn 5218: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5219: padding: 4ex
5220: }
1.795 www 5221:
1.507 raeburn 5222: table.LC_nested_outer tr th {
5223: font-weight: bold;
1.801 tempelho 5224: color:$fontmenu;
1.507 raeburn 5225: background-color: $data_table_head;
1.701 harmsja 5226: font-size: small;
1.507 raeburn 5227: border-bottom: 1px solid #000000;
5228: }
1.795 www 5229:
1.507 raeburn 5230: table.LC_nested_outer tr td.LC_subheader {
5231: background-color: $data_table_head;
5232: font-weight: bold;
5233: font-size: small;
5234: border-bottom: 1px solid #000000;
5235: text-align: right;
1.451 albertel 5236: }
1.795 www 5237:
1.507 raeburn 5238: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5239: background-color: #CCCCCC;
1.451 albertel 5240: font-weight: bold;
5241: font-size: small;
1.507 raeburn 5242: text-align: center;
5243: }
1.795 www 5244:
1.589 raeburn 5245: table.LC_nested tr.LC_info_row td.LC_left_item,
5246: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5247: text-align: left;
1.451 albertel 5248: }
1.795 www 5249:
1.507 raeburn 5250: table.LC_nested td {
1.735 bisitz 5251: background-color: #FFFFFF;
1.451 albertel 5252: font-size: small;
1.507 raeburn 5253: }
1.795 www 5254:
1.507 raeburn 5255: table.LC_nested_outer tr th.LC_right_item,
5256: table.LC_nested tr.LC_info_row td.LC_right_item,
5257: table.LC_nested tr.LC_odd_row td.LC_right_item,
5258: table.LC_nested tr td.LC_right_item {
1.451 albertel 5259: text-align: right;
5260: }
5261:
1.930 faziophi 5262: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5263: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5264: text-align: right;
5265: width: 40%;
5266: padding-right:10px;
5267: vertical-align: top;
5268: padding: 5px;
5269: }
5270:
5271: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5272: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5273: text-align: left;
5274: width: 60%;
5275: padding: 2px 4px;
5276: }
5277:
1.507 raeburn 5278: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5279: background-color: #EEEEEE;
1.451 albertel 5280: }
5281:
1.473 raeburn 5282: table.LC_createuser {
5283: }
5284:
5285: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5286: font-size: small;
1.473 raeburn 5287: }
5288:
5289: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5290: background-color: #CCCCCC;
1.473 raeburn 5291: font-weight: bold;
5292: text-align: center;
5293: }
5294:
1.349 albertel 5295: table.LC_calendar {
5296: border: 1px solid #000000;
5297: border-collapse: collapse;
1.917 raeburn 5298: width: 98%;
1.349 albertel 5299: }
1.795 www 5300:
1.349 albertel 5301: table.LC_calendar_pickdate {
5302: font-size: xx-small;
5303: }
1.795 www 5304:
1.349 albertel 5305: table.LC_calendar tr td {
5306: border: 1px solid #000000;
5307: vertical-align: top;
1.917 raeburn 5308: width: 14%;
1.349 albertel 5309: }
1.795 www 5310:
1.349 albertel 5311: table.LC_calendar tr td.LC_calendar_day_empty {
5312: background-color: $data_table_dark;
5313: }
1.795 www 5314:
1.779 bisitz 5315: table.LC_calendar tr td.LC_calendar_day_current {
5316: background-color: $data_table_highlight;
1.777 tempelho 5317: }
1.795 www 5318:
1.938 bisitz 5319: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5320: background-color: $mail_new;
5321: }
1.795 www 5322:
1.938 bisitz 5323: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5324: background-color: $mail_new_hover;
5325: }
1.795 www 5326:
1.938 bisitz 5327: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5328: background-color: $mail_read;
5329: }
1.795 www 5330:
1.938 bisitz 5331: /*
5332: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5333: background-color: $mail_read_hover;
5334: }
1.938 bisitz 5335: */
1.795 www 5336:
1.938 bisitz 5337: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5338: background-color: $mail_replied;
5339: }
1.795 www 5340:
1.938 bisitz 5341: /*
5342: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5343: background-color: $mail_replied_hover;
5344: }
1.938 bisitz 5345: */
1.795 www 5346:
1.938 bisitz 5347: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5348: background-color: $mail_other;
5349: }
1.795 www 5350:
1.938 bisitz 5351: /*
5352: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5353: background-color: $mail_other_hover;
5354: }
1.938 bisitz 5355: */
1.494 raeburn 5356:
1.777 tempelho 5357: table.LC_data_table tr > td.LC_browser_file,
5358: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5359: background: #AAEE77;
1.389 albertel 5360: }
1.795 www 5361:
1.777 tempelho 5362: table.LC_data_table tr > td.LC_browser_file_locked,
5363: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5364: background: #FFAA99;
1.387 albertel 5365: }
1.795 www 5366:
1.777 tempelho 5367: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5368: background: #888888;
1.779 bisitz 5369: }
1.795 www 5370:
1.777 tempelho 5371: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5372: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5373: background: #F8F866;
1.777 tempelho 5374: }
1.795 www 5375:
1.696 bisitz 5376: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5377: background: #E0E8FF;
1.387 albertel 5378: }
1.696 bisitz 5379:
1.707 bisitz 5380: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5381: /* background: #77FF77; */
1.707 bisitz 5382: }
1.795 www 5383:
1.707 bisitz 5384: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5385: border-right: 8px solid #FFFF77;
1.707 bisitz 5386: }
1.795 www 5387:
1.707 bisitz 5388: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5389: border-right: 8px solid #FFAA77;
1.707 bisitz 5390: }
1.795 www 5391:
1.707 bisitz 5392: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5393: border-right: 8px solid #FF7777;
1.707 bisitz 5394: }
1.795 www 5395:
1.707 bisitz 5396: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5397: border-right: 8px solid #AAFF77;
1.707 bisitz 5398: }
1.795 www 5399:
1.707 bisitz 5400: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5401: border-right: 8px solid #11CC55;
1.707 bisitz 5402: }
5403:
1.388 albertel 5404: span.LC_current_location {
1.701 harmsja 5405: font-size:larger;
1.388 albertel 5406: background: $pgbg;
5407: }
1.387 albertel 5408:
1.395 albertel 5409: span.LC_parm_menu_item {
5410: font-size: larger;
5411: }
1.795 www 5412:
1.395 albertel 5413: span.LC_parm_scope_all {
5414: color: red;
5415: }
1.795 www 5416:
1.395 albertel 5417: span.LC_parm_scope_folder {
5418: color: green;
5419: }
1.795 www 5420:
1.395 albertel 5421: span.LC_parm_scope_resource {
5422: color: orange;
5423: }
1.795 www 5424:
1.395 albertel 5425: span.LC_parm_part {
5426: color: blue;
5427: }
1.795 www 5428:
1.911 bisitz 5429: span.LC_parm_folder,
5430: span.LC_parm_symb {
1.395 albertel 5431: font-size: x-small;
5432: font-family: $mono;
5433: color: #AAAAAA;
5434: }
5435:
1.795 www 5436: td.LC_parm_overview_level_menu,
5437: td.LC_parm_overview_map_menu,
5438: td.LC_parm_overview_parm_selectors,
5439: td.LC_parm_overview_restrictions {
1.396 albertel 5440: border: 1px solid black;
5441: border-collapse: collapse;
5442: }
1.795 www 5443:
1.396 albertel 5444: table.LC_parm_overview_restrictions td {
5445: border-width: 1px 4px 1px 4px;
5446: border-style: solid;
5447: border-color: $pgbg;
5448: text-align: center;
5449: }
1.795 www 5450:
1.396 albertel 5451: table.LC_parm_overview_restrictions th {
5452: background: $tabbg;
5453: border-width: 1px 4px 1px 4px;
5454: border-style: solid;
5455: border-color: $pgbg;
5456: }
1.795 www 5457:
1.398 albertel 5458: table#LC_helpmenu {
1.803 bisitz 5459: border: none;
1.398 albertel 5460: height: 55px;
1.803 bisitz 5461: border-spacing: 0;
1.398 albertel 5462: }
5463:
5464: table#LC_helpmenu fieldset legend {
5465: font-size: larger;
5466: }
1.795 www 5467:
1.397 albertel 5468: table#LC_helpmenu_links {
5469: width: 100%;
5470: border: 1px solid black;
5471: background: $pgbg;
1.803 bisitz 5472: padding: 0;
1.397 albertel 5473: border-spacing: 1px;
5474: }
1.795 www 5475:
1.397 albertel 5476: table#LC_helpmenu_links tr td {
5477: padding: 1px;
5478: background: $tabbg;
1.399 albertel 5479: text-align: center;
5480: font-weight: bold;
1.397 albertel 5481: }
1.396 albertel 5482:
1.795 www 5483: table#LC_helpmenu_links a:link,
5484: table#LC_helpmenu_links a:visited,
1.397 albertel 5485: table#LC_helpmenu_links a:active {
5486: text-decoration: none;
5487: color: $font;
5488: }
1.795 www 5489:
1.397 albertel 5490: table#LC_helpmenu_links a:hover {
5491: text-decoration: underline;
5492: color: $vlink;
5493: }
1.396 albertel 5494:
1.417 albertel 5495: .LC_chrt_popup_exists {
5496: border: 1px solid #339933;
5497: margin: -1px;
5498: }
1.795 www 5499:
1.417 albertel 5500: .LC_chrt_popup_up {
5501: border: 1px solid yellow;
5502: margin: -1px;
5503: }
1.795 www 5504:
1.417 albertel 5505: .LC_chrt_popup {
5506: border: 1px solid #8888FF;
5507: background: #CCCCFF;
5508: }
1.795 www 5509:
1.421 albertel 5510: table.LC_pick_box {
5511: border-collapse: separate;
5512: background: white;
5513: border: 1px solid black;
5514: border-spacing: 1px;
5515: }
1.795 www 5516:
1.421 albertel 5517: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5518: background: $sidebg;
1.421 albertel 5519: font-weight: bold;
1.900 bisitz 5520: text-align: left;
1.740 bisitz 5521: vertical-align: top;
1.421 albertel 5522: width: 184px;
5523: padding: 8px;
5524: }
1.795 www 5525:
1.579 raeburn 5526: table.LC_pick_box td.LC_pick_box_value {
5527: text-align: left;
5528: padding: 8px;
5529: }
1.795 www 5530:
1.579 raeburn 5531: table.LC_pick_box td.LC_pick_box_select {
5532: text-align: left;
5533: padding: 8px;
5534: }
1.795 www 5535:
1.424 albertel 5536: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5537: padding: 0;
1.421 albertel 5538: height: 1px;
5539: background: black;
5540: }
1.795 www 5541:
1.421 albertel 5542: table.LC_pick_box td.LC_pick_box_submit {
5543: text-align: right;
5544: }
1.795 www 5545:
1.579 raeburn 5546: table.LC_pick_box td.LC_evenrow_value {
5547: text-align: left;
5548: padding: 8px;
5549: background-color: $data_table_light;
5550: }
1.795 www 5551:
1.579 raeburn 5552: table.LC_pick_box td.LC_oddrow_value {
5553: text-align: left;
5554: padding: 8px;
5555: background-color: $data_table_light;
5556: }
1.795 www 5557:
1.579 raeburn 5558: span.LC_helpform_receipt_cat {
5559: font-weight: bold;
5560: }
1.795 www 5561:
1.424 albertel 5562: table.LC_group_priv_box {
5563: background: white;
5564: border: 1px solid black;
5565: border-spacing: 1px;
5566: }
1.795 www 5567:
1.424 albertel 5568: table.LC_group_priv_box td.LC_pick_box_title {
5569: background: $tabbg;
5570: font-weight: bold;
5571: text-align: right;
5572: width: 184px;
5573: }
1.795 www 5574:
1.424 albertel 5575: table.LC_group_priv_box td.LC_groups_fixed {
5576: background: $data_table_light;
5577: text-align: center;
5578: }
1.795 www 5579:
1.424 albertel 5580: table.LC_group_priv_box td.LC_groups_optional {
5581: background: $data_table_dark;
5582: text-align: center;
5583: }
1.795 www 5584:
1.424 albertel 5585: table.LC_group_priv_box td.LC_groups_functionality {
5586: background: $data_table_darker;
5587: text-align: center;
5588: font-weight: bold;
5589: }
1.795 www 5590:
1.424 albertel 5591: table.LC_group_priv td {
5592: text-align: left;
1.803 bisitz 5593: padding: 0;
1.424 albertel 5594: }
5595:
1.421 albertel 5596: table.LC_notify_front_page {
5597: background: white;
5598: border: 1px solid black;
5599: padding: 8px;
5600: }
1.795 www 5601:
1.421 albertel 5602: table.LC_notify_front_page td {
5603: padding: 8px;
5604: }
1.795 www 5605:
1.424 albertel 5606: .LC_navbuttons {
5607: margin: 2ex 0ex 2ex 0ex;
5608: }
1.795 www 5609:
1.423 albertel 5610: .LC_topic_bar {
5611: font-weight: bold;
5612: background: $tabbg;
1.918 wenzelju 5613: margin: 1em 0em 1em 2em;
1.805 bisitz 5614: padding: 3px;
1.918 wenzelju 5615: font-size: 1.2em;
1.423 albertel 5616: }
1.795 www 5617:
1.423 albertel 5618: .LC_topic_bar span {
1.918 wenzelju 5619: left: 0.5em;
5620: position: absolute;
1.423 albertel 5621: vertical-align: middle;
1.918 wenzelju 5622: font-size: 1.2em;
1.423 albertel 5623: }
1.795 www 5624:
1.423 albertel 5625: table.LC_course_group_status {
5626: margin: 20px;
5627: }
1.795 www 5628:
1.423 albertel 5629: table.LC_status_selector td {
5630: vertical-align: top;
5631: text-align: center;
1.424 albertel 5632: padding: 4px;
5633: }
1.795 www 5634:
1.599 albertel 5635: div.LC_feedback_link {
1.616 albertel 5636: clear: both;
1.829 kalberla 5637: background: $sidebg;
1.779 bisitz 5638: width: 100%;
1.829 kalberla 5639: padding-bottom: 10px;
5640: border: 1px $tabbg solid;
1.833 kalberla 5641: height: 22px;
5642: line-height: 22px;
5643: padding-top: 5px;
5644: }
5645:
5646: div.LC_feedback_link img {
5647: height: 22px;
1.867 kalberla 5648: vertical-align:middle;
1.829 kalberla 5649: }
5650:
1.911 bisitz 5651: div.LC_feedback_link a {
1.829 kalberla 5652: text-decoration: none;
1.489 raeburn 5653: }
1.795 www 5654:
1.867 kalberla 5655: div.LC_comblock {
1.911 bisitz 5656: display:inline;
1.867 kalberla 5657: color:$font;
5658: font-size:90%;
5659: }
5660:
5661: div.LC_feedback_link div.LC_comblock {
5662: padding-left:5px;
5663: }
5664:
5665: div.LC_feedback_link div.LC_comblock a {
5666: color:$font;
5667: }
5668:
1.489 raeburn 5669: span.LC_feedback_link {
1.858 bisitz 5670: /* background: $feedback_link_bg; */
1.599 albertel 5671: font-size: larger;
5672: }
1.795 www 5673:
1.599 albertel 5674: span.LC_message_link {
1.858 bisitz 5675: /* background: $feedback_link_bg; */
1.599 albertel 5676: font-size: larger;
5677: position: absolute;
5678: right: 1em;
1.489 raeburn 5679: }
1.421 albertel 5680:
1.515 albertel 5681: table.LC_prior_tries {
1.524 albertel 5682: border: 1px solid #000000;
5683: border-collapse: separate;
5684: border-spacing: 1px;
1.515 albertel 5685: }
1.523 albertel 5686:
1.515 albertel 5687: table.LC_prior_tries td {
1.524 albertel 5688: padding: 2px;
1.515 albertel 5689: }
1.523 albertel 5690:
5691: .LC_answer_correct {
1.795 www 5692: background: lightgreen;
5693: color: darkgreen;
5694: padding: 6px;
1.523 albertel 5695: }
1.795 www 5696:
1.523 albertel 5697: .LC_answer_charged_try {
1.797 www 5698: background: #FFAAAA;
1.795 www 5699: color: darkred;
5700: padding: 6px;
1.523 albertel 5701: }
1.795 www 5702:
1.779 bisitz 5703: .LC_answer_not_charged_try,
1.523 albertel 5704: .LC_answer_no_grade,
5705: .LC_answer_late {
1.795 www 5706: background: lightyellow;
1.523 albertel 5707: color: black;
1.795 www 5708: padding: 6px;
1.523 albertel 5709: }
1.795 www 5710:
1.523 albertel 5711: .LC_answer_previous {
1.795 www 5712: background: lightblue;
5713: color: darkblue;
5714: padding: 6px;
1.523 albertel 5715: }
1.795 www 5716:
1.779 bisitz 5717: .LC_answer_no_message {
1.777 tempelho 5718: background: #FFFFFF;
5719: color: black;
1.795 www 5720: padding: 6px;
1.779 bisitz 5721: }
1.795 www 5722:
1.779 bisitz 5723: .LC_answer_unknown {
5724: background: orange;
5725: color: black;
1.795 www 5726: padding: 6px;
1.777 tempelho 5727: }
1.795 www 5728:
1.529 albertel 5729: span.LC_prior_numerical,
5730: span.LC_prior_string,
5731: span.LC_prior_custom,
5732: span.LC_prior_reaction,
5733: span.LC_prior_math {
1.925 bisitz 5734: font-family: $mono;
1.523 albertel 5735: white-space: pre;
5736: }
5737:
1.525 albertel 5738: span.LC_prior_string {
1.925 bisitz 5739: font-family: $mono;
1.525 albertel 5740: white-space: pre;
5741: }
5742:
1.523 albertel 5743: table.LC_prior_option {
5744: width: 100%;
5745: border-collapse: collapse;
5746: }
1.795 www 5747:
1.911 bisitz 5748: table.LC_prior_rank,
1.795 www 5749: table.LC_prior_match {
1.528 albertel 5750: border-collapse: collapse;
5751: }
1.795 www 5752:
1.528 albertel 5753: table.LC_prior_option tr td,
5754: table.LC_prior_rank tr td,
5755: table.LC_prior_match tr td {
1.524 albertel 5756: border: 1px solid #000000;
1.515 albertel 5757: }
5758:
1.855 bisitz 5759: .LC_nobreak {
1.544 albertel 5760: white-space: nowrap;
1.519 raeburn 5761: }
5762:
1.576 raeburn 5763: span.LC_cusr_emph {
5764: font-style: italic;
5765: }
5766:
1.633 raeburn 5767: span.LC_cusr_subheading {
5768: font-weight: normal;
5769: font-size: 85%;
5770: }
5771:
1.861 bisitz 5772: div.LC_docs_entry_move {
1.859 bisitz 5773: border: 1px solid #BBBBBB;
1.545 albertel 5774: background: #DDDDDD;
1.861 bisitz 5775: width: 22px;
1.859 bisitz 5776: padding: 1px;
5777: margin: 0;
1.545 albertel 5778: }
5779:
1.861 bisitz 5780: table.LC_data_table tr > td.LC_docs_entry_commands,
5781: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5782: background: #DDDDDD;
5783: font-size: x-small;
5784: }
1.795 www 5785:
1.861 bisitz 5786: .LC_docs_entry_parameter {
5787: white-space: nowrap;
5788: }
5789:
1.544 albertel 5790: .LC_docs_copy {
1.545 albertel 5791: color: #000099;
1.544 albertel 5792: }
1.795 www 5793:
1.544 albertel 5794: .LC_docs_cut {
1.545 albertel 5795: color: #550044;
1.544 albertel 5796: }
1.795 www 5797:
1.544 albertel 5798: .LC_docs_rename {
1.545 albertel 5799: color: #009900;
1.544 albertel 5800: }
1.795 www 5801:
1.544 albertel 5802: .LC_docs_remove {
1.545 albertel 5803: color: #990000;
5804: }
5805:
1.547 albertel 5806: .LC_docs_reinit_warn,
5807: .LC_docs_ext_edit {
5808: font-size: x-small;
5809: }
5810:
1.545 albertel 5811: table.LC_docs_adddocs td,
5812: table.LC_docs_adddocs th {
5813: border: 1px solid #BBBBBB;
5814: padding: 4px;
5815: background: #DDDDDD;
1.543 albertel 5816: }
5817:
1.584 albertel 5818: table.LC_sty_begin {
5819: background: #BBFFBB;
5820: }
1.795 www 5821:
1.584 albertel 5822: table.LC_sty_end {
5823: background: #FFBBBB;
5824: }
5825:
1.589 raeburn 5826: table.LC_double_column {
1.803 bisitz 5827: border-width: 0;
1.589 raeburn 5828: border-collapse: collapse;
5829: width: 100%;
5830: padding: 2px;
5831: }
5832:
5833: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5834: top: 2px;
1.589 raeburn 5835: left: 2px;
5836: width: 47%;
5837: vertical-align: top;
5838: }
5839:
5840: table.LC_double_column tr td.LC_right_col {
5841: top: 2px;
1.779 bisitz 5842: right: 2px;
1.589 raeburn 5843: width: 47%;
5844: vertical-align: top;
5845: }
5846:
1.591 raeburn 5847: div.LC_left_float {
5848: float: left;
5849: padding-right: 5%;
1.597 albertel 5850: padding-bottom: 4px;
1.591 raeburn 5851: }
5852:
5853: div.LC_clear_float_header {
1.597 albertel 5854: padding-bottom: 2px;
1.591 raeburn 5855: }
5856:
5857: div.LC_clear_float_footer {
1.597 albertel 5858: padding-top: 10px;
1.591 raeburn 5859: clear: both;
5860: }
5861:
1.597 albertel 5862: div.LC_grade_show_user {
1.941 bisitz 5863: /* border-left: 5px solid $sidebg; */
5864: border-top: 5px solid #000000;
5865: margin: 50px 0 0 0;
1.936 bisitz 5866: padding: 15px 0 5px 10px;
1.597 albertel 5867: }
1.795 www 5868:
1.936 bisitz 5869: div.LC_grade_show_user_odd_row {
1.941 bisitz 5870: /* border-left: 5px solid #000000; */
5871: }
5872:
5873: div.LC_grade_show_user div.LC_Box {
5874: margin-right: 50px;
1.597 albertel 5875: }
5876:
5877: div.LC_grade_submissions,
5878: div.LC_grade_message_center,
1.936 bisitz 5879: div.LC_grade_info_links {
1.597 albertel 5880: margin: 5px;
5881: width: 99%;
5882: background: #FFFFFF;
5883: }
1.795 www 5884:
1.597 albertel 5885: div.LC_grade_submissions_header,
1.936 bisitz 5886: div.LC_grade_message_center_header {
1.705 tempelho 5887: font-weight: bold;
5888: font-size: large;
1.597 albertel 5889: }
1.795 www 5890:
1.597 albertel 5891: div.LC_grade_submissions_body,
1.936 bisitz 5892: div.LC_grade_message_center_body {
1.597 albertel 5893: border: 1px solid black;
5894: width: 99%;
5895: background: #FFFFFF;
5896: }
1.795 www 5897:
1.613 albertel 5898: table.LC_scantron_action {
5899: width: 100%;
5900: }
1.795 www 5901:
1.613 albertel 5902: table.LC_scantron_action tr th {
1.698 harmsja 5903: font-weight:bold;
5904: font-style:normal;
1.613 albertel 5905: }
1.795 www 5906:
1.779 bisitz 5907: .LC_edit_problem_header,
1.614 albertel 5908: div.LC_edit_problem_footer {
1.705 tempelho 5909: font-weight: normal;
5910: font-size: medium;
1.602 albertel 5911: margin: 2px;
1.600 albertel 5912: }
1.795 www 5913:
1.600 albertel 5914: div.LC_edit_problem_header,
1.602 albertel 5915: div.LC_edit_problem_header div,
1.614 albertel 5916: div.LC_edit_problem_footer,
5917: div.LC_edit_problem_footer div,
1.602 albertel 5918: div.LC_edit_problem_editxml_header,
5919: div.LC_edit_problem_editxml_header div {
1.600 albertel 5920: margin-top: 5px;
5921: }
1.795 www 5922:
1.600 albertel 5923: div.LC_edit_problem_header_title {
1.705 tempelho 5924: font-weight: bold;
5925: font-size: larger;
1.602 albertel 5926: background: $tabbg;
5927: padding: 3px;
5928: }
1.795 www 5929:
1.602 albertel 5930: table.LC_edit_problem_header_title {
5931: width: 100%;
1.600 albertel 5932: background: $tabbg;
1.602 albertel 5933: }
5934:
5935: div.LC_edit_problem_discards {
5936: float: left;
5937: padding-bottom: 5px;
5938: }
1.795 www 5939:
1.602 albertel 5940: div.LC_edit_problem_saves {
5941: float: right;
5942: padding-bottom: 5px;
1.600 albertel 5943: }
1.795 www 5944:
1.911 bisitz 5945: img.stift {
1.803 bisitz 5946: border-width: 0;
5947: vertical-align: middle;
1.677 riegler 5948: }
1.680 riegler 5949:
1.923 bisitz 5950: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5951: vertical-align: top;
1.777 tempelho 5952: }
1.795 www 5953:
1.716 raeburn 5954: div.LC_createcourse {
1.911 bisitz 5955: margin: 10px 10px 10px 10px;
1.716 raeburn 5956: }
5957:
1.917 raeburn 5958: .LC_dccid {
5959: margin: 0.2em 0 0 0;
5960: padding: 0;
5961: font-size: 90%;
5962: display:none;
5963: }
5964:
1.698 harmsja 5965: a:hover,
1.897 wenzelju 5966: ol.LC_primary_menu a:hover,
1.721 harmsja 5967: ol#LC_MenuBreadcrumbs a:hover,
5968: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5969: ul#LC_secondary_menu a:hover,
1.721 harmsja 5970: .LC_FormSectionClearButton input:hover
1.795 www 5971: ul.LC_TabContent li:hover a {
1.911 bisitz 5972: color:#BF2317;
5973: text-decoration:none;
1.693 droeschl 5974: }
5975:
1.779 bisitz 5976: h1 {
1.911 bisitz 5977: padding: 0;
5978: line-height:130%;
1.693 droeschl 5979: }
1.698 harmsja 5980:
1.911 bisitz 5981: h2,
5982: h3,
5983: h4,
5984: h5,
5985: h6 {
5986: margin: 5px 0 5px 0;
5987: padding: 0;
5988: line-height:130%;
1.693 droeschl 5989: }
1.795 www 5990:
5991: .LC_hcell {
1.911 bisitz 5992: padding:3px 15px 3px 15px;
5993: margin: 0;
5994: background-color:$tabbg;
5995: color:$fontmenu;
5996: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5997: }
1.795 www 5998:
1.840 bisitz 5999: .LC_Box > .LC_hcell {
1.911 bisitz 6000: margin: 0 -10px 10px -10px;
1.835 bisitz 6001: }
6002:
1.721 harmsja 6003: .LC_noBorder {
1.911 bisitz 6004: border: 0;
1.698 harmsja 6005: }
1.693 droeschl 6006:
1.721 harmsja 6007: .LC_FormSectionClearButton input {
1.911 bisitz 6008: background-color:transparent;
6009: border: none;
6010: cursor:pointer;
6011: text-decoration:underline;
1.693 droeschl 6012: }
1.763 bisitz 6013:
6014: .LC_help_open_topic {
1.911 bisitz 6015: color: #FFFFFF;
6016: background-color: #EEEEFF;
6017: margin: 1px;
6018: padding: 4px;
6019: border: 1px solid #000033;
6020: white-space: nowrap;
6021: /* vertical-align: middle; */
1.759 neumanie 6022: }
1.693 droeschl 6023:
1.911 bisitz 6024: dl,
6025: ul,
6026: div,
6027: fieldset {
6028: margin: 10px 10px 10px 0;
6029: /* overflow: hidden; */
1.693 droeschl 6030: }
1.795 www 6031:
1.838 bisitz 6032: fieldset > legend {
1.911 bisitz 6033: font-weight: bold;
6034: padding: 0 5px 0 5px;
1.838 bisitz 6035: }
6036:
1.813 bisitz 6037: #LC_nav_bar {
1.911 bisitz 6038: float: left;
1.934 droeschl 6039: margin: 0;
1.807 droeschl 6040: }
6041:
1.916 droeschl 6042: #LC_realm {
6043: margin: 0.2em 0 0 0;
6044: padding: 0;
6045: font-weight: bold;
6046: text-align: center;
6047: }
6048:
1.911 bisitz 6049: #LC_nav_bar em {
6050: font-weight: bold;
6051: font-style: normal;
1.807 droeschl 6052: }
6053:
1.897 wenzelju 6054: ol.LC_primary_menu {
1.911 bisitz 6055: float: right;
1.934 droeschl 6056: margin: 0;
1.807 droeschl 6057: }
6058:
1.852 droeschl 6059: ol#LC_PathBreadcrumbs {
1.911 bisitz 6060: margin: 0;
1.693 droeschl 6061: }
6062:
1.897 wenzelju 6063: ol.LC_primary_menu li {
1.911 bisitz 6064: display: inline;
6065: padding: 5px 5px 0 10px;
6066: vertical-align: top;
1.693 droeschl 6067: }
6068:
1.897 wenzelju 6069: ol.LC_primary_menu li img {
1.911 bisitz 6070: vertical-align: bottom;
1.934 droeschl 6071: height: 1.1em;
1.693 droeschl 6072: }
6073:
1.897 wenzelju 6074: ol.LC_primary_menu a {
1.911 bisitz 6075: color: RGB(80, 80, 80);
6076: text-decoration: none;
1.693 droeschl 6077: }
1.795 www 6078:
1.949 droeschl 6079: ol.LC_primary_menu a.LC_new_message {
6080: font-weight:bold;
6081: color: darkred;
6082: }
6083:
1.897 wenzelju 6084: ul#LC_secondary_menu {
1.911 bisitz 6085: clear: both;
6086: color: $fontmenu;
6087: background: $tabbg;
6088: list-style: none;
6089: padding: 0;
6090: margin: 0;
6091: width: 100%;
1.808 droeschl 6092: }
6093:
1.897 wenzelju 6094: ul#LC_secondary_menu li {
1.911 bisitz 6095: font-weight: bold;
6096: line-height: 1.8em;
6097: padding: 0 0.8em;
6098: border-right: 1px solid black;
6099: display: inline;
6100: vertical-align: middle;
1.807 droeschl 6101: }
6102:
1.847 tempelho 6103: ul.LC_TabContent {
1.911 bisitz 6104: display:block;
6105: background: $sidebg;
6106: border-bottom: solid 1px $lg_border_color;
6107: list-style:none;
6108: margin: 0 -10px;
6109: padding: 0;
1.693 droeschl 6110: }
6111:
1.795 www 6112: ul.LC_TabContent li,
6113: ul.LC_TabContentBigger li {
1.911 bisitz 6114: float:left;
1.741 harmsja 6115: }
1.795 www 6116:
1.897 wenzelju 6117: ul#LC_secondary_menu li a {
1.911 bisitz 6118: color: $fontmenu;
6119: text-decoration: none;
1.693 droeschl 6120: }
1.795 www 6121:
1.721 harmsja 6122: ul.LC_TabContent {
1.911 bisitz 6123: min-height:1.5em;
1.721 harmsja 6124: }
1.795 www 6125:
6126: ul.LC_TabContent li {
1.911 bisitz 6127: vertical-align:middle;
6128: padding: 0 10px 0 10px;
6129: background-color:$tabbg;
6130: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6131: }
1.795 www 6132:
1.847 tempelho 6133: ul.LC_TabContent .right {
1.911 bisitz 6134: float:right;
1.847 tempelho 6135: }
6136:
1.911 bisitz 6137: ul.LC_TabContent li a,
6138: ul.LC_TabContent li {
6139: color:rgb(47,47,47);
6140: text-decoration:none;
6141: font-size:95%;
6142: font-weight:bold;
6143: padding-right: 16px;
1.721 harmsja 6144: }
1.795 www 6145:
1.911 bisitz 6146: ul.LC_TabContent li:hover,
6147: ul.LC_TabContent li.active {
6148: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6149: border-bottom:solid 2px #FFFFFF;
6150: padding-right: 16px;
1.950 onken 6151: cursor:pointer;
1.744 ehlerst 6152: }
1.795 www 6153:
1.870 tempelho 6154: #maincoursedoc {
1.911 bisitz 6155: clear:both;
1.870 tempelho 6156: }
6157:
6158: ul.LC_TabContentBigger {
1.911 bisitz 6159: display:block;
6160: list-style:none;
6161: padding: 0;
1.870 tempelho 6162: }
6163:
1.795 www 6164: ul.LC_TabContentBigger li {
1.911 bisitz 6165: vertical-align:bottom;
6166: height: 30px;
6167: font-size:110%;
6168: font-weight:bold;
6169: color: #737373;
1.841 tempelho 6170: }
6171:
1.870 tempelho 6172:
6173: ul.LC_TabContentBigger li a {
1.911 bisitz 6174: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6175: height: 30px;
6176: line-height: 30px;
6177: text-align: center;
6178: display: block;
6179: text-decoration: none;
1.741 harmsja 6180: }
1.795 www 6181:
1.911 bisitz 6182: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6183: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6184: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6185: color:$font;
6186: text-decoration: underline;
1.744 ehlerst 6187: }
1.795 www 6188:
1.870 tempelho 6189:
6190: ul.LC_TabContentBigger li b {
1.911 bisitz 6191: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6192: display: block;
6193: float: left;
6194: padding: 0 30px;
1.870 tempelho 6195: }
6196:
6197: ul.LC_TabContentBigger li:hover b,
6198: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6199: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6200: color:$font;
6201: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6202: }
1.693 droeschl 6203:
1.870 tempelho 6204:
1.862 bisitz 6205: ul.LC_CourseBreadcrumbs {
6206: background: $sidebg;
6207: line-height: 32px;
6208: padding-left: 10px;
6209: margin: 0 0 10px 0;
6210: list-style-position: inside;
6211:
6212: }
6213:
1.911 bisitz 6214: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6215: ol#LC_PathBreadcrumbs {
1.911 bisitz 6216: padding-left: 10px;
6217: margin: 0;
1.933 droeschl 6218: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6219: }
6220:
1.911 bisitz 6221: ol#LC_MenuBreadcrumbs li,
6222: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6223: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6224: display: inline;
1.933 droeschl 6225: white-space: normal;
1.693 droeschl 6226: }
6227:
1.823 bisitz 6228: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6229: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6230: text-decoration: none;
6231: font-size:90%;
1.693 droeschl 6232: }
1.795 www 6233:
6234: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6235: text-decoration:none;
6236: font-size:100%;
6237: font-weight:bold;
1.693 droeschl 6238: }
1.795 www 6239:
1.840 bisitz 6240: .LC_Box {
1.911 bisitz 6241: border: solid 1px $lg_border_color;
6242: padding: 0 10px 10px 10px;
1.746 neumanie 6243: }
1.795 www 6244:
6245: .LC_AboutMe_Image {
1.911 bisitz 6246: float:left;
6247: margin-right:10px;
1.747 neumanie 6248: }
1.795 www 6249:
6250: .LC_Clear_AboutMe_Image {
1.911 bisitz 6251: clear:left;
1.747 neumanie 6252: }
1.795 www 6253:
1.721 harmsja 6254: dl.LC_ListStyleClean dt {
1.911 bisitz 6255: padding-right: 5px;
6256: display: table-header-group;
1.693 droeschl 6257: }
6258:
1.721 harmsja 6259: dl.LC_ListStyleClean dd {
1.911 bisitz 6260: display: table-row;
1.693 droeschl 6261: }
6262:
1.721 harmsja 6263: .LC_ListStyleClean,
6264: .LC_ListStyleSimple,
6265: .LC_ListStyleNormal,
1.795 www 6266: .LC_ListStyleSpecial {
1.911 bisitz 6267: /* display:block; */
6268: list-style-position: inside;
6269: list-style-type: none;
6270: overflow: hidden;
6271: padding: 0;
1.693 droeschl 6272: }
6273:
1.721 harmsja 6274: .LC_ListStyleSimple li,
6275: .LC_ListStyleSimple dd,
6276: .LC_ListStyleNormal li,
6277: .LC_ListStyleNormal dd,
6278: .LC_ListStyleSpecial li,
1.795 www 6279: .LC_ListStyleSpecial dd {
1.911 bisitz 6280: margin: 0;
6281: padding: 5px 5px 5px 10px;
6282: clear: both;
1.693 droeschl 6283: }
6284:
1.721 harmsja 6285: .LC_ListStyleClean li,
6286: .LC_ListStyleClean dd {
1.911 bisitz 6287: padding-top: 0;
6288: padding-bottom: 0;
1.693 droeschl 6289: }
6290:
1.721 harmsja 6291: .LC_ListStyleSimple dd,
1.795 www 6292: .LC_ListStyleSimple li {
1.911 bisitz 6293: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6294: }
6295:
1.721 harmsja 6296: .LC_ListStyleSpecial li,
6297: .LC_ListStyleSpecial dd {
1.911 bisitz 6298: list-style-type: none;
6299: background-color: RGB(220, 220, 220);
6300: margin-bottom: 4px;
1.693 droeschl 6301: }
6302:
1.721 harmsja 6303: table.LC_SimpleTable {
1.911 bisitz 6304: margin:5px;
6305: border:solid 1px $lg_border_color;
1.795 www 6306: }
1.693 droeschl 6307:
1.721 harmsja 6308: table.LC_SimpleTable tr {
1.911 bisitz 6309: padding: 0;
6310: border:solid 1px $lg_border_color;
1.693 droeschl 6311: }
1.795 www 6312:
6313: table.LC_SimpleTable thead {
1.911 bisitz 6314: background:rgb(220,220,220);
1.693 droeschl 6315: }
6316:
1.721 harmsja 6317: div.LC_columnSection {
1.911 bisitz 6318: display: block;
6319: clear: both;
6320: overflow: hidden;
6321: margin: 0;
1.693 droeschl 6322: }
6323:
1.721 harmsja 6324: div.LC_columnSection>* {
1.911 bisitz 6325: float: left;
6326: margin: 10px 20px 10px 0;
6327: overflow:hidden;
1.693 droeschl 6328: }
1.721 harmsja 6329:
1.694 tempelho 6330: .LC_loginpage_container {
1.911 bisitz 6331: text-align:left;
6332: margin : 0 auto;
6333: width:90%;
6334: padding: 10px;
6335: height: auto;
6336: background-color:#FFFFFF;
6337: border:1px solid #CCCCCC;
1.694 tempelho 6338: }
6339:
6340:
6341: .LC_loginpage_loginContainer {
1.911 bisitz 6342: float:left;
6343: width: 182px;
6344: padding: 2px;
6345: border:1px solid #CCCCCC;
6346: background-color:$loginbg;
1.694 tempelho 6347: }
6348:
1.795 www 6349: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6350: margin-top: 0;
6351: display:block;
6352: background:$bgcol;
6353: color:$textcol;
6354: padding-left:5px;
1.712 muellerd 6355: }
1.785 tempelho 6356:
1.694 tempelho 6357: .LC_loginpage_loginInfo {
1.911 bisitz 6358: float:left;
6359: width:182px;
6360: border:1px solid #CCCCCC;
6361: padding:2px;
1.712 muellerd 6362: }
6363:
1.694 tempelho 6364: .LC_loginpage_space {
1.911 bisitz 6365: clear: both;
6366: margin-bottom: 20px;
6367: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6368: }
6369:
1.785 tempelho 6370: .LC_loginpage_floatLeft {
1.911 bisitz 6371: float: left;
6372: width: 200px;
6373: margin: 0;
1.785 tempelho 6374: }
6375:
1.795 www 6376: table em {
1.911 bisitz 6377: font-weight: bold;
6378: font-style: normal;
1.748 schulted 6379: }
1.795 www 6380:
1.779 bisitz 6381: table.LC_tableBrowseRes,
1.795 www 6382: table.LC_tableOfContent {
1.911 bisitz 6383: border:none;
6384: border-spacing: 1px;
6385: padding: 3px;
6386: background-color: #FFFFFF;
6387: font-size: 90%;
1.753 droeschl 6388: }
1.789 droeschl 6389:
1.911 bisitz 6390: table.LC_tableOfContent {
6391: border-collapse: collapse;
1.789 droeschl 6392: }
6393:
1.771 droeschl 6394: table.LC_tableBrowseRes a,
1.768 schulted 6395: table.LC_tableOfContent a {
1.911 bisitz 6396: background-color: transparent;
6397: text-decoration: none;
1.753 droeschl 6398: }
6399:
1.795 www 6400: table.LC_tableOfContent img {
1.911 bisitz 6401: border: none;
6402: height: 1.3em;
6403: vertical-align: text-bottom;
6404: margin-right: 0.3em;
1.753 droeschl 6405: }
1.757 schulted 6406:
1.795 www 6407: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6408: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6409: }
6410:
1.795 www 6411: a#LC_content_toolbar_launchnav {
1.911 bisitz 6412: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6413: }
6414:
1.795 www 6415: a#LC_content_toolbar_closenav {
1.911 bisitz 6416: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6417: }
6418:
1.795 www 6419: a#LC_content_toolbar_everything {
1.911 bisitz 6420: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6421: }
6422:
1.795 www 6423: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6424: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6425: }
6426:
1.795 www 6427: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6428: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6429: }
6430:
1.795 www 6431: a#LC_content_toolbar_changefolder {
1.911 bisitz 6432: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6433: }
6434:
1.795 www 6435: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6436: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6437: }
6438:
1.795 www 6439: ul#LC_toolbar li a:hover {
1.911 bisitz 6440: background-position: bottom center;
1.757 schulted 6441: }
6442:
1.795 www 6443: ul#LC_toolbar {
1.911 bisitz 6444: padding: 0;
6445: margin: 2px;
6446: list-style:none;
6447: position:relative;
6448: background-color:white;
1.757 schulted 6449: }
6450:
1.795 www 6451: ul#LC_toolbar li {
1.911 bisitz 6452: border:1px solid white;
6453: padding: 0;
6454: margin: 0;
6455: float: left;
6456: display:inline;
6457: vertical-align:middle;
6458: }
1.757 schulted 6459:
1.783 amueller 6460:
1.795 www 6461: a.LC_toolbarItem {
1.911 bisitz 6462: display:block;
6463: padding: 0;
6464: margin: 0;
6465: height: 32px;
6466: width: 32px;
6467: color:white;
6468: border: none;
6469: background-repeat:no-repeat;
6470: background-color:transparent;
1.757 schulted 6471: }
6472:
1.915 droeschl 6473: ul.LC_funclist {
6474: margin: 0;
6475: padding: 0.5em 1em 0.5em 0;
6476: }
6477:
1.933 droeschl 6478: ul.LC_funclist > li:first-child {
6479: font-weight:bold;
6480: margin-left:0.8em;
6481: }
6482:
1.915 droeschl 6483: ul.LC_funclist + ul.LC_funclist {
6484: /*
6485: left border as a seperator if we have more than
6486: one list
6487: */
6488: border-left: 1px solid $sidebg;
6489: /*
6490: this hides the left border behind the border of the
6491: outer box if element is wrapped to the next 'line'
6492: */
6493: margin-left: -1px;
6494: }
6495:
1.843 bisitz 6496: ul.LC_funclist li {
1.915 droeschl 6497: display: inline;
1.782 bisitz 6498: white-space: nowrap;
1.915 droeschl 6499: margin: 0 0 0 25px;
6500: line-height: 150%;
1.782 bisitz 6501: }
6502:
1.930 faziophi 6503: .ui-accordion .LC_advanced_toggle {
6504: float: right;
6505: font-size: 90%;
6506: padding: 0px 4px
6507: }
1.757 schulted 6508:
1.343 albertel 6509: END
6510: }
6511:
1.306 albertel 6512: =pod
6513:
6514: =item * &headtag()
6515:
6516: Returns a uniform footer for LON-CAPA web pages.
6517:
1.307 albertel 6518: Inputs: $title - optional title for the head
6519: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6520: $args - optional arguments
1.319 albertel 6521: force_register - if is true call registerurl so the remote is
6522: informed
1.415 albertel 6523: redirect -> array ref of
6524: 1- seconds before redirect occurs
6525: 2- url to redirect to
6526: 3- whether the side effect should occur
1.315 albertel 6527: (side effect of setting
6528: $env{'internal.head.redirect'} to the url
6529: redirected too)
1.352 albertel 6530: domain -> force to color decorate a page for a specific
6531: domain
6532: function -> force usage of a specific rolish color scheme
6533: bgcolor -> override the default page bgcolor
1.460 albertel 6534: no_auto_mt_title
6535: -> prevent &mt()ing the title arg
1.464 albertel 6536:
1.306 albertel 6537: =cut
6538:
6539: sub headtag {
1.313 albertel 6540: my ($title,$head_extra,$args) = @_;
1.306 albertel 6541:
1.363 albertel 6542: my $function = $args->{'function'} || &get_users_function();
6543: my $domain = $args->{'domain'} || &determinedomain();
6544: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6545: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6546: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6547: #time(),
1.418 albertel 6548: $env{'environment.color.timestamp'},
1.363 albertel 6549: $function,$domain,$bgcolor);
6550:
1.369 www 6551: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6552:
1.308 albertel 6553: my $result =
6554: '<head>'.
1.461 albertel 6555: &font_settings();
1.319 albertel 6556:
1.461 albertel 6557: if (!$args->{'frameset'}) {
6558: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6559: }
1.319 albertel 6560: if ($args->{'force_register'}) {
6561: $result .= &Apache::lonmenu::registerurl(1);
6562: }
1.436 albertel 6563: if (!$args->{'no_nav_bar'}
6564: && !$args->{'only_body'}
6565: && !$args->{'frameset'}) {
6566: $result .= &help_menu_js();
6567: }
1.319 albertel 6568:
1.314 albertel 6569: if (ref($args->{'redirect'})) {
1.414 albertel 6570: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6571: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6572: if (!$inhibit_continue) {
6573: $env{'internal.head.redirect'} = $url;
6574: }
1.313 albertel 6575: $result.=<<ADDMETA
6576: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6577: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6578: ADDMETA
6579: }
1.306 albertel 6580: if (!defined($title)) {
6581: $title = 'The LearningOnline Network with CAPA';
6582: }
1.460 albertel 6583: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6584: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6585: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6586: .$head_extra;
1.306 albertel 6587: return $result;
6588: }
6589:
6590: =pod
6591:
1.340 albertel 6592: =item * &font_settings()
6593:
6594: Returns neccessary <meta> to set the proper encoding
6595:
6596: Inputs: none
6597:
6598: =cut
6599:
6600: sub font_settings {
6601: my $headerstring='';
1.647 www 6602: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6603: $headerstring.=
6604: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6605: }
6606: return $headerstring;
6607: }
6608:
1.341 albertel 6609: =pod
6610:
6611: =item * &xml_begin()
6612:
6613: Returns the needed doctype and <html>
6614:
6615: Inputs: none
6616:
6617: =cut
6618:
6619: sub xml_begin {
6620: my $output='';
6621:
1.592 albertel 6622: if ($env{'internal.start_page'}==1) {
6623: &Apache::lonhtmlcommon::init_htmlareafields();
6624: }
1.342 albertel 6625:
1.341 albertel 6626: if ($env{'browser.mathml'}) {
6627: $output='<?xml version="1.0"?>'
6628: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6629: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6630:
6631: # .'<!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">] >'
6632: .'<!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">'
6633: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6634: .'xmlns="http://www.w3.org/1999/xhtml">';
6635: } else {
1.849 bisitz 6636: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6637: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6638: }
6639: return $output;
6640: }
1.340 albertel 6641:
6642: =pod
6643:
1.306 albertel 6644: =item * &endheadtag()
6645:
6646: Returns a uniform </head> for LON-CAPA web pages.
6647:
6648: Inputs: none
6649:
6650: =cut
6651:
6652: sub endheadtag {
6653: return '</head>';
6654: }
6655:
6656: =pod
6657:
6658: =item * &head()
6659:
6660: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6661:
1.648 raeburn 6662: Inputs:
6663:
6664: =over 4
6665:
6666: $title - optional title for the page
6667:
6668: $head_extra - optional extra HTML to put inside the <head>
6669:
6670: =back
1.405 albertel 6671:
1.306 albertel 6672: =cut
6673:
6674: sub head {
1.325 albertel 6675: my ($title,$head_extra,$args) = @_;
6676: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6677: }
6678:
6679: =pod
6680:
6681: =item * &start_page()
6682:
6683: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6684:
1.648 raeburn 6685: Inputs:
6686:
6687: =over 4
6688:
6689: $title - optional title for the page
6690:
6691: $head_extra - optional extra HTML to incude inside the <head>
6692:
6693: $args - additional optional args supported are:
6694:
6695: =over 8
6696:
6697: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6698: arg on
1.814 bisitz 6699: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6700: add_entries -> additional attributes to add to the <body>
6701: domain -> force to color decorate a page for a
1.317 albertel 6702: specific domain
1.648 raeburn 6703: function -> force usage of a specific rolish color
1.317 albertel 6704: scheme
1.648 raeburn 6705: redirect -> see &headtag()
6706: bgcolor -> override the default page bg color
6707: js_ready -> return a string ready for being used in
1.317 albertel 6708: a javascript writeln
1.648 raeburn 6709: html_encode -> return a string ready for being used in
1.320 albertel 6710: a html attribute
1.648 raeburn 6711: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6712: $forcereg arg
1.648 raeburn 6713: frameset -> if true will start with a <frameset>
1.330 albertel 6714: rather than <body>
1.648 raeburn 6715: skip_phases -> hash ref of
1.338 albertel 6716: head -> skip the <html><head> generation
6717: body -> skip all <body> generation
1.949 droeschl 6718: #RC no_inline_link -> if true and in remote mode, don't show the
6719: #RC 'Switch To Inline Menu' link
1.648 raeburn 6720: no_auto_mt_title -> prevent &mt()ing the title arg
6721: inherit_jsmath -> when creating popup window in a page,
6722: should it have jsmath forced on by the
6723: current page
1.867 kalberla 6724: bread_crumbs -> Array containing breadcrumbs
6725: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6726:
1.648 raeburn 6727: =back
1.460 albertel 6728:
1.648 raeburn 6729: =back
1.562 albertel 6730:
1.306 albertel 6731: =cut
6732:
6733: sub start_page {
1.309 albertel 6734: my ($title,$head_extra,$args) = @_;
1.318 albertel 6735: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6736: my %head_args;
1.352 albertel 6737: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6738: 'bgcolor','frameset','no_nav_bar','only_body',
6739: 'no_auto_mt_title') {
1.319 albertel 6740: if (defined($args->{$arg})) {
1.324 raeburn 6741: $head_args{$arg} = $args->{$arg};
1.319 albertel 6742: }
1.313 albertel 6743: }
1.319 albertel 6744:
1.315 albertel 6745: $env{'internal.start_page'}++;
1.338 albertel 6746: my $result;
6747: if (! exists($args->{'skip_phases'}{'head'}) ) {
6748: $result.=
1.341 albertel 6749: &xml_begin().
1.338 albertel 6750: &headtag($title,$head_extra,\%head_args).&endheadtag();
6751: }
6752:
6753: if (! exists($args->{'skip_phases'}{'body'}) ) {
6754: if ($args->{'frameset'}) {
6755: my $attr_string = &make_attr_string($args->{'force_register'},
6756: $args->{'add_entries'});
6757: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6758: } else {
6759: $result .=
6760: &bodytag($title,
6761: $args->{'function'}, $args->{'add_entries'},
6762: $args->{'only_body'}, $args->{'domain'},
6763: $args->{'force_register'}, $args->{'no_nav_bar'},
6764: $args->{'bgcolor'}, $args->{'no_inline_link'},
6765: $args);
6766: }
1.330 albertel 6767: }
1.338 albertel 6768:
1.315 albertel 6769: if ($args->{'js_ready'}) {
1.713 kaisler 6770: $result = &js_ready($result);
1.315 albertel 6771: }
1.320 albertel 6772: if ($args->{'html_encode'}) {
1.713 kaisler 6773: $result = &html_encode($result);
6774: }
6775:
1.813 bisitz 6776: # Preparation for new and consistent functionlist at top of screen
6777: # if ($args->{'functionlist'}) {
6778: # $result .= &build_functionlist();
6779: #}
6780:
6781: # Don't add anything more if only_body wanted
6782: return $result if $args->{'only_body'};
6783:
1.920 raeburn 6784: #Breadcrumbs for Construction Space provided by &bodytag.
1.949 droeschl 6785: if (
6786: $env{'request.state'} eq 'construct') {
1.920 raeburn 6787: return $result;
6788: }
6789:
1.813 bisitz 6790: #Breadcrumbs
1.758 kaisler 6791: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6792: &Apache::lonhtmlcommon::clear_breadcrumbs();
6793: #if any br links exists, add them to the breadcrumbs
6794: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6795: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6796: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6797: }
6798: }
6799:
6800: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6801: if(exists($args->{'bread_crumbs_component'})){
6802: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6803: }else{
6804: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6805: }
1.320 albertel 6806: }
1.315 albertel 6807: return $result;
1.306 albertel 6808: }
6809:
1.330 albertel 6810:
1.306 albertel 6811: =pod
6812:
6813: =item * &head()
6814:
6815: Returns a complete </body></html> section for LON-CAPA web pages.
6816:
1.315 albertel 6817: Inputs: $args - additional optional args supported are:
6818: js_ready -> return a string ready for being used in
6819: a javascript writeln
1.320 albertel 6820: html_encode -> return a string ready for being used in
6821: a html attribute
1.330 albertel 6822: frameset -> if true will start with a <frameset>
6823: rather than <body>
1.493 albertel 6824: dicsussion -> if true will get discussion from
6825: lonxml::xmlend
6826: (you can pass the target and parser arguments
6827: through optional 'target' and 'parser' args
6828: to this routine)
1.306 albertel 6829:
6830: =cut
6831:
6832: sub end_page {
1.315 albertel 6833: my ($args) = @_;
6834: $env{'internal.end_page'}++;
1.330 albertel 6835: my $result;
1.335 albertel 6836: if ($args->{'discussion'}) {
6837: my ($target,$parser);
6838: if (ref($args->{'discussion'})) {
6839: ($target,$parser) =($args->{'discussion'}{'target'},
6840: $args->{'discussion'}{'parser'});
6841: }
6842: $result .= &Apache::lonxml::xmlend($target,$parser);
6843: }
6844:
1.330 albertel 6845: if ($args->{'frameset'}) {
6846: $result .= '</frameset>';
6847: } else {
1.635 raeburn 6848: $result .= &endbodytag($args);
1.330 albertel 6849: }
6850: $result .= "\n</html>";
6851:
1.315 albertel 6852: if ($args->{'js_ready'}) {
1.317 albertel 6853: $result = &js_ready($result);
1.315 albertel 6854: }
1.335 albertel 6855:
1.320 albertel 6856: if ($args->{'html_encode'}) {
6857: $result = &html_encode($result);
6858: }
1.335 albertel 6859:
1.315 albertel 6860: return $result;
6861: }
6862:
1.320 albertel 6863: sub html_encode {
6864: my ($result) = @_;
6865:
1.322 albertel 6866: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6867:
6868: return $result;
6869: }
1.317 albertel 6870: sub js_ready {
6871: my ($result) = @_;
6872:
1.323 albertel 6873: $result =~ s/[\n\r]/ /xmsg;
6874: $result =~ s/\\/\\\\/xmsg;
6875: $result =~ s/'/\\'/xmsg;
1.372 albertel 6876: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6877:
6878: return $result;
6879: }
6880:
1.315 albertel 6881: sub validate_page {
6882: if ( exists($env{'internal.start_page'})
1.316 albertel 6883: && $env{'internal.start_page'} > 1) {
6884: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6885: $env{'internal.start_page'}.' '.
1.316 albertel 6886: $ENV{'request.filename'});
1.315 albertel 6887: }
6888: if ( exists($env{'internal.end_page'})
1.316 albertel 6889: && $env{'internal.end_page'} > 1) {
6890: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6891: $env{'internal.end_page'}.' '.
1.316 albertel 6892: $env{'request.filename'});
1.315 albertel 6893: }
6894: if ( exists($env{'internal.start_page'})
6895: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6896: &Apache::lonnet::logthis('start_page called without end_page '.
6897: $env{'request.filename'});
1.315 albertel 6898: }
6899: if ( ! exists($env{'internal.start_page'})
6900: && exists($env{'internal.end_page'})) {
1.316 albertel 6901: &Apache::lonnet::logthis('end_page called without start_page'.
6902: $env{'request.filename'});
1.315 albertel 6903: }
1.306 albertel 6904: }
1.315 albertel 6905:
1.318 albertel 6906: sub simple_error_page {
6907: my ($r,$title,$msg) = @_;
6908: my $page =
6909: &Apache::loncommon::start_page($title).
6910: &mt($msg).
6911: &Apache::loncommon::end_page();
6912: if (ref($r)) {
6913: $r->print($page);
1.327 albertel 6914: return;
1.318 albertel 6915: }
6916: return $page;
6917: }
1.347 albertel 6918:
6919: {
1.610 albertel 6920: my @row_count;
1.347 albertel 6921: sub start_data_table {
1.422 albertel 6922: my ($add_class) = @_;
6923: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6924: unshift(@row_count,0);
1.422 albertel 6925: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6926: }
6927:
6928: sub end_data_table {
1.610 albertel 6929: shift(@row_count);
1.389 albertel 6930: return '</table>'."\n";;
1.347 albertel 6931: }
6932:
6933: sub start_data_table_row {
1.422 albertel 6934: my ($add_class) = @_;
1.610 albertel 6935: $row_count[0]++;
6936: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6937: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6938: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6939: }
1.471 banghart 6940:
6941: sub continue_data_table_row {
6942: my ($add_class) = @_;
1.610 albertel 6943: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6944: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6945: return '<tr class="'.$css_class.'">'."\n";;
6946: }
1.347 albertel 6947:
6948: sub end_data_table_row {
1.389 albertel 6949: return '</tr>'."\n";;
1.347 albertel 6950: }
1.367 www 6951:
1.421 albertel 6952: sub start_data_table_empty_row {
1.707 bisitz 6953: # $row_count[0]++;
1.421 albertel 6954: return '<tr class="LC_empty_row" >'."\n";;
6955: }
6956:
6957: sub end_data_table_empty_row {
6958: return '</tr>'."\n";;
6959: }
6960:
1.367 www 6961: sub start_data_table_header_row {
1.389 albertel 6962: return '<tr class="LC_header_row">'."\n";;
1.367 www 6963: }
6964:
6965: sub end_data_table_header_row {
1.389 albertel 6966: return '</tr>'."\n";;
1.367 www 6967: }
1.890 droeschl 6968:
6969: sub data_table_caption {
6970: my $caption = shift;
6971: return "<caption class=\"LC_caption\">$caption</caption>";
6972: }
1.347 albertel 6973: }
6974:
1.548 albertel 6975: =pod
6976:
6977: =item * &inhibit_menu_check($arg)
6978:
6979: Checks for a inhibitmenu state and generates output to preserve it
6980:
6981: Inputs: $arg - can be any of
6982: - undef - in which case the return value is a string
6983: to add into arguments list of a uri
6984: - 'input' - in which case the return value is a HTML
6985: <form> <input> field of type hidden to
6986: preserve the value
6987: - a url - in which case the return value is the url with
6988: the neccesary cgi args added to preserve the
6989: inhibitmenu state
6990: - a ref to a url - no return value, but the string is
6991: updated to include the neccessary cgi
6992: args to preserve the inhibitmenu state
6993:
6994: =cut
6995:
6996: sub inhibit_menu_check {
6997: my ($arg) = @_;
6998: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6999: if ($arg eq 'input') {
7000: if ($env{'form.inhibitmenu'}) {
7001: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7002: } else {
7003: return
7004: }
7005: }
7006: if ($env{'form.inhibitmenu'}) {
7007: if (ref($arg)) {
7008: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7009: } elsif ($arg eq '') {
7010: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7011: } else {
7012: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7013: }
7014: }
7015: if (!ref($arg)) {
7016: return $arg;
7017: }
7018: }
7019:
1.251 albertel 7020: ###############################################
1.182 matthew 7021:
7022: =pod
7023:
1.549 albertel 7024: =back
7025:
7026: =head1 User Information Routines
7027:
7028: =over 4
7029:
1.405 albertel 7030: =item * &get_users_function()
1.182 matthew 7031:
7032: Used by &bodytag to determine the current users primary role.
7033: Returns either 'student','coordinator','admin', or 'author'.
7034:
7035: =cut
7036:
7037: ###############################################
7038: sub get_users_function {
1.815 tempelho 7039: my $function = 'norole';
1.818 tempelho 7040: if ($env{'request.role'}=~/^(st)/) {
7041: $function='student';
7042: }
1.907 raeburn 7043: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7044: $function='coordinator';
7045: }
1.258 albertel 7046: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7047: $function='admin';
7048: }
1.826 bisitz 7049: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7050: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7051: $function='author';
7052: }
7053: return $function;
1.54 www 7054: }
1.99 www 7055:
7056: ###############################################
7057:
1.233 raeburn 7058: =pod
7059:
1.821 raeburn 7060: =item * &show_course()
7061:
7062: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7063: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7064:
7065: Inputs:
7066: None
7067:
7068: Outputs:
7069: Scalar: 1 if 'Course' to be used, 0 otherwise.
7070:
7071: =cut
7072:
7073: ###############################################
7074: sub show_course {
7075: my $course = !$env{'user.adv'};
7076: if (!$env{'user.adv'}) {
7077: foreach my $env (keys(%env)) {
7078: next if ($env !~ m/^user\.priv\./);
7079: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7080: $course = 0;
7081: last;
7082: }
7083: }
7084: }
7085: return $course;
7086: }
7087:
7088: ###############################################
7089:
7090: =pod
7091:
1.542 raeburn 7092: =item * &check_user_status()
1.274 raeburn 7093:
7094: Determines current status of supplied role for a
7095: specific user. Roles can be active, previous or future.
7096:
7097: Inputs:
7098: user's domain, user's username, course's domain,
1.375 raeburn 7099: course's number, optional section ID.
1.274 raeburn 7100:
7101: Outputs:
7102: role status: active, previous or future.
7103:
7104: =cut
7105:
7106: sub check_user_status {
1.412 raeburn 7107: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7108: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7109: my @uroles = keys %userinfo;
7110: my $srchstr;
7111: my $active_chk = 'none';
1.412 raeburn 7112: my $now = time;
1.274 raeburn 7113: if (@uroles > 0) {
1.908 raeburn 7114: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7115: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7116: } else {
1.412 raeburn 7117: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7118: }
7119: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7120: my $role_end = 0;
7121: my $role_start = 0;
7122: $active_chk = 'active';
1.412 raeburn 7123: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7124: $role_end = $1;
7125: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7126: $role_start = $1;
1.274 raeburn 7127: }
7128: }
7129: if ($role_start > 0) {
1.412 raeburn 7130: if ($now < $role_start) {
1.274 raeburn 7131: $active_chk = 'future';
7132: }
7133: }
7134: if ($role_end > 0) {
1.412 raeburn 7135: if ($now > $role_end) {
1.274 raeburn 7136: $active_chk = 'previous';
7137: }
7138: }
7139: }
7140: }
7141: return $active_chk;
7142: }
7143:
7144: ###############################################
7145:
7146: =pod
7147:
1.405 albertel 7148: =item * &get_sections()
1.233 raeburn 7149:
7150: Determines all the sections for a course including
7151: sections with students and sections containing other roles.
1.419 raeburn 7152: Incoming parameters:
7153:
7154: 1. domain
7155: 2. course number
7156: 3. reference to array containing roles for which sections should
7157: be gathered (optional).
7158: 4. reference to array containing status types for which sections
7159: should be gathered (optional).
7160:
7161: If the third argument is undefined, sections are gathered for any role.
7162: If the fourth argument is undefined, sections are gathered for any status.
7163: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7164:
1.374 raeburn 7165: Returns section hash (keys are section IDs, values are
7166: number of users in each section), subject to the
1.419 raeburn 7167: optional roles filter, optional status filter
1.233 raeburn 7168:
7169: =cut
7170:
7171: ###############################################
7172: sub get_sections {
1.419 raeburn 7173: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7174: if (!defined($cdom) || !defined($cnum)) {
7175: my $cid = $env{'request.course.id'};
7176:
7177: return if (!defined($cid));
7178:
7179: $cdom = $env{'course.'.$cid.'.domain'};
7180: $cnum = $env{'course.'.$cid.'.num'};
7181: }
7182:
7183: my %sectioncount;
1.419 raeburn 7184: my $now = time;
1.240 albertel 7185:
1.366 albertel 7186: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7187: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7188: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7189: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7190: my $start_index = &Apache::loncoursedata::CL_START();
7191: my $end_index = &Apache::loncoursedata::CL_END();
7192: my $status;
1.366 albertel 7193: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7194: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7195: $data->[$status_index],
7196: $data->[$start_index],
7197: $data->[$end_index]);
7198: if ($stu_status eq 'Active') {
7199: $status = 'active';
7200: } elsif ($end < $now) {
7201: $status = 'previous';
7202: } elsif ($start > $now) {
7203: $status = 'future';
7204: }
7205: if ($section ne '-1' && $section !~ /^\s*$/) {
7206: if ((!defined($possible_status)) || (($status ne '') &&
7207: (grep/^\Q$status\E$/,@{$possible_status}))) {
7208: $sectioncount{$section}++;
7209: }
1.240 albertel 7210: }
7211: }
7212: }
7213: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7214: foreach my $user (sort(keys(%courseroles))) {
7215: if ($user !~ /^(\w{2})/) { next; }
7216: my ($role) = ($user =~ /^(\w{2})/);
7217: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7218: my ($section,$status);
1.240 albertel 7219: if ($role eq 'cr' &&
7220: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7221: $section=$1;
7222: }
7223: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7224: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7225: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7226: if ($end == -1 && $start == -1) {
7227: next; #deleted role
7228: }
7229: if (!defined($possible_status)) {
7230: $sectioncount{$section}++;
7231: } else {
7232: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7233: $status = 'active';
7234: } elsif ($end < $now) {
7235: $status = 'future';
7236: } elsif ($start > $now) {
7237: $status = 'previous';
7238: }
7239: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7240: $sectioncount{$section}++;
7241: }
7242: }
1.233 raeburn 7243: }
1.366 albertel 7244: return %sectioncount;
1.233 raeburn 7245: }
7246:
1.274 raeburn 7247: ###############################################
1.294 raeburn 7248:
7249: =pod
1.405 albertel 7250:
7251: =item * &get_course_users()
7252:
1.275 raeburn 7253: Retrieves usernames:domains for users in the specified course
7254: with specific role(s), and access status.
7255:
7256: Incoming parameters:
1.277 albertel 7257: 1. course domain
7258: 2. course number
7259: 3. access status: users must have - either active,
1.275 raeburn 7260: previous, future, or all.
1.277 albertel 7261: 4. reference to array of permissible roles
1.288 raeburn 7262: 5. reference to array of section restrictions (optional)
7263: 6. reference to results object (hash of hashes).
7264: 7. reference to optional userdata hash
1.609 raeburn 7265: 8. reference to optional statushash
1.630 raeburn 7266: 9. flag if privileged users (except those set to unhide in
7267: course settings) should be excluded
1.609 raeburn 7268: Keys of top level results hash are roles.
1.275 raeburn 7269: Keys of inner hashes are username:domain, with
7270: values set to access type.
1.288 raeburn 7271: Optional userdata hash returns an array with arguments in the
7272: same order as loncoursedata::get_classlist() for student data.
7273:
1.609 raeburn 7274: Optional statushash returns
7275:
1.288 raeburn 7276: Entries for end, start, section and status are blank because
7277: of the possibility of multiple values for non-student roles.
7278:
1.275 raeburn 7279: =cut
1.405 albertel 7280:
1.275 raeburn 7281: ###############################################
1.405 albertel 7282:
1.275 raeburn 7283: sub get_course_users {
1.630 raeburn 7284: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7285: my %idx = ();
1.419 raeburn 7286: my %seclists;
1.288 raeburn 7287:
7288: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7289: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7290: $idx{end} = &Apache::loncoursedata::CL_END();
7291: $idx{start} = &Apache::loncoursedata::CL_START();
7292: $idx{id} = &Apache::loncoursedata::CL_ID();
7293: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7294: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7295: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7296:
1.290 albertel 7297: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7298: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7299: my $now = time;
1.277 albertel 7300: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7301: my $match = 0;
1.412 raeburn 7302: my $secmatch = 0;
1.419 raeburn 7303: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7304: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7305: if ($section eq '') {
7306: $section = 'none';
7307: }
1.291 albertel 7308: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7309: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7310: $secmatch = 1;
7311: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7312: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7313: $secmatch = 1;
7314: }
7315: } else {
1.419 raeburn 7316: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7317: $secmatch = 1;
7318: }
1.290 albertel 7319: }
1.412 raeburn 7320: if (!$secmatch) {
7321: next;
7322: }
1.419 raeburn 7323: }
1.275 raeburn 7324: if (defined($$types{'active'})) {
1.288 raeburn 7325: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7326: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7327: $match = 1;
1.275 raeburn 7328: }
7329: }
7330: if (defined($$types{'previous'})) {
1.609 raeburn 7331: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7332: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7333: $match = 1;
1.275 raeburn 7334: }
7335: }
7336: if (defined($$types{'future'})) {
1.609 raeburn 7337: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7338: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7339: $match = 1;
1.275 raeburn 7340: }
7341: }
1.609 raeburn 7342: if ($match) {
7343: push(@{$seclists{$student}},$section);
7344: if (ref($userdata) eq 'HASH') {
7345: $$userdata{$student} = $$classlist{$student};
7346: }
7347: if (ref($statushash) eq 'HASH') {
7348: $statushash->{$student}{'st'}{$section} = $status;
7349: }
1.288 raeburn 7350: }
1.275 raeburn 7351: }
7352: }
1.412 raeburn 7353: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7354: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7355: my $now = time;
1.609 raeburn 7356: my %displaystatus = ( previous => 'Expired',
7357: active => 'Active',
7358: future => 'Future',
7359: );
1.630 raeburn 7360: my %nothide;
7361: if ($hidepriv) {
7362: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7363: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7364: if ($user !~ /:/) {
7365: $nothide{join(':',split(/[\@]/,$user))}=1;
7366: } else {
7367: $nothide{$user} = 1;
7368: }
7369: }
7370: }
1.439 raeburn 7371: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7372: my $match = 0;
1.412 raeburn 7373: my $secmatch = 0;
1.439 raeburn 7374: my $status;
1.412 raeburn 7375: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7376: $user =~ s/:$//;
1.439 raeburn 7377: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7378: if ($end == -1 || $start == -1) {
7379: next;
7380: }
7381: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7382: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7383: my ($uname,$udom) = split(/:/,$user);
7384: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7385: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7386: $secmatch = 1;
7387: } elsif ($usec eq '') {
1.420 albertel 7388: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7389: $secmatch = 1;
7390: }
7391: } else {
7392: if (grep(/^\Q$usec\E$/,@{$sections})) {
7393: $secmatch = 1;
7394: }
7395: }
7396: if (!$secmatch) {
7397: next;
7398: }
1.288 raeburn 7399: }
1.419 raeburn 7400: if ($usec eq '') {
7401: $usec = 'none';
7402: }
1.275 raeburn 7403: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7404: if ($hidepriv) {
7405: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7406: (!$nothide{$uname.':'.$udom})) {
7407: next;
7408: }
7409: }
1.503 raeburn 7410: if ($end > 0 && $end < $now) {
1.439 raeburn 7411: $status = 'previous';
7412: } elsif ($start > $now) {
7413: $status = 'future';
7414: } else {
7415: $status = 'active';
7416: }
1.277 albertel 7417: foreach my $type (keys(%{$types})) {
1.275 raeburn 7418: if ($status eq $type) {
1.420 albertel 7419: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7420: push(@{$$users{$role}{$user}},$type);
7421: }
1.288 raeburn 7422: $match = 1;
7423: }
7424: }
1.419 raeburn 7425: if (($match) && (ref($userdata) eq 'HASH')) {
7426: if (!exists($$userdata{$uname.':'.$udom})) {
7427: &get_user_info($udom,$uname,\%idx,$userdata);
7428: }
1.420 albertel 7429: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7430: push(@{$seclists{$uname.':'.$udom}},$usec);
7431: }
1.609 raeburn 7432: if (ref($statushash) eq 'HASH') {
7433: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7434: }
1.275 raeburn 7435: }
7436: }
7437: }
7438: }
1.290 albertel 7439: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7440: if ((defined($cdom)) && (defined($cnum))) {
7441: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7442: if ( defined($csettings{'internal.courseowner'}) ) {
7443: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7444: next if ($owner eq '');
7445: my ($ownername,$ownerdom);
7446: if ($owner =~ /^([^:]+):([^:]+)$/) {
7447: $ownername = $1;
7448: $ownerdom = $2;
7449: } else {
7450: $ownername = $owner;
7451: $ownerdom = $cdom;
7452: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7453: }
7454: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7455: if (defined($userdata) &&
1.609 raeburn 7456: !exists($$userdata{$owner})) {
7457: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7458: if (!grep(/^none$/,@{$seclists{$owner}})) {
7459: push(@{$seclists{$owner}},'none');
7460: }
7461: if (ref($statushash) eq 'HASH') {
7462: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7463: }
1.290 albertel 7464: }
1.279 raeburn 7465: }
7466: }
7467: }
1.419 raeburn 7468: foreach my $user (keys(%seclists)) {
7469: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7470: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7471: }
1.275 raeburn 7472: }
7473: return;
7474: }
7475:
1.288 raeburn 7476: sub get_user_info {
7477: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7478: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7479: &plainname($uname,$udom,'lastname');
1.291 albertel 7480: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7481: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7482: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7483: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7484: return;
7485: }
1.275 raeburn 7486:
1.472 raeburn 7487: ###############################################
7488:
7489: =pod
7490:
7491: =item * &get_user_quota()
7492:
7493: Retrieves quota assigned for storage of portfolio files for a user
7494:
7495: Incoming parameters:
7496: 1. user's username
7497: 2. user's domain
7498:
7499: Returns:
1.536 raeburn 7500: 1. Disk quota (in Mb) assigned to student.
7501: 2. (Optional) Type of setting: custom or default
7502: (individually assigned or default for user's
7503: institutional status).
7504: 3. (Optional) - User's institutional status (e.g., faculty, staff
7505: or student - types as defined in localenroll::inst_usertypes
7506: for user's domain, which determines default quota for user.
7507: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7508:
7509: If a value has been stored in the user's environment,
1.536 raeburn 7510: it will return that, otherwise it returns the maximal default
7511: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7512:
7513: =cut
7514:
7515: ###############################################
7516:
7517:
7518: sub get_user_quota {
7519: my ($uname,$udom) = @_;
1.536 raeburn 7520: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7521: if (!defined($udom)) {
7522: $udom = $env{'user.domain'};
7523: }
7524: if (!defined($uname)) {
7525: $uname = $env{'user.name'};
7526: }
7527: if (($udom eq '' || $uname eq '') ||
7528: ($udom eq 'public') && ($uname eq 'public')) {
7529: $quota = 0;
1.536 raeburn 7530: $quotatype = 'default';
7531: $defquota = 0;
1.472 raeburn 7532: } else {
1.536 raeburn 7533: my $inststatus;
1.472 raeburn 7534: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7535: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7536: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7537: } else {
1.536 raeburn 7538: my %userenv =
7539: &Apache::lonnet::get('environment',['portfolioquota',
7540: 'inststatus'],$udom,$uname);
1.472 raeburn 7541: my ($tmp) = keys(%userenv);
7542: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7543: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7544: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7545: } else {
7546: undef(%userenv);
7547: }
7548: }
1.536 raeburn 7549: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7550: if ($quota eq '') {
1.536 raeburn 7551: $quota = $defquota;
7552: $quotatype = 'default';
7553: } else {
7554: $quotatype = 'custom';
1.472 raeburn 7555: }
7556: }
1.536 raeburn 7557: if (wantarray) {
7558: return ($quota,$quotatype,$settingstatus,$defquota);
7559: } else {
7560: return $quota;
7561: }
1.472 raeburn 7562: }
7563:
7564: ###############################################
7565:
7566: =pod
7567:
7568: =item * &default_quota()
7569:
1.536 raeburn 7570: Retrieves default quota assigned for storage of user portfolio files,
7571: given an (optional) user's institutional status.
1.472 raeburn 7572:
7573: Incoming parameters:
7574: 1. domain
1.536 raeburn 7575: 2. (Optional) institutional status(es). This is a : separated list of
7576: status types (e.g., faculty, staff, student etc.)
7577: which apply to the user for whom the default is being retrieved.
7578: If the institutional status string in undefined, the domain
7579: default quota will be returned.
1.472 raeburn 7580:
7581: Returns:
7582: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7583: 2. (Optional) institutional type which determined the value of the
7584: default quota.
1.472 raeburn 7585:
7586: If a value has been stored in the domain's configuration db,
7587: it will return that, otherwise it returns 20 (for backwards
7588: compatibility with domains which have not set up a configuration
7589: db file; the original statically defined portfolio quota was 20 Mb).
7590:
1.536 raeburn 7591: If the user's status includes multiple types (e.g., staff and student),
7592: the largest default quota which applies to the user determines the
7593: default quota returned.
7594:
1.780 raeburn 7595: =back
7596:
1.472 raeburn 7597: =cut
7598:
7599: ###############################################
7600:
7601:
7602: sub default_quota {
1.536 raeburn 7603: my ($udom,$inststatus) = @_;
7604: my ($defquota,$settingstatus);
7605: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7606: ['quotas'],$udom);
7607: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7608: if ($inststatus ne '') {
1.765 raeburn 7609: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7610: foreach my $item (@statuses) {
1.711 raeburn 7611: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7612: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7613: if ($defquota eq '') {
7614: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7615: $settingstatus = $item;
7616: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7617: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7618: $settingstatus = $item;
7619: }
7620: }
7621: } else {
7622: if ($quotahash{'quotas'}{$item} ne '') {
7623: if ($defquota eq '') {
7624: $defquota = $quotahash{'quotas'}{$item};
7625: $settingstatus = $item;
7626: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7627: $defquota = $quotahash{'quotas'}{$item};
7628: $settingstatus = $item;
7629: }
1.536 raeburn 7630: }
7631: }
7632: }
7633: }
7634: if ($defquota eq '') {
1.711 raeburn 7635: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7636: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7637: } else {
7638: $defquota = $quotahash{'quotas'}{'default'};
7639: }
1.536 raeburn 7640: $settingstatus = 'default';
7641: }
7642: } else {
7643: $settingstatus = 'default';
7644: $defquota = 20;
7645: }
7646: if (wantarray) {
7647: return ($defquota,$settingstatus);
1.472 raeburn 7648: } else {
1.536 raeburn 7649: return $defquota;
1.472 raeburn 7650: }
7651: }
7652:
1.384 raeburn 7653: sub get_secgrprole_info {
7654: my ($cdom,$cnum,$needroles,$type) = @_;
7655: my %sections_count = &get_sections($cdom,$cnum);
7656: my @sections = (sort {$a <=> $b} keys(%sections_count));
7657: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7658: my @groups = sort(keys(%curr_groups));
7659: my $allroles = [];
7660: my $rolehash;
7661: my $accesshash = {
7662: active => 'Currently has access',
7663: future => 'Will have future access',
7664: previous => 'Previously had access',
7665: };
7666: if ($needroles) {
7667: $rolehash = {'all' => 'all'};
1.385 albertel 7668: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7669: if (&Apache::lonnet::error(%user_roles)) {
7670: undef(%user_roles);
7671: }
7672: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7673: my ($role)=split(/\:/,$item,2);
7674: if ($role eq 'cr') { next; }
7675: if ($role =~ /^cr/) {
7676: $$rolehash{$role} = (split('/',$role))[3];
7677: } else {
7678: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7679: }
7680: }
7681: foreach my $key (sort(keys(%{$rolehash}))) {
7682: push(@{$allroles},$key);
7683: }
7684: push (@{$allroles},'st');
7685: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7686: }
7687: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7688: }
7689:
1.555 raeburn 7690: sub user_picker {
1.627 raeburn 7691: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7692: my $currdom = $dom;
7693: my %curr_selected = (
7694: srchin => 'dom',
1.580 raeburn 7695: srchby => 'lastname',
1.555 raeburn 7696: );
7697: my $srchterm;
1.625 raeburn 7698: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7699: if ($srch->{'srchby'} ne '') {
7700: $curr_selected{'srchby'} = $srch->{'srchby'};
7701: }
7702: if ($srch->{'srchin'} ne '') {
7703: $curr_selected{'srchin'} = $srch->{'srchin'};
7704: }
7705: if ($srch->{'srchtype'} ne '') {
7706: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7707: }
7708: if ($srch->{'srchdomain'} ne '') {
7709: $currdom = $srch->{'srchdomain'};
7710: }
7711: $srchterm = $srch->{'srchterm'};
7712: }
7713: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7714: 'usr' => 'Search criteria',
1.563 raeburn 7715: 'doma' => 'Domain/institution to search',
1.558 albertel 7716: 'uname' => 'username',
7717: 'lastname' => 'last name',
1.555 raeburn 7718: 'lastfirst' => 'last name, first name',
1.558 albertel 7719: 'crs' => 'in this course',
1.576 raeburn 7720: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7721: 'alc' => 'all LON-CAPA',
1.573 raeburn 7722: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7723: 'exact' => 'is',
7724: 'contains' => 'contains',
1.569 raeburn 7725: 'begins' => 'begins with',
1.571 raeburn 7726: 'youm' => "You must include some text to search for.",
7727: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7728: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7729: 'yomc' => "You must choose a domain when using an institutional directory search.",
7730: 'ymcd' => "You must choose a domain when using a domain search.",
7731: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7732: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7733: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7734: );
1.563 raeburn 7735: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7736: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7737:
7738: my @srchins = ('crs','dom','alc','instd');
7739:
7740: foreach my $option (@srchins) {
7741: # FIXME 'alc' option unavailable until
7742: # loncreateuser::print_user_query_page()
7743: # has been completed.
7744: next if ($option eq 'alc');
1.880 raeburn 7745: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7746: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7747: if ($curr_selected{'srchin'} eq $option) {
7748: $srchinsel .= '
7749: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7750: } else {
7751: $srchinsel .= '
7752: <option value="'.$option.'">'.$lt{$option}.'</option>';
7753: }
1.555 raeburn 7754: }
1.563 raeburn 7755: $srchinsel .= "\n </select>\n";
1.555 raeburn 7756:
7757: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7758: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7759: if ($curr_selected{'srchby'} eq $option) {
7760: $srchbysel .= '
7761: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7762: } else {
7763: $srchbysel .= '
7764: <option value="'.$option.'">'.$lt{$option}.'</option>';
7765: }
7766: }
7767: $srchbysel .= "\n </select>\n";
7768:
7769: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7770: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7771: if ($curr_selected{'srchtype'} eq $option) {
7772: $srchtypesel .= '
7773: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7774: } else {
7775: $srchtypesel .= '
7776: <option value="'.$option.'">'.$lt{$option}.'</option>';
7777: }
7778: }
7779: $srchtypesel .= "\n </select>\n";
7780:
1.558 albertel 7781: my ($newuserscript,$new_user_create);
1.556 raeburn 7782:
7783: if ($forcenewuser) {
1.576 raeburn 7784: if (ref($srch) eq 'HASH') {
7785: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7786: if ($cancreate) {
7787: $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>';
7788: } else {
1.799 bisitz 7789: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7790: my %usertypetext = (
7791: official => 'institutional',
7792: unofficial => 'non-institutional',
7793: );
1.799 bisitz 7794: $new_user_create = '<p class="LC_warning">'
7795: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7796: .' '
7797: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7798: ,'<a href="'.$helplink.'">','</a>')
7799: .'</p><br />';
1.627 raeburn 7800: }
1.576 raeburn 7801: }
7802: }
7803:
1.556 raeburn 7804: $newuserscript = <<"ENDSCRIPT";
7805:
1.570 raeburn 7806: function setSearch(createnew,callingForm) {
1.556 raeburn 7807: if (createnew == 1) {
1.570 raeburn 7808: for (var i=0; i<callingForm.srchby.length; i++) {
7809: if (callingForm.srchby.options[i].value == 'uname') {
7810: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7811: }
7812: }
1.570 raeburn 7813: for (var i=0; i<callingForm.srchin.length; i++) {
7814: if ( callingForm.srchin.options[i].value == 'dom') {
7815: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7816: }
7817: }
1.570 raeburn 7818: for (var i=0; i<callingForm.srchtype.length; i++) {
7819: if (callingForm.srchtype.options[i].value == 'exact') {
7820: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7821: }
7822: }
1.570 raeburn 7823: for (var i=0; i<callingForm.srchdomain.length; i++) {
7824: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7825: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7826: }
7827: }
7828: }
7829: }
7830: ENDSCRIPT
1.558 albertel 7831:
1.556 raeburn 7832: }
7833:
1.555 raeburn 7834: my $output = <<"END_BLOCK";
1.556 raeburn 7835: <script type="text/javascript">
1.824 bisitz 7836: // <![CDATA[
1.570 raeburn 7837: function validateEntry(callingForm) {
1.558 albertel 7838:
1.556 raeburn 7839: var checkok = 1;
1.558 albertel 7840: var srchin;
1.570 raeburn 7841: for (var i=0; i<callingForm.srchin.length; i++) {
7842: if ( callingForm.srchin[i].checked ) {
7843: srchin = callingForm.srchin[i].value;
1.558 albertel 7844: }
7845: }
7846:
1.570 raeburn 7847: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7848: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7849: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7850: var srchterm = callingForm.srchterm.value;
7851: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7852: var msg = "";
7853:
7854: if (srchterm == "") {
7855: checkok = 0;
1.571 raeburn 7856: msg += "$lt{'youm'}\\n";
1.556 raeburn 7857: }
7858:
1.569 raeburn 7859: if (srchtype== 'begins') {
7860: if (srchterm.length < 2) {
7861: checkok = 0;
1.571 raeburn 7862: msg += "$lt{'thte'}\\n";
1.569 raeburn 7863: }
7864: }
7865:
1.556 raeburn 7866: if (srchtype== 'contains') {
7867: if (srchterm.length < 3) {
7868: checkok = 0;
1.571 raeburn 7869: msg += "$lt{'thet'}\\n";
1.556 raeburn 7870: }
7871: }
7872: if (srchin == 'instd') {
7873: if (srchdomain == '') {
7874: checkok = 0;
1.571 raeburn 7875: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7876: }
7877: }
7878: if (srchin == 'dom') {
7879: if (srchdomain == '') {
7880: checkok = 0;
1.571 raeburn 7881: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7882: }
7883: }
7884: if (srchby == 'lastfirst') {
7885: if (srchterm.indexOf(",") == -1) {
7886: checkok = 0;
1.571 raeburn 7887: msg += "$lt{'whus'}\\n";
1.556 raeburn 7888: }
7889: if (srchterm.indexOf(",") == srchterm.length -1) {
7890: checkok = 0;
1.571 raeburn 7891: msg += "$lt{'whse'}\\n";
1.556 raeburn 7892: }
7893: }
7894: if (checkok == 0) {
1.571 raeburn 7895: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7896: return;
7897: }
7898: if (checkok == 1) {
1.570 raeburn 7899: callingForm.submit();
1.556 raeburn 7900: }
7901: }
7902:
7903: $newuserscript
7904:
1.824 bisitz 7905: // ]]>
1.556 raeburn 7906: </script>
1.558 albertel 7907:
7908: $new_user_create
7909:
1.555 raeburn 7910: END_BLOCK
1.558 albertel 7911:
1.876 raeburn 7912: $output .= &Apache::lonhtmlcommon::start_pick_box().
7913: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7914: $domform.
7915: &Apache::lonhtmlcommon::row_closure().
7916: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7917: $srchbysel.
7918: $srchtypesel.
7919: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7920: $srchinsel.
7921: &Apache::lonhtmlcommon::row_closure(1).
7922: &Apache::lonhtmlcommon::end_pick_box().
7923: '<br />';
1.555 raeburn 7924: return $output;
7925: }
7926:
1.612 raeburn 7927: sub user_rule_check {
1.615 raeburn 7928: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7929: my $response;
7930: if (ref($usershash) eq 'HASH') {
7931: foreach my $user (keys(%{$usershash})) {
7932: my ($uname,$udom) = split(/:/,$user);
7933: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7934: my ($id,$newuser);
1.612 raeburn 7935: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7936: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7937: $id = $usershash->{$user}->{'id'};
7938: }
7939: my $inst_response;
7940: if (ref($checks) eq 'HASH') {
7941: if (defined($checks->{'username'})) {
1.615 raeburn 7942: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7943: &Apache::lonnet::get_instuser($udom,$uname);
7944: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7945: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7946: &Apache::lonnet::get_instuser($udom,undef,$id);
7947: }
1.615 raeburn 7948: } else {
7949: ($inst_response,%{$inst_results->{$user}}) =
7950: &Apache::lonnet::get_instuser($udom,$uname);
7951: return;
1.612 raeburn 7952: }
1.615 raeburn 7953: if (!$got_rules->{$udom}) {
1.612 raeburn 7954: my %domconfig = &Apache::lonnet::get_dom('configuration',
7955: ['usercreation'],$udom);
7956: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7957: foreach my $item ('username','id') {
1.612 raeburn 7958: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7959: $$curr_rules{$udom}{$item} =
7960: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7961: }
7962: }
7963: }
1.615 raeburn 7964: $got_rules->{$udom} = 1;
1.585 raeburn 7965: }
1.612 raeburn 7966: foreach my $item (keys(%{$checks})) {
7967: if (ref($$curr_rules{$udom}) eq 'HASH') {
7968: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7969: if (@{$$curr_rules{$udom}{$item}} > 0) {
7970: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7971: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7972: if ($rule_check{$rule}) {
7973: $$rulematch{$user}{$item} = $rule;
7974: if ($inst_response eq 'ok') {
1.615 raeburn 7975: if (ref($inst_results) eq 'HASH') {
7976: if (ref($inst_results->{$user}) eq 'HASH') {
7977: if (keys(%{$inst_results->{$user}}) == 0) {
7978: $$alerts{$item}{$udom}{$uname} = 1;
7979: }
1.612 raeburn 7980: }
7981: }
1.615 raeburn 7982: }
7983: last;
1.585 raeburn 7984: }
7985: }
7986: }
7987: }
7988: }
7989: }
7990: }
7991: }
1.612 raeburn 7992: return;
7993: }
7994:
7995: sub user_rule_formats {
7996: my ($domain,$domdesc,$curr_rules,$check) = @_;
7997: my %text = (
7998: 'username' => 'Usernames',
7999: 'id' => 'IDs',
8000: );
8001: my $output;
8002: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8003: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8004: if (@{$ruleorder} > 0) {
8005: $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>';
8006: foreach my $rule (@{$ruleorder}) {
8007: if (ref($curr_rules) eq 'ARRAY') {
8008: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8009: if (ref($rules->{$rule}) eq 'HASH') {
8010: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8011: $rules->{$rule}{'desc'}.'</li>';
8012: }
8013: }
8014: }
8015: }
8016: $output .= '</ul>';
8017: }
8018: }
8019: return $output;
8020: }
8021:
8022: sub instrule_disallow_msg {
1.615 raeburn 8023: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8024: my $response;
8025: my %text = (
8026: item => 'username',
8027: items => 'usernames',
8028: match => 'matches',
8029: do => 'does',
8030: action => 'a username',
8031: one => 'one',
8032: );
8033: if ($count > 1) {
8034: $text{'item'} = 'usernames';
8035: $text{'match'} ='match';
8036: $text{'do'} = 'do';
8037: $text{'action'} = 'usernames',
8038: $text{'one'} = 'ones';
8039: }
8040: if ($checkitem eq 'id') {
8041: $text{'items'} = 'IDs';
8042: $text{'item'} = 'ID';
8043: $text{'action'} = 'an ID';
1.615 raeburn 8044: if ($count > 1) {
8045: $text{'item'} = 'IDs';
8046: $text{'action'} = 'IDs';
8047: }
1.612 raeburn 8048: }
1.674 bisitz 8049: $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 8050: if ($mode eq 'upload') {
8051: if ($checkitem eq 'username') {
8052: $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'}.");
8053: } elsif ($checkitem eq 'id') {
1.674 bisitz 8054: $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 8055: }
1.669 raeburn 8056: } elsif ($mode eq 'selfcreate') {
8057: if ($checkitem eq 'id') {
8058: $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.");
8059: }
1.615 raeburn 8060: } else {
8061: if ($checkitem eq 'username') {
8062: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8063: } elsif ($checkitem eq 'id') {
8064: $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.");
8065: }
1.612 raeburn 8066: }
8067: return $response;
1.585 raeburn 8068: }
8069:
1.624 raeburn 8070: sub personal_data_fieldtitles {
8071: my %fieldtitles = &Apache::lonlocal::texthash (
8072: id => 'Student/Employee ID',
8073: permanentemail => 'E-mail address',
8074: lastname => 'Last Name',
8075: firstname => 'First Name',
8076: middlename => 'Middle Name',
8077: generation => 'Generation',
8078: gen => 'Generation',
1.765 raeburn 8079: inststatus => 'Affiliation',
1.624 raeburn 8080: );
8081: return %fieldtitles;
8082: }
8083:
1.642 raeburn 8084: sub sorted_inst_types {
8085: my ($dom) = @_;
8086: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8087: my $othertitle = &mt('All users');
8088: if ($env{'request.course.id'}) {
1.668 raeburn 8089: $othertitle = &mt('Any users');
1.642 raeburn 8090: }
8091: my @types;
8092: if (ref($order) eq 'ARRAY') {
8093: @types = @{$order};
8094: }
8095: if (@types == 0) {
8096: if (ref($usertypes) eq 'HASH') {
8097: @types = sort(keys(%{$usertypes}));
8098: }
8099: }
8100: if (keys(%{$usertypes}) > 0) {
8101: $othertitle = &mt('Other users');
8102: }
8103: return ($othertitle,$usertypes,\@types);
8104: }
8105:
1.645 raeburn 8106: sub get_institutional_codes {
8107: my ($settings,$allcourses,$LC_code) = @_;
8108: # Get complete list of course sections to update
8109: my @currsections = ();
8110: my @currxlists = ();
8111: my $coursecode = $$settings{'internal.coursecode'};
8112:
8113: if ($$settings{'internal.sectionnums'} ne '') {
8114: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8115: }
8116:
8117: if ($$settings{'internal.crosslistings'} ne '') {
8118: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8119: }
8120:
8121: if (@currxlists > 0) {
8122: foreach (@currxlists) {
8123: if (m/^([^:]+):(\w*)$/) {
8124: unless (grep/^$1$/,@{$allcourses}) {
8125: push @{$allcourses},$1;
8126: $$LC_code{$1} = $2;
8127: }
8128: }
8129: }
8130: }
8131:
8132: if (@currsections > 0) {
8133: foreach (@currsections) {
8134: if (m/^(\w+):(\w*)$/) {
8135: my $sec = $coursecode.$1;
8136: my $lc_sec = $2;
8137: unless (grep/^$sec$/,@{$allcourses}) {
8138: push @{$allcourses},$sec;
8139: $$LC_code{$sec} = $lc_sec;
8140: }
8141: }
8142: }
8143: }
8144: return;
8145: }
8146:
1.112 bowersj2 8147: =pod
8148:
1.780 raeburn 8149: =head1 Slot Helpers
8150:
8151: =over 4
8152:
8153: =item * sorted_slots()
8154:
8155: Sorts an array of slot names in order of slot start time (earliest first).
8156:
8157: Inputs:
8158:
8159: =over 4
8160:
8161: slotsarr - Reference to array of unsorted slot names.
8162:
8163: slots - Reference to hash of hash, where outer hash keys are slot names.
8164:
1.549 albertel 8165: =back
8166:
1.780 raeburn 8167: Returns:
8168:
8169: =over 4
8170:
8171: sorted - An array of slot names sorted by the start time of the slot.
8172:
8173: =back
8174:
8175: =back
8176:
8177: =cut
8178:
8179:
8180: sub sorted_slots {
8181: my ($slotsarr,$slots) = @_;
8182: my @sorted;
8183: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8184: @sorted =
8185: sort {
8186: if (ref($slots->{$a}) && ref($slots->{$b})) {
8187: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8188: }
8189: if (ref($slots->{$a})) { return -1;}
8190: if (ref($slots->{$b})) { return 1;}
8191: return 0;
8192: } @{$slotsarr};
8193: }
8194: return @sorted;
8195: }
8196:
8197:
8198: =pod
8199:
1.549 albertel 8200: =head1 HTTP Helpers
8201:
8202: =over 4
8203:
1.648 raeburn 8204: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8205:
1.258 albertel 8206: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8207: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8208: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8209:
8210: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8211: $possible_names is an ref to an array of form element names. As an example:
8212: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8213: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8214:
8215: =cut
1.1 albertel 8216:
1.6 albertel 8217: sub get_unprocessed_cgi {
1.25 albertel 8218: my ($query,$possible_names)= @_;
1.26 matthew 8219: # $Apache::lonxml::debug=1;
1.356 albertel 8220: foreach my $pair (split(/&/,$query)) {
8221: my ($name, $value) = split(/=/,$pair);
1.369 www 8222: $name = &unescape($name);
1.25 albertel 8223: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8224: $value =~ tr/+/ /;
8225: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8226: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8227: }
1.16 harris41 8228: }
1.6 albertel 8229: }
8230:
1.112 bowersj2 8231: =pod
8232:
1.648 raeburn 8233: =item * &cacheheader()
1.112 bowersj2 8234:
8235: returns cache-controlling header code
8236:
8237: =cut
8238:
1.7 albertel 8239: sub cacheheader {
1.258 albertel 8240: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8241: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8242: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8243: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8244: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8245: return $output;
1.7 albertel 8246: }
8247:
1.112 bowersj2 8248: =pod
8249:
1.648 raeburn 8250: =item * &no_cache($r)
1.112 bowersj2 8251:
8252: specifies header code to not have cache
8253:
8254: =cut
8255:
1.9 albertel 8256: sub no_cache {
1.216 albertel 8257: my ($r) = @_;
8258: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8259: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8260: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8261: $r->no_cache(1);
8262: $r->header_out("Expires" => $date);
8263: $r->header_out("Pragma" => "no-cache");
1.123 www 8264: }
8265:
8266: sub content_type {
1.181 albertel 8267: my ($r,$type,$charset) = @_;
1.299 foxr 8268: if ($r) {
8269: # Note that printout.pl calls this with undef for $r.
8270: &no_cache($r);
8271: }
1.258 albertel 8272: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8273: unless ($charset) {
8274: $charset=&Apache::lonlocal::current_encoding;
8275: }
8276: if ($charset) { $type.='; charset='.$charset; }
8277: if ($r) {
8278: $r->content_type($type);
8279: } else {
8280: print("Content-type: $type\n\n");
8281: }
1.9 albertel 8282: }
1.25 albertel 8283:
1.112 bowersj2 8284: =pod
8285:
1.648 raeburn 8286: =item * &add_to_env($name,$value)
1.112 bowersj2 8287:
1.258 albertel 8288: adds $name to the %env hash with value
1.112 bowersj2 8289: $value, if $name already exists, the entry is converted to an array
8290: reference and $value is added to the array.
8291:
8292: =cut
8293:
1.25 albertel 8294: sub add_to_env {
8295: my ($name,$value)=@_;
1.258 albertel 8296: if (defined($env{$name})) {
8297: if (ref($env{$name})) {
1.25 albertel 8298: #already have multiple values
1.258 albertel 8299: push(@{ $env{$name} },$value);
1.25 albertel 8300: } else {
8301: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8302: my $first=$env{$name};
8303: undef($env{$name});
8304: push(@{ $env{$name} },$first,$value);
1.25 albertel 8305: }
8306: } else {
1.258 albertel 8307: $env{$name}=$value;
1.25 albertel 8308: }
1.31 albertel 8309: }
1.149 albertel 8310:
8311: =pod
8312:
1.648 raeburn 8313: =item * &get_env_multiple($name)
1.149 albertel 8314:
1.258 albertel 8315: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8316: values may be defined and end up as an array ref.
8317:
8318: returns an array of values
8319:
8320: =cut
8321:
8322: sub get_env_multiple {
8323: my ($name) = @_;
8324: my @values;
1.258 albertel 8325: if (defined($env{$name})) {
1.149 albertel 8326: # exists is it an array
1.258 albertel 8327: if (ref($env{$name})) {
8328: @values=@{ $env{$name} };
1.149 albertel 8329: } else {
1.258 albertel 8330: $values[0]=$env{$name};
1.149 albertel 8331: }
8332: }
8333: return(@values);
8334: }
8335:
1.660 raeburn 8336: sub ask_for_embedded_content {
8337: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8338: my $upload_output = '
8339: <form name="upload_embedded" action="'.$actionurl.'"
8340: method="post" enctype="multipart/form-data">';
8341: $upload_output .= $state;
1.661 raeburn 8342: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8343:
8344: my $num = 0;
8345: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8346: $upload_output .= &start_data_table_row().
8347: '<td>'.$embed_file.'</td><td>';
8348: if ($args->{'ignore_remote_references'}
8349: && $embed_file =~ m{^\w+://}) {
8350: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8351: } elsif ($args->{'error_on_invalid_names'}
8352: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8353:
8354: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8355:
8356: } else {
8357: $upload_output .='
1.661 raeburn 8358: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8359: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8360: my $attrib = join(':',@{$$allfiles{$embed_file}});
8361: $upload_output .=
8362: "\n\t\t".
8363: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8364: $attrib.'" />';
8365: if (exists($$codebase{$embed_file})) {
8366: $upload_output .=
8367: "\n\t\t".
8368: '<input name="codebase_'.$num.'" type="hidden" value="'.
8369: &escape($$codebase{$embed_file}).'" />';
8370: }
8371: }
8372: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8373: $num++;
8374: }
8375: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8376: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8377: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8378: '.&mt('(only files for which a location has been provided will be uploaded)').'
8379: </form>';
8380: return $upload_output;
8381: }
8382:
1.661 raeburn 8383: sub upload_embedded {
8384: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8385: $current_disk_usage) = @_;
8386: my $output;
8387: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8388: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8389: my $orig_uploaded_filename =
8390: $env{'form.embedded_item_'.$i.'.filename'};
8391:
8392: $env{'form.embedded_orig_'.$i} =
8393: &unescape($env{'form.embedded_orig_'.$i});
8394: my ($path,$fname) =
8395: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8396: # no path, whole string is fname
8397: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8398:
8399: $path = $env{'form.currentpath'}.$path;
8400: $fname = &Apache::lonnet::clean_filename($fname);
8401: # See if there is anything left
8402: next if ($fname eq '');
8403:
8404: # Check if file already exists as a file or directory.
8405: my ($state,$msg);
8406: if ($context eq 'portfolio') {
8407: my $port_path = $dirpath;
8408: if ($group ne '') {
8409: $port_path = "groups/$group/$port_path";
8410: }
8411: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8412: $dir_root,$port_path,$disk_quota,
8413: $current_disk_usage,$uname,$udom);
8414: if ($state eq 'will_exceed_quota'
8415: || $state eq 'file_locked'
8416: || $state eq 'file_exists' ) {
8417: $output .= $msg;
8418: next;
8419: }
8420: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8421: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8422: if ($state eq 'exists') {
8423: $output .= $msg;
8424: next;
8425: }
8426: }
8427: # Check if extension is valid
8428: if (($fname =~ /\.(\w+)$/) &&
8429: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8430: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8431: next;
8432: } elsif (($fname =~ /\.(\w+)$/) &&
8433: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8434: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8435: next;
8436: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8437: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8438: next;
8439: }
8440:
8441: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8442: if ($context eq 'portfolio') {
8443: my $result=
8444: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8445: $dirpath.$path);
8446: if ($result !~ m|^/uploaded/|) {
8447: $output .= '<span class="LC_error">'
8448: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8449: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8450: .'</span><br />';
8451: next;
8452: } else {
8453: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8454: $path.$fname.'</span>').'</p>';
8455: }
8456: } else {
8457: # Save the file
8458: my $target = $env{'form.embedded_item_'.$i};
8459: my $fullpath = $dir_root.$dirpath.'/'.$path;
8460: my $dest = $fullpath.$fname;
8461: my $url = $url_root.$dirpath.'/'.$path.$fname;
8462: my @parts=split(/\//,$fullpath);
8463: my $count;
8464: my $filepath = $dir_root;
8465: for ($count=4;$count<=$#parts;$count++) {
8466: $filepath .= "/$parts[$count]";
8467: if ((-e $filepath)!=1) {
8468: mkdir($filepath,0770);
8469: }
8470: }
8471: my $fh;
8472: if (!open($fh,'>'.$dest)) {
8473: &Apache::lonnet::logthis('Failed to create '.$dest);
8474: $output .= '<span class="LC_error">'.
8475: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8476: '</span><br />';
8477: } else {
8478: if (!print $fh $env{'form.embedded_item_'.$i}) {
8479: &Apache::lonnet::logthis('Failed to write to '.$dest);
8480: $output .= '<span class="LC_error">'.
8481: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8482: '</span><br />';
8483: } else {
8484: if ($context eq 'testbank') {
8485: $output .= &mt('Embedded file uploaded successfully:').
8486: ' <a href="'.$url.'">'.
8487: $orig_uploaded_filename.'</a><br />';
8488: } else {
1.705 tempelho 8489: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8490: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8491: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8492: }
8493: }
8494: close($fh);
8495: }
8496: }
8497: }
8498: return $output;
8499: }
8500:
8501: sub check_for_existing {
8502: my ($path,$fname,$element) = @_;
8503: my ($state,$msg);
8504: if (-d $path.'/'.$fname) {
8505: $state = 'exists';
8506: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8507: } elsif (-e $path.'/'.$fname) {
8508: $state = 'exists';
8509: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8510: }
8511: if ($state eq 'exists') {
8512: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8513: }
8514: return ($state,$msg);
8515: }
8516:
8517: sub check_for_upload {
8518: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8519: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8520: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8521: my $getpropath = 1;
8522: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8523: $getpropath);
8524: my $found_file = 0;
8525: my $locked_file = 0;
8526: foreach my $line (@dir_list) {
8527: my ($file_name)=split(/\&/,$line,2);
8528: if ($file_name eq $fname){
8529: $file_name = $path.$file_name;
8530: if ($group ne '') {
8531: $file_name = $group.$file_name;
8532: }
8533: $found_file = 1;
8534: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8535: $locked_file = 1;
8536: }
8537: }
8538: }
8539: if (($current_disk_usage + $filesize) > $disk_quota){
8540: my $msg = '<span class="LC_error">'.
8541: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8542: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8543: return ('will_exceed_quota',$msg);
8544: } elsif ($found_file) {
8545: if ($locked_file) {
8546: my $msg = '<span class="LC_error">';
8547: $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>');
8548: $msg .= '</span><br />';
8549: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8550: return ('file_locked',$msg);
8551: } else {
8552: my $msg = '<span class="LC_error">';
8553: $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'});
8554: $msg .= '</span>';
8555: $msg .= '<br />';
8556: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8557: return ('file_exists',$msg);
8558: }
8559: }
8560: }
8561:
1.31 albertel 8562:
1.41 ng 8563: =pod
1.45 matthew 8564:
1.464 albertel 8565: =back
1.41 ng 8566:
1.112 bowersj2 8567: =head1 CSV Upload/Handling functions
1.38 albertel 8568:
1.41 ng 8569: =over 4
8570:
1.648 raeburn 8571: =item * &upfile_store($r)
1.41 ng 8572:
8573: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8574: needs $env{'form.upfile'}
1.41 ng 8575: returns $datatoken to be put into hidden field
8576:
8577: =cut
1.31 albertel 8578:
8579: sub upfile_store {
8580: my $r=shift;
1.258 albertel 8581: $env{'form.upfile'}=~s/\r/\n/gs;
8582: $env{'form.upfile'}=~s/\f/\n/gs;
8583: $env{'form.upfile'}=~s/\n+/\n/gs;
8584: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8585:
1.258 albertel 8586: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8587: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8588: {
1.158 raeburn 8589: my $datafile = $r->dir_config('lonDaemons').
8590: '/tmp/'.$datatoken.'.tmp';
8591: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8592: print $fh $env{'form.upfile'};
1.158 raeburn 8593: close($fh);
8594: }
1.31 albertel 8595: }
8596: return $datatoken;
8597: }
8598:
1.56 matthew 8599: =pod
8600:
1.648 raeburn 8601: =item * &load_tmp_file($r)
1.41 ng 8602:
8603: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8604: needs $env{'form.datatoken'},
8605: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8606:
8607: =cut
1.31 albertel 8608:
8609: sub load_tmp_file {
8610: my $r=shift;
8611: my @studentdata=();
8612: {
1.158 raeburn 8613: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8614: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8615: if ( open(my $fh,"<$studentfile") ) {
8616: @studentdata=<$fh>;
8617: close($fh);
8618: }
1.31 albertel 8619: }
1.258 albertel 8620: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8621: }
8622:
1.56 matthew 8623: =pod
8624:
1.648 raeburn 8625: =item * &upfile_record_sep()
1.41 ng 8626:
8627: Separate uploaded file into records
8628: returns array of records,
1.258 albertel 8629: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8630:
8631: =cut
1.31 albertel 8632:
8633: sub upfile_record_sep {
1.258 albertel 8634: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8635: } else {
1.248 albertel 8636: my @records;
1.258 albertel 8637: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8638: if ($line=~/^\s*$/) { next; }
8639: push(@records,$line);
8640: }
8641: return @records;
1.31 albertel 8642: }
8643: }
8644:
1.56 matthew 8645: =pod
8646:
1.648 raeburn 8647: =item * &record_sep($record)
1.41 ng 8648:
1.258 albertel 8649: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8650:
8651: =cut
8652:
1.263 www 8653: sub takeleft {
8654: my $index=shift;
8655: return substr('0000'.$index,-4,4);
8656: }
8657:
1.31 albertel 8658: sub record_sep {
8659: my $record=shift;
8660: my %components=();
1.258 albertel 8661: if ($env{'form.upfiletype'} eq 'xml') {
8662: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8663: my $i=0;
1.356 albertel 8664: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8665: $field=~s/^(\"|\')//;
8666: $field=~s/(\"|\')$//;
1.263 www 8667: $components{&takeleft($i)}=$field;
1.31 albertel 8668: $i++;
8669: }
1.258 albertel 8670: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8671: my $i=0;
1.356 albertel 8672: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8673: $field=~s/^(\"|\')//;
8674: $field=~s/(\"|\')$//;
1.263 www 8675: $components{&takeleft($i)}=$field;
1.31 albertel 8676: $i++;
8677: }
8678: } else {
1.561 www 8679: my $separator=',';
1.480 banghart 8680: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8681: $separator=';';
1.480 banghart 8682: }
1.31 albertel 8683: my $i=0;
1.561 www 8684: # the character we are looking for to indicate the end of a quote or a record
8685: my $looking_for=$separator;
8686: # do not add the characters to the fields
8687: my $ignore=0;
8688: # we just encountered a separator (or the beginning of the record)
8689: my $just_found_separator=1;
8690: # store the field we are working on here
8691: my $field='';
8692: # work our way through all characters in record
8693: foreach my $character ($record=~/(.)/g) {
8694: if ($character eq $looking_for) {
8695: if ($character ne $separator) {
8696: # Found the end of a quote, again looking for separator
8697: $looking_for=$separator;
8698: $ignore=1;
8699: } else {
8700: # Found a separator, store away what we got
8701: $components{&takeleft($i)}=$field;
8702: $i++;
8703: $just_found_separator=1;
8704: $ignore=0;
8705: $field='';
8706: }
8707: next;
8708: }
8709: # single or double quotation marks after a separator indicate beginning of a quote
8710: # we are now looking for the end of the quote and need to ignore separators
8711: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8712: $looking_for=$character;
8713: next;
8714: }
8715: # ignore would be true after we reached the end of a quote
8716: if ($ignore) { next; }
8717: if (($just_found_separator) && ($character=~/\s/)) { next; }
8718: $field.=$character;
8719: $just_found_separator=0;
1.31 albertel 8720: }
1.561 www 8721: # catch the very last entry, since we never encountered the separator
8722: $components{&takeleft($i)}=$field;
1.31 albertel 8723: }
8724: return %components;
8725: }
8726:
1.144 matthew 8727: ######################################################
8728: ######################################################
8729:
1.56 matthew 8730: =pod
8731:
1.648 raeburn 8732: =item * &upfile_select_html()
1.41 ng 8733:
1.144 matthew 8734: Return HTML code to select a file from the users machine and specify
8735: the file type.
1.41 ng 8736:
8737: =cut
8738:
1.144 matthew 8739: ######################################################
8740: ######################################################
1.31 albertel 8741: sub upfile_select_html {
1.144 matthew 8742: my %Types = (
8743: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8744: semisv => &mt('Semicolon separated values'),
1.144 matthew 8745: space => &mt('Space separated'),
8746: tab => &mt('Tabulator separated'),
8747: # xml => &mt('HTML/XML'),
8748: );
8749: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8750: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8751: foreach my $type (sort(keys(%Types))) {
8752: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8753: }
8754: $Str .= "</select>\n";
8755: return $Str;
1.31 albertel 8756: }
8757:
1.301 albertel 8758: sub get_samples {
8759: my ($records,$toget) = @_;
8760: my @samples=({});
8761: my $got=0;
8762: foreach my $rec (@$records) {
8763: my %temp = &record_sep($rec);
8764: if (! grep(/\S/, values(%temp))) { next; }
8765: if (%temp) {
8766: $samples[$got]=\%temp;
8767: $got++;
8768: if ($got == $toget) { last; }
8769: }
8770: }
8771: return \@samples;
8772: }
8773:
1.144 matthew 8774: ######################################################
8775: ######################################################
8776:
1.56 matthew 8777: =pod
8778:
1.648 raeburn 8779: =item * &csv_print_samples($r,$records)
1.41 ng 8780:
8781: Prints a table of sample values from each column uploaded $r is an
8782: Apache Request ref, $records is an arrayref from
8783: &Apache::loncommon::upfile_record_sep
8784:
8785: =cut
8786:
1.144 matthew 8787: ######################################################
8788: ######################################################
1.31 albertel 8789: sub csv_print_samples {
8790: my ($r,$records) = @_;
1.662 bisitz 8791: my $samples = &get_samples($records,5);
1.301 albertel 8792:
1.594 raeburn 8793: $r->print(&mt('Samples').'<br />'.&start_data_table().
8794: &start_data_table_header_row());
1.356 albertel 8795: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8796: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8797: $r->print(&end_data_table_header_row());
1.301 albertel 8798: foreach my $hash (@$samples) {
1.594 raeburn 8799: $r->print(&start_data_table_row());
1.356 albertel 8800: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8801: $r->print('<td>');
1.356 albertel 8802: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8803: $r->print('</td>');
8804: }
1.594 raeburn 8805: $r->print(&end_data_table_row());
1.31 albertel 8806: }
1.594 raeburn 8807: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8808: }
8809:
1.144 matthew 8810: ######################################################
8811: ######################################################
8812:
1.56 matthew 8813: =pod
8814:
1.648 raeburn 8815: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8816:
8817: Prints a table to create associations between values and table columns.
1.144 matthew 8818:
1.41 ng 8819: $r is an Apache Request ref,
8820: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8821: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8822:
8823: =cut
8824:
1.144 matthew 8825: ######################################################
8826: ######################################################
1.31 albertel 8827: sub csv_print_select_table {
8828: my ($r,$records,$d) = @_;
1.301 albertel 8829: my $i=0;
8830: my $samples = &get_samples($records,1);
1.144 matthew 8831: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8832: &start_data_table().&start_data_table_header_row().
1.144 matthew 8833: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8834: '<th>'.&mt('Column').'</th>'.
8835: &end_data_table_header_row()."\n");
1.356 albertel 8836: foreach my $array_ref (@$d) {
8837: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8838: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8839:
1.875 bisitz 8840: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8841: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8842: $r->print('<option value="none"></option>');
1.356 albertel 8843: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8844: $r->print('<option value="'.$sample.'"'.
8845: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8846: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8847: }
1.594 raeburn 8848: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8849: $i++;
8850: }
1.594 raeburn 8851: $r->print(&end_data_table());
1.31 albertel 8852: $i--;
8853: return $i;
8854: }
1.56 matthew 8855:
1.144 matthew 8856: ######################################################
8857: ######################################################
8858:
1.56 matthew 8859: =pod
1.31 albertel 8860:
1.648 raeburn 8861: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8862:
8863: Prints a table of sample values from the upload and can make associate samples to internal names.
8864:
8865: $r is an Apache Request ref,
8866: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8867: $d is an array of 2 element arrays (internal name, displayed name)
8868:
8869: =cut
8870:
1.144 matthew 8871: ######################################################
8872: ######################################################
1.31 albertel 8873: sub csv_samples_select_table {
8874: my ($r,$records,$d) = @_;
8875: my $i=0;
1.144 matthew 8876: #
1.662 bisitz 8877: my $max_samples = 5;
8878: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8879: $r->print(&start_data_table().
8880: &start_data_table_header_row().'<th>'.
8881: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8882: &end_data_table_header_row());
1.301 albertel 8883:
8884: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8885: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8886: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8887: foreach my $option (@$d) {
8888: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8889: $r->print('<option value="'.$value.'"'.
1.253 albertel 8890: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8891: $display.'</option>');
1.31 albertel 8892: }
8893: $r->print('</select></td><td>');
1.662 bisitz 8894: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8895: if (defined($samples->[$line]{$key})) {
8896: $r->print($samples->[$line]{$key}."<br />\n");
8897: }
8898: }
1.594 raeburn 8899: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8900: $i++;
8901: }
1.594 raeburn 8902: $r->print(&end_data_table());
1.31 albertel 8903: $i--;
8904: return($i);
1.115 matthew 8905: }
8906:
1.144 matthew 8907: ######################################################
8908: ######################################################
8909:
1.115 matthew 8910: =pod
8911:
1.648 raeburn 8912: =item * &clean_excel_name($name)
1.115 matthew 8913:
8914: Returns a replacement for $name which does not contain any illegal characters.
8915:
8916: =cut
8917:
1.144 matthew 8918: ######################################################
8919: ######################################################
1.115 matthew 8920: sub clean_excel_name {
8921: my ($name) = @_;
8922: $name =~ s/[:\*\?\/\\]//g;
8923: if (length($name) > 31) {
8924: $name = substr($name,0,31);
8925: }
8926: return $name;
1.25 albertel 8927: }
1.84 albertel 8928:
1.85 albertel 8929: =pod
8930:
1.648 raeburn 8931: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8932:
8933: Returns either 1 or undef
8934:
8935: 1 if the part is to be hidden, undef if it is to be shown
8936:
8937: Arguments are:
8938:
8939: $id the id of the part to be checked
8940: $symb, optional the symb of the resource to check
8941: $udom, optional the domain of the user to check for
8942: $uname, optional the username of the user to check for
8943:
8944: =cut
1.84 albertel 8945:
8946: sub check_if_partid_hidden {
8947: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8948: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8949: $symb,$udom,$uname);
1.141 albertel 8950: my $truth=1;
8951: #if the string starts with !, then the list is the list to show not hide
8952: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8953: my @hiddenlist=split(/,/,$hiddenparts);
8954: foreach my $checkid (@hiddenlist) {
1.141 albertel 8955: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8956: }
1.141 albertel 8957: return !$truth;
1.84 albertel 8958: }
1.127 matthew 8959:
1.138 matthew 8960:
8961: ############################################################
8962: ############################################################
8963:
8964: =pod
8965:
1.157 matthew 8966: =back
8967:
1.138 matthew 8968: =head1 cgi-bin script and graphing routines
8969:
1.157 matthew 8970: =over 4
8971:
1.648 raeburn 8972: =item * &get_cgi_id()
1.138 matthew 8973:
8974: Inputs: none
8975:
8976: Returns an id which can be used to pass environment variables
8977: to various cgi-bin scripts. These environment variables will
8978: be removed from the users environment after a given time by
8979: the routine &Apache::lonnet::transfer_profile_to_env.
8980:
8981: =cut
8982:
8983: ############################################################
8984: ############################################################
1.152 albertel 8985: my $uniq=0;
1.136 matthew 8986: sub get_cgi_id {
1.154 albertel 8987: $uniq=($uniq+1)%100000;
1.280 albertel 8988: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8989: }
8990:
1.127 matthew 8991: ############################################################
8992: ############################################################
8993:
8994: =pod
8995:
1.648 raeburn 8996: =item * &DrawBarGraph()
1.127 matthew 8997:
1.138 matthew 8998: Facilitates the plotting of data in a (stacked) bar graph.
8999: Puts plot definition data into the users environment in order for
9000: graph.png to plot it. Returns an <img> tag for the plot.
9001: The bars on the plot are labeled '1','2',...,'n'.
9002:
9003: Inputs:
9004:
9005: =over 4
9006:
9007: =item $Title: string, the title of the plot
9008:
9009: =item $xlabel: string, text describing the X-axis of the plot
9010:
9011: =item $ylabel: string, text describing the Y-axis of the plot
9012:
9013: =item $Max: scalar, the maximum Y value to use in the plot
9014: If $Max is < any data point, the graph will not be rendered.
9015:
1.140 matthew 9016: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9017: they are plotted. If undefined, default values will be used.
9018:
1.178 matthew 9019: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9020:
1.138 matthew 9021: =item @Values: An array of array references. Each array reference holds data
9022: to be plotted in a stacked bar chart.
9023:
1.239 matthew 9024: =item If the final element of @Values is a hash reference the key/value
9025: pairs will be added to the graph definition.
9026:
1.138 matthew 9027: =back
9028:
9029: Returns:
9030:
9031: An <img> tag which references graph.png and the appropriate identifying
9032: information for the plot.
9033:
1.127 matthew 9034: =cut
9035:
9036: ############################################################
9037: ############################################################
1.134 matthew 9038: sub DrawBarGraph {
1.178 matthew 9039: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9040: #
9041: if (! defined($colors)) {
9042: $colors = ['#33ff00',
9043: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9044: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9045: ];
9046: }
1.228 matthew 9047: my $extra_settings = {};
9048: if (ref($Values[-1]) eq 'HASH') {
9049: $extra_settings = pop(@Values);
9050: }
1.127 matthew 9051: #
1.136 matthew 9052: my $identifier = &get_cgi_id();
9053: my $id = 'cgi.'.$identifier;
1.129 matthew 9054: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9055: return '';
9056: }
1.225 matthew 9057: #
9058: my @Labels;
9059: if (defined($labels)) {
9060: @Labels = @$labels;
9061: } else {
9062: for (my $i=0;$i<@{$Values[0]};$i++) {
9063: push (@Labels,$i+1);
9064: }
9065: }
9066: #
1.129 matthew 9067: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9068: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9069: my %ValuesHash;
9070: my $NumSets=1;
9071: foreach my $array (@Values) {
9072: next if (! ref($array));
1.136 matthew 9073: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9074: join(',',@$array);
1.129 matthew 9075: }
1.127 matthew 9076: #
1.136 matthew 9077: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9078: if ($NumBars < 3) {
9079: $width = 120+$NumBars*32;
1.220 matthew 9080: $xskip = 1;
1.225 matthew 9081: $bar_width = 30;
9082: } elsif ($NumBars < 5) {
9083: $width = 120+$NumBars*20;
9084: $xskip = 1;
9085: $bar_width = 20;
1.220 matthew 9086: } elsif ($NumBars < 10) {
1.136 matthew 9087: $width = 120+$NumBars*15;
9088: $xskip = 1;
9089: $bar_width = 15;
9090: } elsif ($NumBars <= 25) {
9091: $width = 120+$NumBars*11;
9092: $xskip = 5;
9093: $bar_width = 8;
9094: } elsif ($NumBars <= 50) {
9095: $width = 120+$NumBars*8;
9096: $xskip = 5;
9097: $bar_width = 4;
9098: } else {
9099: $width = 120+$NumBars*8;
9100: $xskip = 5;
9101: $bar_width = 4;
9102: }
9103: #
1.137 matthew 9104: $Max = 1 if ($Max < 1);
9105: if ( int($Max) < $Max ) {
9106: $Max++;
9107: $Max = int($Max);
9108: }
1.127 matthew 9109: $Title = '' if (! defined($Title));
9110: $xlabel = '' if (! defined($xlabel));
9111: $ylabel = '' if (! defined($ylabel));
1.369 www 9112: $ValuesHash{$id.'.title'} = &escape($Title);
9113: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9114: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9115: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9116: $ValuesHash{$id.'.NumBars'} = $NumBars;
9117: $ValuesHash{$id.'.NumSets'} = $NumSets;
9118: $ValuesHash{$id.'.PlotType'} = 'bar';
9119: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9120: $ValuesHash{$id.'.height'} = $height;
9121: $ValuesHash{$id.'.width'} = $width;
9122: $ValuesHash{$id.'.xskip'} = $xskip;
9123: $ValuesHash{$id.'.bar_width'} = $bar_width;
9124: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9125: #
1.228 matthew 9126: # Deal with other parameters
9127: while (my ($key,$value) = each(%$extra_settings)) {
9128: $ValuesHash{$id.'.'.$key} = $value;
9129: }
9130: #
1.646 raeburn 9131: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9132: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9133: }
9134:
9135: ############################################################
9136: ############################################################
9137:
9138: =pod
9139:
1.648 raeburn 9140: =item * &DrawXYGraph()
1.137 matthew 9141:
1.138 matthew 9142: Facilitates the plotting of data in an XY graph.
9143: Puts plot definition data into the users environment in order for
9144: graph.png to plot it. Returns an <img> tag for the plot.
9145:
9146: Inputs:
9147:
9148: =over 4
9149:
9150: =item $Title: string, the title of the plot
9151:
9152: =item $xlabel: string, text describing the X-axis of the plot
9153:
9154: =item $ylabel: string, text describing the Y-axis of the plot
9155:
9156: =item $Max: scalar, the maximum Y value to use in the plot
9157: If $Max is < any data point, the graph will not be rendered.
9158:
9159: =item $colors: Array ref containing the hex color codes for the data to be
9160: plotted in. If undefined, default values will be used.
9161:
9162: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9163:
9164: =item $Ydata: Array ref containing Array refs.
1.185 www 9165: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9166:
9167: =item %Values: hash indicating or overriding any default values which are
9168: passed to graph.png.
9169: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9170:
9171: =back
9172:
9173: Returns:
9174:
9175: An <img> tag which references graph.png and the appropriate identifying
9176: information for the plot.
9177:
1.137 matthew 9178: =cut
9179:
9180: ############################################################
9181: ############################################################
9182: sub DrawXYGraph {
9183: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9184: #
9185: # Create the identifier for the graph
9186: my $identifier = &get_cgi_id();
9187: my $id = 'cgi.'.$identifier;
9188: #
9189: $Title = '' if (! defined($Title));
9190: $xlabel = '' if (! defined($xlabel));
9191: $ylabel = '' if (! defined($ylabel));
9192: my %ValuesHash =
9193: (
1.369 www 9194: $id.'.title' => &escape($Title),
9195: $id.'.xlabel' => &escape($xlabel),
9196: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9197: $id.'.y_max_value'=> $Max,
9198: $id.'.labels' => join(',',@$Xlabels),
9199: $id.'.PlotType' => 'XY',
9200: );
9201: #
9202: if (defined($colors) && ref($colors) eq 'ARRAY') {
9203: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9204: }
9205: #
9206: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9207: return '';
9208: }
9209: my $NumSets=1;
1.138 matthew 9210: foreach my $array (@{$Ydata}){
1.137 matthew 9211: next if (! ref($array));
9212: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9213: }
1.138 matthew 9214: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9215: #
9216: # Deal with other parameters
9217: while (my ($key,$value) = each(%Values)) {
9218: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9219: }
9220: #
1.646 raeburn 9221: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9222: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9223: }
9224:
9225: ############################################################
9226: ############################################################
9227:
9228: =pod
9229:
1.648 raeburn 9230: =item * &DrawXYYGraph()
1.138 matthew 9231:
9232: Facilitates the plotting of data in an XY graph with two Y axes.
9233: Puts plot definition data into the users environment in order for
9234: graph.png to plot it. Returns an <img> tag for the plot.
9235:
9236: Inputs:
9237:
9238: =over 4
9239:
9240: =item $Title: string, the title of the plot
9241:
9242: =item $xlabel: string, text describing the X-axis of the plot
9243:
9244: =item $ylabel: string, text describing the Y-axis of the plot
9245:
9246: =item $colors: Array ref containing the hex color codes for the data to be
9247: plotted in. If undefined, default values will be used.
9248:
9249: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9250:
9251: =item $Ydata1: The first data set
9252:
9253: =item $Min1: The minimum value of the left Y-axis
9254:
9255: =item $Max1: The maximum value of the left Y-axis
9256:
9257: =item $Ydata2: The second data set
9258:
9259: =item $Min2: The minimum value of the right Y-axis
9260:
9261: =item $Max2: The maximum value of the left Y-axis
9262:
9263: =item %Values: hash indicating or overriding any default values which are
9264: passed to graph.png.
9265: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9266:
9267: =back
9268:
9269: Returns:
9270:
9271: An <img> tag which references graph.png and the appropriate identifying
9272: information for the plot.
1.136 matthew 9273:
9274: =cut
9275:
9276: ############################################################
9277: ############################################################
1.137 matthew 9278: sub DrawXYYGraph {
9279: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9280: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9281: #
9282: # Create the identifier for the graph
9283: my $identifier = &get_cgi_id();
9284: my $id = 'cgi.'.$identifier;
9285: #
9286: $Title = '' if (! defined($Title));
9287: $xlabel = '' if (! defined($xlabel));
9288: $ylabel = '' if (! defined($ylabel));
9289: my %ValuesHash =
9290: (
1.369 www 9291: $id.'.title' => &escape($Title),
9292: $id.'.xlabel' => &escape($xlabel),
9293: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9294: $id.'.labels' => join(',',@$Xlabels),
9295: $id.'.PlotType' => 'XY',
9296: $id.'.NumSets' => 2,
1.137 matthew 9297: $id.'.two_axes' => 1,
9298: $id.'.y1_max_value' => $Max1,
9299: $id.'.y1_min_value' => $Min1,
9300: $id.'.y2_max_value' => $Max2,
9301: $id.'.y2_min_value' => $Min2,
1.136 matthew 9302: );
9303: #
1.137 matthew 9304: if (defined($colors) && ref($colors) eq 'ARRAY') {
9305: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9306: }
9307: #
9308: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9309: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9310: return '';
9311: }
9312: my $NumSets=1;
1.137 matthew 9313: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9314: next if (! ref($array));
9315: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9316: }
9317: #
9318: # Deal with other parameters
9319: while (my ($key,$value) = each(%Values)) {
9320: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9321: }
9322: #
1.646 raeburn 9323: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9324: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9325: }
9326:
9327: ############################################################
9328: ############################################################
9329:
9330: =pod
9331:
1.157 matthew 9332: =back
9333:
1.139 matthew 9334: =head1 Statistics helper routines?
9335:
9336: Bad place for them but what the hell.
9337:
1.157 matthew 9338: =over 4
9339:
1.648 raeburn 9340: =item * &chartlink()
1.139 matthew 9341:
9342: Returns a link to the chart for a specific student.
9343:
9344: Inputs:
9345:
9346: =over 4
9347:
9348: =item $linktext: The text of the link
9349:
9350: =item $sname: The students username
9351:
9352: =item $sdomain: The students domain
9353:
9354: =back
9355:
1.157 matthew 9356: =back
9357:
1.139 matthew 9358: =cut
9359:
9360: ############################################################
9361: ############################################################
9362: sub chartlink {
9363: my ($linktext, $sname, $sdomain) = @_;
9364: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9365: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9366: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9367: '">'.$linktext.'</a>';
1.153 matthew 9368: }
9369:
9370: #######################################################
9371: #######################################################
9372:
9373: =pod
9374:
9375: =head1 Course Environment Routines
1.157 matthew 9376:
9377: =over 4
1.153 matthew 9378:
1.648 raeburn 9379: =item * &restore_course_settings()
1.153 matthew 9380:
1.648 raeburn 9381: =item * &store_course_settings()
1.153 matthew 9382:
9383: Restores/Store indicated form parameters from the course environment.
9384: Will not overwrite existing values of the form parameters.
9385:
9386: Inputs:
9387: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9388:
9389: a hash ref describing the data to be stored. For example:
9390:
9391: %Save_Parameters = ('Status' => 'scalar',
9392: 'chartoutputmode' => 'scalar',
9393: 'chartoutputdata' => 'scalar',
9394: 'Section' => 'array',
1.373 raeburn 9395: 'Group' => 'array',
1.153 matthew 9396: 'StudentData' => 'array',
9397: 'Maps' => 'array');
9398:
9399: Returns: both routines return nothing
9400:
1.631 raeburn 9401: =back
9402:
1.153 matthew 9403: =cut
9404:
9405: #######################################################
9406: #######################################################
9407: sub store_course_settings {
1.496 albertel 9408: return &store_settings($env{'request.course.id'},@_);
9409: }
9410:
9411: sub store_settings {
1.153 matthew 9412: # save to the environment
9413: # appenv the same items, just to be safe
1.300 albertel 9414: my $udom = $env{'user.domain'};
9415: my $uname = $env{'user.name'};
1.496 albertel 9416: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9417: my %SaveHash;
9418: my %AppHash;
9419: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9420: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9421: my $envname = 'environment.'.$basename;
1.258 albertel 9422: if (exists($env{'form.'.$setting})) {
1.153 matthew 9423: # Save this value away
9424: if ($type eq 'scalar' &&
1.258 albertel 9425: (! exists($env{$envname}) ||
9426: $env{$envname} ne $env{'form.'.$setting})) {
9427: $SaveHash{$basename} = $env{'form.'.$setting};
9428: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9429: } elsif ($type eq 'array') {
9430: my $stored_form;
1.258 albertel 9431: if (ref($env{'form.'.$setting})) {
1.153 matthew 9432: $stored_form = join(',',
9433: map {
1.369 www 9434: &escape($_);
1.258 albertel 9435: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9436: } else {
9437: $stored_form =
1.369 www 9438: &escape($env{'form.'.$setting});
1.153 matthew 9439: }
9440: # Determine if the array contents are the same.
1.258 albertel 9441: if ($stored_form ne $env{$envname}) {
1.153 matthew 9442: $SaveHash{$basename} = $stored_form;
9443: $AppHash{$envname} = $stored_form;
9444: }
9445: }
9446: }
9447: }
9448: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9449: $udom,$uname);
1.153 matthew 9450: if ($put_result !~ /^(ok|delayed)/) {
9451: &Apache::lonnet::logthis('unable to save form parameters, '.
9452: 'got error:'.$put_result);
9453: }
9454: # Make sure these settings stick around in this session, too
1.646 raeburn 9455: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9456: return;
9457: }
9458:
9459: sub restore_course_settings {
1.499 albertel 9460: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9461: }
9462:
9463: sub restore_settings {
9464: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9465: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9466: next if (exists($env{'form.'.$setting}));
1.496 albertel 9467: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9468: '.'.$setting;
1.258 albertel 9469: if (exists($env{$envname})) {
1.153 matthew 9470: if ($type eq 'scalar') {
1.258 albertel 9471: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9472: } elsif ($type eq 'array') {
1.258 albertel 9473: $env{'form.'.$setting} = [
1.153 matthew 9474: map {
1.369 www 9475: &unescape($_);
1.258 albertel 9476: } split(',',$env{$envname})
1.153 matthew 9477: ];
9478: }
9479: }
9480: }
1.127 matthew 9481: }
9482:
1.618 raeburn 9483: #######################################################
9484: #######################################################
9485:
9486: =pod
9487:
9488: =head1 Domain E-mail Routines
9489:
9490: =over 4
9491:
1.648 raeburn 9492: =item * &build_recipient_list()
1.618 raeburn 9493:
1.884 raeburn 9494: Build recipient lists for five types of e-mail:
1.766 raeburn 9495: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9496: (d) Help requests, (e) Course requests needing approval, generated by
9497: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9498: loncoursequeueadmin.pm respectively.
1.618 raeburn 9499:
9500: Inputs:
1.619 raeburn 9501: defmail (scalar - email address of default recipient),
1.618 raeburn 9502: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9503: defdom (domain for which to retrieve configuration settings),
9504: origmail (scalar - email address of recipient from loncapa.conf,
9505: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9506:
1.655 raeburn 9507: Returns: comma separated list of addresses to which to send e-mail.
9508:
9509: =back
1.618 raeburn 9510:
9511: =cut
9512:
9513: ############################################################
9514: ############################################################
9515: sub build_recipient_list {
1.619 raeburn 9516: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9517: my @recipients;
9518: my $otheremails;
9519: my %domconfig =
9520: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9521: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9522: if (exists($domconfig{'contacts'}{$mailing})) {
9523: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9524: my @contacts = ('adminemail','supportemail');
9525: foreach my $item (@contacts) {
9526: if ($domconfig{'contacts'}{$mailing}{$item}) {
9527: my $addr = $domconfig{'contacts'}{$item};
9528: if (!grep(/^\Q$addr\E$/,@recipients)) {
9529: push(@recipients,$addr);
9530: }
1.619 raeburn 9531: }
1.766 raeburn 9532: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9533: }
9534: }
1.766 raeburn 9535: } elsif ($origmail ne '') {
9536: push(@recipients,$origmail);
1.618 raeburn 9537: }
1.619 raeburn 9538: } elsif ($origmail ne '') {
9539: push(@recipients,$origmail);
1.618 raeburn 9540: }
1.688 raeburn 9541: if (defined($defmail)) {
9542: if ($defmail ne '') {
9543: push(@recipients,$defmail);
9544: }
1.618 raeburn 9545: }
9546: if ($otheremails) {
1.619 raeburn 9547: my @others;
9548: if ($otheremails =~ /,/) {
9549: @others = split(/,/,$otheremails);
1.618 raeburn 9550: } else {
1.619 raeburn 9551: push(@others,$otheremails);
9552: }
9553: foreach my $addr (@others) {
9554: if (!grep(/^\Q$addr\E$/,@recipients)) {
9555: push(@recipients,$addr);
9556: }
1.618 raeburn 9557: }
9558: }
1.619 raeburn 9559: my $recipientlist = join(',',@recipients);
1.618 raeburn 9560: return $recipientlist;
9561: }
9562:
1.127 matthew 9563: ############################################################
9564: ############################################################
1.154 albertel 9565:
1.655 raeburn 9566: =pod
9567:
9568: =head1 Course Catalog Routines
9569:
9570: =over 4
9571:
9572: =item * &gather_categories()
9573:
9574: Converts category definitions - keys of categories hash stored in
9575: coursecategories in configuration.db on the primary library server in a
9576: domain - to an array. Also generates javascript and idx hash used to
9577: generate Domain Coordinator interface for editing Course Categories.
9578:
9579: Inputs:
1.663 raeburn 9580:
1.655 raeburn 9581: categories (reference to hash of category definitions).
1.663 raeburn 9582:
1.655 raeburn 9583: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9584: categories and subcategories).
1.663 raeburn 9585:
1.655 raeburn 9586: idx (reference to hash of counters used in Domain Coordinator interface for
9587: editing Course Categories).
1.663 raeburn 9588:
1.655 raeburn 9589: jsarray (reference to array of categories used to create Javascript arrays for
9590: Domain Coordinator interface for editing Course Categories).
9591:
9592: Returns: nothing
9593:
9594: Side effects: populates cats, idx and jsarray.
9595:
9596: =cut
9597:
9598: sub gather_categories {
9599: my ($categories,$cats,$idx,$jsarray) = @_;
9600: my %counters;
9601: my $num = 0;
9602: foreach my $item (keys(%{$categories})) {
9603: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9604: if ($container eq '' && $depth == 0) {
9605: $cats->[$depth][$categories->{$item}] = $cat;
9606: } else {
9607: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9608: }
9609: my ($escitem,$tail) = split(/:/,$item,2);
9610: if ($counters{$tail} eq '') {
9611: $counters{$tail} = $num;
9612: $num ++;
9613: }
9614: if (ref($idx) eq 'HASH') {
9615: $idx->{$item} = $counters{$tail};
9616: }
9617: if (ref($jsarray) eq 'ARRAY') {
9618: push(@{$jsarray->[$counters{$tail}]},$item);
9619: }
9620: }
9621: return;
9622: }
9623:
9624: =pod
9625:
9626: =item * &extract_categories()
9627:
9628: Used to generate breadcrumb trails for course categories.
9629:
9630: Inputs:
1.663 raeburn 9631:
1.655 raeburn 9632: categories (reference to hash of category definitions).
1.663 raeburn 9633:
1.655 raeburn 9634: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9635: categories and subcategories).
1.663 raeburn 9636:
1.655 raeburn 9637: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9638:
1.655 raeburn 9639: allitems (reference to hash - key is category key
9640: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9641:
1.655 raeburn 9642: idx (reference to hash of counters used in Domain Coordinator interface for
9643: editing Course Categories).
1.663 raeburn 9644:
1.655 raeburn 9645: jsarray (reference to array of categories used to create Javascript arrays for
9646: Domain Coordinator interface for editing Course Categories).
9647:
1.665 raeburn 9648: subcats (reference to hash of arrays containing all subcategories within each
9649: category, -recursive)
9650:
1.655 raeburn 9651: Returns: nothing
9652:
9653: Side effects: populates trails and allitems hash references.
9654:
9655: =cut
9656:
9657: sub extract_categories {
1.665 raeburn 9658: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9659: if (ref($categories) eq 'HASH') {
9660: &gather_categories($categories,$cats,$idx,$jsarray);
9661: if (ref($cats->[0]) eq 'ARRAY') {
9662: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9663: my $name = $cats->[0][$i];
9664: my $item = &escape($name).'::0';
9665: my $trailstr;
9666: if ($name eq 'instcode') {
9667: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9668: } elsif ($name eq 'communities') {
9669: $trailstr = &mt('Communities');
1.655 raeburn 9670: } else {
9671: $trailstr = $name;
9672: }
9673: if ($allitems->{$item} eq '') {
9674: push(@{$trails},$trailstr);
9675: $allitems->{$item} = scalar(@{$trails})-1;
9676: }
9677: my @parents = ($name);
9678: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9679: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9680: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9681: if (ref($subcats) eq 'HASH') {
9682: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9683: }
9684: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9685: }
9686: } else {
9687: if (ref($subcats) eq 'HASH') {
9688: $subcats->{$item} = [];
1.655 raeburn 9689: }
9690: }
9691: }
9692: }
9693: }
9694: return;
9695: }
9696:
9697: =pod
9698:
9699: =item *&recurse_categories()
9700:
9701: Recursively used to generate breadcrumb trails for course categories.
9702:
9703: Inputs:
1.663 raeburn 9704:
1.655 raeburn 9705: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9706: categories and subcategories).
1.663 raeburn 9707:
1.655 raeburn 9708: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9709:
9710: category (current course category, for which breadcrumb trail is being generated).
9711:
9712: trails (reference to array of breadcrumb trails for each category).
9713:
1.655 raeburn 9714: allitems (reference to hash - key is category key
9715: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9716:
1.655 raeburn 9717: parents (array containing containers directories for current category,
9718: back to top level).
9719:
9720: Returns: nothing
9721:
9722: Side effects: populates trails and allitems hash references
9723:
9724: =cut
9725:
9726: sub recurse_categories {
1.665 raeburn 9727: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9728: my $shallower = $depth - 1;
9729: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9730: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9731: my $name = $cats->[$depth]{$category}[$k];
9732: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9733: my $trailstr = join(' -> ',(@{$parents},$category));
9734: if ($allitems->{$item} eq '') {
9735: push(@{$trails},$trailstr);
9736: $allitems->{$item} = scalar(@{$trails})-1;
9737: }
9738: my $deeper = $depth+1;
9739: push(@{$parents},$category);
1.665 raeburn 9740: if (ref($subcats) eq 'HASH') {
9741: my $subcat = &escape($name).':'.$category.':'.$depth;
9742: for (my $j=@{$parents}; $j>=0; $j--) {
9743: my $higher;
9744: if ($j > 0) {
9745: $higher = &escape($parents->[$j]).':'.
9746: &escape($parents->[$j-1]).':'.$j;
9747: } else {
9748: $higher = &escape($parents->[$j]).'::'.$j;
9749: }
9750: push(@{$subcats->{$higher}},$subcat);
9751: }
9752: }
9753: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9754: $subcats);
1.655 raeburn 9755: pop(@{$parents});
9756: }
9757: } else {
9758: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9759: my $trailstr = join(' -> ',(@{$parents},$category));
9760: if ($allitems->{$item} eq '') {
9761: push(@{$trails},$trailstr);
9762: $allitems->{$item} = scalar(@{$trails})-1;
9763: }
9764: }
9765: return;
9766: }
9767:
1.663 raeburn 9768: =pod
9769:
9770: =item *&assign_categories_table()
9771:
9772: Create a datatable for display of hierarchical categories in a domain,
9773: with checkboxes to allow a course to be categorized.
9774:
9775: Inputs:
9776:
9777: cathash - reference to hash of categories defined for the domain (from
9778: configuration.db)
9779:
9780: currcat - scalar with an & separated list of categories assigned to a course.
9781:
1.919 raeburn 9782: type - scalar contains course type (Course or Community).
9783:
1.663 raeburn 9784: Returns: $output (markup to be displayed)
9785:
9786: =cut
9787:
9788: sub assign_categories_table {
1.919 raeburn 9789: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9790: my $output;
9791: if (ref($cathash) eq 'HASH') {
9792: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9793: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9794: $maxdepth = scalar(@cats);
9795: if (@cats > 0) {
9796: my $itemcount = 0;
9797: if (ref($cats[0]) eq 'ARRAY') {
9798: my @currcategories;
9799: if ($currcat ne '') {
9800: @currcategories = split('&',$currcat);
9801: }
1.919 raeburn 9802: my $table;
1.663 raeburn 9803: for (my $i=0; $i<@{$cats[0]}; $i++) {
9804: my $parent = $cats[0][$i];
1.919 raeburn 9805: next if ($parent eq 'instcode');
9806: if ($type eq 'Community') {
9807: next unless ($parent eq 'communities');
9808: } else {
9809: next if ($parent eq 'communities');
9810: }
1.663 raeburn 9811: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9812: my $item = &escape($parent).'::0';
9813: my $checked = '';
9814: if (@currcategories > 0) {
9815: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9816: $checked = ' checked="checked"';
1.663 raeburn 9817: }
9818: }
1.919 raeburn 9819: my $parent_title = $parent;
9820: if ($parent eq 'communities') {
9821: $parent_title = &mt('Communities');
9822: }
9823: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9824: '<input type="checkbox" name="usecategory" value="'.
9825: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9826: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9827: my $depth = 1;
9828: push(@path,$parent);
1.919 raeburn 9829: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9830: pop(@path);
1.919 raeburn 9831: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9832: $itemcount ++;
9833: }
1.919 raeburn 9834: if ($itemcount) {
9835: $output = &Apache::loncommon::start_data_table().
9836: $table.
9837: &Apache::loncommon::end_data_table();
9838: }
1.663 raeburn 9839: }
9840: }
9841: }
9842: return $output;
9843: }
9844:
9845: =pod
9846:
9847: =item *&assign_category_rows()
9848:
9849: Create a datatable row for display of nested categories in a domain,
9850: with checkboxes to allow a course to be categorized,called recursively.
9851:
9852: Inputs:
9853:
9854: itemcount - track row number for alternating colors
9855:
9856: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9857: categories and subcategories.
9858:
9859: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9860:
9861: parent - parent of current category item
9862:
9863: path - Array containing all categories back up through the hierarchy from the
9864: current category to the top level.
9865:
9866: currcategories - reference to array of current categories assigned to the course
9867:
9868: Returns: $output (markup to be displayed).
9869:
9870: =cut
9871:
9872: sub assign_category_rows {
9873: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9874: my ($text,$name,$item,$chgstr);
9875: if (ref($cats) eq 'ARRAY') {
9876: my $maxdepth = scalar(@{$cats});
9877: if (ref($cats->[$depth]) eq 'HASH') {
9878: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9879: my $numchildren = @{$cats->[$depth]{$parent}};
9880: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9881: $text .= '<td><table class="LC_datatable">';
9882: for (my $j=0; $j<$numchildren; $j++) {
9883: $name = $cats->[$depth]{$parent}[$j];
9884: $item = &escape($name).':'.&escape($parent).':'.$depth;
9885: my $deeper = $depth+1;
9886: my $checked = '';
9887: if (ref($currcategories) eq 'ARRAY') {
9888: if (@{$currcategories} > 0) {
9889: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9890: $checked = ' checked="checked"';
1.663 raeburn 9891: }
9892: }
9893: }
1.664 raeburn 9894: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9895: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9896: $item.'"'.$checked.' />'.$name.'</label></span>'.
9897: '<input type="hidden" name="catname" value="'.$name.'" />'.
9898: '</td><td>';
1.663 raeburn 9899: if (ref($path) eq 'ARRAY') {
9900: push(@{$path},$name);
9901: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9902: pop(@{$path});
9903: }
9904: $text .= '</td></tr>';
9905: }
9906: $text .= '</table></td>';
9907: }
9908: }
9909: }
9910: return $text;
9911: }
9912:
1.655 raeburn 9913: ############################################################
9914: ############################################################
9915:
9916:
1.443 albertel 9917: sub commit_customrole {
1.664 raeburn 9918: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9919: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9920: ($start?', '.&mt('starting').' '.localtime($start):'').
9921: ($end?', ending '.localtime($end):'').': <b>'.
9922: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9923: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9924: '</b><br />';
9925: return $output;
9926: }
9927:
9928: sub commit_standardrole {
1.541 raeburn 9929: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9930: my ($output,$logmsg,$linefeed);
9931: if ($context eq 'auto') {
9932: $linefeed = "\n";
9933: } else {
9934: $linefeed = "<br />\n";
9935: }
1.443 albertel 9936: if ($three eq 'st') {
1.541 raeburn 9937: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9938: $one,$two,$sec,$context);
9939: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9940: ($result eq 'unknown_course') || ($result eq 'refused')) {
9941: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9942: } else {
1.541 raeburn 9943: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9944: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9945: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9946: if ($context eq 'auto') {
9947: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9948: } else {
9949: $output .= '<b>'.$result.'</b>'.$linefeed.
9950: &mt('Add to classlist').': <b>ok</b>';
9951: }
9952: $output .= $linefeed;
1.443 albertel 9953: }
9954: } else {
9955: $output = &mt('Assigning').' '.$three.' in '.$url.
9956: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9957: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9958: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9959: if ($context eq 'auto') {
9960: $output .= $result.$linefeed;
9961: } else {
9962: $output .= '<b>'.$result.'</b>'.$linefeed;
9963: }
1.443 albertel 9964: }
9965: return $output;
9966: }
9967:
9968: sub commit_studentrole {
1.541 raeburn 9969: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9970: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9971: if ($context eq 'auto') {
9972: $linefeed = "\n";
9973: } else {
9974: $linefeed = '<br />'."\n";
9975: }
1.443 albertel 9976: if (defined($one) && defined($two)) {
9977: my $cid=$one.'_'.$two;
9978: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9979: my $secchange = 0;
9980: my $expire_role_result;
9981: my $modify_section_result;
1.628 raeburn 9982: if ($oldsec ne '-1') {
9983: if ($oldsec ne $sec) {
1.443 albertel 9984: $secchange = 1;
1.628 raeburn 9985: my $now = time;
1.443 albertel 9986: my $uurl='/'.$cid;
9987: $uurl=~s/\_/\//g;
9988: if ($oldsec) {
9989: $uurl.='/'.$oldsec;
9990: }
1.626 raeburn 9991: $oldsecurl = $uurl;
1.628 raeburn 9992: $expire_role_result =
1.652 raeburn 9993: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9994: if ($env{'request.course.sec'} ne '') {
9995: if ($expire_role_result eq 'refused') {
9996: my @roles = ('st');
9997: my @statuses = ('previous');
9998: my @roledoms = ($one);
9999: my $withsec = 1;
10000: my %roleshash =
10001: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10002: \@statuses,\@roles,\@roledoms,$withsec);
10003: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10004: my ($oldstart,$oldend) =
10005: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10006: if ($oldend > 0 && $oldend <= $now) {
10007: $expire_role_result = 'ok';
10008: }
10009: }
10010: }
10011: }
1.443 albertel 10012: $result = $expire_role_result;
10013: }
10014: }
10015: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10016: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10017: if ($modify_section_result =~ /^ok/) {
10018: if ($secchange == 1) {
1.628 raeburn 10019: if ($sec eq '') {
10020: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10021: } else {
10022: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10023: }
1.443 albertel 10024: } elsif ($oldsec eq '-1') {
1.628 raeburn 10025: if ($sec eq '') {
10026: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10027: } else {
10028: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10029: }
1.443 albertel 10030: } else {
1.628 raeburn 10031: if ($sec eq '') {
10032: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10033: } else {
10034: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10035: }
1.443 albertel 10036: }
10037: } else {
1.628 raeburn 10038: if ($secchange) {
10039: $$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;
10040: } else {
10041: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10042: }
1.443 albertel 10043: }
10044: $result = $modify_section_result;
10045: } elsif ($secchange == 1) {
1.628 raeburn 10046: if ($oldsec eq '') {
10047: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10048: } else {
10049: $$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;
10050: }
1.626 raeburn 10051: if ($expire_role_result eq 'refused') {
10052: my $newsecurl = '/'.$cid;
10053: $newsecurl =~ s/\_/\//g;
10054: if ($sec ne '') {
10055: $newsecurl.='/'.$sec;
10056: }
10057: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10058: if ($sec eq '') {
10059: $$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;
10060: } else {
10061: $$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;
10062: }
10063: }
10064: }
1.443 albertel 10065: }
10066: } else {
1.626 raeburn 10067: $$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 10068: $result = "error: incomplete course id\n";
10069: }
10070: return $result;
10071: }
10072:
10073: ############################################################
10074: ############################################################
10075:
1.566 albertel 10076: sub check_clone {
1.578 raeburn 10077: my ($args,$linefeed) = @_;
1.566 albertel 10078: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10079: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10080: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10081: my $clonemsg;
10082: my $can_clone = 0;
1.944 raeburn 10083: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10084: if ($lctype ne 'community') {
10085: $lctype = 'course';
10086: }
1.566 albertel 10087: if ($clonehome eq 'no_host') {
1.944 raeburn 10088: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10089: $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'});
10090: } else {
10091: $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'});
10092: }
1.566 albertel 10093: } else {
10094: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10095: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10096: if ($clonedesc{'type'} ne 'Community') {
10097: $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'});
10098: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10099: }
10100: }
1.882 raeburn 10101: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10102: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10103: $can_clone = 1;
10104: } else {
10105: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10106: $args->{'clonedomain'},$args->{'clonecourse'});
10107: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10108: if (grep(/^\*$/,@cloners)) {
10109: $can_clone = 1;
10110: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10111: $can_clone = 1;
10112: } else {
1.908 raeburn 10113: my $ccrole = 'cc';
1.944 raeburn 10114: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10115: $ccrole = 'co';
10116: }
1.578 raeburn 10117: my %roleshash =
10118: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10119: $args->{'ccdomain'},
1.908 raeburn 10120: 'userroles',['active'],[$ccrole],
1.578 raeburn 10121: [$args->{'clonedomain'}]);
1.908 raeburn 10122: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10123: $can_clone = 1;
10124: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10125: $can_clone = 1;
10126: } else {
1.944 raeburn 10127: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10128: $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'});
10129: } else {
10130: $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'});
10131: }
1.578 raeburn 10132: }
1.566 albertel 10133: }
1.578 raeburn 10134: }
1.566 albertel 10135: }
10136: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10137: }
10138:
1.444 albertel 10139: sub construct_course {
1.885 raeburn 10140: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10141: my $outcome;
1.541 raeburn 10142: my $linefeed = '<br />'."\n";
10143: if ($context eq 'auto') {
10144: $linefeed = "\n";
10145: }
1.566 albertel 10146:
10147: #
10148: # Are we cloning?
10149: #
10150: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10151: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10152: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10153: if ($context ne 'auto') {
1.578 raeburn 10154: if ($clonemsg ne '') {
10155: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10156: }
1.566 albertel 10157: }
10158: $outcome .= $clonemsg.$linefeed;
10159:
10160: if (!$can_clone) {
10161: return (0,$outcome);
10162: }
10163: }
10164:
1.444 albertel 10165: #
10166: # Open course
10167: #
10168: my $crstype = lc($args->{'crstype'});
10169: my %cenv=();
10170: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10171: $args->{'cdescr'},
10172: $args->{'curl'},
10173: $args->{'course_home'},
10174: $args->{'nonstandard'},
10175: $args->{'crscode'},
10176: $args->{'ccuname'}.':'.
10177: $args->{'ccdomain'},
1.882 raeburn 10178: $args->{'crstype'},
1.885 raeburn 10179: $cnum,$context,$category);
1.444 albertel 10180:
10181: # Note: The testing routines depend on this being output; see
10182: # Utils::Course. This needs to at least be output as a comment
10183: # if anyone ever decides to not show this, and Utils::Course::new
10184: # will need to be suitably modified.
1.541 raeburn 10185: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10186: if ($$courseid =~ /^error:/) {
10187: return (0,$outcome);
10188: }
10189:
1.444 albertel 10190: #
10191: # Check if created correctly
10192: #
1.479 albertel 10193: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10194: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10195: if ($crsuhome eq 'no_host') {
10196: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10197: return (0,$outcome);
10198: }
1.541 raeburn 10199: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10200:
1.444 albertel 10201: #
1.566 albertel 10202: # Do the cloning
10203: #
10204: if ($can_clone && $cloneid) {
10205: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10206: if ($context ne 'auto') {
10207: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10208: }
10209: $outcome .= $clonemsg.$linefeed;
10210: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10211: # Copy all files
1.637 www 10212: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10213: # Restore URL
1.566 albertel 10214: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10215: # Restore title
1.566 albertel 10216: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10217: # Mark as cloned
1.566 albertel 10218: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10219: # Need to clone grading mode
10220: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10221: $cenv{'grading'}=$newenv{'grading'};
10222: # Do not clone these environment entries
10223: &Apache::lonnet::del('environment',
10224: ['default_enrollment_start_date',
10225: 'default_enrollment_end_date',
10226: 'question.email',
10227: 'policy.email',
10228: 'comment.email',
10229: 'pch.users.denied',
1.725 raeburn 10230: 'plc.users.denied',
10231: 'hidefromcat',
10232: 'categories'],
1.638 www 10233: $$crsudom,$$crsunum);
1.444 albertel 10234: }
1.566 albertel 10235:
1.444 albertel 10236: #
10237: # Set environment (will override cloned, if existing)
10238: #
10239: my @sections = ();
10240: my @xlists = ();
10241: if ($args->{'crstype'}) {
10242: $cenv{'type'}=$args->{'crstype'};
10243: }
10244: if ($args->{'crsid'}) {
10245: $cenv{'courseid'}=$args->{'crsid'};
10246: }
10247: if ($args->{'crscode'}) {
10248: $cenv{'internal.coursecode'}=$args->{'crscode'};
10249: }
10250: if ($args->{'crsquota'} ne '') {
10251: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10252: } else {
10253: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10254: }
10255: if ($args->{'ccuname'}) {
10256: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10257: ':'.$args->{'ccdomain'};
10258: } else {
10259: $cenv{'internal.courseowner'} = $args->{'curruser'};
10260: }
10261: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10262: if ($args->{'crssections'}) {
10263: $cenv{'internal.sectionnums'} = '';
10264: if ($args->{'crssections'} =~ m/,/) {
10265: @sections = split/,/,$args->{'crssections'};
10266: } else {
10267: $sections[0] = $args->{'crssections'};
10268: }
10269: if (@sections > 0) {
10270: foreach my $item (@sections) {
10271: my ($sec,$gp) = split/:/,$item;
10272: my $class = $args->{'crscode'}.$sec;
10273: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10274: $cenv{'internal.sectionnums'} .= $item.',';
10275: unless ($addcheck eq 'ok') {
10276: push @badclasses, $class;
10277: }
10278: }
10279: $cenv{'internal.sectionnums'} =~ s/,$//;
10280: }
10281: }
10282: # do not hide course coordinator from staff listing,
10283: # even if privileged
10284: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10285: # add crosslistings
10286: if ($args->{'crsxlist'}) {
10287: $cenv{'internal.crosslistings'}='';
10288: if ($args->{'crsxlist'} =~ m/,/) {
10289: @xlists = split/,/,$args->{'crsxlist'};
10290: } else {
10291: $xlists[0] = $args->{'crsxlist'};
10292: }
10293: if (@xlists > 0) {
10294: foreach my $item (@xlists) {
10295: my ($xl,$gp) = split/:/,$item;
10296: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10297: $cenv{'internal.crosslistings'} .= $item.',';
10298: unless ($addcheck eq 'ok') {
10299: push @badclasses, $xl;
10300: }
10301: }
10302: $cenv{'internal.crosslistings'} =~ s/,$//;
10303: }
10304: }
10305: if ($args->{'autoadds'}) {
10306: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10307: }
10308: if ($args->{'autodrops'}) {
10309: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10310: }
10311: # check for notification of enrollment changes
10312: my @notified = ();
10313: if ($args->{'notify_owner'}) {
10314: if ($args->{'ccuname'} ne '') {
10315: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10316: }
10317: }
10318: if ($args->{'notify_dc'}) {
10319: if ($uname ne '') {
1.630 raeburn 10320: push(@notified,$uname.':'.$udom);
1.444 albertel 10321: }
10322: }
10323: if (@notified > 0) {
10324: my $notifylist;
10325: if (@notified > 1) {
10326: $notifylist = join(',',@notified);
10327: } else {
10328: $notifylist = $notified[0];
10329: }
10330: $cenv{'internal.notifylist'} = $notifylist;
10331: }
10332: if (@badclasses > 0) {
10333: my %lt=&Apache::lonlocal::texthash(
10334: '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',
10335: 'dnhr' => 'does not have rights to access enrollment in these classes',
10336: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10337: );
1.541 raeburn 10338: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10339: ' ('.$lt{'adby'}.')';
10340: if ($context eq 'auto') {
10341: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10342: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10343: foreach my $item (@badclasses) {
10344: if ($context eq 'auto') {
10345: $outcome .= " - $item\n";
10346: } else {
10347: $outcome .= "<li>$item</li>\n";
10348: }
10349: }
10350: if ($context eq 'auto') {
10351: $outcome .= $linefeed;
10352: } else {
1.566 albertel 10353: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10354: }
10355: }
1.444 albertel 10356: }
10357: if ($args->{'no_end_date'}) {
10358: $args->{'endaccess'} = 0;
10359: }
10360: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10361: $cenv{'internal.autoend'}=$args->{'enrollend'};
10362: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10363: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10364: if ($args->{'showphotos'}) {
10365: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10366: }
10367: $cenv{'internal.authtype'} = $args->{'authtype'};
10368: $cenv{'internal.autharg'} = $args->{'autharg'};
10369: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10370: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10371: 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');
10372: if ($context eq 'auto') {
10373: $outcome .= $krb_msg;
10374: } else {
1.566 albertel 10375: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10376: }
10377: $outcome .= $linefeed;
1.444 albertel 10378: }
10379: }
10380: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10381: if ($args->{'setpolicy'}) {
10382: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10383: }
10384: if ($args->{'setcontent'}) {
10385: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10386: }
10387: }
10388: if ($args->{'reshome'}) {
10389: $cenv{'reshome'}=$args->{'reshome'}.'/';
10390: $cenv{'reshome'}=~s/\/+$/\//;
10391: }
10392: #
10393: # course has keyed access
10394: #
10395: if ($args->{'setkeys'}) {
10396: $cenv{'keyaccess'}='yes';
10397: }
10398: # if specified, key authority is not course, but user
10399: # only active if keyaccess is yes
10400: if ($args->{'keyauth'}) {
1.487 albertel 10401: my ($user,$domain) = split(':',$args->{'keyauth'});
10402: $user = &LONCAPA::clean_username($user);
10403: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10404: if ($user ne '' && $domain ne '') {
1.487 albertel 10405: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10406: }
10407: }
10408:
10409: if ($args->{'disresdis'}) {
10410: $cenv{'pch.roles.denied'}='st';
10411: }
10412: if ($args->{'disablechat'}) {
10413: $cenv{'plc.roles.denied'}='st';
10414: }
10415:
10416: # Record we've not yet viewed the Course Initialization Helper for this
10417: # course
10418: $cenv{'course.helper.not.run'} = 1;
10419: #
10420: # Use new Randomseed
10421: #
10422: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10423: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10424: #
10425: # The encryption code and receipt prefix for this course
10426: #
10427: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10428: $cenv{'internal.encpref'}=100+int(9*rand(99));
10429: #
10430: # By default, use standard grading
10431: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10432:
1.541 raeburn 10433: $outcome .= $linefeed.&mt('Setting environment').': '.
10434: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10435: #
10436: # Open all assignments
10437: #
10438: if ($args->{'openall'}) {
10439: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10440: my %storecontent = ($storeunder => time,
10441: $storeunder.'.type' => 'date_start');
10442:
10443: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10444: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10445: }
10446: #
10447: # Set first page
10448: #
10449: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10450: || ($cloneid)) {
1.445 albertel 10451: use LONCAPA::map;
1.444 albertel 10452: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10453:
10454: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10455: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10456:
1.444 albertel 10457: $outcome .= ($fatal?$errtext:'read ok').' - ';
10458: my $title; my $url;
10459: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10460: $title=&mt('Syllabus');
1.444 albertel 10461: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10462: } else {
1.690 bisitz 10463: $title=&mt('Navigate Contents');
1.444 albertel 10464: $url='/adm/navmaps';
10465: }
1.445 albertel 10466:
10467: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10468: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10469:
10470: if ($errtext) { $fatal=2; }
1.541 raeburn 10471: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10472: }
1.566 albertel 10473:
10474: return (1,$outcome);
1.444 albertel 10475: }
10476:
10477: ############################################################
10478: ############################################################
10479:
1.378 raeburn 10480: sub course_type {
10481: my ($cid) = @_;
10482: if (!defined($cid)) {
10483: $cid = $env{'request.course.id'};
10484: }
1.404 albertel 10485: if (defined($env{'course.'.$cid.'.type'})) {
10486: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10487: } else {
10488: return 'Course';
1.377 raeburn 10489: }
10490: }
1.156 albertel 10491:
1.406 raeburn 10492: sub group_term {
10493: my $crstype = &course_type();
10494: my %names = (
10495: 'Course' => 'group',
1.865 raeburn 10496: 'Community' => 'group',
1.406 raeburn 10497: );
10498: return $names{$crstype};
10499: }
10500:
1.902 raeburn 10501: sub course_types {
10502: my @types = ('official','unofficial','community');
10503: my %typename = (
10504: official => 'Official course',
10505: unofficial => 'Unofficial course',
10506: community => 'Community',
10507: );
10508: return (\@types,\%typename);
10509: }
10510:
1.156 albertel 10511: sub icon {
10512: my ($file)=@_;
1.505 albertel 10513: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10514: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10515: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10516: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10517: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10518: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10519: $curfext.".gif") {
10520: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10521: $curfext.".gif";
10522: }
10523: }
1.249 albertel 10524: return &lonhttpdurl($iconname);
1.154 albertel 10525: }
1.84 albertel 10526:
1.575 albertel 10527: sub lonhttpdurl {
1.692 www 10528: #
10529: # Had been used for "small fry" static images on separate port 8080.
10530: # Modify here if lightweight http functionality desired again.
10531: # Currently eliminated due to increasing firewall issues.
10532: #
1.575 albertel 10533: my ($url)=@_;
1.692 www 10534: return $url;
1.215 albertel 10535: }
10536:
1.213 albertel 10537: sub connection_aborted {
10538: my ($r)=@_;
10539: $r->print(" ");$r->rflush();
10540: my $c = $r->connection;
10541: return $c->aborted();
10542: }
10543:
1.221 foxr 10544: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10545: # strings as 'strings'.
10546: sub escape_single {
1.221 foxr 10547: my ($input) = @_;
1.223 albertel 10548: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10549: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10550: return $input;
10551: }
1.223 albertel 10552:
1.222 foxr 10553: # Same as escape_single, but escape's "'s This
10554: # can be used for "strings"
10555: sub escape_double {
10556: my ($input) = @_;
10557: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10558: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10559: return $input;
10560: }
1.223 albertel 10561:
1.222 foxr 10562: # Escapes the last element of a full URL.
10563: sub escape_url {
10564: my ($url) = @_;
1.238 raeburn 10565: my @urlslices = split(/\//, $url,-1);
1.369 www 10566: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10567: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10568: }
1.462 albertel 10569:
1.820 raeburn 10570: sub compare_arrays {
10571: my ($arrayref1,$arrayref2) = @_;
10572: my (@difference,%count);
10573: @difference = ();
10574: %count = ();
10575: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10576: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10577: foreach my $element (keys(%count)) {
10578: if ($count{$element} == 1) {
10579: push(@difference,$element);
10580: }
10581: }
10582: }
10583: return @difference;
10584: }
10585:
1.817 bisitz 10586: # -------------------------------------------------------- Initialize user login
1.462 albertel 10587: sub init_user_environment {
1.463 albertel 10588: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10589: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10590:
10591: my $public=($username eq 'public' && $domain eq 'public');
10592:
10593: # See if old ID present, if so, remove
10594:
10595: my ($filename,$cookie,$userroles);
10596: my $now=time;
10597:
10598: if ($public) {
10599: my $max_public=100;
10600: my $oldest;
10601: my $oldest_time=0;
10602: for(my $next=1;$next<=$max_public;$next++) {
10603: if (-e $lonids."/publicuser_$next.id") {
10604: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10605: if ($mtime<$oldest_time || !$oldest_time) {
10606: $oldest_time=$mtime;
10607: $oldest=$next;
10608: }
10609: } else {
10610: $cookie="publicuser_$next";
10611: last;
10612: }
10613: }
10614: if (!$cookie) { $cookie="publicuser_$oldest"; }
10615: } else {
1.463 albertel 10616: # if this isn't a robot, kill any existing non-robot sessions
10617: if (!$args->{'robot'}) {
10618: opendir(DIR,$lonids);
10619: while ($filename=readdir(DIR)) {
10620: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10621: unlink($lonids.'/'.$filename);
10622: }
1.462 albertel 10623: }
1.463 albertel 10624: closedir(DIR);
1.462 albertel 10625: }
10626: # Give them a new cookie
1.463 albertel 10627: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10628: : $now.$$.int(rand(10000)));
1.463 albertel 10629: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10630:
10631: # Initialize roles
10632:
10633: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10634: }
10635: # ------------------------------------ Check browser type and MathML capability
10636:
10637: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10638: $clientunicode,$clientos) = &decode_user_agent($r);
10639:
10640: # ------------------------------------------------------------- Get environment
10641:
10642: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10643: my ($tmp) = keys(%userenv);
10644: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10645: } else {
10646: undef(%userenv);
10647: }
10648: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10649: $form->{'interface'}=$userenv{'interface'};
10650: }
10651: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10652:
10653: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10654: foreach my $option ('interface','localpath','localres') {
10655: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10656: }
10657: # --------------------------------------------------------- Write first profile
10658:
10659: {
10660: my %initial_env =
10661: ("user.name" => $username,
10662: "user.domain" => $domain,
10663: "user.home" => $authhost,
10664: "browser.type" => $clientbrowser,
10665: "browser.version" => $clientversion,
10666: "browser.mathml" => $clientmathml,
10667: "browser.unicode" => $clientunicode,
10668: "browser.os" => $clientos,
10669: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10670: "request.course.fn" => '',
10671: "request.course.uri" => '',
10672: "request.course.sec" => '',
10673: "request.role" => 'cm',
10674: "request.role.adv" => $env{'user.adv'},
10675: "request.host" => $ENV{'REMOTE_ADDR'},);
10676:
10677: if ($form->{'localpath'}) {
10678: $initial_env{"browser.localpath"} = $form->{'localpath'};
10679: $initial_env{"browser.localres"} = $form->{'localres'};
10680: }
10681:
10682: if ($form->{'interface'}) {
10683: $form->{'interface'}=~s/\W//gs;
10684: $initial_env{"browser.interface"} = $form->{'interface'};
10685: $env{'browser.interface'}=$form->{'interface'};
10686: }
10687:
1.724 raeburn 10688: foreach my $tool ('aboutme','blog','portfolio') {
10689: $userenv{'availabletools.'.$tool} =
10690: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10691: }
10692:
1.864 raeburn 10693: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10694: $userenv{'canrequest.'.$crstype} =
10695: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10696: 'reload','requestcourses');
10697: }
10698:
1.462 albertel 10699: $env{'user.environment'} = "$lonids/$cookie.id";
10700:
10701: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10702: &GDBM_WRCREAT(),0640)) {
10703: &_add_to_env(\%disk_env,\%initial_env);
10704: &_add_to_env(\%disk_env,\%userenv,'environment.');
10705: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10706: if (ref($args->{'extra_env'})) {
10707: &_add_to_env(\%disk_env,$args->{'extra_env'});
10708: }
1.462 albertel 10709: untie(%disk_env);
10710: } else {
1.705 tempelho 10711: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10712: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10713: return 'error: '.$!;
10714: }
10715: }
10716: $env{'request.role'}='cm';
10717: $env{'request.role.adv'}=$env{'user.adv'};
10718: $env{'browser.type'}=$clientbrowser;
10719:
10720: return $cookie;
10721:
10722: }
10723:
10724: sub _add_to_env {
10725: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10726: if (ref($env_data) eq 'HASH') {
10727: while (my ($key,$value) = each(%$env_data)) {
10728: $idf->{$prefix.$key} = $value;
10729: $env{$prefix.$key} = $value;
10730: }
1.462 albertel 10731: }
10732: }
10733:
1.685 tempelho 10734: # --- Get the symbolic name of a problem and the url
10735: sub get_symb {
10736: my ($request,$silent) = @_;
1.726 raeburn 10737: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10738: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10739: if ($symb eq '') {
10740: if (!$silent) {
10741: $request->print("Unable to handle ambiguous references:$url:.");
10742: return ();
10743: }
10744: }
10745: &Apache::lonenc::check_decrypt(\$symb);
10746: return ($symb);
10747: }
10748:
10749: # --------------------------------------------------------------Get annotation
10750:
10751: sub get_annotation {
10752: my ($symb,$enc) = @_;
10753:
10754: my $key = $symb;
10755: if (!$enc) {
10756: $key =
10757: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10758: }
10759: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10760: return $annotation{$key};
10761: }
10762:
10763: sub clean_symb {
1.731 raeburn 10764: my ($symb,$delete_enc) = @_;
1.685 tempelho 10765:
10766: &Apache::lonenc::check_decrypt(\$symb);
10767: my $enc = $env{'request.enc'};
1.731 raeburn 10768: if ($delete_enc) {
1.730 raeburn 10769: delete($env{'request.enc'});
10770: }
1.685 tempelho 10771:
10772: return ($symb,$enc);
10773: }
1.462 albertel 10774:
1.41 ng 10775: =pod
10776:
10777: =back
10778:
1.112 bowersj2 10779: =cut
1.41 ng 10780:
1.112 bowersj2 10781: 1;
10782: __END__;
1.41 ng 10783:
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