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