Annotation of loncom/interface/loncommon.pm, revision 1.692.4.31
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.692.4.31! raeburn 4: # $Id: loncommon.pm,v 1.692.4.30 2010/02/25 15:52:23 raeburn 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.46 matthew 274: "<font color=yellow>INFO: Read file types</font>");
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.692.4.2 raeburn 409: <script type="text/javascript" language="Javascript">
1.692.4.4 raeburn 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.692.4.2 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.692.4.2 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.692.4.4 raeburn 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.692.4.2 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.692.4.2 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.692.4.2 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";
465: <script type="text/javascript">
1.692.4.4 raeburn 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: }
1.692.4.4 raeburn 478: // ]]>
1.653 raeburn 479: </script>
480: ENDAUTHORBRW
481: }
482:
1.91 www 483: sub coursebrowser_javascript {
1.692.4.22 raeburn 484: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
485: my $wintitle = 'Course_Browser';
486: if ($crstype eq 'Community') {
487: $wintitle = 'Community_Browser';
488: }
1.692.4.9 raeburn 489: my $id_functions = &javascript_index_functions();
490: my $output = '
1.692.4.2 raeburn 491: <script type="text/javascript" language="JavaScript">
1.692.4.4 raeburn 492: // <![CDATA[
1.468 raeburn 493: var stdeditbrowser;'."\n";
1.692.4.9 raeburn 494:
495: $output .= <<"ENDSTDBRW";
1.692.4.22 raeburn 496: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 497: var url = '/adm/pickcourse?';
1.692.4.18 raeburn 498: var formid = getFormIdByName(formname);
1.692.4.9 raeburn 499: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 500: if (domainfilter != null) {
501: if (domainfilter != '') {
502: url += 'domainfilter='+domainfilter+'&';
503: }
504: }
1.91 www 505: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 506: '&cdomelement='+udom+
507: '&cnameelement='+desc;
1.468 raeburn 508: if (extra_element !=null && extra_element != '') {
1.594 raeburn 509: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 510: url += '&roleelement='+extra_element;
511: if (domainfilter == null || domainfilter == '') {
512: url += '&domainfilter='+extra_element;
513: }
1.234 raeburn 514: }
1.468 raeburn 515: else {
516: if (formname == 'portform') {
517: url += '&setroles='+extra_element;
1.692.4.25 raeburn 518: } else {
519: if (formname == 'rules') {
520: url += '&fixeddom='+extra_element;
521: }
1.468 raeburn 522: }
523: }
1.230 raeburn 524: }
1.692.4.22 raeburn 525: if (type != null && type != '') {
526: url += '&type='+type;
527: }
528: if (type_elem != null && type_elem != '') {
529: url += '&typeelement='+type_elem;
530: }
1.692.4.7 raeburn 531: if (formname == 'ccrs') {
532: var ownername = document.forms[formid].ccuname.value;
533: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
534: url += '&cloner='+ownername+':'+ownerdom;
535: }
1.293 raeburn 536: if (multflag !=null && multflag != '') {
537: url += '&multiple='+multflag;
538: }
1.692.4.22 raeburn 539: var title = '$wintitle';
1.91 www 540: var options = 'scrollbars=1,resizable=1,menubar=0';
541: options += ',width=700,height=600';
542: stdeditbrowser = open(url,title,options,'1');
543: stdeditbrowser.focus();
544: }
1.692.4.9 raeburn 545: $id_functions
1.91 www 546: ENDSTDBRW
1.692.4.21 raeburn 547: if (($sec_element ne '') || ($role_element ne '')) {
548: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.468 raeburn 549: }
550: $output .= '
1.692.4.4 raeburn 551: // ]]>
1.468 raeburn 552: </script>';
553: return $output;
554: }
555:
1.692.4.9 raeburn 556: sub javascript_index_functions {
557: return <<"ENDJS";
558:
559: function getFormIdByName(formname) {
560: for (var i=0;i<document.forms.length;i++) {
561: if (document.forms[i].name == formname) {
562: return i;
563: }
564: }
565: return -1;
566: }
567:
568: function getIndexByName(formid,item) {
569: for (var i=0;i<document.forms[formid].elements.length;i++) {
570: if (document.forms[formid].elements[i].name == item) {
571: return i;
572: }
573: }
574: return -1;
575: }
576:
577: function getDomainFromSelectbox(formname,udom) {
578: var userdom;
579: var formid = getFormIdByName(formname);
580: if (formid > -1) {
581: var domid = getIndexByName(formid,udom);
582: if (domid > -1) {
583: if (document.forms[formid].elements[domid].type == 'select-one') {
584: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
585: }
586: if (document.forms[formid].elements[domid].type == 'hidden') {
587: userdom=document.forms[formid].elements[domid].value;
588: }
589: }
590: }
591: return userdom;
592: }
593:
594: ENDJS
595:
596: }
597:
598: sub userbrowser_javascript {
599: my $id_functions = &javascript_index_functions();
600: return <<"ENDUSERBRW";
601:
1.692.4.17 raeburn 602: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.692.4.9 raeburn 603: var url = '/adm/pickuser?';
604: var userdom = getDomainFromSelectbox(formname,udom);
605: if (userdom != null) {
606: if (userdom != '') {
607: url += 'srchdom='+userdom+'&';
608: }
609: }
610: url += 'form=' + formname + '&unameelement='+uname+
611: '&udomelement='+udom+
612: '&ulastelement='+ulast+
613: '&ufirstelement='+ufirst+
614: '&uemailelement='+uemail+
615: '&hideudomelement='+hideudom+
616: '&coursedom='+crsdom;
1.692.4.17 raeburn 617: if ((caller != null) && (caller != undefined)) {
618: url += '&caller='+caller;
619: }
1.692.4.9 raeburn 620: var title = 'User_Browser';
621: var options = 'scrollbars=1,resizable=1,menubar=0';
622: options += ',width=700,height=600';
623: var stdeditbrowser = open(url,title,options,'1');
624: stdeditbrowser.focus();
625: }
626:
1.692.4.17 raeburn 627: function fix_domain (formname,udom,origdom,uname) {
1.692.4.9 raeburn 628: var formid = getFormIdByName(formname);
629: if (formid > -1) {
1.692.4.17 raeburn 630: var unameid = getIndexByName(formid,uname);
1.692.4.9 raeburn 631: var domid = getIndexByName(formid,udom);
632: var hidedomid = getIndexByName(formid,origdom);
633: if (hidedomid > -1) {
634: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.692.4.17 raeburn 635: var unameval = document.forms[formid].elements[unameid].value;
636: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
637: if (domid > -1) {
638: var slct = document.forms[formid].elements[domid];
639: if (slct.type == 'select-one') {
640: var i;
641: for (i=0;i<slct.length;i++) {
642: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
643: }
644: }
645: if (slct.type == 'hidden') {
646: slct.value = fixeddom;
1.692.4.9 raeburn 647: }
648: }
649: }
650: }
651: }
652: return;
653: }
654:
655: $id_functions
656: ENDUSERBRW
657: }
658:
659:
1.468 raeburn 660: sub setsec_javascript {
1.692.4.21 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.692.4.21 raeburn 716:
717: function setRole(crstype) {
718: |;
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: }
1.468 raeburn 754: |;
1.692.4.21 raeburn 755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.692.4.22 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.692.4.6 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
765: $linktext = &mt('Select Community');
1.692.4.22 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
768: $type = '';
1.692.4.6 raeburn 769: }
1.692.4.2 raeburn 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.692.4.22 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.692.4.6 raeburn 775: ."'>".$linktext.'</a>'
1.692.4.2 raeburn 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.692.4.9 raeburn 785: sub selectuser_link {
786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.692.4.17 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.692.4.9 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.692.4.17 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.692.4.9 raeburn 790: ');">'.$linktext.'</a>';
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.692.4.1 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.692.4.2 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.692.4.2 raeburn 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.692.4.4 raeburn 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.692.4.4 raeburn 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);
1.552 banghart 1101: if ($env{'browser.interface'} eq 'textual') {
1.79 www 1102: $stayOnPage=1;
1103: }
1.44 bowersj2 1104: $width = 350 if (not defined $width);
1105: $height = 400 if (not defined $height);
1106: my $filename = $topic;
1107: $filename =~ s/ /_/g;
1108:
1.48 bowersj2 1109: my $template = "";
1110: my $link;
1.572 banghart 1111:
1.159 www 1112: $topic=~s/\W/\_/g;
1.44 bowersj2 1113:
1.572 banghart 1114: if (!$stayOnPage) {
1.72 bowersj2 1115: $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 1116: } else {
1.48 bowersj2 1117: $link = "/adm/help/${filename}.hlp";
1118: }
1119:
1120: # Add the text
1.572 banghart 1121: if ($text ne "") {
1.77 www 1122: $template .=
1.572 banghart 1123: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.691 bisitz 1124: "<td bgcolor='#5555FF'><span class=\"LC_nobreak\"><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 1125: }
1126:
1127: # Add the graphic
1.179 matthew 1128: my $title = &mt('Online Help');
1.667 raeburn 1129: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.692.4.2 raeburn 1130: $template .= '<a target="_top" href="'.$link.'" title="'.$title.'">'.
1131: '<img src="'.$helpicon.'" border="0" alt="'.&mt('Help: [_1]',$topic).
1132: '" title="'.$title.'" /></a>';
1133: if ($text ne '') {
1134: $template.='</span></td></tr></table>';
1135: }
1.44 bowersj2 1136: return $template;
1137:
1.106 bowersj2 1138: }
1139:
1140: # This is a quicky function for Latex cheatsheet editing, since it
1141: # appears in at least four places
1142: sub helpLatexCheatsheet {
1.692.4.2 raeburn 1143: my ($topic,$text,$not_author) = @_;
1144: my $out;
1.106 bowersj2 1145: my $addOther = '';
1.692.4.3 raeburn 1146: if ($topic) {
1.692.4.2 raeburn 1147: $addOther = &Apache::loncommon::help_open_topic($topic,$text,
1.106 bowersj2 1148: undef, undef, 600) .
1149: '</td><td>';
1150: }
1.692.4.2 raeburn 1151: $out = '<table><tr><td>'.
1152: $addOther .
1153: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1154: undef,undef,600).
1155: '</td><td>'.
1156: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1157: undef,undef,600).
1158: '</td>';
1159: unless ($not_author) {
1160: $out .= '<td>'.
1161: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
1162: undef,undef,600).
1163: '</td>';
1164: }
1165: $out .= '</tr></table>';
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.692.4.22 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.692.4.4 raeburn 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.692.4.4 raeburn 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.572 banghart 1208: if ($env{'browser.interface'} eq 'textual' ||
1209: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1210: $stayOnPage=1;
1.430 albertel 1211: }
1212: my $output;
1213: if ($component_help) {
1214: if (!$text) {
1215: $output=&help_open_topic($component_help,undef,$stayOnPage,
1216: $width,$height);
1217: } else {
1218: my $help_text;
1219: $help_text=&unescape($topic);
1220: $output='<table><tr><td>'.
1221: &help_open_topic($component_help,$help_text,$stayOnPage,
1222: $width,$height).'</td></tr></table>';
1223: }
1224: }
1225: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1226: return $output.$banner_link;
1227: }
1228:
1229: sub top_nav_help {
1230: my ($text) = @_;
1.436 albertel 1231: $text = &mt($text);
1.572 banghart 1232: my $stay_on_page =
1.436 albertel 1233: ($env{'browser.interface'} eq 'textual' ||
1234: $env{'environment.remote'} eq 'off' );
1.572 banghart 1235: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1236: : "javascript:helpMenu('open')";
1.572 banghart 1237: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1238:
1.201 raeburn 1239: my $title = &mt('Get help');
1.436 albertel 1240:
1241: return <<"END";
1242: $banner_link
1243: <a href="$link" title="$title">$text</a>
1244: END
1245: }
1246:
1247: sub help_menu_js {
1248: my ($text) = @_;
1249:
1250: my $stayOnPage =
1251: ($env{'browser.interface'} eq 'textual' ||
1252: $env{'environment.remote'} eq 'off' );
1253:
1254: my $width = 620;
1255: my $height = 600;
1.430 albertel 1256: my $helptopic=&general_help();
1257: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1258: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1259: my $start_page =
1260: &Apache::loncommon::start_page('Help Menu', undef,
1261: {'frameset' => 1,
1262: 'js_ready' => 1,
1263: 'add_entries' => {
1264: 'border' => '0',
1.579 raeburn 1265: 'rows' => "110,*",},});
1.331 albertel 1266: my $end_page =
1267: &Apache::loncommon::end_page({'frameset' => 1,
1268: 'js_ready' => 1,});
1269:
1.436 albertel 1270: my $template .= <<"ENDTEMPLATE";
1271: <script type="text/javascript">
1.253 albertel 1272: // <![CDATA[
1.692.4.10 raeburn 1273: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1274: var banner_link = '';
1.243 raeburn 1275: function helpMenu(target) {
1276: var caller = this;
1277: if (target == 'open') {
1278: var newWindow = null;
1279: try {
1.262 albertel 1280: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1281: }
1282: catch(error) {
1283: writeHelp(caller);
1284: return;
1285: }
1286: if (newWindow) {
1287: caller = newWindow;
1288: }
1.193 raeburn 1289: }
1.243 raeburn 1290: writeHelp(caller);
1291: return;
1292: }
1293: function writeHelp(caller) {
1.430 albertel 1294: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1295: caller.document.close()
1296: caller.focus()
1.193 raeburn 1297: }
1.219 albertel 1298: // END LON-CAPA Internal -->
1.692.4.10 raeburn 1299: // ]]>
1.436 albertel 1300: </script>
1.193 raeburn 1301: ENDTEMPLATE
1302: return $template;
1303: }
1304:
1.172 www 1305: sub help_open_bug {
1306: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1307: unless ($env{'user.adv'}) { return ''; }
1.172 www 1308: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1309: $text = "" if (not defined $text);
1310: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1311: if ($env{'browser.interface'} eq 'textual' ||
1312: $env{'environment.remote'} eq 'off' ) {
1.172 www 1313: $stayOnPage=1;
1314: }
1.184 albertel 1315: $width = 600 if (not defined $width);
1316: $height = 600 if (not defined $height);
1.172 www 1317:
1318: $topic=~s/\W+/\+/g;
1319: my $link='';
1320: my $template='';
1.379 albertel 1321: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1322: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1323: if (!$stayOnPage)
1324: {
1325: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1326: }
1327: else
1328: {
1329: $link = $url;
1330: }
1331: # Add the text
1332: if ($text ne "")
1333: {
1334: $template .=
1335: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 1336: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 1337: }
1338:
1339: # Add the graphic
1.179 matthew 1340: my $title = &mt('Report a Bug');
1.215 albertel 1341: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1342: $template .= <<"ENDTEMPLATE";
1.436 albertel 1343: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1344: ENDTEMPLATE
1345: if ($text ne '') { $template.='</td></tr></table>' };
1346: return $template;
1347:
1348: }
1349:
1350: sub help_open_faq {
1351: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1352: unless ($env{'user.adv'}) { return ''; }
1.172 www 1353: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1354: $text = "" if (not defined $text);
1355: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1356: if ($env{'browser.interface'} eq 'textual' ||
1357: $env{'environment.remote'} eq 'off' ) {
1.172 www 1358: $stayOnPage=1;
1359: }
1360: $width = 350 if (not defined $width);
1361: $height = 400 if (not defined $height);
1362:
1363: $topic=~s/\W+/\+/g;
1364: my $link='';
1365: my $template='';
1366: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1367: if (!$stayOnPage)
1368: {
1369: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1370: }
1371: else
1372: {
1373: $link = $url;
1374: }
1375:
1376: # Add the text
1377: if ($text ne "")
1378: {
1379: $template .=
1.173 www 1380: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 1381: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 1382: }
1383:
1384: # Add the graphic
1.179 matthew 1385: my $title = &mt('View the FAQ');
1.215 albertel 1386: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1387: $template .= <<"ENDTEMPLATE";
1.436 albertel 1388: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1389: ENDTEMPLATE
1390: if ($text ne '') { $template.='</td></tr></table>' };
1391: return $template;
1392:
1.44 bowersj2 1393: }
1.37 matthew 1394:
1.180 matthew 1395: ###############################################################
1396: ###############################################################
1397:
1.45 matthew 1398: =pod
1399:
1.648 raeburn 1400: =item * &change_content_javascript():
1.256 matthew 1401:
1402: This and the next function allow you to create small sections of an
1403: otherwise static HTML page that you can update on the fly with
1404: Javascript, even in Netscape 4.
1405:
1406: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1407: must be written to the HTML page once. It will prove the Javascript
1408: function "change(name, content)". Calling the change function with the
1409: name of the section
1410: you want to update, matching the name passed to C<changable_area>, and
1411: the new content you want to put in there, will put the content into
1412: that area.
1413:
1414: B<Note>: Netscape 4 only reserves enough space for the changable area
1415: to contain room for the original contents. You need to "make space"
1416: for whatever changes you wish to make, and be B<sure> to check your
1417: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1418: it's adequate for updating a one-line status display, but little more.
1419: This script will set the space to 100% width, so you only need to
1420: worry about height in Netscape 4.
1421:
1422: Modern browsers are much less limiting, and if you can commit to the
1423: user not using Netscape 4, this feature may be used freely with
1424: pretty much any HTML.
1425:
1426: =cut
1427:
1428: sub change_content_javascript {
1429: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1430: if ($env{'browser.type'} eq 'netscape' &&
1431: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1432: return (<<NETSCAPE4);
1433: function change(name, content) {
1434: doc = document.layers[name+"___escape"].layers[0].document;
1435: doc.open();
1436: doc.write(content);
1437: doc.close();
1438: }
1439: NETSCAPE4
1440: } else {
1441: # Otherwise, we need to use semi-standards-compliant code
1442: # (technically, "innerHTML" isn't standard but the equivalent
1443: # is really scary, and every useful browser supports it
1444: return (<<DOMBASED);
1445: function change(name, content) {
1446: element = document.getElementById(name);
1447: element.innerHTML = content;
1448: }
1449: DOMBASED
1450: }
1451: }
1452:
1453: =pod
1454:
1.648 raeburn 1455: =item * &changable_area($name,$origContent):
1.256 matthew 1456:
1457: This provides a "changable area" that can be modified on the fly via
1458: the Javascript code provided in C<change_content_javascript>. $name is
1459: the name you will use to reference the area later; do not repeat the
1460: same name on a given HTML page more then once. $origContent is what
1461: the area will originally contain, which can be left blank.
1462:
1463: =cut
1464:
1465: sub changable_area {
1466: my ($name, $origContent) = @_;
1467:
1.258 albertel 1468: if ($env{'browser.type'} eq 'netscape' &&
1469: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1470: # If this is netscape 4, we need to use the Layer tag
1471: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1472: } else {
1473: return "<span id='$name'>$origContent</span>";
1474: }
1475: }
1476:
1477: =pod
1478:
1.648 raeburn 1479: =item * &viewport_geometry_js
1.590 raeburn 1480:
1481: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1482:
1483: =cut
1484:
1485:
1486: sub viewport_geometry_js {
1487: return <<"GEOMETRY";
1488: var Geometry = {};
1489: function init_geometry() {
1490: if (Geometry.init) { return };
1491: Geometry.init=1;
1492: if (window.innerHeight) {
1493: Geometry.getViewportHeight = function() { return window.innerHeight; };
1494: Geometry.getViewportWidth = function() { return window.innerWidth; };
1495: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1496: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1497: }
1498: else if (document.documentElement && document.documentElement.clientHeight) {
1499: Geometry.getViewportHeight =
1500: function() { return document.documentElement.clientHeight; };
1501: Geometry.getViewportWidth =
1502: function() { return document.documentElement.clientWidth; };
1503:
1504: Geometry.getHorizontalScroll =
1505: function() { return document.documentElement.scrollLeft; };
1506: Geometry.getVerticalScroll =
1507: function() { return document.documentElement.scrollTop; };
1508: }
1509: else if (document.body.clientHeight) {
1510: Geometry.getViewportHeight =
1511: function() { return document.body.clientHeight; };
1512: Geometry.getViewportWidth =
1513: function() { return document.body.clientWidth; };
1514: Geometry.getHorizontalScroll =
1515: function() { return document.body.scrollLeft; };
1516: Geometry.getVerticalScroll =
1517: function() { return document.body.scrollTop; };
1518: }
1519: }
1520:
1521: GEOMETRY
1522: }
1523:
1524: =pod
1525:
1.648 raeburn 1526: =item * &viewport_size_js()
1.590 raeburn 1527:
1528: 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.
1529:
1530: =cut
1531:
1532: sub viewport_size_js {
1533: my $geometry = &viewport_geometry_js();
1534: return <<"DIMS";
1535:
1536: $geometry
1537:
1538: function getViewportDims(width,height) {
1539: init_geometry();
1540: width.value = Geometry.getViewportWidth();
1541: height.value = Geometry.getViewportHeight();
1542: return;
1543: }
1544:
1545: DIMS
1546: }
1547:
1548: =pod
1549:
1.648 raeburn 1550: =item * &resize_textarea_js()
1.565 albertel 1551:
1552: emits the needed javascript to resize a textarea to be as big as possible
1553:
1554: creates a function resize_textrea that takes two IDs first should be
1555: the id of the element to resize, second should be the id of a div that
1556: surrounds everything that comes after the textarea, this routine needs
1557: to be attached to the <body> for the onload and onresize events.
1558:
1.648 raeburn 1559: =back
1.565 albertel 1560:
1561: =cut
1562:
1563: sub resize_textarea_js {
1.590 raeburn 1564: my $geometry = &viewport_geometry_js();
1.565 albertel 1565: return <<"RESIZE";
1566: <script type="text/javascript">
1.692.4.4 raeburn 1567: // <![CDATA[
1.590 raeburn 1568: $geometry
1.565 albertel 1569:
1.588 albertel 1570: function getX(element) {
1571: var x = 0;
1572: while (element) {
1573: x += element.offsetLeft;
1574: element = element.offsetParent;
1575: }
1576: return x;
1577: }
1578: function getY(element) {
1579: var y = 0;
1580: while (element) {
1581: y += element.offsetTop;
1582: element = element.offsetParent;
1583: }
1584: return y;
1585: }
1586:
1587:
1.565 albertel 1588: function resize_textarea(textarea_id,bottom_id) {
1589: init_geometry();
1590: var textarea = document.getElementById(textarea_id);
1591: //alert(textarea);
1592:
1.588 albertel 1593: var textarea_top = getY(textarea);
1.565 albertel 1594: var textarea_height = textarea.offsetHeight;
1595: var bottom = document.getElementById(bottom_id);
1.588 albertel 1596: var bottom_top = getY(bottom);
1.565 albertel 1597: var bottom_height = bottom.offsetHeight;
1598: var window_height = Geometry.getViewportHeight();
1.588 albertel 1599: var fudge = 23;
1.565 albertel 1600: var new_height = window_height-fudge-textarea_top-bottom_height;
1601: if (new_height < 300) {
1602: new_height = 300;
1603: }
1604: textarea.style.height=new_height+'px';
1605: }
1.692.4.4 raeburn 1606: // ]]>
1.565 albertel 1607: </script>
1608: RESIZE
1609:
1610: }
1611:
1612: =pod
1613:
1.256 matthew 1614: =head1 Excel and CSV file utility routines
1615:
1616: =over 4
1617:
1618: =cut
1619:
1620: ###############################################################
1621: ###############################################################
1622:
1623: =pod
1624:
1.648 raeburn 1625: =item * &csv_translate($text)
1.37 matthew 1626:
1.185 www 1627: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1628: format.
1629:
1630: =cut
1631:
1.180 matthew 1632: ###############################################################
1633: ###############################################################
1.37 matthew 1634: sub csv_translate {
1635: my $text = shift;
1636: $text =~ s/\"/\"\"/g;
1.209 albertel 1637: $text =~ s/\n/ /g;
1.37 matthew 1638: return $text;
1639: }
1.180 matthew 1640:
1641: ###############################################################
1642: ###############################################################
1643:
1644: =pod
1645:
1.648 raeburn 1646: =item * &define_excel_formats()
1.180 matthew 1647:
1648: Define some commonly used Excel cell formats.
1649:
1650: Currently supported formats:
1651:
1652: =over 4
1653:
1654: =item header
1655:
1656: =item bold
1657:
1658: =item h1
1659:
1660: =item h2
1661:
1662: =item h3
1663:
1.256 matthew 1664: =item h4
1665:
1666: =item i
1667:
1.180 matthew 1668: =item date
1669:
1670: =back
1671:
1672: Inputs: $workbook
1673:
1674: Returns: $format, a hash reference.
1675:
1676: =cut
1677:
1678: ###############################################################
1679: ###############################################################
1680: sub define_excel_formats {
1681: my ($workbook) = @_;
1682: my $format;
1683: $format->{'header'} = $workbook->add_format(bold => 1,
1684: bottom => 1,
1685: align => 'center');
1686: $format->{'bold'} = $workbook->add_format(bold=>1);
1687: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1688: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1689: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1690: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1691: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1692: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1693: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1694: return $format;
1695: }
1696:
1697: ###############################################################
1698: ###############################################################
1.113 bowersj2 1699:
1700: =pod
1701:
1.648 raeburn 1702: =item * &create_workbook()
1.255 matthew 1703:
1704: Create an Excel worksheet. If it fails, output message on the
1705: request object and return undefs.
1706:
1707: Inputs: Apache request object
1708:
1709: Returns (undef) on failure,
1710: Excel worksheet object, scalar with filename, and formats
1711: from &Apache::loncommon::define_excel_formats on success
1712:
1713: =cut
1714:
1715: ###############################################################
1716: ###############################################################
1717: sub create_workbook {
1718: my ($r) = @_;
1719: #
1720: # Create the excel spreadsheet
1721: my $filename = '/prtspool/'.
1.258 albertel 1722: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1723: time.'_'.rand(1000000000).'.xls';
1724: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1725: if (! defined($workbook)) {
1726: $r->log_error("Error creating excel spreadsheet $filename: $!");
1727: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1728: "This error has been logged. ".
1729: "Please alert your LON-CAPA administrator").
1730: '</p>');
1731: return (undef);
1732: }
1733: #
1734: $workbook->set_tempdir('/home/httpd/perl/tmp');
1735: #
1736: my $format = &Apache::loncommon::define_excel_formats($workbook);
1737: return ($workbook,$filename,$format);
1738: }
1739:
1740: ###############################################################
1741: ###############################################################
1742:
1743: =pod
1744:
1.648 raeburn 1745: =item * &create_text_file()
1.113 bowersj2 1746:
1.542 raeburn 1747: Create a file to write to and eventually make available to the user.
1.256 matthew 1748: If file creation fails, outputs an error message on the request object and
1749: return undefs.
1.113 bowersj2 1750:
1.256 matthew 1751: Inputs: Apache request object, and file suffix
1.113 bowersj2 1752:
1.256 matthew 1753: Returns (undef) on failure,
1754: Filehandle and filename on success.
1.113 bowersj2 1755:
1756: =cut
1757:
1.256 matthew 1758: ###############################################################
1759: ###############################################################
1760: sub create_text_file {
1761: my ($r,$suffix) = @_;
1762: if (! defined($suffix)) { $suffix = 'txt'; };
1763: my $fh;
1764: my $filename = '/prtspool/'.
1.258 albertel 1765: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1766: time.'_'.rand(1000000000).'.'.$suffix;
1767: $fh = Apache::File->new('>/home/httpd'.$filename);
1768: if (! defined($fh)) {
1769: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1770: $r->print(&mt('Problems occurred in creating the output file. '
1771: .'This error has been logged. '
1772: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1773: }
1.256 matthew 1774: return ($fh,$filename)
1.113 bowersj2 1775: }
1776:
1777:
1.256 matthew 1778: =pod
1.113 bowersj2 1779:
1780: =back
1781:
1782: =cut
1.37 matthew 1783:
1784: ###############################################################
1.33 matthew 1785: ## Home server <option> list generating code ##
1786: ###############################################################
1.35 matthew 1787:
1.169 www 1788: # ------------------------------------------
1789:
1790: sub domain_select {
1791: my ($name,$value,$multiple)=@_;
1792: my %domains=map {
1.514 albertel 1793: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1794: } &Apache::lonnet::all_domains();
1.169 www 1795: if ($multiple) {
1796: $domains{''}=&mt('Any domain');
1.550 albertel 1797: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1798: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1799: } else {
1.550 albertel 1800: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1801: return &select_form($name,$value,%domains);
1802: }
1803: }
1804:
1.282 albertel 1805: #-------------------------------------------
1806:
1807: =pod
1808:
1.519 raeburn 1809: =head1 Routines for form select boxes
1810:
1811: =over 4
1812:
1.648 raeburn 1813: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1814:
1815: Returns a string containing a <select> element int multiple mode
1816:
1817:
1818: Args:
1819: $name - name of the <select> element
1.506 raeburn 1820: $value - scalar or array ref of values that should already be selected
1.282 albertel 1821: $size - number of rows long the select element is
1.283 albertel 1822: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1823: (shown text should already have been &mt())
1.506 raeburn 1824: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1825:
1.282 albertel 1826: =cut
1827:
1828: #-------------------------------------------
1.169 www 1829: sub multiple_select_form {
1.284 albertel 1830: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1831: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1832: my $output='';
1.191 matthew 1833: if (! defined($size)) {
1834: $size = 4;
1.283 albertel 1835: if (scalar(keys(%$hash))<4) {
1836: $size = scalar(keys(%$hash));
1.191 matthew 1837: }
1838: }
1.692.4.2 raeburn 1839: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1840: my @order;
1.506 raeburn 1841: if (ref($order) eq 'ARRAY') {
1842: @order = @{$order};
1843: } else {
1844: @order = sort(keys(%$hash));
1.501 banghart 1845: }
1846: if (exists($$hash{'select_form_order'})) {
1847: @order = @{$$hash{'select_form_order'}};
1848: }
1849:
1.284 albertel 1850: foreach my $key (@order) {
1.356 albertel 1851: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1852: $output.='selected="selected" ' if ($selected{$key});
1853: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1854: }
1855: $output.="</select>\n";
1856: return $output;
1857: }
1858:
1.88 www 1859: #-------------------------------------------
1860:
1861: =pod
1862:
1.648 raeburn 1863: =item * &select_form($defdom,$name,%hash)
1.88 www 1864:
1865: Returns a string containing a <select name='$name' size='1'> form to
1866: allow a user to select options from a hash option_name => displayed text.
1867: See lonrights.pm for an example invocation and use.
1868:
1869: =cut
1870:
1871: #-------------------------------------------
1872: sub select_form {
1873: my ($def,$name,%hash) = @_;
1874: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1875: my @keys;
1876: if (exists($hash{'select_form_order'})) {
1877: @keys=@{$hash{'select_form_order'}};
1878: } else {
1879: @keys=sort(keys(%hash));
1880: }
1.356 albertel 1881: foreach my $key (@keys) {
1882: $selectform.=
1883: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1884: ($key eq $def ? 'selected="selected" ' : '').
1.692.4.27 raeburn 1885: ">".$hash{$key}."</option>\n";
1.88 www 1886: }
1887: $selectform.="</select>";
1888: return $selectform;
1889: }
1890:
1.475 www 1891: # For display filters
1892:
1893: sub display_filter {
1894: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1895: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.692.4.2 raeburn 1896: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1897: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1898: (&mt('all'),10,20,50,100,1000,10000))).
1.692.4.2 raeburn 1899: '</label></span> <span class="LC_nobreak">'.
1.475 www 1900: &mt('Filter [_1]',
1.477 www 1901: &select_form($env{'form.displayfilter'},
1902: 'displayfilter',
1903: ('currentfolder' => 'Current folder/page',
1904: 'containing' => 'Containing phrase',
1905: 'none' => 'None'))).
1.692.4.2 raeburn 1906: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1907: }
1908:
1.167 www 1909: sub gradeleveldescription {
1910: my $gradelevel=shift;
1911: my %gradelevels=(0 => 'Not specified',
1912: 1 => 'Grade 1',
1913: 2 => 'Grade 2',
1914: 3 => 'Grade 3',
1915: 4 => 'Grade 4',
1916: 5 => 'Grade 5',
1917: 6 => 'Grade 6',
1918: 7 => 'Grade 7',
1919: 8 => 'Grade 8',
1920: 9 => 'Grade 9',
1921: 10 => 'Grade 10',
1922: 11 => 'Grade 11',
1923: 12 => 'Grade 12',
1924: 13 => 'Grade 13',
1925: 14 => '100 Level',
1926: 15 => '200 Level',
1927: 16 => '300 Level',
1928: 17 => '400 Level',
1929: 18 => 'Graduate Level');
1930: return &mt($gradelevels{$gradelevel});
1931: }
1932:
1.163 www 1933: sub select_level_form {
1934: my ($deflevel,$name)=@_;
1935: unless ($deflevel) { $deflevel=0; }
1.167 www 1936: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1937: for (my $i=0; $i<=18; $i++) {
1938: $selectform.="<option value=\"$i\" ".
1.253 albertel 1939: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1940: ">".&gradeleveldescription($i)."</option>\n";
1941: }
1942: $selectform.="</select>";
1943: return $selectform;
1.163 www 1944: }
1.167 www 1945:
1.35 matthew 1946: #-------------------------------------------
1947:
1.45 matthew 1948: =pod
1949:
1.692.4.23 raeburn 1950: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1951:
1952: Returns a string containing a <select name='$name' size='1'> form to
1953: allow a user to select the domain to preform an operation in.
1954: See loncreateuser.pm for an example invocation and use.
1955:
1.90 www 1956: If the $includeempty flag is set, it also includes an empty choice ("no domain
1957: selected");
1958:
1.692.4.2 raeburn 1959: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1960:
1.692.4.7 raeburn 1961: 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.
1.563 raeburn 1962:
1.692.4.23 raeburn 1963: The optional $incdoms is a reference to an array of domains which will be the only available options.
1964:
1.35 matthew 1965: =cut
1966:
1967: #-------------------------------------------
1.34 matthew 1968: sub select_dom_form {
1.692.4.23 raeburn 1969: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.692.4.7 raeburn 1970: if ($onchange) {
1971: $onchange = ' onchange="'.$onchange.'"';
1.692.4.2 raeburn 1972: }
1.692.4.23 raeburn 1973: my @domains;
1974: if (ref($incdoms) eq 'ARRAY') {
1975: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1976: } else {
1977: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1978: }
1.90 www 1979: if ($includeempty) { @domains=('',@domains); }
1.692.4.2 raeburn 1980: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1981: foreach my $dom (@domains) {
1982: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1983: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1984: if ($showdomdesc) {
1985: if ($dom ne '') {
1986: my $domdesc = &Apache::lonnet::domain($dom,'description');
1987: if ($domdesc ne '') {
1988: $selectdomain .= ' ('.$domdesc.')';
1989: }
1990: }
1991: }
1992: $selectdomain .= "</option>\n";
1.34 matthew 1993: }
1994: $selectdomain.="</select>";
1995: return $selectdomain;
1996: }
1997:
1.35 matthew 1998: #-------------------------------------------
1999:
1.45 matthew 2000: =pod
2001:
1.648 raeburn 2002: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2003:
1.586 raeburn 2004: input: 4 arguments (two required, two optional) -
2005: $domain - domain of new user
2006: $name - name of form element
2007: $default - Value of 'default' causes a default item to be first
2008: option, and selected by default.
2009: $hide - Value of 'hide' causes hiding of the name of the server,
2010: if 1 server found, or default, if 0 found.
1.594 raeburn 2011: output: returns 2 items:
1.586 raeburn 2012: (a) form element which contains either:
2013: (i) <select name="$name">
2014: <option value="$hostid1">$hostid $servers{$hostid}</option>
2015: <option value="$hostid2">$hostid $servers{$hostid}</option>
2016: </select>
2017: form item if there are multiple library servers in $domain, or
2018: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2019: if there is only one library server in $domain.
2020:
2021: (b) number of library servers found.
2022:
2023: See loncreateuser.pm for example of use.
1.35 matthew 2024:
2025: =cut
2026:
2027: #-------------------------------------------
1.586 raeburn 2028: sub home_server_form_item {
2029: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2030: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2031: my $result;
2032: my $numlib = keys(%servers);
2033: if ($numlib > 1) {
2034: $result .= '<select name="'.$name.'" />'."\n";
2035: if ($default) {
1.692.4.2 raeburn 2036: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2037: '</option>'."\n";
2038: }
2039: foreach my $hostid (sort(keys(%servers))) {
2040: $result.= '<option value="'.$hostid.'">'.
2041: $hostid.' '.$servers{$hostid}."</option>\n";
2042: }
2043: $result .= '</select>'."\n";
2044: } elsif ($numlib == 1) {
2045: my $hostid;
2046: foreach my $item (keys(%servers)) {
2047: $hostid = $item;
2048: }
2049: $result .= '<input type="hidden" name="'.$name.'" value="'.
2050: $hostid.'" />';
2051: if (!$hide) {
2052: $result .= $hostid.' '.$servers{$hostid};
2053: }
2054: $result .= "\n";
2055: } elsif ($default) {
2056: $result .= '<input type="hidden" name="'.$name.
2057: '" value="default" />';
2058: if (!$hide) {
2059: $result .= &mt('default');
2060: }
2061: $result .= "\n";
1.33 matthew 2062: }
1.586 raeburn 2063: return ($result,$numlib);
1.33 matthew 2064: }
1.112 bowersj2 2065:
2066: =pod
2067:
1.534 albertel 2068: =back
2069:
1.112 bowersj2 2070: =cut
1.87 matthew 2071:
2072: ###############################################################
1.112 bowersj2 2073: ## Decoding User Agent ##
1.87 matthew 2074: ###############################################################
2075:
2076: =pod
2077:
1.112 bowersj2 2078: =head1 Decoding the User Agent
2079:
2080: =over 4
2081:
2082: =item * &decode_user_agent()
1.87 matthew 2083:
2084: Inputs: $r
2085:
2086: Outputs:
2087:
2088: =over 4
2089:
1.112 bowersj2 2090: =item * $httpbrowser
1.87 matthew 2091:
1.112 bowersj2 2092: =item * $clientbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientversion
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientmathml
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientunicode
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientos
1.87 matthew 2101:
2102: =back
2103:
1.157 matthew 2104: =back
2105:
1.87 matthew 2106: =cut
2107:
2108: ###############################################################
2109: ###############################################################
2110: sub decode_user_agent {
1.247 albertel 2111: my ($r)=@_;
1.87 matthew 2112: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2113: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2114: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2115: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2116: my $clientbrowser='unknown';
2117: my $clientversion='0';
2118: my $clientmathml='';
2119: my $clientunicode='0';
2120: for (my $i=0;$i<=$#browsertype;$i++) {
2121: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2122: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2123: $clientbrowser=$bname;
2124: $httpbrowser=~/$vreg/i;
2125: $clientversion=$1;
2126: $clientmathml=($clientversion>=$minv);
2127: $clientunicode=($clientversion>=$univ);
2128: }
2129: }
2130: my $clientos='unknown';
2131: if (($httpbrowser=~/linux/i) ||
2132: ($httpbrowser=~/unix/i) ||
2133: ($httpbrowser=~/ux/i) ||
2134: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2135: if (($httpbrowser=~/vax/i) ||
2136: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2137: if ($httpbrowser=~/next/i) { $clientos='next'; }
2138: if (($httpbrowser=~/mac/i) ||
2139: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2140: if ($httpbrowser=~/win/i) { $clientos='win'; }
2141: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2142: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2143: $clientunicode,$clientos,);
2144: }
2145:
1.32 matthew 2146: ###############################################################
2147: ## Authentication changing form generation subroutines ##
2148: ###############################################################
2149: ##
2150: ## All of the authform_xxxxxxx subroutines take their inputs in a
2151: ## hash, and have reasonable default values.
2152: ##
2153: ## formname = the name given in the <form> tag.
1.35 matthew 2154: #-------------------------------------------
2155:
1.45 matthew 2156: =pod
2157:
1.112 bowersj2 2158: =head1 Authentication Routines
2159:
2160: =over 4
2161:
1.648 raeburn 2162: =item * &authform_xxxxxx()
1.35 matthew 2163:
2164: The authform_xxxxxx subroutines provide javascript and html forms which
2165: handle some of the conveniences required for authentication forms.
2166: This is not an optimal method, but it works.
2167:
2168: =over 4
2169:
1.112 bowersj2 2170: =item * authform_header
1.35 matthew 2171:
1.112 bowersj2 2172: =item * authform_authorwarning
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_nochange
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_kerberos
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_internal
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_filesystem
1.35 matthew 2181:
2182: =back
2183:
1.648 raeburn 2184: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2185:
1.35 matthew 2186: =cut
2187:
2188: #-------------------------------------------
1.32 matthew 2189: sub authform_header{
2190: my %in = (
2191: formname => 'cu',
1.80 albertel 2192: kerb_def_dom => '',
1.32 matthew 2193: @_,
2194: );
2195: $in{'formname'} = 'document.' . $in{'formname'};
2196: my $result='';
1.80 albertel 2197:
2198: #---------------------------------------------- Code for upper case translation
2199: my $Javascript_toUpperCase;
2200: unless ($in{kerb_def_dom}) {
2201: $Javascript_toUpperCase =<<"END";
2202: switch (choice) {
2203: case 'krb': currentform.elements[choicearg].value =
2204: currentform.elements[choicearg].value.toUpperCase();
2205: break;
2206: default:
2207: }
2208: END
2209: } else {
2210: $Javascript_toUpperCase = "";
2211: }
2212:
1.165 raeburn 2213: my $radioval = "'nochange'";
1.591 raeburn 2214: if (defined($in{'curr_authtype'})) {
2215: if ($in{'curr_authtype'} ne '') {
2216: $radioval = "'".$in{'curr_authtype'}."arg'";
2217: }
1.174 matthew 2218: }
1.165 raeburn 2219: my $argfield = 'null';
1.591 raeburn 2220: if (defined($in{'mode'})) {
1.165 raeburn 2221: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2222: if (defined($in{'curr_autharg'})) {
2223: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2224: $argfield = "'$in{'curr_autharg'}'";
2225: }
2226: }
2227: }
2228: }
2229:
1.32 matthew 2230: $result.=<<"END";
2231: var current = new Object();
1.165 raeburn 2232: current.radiovalue = $radioval;
2233: current.argfield = $argfield;
1.32 matthew 2234:
2235: function changed_radio(choice,currentform) {
2236: var choicearg = choice + 'arg';
2237: // If a radio button in changed, we need to change the argfield
2238: if (current.radiovalue != choice) {
2239: current.radiovalue = choice;
2240: if (current.argfield != null) {
2241: currentform.elements[current.argfield].value = '';
2242: }
2243: if (choice == 'nochange') {
2244: current.argfield = null;
2245: } else {
2246: current.argfield = choicearg;
2247: switch(choice) {
2248: case 'krb':
2249: currentform.elements[current.argfield].value =
2250: "$in{'kerb_def_dom'}";
2251: break;
2252: default:
2253: break;
2254: }
2255: }
2256: }
2257: return;
2258: }
1.22 www 2259:
1.32 matthew 2260: function changed_text(choice,currentform) {
2261: var choicearg = choice + 'arg';
2262: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2263: $Javascript_toUpperCase
1.32 matthew 2264: // clear old field
2265: if ((current.argfield != choicearg) && (current.argfield != null)) {
2266: currentform.elements[current.argfield].value = '';
2267: }
2268: current.argfield = choicearg;
2269: }
2270: set_auth_radio_buttons(choice,currentform);
2271: return;
1.20 www 2272: }
1.32 matthew 2273:
2274: function set_auth_radio_buttons(newvalue,currentform) {
2275: var i=0;
2276: while (i < currentform.login.length) {
2277: if (currentform.login[i].value == newvalue) { break; }
2278: i++;
2279: }
2280: if (i == currentform.login.length) {
2281: return;
2282: }
2283: current.radiovalue = newvalue;
2284: currentform.login[i].checked = true;
2285: return;
2286: }
2287: END
2288: return $result;
2289: }
2290:
2291: sub authform_authorwarning{
2292: my $result='';
1.144 matthew 2293: $result='<i>'.
2294: &mt('As a general rule, only authors or co-authors should be '.
2295: 'filesystem authenticated '.
2296: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2297: return $result;
2298: }
2299:
2300: sub authform_nochange{
2301: my %in = (
2302: formname => 'document.cu',
2303: kerb_def_dom => 'MSU.EDU',
2304: @_,
2305: );
1.586 raeburn 2306: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2307: my $result;
2308: if (keys(%can_assign) == 0) {
2309: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2310: } else {
2311: $result = '<label>'.&mt('[_1] Do not change login data',
2312: '<input type="radio" name="login" value="nochange" '.
2313: 'checked="checked" onclick="'.
1.281 albertel 2314: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2315: '</label>';
1.586 raeburn 2316: }
1.32 matthew 2317: return $result;
2318: }
2319:
1.591 raeburn 2320: sub authform_kerberos {
1.32 matthew 2321: my %in = (
2322: formname => 'document.cu',
2323: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2324: kerb_def_auth => 'krb4',
1.32 matthew 2325: @_,
2326: );
1.586 raeburn 2327: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2328: $autharg,$jscall);
2329: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2330: if ($in{'kerb_def_auth'} eq 'krb5') {
1.692.4.2 raeburn 2331: $check5 = ' checked="checked"';
1.80 albertel 2332: } else {
1.692.4.2 raeburn 2333: $check4 = ' checked="checked"';
1.80 albertel 2334: }
1.165 raeburn 2335: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2336: if (defined($in{'curr_authtype'})) {
2337: if ($in{'curr_authtype'} eq 'krb') {
1.692.4.2 raeburn 2338: $krbcheck = ' checked="checked"';
1.623 raeburn 2339: if (defined($in{'mode'})) {
2340: if ($in{'mode'} eq 'modifyuser') {
2341: $krbcheck = '';
2342: }
2343: }
1.591 raeburn 2344: if (defined($in{'curr_kerb_ver'})) {
2345: if ($in{'curr_krb_ver'} eq '5') {
1.692.4.2 raeburn 2346: $check5 = ' checked="checked"';
1.591 raeburn 2347: $check4 = '';
2348: } else {
1.692.4.2 raeburn 2349: $check4 = ' checked="checked"';
1.591 raeburn 2350: $check5 = '';
2351: }
1.586 raeburn 2352: }
1.591 raeburn 2353: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2354: $krbarg = $in{'curr_autharg'};
2355: }
1.586 raeburn 2356: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2357: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2358: $result =
2359: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2360: $in{'curr_autharg'},$krbver);
2361: } else {
2362: $result =
2363: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2364: }
2365: return $result;
2366: }
2367: }
2368: } else {
2369: if ($authnum == 1) {
1.692.4.2 raeburn 2370: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2371: }
2372: }
1.586 raeburn 2373: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2374: return;
1.587 raeburn 2375: } elsif ($authtype eq '') {
1.591 raeburn 2376: if (defined($in{'mode'})) {
1.587 raeburn 2377: if ($in{'mode'} eq 'modifycourse') {
2378: if ($authnum == 1) {
1.692.4.2 raeburn 2379: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2380: }
2381: }
2382: }
1.586 raeburn 2383: }
2384: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2385: if ($authtype eq '') {
2386: $authtype = '<input type="radio" name="login" value="krb" '.
2387: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2388: $krbcheck.' />';
2389: }
2390: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2391: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2392: $in{'curr_authtype'} eq 'krb5') ||
2393: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb4')) {
2395: $result .= &mt
1.144 matthew 2396: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2397: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2398: '<label>'.$authtype,
1.281 albertel 2399: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2400: 'value="'.$krbarg.'" '.
1.144 matthew 2401: 'onchange="'.$jscall.'" />',
1.281 albertel 2402: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2403: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2404: '</label>');
1.586 raeburn 2405: } elsif ($can_assign{'krb4'}) {
2406: $result .= &mt
2407: ('[_1] Kerberos authenticated with domain [_2] '.
2408: '[_3] Version 4 [_4]',
2409: '<label>'.$authtype,
2410: '</label><input type="text" size="10" name="krbarg" '.
2411: 'value="'.$krbarg.'" '.
2412: 'onchange="'.$jscall.'" />',
2413: '<label><input type="hidden" name="krbver" value="4" />',
2414: '</label>');
2415: } elsif ($can_assign{'krb5'}) {
2416: $result .= &mt
2417: ('[_1] Kerberos authenticated with domain [_2] '.
2418: '[_3] Version 5 [_4]',
2419: '<label>'.$authtype,
2420: '</label><input type="text" size="10" name="krbarg" '.
2421: 'value="'.$krbarg.'" '.
2422: 'onchange="'.$jscall.'" />',
2423: '<label><input type="hidden" name="krbver" value="5" />',
2424: '</label>');
2425: }
1.32 matthew 2426: return $result;
2427: }
2428:
2429: sub authform_internal{
1.586 raeburn 2430: my %in = (
1.32 matthew 2431: formname => 'document.cu',
2432: kerb_def_dom => 'MSU.EDU',
2433: @_,
2434: );
1.586 raeburn 2435: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2436: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2437: if (defined($in{'curr_authtype'})) {
2438: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2439: if ($can_assign{'int'}) {
1.692.4.2 raeburn 2440: $intcheck = 'checked="checked" ';
1.623 raeburn 2441: if (defined($in{'mode'})) {
2442: if ($in{'mode'} eq 'modifyuser') {
2443: $intcheck = '';
2444: }
2445: }
1.591 raeburn 2446: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2447: $intarg = $in{'curr_autharg'};
2448: }
2449: } else {
2450: $result = &mt('Currently internally authenticated.');
2451: return $result;
1.165 raeburn 2452: }
2453: }
1.586 raeburn 2454: } else {
2455: if ($authnum == 1) {
1.692.4.2 raeburn 2456: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2457: }
2458: }
2459: if (!$can_assign{'int'}) {
2460: return;
1.587 raeburn 2461: } elsif ($authtype eq '') {
1.591 raeburn 2462: if (defined($in{'mode'})) {
1.587 raeburn 2463: if ($in{'mode'} eq 'modifycourse') {
2464: if ($authnum == 1) {
1.692.4.2 raeburn 2465: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2466: }
2467: }
2468: }
1.165 raeburn 2469: }
1.586 raeburn 2470: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2471: if ($authtype eq '') {
2472: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2473: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2474: }
1.605 bisitz 2475: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2476: $intarg.'" onchange="'.$jscall.'" />';
2477: $result = &mt
1.144 matthew 2478: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2479: '<label>'.$authtype,'</label>'.$autharg);
1.692.4.4 raeburn 2480: $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 2481: return $result;
2482: }
2483:
2484: sub authform_local{
2485: my %in = (
2486: formname => 'document.cu',
2487: kerb_def_dom => 'MSU.EDU',
2488: @_,
2489: );
1.586 raeburn 2490: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2491: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2492: if (defined($in{'curr_authtype'})) {
2493: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2494: if ($can_assign{'loc'}) {
1.692.4.2 raeburn 2495: $loccheck = 'checked="checked" ';
1.623 raeburn 2496: if (defined($in{'mode'})) {
2497: if ($in{'mode'} eq 'modifyuser') {
2498: $loccheck = '';
2499: }
2500: }
1.591 raeburn 2501: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2502: $locarg = $in{'curr_autharg'};
2503: }
2504: } else {
2505: $result = &mt('Currently using local (institutional) authentication.');
2506: return $result;
1.165 raeburn 2507: }
2508: }
1.586 raeburn 2509: } else {
2510: if ($authnum == 1) {
1.692.4.2 raeburn 2511: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2512: }
2513: }
2514: if (!$can_assign{'loc'}) {
2515: return;
1.587 raeburn 2516: } elsif ($authtype eq '') {
1.591 raeburn 2517: if (defined($in{'mode'})) {
1.587 raeburn 2518: if ($in{'mode'} eq 'modifycourse') {
2519: if ($authnum == 1) {
1.692.4.2 raeburn 2520: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2521: }
2522: }
2523: }
1.165 raeburn 2524: }
1.586 raeburn 2525: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2526: if ($authtype eq '') {
2527: $authtype = '<input type="radio" name="login" value="loc" '.
2528: $loccheck.' onchange="'.$jscall.'" onclick="'.
2529: $jscall.'" />';
2530: }
2531: $autharg = '<input type="text" size="10" name="locarg" value="'.
2532: $locarg.'" onchange="'.$jscall.'" />';
2533: $result = &mt('[_1] Local Authentication with argument [_2]',
2534: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2535: return $result;
2536: }
2537:
2538: sub authform_filesystem{
2539: my %in = (
2540: formname => 'document.cu',
2541: kerb_def_dom => 'MSU.EDU',
2542: @_,
2543: );
1.586 raeburn 2544: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2545: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2546: if (defined($in{'curr_authtype'})) {
2547: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2548: if ($can_assign{'fsys'}) {
1.692.4.2 raeburn 2549: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2550: if (defined($in{'mode'})) {
2551: if ($in{'mode'} eq 'modifyuser') {
2552: $fsyscheck = '';
2553: }
2554: }
1.586 raeburn 2555: } else {
2556: $result = &mt('Currently Filesystem Authenticated.');
2557: return $result;
2558: }
2559: }
2560: } else {
2561: if ($authnum == 1) {
1.692.4.2 raeburn 2562: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2563: }
2564: }
2565: if (!$can_assign{'fsys'}) {
2566: return;
1.587 raeburn 2567: } elsif ($authtype eq '') {
1.591 raeburn 2568: if (defined($in{'mode'})) {
1.587 raeburn 2569: if ($in{'mode'} eq 'modifycourse') {
2570: if ($authnum == 1) {
1.692.4.2 raeburn 2571: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2572: }
2573: }
2574: }
1.586 raeburn 2575: }
2576: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2577: if ($authtype eq '') {
2578: $authtype = '<input type="radio" name="login" value="fsys" '.
2579: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2580: $jscall.'" />';
2581: }
2582: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2583: ' onchange="'.$jscall.'" />';
2584: $result = &mt
1.144 matthew 2585: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2586: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2587: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2588: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2589: 'onchange="'.$jscall.'" />');
1.32 matthew 2590: return $result;
2591: }
2592:
1.586 raeburn 2593: sub get_assignable_auth {
2594: my ($dom) = @_;
2595: if ($dom eq '') {
2596: $dom = $env{'request.role.domain'};
2597: }
2598: my %can_assign = (
2599: krb4 => 1,
2600: krb5 => 1,
2601: int => 1,
2602: loc => 1,
2603: );
2604: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2605: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2606: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2607: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2608: my $context;
2609: if ($env{'request.role'} =~ /^au/) {
2610: $context = 'author';
2611: } elsif ($env{'request.role'} =~ /^dc/) {
2612: $context = 'domain';
2613: } elsif ($env{'request.course.id'}) {
2614: $context = 'course';
2615: }
2616: if ($context) {
2617: if (ref($authhash->{$context}) eq 'HASH') {
2618: %can_assign = %{$authhash->{$context}};
2619: }
2620: }
2621: }
2622: }
2623: my $authnum = 0;
2624: foreach my $key (keys(%can_assign)) {
2625: if ($can_assign{$key}) {
2626: $authnum ++;
2627: }
2628: }
2629: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2630: $authnum --;
2631: }
2632: return ($authnum,%can_assign);
2633: }
2634:
1.80 albertel 2635: ###############################################################
2636: ## Get Kerberos Defaults for Domain ##
2637: ###############################################################
2638: ##
2639: ## Returns default kerberos version and an associated argument
2640: ## as listed in file domain.tab. If not listed, provides
2641: ## appropriate default domain and kerberos version.
2642: ##
2643: #-------------------------------------------
2644:
2645: =pod
2646:
1.648 raeburn 2647: =item * &get_kerberos_defaults()
1.80 albertel 2648:
2649: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2650: version and domain. If not found, it defaults to version 4 and the
2651: domain of the server.
1.80 albertel 2652:
1.648 raeburn 2653: =over 4
2654:
1.80 albertel 2655: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2656:
1.648 raeburn 2657: =back
2658:
2659: =back
2660:
1.80 albertel 2661: =cut
2662:
2663: #-------------------------------------------
2664: sub get_kerberos_defaults {
2665: my $domain=shift;
1.641 raeburn 2666: my ($krbdef,$krbdefdom);
2667: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2668: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2669: $krbdef = $domdefaults{'auth_def'};
2670: $krbdefdom = $domdefaults{'auth_arg_def'};
2671: } else {
1.80 albertel 2672: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2673: my $krbdefdom=$1;
2674: $krbdefdom=~tr/a-z/A-Z/;
2675: $krbdef = "krb4";
2676: }
2677: return ($krbdef,$krbdefdom);
2678: }
1.112 bowersj2 2679:
1.32 matthew 2680:
1.46 matthew 2681: ###############################################################
2682: ## Thesaurus Functions ##
2683: ###############################################################
1.20 www 2684:
1.46 matthew 2685: =pod
1.20 www 2686:
1.112 bowersj2 2687: =head1 Thesaurus Functions
2688:
2689: =over 4
2690:
1.648 raeburn 2691: =item * &initialize_keywords()
1.46 matthew 2692:
2693: Initializes the package variable %Keywords if it is empty. Uses the
2694: package variable $thesaurus_db_file.
2695:
2696: =cut
2697:
2698: ###################################################
2699:
2700: sub initialize_keywords {
2701: return 1 if (scalar keys(%Keywords));
2702: # If we are here, %Keywords is empty, so fill it up
2703: # Make sure the file we need exists...
2704: if (! -e $thesaurus_db_file) {
2705: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2706: " failed because it does not exist");
2707: return 0;
2708: }
2709: # Set up the hash as a database
2710: my %thesaurus_db;
2711: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2712: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2713: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2714: $thesaurus_db_file);
2715: return 0;
2716: }
2717: # Get the average number of appearances of a word.
2718: my $avecount = $thesaurus_db{'average.count'};
2719: # Put keywords (those that appear > average) into %Keywords
2720: while (my ($word,$data)=each (%thesaurus_db)) {
2721: my ($count,undef) = split /:/,$data;
2722: $Keywords{$word}++ if ($count > $avecount);
2723: }
2724: untie %thesaurus_db;
2725: # Remove special values from %Keywords.
1.356 albertel 2726: foreach my $value ('total.count','average.count') {
2727: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2728: }
1.46 matthew 2729: return 1;
2730: }
2731:
2732: ###################################################
2733:
2734: =pod
2735:
1.648 raeburn 2736: =item * &keyword($word)
1.46 matthew 2737:
2738: Returns true if $word is a keyword. A keyword is a word that appears more
2739: than the average number of times in the thesaurus database. Calls
2740: &initialize_keywords
2741:
2742: =cut
2743:
2744: ###################################################
1.20 www 2745:
2746: sub keyword {
1.46 matthew 2747: return if (!&initialize_keywords());
2748: my $word=lc(shift());
2749: $word=~s/\W//g;
2750: return exists($Keywords{$word});
1.20 www 2751: }
1.46 matthew 2752:
2753: ###############################################################
2754:
2755: =pod
1.20 www 2756:
1.648 raeburn 2757: =item * &get_related_words()
1.46 matthew 2758:
1.160 matthew 2759: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2760: an array of words. If the keyword is not in the thesaurus, an empty array
2761: will be returned. The order of the words returned is determined by the
2762: database which holds them.
2763:
2764: Uses global $thesaurus_db_file.
2765:
2766: =cut
2767:
2768: ###############################################################
2769: sub get_related_words {
2770: my $keyword = shift;
2771: my %thesaurus_db;
2772: if (! -e $thesaurus_db_file) {
2773: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2774: "failed because the file does not exist");
2775: return ();
2776: }
2777: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2778: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2779: return ();
2780: }
2781: my @Words=();
1.429 www 2782: my $count=0;
1.46 matthew 2783: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2784: # The first element is the number of times
2785: # the word appears. We do not need it now.
1.429 www 2786: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2787: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2788: my $threshold=$mostfrequentcount/10;
2789: foreach my $possibleword (@RelatedWords) {
2790: my ($word,$wordcount)=split(/\,/,$possibleword);
2791: if ($wordcount>$threshold) {
2792: push(@Words,$word);
2793: $count++;
2794: if ($count>10) { last; }
2795: }
1.20 www 2796: }
2797: }
1.46 matthew 2798: untie %thesaurus_db;
2799: return @Words;
1.14 harris41 2800: }
1.46 matthew 2801:
1.112 bowersj2 2802: =pod
2803:
2804: =back
2805:
2806: =cut
1.61 www 2807:
2808: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2809: =pod
2810:
1.112 bowersj2 2811: =head1 User Name Functions
2812:
2813: =over 4
2814:
1.648 raeburn 2815: =item * &plainname($uname,$udom,$first)
1.81 albertel 2816:
1.112 bowersj2 2817: Takes a users logon name and returns it as a string in
1.226 albertel 2818: "first middle last generation" form
2819: if $first is set to 'lastname' then it returns it as
2820: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2821:
2822: =cut
1.61 www 2823:
1.295 www 2824:
1.81 albertel 2825: ###############################################################
1.61 www 2826: sub plainname {
1.226 albertel 2827: my ($uname,$udom,$first)=@_;
1.537 albertel 2828: return if (!defined($uname) || !defined($udom));
1.295 www 2829: my %names=&getnames($uname,$udom);
1.226 albertel 2830: my $name=&Apache::lonnet::format_name($names{'firstname'},
2831: $names{'middlename'},
2832: $names{'lastname'},
2833: $names{'generation'},$first);
2834: $name=~s/^\s+//;
1.62 www 2835: $name=~s/\s+$//;
2836: $name=~s/\s+/ /g;
1.353 albertel 2837: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2838: return $name;
1.61 www 2839: }
1.66 www 2840:
2841: # -------------------------------------------------------------------- Nickname
1.81 albertel 2842: =pod
2843:
1.648 raeburn 2844: =item * &nickname($uname,$udom)
1.81 albertel 2845:
2846: Gets a users name and returns it as a string as
2847:
2848: ""nickname""
1.66 www 2849:
1.81 albertel 2850: if the user has a nickname or
2851:
2852: "first middle last generation"
2853:
2854: if the user does not
2855:
2856: =cut
1.66 www 2857:
2858: sub nickname {
2859: my ($uname,$udom)=@_;
1.537 albertel 2860: return if (!defined($uname) || !defined($udom));
1.295 www 2861: my %names=&getnames($uname,$udom);
1.68 albertel 2862: my $name=$names{'nickname'};
1.66 www 2863: if ($name) {
2864: $name='"'.$name.'"';
2865: } else {
2866: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2867: $names{'lastname'}.' '.$names{'generation'};
2868: $name=~s/\s+$//;
2869: $name=~s/\s+/ /g;
2870: }
2871: return $name;
2872: }
2873:
1.295 www 2874: sub getnames {
2875: my ($uname,$udom)=@_;
1.537 albertel 2876: return if (!defined($uname) || !defined($udom));
1.433 albertel 2877: if ($udom eq 'public' && $uname eq 'public') {
2878: return ('lastname' => &mt('Public'));
2879: }
1.295 www 2880: my $id=$uname.':'.$udom;
2881: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2882: if ($cached) {
2883: return %{$names};
2884: } else {
2885: my %loadnames=&Apache::lonnet::get('environment',
2886: ['firstname','middlename','lastname','generation','nickname'],
2887: $udom,$uname);
2888: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2889: return %loadnames;
2890: }
2891: }
1.61 www 2892:
1.542 raeburn 2893: # -------------------------------------------------------------------- getemails
1.648 raeburn 2894:
1.542 raeburn 2895: =pod
2896:
1.648 raeburn 2897: =item * &getemails($uname,$udom)
1.542 raeburn 2898:
2899: Gets a user's email information and returns it as a hash with keys:
2900: notification, critnotification, permanentemail
2901:
2902: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2903: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2904:
1.648 raeburn 2905:
1.542 raeburn 2906: =cut
2907:
1.648 raeburn 2908:
1.466 albertel 2909: sub getemails {
2910: my ($uname,$udom)=@_;
2911: if ($udom eq 'public' && $uname eq 'public') {
2912: return;
2913: }
1.467 www 2914: if (!$udom) { $udom=$env{'user.domain'}; }
2915: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2916: my $id=$uname.':'.$udom;
2917: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2918: if ($cached) {
2919: return %{$names};
2920: } else {
2921: my %loadnames=&Apache::lonnet::get('environment',
2922: ['notification','critnotification',
2923: 'permanentemail'],
2924: $udom,$uname);
2925: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2926: return %loadnames;
2927: }
2928: }
2929:
1.551 albertel 2930: sub flush_email_cache {
2931: my ($uname,$udom)=@_;
2932: if (!$udom) { $udom =$env{'user.domain'}; }
2933: if (!$uname) { $uname=$env{'user.name'}; }
2934: return if ($udom eq 'public' && $uname eq 'public');
2935: my $id=$uname.':'.$udom;
2936: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2937: }
2938:
1.692.4.2 raeburn 2939: # -------------------------------------------------------------------- getlangs
2940:
2941: =pod
2942:
2943: =item * &getlangs($uname,$udom)
2944:
2945: Gets a user's language preference and returns it as a hash with key:
2946: language.
2947:
2948: =cut
2949:
2950:
2951: sub getlangs {
2952: my ($uname,$udom) = @_;
2953: if (!$udom) { $udom =$env{'user.domain'}; }
2954: if (!$uname) { $uname=$env{'user.name'}; }
2955: my $id=$uname.':'.$udom;
2956: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2957: if ($cached) {
2958: return %{$langs};
2959: } else {
2960: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2961: $udom,$uname);
2962: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2963: return %loadlangs;
2964: }
2965: }
2966:
2967: sub flush_langs_cache {
2968: my ($uname,$udom)=@_;
2969: if (!$udom) { $udom =$env{'user.domain'}; }
2970: if (!$uname) { $uname=$env{'user.name'}; }
2971: return if ($udom eq 'public' && $uname eq 'public');
2972: my $id=$uname.':'.$udom;
2973: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2974: }
2975:
1.61 www 2976: # ------------------------------------------------------------------ Screenname
1.81 albertel 2977:
2978: =pod
2979:
1.648 raeburn 2980: =item * &screenname($uname,$udom)
1.81 albertel 2981:
2982: Gets a users screenname and returns it as a string
2983:
2984: =cut
1.61 www 2985:
2986: sub screenname {
2987: my ($uname,$udom)=@_;
1.258 albertel 2988: if ($uname eq $env{'user.name'} &&
2989: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2990: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2991: return $names{'screenname'};
1.62 www 2992: }
2993:
1.692.4.2 raeburn 2994: # ------------------------------------------------------------- Confirm Wrapper
2995: =pod
2996:
2997: =item confirmwrapper
2998:
2999: Wrap messages about completion of operation in box
3000:
3001: =cut
3002:
3003: sub confirmwrapper {
3004: my ($message)=@_;
3005: if ($message) {
3006: return "\n".'<div class="LC_confirm_box">'."\n"
3007: .$message."\n"
3008: .'</div>'."\n";
3009: } else {
3010: return $message;
3011: }
3012: }
1.212 albertel 3013:
1.62 www 3014: # ------------------------------------------------------------- Message Wrapper
3015:
3016: sub messagewrapper {
1.369 www 3017: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3018: return
1.441 albertel 3019: '<a href="/adm/email?compose=individual&'.
3020: 'recname='.$username.'&recdom='.$domain.
3021: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3022: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3023: }
3024: # --------------------------------------------------------------- Notes Wrapper
3025:
3026: sub noteswrapper {
3027: my ($link,$un,$do)=@_;
3028: return
3029: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3030: }
3031: # ------------------------------------------------------------- Aboutme Wrapper
3032:
3033: sub aboutmewrapper {
1.166 www 3034: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3035: if (!defined($username) && !defined($domain)) {
3036: return;
3037: }
1.205 www 3038: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.692.4.2 raeburn 3039: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3040: }
3041:
3042: # ------------------------------------------------------------ Syllabus Wrapper
3043:
3044:
3045: sub syllabuswrapper {
1.109 matthew 3046: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
3047: if ($fontcolor) {
3048: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
3049: }
1.208 matthew 3050: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3051: }
1.14 harris41 3052:
1.208 matthew 3053: sub track_student_link {
1.692.4.17 raeburn 3054: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3055: my $link ="/adm/trackstudent?";
1.208 matthew 3056: my $title = 'View recent activity';
3057: if (defined($sname) && $sname !~ /^\s*$/ &&
3058: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3059: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3060: $title .= ' of this student';
1.268 albertel 3061: }
1.208 matthew 3062: if (defined($target) && $target !~ /^\s*$/) {
3063: $target = qq{target="$target"};
3064: } else {
3065: $target = '';
3066: }
1.268 albertel 3067: if ($start) { $link.='&start='.$start; }
1.692.4.17 raeburn 3068: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3069: $title = &mt($title);
3070: $linktext = &mt($linktext);
1.448 albertel 3071: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3072: &help_open_topic('View_recent_activity');
1.208 matthew 3073: }
3074:
1.692.4.2 raeburn 3075: sub slot_reservations_link {
3076: my ($linktext,$sname,$sdom,$target) = @_;
3077: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3078: my $title = 'View slot reservation history';
3079: if (defined($sname) && $sname !~ /^\s*$/ &&
3080: defined($sdom) && $sdom !~ /^\s*$/) {
3081: $link .= "&uname=$sname&udom=$sdom";
3082: $title .= ' of this student';
3083: }
3084: if (defined($target) && $target !~ /^\s*$/) {
3085: $target = qq{target="$target"};
3086: } else {
3087: $target = '';
3088: }
3089: $title = &mt($title);
3090: $linktext = &mt($linktext);
3091: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3092: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3093:
3094: }
3095:
1.508 www 3096: # ===================================================== Display a student photo
3097:
3098:
1.509 albertel 3099: sub student_image_tag {
1.508 www 3100: my ($domain,$user)=@_;
3101: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3102: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3103: return '<img src="'.$imgsrc.'" align="right" />';
3104: } else {
3105: return '';
3106: }
3107: }
3108:
1.112 bowersj2 3109: =pod
3110:
3111: =back
3112:
3113: =head1 Access .tab File Data
3114:
3115: =over 4
3116:
1.648 raeburn 3117: =item * &languageids()
1.112 bowersj2 3118:
3119: returns list of all language ids
3120:
3121: =cut
3122:
1.14 harris41 3123: sub languageids {
1.16 harris41 3124: return sort(keys(%language));
1.14 harris41 3125: }
3126:
1.112 bowersj2 3127: =pod
3128:
1.648 raeburn 3129: =item * &languagedescription()
1.112 bowersj2 3130:
3131: returns description of a specified language id
3132:
3133: =cut
3134:
1.14 harris41 3135: sub languagedescription {
1.125 www 3136: my $code=shift;
3137: return ($supported_language{$code}?'* ':'').
3138: $language{$code}.
1.126 www 3139: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3140: }
3141:
3142: sub plainlanguagedescription {
3143: my $code=shift;
3144: return $language{$code};
3145: }
3146:
3147: sub supportedlanguagecode {
3148: my $code=shift;
3149: return $supported_language{$code};
1.97 www 3150: }
3151:
1.112 bowersj2 3152: =pod
3153:
1.648 raeburn 3154: =item * ©rightids()
1.112 bowersj2 3155:
3156: returns list of all copyrights
3157:
3158: =cut
3159:
3160: sub copyrightids {
3161: return sort(keys(%cprtag));
3162: }
3163:
3164: =pod
3165:
1.648 raeburn 3166: =item * ©rightdescription()
1.112 bowersj2 3167:
3168: returns description of a specified copyright id
3169:
3170: =cut
3171:
3172: sub copyrightdescription {
1.166 www 3173: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3174: }
1.197 matthew 3175:
3176: =pod
3177:
1.648 raeburn 3178: =item * &source_copyrightids()
1.192 taceyjo1 3179:
3180: returns list of all source copyrights
3181:
3182: =cut
3183:
3184: sub source_copyrightids {
3185: return sort(keys(%scprtag));
3186: }
3187:
3188: =pod
3189:
1.648 raeburn 3190: =item * &source_copyrightdescription()
1.192 taceyjo1 3191:
3192: returns description of a specified source copyright id
3193:
3194: =cut
3195:
3196: sub source_copyrightdescription {
3197: return &mt($scprtag{shift(@_)});
3198: }
1.112 bowersj2 3199:
3200: =pod
3201:
1.648 raeburn 3202: =item * &filecategories()
1.112 bowersj2 3203:
3204: returns list of all file categories
3205:
3206: =cut
3207:
3208: sub filecategories {
3209: return sort(keys(%category_extensions));
3210: }
3211:
3212: =pod
3213:
1.648 raeburn 3214: =item * &filecategorytypes()
1.112 bowersj2 3215:
3216: returns list of file types belonging to a given file
3217: category
3218:
3219: =cut
3220:
3221: sub filecategorytypes {
1.356 albertel 3222: my ($cat) = @_;
3223: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3224: }
3225:
3226: =pod
3227:
1.648 raeburn 3228: =item * &fileembstyle()
1.112 bowersj2 3229:
3230: returns embedding style for a specified file type
3231:
3232: =cut
3233:
3234: sub fileembstyle {
3235: return $fe{lc(shift(@_))};
1.169 www 3236: }
3237:
1.351 www 3238: sub filemimetype {
3239: return $fm{lc(shift(@_))};
3240: }
3241:
1.169 www 3242:
3243: sub filecategoryselect {
3244: my ($name,$value)=@_;
1.189 matthew 3245: return &select_form($value,$name,
1.169 www 3246: '' => &mt('Any category'),
3247: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3248: }
3249:
3250: =pod
3251:
1.648 raeburn 3252: =item * &filedescription()
1.112 bowersj2 3253:
3254: returns description for a specified file type
3255:
3256: =cut
3257:
3258: sub filedescription {
1.188 matthew 3259: my $file_description = $fd{lc(shift())};
3260: $file_description =~ s:([\[\]]):~$1:g;
3261: return &mt($file_description);
1.112 bowersj2 3262: }
3263:
3264: =pod
3265:
1.648 raeburn 3266: =item * &filedescriptionex()
1.112 bowersj2 3267:
3268: returns description for a specified file type with
3269: extra formatting
3270:
3271: =cut
3272:
3273: sub filedescriptionex {
3274: my $ex=shift;
1.188 matthew 3275: my $file_description = $fd{lc($ex)};
3276: $file_description =~ s:([\[\]]):~$1:g;
3277: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3278: }
3279:
3280: # End of .tab access
3281: =pod
3282:
3283: =back
3284:
3285: =cut
3286:
3287: # ------------------------------------------------------------------ File Types
3288: sub fileextensions {
3289: return sort(keys(%fe));
3290: }
3291:
1.97 www 3292: # ----------------------------------------------------------- Display Languages
3293: # returns a hash with all desired display languages
3294: #
3295:
3296: sub display_languages {
3297: my %languages=();
1.692.4.1 raeburn 3298: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3299: $languages{$lang}=1;
1.97 www 3300: }
3301: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3302: if ($env{'form.displaylanguage'}) {
1.356 albertel 3303: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3304: $languages{$lang}=1;
1.97 www 3305: }
3306: }
3307: return %languages;
1.14 harris41 3308: }
3309:
1.582 albertel 3310: sub languages {
3311: my ($possible_langs) = @_;
1.692.4.1 raeburn 3312: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3313: if (!ref($possible_langs)) {
3314: if( wantarray ) {
3315: return @preferred_langs;
3316: } else {
3317: return $preferred_langs[0];
3318: }
3319: }
3320: my %possibilities = map { $_ => 1 } (@$possible_langs);
3321: my @preferred_possibilities;
3322: foreach my $preferred_lang (@preferred_langs) {
3323: if (exists($possibilities{$preferred_lang})) {
3324: push(@preferred_possibilities, $preferred_lang);
3325: }
3326: }
3327: if( wantarray ) {
3328: return @preferred_possibilities;
3329: }
3330: return $preferred_possibilities[0];
3331: }
3332:
1.692.4.2 raeburn 3333: sub user_lang {
3334: my ($touname,$toudom,$fromcid) = @_;
3335: my @userlangs;
3336: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3337: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3338: $env{'course.'.$fromcid.'.languages'}));
3339: } else {
3340: my %langhash = &getlangs($touname,$toudom);
3341: if ($langhash{'languages'} ne '') {
3342: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3343: } else {
3344: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3345: if ($domdefs{'lang_def'} ne '') {
3346: @userlangs = ($domdefs{'lang_def'});
3347: }
3348: }
3349: }
3350: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3351: my $user_lh = Apache::localize->get_handle(@languages);
3352: return $user_lh;
3353: }
3354:
1.112 bowersj2 3355: ###############################################################
3356: ## Student Answer Attempts ##
3357: ###############################################################
3358:
3359: =pod
3360:
3361: =head1 Alternate Problem Views
3362:
3363: =over 4
3364:
1.648 raeburn 3365: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3366: $getattempt, $regexp, $gradesub)
3367:
3368: Return string with previous attempt on problem. Arguments:
3369:
3370: =over 4
3371:
3372: =item * $symb: Problem, including path
3373:
3374: =item * $username: username of the desired student
3375:
3376: =item * $domain: domain of the desired student
1.14 harris41 3377:
1.112 bowersj2 3378: =item * $course: Course ID
1.14 harris41 3379:
1.112 bowersj2 3380: =item * $getattempt: Leave blank for all attempts, otherwise put
3381: something
1.14 harris41 3382:
1.112 bowersj2 3383: =item * $regexp: if string matches this regexp, the string will be
3384: sent to $gradesub
1.14 harris41 3385:
1.112 bowersj2 3386: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3387:
1.112 bowersj2 3388: =back
1.14 harris41 3389:
1.112 bowersj2 3390: The output string is a table containing all desired attempts, if any.
1.16 harris41 3391:
1.112 bowersj2 3392: =cut
1.1 albertel 3393:
3394: sub get_previous_attempt {
1.43 ng 3395: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3396: my $prevattempts='';
1.43 ng 3397: no strict 'refs';
1.1 albertel 3398: if ($symb) {
1.3 albertel 3399: my (%returnhash)=
3400: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3401: if ($returnhash{'version'}) {
3402: my %lasthash=();
3403: my $version;
3404: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3405: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3406: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3407: }
1.1 albertel 3408: }
1.596 albertel 3409: $prevattempts=&start_data_table().&start_data_table_header_row();
3410: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3411: foreach my $key (sort(keys(%lasthash))) {
3412: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3413: if ($#parts > 0) {
1.31 albertel 3414: my $data=$parts[-1];
3415: pop(@parts);
1.596 albertel 3416: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
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.40 ng 3426: if ($getattempt eq '') {
3427: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3428: $prevattempts.=&start_data_table_row().
3429: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3430: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3431: my $value = &format_previous_attempt_value($key,
3432: $returnhash{$version.':'.$key});
3433: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3434: }
1.596 albertel 3435: $prevattempts.=&end_data_table_row();
1.40 ng 3436: }
1.1 albertel 3437: }
1.596 albertel 3438: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3439: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3440: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3441: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3442: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3443: }
1.596 albertel 3444: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3445: } else {
1.596 albertel 3446: $prevattempts=
3447: &start_data_table().&start_data_table_row().
3448: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3449: &end_data_table_row().&end_data_table();
1.1 albertel 3450: }
3451: } else {
1.596 albertel 3452: $prevattempts=
3453: &start_data_table().&start_data_table_row().
3454: '<td>'.&mt('No data.').'</td>'.
3455: &end_data_table_row().&end_data_table();
1.1 albertel 3456: }
1.10 albertel 3457: }
3458:
1.581 albertel 3459: sub format_previous_attempt_value {
3460: my ($key,$value) = @_;
3461: if ($key =~ /timestamp/) {
3462: $value = &Apache::lonlocal::locallocaltime($value);
3463: } elsif (ref($value) eq 'ARRAY') {
3464: $value = '('.join(', ', @{ $value }).')';
3465: } else {
3466: $value = &unescape($value);
3467: }
3468: return $value;
3469: }
3470:
3471:
1.107 albertel 3472: sub relative_to_absolute {
3473: my ($url,$output)=@_;
3474: my $parser=HTML::TokeParser->new(\$output);
3475: my $token;
3476: my $thisdir=$url;
3477: my @rlinks=();
3478: while ($token=$parser->get_token) {
3479: if ($token->[0] eq 'S') {
3480: if ($token->[1] eq 'a') {
3481: if ($token->[2]->{'href'}) {
3482: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3483: }
3484: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3485: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3486: } elsif ($token->[1] eq 'base') {
3487: $thisdir=$token->[2]->{'href'};
3488: }
3489: }
3490: }
3491: $thisdir=~s-/[^/]*$--;
1.356 albertel 3492: foreach my $link (@rlinks) {
1.692.4.2 raeburn 3493: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3494: ($link=~/^\//) ||
3495: ($link=~/^javascript:/i) ||
3496: ($link=~/^mailto:/i) ||
3497: ($link=~/^\#/)) {
3498: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3499: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3500: }
3501: }
3502: # -------------------------------------------------- Deal with Applet codebases
3503: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3504: return $output;
3505: }
3506:
1.112 bowersj2 3507: =pod
3508:
1.648 raeburn 3509: =item * &get_student_view()
1.112 bowersj2 3510:
3511: show a snapshot of what student was looking at
3512:
3513: =cut
3514:
1.10 albertel 3515: sub get_student_view {
1.186 albertel 3516: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3517: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3518: my (%form);
1.10 albertel 3519: my @elements=('symb','courseid','domain','username');
3520: foreach my $element (@elements) {
1.186 albertel 3521: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3522: }
1.186 albertel 3523: if (defined($moreenv)) {
3524: %form=(%form,%{$moreenv});
3525: }
1.236 albertel 3526: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3527: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3528: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3529: $userview=~s/\<body[^\>]*\>//gi;
3530: $userview=~s/\<\/body\>//gi;
3531: $userview=~s/\<html\>//gi;
3532: $userview=~s/\<\/html\>//gi;
3533: $userview=~s/\<head\>//gi;
3534: $userview=~s/\<\/head\>//gi;
3535: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3536: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3537: if (wantarray) {
3538: return ($userview,$response);
3539: } else {
3540: return $userview;
3541: }
3542: }
3543:
3544: sub get_student_view_with_retries {
3545: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3546:
3547: my $ok = 0; # True if we got a good response.
3548: my $content;
3549: my $response;
3550:
3551: # Try to get the student_view done. within the retries count:
3552:
3553: do {
3554: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3555: $ok = $response->is_success;
3556: if (!$ok) {
3557: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3558: }
3559: $retries--;
3560: } while (!$ok && ($retries > 0));
3561:
3562: if (!$ok) {
3563: $content = ''; # On error return an empty content.
3564: }
1.651 www 3565: if (wantarray) {
3566: return ($content, $response);
3567: } else {
3568: return $content;
3569: }
1.11 albertel 3570: }
3571:
1.112 bowersj2 3572: =pod
3573:
1.648 raeburn 3574: =item * &get_student_answers()
1.112 bowersj2 3575:
3576: show a snapshot of how student was answering problem
3577:
3578: =cut
3579:
1.11 albertel 3580: sub get_student_answers {
1.100 sakharuk 3581: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3582: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3583: my (%moreenv);
1.11 albertel 3584: my @elements=('symb','courseid','domain','username');
3585: foreach my $element (@elements) {
1.186 albertel 3586: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3587: }
1.186 albertel 3588: $moreenv{'grade_target'}='answer';
3589: %moreenv=(%form,%moreenv);
1.497 raeburn 3590: $feedurl = &Apache::lonnet::clutter($feedurl);
3591: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3592: return $userview;
1.1 albertel 3593: }
1.116 albertel 3594:
3595: =pod
3596:
3597: =item * &submlink()
3598:
1.242 albertel 3599: Inputs: $text $uname $udom $symb $target
1.116 albertel 3600:
3601: Returns: A link to grades.pm such as to see the SUBM view of a student
3602:
3603: =cut
3604:
3605: ###############################################
3606: sub submlink {
1.242 albertel 3607: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3608: if (!($uname && $udom)) {
3609: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3610: &Apache::lonnet::whichuser($symb);
1.116 albertel 3611: if (!$symb) { $symb=$cursymb; }
3612: }
1.254 matthew 3613: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3614: $symb=&escape($symb);
1.242 albertel 3615: if ($target) { $target="target=\"$target\""; }
3616: return '<a href="/adm/grades?&command=submission&'.
3617: 'symb='.$symb.'&student='.$uname.
3618: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3619: }
3620: ##############################################
3621:
3622: =pod
3623:
3624: =item * &pgrdlink()
3625:
3626: Inputs: $text $uname $udom $symb $target
3627:
3628: Returns: A link to grades.pm such as to see the PGRD view of a student
3629:
3630: =cut
3631:
3632: ###############################################
3633: sub pgrdlink {
3634: my $link=&submlink(@_);
3635: $link=~s/(&command=submission)/$1&showgrading=yes/;
3636: return $link;
3637: }
3638: ##############################################
3639:
3640: =pod
3641:
3642: =item * &pprmlink()
3643:
3644: Inputs: $text $uname $udom $symb $target
3645:
3646: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3647: student and a specific resource
1.242 albertel 3648:
3649: =cut
3650:
3651: ###############################################
3652: sub pprmlink {
3653: my ($text,$uname,$udom,$symb,$target)=@_;
3654: if (!($uname && $udom)) {
3655: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3656: &Apache::lonnet::whichuser($symb);
1.242 albertel 3657: if (!$symb) { $symb=$cursymb; }
3658: }
1.254 matthew 3659: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3660: $symb=&escape($symb);
1.242 albertel 3661: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3662: return '<a href="/adm/parmset?command=set&'.
3663: 'symb='.$symb.'&uname='.$uname.
3664: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3665: }
3666: ##############################################
1.37 matthew 3667:
1.112 bowersj2 3668: =pod
3669:
3670: =back
3671:
3672: =cut
3673:
1.37 matthew 3674: ###############################################
1.51 www 3675:
3676:
3677: sub timehash {
1.687 raeburn 3678: my ($thistime) = @_;
3679: my $timezone = &Apache::lonlocal::gettimezone();
3680: my $dt = DateTime->from_epoch(epoch => $thistime)
3681: ->set_time_zone($timezone);
3682: my $wday = $dt->day_of_week();
3683: if ($wday == 7) { $wday = 0; }
3684: return ( 'second' => $dt->second(),
3685: 'minute' => $dt->minute(),
3686: 'hour' => $dt->hour(),
3687: 'day' => $dt->day_of_month(),
3688: 'month' => $dt->month(),
3689: 'year' => $dt->year(),
3690: 'weekday' => $wday,
3691: 'dayyear' => $dt->day_of_year(),
3692: 'dlsav' => $dt->is_dst() );
1.51 www 3693: }
3694:
1.370 www 3695: sub utc_string {
3696: my ($date)=@_;
1.371 www 3697: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3698: }
3699:
1.51 www 3700: sub maketime {
3701: my %th=@_;
1.687 raeburn 3702: my ($epoch_time,$timezone,$dt);
3703: $timezone = &Apache::lonlocal::gettimezone();
3704: eval {
3705: $dt = DateTime->new( year => $th{'year'},
3706: month => $th{'month'},
3707: day => $th{'day'},
3708: hour => $th{'hour'},
3709: minute => $th{'minute'},
3710: second => $th{'second'},
3711: time_zone => $timezone,
3712: );
3713: };
3714: if (!$@) {
3715: $epoch_time = $dt->epoch;
3716: if ($epoch_time) {
3717: return $epoch_time;
3718: }
3719: }
1.51 www 3720: return POSIX::mktime(
3721: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3722: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3723: }
3724:
3725: #########################################
1.51 www 3726:
3727: sub findallcourses {
1.482 raeburn 3728: my ($roles,$uname,$udom) = @_;
1.355 albertel 3729: my %roles;
3730: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3731: my %courses;
1.51 www 3732: my $now=time;
1.482 raeburn 3733: if (!defined($uname)) {
3734: $uname = $env{'user.name'};
3735: }
3736: if (!defined($udom)) {
3737: $udom = $env{'user.domain'};
3738: }
3739: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3740: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3741: if (!%roles) {
3742: %roles = (
3743: cc => 1,
1.692.4.22 raeburn 3744: co => 1,
1.482 raeburn 3745: in => 1,
3746: ep => 1,
3747: ta => 1,
3748: cr => 1,
3749: st => 1,
3750: );
3751: }
3752: foreach my $entry (keys(%roleshash)) {
3753: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3754: if ($trole =~ /^cr/) {
3755: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3756: } else {
3757: next if (!exists($roles{$trole}));
3758: }
3759: if ($tend) {
3760: next if ($tend < $now);
3761: }
3762: if ($tstart) {
3763: next if ($tstart > $now);
3764: }
3765: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3766: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3767: if ($secpart eq '') {
3768: ($cnum,$role) = split(/_/,$cnumpart);
3769: $sec = 'none';
3770: $realsec = '';
3771: } else {
3772: $cnum = $cnumpart;
3773: ($sec,$role) = split(/_/,$secpart);
3774: $realsec = $sec;
1.490 raeburn 3775: }
1.482 raeburn 3776: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3777: }
3778: } else {
3779: foreach my $key (keys(%env)) {
1.483 albertel 3780: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3781: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3782: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3783: next if ($role eq 'ca' || $role eq 'aa');
3784: next if (%roles && !exists($roles{$role}));
3785: my ($starttime,$endtime)=split(/\./,$env{$key});
3786: my $active=1;
3787: if ($starttime) {
3788: if ($now<$starttime) { $active=0; }
3789: }
3790: if ($endtime) {
3791: if ($now>$endtime) { $active=0; }
3792: }
3793: if ($active) {
3794: if ($sec eq '') {
3795: $sec = 'none';
3796: }
3797: $courses{$cdom.'_'.$cnum}{$sec} =
3798: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3799: }
3800: }
1.51 www 3801: }
3802: }
1.474 raeburn 3803: return %courses;
1.51 www 3804: }
1.37 matthew 3805:
1.54 www 3806: ###############################################
1.474 raeburn 3807:
3808: sub blockcheck {
1.482 raeburn 3809: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3810:
3811: if (!defined($udom)) {
3812: $udom = $env{'user.domain'};
3813: }
3814: if (!defined($uname)) {
3815: $uname = $env{'user.name'};
3816: }
3817:
3818: # If uname and udom are for a course, check for blocks in the course.
3819:
3820: if (&Apache::lonnet::is_course($udom,$uname)) {
3821: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3822: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3823: return ($startblock,$endblock);
3824: }
1.474 raeburn 3825:
1.502 raeburn 3826: my $startblock = 0;
3827: my $endblock = 0;
1.482 raeburn 3828: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3829:
1.490 raeburn 3830: # If uname is for a user, and activity is course-specific, i.e.,
3831: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3832:
1.490 raeburn 3833: if (($activity eq 'boards' || $activity eq 'chat' ||
3834: $activity eq 'groups') && ($env{'request.course.id'})) {
3835: foreach my $key (keys(%live_courses)) {
3836: if ($key ne $env{'request.course.id'}) {
3837: delete($live_courses{$key});
3838: }
3839: }
3840: }
3841:
3842: my $otheruser = 0;
3843: my %own_courses;
3844: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3845: # Resource belongs to user other than current user.
3846: $otheruser = 1;
3847: # Gather courses for current user
3848: %own_courses =
3849: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3850: }
3851:
3852: # Gather active course roles - course coordinator, instructor,
3853: # exam proctor, ta, student, or custom role.
1.474 raeburn 3854:
3855: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3856: my ($cdom,$cnum);
3857: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3858: $cdom = $env{'course.'.$course.'.domain'};
3859: $cnum = $env{'course.'.$course.'.num'};
3860: } else {
1.490 raeburn 3861: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3862: }
3863: my $no_ownblock = 0;
3864: my $no_userblock = 0;
1.533 raeburn 3865: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3866: # Check if current user has 'evb' priv for this
3867: if (defined($own_courses{$course})) {
3868: foreach my $sec (keys(%{$own_courses{$course}})) {
3869: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3870: if ($sec ne 'none') {
3871: $checkrole .= '/'.$sec;
3872: }
3873: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3874: $no_ownblock = 1;
3875: last;
3876: }
3877: }
3878: }
3879: # if they have 'evb' priv and are currently not playing student
3880: next if (($no_ownblock) &&
3881: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3882: }
1.474 raeburn 3883: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3884: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3885: if ($sec ne 'none') {
1.482 raeburn 3886: $checkrole .= '/'.$sec;
1.474 raeburn 3887: }
1.490 raeburn 3888: if ($otheruser) {
3889: # Resource belongs to user other than current user.
3890: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3891: my ($trole,$tdom,$tnum,$tsec);
3892: my $entry = $live_courses{$course}{$sec};
3893: if ($entry =~ /^cr/) {
3894: ($trole,$tdom,$tnum,$tsec) =
3895: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3896: } else {
3897: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3898: }
3899: my ($spec,$area,$trest,%allroles,%userroles);
3900: $area = '/'.$tdom.'/'.$tnum;
3901: $trest = $tnum;
3902: if ($tsec ne '') {
3903: $area .= '/'.$tsec;
3904: $trest .= '/'.$tsec;
3905: }
3906: $spec = $trole.'.'.$area;
3907: if ($trole =~ /^cr/) {
3908: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3909: $tdom,$spec,$trest,$area);
3910: } else {
3911: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3912: $tdom,$spec,$trest,$area);
3913: }
3914: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3915: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3916: if ($1) {
3917: $no_userblock = 1;
3918: last;
3919: }
3920: }
1.490 raeburn 3921: } else {
3922: # Resource belongs to current user
3923: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3924: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3925: $no_ownblock = 1;
3926: last;
3927: }
1.474 raeburn 3928: }
3929: }
3930: # if they have the evb priv and are currently not playing student
1.482 raeburn 3931: next if (($no_ownblock) &&
1.491 albertel 3932: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3933: next if ($no_userblock);
1.474 raeburn 3934:
1.490 raeburn 3935: # Retrieve blocking times and identity of blocker for course
3936: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3937:
3938: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3939: if (($start != 0) &&
3940: (($startblock == 0) || ($startblock > $start))) {
3941: $startblock = $start;
3942: }
3943: if (($end != 0) &&
3944: (($endblock == 0) || ($endblock < $end))) {
3945: $endblock = $end;
3946: }
1.490 raeburn 3947: }
3948: return ($startblock,$endblock);
3949: }
3950:
3951: sub get_blocks {
3952: my ($setters,$activity,$cdom,$cnum) = @_;
3953: my $startblock = 0;
3954: my $endblock = 0;
3955: my $course = $cdom.'_'.$cnum;
3956: $setters->{$course} = {};
3957: $setters->{$course}{'staff'} = [];
3958: $setters->{$course}{'times'} = [];
3959: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3960: foreach my $record (keys(%records)) {
3961: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3962: if ($start <= time && $end >= time) {
3963: my ($staff_name,$staff_dom,$title,$blocks) =
3964: &parse_block_record($records{$record});
3965: if ($blocks->{$activity} eq 'on') {
3966: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3967: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3968: if ( ($startblock == 0) || ($startblock > $start) ) {
3969: $startblock = $start;
1.490 raeburn 3970: }
1.491 albertel 3971: if ( ($endblock == 0) || ($endblock < $end) ) {
3972: $endblock = $end;
1.474 raeburn 3973: }
3974: }
3975: }
3976: }
3977: return ($startblock,$endblock);
3978: }
3979:
3980: sub parse_block_record {
3981: my ($record) = @_;
3982: my ($setuname,$setudom,$title,$blocks);
3983: if (ref($record) eq 'HASH') {
3984: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3985: $title = &unescape($record->{'event'});
3986: $blocks = $record->{'blocks'};
3987: } else {
3988: my @data = split(/:/,$record,3);
3989: if (scalar(@data) eq 2) {
3990: $title = $data[1];
3991: ($setuname,$setudom) = split(/@/,$data[0]);
3992: } else {
3993: ($setuname,$setudom,$title) = @data;
3994: }
3995: $blocks = { 'com' => 'on' };
3996: }
3997: return ($setuname,$setudom,$title,$blocks);
3998: }
3999:
4000: sub build_block_table {
4001: my ($startblock,$endblock,$setters) = @_;
4002: my %lt = &Apache::lonlocal::texthash(
4003: 'cacb' => 'Currently active communication blocks',
4004: 'cour' => 'Course',
4005: 'dura' => 'Duration',
4006: 'blse' => 'Block set by'
4007: );
4008: my $output;
1.476 raeburn 4009: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 4010: $output .= &start_data_table();
4011: $output .= '
4012: <tr>
4013: <th>'.$lt{'cour'}.'</th>
4014: <th>'.$lt{'dura'}.'</th>
4015: <th>'.$lt{'blse'}.'</th>
4016: </tr>
4017: ';
4018: foreach my $course (keys(%{$setters})) {
4019: my %courseinfo=&Apache::lonnet::coursedescription($course);
4020: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
4021: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 4022: my $fullname = &plainname($uname,$udom);
4023: if (defined($env{'user.name'}) && defined($env{'user.domain'})
4024: && $env{'user.name'} ne 'public'
4025: && $env{'user.domain'} ne 'public') {
4026: $fullname = &aboutmewrapper($fullname,$uname,$udom);
4027: }
1.474 raeburn 4028: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
4029: $openblock = &Apache::lonlocal::locallocaltime($openblock);
4030: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
4031: $output .= &Apache::loncommon::start_data_table_row().
4032: '<td>'.$courseinfo{'description'}.'</td>'.
4033: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 4034: '<td>'.$fullname.'</td>'.
1.474 raeburn 4035: &Apache::loncommon::end_data_table_row();
4036: }
4037: }
4038: $output .= &end_data_table();
4039: }
4040:
1.490 raeburn 4041: sub blocking_status {
4042: my ($activity,$uname,$udom) = @_;
4043: my %setters;
4044: my ($blocked,$output,$ownitem,$is_course);
4045: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
4046: if ($startblock && $endblock) {
4047: $blocked = 1;
4048: if (wantarray) {
4049: my $category;
4050: if ($activity eq 'boards') {
4051: $category = 'Discussion posts in this course';
4052: } elsif ($activity eq 'blogs') {
4053: $category = 'Blogs';
4054: } elsif ($activity eq 'port') {
4055: if (defined($uname) && defined($udom)) {
4056: if ($uname eq $env{'user.name'} &&
4057: $udom eq $env{'user.domain'}) {
4058: $ownitem = 1;
4059: }
4060: }
4061: $is_course = &Apache::lonnet::is_course($udom,$uname);
4062: if ($ownitem) {
4063: $category = 'Your portfolio files';
4064: } elsif ($is_course) {
4065: my $coursedesc;
4066: foreach my $course (keys(%setters)) {
4067: my %courseinfo =
4068: &Apache::lonnet::coursedescription($course);
4069: $coursedesc = $courseinfo{'description'};
4070: }
1.692.4.2 raeburn 4071: $category = "Group portfolio files in the course '$coursedesc'";
1.490 raeburn 4072: } else {
4073: $category = 'Portfolio files belonging to ';
4074: if ($env{'user.name'} eq 'public' &&
4075: $env{'user.domain'} eq 'public') {
4076: $category .= &plainname($uname,$udom);
4077: } else {
4078: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
4079: }
4080: }
4081: } elsif ($activity eq 'groups') {
4082: $category = 'Groups in this course';
4083: }
4084: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
4085: my $showend = &Apache::lonlocal::locallocaltime($endblock);
4086: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
4087: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
4088: $output .= &build_block_table($startblock,$endblock,\%setters);
4089: }
4090: }
4091: }
4092: if (wantarray) {
4093: return ($blocked,$output);
4094: } else {
4095: return $blocked;
4096: }
4097: }
4098:
1.60 matthew 4099: ###############################################
4100:
1.682 raeburn 4101: sub check_ip_acc {
4102: my ($acc)=@_;
4103: &Apache::lonxml::debug("acc is $acc");
4104: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4105: return 1;
4106: }
4107: my $allowed=0;
4108: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4109:
4110: my $name;
4111: foreach my $pattern (split(',',$acc)) {
4112: $pattern =~ s/^\s*//;
4113: $pattern =~ s/\s*$//;
4114: if ($pattern =~ /\*$/) {
4115: #35.8.*
4116: $pattern=~s/\*//;
4117: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4118: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4119: #35.8.3.[34-56]
4120: my $low=$2;
4121: my $high=$3;
4122: $pattern=$1;
4123: if ($ip =~ /^\Q$pattern\E/) {
4124: my $last=(split(/\./,$ip))[3];
4125: if ($last <=$high && $last >=$low) { $allowed=1; }
4126: }
4127: } elsif ($pattern =~ /^\*/) {
4128: #*.msu.edu
4129: $pattern=~s/\*//;
4130: if (!defined($name)) {
4131: use Socket;
4132: my $netaddr=inet_aton($ip);
4133: ($name)=gethostbyaddr($netaddr,AF_INET);
4134: }
4135: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4136: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4137: #127.0.0.1
4138: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4139: } else {
4140: #some.name.com
4141: if (!defined($name)) {
4142: use Socket;
4143: my $netaddr=inet_aton($ip);
4144: ($name)=gethostbyaddr($netaddr,AF_INET);
4145: }
4146: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4147: }
4148: if ($allowed) { last; }
4149: }
4150: return $allowed;
4151: }
4152:
4153: ###############################################
4154:
1.60 matthew 4155: =pod
4156:
1.112 bowersj2 4157: =head1 Domain Template Functions
4158:
4159: =over 4
4160:
4161: =item * &determinedomain()
1.60 matthew 4162:
4163: Inputs: $domain (usually will be undef)
4164:
1.63 www 4165: Returns: Determines which domain should be used for designs
1.60 matthew 4166:
4167: =cut
1.54 www 4168:
1.60 matthew 4169: ###############################################
1.63 www 4170: sub determinedomain {
4171: my $domain=shift;
1.531 albertel 4172: if (! $domain) {
1.60 matthew 4173: # Determine domain if we have not been given one
1.692.4.18 raeburn 4174: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4175: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4176: if ($env{'request.role.domain'}) {
4177: $domain=$env{'request.role.domain'};
1.60 matthew 4178: }
4179: }
1.63 www 4180: return $domain;
4181: }
4182: ###############################################
1.517 raeburn 4183:
1.518 albertel 4184: sub devalidate_domconfig_cache {
4185: my ($udom)=@_;
4186: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4187: }
4188:
4189: # ---------------------- Get domain configuration for a domain
4190: sub get_domainconf {
4191: my ($udom) = @_;
4192: my $cachetime=1800;
4193: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4194: if (defined($cached)) { return %{$result}; }
4195:
4196: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.692.4.31! raeburn 4197: ['login','rolecolors','loginvia'],$udom);
1.632 raeburn 4198: my (%designhash,%legacy);
1.518 albertel 4199: if (keys(%domconfig) > 0) {
4200: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4201: if (keys(%{$domconfig{'login'}})) {
4202: foreach my $key (keys(%{$domconfig{'login'}})) {
1.692.4.2 raeburn 4203: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.692.4.31! raeburn 4204: if ($key eq 'loginvia') {
! 4205: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
! 4206: my @ids = &Apache::lonnet::current_machine_ids();
! 4207: foreach my $hostname (@ids) {
! 4208: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
! 4209: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
! 4210: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
! 4211: $designhash{$udom.'.login.loginvia'} = $server;
! 4212: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
! 4213:
! 4214: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
! 4215: } else {
! 4216: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
! 4217: }
! 4218: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
! 4219: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
! 4220: }
! 4221: }
! 4222: }
! 4223: }
! 4224: }
! 4225: } else {
! 4226: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
! 4227: $designhash{$udom.'.login.'.$key.'_'.$img} =
! 4228: $domconfig{'login'}{$key}{$img};
! 4229: }
1.692.4.2 raeburn 4230: }
4231: } else {
4232: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4233: }
1.632 raeburn 4234: }
4235: } else {
4236: $legacy{'login'} = 1;
1.518 albertel 4237: }
1.632 raeburn 4238: } else {
4239: $legacy{'login'} = 1;
1.518 albertel 4240: }
4241: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4242: if (keys(%{$domconfig{'rolecolors'}})) {
4243: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4244: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4245: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4246: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4247: }
1.518 albertel 4248: }
4249: }
1.632 raeburn 4250: } else {
4251: $legacy{'rolecolors'} = 1;
1.518 albertel 4252: }
1.632 raeburn 4253: } else {
4254: $legacy{'rolecolors'} = 1;
1.518 albertel 4255: }
1.632 raeburn 4256: if (keys(%legacy) > 0) {
4257: my %legacyhash = &get_legacy_domconf($udom);
4258: foreach my $item (keys(%legacyhash)) {
4259: if ($item =~ /^\Q$udom\E\.login/) {
4260: if ($legacy{'login'}) {
4261: $designhash{$item} = $legacyhash{$item};
4262: }
4263: } else {
4264: if ($legacy{'rolecolors'}) {
4265: $designhash{$item} = $legacyhash{$item};
4266: }
1.518 albertel 4267: }
4268: }
4269: }
1.632 raeburn 4270: } else {
4271: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4272: }
4273: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4274: $cachetime);
4275: return %designhash;
4276: }
4277:
1.632 raeburn 4278: sub get_legacy_domconf {
4279: my ($udom) = @_;
4280: my %legacyhash;
4281: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4282: my $designfile = $designdir.'/'.$udom.'.tab';
4283: if (-e $designfile) {
4284: if ( open (my $fh,"<$designfile") ) {
4285: while (my $line = <$fh>) {
4286: next if ($line =~ /^\#/);
4287: chomp($line);
4288: my ($key,$val)=(split(/\=/,$line));
4289: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4290: }
4291: close($fh);
4292: }
4293: }
4294: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4295: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4296: }
4297: return %legacyhash;
4298: }
4299:
1.63 www 4300: =pod
4301:
1.112 bowersj2 4302: =item * &domainlogo()
1.63 www 4303:
4304: Inputs: $domain (usually will be undef)
4305:
4306: Returns: A link to a domain logo, if the domain logo exists.
4307: If the domain logo does not exist, a description of the domain.
4308:
4309: =cut
1.112 bowersj2 4310:
1.63 www 4311: ###############################################
4312: sub domainlogo {
1.517 raeburn 4313: my $domain = &determinedomain(shift);
1.518 albertel 4314: my %designhash = &get_domainconf($domain);
1.517 raeburn 4315: # See if there is a logo
4316: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4317: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4318: if ($imgsrc =~ m{^/(adm|res)/}) {
4319: if ($imgsrc =~ m{^/res/}) {
4320: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4321: &Apache::lonnet::repcopy($local_name);
4322: }
4323: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4324: }
4325: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4326: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4327: return &Apache::lonnet::domain($domain,'description');
1.59 www 4328: } else {
1.60 matthew 4329: return '';
1.59 www 4330: }
4331: }
1.63 www 4332: ##############################################
4333:
4334: =pod
4335:
1.112 bowersj2 4336: =item * &designparm()
1.63 www 4337:
4338: Inputs: $which parameter; $domain (usually will be undef)
4339:
4340: Returns: value of designparamter $which
4341:
4342: =cut
1.112 bowersj2 4343:
1.397 albertel 4344:
1.400 albertel 4345: ##############################################
1.397 albertel 4346: sub designparm {
4347: my ($which,$domain)=@_;
1.258 albertel 4348: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4349: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4350: return '#000000';
4351: }
1.635 raeburn 4352: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4353: return '#FFFFFF';
4354: }
4355: if ($which=~/\.tabbg$/) {
4356: return '#CCCCCC';
4357: }
4358: }
1.397 albertel 4359: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4360: return $env{'environment.color.'.$which};
1.96 www 4361: }
1.63 www 4362: $domain=&determinedomain($domain);
1.518 albertel 4363: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4364: my $output;
1.517 raeburn 4365: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4366: $output = $domdesign{$domain.'.'.$which};
1.63 www 4367: } else {
1.520 raeburn 4368: $output = $defaultdesign{$which};
4369: }
4370: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4371: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4372: if ($output =~ m{^/(adm|res)/}) {
4373: if ($output =~ m{^/res/}) {
4374: my $local_name = &Apache::lonnet::filelocation('',$output);
4375: &Apache::lonnet::repcopy($local_name);
4376: }
1.520 raeburn 4377: $output = &lonhttpdurl($output);
4378: }
1.63 www 4379: }
1.520 raeburn 4380: return $output;
1.63 www 4381: }
1.59 www 4382:
1.60 matthew 4383: ###############################################
4384: ###############################################
4385:
4386: =pod
4387:
1.112 bowersj2 4388: =back
4389:
1.549 albertel 4390: =head1 HTML Helpers
1.112 bowersj2 4391:
4392: =over 4
4393:
4394: =item * &bodytag()
1.60 matthew 4395:
4396: Returns a uniform header for LON-CAPA web pages.
4397:
4398: Inputs:
4399:
1.112 bowersj2 4400: =over 4
4401:
4402: =item * $title, A title to be displayed on the page.
4403:
4404: =item * $function, the current role (can be undef).
4405:
4406: =item * $addentries, extra parameters for the <body> tag.
4407:
4408: =item * $bodyonly, if defined, only return the <body> tag.
4409:
4410: =item * $domain, if defined, force a given domain.
4411:
4412: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4413: text interface only)
1.60 matthew 4414:
1.326 albertel 4415: =item * $customtitle, alternate text to use instead of $title
4416: in the title box that appears, this text
4417: is not auto translated like the $title is
1.309 albertel 4418:
4419: =item * $notopbar, if true, keep the 'what is this' info but remove the
4420: navigational links
1.317 albertel 4421:
1.338 albertel 4422: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4423:
4424: =item * $notitle, if true keep the nav controls, but remove the title bar
4425:
1.361 albertel 4426: =item * $no_inline_link, if true and in remote mode, don't show the
4427: 'Switch To Inline Menu' link
4428:
1.460 albertel 4429: =item * $args, optional argument valid values are
4430: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4431: inherit_jsmath -> when creating popup window in a page,
4432: should it have jsmath forced on by the
4433: current page
1.460 albertel 4434:
1.112 bowersj2 4435: =back
4436:
1.60 matthew 4437: Returns: A uniform header for LON-CAPA web pages.
4438: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4439: If $bodyonly is undef or zero, an html string containing a <body> tag and
4440: other decorations will be returned.
4441:
4442: =cut
4443:
1.54 www 4444: sub bodytag {
1.309 albertel 4445: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4446: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4447:
1.460 albertel 4448: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4449:
1.183 matthew 4450: $function = &get_users_function() if (!$function);
1.339 albertel 4451: my $img = &designparm($function.'.img',$domain);
4452: my $font = &designparm($function.'.font',$domain);
4453: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4454:
1.692.4.2 raeburn 4455: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4456: 'bgcolor' => $pgbg,
1.339 albertel 4457: 'text' => $font,
4458: 'alink' => &designparm($function.'.alink',$domain),
4459: 'vlink' => &designparm($function.'.vlink',$domain),
4460: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4461: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4462:
1.63 www 4463: # role and realm
1.378 raeburn 4464: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4465: if ($role eq 'ca') {
1.479 albertel 4466: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4467: $realm = &plainname($rname,$rdom);
1.378 raeburn 4468: }
1.55 www 4469: # realm
1.258 albertel 4470: if ($env{'request.course.id'}) {
1.378 raeburn 4471: if ($env{'request.role'} !~ /^cr/) {
4472: $role = &Apache::lonnet::plaintext($role,&course_type());
4473: }
1.359 albertel 4474: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4475: } else {
4476: $role = &Apache::lonnet::plaintext($role);
1.54 www 4477: }
1.433 albertel 4478:
1.359 albertel 4479: if (!$realm) { $realm=' '; }
1.55 www 4480: # Set messages
1.60 matthew 4481: my $messages=&domainlogo($domain);
1.330 albertel 4482:
1.438 albertel 4483: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4484:
1.101 www 4485: # construct main body tag
1.359 albertel 4486: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4487: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4488:
1.530 albertel 4489: if ($bodyonly) {
1.60 matthew 4490: return $bodytag;
1.258 albertel 4491: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4492: # Accessibility
1.224 raeburn 4493:
1.337 albertel 4494: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4495: if (!$notitle) {
1.337 albertel 4496: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4497: }
4498: return $bodytag;
1.359 albertel 4499: }
4500:
1.410 albertel 4501: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4502: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4503: undef($role);
1.434 albertel 4504: } else {
4505: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4506: }
1.359 albertel 4507:
4508: my $roleinfo=(<<ENDROLE);
4509: <td class="LC_title_bar_who">
4510: <div class="LC_title_bar_name">
1.410 albertel 4511: $name
1.361 albertel 4512:
1.359 albertel 4513: </div>
4514: <div class="LC_title_bar_role">
1.361 albertel 4515: $role
1.359 albertel 4516: </div>
4517: <div class="LC_title_bar_realm">
1.361 albertel 4518: $realm
1.359 albertel 4519: </div>
1.206 albertel 4520: </td>
4521: ENDROLE
1.235 raeburn 4522:
1.359 albertel 4523: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4524: if ($customtitle) {
4525: $titleinfo = $customtitle;
4526: }
4527: #
4528: # Extra info if you are the DC
4529: my $dc_info = '';
4530: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4531: $env{'course.'.$env{'request.course.id'}.
4532: '.domain'}.'/'})) {
4533: my $cid = $env{'request.course.id'};
4534: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4535: $dc_info =~ s/\s+$//;
1.359 albertel 4536: $dc_info = '('.$dc_info.')';
4537: }
4538:
1.644 www 4539: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4540: # No Remote
1.258 albertel 4541: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4542: $forcereg=1;
4543: }
4544:
4545: if (!$customtitle && $env{'request.state'} eq 'construct') {
4546: # this is for resources; directories have customtitle, and crumbs
4547: # and select recent are created in lonpubdir.pm
1.229 albertel 4548: my ($uname,$thisdisfn)=
1.258 albertel 4549: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4550: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4551: $formaction=~s/\/+/\//g;
4552:
1.359 albertel 4553: my $parentpath = '';
4554: my $lastitem = '';
4555: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4556: $parentpath = $1;
4557: $lastitem = $2;
4558: } else {
4559: $lastitem = $thisdisfn;
4560: }
4561: $titleinfo =
1.640 bisitz 4562: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4563: .'<b>'.&mt('Construction Space').'</b>: '
4564: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4565: .'" target="_top"><tt><b>'
4566: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
4567: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4568: .'</form>'
4569: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4570: }
1.359 albertel 4571:
1.337 albertel 4572: my $titletable;
1.338 albertel 4573: if (!$notitle) {
1.337 albertel 4574: $titletable =
1.359 albertel 4575: '<table id="LC_title_bar">'.
4576: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4577: '</tr></table>';
1.337 albertel 4578: }
1.359 albertel 4579: if ($notopbar) {
4580: $bodytag .= $titletable;
4581: } else {
4582: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4583: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4584: $titletable);
1.272 raeburn 4585: } else {
1.336 albertel 4586: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4587: $titletable;
1.272 raeburn 4588: }
1.235 raeburn 4589: }
4590: return $bodytag;
1.94 www 4591: }
1.95 www 4592:
1.93 www 4593: #
1.95 www 4594: # Top frame rendering, Remote is up
1.93 www 4595: #
1.359 albertel 4596:
1.517 raeburn 4597: my $imgsrc = $img;
4598: if ($img =~ /^\/adm/) {
1.575 albertel 4599: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4600: }
4601: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4602:
1.305 www 4603: # Explicit link to get inline menu
1.361 albertel 4604: my $menu= ($no_inline_link?''
4605: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4606: #
1.338 albertel 4607: if ($notitle) {
1.337 albertel 4608: return $bodytag;
4609: }
1.94 www 4610: return(<<ENDBODY);
1.60 matthew 4611: $bodytag
1.359 albertel 4612: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4613: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4614: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4615: </tr>
1.359 albertel 4616: <tr><td>$titleinfo $dc_info $menu</td>
4617: $roleinfo
1.368 albertel 4618: </tr>
1.356 albertel 4619: </table>
1.54 www 4620: ENDBODY
1.182 matthew 4621: }
4622:
1.330 albertel 4623: sub make_attr_string {
4624: my ($register,$attr_ref) = @_;
4625:
4626: if ($attr_ref && !ref($attr_ref)) {
4627: die("addentries Must be a hash ref ".
4628: join(':',caller(1))." ".
4629: join(':',caller(0))." ");
4630: }
4631:
4632: if ($register) {
1.339 albertel 4633: my ($on_load,$on_unload);
4634: foreach my $key (keys(%{$attr_ref})) {
4635: if (lc($key) eq 'onload') {
4636: $on_load.=$attr_ref->{$key}.';';
4637: delete($attr_ref->{$key});
4638:
4639: } elsif (lc($key) eq 'onunload') {
4640: $on_unload.=$attr_ref->{$key}.';';
4641: delete($attr_ref->{$key});
4642: }
4643: }
4644: $attr_ref->{'onload'} =
4645: &Apache::lonmenu::loadevents(). $on_load;
4646: $attr_ref->{'onunload'}=
4647: &Apache::lonmenu::unloadevents().$on_unload;
4648: }
4649:
4650: # Accessibility font enhance
4651: if ($env{'browser.fontenhance'} eq 'on') {
4652: my $style;
4653: foreach my $key (keys(%{$attr_ref})) {
4654: if (lc($key) eq 'style') {
4655: $style.=$attr_ref->{$key}.';';
4656: delete($attr_ref->{$key});
4657: }
4658: }
4659: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4660: }
1.339 albertel 4661:
4662: if ($env{'browser.blackwhite'} eq 'on') {
4663: delete($attr_ref->{'font'});
4664: delete($attr_ref->{'link'});
4665: delete($attr_ref->{'alink'});
4666: delete($attr_ref->{'vlink'});
4667: delete($attr_ref->{'bgcolor'});
4668: delete($attr_ref->{'background'});
4669: }
4670:
1.330 albertel 4671: my $attr_string;
4672: foreach my $attr (keys(%$attr_ref)) {
4673: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4674: }
4675: return $attr_string;
4676: }
4677:
4678:
1.182 matthew 4679: ###############################################
1.251 albertel 4680: ###############################################
4681:
4682: =pod
4683:
4684: =item * &endbodytag()
4685:
4686: Returns a uniform footer for LON-CAPA web pages.
4687:
1.635 raeburn 4688: Inputs: 1 - optional reference to an args hash
4689: If in the hash, key for noredirectlink has a value which evaluates to true,
4690: a 'Continue' link is not displayed if the page contains an
4691: internal redirect in the <head></head> section,
4692: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4693:
4694: =cut
4695:
4696: sub endbodytag {
1.635 raeburn 4697: my ($args) = @_;
1.251 albertel 4698: my $endbodytag='</body>';
1.269 albertel 4699: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4700: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4701: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4702: $endbodytag=
4703: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4704: &mt('Continue').'</a>'.
4705: $endbodytag;
4706: }
1.315 albertel 4707: }
1.251 albertel 4708: return $endbodytag;
4709: }
4710:
1.352 albertel 4711: =pod
4712:
4713: =item * &standard_css()
4714:
4715: Returns a style sheet
4716:
4717: Inputs: (all optional)
4718: domain -> force to color decorate a page for a specific
4719: domain
4720: function -> force usage of a specific rolish color scheme
4721: bgcolor -> override the default page bgcolor
4722:
4723: =cut
4724:
1.343 albertel 4725: sub standard_css {
1.345 albertel 4726: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4727: $function = &get_users_function() if (!$function);
4728: my $img = &designparm($function.'.img', $domain);
4729: my $tabbg = &designparm($function.'.tabbg', $domain);
4730: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4731: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4732: my $pgbg_or_bgcolor =
4733: $bgcolor ||
1.352 albertel 4734: &designparm($function.'.pgbg', $domain);
1.382 albertel 4735: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4736: my $alink = &designparm($function.'.alink', $domain);
4737: my $vlink = &designparm($function.'.vlink', $domain);
4738: my $link = &designparm($function.'.link', $domain);
4739:
1.602 albertel 4740: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4741: my $mono = 'monospace';
1.692.4.13 raeburn 4742: my $data_table_head = $tabbg;
1.692.4.6 raeburn 4743: my $data_table_light = '#FAFAFA';
4744: my $data_table_dark = '#F0F0F0';
1.470 banghart 4745: my $data_table_darker = '#CCCCCC';
1.349 albertel 4746: my $data_table_highlight = '#FFFF00';
1.352 albertel 4747: my $mail_new = '#FFBB77';
4748: my $mail_new_hover = '#DD9955';
4749: my $mail_read = '#BBBB77';
4750: my $mail_read_hover = '#999944';
4751: my $mail_replied = '#AAAA88';
4752: my $mail_replied_hover = '#888855';
4753: my $mail_other = '#99BBBB';
4754: my $mail_other_hover = '#669999';
1.391 albertel 4755: my $table_header = '#DDDDDD';
1.489 raeburn 4756: my $feedback_link_bg = '#BBBBBB';
1.692.4.3 raeburn 4757: my $lg_border_color = '#C8C8C8';
1.392 albertel 4758:
1.608 albertel 4759: my $border = ($env{'browser.type'} eq 'explorer' ||
1.692.4.2 raeburn 4760: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4761: : '0 3px 0 4px';
1.448 albertel 4762:
1.523 albertel 4763:
1.343 albertel 4764: return <<END;
1.345 albertel 4765: h1, h2, h3, th { font-family: $sans }
1.343 albertel 4766: a:focus { color: red; background: yellow }
1.692.4.6 raeburn 4767:
4768: hr {
4769: clear: both;
4770: color: $tabbg;
4771: background-color: $tabbg;
4772: height: 3px;
4773: border: none;
4774: }
4775:
1.510 albertel 4776: table.thinborder,
1.523 albertel 4777:
1.510 albertel 4778: table.thinborder tr th {
4779: border-style: solid;
4780: border-width: 1px;
4781: background: $tabbg;
4782: }
1.523 albertel 4783: table.thinborder tr td {
1.510 albertel 4784: border-style: solid;
4785: border-width: 1px
4786: }
1.426 albertel 4787:
1.343 albertel 4788: form, .inline { display: inline; }
4789: .center { text-align: center; }
1.593 albertel 4790: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4791: .LC_error {
4792: color: red;
4793: font-size: larger;
4794: }
1.457 albertel 4795: .LC_warning,
4796: .LC_diff_removed {
1.394 albertel 4797: color: red;
4798: }
1.532 albertel 4799:
4800: .LC_info,
1.457 albertel 4801: .LC_success,
4802: .LC_diff_added {
1.350 albertel 4803: color: green;
4804: }
1.692.4.2 raeburn 4805:
4806: div.LC_confirm_box {
4807: background-color: #FAFAFA;
4808: border: 1px solid $lg_border_color;
4809: margin-right: 0;
4810: padding: 5px;
4811: }
4812:
4813: div.LC_confirm_box .LC_error img,
4814: div.LC_confirm_box .LC_success img {
4815: vertical-align: middle;
1.543 albertel 4816: }
4817:
1.440 albertel 4818: .LC_icon {
1.692.4.2 raeburn 4819: border: none;
1.440 albertel 4820: }
1.539 albertel 4821: .LC_indexer_icon {
1.692.4.2 raeburn 4822: border: 0;
1.539 albertel 4823: height: 22px;
4824: }
1.543 albertel 4825: .LC_docs_spacer {
4826: width: 25px;
4827: height: 1px;
1.692.4.2 raeburn 4828: border: none;
1.543 albertel 4829: }
1.346 albertel 4830:
1.532 albertel 4831: .LC_internal_info {
1.692.4.2 raeburn 4832: color: #999999;
1.532 albertel 4833: }
4834:
1.692.4.19 raeburn 4835: .LC_discussion {
4836: background: $tabbg;
4837: border: 1px solid black;
4838: margin: 2px;
4839: }
4840:
4841: .LC_disc_action_links_bar {
4842: background: $tabbg;
4843: border: none;
4844: margin: 4px;
4845: }
4846:
4847: .LC_disc_action_left {
4848: text-align: left;
4849: }
4850:
4851: .LC_disc_action_right {
4852: text-align: right;
4853: }
4854:
4855: .LC_disc_new_item {
4856: background: white;
4857: border: 2px solid red;
4858: margin: 2px;
4859: }
4860:
4861: .LC_disc_old_item {
4862: background: white;
4863: border: 1px solid black;
4864: margin: 2px;
4865: }
4866:
1.458 albertel 4867: table.LC_pastsubmission {
4868: border: 1px solid black;
4869: margin: 2px;
4870: }
4871:
1.606 albertel 4872: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4873: width: 100%;
4874: background: $pgbg;
1.392 albertel 4875: border: 2px;
1.402 albertel 4876: border-collapse: separate;
1.692.4.2 raeburn 4877: padding: 0;
1.345 albertel 4878: }
1.392 albertel 4879:
1.606 albertel 4880: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4881: table#LC_title_bar.LC_with_remote {
1.359 albertel 4882: width: 100%;
1.392 albertel 4883: border-color: $pgbg;
4884: border-style: solid;
4885: border-width: $border;
4886:
1.379 albertel 4887: background: $pgbg;
4888: font-family: $sans;
1.392 albertel 4889: border-collapse: collapse;
1.692.4.2 raeburn 4890: padding: 0;
1.359 albertel 4891: }
1.392 albertel 4892:
1.409 albertel 4893: table.LC_docs_path {
4894: width: 100%;
4895: border: 0;
4896: background: $pgbg;
4897: font-family: $sans;
4898: border-collapse: collapse;
1.692.4.2 raeburn 4899: padding: 0;
1.409 albertel 4900: }
4901:
1.359 albertel 4902: table#LC_title_bar td {
4903: background: $tabbg;
4904: }
4905: table#LC_title_bar td.LC_title_bar_who {
4906: background: $tabbg;
4907: color: $font;
1.427 albertel 4908: font: small $sans;
1.359 albertel 4909: text-align: right;
4910: }
1.469 banghart 4911: span.LC_metadata {
4912: font-family: $sans;
4913: }
1.359 albertel 4914: span.LC_title_bar_title {
1.416 albertel 4915: font: bold x-large $sans;
1.359 albertel 4916: }
4917: table#LC_title_bar td.LC_title_bar_domain_logo {
4918: background: $sidebg;
4919: text-align: right;
1.692.4.2 raeburn 4920: padding: 0;
1.368 albertel 4921: }
4922: table#LC_title_bar td.LC_title_bar_role_logo {
4923: background: $sidebg;
1.692.4.2 raeburn 4924: padding: 0;
1.359 albertel 4925: }
4926:
1.346 albertel 4927: table#LC_menubuttons_mainmenu {
1.526 www 4928: width: 100%;
1.692.4.2 raeburn 4929: border: 0;
1.346 albertel 4930: border-spacing: 1px;
1.692.4.2 raeburn 4931: padding: 0 1px;
4932: margin: 0;
1.346 albertel 4933: border-collapse: separate;
4934: }
4935: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
1.692.4.2 raeburn 4936: border: none;
1.346 albertel 4937: }
1.345 albertel 4938: table#LC_top_nav td {
4939: background: $tabbg;
1.692.4.2 raeburn 4940: border: none;
1.407 albertel 4941: font-size: small;
1.345 albertel 4942: }
4943: table#LC_top_nav td a, div#LC_top_nav a {
4944: color: $font;
4945: font-family: $sans;
4946: }
1.364 albertel 4947: table#LC_top_nav td.LC_top_nav_logo {
4948: background: $tabbg;
1.432 albertel 4949: text-align: left;
1.408 albertel 4950: white-space: nowrap;
1.432 albertel 4951: width: 31px;
1.408 albertel 4952: }
4953: table#LC_top_nav td.LC_top_nav_logo img {
1.692.4.2 raeburn 4954: border: none;
1.408 albertel 4955: vertical-align: bottom;
1.364 albertel 4956: }
1.432 albertel 4957: table#LC_top_nav td.LC_top_nav_exit,
4958: table#LC_top_nav td.LC_top_nav_help {
4959: width: 2.0em;
4960: }
1.442 albertel 4961: table#LC_top_nav td.LC_top_nav_login {
4962: width: 4.0em;
4963: text-align: center;
4964: }
1.409 albertel 4965: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4966: background: $tabbg;
4967: color: $font;
4968: font-family: $sans;
1.358 albertel 4969: font-size: smaller;
1.357 albertel 4970: }
1.411 albertel 4971: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4972: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4973: background: $tabbg;
4974: color: $font;
4975: font-family: $sans;
4976: font-size: larger;
4977: text-align: right;
4978: }
1.383 albertel 4979: td.LC_table_cell_checkbox {
4980: text-align: center;
4981: }
1.522 albertel 4982: table#LC_mainmenu td.LC_mainmenu_column {
4983: vertical-align: top;
4984: }
4985:
1.346 albertel 4986: .LC_menubuttons_inline_text {
4987: color: $font;
4988: font-family: $sans;
4989: font-size: smaller;
4990: }
4991:
1.526 www 4992: .LC_menubuttons_link {
4993: text-decoration: none;
4994: }
1.692.4.2 raeburn 4995: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4996: .LC_menubuttons_category {
1.521 www 4997: color: $font;
1.526 www 4998: background: $pgbg;
1.521 www 4999: font-family: $sans;
5000: font-size: larger;
5001: font-weight: bold;
5002: }
5003:
1.346 albertel 5004: td.LC_menubuttons_text {
1.526 www 5005: width: 90%;
1.346 albertel 5006: color: $font;
5007: font-family: $sans;
5008: }
1.526 www 5009:
1.346 albertel 5010: td.LC_menubuttons_img {
5011: }
1.526 www 5012:
1.346 albertel 5013: .LC_current_location {
5014: font-family: $sans;
5015: background: $tabbg;
5016: }
5017: .LC_new_mail {
5018: font-family: $sans;
1.634 www 5019: background: $tabbg;
1.346 albertel 5020: font-weight: bold;
5021: }
1.347 albertel 5022:
1.527 www 5023: .LC_dropadd_labeltext {
5024: font-family: $sans;
5025: text-align: right;
5026: }
5027:
5028: .LC_preferences_labeltext {
5029: font-family: $sans;
5030: text-align: right;
5031: }
5032:
1.666 raeburn 5033: .LC_roleslog_note {
5034: font-size: smaller;
5035: }
5036:
1.692.4.2 raeburn 5037: .LC_mail_functions {
5038: font-weight: bold;
5039: }
5040:
1.440 albertel 5041: table.LC_aboutme_port {
1.692.4.2 raeburn 5042: border: none;
1.440 albertel 5043: border-collapse: collapse;
1.692.4.2 raeburn 5044: border-spacing: 0;
1.440 albertel 5045: }
1.349 albertel 5046: table.LC_data_table, table.LC_mail_list {
1.347 albertel 5047: border: 1px solid #000000;
1.402 albertel 5048: border-collapse: separate;
1.426 albertel 5049: border-spacing: 1px;
1.610 albertel 5050: background: $pgbg;
1.347 albertel 5051: }
1.422 albertel 5052: .LC_data_table_dense {
5053: font-size: small;
5054: }
1.507 raeburn 5055: table.LC_nested_outer {
5056: border: 1px solid #000000;
1.589 raeburn 5057: border-collapse: collapse;
1.692.4.2 raeburn 5058: border-spacing: 0;
1.507 raeburn 5059: width: 100%;
5060: }
1.692.4.11 raeburn 5061: table.LC_innerpickbox,
1.507 raeburn 5062: table.LC_nested {
1.692.4.2 raeburn 5063: border: none;
1.589 raeburn 5064: border-collapse: collapse;
1.692.4.2 raeburn 5065: border-spacing: 0;
1.507 raeburn 5066: width: 100%;
5067: }
1.523 albertel 5068: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
1.692.4.11 raeburn 5069: table.LC_prior_tries tr th,
5070: table.LC_innerpickbox tr th {
1.349 albertel 5071: font-weight: bold;
5072: background-color: $data_table_head;
1.421 albertel 5073: font-size: smaller;
1.347 albertel 5074: }
1.692.4.11 raeburn 5075: table.LC_innerpickbox tr th,
5076: table.LC_innerpickbox tr td {
5077: vertical-align: top;
5078: }
1.692.4.2 raeburn 5079: table.LC_data_table tr.LC_info_row > td {
5080: background-color: #CCCCCC;
5081: font-weight: bold;
5082: text-align: left;
5083: }
1.610 albertel 5084: table.LC_data_table tr.LC_odd_row > td,
1.692.4.2 raeburn 5085: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 5086: table.LC_aboutme_port tr td {
1.349 albertel 5087: background-color: $data_table_light;
1.425 albertel 5088: padding: 2px;
1.347 albertel 5089: }
1.610 albertel 5090: table.LC_data_table tr.LC_even_row > td,
1.692.4.2 raeburn 5091: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 5092: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 5093: background-color: $data_table_dark;
1.692.4.2 raeburn 5094: padding: 2px;
1.347 albertel 5095: }
1.425 albertel 5096: table.LC_data_table tr.LC_data_table_highlight td {
5097: background-color: $data_table_darker;
5098: }
1.639 raeburn 5099: table.LC_data_table tr td.LC_leftcol_header {
5100: background-color: $data_table_head;
5101: font-weight: bold;
5102: }
1.451 albertel 5103: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5104: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5105: background-color: #FFFFFF;
1.421 albertel 5106: font-weight: bold;
5107: font-style: italic;
5108: text-align: center;
5109: padding: 8px;
1.347 albertel 5110: }
1.507 raeburn 5111: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5112: padding: 4ex
5113: }
1.507 raeburn 5114: table.LC_nested_outer tr th {
5115: font-weight: bold;
5116: background-color: $data_table_head;
5117: font-size: smaller;
5118: border-bottom: 1px solid #000000;
5119: }
5120: table.LC_nested_outer tr td.LC_subheader {
5121: background-color: $data_table_head;
5122: font-weight: bold;
5123: font-size: small;
5124: border-bottom: 1px solid #000000;
5125: text-align: right;
1.451 albertel 5126: }
1.507 raeburn 5127: table.LC_nested tr.LC_info_row td {
1.692.4.2 raeburn 5128: background-color: #CCCCCC;
1.451 albertel 5129: font-weight: bold;
5130: font-size: small;
1.507 raeburn 5131: text-align: center;
5132: }
1.589 raeburn 5133: table.LC_nested tr.LC_info_row td.LC_left_item,
5134: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5135: text-align: left;
1.451 albertel 5136: }
1.507 raeburn 5137: table.LC_nested td {
1.692.4.2 raeburn 5138: background-color: #FFFFFF;
1.451 albertel 5139: font-size: small;
1.507 raeburn 5140: }
5141: table.LC_nested_outer tr th.LC_right_item,
5142: table.LC_nested tr.LC_info_row td.LC_right_item,
5143: table.LC_nested tr.LC_odd_row td.LC_right_item,
5144: table.LC_nested tr td.LC_right_item {
1.451 albertel 5145: text-align: right;
5146: }
5147:
1.507 raeburn 5148: table.LC_nested tr.LC_odd_row td {
1.692.4.2 raeburn 5149: background-color: #EEEEEE;
1.451 albertel 5150: }
5151:
1.473 raeburn 5152: table.LC_createuser {
5153: }
5154:
5155: table.LC_createuser tr.LC_section_row td {
5156: font-size: smaller;
5157: }
5158:
5159: table.LC_createuser tr.LC_info_row td {
1.692.4.2 raeburn 5160: background-color: #CCCCCC;
1.473 raeburn 5161: font-weight: bold;
5162: text-align: center;
5163: }
5164:
1.349 albertel 5165: table.LC_calendar {
5166: border: 1px solid #000000;
5167: border-collapse: collapse;
5168: }
5169: table.LC_calendar_pickdate {
5170: font-size: xx-small;
5171: }
5172: table.LC_calendar tr td {
5173: border: 1px solid #000000;
5174: vertical-align: top;
5175: }
5176: table.LC_calendar tr td.LC_calendar_day_empty {
5177: background-color: $data_table_dark;
5178: }
5179: table.LC_calendar tr td.LC_calendar_day_current {
5180: background-color: $data_table_highlight;
5181: }
5182:
5183: table.LC_mail_list tr.LC_mail_new {
5184: background-color: $mail_new;
5185: }
5186: table.LC_mail_list tr.LC_mail_new:hover {
5187: background-color: $mail_new_hover;
5188: }
5189: table.LC_mail_list tr.LC_mail_read {
5190: background-color: $mail_read;
5191: }
5192: table.LC_mail_list tr.LC_mail_read:hover {
5193: background-color: $mail_read_hover;
5194: }
5195: table.LC_mail_list tr.LC_mail_replied {
5196: background-color: $mail_replied;
5197: }
5198: table.LC_mail_list tr.LC_mail_replied:hover {
5199: background-color: $mail_replied_hover;
5200: }
5201: table.LC_mail_list tr.LC_mail_other {
5202: background-color: $mail_other;
5203: }
5204: table.LC_mail_list tr.LC_mail_other:hover {
5205: background-color: $mail_other_hover;
5206: }
1.494 raeburn 5207: table.LC_mail_list tr.LC_mail_even {
5208: }
5209: table.LC_mail_list tr.LC_mail_odd {
5210: }
5211:
1.385 albertel 5212:
1.386 albertel 5213: table#LC_portfolio_actions {
5214: width: auto;
5215: background: $pgbg;
1.692.4.2 raeburn 5216: border: none;
1.386 albertel 5217: border-spacing: 2px 2px;
1.692.4.2 raeburn 5218: padding: 0;
5219: margin: 0;
1.386 albertel 5220: border-collapse: separate;
5221: }
5222: table#LC_portfolio_actions td.LC_label {
5223: background: $tabbg;
5224: text-align: right;
5225: }
5226: table#LC_portfolio_actions td.LC_value {
5227: background: $tabbg;
5228: }
1.385 albertel 5229:
1.391 albertel 5230: table#LC_cstr_controls {
5231: width: 100%;
5232: border-collapse: collapse;
5233: }
5234: table#LC_cstr_controls tr td {
5235: border: 4px solid $pgbg;
5236: padding: 4px;
5237: text-align: center;
5238: background: $tabbg;
5239: }
5240: table#LC_cstr_controls tr th {
5241: border: 4px solid $pgbg;
5242: background: $table_header;
5243: text-align: center;
5244: font-family: $sans;
5245: font-size: smaller;
5246: }
5247:
1.389 albertel 5248: table#LC_browser {
5249:
5250: }
5251: table#LC_browser tr th {
1.391 albertel 5252: background: $table_header;
1.389 albertel 5253: }
1.390 albertel 5254: table#LC_browser tr td {
5255: padding: 2px;
5256: }
1.389 albertel 5257: table#LC_browser tr.LC_browser_file,
5258: table#LC_browser tr.LC_browser_file_published {
5259: background: #CCFF88;
5260: }
5261: table#LC_browser tr.LC_browser_file_locked,
5262: table#LC_browser tr.LC_browser_file_unpublished {
5263: background: #FFAA99;
1.387 albertel 5264: }
1.389 albertel 5265: table#LC_browser tr.LC_browser_file_obsolete {
5266: background: #AAAAAA;
1.387 albertel 5267: }
1.455 albertel 5268: table#LC_browser tr.LC_browser_file_modified,
5269: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 5270: background: #FFFF77;
1.387 albertel 5271: }
1.389 albertel 5272: table#LC_browser tr.LC_browser_folder {
5273: background: #CCCCFF;
1.387 albertel 5274: }
1.692.4.2 raeburn 5275:
1.692.4.28 raeburn 5276: table.LC_data_table tr > td.LC_browser_file,
5277: table.LC_data_table tr > td.LC_browser_file_published {
5278: background: #AAEE77;
5279: }
5280:
5281: table.LC_data_table tr > td.LC_browser_file_locked,
5282: table.LC_data_table tr > td.LC_browser_file_unpublished {
5283: background: #FFAA99;
5284: }
5285:
5286: table.LC_data_table tr > td.LC_browser_file_obsolete {
5287: background: #888888;
5288: }
5289:
5290: table.LC_data_table tr > td.LC_browser_file_modified,
5291: table.LC_data_table tr > td.LC_browser_file_metamodified {
5292: background: #F8F866;
5293: }
5294:
5295: table.LC_data_table tr.LC_browser_folder > td {
5296: background: #E0E8FF;
5297: }
5298:
1.692.4.2 raeburn 5299: table.LC_data_table tr > td.LC_roles_is {
5300: /* background: #77FF77; */
5301: }
5302: table.LC_data_table tr > td.LC_roles_future {
5303: background: #FFFF77;
5304: }
5305: table.LC_data_table tr > td.LC_roles_will {
5306: background: #FFAA77;
5307: }
5308: table.LC_data_table tr > td.LC_roles_expired {
5309: background: #FF7777;
5310: }
5311: table.LC_data_table tr > td.LC_roles_will_not {
5312: background: #AAFF77;
5313: }
5314: table.LC_data_table tr > td.LC_roles_selected {
5315: background: #11CC55;
5316: }
5317:
1.388 albertel 5318: span.LC_current_location {
5319: font-size: x-large;
5320: background: $pgbg;
5321: }
1.387 albertel 5322:
1.395 albertel 5323: span.LC_parm_menu_item {
5324: font-size: larger;
5325: font-family: $sans;
5326: }
5327: span.LC_parm_scope_all {
5328: color: red;
5329: }
5330: span.LC_parm_scope_folder {
5331: color: green;
5332: }
5333: span.LC_parm_scope_resource {
5334: color: orange;
5335: }
5336: span.LC_parm_part {
5337: color: blue;
5338: }
5339: span.LC_parm_folder, span.LC_parm_symb {
5340: font-size: x-small;
5341: font-family: $mono;
5342: color: #AAAAAA;
5343: }
5344:
1.396 albertel 5345: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
5346: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
5347: border: 1px solid black;
5348: border-collapse: collapse;
5349: }
5350: table.LC_parm_overview_restrictions td {
5351: border-width: 1px 4px 1px 4px;
5352: border-style: solid;
5353: border-color: $pgbg;
5354: text-align: center;
5355: }
5356: table.LC_parm_overview_restrictions th {
5357: background: $tabbg;
5358: border-width: 1px 4px 1px 4px;
5359: border-style: solid;
5360: border-color: $pgbg;
5361: }
1.398 albertel 5362: table#LC_helpmenu {
1.692.4.2 raeburn 5363: border: none;
1.398 albertel 5364: height: 55px;
1.692.4.2 raeburn 5365: border-spacing: 0;
1.398 albertel 5366: }
5367:
5368: table#LC_helpmenu fieldset legend {
5369: font-size: larger;
5370: font-weight: bold;
5371: }
1.397 albertel 5372: table#LC_helpmenu_links {
5373: width: 100%;
5374: border: 1px solid black;
5375: background: $pgbg;
1.692.4.2 raeburn 5376: padding: 0;
1.397 albertel 5377: border-spacing: 1px;
5378: }
5379: table#LC_helpmenu_links tr td {
5380: padding: 1px;
5381: background: $tabbg;
1.399 albertel 5382: text-align: center;
5383: font-weight: bold;
1.397 albertel 5384: }
1.396 albertel 5385:
1.397 albertel 5386: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5387: table#LC_helpmenu_links a:active {
5388: text-decoration: none;
5389: color: $font;
5390: }
5391: table#LC_helpmenu_links a:hover {
5392: text-decoration: underline;
5393: color: $vlink;
5394: }
1.396 albertel 5395:
1.417 albertel 5396: .LC_chrt_popup_exists {
5397: border: 1px solid #339933;
5398: margin: -1px;
5399: }
5400: .LC_chrt_popup_up {
5401: border: 1px solid yellow;
5402: margin: -1px;
5403: }
5404: .LC_chrt_popup {
5405: border: 1px solid #8888FF;
5406: background: #CCCCFF;
5407: }
1.421 albertel 5408: table.LC_pick_box {
5409: border-collapse: separate;
5410: background: white;
5411: border: 1px solid black;
5412: border-spacing: 1px;
5413: }
5414: table.LC_pick_box td.LC_pick_box_title {
1.692.4.16 raeburn 5415: background: $tabbg;
1.421 albertel 5416: font-weight: bold;
5417: text-align: right;
1.692.4.2 raeburn 5418: vertical-align: top;
1.421 albertel 5419: width: 184px;
5420: padding: 8px;
5421: }
1.645 raeburn 5422: table.LC_pick_box td.LC_selfenroll_pick_box_title {
1.692.4.16 raeburn 5423: background: $tabbg;
1.645 raeburn 5424: font-weight: bold;
5425: text-align: right;
5426: width: 350px;
5427: padding: 8px;
5428: }
5429:
1.579 raeburn 5430: table.LC_pick_box td.LC_pick_box_value {
5431: text-align: left;
5432: padding: 8px;
5433: }
5434: table.LC_pick_box td.LC_pick_box_select {
5435: text-align: left;
5436: padding: 8px;
5437: }
1.424 albertel 5438: table.LC_pick_box td.LC_pick_box_separator {
1.692.4.2 raeburn 5439: padding: 0;
1.421 albertel 5440: height: 1px;
5441: background: black;
5442: }
5443: table.LC_pick_box td.LC_pick_box_submit {
5444: text-align: right;
5445: }
1.579 raeburn 5446: table.LC_pick_box td.LC_evenrow_value {
5447: text-align: left;
5448: padding: 8px;
5449: background-color: $data_table_light;
5450: }
5451: table.LC_pick_box td.LC_oddrow_value {
5452: text-align: left;
5453: padding: 8px;
5454: background-color: $data_table_light;
5455: }
5456: table.LC_helpform_receipt {
5457: width: 620px;
5458: border-collapse: separate;
5459: background: white;
5460: border: 1px solid black;
5461: border-spacing: 1px;
5462: }
5463: table.LC_helpform_receipt td.LC_pick_box_title {
5464: background: $tabbg;
5465: font-weight: bold;
5466: text-align: right;
5467: width: 184px;
5468: padding: 8px;
5469: }
5470: table.LC_helpform_receipt td.LC_evenrow_value {
5471: text-align: left;
5472: padding: 8px;
5473: background-color: $data_table_light;
5474: }
5475: table.LC_helpform_receipt td.LC_oddrow_value {
5476: text-align: left;
5477: padding: 8px;
5478: background-color: $data_table_light;
5479: }
5480: table.LC_helpform_receipt td.LC_pick_box_separator {
1.692.4.2 raeburn 5481: padding: 0;
1.579 raeburn 5482: height: 1px;
5483: background: black;
5484: }
5485: span.LC_helpform_receipt_cat {
5486: font-weight: bold;
5487: }
1.424 albertel 5488: table.LC_group_priv_box {
5489: background: white;
5490: border: 1px solid black;
5491: border-spacing: 1px;
5492: }
5493: table.LC_group_priv_box td.LC_pick_box_title {
5494: background: $tabbg;
5495: font-weight: bold;
5496: text-align: right;
5497: width: 184px;
5498: }
5499: table.LC_group_priv_box td.LC_groups_fixed {
5500: background: $data_table_light;
5501: text-align: center;
5502: }
5503: table.LC_group_priv_box td.LC_groups_optional {
5504: background: $data_table_dark;
5505: text-align: center;
5506: }
5507: table.LC_group_priv_box td.LC_groups_functionality {
5508: background: $data_table_darker;
5509: text-align: center;
5510: font-weight: bold;
5511: }
5512: table.LC_group_priv td {
5513: text-align: left;
1.692.4.2 raeburn 5514: padding: 0;
1.424 albertel 5515: }
5516:
1.421 albertel 5517: table.LC_notify_front_page {
5518: background: white;
5519: border: 1px solid black;
5520: padding: 8px;
5521: }
5522: table.LC_notify_front_page td {
5523: padding: 8px;
5524: }
1.424 albertel 5525: .LC_navbuttons {
5526: margin: 2ex 0ex 2ex 0ex;
5527: }
1.423 albertel 5528: .LC_topic_bar {
5529: font-family: $sans;
5530: font-weight: bold;
5531: width: 100%;
5532: background: $tabbg;
5533: vertical-align: middle;
5534: margin: 2ex 0ex 2ex 0ex;
1.692.4.2 raeburn 5535: padding: 3px;
1.423 albertel 5536: }
5537: .LC_topic_bar span {
5538: vertical-align: middle;
5539: }
5540: .LC_topic_bar img {
5541: vertical-align: bottom;
5542: }
5543: table.LC_course_group_status {
5544: margin: 20px;
5545: }
5546: table.LC_status_selector td {
5547: vertical-align: top;
5548: text-align: center;
1.424 albertel 5549: padding: 4px;
5550: }
5551: table.LC_descriptive_input td.LC_description {
5552: vertical-align: top;
5553: text-align: right;
5554: font-weight: bold;
1.423 albertel 5555: }
1.599 albertel 5556: div.LC_feedback_link {
1.616 albertel 5557: clear: both;
1.599 albertel 5558: background: white;
5559: width: 100%;
1.489 raeburn 5560: }
5561: span.LC_feedback_link {
1.599 albertel 5562: background: $feedback_link_bg;
5563: font-size: larger;
5564: }
5565: span.LC_message_link {
5566: background: $feedback_link_bg;
5567: font-size: larger;
5568: position: absolute;
5569: right: 1em;
1.489 raeburn 5570: }
1.421 albertel 5571:
1.515 albertel 5572: table.LC_prior_tries {
1.524 albertel 5573: border: 1px solid #000000;
5574: border-collapse: separate;
5575: border-spacing: 1px;
1.515 albertel 5576: }
1.523 albertel 5577:
1.515 albertel 5578: table.LC_prior_tries td {
1.524 albertel 5579: padding: 2px;
1.515 albertel 5580: }
1.523 albertel 5581:
5582: .LC_answer_correct {
5583: background: #AAFFAA;
5584: color: black;
5585: }
5586: .LC_answer_charged_try {
5587: background: #FFAAAA ! important;
5588: color: black;
5589: }
5590: .LC_answer_not_charged_try,
5591: .LC_answer_no_grade,
5592: .LC_answer_late {
5593: background: #FFFFAA;
5594: color: black;
5595: }
5596: .LC_answer_previous {
5597: background: #AAAAFF;
5598: color: black;
5599: }
5600: .LC_answer_no_message {
5601: background: #FFFFFF;
5602: color: black;
5603: }
5604: .LC_answer_unknown {
5605: background: orange;
5606: color: black;
5607: }
5608:
5609:
1.529 albertel 5610: span.LC_prior_numerical,
5611: span.LC_prior_string,
5612: span.LC_prior_custom,
5613: span.LC_prior_reaction,
5614: span.LC_prior_math {
1.523 albertel 5615: font-family: monospace;
5616: white-space: pre;
5617: }
5618:
1.525 albertel 5619: span.LC_prior_string {
5620: font-family: monospace;
5621: white-space: pre;
5622: }
5623:
1.523 albertel 5624: table.LC_prior_option {
5625: width: 100%;
5626: border-collapse: collapse;
5627: }
1.528 albertel 5628: table.LC_prior_rank, table.LC_prior_match {
5629: border-collapse: collapse;
5630: }
5631: table.LC_prior_option tr td,
5632: table.LC_prior_rank tr td,
5633: table.LC_prior_match tr td {
1.524 albertel 5634: border: 1px solid #000000;
1.515 albertel 5635: }
5636:
1.692.4.28 raeburn 5637: .LC_nobreak {
1.544 albertel 5638: white-space: nowrap;
1.519 raeburn 5639: }
5640:
1.576 raeburn 5641: span.LC_cusr_emph {
5642: font-style: italic;
5643: }
5644:
1.633 raeburn 5645: span.LC_cusr_subheading {
5646: font-weight: normal;
5647: font-size: 85%;
5648: }
5649:
1.545 albertel 5650: table.LC_docs_documents {
5651: background: #BBBBBB;
1.692.4.2 raeburn 5652: border-width: 0;
1.545 albertel 5653: border-collapse: collapse;
5654: }
5655:
5656: table.LC_docs_documents td.LC_docs_document {
5657: border: 2px solid black;
5658: padding: 4px;
5659: }
5660:
5661: .LC_docs_course_commands div {
5662: float: left;
5663: border: 4px solid #AAAAAA;
5664: padding: 4px;
5665: background: #DDDDCC;
5666: }
5667:
5668: .LC_docs_entry_move {
1.692.4.2 raeburn 5669: border: none;
1.545 albertel 5670: border-collapse: collapse;
1.544 albertel 5671: }
5672:
1.545 albertel 5673: .LC_docs_entry_move td {
5674: border: 2px solid #BBBBBB;
5675: background: #DDDDDD;
5676: }
5677:
5678: .LC_docs_editor td.LC_docs_entry_commands {
5679: background: #DDDDDD;
5680: font-size: x-small;
5681: }
1.544 albertel 5682: .LC_docs_copy {
1.545 albertel 5683: color: #000099;
1.544 albertel 5684: }
5685: .LC_docs_cut {
1.545 albertel 5686: color: #550044;
1.544 albertel 5687: }
5688: .LC_docs_rename {
1.545 albertel 5689: color: #009900;
1.544 albertel 5690: }
5691: .LC_docs_remove {
1.545 albertel 5692: color: #990000;
5693: }
5694:
1.547 albertel 5695: .LC_docs_reinit_warn,
5696: .LC_docs_ext_edit {
5697: font-size: x-small;
5698: }
5699:
1.545 albertel 5700: .LC_docs_editor td.LC_docs_entry_title,
5701: .LC_docs_editor td.LC_docs_entry_icon {
5702: background: #FFFFBB;
5703: }
5704: .LC_docs_editor td.LC_docs_entry_parameter {
5705: background: #BBBBFF;
5706: font-size: x-small;
5707: white-space: nowrap;
5708: }
5709:
5710: table.LC_docs_adddocs td,
5711: table.LC_docs_adddocs th {
5712: border: 1px solid #BBBBBB;
5713: padding: 4px;
5714: background: #DDDDDD;
1.543 albertel 5715: }
5716:
1.584 albertel 5717: table.LC_sty_begin {
5718: background: #BBFFBB;
5719: }
5720: table.LC_sty_end {
5721: background: #FFBBBB;
5722: }
5723:
1.589 raeburn 5724: table.LC_double_column {
1.692.4.2 raeburn 5725: border-width: 0;
1.589 raeburn 5726: border-collapse: collapse;
5727: width: 100%;
5728: padding: 2px;
5729: }
5730:
5731: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5732: top: 2px;
1.589 raeburn 5733: left: 2px;
5734: width: 47%;
5735: vertical-align: top;
5736: }
5737:
5738: table.LC_double_column tr td.LC_right_col {
5739: top: 2px;
5740: right: 2px;
5741: width: 47%;
5742: vertical-align: top;
5743: }
5744:
1.594 raeburn 5745: span.LC_role_level {
5746: font-weight: bold;
5747: }
5748:
1.591 raeburn 5749: div.LC_left_float {
5750: float: left;
5751: padding-right: 5%;
1.597 albertel 5752: padding-bottom: 4px;
1.591 raeburn 5753: }
5754:
5755: div.LC_clear_float_header {
1.597 albertel 5756: padding-bottom: 2px;
1.591 raeburn 5757: }
5758:
5759: div.LC_clear_float_footer {
1.597 albertel 5760: padding-top: 10px;
1.591 raeburn 5761: clear: both;
5762: }
5763:
1.597 albertel 5764:
1.601 albertel 5765: div.LC_grade_select_mode {
1.604 albertel 5766: font-family: $sans;
1.601 albertel 5767: }
5768: div.LC_grade_select_mode div div {
5769: margin: 5px;
5770: }
5771: div.LC_grade_select_mode_selector {
5772: margin: 5px;
5773: float: left;
5774: }
5775: div.LC_grade_select_mode_selector_header {
5776: font: bold medium $sans;
5777: }
5778: div.LC_grade_select_mode_type {
5779: clear: left;
5780: }
5781:
1.597 albertel 5782: div.LC_grade_show_user {
5783: margin-top: 20px;
5784: border: 1px solid black;
5785: }
5786: div.LC_grade_user_name {
5787: background: #DDDDEE;
5788: border-bottom: 1px solid black;
5789: font: bold large $sans;
5790: }
5791: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5792: background: #DDEEDD;
5793: }
5794:
5795: div.LC_grade_show_problem,
5796: div.LC_grade_submissions,
5797: div.LC_grade_message_center,
5798: div.LC_grade_info_links,
5799: div.LC_grade_assign {
5800: margin: 5px;
5801: width: 99%;
5802: background: #FFFFFF;
5803: }
5804: div.LC_grade_show_problem_header,
5805: div.LC_grade_submissions_header,
5806: div.LC_grade_message_center_header,
5807: div.LC_grade_assign_header {
5808: font: bold large $sans;
5809: }
5810: div.LC_grade_show_problem_problem,
5811: div.LC_grade_submissions_body,
5812: div.LC_grade_message_center_body,
5813: div.LC_grade_assign_body {
5814: border: 1px solid black;
5815: width: 99%;
5816: background: #FFFFFF;
5817: }
1.598 albertel 5818: span.LC_grade_check_note {
5819: font: normal medium $sans;
5820: display: inline;
5821: position: absolute;
5822: right: 1em;
5823: }
1.597 albertel 5824:
1.613 albertel 5825: table.LC_scantron_action {
5826: width: 100%;
5827: }
5828: table.LC_scantron_action tr th {
5829: font: normal bold $sans;
5830: }
1.600 albertel 5831:
1.614 albertel 5832: div.LC_edit_problem_header,
5833: div.LC_edit_problem_footer {
1.600 albertel 5834: font: normal medium $sans;
1.602 albertel 5835: margin: 2px;
1.600 albertel 5836: }
5837: div.LC_edit_problem_header,
1.602 albertel 5838: div.LC_edit_problem_header div,
1.614 albertel 5839: div.LC_edit_problem_footer,
5840: div.LC_edit_problem_footer div,
1.602 albertel 5841: div.LC_edit_problem_editxml_header,
5842: div.LC_edit_problem_editxml_header div {
1.600 albertel 5843: margin-top: 5px;
5844: }
1.602 albertel 5845: div.LC_edit_problem_header_edit_row {
5846: background: $tabbg;
5847: padding: 3px;
5848: margin-bottom: 5px;
5849: }
1.600 albertel 5850: div.LC_edit_problem_header_title {
1.602 albertel 5851: font: larger bold $sans;
5852: background: $tabbg;
5853: padding: 3px;
5854: }
5855: table.LC_edit_problem_header_title {
5856: font: larger bold $sans;
5857: width: 100%;
5858: border-color: $pgbg;
5859: border-style: solid;
5860: border-width: $border;
5861:
1.600 albertel 5862: background: $tabbg;
1.602 albertel 5863: border-collapse: collapse;
1.692.4.2 raeburn 5864: padding: 0;
1.602 albertel 5865: }
5866:
5867: div.LC_edit_problem_discards {
5868: float: left;
5869: padding-bottom: 5px;
5870: }
5871: div.LC_edit_problem_saves {
5872: float: right;
5873: padding-bottom: 5px;
1.600 albertel 5874: }
5875: hr.LC_edit_problem_divide {
1.602 albertel 5876: clear: both;
1.600 albertel 5877: color: $tabbg;
5878: background-color: $tabbg;
5879: height: 3px;
1.692.4.2 raeburn 5880: border: none;
1.600 albertel 5881: }
1.679 riegler 5882: img.stift{
1.678 riegler 5883: border-width:0;
1.679 riegler 5884: vertical-align:middle;
1.677 riegler 5885: }
1.680 riegler 5886:
1.681 riegler 5887: table#LC_mainmenu{
5888: margin-top:10px;
5889: width:80%;
5890:
5891: }
5892:
1.680 riegler 5893: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5894: vertical-align: top;
5895: width: 45%;
5896: }
5897: .LC_mainmenu_fieldset_category {
5898: color: $font;
5899: background: $pgbg;
5900: font-family: $sans;
5901: font-size: small;
5902: font-weight: bold;
5903: }
5904: fieldset#LC_mainmenu_fieldset {
1.692.4.2 raeburn 5905: margin:0 10px 10px 0;
5906:
5907: }
1.680 riegler 5908:
1.692.4.2 raeburn 5909: div.LC_createcourse {
5910: margin: 10px 10px 10px 10px;
1.680 riegler 5911: }
1.692.4.2 raeburn 5912:
1.343 albertel 5913: END
5914: }
5915:
1.306 albertel 5916: =pod
5917:
5918: =item * &headtag()
5919:
5920: Returns a uniform footer for LON-CAPA web pages.
5921:
1.307 albertel 5922: Inputs: $title - optional title for the head
5923: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5924: $args - optional arguments
1.319 albertel 5925: force_register - if is true call registerurl so the remote is
5926: informed
1.415 albertel 5927: redirect -> array ref of
5928: 1- seconds before redirect occurs
5929: 2- url to redirect to
5930: 3- whether the side effect should occur
1.315 albertel 5931: (side effect of setting
5932: $env{'internal.head.redirect'} to the url
5933: redirected too)
1.352 albertel 5934: domain -> force to color decorate a page for a specific
5935: domain
5936: function -> force usage of a specific rolish color scheme
5937: bgcolor -> override the default page bgcolor
1.460 albertel 5938: no_auto_mt_title
5939: -> prevent &mt()ing the title arg
1.464 albertel 5940:
1.306 albertel 5941: =cut
5942:
5943: sub headtag {
1.313 albertel 5944: my ($title,$head_extra,$args) = @_;
1.306 albertel 5945:
1.363 albertel 5946: my $function = $args->{'function'} || &get_users_function();
5947: my $domain = $args->{'domain'} || &determinedomain();
5948: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5949: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5950: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5951: #time(),
1.418 albertel 5952: $env{'environment.color.timestamp'},
1.363 albertel 5953: $function,$domain,$bgcolor);
5954:
1.369 www 5955: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5956:
1.308 albertel 5957: my $result =
5958: '<head>'.
1.461 albertel 5959: &font_settings();
1.319 albertel 5960:
1.461 albertel 5961: if (!$args->{'frameset'}) {
5962: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5963: }
1.319 albertel 5964: if ($args->{'force_register'}) {
5965: $result .= &Apache::lonmenu::registerurl(1);
5966: }
1.436 albertel 5967: if (!$args->{'no_nav_bar'}
5968: && !$args->{'only_body'}
5969: && !$args->{'frameset'}) {
5970: $result .= &help_menu_js();
5971: }
1.319 albertel 5972:
1.314 albertel 5973: if (ref($args->{'redirect'})) {
1.414 albertel 5974: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5975: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5976: if (!$inhibit_continue) {
5977: $env{'internal.head.redirect'} = $url;
5978: }
1.313 albertel 5979: $result.=<<ADDMETA
5980: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5981: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5982: ADDMETA
5983: }
1.306 albertel 5984: if (!defined($title)) {
5985: $title = 'The LearningOnline Network with CAPA';
5986: }
1.460 albertel 5987: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5988: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5989: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5990: .$head_extra;
1.306 albertel 5991: return $result;
5992: }
5993:
5994: =pod
5995:
1.340 albertel 5996: =item * &font_settings()
5997:
5998: Returns neccessary <meta> to set the proper encoding
5999:
6000: Inputs: none
6001:
6002: =cut
6003:
6004: sub font_settings {
6005: my $headerstring='';
1.647 www 6006: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6007: $headerstring.=
6008: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6009: }
6010: return $headerstring;
6011: }
6012:
1.341 albertel 6013: =pod
6014:
6015: =item * &xml_begin()
6016:
6017: Returns the needed doctype and <html>
6018:
6019: Inputs: none
6020:
6021: =cut
6022:
6023: sub xml_begin {
6024: my $output='';
6025:
1.592 albertel 6026: if ($env{'internal.start_page'}==1) {
6027: &Apache::lonhtmlcommon::init_htmlareafields();
6028: }
1.342 albertel 6029:
1.341 albertel 6030: if ($env{'browser.mathml'}) {
6031: $output='<?xml version="1.0"?>'
6032: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6033: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6034:
6035: # .'<!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">] >'
6036: .'<!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">'
6037: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6038: .'xmlns="http://www.w3.org/1999/xhtml">';
6039: } else {
1.692.4.6 raeburn 6040: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'.
6041: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6042: }
6043: return $output;
6044: }
1.340 albertel 6045:
6046: =pod
6047:
1.306 albertel 6048: =item * &endheadtag()
6049:
6050: Returns a uniform </head> for LON-CAPA web pages.
6051:
6052: Inputs: none
6053:
6054: =cut
6055:
6056: sub endheadtag {
6057: return '</head>';
6058: }
6059:
6060: =pod
6061:
6062: =item * &head()
6063:
6064: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6065:
1.648 raeburn 6066: Inputs:
6067:
6068: =over 4
6069:
6070: $title - optional title for the page
6071:
6072: $head_extra - optional extra HTML to put inside the <head>
6073:
6074: =back
1.405 albertel 6075:
1.306 albertel 6076: =cut
6077:
6078: sub head {
1.325 albertel 6079: my ($title,$head_extra,$args) = @_;
6080: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6081: }
6082:
6083: =pod
6084:
6085: =item * &start_page()
6086:
6087: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6088:
1.648 raeburn 6089: Inputs:
6090:
6091: =over 4
6092:
6093: $title - optional title for the page
6094:
6095: $head_extra - optional extra HTML to incude inside the <head>
6096:
6097: $args - additional optional args supported are:
6098:
6099: =over 8
6100:
6101: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6102: arg on
1.648 raeburn 6103: no_nav_bar -> is true will set &bodytag() notopbar arg on
6104: add_entries -> additional attributes to add to the <body>
6105: domain -> force to color decorate a page for a
1.317 albertel 6106: specific domain
1.648 raeburn 6107: function -> force usage of a specific rolish color
1.317 albertel 6108: scheme
1.648 raeburn 6109: redirect -> see &headtag()
6110: bgcolor -> override the default page bg color
6111: js_ready -> return a string ready for being used in
1.317 albertel 6112: a javascript writeln
1.648 raeburn 6113: html_encode -> return a string ready for being used in
1.320 albertel 6114: a html attribute
1.648 raeburn 6115: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6116: $forcereg arg
1.648 raeburn 6117: body_title -> alternate text to use instead of $title
1.326 albertel 6118: in the title box that appears, this text
6119: is not auto translated like the $title is
1.648 raeburn 6120: frameset -> if true will start with a <frameset>
1.330 albertel 6121: rather than <body>
1.648 raeburn 6122: no_title -> if true the title bar won't be shown
6123: skip_phases -> hash ref of
1.338 albertel 6124: head -> skip the <html><head> generation
6125: body -> skip all <body> generation
1.648 raeburn 6126: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6127: 'Switch To Inline Menu' link
1.648 raeburn 6128: no_auto_mt_title -> prevent &mt()ing the title arg
6129: inherit_jsmath -> when creating popup window in a page,
6130: should it have jsmath forced on by the
6131: current page
1.361 albertel 6132:
1.648 raeburn 6133: =back
1.460 albertel 6134:
1.648 raeburn 6135: =back
1.562 albertel 6136:
1.306 albertel 6137: =cut
6138:
6139: sub start_page {
1.309 albertel 6140: my ($title,$head_extra,$args) = @_;
1.318 albertel 6141: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6142: my %head_args;
1.352 albertel 6143: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6144: 'bgcolor','frameset','no_nav_bar','only_body',
6145: 'no_auto_mt_title') {
1.319 albertel 6146: if (defined($args->{$arg})) {
1.324 raeburn 6147: $head_args{$arg} = $args->{$arg};
1.319 albertel 6148: }
1.313 albertel 6149: }
1.319 albertel 6150:
1.315 albertel 6151: $env{'internal.start_page'}++;
1.338 albertel 6152: my $result;
6153: if (! exists($args->{'skip_phases'}{'head'}) ) {
6154: $result.=
1.341 albertel 6155: &xml_begin().
1.338 albertel 6156: &headtag($title,$head_extra,\%head_args).&endheadtag();
6157: }
6158:
6159: if (! exists($args->{'skip_phases'}{'body'}) ) {
6160: if ($args->{'frameset'}) {
6161: my $attr_string = &make_attr_string($args->{'force_register'},
6162: $args->{'add_entries'});
6163: $result .= "\n<frameset $attr_string>\n";
6164: } else {
6165: $result .=
6166: &bodytag($title,
6167: $args->{'function'}, $args->{'add_entries'},
6168: $args->{'only_body'}, $args->{'domain'},
6169: $args->{'force_register'}, $args->{'body_title'},
6170: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6171: $args->{'no_title'}, $args->{'no_inline_link'},
6172: $args);
1.338 albertel 6173: }
1.330 albertel 6174: }
1.338 albertel 6175:
1.315 albertel 6176: if ($args->{'js_ready'}) {
1.317 albertel 6177: $result = &js_ready($result);
1.315 albertel 6178: }
1.320 albertel 6179: if ($args->{'html_encode'}) {
6180: $result = &html_encode($result);
6181: }
1.692.4.2 raeburn 6182: #Breadcrumbs
6183: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6184: &Apache::lonhtmlcommon::clear_breadcrumbs();
6185: #if any br links exists, add them to the breadcrumbs
6186: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6187: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6188: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6189: }
6190: }
1.306 albertel 6191:
1.692.4.2 raeburn 6192: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6193: if (exists($args->{'bread_crumbs_component'})){
6194: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6195: } else {
6196: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6197: }
6198: }
6199: return $result;
1.692.4.3 raeburn 6200: }
1.330 albertel 6201:
1.306 albertel 6202: =pod
6203:
6204: =item * &head()
6205:
6206: Returns a complete </body></html> section for LON-CAPA web pages.
6207:
1.315 albertel 6208: Inputs: $args - additional optional args supported are:
6209: js_ready -> return a string ready for being used in
6210: a javascript writeln
1.320 albertel 6211: html_encode -> return a string ready for being used in
6212: a html attribute
1.330 albertel 6213: frameset -> if true will start with a <frameset>
6214: rather than <body>
1.493 albertel 6215: dicsussion -> if true will get discussion from
6216: lonxml::xmlend
6217: (you can pass the target and parser arguments
6218: through optional 'target' and 'parser' args
6219: to this routine)
1.306 albertel 6220:
6221: =cut
6222:
6223: sub end_page {
1.315 albertel 6224: my ($args) = @_;
6225: $env{'internal.end_page'}++;
1.330 albertel 6226: my $result;
1.335 albertel 6227: if ($args->{'discussion'}) {
6228: my ($target,$parser);
6229: if (ref($args->{'discussion'})) {
6230: ($target,$parser) =($args->{'discussion'}{'target'},
6231: $args->{'discussion'}{'parser'});
6232: }
6233: $result .= &Apache::lonxml::xmlend($target,$parser);
6234: }
6235:
1.330 albertel 6236: if ($args->{'frameset'}) {
6237: $result .= '</frameset>';
6238: } else {
1.635 raeburn 6239: $result .= &endbodytag($args);
1.330 albertel 6240: }
6241: $result .= "\n</html>";
6242:
1.315 albertel 6243: if ($args->{'js_ready'}) {
1.317 albertel 6244: $result = &js_ready($result);
1.315 albertel 6245: }
1.335 albertel 6246:
1.320 albertel 6247: if ($args->{'html_encode'}) {
6248: $result = &html_encode($result);
6249: }
1.335 albertel 6250:
1.315 albertel 6251: return $result;
6252: }
6253:
1.320 albertel 6254: sub html_encode {
6255: my ($result) = @_;
6256:
1.322 albertel 6257: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6258:
6259: return $result;
6260: }
1.317 albertel 6261: sub js_ready {
6262: my ($result) = @_;
6263:
1.323 albertel 6264: $result =~ s/[\n\r]/ /xmsg;
6265: $result =~ s/\\/\\\\/xmsg;
6266: $result =~ s/'/\\'/xmsg;
1.372 albertel 6267: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6268:
6269: return $result;
6270: }
6271:
1.315 albertel 6272: sub validate_page {
6273: if ( exists($env{'internal.start_page'})
1.316 albertel 6274: && $env{'internal.start_page'} > 1) {
6275: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6276: $env{'internal.start_page'}.' '.
1.316 albertel 6277: $ENV{'request.filename'});
1.315 albertel 6278: }
6279: if ( exists($env{'internal.end_page'})
1.316 albertel 6280: && $env{'internal.end_page'} > 1) {
6281: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6282: $env{'internal.end_page'}.' '.
1.316 albertel 6283: $env{'request.filename'});
1.315 albertel 6284: }
6285: if ( exists($env{'internal.start_page'})
6286: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6287: &Apache::lonnet::logthis('start_page called without end_page '.
6288: $env{'request.filename'});
1.315 albertel 6289: }
6290: if ( ! exists($env{'internal.start_page'})
6291: && exists($env{'internal.end_page'})) {
1.316 albertel 6292: &Apache::lonnet::logthis('end_page called without start_page'.
6293: $env{'request.filename'});
1.315 albertel 6294: }
1.306 albertel 6295: }
1.315 albertel 6296:
1.318 albertel 6297: sub simple_error_page {
6298: my ($r,$title,$msg) = @_;
6299: my $page =
6300: &Apache::loncommon::start_page($title).
6301: &mt($msg).
6302: &Apache::loncommon::end_page();
6303: if (ref($r)) {
6304: $r->print($page);
1.327 albertel 6305: return;
1.318 albertel 6306: }
6307: return $page;
6308: }
1.347 albertel 6309:
6310: {
1.610 albertel 6311: my @row_count;
1.347 albertel 6312: sub start_data_table {
1.422 albertel 6313: my ($add_class) = @_;
6314: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6315: unshift(@row_count,0);
1.422 albertel 6316: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6317: }
6318:
6319: sub end_data_table {
1.610 albertel 6320: shift(@row_count);
1.389 albertel 6321: return '</table>'."\n";;
1.347 albertel 6322: }
6323:
6324: sub start_data_table_row {
1.422 albertel 6325: my ($add_class) = @_;
1.610 albertel 6326: $row_count[0]++;
6327: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6328: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6329: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6330: }
1.471 banghart 6331:
6332: sub continue_data_table_row {
6333: my ($add_class) = @_;
1.610 albertel 6334: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6335: $css_class = (join(' ',$css_class,$add_class));
6336: return '<tr class="'.$css_class.'">'."\n";;
6337: }
1.347 albertel 6338:
6339: sub end_data_table_row {
1.389 albertel 6340: return '</tr>'."\n";;
1.347 albertel 6341: }
1.367 www 6342:
1.421 albertel 6343: sub start_data_table_empty_row {
1.610 albertel 6344: $row_count[0]++;
1.421 albertel 6345: return '<tr class="LC_empty_row" >'."\n";;
6346: }
6347:
6348: sub end_data_table_empty_row {
6349: return '</tr>'."\n";;
6350: }
6351:
1.367 www 6352: sub start_data_table_header_row {
1.389 albertel 6353: return '<tr class="LC_header_row">'."\n";;
1.367 www 6354: }
6355:
6356: sub end_data_table_header_row {
1.389 albertel 6357: return '</tr>'."\n";;
1.367 www 6358: }
1.347 albertel 6359: }
6360:
1.548 albertel 6361: =pod
6362:
6363: =item * &inhibit_menu_check($arg)
6364:
6365: Checks for a inhibitmenu state and generates output to preserve it
6366:
6367: Inputs: $arg - can be any of
6368: - undef - in which case the return value is a string
6369: to add into arguments list of a uri
6370: - 'input' - in which case the return value is a HTML
6371: <form> <input> field of type hidden to
6372: preserve the value
6373: - a url - in which case the return value is the url with
6374: the neccesary cgi args added to preserve the
6375: inhibitmenu state
6376: - a ref to a url - no return value, but the string is
6377: updated to include the neccessary cgi
6378: args to preserve the inhibitmenu state
6379:
6380: =cut
6381:
6382: sub inhibit_menu_check {
6383: my ($arg) = @_;
6384: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6385: if ($arg eq 'input') {
6386: if ($env{'form.inhibitmenu'}) {
6387: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6388: } else {
6389: return
6390: }
6391: }
6392: if ($env{'form.inhibitmenu'}) {
6393: if (ref($arg)) {
6394: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6395: } elsif ($arg eq '') {
6396: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6397: } else {
6398: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6399: }
6400: }
6401: if (!ref($arg)) {
6402: return $arg;
6403: }
6404: }
6405:
1.251 albertel 6406: ###############################################
1.182 matthew 6407:
6408: =pod
6409:
1.549 albertel 6410: =back
6411:
6412: =head1 User Information Routines
6413:
6414: =over 4
6415:
1.405 albertel 6416: =item * &get_users_function()
1.182 matthew 6417:
6418: Used by &bodytag to determine the current users primary role.
6419: Returns either 'student','coordinator','admin', or 'author'.
6420:
6421: =cut
6422:
6423: ###############################################
6424: sub get_users_function {
6425: my $function = 'student';
1.692.4.26 raeburn 6426: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6427: $function='coordinator';
6428: }
1.258 albertel 6429: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6430: $function='admin';
6431: }
1.692.4.5 raeburn 6432: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6433: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6434: $function='author';
6435: }
6436: return $function;
1.54 www 6437: }
1.99 www 6438:
6439: ###############################################
6440:
1.233 raeburn 6441: =pod
6442:
1.692.4.2 raeburn 6443: =item * &show_course()
6444:
6445: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6446: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6447: Inputs:
6448: None
6449:
6450: Outputs:
6451: Scalar: 1 if 'Course' to be used, 0 otherwise.
6452:
6453: =cut
6454:
6455: ###############################################
6456: sub show_course {
6457: my $course = !$env{'user.adv'};
6458: if (!$env{'user.adv'}) {
6459: foreach my $env (keys(%env)) {
6460: next if ($env !~ m/^user\.priv\./);
6461: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
6462: $course = 0;
6463: last;
6464: }
6465: }
6466: }
6467: return $course;
6468: }
6469:
6470: ###############################################
6471:
6472: =pod
6473:
1.542 raeburn 6474: =item * &check_user_status()
1.274 raeburn 6475:
6476: Determines current status of supplied role for a
6477: specific user. Roles can be active, previous or future.
6478:
6479: Inputs:
6480: user's domain, user's username, course's domain,
1.375 raeburn 6481: course's number, optional section ID.
1.274 raeburn 6482:
6483: Outputs:
6484: role status: active, previous or future.
6485:
6486: =cut
6487:
6488: sub check_user_status {
1.412 raeburn 6489: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6490: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6491: my @uroles = keys %userinfo;
6492: my $srchstr;
6493: my $active_chk = 'none';
1.412 raeburn 6494: my $now = time;
1.274 raeburn 6495: if (@uroles > 0) {
1.692.4.22 raeburn 6496: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6497: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6498: } else {
1.412 raeburn 6499: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6500: }
6501: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6502: my $role_end = 0;
6503: my $role_start = 0;
6504: $active_chk = 'active';
1.412 raeburn 6505: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6506: $role_end = $1;
6507: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6508: $role_start = $1;
1.274 raeburn 6509: }
6510: }
6511: if ($role_start > 0) {
1.412 raeburn 6512: if ($now < $role_start) {
1.274 raeburn 6513: $active_chk = 'future';
6514: }
6515: }
6516: if ($role_end > 0) {
1.412 raeburn 6517: if ($now > $role_end) {
1.274 raeburn 6518: $active_chk = 'previous';
6519: }
6520: }
6521: }
6522: }
6523: return $active_chk;
6524: }
6525:
6526: ###############################################
6527:
6528: =pod
6529:
1.405 albertel 6530: =item * &get_sections()
1.233 raeburn 6531:
6532: Determines all the sections for a course including
6533: sections with students and sections containing other roles.
1.419 raeburn 6534: Incoming parameters:
6535:
6536: 1. domain
6537: 2. course number
6538: 3. reference to array containing roles for which sections should
6539: be gathered (optional).
6540: 4. reference to array containing status types for which sections
6541: should be gathered (optional).
6542:
6543: If the third argument is undefined, sections are gathered for any role.
6544: If the fourth argument is undefined, sections are gathered for any status.
6545: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6546:
1.374 raeburn 6547: Returns section hash (keys are section IDs, values are
6548: number of users in each section), subject to the
1.419 raeburn 6549: optional roles filter, optional status filter
1.233 raeburn 6550:
6551: =cut
6552:
6553: ###############################################
6554: sub get_sections {
1.419 raeburn 6555: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6556: if (!defined($cdom) || !defined($cnum)) {
6557: my $cid = $env{'request.course.id'};
6558:
6559: return if (!defined($cid));
6560:
6561: $cdom = $env{'course.'.$cid.'.domain'};
6562: $cnum = $env{'course.'.$cid.'.num'};
6563: }
6564:
6565: my %sectioncount;
1.419 raeburn 6566: my $now = time;
1.240 albertel 6567:
1.366 albertel 6568: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6569: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6570: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6571: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6572: my $start_index = &Apache::loncoursedata::CL_START();
6573: my $end_index = &Apache::loncoursedata::CL_END();
6574: my $status;
1.366 albertel 6575: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6576: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6577: $data->[$status_index],
6578: $data->[$start_index],
6579: $data->[$end_index]);
6580: if ($stu_status eq 'Active') {
6581: $status = 'active';
6582: } elsif ($end < $now) {
6583: $status = 'previous';
6584: } elsif ($start > $now) {
6585: $status = 'future';
6586: }
6587: if ($section ne '-1' && $section !~ /^\s*$/) {
6588: if ((!defined($possible_status)) || (($status ne '') &&
6589: (grep/^\Q$status\E$/,@{$possible_status}))) {
6590: $sectioncount{$section}++;
6591: }
1.240 albertel 6592: }
6593: }
6594: }
6595: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6596: foreach my $user (sort(keys(%courseroles))) {
6597: if ($user !~ /^(\w{2})/) { next; }
6598: my ($role) = ($user =~ /^(\w{2})/);
6599: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6600: my ($section,$status);
1.240 albertel 6601: if ($role eq 'cr' &&
6602: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6603: $section=$1;
6604: }
6605: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6606: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6607: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6608: if ($end == -1 && $start == -1) {
6609: next; #deleted role
6610: }
6611: if (!defined($possible_status)) {
6612: $sectioncount{$section}++;
6613: } else {
6614: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6615: $status = 'active';
6616: } elsif ($end < $now) {
6617: $status = 'future';
6618: } elsif ($start > $now) {
6619: $status = 'previous';
6620: }
6621: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6622: $sectioncount{$section}++;
6623: }
6624: }
1.233 raeburn 6625: }
1.366 albertel 6626: return %sectioncount;
1.233 raeburn 6627: }
6628:
1.274 raeburn 6629: ###############################################
1.294 raeburn 6630:
6631: =pod
1.405 albertel 6632:
6633: =item * &get_course_users()
6634:
1.275 raeburn 6635: Retrieves usernames:domains for users in the specified course
6636: with specific role(s), and access status.
6637:
6638: Incoming parameters:
1.277 albertel 6639: 1. course domain
6640: 2. course number
6641: 3. access status: users must have - either active,
1.275 raeburn 6642: previous, future, or all.
1.277 albertel 6643: 4. reference to array of permissible roles
1.288 raeburn 6644: 5. reference to array of section restrictions (optional)
6645: 6. reference to results object (hash of hashes).
6646: 7. reference to optional userdata hash
1.609 raeburn 6647: 8. reference to optional statushash
1.630 raeburn 6648: 9. flag if privileged users (except those set to unhide in
6649: course settings) should be excluded
1.609 raeburn 6650: Keys of top level results hash are roles.
1.275 raeburn 6651: Keys of inner hashes are username:domain, with
6652: values set to access type.
1.288 raeburn 6653: Optional userdata hash returns an array with arguments in the
6654: same order as loncoursedata::get_classlist() for student data.
6655:
1.609 raeburn 6656: Optional statushash returns
6657:
1.288 raeburn 6658: Entries for end, start, section and status are blank because
6659: of the possibility of multiple values for non-student roles.
6660:
1.275 raeburn 6661: =cut
1.405 albertel 6662:
1.275 raeburn 6663: ###############################################
1.405 albertel 6664:
1.275 raeburn 6665: sub get_course_users {
1.630 raeburn 6666: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6667: my %idx = ();
1.419 raeburn 6668: my %seclists;
1.288 raeburn 6669:
6670: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6671: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6672: $idx{end} = &Apache::loncoursedata::CL_END();
6673: $idx{start} = &Apache::loncoursedata::CL_START();
6674: $idx{id} = &Apache::loncoursedata::CL_ID();
6675: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6676: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6677: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6678:
1.290 albertel 6679: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6680: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6681: my $now = time;
1.277 albertel 6682: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6683: my $match = 0;
1.412 raeburn 6684: my $secmatch = 0;
1.419 raeburn 6685: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6686: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6687: if ($section eq '') {
6688: $section = 'none';
6689: }
1.291 albertel 6690: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6691: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6692: $secmatch = 1;
6693: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6694: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6695: $secmatch = 1;
6696: }
6697: } else {
1.419 raeburn 6698: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6699: $secmatch = 1;
6700: }
1.290 albertel 6701: }
1.412 raeburn 6702: if (!$secmatch) {
6703: next;
6704: }
1.419 raeburn 6705: }
1.275 raeburn 6706: if (defined($$types{'active'})) {
1.288 raeburn 6707: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6708: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6709: $match = 1;
1.275 raeburn 6710: }
6711: }
6712: if (defined($$types{'previous'})) {
1.609 raeburn 6713: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6714: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6715: $match = 1;
1.275 raeburn 6716: }
6717: }
6718: if (defined($$types{'future'})) {
1.609 raeburn 6719: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6720: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6721: $match = 1;
1.275 raeburn 6722: }
6723: }
1.609 raeburn 6724: if ($match) {
6725: push(@{$seclists{$student}},$section);
6726: if (ref($userdata) eq 'HASH') {
6727: $$userdata{$student} = $$classlist{$student};
6728: }
6729: if (ref($statushash) eq 'HASH') {
6730: $statushash->{$student}{'st'}{$section} = $status;
6731: }
1.288 raeburn 6732: }
1.275 raeburn 6733: }
6734: }
1.412 raeburn 6735: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6736: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6737: my $now = time;
1.609 raeburn 6738: my %displaystatus = ( previous => 'Expired',
6739: active => 'Active',
6740: future => 'Future',
6741: );
1.630 raeburn 6742: my %nothide;
6743: if ($hidepriv) {
6744: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6745: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6746: if ($user !~ /:/) {
6747: $nothide{join(':',split(/[\@]/,$user))}=1;
6748: } else {
6749: $nothide{$user} = 1;
6750: }
6751: }
6752: }
1.439 raeburn 6753: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6754: my $match = 0;
1.412 raeburn 6755: my $secmatch = 0;
1.439 raeburn 6756: my $status;
1.412 raeburn 6757: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6758: $user =~ s/:$//;
1.439 raeburn 6759: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6760: if ($end == -1 || $start == -1) {
6761: next;
6762: }
6763: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6764: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6765: my ($uname,$udom) = split(/:/,$user);
6766: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6767: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6768: $secmatch = 1;
6769: } elsif ($usec eq '') {
1.420 albertel 6770: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6771: $secmatch = 1;
6772: }
6773: } else {
6774: if (grep(/^\Q$usec\E$/,@{$sections})) {
6775: $secmatch = 1;
6776: }
6777: }
6778: if (!$secmatch) {
6779: next;
6780: }
1.288 raeburn 6781: }
1.419 raeburn 6782: if ($usec eq '') {
6783: $usec = 'none';
6784: }
1.275 raeburn 6785: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6786: if ($hidepriv) {
6787: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6788: (!$nothide{$uname.':'.$udom})) {
6789: next;
6790: }
6791: }
1.503 raeburn 6792: if ($end > 0 && $end < $now) {
1.439 raeburn 6793: $status = 'previous';
6794: } elsif ($start > $now) {
6795: $status = 'future';
6796: } else {
6797: $status = 'active';
6798: }
1.277 albertel 6799: foreach my $type (keys(%{$types})) {
1.275 raeburn 6800: if ($status eq $type) {
1.420 albertel 6801: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6802: push(@{$$users{$role}{$user}},$type);
6803: }
1.288 raeburn 6804: $match = 1;
6805: }
6806: }
1.419 raeburn 6807: if (($match) && (ref($userdata) eq 'HASH')) {
6808: if (!exists($$userdata{$uname.':'.$udom})) {
6809: &get_user_info($udom,$uname,\%idx,$userdata);
6810: }
1.420 albertel 6811: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6812: push(@{$seclists{$uname.':'.$udom}},$usec);
6813: }
1.609 raeburn 6814: if (ref($statushash) eq 'HASH') {
6815: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6816: }
1.275 raeburn 6817: }
6818: }
6819: }
6820: }
1.290 albertel 6821: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6822: if ((defined($cdom)) && (defined($cnum))) {
6823: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6824: if ( defined($csettings{'internal.courseowner'}) ) {
6825: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6826: next if ($owner eq '');
6827: my ($ownername,$ownerdom);
6828: if ($owner =~ /^([^:]+):([^:]+)$/) {
6829: $ownername = $1;
6830: $ownerdom = $2;
6831: } else {
6832: $ownername = $owner;
6833: $ownerdom = $cdom;
6834: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6835: }
6836: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6837: if (defined($userdata) &&
1.609 raeburn 6838: !exists($$userdata{$owner})) {
6839: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6840: if (!grep(/^none$/,@{$seclists{$owner}})) {
6841: push(@{$seclists{$owner}},'none');
6842: }
6843: if (ref($statushash) eq 'HASH') {
6844: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6845: }
1.290 albertel 6846: }
1.279 raeburn 6847: }
6848: }
6849: }
1.419 raeburn 6850: foreach my $user (keys(%seclists)) {
6851: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6852: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6853: }
1.275 raeburn 6854: }
6855: return;
6856: }
6857:
1.288 raeburn 6858: sub get_user_info {
6859: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6860: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6861: &plainname($uname,$udom,'lastname');
1.291 albertel 6862: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6863: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6864: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6865: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6866: return;
6867: }
1.275 raeburn 6868:
1.472 raeburn 6869: ###############################################
6870:
6871: =pod
6872:
6873: =item * &get_user_quota()
6874:
6875: Retrieves quota assigned for storage of portfolio files for a user
6876:
6877: Incoming parameters:
6878: 1. user's username
6879: 2. user's domain
6880:
6881: Returns:
1.536 raeburn 6882: 1. Disk quota (in Mb) assigned to student.
6883: 2. (Optional) Type of setting: custom or default
6884: (individually assigned or default for user's
6885: institutional status).
6886: 3. (Optional) - User's institutional status (e.g., faculty, staff
6887: or student - types as defined in localenroll::inst_usertypes
6888: for user's domain, which determines default quota for user.
6889: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6890:
6891: If a value has been stored in the user's environment,
1.536 raeburn 6892: it will return that, otherwise it returns the maximal default
6893: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6894:
6895: =cut
6896:
6897: ###############################################
6898:
6899:
6900: sub get_user_quota {
6901: my ($uname,$udom) = @_;
1.536 raeburn 6902: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6903: if (!defined($udom)) {
6904: $udom = $env{'user.domain'};
6905: }
6906: if (!defined($uname)) {
6907: $uname = $env{'user.name'};
6908: }
6909: if (($udom eq '' || $uname eq '') ||
6910: ($udom eq 'public') && ($uname eq 'public')) {
6911: $quota = 0;
1.536 raeburn 6912: $quotatype = 'default';
6913: $defquota = 0;
1.472 raeburn 6914: } else {
1.536 raeburn 6915: my $inststatus;
1.472 raeburn 6916: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6917: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6918: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6919: } else {
1.536 raeburn 6920: my %userenv =
6921: &Apache::lonnet::get('environment',['portfolioquota',
6922: 'inststatus'],$udom,$uname);
1.472 raeburn 6923: my ($tmp) = keys(%userenv);
6924: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6925: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6926: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6927: } else {
6928: undef(%userenv);
6929: }
6930: }
1.536 raeburn 6931: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6932: if ($quota eq '') {
1.536 raeburn 6933: $quota = $defquota;
6934: $quotatype = 'default';
6935: } else {
6936: $quotatype = 'custom';
1.472 raeburn 6937: }
6938: }
1.536 raeburn 6939: if (wantarray) {
6940: return ($quota,$quotatype,$settingstatus,$defquota);
6941: } else {
6942: return $quota;
6943: }
1.472 raeburn 6944: }
6945:
6946: ###############################################
6947:
6948: =pod
6949:
6950: =item * &default_quota()
6951:
1.536 raeburn 6952: Retrieves default quota assigned for storage of user portfolio files,
6953: given an (optional) user's institutional status.
1.472 raeburn 6954:
6955: Incoming parameters:
6956: 1. domain
1.536 raeburn 6957: 2. (Optional) institutional status(es). This is a : separated list of
6958: status types (e.g., faculty, staff, student etc.)
6959: which apply to the user for whom the default is being retrieved.
6960: If the institutional status string in undefined, the domain
6961: default quota will be returned.
1.472 raeburn 6962:
6963: Returns:
6964: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6965: 2. (Optional) institutional type which determined the value of the
6966: default quota.
1.472 raeburn 6967:
6968: If a value has been stored in the domain's configuration db,
6969: it will return that, otherwise it returns 20 (for backwards
6970: compatibility with domains which have not set up a configuration
6971: db file; the original statically defined portfolio quota was 20 Mb).
6972:
1.536 raeburn 6973: If the user's status includes multiple types (e.g., staff and student),
6974: the largest default quota which applies to the user determines the
6975: default quota returned.
6976:
1.692.4.15 raeburn 6977: =back
6978:
1.472 raeburn 6979: =cut
6980:
6981: ###############################################
6982:
6983:
6984: sub default_quota {
1.536 raeburn 6985: my ($udom,$inststatus) = @_;
6986: my ($defquota,$settingstatus);
6987: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6988: ['quotas'],$udom);
6989: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6990: if ($inststatus ne '') {
1.692.4.2 raeburn 6991: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 6992: foreach my $item (@statuses) {
1.692.4.2 raeburn 6993: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
6994: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
6995: if ($defquota eq '') {
6996: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
6997: $settingstatus = $item;
6998: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
6999: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7000: $settingstatus = $item;
7001: }
7002: }
7003: } else {
7004: if ($quotahash{'quotas'}{$item} ne '') {
7005: if ($defquota eq '') {
7006: $defquota = $quotahash{'quotas'}{$item};
7007: $settingstatus = $item;
7008: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7009: $defquota = $quotahash{'quotas'}{$item};
7010: $settingstatus = $item;
7011: }
1.536 raeburn 7012: }
7013: }
7014: }
7015: }
7016: if ($defquota eq '') {
1.692.4.2 raeburn 7017: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7018: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7019: } else {
7020: $defquota = $quotahash{'quotas'}{'default'};
7021: }
1.536 raeburn 7022: $settingstatus = 'default';
7023: }
7024: } else {
7025: $settingstatus = 'default';
7026: $defquota = 20;
7027: }
7028: if (wantarray) {
7029: return ($defquota,$settingstatus);
1.472 raeburn 7030: } else {
1.536 raeburn 7031: return $defquota;
1.472 raeburn 7032: }
7033: }
7034:
1.384 raeburn 7035: sub get_secgrprole_info {
7036: my ($cdom,$cnum,$needroles,$type) = @_;
7037: my %sections_count = &get_sections($cdom,$cnum);
7038: my @sections = (sort {$a <=> $b} keys(%sections_count));
7039: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7040: my @groups = sort(keys(%curr_groups));
7041: my $allroles = [];
7042: my $rolehash;
7043: my $accesshash = {
7044: active => 'Currently has access',
7045: future => 'Will have future access',
7046: previous => 'Previously had access',
7047: };
7048: if ($needroles) {
7049: $rolehash = {'all' => 'all'};
1.385 albertel 7050: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7051: if (&Apache::lonnet::error(%user_roles)) {
7052: undef(%user_roles);
7053: }
7054: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7055: my ($role)=split(/\:/,$item,2);
7056: if ($role eq 'cr') { next; }
7057: if ($role =~ /^cr/) {
7058: $$rolehash{$role} = (split('/',$role))[3];
7059: } else {
7060: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7061: }
7062: }
7063: foreach my $key (sort(keys(%{$rolehash}))) {
7064: push(@{$allroles},$key);
7065: }
7066: push (@{$allroles},'st');
7067: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7068: }
7069: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7070: }
7071:
1.555 raeburn 7072: sub user_picker {
1.627 raeburn 7073: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7074: my $currdom = $dom;
7075: my %curr_selected = (
7076: srchin => 'dom',
1.580 raeburn 7077: srchby => 'lastname',
1.555 raeburn 7078: );
7079: my $srchterm;
1.625 raeburn 7080: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7081: if ($srch->{'srchby'} ne '') {
7082: $curr_selected{'srchby'} = $srch->{'srchby'};
7083: }
7084: if ($srch->{'srchin'} ne '') {
7085: $curr_selected{'srchin'} = $srch->{'srchin'};
7086: }
7087: if ($srch->{'srchtype'} ne '') {
7088: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7089: }
7090: if ($srch->{'srchdomain'} ne '') {
7091: $currdom = $srch->{'srchdomain'};
7092: }
7093: $srchterm = $srch->{'srchterm'};
7094: }
7095: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7096: 'usr' => 'Search criteria',
1.563 raeburn 7097: 'doma' => 'Domain/institution to search',
1.558 albertel 7098: 'uname' => 'username',
7099: 'lastname' => 'last name',
1.555 raeburn 7100: 'lastfirst' => 'last name, first name',
1.558 albertel 7101: 'crs' => 'in this course',
1.576 raeburn 7102: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7103: 'alc' => 'all LON-CAPA',
1.573 raeburn 7104: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7105: 'exact' => 'is',
7106: 'contains' => 'contains',
1.569 raeburn 7107: 'begins' => 'begins with',
1.571 raeburn 7108: 'youm' => "You must include some text to search for.",
7109: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7110: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7111: 'yomc' => "You must choose a domain when using an institutional directory search.",
7112: 'ymcd' => "You must choose a domain when using a domain search.",
7113: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7114: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7115: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7116: );
1.563 raeburn 7117: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7118: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7119:
7120: my @srchins = ('crs','dom','alc','instd');
7121:
7122: foreach my $option (@srchins) {
7123: # FIXME 'alc' option unavailable until
7124: # loncreateuser::print_user_query_page()
7125: # has been completed.
7126: next if ($option eq 'alc');
1.692.4.11 raeburn 7127: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7128: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7129: if ($curr_selected{'srchin'} eq $option) {
7130: $srchinsel .= '
7131: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7132: } else {
7133: $srchinsel .= '
7134: <option value="'.$option.'">'.$lt{$option}.'</option>';
7135: }
1.555 raeburn 7136: }
1.563 raeburn 7137: $srchinsel .= "\n </select>\n";
1.555 raeburn 7138:
7139: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7140: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7141: if ($curr_selected{'srchby'} eq $option) {
7142: $srchbysel .= '
7143: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7144: } else {
7145: $srchbysel .= '
7146: <option value="'.$option.'">'.$lt{$option}.'</option>';
7147: }
7148: }
7149: $srchbysel .= "\n </select>\n";
7150:
7151: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7152: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7153: if ($curr_selected{'srchtype'} eq $option) {
7154: $srchtypesel .= '
7155: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7156: } else {
7157: $srchtypesel .= '
7158: <option value="'.$option.'">'.$lt{$option}.'</option>';
7159: }
7160: }
7161: $srchtypesel .= "\n </select>\n";
7162:
1.558 albertel 7163: my ($newuserscript,$new_user_create);
1.556 raeburn 7164:
7165: if ($forcenewuser) {
1.576 raeburn 7166: if (ref($srch) eq 'HASH') {
7167: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7168: if ($cancreate) {
7169: $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>';
7170: } else {
1.692.4.2 raeburn 7171: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7172: my %usertypetext = (
7173: official => 'institutional',
7174: unofficial => 'non-institutional',
7175: );
1.692.4.2 raeburn 7176: $new_user_create = '<p class="LC_warning">'.
7177: &mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.
7178: &mt('Please contact the [_1]helpdesk[_2] for assistance.','<a href="'.$helplink.'">','</a>').'</p><br />';
1.627 raeburn 7179: }
1.576 raeburn 7180: }
7181: }
7182:
1.556 raeburn 7183: $newuserscript = <<"ENDSCRIPT";
7184:
1.570 raeburn 7185: function setSearch(createnew,callingForm) {
1.556 raeburn 7186: if (createnew == 1) {
1.570 raeburn 7187: for (var i=0; i<callingForm.srchby.length; i++) {
7188: if (callingForm.srchby.options[i].value == 'uname') {
7189: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7190: }
7191: }
1.570 raeburn 7192: for (var i=0; i<callingForm.srchin.length; i++) {
7193: if ( callingForm.srchin.options[i].value == 'dom') {
7194: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7195: }
7196: }
1.570 raeburn 7197: for (var i=0; i<callingForm.srchtype.length; i++) {
7198: if (callingForm.srchtype.options[i].value == 'exact') {
7199: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7200: }
7201: }
1.570 raeburn 7202: for (var i=0; i<callingForm.srchdomain.length; i++) {
7203: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7204: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7205: }
7206: }
7207: }
7208: }
7209: ENDSCRIPT
1.558 albertel 7210:
1.556 raeburn 7211: }
7212:
1.555 raeburn 7213: my $output = <<"END_BLOCK";
1.556 raeburn 7214: <script type="text/javascript">
1.692.4.4 raeburn 7215: // <![CDATA[
1.570 raeburn 7216: function validateEntry(callingForm) {
1.558 albertel 7217:
1.556 raeburn 7218: var checkok = 1;
1.558 albertel 7219: var srchin;
1.570 raeburn 7220: for (var i=0; i<callingForm.srchin.length; i++) {
7221: if ( callingForm.srchin[i].checked ) {
7222: srchin = callingForm.srchin[i].value;
1.558 albertel 7223: }
7224: }
7225:
1.570 raeburn 7226: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7227: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7228: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7229: var srchterm = callingForm.srchterm.value;
7230: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7231: var msg = "";
7232:
7233: if (srchterm == "") {
7234: checkok = 0;
1.571 raeburn 7235: msg += "$lt{'youm'}\\n";
1.556 raeburn 7236: }
7237:
1.569 raeburn 7238: if (srchtype== 'begins') {
7239: if (srchterm.length < 2) {
7240: checkok = 0;
1.571 raeburn 7241: msg += "$lt{'thte'}\\n";
1.569 raeburn 7242: }
7243: }
7244:
1.556 raeburn 7245: if (srchtype== 'contains') {
7246: if (srchterm.length < 3) {
7247: checkok = 0;
1.571 raeburn 7248: msg += "$lt{'thet'}\\n";
1.556 raeburn 7249: }
7250: }
7251: if (srchin == 'instd') {
7252: if (srchdomain == '') {
7253: checkok = 0;
1.571 raeburn 7254: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7255: }
7256: }
7257: if (srchin == 'dom') {
7258: if (srchdomain == '') {
7259: checkok = 0;
1.571 raeburn 7260: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7261: }
7262: }
7263: if (srchby == 'lastfirst') {
7264: if (srchterm.indexOf(",") == -1) {
7265: checkok = 0;
1.571 raeburn 7266: msg += "$lt{'whus'}\\n";
1.556 raeburn 7267: }
7268: if (srchterm.indexOf(",") == srchterm.length -1) {
7269: checkok = 0;
1.571 raeburn 7270: msg += "$lt{'whse'}\\n";
1.556 raeburn 7271: }
7272: }
7273: if (checkok == 0) {
1.571 raeburn 7274: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7275: return;
7276: }
7277: if (checkok == 1) {
1.570 raeburn 7278: callingForm.submit();
1.556 raeburn 7279: }
7280: }
7281:
7282: $newuserscript
7283:
1.692.4.4 raeburn 7284: // ]]>
1.556 raeburn 7285: </script>
1.558 albertel 7286:
7287: $new_user_create
7288:
1.555 raeburn 7289: END_BLOCK
1.558 albertel 7290:
1.692.4.9 raeburn 7291: $output .= &Apache::lonhtmlcommon::start_pick_box().
7292: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7293: $domform.
7294: &Apache::lonhtmlcommon::row_closure().
7295: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7296: $srchbysel.
7297: $srchtypesel.
7298: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7299: $srchinsel.
7300: &Apache::lonhtmlcommon::row_closure(1).
7301: &Apache::lonhtmlcommon::end_pick_box().
7302: '<br />';
1.555 raeburn 7303: return $output;
7304: }
7305:
1.612 raeburn 7306: sub user_rule_check {
1.615 raeburn 7307: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7308: my $response;
7309: if (ref($usershash) eq 'HASH') {
7310: foreach my $user (keys(%{$usershash})) {
7311: my ($uname,$udom) = split(/:/,$user);
7312: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7313: my ($id,$newuser);
1.612 raeburn 7314: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7315: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7316: $id = $usershash->{$user}->{'id'};
7317: }
7318: my $inst_response;
7319: if (ref($checks) eq 'HASH') {
7320: if (defined($checks->{'username'})) {
1.615 raeburn 7321: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7322: &Apache::lonnet::get_instuser($udom,$uname);
7323: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7324: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7325: &Apache::lonnet::get_instuser($udom,undef,$id);
7326: }
1.615 raeburn 7327: } else {
7328: ($inst_response,%{$inst_results->{$user}}) =
7329: &Apache::lonnet::get_instuser($udom,$uname);
7330: return;
1.612 raeburn 7331: }
1.615 raeburn 7332: if (!$got_rules->{$udom}) {
1.612 raeburn 7333: my %domconfig = &Apache::lonnet::get_dom('configuration',
7334: ['usercreation'],$udom);
7335: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7336: foreach my $item ('username','id') {
1.612 raeburn 7337: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7338: $$curr_rules{$udom}{$item} =
7339: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7340: }
7341: }
7342: }
1.615 raeburn 7343: $got_rules->{$udom} = 1;
1.585 raeburn 7344: }
1.612 raeburn 7345: foreach my $item (keys(%{$checks})) {
7346: if (ref($$curr_rules{$udom}) eq 'HASH') {
7347: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7348: if (@{$$curr_rules{$udom}{$item}} > 0) {
7349: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7350: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7351: if ($rule_check{$rule}) {
7352: $$rulematch{$user}{$item} = $rule;
7353: if ($inst_response eq 'ok') {
1.615 raeburn 7354: if (ref($inst_results) eq 'HASH') {
7355: if (ref($inst_results->{$user}) eq 'HASH') {
7356: if (keys(%{$inst_results->{$user}}) == 0) {
7357: $$alerts{$item}{$udom}{$uname} = 1;
7358: }
1.612 raeburn 7359: }
7360: }
1.615 raeburn 7361: }
7362: last;
1.585 raeburn 7363: }
7364: }
7365: }
7366: }
7367: }
7368: }
7369: }
7370: }
1.612 raeburn 7371: return;
7372: }
7373:
7374: sub user_rule_formats {
7375: my ($domain,$domdesc,$curr_rules,$check) = @_;
7376: my %text = (
7377: 'username' => 'Usernames',
7378: 'id' => 'IDs',
7379: );
7380: my $output;
7381: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7382: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7383: if (@{$ruleorder} > 0) {
7384: $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>';
7385: foreach my $rule (@{$ruleorder}) {
7386: if (ref($curr_rules) eq 'ARRAY') {
7387: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7388: if (ref($rules->{$rule}) eq 'HASH') {
7389: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7390: $rules->{$rule}{'desc'}.'</li>';
7391: }
7392: }
7393: }
7394: }
7395: $output .= '</ul>';
7396: }
7397: }
7398: return $output;
7399: }
7400:
7401: sub instrule_disallow_msg {
1.615 raeburn 7402: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7403: my $response;
7404: my %text = (
7405: item => 'username',
7406: items => 'usernames',
7407: match => 'matches',
7408: do => 'does',
7409: action => 'a username',
7410: one => 'one',
7411: );
7412: if ($count > 1) {
7413: $text{'item'} = 'usernames';
7414: $text{'match'} ='match';
7415: $text{'do'} = 'do';
7416: $text{'action'} = 'usernames',
7417: $text{'one'} = 'ones';
7418: }
7419: if ($checkitem eq 'id') {
7420: $text{'items'} = 'IDs';
7421: $text{'item'} = 'ID';
7422: $text{'action'} = 'an ID';
1.615 raeburn 7423: if ($count > 1) {
7424: $text{'item'} = 'IDs';
7425: $text{'action'} = 'IDs';
7426: }
1.612 raeburn 7427: }
1.674 bisitz 7428: $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 7429: if ($mode eq 'upload') {
7430: if ($checkitem eq 'username') {
7431: $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'}.");
7432: } elsif ($checkitem eq 'id') {
1.674 bisitz 7433: $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 7434: }
1.669 raeburn 7435: } elsif ($mode eq 'selfcreate') {
7436: if ($checkitem eq 'id') {
7437: $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.");
7438: }
1.615 raeburn 7439: } else {
7440: if ($checkitem eq 'username') {
7441: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7442: } elsif ($checkitem eq 'id') {
7443: $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.");
7444: }
1.612 raeburn 7445: }
7446: return $response;
1.585 raeburn 7447: }
7448:
1.624 raeburn 7449: sub personal_data_fieldtitles {
7450: my %fieldtitles = &Apache::lonlocal::texthash (
7451: id => 'Student/Employee ID',
7452: permanentemail => 'E-mail address',
7453: lastname => 'Last Name',
7454: firstname => 'First Name',
7455: middlename => 'Middle Name',
7456: generation => 'Generation',
7457: gen => 'Generation',
1.692.4.2 raeburn 7458: inststatus => 'Affiliation',
1.624 raeburn 7459: );
7460: return %fieldtitles;
7461: }
7462:
1.642 raeburn 7463: sub sorted_inst_types {
7464: my ($dom) = @_;
7465: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7466: my $othertitle = &mt('All users');
7467: if ($env{'request.course.id'}) {
1.668 raeburn 7468: $othertitle = &mt('Any users');
1.642 raeburn 7469: }
7470: my @types;
7471: if (ref($order) eq 'ARRAY') {
7472: @types = @{$order};
7473: }
7474: if (@types == 0) {
7475: if (ref($usertypes) eq 'HASH') {
7476: @types = sort(keys(%{$usertypes}));
7477: }
7478: }
7479: if (keys(%{$usertypes}) > 0) {
7480: $othertitle = &mt('Other users');
7481: }
7482: return ($othertitle,$usertypes,\@types);
7483: }
7484:
1.645 raeburn 7485: sub get_institutional_codes {
7486: my ($settings,$allcourses,$LC_code) = @_;
7487: # Get complete list of course sections to update
7488: my @currsections = ();
7489: my @currxlists = ();
7490: my $coursecode = $$settings{'internal.coursecode'};
7491:
7492: if ($$settings{'internal.sectionnums'} ne '') {
7493: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7494: }
7495:
7496: if ($$settings{'internal.crosslistings'} ne '') {
7497: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7498: }
7499:
7500: if (@currxlists > 0) {
7501: foreach (@currxlists) {
7502: if (m/^([^:]+):(\w*)$/) {
7503: unless (grep/^$1$/,@{$allcourses}) {
7504: push @{$allcourses},$1;
7505: $$LC_code{$1} = $2;
7506: }
7507: }
7508: }
7509: }
7510:
7511: if (@currsections > 0) {
7512: foreach (@currsections) {
7513: if (m/^(\w+):(\w*)$/) {
7514: my $sec = $coursecode.$1;
7515: my $lc_sec = $2;
7516: unless (grep/^$sec$/,@{$allcourses}) {
7517: push @{$allcourses},$sec;
7518: $$LC_code{$sec} = $lc_sec;
7519: }
7520: }
7521: }
7522: }
7523: return;
7524: }
7525:
1.112 bowersj2 7526: =pod
7527:
1.692.4.2 raeburn 7528: =head1 Slot Helpers
7529:
7530: =over 4
7531:
7532: =item * sorted_slots()
7533:
7534: Sorts an array of slot names in order of slot start time (earliest first).
7535:
7536: Inputs:
7537:
7538: =over 4
7539:
7540: slotsarr - Reference to array of unsorted slot names.
7541:
7542: slots - Reference to hash of hash, where outer hash keys are slot names.
7543:
7544: =back
7545:
7546: Returns:
7547:
7548: =over 4
7549:
7550: sorted - An array of slot names sorted by the start time of the slot.
7551:
7552: =back
7553:
7554: =back
7555:
7556: =cut
7557:
7558:
7559: sub sorted_slots {
7560: my ($slotsarr,$slots) = @_;
7561: my @sorted;
7562: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7563: @sorted =
7564: sort {
7565: if (ref($slots->{$a}) && ref($slots->{$b})) {
7566: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7567: }
7568: if (ref($slots->{$a})) { return -1;}
7569: if (ref($slots->{$b})) { return 1;}
7570: return 0;
7571: } @{$slotsarr};
7572: }
7573: return @sorted;
7574: }
7575:
7576: =pod
7577:
1.549 albertel 7578: =head1 HTTP Helpers
7579:
7580: =over 4
7581:
1.648 raeburn 7582: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7583:
1.258 albertel 7584: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7585: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7586: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7587:
7588: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7589: $possible_names is an ref to an array of form element names. As an example:
7590: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7591: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7592:
7593: =cut
1.1 albertel 7594:
1.6 albertel 7595: sub get_unprocessed_cgi {
1.25 albertel 7596: my ($query,$possible_names)= @_;
1.26 matthew 7597: # $Apache::lonxml::debug=1;
1.356 albertel 7598: foreach my $pair (split(/&/,$query)) {
7599: my ($name, $value) = split(/=/,$pair);
1.369 www 7600: $name = &unescape($name);
1.25 albertel 7601: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7602: $value =~ tr/+/ /;
7603: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7604: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7605: }
1.16 harris41 7606: }
1.6 albertel 7607: }
7608:
1.112 bowersj2 7609: =pod
7610:
1.648 raeburn 7611: =item * &cacheheader()
1.112 bowersj2 7612:
7613: returns cache-controlling header code
7614:
7615: =cut
7616:
1.7 albertel 7617: sub cacheheader {
1.258 albertel 7618: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7619: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7620: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7621: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7622: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7623: return $output;
1.7 albertel 7624: }
7625:
1.112 bowersj2 7626: =pod
7627:
1.648 raeburn 7628: =item * &no_cache($r)
1.112 bowersj2 7629:
7630: specifies header code to not have cache
7631:
7632: =cut
7633:
1.9 albertel 7634: sub no_cache {
1.216 albertel 7635: my ($r) = @_;
7636: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7637: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7638: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7639: $r->no_cache(1);
7640: $r->header_out("Expires" => $date);
7641: $r->header_out("Pragma" => "no-cache");
1.123 www 7642: }
7643:
7644: sub content_type {
1.181 albertel 7645: my ($r,$type,$charset) = @_;
1.299 foxr 7646: if ($r) {
7647: # Note that printout.pl calls this with undef for $r.
7648: &no_cache($r);
7649: }
1.258 albertel 7650: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7651: unless ($charset) {
7652: $charset=&Apache::lonlocal::current_encoding;
7653: }
7654: if ($charset) { $type.='; charset='.$charset; }
7655: if ($r) {
7656: $r->content_type($type);
7657: } else {
7658: print("Content-type: $type\n\n");
7659: }
1.9 albertel 7660: }
1.25 albertel 7661:
1.112 bowersj2 7662: =pod
7663:
1.648 raeburn 7664: =item * &add_to_env($name,$value)
1.112 bowersj2 7665:
1.258 albertel 7666: adds $name to the %env hash with value
1.112 bowersj2 7667: $value, if $name already exists, the entry is converted to an array
7668: reference and $value is added to the array.
7669:
7670: =cut
7671:
1.25 albertel 7672: sub add_to_env {
7673: my ($name,$value)=@_;
1.258 albertel 7674: if (defined($env{$name})) {
7675: if (ref($env{$name})) {
1.25 albertel 7676: #already have multiple values
1.258 albertel 7677: push(@{ $env{$name} },$value);
1.25 albertel 7678: } else {
7679: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7680: my $first=$env{$name};
7681: undef($env{$name});
7682: push(@{ $env{$name} },$first,$value);
1.25 albertel 7683: }
7684: } else {
1.258 albertel 7685: $env{$name}=$value;
1.25 albertel 7686: }
1.31 albertel 7687: }
1.149 albertel 7688:
7689: =pod
7690:
1.648 raeburn 7691: =item * &get_env_multiple($name)
1.149 albertel 7692:
1.258 albertel 7693: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7694: values may be defined and end up as an array ref.
7695:
7696: returns an array of values
7697:
7698: =cut
7699:
7700: sub get_env_multiple {
7701: my ($name) = @_;
7702: my @values;
1.258 albertel 7703: if (defined($env{$name})) {
1.149 albertel 7704: # exists is it an array
1.258 albertel 7705: if (ref($env{$name})) {
7706: @values=@{ $env{$name} };
1.149 albertel 7707: } else {
1.258 albertel 7708: $values[0]=$env{$name};
1.149 albertel 7709: }
7710: }
7711: return(@values);
7712: }
7713:
1.660 raeburn 7714: sub ask_for_embedded_content {
7715: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7716: my $upload_output = '
7717: <form name="upload_embedded" action="'.$actionurl.'"
7718: method="post" enctype="multipart/form-data">';
7719: $upload_output .= $state;
1.661 raeburn 7720: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7721:
7722: my $num = 0;
7723: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7724: $upload_output .= &start_data_table_row().
7725: '<td>'.$embed_file.'</td><td>';
7726: if ($args->{'ignore_remote_references'}
7727: && $embed_file =~ m{^\w+://}) {
7728: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7729: } elsif ($args->{'error_on_invalid_names'}
7730: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7731:
7732: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7733:
7734: } else {
7735: $upload_output .='
1.661 raeburn 7736: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7737: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7738: my $attrib = join(':',@{$$allfiles{$embed_file}});
7739: $upload_output .=
7740: "\n\t\t".
7741: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7742: $attrib.'" />';
7743: if (exists($$codebase{$embed_file})) {
7744: $upload_output .=
7745: "\n\t\t".
7746: '<input name="codebase_'.$num.'" type="hidden" value="'.
7747: &escape($$codebase{$embed_file}).'" />';
7748: }
7749: }
7750: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7751: $num++;
7752: }
7753: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7754: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7755: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7756: '.&mt('(only files for which a location has been provided will be uploaded)').'
7757: </form>';
7758: return $upload_output;
7759: }
7760:
1.661 raeburn 7761: sub upload_embedded {
7762: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7763: $current_disk_usage) = @_;
7764: my $output;
7765: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7766: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7767: my $orig_uploaded_filename =
7768: $env{'form.embedded_item_'.$i.'.filename'};
7769:
7770: $env{'form.embedded_orig_'.$i} =
7771: &unescape($env{'form.embedded_orig_'.$i});
7772: my ($path,$fname) =
7773: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7774: # no path, whole string is fname
7775: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7776:
7777: $path = $env{'form.currentpath'}.$path;
7778: $fname = &Apache::lonnet::clean_filename($fname);
7779: # See if there is anything left
7780: next if ($fname eq '');
7781:
7782: # Check if file already exists as a file or directory.
7783: my ($state,$msg);
7784: if ($context eq 'portfolio') {
7785: my $port_path = $dirpath;
7786: if ($group ne '') {
7787: $port_path = "groups/$group/$port_path";
7788: }
7789: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7790: $dir_root,$port_path,$disk_quota,
7791: $current_disk_usage,$uname,$udom);
7792: if ($state eq 'will_exceed_quota'
7793: || $state eq 'file_locked'
7794: || $state eq 'file_exists' ) {
7795: $output .= $msg;
7796: next;
7797: }
7798: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7799: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7800: if ($state eq 'exists') {
7801: $output .= $msg;
7802: next;
7803: }
7804: }
7805: # Check if extension is valid
7806: if (($fname =~ /\.(\w+)$/) &&
7807: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7808: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7809: next;
7810: } elsif (($fname =~ /\.(\w+)$/) &&
7811: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7812: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7813: next;
7814: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7815: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7816: next;
7817: }
7818:
7819: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7820: if ($context eq 'portfolio') {
7821: my $result=
7822: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7823: $dirpath.$path);
7824: if ($result !~ m|^/uploaded/|) {
7825: $output .= '<span class="LC_error">'
7826: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7827: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7828: .'</span><br />';
7829: next;
7830: } else {
7831: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7832: $path.$fname.'</span>').'</p>';
7833: }
7834: } else {
7835: # Save the file
7836: my $target = $env{'form.embedded_item_'.$i};
7837: my $fullpath = $dir_root.$dirpath.'/'.$path;
7838: my $dest = $fullpath.$fname;
7839: my $url = $url_root.$dirpath.'/'.$path.$fname;
7840: my @parts=split(/\//,$fullpath);
7841: my $count;
7842: my $filepath = $dir_root;
7843: for ($count=4;$count<=$#parts;$count++) {
7844: $filepath .= "/$parts[$count]";
7845: if ((-e $filepath)!=1) {
7846: mkdir($filepath,0770);
7847: }
7848: }
7849: my $fh;
7850: if (!open($fh,'>'.$dest)) {
7851: &Apache::lonnet::logthis('Failed to create '.$dest);
7852: $output .= '<span class="LC_error">'.
7853: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7854: '</span><br />';
7855: } else {
7856: if (!print $fh $env{'form.embedded_item_'.$i}) {
7857: &Apache::lonnet::logthis('Failed to write to '.$dest);
7858: $output .= '<span class="LC_error">'.
7859: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7860: '</span><br />';
7861: } else {
7862: if ($context eq 'testbank') {
7863: $output .= &mt('Embedded file uploaded successfully:').
7864: ' <a href="'.$url.'">'.
7865: $orig_uploaded_filename.'</a><br />';
7866: } else {
7867: $output .= '<font size="+2">'.
7868: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
7869: $orig_uploaded_filename.'</a>').'</font><br />';
7870: }
7871: }
7872: close($fh);
7873: }
7874: }
7875: }
7876: return $output;
7877: }
7878:
7879: sub check_for_existing {
7880: my ($path,$fname,$element) = @_;
7881: my ($state,$msg);
7882: if (-d $path.'/'.$fname) {
7883: $state = 'exists';
7884: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7885: } elsif (-e $path.'/'.$fname) {
7886: $state = 'exists';
7887: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7888: }
7889: if ($state eq 'exists') {
7890: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7891: }
7892: return ($state,$msg);
7893: }
7894:
7895: sub check_for_upload {
7896: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7897: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7898: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7899: my $getpropath = 1;
7900: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7901: $getpropath);
7902: my $found_file = 0;
7903: my $locked_file = 0;
7904: foreach my $line (@dir_list) {
7905: my ($file_name)=split(/\&/,$line,2);
7906: if ($file_name eq $fname){
7907: $file_name = $path.$file_name;
7908: if ($group ne '') {
7909: $file_name = $group.$file_name;
7910: }
7911: $found_file = 1;
7912: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7913: $locked_file = 1;
7914: }
7915: }
7916: }
7917: if (($current_disk_usage + $filesize) > $disk_quota){
7918: my $msg = '<span class="LC_error">'.
7919: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7920: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7921: return ('will_exceed_quota',$msg);
7922: } elsif ($found_file) {
7923: if ($locked_file) {
7924: my $msg = '<span class="LC_error">';
7925: $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>');
7926: $msg .= '</span><br />';
7927: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7928: return ('file_locked',$msg);
7929: } else {
7930: my $msg = '<span class="LC_error">';
7931: $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'});
7932: $msg .= '</span>';
7933: $msg .= '<br />';
7934: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7935: return ('file_exists',$msg);
7936: }
7937: }
7938: }
7939:
1.31 albertel 7940:
1.41 ng 7941: =pod
1.45 matthew 7942:
1.464 albertel 7943: =back
1.41 ng 7944:
1.112 bowersj2 7945: =head1 CSV Upload/Handling functions
1.38 albertel 7946:
1.41 ng 7947: =over 4
7948:
1.648 raeburn 7949: =item * &upfile_store($r)
1.41 ng 7950:
7951: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7952: needs $env{'form.upfile'}
1.41 ng 7953: returns $datatoken to be put into hidden field
7954:
7955: =cut
1.31 albertel 7956:
7957: sub upfile_store {
7958: my $r=shift;
1.258 albertel 7959: $env{'form.upfile'}=~s/\r/\n/gs;
7960: $env{'form.upfile'}=~s/\f/\n/gs;
7961: $env{'form.upfile'}=~s/\n+/\n/gs;
7962: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7963:
1.258 albertel 7964: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7965: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7966: {
1.158 raeburn 7967: my $datafile = $r->dir_config('lonDaemons').
7968: '/tmp/'.$datatoken.'.tmp';
7969: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7970: print $fh $env{'form.upfile'};
1.158 raeburn 7971: close($fh);
7972: }
1.31 albertel 7973: }
7974: return $datatoken;
7975: }
7976:
1.56 matthew 7977: =pod
7978:
1.648 raeburn 7979: =item * &load_tmp_file($r)
1.41 ng 7980:
7981: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7982: needs $env{'form.datatoken'},
7983: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7984:
7985: =cut
1.31 albertel 7986:
7987: sub load_tmp_file {
7988: my $r=shift;
7989: my @studentdata=();
7990: {
1.158 raeburn 7991: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7992: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7993: if ( open(my $fh,"<$studentfile") ) {
7994: @studentdata=<$fh>;
7995: close($fh);
7996: }
1.31 albertel 7997: }
1.258 albertel 7998: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7999: }
8000:
1.56 matthew 8001: =pod
8002:
1.648 raeburn 8003: =item * &upfile_record_sep()
1.41 ng 8004:
8005: Separate uploaded file into records
8006: returns array of records,
1.258 albertel 8007: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8008:
8009: =cut
1.31 albertel 8010:
8011: sub upfile_record_sep {
1.258 albertel 8012: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8013: } else {
1.248 albertel 8014: my @records;
1.258 albertel 8015: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8016: if ($line=~/^\s*$/) { next; }
8017: push(@records,$line);
8018: }
8019: return @records;
1.31 albertel 8020: }
8021: }
8022:
1.56 matthew 8023: =pod
8024:
1.648 raeburn 8025: =item * &record_sep($record)
1.41 ng 8026:
1.258 albertel 8027: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8028:
8029: =cut
8030:
1.263 www 8031: sub takeleft {
8032: my $index=shift;
8033: return substr('0000'.$index,-4,4);
8034: }
8035:
1.31 albertel 8036: sub record_sep {
8037: my $record=shift;
8038: my %components=();
1.258 albertel 8039: if ($env{'form.upfiletype'} eq 'xml') {
8040: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8041: my $i=0;
1.356 albertel 8042: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8043: $field=~s/^(\"|\')//;
8044: $field=~s/(\"|\')$//;
1.263 www 8045: $components{&takeleft($i)}=$field;
1.31 albertel 8046: $i++;
8047: }
1.258 albertel 8048: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8049: my $i=0;
1.356 albertel 8050: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8051: $field=~s/^(\"|\')//;
8052: $field=~s/(\"|\')$//;
1.263 www 8053: $components{&takeleft($i)}=$field;
1.31 albertel 8054: $i++;
8055: }
8056: } else {
1.561 www 8057: my $separator=',';
1.480 banghart 8058: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8059: $separator=';';
1.480 banghart 8060: }
1.31 albertel 8061: my $i=0;
1.561 www 8062: # the character we are looking for to indicate the end of a quote or a record
8063: my $looking_for=$separator;
8064: # do not add the characters to the fields
8065: my $ignore=0;
8066: # we just encountered a separator (or the beginning of the record)
8067: my $just_found_separator=1;
8068: # store the field we are working on here
8069: my $field='';
8070: # work our way through all characters in record
8071: foreach my $character ($record=~/(.)/g) {
8072: if ($character eq $looking_for) {
8073: if ($character ne $separator) {
8074: # Found the end of a quote, again looking for separator
8075: $looking_for=$separator;
8076: $ignore=1;
8077: } else {
8078: # Found a separator, store away what we got
8079: $components{&takeleft($i)}=$field;
8080: $i++;
8081: $just_found_separator=1;
8082: $ignore=0;
8083: $field='';
8084: }
8085: next;
8086: }
8087: # single or double quotation marks after a separator indicate beginning of a quote
8088: # we are now looking for the end of the quote and need to ignore separators
8089: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8090: $looking_for=$character;
8091: next;
8092: }
8093: # ignore would be true after we reached the end of a quote
8094: if ($ignore) { next; }
8095: if (($just_found_separator) && ($character=~/\s/)) { next; }
8096: $field.=$character;
8097: $just_found_separator=0;
1.31 albertel 8098: }
1.561 www 8099: # catch the very last entry, since we never encountered the separator
8100: $components{&takeleft($i)}=$field;
1.31 albertel 8101: }
8102: return %components;
8103: }
8104:
1.144 matthew 8105: ######################################################
8106: ######################################################
8107:
1.56 matthew 8108: =pod
8109:
1.648 raeburn 8110: =item * &upfile_select_html()
1.41 ng 8111:
1.144 matthew 8112: Return HTML code to select a file from the users machine and specify
8113: the file type.
1.41 ng 8114:
8115: =cut
8116:
1.144 matthew 8117: ######################################################
8118: ######################################################
1.31 albertel 8119: sub upfile_select_html {
1.144 matthew 8120: my %Types = (
8121: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8122: semisv => &mt('Semicolon separated values'),
1.144 matthew 8123: space => &mt('Space separated'),
8124: tab => &mt('Tabulator separated'),
8125: # xml => &mt('HTML/XML'),
8126: );
8127: my $Str = '<input type="file" name="upfile" size="50" />'.
1.692.4.2 raeburn 8128: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8129: foreach my $type (sort(keys(%Types))) {
8130: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8131: }
8132: $Str .= "</select>\n";
8133: return $Str;
1.31 albertel 8134: }
8135:
1.301 albertel 8136: sub get_samples {
8137: my ($records,$toget) = @_;
8138: my @samples=({});
8139: my $got=0;
8140: foreach my $rec (@$records) {
8141: my %temp = &record_sep($rec);
8142: if (! grep(/\S/, values(%temp))) { next; }
8143: if (%temp) {
8144: $samples[$got]=\%temp;
8145: $got++;
8146: if ($got == $toget) { last; }
8147: }
8148: }
8149: return \@samples;
8150: }
8151:
1.144 matthew 8152: ######################################################
8153: ######################################################
8154:
1.56 matthew 8155: =pod
8156:
1.648 raeburn 8157: =item * &csv_print_samples($r,$records)
1.41 ng 8158:
8159: Prints a table of sample values from each column uploaded $r is an
8160: Apache Request ref, $records is an arrayref from
8161: &Apache::loncommon::upfile_record_sep
8162:
8163: =cut
8164:
1.144 matthew 8165: ######################################################
8166: ######################################################
1.31 albertel 8167: sub csv_print_samples {
8168: my ($r,$records) = @_;
1.662 bisitz 8169: my $samples = &get_samples($records,5);
1.301 albertel 8170:
1.594 raeburn 8171: $r->print(&mt('Samples').'<br />'.&start_data_table().
8172: &start_data_table_header_row());
1.356 albertel 8173: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.692.4.6 raeburn 8174: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>');
8175: }
1.594 raeburn 8176: $r->print(&end_data_table_header_row());
1.301 albertel 8177: foreach my $hash (@$samples) {
1.594 raeburn 8178: $r->print(&start_data_table_row());
1.356 albertel 8179: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8180: $r->print('<td>');
1.356 albertel 8181: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8182: $r->print('</td>');
8183: }
1.594 raeburn 8184: $r->print(&end_data_table_row());
1.31 albertel 8185: }
1.594 raeburn 8186: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8187: }
8188:
1.144 matthew 8189: ######################################################
8190: ######################################################
8191:
1.56 matthew 8192: =pod
8193:
1.648 raeburn 8194: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8195:
8196: Prints a table to create associations between values and table columns.
1.144 matthew 8197:
1.41 ng 8198: $r is an Apache Request ref,
8199: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8200: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8201:
8202: =cut
8203:
1.144 matthew 8204: ######################################################
8205: ######################################################
1.31 albertel 8206: sub csv_print_select_table {
8207: my ($r,$records,$d) = @_;
1.301 albertel 8208: my $i=0;
8209: my $samples = &get_samples($records,1);
1.144 matthew 8210: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8211: &start_data_table().&start_data_table_header_row().
1.144 matthew 8212: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8213: '<th>'.&mt('Column').'</th>'.
8214: &end_data_table_header_row()."\n");
1.356 albertel 8215: foreach my $array_ref (@$d) {
8216: my ($value,$display,$defaultcol)=@{ $array_ref };
1.689 bisitz 8217: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8218:
1.692.4.8 raeburn 8219: $r->print('<td><select name"f'.$i.'"'.
1.32 matthew 8220: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8221: $r->print('<option value="none"></option>');
1.356 albertel 8222: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8223: $r->print('<option value="'.$sample.'"'.
8224: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8225: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8226: }
1.594 raeburn 8227: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8228: $i++;
8229: }
1.594 raeburn 8230: $r->print(&end_data_table());
1.31 albertel 8231: $i--;
8232: return $i;
8233: }
1.56 matthew 8234:
1.144 matthew 8235: ######################################################
8236: ######################################################
8237:
1.56 matthew 8238: =pod
1.31 albertel 8239:
1.648 raeburn 8240: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8241:
8242: Prints a table of sample values from the upload and can make associate samples to internal names.
8243:
8244: $r is an Apache Request ref,
8245: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8246: $d is an array of 2 element arrays (internal name, displayed name)
8247:
8248: =cut
8249:
1.144 matthew 8250: ######################################################
8251: ######################################################
1.31 albertel 8252: sub csv_samples_select_table {
8253: my ($r,$records,$d) = @_;
8254: my $i=0;
1.144 matthew 8255: #
1.662 bisitz 8256: my $max_samples = 5;
8257: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8258: $r->print(&start_data_table().
8259: &start_data_table_header_row().'<th>'.
8260: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8261: &end_data_table_header_row());
1.301 albertel 8262:
8263: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8264: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8265: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8266: foreach my $option (@$d) {
8267: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8268: $r->print('<option value="'.$value.'"'.
1.253 albertel 8269: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8270: $display.'</option>');
1.31 albertel 8271: }
8272: $r->print('</select></td><td>');
1.662 bisitz 8273: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8274: if (defined($samples->[$line]{$key})) {
8275: $r->print($samples->[$line]{$key}."<br />\n");
8276: }
8277: }
1.594 raeburn 8278: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8279: $i++;
8280: }
1.594 raeburn 8281: $r->print(&end_data_table());
1.31 albertel 8282: $i--;
8283: return($i);
1.115 matthew 8284: }
8285:
1.144 matthew 8286: ######################################################
8287: ######################################################
8288:
1.115 matthew 8289: =pod
8290:
1.648 raeburn 8291: =item * &clean_excel_name($name)
1.115 matthew 8292:
8293: Returns a replacement for $name which does not contain any illegal characters.
8294:
8295: =cut
8296:
1.144 matthew 8297: ######################################################
8298: ######################################################
1.115 matthew 8299: sub clean_excel_name {
8300: my ($name) = @_;
8301: $name =~ s/[:\*\?\/\\]//g;
8302: if (length($name) > 31) {
8303: $name = substr($name,0,31);
8304: }
8305: return $name;
1.25 albertel 8306: }
1.84 albertel 8307:
1.85 albertel 8308: =pod
8309:
1.648 raeburn 8310: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8311:
8312: Returns either 1 or undef
8313:
8314: 1 if the part is to be hidden, undef if it is to be shown
8315:
8316: Arguments are:
8317:
8318: $id the id of the part to be checked
8319: $symb, optional the symb of the resource to check
8320: $udom, optional the domain of the user to check for
8321: $uname, optional the username of the user to check for
8322:
8323: =cut
1.84 albertel 8324:
8325: sub check_if_partid_hidden {
8326: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8327: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8328: $symb,$udom,$uname);
1.141 albertel 8329: my $truth=1;
8330: #if the string starts with !, then the list is the list to show not hide
8331: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8332: my @hiddenlist=split(/,/,$hiddenparts);
8333: foreach my $checkid (@hiddenlist) {
1.141 albertel 8334: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8335: }
1.141 albertel 8336: return !$truth;
1.84 albertel 8337: }
1.127 matthew 8338:
1.138 matthew 8339:
8340: ############################################################
8341: ############################################################
8342:
8343: =pod
8344:
1.157 matthew 8345: =back
8346:
1.138 matthew 8347: =head1 cgi-bin script and graphing routines
8348:
1.157 matthew 8349: =over 4
8350:
1.648 raeburn 8351: =item * &get_cgi_id()
1.138 matthew 8352:
8353: Inputs: none
8354:
8355: Returns an id which can be used to pass environment variables
8356: to various cgi-bin scripts. These environment variables will
8357: be removed from the users environment after a given time by
8358: the routine &Apache::lonnet::transfer_profile_to_env.
8359:
8360: =cut
8361:
8362: ############################################################
8363: ############################################################
1.152 albertel 8364: my $uniq=0;
1.136 matthew 8365: sub get_cgi_id {
1.154 albertel 8366: $uniq=($uniq+1)%100000;
1.280 albertel 8367: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8368: }
8369:
1.127 matthew 8370: ############################################################
8371: ############################################################
8372:
8373: =pod
8374:
1.648 raeburn 8375: =item * &DrawBarGraph()
1.127 matthew 8376:
1.138 matthew 8377: Facilitates the plotting of data in a (stacked) bar graph.
8378: Puts plot definition data into the users environment in order for
8379: graph.png to plot it. Returns an <img> tag for the plot.
8380: The bars on the plot are labeled '1','2',...,'n'.
8381:
8382: Inputs:
8383:
8384: =over 4
8385:
8386: =item $Title: string, the title of the plot
8387:
8388: =item $xlabel: string, text describing the X-axis of the plot
8389:
8390: =item $ylabel: string, text describing the Y-axis of the plot
8391:
8392: =item $Max: scalar, the maximum Y value to use in the plot
8393: If $Max is < any data point, the graph will not be rendered.
8394:
1.140 matthew 8395: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8396: they are plotted. If undefined, default values will be used.
8397:
1.178 matthew 8398: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8399:
1.138 matthew 8400: =item @Values: An array of array references. Each array reference holds data
8401: to be plotted in a stacked bar chart.
8402:
1.239 matthew 8403: =item If the final element of @Values is a hash reference the key/value
8404: pairs will be added to the graph definition.
8405:
1.138 matthew 8406: =back
8407:
8408: Returns:
8409:
8410: An <img> tag which references graph.png and the appropriate identifying
8411: information for the plot.
8412:
1.127 matthew 8413: =cut
8414:
8415: ############################################################
8416: ############################################################
1.134 matthew 8417: sub DrawBarGraph {
1.178 matthew 8418: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8419: #
8420: if (! defined($colors)) {
8421: $colors = ['#33ff00',
8422: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8423: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8424: ];
8425: }
1.228 matthew 8426: my $extra_settings = {};
8427: if (ref($Values[-1]) eq 'HASH') {
8428: $extra_settings = pop(@Values);
8429: }
1.127 matthew 8430: #
1.136 matthew 8431: my $identifier = &get_cgi_id();
8432: my $id = 'cgi.'.$identifier;
1.129 matthew 8433: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8434: return '';
8435: }
1.225 matthew 8436: #
8437: my @Labels;
8438: if (defined($labels)) {
8439: @Labels = @$labels;
8440: } else {
8441: for (my $i=0;$i<@{$Values[0]};$i++) {
8442: push (@Labels,$i+1);
8443: }
8444: }
8445: #
1.129 matthew 8446: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8447: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8448: my %ValuesHash;
8449: my $NumSets=1;
8450: foreach my $array (@Values) {
8451: next if (! ref($array));
1.136 matthew 8452: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8453: join(',',@$array);
1.129 matthew 8454: }
1.127 matthew 8455: #
1.136 matthew 8456: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8457: if ($NumBars < 3) {
8458: $width = 120+$NumBars*32;
1.220 matthew 8459: $xskip = 1;
1.225 matthew 8460: $bar_width = 30;
8461: } elsif ($NumBars < 5) {
8462: $width = 120+$NumBars*20;
8463: $xskip = 1;
8464: $bar_width = 20;
1.220 matthew 8465: } elsif ($NumBars < 10) {
1.136 matthew 8466: $width = 120+$NumBars*15;
8467: $xskip = 1;
8468: $bar_width = 15;
8469: } elsif ($NumBars <= 25) {
8470: $width = 120+$NumBars*11;
8471: $xskip = 5;
8472: $bar_width = 8;
8473: } elsif ($NumBars <= 50) {
8474: $width = 120+$NumBars*8;
8475: $xskip = 5;
8476: $bar_width = 4;
8477: } else {
8478: $width = 120+$NumBars*8;
8479: $xskip = 5;
8480: $bar_width = 4;
8481: }
8482: #
1.137 matthew 8483: $Max = 1 if ($Max < 1);
8484: if ( int($Max) < $Max ) {
8485: $Max++;
8486: $Max = int($Max);
8487: }
1.127 matthew 8488: $Title = '' if (! defined($Title));
8489: $xlabel = '' if (! defined($xlabel));
8490: $ylabel = '' if (! defined($ylabel));
1.369 www 8491: $ValuesHash{$id.'.title'} = &escape($Title);
8492: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8493: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8494: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8495: $ValuesHash{$id.'.NumBars'} = $NumBars;
8496: $ValuesHash{$id.'.NumSets'} = $NumSets;
8497: $ValuesHash{$id.'.PlotType'} = 'bar';
8498: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8499: $ValuesHash{$id.'.height'} = $height;
8500: $ValuesHash{$id.'.width'} = $width;
8501: $ValuesHash{$id.'.xskip'} = $xskip;
8502: $ValuesHash{$id.'.bar_width'} = $bar_width;
8503: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8504: #
1.228 matthew 8505: # Deal with other parameters
8506: while (my ($key,$value) = each(%$extra_settings)) {
8507: $ValuesHash{$id.'.'.$key} = $value;
8508: }
8509: #
1.646 raeburn 8510: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8511: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8512: }
8513:
8514: ############################################################
8515: ############################################################
8516:
8517: =pod
8518:
1.648 raeburn 8519: =item * &DrawXYGraph()
1.137 matthew 8520:
1.138 matthew 8521: Facilitates the plotting of data in an XY graph.
8522: Puts plot definition data into the users environment in order for
8523: graph.png to plot it. Returns an <img> tag for the plot.
8524:
8525: Inputs:
8526:
8527: =over 4
8528:
8529: =item $Title: string, the title of the plot
8530:
8531: =item $xlabel: string, text describing the X-axis of the plot
8532:
8533: =item $ylabel: string, text describing the Y-axis of the plot
8534:
8535: =item $Max: scalar, the maximum Y value to use in the plot
8536: If $Max is < any data point, the graph will not be rendered.
8537:
8538: =item $colors: Array ref containing the hex color codes for the data to be
8539: plotted in. If undefined, default values will be used.
8540:
8541: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8542:
8543: =item $Ydata: Array ref containing Array refs.
1.185 www 8544: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8545:
8546: =item %Values: hash indicating or overriding any default values which are
8547: passed to graph.png.
8548: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8549:
8550: =back
8551:
8552: Returns:
8553:
8554: An <img> tag which references graph.png and the appropriate identifying
8555: information for the plot.
8556:
1.137 matthew 8557: =cut
8558:
8559: ############################################################
8560: ############################################################
8561: sub DrawXYGraph {
8562: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8563: #
8564: # Create the identifier for the graph
8565: my $identifier = &get_cgi_id();
8566: my $id = 'cgi.'.$identifier;
8567: #
8568: $Title = '' if (! defined($Title));
8569: $xlabel = '' if (! defined($xlabel));
8570: $ylabel = '' if (! defined($ylabel));
8571: my %ValuesHash =
8572: (
1.369 www 8573: $id.'.title' => &escape($Title),
8574: $id.'.xlabel' => &escape($xlabel),
8575: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8576: $id.'.y_max_value'=> $Max,
8577: $id.'.labels' => join(',',@$Xlabels),
8578: $id.'.PlotType' => 'XY',
8579: );
8580: #
8581: if (defined($colors) && ref($colors) eq 'ARRAY') {
8582: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8583: }
8584: #
8585: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8586: return '';
8587: }
8588: my $NumSets=1;
1.138 matthew 8589: foreach my $array (@{$Ydata}){
1.137 matthew 8590: next if (! ref($array));
8591: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8592: }
1.138 matthew 8593: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8594: #
8595: # Deal with other parameters
8596: while (my ($key,$value) = each(%Values)) {
8597: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8598: }
8599: #
1.646 raeburn 8600: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8601: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8602: }
8603:
8604: ############################################################
8605: ############################################################
8606:
8607: =pod
8608:
1.648 raeburn 8609: =item * &DrawXYYGraph()
1.138 matthew 8610:
8611: Facilitates the plotting of data in an XY graph with two Y axes.
8612: Puts plot definition data into the users environment in order for
8613: graph.png to plot it. Returns an <img> tag for the plot.
8614:
8615: Inputs:
8616:
8617: =over 4
8618:
8619: =item $Title: string, the title of the plot
8620:
8621: =item $xlabel: string, text describing the X-axis of the plot
8622:
8623: =item $ylabel: string, text describing the Y-axis of the plot
8624:
8625: =item $colors: Array ref containing the hex color codes for the data to be
8626: plotted in. If undefined, default values will be used.
8627:
8628: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8629:
8630: =item $Ydata1: The first data set
8631:
8632: =item $Min1: The minimum value of the left Y-axis
8633:
8634: =item $Max1: The maximum value of the left Y-axis
8635:
8636: =item $Ydata2: The second data set
8637:
8638: =item $Min2: The minimum value of the right Y-axis
8639:
8640: =item $Max2: The maximum value of the left Y-axis
8641:
8642: =item %Values: hash indicating or overriding any default values which are
8643: passed to graph.png.
8644: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8645:
8646: =back
8647:
8648: Returns:
8649:
8650: An <img> tag which references graph.png and the appropriate identifying
8651: information for the plot.
1.136 matthew 8652:
8653: =cut
8654:
8655: ############################################################
8656: ############################################################
1.137 matthew 8657: sub DrawXYYGraph {
8658: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8659: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8660: #
8661: # Create the identifier for the graph
8662: my $identifier = &get_cgi_id();
8663: my $id = 'cgi.'.$identifier;
8664: #
8665: $Title = '' if (! defined($Title));
8666: $xlabel = '' if (! defined($xlabel));
8667: $ylabel = '' if (! defined($ylabel));
8668: my %ValuesHash =
8669: (
1.369 www 8670: $id.'.title' => &escape($Title),
8671: $id.'.xlabel' => &escape($xlabel),
8672: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8673: $id.'.labels' => join(',',@$Xlabels),
8674: $id.'.PlotType' => 'XY',
8675: $id.'.NumSets' => 2,
1.137 matthew 8676: $id.'.two_axes' => 1,
8677: $id.'.y1_max_value' => $Max1,
8678: $id.'.y1_min_value' => $Min1,
8679: $id.'.y2_max_value' => $Max2,
8680: $id.'.y2_min_value' => $Min2,
1.136 matthew 8681: );
8682: #
1.137 matthew 8683: if (defined($colors) && ref($colors) eq 'ARRAY') {
8684: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8685: }
8686: #
8687: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8688: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8689: return '';
8690: }
8691: my $NumSets=1;
1.137 matthew 8692: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8693: next if (! ref($array));
8694: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8695: }
8696: #
8697: # Deal with other parameters
8698: while (my ($key,$value) = each(%Values)) {
8699: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8700: }
8701: #
1.646 raeburn 8702: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8703: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8704: }
8705:
8706: ############################################################
8707: ############################################################
8708:
8709: =pod
8710:
1.157 matthew 8711: =back
8712:
1.139 matthew 8713: =head1 Statistics helper routines?
8714:
8715: Bad place for them but what the hell.
8716:
1.157 matthew 8717: =over 4
8718:
1.648 raeburn 8719: =item * &chartlink()
1.139 matthew 8720:
8721: Returns a link to the chart for a specific student.
8722:
8723: Inputs:
8724:
8725: =over 4
8726:
8727: =item $linktext: The text of the link
8728:
8729: =item $sname: The students username
8730:
8731: =item $sdomain: The students domain
8732:
8733: =back
8734:
1.157 matthew 8735: =back
8736:
1.139 matthew 8737: =cut
8738:
8739: ############################################################
8740: ############################################################
8741: sub chartlink {
8742: my ($linktext, $sname, $sdomain) = @_;
8743: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8744: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8745: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8746: '">'.$linktext.'</a>';
1.153 matthew 8747: }
8748:
8749: #######################################################
8750: #######################################################
8751:
8752: =pod
8753:
8754: =head1 Course Environment Routines
1.157 matthew 8755:
8756: =over 4
1.153 matthew 8757:
1.648 raeburn 8758: =item * &restore_course_settings()
1.153 matthew 8759:
1.648 raeburn 8760: =item * &store_course_settings()
1.153 matthew 8761:
8762: Restores/Store indicated form parameters from the course environment.
8763: Will not overwrite existing values of the form parameters.
8764:
8765: Inputs:
8766: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8767:
8768: a hash ref describing the data to be stored. For example:
8769:
8770: %Save_Parameters = ('Status' => 'scalar',
8771: 'chartoutputmode' => 'scalar',
8772: 'chartoutputdata' => 'scalar',
8773: 'Section' => 'array',
1.373 raeburn 8774: 'Group' => 'array',
1.153 matthew 8775: 'StudentData' => 'array',
8776: 'Maps' => 'array');
8777:
8778: Returns: both routines return nothing
8779:
1.631 raeburn 8780: =back
8781:
1.153 matthew 8782: =cut
8783:
8784: #######################################################
8785: #######################################################
8786: sub store_course_settings {
1.496 albertel 8787: return &store_settings($env{'request.course.id'},@_);
8788: }
8789:
8790: sub store_settings {
1.153 matthew 8791: # save to the environment
8792: # appenv the same items, just to be safe
1.300 albertel 8793: my $udom = $env{'user.domain'};
8794: my $uname = $env{'user.name'};
1.496 albertel 8795: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8796: my %SaveHash;
8797: my %AppHash;
8798: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8799: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8800: my $envname = 'environment.'.$basename;
1.258 albertel 8801: if (exists($env{'form.'.$setting})) {
1.153 matthew 8802: # Save this value away
8803: if ($type eq 'scalar' &&
1.258 albertel 8804: (! exists($env{$envname}) ||
8805: $env{$envname} ne $env{'form.'.$setting})) {
8806: $SaveHash{$basename} = $env{'form.'.$setting};
8807: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8808: } elsif ($type eq 'array') {
8809: my $stored_form;
1.258 albertel 8810: if (ref($env{'form.'.$setting})) {
1.153 matthew 8811: $stored_form = join(',',
8812: map {
1.369 www 8813: &escape($_);
1.258 albertel 8814: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8815: } else {
8816: $stored_form =
1.369 www 8817: &escape($env{'form.'.$setting});
1.153 matthew 8818: }
8819: # Determine if the array contents are the same.
1.258 albertel 8820: if ($stored_form ne $env{$envname}) {
1.153 matthew 8821: $SaveHash{$basename} = $stored_form;
8822: $AppHash{$envname} = $stored_form;
8823: }
8824: }
8825: }
8826: }
8827: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8828: $udom,$uname);
1.153 matthew 8829: if ($put_result !~ /^(ok|delayed)/) {
8830: &Apache::lonnet::logthis('unable to save form parameters, '.
8831: 'got error:'.$put_result);
8832: }
8833: # Make sure these settings stick around in this session, too
1.646 raeburn 8834: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8835: return;
8836: }
8837:
8838: sub restore_course_settings {
1.499 albertel 8839: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8840: }
8841:
8842: sub restore_settings {
8843: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8844: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8845: next if (exists($env{'form.'.$setting}));
1.496 albertel 8846: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8847: '.'.$setting;
1.258 albertel 8848: if (exists($env{$envname})) {
1.153 matthew 8849: if ($type eq 'scalar') {
1.258 albertel 8850: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8851: } elsif ($type eq 'array') {
1.258 albertel 8852: $env{'form.'.$setting} = [
1.153 matthew 8853: map {
1.369 www 8854: &unescape($_);
1.258 albertel 8855: } split(',',$env{$envname})
1.153 matthew 8856: ];
8857: }
8858: }
8859: }
1.127 matthew 8860: }
8861:
1.618 raeburn 8862: #######################################################
8863: #######################################################
8864:
8865: =pod
8866:
8867: =head1 Domain E-mail Routines
8868:
8869: =over 4
8870:
1.648 raeburn 8871: =item * &build_recipient_list()
1.618 raeburn 8872:
1.692.4.14 raeburn 8873: Build recipient lists for five types of e-mail:
1.692.4.2 raeburn 8874: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.692.4.14 raeburn 8875: (d) Help requests, (e) Course requests needing approval, generated by
8876: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
8877: loncoursequeueadmin.pm respectively.
1.618 raeburn 8878:
8879: Inputs:
1.619 raeburn 8880: defmail (scalar - email address of default recipient),
1.618 raeburn 8881: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8882: defdom (domain for which to retrieve configuration settings),
8883: origmail (scalar - email address of recipient from loncapa.conf,
8884: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8885:
1.655 raeburn 8886: Returns: comma separated list of addresses to which to send e-mail.
8887:
8888: =back
1.618 raeburn 8889:
8890: =cut
8891:
8892: ############################################################
8893: ############################################################
8894: sub build_recipient_list {
1.619 raeburn 8895: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8896: my @recipients;
8897: my $otheremails;
8898: my %domconfig =
8899: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8900: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.692.4.2 raeburn 8901: if (exists($domconfig{'contacts'}{$mailing})) {
8902: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8903: my @contacts = ('adminemail','supportemail');
8904: foreach my $item (@contacts) {
8905: if ($domconfig{'contacts'}{$mailing}{$item}) {
8906: my $addr = $domconfig{'contacts'}{$item};
8907: if (!grep(/^\Q$addr\E$/,@recipients)) {
8908: push(@recipients,$addr);
8909: }
1.619 raeburn 8910: }
1.692.4.2 raeburn 8911: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 8912: }
8913: }
1.692.4.2 raeburn 8914: } elsif ($origmail ne '') {
8915: push(@recipients,$origmail);
1.618 raeburn 8916: }
1.619 raeburn 8917: } elsif ($origmail ne '') {
8918: push(@recipients,$origmail);
1.618 raeburn 8919: }
1.688 raeburn 8920: if (defined($defmail)) {
8921: if ($defmail ne '') {
8922: push(@recipients,$defmail);
8923: }
1.618 raeburn 8924: }
8925: if ($otheremails) {
1.619 raeburn 8926: my @others;
8927: if ($otheremails =~ /,/) {
8928: @others = split(/,/,$otheremails);
1.618 raeburn 8929: } else {
1.619 raeburn 8930: push(@others,$otheremails);
8931: }
8932: foreach my $addr (@others) {
8933: if (!grep(/^\Q$addr\E$/,@recipients)) {
8934: push(@recipients,$addr);
8935: }
1.618 raeburn 8936: }
8937: }
1.619 raeburn 8938: my $recipientlist = join(',',@recipients);
1.618 raeburn 8939: return $recipientlist;
8940: }
8941:
1.127 matthew 8942: ############################################################
8943: ############################################################
1.154 albertel 8944:
1.655 raeburn 8945: =pod
8946:
8947: =head1 Course Catalog Routines
8948:
8949: =over 4
8950:
8951: =item * &gather_categories()
8952:
8953: Converts category definitions - keys of categories hash stored in
8954: coursecategories in configuration.db on the primary library server in a
8955: domain - to an array. Also generates javascript and idx hash used to
8956: generate Domain Coordinator interface for editing Course Categories.
8957:
8958: Inputs:
1.663 raeburn 8959:
1.655 raeburn 8960: categories (reference to hash of category definitions).
1.663 raeburn 8961:
1.655 raeburn 8962: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8963: categories and subcategories).
1.663 raeburn 8964:
1.655 raeburn 8965: idx (reference to hash of counters used in Domain Coordinator interface for
8966: editing Course Categories).
1.663 raeburn 8967:
1.655 raeburn 8968: jsarray (reference to array of categories used to create Javascript arrays for
8969: Domain Coordinator interface for editing Course Categories).
8970:
8971: Returns: nothing
8972:
8973: Side effects: populates cats, idx and jsarray.
8974:
8975: =cut
8976:
8977: sub gather_categories {
8978: my ($categories,$cats,$idx,$jsarray) = @_;
8979: my %counters;
8980: my $num = 0;
8981: foreach my $item (keys(%{$categories})) {
8982: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8983: if ($container eq '' && $depth == 0) {
8984: $cats->[$depth][$categories->{$item}] = $cat;
8985: } else {
8986: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8987: }
8988: my ($escitem,$tail) = split(/:/,$item,2);
8989: if ($counters{$tail} eq '') {
8990: $counters{$tail} = $num;
8991: $num ++;
8992: }
8993: if (ref($idx) eq 'HASH') {
8994: $idx->{$item} = $counters{$tail};
8995: }
8996: if (ref($jsarray) eq 'ARRAY') {
8997: push(@{$jsarray->[$counters{$tail}]},$item);
8998: }
8999: }
9000: return;
9001: }
9002:
9003: =pod
9004:
9005: =item * &extract_categories()
9006:
9007: Used to generate breadcrumb trails for course categories.
9008:
9009: Inputs:
1.663 raeburn 9010:
1.655 raeburn 9011: categories (reference to hash of category definitions).
1.663 raeburn 9012:
1.655 raeburn 9013: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9014: categories and subcategories).
1.663 raeburn 9015:
1.655 raeburn 9016: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9017:
1.655 raeburn 9018: allitems (reference to hash - key is category key
9019: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9020:
1.655 raeburn 9021: idx (reference to hash of counters used in Domain Coordinator interface for
9022: editing Course Categories).
1.663 raeburn 9023:
1.655 raeburn 9024: jsarray (reference to array of categories used to create Javascript arrays for
9025: Domain Coordinator interface for editing Course Categories).
9026:
1.665 raeburn 9027: subcats (reference to hash of arrays containing all subcategories within each
9028: category, -recursive)
9029:
1.655 raeburn 9030: Returns: nothing
9031:
9032: Side effects: populates trails and allitems hash references.
9033:
9034: =cut
9035:
9036: sub extract_categories {
1.665 raeburn 9037: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9038: if (ref($categories) eq 'HASH') {
9039: &gather_categories($categories,$cats,$idx,$jsarray);
9040: if (ref($cats->[0]) eq 'ARRAY') {
9041: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9042: my $name = $cats->[0][$i];
9043: my $item = &escape($name).'::0';
9044: my $trailstr;
9045: if ($name eq 'instcode') {
9046: $trailstr = &mt('Official courses (with institutional codes)');
1.692.4.24 raeburn 9047: } elsif ($name eq 'communities') {
9048: $trailstr = &mt('Communities');
1.655 raeburn 9049: } else {
9050: $trailstr = $name;
9051: }
9052: if ($allitems->{$item} eq '') {
9053: push(@{$trails},$trailstr);
9054: $allitems->{$item} = scalar(@{$trails})-1;
9055: }
9056: my @parents = ($name);
9057: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9058: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9059: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9060: if (ref($subcats) eq 'HASH') {
9061: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9062: }
9063: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9064: }
9065: } else {
9066: if (ref($subcats) eq 'HASH') {
9067: $subcats->{$item} = [];
1.655 raeburn 9068: }
9069: }
9070: }
9071: }
9072: }
9073: return;
9074: }
9075:
9076: =pod
9077:
9078: =item *&recurse_categories()
9079:
9080: Recursively used to generate breadcrumb trails for course categories.
9081:
9082: Inputs:
1.663 raeburn 9083:
1.655 raeburn 9084: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9085: categories and subcategories).
1.663 raeburn 9086:
1.655 raeburn 9087: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9088:
9089: category (current course category, for which breadcrumb trail is being generated).
9090:
9091: trails (reference to array of breadcrumb trails for each category).
9092:
1.655 raeburn 9093: allitems (reference to hash - key is category key
9094: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9095:
1.655 raeburn 9096: parents (array containing containers directories for current category,
9097: back to top level).
9098:
9099: Returns: nothing
9100:
9101: Side effects: populates trails and allitems hash references
9102:
9103: =cut
9104:
9105: sub recurse_categories {
1.665 raeburn 9106: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9107: my $shallower = $depth - 1;
9108: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9109: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9110: my $name = $cats->[$depth]{$category}[$k];
9111: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9112: my $trailstr = join(' -> ',(@{$parents},$category));
9113: if ($allitems->{$item} eq '') {
9114: push(@{$trails},$trailstr);
9115: $allitems->{$item} = scalar(@{$trails})-1;
9116: }
9117: my $deeper = $depth+1;
9118: push(@{$parents},$category);
1.665 raeburn 9119: if (ref($subcats) eq 'HASH') {
9120: my $subcat = &escape($name).':'.$category.':'.$depth;
9121: for (my $j=@{$parents}; $j>=0; $j--) {
9122: my $higher;
9123: if ($j > 0) {
9124: $higher = &escape($parents->[$j]).':'.
9125: &escape($parents->[$j-1]).':'.$j;
9126: } else {
9127: $higher = &escape($parents->[$j]).'::'.$j;
9128: }
9129: push(@{$subcats->{$higher}},$subcat);
9130: }
9131: }
9132: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9133: $subcats);
1.655 raeburn 9134: pop(@{$parents});
9135: }
9136: } else {
9137: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9138: my $trailstr = join(' -> ',(@{$parents},$category));
9139: if ($allitems->{$item} eq '') {
9140: push(@{$trails},$trailstr);
9141: $allitems->{$item} = scalar(@{$trails})-1;
9142: }
9143: }
9144: return;
9145: }
9146:
1.663 raeburn 9147: =pod
9148:
9149: =item *&assign_categories_table()
9150:
9151: Create a datatable for display of hierarchical categories in a domain,
9152: with checkboxes to allow a course to be categorized.
9153:
9154: Inputs:
9155:
9156: cathash - reference to hash of categories defined for the domain (from
9157: configuration.db)
9158:
1.692.4.24 raeburn 9159: currcat - scalar with an & separated list of categories assigned to a course.
9160:
9161: type - scalar contains course type (Course or Community).
1.663 raeburn 9162:
9163: Returns: $output (markup to be displayed)
9164:
9165: =cut
9166:
9167: sub assign_categories_table {
1.692.4.24 raeburn 9168: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9169: my $output;
9170: if (ref($cathash) eq 'HASH') {
9171: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9172: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9173: $maxdepth = scalar(@cats);
9174: if (@cats > 0) {
9175: my $itemcount = 0;
9176: if (ref($cats[0]) eq 'ARRAY') {
9177: my @currcategories;
9178: if ($currcat ne '') {
9179: @currcategories = split('&',$currcat);
9180: }
1.692.4.24 raeburn 9181: my $table;
1.663 raeburn 9182: for (my $i=0; $i<@{$cats[0]}; $i++) {
9183: my $parent = $cats[0][$i];
9184: next if ($parent eq 'instcode');
1.692.4.24 raeburn 9185: if ($type eq 'Community') {
9186: next unless ($parent eq 'communities');
9187: } else {
9188: next if ($parent eq 'communities');
9189: }
9190: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.663 raeburn 9191: my $item = &escape($parent).'::0';
9192: my $checked = '';
9193: if (@currcategories > 0) {
9194: if (grep(/^\Q$item\E$/,@currcategories)) {
9195: $checked = ' checked="checked" ';
9196: }
9197: }
1.692.4.24 raeburn 9198: my $parent_title = $parent;
9199: if ($parent eq 'communities') {
9200: $parent_title = &mt('Communities');
9201: }
9202: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9203: '<input type="checkbox" name="usecategory" value="'.
9204: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9205: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9206: my $depth = 1;
9207: push(@path,$parent);
1.692.4.24 raeburn 9208: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9209: pop(@path);
1.692.4.24 raeburn 9210: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9211: $itemcount ++;
9212: }
1.692.4.24 raeburn 9213: if ($itemcount) {
9214: $output = &Apache::loncommon::start_data_table().
9215: $table.
9216: &Apache::loncommon::end_data_table();
9217: }
1.663 raeburn 9218: }
9219: }
9220: }
9221: return $output;
9222: }
9223:
9224: =pod
9225:
9226: =item *&assign_category_rows()
9227:
9228: Create a datatable row for display of nested categories in a domain,
9229: with checkboxes to allow a course to be categorized,called recursively.
9230:
9231: Inputs:
9232:
9233: itemcount - track row number for alternating colors
9234:
9235: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9236: categories and subcategories.
9237:
9238: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9239:
9240: parent - parent of current category item
9241:
9242: path - Array containing all categories back up through the hierarchy from the
9243: current category to the top level.
9244:
9245: currcategories - reference to array of current categories assigned to the course
9246:
9247: Returns: $output (markup to be displayed).
9248:
9249: =cut
9250:
9251: sub assign_category_rows {
9252: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9253: my ($text,$name,$item,$chgstr);
9254: if (ref($cats) eq 'ARRAY') {
9255: my $maxdepth = scalar(@{$cats});
9256: if (ref($cats->[$depth]) eq 'HASH') {
9257: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9258: my $numchildren = @{$cats->[$depth]{$parent}};
9259: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9260: $text .= '<td><table class="LC_datatable">';
9261: for (my $j=0; $j<$numchildren; $j++) {
9262: $name = $cats->[$depth]{$parent}[$j];
9263: $item = &escape($name).':'.&escape($parent).':'.$depth;
9264: my $deeper = $depth+1;
9265: my $checked = '';
9266: if (ref($currcategories) eq 'ARRAY') {
9267: if (@{$currcategories} > 0) {
9268: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9269: $checked = ' checked="checked" ';
9270: }
9271: }
9272: }
1.664 raeburn 9273: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9274: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9275: $item.'"'.$checked.' />'.$name.'</label></span>'.
9276: '<input type="hidden" name="catname" value="'.$name.'" />'.
9277: '</td><td>';
1.663 raeburn 9278: if (ref($path) eq 'ARRAY') {
9279: push(@{$path},$name);
9280: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9281: pop(@{$path});
9282: }
9283: $text .= '</td></tr>';
9284: }
9285: $text .= '</table></td>';
9286: }
9287: }
9288: }
9289: return $text;
9290: }
9291:
1.655 raeburn 9292: ############################################################
9293: ############################################################
9294:
9295:
1.443 albertel 9296: sub commit_customrole {
1.664 raeburn 9297: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9298: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9299: ($start?', '.&mt('starting').' '.localtime($start):'').
9300: ($end?', ending '.localtime($end):'').': <b>'.
9301: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9302: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9303: '</b><br />';
9304: return $output;
9305: }
9306:
9307: sub commit_standardrole {
1.541 raeburn 9308: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9309: my ($output,$logmsg,$linefeed);
9310: if ($context eq 'auto') {
9311: $linefeed = "\n";
9312: } else {
9313: $linefeed = "<br />\n";
9314: }
1.443 albertel 9315: if ($three eq 'st') {
1.541 raeburn 9316: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9317: $one,$two,$sec,$context);
9318: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9319: ($result eq 'unknown_course') || ($result eq 'refused')) {
9320: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9321: } else {
1.541 raeburn 9322: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9323: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9324: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9325: if ($context eq 'auto') {
9326: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9327: } else {
9328: $output .= '<b>'.$result.'</b>'.$linefeed.
9329: &mt('Add to classlist').': <b>ok</b>';
9330: }
9331: $output .= $linefeed;
1.443 albertel 9332: }
9333: } else {
9334: $output = &mt('Assigning').' '.$three.' in '.$url.
9335: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9336: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9337: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9338: if ($context eq 'auto') {
9339: $output .= $result.$linefeed;
9340: } else {
9341: $output .= '<b>'.$result.'</b>'.$linefeed;
9342: }
1.443 albertel 9343: }
9344: return $output;
9345: }
9346:
9347: sub commit_studentrole {
1.541 raeburn 9348: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9349: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9350: if ($context eq 'auto') {
9351: $linefeed = "\n";
9352: } else {
9353: $linefeed = '<br />'."\n";
9354: }
1.443 albertel 9355: if (defined($one) && defined($two)) {
9356: my $cid=$one.'_'.$two;
9357: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9358: my $secchange = 0;
9359: my $expire_role_result;
9360: my $modify_section_result;
1.628 raeburn 9361: if ($oldsec ne '-1') {
9362: if ($oldsec ne $sec) {
1.443 albertel 9363: $secchange = 1;
1.628 raeburn 9364: my $now = time;
1.443 albertel 9365: my $uurl='/'.$cid;
9366: $uurl=~s/\_/\//g;
9367: if ($oldsec) {
9368: $uurl.='/'.$oldsec;
9369: }
1.626 raeburn 9370: $oldsecurl = $uurl;
1.628 raeburn 9371: $expire_role_result =
1.652 raeburn 9372: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9373: if ($env{'request.course.sec'} ne '') {
9374: if ($expire_role_result eq 'refused') {
9375: my @roles = ('st');
9376: my @statuses = ('previous');
9377: my @roledoms = ($one);
9378: my $withsec = 1;
9379: my %roleshash =
9380: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9381: \@statuses,\@roles,\@roledoms,$withsec);
9382: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9383: my ($oldstart,$oldend) =
9384: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9385: if ($oldend > 0 && $oldend <= $now) {
9386: $expire_role_result = 'ok';
9387: }
9388: }
9389: }
9390: }
1.443 albertel 9391: $result = $expire_role_result;
9392: }
9393: }
9394: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9395: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9396: if ($modify_section_result =~ /^ok/) {
9397: if ($secchange == 1) {
1.628 raeburn 9398: if ($sec eq '') {
9399: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9400: } else {
9401: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9402: }
1.443 albertel 9403: } elsif ($oldsec eq '-1') {
1.628 raeburn 9404: if ($sec eq '') {
9405: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9406: } else {
9407: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9408: }
1.443 albertel 9409: } else {
1.628 raeburn 9410: if ($sec eq '') {
9411: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9412: } else {
9413: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9414: }
1.443 albertel 9415: }
9416: } else {
1.628 raeburn 9417: if ($secchange) {
9418: $$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;
9419: } else {
9420: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9421: }
1.443 albertel 9422: }
9423: $result = $modify_section_result;
9424: } elsif ($secchange == 1) {
1.628 raeburn 9425: if ($oldsec eq '') {
9426: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9427: } else {
9428: $$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;
9429: }
1.626 raeburn 9430: if ($expire_role_result eq 'refused') {
9431: my $newsecurl = '/'.$cid;
9432: $newsecurl =~ s/\_/\//g;
9433: if ($sec ne '') {
9434: $newsecurl.='/'.$sec;
9435: }
9436: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9437: if ($sec eq '') {
9438: $$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;
9439: } else {
9440: $$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;
9441: }
9442: }
9443: }
1.443 albertel 9444: }
9445: } else {
1.626 raeburn 9446: $$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 9447: $result = "error: incomplete course id\n";
9448: }
9449: return $result;
9450: }
9451:
9452: ############################################################
9453: ############################################################
9454:
1.566 albertel 9455: sub check_clone {
1.578 raeburn 9456: my ($args,$linefeed) = @_;
1.566 albertel 9457: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9458: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9459: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9460: my $clonemsg;
9461: my $can_clone = 0;
1.692.4.30 raeburn 9462: my $lctype = lc($args->{'crstype'});
1.692.4.22 raeburn 9463: if ($lctype ne 'community') {
9464: $lctype = 'course';
9465: }
1.566 albertel 9466: if ($clonehome eq 'no_host') {
1.692.4.30 raeburn 9467: if ($args->{'crstype'} eq 'Community') {
1.692.4.22 raeburn 9468: $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'});
9469: } else {
9470: $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'});
9471: }
1.566 albertel 9472: } else {
9473: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.692.4.30 raeburn 9474: if ($args->{'crstype'} eq 'Community') {
1.692.4.22 raeburn 9475: if ($clonedesc{'type'} ne 'Community') {
9476: $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'});
9477: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9478: }
9479: }
9480: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.692.4.12 raeburn 9481: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.692.4.22 raeburn 9482: $can_clone = 1;
9483: } else {
9484: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9485: $args->{'clonedomain'},$args->{'clonecourse'});
9486: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9487: if (grep(/^\*$/,@cloners)) {
9488: $can_clone = 1;
9489: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9490: $can_clone = 1;
9491: } else {
1.692.4.22 raeburn 9492: my $ccrole = 'cc';
1.692.4.30 raeburn 9493: if ($args->{'crstype'} eq 'Community') {
1.692.4.22 raeburn 9494: $ccrole = 'co';
9495: }
9496: my %roleshash =
9497: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9498: $args->{'ccdomain'},
9499: 'userroles',['active'],[$ccrole],
9500: [$args->{'clonedomain'}]);
9501: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9502: $can_clone = 1;
1.692.4.29 raeburn 9503: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
9504: $can_clone = 1;
1.692.4.22 raeburn 9505: } else {
1.692.4.30 raeburn 9506: if ($args->{'crstype'} eq 'Community') {
1.692.4.22 raeburn 9507: $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'});
9508: } else {
9509: $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'});
9510: }
9511: }
9512: }
1.578 raeburn 9513: }
1.566 albertel 9514: }
9515: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9516: }
9517:
1.444 albertel 9518: sub construct_course {
1.692.4.14 raeburn 9519: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 9520: my $outcome;
1.541 raeburn 9521: my $linefeed = '<br />'."\n";
9522: if ($context eq 'auto') {
9523: $linefeed = "\n";
9524: }
1.566 albertel 9525:
9526: #
9527: # Are we cloning?
9528: #
9529: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9530: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9531: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9532: if ($context ne 'auto') {
1.578 raeburn 9533: if ($clonemsg ne '') {
9534: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9535: }
1.566 albertel 9536: }
9537: $outcome .= $clonemsg.$linefeed;
9538:
9539: if (!$can_clone) {
9540: return (0,$outcome);
9541: }
9542: }
9543:
1.444 albertel 9544: #
9545: # Open course
9546: #
9547: my $crstype = lc($args->{'crstype'});
9548: my %cenv=();
9549: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9550: $args->{'cdescr'},
9551: $args->{'curl'},
9552: $args->{'course_home'},
9553: $args->{'nonstandard'},
9554: $args->{'crscode'},
9555: $args->{'ccuname'}.':'.
9556: $args->{'ccdomain'},
1.692.4.12 raeburn 9557: $args->{'crstype'},
1.692.4.14 raeburn 9558: $cnum,$context,$category);
1.692.4.12 raeburn 9559:
1.444 albertel 9560:
9561: # Note: The testing routines depend on this being output; see
9562: # Utils::Course. This needs to at least be output as a comment
9563: # if anyone ever decides to not show this, and Utils::Course::new
9564: # will need to be suitably modified.
1.541 raeburn 9565: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9566: #
9567: # Check if created correctly
9568: #
1.479 albertel 9569: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9570: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9571: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9572:
1.444 albertel 9573: #
1.566 albertel 9574: # Do the cloning
9575: #
9576: if ($can_clone && $cloneid) {
9577: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9578: if ($context ne 'auto') {
9579: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9580: }
9581: $outcome .= $clonemsg.$linefeed;
9582: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9583: # Copy all files
1.637 www 9584: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9585: # Restore URL
1.566 albertel 9586: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9587: # Restore title
1.566 albertel 9588: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9589: # Mark as cloned
1.566 albertel 9590: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9591: # Need to clone grading mode
9592: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9593: $cenv{'grading'}=$newenv{'grading'};
9594: # Do not clone these environment entries
9595: &Apache::lonnet::del('environment',
9596: ['default_enrollment_start_date',
9597: 'default_enrollment_end_date',
9598: 'question.email',
9599: 'policy.email',
9600: 'comment.email',
9601: 'pch.users.denied',
1.692.4.2 raeburn 9602: 'plc.users.denied',
9603: 'hidefromcat',
9604: 'categories'],
1.638 www 9605: $$crsudom,$$crsunum);
1.444 albertel 9606: }
1.566 albertel 9607:
1.444 albertel 9608: #
9609: # Set environment (will override cloned, if existing)
9610: #
9611: my @sections = ();
9612: my @xlists = ();
9613: if ($args->{'crstype'}) {
9614: $cenv{'type'}=$args->{'crstype'};
9615: }
9616: if ($args->{'crsid'}) {
9617: $cenv{'courseid'}=$args->{'crsid'};
9618: }
9619: if ($args->{'crscode'}) {
9620: $cenv{'internal.coursecode'}=$args->{'crscode'};
9621: }
9622: if ($args->{'crsquota'} ne '') {
9623: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9624: } else {
9625: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9626: }
9627: if ($args->{'ccuname'}) {
9628: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9629: ':'.$args->{'ccdomain'};
9630: } else {
9631: $cenv{'internal.courseowner'} = $args->{'curruser'};
9632: }
9633: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9634: if ($args->{'crssections'}) {
9635: $cenv{'internal.sectionnums'} = '';
9636: if ($args->{'crssections'} =~ m/,/) {
9637: @sections = split/,/,$args->{'crssections'};
9638: } else {
9639: $sections[0] = $args->{'crssections'};
9640: }
9641: if (@sections > 0) {
9642: foreach my $item (@sections) {
9643: my ($sec,$gp) = split/:/,$item;
9644: my $class = $args->{'crscode'}.$sec;
9645: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9646: $cenv{'internal.sectionnums'} .= $item.',';
9647: unless ($addcheck eq 'ok') {
9648: push @badclasses, $class;
9649: }
9650: }
9651: $cenv{'internal.sectionnums'} =~ s/,$//;
9652: }
9653: }
9654: # do not hide course coordinator from staff listing,
9655: # even if privileged
9656: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9657: # add crosslistings
9658: if ($args->{'crsxlist'}) {
9659: $cenv{'internal.crosslistings'}='';
9660: if ($args->{'crsxlist'} =~ m/,/) {
9661: @xlists = split/,/,$args->{'crsxlist'};
9662: } else {
9663: $xlists[0] = $args->{'crsxlist'};
9664: }
9665: if (@xlists > 0) {
9666: foreach my $item (@xlists) {
9667: my ($xl,$gp) = split/:/,$item;
9668: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9669: $cenv{'internal.crosslistings'} .= $item.',';
9670: unless ($addcheck eq 'ok') {
9671: push @badclasses, $xl;
9672: }
9673: }
9674: $cenv{'internal.crosslistings'} =~ s/,$//;
9675: }
9676: }
9677: if ($args->{'autoadds'}) {
9678: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9679: }
9680: if ($args->{'autodrops'}) {
9681: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9682: }
9683: # check for notification of enrollment changes
9684: my @notified = ();
9685: if ($args->{'notify_owner'}) {
9686: if ($args->{'ccuname'} ne '') {
9687: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9688: }
9689: }
9690: if ($args->{'notify_dc'}) {
9691: if ($uname ne '') {
1.630 raeburn 9692: push(@notified,$uname.':'.$udom);
1.444 albertel 9693: }
9694: }
9695: if (@notified > 0) {
9696: my $notifylist;
9697: if (@notified > 1) {
9698: $notifylist = join(',',@notified);
9699: } else {
9700: $notifylist = $notified[0];
9701: }
9702: $cenv{'internal.notifylist'} = $notifylist;
9703: }
9704: if (@badclasses > 0) {
9705: my %lt=&Apache::lonlocal::texthash(
9706: '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',
9707: 'dnhr' => 'does not have rights to access enrollment in these classes',
9708: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9709: );
1.541 raeburn 9710: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9711: ' ('.$lt{'adby'}.')';
9712: if ($context eq 'auto') {
9713: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9714: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9715: foreach my $item (@badclasses) {
9716: if ($context eq 'auto') {
9717: $outcome .= " - $item\n";
9718: } else {
9719: $outcome .= "<li>$item</li>\n";
9720: }
9721: }
9722: if ($context eq 'auto') {
9723: $outcome .= $linefeed;
9724: } else {
1.566 albertel 9725: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9726: }
9727: }
1.444 albertel 9728: }
9729: if ($args->{'no_end_date'}) {
9730: $args->{'endaccess'} = 0;
9731: }
9732: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9733: $cenv{'internal.autoend'}=$args->{'enrollend'};
9734: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9735: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9736: if ($args->{'showphotos'}) {
9737: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9738: }
9739: $cenv{'internal.authtype'} = $args->{'authtype'};
9740: $cenv{'internal.autharg'} = $args->{'autharg'};
9741: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9742: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9743: 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');
9744: if ($context eq 'auto') {
9745: $outcome .= $krb_msg;
9746: } else {
1.566 albertel 9747: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9748: }
9749: $outcome .= $linefeed;
1.444 albertel 9750: }
9751: }
9752: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9753: if ($args->{'setpolicy'}) {
9754: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9755: }
9756: if ($args->{'setcontent'}) {
9757: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9758: }
9759: }
9760: if ($args->{'reshome'}) {
9761: $cenv{'reshome'}=$args->{'reshome'}.'/';
9762: $cenv{'reshome'}=~s/\/+$/\//;
9763: }
9764: #
9765: # course has keyed access
9766: #
9767: if ($args->{'setkeys'}) {
9768: $cenv{'keyaccess'}='yes';
9769: }
9770: # if specified, key authority is not course, but user
9771: # only active if keyaccess is yes
9772: if ($args->{'keyauth'}) {
1.487 albertel 9773: my ($user,$domain) = split(':',$args->{'keyauth'});
9774: $user = &LONCAPA::clean_username($user);
9775: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9776: if ($user ne '' && $domain ne '') {
1.487 albertel 9777: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9778: }
9779: }
9780:
9781: if ($args->{'disresdis'}) {
9782: $cenv{'pch.roles.denied'}='st';
9783: }
9784: if ($args->{'disablechat'}) {
9785: $cenv{'plc.roles.denied'}='st';
9786: }
9787:
9788: # Record we've not yet viewed the Course Initialization Helper for this
9789: # course
9790: $cenv{'course.helper.not.run'} = 1;
9791: #
9792: # Use new Randomseed
9793: #
9794: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9795: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9796: #
9797: # The encryption code and receipt prefix for this course
9798: #
9799: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9800: $cenv{'internal.encpref'}=100+int(9*rand(99));
9801: #
9802: # By default, use standard grading
9803: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9804:
1.541 raeburn 9805: $outcome .= $linefeed.&mt('Setting environment').': '.
9806: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9807: #
9808: # Open all assignments
9809: #
9810: if ($args->{'openall'}) {
9811: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9812: my %storecontent = ($storeunder => time,
9813: $storeunder.'.type' => 'date_start');
9814:
9815: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9816: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9817: }
9818: #
9819: # Set first page
9820: #
9821: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9822: || ($cloneid)) {
1.445 albertel 9823: use LONCAPA::map;
1.444 albertel 9824: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9825:
9826: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9827: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9828:
1.444 albertel 9829: $outcome .= ($fatal?$errtext:'read ok').' - ';
9830: my $title; my $url;
9831: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9832: $title=&mt('Syllabus');
1.444 albertel 9833: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9834: } else {
1.690 bisitz 9835: $title=&mt('Navigate Contents');
1.444 albertel 9836: $url='/adm/navmaps';
9837: }
1.445 albertel 9838:
9839: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9840: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9841:
9842: if ($errtext) { $fatal=2; }
1.541 raeburn 9843: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9844: }
1.566 albertel 9845:
9846: return (1,$outcome);
1.444 albertel 9847: }
9848:
9849: ############################################################
9850: ############################################################
9851:
1.378 raeburn 9852: sub course_type {
9853: my ($cid) = @_;
9854: if (!defined($cid)) {
9855: $cid = $env{'request.course.id'};
9856: }
1.404 albertel 9857: if (defined($env{'course.'.$cid.'.type'})) {
9858: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9859: } else {
9860: return 'Course';
1.377 raeburn 9861: }
9862: }
1.156 albertel 9863:
1.406 raeburn 9864: sub group_term {
9865: my $crstype = &course_type();
9866: my %names = (
1.692.4.6 raeburn 9867: 'Course' => 'group',
9868: 'Community' => 'group',
1.406 raeburn 9869: );
9870: return $names{$crstype};
9871: }
9872:
1.692.4.20 raeburn 9873: sub course_types {
9874: my @types = ('official','unofficial','community');
9875: my %typename = (
9876: official => 'Official course',
9877: unofficial => 'Unofficial course',
9878: community => 'Community',
9879: );
9880: return (\@types,\%typename);
9881: }
9882:
1.156 albertel 9883: sub icon {
9884: my ($file)=@_;
1.505 albertel 9885: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9886: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9887: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9888: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9889: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9890: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9891: $curfext.".gif") {
9892: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9893: $curfext.".gif";
9894: }
9895: }
1.249 albertel 9896: return &lonhttpdurl($iconname);
1.154 albertel 9897: }
1.84 albertel 9898:
1.575 albertel 9899: sub lonhttpdurl {
1.692 www 9900: #
9901: # Had been used for "small fry" static images on separate port 8080.
9902: # Modify here if lightweight http functionality desired again.
9903: # Currently eliminated due to increasing firewall issues.
9904: #
1.575 albertel 9905: my ($url)=@_;
1.692 www 9906: return $url;
1.215 albertel 9907: }
9908:
1.213 albertel 9909: sub connection_aborted {
9910: my ($r)=@_;
9911: $r->print(" ");$r->rflush();
9912: my $c = $r->connection;
9913: return $c->aborted();
9914: }
9915:
1.221 foxr 9916: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9917: # strings as 'strings'.
9918: sub escape_single {
1.221 foxr 9919: my ($input) = @_;
1.223 albertel 9920: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9921: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9922: return $input;
9923: }
1.223 albertel 9924:
1.222 foxr 9925: # Same as escape_single, but escape's "'s This
9926: # can be used for "strings"
9927: sub escape_double {
9928: my ($input) = @_;
9929: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9930: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9931: return $input;
9932: }
1.223 albertel 9933:
1.222 foxr 9934: # Escapes the last element of a full URL.
9935: sub escape_url {
9936: my ($url) = @_;
1.238 raeburn 9937: my @urlslices = split(/\//, $url,-1);
1.369 www 9938: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9939: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9940: }
1.462 albertel 9941:
1.692.4.2 raeburn 9942: sub compare_arrays {
9943: my ($arrayref1,$arrayref2) = @_;
9944: my (@difference,%count);
9945: @difference = ();
9946: %count = ();
9947: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
9948: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
9949: foreach my $element (keys(%count)) {
9950: if ($count{$element} == 1) {
9951: push(@difference,$element);
9952: }
9953: }
9954: }
9955: return @difference;
9956: }
9957:
1.462 albertel 9958: # -------------------------------------------------------- Initliaze user login
9959: sub init_user_environment {
1.463 albertel 9960: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9961: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9962:
9963: my $public=($username eq 'public' && $domain eq 'public');
9964:
9965: # See if old ID present, if so, remove
9966:
9967: my ($filename,$cookie,$userroles);
9968: my $now=time;
9969:
9970: if ($public) {
9971: my $max_public=100;
9972: my $oldest;
9973: my $oldest_time=0;
9974: for(my $next=1;$next<=$max_public;$next++) {
9975: if (-e $lonids."/publicuser_$next.id") {
9976: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9977: if ($mtime<$oldest_time || !$oldest_time) {
9978: $oldest_time=$mtime;
9979: $oldest=$next;
9980: }
9981: } else {
9982: $cookie="publicuser_$next";
9983: last;
9984: }
9985: }
9986: if (!$cookie) { $cookie="publicuser_$oldest"; }
9987: } else {
1.463 albertel 9988: # if this isn't a robot, kill any existing non-robot sessions
9989: if (!$args->{'robot'}) {
9990: opendir(DIR,$lonids);
9991: while ($filename=readdir(DIR)) {
9992: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9993: unlink($lonids.'/'.$filename);
9994: }
1.462 albertel 9995: }
1.463 albertel 9996: closedir(DIR);
1.462 albertel 9997: }
9998: # Give them a new cookie
1.463 albertel 9999: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10000: : $now.$$.int(rand(10000)));
1.463 albertel 10001: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10002:
10003: # Initialize roles
10004:
10005: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10006: }
10007: # ------------------------------------ Check browser type and MathML capability
10008:
10009: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10010: $clientunicode,$clientos) = &decode_user_agent($r);
10011:
10012: # -------------------------------------- Any accessibility options to remember?
10013: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
10014: foreach my $option ('imagesuppress','appletsuppress',
10015: 'embedsuppress','fontenhance','blackwhite') {
10016: if ($form->{$option} eq 'true') {
10017: &Apache::lonnet::put('environment',{$option => 'on'},
10018: $domain,$username);
10019: } else {
10020: &Apache::lonnet::del('environment',[$option],
10021: $domain,$username);
10022: }
10023: }
10024: }
10025: # ------------------------------------------------------------- Get environment
10026:
10027: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10028: my ($tmp) = keys(%userenv);
10029: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10030: # default remote control to off
10031: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10032: } else {
10033: undef(%userenv);
10034: }
10035: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10036: $form->{'interface'}=$userenv{'interface'};
10037: }
10038: $env{'environment.remote'}=$userenv{'remote'};
10039: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10040:
10041: # --------------- Do not trust query string to be put directly into environment
10042: foreach my $option ('imagesuppress','appletsuppress',
10043: 'embedsuppress','fontenhance','blackwhite',
10044: 'interface','localpath','localres') {
10045: $form->{$option}=~s/[\n\r\=]//gs;
10046: }
10047: # --------------------------------------------------------- Write first profile
10048:
10049: {
10050: my %initial_env =
10051: ("user.name" => $username,
10052: "user.domain" => $domain,
10053: "user.home" => $authhost,
10054: "browser.type" => $clientbrowser,
10055: "browser.version" => $clientversion,
10056: "browser.mathml" => $clientmathml,
10057: "browser.unicode" => $clientunicode,
10058: "browser.os" => $clientos,
10059: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10060: "request.course.fn" => '',
10061: "request.course.uri" => '',
10062: "request.course.sec" => '',
10063: "request.role" => 'cm',
10064: "request.role.adv" => $env{'user.adv'},
10065: "request.host" => $ENV{'REMOTE_ADDR'},);
10066:
10067: if ($form->{'localpath'}) {
10068: $initial_env{"browser.localpath"} = $form->{'localpath'};
10069: $initial_env{"browser.localres"} = $form->{'localres'};
10070: }
10071:
10072: if ($public) {
10073: $initial_env{"environment.remote"} = "off";
10074: }
10075: if ($form->{'interface'}) {
10076: $form->{'interface'}=~s/\W//gs;
10077: $initial_env{"browser.interface"} = $form->{'interface'};
10078: $env{'browser.interface'}=$form->{'interface'};
10079: foreach my $option ('imagesuppress','appletsuppress',
10080: 'embedsuppress','fontenhance','blackwhite') {
10081: if (($form->{$option} eq 'true') ||
10082: ($userenv{$option} eq 'on')) {
10083: $initial_env{"browser.$option"} = "on";
10084: }
10085: }
10086: }
10087:
1.692.4.2 raeburn 10088: foreach my $tool ('aboutme','blog','portfolio') {
10089: $userenv{'availabletools.'.$tool} =
10090: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10091: }
10092:
1.692.4.6 raeburn 10093: foreach my $crstype ('official','unofficial','community') {
1.692.4.2 raeburn 10094: $userenv{'canrequest.'.$crstype} =
10095: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10096: 'reload','requestcourses');
10097: }
10098:
1.462 albertel 10099: $env{'user.environment'} = "$lonids/$cookie.id";
10100:
10101: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10102: &GDBM_WRCREAT(),0640)) {
10103: &_add_to_env(\%disk_env,\%initial_env);
10104: &_add_to_env(\%disk_env,\%userenv,'environment.');
10105: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10106: if (ref($args->{'extra_env'})) {
10107: &_add_to_env(\%disk_env,$args->{'extra_env'});
10108: }
1.462 albertel 10109: untie(%disk_env);
10110: } else {
10111: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
10112: 'Could not create environment storage in lonauth: '.$!.'</font>');
10113: return 'error: '.$!;
10114: }
10115: }
10116: $env{'request.role'}='cm';
10117: $env{'request.role.adv'}=$env{'user.adv'};
10118: $env{'browser.type'}=$clientbrowser;
10119:
10120: return $cookie;
10121:
10122: }
10123:
10124: sub _add_to_env {
10125: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10126: if (ref($env_data) eq 'HASH') {
10127: while (my ($key,$value) = each(%$env_data)) {
10128: $idf->{$prefix.$key} = $value;
10129: $env{$prefix.$key} = $value;
10130: }
1.462 albertel 10131: }
10132: }
10133:
1.685 tempelho 10134: # --- Get the symbolic name of a problem and the url
10135: sub get_symb {
10136: my ($request,$silent) = @_;
1.692.4.2 raeburn 10137: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10138: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10139: if ($symb eq '') {
10140: if (!$silent) {
10141: $request->print("Unable to handle ambiguous references:$url:.");
10142: return ();
10143: }
10144: }
10145: &Apache::lonenc::check_decrypt(\$symb);
10146: return ($symb);
10147: }
10148:
10149: # --------------------------------------------------------------Get annotation
10150:
10151: sub get_annotation {
10152: my ($symb,$enc) = @_;
10153:
10154: my $key = $symb;
10155: if (!$enc) {
10156: $key =
10157: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10158: }
10159: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10160: return $annotation{$key};
10161: }
10162:
10163: sub clean_symb {
1.692.4.2 raeburn 10164: my ($symb,$delete_enc) = @_;
1.685 tempelho 10165:
10166: &Apache::lonenc::check_decrypt(\$symb);
10167: my $enc = $env{'request.enc'};
1.692.4.2 raeburn 10168: if ($delete_enc) {
10169: delete($env{'request.enc'});
10170: }
1.685 tempelho 10171:
10172: return ($symb,$enc);
10173: }
1.462 albertel 10174:
1.41 ng 10175: =pod
10176:
10177: =back
10178:
1.112 bowersj2 10179: =cut
1.41 ng 10180:
1.112 bowersj2 10181: 1;
10182: __END__;
1.41 ng 10183:
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