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