Annotation of loncom/interface/loncommon.pm, revision 1.925.2.2
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.925.2.2! raeburn 4: # $Id: loncommon.pm,v 1.925.2.1 2009/12/07 17:11: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.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
486: my $wintitle = &mt('Course Browser');
487: if ($crstype ne '') {
488: $wintitle = &mt($crstype);
489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 1130: .' title="'.$title.'"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.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.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: 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.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1722: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1723: "This error has been logged. ".
1724: "Please alert your LON-CAPA administrator").
1725: '</p>');
1726: return (undef);
1727: }
1728: #
1729: $workbook->set_tempdir('/home/httpd/perl/tmp');
1730: #
1731: my $format = &Apache::loncommon::define_excel_formats($workbook);
1732: return ($workbook,$filename,$format);
1733: }
1734:
1735: ###############################################################
1736: ###############################################################
1737:
1738: =pod
1739:
1.648 raeburn 1740: =item * &create_text_file()
1.113 bowersj2 1741:
1.542 raeburn 1742: Create a file to write to and eventually make available to the user.
1.256 matthew 1743: If file creation fails, outputs an error message on the request object and
1744: return undefs.
1.113 bowersj2 1745:
1.256 matthew 1746: Inputs: Apache request object, and file suffix
1.113 bowersj2 1747:
1.256 matthew 1748: Returns (undef) on failure,
1749: Filehandle and filename on success.
1.113 bowersj2 1750:
1751: =cut
1752:
1.256 matthew 1753: ###############################################################
1754: ###############################################################
1755: sub create_text_file {
1756: my ($r,$suffix) = @_;
1757: if (! defined($suffix)) { $suffix = 'txt'; };
1758: my $fh;
1759: my $filename = '/prtspool/'.
1.258 albertel 1760: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1761: time.'_'.rand(1000000000).'.'.$suffix;
1762: $fh = Apache::File->new('>/home/httpd'.$filename);
1763: if (! defined($fh)) {
1764: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1765: $r->print(&mt('Problems occurred in creating the output file. '
1766: .'This error has been logged. '
1767: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1768: }
1.256 matthew 1769: return ($fh,$filename)
1.113 bowersj2 1770: }
1771:
1772:
1.256 matthew 1773: =pod
1.113 bowersj2 1774:
1775: =back
1776:
1777: =cut
1.37 matthew 1778:
1779: ###############################################################
1.33 matthew 1780: ## Home server <option> list generating code ##
1781: ###############################################################
1.35 matthew 1782:
1.169 www 1783: # ------------------------------------------
1784:
1785: sub domain_select {
1786: my ($name,$value,$multiple)=@_;
1787: my %domains=map {
1.514 albertel 1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1789: } &Apache::lonnet::all_domains();
1.169 www 1790: if ($multiple) {
1791: $domains{''}=&mt('Any domain');
1.550 albertel 1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1793: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1794: } else {
1.550 albertel 1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1796: return &select_form($name,$value,%domains);
1797: }
1798: }
1799:
1.282 albertel 1800: #-------------------------------------------
1801:
1802: =pod
1803:
1.519 raeburn 1804: =head1 Routines for form select boxes
1805:
1806: =over 4
1807:
1.648 raeburn 1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1809:
1810: Returns a string containing a <select> element int multiple mode
1811:
1812:
1813: Args:
1814: $name - name of the <select> element
1.506 raeburn 1815: $value - scalar or array ref of values that should already be selected
1.282 albertel 1816: $size - number of rows long the select element is
1.283 albertel 1817: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1818: (shown text should already have been &mt())
1.506 raeburn 1819: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1820:
1.282 albertel 1821: =cut
1822:
1823: #-------------------------------------------
1.169 www 1824: sub multiple_select_form {
1.284 albertel 1825: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1827: my $output='';
1.191 matthew 1828: if (! defined($size)) {
1829: $size = 4;
1.283 albertel 1830: if (scalar(keys(%$hash))<4) {
1831: $size = scalar(keys(%$hash));
1.191 matthew 1832: }
1833: }
1.734 bisitz 1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1835: my @order;
1.506 raeburn 1836: if (ref($order) eq 'ARRAY') {
1837: @order = @{$order};
1838: } else {
1839: @order = sort(keys(%$hash));
1.501 banghart 1840: }
1841: if (exists($$hash{'select_form_order'})) {
1842: @order = @{$$hash{'select_form_order'}};
1843: }
1844:
1.284 albertel 1845: foreach my $key (@order) {
1.356 albertel 1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1847: $output.='selected="selected" ' if ($selected{$key});
1848: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1849: }
1850: $output.="</select>\n";
1851: return $output;
1852: }
1853:
1.88 www 1854: #-------------------------------------------
1855:
1856: =pod
1857:
1.648 raeburn 1858: =item * &select_form($defdom,$name,%hash)
1.88 www 1859:
1860: Returns a string containing a <select name='$name' size='1'> form to
1861: allow a user to select options from a hash option_name => displayed text.
1862: See lonrights.pm for an example invocation and use.
1863:
1864: =cut
1865:
1866: #-------------------------------------------
1867: sub select_form {
1868: my ($def,$name,%hash) = @_;
1869: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1870: my @keys;
1871: if (exists($hash{'select_form_order'})) {
1872: @keys=@{$hash{'select_form_order'}};
1873: } else {
1874: @keys=sort(keys(%hash));
1875: }
1.356 albertel 1876: foreach my $key (@keys) {
1877: $selectform.=
1878: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1879: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1880: ">".$hash{$key}."</option>\n";
1.88 www 1881: }
1882: $selectform.="</select>";
1883: return $selectform;
1884: }
1885:
1.475 www 1886: # For display filters
1887:
1888: sub display_filter {
1889: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1890: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1891: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1892: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1893: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1894: '</label></span> <span class="LC_nobreak">'.
1.475 www 1895: &mt('Filter [_1]',
1.477 www 1896: &select_form($env{'form.displayfilter'},
1897: 'displayfilter',
1898: ('currentfolder' => 'Current folder/page',
1899: 'containing' => 'Containing phrase',
1900: 'none' => 'None'))).
1.714 bisitz 1901: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1902: }
1903:
1.167 www 1904: sub gradeleveldescription {
1905: my $gradelevel=shift;
1906: my %gradelevels=(0 => 'Not specified',
1907: 1 => 'Grade 1',
1908: 2 => 'Grade 2',
1909: 3 => 'Grade 3',
1910: 4 => 'Grade 4',
1911: 5 => 'Grade 5',
1912: 6 => 'Grade 6',
1913: 7 => 'Grade 7',
1914: 8 => 'Grade 8',
1915: 9 => 'Grade 9',
1916: 10 => 'Grade 10',
1917: 11 => 'Grade 11',
1918: 12 => 'Grade 12',
1919: 13 => 'Grade 13',
1920: 14 => '100 Level',
1921: 15 => '200 Level',
1922: 16 => '300 Level',
1923: 17 => '400 Level',
1924: 18 => 'Graduate Level');
1925: return &mt($gradelevels{$gradelevel});
1926: }
1927:
1.163 www 1928: sub select_level_form {
1929: my ($deflevel,$name)=@_;
1930: unless ($deflevel) { $deflevel=0; }
1.167 www 1931: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1932: for (my $i=0; $i<=18; $i++) {
1933: $selectform.="<option value=\"$i\" ".
1.253 albertel 1934: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1935: ">".&gradeleveldescription($i)."</option>\n";
1936: }
1937: $selectform.="</select>";
1938: return $selectform;
1.163 www 1939: }
1.167 www 1940:
1.35 matthew 1941: #-------------------------------------------
1942:
1.45 matthew 1943: =pod
1944:
1.910 raeburn 1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1946:
1947: Returns a string containing a <select name='$name' size='1'> form to
1948: allow a user to select the domain to preform an operation in.
1949: See loncreateuser.pm for an example invocation and use.
1950:
1.90 www 1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
1952: selected");
1953:
1.743 raeburn 1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1955:
1.910 raeburn 1956: 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.
1957:
1958: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1959:
1.35 matthew 1960: =cut
1961:
1962: #-------------------------------------------
1.34 matthew 1963: sub select_dom_form {
1.910 raeburn 1964: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1965: if ($onchange) {
1.874 raeburn 1966: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1967: }
1.910 raeburn 1968: my @domains;
1969: if (ref($incdoms) eq 'ARRAY') {
1970: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1971: } else {
1972: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1973: }
1.90 www 1974: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1975: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1976: foreach my $dom (@domains) {
1977: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1978: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1979: if ($showdomdesc) {
1980: if ($dom ne '') {
1981: my $domdesc = &Apache::lonnet::domain($dom,'description');
1982: if ($domdesc ne '') {
1983: $selectdomain .= ' ('.$domdesc.')';
1984: }
1985: }
1986: }
1987: $selectdomain .= "</option>\n";
1.34 matthew 1988: }
1989: $selectdomain.="</select>";
1990: return $selectdomain;
1991: }
1992:
1.35 matthew 1993: #-------------------------------------------
1994:
1.45 matthew 1995: =pod
1996:
1.648 raeburn 1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1998:
1.586 raeburn 1999: input: 4 arguments (two required, two optional) -
2000: $domain - domain of new user
2001: $name - name of form element
2002: $default - Value of 'default' causes a default item to be first
2003: option, and selected by default.
2004: $hide - Value of 'hide' causes hiding of the name of the server,
2005: if 1 server found, or default, if 0 found.
1.594 raeburn 2006: output: returns 2 items:
1.586 raeburn 2007: (a) form element which contains either:
2008: (i) <select name="$name">
2009: <option value="$hostid1">$hostid $servers{$hostid}</option>
2010: <option value="$hostid2">$hostid $servers{$hostid}</option>
2011: </select>
2012: form item if there are multiple library servers in $domain, or
2013: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2014: if there is only one library server in $domain.
2015:
2016: (b) number of library servers found.
2017:
2018: See loncreateuser.pm for example of use.
1.35 matthew 2019:
2020: =cut
2021:
2022: #-------------------------------------------
1.586 raeburn 2023: sub home_server_form_item {
2024: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2025: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2026: my $result;
2027: my $numlib = keys(%servers);
2028: if ($numlib > 1) {
2029: $result .= '<select name="'.$name.'" />'."\n";
2030: if ($default) {
1.804 bisitz 2031: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2032: '</option>'."\n";
2033: }
2034: foreach my $hostid (sort(keys(%servers))) {
2035: $result.= '<option value="'.$hostid.'">'.
2036: $hostid.' '.$servers{$hostid}."</option>\n";
2037: }
2038: $result .= '</select>'."\n";
2039: } elsif ($numlib == 1) {
2040: my $hostid;
2041: foreach my $item (keys(%servers)) {
2042: $hostid = $item;
2043: }
2044: $result .= '<input type="hidden" name="'.$name.'" value="'.
2045: $hostid.'" />';
2046: if (!$hide) {
2047: $result .= $hostid.' '.$servers{$hostid};
2048: }
2049: $result .= "\n";
2050: } elsif ($default) {
2051: $result .= '<input type="hidden" name="'.$name.
2052: '" value="default" />';
2053: if (!$hide) {
2054: $result .= &mt('default');
2055: }
2056: $result .= "\n";
1.33 matthew 2057: }
1.586 raeburn 2058: return ($result,$numlib);
1.33 matthew 2059: }
1.112 bowersj2 2060:
2061: =pod
2062:
1.534 albertel 2063: =back
2064:
1.112 bowersj2 2065: =cut
1.87 matthew 2066:
2067: ###############################################################
1.112 bowersj2 2068: ## Decoding User Agent ##
1.87 matthew 2069: ###############################################################
2070:
2071: =pod
2072:
1.112 bowersj2 2073: =head1 Decoding the User Agent
2074:
2075: =over 4
2076:
2077: =item * &decode_user_agent()
1.87 matthew 2078:
2079: Inputs: $r
2080:
2081: Outputs:
2082:
2083: =over 4
2084:
1.112 bowersj2 2085: =item * $httpbrowser
1.87 matthew 2086:
1.112 bowersj2 2087: =item * $clientbrowser
1.87 matthew 2088:
1.112 bowersj2 2089: =item * $clientversion
1.87 matthew 2090:
1.112 bowersj2 2091: =item * $clientmathml
1.87 matthew 2092:
1.112 bowersj2 2093: =item * $clientunicode
1.87 matthew 2094:
1.112 bowersj2 2095: =item * $clientos
1.87 matthew 2096:
2097: =back
2098:
1.157 matthew 2099: =back
2100:
1.87 matthew 2101: =cut
2102:
2103: ###############################################################
2104: ###############################################################
2105: sub decode_user_agent {
1.247 albertel 2106: my ($r)=@_;
1.87 matthew 2107: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2108: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2109: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2110: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2111: my $clientbrowser='unknown';
2112: my $clientversion='0';
2113: my $clientmathml='';
2114: my $clientunicode='0';
2115: for (my $i=0;$i<=$#browsertype;$i++) {
2116: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2117: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2118: $clientbrowser=$bname;
2119: $httpbrowser=~/$vreg/i;
2120: $clientversion=$1;
2121: $clientmathml=($clientversion>=$minv);
2122: $clientunicode=($clientversion>=$univ);
2123: }
2124: }
2125: my $clientos='unknown';
2126: if (($httpbrowser=~/linux/i) ||
2127: ($httpbrowser=~/unix/i) ||
2128: ($httpbrowser=~/ux/i) ||
2129: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2130: if (($httpbrowser=~/vax/i) ||
2131: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2132: if ($httpbrowser=~/next/i) { $clientos='next'; }
2133: if (($httpbrowser=~/mac/i) ||
2134: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2135: if ($httpbrowser=~/win/i) { $clientos='win'; }
2136: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2137: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2138: $clientunicode,$clientos,);
2139: }
2140:
1.32 matthew 2141: ###############################################################
2142: ## Authentication changing form generation subroutines ##
2143: ###############################################################
2144: ##
2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
2146: ## hash, and have reasonable default values.
2147: ##
2148: ## formname = the name given in the <form> tag.
1.35 matthew 2149: #-------------------------------------------
2150:
1.45 matthew 2151: =pod
2152:
1.112 bowersj2 2153: =head1 Authentication Routines
2154:
2155: =over 4
2156:
1.648 raeburn 2157: =item * &authform_xxxxxx()
1.35 matthew 2158:
2159: The authform_xxxxxx subroutines provide javascript and html forms which
2160: handle some of the conveniences required for authentication forms.
2161: This is not an optimal method, but it works.
2162:
2163: =over 4
2164:
1.112 bowersj2 2165: =item * authform_header
1.35 matthew 2166:
1.112 bowersj2 2167: =item * authform_authorwarning
1.35 matthew 2168:
1.112 bowersj2 2169: =item * authform_nochange
1.35 matthew 2170:
1.112 bowersj2 2171: =item * authform_kerberos
1.35 matthew 2172:
1.112 bowersj2 2173: =item * authform_internal
1.35 matthew 2174:
1.112 bowersj2 2175: =item * authform_filesystem
1.35 matthew 2176:
2177: =back
2178:
1.648 raeburn 2179: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2180:
1.35 matthew 2181: =cut
2182:
2183: #-------------------------------------------
1.32 matthew 2184: sub authform_header{
2185: my %in = (
2186: formname => 'cu',
1.80 albertel 2187: kerb_def_dom => '',
1.32 matthew 2188: @_,
2189: );
2190: $in{'formname'} = 'document.' . $in{'formname'};
2191: my $result='';
1.80 albertel 2192:
2193: #---------------------------------------------- Code for upper case translation
2194: my $Javascript_toUpperCase;
2195: unless ($in{kerb_def_dom}) {
2196: $Javascript_toUpperCase =<<"END";
2197: switch (choice) {
2198: case 'krb': currentform.elements[choicearg].value =
2199: currentform.elements[choicearg].value.toUpperCase();
2200: break;
2201: default:
2202: }
2203: END
2204: } else {
2205: $Javascript_toUpperCase = "";
2206: }
2207:
1.165 raeburn 2208: my $radioval = "'nochange'";
1.591 raeburn 2209: if (defined($in{'curr_authtype'})) {
2210: if ($in{'curr_authtype'} ne '') {
2211: $radioval = "'".$in{'curr_authtype'}."arg'";
2212: }
1.174 matthew 2213: }
1.165 raeburn 2214: my $argfield = 'null';
1.591 raeburn 2215: if (defined($in{'mode'})) {
1.165 raeburn 2216: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2217: if (defined($in{'curr_autharg'})) {
2218: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2219: $argfield = "'$in{'curr_autharg'}'";
2220: }
2221: }
2222: }
2223: }
2224:
1.32 matthew 2225: $result.=<<"END";
2226: var current = new Object();
1.165 raeburn 2227: current.radiovalue = $radioval;
2228: current.argfield = $argfield;
1.32 matthew 2229:
2230: function changed_radio(choice,currentform) {
2231: var choicearg = choice + 'arg';
2232: // If a radio button in changed, we need to change the argfield
2233: if (current.radiovalue != choice) {
2234: current.radiovalue = choice;
2235: if (current.argfield != null) {
2236: currentform.elements[current.argfield].value = '';
2237: }
2238: if (choice == 'nochange') {
2239: current.argfield = null;
2240: } else {
2241: current.argfield = choicearg;
2242: switch(choice) {
2243: case 'krb':
2244: currentform.elements[current.argfield].value =
2245: "$in{'kerb_def_dom'}";
2246: break;
2247: default:
2248: break;
2249: }
2250: }
2251: }
2252: return;
2253: }
1.22 www 2254:
1.32 matthew 2255: function changed_text(choice,currentform) {
2256: var choicearg = choice + 'arg';
2257: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2258: $Javascript_toUpperCase
1.32 matthew 2259: // clear old field
2260: if ((current.argfield != choicearg) && (current.argfield != null)) {
2261: currentform.elements[current.argfield].value = '';
2262: }
2263: current.argfield = choicearg;
2264: }
2265: set_auth_radio_buttons(choice,currentform);
2266: return;
1.20 www 2267: }
1.32 matthew 2268:
2269: function set_auth_radio_buttons(newvalue,currentform) {
2270: var i=0;
2271: while (i < currentform.login.length) {
2272: if (currentform.login[i].value == newvalue) { break; }
2273: i++;
2274: }
2275: if (i == currentform.login.length) {
2276: return;
2277: }
2278: current.radiovalue = newvalue;
2279: currentform.login[i].checked = true;
2280: return;
2281: }
2282: END
2283: return $result;
2284: }
2285:
2286: sub authform_authorwarning{
2287: my $result='';
1.144 matthew 2288: $result='<i>'.
2289: &mt('As a general rule, only authors or co-authors should be '.
2290: 'filesystem authenticated '.
2291: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2292: return $result;
2293: }
2294:
2295: sub authform_nochange{
2296: my %in = (
2297: formname => 'document.cu',
2298: kerb_def_dom => 'MSU.EDU',
2299: @_,
2300: );
1.586 raeburn 2301: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2302: my $result;
2303: if (keys(%can_assign) == 0) {
2304: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2305: } else {
2306: $result = '<label>'.&mt('[_1] Do not change login data',
2307: '<input type="radio" name="login" value="nochange" '.
2308: 'checked="checked" onclick="'.
1.281 albertel 2309: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2310: '</label>';
1.586 raeburn 2311: }
1.32 matthew 2312: return $result;
2313: }
2314:
1.591 raeburn 2315: sub authform_kerberos {
1.32 matthew 2316: my %in = (
2317: formname => 'document.cu',
2318: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2319: kerb_def_auth => 'krb4',
1.32 matthew 2320: @_,
2321: );
1.586 raeburn 2322: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2323: $autharg,$jscall);
2324: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2325: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2326: $check5 = ' checked="checked"';
1.80 albertel 2327: } else {
1.772 bisitz 2328: $check4 = ' checked="checked"';
1.80 albertel 2329: }
1.165 raeburn 2330: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2331: if (defined($in{'curr_authtype'})) {
2332: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2333: $krbcheck = ' checked="checked"';
1.623 raeburn 2334: if (defined($in{'mode'})) {
2335: if ($in{'mode'} eq 'modifyuser') {
2336: $krbcheck = '';
2337: }
2338: }
1.591 raeburn 2339: if (defined($in{'curr_kerb_ver'})) {
2340: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2341: $check5 = ' checked="checked"';
1.591 raeburn 2342: $check4 = '';
2343: } else {
1.772 bisitz 2344: $check4 = ' checked="checked"';
1.591 raeburn 2345: $check5 = '';
2346: }
1.586 raeburn 2347: }
1.591 raeburn 2348: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2349: $krbarg = $in{'curr_autharg'};
2350: }
1.586 raeburn 2351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2352: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2353: $result =
2354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2355: $in{'curr_autharg'},$krbver);
2356: } else {
2357: $result =
2358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2359: }
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
1.784 bisitz 2365: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2366: }
2367: }
1.586 raeburn 2368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2369: return;
1.587 raeburn 2370: } elsif ($authtype eq '') {
1.591 raeburn 2371: if (defined($in{'mode'})) {
1.587 raeburn 2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
1.784 bisitz 2374: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2375: }
2376: }
2377: }
1.586 raeburn 2378: }
2379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="krb" '.
2382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2383: $krbcheck.' />';
2384: }
2385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2387: $in{'curr_authtype'} eq 'krb5') ||
2388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2389: $in{'curr_authtype'} eq 'krb4')) {
2390: $result .= &mt
1.144 matthew 2391: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2392: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2393: '<label>'.$authtype,
1.281 albertel 2394: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2395: 'value="'.$krbarg.'" '.
1.144 matthew 2396: 'onchange="'.$jscall.'" />',
1.281 albertel 2397: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2399: '</label>');
1.586 raeburn 2400: } elsif ($can_assign{'krb4'}) {
2401: $result .= &mt
2402: ('[_1] Kerberos authenticated with domain [_2] '.
2403: '[_3] Version 4 [_4]',
2404: '<label>'.$authtype,
2405: '</label><input type="text" size="10" name="krbarg" '.
2406: 'value="'.$krbarg.'" '.
2407: 'onchange="'.$jscall.'" />',
2408: '<label><input type="hidden" name="krbver" value="4" />',
2409: '</label>');
2410: } elsif ($can_assign{'krb5'}) {
2411: $result .= &mt
2412: ('[_1] Kerberos authenticated with domain [_2] '.
2413: '[_3] Version 5 [_4]',
2414: '<label>'.$authtype,
2415: '</label><input type="text" size="10" name="krbarg" '.
2416: 'value="'.$krbarg.'" '.
2417: 'onchange="'.$jscall.'" />',
2418: '<label><input type="hidden" name="krbver" value="5" />',
2419: '</label>');
2420: }
1.32 matthew 2421: return $result;
2422: }
2423:
2424: sub authform_internal{
1.586 raeburn 2425: my %in = (
1.32 matthew 2426: formname => 'document.cu',
2427: kerb_def_dom => 'MSU.EDU',
2428: @_,
2429: );
1.586 raeburn 2430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2432: if (defined($in{'curr_authtype'})) {
2433: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2434: if ($can_assign{'int'}) {
1.772 bisitz 2435: $intcheck = 'checked="checked" ';
1.623 raeburn 2436: if (defined($in{'mode'})) {
2437: if ($in{'mode'} eq 'modifyuser') {
2438: $intcheck = '';
2439: }
2440: }
1.591 raeburn 2441: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2442: $intarg = $in{'curr_autharg'};
2443: }
2444: } else {
2445: $result = &mt('Currently internally authenticated.');
2446: return $result;
1.165 raeburn 2447: }
2448: }
1.586 raeburn 2449: } else {
2450: if ($authnum == 1) {
1.784 bisitz 2451: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2452: }
2453: }
2454: if (!$can_assign{'int'}) {
2455: return;
1.587 raeburn 2456: } elsif ($authtype eq '') {
1.591 raeburn 2457: if (defined($in{'mode'})) {
1.587 raeburn 2458: if ($in{'mode'} eq 'modifycourse') {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2461: }
2462: }
2463: }
1.165 raeburn 2464: }
1.586 raeburn 2465: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2466: if ($authtype eq '') {
2467: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2468: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2469: }
1.605 bisitz 2470: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2471: $intarg.'" onchange="'.$jscall.'" />';
2472: $result = &mt
1.144 matthew 2473: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2474: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2475: $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 2476: return $result;
2477: }
2478:
2479: sub authform_local{
2480: my %in = (
2481: formname => 'document.cu',
2482: kerb_def_dom => 'MSU.EDU',
2483: @_,
2484: );
1.586 raeburn 2485: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2486: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2487: if (defined($in{'curr_authtype'})) {
2488: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2489: if ($can_assign{'loc'}) {
1.772 bisitz 2490: $loccheck = 'checked="checked" ';
1.623 raeburn 2491: if (defined($in{'mode'})) {
2492: if ($in{'mode'} eq 'modifyuser') {
2493: $loccheck = '';
2494: }
2495: }
1.591 raeburn 2496: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2497: $locarg = $in{'curr_autharg'};
2498: }
2499: } else {
2500: $result = &mt('Currently using local (institutional) authentication.');
2501: return $result;
1.165 raeburn 2502: }
2503: }
1.586 raeburn 2504: } else {
2505: if ($authnum == 1) {
1.784 bisitz 2506: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2507: }
2508: }
2509: if (!$can_assign{'loc'}) {
2510: return;
1.587 raeburn 2511: } elsif ($authtype eq '') {
1.591 raeburn 2512: if (defined($in{'mode'})) {
1.587 raeburn 2513: if ($in{'mode'} eq 'modifycourse') {
2514: if ($authnum == 1) {
1.784 bisitz 2515: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2516: }
2517: }
2518: }
1.165 raeburn 2519: }
1.586 raeburn 2520: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2521: if ($authtype eq '') {
2522: $authtype = '<input type="radio" name="login" value="loc" '.
2523: $loccheck.' onchange="'.$jscall.'" onclick="'.
2524: $jscall.'" />';
2525: }
2526: $autharg = '<input type="text" size="10" name="locarg" value="'.
2527: $locarg.'" onchange="'.$jscall.'" />';
2528: $result = &mt('[_1] Local Authentication with argument [_2]',
2529: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2530: return $result;
2531: }
2532:
2533: sub authform_filesystem{
2534: my %in = (
2535: formname => 'document.cu',
2536: kerb_def_dom => 'MSU.EDU',
2537: @_,
2538: );
1.586 raeburn 2539: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2540: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2541: if (defined($in{'curr_authtype'})) {
2542: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2543: if ($can_assign{'fsys'}) {
1.772 bisitz 2544: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2545: if (defined($in{'mode'})) {
2546: if ($in{'mode'} eq 'modifyuser') {
2547: $fsyscheck = '';
2548: }
2549: }
1.586 raeburn 2550: } else {
2551: $result = &mt('Currently Filesystem Authenticated.');
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2558: }
2559: }
2560: if (!$can_assign{'fsys'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="fsys" '.
2574: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2575: $jscall.'" />';
2576: }
2577: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2578: ' onchange="'.$jscall.'" />';
2579: $result = &mt
1.144 matthew 2580: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2581: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2582: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2583: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2584: 'onchange="'.$jscall.'" />');
1.32 matthew 2585: return $result;
2586: }
2587:
1.586 raeburn 2588: sub get_assignable_auth {
2589: my ($dom) = @_;
2590: if ($dom eq '') {
2591: $dom = $env{'request.role.domain'};
2592: }
2593: my %can_assign = (
2594: krb4 => 1,
2595: krb5 => 1,
2596: int => 1,
2597: loc => 1,
2598: );
2599: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2600: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2601: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2602: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2603: my $context;
2604: if ($env{'request.role'} =~ /^au/) {
2605: $context = 'author';
2606: } elsif ($env{'request.role'} =~ /^dc/) {
2607: $context = 'domain';
2608: } elsif ($env{'request.course.id'}) {
2609: $context = 'course';
2610: }
2611: if ($context) {
2612: if (ref($authhash->{$context}) eq 'HASH') {
2613: %can_assign = %{$authhash->{$context}};
2614: }
2615: }
2616: }
2617: }
2618: my $authnum = 0;
2619: foreach my $key (keys(%can_assign)) {
2620: if ($can_assign{$key}) {
2621: $authnum ++;
2622: }
2623: }
2624: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2625: $authnum --;
2626: }
2627: return ($authnum,%can_assign);
2628: }
2629:
1.80 albertel 2630: ###############################################################
2631: ## Get Kerberos Defaults for Domain ##
2632: ###############################################################
2633: ##
2634: ## Returns default kerberos version and an associated argument
2635: ## as listed in file domain.tab. If not listed, provides
2636: ## appropriate default domain and kerberos version.
2637: ##
2638: #-------------------------------------------
2639:
2640: =pod
2641:
1.648 raeburn 2642: =item * &get_kerberos_defaults()
1.80 albertel 2643:
2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2645: version and domain. If not found, it defaults to version 4 and the
2646: domain of the server.
1.80 albertel 2647:
1.648 raeburn 2648: =over 4
2649:
1.80 albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2651:
1.648 raeburn 2652: =back
2653:
2654: =back
2655:
1.80 albertel 2656: =cut
2657:
2658: #-------------------------------------------
2659: sub get_kerberos_defaults {
2660: my $domain=shift;
1.641 raeburn 2661: my ($krbdef,$krbdefdom);
2662: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2663: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2664: $krbdef = $domdefaults{'auth_def'};
2665: $krbdefdom = $domdefaults{'auth_arg_def'};
2666: } else {
1.80 albertel 2667: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2668: my $krbdefdom=$1;
2669: $krbdefdom=~tr/a-z/A-Z/;
2670: $krbdef = "krb4";
2671: }
2672: return ($krbdef,$krbdefdom);
2673: }
1.112 bowersj2 2674:
1.32 matthew 2675:
1.46 matthew 2676: ###############################################################
2677: ## Thesaurus Functions ##
2678: ###############################################################
1.20 www 2679:
1.46 matthew 2680: =pod
1.20 www 2681:
1.112 bowersj2 2682: =head1 Thesaurus Functions
2683:
2684: =over 4
2685:
1.648 raeburn 2686: =item * &initialize_keywords()
1.46 matthew 2687:
2688: Initializes the package variable %Keywords if it is empty. Uses the
2689: package variable $thesaurus_db_file.
2690:
2691: =cut
2692:
2693: ###################################################
2694:
2695: sub initialize_keywords {
2696: return 1 if (scalar keys(%Keywords));
2697: # If we are here, %Keywords is empty, so fill it up
2698: # Make sure the file we need exists...
2699: if (! -e $thesaurus_db_file) {
2700: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2701: " failed because it does not exist");
2702: return 0;
2703: }
2704: # Set up the hash as a database
2705: my %thesaurus_db;
2706: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2707: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2708: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2709: $thesaurus_db_file);
2710: return 0;
2711: }
2712: # Get the average number of appearances of a word.
2713: my $avecount = $thesaurus_db{'average.count'};
2714: # Put keywords (those that appear > average) into %Keywords
2715: while (my ($word,$data)=each (%thesaurus_db)) {
2716: my ($count,undef) = split /:/,$data;
2717: $Keywords{$word}++ if ($count > $avecount);
2718: }
2719: untie %thesaurus_db;
2720: # Remove special values from %Keywords.
1.356 albertel 2721: foreach my $value ('total.count','average.count') {
2722: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2723: }
1.46 matthew 2724: return 1;
2725: }
2726:
2727: ###################################################
2728:
2729: =pod
2730:
1.648 raeburn 2731: =item * &keyword($word)
1.46 matthew 2732:
2733: Returns true if $word is a keyword. A keyword is a word that appears more
2734: than the average number of times in the thesaurus database. Calls
2735: &initialize_keywords
2736:
2737: =cut
2738:
2739: ###################################################
1.20 www 2740:
2741: sub keyword {
1.46 matthew 2742: return if (!&initialize_keywords());
2743: my $word=lc(shift());
2744: $word=~s/\W//g;
2745: return exists($Keywords{$word});
1.20 www 2746: }
1.46 matthew 2747:
2748: ###############################################################
2749:
2750: =pod
1.20 www 2751:
1.648 raeburn 2752: =item * &get_related_words()
1.46 matthew 2753:
1.160 matthew 2754: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2755: an array of words. If the keyword is not in the thesaurus, an empty array
2756: will be returned. The order of the words returned is determined by the
2757: database which holds them.
2758:
2759: Uses global $thesaurus_db_file.
2760:
2761: =cut
2762:
2763: ###############################################################
2764: sub get_related_words {
2765: my $keyword = shift;
2766: my %thesaurus_db;
2767: if (! -e $thesaurus_db_file) {
2768: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2769: "failed because the file does not exist");
2770: return ();
2771: }
2772: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2773: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2774: return ();
2775: }
2776: my @Words=();
1.429 www 2777: my $count=0;
1.46 matthew 2778: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2779: # The first element is the number of times
2780: # the word appears. We do not need it now.
1.429 www 2781: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2782: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2783: my $threshold=$mostfrequentcount/10;
2784: foreach my $possibleword (@RelatedWords) {
2785: my ($word,$wordcount)=split(/\,/,$possibleword);
2786: if ($wordcount>$threshold) {
2787: push(@Words,$word);
2788: $count++;
2789: if ($count>10) { last; }
2790: }
1.20 www 2791: }
2792: }
1.46 matthew 2793: untie %thesaurus_db;
2794: return @Words;
1.14 harris41 2795: }
1.46 matthew 2796:
1.112 bowersj2 2797: =pod
2798:
2799: =back
2800:
2801: =cut
1.61 www 2802:
2803: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2804: =pod
2805:
1.112 bowersj2 2806: =head1 User Name Functions
2807:
2808: =over 4
2809:
1.648 raeburn 2810: =item * &plainname($uname,$udom,$first)
1.81 albertel 2811:
1.112 bowersj2 2812: Takes a users logon name and returns it as a string in
1.226 albertel 2813: "first middle last generation" form
2814: if $first is set to 'lastname' then it returns it as
2815: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2816:
2817: =cut
1.61 www 2818:
1.295 www 2819:
1.81 albertel 2820: ###############################################################
1.61 www 2821: sub plainname {
1.226 albertel 2822: my ($uname,$udom,$first)=@_;
1.537 albertel 2823: return if (!defined($uname) || !defined($udom));
1.295 www 2824: my %names=&getnames($uname,$udom);
1.226 albertel 2825: my $name=&Apache::lonnet::format_name($names{'firstname'},
2826: $names{'middlename'},
2827: $names{'lastname'},
2828: $names{'generation'},$first);
2829: $name=~s/^\s+//;
1.62 www 2830: $name=~s/\s+$//;
2831: $name=~s/\s+/ /g;
1.353 albertel 2832: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2833: return $name;
1.61 www 2834: }
1.66 www 2835:
2836: # -------------------------------------------------------------------- Nickname
1.81 albertel 2837: =pod
2838:
1.648 raeburn 2839: =item * &nickname($uname,$udom)
1.81 albertel 2840:
2841: Gets a users name and returns it as a string as
2842:
2843: ""nickname""
1.66 www 2844:
1.81 albertel 2845: if the user has a nickname or
2846:
2847: "first middle last generation"
2848:
2849: if the user does not
2850:
2851: =cut
1.66 www 2852:
2853: sub nickname {
2854: my ($uname,$udom)=@_;
1.537 albertel 2855: return if (!defined($uname) || !defined($udom));
1.295 www 2856: my %names=&getnames($uname,$udom);
1.68 albertel 2857: my $name=$names{'nickname'};
1.66 www 2858: if ($name) {
2859: $name='"'.$name.'"';
2860: } else {
2861: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2862: $names{'lastname'}.' '.$names{'generation'};
2863: $name=~s/\s+$//;
2864: $name=~s/\s+/ /g;
2865: }
2866: return $name;
2867: }
2868:
1.295 www 2869: sub getnames {
2870: my ($uname,$udom)=@_;
1.537 albertel 2871: return if (!defined($uname) || !defined($udom));
1.433 albertel 2872: if ($udom eq 'public' && $uname eq 'public') {
2873: return ('lastname' => &mt('Public'));
2874: }
1.295 www 2875: my $id=$uname.':'.$udom;
2876: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2877: if ($cached) {
2878: return %{$names};
2879: } else {
2880: my %loadnames=&Apache::lonnet::get('environment',
2881: ['firstname','middlename','lastname','generation','nickname'],
2882: $udom,$uname);
2883: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2884: return %loadnames;
2885: }
2886: }
1.61 www 2887:
1.542 raeburn 2888: # -------------------------------------------------------------------- getemails
1.648 raeburn 2889:
1.542 raeburn 2890: =pod
2891:
1.648 raeburn 2892: =item * &getemails($uname,$udom)
1.542 raeburn 2893:
2894: Gets a user's email information and returns it as a hash with keys:
2895: notification, critnotification, permanentemail
2896:
2897: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2899:
1.648 raeburn 2900:
1.542 raeburn 2901: =cut
2902:
1.648 raeburn 2903:
1.466 albertel 2904: sub getemails {
2905: my ($uname,$udom)=@_;
2906: if ($udom eq 'public' && $uname eq 'public') {
2907: return;
2908: }
1.467 www 2909: if (!$udom) { $udom=$env{'user.domain'}; }
2910: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2911: my $id=$uname.':'.$udom;
2912: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2913: if ($cached) {
2914: return %{$names};
2915: } else {
2916: my %loadnames=&Apache::lonnet::get('environment',
2917: ['notification','critnotification',
2918: 'permanentemail'],
2919: $udom,$uname);
2920: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2921: return %loadnames;
2922: }
2923: }
2924:
1.551 albertel 2925: sub flush_email_cache {
2926: my ($uname,$udom)=@_;
2927: if (!$udom) { $udom =$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: return if ($udom eq 'public' && $uname eq 'public');
2930: my $id=$uname.':'.$udom;
2931: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2932: }
2933:
1.728 raeburn 2934: # -------------------------------------------------------------------- getlangs
2935:
2936: =pod
2937:
2938: =item * &getlangs($uname,$udom)
2939:
2940: Gets a user's language preference and returns it as a hash with key:
2941: language.
2942:
2943: =cut
2944:
2945:
2946: sub getlangs {
2947: my ($uname,$udom) = @_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: my $id=$uname.':'.$udom;
2951: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2952: if ($cached) {
2953: return %{$langs};
2954: } else {
2955: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2956: $udom,$uname);
2957: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2958: return %loadlangs;
2959: }
2960: }
2961:
2962: sub flush_langs_cache {
2963: my ($uname,$udom)=@_;
2964: if (!$udom) { $udom =$env{'user.domain'}; }
2965: if (!$uname) { $uname=$env{'user.name'}; }
2966: return if ($udom eq 'public' && $uname eq 'public');
2967: my $id=$uname.':'.$udom;
2968: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2969: }
2970:
1.61 www 2971: # ------------------------------------------------------------------ Screenname
1.81 albertel 2972:
2973: =pod
2974:
1.648 raeburn 2975: =item * &screenname($uname,$udom)
1.81 albertel 2976:
2977: Gets a users screenname and returns it as a string
2978:
2979: =cut
1.61 www 2980:
2981: sub screenname {
2982: my ($uname,$udom)=@_;
1.258 albertel 2983: if ($uname eq $env{'user.name'} &&
2984: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2985: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2986: return $names{'screenname'};
1.62 www 2987: }
2988:
1.212 albertel 2989:
1.802 bisitz 2990: # ------------------------------------------------------------- Confirm Wrapper
2991: =pod
2992:
2993: =item confirmwrapper
2994:
2995: Wrap messages about completion of operation in box
2996:
2997: =cut
2998:
2999: sub confirmwrapper {
3000: my ($message)=@_;
3001: if ($message) {
3002: return "\n".'<div class="LC_confirm_box">'."\n"
3003: .$message."\n"
3004: .'</div>'."\n";
3005: } else {
3006: return $message;
3007: }
3008: }
3009:
1.62 www 3010: # ------------------------------------------------------------- Message Wrapper
3011:
3012: sub messagewrapper {
1.369 www 3013: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3014: return
1.441 albertel 3015: '<a href="/adm/email?compose=individual&'.
3016: 'recname='.$username.'&recdom='.$domain.
3017: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3018: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3019: }
1.802 bisitz 3020:
1.74 www 3021: # --------------------------------------------------------------- Notes Wrapper
3022:
3023: sub noteswrapper {
3024: my ($link,$un,$do)=@_;
3025: return
1.896 amueller 3026: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3027: }
1.802 bisitz 3028:
1.62 www 3029: # ------------------------------------------------------------- Aboutme Wrapper
3030:
3031: sub aboutmewrapper {
1.166 www 3032: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3033: if (!defined($username) && !defined($domain)) {
3034: return;
3035: }
1.892 amueller 3036: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3037: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3038: }
3039:
3040: # ------------------------------------------------------------ Syllabus Wrapper
3041:
3042: sub syllabuswrapper {
1.707 bisitz 3043: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3044: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3045: }
1.14 harris41 3046:
1.802 bisitz 3047: # -----------------------------------------------------------------------------
3048:
1.208 matthew 3049: sub track_student_link {
1.887 raeburn 3050: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3051: my $link ="/adm/trackstudent?";
1.208 matthew 3052: my $title = 'View recent activity';
3053: if (defined($sname) && $sname !~ /^\s*$/ &&
3054: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3055: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3056: $title .= ' of this student';
1.268 albertel 3057: }
1.208 matthew 3058: if (defined($target) && $target !~ /^\s*$/) {
3059: $target = qq{target="$target"};
3060: } else {
3061: $target = '';
3062: }
1.268 albertel 3063: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3064: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3065: $title = &mt($title);
3066: $linktext = &mt($linktext);
1.448 albertel 3067: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3068: &help_open_topic('View_recent_activity');
1.208 matthew 3069: }
3070:
1.781 raeburn 3071: sub slot_reservations_link {
3072: my ($linktext,$sname,$sdom,$target) = @_;
3073: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3074: my $title = 'View slot reservation history';
3075: if (defined($sname) && $sname !~ /^\s*$/ &&
3076: defined($sdom) && $sdom !~ /^\s*$/) {
3077: $link .= "&uname=$sname&udom=$sdom";
3078: $title .= ' of this student';
3079: }
3080: if (defined($target) && $target !~ /^\s*$/) {
3081: $target = qq{target="$target"};
3082: } else {
3083: $target = '';
3084: }
3085: $title = &mt($title);
3086: $linktext = &mt($linktext);
3087: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3089:
3090: }
3091:
1.508 www 3092: # ===================================================== Display a student photo
3093:
3094:
1.509 albertel 3095: sub student_image_tag {
1.508 www 3096: my ($domain,$user)=@_;
3097: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3098: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3099: return '<img src="'.$imgsrc.'" align="right" />';
3100: } else {
3101: return '';
3102: }
3103: }
3104:
1.112 bowersj2 3105: =pod
3106:
3107: =back
3108:
3109: =head1 Access .tab File Data
3110:
3111: =over 4
3112:
1.648 raeburn 3113: =item * &languageids()
1.112 bowersj2 3114:
3115: returns list of all language ids
3116:
3117: =cut
3118:
1.14 harris41 3119: sub languageids {
1.16 harris41 3120: return sort(keys(%language));
1.14 harris41 3121: }
3122:
1.112 bowersj2 3123: =pod
3124:
1.648 raeburn 3125: =item * &languagedescription()
1.112 bowersj2 3126:
3127: returns description of a specified language id
3128:
3129: =cut
3130:
1.14 harris41 3131: sub languagedescription {
1.125 www 3132: my $code=shift;
3133: return ($supported_language{$code}?'* ':'').
3134: $language{$code}.
1.126 www 3135: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3136: }
3137:
3138: sub plainlanguagedescription {
3139: my $code=shift;
3140: return $language{$code};
3141: }
3142:
3143: sub supportedlanguagecode {
3144: my $code=shift;
3145: return $supported_language{$code};
1.97 www 3146: }
3147:
1.112 bowersj2 3148: =pod
3149:
1.648 raeburn 3150: =item * ©rightids()
1.112 bowersj2 3151:
3152: returns list of all copyrights
3153:
3154: =cut
3155:
3156: sub copyrightids {
3157: return sort(keys(%cprtag));
3158: }
3159:
3160: =pod
3161:
1.648 raeburn 3162: =item * ©rightdescription()
1.112 bowersj2 3163:
3164: returns description of a specified copyright id
3165:
3166: =cut
3167:
3168: sub copyrightdescription {
1.166 www 3169: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3170: }
1.197 matthew 3171:
3172: =pod
3173:
1.648 raeburn 3174: =item * &source_copyrightids()
1.192 taceyjo1 3175:
3176: returns list of all source copyrights
3177:
3178: =cut
3179:
3180: sub source_copyrightids {
3181: return sort(keys(%scprtag));
3182: }
3183:
3184: =pod
3185:
1.648 raeburn 3186: =item * &source_copyrightdescription()
1.192 taceyjo1 3187:
3188: returns description of a specified source copyright id
3189:
3190: =cut
3191:
3192: sub source_copyrightdescription {
3193: return &mt($scprtag{shift(@_)});
3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.648 raeburn 3198: =item * &filecategories()
1.112 bowersj2 3199:
3200: returns list of all file categories
3201:
3202: =cut
3203:
3204: sub filecategories {
3205: return sort(keys(%category_extensions));
3206: }
3207:
3208: =pod
3209:
1.648 raeburn 3210: =item * &filecategorytypes()
1.112 bowersj2 3211:
3212: returns list of file types belonging to a given file
3213: category
3214:
3215: =cut
3216:
3217: sub filecategorytypes {
1.356 albertel 3218: my ($cat) = @_;
3219: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3220: }
3221:
3222: =pod
3223:
1.648 raeburn 3224: =item * &fileembstyle()
1.112 bowersj2 3225:
3226: returns embedding style for a specified file type
3227:
3228: =cut
3229:
3230: sub fileembstyle {
3231: return $fe{lc(shift(@_))};
1.169 www 3232: }
3233:
1.351 www 3234: sub filemimetype {
3235: return $fm{lc(shift(@_))};
3236: }
3237:
1.169 www 3238:
3239: sub filecategoryselect {
3240: my ($name,$value)=@_;
1.189 matthew 3241: return &select_form($value,$name,
1.169 www 3242: '' => &mt('Any category'),
3243: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3244: }
3245:
3246: =pod
3247:
1.648 raeburn 3248: =item * &filedescription()
1.112 bowersj2 3249:
3250: returns description for a specified file type
3251:
3252: =cut
3253:
3254: sub filedescription {
1.188 matthew 3255: my $file_description = $fd{lc(shift())};
3256: $file_description =~ s:([\[\]]):~$1:g;
3257: return &mt($file_description);
1.112 bowersj2 3258: }
3259:
3260: =pod
3261:
1.648 raeburn 3262: =item * &filedescriptionex()
1.112 bowersj2 3263:
3264: returns description for a specified file type with
3265: extra formatting
3266:
3267: =cut
3268:
3269: sub filedescriptionex {
3270: my $ex=shift;
1.188 matthew 3271: my $file_description = $fd{lc($ex)};
3272: $file_description =~ s:([\[\]]):~$1:g;
3273: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3274: }
3275:
3276: # End of .tab access
3277: =pod
3278:
3279: =back
3280:
3281: =cut
3282:
3283: # ------------------------------------------------------------------ File Types
3284: sub fileextensions {
3285: return sort(keys(%fe));
3286: }
3287:
1.97 www 3288: # ----------------------------------------------------------- Display Languages
3289: # returns a hash with all desired display languages
3290: #
3291:
3292: sub display_languages {
3293: my %languages=();
1.695 raeburn 3294: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3295: $languages{$lang}=1;
1.97 www 3296: }
3297: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3298: if ($env{'form.displaylanguage'}) {
1.356 albertel 3299: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3300: $languages{$lang}=1;
1.97 www 3301: }
3302: }
3303: return %languages;
1.14 harris41 3304: }
3305:
1.582 albertel 3306: sub languages {
3307: my ($possible_langs) = @_;
1.695 raeburn 3308: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3309: if (!ref($possible_langs)) {
3310: if( wantarray ) {
3311: return @preferred_langs;
3312: } else {
3313: return $preferred_langs[0];
3314: }
3315: }
3316: my %possibilities = map { $_ => 1 } (@$possible_langs);
3317: my @preferred_possibilities;
3318: foreach my $preferred_lang (@preferred_langs) {
3319: if (exists($possibilities{$preferred_lang})) {
3320: push(@preferred_possibilities, $preferred_lang);
3321: }
3322: }
3323: if( wantarray ) {
3324: return @preferred_possibilities;
3325: }
3326: return $preferred_possibilities[0];
3327: }
3328:
1.742 raeburn 3329: sub user_lang {
3330: my ($touname,$toudom,$fromcid) = @_;
3331: my @userlangs;
3332: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3333: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3334: $env{'course.'.$fromcid.'.languages'}));
3335: } else {
3336: my %langhash = &getlangs($touname,$toudom);
3337: if ($langhash{'languages'} ne '') {
3338: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3339: } else {
3340: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3341: if ($domdefs{'lang_def'} ne '') {
3342: @userlangs = ($domdefs{'lang_def'});
3343: }
3344: }
3345: }
3346: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3347: my $user_lh = Apache::localize->get_handle(@languages);
3348: return $user_lh;
3349: }
3350:
3351:
1.112 bowersj2 3352: ###############################################################
3353: ## Student Answer Attempts ##
3354: ###############################################################
3355:
3356: =pod
3357:
3358: =head1 Alternate Problem Views
3359:
3360: =over 4
3361:
1.648 raeburn 3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3363: $getattempt, $regexp, $gradesub)
3364:
3365: Return string with previous attempt on problem. Arguments:
3366:
3367: =over 4
3368:
3369: =item * $symb: Problem, including path
3370:
3371: =item * $username: username of the desired student
3372:
3373: =item * $domain: domain of the desired student
1.14 harris41 3374:
1.112 bowersj2 3375: =item * $course: Course ID
1.14 harris41 3376:
1.112 bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
3378: something
1.14 harris41 3379:
1.112 bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
3381: sent to $gradesub
1.14 harris41 3382:
1.112 bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3384:
1.112 bowersj2 3385: =back
1.14 harris41 3386:
1.112 bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16 harris41 3388:
1.112 bowersj2 3389: =cut
1.1 albertel 3390:
3391: sub get_previous_attempt {
1.43 ng 3392: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3393: my $prevattempts='';
1.43 ng 3394: no strict 'refs';
1.1 albertel 3395: if ($symb) {
1.3 albertel 3396: my (%returnhash)=
3397: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3398: if ($returnhash{'version'}) {
3399: my %lasthash=();
3400: my $version;
3401: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3402: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3403: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3404: }
1.1 albertel 3405: }
1.596 albertel 3406: $prevattempts=&start_data_table().&start_data_table_header_row();
3407: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3408: foreach my $key (sort(keys(%lasthash))) {
3409: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3410: if ($#parts > 0) {
1.31 albertel 3411: my $data=$parts[-1];
3412: pop(@parts);
1.596 albertel 3413: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3414: } else {
1.41 ng 3415: if ($#parts == 0) {
3416: $prevattempts.='<th>'.$parts[0].'</th>';
3417: } else {
3418: $prevattempts.='<th>'.$ign.'</th>';
3419: }
1.31 albertel 3420: }
1.16 harris41 3421: }
1.596 albertel 3422: $prevattempts.=&end_data_table_header_row();
1.40 ng 3423: if ($getattempt eq '') {
3424: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3425: $prevattempts.=&start_data_table_row().
3426: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3427: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3428: my $value = &format_previous_attempt_value($key,
3429: $returnhash{$version.':'.$key});
3430: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3431: }
1.596 albertel 3432: $prevattempts.=&end_data_table_row();
1.40 ng 3433: }
1.1 albertel 3434: }
1.596 albertel 3435: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3436: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3437: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3438: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3439: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3440: }
1.596 albertel 3441: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3442: } else {
1.596 albertel 3443: $prevattempts=
3444: &start_data_table().&start_data_table_row().
3445: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3446: &end_data_table_row().&end_data_table();
1.1 albertel 3447: }
3448: } else {
1.596 albertel 3449: $prevattempts=
3450: &start_data_table().&start_data_table_row().
3451: '<td>'.&mt('No data.').'</td>'.
3452: &end_data_table_row().&end_data_table();
1.1 albertel 3453: }
1.10 albertel 3454: }
3455:
1.581 albertel 3456: sub format_previous_attempt_value {
3457: my ($key,$value) = @_;
3458: if ($key =~ /timestamp/) {
3459: $value = &Apache::lonlocal::locallocaltime($value);
3460: } elsif (ref($value) eq 'ARRAY') {
3461: $value = '('.join(', ', @{ $value }).')';
3462: } else {
3463: $value = &unescape($value);
3464: }
3465: return $value;
3466: }
3467:
3468:
1.107 albertel 3469: sub relative_to_absolute {
3470: my ($url,$output)=@_;
3471: my $parser=HTML::TokeParser->new(\$output);
3472: my $token;
3473: my $thisdir=$url;
3474: my @rlinks=();
3475: while ($token=$parser->get_token) {
3476: if ($token->[0] eq 'S') {
3477: if ($token->[1] eq 'a') {
3478: if ($token->[2]->{'href'}) {
3479: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3480: }
3481: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3482: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3483: } elsif ($token->[1] eq 'base') {
3484: $thisdir=$token->[2]->{'href'};
3485: }
3486: }
3487: }
3488: $thisdir=~s-/[^/]*$--;
1.356 albertel 3489: foreach my $link (@rlinks) {
1.726 raeburn 3490: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3491: ($link=~/^\//) ||
3492: ($link=~/^javascript:/i) ||
3493: ($link=~/^mailto:/i) ||
3494: ($link=~/^\#/)) {
3495: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3496: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3497: }
3498: }
3499: # -------------------------------------------------- Deal with Applet codebases
3500: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3501: return $output;
3502: }
3503:
1.112 bowersj2 3504: =pod
3505:
1.648 raeburn 3506: =item * &get_student_view()
1.112 bowersj2 3507:
3508: show a snapshot of what student was looking at
3509:
3510: =cut
3511:
1.10 albertel 3512: sub get_student_view {
1.186 albertel 3513: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3514: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3515: my (%form);
1.10 albertel 3516: my @elements=('symb','courseid','domain','username');
3517: foreach my $element (@elements) {
1.186 albertel 3518: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3519: }
1.186 albertel 3520: if (defined($moreenv)) {
3521: %form=(%form,%{$moreenv});
3522: }
1.236 albertel 3523: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3524: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3525: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3526: $userview=~s/\<body[^\>]*\>//gi;
3527: $userview=~s/\<\/body\>//gi;
3528: $userview=~s/\<html\>//gi;
3529: $userview=~s/\<\/html\>//gi;
3530: $userview=~s/\<head\>//gi;
3531: $userview=~s/\<\/head\>//gi;
3532: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3533: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3534: if (wantarray) {
3535: return ($userview,$response);
3536: } else {
3537: return $userview;
3538: }
3539: }
3540:
3541: sub get_student_view_with_retries {
3542: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3543:
3544: my $ok = 0; # True if we got a good response.
3545: my $content;
3546: my $response;
3547:
3548: # Try to get the student_view done. within the retries count:
3549:
3550: do {
3551: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3552: $ok = $response->is_success;
3553: if (!$ok) {
3554: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3555: }
3556: $retries--;
3557: } while (!$ok && ($retries > 0));
3558:
3559: if (!$ok) {
3560: $content = ''; # On error return an empty content.
3561: }
1.651 www 3562: if (wantarray) {
3563: return ($content, $response);
3564: } else {
3565: return $content;
3566: }
1.11 albertel 3567: }
3568:
1.112 bowersj2 3569: =pod
3570:
1.648 raeburn 3571: =item * &get_student_answers()
1.112 bowersj2 3572:
3573: show a snapshot of how student was answering problem
3574:
3575: =cut
3576:
1.11 albertel 3577: sub get_student_answers {
1.100 sakharuk 3578: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3579: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3580: my (%moreenv);
1.11 albertel 3581: my @elements=('symb','courseid','domain','username');
3582: foreach my $element (@elements) {
1.186 albertel 3583: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3584: }
1.186 albertel 3585: $moreenv{'grade_target'}='answer';
3586: %moreenv=(%form,%moreenv);
1.497 raeburn 3587: $feedurl = &Apache::lonnet::clutter($feedurl);
3588: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3589: return $userview;
1.1 albertel 3590: }
1.116 albertel 3591:
3592: =pod
3593:
3594: =item * &submlink()
3595:
1.242 albertel 3596: Inputs: $text $uname $udom $symb $target
1.116 albertel 3597:
3598: Returns: A link to grades.pm such as to see the SUBM view of a student
3599:
3600: =cut
3601:
3602: ###############################################
3603: sub submlink {
1.242 albertel 3604: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3605: if (!($uname && $udom)) {
3606: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3607: &Apache::lonnet::whichuser($symb);
1.116 albertel 3608: if (!$symb) { $symb=$cursymb; }
3609: }
1.254 matthew 3610: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3611: $symb=&escape($symb);
1.242 albertel 3612: if ($target) { $target="target=\"$target\""; }
3613: return '<a href="/adm/grades?&command=submission&'.
3614: 'symb='.$symb.'&student='.$uname.
3615: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3616: }
3617: ##############################################
3618:
3619: =pod
3620:
3621: =item * &pgrdlink()
3622:
3623: Inputs: $text $uname $udom $symb $target
3624:
3625: Returns: A link to grades.pm such as to see the PGRD view of a student
3626:
3627: =cut
3628:
3629: ###############################################
3630: sub pgrdlink {
3631: my $link=&submlink(@_);
3632: $link=~s/(&command=submission)/$1&showgrading=yes/;
3633: return $link;
3634: }
3635: ##############################################
3636:
3637: =pod
3638:
3639: =item * &pprmlink()
3640:
3641: Inputs: $text $uname $udom $symb $target
3642:
3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3644: student and a specific resource
1.242 albertel 3645:
3646: =cut
3647:
3648: ###############################################
3649: sub pprmlink {
3650: my ($text,$uname,$udom,$symb,$target)=@_;
3651: if (!($uname && $udom)) {
3652: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3653: &Apache::lonnet::whichuser($symb);
1.242 albertel 3654: if (!$symb) { $symb=$cursymb; }
3655: }
1.254 matthew 3656: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3657: $symb=&escape($symb);
1.242 albertel 3658: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3659: return '<a href="/adm/parmset?command=set&'.
3660: 'symb='.$symb.'&uname='.$uname.
3661: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3662: }
3663: ##############################################
1.37 matthew 3664:
1.112 bowersj2 3665: =pod
3666:
3667: =back
3668:
3669: =cut
3670:
1.37 matthew 3671: ###############################################
1.51 www 3672:
3673:
3674: sub timehash {
1.687 raeburn 3675: my ($thistime) = @_;
3676: my $timezone = &Apache::lonlocal::gettimezone();
3677: my $dt = DateTime->from_epoch(epoch => $thistime)
3678: ->set_time_zone($timezone);
3679: my $wday = $dt->day_of_week();
3680: if ($wday == 7) { $wday = 0; }
3681: return ( 'second' => $dt->second(),
3682: 'minute' => $dt->minute(),
3683: 'hour' => $dt->hour(),
3684: 'day' => $dt->day_of_month(),
3685: 'month' => $dt->month(),
3686: 'year' => $dt->year(),
3687: 'weekday' => $wday,
3688: 'dayyear' => $dt->day_of_year(),
3689: 'dlsav' => $dt->is_dst() );
1.51 www 3690: }
3691:
1.370 www 3692: sub utc_string {
3693: my ($date)=@_;
1.371 www 3694: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3695: }
3696:
1.51 www 3697: sub maketime {
3698: my %th=@_;
1.687 raeburn 3699: my ($epoch_time,$timezone,$dt);
3700: $timezone = &Apache::lonlocal::gettimezone();
3701: eval {
3702: $dt = DateTime->new( year => $th{'year'},
3703: month => $th{'month'},
3704: day => $th{'day'},
3705: hour => $th{'hour'},
3706: minute => $th{'minute'},
3707: second => $th{'second'},
3708: time_zone => $timezone,
3709: );
3710: };
3711: if (!$@) {
3712: $epoch_time = $dt->epoch;
3713: if ($epoch_time) {
3714: return $epoch_time;
3715: }
3716: }
1.51 www 3717: return POSIX::mktime(
3718: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3719: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3720: }
3721:
3722: #########################################
1.51 www 3723:
3724: sub findallcourses {
1.482 raeburn 3725: my ($roles,$uname,$udom) = @_;
1.355 albertel 3726: my %roles;
3727: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3728: my %courses;
1.51 www 3729: my $now=time;
1.482 raeburn 3730: if (!defined($uname)) {
3731: $uname = $env{'user.name'};
3732: }
3733: if (!defined($udom)) {
3734: $udom = $env{'user.domain'};
3735: }
3736: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3737: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3738: if (!%roles) {
3739: %roles = (
3740: cc => 1,
1.907 raeburn 3741: co => 1,
1.482 raeburn 3742: in => 1,
3743: ep => 1,
3744: ta => 1,
3745: cr => 1,
3746: st => 1,
3747: );
3748: }
3749: foreach my $entry (keys(%roleshash)) {
3750: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3751: if ($trole =~ /^cr/) {
3752: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3753: } else {
3754: next if (!exists($roles{$trole}));
3755: }
3756: if ($tend) {
3757: next if ($tend < $now);
3758: }
3759: if ($tstart) {
3760: next if ($tstart > $now);
3761: }
3762: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3763: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3764: if ($secpart eq '') {
3765: ($cnum,$role) = split(/_/,$cnumpart);
3766: $sec = 'none';
3767: $realsec = '';
3768: } else {
3769: $cnum = $cnumpart;
3770: ($sec,$role) = split(/_/,$secpart);
3771: $realsec = $sec;
1.490 raeburn 3772: }
1.482 raeburn 3773: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3774: }
3775: } else {
3776: foreach my $key (keys(%env)) {
1.483 albertel 3777: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3778: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3779: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3780: next if ($role eq 'ca' || $role eq 'aa');
3781: next if (%roles && !exists($roles{$role}));
3782: my ($starttime,$endtime)=split(/\./,$env{$key});
3783: my $active=1;
3784: if ($starttime) {
3785: if ($now<$starttime) { $active=0; }
3786: }
3787: if ($endtime) {
3788: if ($now>$endtime) { $active=0; }
3789: }
3790: if ($active) {
3791: if ($sec eq '') {
3792: $sec = 'none';
3793: }
3794: $courses{$cdom.'_'.$cnum}{$sec} =
3795: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3796: }
3797: }
1.51 www 3798: }
3799: }
1.474 raeburn 3800: return %courses;
1.51 www 3801: }
1.37 matthew 3802:
1.54 www 3803: ###############################################
1.474 raeburn 3804:
3805: sub blockcheck {
1.482 raeburn 3806: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3807:
3808: if (!defined($udom)) {
3809: $udom = $env{'user.domain'};
3810: }
3811: if (!defined($uname)) {
3812: $uname = $env{'user.name'};
3813: }
3814:
3815: # If uname and udom are for a course, check for blocks in the course.
3816:
3817: if (&Apache::lonnet::is_course($udom,$uname)) {
3818: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3819: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3820: return ($startblock,$endblock);
3821: }
1.474 raeburn 3822:
1.502 raeburn 3823: my $startblock = 0;
3824: my $endblock = 0;
1.482 raeburn 3825: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3826:
1.490 raeburn 3827: # If uname is for a user, and activity is course-specific, i.e.,
3828: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3829:
1.490 raeburn 3830: if (($activity eq 'boards' || $activity eq 'chat' ||
3831: $activity eq 'groups') && ($env{'request.course.id'})) {
3832: foreach my $key (keys(%live_courses)) {
3833: if ($key ne $env{'request.course.id'}) {
3834: delete($live_courses{$key});
3835: }
3836: }
3837: }
3838:
3839: my $otheruser = 0;
3840: my %own_courses;
3841: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3842: # Resource belongs to user other than current user.
3843: $otheruser = 1;
3844: # Gather courses for current user
3845: %own_courses =
3846: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3847: }
3848:
3849: # Gather active course roles - course coordinator, instructor,
3850: # exam proctor, ta, student, or custom role.
1.474 raeburn 3851:
3852: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3853: my ($cdom,$cnum);
3854: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3855: $cdom = $env{'course.'.$course.'.domain'};
3856: $cnum = $env{'course.'.$course.'.num'};
3857: } else {
1.490 raeburn 3858: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3859: }
3860: my $no_ownblock = 0;
3861: my $no_userblock = 0;
1.533 raeburn 3862: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3863: # Check if current user has 'evb' priv for this
3864: if (defined($own_courses{$course})) {
3865: foreach my $sec (keys(%{$own_courses{$course}})) {
3866: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3867: if ($sec ne 'none') {
3868: $checkrole .= '/'.$sec;
3869: }
3870: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3871: $no_ownblock = 1;
3872: last;
3873: }
3874: }
3875: }
3876: # if they have 'evb' priv and are currently not playing student
3877: next if (($no_ownblock) &&
3878: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3879: }
1.474 raeburn 3880: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3881: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3882: if ($sec ne 'none') {
1.482 raeburn 3883: $checkrole .= '/'.$sec;
1.474 raeburn 3884: }
1.490 raeburn 3885: if ($otheruser) {
3886: # Resource belongs to user other than current user.
3887: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3888: my ($trole,$tdom,$tnum,$tsec);
3889: my $entry = $live_courses{$course}{$sec};
3890: if ($entry =~ /^cr/) {
3891: ($trole,$tdom,$tnum,$tsec) =
3892: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3893: } else {
3894: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3895: }
3896: my ($spec,$area,$trest,%allroles,%userroles);
3897: $area = '/'.$tdom.'/'.$tnum;
3898: $trest = $tnum;
3899: if ($tsec ne '') {
3900: $area .= '/'.$tsec;
3901: $trest .= '/'.$tsec;
3902: }
3903: $spec = $trole.'.'.$area;
3904: if ($trole =~ /^cr/) {
3905: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3906: $tdom,$spec,$trest,$area);
3907: } else {
3908: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3909: $tdom,$spec,$trest,$area);
3910: }
3911: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3912: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3913: if ($1) {
3914: $no_userblock = 1;
3915: last;
3916: }
3917: }
1.490 raeburn 3918: } else {
3919: # Resource belongs to current user
3920: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3921: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3922: $no_ownblock = 1;
3923: last;
3924: }
1.474 raeburn 3925: }
3926: }
3927: # if they have the evb priv and are currently not playing student
1.482 raeburn 3928: next if (($no_ownblock) &&
1.491 albertel 3929: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3930: next if ($no_userblock);
1.474 raeburn 3931:
1.866 kalberla 3932: # Retrieve blocking times and identity of locker for course
1.490 raeburn 3933: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3934:
3935: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3936: if (($start != 0) &&
3937: (($startblock == 0) || ($startblock > $start))) {
3938: $startblock = $start;
3939: }
3940: if (($end != 0) &&
3941: (($endblock == 0) || ($endblock < $end))) {
3942: $endblock = $end;
3943: }
1.490 raeburn 3944: }
3945: return ($startblock,$endblock);
3946: }
3947:
3948: sub get_blocks {
3949: my ($setters,$activity,$cdom,$cnum) = @_;
3950: my $startblock = 0;
3951: my $endblock = 0;
3952: my $course = $cdom.'_'.$cnum;
3953: $setters->{$course} = {};
3954: $setters->{$course}{'staff'} = [];
3955: $setters->{$course}{'times'} = [];
3956: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3957: foreach my $record (keys(%records)) {
3958: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3959: if ($start <= time && $end >= time) {
3960: my ($staff_name,$staff_dom,$title,$blocks) =
3961: &parse_block_record($records{$record});
3962: if ($blocks->{$activity} eq 'on') {
3963: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3964: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3965: if ( ($startblock == 0) || ($startblock > $start) ) {
3966: $startblock = $start;
1.490 raeburn 3967: }
1.491 albertel 3968: if ( ($endblock == 0) || ($endblock < $end) ) {
3969: $endblock = $end;
1.474 raeburn 3970: }
3971: }
3972: }
3973: }
3974: return ($startblock,$endblock);
3975: }
3976:
3977: sub parse_block_record {
3978: my ($record) = @_;
3979: my ($setuname,$setudom,$title,$blocks);
3980: if (ref($record) eq 'HASH') {
3981: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3982: $title = &unescape($record->{'event'});
3983: $blocks = $record->{'blocks'};
3984: } else {
3985: my @data = split(/:/,$record,3);
3986: if (scalar(@data) eq 2) {
3987: $title = $data[1];
3988: ($setuname,$setudom) = split(/@/,$data[0]);
3989: } else {
3990: ($setuname,$setudom,$title) = @data;
3991: }
3992: $blocks = { 'com' => 'on' };
3993: }
3994: return ($setuname,$setudom,$title,$blocks);
3995: }
3996:
1.854 kalberla 3997: sub blocking_status {
3998: my ($activity,$uname,$udom) = @_;
1.867 kalberla 3999: my %setters;
1.890 droeschl 4000:
4001: # check for active blocking
1.867 kalberla 4002: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4003:
1.890 droeschl 4004: my $blocked = $startblock && $endblock ? 1 : 0;
4005:
4006: # caller just wants to know whether a block is active
4007: if (!wantarray) { return $blocked; }
4008:
4009: # build a link to a popup window containing the details
4010: my $querystring = "?activity=$activity";
4011: # $uname and $udom decide whose portfolio the user is trying to look at
4012: $querystring .= "&udom=$udom" if $udom;
4013: $querystring .= "&uname=$uname" if $uname;
4014:
4015: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4016: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4017: var options = "width=" + w + ",height=" + h + ",";
4018: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4019: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4020: var newWin = window.open(url, wdwName, options);
4021: newWin.focus();
4022: }
1.890 droeschl 4023: END_MYBLOCK
1.854 kalberla 4024:
1.890 droeschl 4025: $output = Apache::lonhtmlcommon::scripttag($output);
4026:
1.854 kalberla 4027: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4028: my $text = mt('Communication Blocked');
4029:
1.867 kalberla 4030: $output .= <<"END_BLOCK";
4031: <div class='LC_comblock'>
1.869 kalberla 4032: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4033: title='$text'>
4034: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4035: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4036: title='$text'>$text</a>
1.867 kalberla 4037: </div>
4038:
4039: END_BLOCK
1.474 raeburn 4040:
1.854 kalberla 4041: return ($blocked, $output);
4042: }
1.490 raeburn 4043:
1.60 matthew 4044: ###############################################
4045:
1.682 raeburn 4046: sub check_ip_acc {
4047: my ($acc)=@_;
4048: &Apache::lonxml::debug("acc is $acc");
4049: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4050: return 1;
4051: }
4052: my $allowed=0;
4053: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4054:
4055: my $name;
4056: foreach my $pattern (split(',',$acc)) {
4057: $pattern =~ s/^\s*//;
4058: $pattern =~ s/\s*$//;
4059: if ($pattern =~ /\*$/) {
4060: #35.8.*
4061: $pattern=~s/\*//;
4062: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4063: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4064: #35.8.3.[34-56]
4065: my $low=$2;
4066: my $high=$3;
4067: $pattern=$1;
4068: if ($ip =~ /^\Q$pattern\E/) {
4069: my $last=(split(/\./,$ip))[3];
4070: if ($last <=$high && $last >=$low) { $allowed=1; }
4071: }
4072: } elsif ($pattern =~ /^\*/) {
4073: #*.msu.edu
4074: $pattern=~s/\*//;
4075: if (!defined($name)) {
4076: use Socket;
4077: my $netaddr=inet_aton($ip);
4078: ($name)=gethostbyaddr($netaddr,AF_INET);
4079: }
4080: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4081: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4082: #127.0.0.1
4083: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4084: } else {
4085: #some.name.com
4086: if (!defined($name)) {
4087: use Socket;
4088: my $netaddr=inet_aton($ip);
4089: ($name)=gethostbyaddr($netaddr,AF_INET);
4090: }
4091: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4092: }
4093: if ($allowed) { last; }
4094: }
4095: return $allowed;
4096: }
4097:
4098: ###############################################
4099:
1.60 matthew 4100: =pod
4101:
1.112 bowersj2 4102: =head1 Domain Template Functions
4103:
4104: =over 4
4105:
4106: =item * &determinedomain()
1.60 matthew 4107:
4108: Inputs: $domain (usually will be undef)
4109:
1.63 www 4110: Returns: Determines which domain should be used for designs
1.60 matthew 4111:
4112: =cut
1.54 www 4113:
1.60 matthew 4114: ###############################################
1.63 www 4115: sub determinedomain {
4116: my $domain=shift;
1.531 albertel 4117: if (! $domain) {
1.60 matthew 4118: # Determine domain if we have not been given one
1.893 raeburn 4119: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4120: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4121: if ($env{'request.role.domain'}) {
4122: $domain=$env{'request.role.domain'};
1.60 matthew 4123: }
4124: }
1.63 www 4125: return $domain;
4126: }
4127: ###############################################
1.517 raeburn 4128:
1.518 albertel 4129: sub devalidate_domconfig_cache {
4130: my ($udom)=@_;
4131: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4132: }
4133:
4134: # ---------------------- Get domain configuration for a domain
4135: sub get_domainconf {
4136: my ($udom) = @_;
4137: my $cachetime=1800;
4138: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4139: if (defined($cached)) { return %{$result}; }
4140:
4141: my %domconfig = &Apache::lonnet::get_dom('configuration',
4142: ['login','rolecolors'],$udom);
1.632 raeburn 4143: my (%designhash,%legacy);
1.518 albertel 4144: if (keys(%domconfig) > 0) {
4145: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4146: if (keys(%{$domconfig{'login'}})) {
4147: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4148: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4149: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4150: $designhash{$udom.'.login.'.$key.'_'.$img} =
4151: $domconfig{'login'}{$key}{$img};
4152: }
4153: } else {
4154: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4155: }
1.632 raeburn 4156: }
4157: } else {
4158: $legacy{'login'} = 1;
1.518 albertel 4159: }
1.632 raeburn 4160: } else {
4161: $legacy{'login'} = 1;
1.518 albertel 4162: }
4163: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4164: if (keys(%{$domconfig{'rolecolors'}})) {
4165: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4166: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4167: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4168: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4169: }
1.518 albertel 4170: }
4171: }
1.632 raeburn 4172: } else {
4173: $legacy{'rolecolors'} = 1;
1.518 albertel 4174: }
1.632 raeburn 4175: } else {
4176: $legacy{'rolecolors'} = 1;
1.518 albertel 4177: }
1.632 raeburn 4178: if (keys(%legacy) > 0) {
4179: my %legacyhash = &get_legacy_domconf($udom);
4180: foreach my $item (keys(%legacyhash)) {
4181: if ($item =~ /^\Q$udom\E\.login/) {
4182: if ($legacy{'login'}) {
4183: $designhash{$item} = $legacyhash{$item};
4184: }
4185: } else {
4186: if ($legacy{'rolecolors'}) {
4187: $designhash{$item} = $legacyhash{$item};
4188: }
1.518 albertel 4189: }
4190: }
4191: }
1.632 raeburn 4192: } else {
4193: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4194: }
4195: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4196: $cachetime);
4197: return %designhash;
4198: }
4199:
1.632 raeburn 4200: sub get_legacy_domconf {
4201: my ($udom) = @_;
4202: my %legacyhash;
4203: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4204: my $designfile = $designdir.'/'.$udom.'.tab';
4205: if (-e $designfile) {
4206: if ( open (my $fh,"<$designfile") ) {
4207: while (my $line = <$fh>) {
4208: next if ($line =~ /^\#/);
4209: chomp($line);
4210: my ($key,$val)=(split(/\=/,$line));
4211: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4212: }
4213: close($fh);
4214: }
4215: }
4216: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4217: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4218: }
4219: return %legacyhash;
4220: }
4221:
1.63 www 4222: =pod
4223:
1.112 bowersj2 4224: =item * &domainlogo()
1.63 www 4225:
4226: Inputs: $domain (usually will be undef)
4227:
4228: Returns: A link to a domain logo, if the domain logo exists.
4229: If the domain logo does not exist, a description of the domain.
4230:
4231: =cut
1.112 bowersj2 4232:
1.63 www 4233: ###############################################
4234: sub domainlogo {
1.517 raeburn 4235: my $domain = &determinedomain(shift);
1.518 albertel 4236: my %designhash = &get_domainconf($domain);
1.517 raeburn 4237: # See if there is a logo
4238: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4239: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4240: if ($imgsrc =~ m{^/(adm|res)/}) {
4241: if ($imgsrc =~ m{^/res/}) {
4242: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4243: &Apache::lonnet::repcopy($local_name);
4244: }
4245: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4246: }
4247: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4248: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4249: return &Apache::lonnet::domain($domain,'description');
1.59 www 4250: } else {
1.60 matthew 4251: return '';
1.59 www 4252: }
4253: }
1.63 www 4254: ##############################################
4255:
4256: =pod
4257:
1.112 bowersj2 4258: =item * &designparm()
1.63 www 4259:
4260: Inputs: $which parameter; $domain (usually will be undef)
4261:
4262: Returns: value of designparamter $which
4263:
4264: =cut
1.112 bowersj2 4265:
1.397 albertel 4266:
1.400 albertel 4267: ##############################################
1.397 albertel 4268: sub designparm {
4269: my ($which,$domain)=@_;
4270: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4271: return $env{'environment.color.'.$which};
1.96 www 4272: }
1.63 www 4273: $domain=&determinedomain($domain);
1.518 albertel 4274: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4275: my $output;
1.517 raeburn 4276: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4277: $output = $domdesign{$domain.'.'.$which};
1.63 www 4278: } else {
1.520 raeburn 4279: $output = $defaultdesign{$which};
4280: }
4281: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4282: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4283: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4284: if ($output =~ m{^/res/}) {
4285: my $local_name = &Apache::lonnet::filelocation('',$output);
4286: &Apache::lonnet::repcopy($local_name);
4287: }
1.520 raeburn 4288: $output = &lonhttpdurl($output);
4289: }
1.63 www 4290: }
1.520 raeburn 4291: return $output;
1.63 www 4292: }
1.59 www 4293:
1.822 bisitz 4294: ##############################################
4295: =pod
4296:
1.832 bisitz 4297: =item * &authorspace()
4298:
4299: Inputs: ./.
4300:
4301: Returns: Path to the Construction Space of the current user's
4302: accessed author space
4303: The author space will be that of the current user
4304: when accessing the own author space
4305: and that of the co-author/assistent co-author
4306: when accessing the co-author's/assistent co-author's
4307: space
4308:
4309: =cut
4310:
4311: sub authorspace {
4312: my $caname = '';
4313: if ($env{'request.role'} =~ /^ca|^aa/) {
4314: (undef,$caname) =
4315: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4316: } else {
4317: $caname = $env{'user.name'};
4318: }
4319: return '/priv/'.$caname.'/';
4320: }
4321:
4322: ##############################################
4323: =pod
4324:
1.822 bisitz 4325: =item * &head_subbox()
4326:
4327: Inputs: $content (contains HTML code with page functions, etc.)
4328:
4329: Returns: HTML div with $content
4330: To be included in page header
4331:
4332: =cut
4333:
4334: sub head_subbox {
4335: my ($content)=@_;
4336: my $output =
1.844 bisitz 4337: '<div id="LC_head_subbox">'
1.822 bisitz 4338: .$content
4339: .'</div>'
4340: }
4341:
4342: ##############################################
4343: =pod
4344:
4345: =item * &CSTR_pageheader()
4346:
4347: Inputs: ./.
4348:
4349: Returns: HTML div with CSTR path and recent box
4350: To be included on Construction Space pages
4351:
4352: =cut
4353:
4354: sub CSTR_pageheader {
4355: # this is for resources; directories have customtitle, and crumbs
4356: # and select recent are created in lonpubdir.pm
4357: my ($uname,$thisdisfn)=
4358: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4359: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4360: $formaction=~s/\/+/\//g;
4361:
4362: my $parentpath = '';
4363: my $lastitem = '';
4364: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4365: $parentpath = $1;
4366: $lastitem = $2;
4367: } else {
4368: $lastitem = $thisdisfn;
4369: }
1.921 bisitz 4370:
4371: my $output =
1.822 bisitz 4372: '<div>'
4373: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4374: .'<b>'.&mt('Construction Space:').'</b> '
4375: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4376: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4377: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4378:
4379: if ($lastitem) {
4380: $output .=
4381: '<span class="LC_filename">'
4382: .$lastitem
4383: .'</span>';
4384: }
4385: $output .=
4386: '<br />'
1.822 bisitz 4387: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4388: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4389: .'</form>'
4390: .&Apache::lonmenu::constspaceform()
4391: .'</div>';
1.921 bisitz 4392:
4393: return $output;
1.822 bisitz 4394: }
4395:
1.60 matthew 4396: ###############################################
4397: ###############################################
4398:
4399: =pod
4400:
1.112 bowersj2 4401: =back
4402:
1.549 albertel 4403: =head1 HTML Helpers
1.112 bowersj2 4404:
4405: =over 4
4406:
4407: =item * &bodytag()
1.60 matthew 4408:
4409: Returns a uniform header for LON-CAPA web pages.
4410:
4411: Inputs:
4412:
1.112 bowersj2 4413: =over 4
4414:
4415: =item * $title, A title to be displayed on the page.
4416:
4417: =item * $function, the current role (can be undef).
4418:
4419: =item * $addentries, extra parameters for the <body> tag.
4420:
4421: =item * $bodyonly, if defined, only return the <body> tag.
4422:
4423: =item * $domain, if defined, force a given domain.
4424:
4425: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4426: text interface only)
1.60 matthew 4427:
1.814 bisitz 4428: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4429: navigational links
1.317 albertel 4430:
1.338 albertel 4431: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4432:
1.361 albertel 4433: =item * $no_inline_link, if true and in remote mode, don't show the
4434: 'Switch To Inline Menu' link
4435:
1.460 albertel 4436: =item * $args, optional argument valid values are
4437: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4438: inherit_jsmath -> when creating popup window in a page,
4439: should it have jsmath forced on by the
4440: current page
1.460 albertel 4441:
1.112 bowersj2 4442: =back
4443:
1.60 matthew 4444: Returns: A uniform header for LON-CAPA web pages.
4445: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4446: If $bodyonly is undef or zero, an html string containing a <body> tag and
4447: other decorations will be returned.
4448:
4449: =cut
4450:
1.54 www 4451: sub bodytag {
1.831 bisitz 4452: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4453: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4454:
1.460 albertel 4455: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4456:
1.183 matthew 4457: $function = &get_users_function() if (!$function);
1.339 albertel 4458: my $img = &designparm($function.'.img',$domain);
4459: my $font = &designparm($function.'.font',$domain);
4460: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4461:
1.803 bisitz 4462: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4463: 'bgcolor' => $pgbg,
1.339 albertel 4464: 'text' => $font,
4465: 'alink' => &designparm($function.'.alink',$domain),
4466: 'vlink' => &designparm($function.'.vlink',$domain),
4467: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4468: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4469:
1.63 www 4470: # role and realm
1.378 raeburn 4471: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4472: if ($role eq 'ca') {
1.479 albertel 4473: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4474: $realm = &plainname($rname,$rdom);
1.378 raeburn 4475: }
1.55 www 4476: # realm
1.258 albertel 4477: if ($env{'request.course.id'}) {
1.378 raeburn 4478: if ($env{'request.role'} !~ /^cr/) {
4479: $role = &Apache::lonnet::plaintext($role,&course_type());
4480: }
1.898 raeburn 4481: if ($env{'request.course.sec'}) {
4482: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4483: }
1.359 albertel 4484: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4485: } else {
4486: $role = &Apache::lonnet::plaintext($role);
1.54 www 4487: }
1.433 albertel 4488:
1.359 albertel 4489: if (!$realm) { $realm=' '; }
1.55 www 4490: # Set messages
1.60 matthew 4491: my $messages=&domainlogo($domain);
1.330 albertel 4492:
1.438 albertel 4493: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4494:
1.101 www 4495: # construct main body tag
1.359 albertel 4496: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4497: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4498:
1.530 albertel 4499: if ($bodyonly) {
1.60 matthew 4500: return $bodytag;
1.798 tempelho 4501: }
1.359 albertel 4502:
1.410 albertel 4503: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4504: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4505: undef($role);
1.434 albertel 4506: } else {
4507: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4508: }
1.359 albertel 4509:
1.762 bisitz 4510: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4511: #
4512: # Extra info if you are the DC
4513: my $dc_info = '';
4514: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4515: $env{'course.'.$env{'request.course.id'}.
4516: '.domain'}.'/'})) {
4517: my $cid = $env{'request.course.id'};
1.917 raeburn 4518: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4519: $dc_info =~ s/\s+$//;
1.359 albertel 4520: }
4521:
1.898 raeburn 4522: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4523: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4524:
1.837 bisitz 4525: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4526: # No Remote
1.916 droeschl 4527: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4528: return $bodytag;
4529: }
1.925.2.2! raeburn 4530: my $custommenu = &needs_gci_custom();
1.903 droeschl 4531:
4532: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4533:
4534: # if ($env{'request.state'} eq 'construct') {
4535: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4536: # }
4537:
1.359 albertel 4538:
4539:
1.916 droeschl 4540: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4541: if ($dc_info) {
4542: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4543: }
1.916 droeschl 4544: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4545: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4546: return $bodytag;
4547: }
1.894 droeschl 4548:
1.916 droeschl 4549: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4550:
1.903 droeschl 4551: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.925.2.2! raeburn 4552: Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
1.816 bisitz 4553:
1.903 droeschl 4554: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4555:
1.917 raeburn 4556: if ($dc_info) {
4557: $dc_info = &dc_courseid_toggle($dc_info);
4558: }
4559: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4560:
1.903 droeschl 4561: #don't show menus for public users
4562: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
1.925.2.2! raeburn 4563: if ($custommenu) {
! 4564: $bodytag .= &Apache::lonmenu::gci_secondary_menu();
! 4565: } else {
! 4566: $bodytag .= Apache::lonmenu::secondary_menu();
! 4567: }
1.903 droeschl 4568: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4569: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4570: if ($env{'request.state'} eq 'construct') {
4571: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4572: $args->{'bread_crumbs'});
4573: } elsif ($forcereg) {
4574: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4575: }
1.903 droeschl 4576: }else{
4577: # this is to seperate menu from content when there's no secondary
4578: # menu. Especially needed for public accessible ressources.
4579: $bodytag .= '<hr style="clear:both" />';
4580: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4581: }
1.903 droeschl 4582:
4583: #SD testing
4584: #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235 raeburn 4585: return $bodytag;
1.94 www 4586: }
1.95 www 4587:
1.93 www 4588: #
1.95 www 4589: # Top frame rendering, Remote is up
1.93 www 4590: #
1.359 albertel 4591:
1.517 raeburn 4592: my $imgsrc = $img;
4593: if ($img =~ /^\/adm/) {
1.575 albertel 4594: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4595: }
4596: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4597:
1.305 www 4598: # Explicit link to get inline menu
1.361 albertel 4599: my $menu= ($no_inline_link?''
1.883 droeschl 4600: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4601:
4602: if ($dc_info) {
4603: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4604: }
4605:
1.916 droeschl 4606: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4607: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4608: <li>$menu</li>
1.917 raeburn 4609: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4610: return(<<ENDBODY);
1.60 matthew 4611: $bodytag
1.359 albertel 4612: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4613: <tr><td>$upperleft</td>
4614: <td>$messages </td>
1.54 www 4615: </tr>
1.359 albertel 4616: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4617: </tr>
1.356 albertel 4618: </table>
1.54 www 4619: ENDBODY
1.182 matthew 4620: }
4621:
1.917 raeburn 4622: sub dc_courseid_toggle {
4623: my ($dc_info) = @_;
4624: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4625: '<a href="javascript:showCourseID();">'.
4626: &mt('(More ...)').'</a></span>'.
4627: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4628: }
4629:
1.330 albertel 4630: sub make_attr_string {
4631: my ($register,$attr_ref) = @_;
4632:
4633: if ($attr_ref && !ref($attr_ref)) {
4634: die("addentries Must be a hash ref ".
4635: join(':',caller(1))." ".
4636: join(':',caller(0))." ");
4637: }
4638:
4639: if ($register) {
1.339 albertel 4640: my ($on_load,$on_unload);
4641: foreach my $key (keys(%{$attr_ref})) {
4642: if (lc($key) eq 'onload') {
4643: $on_load.=$attr_ref->{$key}.';';
4644: delete($attr_ref->{$key});
4645:
4646: } elsif (lc($key) eq 'onunload') {
4647: $on_unload.=$attr_ref->{$key}.';';
4648: delete($attr_ref->{$key});
4649: }
4650: }
4651: $attr_ref->{'onload'} =
4652: &Apache::lonmenu::loadevents(). $on_load;
4653: $attr_ref->{'onunload'}=
4654: &Apache::lonmenu::unloadevents().$on_unload;
4655: }
4656:
4657: # Accessibility font enhance
4658: if ($env{'browser.fontenhance'} eq 'on') {
4659: my $style;
4660: foreach my $key (keys(%{$attr_ref})) {
4661: if (lc($key) eq 'style') {
4662: $style.=$attr_ref->{$key}.';';
4663: delete($attr_ref->{$key});
4664: }
4665: }
4666: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4667: }
1.339 albertel 4668:
1.330 albertel 4669: my $attr_string;
4670: foreach my $attr (keys(%$attr_ref)) {
4671: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4672: }
4673: return $attr_string;
4674: }
4675:
4676:
1.182 matthew 4677: ###############################################
1.251 albertel 4678: ###############################################
4679:
4680: =pod
4681:
4682: =item * &endbodytag()
4683:
4684: Returns a uniform footer for LON-CAPA web pages.
4685:
1.635 raeburn 4686: Inputs: 1 - optional reference to an args hash
4687: If in the hash, key for noredirectlink has a value which evaluates to true,
4688: a 'Continue' link is not displayed if the page contains an
4689: internal redirect in the <head></head> section,
4690: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4691:
4692: =cut
4693:
4694: sub endbodytag {
1.635 raeburn 4695: my ($args) = @_;
1.251 albertel 4696: my $endbodytag='</body>';
1.269 albertel 4697: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4698: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4699: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4700: $endbodytag=
4701: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4702: &mt('Continue').'</a>'.
4703: $endbodytag;
4704: }
1.315 albertel 4705: }
1.251 albertel 4706: return $endbodytag;
4707: }
4708:
1.352 albertel 4709: =pod
4710:
4711: =item * &standard_css()
4712:
4713: Returns a style sheet
4714:
4715: Inputs: (all optional)
4716: domain -> force to color decorate a page for a specific
4717: domain
4718: function -> force usage of a specific rolish color scheme
4719: bgcolor -> override the default page bgcolor
4720:
4721: =cut
4722:
1.343 albertel 4723: sub standard_css {
1.345 albertel 4724: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4725: $function = &get_users_function() if (!$function);
4726: my $img = &designparm($function.'.img', $domain);
4727: my $tabbg = &designparm($function.'.tabbg', $domain);
4728: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4729: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4730: #second colour for later usage
1.345 albertel 4731: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4732: my $pgbg_or_bgcolor =
4733: $bgcolor ||
1.352 albertel 4734: &designparm($function.'.pgbg', $domain);
1.382 albertel 4735: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4736: my $alink = &designparm($function.'.alink', $domain);
4737: my $vlink = &designparm($function.'.vlink', $domain);
4738: my $link = &designparm($function.'.link', $domain);
4739:
1.704 muellerd 4740: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4741: my $bgcol = &designparm('login.bgcol',$domain);
4742: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4743:
1.602 albertel 4744: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4745: my $mono = 'monospace';
1.850 bisitz 4746: my $data_table_head = $sidebg;
4747: my $data_table_light = '#FAFAFA';
4748: my $data_table_dark = '#F0F0F0';
1.470 banghart 4749: my $data_table_darker = '#CCCCCC';
1.349 albertel 4750: my $data_table_highlight = '#FFFF00';
1.352 albertel 4751: my $mail_new = '#FFBB77';
4752: my $mail_new_hover = '#DD9955';
4753: my $mail_read = '#BBBB77';
4754: my $mail_read_hover = '#999944';
4755: my $mail_replied = '#AAAA88';
4756: my $mail_replied_hover = '#888855';
4757: my $mail_other = '#99BBBB';
4758: my $mail_other_hover = '#669999';
1.391 albertel 4759: my $table_header = '#DDDDDD';
1.489 raeburn 4760: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4761: my $lg_border_color = '#C8C8C8';
1.392 albertel 4762:
1.608 albertel 4763: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4764: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4765: : '0 3px 0 4px';
1.448 albertel 4766:
1.523 albertel 4767:
1.343 albertel 4768: return <<END;
1.795 www 4769: body {
1.911 bisitz 4770: font-family: $sans;
4771: line-height:130%;
4772: font-size:0.83em;
4773: color:$font;
1.795 www 4774: }
4775:
1.911 bisitz 4776: a:focus {
1.795 www 4777: color: red;
1.911 bisitz 4778: background: yellow;
1.795 www 4779: }
1.698 harmsja 4780:
1.911 bisitz 4781: form, .inline {
4782: display: inline;
1.795 www 4783: }
1.721 harmsja 4784:
1.795 www 4785: .LC_right {
1.911 bisitz 4786: text-align:right;
1.795 www 4787: }
4788:
4789: .LC_middle {
1.911 bisitz 4790: vertical-align:middle;
1.795 www 4791: }
1.721 harmsja 4792:
4793: /* just for tests */
1.911 bisitz 4794: .LC_400Box {
4795: width:400px;
4796: }
1.721 harmsja 4797: /* end */
4798:
1.778 bisitz 4799: .LC_filename {
4800: font-family: $mono;
4801: white-space:pre;
1.921 bisitz 4802: font-size: 120%;
1.778 bisitz 4803: }
4804:
4805: .LC_fileicon {
4806: border: none;
4807: height: 1.3em;
4808: vertical-align: text-bottom;
4809: margin-right: 0.3em;
4810: text-decoration:none;
4811: }
4812:
1.350 albertel 4813: .LC_error {
4814: color: red;
4815: font-size: larger;
4816: }
1.795 www 4817:
1.457 albertel 4818: .LC_warning,
4819: .LC_diff_removed {
1.733 bisitz 4820: color: red;
1.394 albertel 4821: }
1.532 albertel 4822:
4823: .LC_info,
1.457 albertel 4824: .LC_success,
4825: .LC_diff_added {
1.350 albertel 4826: color: green;
4827: }
1.795 www 4828:
1.802 bisitz 4829: div.LC_confirm_box {
4830: background-color: #FAFAFA;
4831: border: 1px solid $lg_border_color;
4832: margin-right: 0;
4833: padding: 5px;
4834: }
4835:
4836: div.LC_confirm_box .LC_error img,
4837: div.LC_confirm_box .LC_success img {
4838: vertical-align: middle;
4839: }
4840:
1.440 albertel 4841: .LC_icon {
1.771 droeschl 4842: border: none;
1.790 droeschl 4843: vertical-align: middle;
1.771 droeschl 4844: }
4845:
1.543 albertel 4846: .LC_docs_spacer {
4847: width: 25px;
4848: height: 1px;
1.771 droeschl 4849: border: none;
1.543 albertel 4850: }
1.346 albertel 4851:
1.532 albertel 4852: .LC_internal_info {
1.735 bisitz 4853: color: #999999;
1.532 albertel 4854: }
4855:
1.794 www 4856: .LC_discussion {
1.911 bisitz 4857: background: $tabbg;
4858: border: 1px solid black;
4859: margin: 2px;
1.794 www 4860: }
4861:
4862: .LC_disc_action_links_bar {
1.911 bisitz 4863: background: $tabbg;
4864: border: none;
4865: margin: 4px;
1.794 www 4866: }
4867:
4868: .LC_disc_action_left {
1.911 bisitz 4869: text-align: left;
1.794 www 4870: }
4871:
4872: .LC_disc_action_right {
1.911 bisitz 4873: text-align: right;
1.794 www 4874: }
4875:
4876: .LC_disc_new_item {
1.911 bisitz 4877: background: white;
4878: border: 2px solid red;
4879: margin: 2px;
1.794 www 4880: }
4881:
4882: .LC_disc_old_item {
1.911 bisitz 4883: background: white;
4884: border: 1px solid black;
4885: margin: 2px;
1.794 www 4886: }
4887:
1.458 albertel 4888: table.LC_pastsubmission {
4889: border: 1px solid black;
4890: margin: 2px;
4891: }
4892:
1.924 bisitz 4893: table#LC_menubuttons {
1.345 albertel 4894: width: 100%;
4895: background: $pgbg;
1.392 albertel 4896: border: 2px;
1.402 albertel 4897: border-collapse: separate;
1.803 bisitz 4898: padding: 0;
1.345 albertel 4899: }
1.392 albertel 4900:
1.801 tempelho 4901: table#LC_title_bar a {
4902: color: $fontmenu;
4903: }
1.836 bisitz 4904:
1.807 droeschl 4905: table#LC_title_bar {
1.819 tempelho 4906: clear: both;
1.836 bisitz 4907: display: none;
1.807 droeschl 4908: }
4909:
1.795 www 4910: table#LC_title_bar,
4911: table.LC_breadcrumbs,
1.393 albertel 4912: table#LC_title_bar.LC_with_remote {
1.359 albertel 4913: width: 100%;
1.392 albertel 4914: border-color: $pgbg;
4915: border-style: solid;
4916: border-width: $border;
1.379 albertel 4917: background: $pgbg;
1.801 tempelho 4918: color: $fontmenu;
1.392 albertel 4919: border-collapse: collapse;
1.803 bisitz 4920: padding: 0;
1.819 tempelho 4921: margin: 0;
1.359 albertel 4922: }
1.795 www 4923:
1.913 droeschl 4924: /* #SD START (work in progress)*/
4925:
4926: ul.LC_bct {
4927: margin: 0;
4928: padding: 0;
4929: }
4930: ul.LC_bct ol {
4931: display: inline;
4932: }
4933: ul.LC_bct ul {
4934: display: inline;
4935: padding: 0;
4936: }
4937: ul.LC_bct li {
4938: list-style-type: none;
4939: display: inline;
4940: }
4941:
4942:
4943: ul.LC_breadcrumb_tools {
4944: }
4945:
4946: li.LC_breadcrumb_tools {
4947: }
4948: li.LC_breadcrumb_tools img{
4949: vertical-align: middle;
4950: }
4951:
4952: .LC_breadcrumb_tools_A {
4953: margin: 0 0 0 1em;
4954: }
4955: .LC_breadcrumb_tools_B {
4956: float: right;
4957: margin-top: 0.4em;
4958: }
4959: .LC_breadcrumb_tools_C {
4960: margin: 0 1em 0 0;
4961: float: right;
4962: }
4963: /* #SD END */
4964:
1.359 albertel 4965: table#LC_title_bar td {
4966: background: $tabbg;
4967: }
1.795 www 4968:
1.911 bisitz 4969: table#LC_menubuttons img {
1.803 bisitz 4970: border: none;
1.346 albertel 4971: }
1.795 www 4972:
1.842 droeschl 4973: .LC_breadcrumbs_component {
1.911 bisitz 4974: float: right;
4975: margin: 0 1em;
1.357 albertel 4976: }
1.842 droeschl 4977: .LC_breadcrumbs_component img {
1.911 bisitz 4978: vertical-align: middle;
1.777 tempelho 4979: }
1.795 www 4980:
1.383 albertel 4981: td.LC_table_cell_checkbox {
4982: text-align: center;
4983: }
1.795 www 4984:
4985: .LC_fontsize_small {
1.911 bisitz 4986: font-size: 70%;
1.705 tempelho 4987: }
4988:
1.844 bisitz 4989: #LC_breadcrumbs {
1.911 bisitz 4990: clear:both;
4991: background: $sidebg;
4992: border-bottom: 1px solid $lg_border_color;
4993: line-height: 2.5em;
1.915 droeschl 4994: /* SD working here
4995: height: 2.5em;
4996: overflow: hidden; */
1.911 bisitz 4997: margin: 0;
4998: padding: 0;
1.819 tempelho 4999: }
1.862 bisitz 5000:
1.839 droeschl 5001: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5002: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5003: display:none;
1.839 droeschl 5004: }
1.819 tempelho 5005:
1.844 bisitz 5006: #LC_head_subbox {
1.911 bisitz 5007: clear:both;
5008: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5009: border: 1px solid $sidebg;
5010: margin: 0 0 10px 0;
1.822 bisitz 5011: }
5012:
1.795 www 5013: .LC_fontsize_medium {
1.911 bisitz 5014: font-size: 85%;
1.705 tempelho 5015: }
5016:
1.795 www 5017: .LC_fontsize_large {
1.911 bisitz 5018: font-size: 120%;
1.705 tempelho 5019: }
5020:
1.346 albertel 5021: .LC_menubuttons_inline_text {
5022: color: $font;
1.698 harmsja 5023: font-size: 90%;
1.701 harmsja 5024: padding-left:3px;
1.346 albertel 5025: }
5026:
1.526 www 5027: .LC_menubuttons_link {
5028: text-decoration: none;
5029: }
1.795 www 5030:
1.522 albertel 5031: .LC_menubuttons_category {
1.521 www 5032: color: $font;
1.526 www 5033: background: $pgbg;
1.521 www 5034: font-size: larger;
5035: font-weight: bold;
5036: }
5037:
1.346 albertel 5038: td.LC_menubuttons_text {
1.911 bisitz 5039: color: $font;
1.346 albertel 5040: }
1.706 harmsja 5041:
1.346 albertel 5042: .LC_current_location {
5043: background: $tabbg;
5044: }
1.795 www 5045:
5046: table.LC_data_table,
5047: table.LC_mail_list {
1.347 albertel 5048: border: 1px solid #000000;
1.402 albertel 5049: border-collapse: separate;
1.426 albertel 5050: border-spacing: 1px;
1.610 albertel 5051: background: $pgbg;
1.347 albertel 5052: }
1.795 www 5053:
1.422 albertel 5054: .LC_data_table_dense {
5055: font-size: small;
5056: }
1.795 www 5057:
1.507 raeburn 5058: table.LC_nested_outer {
5059: border: 1px solid #000000;
1.589 raeburn 5060: border-collapse: collapse;
1.803 bisitz 5061: border-spacing: 0;
1.507 raeburn 5062: width: 100%;
5063: }
1.795 www 5064:
1.879 raeburn 5065: table.LC_innerpickbox,
1.507 raeburn 5066: table.LC_nested {
1.803 bisitz 5067: border: none;
1.589 raeburn 5068: border-collapse: collapse;
1.803 bisitz 5069: border-spacing: 0;
1.507 raeburn 5070: width: 100%;
5071: }
1.795 www 5072:
1.911 bisitz 5073: table.LC_data_table tr th,
5074: table.LC_calendar tr th,
1.795 www 5075: table.LC_mail_list tr th,
1.879 raeburn 5076: table.LC_prior_tries tr th,
5077: table.LC_innerpickbox tr th {
1.349 albertel 5078: font-weight: bold;
5079: background-color: $data_table_head;
1.801 tempelho 5080: color:$fontmenu;
1.701 harmsja 5081: font-size:90%;
1.347 albertel 5082: }
1.795 www 5083:
1.879 raeburn 5084: table.LC_innerpickbox tr th,
5085: table.LC_innerpickbox tr td {
5086: vertical-align: top;
5087: }
5088:
1.711 raeburn 5089: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5090: background-color: #CCCCCC;
1.711 raeburn 5091: font-weight: bold;
5092: text-align: left;
5093: }
1.795 www 5094:
1.912 bisitz 5095: table.LC_data_table tr.LC_odd_row > td {
5096: background-color: $data_table_light;
5097: padding: 2px;
5098: vertical-align: top;
5099: }
5100:
1.809 bisitz 5101: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5102: background-color: $data_table_light;
1.912 bisitz 5103: vertical-align: top;
5104: }
5105:
5106: table.LC_data_table tr.LC_even_row > td {
5107: background-color: $data_table_dark;
1.425 albertel 5108: padding: 2px;
1.900 bisitz 5109: vertical-align: top;
1.347 albertel 5110: }
1.795 www 5111:
1.809 bisitz 5112: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5113: background-color: $data_table_dark;
1.900 bisitz 5114: vertical-align: top;
1.347 albertel 5115: }
1.795 www 5116:
1.425 albertel 5117: table.LC_data_table tr.LC_data_table_highlight td {
5118: background-color: $data_table_darker;
5119: }
1.795 www 5120:
1.639 raeburn 5121: table.LC_data_table tr td.LC_leftcol_header {
5122: background-color: $data_table_head;
5123: font-weight: bold;
5124: }
1.795 www 5125:
1.451 albertel 5126: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5127: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5128: background-color: #FFFFFF;
1.421 albertel 5129: font-weight: bold;
5130: font-style: italic;
5131: text-align: center;
5132: padding: 8px;
1.347 albertel 5133: }
1.795 www 5134:
1.890 droeschl 5135: table.LC_caption {
5136: }
5137:
1.507 raeburn 5138: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5139: padding: 4ex
5140: }
1.795 www 5141:
1.507 raeburn 5142: table.LC_nested_outer tr th {
5143: font-weight: bold;
1.801 tempelho 5144: color:$fontmenu;
1.507 raeburn 5145: background-color: $data_table_head;
1.701 harmsja 5146: font-size: small;
1.507 raeburn 5147: border-bottom: 1px solid #000000;
5148: }
1.795 www 5149:
1.507 raeburn 5150: table.LC_nested_outer tr td.LC_subheader {
5151: background-color: $data_table_head;
5152: font-weight: bold;
5153: font-size: small;
5154: border-bottom: 1px solid #000000;
5155: text-align: right;
1.451 albertel 5156: }
1.795 www 5157:
1.507 raeburn 5158: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5159: background-color: #CCCCCC;
1.451 albertel 5160: font-weight: bold;
5161: font-size: small;
1.507 raeburn 5162: text-align: center;
5163: }
1.795 www 5164:
1.589 raeburn 5165: table.LC_nested tr.LC_info_row td.LC_left_item,
5166: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5167: text-align: left;
1.451 albertel 5168: }
1.795 www 5169:
1.507 raeburn 5170: table.LC_nested td {
1.735 bisitz 5171: background-color: #FFFFFF;
1.451 albertel 5172: font-size: small;
1.507 raeburn 5173: }
1.795 www 5174:
1.507 raeburn 5175: table.LC_nested_outer tr th.LC_right_item,
5176: table.LC_nested tr.LC_info_row td.LC_right_item,
5177: table.LC_nested tr.LC_odd_row td.LC_right_item,
5178: table.LC_nested tr td.LC_right_item {
1.451 albertel 5179: text-align: right;
5180: }
5181:
1.507 raeburn 5182: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5183: background-color: #EEEEEE;
1.451 albertel 5184: }
5185:
1.473 raeburn 5186: table.LC_createuser {
5187: }
5188:
5189: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5190: font-size: small;
1.473 raeburn 5191: }
5192:
5193: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5194: background-color: #CCCCCC;
1.473 raeburn 5195: font-weight: bold;
5196: text-align: center;
5197: }
5198:
1.349 albertel 5199: table.LC_calendar {
5200: border: 1px solid #000000;
5201: border-collapse: collapse;
1.917 raeburn 5202: width: 98%;
1.349 albertel 5203: }
1.795 www 5204:
1.349 albertel 5205: table.LC_calendar_pickdate {
5206: font-size: xx-small;
5207: }
1.795 www 5208:
1.349 albertel 5209: table.LC_calendar tr td {
5210: border: 1px solid #000000;
5211: vertical-align: top;
1.917 raeburn 5212: width: 14%;
1.349 albertel 5213: }
1.795 www 5214:
1.349 albertel 5215: table.LC_calendar tr td.LC_calendar_day_empty {
5216: background-color: $data_table_dark;
5217: }
1.795 www 5218:
1.779 bisitz 5219: table.LC_calendar tr td.LC_calendar_day_current {
5220: background-color: $data_table_highlight;
1.777 tempelho 5221: }
1.795 www 5222:
1.349 albertel 5223: table.LC_mail_list tr.LC_mail_new {
5224: background-color: $mail_new;
5225: }
1.795 www 5226:
1.349 albertel 5227: table.LC_mail_list tr.LC_mail_new:hover {
5228: background-color: $mail_new_hover;
5229: }
1.795 www 5230:
1.349 albertel 5231: table.LC_mail_list tr.LC_mail_read {
5232: background-color: $mail_read;
5233: }
1.795 www 5234:
1.349 albertel 5235: table.LC_mail_list tr.LC_mail_read:hover {
5236: background-color: $mail_read_hover;
5237: }
1.795 www 5238:
1.349 albertel 5239: table.LC_mail_list tr.LC_mail_replied {
5240: background-color: $mail_replied;
5241: }
1.795 www 5242:
1.349 albertel 5243: table.LC_mail_list tr.LC_mail_replied:hover {
5244: background-color: $mail_replied_hover;
5245: }
1.795 www 5246:
1.349 albertel 5247: table.LC_mail_list tr.LC_mail_other {
5248: background-color: $mail_other;
5249: }
1.795 www 5250:
1.349 albertel 5251: table.LC_mail_list tr.LC_mail_other:hover {
5252: background-color: $mail_other_hover;
5253: }
1.494 raeburn 5254:
1.777 tempelho 5255: table.LC_data_table tr > td.LC_browser_file,
5256: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5257: background: #AAEE77;
1.389 albertel 5258: }
1.795 www 5259:
1.777 tempelho 5260: table.LC_data_table tr > td.LC_browser_file_locked,
5261: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5262: background: #FFAA99;
1.387 albertel 5263: }
1.795 www 5264:
1.777 tempelho 5265: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5266: background: #888888;
1.779 bisitz 5267: }
1.795 www 5268:
1.777 tempelho 5269: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5270: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5271: background: #F8F866;
1.777 tempelho 5272: }
1.795 www 5273:
1.696 bisitz 5274: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5275: background: #E0E8FF;
1.387 albertel 5276: }
1.696 bisitz 5277:
1.707 bisitz 5278: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5279: /* background: #77FF77; */
1.707 bisitz 5280: }
1.795 www 5281:
1.707 bisitz 5282: table.LC_data_table tr > td.LC_roles_future {
5283: background: #FFFF77;
5284: }
1.795 www 5285:
1.707 bisitz 5286: table.LC_data_table tr > td.LC_roles_will {
5287: background: #FFAA77;
5288: }
1.795 www 5289:
1.707 bisitz 5290: table.LC_data_table tr > td.LC_roles_expired {
5291: background: #FF7777;
5292: }
1.795 www 5293:
1.707 bisitz 5294: table.LC_data_table tr > td.LC_roles_will_not {
5295: background: #AAFF77;
5296: }
1.795 www 5297:
1.707 bisitz 5298: table.LC_data_table tr > td.LC_roles_selected {
5299: background: #11CC55;
5300: }
5301:
1.388 albertel 5302: span.LC_current_location {
1.701 harmsja 5303: font-size:larger;
1.388 albertel 5304: background: $pgbg;
5305: }
1.387 albertel 5306:
1.395 albertel 5307: span.LC_parm_menu_item {
5308: font-size: larger;
5309: }
1.795 www 5310:
1.395 albertel 5311: span.LC_parm_scope_all {
5312: color: red;
5313: }
1.795 www 5314:
1.395 albertel 5315: span.LC_parm_scope_folder {
5316: color: green;
5317: }
1.795 www 5318:
1.395 albertel 5319: span.LC_parm_scope_resource {
5320: color: orange;
5321: }
1.795 www 5322:
1.395 albertel 5323: span.LC_parm_part {
5324: color: blue;
5325: }
1.795 www 5326:
1.911 bisitz 5327: span.LC_parm_folder,
5328: span.LC_parm_symb {
1.395 albertel 5329: font-size: x-small;
5330: font-family: $mono;
5331: color: #AAAAAA;
5332: }
5333:
1.795 www 5334: td.LC_parm_overview_level_menu,
5335: td.LC_parm_overview_map_menu,
5336: td.LC_parm_overview_parm_selectors,
5337: td.LC_parm_overview_restrictions {
1.396 albertel 5338: border: 1px solid black;
5339: border-collapse: collapse;
5340: }
1.795 www 5341:
1.396 albertel 5342: table.LC_parm_overview_restrictions td {
5343: border-width: 1px 4px 1px 4px;
5344: border-style: solid;
5345: border-color: $pgbg;
5346: text-align: center;
5347: }
1.795 www 5348:
1.396 albertel 5349: table.LC_parm_overview_restrictions th {
5350: background: $tabbg;
5351: border-width: 1px 4px 1px 4px;
5352: border-style: solid;
5353: border-color: $pgbg;
5354: }
1.795 www 5355:
1.398 albertel 5356: table#LC_helpmenu {
1.803 bisitz 5357: border: none;
1.398 albertel 5358: height: 55px;
1.803 bisitz 5359: border-spacing: 0;
1.398 albertel 5360: }
5361:
5362: table#LC_helpmenu fieldset legend {
5363: font-size: larger;
5364: }
1.795 www 5365:
1.397 albertel 5366: table#LC_helpmenu_links {
5367: width: 100%;
5368: border: 1px solid black;
5369: background: $pgbg;
1.803 bisitz 5370: padding: 0;
1.397 albertel 5371: border-spacing: 1px;
5372: }
1.795 www 5373:
1.397 albertel 5374: table#LC_helpmenu_links tr td {
5375: padding: 1px;
5376: background: $tabbg;
1.399 albertel 5377: text-align: center;
5378: font-weight: bold;
1.397 albertel 5379: }
1.396 albertel 5380:
1.795 www 5381: table#LC_helpmenu_links a:link,
5382: table#LC_helpmenu_links a:visited,
1.397 albertel 5383: table#LC_helpmenu_links a:active {
5384: text-decoration: none;
5385: color: $font;
5386: }
1.795 www 5387:
1.397 albertel 5388: table#LC_helpmenu_links a:hover {
5389: text-decoration: underline;
5390: color: $vlink;
5391: }
1.396 albertel 5392:
1.417 albertel 5393: .LC_chrt_popup_exists {
5394: border: 1px solid #339933;
5395: margin: -1px;
5396: }
1.795 www 5397:
1.417 albertel 5398: .LC_chrt_popup_up {
5399: border: 1px solid yellow;
5400: margin: -1px;
5401: }
1.795 www 5402:
1.417 albertel 5403: .LC_chrt_popup {
5404: border: 1px solid #8888FF;
5405: background: #CCCCFF;
5406: }
1.795 www 5407:
1.421 albertel 5408: table.LC_pick_box {
5409: border-collapse: separate;
5410: background: white;
5411: border: 1px solid black;
5412: border-spacing: 1px;
5413: }
1.795 www 5414:
1.421 albertel 5415: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5416: background: $sidebg;
1.421 albertel 5417: font-weight: bold;
1.900 bisitz 5418: text-align: left;
1.740 bisitz 5419: vertical-align: top;
1.421 albertel 5420: width: 184px;
5421: padding: 8px;
5422: }
1.795 www 5423:
1.579 raeburn 5424: table.LC_pick_box td.LC_pick_box_value {
5425: text-align: left;
5426: padding: 8px;
5427: }
1.795 www 5428:
1.579 raeburn 5429: table.LC_pick_box td.LC_pick_box_select {
5430: text-align: left;
5431: padding: 8px;
5432: }
1.795 www 5433:
1.424 albertel 5434: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5435: padding: 0;
1.421 albertel 5436: height: 1px;
5437: background: black;
5438: }
1.795 www 5439:
1.421 albertel 5440: table.LC_pick_box td.LC_pick_box_submit {
5441: text-align: right;
5442: }
1.795 www 5443:
1.579 raeburn 5444: table.LC_pick_box td.LC_evenrow_value {
5445: text-align: left;
5446: padding: 8px;
5447: background-color: $data_table_light;
5448: }
1.795 www 5449:
1.579 raeburn 5450: table.LC_pick_box td.LC_oddrow_value {
5451: text-align: left;
5452: padding: 8px;
5453: background-color: $data_table_light;
5454: }
1.795 www 5455:
1.579 raeburn 5456: span.LC_helpform_receipt_cat {
5457: font-weight: bold;
5458: }
1.795 www 5459:
1.424 albertel 5460: table.LC_group_priv_box {
5461: background: white;
5462: border: 1px solid black;
5463: border-spacing: 1px;
5464: }
1.795 www 5465:
1.424 albertel 5466: table.LC_group_priv_box td.LC_pick_box_title {
5467: background: $tabbg;
5468: font-weight: bold;
5469: text-align: right;
5470: width: 184px;
5471: }
1.795 www 5472:
1.424 albertel 5473: table.LC_group_priv_box td.LC_groups_fixed {
5474: background: $data_table_light;
5475: text-align: center;
5476: }
1.795 www 5477:
1.424 albertel 5478: table.LC_group_priv_box td.LC_groups_optional {
5479: background: $data_table_dark;
5480: text-align: center;
5481: }
1.795 www 5482:
1.424 albertel 5483: table.LC_group_priv_box td.LC_groups_functionality {
5484: background: $data_table_darker;
5485: text-align: center;
5486: font-weight: bold;
5487: }
1.795 www 5488:
1.424 albertel 5489: table.LC_group_priv td {
5490: text-align: left;
1.803 bisitz 5491: padding: 0;
1.424 albertel 5492: }
5493:
1.421 albertel 5494: table.LC_notify_front_page {
5495: background: white;
5496: border: 1px solid black;
5497: padding: 8px;
5498: }
1.795 www 5499:
1.421 albertel 5500: table.LC_notify_front_page td {
5501: padding: 8px;
5502: }
1.795 www 5503:
1.424 albertel 5504: .LC_navbuttons {
5505: margin: 2ex 0ex 2ex 0ex;
5506: }
1.795 www 5507:
1.423 albertel 5508: .LC_topic_bar {
5509: font-weight: bold;
5510: background: $tabbg;
1.918 wenzelju 5511: margin: 1em 0em 1em 2em;
1.805 bisitz 5512: padding: 3px;
1.918 wenzelju 5513: font-size: 1.2em;
1.423 albertel 5514: }
1.795 www 5515:
1.423 albertel 5516: .LC_topic_bar span {
1.918 wenzelju 5517: left: 0.5em;
5518: position: absolute;
1.423 albertel 5519: vertical-align: middle;
1.918 wenzelju 5520: font-size: 1.2em;
1.423 albertel 5521: }
1.795 www 5522:
1.423 albertel 5523: .LC_topic_bar img {
5524: vertical-align: bottom;
5525: }
1.795 www 5526:
1.423 albertel 5527: table.LC_course_group_status {
5528: margin: 20px;
5529: }
1.795 www 5530:
1.423 albertel 5531: table.LC_status_selector td {
5532: vertical-align: top;
5533: text-align: center;
1.424 albertel 5534: padding: 4px;
5535: }
1.795 www 5536:
1.599 albertel 5537: div.LC_feedback_link {
1.616 albertel 5538: clear: both;
1.829 kalberla 5539: background: $sidebg;
1.779 bisitz 5540: width: 100%;
1.829 kalberla 5541: padding-bottom: 10px;
5542: border: 1px $tabbg solid;
1.833 kalberla 5543: height: 22px;
5544: line-height: 22px;
5545: padding-top: 5px;
5546: }
5547:
5548: div.LC_feedback_link img {
5549: height: 22px;
1.867 kalberla 5550: vertical-align:middle;
1.829 kalberla 5551: }
5552:
1.911 bisitz 5553: div.LC_feedback_link a {
1.829 kalberla 5554: text-decoration: none;
1.489 raeburn 5555: }
1.795 www 5556:
1.867 kalberla 5557: div.LC_comblock {
1.911 bisitz 5558: display:inline;
1.867 kalberla 5559: color:$font;
5560: font-size:90%;
5561: }
5562:
5563: div.LC_feedback_link div.LC_comblock {
5564: padding-left:5px;
5565: }
5566:
5567: div.LC_feedback_link div.LC_comblock a {
5568: color:$font;
5569: }
5570:
1.489 raeburn 5571: span.LC_feedback_link {
1.858 bisitz 5572: /* background: $feedback_link_bg; */
1.599 albertel 5573: font-size: larger;
5574: }
1.795 www 5575:
1.599 albertel 5576: span.LC_message_link {
1.858 bisitz 5577: /* background: $feedback_link_bg; */
1.599 albertel 5578: font-size: larger;
5579: position: absolute;
5580: right: 1em;
1.489 raeburn 5581: }
1.421 albertel 5582:
1.515 albertel 5583: table.LC_prior_tries {
1.524 albertel 5584: border: 1px solid #000000;
5585: border-collapse: separate;
5586: border-spacing: 1px;
1.515 albertel 5587: }
1.523 albertel 5588:
1.515 albertel 5589: table.LC_prior_tries td {
1.524 albertel 5590: padding: 2px;
1.515 albertel 5591: }
1.523 albertel 5592:
5593: .LC_answer_correct {
1.795 www 5594: background: lightgreen;
5595: color: darkgreen;
5596: padding: 6px;
1.523 albertel 5597: }
1.795 www 5598:
1.523 albertel 5599: .LC_answer_charged_try {
1.797 www 5600: background: #FFAAAA;
1.795 www 5601: color: darkred;
5602: padding: 6px;
1.523 albertel 5603: }
1.795 www 5604:
1.779 bisitz 5605: .LC_answer_not_charged_try,
1.523 albertel 5606: .LC_answer_no_grade,
5607: .LC_answer_late {
1.795 www 5608: background: lightyellow;
1.523 albertel 5609: color: black;
1.795 www 5610: padding: 6px;
1.523 albertel 5611: }
1.795 www 5612:
1.523 albertel 5613: .LC_answer_previous {
1.795 www 5614: background: lightblue;
5615: color: darkblue;
5616: padding: 6px;
1.523 albertel 5617: }
1.795 www 5618:
1.779 bisitz 5619: .LC_answer_no_message {
1.777 tempelho 5620: background: #FFFFFF;
5621: color: black;
1.795 www 5622: padding: 6px;
1.779 bisitz 5623: }
1.795 www 5624:
1.779 bisitz 5625: .LC_answer_unknown {
5626: background: orange;
5627: color: black;
1.795 www 5628: padding: 6px;
1.777 tempelho 5629: }
1.795 www 5630:
1.529 albertel 5631: span.LC_prior_numerical,
5632: span.LC_prior_string,
5633: span.LC_prior_custom,
5634: span.LC_prior_reaction,
5635: span.LC_prior_math {
1.925 bisitz 5636: font-family: $mono;
1.523 albertel 5637: white-space: pre;
5638: }
5639:
1.525 albertel 5640: span.LC_prior_string {
1.925 bisitz 5641: font-family: $mono;
1.525 albertel 5642: white-space: pre;
5643: }
5644:
1.523 albertel 5645: table.LC_prior_option {
5646: width: 100%;
5647: border-collapse: collapse;
5648: }
1.795 www 5649:
1.911 bisitz 5650: table.LC_prior_rank,
1.795 www 5651: table.LC_prior_match {
1.528 albertel 5652: border-collapse: collapse;
5653: }
1.795 www 5654:
1.528 albertel 5655: table.LC_prior_option tr td,
5656: table.LC_prior_rank tr td,
5657: table.LC_prior_match tr td {
1.524 albertel 5658: border: 1px solid #000000;
1.515 albertel 5659: }
5660:
1.855 bisitz 5661: .LC_nobreak {
1.544 albertel 5662: white-space: nowrap;
1.519 raeburn 5663: }
5664:
1.576 raeburn 5665: span.LC_cusr_emph {
5666: font-style: italic;
5667: }
5668:
1.633 raeburn 5669: span.LC_cusr_subheading {
5670: font-weight: normal;
5671: font-size: 85%;
5672: }
5673:
1.861 bisitz 5674: div.LC_docs_entry_move {
1.859 bisitz 5675: border: 1px solid #BBBBBB;
1.545 albertel 5676: background: #DDDDDD;
1.861 bisitz 5677: width: 22px;
1.859 bisitz 5678: padding: 1px;
5679: margin: 0;
1.545 albertel 5680: }
5681:
1.861 bisitz 5682: table.LC_data_table tr > td.LC_docs_entry_commands,
5683: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5684: background: #DDDDDD;
5685: font-size: x-small;
5686: }
1.795 www 5687:
1.861 bisitz 5688: .LC_docs_entry_parameter {
5689: white-space: nowrap;
5690: }
5691:
1.544 albertel 5692: .LC_docs_copy {
1.545 albertel 5693: color: #000099;
1.544 albertel 5694: }
1.795 www 5695:
1.544 albertel 5696: .LC_docs_cut {
1.545 albertel 5697: color: #550044;
1.544 albertel 5698: }
1.795 www 5699:
1.544 albertel 5700: .LC_docs_rename {
1.545 albertel 5701: color: #009900;
1.544 albertel 5702: }
1.795 www 5703:
1.544 albertel 5704: .LC_docs_remove {
1.545 albertel 5705: color: #990000;
5706: }
5707:
1.547 albertel 5708: .LC_docs_reinit_warn,
5709: .LC_docs_ext_edit {
5710: font-size: x-small;
5711: }
5712:
1.545 albertel 5713: table.LC_docs_adddocs td,
5714: table.LC_docs_adddocs th {
5715: border: 1px solid #BBBBBB;
5716: padding: 4px;
5717: background: #DDDDDD;
1.543 albertel 5718: }
5719:
1.584 albertel 5720: table.LC_sty_begin {
5721: background: #BBFFBB;
5722: }
1.795 www 5723:
1.584 albertel 5724: table.LC_sty_end {
5725: background: #FFBBBB;
5726: }
5727:
1.589 raeburn 5728: table.LC_double_column {
1.803 bisitz 5729: border-width: 0;
1.589 raeburn 5730: border-collapse: collapse;
5731: width: 100%;
5732: padding: 2px;
5733: }
5734:
5735: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5736: top: 2px;
1.589 raeburn 5737: left: 2px;
5738: width: 47%;
5739: vertical-align: top;
5740: }
5741:
5742: table.LC_double_column tr td.LC_right_col {
5743: top: 2px;
1.779 bisitz 5744: right: 2px;
1.589 raeburn 5745: width: 47%;
5746: vertical-align: top;
5747: }
5748:
1.591 raeburn 5749: div.LC_left_float {
5750: float: left;
5751: padding-right: 5%;
1.597 albertel 5752: padding-bottom: 4px;
1.591 raeburn 5753: }
5754:
5755: div.LC_clear_float_header {
1.597 albertel 5756: padding-bottom: 2px;
1.591 raeburn 5757: }
5758:
5759: div.LC_clear_float_footer {
1.597 albertel 5760: padding-top: 10px;
1.591 raeburn 5761: clear: both;
5762: }
5763:
1.597 albertel 5764: div.LC_grade_show_user {
5765: margin-top: 20px;
5766: border: 1px solid black;
5767: }
1.795 www 5768:
1.597 albertel 5769: div.LC_grade_user_name {
5770: background: #DDDDEE;
5771: border-bottom: 1px solid black;
1.705 tempelho 5772: font-weight: bold;
5773: font-size: large;
1.597 albertel 5774: }
1.795 www 5775:
1.597 albertel 5776: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5777: background: #DDEEDD;
5778: }
5779:
5780: div.LC_grade_show_problem,
5781: div.LC_grade_submissions,
5782: div.LC_grade_message_center,
5783: div.LC_grade_info_links,
5784: div.LC_grade_assign {
5785: margin: 5px;
5786: width: 99%;
5787: background: #FFFFFF;
5788: }
1.795 www 5789:
1.597 albertel 5790: div.LC_grade_show_problem_header,
5791: div.LC_grade_submissions_header,
5792: div.LC_grade_message_center_header,
5793: div.LC_grade_assign_header {
1.705 tempelho 5794: font-weight: bold;
5795: font-size: large;
1.597 albertel 5796: }
1.795 www 5797:
1.597 albertel 5798: div.LC_grade_show_problem_problem,
5799: div.LC_grade_submissions_body,
5800: div.LC_grade_message_center_body,
5801: div.LC_grade_assign_body {
5802: border: 1px solid black;
5803: width: 99%;
5804: background: #FFFFFF;
5805: }
1.795 www 5806:
1.598 albertel 5807: span.LC_grade_check_note {
1.705 tempelho 5808: font-weight: normal;
5809: font-size: medium;
1.598 albertel 5810: display: inline;
5811: position: absolute;
5812: right: 1em;
5813: }
1.597 albertel 5814:
1.613 albertel 5815: table.LC_scantron_action {
5816: width: 100%;
5817: }
1.795 www 5818:
1.613 albertel 5819: table.LC_scantron_action tr th {
1.698 harmsja 5820: font-weight:bold;
5821: font-style:normal;
1.613 albertel 5822: }
1.795 www 5823:
1.779 bisitz 5824: .LC_edit_problem_header,
1.614 albertel 5825: div.LC_edit_problem_footer {
1.705 tempelho 5826: font-weight: normal;
5827: font-size: medium;
1.602 albertel 5828: margin: 2px;
1.600 albertel 5829: }
1.795 www 5830:
1.600 albertel 5831: div.LC_edit_problem_header,
1.602 albertel 5832: div.LC_edit_problem_header div,
1.614 albertel 5833: div.LC_edit_problem_footer,
5834: div.LC_edit_problem_footer div,
1.602 albertel 5835: div.LC_edit_problem_editxml_header,
5836: div.LC_edit_problem_editxml_header div {
1.600 albertel 5837: margin-top: 5px;
5838: }
1.795 www 5839:
1.600 albertel 5840: div.LC_edit_problem_header_title {
1.705 tempelho 5841: font-weight: bold;
5842: font-size: larger;
1.602 albertel 5843: background: $tabbg;
5844: padding: 3px;
5845: }
1.795 www 5846:
1.602 albertel 5847: table.LC_edit_problem_header_title {
1.705 tempelho 5848: font-size: larger;
5849: font-weight: bold;
1.602 albertel 5850: width: 100%;
5851: border-color: $pgbg;
5852: border-style: solid;
5853: border-width: $border;
1.600 albertel 5854: background: $tabbg;
1.602 albertel 5855: border-collapse: collapse;
1.803 bisitz 5856: padding: 0;
1.602 albertel 5857: }
5858:
5859: div.LC_edit_problem_discards {
5860: float: left;
5861: padding-bottom: 5px;
5862: }
1.795 www 5863:
1.602 albertel 5864: div.LC_edit_problem_saves {
5865: float: right;
5866: padding-bottom: 5px;
1.600 albertel 5867: }
1.795 www 5868:
1.911 bisitz 5869: img.stift {
1.803 bisitz 5870: border-width: 0;
5871: vertical-align: middle;
1.677 riegler 5872: }
1.680 riegler 5873:
1.923 bisitz 5874: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5875: vertical-align: top;
1.777 tempelho 5876: }
1.795 www 5877:
1.716 raeburn 5878: div.LC_createcourse {
1.911 bisitz 5879: margin: 10px 10px 10px 10px;
1.716 raeburn 5880: }
5881:
1.917 raeburn 5882: .LC_dccid {
5883: margin: 0.2em 0 0 0;
5884: padding: 0;
5885: font-size: 90%;
5886: display:none;
5887: }
5888:
1.693 droeschl 5889: /* ---- Remove when done ----
5890: # The following styles is part of the redesign of LON-CAPA and are
5891: # subject to change during this project.
5892: # Don't rely on their current functionality as they might be
5893: # changed or removed.
5894: # --------------------------*/
5895:
1.698 harmsja 5896: a:hover,
1.897 wenzelju 5897: ol.LC_primary_menu a:hover,
1.721 harmsja 5898: ol#LC_MenuBreadcrumbs a:hover,
5899: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5900: ul#LC_secondary_menu a:hover,
1.721 harmsja 5901: .LC_FormSectionClearButton input:hover
1.795 www 5902: ul.LC_TabContent li:hover a {
1.911 bisitz 5903: color:#BF2317;
5904: text-decoration:none;
1.693 droeschl 5905: }
5906:
1.779 bisitz 5907: h1 {
1.911 bisitz 5908: padding: 0;
5909: line-height:130%;
1.693 droeschl 5910: }
1.698 harmsja 5911:
1.911 bisitz 5912: h2,
5913: h3,
5914: h4,
5915: h5,
5916: h6 {
5917: margin: 5px 0 5px 0;
5918: padding: 0;
5919: line-height:130%;
1.693 droeschl 5920: }
1.795 www 5921:
5922: .LC_hcell {
1.911 bisitz 5923: padding:3px 15px 3px 15px;
5924: margin: 0;
5925: background-color:$tabbg;
5926: color:$fontmenu;
5927: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5928: }
1.795 www 5929:
1.840 bisitz 5930: .LC_Box > .LC_hcell {
1.911 bisitz 5931: margin: 0 -10px 10px -10px;
1.835 bisitz 5932: }
5933:
1.721 harmsja 5934: .LC_noBorder {
1.911 bisitz 5935: border: 0;
1.698 harmsja 5936: }
1.693 droeschl 5937:
1.721 harmsja 5938: .LC_FormSectionClearButton input {
1.911 bisitz 5939: background-color:transparent;
5940: border: none;
5941: cursor:pointer;
5942: text-decoration:underline;
1.693 droeschl 5943: }
1.763 bisitz 5944:
5945: .LC_help_open_topic {
1.911 bisitz 5946: color: #FFFFFF;
5947: background-color: #EEEEFF;
5948: margin: 1px;
5949: padding: 4px;
5950: border: 1px solid #000033;
5951: white-space: nowrap;
5952: /* vertical-align: middle; */
1.759 neumanie 5953: }
1.693 droeschl 5954:
1.911 bisitz 5955: dl,
5956: ul,
5957: div,
5958: fieldset {
5959: margin: 10px 10px 10px 0;
5960: /* overflow: hidden; */
1.693 droeschl 5961: }
1.795 www 5962:
1.838 bisitz 5963: fieldset > legend {
1.911 bisitz 5964: font-weight: bold;
5965: padding: 0 5px 0 5px;
1.838 bisitz 5966: }
5967:
1.813 bisitz 5968: #LC_nav_bar {
1.911 bisitz 5969: float: left;
5970: margin: 0.2em 0 0 0;
1.807 droeschl 5971: }
5972:
1.916 droeschl 5973: #LC_realm {
5974: margin: 0.2em 0 0 0;
5975: padding: 0;
5976: font-weight: bold;
5977: text-align: center;
5978: }
5979:
1.911 bisitz 5980: #LC_nav_bar em {
5981: font-weight: bold;
5982: font-style: normal;
1.807 droeschl 5983: }
5984:
1.897 wenzelju 5985: ol.LC_primary_menu {
1.911 bisitz 5986: float: right;
5987: margin: 0.2em 0 0 0;
1.807 droeschl 5988: }
5989:
1.852 droeschl 5990: ol#LC_PathBreadcrumbs {
1.911 bisitz 5991: margin: 0;
1.693 droeschl 5992: }
5993:
1.897 wenzelju 5994: ol.LC_primary_menu li {
1.911 bisitz 5995: display: inline;
5996: padding: 5px 5px 0 10px;
5997: vertical-align: top;
1.693 droeschl 5998: }
5999:
1.897 wenzelju 6000: ol.LC_primary_menu li img {
1.911 bisitz 6001: vertical-align: bottom;
1.693 droeschl 6002: }
6003:
1.897 wenzelju 6004: ol.LC_primary_menu a {
1.911 bisitz 6005: font-size: 90%;
6006: color: RGB(80, 80, 80);
6007: text-decoration: none;
1.693 droeschl 6008: }
1.795 www 6009:
1.897 wenzelju 6010: ul#LC_secondary_menu {
1.911 bisitz 6011: clear: both;
6012: color: $fontmenu;
6013: background: $tabbg;
6014: list-style: none;
6015: padding: 0;
6016: margin: 0;
6017: width: 100%;
1.808 droeschl 6018: }
6019:
1.897 wenzelju 6020: ul#LC_secondary_menu li {
1.911 bisitz 6021: font-weight: bold;
6022: line-height: 1.8em;
6023: padding: 0 0.8em;
6024: border-right: 1px solid black;
6025: display: inline;
6026: vertical-align: middle;
1.807 droeschl 6027: }
6028:
1.847 tempelho 6029: ul.LC_TabContent {
1.911 bisitz 6030: display:block;
6031: background: $sidebg;
6032: border-bottom: solid 1px $lg_border_color;
6033: list-style:none;
6034: margin: 0 -10px;
6035: padding: 0;
1.693 droeschl 6036: }
6037:
1.795 www 6038: ul.LC_TabContent li,
6039: ul.LC_TabContentBigger li {
1.911 bisitz 6040: float:left;
1.741 harmsja 6041: }
1.795 www 6042:
1.897 wenzelju 6043: ul#LC_secondary_menu li a {
1.911 bisitz 6044: color: $fontmenu;
6045: text-decoration: none;
1.693 droeschl 6046: }
1.795 www 6047:
1.721 harmsja 6048: ul.LC_TabContent {
1.911 bisitz 6049: min-height:1.5em;
1.721 harmsja 6050: }
1.795 www 6051:
6052: ul.LC_TabContent li {
1.911 bisitz 6053: vertical-align:middle;
6054: padding: 0 10px 0 10px;
6055: background-color:$tabbg;
6056: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6057: }
1.795 www 6058:
1.847 tempelho 6059: ul.LC_TabContent .right {
1.911 bisitz 6060: float:right;
1.847 tempelho 6061: }
6062:
1.911 bisitz 6063: ul.LC_TabContent li a,
6064: ul.LC_TabContent li {
6065: color:rgb(47,47,47);
6066: text-decoration:none;
6067: font-size:95%;
6068: font-weight:bold;
6069: padding-right: 16px;
1.721 harmsja 6070: }
1.795 www 6071:
1.911 bisitz 6072: ul.LC_TabContent li:hover,
6073: ul.LC_TabContent li.active {
6074: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6075: border-bottom:solid 2px #FFFFFF;
6076: padding-right: 16px;
1.744 ehlerst 6077: }
1.795 www 6078:
1.870 tempelho 6079: #maincoursedoc {
1.911 bisitz 6080: clear:both;
1.870 tempelho 6081: }
6082:
6083: ul.LC_TabContentBigger {
1.911 bisitz 6084: display:block;
6085: list-style:none;
6086: padding: 0;
1.870 tempelho 6087: }
6088:
1.795 www 6089: ul.LC_TabContentBigger li {
1.911 bisitz 6090: vertical-align:bottom;
6091: height: 30px;
6092: font-size:110%;
6093: font-weight:bold;
6094: color: #737373;
1.841 tempelho 6095: }
6096:
1.870 tempelho 6097:
6098: ul.LC_TabContentBigger li a {
1.911 bisitz 6099: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6100: height: 30px;
6101: line-height: 30px;
6102: text-align: center;
6103: display: block;
6104: text-decoration: none;
1.741 harmsja 6105: }
1.795 www 6106:
1.911 bisitz 6107: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6108: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6109: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6110: color:$font;
6111: text-decoration: underline;
1.744 ehlerst 6112: }
1.795 www 6113:
1.870 tempelho 6114:
6115: ul.LC_TabContentBigger li b {
1.911 bisitz 6116: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6117: display: block;
6118: float: left;
6119: padding: 0 30px;
1.870 tempelho 6120: }
6121:
6122: ul.LC_TabContentBigger li:hover b,
6123: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6124: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6125: color:$font;
6126: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6127: }
1.693 droeschl 6128:
1.870 tempelho 6129:
1.862 bisitz 6130: ul.LC_CourseBreadcrumbs {
6131: background: $sidebg;
6132: line-height: 32px;
6133: padding-left: 10px;
6134: margin: 0 0 10px 0;
6135: list-style-position: inside;
6136:
6137: }
6138:
1.911 bisitz 6139: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6140: ol#LC_PathBreadcrumbs {
1.911 bisitz 6141: padding-left: 10px;
6142: margin: 0;
6143: list-style-position: inside;
1.915 droeschl 6144: /* SD working here
1.904 droeschl 6145: white-space: nowrap; */
1.693 droeschl 6146: }
6147:
1.911 bisitz 6148: ol#LC_MenuBreadcrumbs li,
6149: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6150: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6151: display: inline;
6152: white-space: nowrap;
1.915 droeschl 6153: /* SD working here
6154: white-space: normal; */
1.693 droeschl 6155: }
6156:
1.823 bisitz 6157: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6158: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6159: text-decoration: none;
6160: font-size:90%;
1.693 droeschl 6161: }
1.795 www 6162:
6163: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6164: text-decoration:none;
6165: font-size:100%;
6166: font-weight:bold;
1.693 droeschl 6167: }
1.795 www 6168:
1.840 bisitz 6169: .LC_Box {
1.911 bisitz 6170: border: solid 1px $lg_border_color;
6171: padding: 0 10px 10px 10px;
1.746 neumanie 6172: }
1.795 www 6173:
6174: .LC_AboutMe_Image {
1.911 bisitz 6175: float:left;
6176: margin-right:10px;
1.747 neumanie 6177: }
1.795 www 6178:
6179: .LC_Clear_AboutMe_Image {
1.911 bisitz 6180: clear:left;
1.747 neumanie 6181: }
1.795 www 6182:
1.721 harmsja 6183: dl.LC_ListStyleClean dt {
1.911 bisitz 6184: padding-right: 5px;
6185: display: table-header-group;
1.693 droeschl 6186: }
6187:
1.721 harmsja 6188: dl.LC_ListStyleClean dd {
1.911 bisitz 6189: display: table-row;
1.693 droeschl 6190: }
6191:
1.721 harmsja 6192: .LC_ListStyleClean,
6193: .LC_ListStyleSimple,
6194: .LC_ListStyleNormal,
1.795 www 6195: .LC_ListStyleSpecial {
1.911 bisitz 6196: /* display:block; */
6197: list-style-position: inside;
6198: list-style-type: none;
6199: overflow: hidden;
6200: padding: 0;
1.693 droeschl 6201: }
6202:
1.721 harmsja 6203: .LC_ListStyleSimple li,
6204: .LC_ListStyleSimple dd,
6205: .LC_ListStyleNormal li,
6206: .LC_ListStyleNormal dd,
6207: .LC_ListStyleSpecial li,
1.795 www 6208: .LC_ListStyleSpecial dd {
1.911 bisitz 6209: margin: 0;
6210: padding: 5px 5px 5px 10px;
6211: clear: both;
1.693 droeschl 6212: }
6213:
1.721 harmsja 6214: .LC_ListStyleClean li,
6215: .LC_ListStyleClean dd {
1.911 bisitz 6216: padding-top: 0;
6217: padding-bottom: 0;
1.693 droeschl 6218: }
6219:
1.721 harmsja 6220: .LC_ListStyleSimple dd,
1.795 www 6221: .LC_ListStyleSimple li {
1.911 bisitz 6222: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6223: }
6224:
1.721 harmsja 6225: .LC_ListStyleSpecial li,
6226: .LC_ListStyleSpecial dd {
1.911 bisitz 6227: list-style-type: none;
6228: background-color: RGB(220, 220, 220);
6229: margin-bottom: 4px;
1.693 droeschl 6230: }
6231:
1.721 harmsja 6232: table.LC_SimpleTable {
1.911 bisitz 6233: margin:5px;
6234: border:solid 1px $lg_border_color;
1.795 www 6235: }
1.693 droeschl 6236:
1.721 harmsja 6237: table.LC_SimpleTable tr {
1.911 bisitz 6238: padding: 0;
6239: border:solid 1px $lg_border_color;
1.693 droeschl 6240: }
1.795 www 6241:
6242: table.LC_SimpleTable thead {
1.911 bisitz 6243: background:rgb(220,220,220);
1.693 droeschl 6244: }
6245:
1.721 harmsja 6246: div.LC_columnSection {
1.911 bisitz 6247: display: block;
6248: clear: both;
6249: overflow: hidden;
6250: margin: 0;
1.693 droeschl 6251: }
6252:
1.721 harmsja 6253: div.LC_columnSection>* {
1.911 bisitz 6254: float: left;
6255: margin: 10px 20px 10px 0;
6256: overflow:hidden;
1.693 droeschl 6257: }
1.721 harmsja 6258:
1.694 tempelho 6259: .LC_loginpage_container {
1.911 bisitz 6260: text-align:left;
6261: margin : 0 auto;
6262: width:90%;
6263: padding: 10px;
6264: height: auto;
6265: background-color:#FFFFFF;
6266: border:1px solid #CCCCCC;
1.694 tempelho 6267: }
6268:
6269:
6270: .LC_loginpage_loginContainer {
1.911 bisitz 6271: float:left;
6272: width: 182px;
6273: padding: 2px;
6274: border:1px solid #CCCCCC;
6275: background-color:$loginbg;
1.694 tempelho 6276: }
6277:
1.795 www 6278: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6279: margin-top: 0;
6280: display:block;
6281: background:$bgcol;
6282: color:$textcol;
6283: padding-left:5px;
1.712 muellerd 6284: }
1.785 tempelho 6285:
1.694 tempelho 6286: .LC_loginpage_loginInfo {
1.911 bisitz 6287: float:left;
6288: width:182px;
6289: border:1px solid #CCCCCC;
6290: padding:2px;
1.712 muellerd 6291: }
6292:
1.694 tempelho 6293: .LC_loginpage_space {
1.911 bisitz 6294: clear: both;
6295: margin-bottom: 20px;
6296: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6297: }
6298:
1.785 tempelho 6299: .LC_loginpage_floatLeft {
1.911 bisitz 6300: float: left;
6301: width: 200px;
6302: margin: 0;
1.785 tempelho 6303: }
6304:
1.795 www 6305: table em {
1.911 bisitz 6306: font-weight: bold;
6307: font-style: normal;
1.748 schulted 6308: }
1.795 www 6309:
1.779 bisitz 6310: table.LC_tableBrowseRes,
1.795 www 6311: table.LC_tableOfContent {
1.911 bisitz 6312: border:none;
6313: border-spacing: 1px;
6314: padding: 3px;
6315: background-color: #FFFFFF;
6316: font-size: 90%;
1.753 droeschl 6317: }
1.789 droeschl 6318:
1.911 bisitz 6319: table.LC_tableOfContent {
6320: border-collapse: collapse;
1.789 droeschl 6321: }
6322:
1.771 droeschl 6323: table.LC_tableBrowseRes a,
1.768 schulted 6324: table.LC_tableOfContent a {
1.911 bisitz 6325: background-color: transparent;
6326: text-decoration: none;
1.753 droeschl 6327: }
6328:
1.795 www 6329: table.LC_tableOfContent img {
1.911 bisitz 6330: border: none;
6331: height: 1.3em;
6332: vertical-align: text-bottom;
6333: margin-right: 0.3em;
1.753 droeschl 6334: }
1.757 schulted 6335:
1.795 www 6336: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6337: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6338: }
6339:
1.795 www 6340: a#LC_content_toolbar_launchnav {
1.911 bisitz 6341: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6342: }
6343:
1.795 www 6344: a#LC_content_toolbar_closenav {
1.911 bisitz 6345: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6346: }
6347:
1.795 www 6348: a#LC_content_toolbar_everything {
1.911 bisitz 6349: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6350: }
6351:
1.795 www 6352: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6353: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6354: }
6355:
1.795 www 6356: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6357: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6358: }
6359:
1.795 www 6360: a#LC_content_toolbar_changefolder {
1.911 bisitz 6361: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6362: }
6363:
1.795 www 6364: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6365: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6366: }
6367:
1.795 www 6368: ul#LC_toolbar li a:hover {
1.911 bisitz 6369: background-position: bottom center;
1.757 schulted 6370: }
6371:
1.795 www 6372: ul#LC_toolbar {
1.911 bisitz 6373: padding: 0;
6374: margin: 2px;
6375: list-style:none;
6376: position:relative;
6377: background-color:white;
1.757 schulted 6378: }
6379:
1.795 www 6380: ul#LC_toolbar li {
1.911 bisitz 6381: border:1px solid white;
6382: padding: 0;
6383: margin: 0;
6384: float: left;
6385: display:inline;
6386: vertical-align:middle;
6387: }
1.757 schulted 6388:
1.783 amueller 6389:
1.795 www 6390: a.LC_toolbarItem {
1.911 bisitz 6391: display:block;
6392: padding: 0;
6393: margin: 0;
6394: height: 32px;
6395: width: 32px;
6396: color:white;
6397: border: none;
6398: background-repeat:no-repeat;
6399: background-color:transparent;
1.757 schulted 6400: }
6401:
1.915 droeschl 6402: ul.LC_funclist {
6403: margin: 0;
6404: padding: 0.5em 1em 0.5em 0;
6405: }
6406:
6407: ul.LC_funclist + ul.LC_funclist {
6408: /*
6409: left border as a seperator if we have more than
6410: one list
6411: */
6412: border-left: 1px solid $sidebg;
6413: /*
6414: this hides the left border behind the border of the
6415: outer box if element is wrapped to the next 'line'
6416: */
6417: margin-left: -1px;
6418: }
6419:
1.843 bisitz 6420: ul.LC_funclist li {
1.915 droeschl 6421: display: inline;
1.782 bisitz 6422: white-space: nowrap;
1.915 droeschl 6423: margin: 0 0 0 25px;
6424: line-height: 150%;
1.782 bisitz 6425: }
6426:
1.925.2.1 raeburn 6427: #gciheader {
6428: float:left;
6429: width:100%;
6430: background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
6431: font-size:93%;
6432: line-height:normal;
6433: }
6434: #gciheader ul {
6435: margin:0;
6436: padding:10px 10px 0;
6437: list-style:none;
6438: }
6439: #gciheader li {
6440: float:left;
6441: background:url("/gcimenu_left.gif") no-repeat left top;
6442: margin:0;
6443: padding:0 0 0 9px;
6444: }
6445: #gciheader a {
6446: display:block;
6447: background:url("/gcimenu_right.gif") no-repeat right top;
6448: padding:5px 15px 4px 6px;
6449: }
6450: #gciheader #current {
6451: background-image:url("/gcimenu_left_on.gif");
6452: }
6453: #gciheader #current a {
6454: background-image:url("/gcimenu_right_on.gif");
6455: padding-bottom:5px;
6456: }
1.757 schulted 6457:
1.343 albertel 6458: END
6459: }
6460:
1.306 albertel 6461: =pod
6462:
6463: =item * &headtag()
6464:
6465: Returns a uniform footer for LON-CAPA web pages.
6466:
1.307 albertel 6467: Inputs: $title - optional title for the head
6468: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6469: $args - optional arguments
1.319 albertel 6470: force_register - if is true call registerurl so the remote is
6471: informed
1.415 albertel 6472: redirect -> array ref of
6473: 1- seconds before redirect occurs
6474: 2- url to redirect to
6475: 3- whether the side effect should occur
1.315 albertel 6476: (side effect of setting
6477: $env{'internal.head.redirect'} to the url
6478: redirected too)
1.352 albertel 6479: domain -> force to color decorate a page for a specific
6480: domain
6481: function -> force usage of a specific rolish color scheme
6482: bgcolor -> override the default page bgcolor
1.460 albertel 6483: no_auto_mt_title
6484: -> prevent &mt()ing the title arg
1.464 albertel 6485:
1.306 albertel 6486: =cut
6487:
6488: sub headtag {
1.313 albertel 6489: my ($title,$head_extra,$args) = @_;
1.306 albertel 6490:
1.363 albertel 6491: my $function = $args->{'function'} || &get_users_function();
6492: my $domain = $args->{'domain'} || &determinedomain();
6493: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6494: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6495: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6496: #time(),
1.418 albertel 6497: $env{'environment.color.timestamp'},
1.363 albertel 6498: $function,$domain,$bgcolor);
6499:
1.369 www 6500: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6501:
1.308 albertel 6502: my $result =
6503: '<head>'.
1.461 albertel 6504: &font_settings();
1.319 albertel 6505:
1.461 albertel 6506: if (!$args->{'frameset'}) {
6507: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6508: }
1.319 albertel 6509: if ($args->{'force_register'}) {
6510: $result .= &Apache::lonmenu::registerurl(1);
6511: }
1.436 albertel 6512: if (!$args->{'no_nav_bar'}
6513: && !$args->{'only_body'}
6514: && !$args->{'frameset'}) {
6515: $result .= &help_menu_js();
6516: }
1.319 albertel 6517:
1.314 albertel 6518: if (ref($args->{'redirect'})) {
1.414 albertel 6519: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6520: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6521: if (!$inhibit_continue) {
6522: $env{'internal.head.redirect'} = $url;
6523: }
1.313 albertel 6524: $result.=<<ADDMETA
6525: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6526: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6527: ADDMETA
6528: }
1.306 albertel 6529: if (!defined($title)) {
6530: $title = 'The LearningOnline Network with CAPA';
6531: }
1.460 albertel 6532: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6533: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6534: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6535: .$head_extra;
1.306 albertel 6536: return $result;
6537: }
6538:
6539: =pod
6540:
1.340 albertel 6541: =item * &font_settings()
6542:
6543: Returns neccessary <meta> to set the proper encoding
6544:
6545: Inputs: none
6546:
6547: =cut
6548:
6549: sub font_settings {
6550: my $headerstring='';
1.647 www 6551: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6552: $headerstring.=
6553: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6554: }
6555: return $headerstring;
6556: }
6557:
1.341 albertel 6558: =pod
6559:
6560: =item * &xml_begin()
6561:
6562: Returns the needed doctype and <html>
6563:
6564: Inputs: none
6565:
6566: =cut
6567:
6568: sub xml_begin {
6569: my $output='';
6570:
1.592 albertel 6571: if ($env{'internal.start_page'}==1) {
6572: &Apache::lonhtmlcommon::init_htmlareafields();
6573: }
1.342 albertel 6574:
1.341 albertel 6575: if ($env{'browser.mathml'}) {
6576: $output='<?xml version="1.0"?>'
6577: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6578: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6579:
6580: # .'<!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">] >'
6581: .'<!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">'
6582: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6583: .'xmlns="http://www.w3.org/1999/xhtml">';
6584: } else {
1.849 bisitz 6585: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6586: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6587: }
6588: return $output;
6589: }
1.340 albertel 6590:
6591: =pod
6592:
1.306 albertel 6593: =item * &endheadtag()
6594:
6595: Returns a uniform </head> for LON-CAPA web pages.
6596:
6597: Inputs: none
6598:
6599: =cut
6600:
6601: sub endheadtag {
6602: return '</head>';
6603: }
6604:
6605: =pod
6606:
6607: =item * &head()
6608:
6609: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6610:
1.648 raeburn 6611: Inputs:
6612:
6613: =over 4
6614:
6615: $title - optional title for the page
6616:
6617: $head_extra - optional extra HTML to put inside the <head>
6618:
6619: =back
1.405 albertel 6620:
1.306 albertel 6621: =cut
6622:
6623: sub head {
1.325 albertel 6624: my ($title,$head_extra,$args) = @_;
6625: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6626: }
6627:
6628: =pod
6629:
6630: =item * &start_page()
6631:
6632: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6633:
1.648 raeburn 6634: Inputs:
6635:
6636: =over 4
6637:
6638: $title - optional title for the page
6639:
6640: $head_extra - optional extra HTML to incude inside the <head>
6641:
6642: $args - additional optional args supported are:
6643:
6644: =over 8
6645:
6646: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6647: arg on
1.814 bisitz 6648: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6649: add_entries -> additional attributes to add to the <body>
6650: domain -> force to color decorate a page for a
1.317 albertel 6651: specific domain
1.648 raeburn 6652: function -> force usage of a specific rolish color
1.317 albertel 6653: scheme
1.648 raeburn 6654: redirect -> see &headtag()
6655: bgcolor -> override the default page bg color
6656: js_ready -> return a string ready for being used in
1.317 albertel 6657: a javascript writeln
1.648 raeburn 6658: html_encode -> return a string ready for being used in
1.320 albertel 6659: a html attribute
1.648 raeburn 6660: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6661: $forcereg arg
1.648 raeburn 6662: frameset -> if true will start with a <frameset>
1.330 albertel 6663: rather than <body>
1.648 raeburn 6664: skip_phases -> hash ref of
1.338 albertel 6665: head -> skip the <html><head> generation
6666: body -> skip all <body> generation
1.648 raeburn 6667: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6668: 'Switch To Inline Menu' link
1.648 raeburn 6669: no_auto_mt_title -> prevent &mt()ing the title arg
6670: inherit_jsmath -> when creating popup window in a page,
6671: should it have jsmath forced on by the
6672: current page
1.867 kalberla 6673: bread_crumbs -> Array containing breadcrumbs
6674: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6675:
1.648 raeburn 6676: =back
1.460 albertel 6677:
1.648 raeburn 6678: =back
1.562 albertel 6679:
1.306 albertel 6680: =cut
6681:
6682: sub start_page {
1.309 albertel 6683: my ($title,$head_extra,$args) = @_;
1.318 albertel 6684: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6685: my %head_args;
1.352 albertel 6686: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6687: 'bgcolor','frameset','no_nav_bar','only_body',
6688: 'no_auto_mt_title') {
1.319 albertel 6689: if (defined($args->{$arg})) {
1.324 raeburn 6690: $head_args{$arg} = $args->{$arg};
1.319 albertel 6691: }
1.313 albertel 6692: }
1.319 albertel 6693:
1.315 albertel 6694: $env{'internal.start_page'}++;
1.338 albertel 6695: my $result;
6696: if (! exists($args->{'skip_phases'}{'head'}) ) {
6697: $result.=
1.341 albertel 6698: &xml_begin().
1.338 albertel 6699: &headtag($title,$head_extra,\%head_args).&endheadtag();
6700: }
6701:
6702: if (! exists($args->{'skip_phases'}{'body'}) ) {
6703: if ($args->{'frameset'}) {
6704: my $attr_string = &make_attr_string($args->{'force_register'},
6705: $args->{'add_entries'});
6706: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6707: } else {
6708: $result .=
6709: &bodytag($title,
6710: $args->{'function'}, $args->{'add_entries'},
6711: $args->{'only_body'}, $args->{'domain'},
6712: $args->{'force_register'}, $args->{'no_nav_bar'},
6713: $args->{'bgcolor'}, $args->{'no_inline_link'},
6714: $args);
6715: }
1.330 albertel 6716: }
1.338 albertel 6717:
1.315 albertel 6718: if ($args->{'js_ready'}) {
1.713 kaisler 6719: $result = &js_ready($result);
1.315 albertel 6720: }
1.320 albertel 6721: if ($args->{'html_encode'}) {
1.713 kaisler 6722: $result = &html_encode($result);
6723: }
6724:
1.813 bisitz 6725: # Preparation for new and consistent functionlist at top of screen
6726: # if ($args->{'functionlist'}) {
6727: # $result .= &build_functionlist();
6728: #}
6729:
6730: # Don't add anything more if only_body wanted
6731: return $result if $args->{'only_body'};
6732:
1.920 raeburn 6733: #Breadcrumbs for Construction Space provided by &bodytag.
6734: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6735: return $result;
6736: }
6737:
1.813 bisitz 6738: #Breadcrumbs
1.758 kaisler 6739: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6740: &Apache::lonhtmlcommon::clear_breadcrumbs();
6741: #if any br links exists, add them to the breadcrumbs
6742: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6743: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6744: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6745: }
6746: }
6747:
6748: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6749: if(exists($args->{'bread_crumbs_component'})){
6750: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6751: }else{
6752: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6753: }
1.320 albertel 6754: }
1.315 albertel 6755: return $result;
1.306 albertel 6756: }
6757:
1.330 albertel 6758:
1.306 albertel 6759: =pod
6760:
6761: =item * &head()
6762:
6763: Returns a complete </body></html> section for LON-CAPA web pages.
6764:
1.315 albertel 6765: Inputs: $args - additional optional args supported are:
6766: js_ready -> return a string ready for being used in
6767: a javascript writeln
1.320 albertel 6768: html_encode -> return a string ready for being used in
6769: a html attribute
1.330 albertel 6770: frameset -> if true will start with a <frameset>
6771: rather than <body>
1.493 albertel 6772: dicsussion -> if true will get discussion from
6773: lonxml::xmlend
6774: (you can pass the target and parser arguments
6775: through optional 'target' and 'parser' args
6776: to this routine)
1.306 albertel 6777:
6778: =cut
6779:
6780: sub end_page {
1.315 albertel 6781: my ($args) = @_;
6782: $env{'internal.end_page'}++;
1.330 albertel 6783: my $result;
1.335 albertel 6784: if ($args->{'discussion'}) {
6785: my ($target,$parser);
6786: if (ref($args->{'discussion'})) {
6787: ($target,$parser) =($args->{'discussion'}{'target'},
6788: $args->{'discussion'}{'parser'});
6789: }
6790: $result .= &Apache::lonxml::xmlend($target,$parser);
6791: }
6792:
1.330 albertel 6793: if ($args->{'frameset'}) {
6794: $result .= '</frameset>';
6795: } else {
1.635 raeburn 6796: $result .= &endbodytag($args);
1.330 albertel 6797: }
6798: $result .= "\n</html>";
6799:
1.315 albertel 6800: if ($args->{'js_ready'}) {
1.317 albertel 6801: $result = &js_ready($result);
1.315 albertel 6802: }
1.335 albertel 6803:
1.320 albertel 6804: if ($args->{'html_encode'}) {
6805: $result = &html_encode($result);
6806: }
1.335 albertel 6807:
1.315 albertel 6808: return $result;
6809: }
6810:
1.320 albertel 6811: sub html_encode {
6812: my ($result) = @_;
6813:
1.322 albertel 6814: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6815:
6816: return $result;
6817: }
1.317 albertel 6818: sub js_ready {
6819: my ($result) = @_;
6820:
1.323 albertel 6821: $result =~ s/[\n\r]/ /xmsg;
6822: $result =~ s/\\/\\\\/xmsg;
6823: $result =~ s/'/\\'/xmsg;
1.372 albertel 6824: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6825:
6826: return $result;
6827: }
6828:
1.315 albertel 6829: sub validate_page {
6830: if ( exists($env{'internal.start_page'})
1.316 albertel 6831: && $env{'internal.start_page'} > 1) {
6832: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6833: $env{'internal.start_page'}.' '.
1.316 albertel 6834: $ENV{'request.filename'});
1.315 albertel 6835: }
6836: if ( exists($env{'internal.end_page'})
1.316 albertel 6837: && $env{'internal.end_page'} > 1) {
6838: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6839: $env{'internal.end_page'}.' '.
1.316 albertel 6840: $env{'request.filename'});
1.315 albertel 6841: }
6842: if ( exists($env{'internal.start_page'})
6843: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6844: &Apache::lonnet::logthis('start_page called without end_page '.
6845: $env{'request.filename'});
1.315 albertel 6846: }
6847: if ( ! exists($env{'internal.start_page'})
6848: && exists($env{'internal.end_page'})) {
1.316 albertel 6849: &Apache::lonnet::logthis('end_page called without start_page'.
6850: $env{'request.filename'});
1.315 albertel 6851: }
1.306 albertel 6852: }
1.315 albertel 6853:
1.318 albertel 6854: sub simple_error_page {
6855: my ($r,$title,$msg) = @_;
6856: my $page =
6857: &Apache::loncommon::start_page($title).
6858: &mt($msg).
6859: &Apache::loncommon::end_page();
6860: if (ref($r)) {
6861: $r->print($page);
1.327 albertel 6862: return;
1.318 albertel 6863: }
6864: return $page;
6865: }
1.347 albertel 6866:
6867: {
1.610 albertel 6868: my @row_count;
1.347 albertel 6869: sub start_data_table {
1.422 albertel 6870: my ($add_class) = @_;
6871: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6872: unshift(@row_count,0);
1.422 albertel 6873: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6874: }
6875:
6876: sub end_data_table {
1.610 albertel 6877: shift(@row_count);
1.389 albertel 6878: return '</table>'."\n";;
1.347 albertel 6879: }
6880:
6881: sub start_data_table_row {
1.422 albertel 6882: my ($add_class) = @_;
1.610 albertel 6883: $row_count[0]++;
6884: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6885: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6886: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6887: }
1.471 banghart 6888:
6889: sub continue_data_table_row {
6890: my ($add_class) = @_;
1.610 albertel 6891: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6892: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6893: return '<tr class="'.$css_class.'">'."\n";;
6894: }
1.347 albertel 6895:
6896: sub end_data_table_row {
1.389 albertel 6897: return '</tr>'."\n";;
1.347 albertel 6898: }
1.367 www 6899:
1.421 albertel 6900: sub start_data_table_empty_row {
1.707 bisitz 6901: # $row_count[0]++;
1.421 albertel 6902: return '<tr class="LC_empty_row" >'."\n";;
6903: }
6904:
6905: sub end_data_table_empty_row {
6906: return '</tr>'."\n";;
6907: }
6908:
1.367 www 6909: sub start_data_table_header_row {
1.389 albertel 6910: return '<tr class="LC_header_row">'."\n";;
1.367 www 6911: }
6912:
6913: sub end_data_table_header_row {
1.389 albertel 6914: return '</tr>'."\n";;
1.367 www 6915: }
1.890 droeschl 6916:
6917: sub data_table_caption {
6918: my $caption = shift;
6919: return "<caption class=\"LC_caption\">$caption</caption>";
6920: }
1.347 albertel 6921: }
6922:
1.548 albertel 6923: =pod
6924:
6925: =item * &inhibit_menu_check($arg)
6926:
6927: Checks for a inhibitmenu state and generates output to preserve it
6928:
6929: Inputs: $arg - can be any of
6930: - undef - in which case the return value is a string
6931: to add into arguments list of a uri
6932: - 'input' - in which case the return value is a HTML
6933: <form> <input> field of type hidden to
6934: preserve the value
6935: - a url - in which case the return value is the url with
6936: the neccesary cgi args added to preserve the
6937: inhibitmenu state
6938: - a ref to a url - no return value, but the string is
6939: updated to include the neccessary cgi
6940: args to preserve the inhibitmenu state
6941:
6942: =cut
6943:
6944: sub inhibit_menu_check {
6945: my ($arg) = @_;
6946: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6947: if ($arg eq 'input') {
6948: if ($env{'form.inhibitmenu'}) {
6949: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6950: } else {
6951: return
6952: }
6953: }
6954: if ($env{'form.inhibitmenu'}) {
6955: if (ref($arg)) {
6956: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6957: } elsif ($arg eq '') {
6958: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6959: } else {
6960: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6961: }
6962: }
6963: if (!ref($arg)) {
6964: return $arg;
6965: }
6966: }
6967:
1.251 albertel 6968: ###############################################
1.182 matthew 6969:
6970: =pod
6971:
1.549 albertel 6972: =back
6973:
6974: =head1 User Information Routines
6975:
6976: =over 4
6977:
1.405 albertel 6978: =item * &get_users_function()
1.182 matthew 6979:
6980: Used by &bodytag to determine the current users primary role.
6981: Returns either 'student','coordinator','admin', or 'author'.
6982:
6983: =cut
6984:
6985: ###############################################
6986: sub get_users_function {
1.815 tempelho 6987: my $function = 'norole';
1.818 tempelho 6988: if ($env{'request.role'}=~/^(st)/) {
6989: $function='student';
6990: }
1.907 raeburn 6991: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6992: $function='coordinator';
6993: }
1.258 albertel 6994: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6995: $function='admin';
6996: }
1.826 bisitz 6997: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6998: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6999: $function='author';
7000: }
7001: return $function;
1.54 www 7002: }
1.99 www 7003:
7004: ###############################################
7005:
1.233 raeburn 7006: =pod
7007:
1.821 raeburn 7008: =item * &show_course()
7009:
7010: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7011: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7012:
7013: Inputs:
7014: None
7015:
7016: Outputs:
7017: Scalar: 1 if 'Course' to be used, 0 otherwise.
7018:
7019: =cut
7020:
7021: ###############################################
7022: sub show_course {
7023: my $course = !$env{'user.adv'};
7024: if (!$env{'user.adv'}) {
7025: foreach my $env (keys(%env)) {
7026: next if ($env !~ m/^user\.priv\./);
7027: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7028: $course = 0;
7029: last;
7030: }
7031: }
7032: }
7033: return $course;
7034: }
7035:
7036: ###############################################
7037:
7038: =pod
7039:
1.542 raeburn 7040: =item * &check_user_status()
1.274 raeburn 7041:
7042: Determines current status of supplied role for a
7043: specific user. Roles can be active, previous or future.
7044:
7045: Inputs:
7046: user's domain, user's username, course's domain,
1.375 raeburn 7047: course's number, optional section ID.
1.274 raeburn 7048:
7049: Outputs:
7050: role status: active, previous or future.
7051:
7052: =cut
7053:
7054: sub check_user_status {
1.412 raeburn 7055: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7056: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7057: my @uroles = keys %userinfo;
7058: my $srchstr;
7059: my $active_chk = 'none';
1.412 raeburn 7060: my $now = time;
1.274 raeburn 7061: if (@uroles > 0) {
1.908 raeburn 7062: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7063: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7064: } else {
1.412 raeburn 7065: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7066: }
7067: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7068: my $role_end = 0;
7069: my $role_start = 0;
7070: $active_chk = 'active';
1.412 raeburn 7071: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7072: $role_end = $1;
7073: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7074: $role_start = $1;
1.274 raeburn 7075: }
7076: }
7077: if ($role_start > 0) {
1.412 raeburn 7078: if ($now < $role_start) {
1.274 raeburn 7079: $active_chk = 'future';
7080: }
7081: }
7082: if ($role_end > 0) {
1.412 raeburn 7083: if ($now > $role_end) {
1.274 raeburn 7084: $active_chk = 'previous';
7085: }
7086: }
7087: }
7088: }
7089: return $active_chk;
7090: }
7091:
7092: ###############################################
7093:
7094: =pod
7095:
1.405 albertel 7096: =item * &get_sections()
1.233 raeburn 7097:
7098: Determines all the sections for a course including
7099: sections with students and sections containing other roles.
1.419 raeburn 7100: Incoming parameters:
7101:
7102: 1. domain
7103: 2. course number
7104: 3. reference to array containing roles for which sections should
7105: be gathered (optional).
7106: 4. reference to array containing status types for which sections
7107: should be gathered (optional).
7108:
7109: If the third argument is undefined, sections are gathered for any role.
7110: If the fourth argument is undefined, sections are gathered for any status.
7111: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7112:
1.374 raeburn 7113: Returns section hash (keys are section IDs, values are
7114: number of users in each section), subject to the
1.419 raeburn 7115: optional roles filter, optional status filter
1.233 raeburn 7116:
7117: =cut
7118:
7119: ###############################################
7120: sub get_sections {
1.419 raeburn 7121: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7122: if (!defined($cdom) || !defined($cnum)) {
7123: my $cid = $env{'request.course.id'};
7124:
7125: return if (!defined($cid));
7126:
7127: $cdom = $env{'course.'.$cid.'.domain'};
7128: $cnum = $env{'course.'.$cid.'.num'};
7129: }
7130:
7131: my %sectioncount;
1.419 raeburn 7132: my $now = time;
1.240 albertel 7133:
1.366 albertel 7134: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7135: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7136: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7137: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7138: my $start_index = &Apache::loncoursedata::CL_START();
7139: my $end_index = &Apache::loncoursedata::CL_END();
7140: my $status;
1.366 albertel 7141: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7142: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7143: $data->[$status_index],
7144: $data->[$start_index],
7145: $data->[$end_index]);
7146: if ($stu_status eq 'Active') {
7147: $status = 'active';
7148: } elsif ($end < $now) {
7149: $status = 'previous';
7150: } elsif ($start > $now) {
7151: $status = 'future';
7152: }
7153: if ($section ne '-1' && $section !~ /^\s*$/) {
7154: if ((!defined($possible_status)) || (($status ne '') &&
7155: (grep/^\Q$status\E$/,@{$possible_status}))) {
7156: $sectioncount{$section}++;
7157: }
1.240 albertel 7158: }
7159: }
7160: }
7161: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7162: foreach my $user (sort(keys(%courseroles))) {
7163: if ($user !~ /^(\w{2})/) { next; }
7164: my ($role) = ($user =~ /^(\w{2})/);
7165: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7166: my ($section,$status);
1.240 albertel 7167: if ($role eq 'cr' &&
7168: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7169: $section=$1;
7170: }
7171: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7172: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7173: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7174: if ($end == -1 && $start == -1) {
7175: next; #deleted role
7176: }
7177: if (!defined($possible_status)) {
7178: $sectioncount{$section}++;
7179: } else {
7180: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7181: $status = 'active';
7182: } elsif ($end < $now) {
7183: $status = 'future';
7184: } elsif ($start > $now) {
7185: $status = 'previous';
7186: }
7187: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7188: $sectioncount{$section}++;
7189: }
7190: }
1.233 raeburn 7191: }
1.366 albertel 7192: return %sectioncount;
1.233 raeburn 7193: }
7194:
1.274 raeburn 7195: ###############################################
1.294 raeburn 7196:
7197: =pod
1.405 albertel 7198:
7199: =item * &get_course_users()
7200:
1.275 raeburn 7201: Retrieves usernames:domains for users in the specified course
7202: with specific role(s), and access status.
7203:
7204: Incoming parameters:
1.277 albertel 7205: 1. course domain
7206: 2. course number
7207: 3. access status: users must have - either active,
1.275 raeburn 7208: previous, future, or all.
1.277 albertel 7209: 4. reference to array of permissible roles
1.288 raeburn 7210: 5. reference to array of section restrictions (optional)
7211: 6. reference to results object (hash of hashes).
7212: 7. reference to optional userdata hash
1.609 raeburn 7213: 8. reference to optional statushash
1.630 raeburn 7214: 9. flag if privileged users (except those set to unhide in
7215: course settings) should be excluded
1.609 raeburn 7216: Keys of top level results hash are roles.
1.275 raeburn 7217: Keys of inner hashes are username:domain, with
7218: values set to access type.
1.288 raeburn 7219: Optional userdata hash returns an array with arguments in the
7220: same order as loncoursedata::get_classlist() for student data.
7221:
1.609 raeburn 7222: Optional statushash returns
7223:
1.288 raeburn 7224: Entries for end, start, section and status are blank because
7225: of the possibility of multiple values for non-student roles.
7226:
1.275 raeburn 7227: =cut
1.405 albertel 7228:
1.275 raeburn 7229: ###############################################
1.405 albertel 7230:
1.275 raeburn 7231: sub get_course_users {
1.630 raeburn 7232: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7233: my %idx = ();
1.419 raeburn 7234: my %seclists;
1.288 raeburn 7235:
7236: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7237: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7238: $idx{end} = &Apache::loncoursedata::CL_END();
7239: $idx{start} = &Apache::loncoursedata::CL_START();
7240: $idx{id} = &Apache::loncoursedata::CL_ID();
7241: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7242: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7243: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7244:
1.290 albertel 7245: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7246: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7247: my $now = time;
1.277 albertel 7248: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7249: my $match = 0;
1.412 raeburn 7250: my $secmatch = 0;
1.419 raeburn 7251: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7252: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7253: if ($section eq '') {
7254: $section = 'none';
7255: }
1.291 albertel 7256: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7257: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7258: $secmatch = 1;
7259: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7260: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7261: $secmatch = 1;
7262: }
7263: } else {
1.419 raeburn 7264: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7265: $secmatch = 1;
7266: }
1.290 albertel 7267: }
1.412 raeburn 7268: if (!$secmatch) {
7269: next;
7270: }
1.419 raeburn 7271: }
1.275 raeburn 7272: if (defined($$types{'active'})) {
1.288 raeburn 7273: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7274: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7275: $match = 1;
1.275 raeburn 7276: }
7277: }
7278: if (defined($$types{'previous'})) {
1.609 raeburn 7279: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7280: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7281: $match = 1;
1.275 raeburn 7282: }
7283: }
7284: if (defined($$types{'future'})) {
1.609 raeburn 7285: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7286: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7287: $match = 1;
1.275 raeburn 7288: }
7289: }
1.609 raeburn 7290: if ($match) {
7291: push(@{$seclists{$student}},$section);
7292: if (ref($userdata) eq 'HASH') {
7293: $$userdata{$student} = $$classlist{$student};
7294: }
7295: if (ref($statushash) eq 'HASH') {
7296: $statushash->{$student}{'st'}{$section} = $status;
7297: }
1.288 raeburn 7298: }
1.275 raeburn 7299: }
7300: }
1.412 raeburn 7301: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7302: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7303: my $now = time;
1.609 raeburn 7304: my %displaystatus = ( previous => 'Expired',
7305: active => 'Active',
7306: future => 'Future',
7307: );
1.630 raeburn 7308: my %nothide;
7309: if ($hidepriv) {
7310: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7311: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7312: if ($user !~ /:/) {
7313: $nothide{join(':',split(/[\@]/,$user))}=1;
7314: } else {
7315: $nothide{$user} = 1;
7316: }
7317: }
7318: }
1.439 raeburn 7319: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7320: my $match = 0;
1.412 raeburn 7321: my $secmatch = 0;
1.439 raeburn 7322: my $status;
1.412 raeburn 7323: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7324: $user =~ s/:$//;
1.439 raeburn 7325: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7326: if ($end == -1 || $start == -1) {
7327: next;
7328: }
7329: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7330: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7331: my ($uname,$udom) = split(/:/,$user);
7332: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7333: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7334: $secmatch = 1;
7335: } elsif ($usec eq '') {
1.420 albertel 7336: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7337: $secmatch = 1;
7338: }
7339: } else {
7340: if (grep(/^\Q$usec\E$/,@{$sections})) {
7341: $secmatch = 1;
7342: }
7343: }
7344: if (!$secmatch) {
7345: next;
7346: }
1.288 raeburn 7347: }
1.419 raeburn 7348: if ($usec eq '') {
7349: $usec = 'none';
7350: }
1.275 raeburn 7351: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7352: if ($hidepriv) {
7353: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7354: (!$nothide{$uname.':'.$udom})) {
7355: next;
7356: }
7357: }
1.503 raeburn 7358: if ($end > 0 && $end < $now) {
1.439 raeburn 7359: $status = 'previous';
7360: } elsif ($start > $now) {
7361: $status = 'future';
7362: } else {
7363: $status = 'active';
7364: }
1.277 albertel 7365: foreach my $type (keys(%{$types})) {
1.275 raeburn 7366: if ($status eq $type) {
1.420 albertel 7367: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7368: push(@{$$users{$role}{$user}},$type);
7369: }
1.288 raeburn 7370: $match = 1;
7371: }
7372: }
1.419 raeburn 7373: if (($match) && (ref($userdata) eq 'HASH')) {
7374: if (!exists($$userdata{$uname.':'.$udom})) {
7375: &get_user_info($udom,$uname,\%idx,$userdata);
7376: }
1.420 albertel 7377: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7378: push(@{$seclists{$uname.':'.$udom}},$usec);
7379: }
1.609 raeburn 7380: if (ref($statushash) eq 'HASH') {
7381: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7382: }
1.275 raeburn 7383: }
7384: }
7385: }
7386: }
1.290 albertel 7387: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7388: if ((defined($cdom)) && (defined($cnum))) {
7389: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7390: if ( defined($csettings{'internal.courseowner'}) ) {
7391: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7392: next if ($owner eq '');
7393: my ($ownername,$ownerdom);
7394: if ($owner =~ /^([^:]+):([^:]+)$/) {
7395: $ownername = $1;
7396: $ownerdom = $2;
7397: } else {
7398: $ownername = $owner;
7399: $ownerdom = $cdom;
7400: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7401: }
7402: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7403: if (defined($userdata) &&
1.609 raeburn 7404: !exists($$userdata{$owner})) {
7405: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7406: if (!grep(/^none$/,@{$seclists{$owner}})) {
7407: push(@{$seclists{$owner}},'none');
7408: }
7409: if (ref($statushash) eq 'HASH') {
7410: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7411: }
1.290 albertel 7412: }
1.279 raeburn 7413: }
7414: }
7415: }
1.419 raeburn 7416: foreach my $user (keys(%seclists)) {
7417: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7418: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7419: }
1.275 raeburn 7420: }
7421: return;
7422: }
7423:
1.288 raeburn 7424: sub get_user_info {
7425: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7426: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7427: &plainname($uname,$udom,'lastname');
1.291 albertel 7428: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7429: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7430: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7431: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7432: return;
7433: }
1.275 raeburn 7434:
1.472 raeburn 7435: ###############################################
7436:
7437: =pod
7438:
7439: =item * &get_user_quota()
7440:
7441: Retrieves quota assigned for storage of portfolio files for a user
7442:
7443: Incoming parameters:
7444: 1. user's username
7445: 2. user's domain
7446:
7447: Returns:
1.536 raeburn 7448: 1. Disk quota (in Mb) assigned to student.
7449: 2. (Optional) Type of setting: custom or default
7450: (individually assigned or default for user's
7451: institutional status).
7452: 3. (Optional) - User's institutional status (e.g., faculty, staff
7453: or student - types as defined in localenroll::inst_usertypes
7454: for user's domain, which determines default quota for user.
7455: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7456:
7457: If a value has been stored in the user's environment,
1.536 raeburn 7458: it will return that, otherwise it returns the maximal default
7459: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7460:
7461: =cut
7462:
7463: ###############################################
7464:
7465:
7466: sub get_user_quota {
7467: my ($uname,$udom) = @_;
1.536 raeburn 7468: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7469: if (!defined($udom)) {
7470: $udom = $env{'user.domain'};
7471: }
7472: if (!defined($uname)) {
7473: $uname = $env{'user.name'};
7474: }
7475: if (($udom eq '' || $uname eq '') ||
7476: ($udom eq 'public') && ($uname eq 'public')) {
7477: $quota = 0;
1.536 raeburn 7478: $quotatype = 'default';
7479: $defquota = 0;
1.472 raeburn 7480: } else {
1.536 raeburn 7481: my $inststatus;
1.472 raeburn 7482: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7483: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7484: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7485: } else {
1.536 raeburn 7486: my %userenv =
7487: &Apache::lonnet::get('environment',['portfolioquota',
7488: 'inststatus'],$udom,$uname);
1.472 raeburn 7489: my ($tmp) = keys(%userenv);
7490: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7491: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7492: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7493: } else {
7494: undef(%userenv);
7495: }
7496: }
1.536 raeburn 7497: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7498: if ($quota eq '') {
1.536 raeburn 7499: $quota = $defquota;
7500: $quotatype = 'default';
7501: } else {
7502: $quotatype = 'custom';
1.472 raeburn 7503: }
7504: }
1.536 raeburn 7505: if (wantarray) {
7506: return ($quota,$quotatype,$settingstatus,$defquota);
7507: } else {
7508: return $quota;
7509: }
1.472 raeburn 7510: }
7511:
7512: ###############################################
7513:
7514: =pod
7515:
7516: =item * &default_quota()
7517:
1.536 raeburn 7518: Retrieves default quota assigned for storage of user portfolio files,
7519: given an (optional) user's institutional status.
1.472 raeburn 7520:
7521: Incoming parameters:
7522: 1. domain
1.536 raeburn 7523: 2. (Optional) institutional status(es). This is a : separated list of
7524: status types (e.g., faculty, staff, student etc.)
7525: which apply to the user for whom the default is being retrieved.
7526: If the institutional status string in undefined, the domain
7527: default quota will be returned.
1.472 raeburn 7528:
7529: Returns:
7530: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7531: 2. (Optional) institutional type which determined the value of the
7532: default quota.
1.472 raeburn 7533:
7534: If a value has been stored in the domain's configuration db,
7535: it will return that, otherwise it returns 20 (for backwards
7536: compatibility with domains which have not set up a configuration
7537: db file; the original statically defined portfolio quota was 20 Mb).
7538:
1.536 raeburn 7539: If the user's status includes multiple types (e.g., staff and student),
7540: the largest default quota which applies to the user determines the
7541: default quota returned.
7542:
1.780 raeburn 7543: =back
7544:
1.472 raeburn 7545: =cut
7546:
7547: ###############################################
7548:
7549:
7550: sub default_quota {
1.536 raeburn 7551: my ($udom,$inststatus) = @_;
7552: my ($defquota,$settingstatus);
7553: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7554: ['quotas'],$udom);
7555: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7556: if ($inststatus ne '') {
1.765 raeburn 7557: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7558: foreach my $item (@statuses) {
1.711 raeburn 7559: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7560: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7561: if ($defquota eq '') {
7562: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7563: $settingstatus = $item;
7564: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7565: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7566: $settingstatus = $item;
7567: }
7568: }
7569: } else {
7570: if ($quotahash{'quotas'}{$item} ne '') {
7571: if ($defquota eq '') {
7572: $defquota = $quotahash{'quotas'}{$item};
7573: $settingstatus = $item;
7574: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7575: $defquota = $quotahash{'quotas'}{$item};
7576: $settingstatus = $item;
7577: }
1.536 raeburn 7578: }
7579: }
7580: }
7581: }
7582: if ($defquota eq '') {
1.711 raeburn 7583: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7584: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7585: } else {
7586: $defquota = $quotahash{'quotas'}{'default'};
7587: }
1.536 raeburn 7588: $settingstatus = 'default';
7589: }
7590: } else {
7591: $settingstatus = 'default';
7592: $defquota = 20;
7593: }
7594: if (wantarray) {
7595: return ($defquota,$settingstatus);
1.472 raeburn 7596: } else {
1.536 raeburn 7597: return $defquota;
1.472 raeburn 7598: }
7599: }
7600:
1.384 raeburn 7601: sub get_secgrprole_info {
7602: my ($cdom,$cnum,$needroles,$type) = @_;
7603: my %sections_count = &get_sections($cdom,$cnum);
7604: my @sections = (sort {$a <=> $b} keys(%sections_count));
7605: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7606: my @groups = sort(keys(%curr_groups));
7607: my $allroles = [];
7608: my $rolehash;
7609: my $accesshash = {
7610: active => 'Currently has access',
7611: future => 'Will have future access',
7612: previous => 'Previously had access',
7613: };
7614: if ($needroles) {
7615: $rolehash = {'all' => 'all'};
1.385 albertel 7616: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7617: if (&Apache::lonnet::error(%user_roles)) {
7618: undef(%user_roles);
7619: }
7620: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7621: my ($role)=split(/\:/,$item,2);
7622: if ($role eq 'cr') { next; }
7623: if ($role =~ /^cr/) {
7624: $$rolehash{$role} = (split('/',$role))[3];
7625: } else {
7626: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7627: }
7628: }
7629: foreach my $key (sort(keys(%{$rolehash}))) {
7630: push(@{$allroles},$key);
7631: }
7632: push (@{$allroles},'st');
7633: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7634: }
7635: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7636: }
7637:
1.555 raeburn 7638: sub user_picker {
1.627 raeburn 7639: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7640: my $currdom = $dom;
7641: my %curr_selected = (
7642: srchin => 'dom',
1.580 raeburn 7643: srchby => 'lastname',
1.555 raeburn 7644: );
7645: my $srchterm;
1.625 raeburn 7646: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7647: if ($srch->{'srchby'} ne '') {
7648: $curr_selected{'srchby'} = $srch->{'srchby'};
7649: }
7650: if ($srch->{'srchin'} ne '') {
7651: $curr_selected{'srchin'} = $srch->{'srchin'};
7652: }
7653: if ($srch->{'srchtype'} ne '') {
7654: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7655: }
7656: if ($srch->{'srchdomain'} ne '') {
7657: $currdom = $srch->{'srchdomain'};
7658: }
7659: $srchterm = $srch->{'srchterm'};
7660: }
7661: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7662: 'usr' => 'Search criteria',
1.563 raeburn 7663: 'doma' => 'Domain/institution to search',
1.558 albertel 7664: 'uname' => 'username',
7665: 'lastname' => 'last name',
1.555 raeburn 7666: 'lastfirst' => 'last name, first name',
1.558 albertel 7667: 'crs' => 'in this course',
1.576 raeburn 7668: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7669: 'alc' => 'all LON-CAPA',
1.573 raeburn 7670: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7671: 'exact' => 'is',
7672: 'contains' => 'contains',
1.569 raeburn 7673: 'begins' => 'begins with',
1.571 raeburn 7674: 'youm' => "You must include some text to search for.",
7675: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7676: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7677: 'yomc' => "You must choose a domain when using an institutional directory search.",
7678: 'ymcd' => "You must choose a domain when using a domain search.",
7679: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7680: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7681: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7682: );
1.563 raeburn 7683: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7684: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7685:
7686: my @srchins = ('crs','dom','alc','instd');
7687:
7688: foreach my $option (@srchins) {
7689: # FIXME 'alc' option unavailable until
7690: # loncreateuser::print_user_query_page()
7691: # has been completed.
7692: next if ($option eq 'alc');
1.880 raeburn 7693: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7694: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7695: if ($curr_selected{'srchin'} eq $option) {
7696: $srchinsel .= '
7697: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7698: } else {
7699: $srchinsel .= '
7700: <option value="'.$option.'">'.$lt{$option}.'</option>';
7701: }
1.555 raeburn 7702: }
1.563 raeburn 7703: $srchinsel .= "\n </select>\n";
1.555 raeburn 7704:
7705: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7706: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7707: if ($curr_selected{'srchby'} eq $option) {
7708: $srchbysel .= '
7709: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7710: } else {
7711: $srchbysel .= '
7712: <option value="'.$option.'">'.$lt{$option}.'</option>';
7713: }
7714: }
7715: $srchbysel .= "\n </select>\n";
7716:
7717: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7718: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7719: if ($curr_selected{'srchtype'} eq $option) {
7720: $srchtypesel .= '
7721: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7722: } else {
7723: $srchtypesel .= '
7724: <option value="'.$option.'">'.$lt{$option}.'</option>';
7725: }
7726: }
7727: $srchtypesel .= "\n </select>\n";
7728:
1.558 albertel 7729: my ($newuserscript,$new_user_create);
1.556 raeburn 7730:
7731: if ($forcenewuser) {
1.576 raeburn 7732: if (ref($srch) eq 'HASH') {
7733: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7734: if ($cancreate) {
7735: $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>';
7736: } else {
1.799 bisitz 7737: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7738: my %usertypetext = (
7739: official => 'institutional',
7740: unofficial => 'non-institutional',
7741: );
1.799 bisitz 7742: $new_user_create = '<p class="LC_warning">'
7743: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7744: .' '
7745: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7746: ,'<a href="'.$helplink.'">','</a>')
7747: .'</p><br />';
1.627 raeburn 7748: }
1.576 raeburn 7749: }
7750: }
7751:
1.556 raeburn 7752: $newuserscript = <<"ENDSCRIPT";
7753:
1.570 raeburn 7754: function setSearch(createnew,callingForm) {
1.556 raeburn 7755: if (createnew == 1) {
1.570 raeburn 7756: for (var i=0; i<callingForm.srchby.length; i++) {
7757: if (callingForm.srchby.options[i].value == 'uname') {
7758: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7759: }
7760: }
1.570 raeburn 7761: for (var i=0; i<callingForm.srchin.length; i++) {
7762: if ( callingForm.srchin.options[i].value == 'dom') {
7763: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7764: }
7765: }
1.570 raeburn 7766: for (var i=0; i<callingForm.srchtype.length; i++) {
7767: if (callingForm.srchtype.options[i].value == 'exact') {
7768: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7769: }
7770: }
1.570 raeburn 7771: for (var i=0; i<callingForm.srchdomain.length; i++) {
7772: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7773: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7774: }
7775: }
7776: }
7777: }
7778: ENDSCRIPT
1.558 albertel 7779:
1.556 raeburn 7780: }
7781:
1.555 raeburn 7782: my $output = <<"END_BLOCK";
1.556 raeburn 7783: <script type="text/javascript">
1.824 bisitz 7784: // <![CDATA[
1.570 raeburn 7785: function validateEntry(callingForm) {
1.558 albertel 7786:
1.556 raeburn 7787: var checkok = 1;
1.558 albertel 7788: var srchin;
1.570 raeburn 7789: for (var i=0; i<callingForm.srchin.length; i++) {
7790: if ( callingForm.srchin[i].checked ) {
7791: srchin = callingForm.srchin[i].value;
1.558 albertel 7792: }
7793: }
7794:
1.570 raeburn 7795: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7796: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7797: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7798: var srchterm = callingForm.srchterm.value;
7799: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7800: var msg = "";
7801:
7802: if (srchterm == "") {
7803: checkok = 0;
1.571 raeburn 7804: msg += "$lt{'youm'}\\n";
1.556 raeburn 7805: }
7806:
1.569 raeburn 7807: if (srchtype== 'begins') {
7808: if (srchterm.length < 2) {
7809: checkok = 0;
1.571 raeburn 7810: msg += "$lt{'thte'}\\n";
1.569 raeburn 7811: }
7812: }
7813:
1.556 raeburn 7814: if (srchtype== 'contains') {
7815: if (srchterm.length < 3) {
7816: checkok = 0;
1.571 raeburn 7817: msg += "$lt{'thet'}\\n";
1.556 raeburn 7818: }
7819: }
7820: if (srchin == 'instd') {
7821: if (srchdomain == '') {
7822: checkok = 0;
1.571 raeburn 7823: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7824: }
7825: }
7826: if (srchin == 'dom') {
7827: if (srchdomain == '') {
7828: checkok = 0;
1.571 raeburn 7829: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7830: }
7831: }
7832: if (srchby == 'lastfirst') {
7833: if (srchterm.indexOf(",") == -1) {
7834: checkok = 0;
1.571 raeburn 7835: msg += "$lt{'whus'}\\n";
1.556 raeburn 7836: }
7837: if (srchterm.indexOf(",") == srchterm.length -1) {
7838: checkok = 0;
1.571 raeburn 7839: msg += "$lt{'whse'}\\n";
1.556 raeburn 7840: }
7841: }
7842: if (checkok == 0) {
1.571 raeburn 7843: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7844: return;
7845: }
7846: if (checkok == 1) {
1.570 raeburn 7847: callingForm.submit();
1.556 raeburn 7848: }
7849: }
7850:
7851: $newuserscript
7852:
1.824 bisitz 7853: // ]]>
1.556 raeburn 7854: </script>
1.558 albertel 7855:
7856: $new_user_create
7857:
1.555 raeburn 7858: END_BLOCK
1.558 albertel 7859:
1.876 raeburn 7860: $output .= &Apache::lonhtmlcommon::start_pick_box().
7861: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7862: $domform.
7863: &Apache::lonhtmlcommon::row_closure().
7864: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7865: $srchbysel.
7866: $srchtypesel.
7867: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7868: $srchinsel.
7869: &Apache::lonhtmlcommon::row_closure(1).
7870: &Apache::lonhtmlcommon::end_pick_box().
7871: '<br />';
1.555 raeburn 7872: return $output;
7873: }
7874:
1.612 raeburn 7875: sub user_rule_check {
1.615 raeburn 7876: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7877: my $response;
7878: if (ref($usershash) eq 'HASH') {
7879: foreach my $user (keys(%{$usershash})) {
7880: my ($uname,$udom) = split(/:/,$user);
7881: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7882: my ($id,$newuser);
1.612 raeburn 7883: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7884: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7885: $id = $usershash->{$user}->{'id'};
7886: }
7887: my $inst_response;
7888: if (ref($checks) eq 'HASH') {
7889: if (defined($checks->{'username'})) {
1.615 raeburn 7890: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7891: &Apache::lonnet::get_instuser($udom,$uname);
7892: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7893: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7894: &Apache::lonnet::get_instuser($udom,undef,$id);
7895: }
1.615 raeburn 7896: } else {
7897: ($inst_response,%{$inst_results->{$user}}) =
7898: &Apache::lonnet::get_instuser($udom,$uname);
7899: return;
1.612 raeburn 7900: }
1.615 raeburn 7901: if (!$got_rules->{$udom}) {
1.612 raeburn 7902: my %domconfig = &Apache::lonnet::get_dom('configuration',
7903: ['usercreation'],$udom);
7904: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7905: foreach my $item ('username','id') {
1.612 raeburn 7906: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7907: $$curr_rules{$udom}{$item} =
7908: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7909: }
7910: }
7911: }
1.615 raeburn 7912: $got_rules->{$udom} = 1;
1.585 raeburn 7913: }
1.612 raeburn 7914: foreach my $item (keys(%{$checks})) {
7915: if (ref($$curr_rules{$udom}) eq 'HASH') {
7916: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7917: if (@{$$curr_rules{$udom}{$item}} > 0) {
7918: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7919: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7920: if ($rule_check{$rule}) {
7921: $$rulematch{$user}{$item} = $rule;
7922: if ($inst_response eq 'ok') {
1.615 raeburn 7923: if (ref($inst_results) eq 'HASH') {
7924: if (ref($inst_results->{$user}) eq 'HASH') {
7925: if (keys(%{$inst_results->{$user}}) == 0) {
7926: $$alerts{$item}{$udom}{$uname} = 1;
7927: }
1.612 raeburn 7928: }
7929: }
1.615 raeburn 7930: }
7931: last;
1.585 raeburn 7932: }
7933: }
7934: }
7935: }
7936: }
7937: }
7938: }
7939: }
1.612 raeburn 7940: return;
7941: }
7942:
7943: sub user_rule_formats {
7944: my ($domain,$domdesc,$curr_rules,$check) = @_;
7945: my %text = (
7946: 'username' => 'Usernames',
7947: 'id' => 'IDs',
7948: );
7949: my $output;
7950: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7951: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7952: if (@{$ruleorder} > 0) {
7953: $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>';
7954: foreach my $rule (@{$ruleorder}) {
7955: if (ref($curr_rules) eq 'ARRAY') {
7956: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7957: if (ref($rules->{$rule}) eq 'HASH') {
7958: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7959: $rules->{$rule}{'desc'}.'</li>';
7960: }
7961: }
7962: }
7963: }
7964: $output .= '</ul>';
7965: }
7966: }
7967: return $output;
7968: }
7969:
7970: sub instrule_disallow_msg {
1.615 raeburn 7971: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7972: my $response;
7973: my %text = (
7974: item => 'username',
7975: items => 'usernames',
7976: match => 'matches',
7977: do => 'does',
7978: action => 'a username',
7979: one => 'one',
7980: );
7981: if ($count > 1) {
7982: $text{'item'} = 'usernames';
7983: $text{'match'} ='match';
7984: $text{'do'} = 'do';
7985: $text{'action'} = 'usernames',
7986: $text{'one'} = 'ones';
7987: }
7988: if ($checkitem eq 'id') {
7989: $text{'items'} = 'IDs';
7990: $text{'item'} = 'ID';
7991: $text{'action'} = 'an ID';
1.615 raeburn 7992: if ($count > 1) {
7993: $text{'item'} = 'IDs';
7994: $text{'action'} = 'IDs';
7995: }
1.612 raeburn 7996: }
1.674 bisitz 7997: $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 7998: if ($mode eq 'upload') {
7999: if ($checkitem eq 'username') {
8000: $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'}.");
8001: } elsif ($checkitem eq 'id') {
1.674 bisitz 8002: $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 8003: }
1.669 raeburn 8004: } elsif ($mode eq 'selfcreate') {
8005: if ($checkitem eq 'id') {
8006: $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.");
8007: }
1.615 raeburn 8008: } else {
8009: if ($checkitem eq 'username') {
8010: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8011: } elsif ($checkitem eq 'id') {
8012: $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.");
8013: }
1.612 raeburn 8014: }
8015: return $response;
1.585 raeburn 8016: }
8017:
1.624 raeburn 8018: sub personal_data_fieldtitles {
8019: my %fieldtitles = &Apache::lonlocal::texthash (
8020: id => 'Student/Employee ID',
8021: permanentemail => 'E-mail address',
8022: lastname => 'Last Name',
8023: firstname => 'First Name',
8024: middlename => 'Middle Name',
8025: generation => 'Generation',
8026: gen => 'Generation',
1.765 raeburn 8027: inststatus => 'Affiliation',
1.624 raeburn 8028: );
8029: return %fieldtitles;
8030: }
8031:
1.642 raeburn 8032: sub sorted_inst_types {
8033: my ($dom) = @_;
8034: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8035: my $othertitle = &mt('All users');
8036: if ($env{'request.course.id'}) {
1.668 raeburn 8037: $othertitle = &mt('Any users');
1.642 raeburn 8038: }
8039: my @types;
8040: if (ref($order) eq 'ARRAY') {
8041: @types = @{$order};
8042: }
8043: if (@types == 0) {
8044: if (ref($usertypes) eq 'HASH') {
8045: @types = sort(keys(%{$usertypes}));
8046: }
8047: }
8048: if (keys(%{$usertypes}) > 0) {
8049: $othertitle = &mt('Other users');
8050: }
8051: return ($othertitle,$usertypes,\@types);
8052: }
8053:
1.645 raeburn 8054: sub get_institutional_codes {
8055: my ($settings,$allcourses,$LC_code) = @_;
8056: # Get complete list of course sections to update
8057: my @currsections = ();
8058: my @currxlists = ();
8059: my $coursecode = $$settings{'internal.coursecode'};
8060:
8061: if ($$settings{'internal.sectionnums'} ne '') {
8062: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8063: }
8064:
8065: if ($$settings{'internal.crosslistings'} ne '') {
8066: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8067: }
8068:
8069: if (@currxlists > 0) {
8070: foreach (@currxlists) {
8071: if (m/^([^:]+):(\w*)$/) {
8072: unless (grep/^$1$/,@{$allcourses}) {
8073: push @{$allcourses},$1;
8074: $$LC_code{$1} = $2;
8075: }
8076: }
8077: }
8078: }
8079:
8080: if (@currsections > 0) {
8081: foreach (@currsections) {
8082: if (m/^(\w+):(\w*)$/) {
8083: my $sec = $coursecode.$1;
8084: my $lc_sec = $2;
8085: unless (grep/^$sec$/,@{$allcourses}) {
8086: push @{$allcourses},$sec;
8087: $$LC_code{$sec} = $lc_sec;
8088: }
8089: }
8090: }
8091: }
8092: return;
8093: }
8094:
1.112 bowersj2 8095: =pod
8096:
1.780 raeburn 8097: =head1 Slot Helpers
8098:
8099: =over 4
8100:
8101: =item * sorted_slots()
8102:
8103: Sorts an array of slot names in order of slot start time (earliest first).
8104:
8105: Inputs:
8106:
8107: =over 4
8108:
8109: slotsarr - Reference to array of unsorted slot names.
8110:
8111: slots - Reference to hash of hash, where outer hash keys are slot names.
8112:
1.549 albertel 8113: =back
8114:
1.780 raeburn 8115: Returns:
8116:
8117: =over 4
8118:
8119: sorted - An array of slot names sorted by the start time of the slot.
8120:
8121: =back
8122:
8123: =back
8124:
8125: =cut
8126:
8127:
8128: sub sorted_slots {
8129: my ($slotsarr,$slots) = @_;
8130: my @sorted;
8131: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8132: @sorted =
8133: sort {
8134: if (ref($slots->{$a}) && ref($slots->{$b})) {
8135: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8136: }
8137: if (ref($slots->{$a})) { return -1;}
8138: if (ref($slots->{$b})) { return 1;}
8139: return 0;
8140: } @{$slotsarr};
8141: }
8142: return @sorted;
8143: }
8144:
8145:
8146: =pod
8147:
1.549 albertel 8148: =head1 HTTP Helpers
8149:
8150: =over 4
8151:
1.648 raeburn 8152: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8153:
1.258 albertel 8154: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8155: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8156: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8157:
8158: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8159: $possible_names is an ref to an array of form element names. As an example:
8160: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8161: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8162:
8163: =cut
1.1 albertel 8164:
1.6 albertel 8165: sub get_unprocessed_cgi {
1.25 albertel 8166: my ($query,$possible_names)= @_;
1.26 matthew 8167: # $Apache::lonxml::debug=1;
1.356 albertel 8168: foreach my $pair (split(/&/,$query)) {
8169: my ($name, $value) = split(/=/,$pair);
1.369 www 8170: $name = &unescape($name);
1.25 albertel 8171: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8172: $value =~ tr/+/ /;
8173: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8174: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8175: }
1.16 harris41 8176: }
1.6 albertel 8177: }
8178:
1.112 bowersj2 8179: =pod
8180:
1.648 raeburn 8181: =item * &cacheheader()
1.112 bowersj2 8182:
8183: returns cache-controlling header code
8184:
8185: =cut
8186:
1.7 albertel 8187: sub cacheheader {
1.258 albertel 8188: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8189: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8190: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8191: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8192: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8193: return $output;
1.7 albertel 8194: }
8195:
1.112 bowersj2 8196: =pod
8197:
1.648 raeburn 8198: =item * &no_cache($r)
1.112 bowersj2 8199:
8200: specifies header code to not have cache
8201:
8202: =cut
8203:
1.9 albertel 8204: sub no_cache {
1.216 albertel 8205: my ($r) = @_;
8206: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8207: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8208: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8209: $r->no_cache(1);
8210: $r->header_out("Expires" => $date);
8211: $r->header_out("Pragma" => "no-cache");
1.123 www 8212: }
8213:
8214: sub content_type {
1.181 albertel 8215: my ($r,$type,$charset) = @_;
1.299 foxr 8216: if ($r) {
8217: # Note that printout.pl calls this with undef for $r.
8218: &no_cache($r);
8219: }
1.258 albertel 8220: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8221: unless ($charset) {
8222: $charset=&Apache::lonlocal::current_encoding;
8223: }
8224: if ($charset) { $type.='; charset='.$charset; }
8225: if ($r) {
8226: $r->content_type($type);
8227: } else {
8228: print("Content-type: $type\n\n");
8229: }
1.9 albertel 8230: }
1.25 albertel 8231:
1.112 bowersj2 8232: =pod
8233:
1.648 raeburn 8234: =item * &add_to_env($name,$value)
1.112 bowersj2 8235:
1.258 albertel 8236: adds $name to the %env hash with value
1.112 bowersj2 8237: $value, if $name already exists, the entry is converted to an array
8238: reference and $value is added to the array.
8239:
8240: =cut
8241:
1.25 albertel 8242: sub add_to_env {
8243: my ($name,$value)=@_;
1.258 albertel 8244: if (defined($env{$name})) {
8245: if (ref($env{$name})) {
1.25 albertel 8246: #already have multiple values
1.258 albertel 8247: push(@{ $env{$name} },$value);
1.25 albertel 8248: } else {
8249: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8250: my $first=$env{$name};
8251: undef($env{$name});
8252: push(@{ $env{$name} },$first,$value);
1.25 albertel 8253: }
8254: } else {
1.258 albertel 8255: $env{$name}=$value;
1.25 albertel 8256: }
1.31 albertel 8257: }
1.149 albertel 8258:
8259: =pod
8260:
1.648 raeburn 8261: =item * &get_env_multiple($name)
1.149 albertel 8262:
1.258 albertel 8263: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8264: values may be defined and end up as an array ref.
8265:
8266: returns an array of values
8267:
8268: =cut
8269:
8270: sub get_env_multiple {
8271: my ($name) = @_;
8272: my @values;
1.258 albertel 8273: if (defined($env{$name})) {
1.149 albertel 8274: # exists is it an array
1.258 albertel 8275: if (ref($env{$name})) {
8276: @values=@{ $env{$name} };
1.149 albertel 8277: } else {
1.258 albertel 8278: $values[0]=$env{$name};
1.149 albertel 8279: }
8280: }
8281: return(@values);
8282: }
8283:
1.660 raeburn 8284: sub ask_for_embedded_content {
8285: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8286: my $upload_output = '
8287: <form name="upload_embedded" action="'.$actionurl.'"
8288: method="post" enctype="multipart/form-data">';
8289: $upload_output .= $state;
1.661 raeburn 8290: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8291:
8292: my $num = 0;
8293: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8294: $upload_output .= &start_data_table_row().
8295: '<td>'.$embed_file.'</td><td>';
8296: if ($args->{'ignore_remote_references'}
8297: && $embed_file =~ m{^\w+://}) {
8298: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8299: } elsif ($args->{'error_on_invalid_names'}
8300: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8301:
8302: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8303:
8304: } else {
8305: $upload_output .='
1.661 raeburn 8306: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8307: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8308: my $attrib = join(':',@{$$allfiles{$embed_file}});
8309: $upload_output .=
8310: "\n\t\t".
8311: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8312: $attrib.'" />';
8313: if (exists($$codebase{$embed_file})) {
8314: $upload_output .=
8315: "\n\t\t".
8316: '<input name="codebase_'.$num.'" type="hidden" value="'.
8317: &escape($$codebase{$embed_file}).'" />';
8318: }
8319: }
8320: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8321: $num++;
8322: }
8323: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8324: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8325: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8326: '.&mt('(only files for which a location has been provided will be uploaded)').'
8327: </form>';
8328: return $upload_output;
8329: }
8330:
1.661 raeburn 8331: sub upload_embedded {
8332: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8333: $current_disk_usage) = @_;
8334: my $output;
8335: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8336: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8337: my $orig_uploaded_filename =
8338: $env{'form.embedded_item_'.$i.'.filename'};
8339:
8340: $env{'form.embedded_orig_'.$i} =
8341: &unescape($env{'form.embedded_orig_'.$i});
8342: my ($path,$fname) =
8343: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8344: # no path, whole string is fname
8345: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8346:
8347: $path = $env{'form.currentpath'}.$path;
8348: $fname = &Apache::lonnet::clean_filename($fname);
8349: # See if there is anything left
8350: next if ($fname eq '');
8351:
8352: # Check if file already exists as a file or directory.
8353: my ($state,$msg);
8354: if ($context eq 'portfolio') {
8355: my $port_path = $dirpath;
8356: if ($group ne '') {
8357: $port_path = "groups/$group/$port_path";
8358: }
8359: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8360: $dir_root,$port_path,$disk_quota,
8361: $current_disk_usage,$uname,$udom);
8362: if ($state eq 'will_exceed_quota'
8363: || $state eq 'file_locked'
8364: || $state eq 'file_exists' ) {
8365: $output .= $msg;
8366: next;
8367: }
8368: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8369: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8370: if ($state eq 'exists') {
8371: $output .= $msg;
8372: next;
8373: }
8374: }
8375: # Check if extension is valid
8376: if (($fname =~ /\.(\w+)$/) &&
8377: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8378: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8379: next;
8380: } elsif (($fname =~ /\.(\w+)$/) &&
8381: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8382: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8383: next;
8384: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8385: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8386: next;
8387: }
8388:
8389: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8390: if ($context eq 'portfolio') {
8391: my $result=
8392: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8393: $dirpath.$path);
8394: if ($result !~ m|^/uploaded/|) {
8395: $output .= '<span class="LC_error">'
8396: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8397: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8398: .'</span><br />';
8399: next;
8400: } else {
8401: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8402: $path.$fname.'</span>').'</p>';
8403: }
8404: } else {
8405: # Save the file
8406: my $target = $env{'form.embedded_item_'.$i};
8407: my $fullpath = $dir_root.$dirpath.'/'.$path;
8408: my $dest = $fullpath.$fname;
8409: my $url = $url_root.$dirpath.'/'.$path.$fname;
8410: my @parts=split(/\//,$fullpath);
8411: my $count;
8412: my $filepath = $dir_root;
8413: for ($count=4;$count<=$#parts;$count++) {
8414: $filepath .= "/$parts[$count]";
8415: if ((-e $filepath)!=1) {
8416: mkdir($filepath,0770);
8417: }
8418: }
8419: my $fh;
8420: if (!open($fh,'>'.$dest)) {
8421: &Apache::lonnet::logthis('Failed to create '.$dest);
8422: $output .= '<span class="LC_error">'.
8423: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8424: '</span><br />';
8425: } else {
8426: if (!print $fh $env{'form.embedded_item_'.$i}) {
8427: &Apache::lonnet::logthis('Failed to write to '.$dest);
8428: $output .= '<span class="LC_error">'.
8429: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8430: '</span><br />';
8431: } else {
8432: if ($context eq 'testbank') {
8433: $output .= &mt('Embedded file uploaded successfully:').
8434: ' <a href="'.$url.'">'.
8435: $orig_uploaded_filename.'</a><br />';
8436: } else {
1.705 tempelho 8437: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8438: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8439: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8440: }
8441: }
8442: close($fh);
8443: }
8444: }
8445: }
8446: return $output;
8447: }
8448:
8449: sub check_for_existing {
8450: my ($path,$fname,$element) = @_;
8451: my ($state,$msg);
8452: if (-d $path.'/'.$fname) {
8453: $state = 'exists';
8454: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8455: } elsif (-e $path.'/'.$fname) {
8456: $state = 'exists';
8457: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8458: }
8459: if ($state eq 'exists') {
8460: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8461: }
8462: return ($state,$msg);
8463: }
8464:
8465: sub check_for_upload {
8466: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8467: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8468: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8469: my $getpropath = 1;
8470: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8471: $getpropath);
8472: my $found_file = 0;
8473: my $locked_file = 0;
8474: foreach my $line (@dir_list) {
8475: my ($file_name)=split(/\&/,$line,2);
8476: if ($file_name eq $fname){
8477: $file_name = $path.$file_name;
8478: if ($group ne '') {
8479: $file_name = $group.$file_name;
8480: }
8481: $found_file = 1;
8482: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8483: $locked_file = 1;
8484: }
8485: }
8486: }
8487: if (($current_disk_usage + $filesize) > $disk_quota){
8488: my $msg = '<span class="LC_error">'.
8489: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8490: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8491: return ('will_exceed_quota',$msg);
8492: } elsif ($found_file) {
8493: if ($locked_file) {
8494: my $msg = '<span class="LC_error">';
8495: $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>');
8496: $msg .= '</span><br />';
8497: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8498: return ('file_locked',$msg);
8499: } else {
8500: my $msg = '<span class="LC_error">';
8501: $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'});
8502: $msg .= '</span>';
8503: $msg .= '<br />';
8504: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8505: return ('file_exists',$msg);
8506: }
8507: }
8508: }
8509:
1.31 albertel 8510:
1.41 ng 8511: =pod
1.45 matthew 8512:
1.464 albertel 8513: =back
1.41 ng 8514:
1.112 bowersj2 8515: =head1 CSV Upload/Handling functions
1.38 albertel 8516:
1.41 ng 8517: =over 4
8518:
1.648 raeburn 8519: =item * &upfile_store($r)
1.41 ng 8520:
8521: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8522: needs $env{'form.upfile'}
1.41 ng 8523: returns $datatoken to be put into hidden field
8524:
8525: =cut
1.31 albertel 8526:
8527: sub upfile_store {
8528: my $r=shift;
1.258 albertel 8529: $env{'form.upfile'}=~s/\r/\n/gs;
8530: $env{'form.upfile'}=~s/\f/\n/gs;
8531: $env{'form.upfile'}=~s/\n+/\n/gs;
8532: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8533:
1.258 albertel 8534: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8535: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8536: {
1.158 raeburn 8537: my $datafile = $r->dir_config('lonDaemons').
8538: '/tmp/'.$datatoken.'.tmp';
8539: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8540: print $fh $env{'form.upfile'};
1.158 raeburn 8541: close($fh);
8542: }
1.31 albertel 8543: }
8544: return $datatoken;
8545: }
8546:
1.56 matthew 8547: =pod
8548:
1.648 raeburn 8549: =item * &load_tmp_file($r)
1.41 ng 8550:
8551: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8552: needs $env{'form.datatoken'},
8553: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8554:
8555: =cut
1.31 albertel 8556:
8557: sub load_tmp_file {
8558: my $r=shift;
8559: my @studentdata=();
8560: {
1.158 raeburn 8561: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8562: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8563: if ( open(my $fh,"<$studentfile") ) {
8564: @studentdata=<$fh>;
8565: close($fh);
8566: }
1.31 albertel 8567: }
1.258 albertel 8568: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8569: }
8570:
1.56 matthew 8571: =pod
8572:
1.648 raeburn 8573: =item * &upfile_record_sep()
1.41 ng 8574:
8575: Separate uploaded file into records
8576: returns array of records,
1.258 albertel 8577: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8578:
8579: =cut
1.31 albertel 8580:
8581: sub upfile_record_sep {
1.258 albertel 8582: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8583: } else {
1.248 albertel 8584: my @records;
1.258 albertel 8585: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8586: if ($line=~/^\s*$/) { next; }
8587: push(@records,$line);
8588: }
8589: return @records;
1.31 albertel 8590: }
8591: }
8592:
1.56 matthew 8593: =pod
8594:
1.648 raeburn 8595: =item * &record_sep($record)
1.41 ng 8596:
1.258 albertel 8597: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8598:
8599: =cut
8600:
1.263 www 8601: sub takeleft {
8602: my $index=shift;
8603: return substr('0000'.$index,-4,4);
8604: }
8605:
1.31 albertel 8606: sub record_sep {
8607: my $record=shift;
8608: my %components=();
1.258 albertel 8609: if ($env{'form.upfiletype'} eq 'xml') {
8610: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8611: my $i=0;
1.356 albertel 8612: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8613: $field=~s/^(\"|\')//;
8614: $field=~s/(\"|\')$//;
1.263 www 8615: $components{&takeleft($i)}=$field;
1.31 albertel 8616: $i++;
8617: }
1.258 albertel 8618: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8619: my $i=0;
1.356 albertel 8620: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8621: $field=~s/^(\"|\')//;
8622: $field=~s/(\"|\')$//;
1.263 www 8623: $components{&takeleft($i)}=$field;
1.31 albertel 8624: $i++;
8625: }
8626: } else {
1.561 www 8627: my $separator=',';
1.480 banghart 8628: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8629: $separator=';';
1.480 banghart 8630: }
1.31 albertel 8631: my $i=0;
1.561 www 8632: # the character we are looking for to indicate the end of a quote or a record
8633: my $looking_for=$separator;
8634: # do not add the characters to the fields
8635: my $ignore=0;
8636: # we just encountered a separator (or the beginning of the record)
8637: my $just_found_separator=1;
8638: # store the field we are working on here
8639: my $field='';
8640: # work our way through all characters in record
8641: foreach my $character ($record=~/(.)/g) {
8642: if ($character eq $looking_for) {
8643: if ($character ne $separator) {
8644: # Found the end of a quote, again looking for separator
8645: $looking_for=$separator;
8646: $ignore=1;
8647: } else {
8648: # Found a separator, store away what we got
8649: $components{&takeleft($i)}=$field;
8650: $i++;
8651: $just_found_separator=1;
8652: $ignore=0;
8653: $field='';
8654: }
8655: next;
8656: }
8657: # single or double quotation marks after a separator indicate beginning of a quote
8658: # we are now looking for the end of the quote and need to ignore separators
8659: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8660: $looking_for=$character;
8661: next;
8662: }
8663: # ignore would be true after we reached the end of a quote
8664: if ($ignore) { next; }
8665: if (($just_found_separator) && ($character=~/\s/)) { next; }
8666: $field.=$character;
8667: $just_found_separator=0;
1.31 albertel 8668: }
1.561 www 8669: # catch the very last entry, since we never encountered the separator
8670: $components{&takeleft($i)}=$field;
1.31 albertel 8671: }
8672: return %components;
8673: }
8674:
1.144 matthew 8675: ######################################################
8676: ######################################################
8677:
1.56 matthew 8678: =pod
8679:
1.648 raeburn 8680: =item * &upfile_select_html()
1.41 ng 8681:
1.144 matthew 8682: Return HTML code to select a file from the users machine and specify
8683: the file type.
1.41 ng 8684:
8685: =cut
8686:
1.144 matthew 8687: ######################################################
8688: ######################################################
1.31 albertel 8689: sub upfile_select_html {
1.144 matthew 8690: my %Types = (
8691: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8692: semisv => &mt('Semicolon separated values'),
1.144 matthew 8693: space => &mt('Space separated'),
8694: tab => &mt('Tabulator separated'),
8695: # xml => &mt('HTML/XML'),
8696: );
8697: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8698: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8699: foreach my $type (sort(keys(%Types))) {
8700: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8701: }
8702: $Str .= "</select>\n";
8703: return $Str;
1.31 albertel 8704: }
8705:
1.301 albertel 8706: sub get_samples {
8707: my ($records,$toget) = @_;
8708: my @samples=({});
8709: my $got=0;
8710: foreach my $rec (@$records) {
8711: my %temp = &record_sep($rec);
8712: if (! grep(/\S/, values(%temp))) { next; }
8713: if (%temp) {
8714: $samples[$got]=\%temp;
8715: $got++;
8716: if ($got == $toget) { last; }
8717: }
8718: }
8719: return \@samples;
8720: }
8721:
1.144 matthew 8722: ######################################################
8723: ######################################################
8724:
1.56 matthew 8725: =pod
8726:
1.648 raeburn 8727: =item * &csv_print_samples($r,$records)
1.41 ng 8728:
8729: Prints a table of sample values from each column uploaded $r is an
8730: Apache Request ref, $records is an arrayref from
8731: &Apache::loncommon::upfile_record_sep
8732:
8733: =cut
8734:
1.144 matthew 8735: ######################################################
8736: ######################################################
1.31 albertel 8737: sub csv_print_samples {
8738: my ($r,$records) = @_;
1.662 bisitz 8739: my $samples = &get_samples($records,5);
1.301 albertel 8740:
1.594 raeburn 8741: $r->print(&mt('Samples').'<br />'.&start_data_table().
8742: &start_data_table_header_row());
1.356 albertel 8743: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8744: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8745: $r->print(&end_data_table_header_row());
1.301 albertel 8746: foreach my $hash (@$samples) {
1.594 raeburn 8747: $r->print(&start_data_table_row());
1.356 albertel 8748: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8749: $r->print('<td>');
1.356 albertel 8750: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8751: $r->print('</td>');
8752: }
1.594 raeburn 8753: $r->print(&end_data_table_row());
1.31 albertel 8754: }
1.594 raeburn 8755: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8756: }
8757:
1.144 matthew 8758: ######################################################
8759: ######################################################
8760:
1.56 matthew 8761: =pod
8762:
1.648 raeburn 8763: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8764:
8765: Prints a table to create associations between values and table columns.
1.144 matthew 8766:
1.41 ng 8767: $r is an Apache Request ref,
8768: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8769: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8770:
8771: =cut
8772:
1.144 matthew 8773: ######################################################
8774: ######################################################
1.31 albertel 8775: sub csv_print_select_table {
8776: my ($r,$records,$d) = @_;
1.301 albertel 8777: my $i=0;
8778: my $samples = &get_samples($records,1);
1.144 matthew 8779: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8780: &start_data_table().&start_data_table_header_row().
1.144 matthew 8781: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8782: '<th>'.&mt('Column').'</th>'.
8783: &end_data_table_header_row()."\n");
1.356 albertel 8784: foreach my $array_ref (@$d) {
8785: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8786: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8787:
1.875 bisitz 8788: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8789: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8790: $r->print('<option value="none"></option>');
1.356 albertel 8791: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8792: $r->print('<option value="'.$sample.'"'.
8793: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8794: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8795: }
1.594 raeburn 8796: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8797: $i++;
8798: }
1.594 raeburn 8799: $r->print(&end_data_table());
1.31 albertel 8800: $i--;
8801: return $i;
8802: }
1.56 matthew 8803:
1.144 matthew 8804: ######################################################
8805: ######################################################
8806:
1.56 matthew 8807: =pod
1.31 albertel 8808:
1.648 raeburn 8809: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8810:
8811: Prints a table of sample values from the upload and can make associate samples to internal names.
8812:
8813: $r is an Apache Request ref,
8814: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8815: $d is an array of 2 element arrays (internal name, displayed name)
8816:
8817: =cut
8818:
1.144 matthew 8819: ######################################################
8820: ######################################################
1.31 albertel 8821: sub csv_samples_select_table {
8822: my ($r,$records,$d) = @_;
8823: my $i=0;
1.144 matthew 8824: #
1.662 bisitz 8825: my $max_samples = 5;
8826: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8827: $r->print(&start_data_table().
8828: &start_data_table_header_row().'<th>'.
8829: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8830: &end_data_table_header_row());
1.301 albertel 8831:
8832: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8833: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8834: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8835: foreach my $option (@$d) {
8836: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8837: $r->print('<option value="'.$value.'"'.
1.253 albertel 8838: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8839: $display.'</option>');
1.31 albertel 8840: }
8841: $r->print('</select></td><td>');
1.662 bisitz 8842: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8843: if (defined($samples->[$line]{$key})) {
8844: $r->print($samples->[$line]{$key}."<br />\n");
8845: }
8846: }
1.594 raeburn 8847: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8848: $i++;
8849: }
1.594 raeburn 8850: $r->print(&end_data_table());
1.31 albertel 8851: $i--;
8852: return($i);
1.115 matthew 8853: }
8854:
1.144 matthew 8855: ######################################################
8856: ######################################################
8857:
1.115 matthew 8858: =pod
8859:
1.648 raeburn 8860: =item * &clean_excel_name($name)
1.115 matthew 8861:
8862: Returns a replacement for $name which does not contain any illegal characters.
8863:
8864: =cut
8865:
1.144 matthew 8866: ######################################################
8867: ######################################################
1.115 matthew 8868: sub clean_excel_name {
8869: my ($name) = @_;
8870: $name =~ s/[:\*\?\/\\]//g;
8871: if (length($name) > 31) {
8872: $name = substr($name,0,31);
8873: }
8874: return $name;
1.25 albertel 8875: }
1.84 albertel 8876:
1.85 albertel 8877: =pod
8878:
1.648 raeburn 8879: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8880:
8881: Returns either 1 or undef
8882:
8883: 1 if the part is to be hidden, undef if it is to be shown
8884:
8885: Arguments are:
8886:
8887: $id the id of the part to be checked
8888: $symb, optional the symb of the resource to check
8889: $udom, optional the domain of the user to check for
8890: $uname, optional the username of the user to check for
8891:
8892: =cut
1.84 albertel 8893:
8894: sub check_if_partid_hidden {
8895: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8896: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8897: $symb,$udom,$uname);
1.141 albertel 8898: my $truth=1;
8899: #if the string starts with !, then the list is the list to show not hide
8900: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8901: my @hiddenlist=split(/,/,$hiddenparts);
8902: foreach my $checkid (@hiddenlist) {
1.141 albertel 8903: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8904: }
1.141 albertel 8905: return !$truth;
1.84 albertel 8906: }
1.127 matthew 8907:
1.138 matthew 8908:
8909: ############################################################
8910: ############################################################
8911:
8912: =pod
8913:
1.157 matthew 8914: =back
8915:
1.138 matthew 8916: =head1 cgi-bin script and graphing routines
8917:
1.157 matthew 8918: =over 4
8919:
1.648 raeburn 8920: =item * &get_cgi_id()
1.138 matthew 8921:
8922: Inputs: none
8923:
8924: Returns an id which can be used to pass environment variables
8925: to various cgi-bin scripts. These environment variables will
8926: be removed from the users environment after a given time by
8927: the routine &Apache::lonnet::transfer_profile_to_env.
8928:
8929: =cut
8930:
8931: ############################################################
8932: ############################################################
1.152 albertel 8933: my $uniq=0;
1.136 matthew 8934: sub get_cgi_id {
1.154 albertel 8935: $uniq=($uniq+1)%100000;
1.280 albertel 8936: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8937: }
8938:
1.127 matthew 8939: ############################################################
8940: ############################################################
8941:
8942: =pod
8943:
1.648 raeburn 8944: =item * &DrawBarGraph()
1.127 matthew 8945:
1.138 matthew 8946: Facilitates the plotting of data in a (stacked) bar graph.
8947: Puts plot definition data into the users environment in order for
8948: graph.png to plot it. Returns an <img> tag for the plot.
8949: The bars on the plot are labeled '1','2',...,'n'.
8950:
8951: Inputs:
8952:
8953: =over 4
8954:
8955: =item $Title: string, the title of the plot
8956:
8957: =item $xlabel: string, text describing the X-axis of the plot
8958:
8959: =item $ylabel: string, text describing the Y-axis of the plot
8960:
8961: =item $Max: scalar, the maximum Y value to use in the plot
8962: If $Max is < any data point, the graph will not be rendered.
8963:
1.140 matthew 8964: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8965: they are plotted. If undefined, default values will be used.
8966:
1.178 matthew 8967: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8968:
1.138 matthew 8969: =item @Values: An array of array references. Each array reference holds data
8970: to be plotted in a stacked bar chart.
8971:
1.239 matthew 8972: =item If the final element of @Values is a hash reference the key/value
8973: pairs will be added to the graph definition.
8974:
1.138 matthew 8975: =back
8976:
8977: Returns:
8978:
8979: An <img> tag which references graph.png and the appropriate identifying
8980: information for the plot.
8981:
1.127 matthew 8982: =cut
8983:
8984: ############################################################
8985: ############################################################
1.134 matthew 8986: sub DrawBarGraph {
1.178 matthew 8987: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8988: #
8989: if (! defined($colors)) {
8990: $colors = ['#33ff00',
8991: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8992: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8993: ];
8994: }
1.228 matthew 8995: my $extra_settings = {};
8996: if (ref($Values[-1]) eq 'HASH') {
8997: $extra_settings = pop(@Values);
8998: }
1.127 matthew 8999: #
1.136 matthew 9000: my $identifier = &get_cgi_id();
9001: my $id = 'cgi.'.$identifier;
1.129 matthew 9002: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9003: return '';
9004: }
1.225 matthew 9005: #
9006: my @Labels;
9007: if (defined($labels)) {
9008: @Labels = @$labels;
9009: } else {
9010: for (my $i=0;$i<@{$Values[0]};$i++) {
9011: push (@Labels,$i+1);
9012: }
9013: }
9014: #
1.129 matthew 9015: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9016: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9017: my %ValuesHash;
9018: my $NumSets=1;
9019: foreach my $array (@Values) {
9020: next if (! ref($array));
1.136 matthew 9021: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9022: join(',',@$array);
1.129 matthew 9023: }
1.127 matthew 9024: #
1.136 matthew 9025: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9026: if ($NumBars < 3) {
9027: $width = 120+$NumBars*32;
1.220 matthew 9028: $xskip = 1;
1.225 matthew 9029: $bar_width = 30;
9030: } elsif ($NumBars < 5) {
9031: $width = 120+$NumBars*20;
9032: $xskip = 1;
9033: $bar_width = 20;
1.220 matthew 9034: } elsif ($NumBars < 10) {
1.136 matthew 9035: $width = 120+$NumBars*15;
9036: $xskip = 1;
9037: $bar_width = 15;
9038: } elsif ($NumBars <= 25) {
9039: $width = 120+$NumBars*11;
9040: $xskip = 5;
9041: $bar_width = 8;
9042: } elsif ($NumBars <= 50) {
9043: $width = 120+$NumBars*8;
9044: $xskip = 5;
9045: $bar_width = 4;
9046: } else {
9047: $width = 120+$NumBars*8;
9048: $xskip = 5;
9049: $bar_width = 4;
9050: }
9051: #
1.137 matthew 9052: $Max = 1 if ($Max < 1);
9053: if ( int($Max) < $Max ) {
9054: $Max++;
9055: $Max = int($Max);
9056: }
1.127 matthew 9057: $Title = '' if (! defined($Title));
9058: $xlabel = '' if (! defined($xlabel));
9059: $ylabel = '' if (! defined($ylabel));
1.369 www 9060: $ValuesHash{$id.'.title'} = &escape($Title);
9061: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9062: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9063: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9064: $ValuesHash{$id.'.NumBars'} = $NumBars;
9065: $ValuesHash{$id.'.NumSets'} = $NumSets;
9066: $ValuesHash{$id.'.PlotType'} = 'bar';
9067: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9068: $ValuesHash{$id.'.height'} = $height;
9069: $ValuesHash{$id.'.width'} = $width;
9070: $ValuesHash{$id.'.xskip'} = $xskip;
9071: $ValuesHash{$id.'.bar_width'} = $bar_width;
9072: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9073: #
1.228 matthew 9074: # Deal with other parameters
9075: while (my ($key,$value) = each(%$extra_settings)) {
9076: $ValuesHash{$id.'.'.$key} = $value;
9077: }
9078: #
1.646 raeburn 9079: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9080: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9081: }
9082:
9083: ############################################################
9084: ############################################################
9085:
9086: =pod
9087:
1.648 raeburn 9088: =item * &DrawXYGraph()
1.137 matthew 9089:
1.138 matthew 9090: Facilitates the plotting of data in an XY graph.
9091: Puts plot definition data into the users environment in order for
9092: graph.png to plot it. Returns an <img> tag for the plot.
9093:
9094: Inputs:
9095:
9096: =over 4
9097:
9098: =item $Title: string, the title of the plot
9099:
9100: =item $xlabel: string, text describing the X-axis of the plot
9101:
9102: =item $ylabel: string, text describing the Y-axis of the plot
9103:
9104: =item $Max: scalar, the maximum Y value to use in the plot
9105: If $Max is < any data point, the graph will not be rendered.
9106:
9107: =item $colors: Array ref containing the hex color codes for the data to be
9108: plotted in. If undefined, default values will be used.
9109:
9110: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9111:
9112: =item $Ydata: Array ref containing Array refs.
1.185 www 9113: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9114:
9115: =item %Values: hash indicating or overriding any default values which are
9116: passed to graph.png.
9117: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9118:
9119: =back
9120:
9121: Returns:
9122:
9123: An <img> tag which references graph.png and the appropriate identifying
9124: information for the plot.
9125:
1.137 matthew 9126: =cut
9127:
9128: ############################################################
9129: ############################################################
9130: sub DrawXYGraph {
9131: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9132: #
9133: # Create the identifier for the graph
9134: my $identifier = &get_cgi_id();
9135: my $id = 'cgi.'.$identifier;
9136: #
9137: $Title = '' if (! defined($Title));
9138: $xlabel = '' if (! defined($xlabel));
9139: $ylabel = '' if (! defined($ylabel));
9140: my %ValuesHash =
9141: (
1.369 www 9142: $id.'.title' => &escape($Title),
9143: $id.'.xlabel' => &escape($xlabel),
9144: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9145: $id.'.y_max_value'=> $Max,
9146: $id.'.labels' => join(',',@$Xlabels),
9147: $id.'.PlotType' => 'XY',
9148: );
9149: #
9150: if (defined($colors) && ref($colors) eq 'ARRAY') {
9151: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9152: }
9153: #
9154: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9155: return '';
9156: }
9157: my $NumSets=1;
1.138 matthew 9158: foreach my $array (@{$Ydata}){
1.137 matthew 9159: next if (! ref($array));
9160: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9161: }
1.138 matthew 9162: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9163: #
9164: # Deal with other parameters
9165: while (my ($key,$value) = each(%Values)) {
9166: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9167: }
9168: #
1.646 raeburn 9169: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9170: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9171: }
9172:
9173: ############################################################
9174: ############################################################
9175:
9176: =pod
9177:
1.648 raeburn 9178: =item * &DrawXYYGraph()
1.138 matthew 9179:
9180: Facilitates the plotting of data in an XY graph with two Y axes.
9181: Puts plot definition data into the users environment in order for
9182: graph.png to plot it. Returns an <img> tag for the plot.
9183:
9184: Inputs:
9185:
9186: =over 4
9187:
9188: =item $Title: string, the title of the plot
9189:
9190: =item $xlabel: string, text describing the X-axis of the plot
9191:
9192: =item $ylabel: string, text describing the Y-axis of the plot
9193:
9194: =item $colors: Array ref containing the hex color codes for the data to be
9195: plotted in. If undefined, default values will be used.
9196:
9197: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9198:
9199: =item $Ydata1: The first data set
9200:
9201: =item $Min1: The minimum value of the left Y-axis
9202:
9203: =item $Max1: The maximum value of the left Y-axis
9204:
9205: =item $Ydata2: The second data set
9206:
9207: =item $Min2: The minimum value of the right Y-axis
9208:
9209: =item $Max2: The maximum value of the left Y-axis
9210:
9211: =item %Values: hash indicating or overriding any default values which are
9212: passed to graph.png.
9213: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9214:
9215: =back
9216:
9217: Returns:
9218:
9219: An <img> tag which references graph.png and the appropriate identifying
9220: information for the plot.
1.136 matthew 9221:
9222: =cut
9223:
9224: ############################################################
9225: ############################################################
1.137 matthew 9226: sub DrawXYYGraph {
9227: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9228: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9229: #
9230: # Create the identifier for the graph
9231: my $identifier = &get_cgi_id();
9232: my $id = 'cgi.'.$identifier;
9233: #
9234: $Title = '' if (! defined($Title));
9235: $xlabel = '' if (! defined($xlabel));
9236: $ylabel = '' if (! defined($ylabel));
9237: my %ValuesHash =
9238: (
1.369 www 9239: $id.'.title' => &escape($Title),
9240: $id.'.xlabel' => &escape($xlabel),
9241: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9242: $id.'.labels' => join(',',@$Xlabels),
9243: $id.'.PlotType' => 'XY',
9244: $id.'.NumSets' => 2,
1.137 matthew 9245: $id.'.two_axes' => 1,
9246: $id.'.y1_max_value' => $Max1,
9247: $id.'.y1_min_value' => $Min1,
9248: $id.'.y2_max_value' => $Max2,
9249: $id.'.y2_min_value' => $Min2,
1.136 matthew 9250: );
9251: #
1.137 matthew 9252: if (defined($colors) && ref($colors) eq 'ARRAY') {
9253: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9254: }
9255: #
9256: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9257: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9258: return '';
9259: }
9260: my $NumSets=1;
1.137 matthew 9261: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9262: next if (! ref($array));
9263: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9264: }
9265: #
9266: # Deal with other parameters
9267: while (my ($key,$value) = each(%Values)) {
9268: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9269: }
9270: #
1.646 raeburn 9271: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9272: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9273: }
9274:
9275: ############################################################
9276: ############################################################
9277:
9278: =pod
9279:
1.157 matthew 9280: =back
9281:
1.139 matthew 9282: =head1 Statistics helper routines?
9283:
9284: Bad place for them but what the hell.
9285:
1.157 matthew 9286: =over 4
9287:
1.648 raeburn 9288: =item * &chartlink()
1.139 matthew 9289:
9290: Returns a link to the chart for a specific student.
9291:
9292: Inputs:
9293:
9294: =over 4
9295:
9296: =item $linktext: The text of the link
9297:
9298: =item $sname: The students username
9299:
9300: =item $sdomain: The students domain
9301:
9302: =back
9303:
1.157 matthew 9304: =back
9305:
1.139 matthew 9306: =cut
9307:
9308: ############################################################
9309: ############################################################
9310: sub chartlink {
9311: my ($linktext, $sname, $sdomain) = @_;
9312: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9313: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9314: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9315: '">'.$linktext.'</a>';
1.153 matthew 9316: }
9317:
9318: #######################################################
9319: #######################################################
9320:
9321: =pod
9322:
9323: =head1 Course Environment Routines
1.157 matthew 9324:
9325: =over 4
1.153 matthew 9326:
1.648 raeburn 9327: =item * &restore_course_settings()
1.153 matthew 9328:
1.648 raeburn 9329: =item * &store_course_settings()
1.153 matthew 9330:
9331: Restores/Store indicated form parameters from the course environment.
9332: Will not overwrite existing values of the form parameters.
9333:
9334: Inputs:
9335: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9336:
9337: a hash ref describing the data to be stored. For example:
9338:
9339: %Save_Parameters = ('Status' => 'scalar',
9340: 'chartoutputmode' => 'scalar',
9341: 'chartoutputdata' => 'scalar',
9342: 'Section' => 'array',
1.373 raeburn 9343: 'Group' => 'array',
1.153 matthew 9344: 'StudentData' => 'array',
9345: 'Maps' => 'array');
9346:
9347: Returns: both routines return nothing
9348:
1.631 raeburn 9349: =back
9350:
1.153 matthew 9351: =cut
9352:
9353: #######################################################
9354: #######################################################
9355: sub store_course_settings {
1.496 albertel 9356: return &store_settings($env{'request.course.id'},@_);
9357: }
9358:
9359: sub store_settings {
1.153 matthew 9360: # save to the environment
9361: # appenv the same items, just to be safe
1.300 albertel 9362: my $udom = $env{'user.domain'};
9363: my $uname = $env{'user.name'};
1.496 albertel 9364: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9365: my %SaveHash;
9366: my %AppHash;
9367: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9368: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9369: my $envname = 'environment.'.$basename;
1.258 albertel 9370: if (exists($env{'form.'.$setting})) {
1.153 matthew 9371: # Save this value away
9372: if ($type eq 'scalar' &&
1.258 albertel 9373: (! exists($env{$envname}) ||
9374: $env{$envname} ne $env{'form.'.$setting})) {
9375: $SaveHash{$basename} = $env{'form.'.$setting};
9376: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9377: } elsif ($type eq 'array') {
9378: my $stored_form;
1.258 albertel 9379: if (ref($env{'form.'.$setting})) {
1.153 matthew 9380: $stored_form = join(',',
9381: map {
1.369 www 9382: &escape($_);
1.258 albertel 9383: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9384: } else {
9385: $stored_form =
1.369 www 9386: &escape($env{'form.'.$setting});
1.153 matthew 9387: }
9388: # Determine if the array contents are the same.
1.258 albertel 9389: if ($stored_form ne $env{$envname}) {
1.153 matthew 9390: $SaveHash{$basename} = $stored_form;
9391: $AppHash{$envname} = $stored_form;
9392: }
9393: }
9394: }
9395: }
9396: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9397: $udom,$uname);
1.153 matthew 9398: if ($put_result !~ /^(ok|delayed)/) {
9399: &Apache::lonnet::logthis('unable to save form parameters, '.
9400: 'got error:'.$put_result);
9401: }
9402: # Make sure these settings stick around in this session, too
1.646 raeburn 9403: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9404: return;
9405: }
9406:
9407: sub restore_course_settings {
1.499 albertel 9408: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9409: }
9410:
9411: sub restore_settings {
9412: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9413: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9414: next if (exists($env{'form.'.$setting}));
1.496 albertel 9415: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9416: '.'.$setting;
1.258 albertel 9417: if (exists($env{$envname})) {
1.153 matthew 9418: if ($type eq 'scalar') {
1.258 albertel 9419: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9420: } elsif ($type eq 'array') {
1.258 albertel 9421: $env{'form.'.$setting} = [
1.153 matthew 9422: map {
1.369 www 9423: &unescape($_);
1.258 albertel 9424: } split(',',$env{$envname})
1.153 matthew 9425: ];
9426: }
9427: }
9428: }
1.127 matthew 9429: }
9430:
1.618 raeburn 9431: #######################################################
9432: #######################################################
9433:
9434: =pod
9435:
9436: =head1 Domain E-mail Routines
9437:
9438: =over 4
9439:
1.648 raeburn 9440: =item * &build_recipient_list()
1.618 raeburn 9441:
1.884 raeburn 9442: Build recipient lists for five types of e-mail:
1.766 raeburn 9443: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9444: (d) Help requests, (e) Course requests needing approval, generated by
9445: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9446: loncoursequeueadmin.pm respectively.
1.618 raeburn 9447:
9448: Inputs:
1.619 raeburn 9449: defmail (scalar - email address of default recipient),
1.618 raeburn 9450: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9451: defdom (domain for which to retrieve configuration settings),
9452: origmail (scalar - email address of recipient from loncapa.conf,
9453: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9454:
1.655 raeburn 9455: Returns: comma separated list of addresses to which to send e-mail.
9456:
9457: =back
1.618 raeburn 9458:
9459: =cut
9460:
9461: ############################################################
9462: ############################################################
9463: sub build_recipient_list {
1.619 raeburn 9464: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9465: my @recipients;
9466: my $otheremails;
9467: my %domconfig =
9468: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9469: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9470: if (exists($domconfig{'contacts'}{$mailing})) {
9471: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9472: my @contacts = ('adminemail','supportemail');
9473: foreach my $item (@contacts) {
9474: if ($domconfig{'contacts'}{$mailing}{$item}) {
9475: my $addr = $domconfig{'contacts'}{$item};
9476: if (!grep(/^\Q$addr\E$/,@recipients)) {
9477: push(@recipients,$addr);
9478: }
1.619 raeburn 9479: }
1.766 raeburn 9480: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9481: }
9482: }
1.766 raeburn 9483: } elsif ($origmail ne '') {
9484: push(@recipients,$origmail);
1.618 raeburn 9485: }
1.619 raeburn 9486: } elsif ($origmail ne '') {
9487: push(@recipients,$origmail);
1.618 raeburn 9488: }
1.688 raeburn 9489: if (defined($defmail)) {
9490: if ($defmail ne '') {
9491: push(@recipients,$defmail);
9492: }
1.618 raeburn 9493: }
9494: if ($otheremails) {
1.619 raeburn 9495: my @others;
9496: if ($otheremails =~ /,/) {
9497: @others = split(/,/,$otheremails);
1.618 raeburn 9498: } else {
1.619 raeburn 9499: push(@others,$otheremails);
9500: }
9501: foreach my $addr (@others) {
9502: if (!grep(/^\Q$addr\E$/,@recipients)) {
9503: push(@recipients,$addr);
9504: }
1.618 raeburn 9505: }
9506: }
1.619 raeburn 9507: my $recipientlist = join(',',@recipients);
1.618 raeburn 9508: return $recipientlist;
9509: }
9510:
1.127 matthew 9511: ############################################################
9512: ############################################################
1.154 albertel 9513:
1.655 raeburn 9514: =pod
9515:
9516: =head1 Course Catalog Routines
9517:
9518: =over 4
9519:
9520: =item * &gather_categories()
9521:
9522: Converts category definitions - keys of categories hash stored in
9523: coursecategories in configuration.db on the primary library server in a
9524: domain - to an array. Also generates javascript and idx hash used to
9525: generate Domain Coordinator interface for editing Course Categories.
9526:
9527: Inputs:
1.663 raeburn 9528:
1.655 raeburn 9529: categories (reference to hash of category definitions).
1.663 raeburn 9530:
1.655 raeburn 9531: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9532: categories and subcategories).
1.663 raeburn 9533:
1.655 raeburn 9534: idx (reference to hash of counters used in Domain Coordinator interface for
9535: editing Course Categories).
1.663 raeburn 9536:
1.655 raeburn 9537: jsarray (reference to array of categories used to create Javascript arrays for
9538: Domain Coordinator interface for editing Course Categories).
9539:
9540: Returns: nothing
9541:
9542: Side effects: populates cats, idx and jsarray.
9543:
9544: =cut
9545:
9546: sub gather_categories {
9547: my ($categories,$cats,$idx,$jsarray) = @_;
9548: my %counters;
9549: my $num = 0;
9550: foreach my $item (keys(%{$categories})) {
9551: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9552: if ($container eq '' && $depth == 0) {
9553: $cats->[$depth][$categories->{$item}] = $cat;
9554: } else {
9555: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9556: }
9557: my ($escitem,$tail) = split(/:/,$item,2);
9558: if ($counters{$tail} eq '') {
9559: $counters{$tail} = $num;
9560: $num ++;
9561: }
9562: if (ref($idx) eq 'HASH') {
9563: $idx->{$item} = $counters{$tail};
9564: }
9565: if (ref($jsarray) eq 'ARRAY') {
9566: push(@{$jsarray->[$counters{$tail}]},$item);
9567: }
9568: }
9569: return;
9570: }
9571:
9572: =pod
9573:
9574: =item * &extract_categories()
9575:
9576: Used to generate breadcrumb trails for course categories.
9577:
9578: Inputs:
1.663 raeburn 9579:
1.655 raeburn 9580: categories (reference to hash of category definitions).
1.663 raeburn 9581:
1.655 raeburn 9582: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9583: categories and subcategories).
1.663 raeburn 9584:
1.655 raeburn 9585: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9586:
1.655 raeburn 9587: allitems (reference to hash - key is category key
9588: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9589:
1.655 raeburn 9590: idx (reference to hash of counters used in Domain Coordinator interface for
9591: editing Course Categories).
1.663 raeburn 9592:
1.655 raeburn 9593: jsarray (reference to array of categories used to create Javascript arrays for
9594: Domain Coordinator interface for editing Course Categories).
9595:
1.665 raeburn 9596: subcats (reference to hash of arrays containing all subcategories within each
9597: category, -recursive)
9598:
1.655 raeburn 9599: Returns: nothing
9600:
9601: Side effects: populates trails and allitems hash references.
9602:
9603: =cut
9604:
9605: sub extract_categories {
1.665 raeburn 9606: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9607: if (ref($categories) eq 'HASH') {
9608: &gather_categories($categories,$cats,$idx,$jsarray);
9609: if (ref($cats->[0]) eq 'ARRAY') {
9610: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9611: my $name = $cats->[0][$i];
9612: my $item = &escape($name).'::0';
9613: my $trailstr;
9614: if ($name eq 'instcode') {
9615: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9616: } elsif ($name eq 'communities') {
9617: $trailstr = &mt('Communities');
1.655 raeburn 9618: } else {
9619: $trailstr = $name;
9620: }
9621: if ($allitems->{$item} eq '') {
9622: push(@{$trails},$trailstr);
9623: $allitems->{$item} = scalar(@{$trails})-1;
9624: }
9625: my @parents = ($name);
9626: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9627: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9628: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9629: if (ref($subcats) eq 'HASH') {
9630: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9631: }
9632: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9633: }
9634: } else {
9635: if (ref($subcats) eq 'HASH') {
9636: $subcats->{$item} = [];
1.655 raeburn 9637: }
9638: }
9639: }
9640: }
9641: }
9642: return;
9643: }
9644:
9645: =pod
9646:
9647: =item *&recurse_categories()
9648:
9649: Recursively used to generate breadcrumb trails for course categories.
9650:
9651: Inputs:
1.663 raeburn 9652:
1.655 raeburn 9653: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9654: categories and subcategories).
1.663 raeburn 9655:
1.655 raeburn 9656: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9657:
9658: category (current course category, for which breadcrumb trail is being generated).
9659:
9660: trails (reference to array of breadcrumb trails for each category).
9661:
1.655 raeburn 9662: allitems (reference to hash - key is category key
9663: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9664:
1.655 raeburn 9665: parents (array containing containers directories for current category,
9666: back to top level).
9667:
9668: Returns: nothing
9669:
9670: Side effects: populates trails and allitems hash references
9671:
9672: =cut
9673:
9674: sub recurse_categories {
1.665 raeburn 9675: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9676: my $shallower = $depth - 1;
9677: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9678: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9679: my $name = $cats->[$depth]{$category}[$k];
9680: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9681: my $trailstr = join(' -> ',(@{$parents},$category));
9682: if ($allitems->{$item} eq '') {
9683: push(@{$trails},$trailstr);
9684: $allitems->{$item} = scalar(@{$trails})-1;
9685: }
9686: my $deeper = $depth+1;
9687: push(@{$parents},$category);
1.665 raeburn 9688: if (ref($subcats) eq 'HASH') {
9689: my $subcat = &escape($name).':'.$category.':'.$depth;
9690: for (my $j=@{$parents}; $j>=0; $j--) {
9691: my $higher;
9692: if ($j > 0) {
9693: $higher = &escape($parents->[$j]).':'.
9694: &escape($parents->[$j-1]).':'.$j;
9695: } else {
9696: $higher = &escape($parents->[$j]).'::'.$j;
9697: }
9698: push(@{$subcats->{$higher}},$subcat);
9699: }
9700: }
9701: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9702: $subcats);
1.655 raeburn 9703: pop(@{$parents});
9704: }
9705: } else {
9706: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9707: my $trailstr = join(' -> ',(@{$parents},$category));
9708: if ($allitems->{$item} eq '') {
9709: push(@{$trails},$trailstr);
9710: $allitems->{$item} = scalar(@{$trails})-1;
9711: }
9712: }
9713: return;
9714: }
9715:
1.663 raeburn 9716: =pod
9717:
9718: =item *&assign_categories_table()
9719:
9720: Create a datatable for display of hierarchical categories in a domain,
9721: with checkboxes to allow a course to be categorized.
9722:
9723: Inputs:
9724:
9725: cathash - reference to hash of categories defined for the domain (from
9726: configuration.db)
9727:
9728: currcat - scalar with an & separated list of categories assigned to a course.
9729:
1.919 raeburn 9730: type - scalar contains course type (Course or Community).
9731:
1.663 raeburn 9732: Returns: $output (markup to be displayed)
9733:
9734: =cut
9735:
9736: sub assign_categories_table {
1.919 raeburn 9737: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9738: my $output;
9739: if (ref($cathash) eq 'HASH') {
9740: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9741: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9742: $maxdepth = scalar(@cats);
9743: if (@cats > 0) {
9744: my $itemcount = 0;
9745: if (ref($cats[0]) eq 'ARRAY') {
9746: my @currcategories;
9747: if ($currcat ne '') {
9748: @currcategories = split('&',$currcat);
9749: }
1.919 raeburn 9750: my $table;
1.663 raeburn 9751: for (my $i=0; $i<@{$cats[0]}; $i++) {
9752: my $parent = $cats[0][$i];
1.919 raeburn 9753: next if ($parent eq 'instcode');
9754: if ($type eq 'Community') {
9755: next unless ($parent eq 'communities');
9756: } else {
9757: next if ($parent eq 'communities');
9758: }
1.663 raeburn 9759: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9760: my $item = &escape($parent).'::0';
9761: my $checked = '';
9762: if (@currcategories > 0) {
9763: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9764: $checked = ' checked="checked"';
1.663 raeburn 9765: }
9766: }
1.919 raeburn 9767: my $parent_title = $parent;
9768: if ($parent eq 'communities') {
9769: $parent_title = &mt('Communities');
9770: }
9771: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9772: '<input type="checkbox" name="usecategory" value="'.
9773: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9774: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9775: my $depth = 1;
9776: push(@path,$parent);
1.919 raeburn 9777: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9778: pop(@path);
1.919 raeburn 9779: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9780: $itemcount ++;
9781: }
1.919 raeburn 9782: if ($itemcount) {
9783: $output = &Apache::loncommon::start_data_table().
9784: $table.
9785: &Apache::loncommon::end_data_table();
9786: }
1.663 raeburn 9787: }
9788: }
9789: }
9790: return $output;
9791: }
9792:
9793: =pod
9794:
9795: =item *&assign_category_rows()
9796:
9797: Create a datatable row for display of nested categories in a domain,
9798: with checkboxes to allow a course to be categorized,called recursively.
9799:
9800: Inputs:
9801:
9802: itemcount - track row number for alternating colors
9803:
9804: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9805: categories and subcategories.
9806:
9807: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9808:
9809: parent - parent of current category item
9810:
9811: path - Array containing all categories back up through the hierarchy from the
9812: current category to the top level.
9813:
9814: currcategories - reference to array of current categories assigned to the course
9815:
9816: Returns: $output (markup to be displayed).
9817:
9818: =cut
9819:
9820: sub assign_category_rows {
9821: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9822: my ($text,$name,$item,$chgstr);
9823: if (ref($cats) eq 'ARRAY') {
9824: my $maxdepth = scalar(@{$cats});
9825: if (ref($cats->[$depth]) eq 'HASH') {
9826: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9827: my $numchildren = @{$cats->[$depth]{$parent}};
9828: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9829: $text .= '<td><table class="LC_datatable">';
9830: for (my $j=0; $j<$numchildren; $j++) {
9831: $name = $cats->[$depth]{$parent}[$j];
9832: $item = &escape($name).':'.&escape($parent).':'.$depth;
9833: my $deeper = $depth+1;
9834: my $checked = '';
9835: if (ref($currcategories) eq 'ARRAY') {
9836: if (@{$currcategories} > 0) {
9837: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9838: $checked = ' checked="checked"';
1.663 raeburn 9839: }
9840: }
9841: }
1.664 raeburn 9842: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9843: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9844: $item.'"'.$checked.' />'.$name.'</label></span>'.
9845: '<input type="hidden" name="catname" value="'.$name.'" />'.
9846: '</td><td>';
1.663 raeburn 9847: if (ref($path) eq 'ARRAY') {
9848: push(@{$path},$name);
9849: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9850: pop(@{$path});
9851: }
9852: $text .= '</td></tr>';
9853: }
9854: $text .= '</table></td>';
9855: }
9856: }
9857: }
9858: return $text;
9859: }
9860:
1.655 raeburn 9861: ############################################################
9862: ############################################################
9863:
9864:
1.443 albertel 9865: sub commit_customrole {
1.664 raeburn 9866: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9867: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9868: ($start?', '.&mt('starting').' '.localtime($start):'').
9869: ($end?', ending '.localtime($end):'').': <b>'.
9870: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9871: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9872: '</b><br />';
9873: return $output;
9874: }
9875:
9876: sub commit_standardrole {
1.541 raeburn 9877: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9878: my ($output,$logmsg,$linefeed);
9879: if ($context eq 'auto') {
9880: $linefeed = "\n";
9881: } else {
9882: $linefeed = "<br />\n";
9883: }
1.443 albertel 9884: if ($three eq 'st') {
1.541 raeburn 9885: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9886: $one,$two,$sec,$context);
9887: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9888: ($result eq 'unknown_course') || ($result eq 'refused')) {
9889: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9890: } else {
1.541 raeburn 9891: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9892: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9893: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9894: if ($context eq 'auto') {
9895: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9896: } else {
9897: $output .= '<b>'.$result.'</b>'.$linefeed.
9898: &mt('Add to classlist').': <b>ok</b>';
9899: }
9900: $output .= $linefeed;
1.443 albertel 9901: }
9902: } else {
9903: $output = &mt('Assigning').' '.$three.' in '.$url.
9904: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9905: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9906: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9907: if ($context eq 'auto') {
9908: $output .= $result.$linefeed;
9909: } else {
9910: $output .= '<b>'.$result.'</b>'.$linefeed;
9911: }
1.443 albertel 9912: }
9913: return $output;
9914: }
9915:
9916: sub commit_studentrole {
1.541 raeburn 9917: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9918: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9919: if ($context eq 'auto') {
9920: $linefeed = "\n";
9921: } else {
9922: $linefeed = '<br />'."\n";
9923: }
1.443 albertel 9924: if (defined($one) && defined($two)) {
9925: my $cid=$one.'_'.$two;
9926: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9927: my $secchange = 0;
9928: my $expire_role_result;
9929: my $modify_section_result;
1.628 raeburn 9930: if ($oldsec ne '-1') {
9931: if ($oldsec ne $sec) {
1.443 albertel 9932: $secchange = 1;
1.628 raeburn 9933: my $now = time;
1.443 albertel 9934: my $uurl='/'.$cid;
9935: $uurl=~s/\_/\//g;
9936: if ($oldsec) {
9937: $uurl.='/'.$oldsec;
9938: }
1.626 raeburn 9939: $oldsecurl = $uurl;
1.628 raeburn 9940: $expire_role_result =
1.652 raeburn 9941: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9942: if ($env{'request.course.sec'} ne '') {
9943: if ($expire_role_result eq 'refused') {
9944: my @roles = ('st');
9945: my @statuses = ('previous');
9946: my @roledoms = ($one);
9947: my $withsec = 1;
9948: my %roleshash =
9949: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9950: \@statuses,\@roles,\@roledoms,$withsec);
9951: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9952: my ($oldstart,$oldend) =
9953: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9954: if ($oldend > 0 && $oldend <= $now) {
9955: $expire_role_result = 'ok';
9956: }
9957: }
9958: }
9959: }
1.443 albertel 9960: $result = $expire_role_result;
9961: }
9962: }
9963: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9964: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9965: if ($modify_section_result =~ /^ok/) {
9966: if ($secchange == 1) {
1.628 raeburn 9967: if ($sec eq '') {
9968: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9969: } else {
9970: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9971: }
1.443 albertel 9972: } elsif ($oldsec eq '-1') {
1.628 raeburn 9973: if ($sec eq '') {
9974: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9975: } else {
9976: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9977: }
1.443 albertel 9978: } else {
1.628 raeburn 9979: if ($sec eq '') {
9980: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9981: } else {
9982: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9983: }
1.443 albertel 9984: }
9985: } else {
1.628 raeburn 9986: if ($secchange) {
9987: $$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;
9988: } else {
9989: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9990: }
1.443 albertel 9991: }
9992: $result = $modify_section_result;
9993: } elsif ($secchange == 1) {
1.628 raeburn 9994: if ($oldsec eq '') {
9995: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9996: } else {
9997: $$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;
9998: }
1.626 raeburn 9999: if ($expire_role_result eq 'refused') {
10000: my $newsecurl = '/'.$cid;
10001: $newsecurl =~ s/\_/\//g;
10002: if ($sec ne '') {
10003: $newsecurl.='/'.$sec;
10004: }
10005: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10006: if ($sec eq '') {
10007: $$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;
10008: } else {
10009: $$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;
10010: }
10011: }
10012: }
1.443 albertel 10013: }
10014: } else {
1.626 raeburn 10015: $$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 10016: $result = "error: incomplete course id\n";
10017: }
10018: return $result;
10019: }
10020:
10021: ############################################################
10022: ############################################################
10023:
1.566 albertel 10024: sub check_clone {
1.578 raeburn 10025: my ($args,$linefeed) = @_;
1.566 albertel 10026: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10027: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10028: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10029: my $clonemsg;
10030: my $can_clone = 0;
1.908 raeburn 10031: my $lctype = lc($args->{'type'});
10032: if ($lctype ne 'community') {
10033: $lctype = 'course';
10034: }
1.566 albertel 10035: if ($clonehome eq 'no_host') {
1.908 raeburn 10036: if ($args->{'type'} eq 'Community') {
10037: $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'});
10038: } else {
10039: $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'});
10040: }
1.566 albertel 10041: } else {
10042: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10043: if ($args->{'type'} eq 'Community') {
10044: if ($clonedesc{'type'} ne 'Community') {
10045: $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'});
10046: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10047: }
10048: }
1.882 raeburn 10049: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10050: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10051: $can_clone = 1;
10052: } else {
10053: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10054: $args->{'clonedomain'},$args->{'clonecourse'});
10055: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10056: if (grep(/^\*$/,@cloners)) {
10057: $can_clone = 1;
10058: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10059: $can_clone = 1;
10060: } else {
1.908 raeburn 10061: my $ccrole = 'cc';
10062: if ($args->{'type'} eq 'Community') {
10063: $ccrole = 'co';
10064: }
1.578 raeburn 10065: my %roleshash =
10066: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10067: $args->{'ccdomain'},
1.908 raeburn 10068: 'userroles',['active'],[$ccrole],
1.578 raeburn 10069: [$args->{'clonedomain'}]);
1.908 raeburn 10070: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10071: $can_clone = 1;
10072: } else {
1.908 raeburn 10073: if ($args->{'type'} eq 'Community') {
10074: $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'});
10075: } else {
10076: $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'});
10077: }
1.578 raeburn 10078: }
1.566 albertel 10079: }
1.578 raeburn 10080: }
1.566 albertel 10081: }
10082: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10083: }
10084:
1.444 albertel 10085: sub construct_course {
1.885 raeburn 10086: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10087: my $outcome;
1.541 raeburn 10088: my $linefeed = '<br />'."\n";
10089: if ($context eq 'auto') {
10090: $linefeed = "\n";
10091: }
1.566 albertel 10092:
10093: #
10094: # Are we cloning?
10095: #
10096: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10097: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10098: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10099: if ($context ne 'auto') {
1.578 raeburn 10100: if ($clonemsg ne '') {
10101: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10102: }
1.566 albertel 10103: }
10104: $outcome .= $clonemsg.$linefeed;
10105:
10106: if (!$can_clone) {
10107: return (0,$outcome);
10108: }
10109: }
10110:
1.444 albertel 10111: #
10112: # Open course
10113: #
10114: my $crstype = lc($args->{'crstype'});
10115: my %cenv=();
10116: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10117: $args->{'cdescr'},
10118: $args->{'curl'},
10119: $args->{'course_home'},
10120: $args->{'nonstandard'},
10121: $args->{'crscode'},
10122: $args->{'ccuname'}.':'.
10123: $args->{'ccdomain'},
1.882 raeburn 10124: $args->{'crstype'},
1.885 raeburn 10125: $cnum,$context,$category);
1.444 albertel 10126:
10127: # Note: The testing routines depend on this being output; see
10128: # Utils::Course. This needs to at least be output as a comment
10129: # if anyone ever decides to not show this, and Utils::Course::new
10130: # will need to be suitably modified.
1.541 raeburn 10131: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10132: #
10133: # Check if created correctly
10134: #
1.479 albertel 10135: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10136: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10137: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10138:
1.444 albertel 10139: #
1.566 albertel 10140: # Do the cloning
10141: #
10142: if ($can_clone && $cloneid) {
10143: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10144: if ($context ne 'auto') {
10145: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10146: }
10147: $outcome .= $clonemsg.$linefeed;
10148: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10149: # Copy all files
1.637 www 10150: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10151: # Restore URL
1.566 albertel 10152: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10153: # Restore title
1.566 albertel 10154: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10155: # Mark as cloned
1.566 albertel 10156: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10157: # Need to clone grading mode
10158: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10159: $cenv{'grading'}=$newenv{'grading'};
10160: # Do not clone these environment entries
10161: &Apache::lonnet::del('environment',
10162: ['default_enrollment_start_date',
10163: 'default_enrollment_end_date',
10164: 'question.email',
10165: 'policy.email',
10166: 'comment.email',
10167: 'pch.users.denied',
1.725 raeburn 10168: 'plc.users.denied',
10169: 'hidefromcat',
10170: 'categories'],
1.638 www 10171: $$crsudom,$$crsunum);
1.444 albertel 10172: }
1.566 albertel 10173:
1.444 albertel 10174: #
10175: # Set environment (will override cloned, if existing)
10176: #
10177: my @sections = ();
10178: my @xlists = ();
10179: if ($args->{'crstype'}) {
10180: $cenv{'type'}=$args->{'crstype'};
10181: }
10182: if ($args->{'crsid'}) {
10183: $cenv{'courseid'}=$args->{'crsid'};
10184: }
10185: if ($args->{'crscode'}) {
10186: $cenv{'internal.coursecode'}=$args->{'crscode'};
10187: }
10188: if ($args->{'crsquota'} ne '') {
10189: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10190: } else {
10191: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10192: }
10193: if ($args->{'ccuname'}) {
10194: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10195: ':'.$args->{'ccdomain'};
10196: } else {
10197: $cenv{'internal.courseowner'} = $args->{'curruser'};
10198: }
10199: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10200: if ($args->{'crssections'}) {
10201: $cenv{'internal.sectionnums'} = '';
10202: if ($args->{'crssections'} =~ m/,/) {
10203: @sections = split/,/,$args->{'crssections'};
10204: } else {
10205: $sections[0] = $args->{'crssections'};
10206: }
10207: if (@sections > 0) {
10208: foreach my $item (@sections) {
10209: my ($sec,$gp) = split/:/,$item;
10210: my $class = $args->{'crscode'}.$sec;
10211: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10212: $cenv{'internal.sectionnums'} .= $item.',';
10213: unless ($addcheck eq 'ok') {
10214: push @badclasses, $class;
10215: }
10216: }
10217: $cenv{'internal.sectionnums'} =~ s/,$//;
10218: }
10219: }
10220: # do not hide course coordinator from staff listing,
10221: # even if privileged
10222: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10223: # add crosslistings
10224: if ($args->{'crsxlist'}) {
10225: $cenv{'internal.crosslistings'}='';
10226: if ($args->{'crsxlist'} =~ m/,/) {
10227: @xlists = split/,/,$args->{'crsxlist'};
10228: } else {
10229: $xlists[0] = $args->{'crsxlist'};
10230: }
10231: if (@xlists > 0) {
10232: foreach my $item (@xlists) {
10233: my ($xl,$gp) = split/:/,$item;
10234: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10235: $cenv{'internal.crosslistings'} .= $item.',';
10236: unless ($addcheck eq 'ok') {
10237: push @badclasses, $xl;
10238: }
10239: }
10240: $cenv{'internal.crosslistings'} =~ s/,$//;
10241: }
10242: }
10243: if ($args->{'autoadds'}) {
10244: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10245: }
10246: if ($args->{'autodrops'}) {
10247: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10248: }
10249: # check for notification of enrollment changes
10250: my @notified = ();
10251: if ($args->{'notify_owner'}) {
10252: if ($args->{'ccuname'} ne '') {
10253: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10254: }
10255: }
10256: if ($args->{'notify_dc'}) {
10257: if ($uname ne '') {
1.630 raeburn 10258: push(@notified,$uname.':'.$udom);
1.444 albertel 10259: }
10260: }
10261: if (@notified > 0) {
10262: my $notifylist;
10263: if (@notified > 1) {
10264: $notifylist = join(',',@notified);
10265: } else {
10266: $notifylist = $notified[0];
10267: }
10268: $cenv{'internal.notifylist'} = $notifylist;
10269: }
10270: if (@badclasses > 0) {
10271: my %lt=&Apache::lonlocal::texthash(
10272: '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',
10273: 'dnhr' => 'does not have rights to access enrollment in these classes',
10274: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10275: );
1.541 raeburn 10276: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10277: ' ('.$lt{'adby'}.')';
10278: if ($context eq 'auto') {
10279: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10280: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10281: foreach my $item (@badclasses) {
10282: if ($context eq 'auto') {
10283: $outcome .= " - $item\n";
10284: } else {
10285: $outcome .= "<li>$item</li>\n";
10286: }
10287: }
10288: if ($context eq 'auto') {
10289: $outcome .= $linefeed;
10290: } else {
1.566 albertel 10291: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10292: }
10293: }
1.444 albertel 10294: }
10295: if ($args->{'no_end_date'}) {
10296: $args->{'endaccess'} = 0;
10297: }
10298: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10299: $cenv{'internal.autoend'}=$args->{'enrollend'};
10300: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10301: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10302: if ($args->{'showphotos'}) {
10303: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10304: }
10305: $cenv{'internal.authtype'} = $args->{'authtype'};
10306: $cenv{'internal.autharg'} = $args->{'autharg'};
10307: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10308: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10309: 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');
10310: if ($context eq 'auto') {
10311: $outcome .= $krb_msg;
10312: } else {
1.566 albertel 10313: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10314: }
10315: $outcome .= $linefeed;
1.444 albertel 10316: }
10317: }
10318: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10319: if ($args->{'setpolicy'}) {
10320: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10321: }
10322: if ($args->{'setcontent'}) {
10323: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10324: }
10325: }
10326: if ($args->{'reshome'}) {
10327: $cenv{'reshome'}=$args->{'reshome'}.'/';
10328: $cenv{'reshome'}=~s/\/+$/\//;
10329: }
10330: #
10331: # course has keyed access
10332: #
10333: if ($args->{'setkeys'}) {
10334: $cenv{'keyaccess'}='yes';
10335: }
10336: # if specified, key authority is not course, but user
10337: # only active if keyaccess is yes
10338: if ($args->{'keyauth'}) {
1.487 albertel 10339: my ($user,$domain) = split(':',$args->{'keyauth'});
10340: $user = &LONCAPA::clean_username($user);
10341: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10342: if ($user ne '' && $domain ne '') {
1.487 albertel 10343: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10344: }
10345: }
10346:
10347: if ($args->{'disresdis'}) {
10348: $cenv{'pch.roles.denied'}='st';
10349: }
10350: if ($args->{'disablechat'}) {
10351: $cenv{'plc.roles.denied'}='st';
10352: }
10353:
10354: # Record we've not yet viewed the Course Initialization Helper for this
10355: # course
10356: $cenv{'course.helper.not.run'} = 1;
10357: #
10358: # Use new Randomseed
10359: #
10360: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10361: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10362: #
10363: # The encryption code and receipt prefix for this course
10364: #
10365: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10366: $cenv{'internal.encpref'}=100+int(9*rand(99));
10367: #
10368: # By default, use standard grading
10369: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10370:
1.541 raeburn 10371: $outcome .= $linefeed.&mt('Setting environment').': '.
10372: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10373: #
10374: # Open all assignments
10375: #
10376: if ($args->{'openall'}) {
10377: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10378: my %storecontent = ($storeunder => time,
10379: $storeunder.'.type' => 'date_start');
10380:
10381: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10382: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10383: }
10384: #
10385: # Set first page
10386: #
10387: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10388: || ($cloneid)) {
1.445 albertel 10389: use LONCAPA::map;
1.444 albertel 10390: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10391:
10392: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10393: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10394:
1.444 albertel 10395: $outcome .= ($fatal?$errtext:'read ok').' - ';
10396: my $title; my $url;
10397: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10398: $title=&mt('Syllabus');
1.444 albertel 10399: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10400: } else {
1.690 bisitz 10401: $title=&mt('Navigate Contents');
1.444 albertel 10402: $url='/adm/navmaps';
10403: }
1.445 albertel 10404:
10405: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10406: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10407:
10408: if ($errtext) { $fatal=2; }
1.541 raeburn 10409: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10410: }
1.566 albertel 10411:
10412: return (1,$outcome);
1.444 albertel 10413: }
10414:
10415: ############################################################
10416: ############################################################
10417:
1.378 raeburn 10418: sub course_type {
10419: my ($cid) = @_;
10420: if (!defined($cid)) {
10421: $cid = $env{'request.course.id'};
10422: }
1.404 albertel 10423: if (defined($env{'course.'.$cid.'.type'})) {
10424: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10425: } else {
10426: return 'Course';
1.377 raeburn 10427: }
10428: }
1.156 albertel 10429:
1.406 raeburn 10430: sub group_term {
10431: my $crstype = &course_type();
10432: my %names = (
10433: 'Course' => 'group',
1.865 raeburn 10434: 'Community' => 'group',
1.406 raeburn 10435: );
10436: return $names{$crstype};
10437: }
10438:
1.902 raeburn 10439: sub course_types {
10440: my @types = ('official','unofficial','community');
10441: my %typename = (
10442: official => 'Official course',
10443: unofficial => 'Unofficial course',
10444: community => 'Community',
10445: );
10446: return (\@types,\%typename);
10447: }
10448:
1.156 albertel 10449: sub icon {
10450: my ($file)=@_;
1.505 albertel 10451: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10452: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10453: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10454: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10455: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10456: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10457: $curfext.".gif") {
10458: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10459: $curfext.".gif";
10460: }
10461: }
1.249 albertel 10462: return &lonhttpdurl($iconname);
1.154 albertel 10463: }
1.84 albertel 10464:
1.575 albertel 10465: sub lonhttpdurl {
1.692 www 10466: #
10467: # Had been used for "small fry" static images on separate port 8080.
10468: # Modify here if lightweight http functionality desired again.
10469: # Currently eliminated due to increasing firewall issues.
10470: #
1.575 albertel 10471: my ($url)=@_;
1.692 www 10472: return $url;
1.215 albertel 10473: }
10474:
1.213 albertel 10475: sub connection_aborted {
10476: my ($r)=@_;
10477: $r->print(" ");$r->rflush();
10478: my $c = $r->connection;
10479: return $c->aborted();
10480: }
10481:
1.221 foxr 10482: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10483: # strings as 'strings'.
10484: sub escape_single {
1.221 foxr 10485: my ($input) = @_;
1.223 albertel 10486: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10487: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10488: return $input;
10489: }
1.223 albertel 10490:
1.222 foxr 10491: # Same as escape_single, but escape's "'s This
10492: # can be used for "strings"
10493: sub escape_double {
10494: my ($input) = @_;
10495: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10496: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10497: return $input;
10498: }
1.223 albertel 10499:
1.222 foxr 10500: # Escapes the last element of a full URL.
10501: sub escape_url {
10502: my ($url) = @_;
1.238 raeburn 10503: my @urlslices = split(/\//, $url,-1);
1.369 www 10504: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10505: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10506: }
1.462 albertel 10507:
1.820 raeburn 10508: sub compare_arrays {
10509: my ($arrayref1,$arrayref2) = @_;
10510: my (@difference,%count);
10511: @difference = ();
10512: %count = ();
10513: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10514: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10515: foreach my $element (keys(%count)) {
10516: if ($count{$element} == 1) {
10517: push(@difference,$element);
10518: }
10519: }
10520: }
10521: return @difference;
10522: }
10523:
1.817 bisitz 10524: # -------------------------------------------------------- Initialize user login
1.462 albertel 10525: sub init_user_environment {
1.463 albertel 10526: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10527: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10528:
10529: my $public=($username eq 'public' && $domain eq 'public');
10530:
10531: # See if old ID present, if so, remove
10532:
10533: my ($filename,$cookie,$userroles);
10534: my $now=time;
10535:
10536: if ($public) {
10537: my $max_public=100;
10538: my $oldest;
10539: my $oldest_time=0;
10540: for(my $next=1;$next<=$max_public;$next++) {
10541: if (-e $lonids."/publicuser_$next.id") {
10542: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10543: if ($mtime<$oldest_time || !$oldest_time) {
10544: $oldest_time=$mtime;
10545: $oldest=$next;
10546: }
10547: } else {
10548: $cookie="publicuser_$next";
10549: last;
10550: }
10551: }
10552: if (!$cookie) { $cookie="publicuser_$oldest"; }
10553: } else {
1.463 albertel 10554: # if this isn't a robot, kill any existing non-robot sessions
10555: if (!$args->{'robot'}) {
10556: opendir(DIR,$lonids);
10557: while ($filename=readdir(DIR)) {
10558: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10559: unlink($lonids.'/'.$filename);
10560: }
1.462 albertel 10561: }
1.463 albertel 10562: closedir(DIR);
1.462 albertel 10563: }
10564: # Give them a new cookie
1.463 albertel 10565: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10566: : $now.$$.int(rand(10000)));
1.463 albertel 10567: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10568:
10569: # Initialize roles
10570:
10571: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10572: }
10573: # ------------------------------------ Check browser type and MathML capability
10574:
10575: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10576: $clientunicode,$clientos) = &decode_user_agent($r);
10577:
10578: # ------------------------------------------------------------- Get environment
10579:
10580: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10581: my ($tmp) = keys(%userenv);
10582: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10583: # default remote control to off
10584: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10585: } else {
10586: undef(%userenv);
10587: }
10588: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10589: $form->{'interface'}=$userenv{'interface'};
10590: }
10591: $env{'environment.remote'}=$userenv{'remote'};
10592: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10593:
10594: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10595: foreach my $option ('interface','localpath','localres') {
10596: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10597: }
10598: # --------------------------------------------------------- Write first profile
10599:
10600: {
10601: my %initial_env =
10602: ("user.name" => $username,
10603: "user.domain" => $domain,
10604: "user.home" => $authhost,
10605: "browser.type" => $clientbrowser,
10606: "browser.version" => $clientversion,
10607: "browser.mathml" => $clientmathml,
10608: "browser.unicode" => $clientunicode,
10609: "browser.os" => $clientos,
10610: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10611: "request.course.fn" => '',
10612: "request.course.uri" => '',
10613: "request.course.sec" => '',
10614: "request.role" => 'cm',
10615: "request.role.adv" => $env{'user.adv'},
10616: "request.host" => $ENV{'REMOTE_ADDR'},);
10617:
10618: if ($form->{'localpath'}) {
10619: $initial_env{"browser.localpath"} = $form->{'localpath'};
10620: $initial_env{"browser.localres"} = $form->{'localres'};
10621: }
10622:
10623: if ($public) {
10624: $initial_env{"environment.remote"} = "off";
10625: }
10626: if ($form->{'interface'}) {
10627: $form->{'interface'}=~s/\W//gs;
10628: $initial_env{"browser.interface"} = $form->{'interface'};
10629: $env{'browser.interface'}=$form->{'interface'};
10630: }
10631:
1.724 raeburn 10632: foreach my $tool ('aboutme','blog','portfolio') {
10633: $userenv{'availabletools.'.$tool} =
10634: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10635: }
10636:
1.864 raeburn 10637: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10638: $userenv{'canrequest.'.$crstype} =
10639: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10640: 'reload','requestcourses');
10641: }
10642:
1.462 albertel 10643: $env{'user.environment'} = "$lonids/$cookie.id";
10644:
10645: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10646: &GDBM_WRCREAT(),0640)) {
10647: &_add_to_env(\%disk_env,\%initial_env);
10648: &_add_to_env(\%disk_env,\%userenv,'environment.');
10649: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10650: if (ref($args->{'extra_env'})) {
10651: &_add_to_env(\%disk_env,$args->{'extra_env'});
10652: }
1.462 albertel 10653: untie(%disk_env);
10654: } else {
1.705 tempelho 10655: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10656: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10657: return 'error: '.$!;
10658: }
10659: }
10660: $env{'request.role'}='cm';
10661: $env{'request.role.adv'}=$env{'user.adv'};
10662: $env{'browser.type'}=$clientbrowser;
10663:
10664: return $cookie;
10665:
10666: }
10667:
10668: sub _add_to_env {
10669: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10670: if (ref($env_data) eq 'HASH') {
10671: while (my ($key,$value) = each(%$env_data)) {
10672: $idf->{$prefix.$key} = $value;
10673: $env{$prefix.$key} = $value;
10674: }
1.462 albertel 10675: }
10676: }
10677:
1.685 tempelho 10678: # --- Get the symbolic name of a problem and the url
10679: sub get_symb {
10680: my ($request,$silent) = @_;
1.726 raeburn 10681: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10682: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10683: if ($symb eq '') {
10684: if (!$silent) {
10685: $request->print("Unable to handle ambiguous references:$url:.");
10686: return ();
10687: }
10688: }
10689: &Apache::lonenc::check_decrypt(\$symb);
10690: return ($symb);
10691: }
10692:
10693: # --------------------------------------------------------------Get annotation
10694:
10695: sub get_annotation {
10696: my ($symb,$enc) = @_;
10697:
10698: my $key = $symb;
10699: if (!$enc) {
10700: $key =
10701: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10702: }
10703: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10704: return $annotation{$key};
10705: }
10706:
10707: sub clean_symb {
1.731 raeburn 10708: my ($symb,$delete_enc) = @_;
1.685 tempelho 10709:
10710: &Apache::lonenc::check_decrypt(\$symb);
10711: my $enc = $env{'request.enc'};
1.731 raeburn 10712: if ($delete_enc) {
1.730 raeburn 10713: delete($env{'request.enc'});
10714: }
1.685 tempelho 10715:
10716: return ($symb,$enc);
10717: }
1.462 albertel 10718:
1.925.2.1 raeburn 10719: sub needs_gci_custom {
10720: my $custommenu;
10721: my $numdc = &check_for_gci_dc();
10722: unless ($numdc) {
10723: my $then=$env{'user.login.time'};
10724: my $now = time;
10725: my %cnums = (
10726: review => '9615072b469884921gcil1',
10727: submit => '1H96711d710194bfegcil1',
10728: );
10729: if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
10730: my ($start,$end) =
10731: split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
10732: if (((!$start) || ($start && $start <= $now)) &&
10733: ((!$end) || ($end > $now))) {
10734: $custommenu = 1;
10735: if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
10736: my ($ccstart,$ccend) =
10737: split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
10738: if (((!$start) || ($start && $start <= $now)) &&
10739: ((!$end) || ($end > $now))) {
10740: $custommenu = '';
10741: }
10742: }
10743: }
10744: }
10745: }
10746: return $custommenu;
10747: }
10748:
10749: sub check_for_gci_dc {
10750: my $then=$env{'user.login.time'};
10751: my $numdc = 0;
10752: foreach my $dom ('gci','gcitest') {
10753: if ($env{'user.role.dc./'.$dom.'/'}) {
10754: my $livedc = 1;
10755: my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
10756: if ($tstart && $tstart>$then) { $livedc = 0; }
10757: if ($tend && $tend <$then) { $livedc = 0; }
10758: if ($livedc) {
10759: $numdc++;
10760: }
10761: }
10762: }
10763: return $numdc;
10764: }
10765:
10766: sub existing_gcitest_courses {
10767: my %courses;
10768: my $cdom = 'gcitest';
10769: my $role = 'cc';
10770: my $now = time;
10771: foreach my $envkey (keys(%env)) {
10772: my $cnum;
10773: if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
10774: $cnum = $1;
10775: } else {
10776: next;
10777: }
10778: my ($tstart,$tend) = split(':',$env{$envkey});
10779: if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
10780: my %coursehash = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
10781: $courses{$cdom.'_'.$cnum}{'description'} = $coursehash{'description'};
10782: $courses{$cdom.'_'.$cnum}{'owner'} = $coursehash{'internal.courseowner'};
10783: if (defined($coursehash{'default_enrollment_start_date'}) ) {
10784: $courses{$cdom.'_'.$cnum}{'startaccess'} =
10785: &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_start_date'});
10786: }
10787: if (defined($coursehash{'default_enrollment_end_date'}) ) {
10788: $courses{$cdom.'_'.$cnum}{'endaccess'} =
10789: &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_end_date'});
10790: if ($coursehash{'default_enrollment_end_date'} == 0) {
10791: $courses{$cdom.'_'.$cnum}{'endaccess'} = &mt('No ending date');
10792: }
10793: }
10794: }
10795: }
10796: return %courses;
10797: }
10798:
1.41 ng 10799: =pod
10800:
10801: =back
10802:
1.112 bowersj2 10803: =cut
1.41 ng 10804:
1.112 bowersj2 10805: 1;
10806: __END__;
1.41 ng 10807:
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