Annotation of loncom/interface/loncommon.pm, revision 1.934
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.934 ! droeschl 4: # $Id: loncommon.pm,v 1.933 2010/01/19 19:00:02 droeschl Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 ! droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.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: $!");
1.928 bisitz 1722: $r->print(
1723: '<p class="LC_error">'
1724: .&mt('Problems occurred in creating the new Excel file.')
1725: .' '.&mt('This error has been logged.')
1726: .' '.&mt('Please alert your LON-CAPA administrator.')
1727: .'</p>'
1728: );
1.255 matthew 1729: return (undef);
1730: }
1731: #
1732: $workbook->set_tempdir('/home/httpd/perl/tmp');
1733: #
1734: my $format = &Apache::loncommon::define_excel_formats($workbook);
1735: return ($workbook,$filename,$format);
1736: }
1737:
1738: ###############################################################
1739: ###############################################################
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &create_text_file()
1.113 bowersj2 1744:
1.542 raeburn 1745: Create a file to write to and eventually make available to the user.
1.256 matthew 1746: If file creation fails, outputs an error message on the request object and
1747: return undefs.
1.113 bowersj2 1748:
1.256 matthew 1749: Inputs: Apache request object, and file suffix
1.113 bowersj2 1750:
1.256 matthew 1751: Returns (undef) on failure,
1752: Filehandle and filename on success.
1.113 bowersj2 1753:
1754: =cut
1755:
1.256 matthew 1756: ###############################################################
1757: ###############################################################
1758: sub create_text_file {
1759: my ($r,$suffix) = @_;
1760: if (! defined($suffix)) { $suffix = 'txt'; };
1761: my $fh;
1762: my $filename = '/prtspool/'.
1.258 albertel 1763: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1764: time.'_'.rand(1000000000).'.'.$suffix;
1765: $fh = Apache::File->new('>/home/httpd'.$filename);
1766: if (! defined($fh)) {
1767: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1768: $r->print(
1769: '<p class="LC_error">'
1770: .&mt('Problems occurred in creating the output file.')
1771: .' '.&mt('This error has been logged.')
1772: .' '.&mt('Please alert your LON-CAPA administrator.')
1773: .'</p>'
1774: );
1.113 bowersj2 1775: }
1.256 matthew 1776: return ($fh,$filename)
1.113 bowersj2 1777: }
1778:
1779:
1.256 matthew 1780: =pod
1.113 bowersj2 1781:
1782: =back
1783:
1784: =cut
1.37 matthew 1785:
1786: ###############################################################
1.33 matthew 1787: ## Home server <option> list generating code ##
1788: ###############################################################
1.35 matthew 1789:
1.169 www 1790: # ------------------------------------------
1791:
1792: sub domain_select {
1793: my ($name,$value,$multiple)=@_;
1794: my %domains=map {
1.514 albertel 1795: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1796: } &Apache::lonnet::all_domains();
1.169 www 1797: if ($multiple) {
1798: $domains{''}=&mt('Any domain');
1.550 albertel 1799: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1800: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1801: } else {
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1803: return &select_form($name,$value,%domains);
1804: }
1805: }
1806:
1.282 albertel 1807: #-------------------------------------------
1808:
1809: =pod
1810:
1.519 raeburn 1811: =head1 Routines for form select boxes
1812:
1813: =over 4
1814:
1.648 raeburn 1815: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1816:
1817: Returns a string containing a <select> element int multiple mode
1818:
1819:
1820: Args:
1821: $name - name of the <select> element
1.506 raeburn 1822: $value - scalar or array ref of values that should already be selected
1.282 albertel 1823: $size - number of rows long the select element is
1.283 albertel 1824: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1825: (shown text should already have been &mt())
1.506 raeburn 1826: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1827:
1.282 albertel 1828: =cut
1829:
1830: #-------------------------------------------
1.169 www 1831: sub multiple_select_form {
1.284 albertel 1832: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1833: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1834: my $output='';
1.191 matthew 1835: if (! defined($size)) {
1836: $size = 4;
1.283 albertel 1837: if (scalar(keys(%$hash))<4) {
1838: $size = scalar(keys(%$hash));
1.191 matthew 1839: }
1840: }
1.734 bisitz 1841: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1842: my @order;
1.506 raeburn 1843: if (ref($order) eq 'ARRAY') {
1844: @order = @{$order};
1845: } else {
1846: @order = sort(keys(%$hash));
1.501 banghart 1847: }
1848: if (exists($$hash{'select_form_order'})) {
1849: @order = @{$$hash{'select_form_order'}};
1850: }
1851:
1.284 albertel 1852: foreach my $key (@order) {
1.356 albertel 1853: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1854: $output.='selected="selected" ' if ($selected{$key});
1855: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1856: }
1857: $output.="</select>\n";
1858: return $output;
1859: }
1860:
1.88 www 1861: #-------------------------------------------
1862:
1863: =pod
1864:
1.648 raeburn 1865: =item * &select_form($defdom,$name,%hash)
1.88 www 1866:
1867: Returns a string containing a <select name='$name' size='1'> form to
1868: allow a user to select options from a hash option_name => displayed text.
1869: See lonrights.pm for an example invocation and use.
1870:
1871: =cut
1872:
1873: #-------------------------------------------
1874: sub select_form {
1875: my ($def,$name,%hash) = @_;
1876: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1877: my @keys;
1878: if (exists($hash{'select_form_order'})) {
1879: @keys=@{$hash{'select_form_order'}};
1880: } else {
1881: @keys=sort(keys(%hash));
1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1887: ">".$hash{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1905: ('currentfolder' => 'Current folder/page',
1906: 'containing' => 'Containing phrase',
1907: 'none' => 'None'))).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: 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.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
2277: var i=0;
2278: while (i < currentform.login.length) {
2279: if (currentform.login[i].value == newvalue) { break; }
2280: i++;
2281: }
2282: if (i == currentform.login.length) {
2283: return;
2284: }
2285: current.radiovalue = newvalue;
2286: currentform.login[i].checked = true;
2287: return;
2288: }
2289: END
2290: return $result;
2291: }
2292:
2293: sub authform_authorwarning{
2294: my $result='';
1.144 matthew 2295: $result='<i>'.
2296: &mt('As a general rule, only authors or co-authors should be '.
2297: 'filesystem authenticated '.
2298: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2299: return $result;
2300: }
2301:
2302: sub authform_nochange{
2303: my %in = (
2304: formname => 'document.cu',
2305: kerb_def_dom => 'MSU.EDU',
2306: @_,
2307: );
1.586 raeburn 2308: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2309: my $result;
2310: if (keys(%can_assign) == 0) {
2311: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2312: } else {
2313: $result = '<label>'.&mt('[_1] Do not change login data',
2314: '<input type="radio" name="login" value="nochange" '.
2315: 'checked="checked" onclick="'.
1.281 albertel 2316: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2317: '</label>';
1.586 raeburn 2318: }
1.32 matthew 2319: return $result;
2320: }
2321:
1.591 raeburn 2322: sub authform_kerberos {
1.32 matthew 2323: my %in = (
2324: formname => 'document.cu',
2325: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2326: kerb_def_auth => 'krb4',
1.32 matthew 2327: @_,
2328: );
1.586 raeburn 2329: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2330: $autharg,$jscall);
2331: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2332: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2333: $check5 = ' checked="checked"';
1.80 albertel 2334: } else {
1.772 bisitz 2335: $check4 = ' checked="checked"';
1.80 albertel 2336: }
1.165 raeburn 2337: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2338: if (defined($in{'curr_authtype'})) {
2339: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2340: $krbcheck = ' checked="checked"';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $krbcheck = '';
2344: }
2345: }
1.591 raeburn 2346: if (defined($in{'curr_kerb_ver'})) {
2347: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2348: $check5 = ' checked="checked"';
1.591 raeburn 2349: $check4 = '';
2350: } else {
1.772 bisitz 2351: $check4 = ' checked="checked"';
1.591 raeburn 2352: $check5 = '';
2353: }
1.586 raeburn 2354: }
1.591 raeburn 2355: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2356: $krbarg = $in{'curr_autharg'};
2357: }
1.586 raeburn 2358: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2360: $result =
2361: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2362: $in{'curr_autharg'},$krbver);
2363: } else {
2364: $result =
2365: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2366: }
2367: return $result;
2368: }
2369: }
2370: } else {
2371: if ($authnum == 1) {
1.784 bisitz 2372: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2373: }
2374: }
1.586 raeburn 2375: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2376: return;
1.587 raeburn 2377: } elsif ($authtype eq '') {
1.591 raeburn 2378: if (defined($in{'mode'})) {
1.587 raeburn 2379: if ($in{'mode'} eq 'modifycourse') {
2380: if ($authnum == 1) {
1.784 bisitz 2381: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2382: }
2383: }
2384: }
1.586 raeburn 2385: }
2386: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2387: if ($authtype eq '') {
2388: $authtype = '<input type="radio" name="login" value="krb" '.
2389: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2390: $krbcheck.' />';
2391: }
2392: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2393: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb5') ||
2395: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2396: $in{'curr_authtype'} eq 'krb4')) {
2397: $result .= &mt
1.144 matthew 2398: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2399: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2400: '<label>'.$authtype,
1.281 albertel 2401: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2402: 'value="'.$krbarg.'" '.
1.144 matthew 2403: 'onchange="'.$jscall.'" />',
1.281 albertel 2404: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2405: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2406: '</label>');
1.586 raeburn 2407: } elsif ($can_assign{'krb4'}) {
2408: $result .= &mt
2409: ('[_1] Kerberos authenticated with domain [_2] '.
2410: '[_3] Version 4 [_4]',
2411: '<label>'.$authtype,
2412: '</label><input type="text" size="10" name="krbarg" '.
2413: 'value="'.$krbarg.'" '.
2414: 'onchange="'.$jscall.'" />',
2415: '<label><input type="hidden" name="krbver" value="4" />',
2416: '</label>');
2417: } elsif ($can_assign{'krb5'}) {
2418: $result .= &mt
2419: ('[_1] Kerberos authenticated with domain [_2] '.
2420: '[_3] Version 5 [_4]',
2421: '<label>'.$authtype,
2422: '</label><input type="text" size="10" name="krbarg" '.
2423: 'value="'.$krbarg.'" '.
2424: 'onchange="'.$jscall.'" />',
2425: '<label><input type="hidden" name="krbver" value="5" />',
2426: '</label>');
2427: }
1.32 matthew 2428: return $result;
2429: }
2430:
2431: sub authform_internal{
1.586 raeburn 2432: my %in = (
1.32 matthew 2433: formname => 'document.cu',
2434: kerb_def_dom => 'MSU.EDU',
2435: @_,
2436: );
1.586 raeburn 2437: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2438: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2439: if (defined($in{'curr_authtype'})) {
2440: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2441: if ($can_assign{'int'}) {
1.772 bisitz 2442: $intcheck = 'checked="checked" ';
1.623 raeburn 2443: if (defined($in{'mode'})) {
2444: if ($in{'mode'} eq 'modifyuser') {
2445: $intcheck = '';
2446: }
2447: }
1.591 raeburn 2448: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2449: $intarg = $in{'curr_autharg'};
2450: }
2451: } else {
2452: $result = &mt('Currently internally authenticated.');
2453: return $result;
1.165 raeburn 2454: }
2455: }
1.586 raeburn 2456: } else {
2457: if ($authnum == 1) {
1.784 bisitz 2458: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2459: }
2460: }
2461: if (!$can_assign{'int'}) {
2462: return;
1.587 raeburn 2463: } elsif ($authtype eq '') {
1.591 raeburn 2464: if (defined($in{'mode'})) {
1.587 raeburn 2465: if ($in{'mode'} eq 'modifycourse') {
2466: if ($authnum == 1) {
1.784 bisitz 2467: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2468: }
2469: }
2470: }
1.165 raeburn 2471: }
1.586 raeburn 2472: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2473: if ($authtype eq '') {
2474: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2475: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2476: }
1.605 bisitz 2477: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2478: $intarg.'" onchange="'.$jscall.'" />';
2479: $result = &mt
1.144 matthew 2480: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2481: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2482: $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 2483: return $result;
2484: }
2485:
2486: sub authform_local{
2487: my %in = (
2488: formname => 'document.cu',
2489: kerb_def_dom => 'MSU.EDU',
2490: @_,
2491: );
1.586 raeburn 2492: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2494: if (defined($in{'curr_authtype'})) {
2495: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2496: if ($can_assign{'loc'}) {
1.772 bisitz 2497: $loccheck = 'checked="checked" ';
1.623 raeburn 2498: if (defined($in{'mode'})) {
2499: if ($in{'mode'} eq 'modifyuser') {
2500: $loccheck = '';
2501: }
2502: }
1.591 raeburn 2503: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2504: $locarg = $in{'curr_autharg'};
2505: }
2506: } else {
2507: $result = &mt('Currently using local (institutional) authentication.');
2508: return $result;
1.165 raeburn 2509: }
2510: }
1.586 raeburn 2511: } else {
2512: if ($authnum == 1) {
1.784 bisitz 2513: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2514: }
2515: }
2516: if (!$can_assign{'loc'}) {
2517: return;
1.587 raeburn 2518: } elsif ($authtype eq '') {
1.591 raeburn 2519: if (defined($in{'mode'})) {
1.587 raeburn 2520: if ($in{'mode'} eq 'modifycourse') {
2521: if ($authnum == 1) {
1.784 bisitz 2522: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2523: }
2524: }
2525: }
1.165 raeburn 2526: }
1.586 raeburn 2527: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2528: if ($authtype eq '') {
2529: $authtype = '<input type="radio" name="login" value="loc" '.
2530: $loccheck.' onchange="'.$jscall.'" onclick="'.
2531: $jscall.'" />';
2532: }
2533: $autharg = '<input type="text" size="10" name="locarg" value="'.
2534: $locarg.'" onchange="'.$jscall.'" />';
2535: $result = &mt('[_1] Local Authentication with argument [_2]',
2536: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2537: return $result;
2538: }
2539:
2540: sub authform_filesystem{
2541: my %in = (
2542: formname => 'document.cu',
2543: kerb_def_dom => 'MSU.EDU',
2544: @_,
2545: );
1.586 raeburn 2546: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2547: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2548: if (defined($in{'curr_authtype'})) {
2549: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2550: if ($can_assign{'fsys'}) {
1.772 bisitz 2551: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2552: if (defined($in{'mode'})) {
2553: if ($in{'mode'} eq 'modifyuser') {
2554: $fsyscheck = '';
2555: }
2556: }
1.586 raeburn 2557: } else {
2558: $result = &mt('Currently Filesystem Authenticated.');
2559: return $result;
2560: }
2561: }
2562: } else {
2563: if ($authnum == 1) {
1.784 bisitz 2564: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2565: }
2566: }
2567: if (!$can_assign{'fsys'}) {
2568: return;
1.587 raeburn 2569: } elsif ($authtype eq '') {
1.591 raeburn 2570: if (defined($in{'mode'})) {
1.587 raeburn 2571: if ($in{'mode'} eq 'modifycourse') {
2572: if ($authnum == 1) {
1.784 bisitz 2573: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2574: }
2575: }
2576: }
1.586 raeburn 2577: }
2578: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2579: if ($authtype eq '') {
2580: $authtype = '<input type="radio" name="login" value="fsys" '.
2581: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2582: $jscall.'" />';
2583: }
2584: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2585: ' onchange="'.$jscall.'" />';
2586: $result = &mt
1.144 matthew 2587: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2588: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2589: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2590: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2591: 'onchange="'.$jscall.'" />');
1.32 matthew 2592: return $result;
2593: }
2594:
1.586 raeburn 2595: sub get_assignable_auth {
2596: my ($dom) = @_;
2597: if ($dom eq '') {
2598: $dom = $env{'request.role.domain'};
2599: }
2600: my %can_assign = (
2601: krb4 => 1,
2602: krb5 => 1,
2603: int => 1,
2604: loc => 1,
2605: );
2606: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2607: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2608: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2609: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2610: my $context;
2611: if ($env{'request.role'} =~ /^au/) {
2612: $context = 'author';
2613: } elsif ($env{'request.role'} =~ /^dc/) {
2614: $context = 'domain';
2615: } elsif ($env{'request.course.id'}) {
2616: $context = 'course';
2617: }
2618: if ($context) {
2619: if (ref($authhash->{$context}) eq 'HASH') {
2620: %can_assign = %{$authhash->{$context}};
2621: }
2622: }
2623: }
2624: }
2625: my $authnum = 0;
2626: foreach my $key (keys(%can_assign)) {
2627: if ($can_assign{$key}) {
2628: $authnum ++;
2629: }
2630: }
2631: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2632: $authnum --;
2633: }
2634: return ($authnum,%can_assign);
2635: }
2636:
1.80 albertel 2637: ###############################################################
2638: ## Get Kerberos Defaults for Domain ##
2639: ###############################################################
2640: ##
2641: ## Returns default kerberos version and an associated argument
2642: ## as listed in file domain.tab. If not listed, provides
2643: ## appropriate default domain and kerberos version.
2644: ##
2645: #-------------------------------------------
2646:
2647: =pod
2648:
1.648 raeburn 2649: =item * &get_kerberos_defaults()
1.80 albertel 2650:
2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2652: version and domain. If not found, it defaults to version 4 and the
2653: domain of the server.
1.80 albertel 2654:
1.648 raeburn 2655: =over 4
2656:
1.80 albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2658:
1.648 raeburn 2659: =back
2660:
2661: =back
2662:
1.80 albertel 2663: =cut
2664:
2665: #-------------------------------------------
2666: sub get_kerberos_defaults {
2667: my $domain=shift;
1.641 raeburn 2668: my ($krbdef,$krbdefdom);
2669: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2670: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2671: $krbdef = $domdefaults{'auth_def'};
2672: $krbdefdom = $domdefaults{'auth_arg_def'};
2673: } else {
1.80 albertel 2674: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2675: my $krbdefdom=$1;
2676: $krbdefdom=~tr/a-z/A-Z/;
2677: $krbdef = "krb4";
2678: }
2679: return ($krbdef,$krbdefdom);
2680: }
1.112 bowersj2 2681:
1.32 matthew 2682:
1.46 matthew 2683: ###############################################################
2684: ## Thesaurus Functions ##
2685: ###############################################################
1.20 www 2686:
1.46 matthew 2687: =pod
1.20 www 2688:
1.112 bowersj2 2689: =head1 Thesaurus Functions
2690:
2691: =over 4
2692:
1.648 raeburn 2693: =item * &initialize_keywords()
1.46 matthew 2694:
2695: Initializes the package variable %Keywords if it is empty. Uses the
2696: package variable $thesaurus_db_file.
2697:
2698: =cut
2699:
2700: ###################################################
2701:
2702: sub initialize_keywords {
2703: return 1 if (scalar keys(%Keywords));
2704: # If we are here, %Keywords is empty, so fill it up
2705: # Make sure the file we need exists...
2706: if (! -e $thesaurus_db_file) {
2707: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2708: " failed because it does not exist");
2709: return 0;
2710: }
2711: # Set up the hash as a database
2712: my %thesaurus_db;
2713: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2714: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2715: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2716: $thesaurus_db_file);
2717: return 0;
2718: }
2719: # Get the average number of appearances of a word.
2720: my $avecount = $thesaurus_db{'average.count'};
2721: # Put keywords (those that appear > average) into %Keywords
2722: while (my ($word,$data)=each (%thesaurus_db)) {
2723: my ($count,undef) = split /:/,$data;
2724: $Keywords{$word}++ if ($count > $avecount);
2725: }
2726: untie %thesaurus_db;
2727: # Remove special values from %Keywords.
1.356 albertel 2728: foreach my $value ('total.count','average.count') {
2729: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2730: }
1.46 matthew 2731: return 1;
2732: }
2733:
2734: ###################################################
2735:
2736: =pod
2737:
1.648 raeburn 2738: =item * &keyword($word)
1.46 matthew 2739:
2740: Returns true if $word is a keyword. A keyword is a word that appears more
2741: than the average number of times in the thesaurus database. Calls
2742: &initialize_keywords
2743:
2744: =cut
2745:
2746: ###################################################
1.20 www 2747:
2748: sub keyword {
1.46 matthew 2749: return if (!&initialize_keywords());
2750: my $word=lc(shift());
2751: $word=~s/\W//g;
2752: return exists($Keywords{$word});
1.20 www 2753: }
1.46 matthew 2754:
2755: ###############################################################
2756:
2757: =pod
1.20 www 2758:
1.648 raeburn 2759: =item * &get_related_words()
1.46 matthew 2760:
1.160 matthew 2761: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2762: an array of words. If the keyword is not in the thesaurus, an empty array
2763: will be returned. The order of the words returned is determined by the
2764: database which holds them.
2765:
2766: Uses global $thesaurus_db_file.
2767:
2768: =cut
2769:
2770: ###############################################################
2771: sub get_related_words {
2772: my $keyword = shift;
2773: my %thesaurus_db;
2774: if (! -e $thesaurus_db_file) {
2775: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2776: "failed because the file does not exist");
2777: return ();
2778: }
2779: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2780: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2781: return ();
2782: }
2783: my @Words=();
1.429 www 2784: my $count=0;
1.46 matthew 2785: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2786: # The first element is the number of times
2787: # the word appears. We do not need it now.
1.429 www 2788: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2789: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2790: my $threshold=$mostfrequentcount/10;
2791: foreach my $possibleword (@RelatedWords) {
2792: my ($word,$wordcount)=split(/\,/,$possibleword);
2793: if ($wordcount>$threshold) {
2794: push(@Words,$word);
2795: $count++;
2796: if ($count>10) { last; }
2797: }
1.20 www 2798: }
2799: }
1.46 matthew 2800: untie %thesaurus_db;
2801: return @Words;
1.14 harris41 2802: }
1.46 matthew 2803:
1.112 bowersj2 2804: =pod
2805:
2806: =back
2807:
2808: =cut
1.61 www 2809:
2810: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2811: =pod
2812:
1.112 bowersj2 2813: =head1 User Name Functions
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &plainname($uname,$udom,$first)
1.81 albertel 2818:
1.112 bowersj2 2819: Takes a users logon name and returns it as a string in
1.226 albertel 2820: "first middle last generation" form
2821: if $first is set to 'lastname' then it returns it as
2822: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2823:
2824: =cut
1.61 www 2825:
1.295 www 2826:
1.81 albertel 2827: ###############################################################
1.61 www 2828: sub plainname {
1.226 albertel 2829: my ($uname,$udom,$first)=@_;
1.537 albertel 2830: return if (!defined($uname) || !defined($udom));
1.295 www 2831: my %names=&getnames($uname,$udom);
1.226 albertel 2832: my $name=&Apache::lonnet::format_name($names{'firstname'},
2833: $names{'middlename'},
2834: $names{'lastname'},
2835: $names{'generation'},$first);
2836: $name=~s/^\s+//;
1.62 www 2837: $name=~s/\s+$//;
2838: $name=~s/\s+/ /g;
1.353 albertel 2839: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2840: return $name;
1.61 www 2841: }
1.66 www 2842:
2843: # -------------------------------------------------------------------- Nickname
1.81 albertel 2844: =pod
2845:
1.648 raeburn 2846: =item * &nickname($uname,$udom)
1.81 albertel 2847:
2848: Gets a users name and returns it as a string as
2849:
2850: ""nickname""
1.66 www 2851:
1.81 albertel 2852: if the user has a nickname or
2853:
2854: "first middle last generation"
2855:
2856: if the user does not
2857:
2858: =cut
1.66 www 2859:
2860: sub nickname {
2861: my ($uname,$udom)=@_;
1.537 albertel 2862: return if (!defined($uname) || !defined($udom));
1.295 www 2863: my %names=&getnames($uname,$udom);
1.68 albertel 2864: my $name=$names{'nickname'};
1.66 www 2865: if ($name) {
2866: $name='"'.$name.'"';
2867: } else {
2868: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2869: $names{'lastname'}.' '.$names{'generation'};
2870: $name=~s/\s+$//;
2871: $name=~s/\s+/ /g;
2872: }
2873: return $name;
2874: }
2875:
1.295 www 2876: sub getnames {
2877: my ($uname,$udom)=@_;
1.537 albertel 2878: return if (!defined($uname) || !defined($udom));
1.433 albertel 2879: if ($udom eq 'public' && $uname eq 'public') {
2880: return ('lastname' => &mt('Public'));
2881: }
1.295 www 2882: my $id=$uname.':'.$udom;
2883: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2884: if ($cached) {
2885: return %{$names};
2886: } else {
2887: my %loadnames=&Apache::lonnet::get('environment',
2888: ['firstname','middlename','lastname','generation','nickname'],
2889: $udom,$uname);
2890: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2891: return %loadnames;
2892: }
2893: }
1.61 www 2894:
1.542 raeburn 2895: # -------------------------------------------------------------------- getemails
1.648 raeburn 2896:
1.542 raeburn 2897: =pod
2898:
1.648 raeburn 2899: =item * &getemails($uname,$udom)
1.542 raeburn 2900:
2901: Gets a user's email information and returns it as a hash with keys:
2902: notification, critnotification, permanentemail
2903:
2904: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2906:
1.648 raeburn 2907:
1.542 raeburn 2908: =cut
2909:
1.648 raeburn 2910:
1.466 albertel 2911: sub getemails {
2912: my ($uname,$udom)=@_;
2913: if ($udom eq 'public' && $uname eq 'public') {
2914: return;
2915: }
1.467 www 2916: if (!$udom) { $udom=$env{'user.domain'}; }
2917: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2918: my $id=$uname.':'.$udom;
2919: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2920: if ($cached) {
2921: return %{$names};
2922: } else {
2923: my %loadnames=&Apache::lonnet::get('environment',
2924: ['notification','critnotification',
2925: 'permanentemail'],
2926: $udom,$uname);
2927: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2928: return %loadnames;
2929: }
2930: }
2931:
1.551 albertel 2932: sub flush_email_cache {
2933: my ($uname,$udom)=@_;
2934: if (!$udom) { $udom =$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: return if ($udom eq 'public' && $uname eq 'public');
2937: my $id=$uname.':'.$udom;
2938: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2939: }
2940:
1.728 raeburn 2941: # -------------------------------------------------------------------- getlangs
2942:
2943: =pod
2944:
2945: =item * &getlangs($uname,$udom)
2946:
2947: Gets a user's language preference and returns it as a hash with key:
2948: language.
2949:
2950: =cut
2951:
2952:
2953: sub getlangs {
2954: my ($uname,$udom) = @_;
2955: if (!$udom) { $udom =$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $id=$uname.':'.$udom;
2958: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2959: if ($cached) {
2960: return %{$langs};
2961: } else {
2962: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2963: $udom,$uname);
2964: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2965: return %loadlangs;
2966: }
2967: }
2968:
2969: sub flush_langs_cache {
2970: my ($uname,$udom)=@_;
2971: if (!$udom) { $udom =$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: return if ($udom eq 'public' && $uname eq 'public');
2974: my $id=$uname.':'.$udom;
2975: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2976: }
2977:
1.61 www 2978: # ------------------------------------------------------------------ Screenname
1.81 albertel 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &screenname($uname,$udom)
1.81 albertel 2983:
2984: Gets a users screenname and returns it as a string
2985:
2986: =cut
1.61 www 2987:
2988: sub screenname {
2989: my ($uname,$udom)=@_;
1.258 albertel 2990: if ($uname eq $env{'user.name'} &&
2991: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2992: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2993: return $names{'screenname'};
1.62 www 2994: }
2995:
1.212 albertel 2996:
1.802 bisitz 2997: # ------------------------------------------------------------- Confirm Wrapper
2998: =pod
2999:
3000: =item confirmwrapper
3001:
3002: Wrap messages about completion of operation in box
3003:
3004: =cut
3005:
3006: sub confirmwrapper {
3007: my ($message)=@_;
3008: if ($message) {
3009: return "\n".'<div class="LC_confirm_box">'."\n"
3010: .$message."\n"
3011: .'</div>'."\n";
3012: } else {
3013: return $message;
3014: }
3015: }
3016:
1.62 www 3017: # ------------------------------------------------------------- Message Wrapper
3018:
3019: sub messagewrapper {
1.369 www 3020: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3021: return
1.441 albertel 3022: '<a href="/adm/email?compose=individual&'.
3023: 'recname='.$username.'&recdom='.$domain.
3024: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3025: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3026: }
1.802 bisitz 3027:
1.74 www 3028: # --------------------------------------------------------------- Notes Wrapper
3029:
3030: sub noteswrapper {
3031: my ($link,$un,$do)=@_;
3032: return
1.896 amueller 3033: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3034: }
1.802 bisitz 3035:
1.62 www 3036: # ------------------------------------------------------------- Aboutme Wrapper
3037:
3038: sub aboutmewrapper {
1.166 www 3039: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3040: if (!defined($username) && !defined($domain)) {
3041: return;
3042: }
1.892 amueller 3043: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3044: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3045: }
3046:
3047: # ------------------------------------------------------------ Syllabus Wrapper
3048:
3049: sub syllabuswrapper {
1.707 bisitz 3050: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3051: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3052: }
1.14 harris41 3053:
1.802 bisitz 3054: # -----------------------------------------------------------------------------
3055:
1.208 matthew 3056: sub track_student_link {
1.887 raeburn 3057: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3058: my $link ="/adm/trackstudent?";
1.208 matthew 3059: my $title = 'View recent activity';
3060: if (defined($sname) && $sname !~ /^\s*$/ &&
3061: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3062: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3063: $title .= ' of this student';
1.268 albertel 3064: }
1.208 matthew 3065: if (defined($target) && $target !~ /^\s*$/) {
3066: $target = qq{target="$target"};
3067: } else {
3068: $target = '';
3069: }
1.268 albertel 3070: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3071: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3072: $title = &mt($title);
3073: $linktext = &mt($linktext);
1.448 albertel 3074: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3075: &help_open_topic('View_recent_activity');
1.208 matthew 3076: }
3077:
1.781 raeburn 3078: sub slot_reservations_link {
3079: my ($linktext,$sname,$sdom,$target) = @_;
3080: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3081: my $title = 'View slot reservation history';
3082: if (defined($sname) && $sname !~ /^\s*$/ &&
3083: defined($sdom) && $sdom !~ /^\s*$/) {
3084: $link .= "&uname=$sname&udom=$sdom";
3085: $title .= ' of this student';
3086: }
3087: if (defined($target) && $target !~ /^\s*$/) {
3088: $target = qq{target="$target"};
3089: } else {
3090: $target = '';
3091: }
3092: $title = &mt($title);
3093: $linktext = &mt($linktext);
3094: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3096:
3097: }
3098:
1.508 www 3099: # ===================================================== Display a student photo
3100:
3101:
1.509 albertel 3102: sub student_image_tag {
1.508 www 3103: my ($domain,$user)=@_;
3104: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3105: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3106: return '<img src="'.$imgsrc.'" align="right" />';
3107: } else {
3108: return '';
3109: }
3110: }
3111:
1.112 bowersj2 3112: =pod
3113:
3114: =back
3115:
3116: =head1 Access .tab File Data
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &languageids()
1.112 bowersj2 3121:
3122: returns list of all language ids
3123:
3124: =cut
3125:
1.14 harris41 3126: sub languageids {
1.16 harris41 3127: return sort(keys(%language));
1.14 harris41 3128: }
3129:
1.112 bowersj2 3130: =pod
3131:
1.648 raeburn 3132: =item * &languagedescription()
1.112 bowersj2 3133:
3134: returns description of a specified language id
3135:
3136: =cut
3137:
1.14 harris41 3138: sub languagedescription {
1.125 www 3139: my $code=shift;
3140: return ($supported_language{$code}?'* ':'').
3141: $language{$code}.
1.126 www 3142: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3143: }
3144:
3145: sub plainlanguagedescription {
3146: my $code=shift;
3147: return $language{$code};
3148: }
3149:
3150: sub supportedlanguagecode {
3151: my $code=shift;
3152: return $supported_language{$code};
1.97 www 3153: }
3154:
1.112 bowersj2 3155: =pod
3156:
1.648 raeburn 3157: =item * ©rightids()
1.112 bowersj2 3158:
3159: returns list of all copyrights
3160:
3161: =cut
3162:
3163: sub copyrightids {
3164: return sort(keys(%cprtag));
3165: }
3166:
3167: =pod
3168:
1.648 raeburn 3169: =item * ©rightdescription()
1.112 bowersj2 3170:
3171: returns description of a specified copyright id
3172:
3173: =cut
3174:
3175: sub copyrightdescription {
1.166 www 3176: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3177: }
1.197 matthew 3178:
3179: =pod
3180:
1.648 raeburn 3181: =item * &source_copyrightids()
1.192 taceyjo1 3182:
3183: returns list of all source copyrights
3184:
3185: =cut
3186:
3187: sub source_copyrightids {
3188: return sort(keys(%scprtag));
3189: }
3190:
3191: =pod
3192:
1.648 raeburn 3193: =item * &source_copyrightdescription()
1.192 taceyjo1 3194:
3195: returns description of a specified source copyright id
3196:
3197: =cut
3198:
3199: sub source_copyrightdescription {
3200: return &mt($scprtag{shift(@_)});
3201: }
1.112 bowersj2 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &filecategories()
1.112 bowersj2 3206:
3207: returns list of all file categories
3208:
3209: =cut
3210:
3211: sub filecategories {
3212: return sort(keys(%category_extensions));
3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &filecategorytypes()
1.112 bowersj2 3218:
3219: returns list of file types belonging to a given file
3220: category
3221:
3222: =cut
3223:
3224: sub filecategorytypes {
1.356 albertel 3225: my ($cat) = @_;
3226: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &fileembstyle()
1.112 bowersj2 3232:
3233: returns embedding style for a specified file type
3234:
3235: =cut
3236:
3237: sub fileembstyle {
3238: return $fe{lc(shift(@_))};
1.169 www 3239: }
3240:
1.351 www 3241: sub filemimetype {
3242: return $fm{lc(shift(@_))};
3243: }
3244:
1.169 www 3245:
3246: sub filecategoryselect {
3247: my ($name,$value)=@_;
1.189 matthew 3248: return &select_form($value,$name,
1.169 www 3249: '' => &mt('Any category'),
3250: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescription()
1.112 bowersj2 3256:
3257: returns description for a specified file type
3258:
3259: =cut
3260:
3261: sub filedescription {
1.188 matthew 3262: my $file_description = $fd{lc(shift())};
3263: $file_description =~ s:([\[\]]):~$1:g;
3264: return &mt($file_description);
1.112 bowersj2 3265: }
3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &filedescriptionex()
1.112 bowersj2 3270:
3271: returns description for a specified file type with
3272: extra formatting
3273:
3274: =cut
3275:
3276: sub filedescriptionex {
3277: my $ex=shift;
1.188 matthew 3278: my $file_description = $fd{lc($ex)};
3279: $file_description =~ s:([\[\]]):~$1:g;
3280: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3281: }
3282:
3283: # End of .tab access
3284: =pod
3285:
3286: =back
3287:
3288: =cut
3289:
3290: # ------------------------------------------------------------------ File Types
3291: sub fileextensions {
3292: return sort(keys(%fe));
3293: }
3294:
1.97 www 3295: # ----------------------------------------------------------- Display Languages
3296: # returns a hash with all desired display languages
3297: #
3298:
3299: sub display_languages {
3300: my %languages=();
1.695 raeburn 3301: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3302: $languages{$lang}=1;
1.97 www 3303: }
3304: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3305: if ($env{'form.displaylanguage'}) {
1.356 albertel 3306: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3307: $languages{$lang}=1;
1.97 www 3308: }
3309: }
3310: return %languages;
1.14 harris41 3311: }
3312:
1.582 albertel 3313: sub languages {
3314: my ($possible_langs) = @_;
1.695 raeburn 3315: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3316: if (!ref($possible_langs)) {
3317: if( wantarray ) {
3318: return @preferred_langs;
3319: } else {
3320: return $preferred_langs[0];
3321: }
3322: }
3323: my %possibilities = map { $_ => 1 } (@$possible_langs);
3324: my @preferred_possibilities;
3325: foreach my $preferred_lang (@preferred_langs) {
3326: if (exists($possibilities{$preferred_lang})) {
3327: push(@preferred_possibilities, $preferred_lang);
3328: }
3329: }
3330: if( wantarray ) {
3331: return @preferred_possibilities;
3332: }
3333: return $preferred_possibilities[0];
3334: }
3335:
1.742 raeburn 3336: sub user_lang {
3337: my ($touname,$toudom,$fromcid) = @_;
3338: my @userlangs;
3339: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3340: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3341: $env{'course.'.$fromcid.'.languages'}));
3342: } else {
3343: my %langhash = &getlangs($touname,$toudom);
3344: if ($langhash{'languages'} ne '') {
3345: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3346: } else {
3347: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3348: if ($domdefs{'lang_def'} ne '') {
3349: @userlangs = ($domdefs{'lang_def'});
3350: }
3351: }
3352: }
3353: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3354: my $user_lh = Apache::localize->get_handle(@languages);
3355: return $user_lh;
3356: }
3357:
3358:
1.112 bowersj2 3359: ###############################################################
3360: ## Student Answer Attempts ##
3361: ###############################################################
3362:
3363: =pod
3364:
3365: =head1 Alternate Problem Views
3366:
3367: =over 4
3368:
1.648 raeburn 3369: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3370: $getattempt, $regexp, $gradesub)
3371:
3372: Return string with previous attempt on problem. Arguments:
3373:
3374: =over 4
3375:
3376: =item * $symb: Problem, including path
3377:
3378: =item * $username: username of the desired student
3379:
3380: =item * $domain: domain of the desired student
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $course: Course ID
1.14 harris41 3383:
1.112 bowersj2 3384: =item * $getattempt: Leave blank for all attempts, otherwise put
3385: something
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $regexp: if string matches this regexp, the string will be
3388: sent to $gradesub
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3391:
1.112 bowersj2 3392: =back
1.14 harris41 3393:
1.112 bowersj2 3394: The output string is a table containing all desired attempts, if any.
1.16 harris41 3395:
1.112 bowersj2 3396: =cut
1.1 albertel 3397:
3398: sub get_previous_attempt {
1.43 ng 3399: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3400: my $prevattempts='';
1.43 ng 3401: no strict 'refs';
1.1 albertel 3402: if ($symb) {
1.3 albertel 3403: my (%returnhash)=
3404: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3405: if ($returnhash{'version'}) {
3406: my %lasthash=();
3407: my $version;
3408: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3409: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3410: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3411: }
1.1 albertel 3412: }
1.596 albertel 3413: $prevattempts=&start_data_table().&start_data_table_header_row();
3414: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3415: foreach my $key (sort(keys(%lasthash))) {
3416: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3417: if ($#parts > 0) {
1.31 albertel 3418: my $data=$parts[-1];
3419: pop(@parts);
1.596 albertel 3420: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3421: } else {
1.41 ng 3422: if ($#parts == 0) {
3423: $prevattempts.='<th>'.$parts[0].'</th>';
3424: } else {
3425: $prevattempts.='<th>'.$ign.'</th>';
3426: }
1.31 albertel 3427: }
1.16 harris41 3428: }
1.596 albertel 3429: $prevattempts.=&end_data_table_header_row();
1.40 ng 3430: if ($getattempt eq '') {
3431: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3432: $prevattempts.=&start_data_table_row().
3433: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3434: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3435: my $value = &format_previous_attempt_value($key,
3436: $returnhash{$version.':'.$key});
3437: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3438: }
1.596 albertel 3439: $prevattempts.=&end_data_table_row();
1.40 ng 3440: }
1.1 albertel 3441: }
1.596 albertel 3442: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3443: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3444: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3445: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3446: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3447: }
1.596 albertel 3448: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3449: } else {
1.596 albertel 3450: $prevattempts=
3451: &start_data_table().&start_data_table_row().
3452: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3453: &end_data_table_row().&end_data_table();
1.1 albertel 3454: }
3455: } else {
1.596 albertel 3456: $prevattempts=
3457: &start_data_table().&start_data_table_row().
3458: '<td>'.&mt('No data.').'</td>'.
3459: &end_data_table_row().&end_data_table();
1.1 albertel 3460: }
1.10 albertel 3461: }
3462:
1.581 albertel 3463: sub format_previous_attempt_value {
3464: my ($key,$value) = @_;
3465: if ($key =~ /timestamp/) {
3466: $value = &Apache::lonlocal::locallocaltime($value);
3467: } elsif (ref($value) eq 'ARRAY') {
3468: $value = '('.join(', ', @{ $value }).')';
3469: } else {
3470: $value = &unescape($value);
3471: }
3472: return $value;
3473: }
3474:
3475:
1.107 albertel 3476: sub relative_to_absolute {
3477: my ($url,$output)=@_;
3478: my $parser=HTML::TokeParser->new(\$output);
3479: my $token;
3480: my $thisdir=$url;
3481: my @rlinks=();
3482: while ($token=$parser->get_token) {
3483: if ($token->[0] eq 'S') {
3484: if ($token->[1] eq 'a') {
3485: if ($token->[2]->{'href'}) {
3486: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3487: }
3488: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3489: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3490: } elsif ($token->[1] eq 'base') {
3491: $thisdir=$token->[2]->{'href'};
3492: }
3493: }
3494: }
3495: $thisdir=~s-/[^/]*$--;
1.356 albertel 3496: foreach my $link (@rlinks) {
1.726 raeburn 3497: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3498: ($link=~/^\//) ||
3499: ($link=~/^javascript:/i) ||
3500: ($link=~/^mailto:/i) ||
3501: ($link=~/^\#/)) {
3502: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3503: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3504: }
3505: }
3506: # -------------------------------------------------- Deal with Applet codebases
3507: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3508: return $output;
3509: }
3510:
1.112 bowersj2 3511: =pod
3512:
1.648 raeburn 3513: =item * &get_student_view()
1.112 bowersj2 3514:
3515: show a snapshot of what student was looking at
3516:
3517: =cut
3518:
1.10 albertel 3519: sub get_student_view {
1.186 albertel 3520: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3521: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3522: my (%form);
1.10 albertel 3523: my @elements=('symb','courseid','domain','username');
3524: foreach my $element (@elements) {
1.186 albertel 3525: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3526: }
1.186 albertel 3527: if (defined($moreenv)) {
3528: %form=(%form,%{$moreenv});
3529: }
1.236 albertel 3530: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3531: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3532: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3533: $userview=~s/\<body[^\>]*\>//gi;
3534: $userview=~s/\<\/body\>//gi;
3535: $userview=~s/\<html\>//gi;
3536: $userview=~s/\<\/html\>//gi;
3537: $userview=~s/\<head\>//gi;
3538: $userview=~s/\<\/head\>//gi;
3539: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3540: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3541: if (wantarray) {
3542: return ($userview,$response);
3543: } else {
3544: return $userview;
3545: }
3546: }
3547:
3548: sub get_student_view_with_retries {
3549: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3550:
3551: my $ok = 0; # True if we got a good response.
3552: my $content;
3553: my $response;
3554:
3555: # Try to get the student_view done. within the retries count:
3556:
3557: do {
3558: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3559: $ok = $response->is_success;
3560: if (!$ok) {
3561: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3562: }
3563: $retries--;
3564: } while (!$ok && ($retries > 0));
3565:
3566: if (!$ok) {
3567: $content = ''; # On error return an empty content.
3568: }
1.651 www 3569: if (wantarray) {
3570: return ($content, $response);
3571: } else {
3572: return $content;
3573: }
1.11 albertel 3574: }
3575:
1.112 bowersj2 3576: =pod
3577:
1.648 raeburn 3578: =item * &get_student_answers()
1.112 bowersj2 3579:
3580: show a snapshot of how student was answering problem
3581:
3582: =cut
3583:
1.11 albertel 3584: sub get_student_answers {
1.100 sakharuk 3585: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3586: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3587: my (%moreenv);
1.11 albertel 3588: my @elements=('symb','courseid','domain','username');
3589: foreach my $element (@elements) {
1.186 albertel 3590: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3591: }
1.186 albertel 3592: $moreenv{'grade_target'}='answer';
3593: %moreenv=(%form,%moreenv);
1.497 raeburn 3594: $feedurl = &Apache::lonnet::clutter($feedurl);
3595: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3596: return $userview;
1.1 albertel 3597: }
1.116 albertel 3598:
3599: =pod
3600:
3601: =item * &submlink()
3602:
1.242 albertel 3603: Inputs: $text $uname $udom $symb $target
1.116 albertel 3604:
3605: Returns: A link to grades.pm such as to see the SUBM view of a student
3606:
3607: =cut
3608:
3609: ###############################################
3610: sub submlink {
1.242 albertel 3611: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3612: if (!($uname && $udom)) {
3613: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3614: &Apache::lonnet::whichuser($symb);
1.116 albertel 3615: if (!$symb) { $symb=$cursymb; }
3616: }
1.254 matthew 3617: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3618: $symb=&escape($symb);
1.242 albertel 3619: if ($target) { $target="target=\"$target\""; }
3620: return '<a href="/adm/grades?&command=submission&'.
3621: 'symb='.$symb.'&student='.$uname.
3622: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3623: }
3624: ##############################################
3625:
3626: =pod
3627:
3628: =item * &pgrdlink()
3629:
3630: Inputs: $text $uname $udom $symb $target
3631:
3632: Returns: A link to grades.pm such as to see the PGRD view of a student
3633:
3634: =cut
3635:
3636: ###############################################
3637: sub pgrdlink {
3638: my $link=&submlink(@_);
3639: $link=~s/(&command=submission)/$1&showgrading=yes/;
3640: return $link;
3641: }
3642: ##############################################
3643:
3644: =pod
3645:
3646: =item * &pprmlink()
3647:
3648: Inputs: $text $uname $udom $symb $target
3649:
3650: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3651: student and a specific resource
1.242 albertel 3652:
3653: =cut
3654:
3655: ###############################################
3656: sub pprmlink {
3657: my ($text,$uname,$udom,$symb,$target)=@_;
3658: if (!($uname && $udom)) {
3659: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3660: &Apache::lonnet::whichuser($symb);
1.242 albertel 3661: if (!$symb) { $symb=$cursymb; }
3662: }
1.254 matthew 3663: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3664: $symb=&escape($symb);
1.242 albertel 3665: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3666: return '<a href="/adm/parmset?command=set&'.
3667: 'symb='.$symb.'&uname='.$uname.
3668: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3669: }
3670: ##############################################
1.37 matthew 3671:
1.112 bowersj2 3672: =pod
3673:
3674: =back
3675:
3676: =cut
3677:
1.37 matthew 3678: ###############################################
1.51 www 3679:
3680:
3681: sub timehash {
1.687 raeburn 3682: my ($thistime) = @_;
3683: my $timezone = &Apache::lonlocal::gettimezone();
3684: my $dt = DateTime->from_epoch(epoch => $thistime)
3685: ->set_time_zone($timezone);
3686: my $wday = $dt->day_of_week();
3687: if ($wday == 7) { $wday = 0; }
3688: return ( 'second' => $dt->second(),
3689: 'minute' => $dt->minute(),
3690: 'hour' => $dt->hour(),
3691: 'day' => $dt->day_of_month(),
3692: 'month' => $dt->month(),
3693: 'year' => $dt->year(),
3694: 'weekday' => $wday,
3695: 'dayyear' => $dt->day_of_year(),
3696: 'dlsav' => $dt->is_dst() );
1.51 www 3697: }
3698:
1.370 www 3699: sub utc_string {
3700: my ($date)=@_;
1.371 www 3701: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3702: }
3703:
1.51 www 3704: sub maketime {
3705: my %th=@_;
1.687 raeburn 3706: my ($epoch_time,$timezone,$dt);
3707: $timezone = &Apache::lonlocal::gettimezone();
3708: eval {
3709: $dt = DateTime->new( year => $th{'year'},
3710: month => $th{'month'},
3711: day => $th{'day'},
3712: hour => $th{'hour'},
3713: minute => $th{'minute'},
3714: second => $th{'second'},
3715: time_zone => $timezone,
3716: );
3717: };
3718: if (!$@) {
3719: $epoch_time = $dt->epoch;
3720: if ($epoch_time) {
3721: return $epoch_time;
3722: }
3723: }
1.51 www 3724: return POSIX::mktime(
3725: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3726: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3727: }
3728:
3729: #########################################
1.51 www 3730:
3731: sub findallcourses {
1.482 raeburn 3732: my ($roles,$uname,$udom) = @_;
1.355 albertel 3733: my %roles;
3734: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3735: my %courses;
1.51 www 3736: my $now=time;
1.482 raeburn 3737: if (!defined($uname)) {
3738: $uname = $env{'user.name'};
3739: }
3740: if (!defined($udom)) {
3741: $udom = $env{'user.domain'};
3742: }
3743: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3744: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3745: if (!%roles) {
3746: %roles = (
3747: cc => 1,
1.907 raeburn 3748: co => 1,
1.482 raeburn 3749: in => 1,
3750: ep => 1,
3751: ta => 1,
3752: cr => 1,
3753: st => 1,
3754: );
3755: }
3756: foreach my $entry (keys(%roleshash)) {
3757: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3758: if ($trole =~ /^cr/) {
3759: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3760: } else {
3761: next if (!exists($roles{$trole}));
3762: }
3763: if ($tend) {
3764: next if ($tend < $now);
3765: }
3766: if ($tstart) {
3767: next if ($tstart > $now);
3768: }
3769: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3770: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3771: if ($secpart eq '') {
3772: ($cnum,$role) = split(/_/,$cnumpart);
3773: $sec = 'none';
3774: $realsec = '';
3775: } else {
3776: $cnum = $cnumpart;
3777: ($sec,$role) = split(/_/,$secpart);
3778: $realsec = $sec;
1.490 raeburn 3779: }
1.482 raeburn 3780: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3781: }
3782: } else {
3783: foreach my $key (keys(%env)) {
1.483 albertel 3784: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3785: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3786: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3787: next if ($role eq 'ca' || $role eq 'aa');
3788: next if (%roles && !exists($roles{$role}));
3789: my ($starttime,$endtime)=split(/\./,$env{$key});
3790: my $active=1;
3791: if ($starttime) {
3792: if ($now<$starttime) { $active=0; }
3793: }
3794: if ($endtime) {
3795: if ($now>$endtime) { $active=0; }
3796: }
3797: if ($active) {
3798: if ($sec eq '') {
3799: $sec = 'none';
3800: }
3801: $courses{$cdom.'_'.$cnum}{$sec} =
3802: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3803: }
3804: }
1.51 www 3805: }
3806: }
1.474 raeburn 3807: return %courses;
1.51 www 3808: }
1.37 matthew 3809:
1.54 www 3810: ###############################################
1.474 raeburn 3811:
3812: sub blockcheck {
1.482 raeburn 3813: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3814:
3815: if (!defined($udom)) {
3816: $udom = $env{'user.domain'};
3817: }
3818: if (!defined($uname)) {
3819: $uname = $env{'user.name'};
3820: }
3821:
3822: # If uname and udom are for a course, check for blocks in the course.
3823:
3824: if (&Apache::lonnet::is_course($udom,$uname)) {
3825: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3826: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3827: return ($startblock,$endblock);
3828: }
1.474 raeburn 3829:
1.502 raeburn 3830: my $startblock = 0;
3831: my $endblock = 0;
1.482 raeburn 3832: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3833:
1.490 raeburn 3834: # If uname is for a user, and activity is course-specific, i.e.,
3835: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3836:
1.490 raeburn 3837: if (($activity eq 'boards' || $activity eq 'chat' ||
3838: $activity eq 'groups') && ($env{'request.course.id'})) {
3839: foreach my $key (keys(%live_courses)) {
3840: if ($key ne $env{'request.course.id'}) {
3841: delete($live_courses{$key});
3842: }
3843: }
3844: }
3845:
3846: my $otheruser = 0;
3847: my %own_courses;
3848: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3849: # Resource belongs to user other than current user.
3850: $otheruser = 1;
3851: # Gather courses for current user
3852: %own_courses =
3853: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3854: }
3855:
3856: # Gather active course roles - course coordinator, instructor,
3857: # exam proctor, ta, student, or custom role.
1.474 raeburn 3858:
3859: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3860: my ($cdom,$cnum);
3861: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3862: $cdom = $env{'course.'.$course.'.domain'};
3863: $cnum = $env{'course.'.$course.'.num'};
3864: } else {
1.490 raeburn 3865: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3866: }
3867: my $no_ownblock = 0;
3868: my $no_userblock = 0;
1.533 raeburn 3869: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3870: # Check if current user has 'evb' priv for this
3871: if (defined($own_courses{$course})) {
3872: foreach my $sec (keys(%{$own_courses{$course}})) {
3873: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3874: if ($sec ne 'none') {
3875: $checkrole .= '/'.$sec;
3876: }
3877: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3878: $no_ownblock = 1;
3879: last;
3880: }
3881: }
3882: }
3883: # if they have 'evb' priv and are currently not playing student
3884: next if (($no_ownblock) &&
3885: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3886: }
1.474 raeburn 3887: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3888: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3889: if ($sec ne 'none') {
1.482 raeburn 3890: $checkrole .= '/'.$sec;
1.474 raeburn 3891: }
1.490 raeburn 3892: if ($otheruser) {
3893: # Resource belongs to user other than current user.
3894: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3895: my ($trole,$tdom,$tnum,$tsec);
3896: my $entry = $live_courses{$course}{$sec};
3897: if ($entry =~ /^cr/) {
3898: ($trole,$tdom,$tnum,$tsec) =
3899: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3900: } else {
3901: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3902: }
3903: my ($spec,$area,$trest,%allroles,%userroles);
3904: $area = '/'.$tdom.'/'.$tnum;
3905: $trest = $tnum;
3906: if ($tsec ne '') {
3907: $area .= '/'.$tsec;
3908: $trest .= '/'.$tsec;
3909: }
3910: $spec = $trole.'.'.$area;
3911: if ($trole =~ /^cr/) {
3912: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3913: $tdom,$spec,$trest,$area);
3914: } else {
3915: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3916: $tdom,$spec,$trest,$area);
3917: }
3918: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3919: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3920: if ($1) {
3921: $no_userblock = 1;
3922: last;
3923: }
3924: }
1.490 raeburn 3925: } else {
3926: # Resource belongs to current user
3927: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3928: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3929: $no_ownblock = 1;
3930: last;
3931: }
1.474 raeburn 3932: }
3933: }
3934: # if they have the evb priv and are currently not playing student
1.482 raeburn 3935: next if (($no_ownblock) &&
1.491 albertel 3936: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3937: next if ($no_userblock);
1.474 raeburn 3938:
1.866 kalberla 3939: # Retrieve blocking times and identity of locker for course
1.490 raeburn 3940: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3941:
3942: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3943: if (($start != 0) &&
3944: (($startblock == 0) || ($startblock > $start))) {
3945: $startblock = $start;
3946: }
3947: if (($end != 0) &&
3948: (($endblock == 0) || ($endblock < $end))) {
3949: $endblock = $end;
3950: }
1.490 raeburn 3951: }
3952: return ($startblock,$endblock);
3953: }
3954:
3955: sub get_blocks {
3956: my ($setters,$activity,$cdom,$cnum) = @_;
3957: my $startblock = 0;
3958: my $endblock = 0;
3959: my $course = $cdom.'_'.$cnum;
3960: $setters->{$course} = {};
3961: $setters->{$course}{'staff'} = [];
3962: $setters->{$course}{'times'} = [];
3963: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3964: foreach my $record (keys(%records)) {
3965: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3966: if ($start <= time && $end >= time) {
3967: my ($staff_name,$staff_dom,$title,$blocks) =
3968: &parse_block_record($records{$record});
3969: if ($blocks->{$activity} eq 'on') {
3970: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3971: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3972: if ( ($startblock == 0) || ($startblock > $start) ) {
3973: $startblock = $start;
1.490 raeburn 3974: }
1.491 albertel 3975: if ( ($endblock == 0) || ($endblock < $end) ) {
3976: $endblock = $end;
1.474 raeburn 3977: }
3978: }
3979: }
3980: }
3981: return ($startblock,$endblock);
3982: }
3983:
3984: sub parse_block_record {
3985: my ($record) = @_;
3986: my ($setuname,$setudom,$title,$blocks);
3987: if (ref($record) eq 'HASH') {
3988: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3989: $title = &unescape($record->{'event'});
3990: $blocks = $record->{'blocks'};
3991: } else {
3992: my @data = split(/:/,$record,3);
3993: if (scalar(@data) eq 2) {
3994: $title = $data[1];
3995: ($setuname,$setudom) = split(/@/,$data[0]);
3996: } else {
3997: ($setuname,$setudom,$title) = @data;
3998: }
3999: $blocks = { 'com' => 'on' };
4000: }
4001: return ($setuname,$setudom,$title,$blocks);
4002: }
4003:
1.854 kalberla 4004: sub blocking_status {
4005: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4006: my %setters;
1.890 droeschl 4007:
4008: # check for active blocking
1.867 kalberla 4009: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4010:
1.890 droeschl 4011: my $blocked = $startblock && $endblock ? 1 : 0;
4012:
4013: # caller just wants to know whether a block is active
4014: if (!wantarray) { return $blocked; }
4015:
4016: # build a link to a popup window containing the details
4017: my $querystring = "?activity=$activity";
4018: # $uname and $udom decide whose portfolio the user is trying to look at
4019: $querystring .= "&udom=$udom" if $udom;
4020: $querystring .= "&uname=$uname" if $uname;
4021:
4022: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4023: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4024: var options = "width=" + w + ",height=" + h + ",";
4025: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4026: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4027: var newWin = window.open(url, wdwName, options);
4028: newWin.focus();
4029: }
1.890 droeschl 4030: END_MYBLOCK
1.854 kalberla 4031:
1.890 droeschl 4032: $output = Apache::lonhtmlcommon::scripttag($output);
4033:
1.854 kalberla 4034: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4035: my $text = mt('Communication Blocked');
4036:
1.867 kalberla 4037: $output .= <<"END_BLOCK";
4038: <div class='LC_comblock'>
1.869 kalberla 4039: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4040: title='$text'>
4041: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4042: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4043: title='$text'>$text</a>
1.867 kalberla 4044: </div>
4045:
4046: END_BLOCK
1.474 raeburn 4047:
1.854 kalberla 4048: return ($blocked, $output);
4049: }
1.490 raeburn 4050:
1.60 matthew 4051: ###############################################
4052:
1.682 raeburn 4053: sub check_ip_acc {
4054: my ($acc)=@_;
4055: &Apache::lonxml::debug("acc is $acc");
4056: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4057: return 1;
4058: }
4059: my $allowed=0;
4060: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4061:
4062: my $name;
4063: foreach my $pattern (split(',',$acc)) {
4064: $pattern =~ s/^\s*//;
4065: $pattern =~ s/\s*$//;
4066: if ($pattern =~ /\*$/) {
4067: #35.8.*
4068: $pattern=~s/\*//;
4069: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4070: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4071: #35.8.3.[34-56]
4072: my $low=$2;
4073: my $high=$3;
4074: $pattern=$1;
4075: if ($ip =~ /^\Q$pattern\E/) {
4076: my $last=(split(/\./,$ip))[3];
4077: if ($last <=$high && $last >=$low) { $allowed=1; }
4078: }
4079: } elsif ($pattern =~ /^\*/) {
4080: #*.msu.edu
4081: $pattern=~s/\*//;
4082: if (!defined($name)) {
4083: use Socket;
4084: my $netaddr=inet_aton($ip);
4085: ($name)=gethostbyaddr($netaddr,AF_INET);
4086: }
4087: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4088: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4089: #127.0.0.1
4090: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4091: } else {
4092: #some.name.com
4093: if (!defined($name)) {
4094: use Socket;
4095: my $netaddr=inet_aton($ip);
4096: ($name)=gethostbyaddr($netaddr,AF_INET);
4097: }
4098: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4099: }
4100: if ($allowed) { last; }
4101: }
4102: return $allowed;
4103: }
4104:
4105: ###############################################
4106:
1.60 matthew 4107: =pod
4108:
1.112 bowersj2 4109: =head1 Domain Template Functions
4110:
4111: =over 4
4112:
4113: =item * &determinedomain()
1.60 matthew 4114:
4115: Inputs: $domain (usually will be undef)
4116:
1.63 www 4117: Returns: Determines which domain should be used for designs
1.60 matthew 4118:
4119: =cut
1.54 www 4120:
1.60 matthew 4121: ###############################################
1.63 www 4122: sub determinedomain {
4123: my $domain=shift;
1.531 albertel 4124: if (! $domain) {
1.60 matthew 4125: # Determine domain if we have not been given one
1.893 raeburn 4126: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4127: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4128: if ($env{'request.role.domain'}) {
4129: $domain=$env{'request.role.domain'};
1.60 matthew 4130: }
4131: }
1.63 www 4132: return $domain;
4133: }
4134: ###############################################
1.517 raeburn 4135:
1.518 albertel 4136: sub devalidate_domconfig_cache {
4137: my ($udom)=@_;
4138: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4139: }
4140:
4141: # ---------------------- Get domain configuration for a domain
4142: sub get_domainconf {
4143: my ($udom) = @_;
4144: my $cachetime=1800;
4145: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4146: if (defined($cached)) { return %{$result}; }
4147:
4148: my %domconfig = &Apache::lonnet::get_dom('configuration',
4149: ['login','rolecolors'],$udom);
1.632 raeburn 4150: my (%designhash,%legacy);
1.518 albertel 4151: if (keys(%domconfig) > 0) {
4152: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4153: if (keys(%{$domconfig{'login'}})) {
4154: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4155: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4156: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4157: $designhash{$udom.'.login.'.$key.'_'.$img} =
4158: $domconfig{'login'}{$key}{$img};
4159: }
4160: } else {
4161: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4162: }
1.632 raeburn 4163: }
4164: } else {
4165: $legacy{'login'} = 1;
1.518 albertel 4166: }
1.632 raeburn 4167: } else {
4168: $legacy{'login'} = 1;
1.518 albertel 4169: }
4170: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4171: if (keys(%{$domconfig{'rolecolors'}})) {
4172: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4173: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4174: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4175: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4176: }
1.518 albertel 4177: }
4178: }
1.632 raeburn 4179: } else {
4180: $legacy{'rolecolors'} = 1;
1.518 albertel 4181: }
1.632 raeburn 4182: } else {
4183: $legacy{'rolecolors'} = 1;
1.518 albertel 4184: }
1.632 raeburn 4185: if (keys(%legacy) > 0) {
4186: my %legacyhash = &get_legacy_domconf($udom);
4187: foreach my $item (keys(%legacyhash)) {
4188: if ($item =~ /^\Q$udom\E\.login/) {
4189: if ($legacy{'login'}) {
4190: $designhash{$item} = $legacyhash{$item};
4191: }
4192: } else {
4193: if ($legacy{'rolecolors'}) {
4194: $designhash{$item} = $legacyhash{$item};
4195: }
1.518 albertel 4196: }
4197: }
4198: }
1.632 raeburn 4199: } else {
4200: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4201: }
4202: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4203: $cachetime);
4204: return %designhash;
4205: }
4206:
1.632 raeburn 4207: sub get_legacy_domconf {
4208: my ($udom) = @_;
4209: my %legacyhash;
4210: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4211: my $designfile = $designdir.'/'.$udom.'.tab';
4212: if (-e $designfile) {
4213: if ( open (my $fh,"<$designfile") ) {
4214: while (my $line = <$fh>) {
4215: next if ($line =~ /^\#/);
4216: chomp($line);
4217: my ($key,$val)=(split(/\=/,$line));
4218: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4219: }
4220: close($fh);
4221: }
4222: }
4223: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4224: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4225: }
4226: return %legacyhash;
4227: }
4228:
1.63 www 4229: =pod
4230:
1.112 bowersj2 4231: =item * &domainlogo()
1.63 www 4232:
4233: Inputs: $domain (usually will be undef)
4234:
4235: Returns: A link to a domain logo, if the domain logo exists.
4236: If the domain logo does not exist, a description of the domain.
4237:
4238: =cut
1.112 bowersj2 4239:
1.63 www 4240: ###############################################
4241: sub domainlogo {
1.517 raeburn 4242: my $domain = &determinedomain(shift);
1.518 albertel 4243: my %designhash = &get_domainconf($domain);
1.517 raeburn 4244: # See if there is a logo
4245: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4246: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4247: if ($imgsrc =~ m{^/(adm|res)/}) {
4248: if ($imgsrc =~ m{^/res/}) {
4249: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4250: &Apache::lonnet::repcopy($local_name);
4251: }
4252: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4253: }
4254: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4255: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4256: return &Apache::lonnet::domain($domain,'description');
1.59 www 4257: } else {
1.60 matthew 4258: return '';
1.59 www 4259: }
4260: }
1.63 www 4261: ##############################################
4262:
4263: =pod
4264:
1.112 bowersj2 4265: =item * &designparm()
1.63 www 4266:
4267: Inputs: $which parameter; $domain (usually will be undef)
4268:
4269: Returns: value of designparamter $which
4270:
4271: =cut
1.112 bowersj2 4272:
1.397 albertel 4273:
1.400 albertel 4274: ##############################################
1.397 albertel 4275: sub designparm {
4276: my ($which,$domain)=@_;
4277: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4278: return $env{'environment.color.'.$which};
1.96 www 4279: }
1.63 www 4280: $domain=&determinedomain($domain);
1.518 albertel 4281: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4282: my $output;
1.517 raeburn 4283: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4284: $output = $domdesign{$domain.'.'.$which};
1.63 www 4285: } else {
1.520 raeburn 4286: $output = $defaultdesign{$which};
4287: }
4288: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4289: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4290: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4291: if ($output =~ m{^/res/}) {
4292: my $local_name = &Apache::lonnet::filelocation('',$output);
4293: &Apache::lonnet::repcopy($local_name);
4294: }
1.520 raeburn 4295: $output = &lonhttpdurl($output);
4296: }
1.63 www 4297: }
1.520 raeburn 4298: return $output;
1.63 www 4299: }
1.59 www 4300:
1.822 bisitz 4301: ##############################################
4302: =pod
4303:
1.832 bisitz 4304: =item * &authorspace()
4305:
4306: Inputs: ./.
4307:
4308: Returns: Path to the Construction Space of the current user's
4309: accessed author space
4310: The author space will be that of the current user
4311: when accessing the own author space
4312: and that of the co-author/assistent co-author
4313: when accessing the co-author's/assistent co-author's
4314: space
4315:
4316: =cut
4317:
4318: sub authorspace {
4319: my $caname = '';
4320: if ($env{'request.role'} =~ /^ca|^aa/) {
4321: (undef,$caname) =
4322: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4323: } else {
4324: $caname = $env{'user.name'};
4325: }
4326: return '/priv/'.$caname.'/';
4327: }
4328:
4329: ##############################################
4330: =pod
4331:
1.822 bisitz 4332: =item * &head_subbox()
4333:
4334: Inputs: $content (contains HTML code with page functions, etc.)
4335:
4336: Returns: HTML div with $content
4337: To be included in page header
4338:
4339: =cut
4340:
4341: sub head_subbox {
4342: my ($content)=@_;
4343: my $output =
1.844 bisitz 4344: '<div id="LC_head_subbox">'
1.822 bisitz 4345: .$content
4346: .'</div>'
4347: }
4348:
4349: ##############################################
4350: =pod
4351:
4352: =item * &CSTR_pageheader()
4353:
4354: Inputs: ./.
4355:
4356: Returns: HTML div with CSTR path and recent box
4357: To be included on Construction Space pages
4358:
4359: =cut
4360:
4361: sub CSTR_pageheader {
4362: # this is for resources; directories have customtitle, and crumbs
4363: # and select recent are created in lonpubdir.pm
4364: my ($uname,$thisdisfn)=
4365: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4366: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4367: $formaction=~s/\/+/\//g;
4368:
4369: my $parentpath = '';
4370: my $lastitem = '';
4371: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4372: $parentpath = $1;
4373: $lastitem = $2;
4374: } else {
4375: $lastitem = $thisdisfn;
4376: }
1.921 bisitz 4377:
4378: my $output =
1.822 bisitz 4379: '<div>'
4380: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4381: .'<b>'.&mt('Construction Space:').'</b> '
4382: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4383: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4384: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4385:
4386: if ($lastitem) {
4387: $output .=
4388: '<span class="LC_filename">'
4389: .$lastitem
4390: .'</span>';
4391: }
4392: $output .=
4393: '<br />'
1.822 bisitz 4394: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4395: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4396: .'</form>'
4397: .&Apache::lonmenu::constspaceform()
4398: .'</div>';
1.921 bisitz 4399:
4400: return $output;
1.822 bisitz 4401: }
4402:
1.60 matthew 4403: ###############################################
4404: ###############################################
4405:
4406: =pod
4407:
1.112 bowersj2 4408: =back
4409:
1.549 albertel 4410: =head1 HTML Helpers
1.112 bowersj2 4411:
4412: =over 4
4413:
4414: =item * &bodytag()
1.60 matthew 4415:
4416: Returns a uniform header for LON-CAPA web pages.
4417:
4418: Inputs:
4419:
1.112 bowersj2 4420: =over 4
4421:
4422: =item * $title, A title to be displayed on the page.
4423:
4424: =item * $function, the current role (can be undef).
4425:
4426: =item * $addentries, extra parameters for the <body> tag.
4427:
4428: =item * $bodyonly, if defined, only return the <body> tag.
4429:
4430: =item * $domain, if defined, force a given domain.
4431:
4432: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4433: text interface only)
1.60 matthew 4434:
1.814 bisitz 4435: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4436: navigational links
1.317 albertel 4437:
1.338 albertel 4438: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4439:
1.361 albertel 4440: =item * $no_inline_link, if true and in remote mode, don't show the
4441: 'Switch To Inline Menu' link
4442:
1.460 albertel 4443: =item * $args, optional argument valid values are
4444: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4445: inherit_jsmath -> when creating popup window in a page,
4446: should it have jsmath forced on by the
4447: current page
1.460 albertel 4448:
1.112 bowersj2 4449: =back
4450:
1.60 matthew 4451: Returns: A uniform header for LON-CAPA web pages.
4452: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4453: If $bodyonly is undef or zero, an html string containing a <body> tag and
4454: other decorations will be returned.
4455:
4456: =cut
4457:
1.54 www 4458: sub bodytag {
1.831 bisitz 4459: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4460: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4461:
1.460 albertel 4462: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4463:
1.183 matthew 4464: $function = &get_users_function() if (!$function);
1.339 albertel 4465: my $img = &designparm($function.'.img',$domain);
4466: my $font = &designparm($function.'.font',$domain);
4467: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4468:
1.803 bisitz 4469: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4470: 'bgcolor' => $pgbg,
1.339 albertel 4471: 'text' => $font,
4472: 'alink' => &designparm($function.'.alink',$domain),
4473: 'vlink' => &designparm($function.'.vlink',$domain),
4474: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4475: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4476:
1.63 www 4477: # role and realm
1.378 raeburn 4478: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4479: if ($role eq 'ca') {
1.479 albertel 4480: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4481: $realm = &plainname($rname,$rdom);
1.378 raeburn 4482: }
1.55 www 4483: # realm
1.258 albertel 4484: if ($env{'request.course.id'}) {
1.378 raeburn 4485: if ($env{'request.role'} !~ /^cr/) {
4486: $role = &Apache::lonnet::plaintext($role,&course_type());
4487: }
1.898 raeburn 4488: if ($env{'request.course.sec'}) {
4489: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4490: }
1.359 albertel 4491: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4492: } else {
4493: $role = &Apache::lonnet::plaintext($role);
1.54 www 4494: }
1.433 albertel 4495:
1.359 albertel 4496: if (!$realm) { $realm=' '; }
1.55 www 4497: # Set messages
1.60 matthew 4498: my $messages=&domainlogo($domain);
1.330 albertel 4499:
1.438 albertel 4500: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4501:
1.101 www 4502: # construct main body tag
1.359 albertel 4503: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4504: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4505:
1.530 albertel 4506: if ($bodyonly) {
1.60 matthew 4507: return $bodytag;
1.798 tempelho 4508: }
1.359 albertel 4509:
1.410 albertel 4510: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4511: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4512: undef($role);
1.434 albertel 4513: } else {
4514: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4515: }
1.359 albertel 4516:
1.762 bisitz 4517: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4518: #
4519: # Extra info if you are the DC
4520: my $dc_info = '';
4521: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4522: $env{'course.'.$env{'request.course.id'}.
4523: '.domain'}.'/'})) {
4524: my $cid = $env{'request.course.id'};
1.917 raeburn 4525: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4526: $dc_info =~ s/\s+$//;
1.359 albertel 4527: }
4528:
1.898 raeburn 4529: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4530: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4531:
1.837 bisitz 4532: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4533: # No Remote
1.916 droeschl 4534: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4535: return $bodytag;
4536: }
1.903 droeschl 4537:
4538: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4539:
4540: # if ($env{'request.state'} eq 'construct') {
4541: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4542: # }
4543:
1.359 albertel 4544:
4545:
1.916 droeschl 4546: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4547: if ($dc_info) {
4548: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4549: }
1.916 droeschl 4550: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4551: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4552: return $bodytag;
4553: }
1.894 droeschl 4554:
1.927 raeburn 4555: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4556: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4557: }
1.916 droeschl 4558:
1.903 droeschl 4559: $bodytag .= Apache::lonhtmlcommon::scripttag(
4560: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4561:
1.903 droeschl 4562: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4563:
1.917 raeburn 4564: if ($dc_info) {
4565: $dc_info = &dc_courseid_toggle($dc_info);
4566: }
4567: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4568:
1.903 droeschl 4569: #don't show menus for public users
4570: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4571: $bodytag .= Apache::lonmenu::secondary_menu();
4572: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4573: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4574: if ($env{'request.state'} eq 'construct') {
4575: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4576: $args->{'bread_crumbs'});
4577: } elsif ($forcereg) {
4578: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4579: }
1.903 droeschl 4580: }else{
4581: # this is to seperate menu from content when there's no secondary
4582: # menu. Especially needed for public accessible ressources.
4583: $bodytag .= '<hr style="clear:both" />';
4584: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4585: }
1.903 droeschl 4586:
1.235 raeburn 4587: return $bodytag;
1.94 www 4588: }
1.95 www 4589:
1.93 www 4590: #
1.95 www 4591: # Top frame rendering, Remote is up
1.93 www 4592: #
1.359 albertel 4593:
1.517 raeburn 4594: my $imgsrc = $img;
4595: if ($img =~ /^\/adm/) {
1.575 albertel 4596: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4597: }
4598: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4599:
1.305 www 4600: # Explicit link to get inline menu
1.361 albertel 4601: my $menu= ($no_inline_link?''
1.883 droeschl 4602: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4603:
4604: if ($dc_info) {
4605: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4606: }
4607:
1.916 droeschl 4608: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4609: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4610: <li>$menu</li>
1.917 raeburn 4611: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4612: return(<<ENDBODY);
1.60 matthew 4613: $bodytag
1.359 albertel 4614: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4615: <tr><td>$upperleft</td>
4616: <td>$messages </td>
1.54 www 4617: </tr>
1.359 albertel 4618: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4619: </tr>
1.356 albertel 4620: </table>
1.54 www 4621: ENDBODY
1.182 matthew 4622: }
4623:
1.917 raeburn 4624: sub dc_courseid_toggle {
4625: my ($dc_info) = @_;
4626: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4627: '<a href="javascript:showCourseID();">'.
4628: &mt('(More ...)').'</a></span>'.
4629: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4630: }
4631:
1.330 albertel 4632: sub make_attr_string {
4633: my ($register,$attr_ref) = @_;
4634:
4635: if ($attr_ref && !ref($attr_ref)) {
4636: die("addentries Must be a hash ref ".
4637: join(':',caller(1))." ".
4638: join(':',caller(0))." ");
4639: }
4640:
4641: if ($register) {
1.339 albertel 4642: my ($on_load,$on_unload);
4643: foreach my $key (keys(%{$attr_ref})) {
4644: if (lc($key) eq 'onload') {
4645: $on_load.=$attr_ref->{$key}.';';
4646: delete($attr_ref->{$key});
4647:
4648: } elsif (lc($key) eq 'onunload') {
4649: $on_unload.=$attr_ref->{$key}.';';
4650: delete($attr_ref->{$key});
4651: }
4652: }
4653: $attr_ref->{'onload'} =
4654: &Apache::lonmenu::loadevents(). $on_load;
4655: $attr_ref->{'onunload'}=
4656: &Apache::lonmenu::unloadevents().$on_unload;
4657: }
4658:
4659: # Accessibility font enhance
4660: if ($env{'browser.fontenhance'} eq 'on') {
4661: my $style;
4662: foreach my $key (keys(%{$attr_ref})) {
4663: if (lc($key) eq 'style') {
4664: $style.=$attr_ref->{$key}.';';
4665: delete($attr_ref->{$key});
4666: }
4667: }
4668: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4669: }
1.339 albertel 4670:
1.330 albertel 4671: my $attr_string;
4672: foreach my $attr (keys(%$attr_ref)) {
4673: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4674: }
4675: return $attr_string;
4676: }
4677:
4678:
1.182 matthew 4679: ###############################################
1.251 albertel 4680: ###############################################
4681:
4682: =pod
4683:
4684: =item * &endbodytag()
4685:
4686: Returns a uniform footer for LON-CAPA web pages.
4687:
1.635 raeburn 4688: Inputs: 1 - optional reference to an args hash
4689: If in the hash, key for noredirectlink has a value which evaluates to true,
4690: a 'Continue' link is not displayed if the page contains an
4691: internal redirect in the <head></head> section,
4692: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4693:
4694: =cut
4695:
4696: sub endbodytag {
1.635 raeburn 4697: my ($args) = @_;
1.251 albertel 4698: my $endbodytag='</body>';
1.269 albertel 4699: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4700: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4701: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4702: $endbodytag=
4703: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4704: &mt('Continue').'</a>'.
4705: $endbodytag;
4706: }
1.315 albertel 4707: }
1.251 albertel 4708: return $endbodytag;
4709: }
4710:
1.352 albertel 4711: =pod
4712:
4713: =item * &standard_css()
4714:
4715: Returns a style sheet
4716:
4717: Inputs: (all optional)
4718: domain -> force to color decorate a page for a specific
4719: domain
4720: function -> force usage of a specific rolish color scheme
4721: bgcolor -> override the default page bgcolor
4722:
4723: =cut
4724:
1.343 albertel 4725: sub standard_css {
1.345 albertel 4726: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4727: $function = &get_users_function() if (!$function);
4728: my $img = &designparm($function.'.img', $domain);
4729: my $tabbg = &designparm($function.'.tabbg', $domain);
4730: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4731: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4732: #second colour for later usage
1.345 albertel 4733: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4734: my $pgbg_or_bgcolor =
4735: $bgcolor ||
1.352 albertel 4736: &designparm($function.'.pgbg', $domain);
1.382 albertel 4737: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4738: my $alink = &designparm($function.'.alink', $domain);
4739: my $vlink = &designparm($function.'.vlink', $domain);
4740: my $link = &designparm($function.'.link', $domain);
4741:
1.704 muellerd 4742: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4743: my $bgcol = &designparm('login.bgcol',$domain);
4744: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4745:
1.602 albertel 4746: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4747: my $mono = 'monospace';
1.850 bisitz 4748: my $data_table_head = $sidebg;
4749: my $data_table_light = '#FAFAFA';
4750: my $data_table_dark = '#F0F0F0';
1.470 banghart 4751: my $data_table_darker = '#CCCCCC';
1.349 albertel 4752: my $data_table_highlight = '#FFFF00';
1.352 albertel 4753: my $mail_new = '#FFBB77';
4754: my $mail_new_hover = '#DD9955';
4755: my $mail_read = '#BBBB77';
4756: my $mail_read_hover = '#999944';
4757: my $mail_replied = '#AAAA88';
4758: my $mail_replied_hover = '#888855';
4759: my $mail_other = '#99BBBB';
4760: my $mail_other_hover = '#669999';
1.391 albertel 4761: my $table_header = '#DDDDDD';
1.489 raeburn 4762: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4763: my $lg_border_color = '#C8C8C8';
1.392 albertel 4764:
1.608 albertel 4765: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4766: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4767: : '0 3px 0 4px';
1.448 albertel 4768:
1.523 albertel 4769:
1.343 albertel 4770: return <<END;
1.795 www 4771: body {
1.911 bisitz 4772: font-family: $sans;
4773: line-height:130%;
4774: font-size:0.83em;
4775: color:$font;
1.795 www 4776: }
4777:
1.911 bisitz 4778: a:focus {
1.795 www 4779: color: red;
1.911 bisitz 4780: background: yellow;
1.795 www 4781: }
1.698 harmsja 4782:
1.911 bisitz 4783: form, .inline {
4784: display: inline;
1.795 www 4785: }
1.721 harmsja 4786:
1.795 www 4787: .LC_right {
1.911 bisitz 4788: text-align:right;
1.795 www 4789: }
4790:
4791: .LC_middle {
1.911 bisitz 4792: vertical-align:middle;
1.795 www 4793: }
1.721 harmsja 4794:
4795: /* just for tests */
1.911 bisitz 4796: .LC_400Box {
4797: width:400px;
4798: }
1.721 harmsja 4799: /* end */
4800:
1.778 bisitz 4801: .LC_filename {
4802: font-family: $mono;
4803: white-space:pre;
1.921 bisitz 4804: font-size: 120%;
1.778 bisitz 4805: }
4806:
4807: .LC_fileicon {
4808: border: none;
4809: height: 1.3em;
4810: vertical-align: text-bottom;
4811: margin-right: 0.3em;
4812: text-decoration:none;
4813: }
4814:
1.350 albertel 4815: .LC_error {
4816: color: red;
4817: font-size: larger;
4818: }
1.795 www 4819:
1.457 albertel 4820: .LC_warning,
4821: .LC_diff_removed {
1.733 bisitz 4822: color: red;
1.394 albertel 4823: }
1.532 albertel 4824:
4825: .LC_info,
1.457 albertel 4826: .LC_success,
4827: .LC_diff_added {
1.350 albertel 4828: color: green;
4829: }
1.795 www 4830:
1.802 bisitz 4831: div.LC_confirm_box {
4832: background-color: #FAFAFA;
4833: border: 1px solid $lg_border_color;
4834: margin-right: 0;
4835: padding: 5px;
4836: }
4837:
4838: div.LC_confirm_box .LC_error img,
4839: div.LC_confirm_box .LC_success img {
4840: vertical-align: middle;
4841: }
4842:
1.440 albertel 4843: .LC_icon {
1.771 droeschl 4844: border: none;
1.790 droeschl 4845: vertical-align: middle;
1.771 droeschl 4846: }
4847:
1.543 albertel 4848: .LC_docs_spacer {
4849: width: 25px;
4850: height: 1px;
1.771 droeschl 4851: border: none;
1.543 albertel 4852: }
1.346 albertel 4853:
1.532 albertel 4854: .LC_internal_info {
1.735 bisitz 4855: color: #999999;
1.532 albertel 4856: }
4857:
1.794 www 4858: .LC_discussion {
1.911 bisitz 4859: background: $tabbg;
4860: border: 1px solid black;
4861: margin: 2px;
1.794 www 4862: }
4863:
4864: .LC_disc_action_links_bar {
1.911 bisitz 4865: background: $tabbg;
4866: border: none;
4867: margin: 4px;
1.794 www 4868: }
4869:
4870: .LC_disc_action_left {
1.911 bisitz 4871: text-align: left;
1.794 www 4872: }
4873:
4874: .LC_disc_action_right {
1.911 bisitz 4875: text-align: right;
1.794 www 4876: }
4877:
4878: .LC_disc_new_item {
1.911 bisitz 4879: background: white;
4880: border: 2px solid red;
4881: margin: 2px;
1.794 www 4882: }
4883:
4884: .LC_disc_old_item {
1.911 bisitz 4885: background: white;
4886: border: 1px solid black;
4887: margin: 2px;
1.794 www 4888: }
4889:
1.458 albertel 4890: table.LC_pastsubmission {
4891: border: 1px solid black;
4892: margin: 2px;
4893: }
4894:
1.924 bisitz 4895: table#LC_menubuttons {
1.345 albertel 4896: width: 100%;
4897: background: $pgbg;
1.392 albertel 4898: border: 2px;
1.402 albertel 4899: border-collapse: separate;
1.803 bisitz 4900: padding: 0;
1.345 albertel 4901: }
1.392 albertel 4902:
1.801 tempelho 4903: table#LC_title_bar a {
4904: color: $fontmenu;
4905: }
1.836 bisitz 4906:
1.807 droeschl 4907: table#LC_title_bar {
1.819 tempelho 4908: clear: both;
1.836 bisitz 4909: display: none;
1.807 droeschl 4910: }
4911:
1.795 www 4912: table#LC_title_bar,
1.933 droeschl 4913: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4914: table#LC_title_bar.LC_with_remote {
1.359 albertel 4915: width: 100%;
1.392 albertel 4916: border-color: $pgbg;
4917: border-style: solid;
4918: border-width: $border;
1.379 albertel 4919: background: $pgbg;
1.801 tempelho 4920: color: $fontmenu;
1.392 albertel 4921: border-collapse: collapse;
1.803 bisitz 4922: padding: 0;
1.819 tempelho 4923: margin: 0;
1.359 albertel 4924: }
1.795 www 4925:
1.933 droeschl 4926: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 4927: margin: 0;
4928: padding: 0;
1.933 droeschl 4929: position: relative;
4930: list-style: none;
1.913 droeschl 4931: }
1.933 droeschl 4932: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 4933: display: inline;
4934: }
1.933 droeschl 4935:
4936: .LC_breadcrumb_tools_navigation {
1.913 droeschl 4937: padding: 0;
1.933 droeschl 4938: margin: 0;
4939: float: left;
1.913 droeschl 4940: }
1.933 droeschl 4941: .LC_breadcrumb_tools_tools {
4942: padding: 0;
4943: margin: 0;
1.913 droeschl 4944: float: right;
4945: }
4946:
1.359 albertel 4947: table#LC_title_bar td {
4948: background: $tabbg;
4949: }
1.795 www 4950:
1.911 bisitz 4951: table#LC_menubuttons img {
1.803 bisitz 4952: border: none;
1.346 albertel 4953: }
1.795 www 4954:
1.842 droeschl 4955: .LC_breadcrumbs_component {
1.911 bisitz 4956: float: right;
4957: margin: 0 1em;
1.357 albertel 4958: }
1.842 droeschl 4959: .LC_breadcrumbs_component img {
1.911 bisitz 4960: vertical-align: middle;
1.777 tempelho 4961: }
1.795 www 4962:
1.383 albertel 4963: td.LC_table_cell_checkbox {
4964: text-align: center;
4965: }
1.795 www 4966:
4967: .LC_fontsize_small {
1.911 bisitz 4968: font-size: 70%;
1.705 tempelho 4969: }
4970:
1.844 bisitz 4971: #LC_breadcrumbs {
1.911 bisitz 4972: clear:both;
4973: background: $sidebg;
4974: border-bottom: 1px solid $lg_border_color;
4975: line-height: 2.5em;
1.933 droeschl 4976: overflow: hidden;
1.911 bisitz 4977: margin: 0;
4978: padding: 0;
1.819 tempelho 4979: }
1.862 bisitz 4980:
1.839 droeschl 4981: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 4982: #LC_remote #LC_breadcrumbs {
1.911 bisitz 4983: display:none;
1.839 droeschl 4984: }
1.819 tempelho 4985:
1.844 bisitz 4986: #LC_head_subbox {
1.911 bisitz 4987: clear:both;
4988: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 4989: border: 1px solid $sidebg;
4990: margin: 0 0 10px 0;
1.822 bisitz 4991: }
4992:
1.795 www 4993: .LC_fontsize_medium {
1.911 bisitz 4994: font-size: 85%;
1.705 tempelho 4995: }
4996:
1.795 www 4997: .LC_fontsize_large {
1.911 bisitz 4998: font-size: 120%;
1.705 tempelho 4999: }
5000:
1.346 albertel 5001: .LC_menubuttons_inline_text {
5002: color: $font;
1.698 harmsja 5003: font-size: 90%;
1.701 harmsja 5004: padding-left:3px;
1.346 albertel 5005: }
5006:
1.934 ! droeschl 5007: .LC_menubuttons_inline_text img{
! 5008: vertical-align: middle;
! 5009: }
! 5010:
1.526 www 5011: .LC_menubuttons_link {
5012: text-decoration: none;
5013: }
1.795 www 5014:
1.522 albertel 5015: .LC_menubuttons_category {
1.521 www 5016: color: $font;
1.526 www 5017: background: $pgbg;
1.521 www 5018: font-size: larger;
5019: font-weight: bold;
5020: }
5021:
1.346 albertel 5022: td.LC_menubuttons_text {
1.911 bisitz 5023: color: $font;
1.346 albertel 5024: }
1.706 harmsja 5025:
1.346 albertel 5026: .LC_current_location {
5027: background: $tabbg;
5028: }
1.795 www 5029:
5030: table.LC_data_table,
5031: table.LC_mail_list {
1.347 albertel 5032: border: 1px solid #000000;
1.402 albertel 5033: border-collapse: separate;
1.426 albertel 5034: border-spacing: 1px;
1.610 albertel 5035: background: $pgbg;
1.347 albertel 5036: }
1.795 www 5037:
1.422 albertel 5038: .LC_data_table_dense {
5039: font-size: small;
5040: }
1.795 www 5041:
1.507 raeburn 5042: table.LC_nested_outer {
5043: border: 1px solid #000000;
1.589 raeburn 5044: border-collapse: collapse;
1.803 bisitz 5045: border-spacing: 0;
1.507 raeburn 5046: width: 100%;
5047: }
1.795 www 5048:
1.879 raeburn 5049: table.LC_innerpickbox,
1.507 raeburn 5050: table.LC_nested {
1.803 bisitz 5051: border: none;
1.589 raeburn 5052: border-collapse: collapse;
1.803 bisitz 5053: border-spacing: 0;
1.507 raeburn 5054: width: 100%;
5055: }
1.795 www 5056:
1.930 faziophi 5057: .ui-accordion,
5058: .ui-accordion table.LC_data_table,
5059: .ui-accordion table.LC_nested_outer{
5060: border: 0px;
5061: border-spacing: 0px;
5062: margin: 3px;
5063: }
5064:
1.911 bisitz 5065: table.LC_data_table tr th,
5066: table.LC_calendar tr th,
1.795 www 5067: table.LC_mail_list tr th,
1.879 raeburn 5068: table.LC_prior_tries tr th,
5069: table.LC_innerpickbox tr th {
1.349 albertel 5070: font-weight: bold;
5071: background-color: $data_table_head;
1.801 tempelho 5072: color:$fontmenu;
1.701 harmsja 5073: font-size:90%;
1.347 albertel 5074: }
1.795 www 5075:
1.879 raeburn 5076: table.LC_innerpickbox tr th,
5077: table.LC_innerpickbox tr td {
5078: vertical-align: top;
5079: }
5080:
1.711 raeburn 5081: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5082: background-color: #CCCCCC;
1.711 raeburn 5083: font-weight: bold;
5084: text-align: left;
5085: }
1.795 www 5086:
1.912 bisitz 5087: table.LC_data_table tr.LC_odd_row > td {
5088: background-color: $data_table_light;
5089: padding: 2px;
5090: vertical-align: top;
5091: }
5092:
1.809 bisitz 5093: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5094: background-color: $data_table_light;
1.912 bisitz 5095: vertical-align: top;
5096: }
5097:
5098: table.LC_data_table tr.LC_even_row > td {
5099: background-color: $data_table_dark;
1.425 albertel 5100: padding: 2px;
1.900 bisitz 5101: vertical-align: top;
1.347 albertel 5102: }
1.795 www 5103:
1.809 bisitz 5104: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5105: background-color: $data_table_dark;
1.900 bisitz 5106: vertical-align: top;
1.347 albertel 5107: }
1.795 www 5108:
1.425 albertel 5109: table.LC_data_table tr.LC_data_table_highlight td {
5110: background-color: $data_table_darker;
5111: }
1.795 www 5112:
1.639 raeburn 5113: table.LC_data_table tr td.LC_leftcol_header {
5114: background-color: $data_table_head;
5115: font-weight: bold;
5116: }
1.795 www 5117:
1.451 albertel 5118: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5119: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5120: background-color: #FFFFFF;
1.421 albertel 5121: font-weight: bold;
5122: font-style: italic;
5123: text-align: center;
5124: padding: 8px;
1.347 albertel 5125: }
1.795 www 5126:
1.890 droeschl 5127: table.LC_caption {
5128: }
5129:
1.507 raeburn 5130: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5131: padding: 4ex
5132: }
1.795 www 5133:
1.507 raeburn 5134: table.LC_nested_outer tr th {
5135: font-weight: bold;
1.801 tempelho 5136: color:$fontmenu;
1.507 raeburn 5137: background-color: $data_table_head;
1.701 harmsja 5138: font-size: small;
1.507 raeburn 5139: border-bottom: 1px solid #000000;
5140: }
1.795 www 5141:
1.507 raeburn 5142: table.LC_nested_outer tr td.LC_subheader {
5143: background-color: $data_table_head;
5144: font-weight: bold;
5145: font-size: small;
5146: border-bottom: 1px solid #000000;
5147: text-align: right;
1.451 albertel 5148: }
1.795 www 5149:
1.507 raeburn 5150: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5151: background-color: #CCCCCC;
1.451 albertel 5152: font-weight: bold;
5153: font-size: small;
1.507 raeburn 5154: text-align: center;
5155: }
1.795 www 5156:
1.589 raeburn 5157: table.LC_nested tr.LC_info_row td.LC_left_item,
5158: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5159: text-align: left;
1.451 albertel 5160: }
1.795 www 5161:
1.507 raeburn 5162: table.LC_nested td {
1.735 bisitz 5163: background-color: #FFFFFF;
1.451 albertel 5164: font-size: small;
1.507 raeburn 5165: }
1.795 www 5166:
1.507 raeburn 5167: table.LC_nested_outer tr th.LC_right_item,
5168: table.LC_nested tr.LC_info_row td.LC_right_item,
5169: table.LC_nested tr.LC_odd_row td.LC_right_item,
5170: table.LC_nested tr td.LC_right_item {
1.451 albertel 5171: text-align: right;
5172: }
5173:
1.930 faziophi 5174: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5175: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5176: text-align: right;
5177: width: 40%;
5178: padding-right:10px;
5179: vertical-align: top;
5180: padding: 5px;
5181: }
5182:
5183: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5184: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5185: text-align: left;
5186: width: 60%;
5187: padding: 2px 4px;
5188: }
5189:
1.507 raeburn 5190: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5191: background-color: #EEEEEE;
1.451 albertel 5192: }
5193:
1.473 raeburn 5194: table.LC_createuser {
5195: }
5196:
5197: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5198: font-size: small;
1.473 raeburn 5199: }
5200:
5201: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5202: background-color: #CCCCCC;
1.473 raeburn 5203: font-weight: bold;
5204: text-align: center;
5205: }
5206:
1.349 albertel 5207: table.LC_calendar {
5208: border: 1px solid #000000;
5209: border-collapse: collapse;
1.917 raeburn 5210: width: 98%;
1.349 albertel 5211: }
1.795 www 5212:
1.349 albertel 5213: table.LC_calendar_pickdate {
5214: font-size: xx-small;
5215: }
1.795 www 5216:
1.349 albertel 5217: table.LC_calendar tr td {
5218: border: 1px solid #000000;
5219: vertical-align: top;
1.917 raeburn 5220: width: 14%;
1.349 albertel 5221: }
1.795 www 5222:
1.349 albertel 5223: table.LC_calendar tr td.LC_calendar_day_empty {
5224: background-color: $data_table_dark;
5225: }
1.795 www 5226:
1.779 bisitz 5227: table.LC_calendar tr td.LC_calendar_day_current {
5228: background-color: $data_table_highlight;
1.777 tempelho 5229: }
1.795 www 5230:
1.349 albertel 5231: table.LC_mail_list tr.LC_mail_new {
5232: background-color: $mail_new;
5233: }
1.795 www 5234:
1.349 albertel 5235: table.LC_mail_list tr.LC_mail_new:hover {
5236: background-color: $mail_new_hover;
5237: }
1.795 www 5238:
1.349 albertel 5239: table.LC_mail_list tr.LC_mail_read {
5240: background-color: $mail_read;
5241: }
1.795 www 5242:
1.349 albertel 5243: table.LC_mail_list tr.LC_mail_read:hover {
5244: background-color: $mail_read_hover;
5245: }
1.795 www 5246:
1.349 albertel 5247: table.LC_mail_list tr.LC_mail_replied {
5248: background-color: $mail_replied;
5249: }
1.795 www 5250:
1.349 albertel 5251: table.LC_mail_list tr.LC_mail_replied:hover {
5252: background-color: $mail_replied_hover;
5253: }
1.795 www 5254:
1.349 albertel 5255: table.LC_mail_list tr.LC_mail_other {
5256: background-color: $mail_other;
5257: }
1.795 www 5258:
1.349 albertel 5259: table.LC_mail_list tr.LC_mail_other:hover {
5260: background-color: $mail_other_hover;
5261: }
1.494 raeburn 5262:
1.777 tempelho 5263: table.LC_data_table tr > td.LC_browser_file,
5264: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5265: background: #AAEE77;
1.389 albertel 5266: }
1.795 www 5267:
1.777 tempelho 5268: table.LC_data_table tr > td.LC_browser_file_locked,
5269: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5270: background: #FFAA99;
1.387 albertel 5271: }
1.795 www 5272:
1.777 tempelho 5273: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5274: background: #888888;
1.779 bisitz 5275: }
1.795 www 5276:
1.777 tempelho 5277: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5278: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5279: background: #F8F866;
1.777 tempelho 5280: }
1.795 www 5281:
1.696 bisitz 5282: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5283: background: #E0E8FF;
1.387 albertel 5284: }
1.696 bisitz 5285:
1.707 bisitz 5286: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5287: /* background: #77FF77; */
1.707 bisitz 5288: }
1.795 www 5289:
1.707 bisitz 5290: table.LC_data_table tr > td.LC_roles_future {
5291: background: #FFFF77;
5292: }
1.795 www 5293:
1.707 bisitz 5294: table.LC_data_table tr > td.LC_roles_will {
5295: background: #FFAA77;
5296: }
1.795 www 5297:
1.707 bisitz 5298: table.LC_data_table tr > td.LC_roles_expired {
5299: background: #FF7777;
5300: }
1.795 www 5301:
1.707 bisitz 5302: table.LC_data_table tr > td.LC_roles_will_not {
5303: background: #AAFF77;
5304: }
1.795 www 5305:
1.707 bisitz 5306: table.LC_data_table tr > td.LC_roles_selected {
5307: background: #11CC55;
5308: }
5309:
1.388 albertel 5310: span.LC_current_location {
1.701 harmsja 5311: font-size:larger;
1.388 albertel 5312: background: $pgbg;
5313: }
1.387 albertel 5314:
1.395 albertel 5315: span.LC_parm_menu_item {
5316: font-size: larger;
5317: }
1.795 www 5318:
1.395 albertel 5319: span.LC_parm_scope_all {
5320: color: red;
5321: }
1.795 www 5322:
1.395 albertel 5323: span.LC_parm_scope_folder {
5324: color: green;
5325: }
1.795 www 5326:
1.395 albertel 5327: span.LC_parm_scope_resource {
5328: color: orange;
5329: }
1.795 www 5330:
1.395 albertel 5331: span.LC_parm_part {
5332: color: blue;
5333: }
1.795 www 5334:
1.911 bisitz 5335: span.LC_parm_folder,
5336: span.LC_parm_symb {
1.395 albertel 5337: font-size: x-small;
5338: font-family: $mono;
5339: color: #AAAAAA;
5340: }
5341:
1.795 www 5342: td.LC_parm_overview_level_menu,
5343: td.LC_parm_overview_map_menu,
5344: td.LC_parm_overview_parm_selectors,
5345: td.LC_parm_overview_restrictions {
1.396 albertel 5346: border: 1px solid black;
5347: border-collapse: collapse;
5348: }
1.795 www 5349:
1.396 albertel 5350: table.LC_parm_overview_restrictions td {
5351: border-width: 1px 4px 1px 4px;
5352: border-style: solid;
5353: border-color: $pgbg;
5354: text-align: center;
5355: }
1.795 www 5356:
1.396 albertel 5357: table.LC_parm_overview_restrictions th {
5358: background: $tabbg;
5359: border-width: 1px 4px 1px 4px;
5360: border-style: solid;
5361: border-color: $pgbg;
5362: }
1.795 www 5363:
1.398 albertel 5364: table#LC_helpmenu {
1.803 bisitz 5365: border: none;
1.398 albertel 5366: height: 55px;
1.803 bisitz 5367: border-spacing: 0;
1.398 albertel 5368: }
5369:
5370: table#LC_helpmenu fieldset legend {
5371: font-size: larger;
5372: }
1.795 www 5373:
1.397 albertel 5374: table#LC_helpmenu_links {
5375: width: 100%;
5376: border: 1px solid black;
5377: background: $pgbg;
1.803 bisitz 5378: padding: 0;
1.397 albertel 5379: border-spacing: 1px;
5380: }
1.795 www 5381:
1.397 albertel 5382: table#LC_helpmenu_links tr td {
5383: padding: 1px;
5384: background: $tabbg;
1.399 albertel 5385: text-align: center;
5386: font-weight: bold;
1.397 albertel 5387: }
1.396 albertel 5388:
1.795 www 5389: table#LC_helpmenu_links a:link,
5390: table#LC_helpmenu_links a:visited,
1.397 albertel 5391: table#LC_helpmenu_links a:active {
5392: text-decoration: none;
5393: color: $font;
5394: }
1.795 www 5395:
1.397 albertel 5396: table#LC_helpmenu_links a:hover {
5397: text-decoration: underline;
5398: color: $vlink;
5399: }
1.396 albertel 5400:
1.417 albertel 5401: .LC_chrt_popup_exists {
5402: border: 1px solid #339933;
5403: margin: -1px;
5404: }
1.795 www 5405:
1.417 albertel 5406: .LC_chrt_popup_up {
5407: border: 1px solid yellow;
5408: margin: -1px;
5409: }
1.795 www 5410:
1.417 albertel 5411: .LC_chrt_popup {
5412: border: 1px solid #8888FF;
5413: background: #CCCCFF;
5414: }
1.795 www 5415:
1.421 albertel 5416: table.LC_pick_box {
5417: border-collapse: separate;
5418: background: white;
5419: border: 1px solid black;
5420: border-spacing: 1px;
5421: }
1.795 www 5422:
1.421 albertel 5423: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5424: background: $sidebg;
1.421 albertel 5425: font-weight: bold;
1.900 bisitz 5426: text-align: left;
1.740 bisitz 5427: vertical-align: top;
1.421 albertel 5428: width: 184px;
5429: padding: 8px;
5430: }
1.795 www 5431:
1.579 raeburn 5432: table.LC_pick_box td.LC_pick_box_value {
5433: text-align: left;
5434: padding: 8px;
5435: }
1.795 www 5436:
1.579 raeburn 5437: table.LC_pick_box td.LC_pick_box_select {
5438: text-align: left;
5439: padding: 8px;
5440: }
1.795 www 5441:
1.424 albertel 5442: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5443: padding: 0;
1.421 albertel 5444: height: 1px;
5445: background: black;
5446: }
1.795 www 5447:
1.421 albertel 5448: table.LC_pick_box td.LC_pick_box_submit {
5449: text-align: right;
5450: }
1.795 www 5451:
1.579 raeburn 5452: table.LC_pick_box td.LC_evenrow_value {
5453: text-align: left;
5454: padding: 8px;
5455: background-color: $data_table_light;
5456: }
1.795 www 5457:
1.579 raeburn 5458: table.LC_pick_box td.LC_oddrow_value {
5459: text-align: left;
5460: padding: 8px;
5461: background-color: $data_table_light;
5462: }
1.795 www 5463:
1.579 raeburn 5464: span.LC_helpform_receipt_cat {
5465: font-weight: bold;
5466: }
1.795 www 5467:
1.424 albertel 5468: table.LC_group_priv_box {
5469: background: white;
5470: border: 1px solid black;
5471: border-spacing: 1px;
5472: }
1.795 www 5473:
1.424 albertel 5474: table.LC_group_priv_box td.LC_pick_box_title {
5475: background: $tabbg;
5476: font-weight: bold;
5477: text-align: right;
5478: width: 184px;
5479: }
1.795 www 5480:
1.424 albertel 5481: table.LC_group_priv_box td.LC_groups_fixed {
5482: background: $data_table_light;
5483: text-align: center;
5484: }
1.795 www 5485:
1.424 albertel 5486: table.LC_group_priv_box td.LC_groups_optional {
5487: background: $data_table_dark;
5488: text-align: center;
5489: }
1.795 www 5490:
1.424 albertel 5491: table.LC_group_priv_box td.LC_groups_functionality {
5492: background: $data_table_darker;
5493: text-align: center;
5494: font-weight: bold;
5495: }
1.795 www 5496:
1.424 albertel 5497: table.LC_group_priv td {
5498: text-align: left;
1.803 bisitz 5499: padding: 0;
1.424 albertel 5500: }
5501:
1.421 albertel 5502: table.LC_notify_front_page {
5503: background: white;
5504: border: 1px solid black;
5505: padding: 8px;
5506: }
1.795 www 5507:
1.421 albertel 5508: table.LC_notify_front_page td {
5509: padding: 8px;
5510: }
1.795 www 5511:
1.424 albertel 5512: .LC_navbuttons {
5513: margin: 2ex 0ex 2ex 0ex;
5514: }
1.795 www 5515:
1.423 albertel 5516: .LC_topic_bar {
5517: font-weight: bold;
5518: background: $tabbg;
1.918 wenzelju 5519: margin: 1em 0em 1em 2em;
1.805 bisitz 5520: padding: 3px;
1.918 wenzelju 5521: font-size: 1.2em;
1.423 albertel 5522: }
1.795 www 5523:
1.423 albertel 5524: .LC_topic_bar span {
1.918 wenzelju 5525: left: 0.5em;
5526: position: absolute;
1.423 albertel 5527: vertical-align: middle;
1.918 wenzelju 5528: font-size: 1.2em;
1.423 albertel 5529: }
1.795 www 5530:
1.423 albertel 5531: table.LC_course_group_status {
5532: margin: 20px;
5533: }
1.795 www 5534:
1.423 albertel 5535: table.LC_status_selector td {
5536: vertical-align: top;
5537: text-align: center;
1.424 albertel 5538: padding: 4px;
5539: }
1.795 www 5540:
1.599 albertel 5541: div.LC_feedback_link {
1.616 albertel 5542: clear: both;
1.829 kalberla 5543: background: $sidebg;
1.779 bisitz 5544: width: 100%;
1.829 kalberla 5545: padding-bottom: 10px;
5546: border: 1px $tabbg solid;
1.833 kalberla 5547: height: 22px;
5548: line-height: 22px;
5549: padding-top: 5px;
5550: }
5551:
5552: div.LC_feedback_link img {
5553: height: 22px;
1.867 kalberla 5554: vertical-align:middle;
1.829 kalberla 5555: }
5556:
1.911 bisitz 5557: div.LC_feedback_link a {
1.829 kalberla 5558: text-decoration: none;
1.489 raeburn 5559: }
1.795 www 5560:
1.867 kalberla 5561: div.LC_comblock {
1.911 bisitz 5562: display:inline;
1.867 kalberla 5563: color:$font;
5564: font-size:90%;
5565: }
5566:
5567: div.LC_feedback_link div.LC_comblock {
5568: padding-left:5px;
5569: }
5570:
5571: div.LC_feedback_link div.LC_comblock a {
5572: color:$font;
5573: }
5574:
1.489 raeburn 5575: span.LC_feedback_link {
1.858 bisitz 5576: /* background: $feedback_link_bg; */
1.599 albertel 5577: font-size: larger;
5578: }
1.795 www 5579:
1.599 albertel 5580: span.LC_message_link {
1.858 bisitz 5581: /* background: $feedback_link_bg; */
1.599 albertel 5582: font-size: larger;
5583: position: absolute;
5584: right: 1em;
1.489 raeburn 5585: }
1.421 albertel 5586:
1.515 albertel 5587: table.LC_prior_tries {
1.524 albertel 5588: border: 1px solid #000000;
5589: border-collapse: separate;
5590: border-spacing: 1px;
1.515 albertel 5591: }
1.523 albertel 5592:
1.515 albertel 5593: table.LC_prior_tries td {
1.524 albertel 5594: padding: 2px;
1.515 albertel 5595: }
1.523 albertel 5596:
5597: .LC_answer_correct {
1.795 www 5598: background: lightgreen;
5599: color: darkgreen;
5600: padding: 6px;
1.523 albertel 5601: }
1.795 www 5602:
1.523 albertel 5603: .LC_answer_charged_try {
1.797 www 5604: background: #FFAAAA;
1.795 www 5605: color: darkred;
5606: padding: 6px;
1.523 albertel 5607: }
1.795 www 5608:
1.779 bisitz 5609: .LC_answer_not_charged_try,
1.523 albertel 5610: .LC_answer_no_grade,
5611: .LC_answer_late {
1.795 www 5612: background: lightyellow;
1.523 albertel 5613: color: black;
1.795 www 5614: padding: 6px;
1.523 albertel 5615: }
1.795 www 5616:
1.523 albertel 5617: .LC_answer_previous {
1.795 www 5618: background: lightblue;
5619: color: darkblue;
5620: padding: 6px;
1.523 albertel 5621: }
1.795 www 5622:
1.779 bisitz 5623: .LC_answer_no_message {
1.777 tempelho 5624: background: #FFFFFF;
5625: color: black;
1.795 www 5626: padding: 6px;
1.779 bisitz 5627: }
1.795 www 5628:
1.779 bisitz 5629: .LC_answer_unknown {
5630: background: orange;
5631: color: black;
1.795 www 5632: padding: 6px;
1.777 tempelho 5633: }
1.795 www 5634:
1.529 albertel 5635: span.LC_prior_numerical,
5636: span.LC_prior_string,
5637: span.LC_prior_custom,
5638: span.LC_prior_reaction,
5639: span.LC_prior_math {
1.925 bisitz 5640: font-family: $mono;
1.523 albertel 5641: white-space: pre;
5642: }
5643:
1.525 albertel 5644: span.LC_prior_string {
1.925 bisitz 5645: font-family: $mono;
1.525 albertel 5646: white-space: pre;
5647: }
5648:
1.523 albertel 5649: table.LC_prior_option {
5650: width: 100%;
5651: border-collapse: collapse;
5652: }
1.795 www 5653:
1.911 bisitz 5654: table.LC_prior_rank,
1.795 www 5655: table.LC_prior_match {
1.528 albertel 5656: border-collapse: collapse;
5657: }
1.795 www 5658:
1.528 albertel 5659: table.LC_prior_option tr td,
5660: table.LC_prior_rank tr td,
5661: table.LC_prior_match tr td {
1.524 albertel 5662: border: 1px solid #000000;
1.515 albertel 5663: }
5664:
1.855 bisitz 5665: .LC_nobreak {
1.544 albertel 5666: white-space: nowrap;
1.519 raeburn 5667: }
5668:
1.576 raeburn 5669: span.LC_cusr_emph {
5670: font-style: italic;
5671: }
5672:
1.633 raeburn 5673: span.LC_cusr_subheading {
5674: font-weight: normal;
5675: font-size: 85%;
5676: }
5677:
1.861 bisitz 5678: div.LC_docs_entry_move {
1.859 bisitz 5679: border: 1px solid #BBBBBB;
1.545 albertel 5680: background: #DDDDDD;
1.861 bisitz 5681: width: 22px;
1.859 bisitz 5682: padding: 1px;
5683: margin: 0;
1.545 albertel 5684: }
5685:
1.861 bisitz 5686: table.LC_data_table tr > td.LC_docs_entry_commands,
5687: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5688: background: #DDDDDD;
5689: font-size: x-small;
5690: }
1.795 www 5691:
1.861 bisitz 5692: .LC_docs_entry_parameter {
5693: white-space: nowrap;
5694: }
5695:
1.544 albertel 5696: .LC_docs_copy {
1.545 albertel 5697: color: #000099;
1.544 albertel 5698: }
1.795 www 5699:
1.544 albertel 5700: .LC_docs_cut {
1.545 albertel 5701: color: #550044;
1.544 albertel 5702: }
1.795 www 5703:
1.544 albertel 5704: .LC_docs_rename {
1.545 albertel 5705: color: #009900;
1.544 albertel 5706: }
1.795 www 5707:
1.544 albertel 5708: .LC_docs_remove {
1.545 albertel 5709: color: #990000;
5710: }
5711:
1.547 albertel 5712: .LC_docs_reinit_warn,
5713: .LC_docs_ext_edit {
5714: font-size: x-small;
5715: }
5716:
1.545 albertel 5717: table.LC_docs_adddocs td,
5718: table.LC_docs_adddocs th {
5719: border: 1px solid #BBBBBB;
5720: padding: 4px;
5721: background: #DDDDDD;
1.543 albertel 5722: }
5723:
1.584 albertel 5724: table.LC_sty_begin {
5725: background: #BBFFBB;
5726: }
1.795 www 5727:
1.584 albertel 5728: table.LC_sty_end {
5729: background: #FFBBBB;
5730: }
5731:
1.589 raeburn 5732: table.LC_double_column {
1.803 bisitz 5733: border-width: 0;
1.589 raeburn 5734: border-collapse: collapse;
5735: width: 100%;
5736: padding: 2px;
5737: }
5738:
5739: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5740: top: 2px;
1.589 raeburn 5741: left: 2px;
5742: width: 47%;
5743: vertical-align: top;
5744: }
5745:
5746: table.LC_double_column tr td.LC_right_col {
5747: top: 2px;
1.779 bisitz 5748: right: 2px;
1.589 raeburn 5749: width: 47%;
5750: vertical-align: top;
5751: }
5752:
1.591 raeburn 5753: div.LC_left_float {
5754: float: left;
5755: padding-right: 5%;
1.597 albertel 5756: padding-bottom: 4px;
1.591 raeburn 5757: }
5758:
5759: div.LC_clear_float_header {
1.597 albertel 5760: padding-bottom: 2px;
1.591 raeburn 5761: }
5762:
5763: div.LC_clear_float_footer {
1.597 albertel 5764: padding-top: 10px;
1.591 raeburn 5765: clear: both;
5766: }
5767:
1.597 albertel 5768: div.LC_grade_show_user {
5769: margin-top: 20px;
5770: border: 1px solid black;
5771: }
1.795 www 5772:
1.597 albertel 5773: div.LC_grade_user_name {
5774: background: #DDDDEE;
5775: border-bottom: 1px solid black;
1.705 tempelho 5776: font-weight: bold;
5777: font-size: large;
1.597 albertel 5778: }
1.795 www 5779:
1.597 albertel 5780: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5781: background: #DDEEDD;
5782: }
5783:
5784: div.LC_grade_show_problem,
5785: div.LC_grade_submissions,
5786: div.LC_grade_message_center,
5787: div.LC_grade_info_links,
5788: div.LC_grade_assign {
5789: margin: 5px;
5790: width: 99%;
5791: background: #FFFFFF;
5792: }
1.795 www 5793:
1.597 albertel 5794: div.LC_grade_show_problem_header,
5795: div.LC_grade_submissions_header,
5796: div.LC_grade_message_center_header,
5797: div.LC_grade_assign_header {
1.705 tempelho 5798: font-weight: bold;
5799: font-size: large;
1.597 albertel 5800: }
1.795 www 5801:
1.597 albertel 5802: div.LC_grade_show_problem_problem,
5803: div.LC_grade_submissions_body,
5804: div.LC_grade_message_center_body,
5805: div.LC_grade_assign_body {
5806: border: 1px solid black;
5807: width: 99%;
5808: background: #FFFFFF;
5809: }
1.795 www 5810:
1.598 albertel 5811: span.LC_grade_check_note {
1.705 tempelho 5812: font-weight: normal;
5813: font-size: medium;
1.598 albertel 5814: display: inline;
5815: position: absolute;
5816: right: 1em;
5817: }
1.597 albertel 5818:
1.613 albertel 5819: table.LC_scantron_action {
5820: width: 100%;
5821: }
1.795 www 5822:
1.613 albertel 5823: table.LC_scantron_action tr th {
1.698 harmsja 5824: font-weight:bold;
5825: font-style:normal;
1.613 albertel 5826: }
1.795 www 5827:
1.779 bisitz 5828: .LC_edit_problem_header,
1.614 albertel 5829: div.LC_edit_problem_footer {
1.705 tempelho 5830: font-weight: normal;
5831: font-size: medium;
1.602 albertel 5832: margin: 2px;
1.600 albertel 5833: }
1.795 www 5834:
1.600 albertel 5835: div.LC_edit_problem_header,
1.602 albertel 5836: div.LC_edit_problem_header div,
1.614 albertel 5837: div.LC_edit_problem_footer,
5838: div.LC_edit_problem_footer div,
1.602 albertel 5839: div.LC_edit_problem_editxml_header,
5840: div.LC_edit_problem_editxml_header div {
1.600 albertel 5841: margin-top: 5px;
5842: }
1.795 www 5843:
1.600 albertel 5844: div.LC_edit_problem_header_title {
1.705 tempelho 5845: font-weight: bold;
5846: font-size: larger;
1.602 albertel 5847: background: $tabbg;
5848: padding: 3px;
5849: }
1.795 www 5850:
1.602 albertel 5851: table.LC_edit_problem_header_title {
1.705 tempelho 5852: font-size: larger;
5853: font-weight: bold;
1.602 albertel 5854: width: 100%;
5855: border-color: $pgbg;
5856: border-style: solid;
5857: border-width: $border;
1.600 albertel 5858: background: $tabbg;
1.602 albertel 5859: border-collapse: collapse;
1.803 bisitz 5860: padding: 0;
1.602 albertel 5861: }
5862:
5863: div.LC_edit_problem_discards {
5864: float: left;
5865: padding-bottom: 5px;
5866: }
1.795 www 5867:
1.602 albertel 5868: div.LC_edit_problem_saves {
5869: float: right;
5870: padding-bottom: 5px;
1.600 albertel 5871: }
1.795 www 5872:
1.911 bisitz 5873: img.stift {
1.803 bisitz 5874: border-width: 0;
5875: vertical-align: middle;
1.677 riegler 5876: }
1.680 riegler 5877:
1.923 bisitz 5878: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5879: vertical-align: top;
1.777 tempelho 5880: }
1.795 www 5881:
1.716 raeburn 5882: div.LC_createcourse {
1.911 bisitz 5883: margin: 10px 10px 10px 10px;
1.716 raeburn 5884: }
5885:
1.917 raeburn 5886: .LC_dccid {
5887: margin: 0.2em 0 0 0;
5888: padding: 0;
5889: font-size: 90%;
5890: display:none;
5891: }
5892:
1.693 droeschl 5893: /* ---- Remove when done ----
5894: # The following styles is part of the redesign of LON-CAPA and are
5895: # subject to change during this project.
5896: # Don't rely on their current functionality as they might be
5897: # changed or removed.
5898: # --------------------------*/
5899:
1.698 harmsja 5900: a:hover,
1.897 wenzelju 5901: ol.LC_primary_menu a:hover,
1.721 harmsja 5902: ol#LC_MenuBreadcrumbs a:hover,
5903: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5904: ul#LC_secondary_menu a:hover,
1.721 harmsja 5905: .LC_FormSectionClearButton input:hover
1.795 www 5906: ul.LC_TabContent li:hover a {
1.911 bisitz 5907: color:#BF2317;
5908: text-decoration:none;
1.693 droeschl 5909: }
5910:
1.779 bisitz 5911: h1 {
1.911 bisitz 5912: padding: 0;
5913: line-height:130%;
1.693 droeschl 5914: }
1.698 harmsja 5915:
1.911 bisitz 5916: h2,
5917: h3,
5918: h4,
5919: h5,
5920: h6 {
5921: margin: 5px 0 5px 0;
5922: padding: 0;
5923: line-height:130%;
1.693 droeschl 5924: }
1.795 www 5925:
5926: .LC_hcell {
1.911 bisitz 5927: padding:3px 15px 3px 15px;
5928: margin: 0;
5929: background-color:$tabbg;
5930: color:$fontmenu;
5931: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5932: }
1.795 www 5933:
1.840 bisitz 5934: .LC_Box > .LC_hcell {
1.911 bisitz 5935: margin: 0 -10px 10px -10px;
1.835 bisitz 5936: }
5937:
1.721 harmsja 5938: .LC_noBorder {
1.911 bisitz 5939: border: 0;
1.698 harmsja 5940: }
1.693 droeschl 5941:
1.721 harmsja 5942: .LC_FormSectionClearButton input {
1.911 bisitz 5943: background-color:transparent;
5944: border: none;
5945: cursor:pointer;
5946: text-decoration:underline;
1.693 droeschl 5947: }
1.763 bisitz 5948:
5949: .LC_help_open_topic {
1.911 bisitz 5950: color: #FFFFFF;
5951: background-color: #EEEEFF;
5952: margin: 1px;
5953: padding: 4px;
5954: border: 1px solid #000033;
5955: white-space: nowrap;
5956: /* vertical-align: middle; */
1.759 neumanie 5957: }
1.693 droeschl 5958:
1.911 bisitz 5959: dl,
5960: ul,
5961: div,
5962: fieldset {
5963: margin: 10px 10px 10px 0;
5964: /* overflow: hidden; */
1.693 droeschl 5965: }
1.795 www 5966:
1.838 bisitz 5967: fieldset > legend {
1.911 bisitz 5968: font-weight: bold;
5969: padding: 0 5px 0 5px;
1.838 bisitz 5970: }
5971:
1.813 bisitz 5972: #LC_nav_bar {
1.911 bisitz 5973: float: left;
1.934 ! droeschl 5974: margin: 0;
1.807 droeschl 5975: }
5976:
1.916 droeschl 5977: #LC_realm {
5978: margin: 0.2em 0 0 0;
5979: padding: 0;
5980: font-weight: bold;
5981: text-align: center;
5982: }
5983:
1.911 bisitz 5984: #LC_nav_bar em {
5985: font-weight: bold;
5986: font-style: normal;
1.807 droeschl 5987: }
5988:
1.897 wenzelju 5989: ol.LC_primary_menu {
1.911 bisitz 5990: float: right;
1.934 ! droeschl 5991: margin: 0;
1.807 droeschl 5992: }
5993:
1.929 wenzelju 5994: span.LC_new_message{
5995: font-weight:bold;
5996: color: darkred;
5997: }
5998:
1.852 droeschl 5999: ol#LC_PathBreadcrumbs {
1.911 bisitz 6000: margin: 0;
1.693 droeschl 6001: }
6002:
1.897 wenzelju 6003: ol.LC_primary_menu li {
1.911 bisitz 6004: display: inline;
6005: padding: 5px 5px 0 10px;
6006: vertical-align: top;
1.693 droeschl 6007: }
6008:
1.897 wenzelju 6009: ol.LC_primary_menu li img {
1.911 bisitz 6010: vertical-align: bottom;
1.934 ! droeschl 6011: height: 1.1em;
1.693 droeschl 6012: }
6013:
1.897 wenzelju 6014: ol.LC_primary_menu a {
1.911 bisitz 6015: color: RGB(80, 80, 80);
6016: text-decoration: none;
1.693 droeschl 6017: }
1.795 www 6018:
1.897 wenzelju 6019: ul#LC_secondary_menu {
1.911 bisitz 6020: clear: both;
6021: color: $fontmenu;
6022: background: $tabbg;
6023: list-style: none;
6024: padding: 0;
6025: margin: 0;
6026: width: 100%;
1.808 droeschl 6027: }
6028:
1.897 wenzelju 6029: ul#LC_secondary_menu li {
1.911 bisitz 6030: font-weight: bold;
6031: line-height: 1.8em;
6032: padding: 0 0.8em;
6033: border-right: 1px solid black;
6034: display: inline;
6035: vertical-align: middle;
1.807 droeschl 6036: }
6037:
1.847 tempelho 6038: ul.LC_TabContent {
1.911 bisitz 6039: display:block;
6040: background: $sidebg;
6041: border-bottom: solid 1px $lg_border_color;
6042: list-style:none;
6043: margin: 0 -10px;
6044: padding: 0;
1.693 droeschl 6045: }
6046:
1.795 www 6047: ul.LC_TabContent li,
6048: ul.LC_TabContentBigger li {
1.911 bisitz 6049: float:left;
1.741 harmsja 6050: }
1.795 www 6051:
1.897 wenzelju 6052: ul#LC_secondary_menu li a {
1.911 bisitz 6053: color: $fontmenu;
6054: text-decoration: none;
1.693 droeschl 6055: }
1.795 www 6056:
1.721 harmsja 6057: ul.LC_TabContent {
1.911 bisitz 6058: min-height:1.5em;
1.721 harmsja 6059: }
1.795 www 6060:
6061: ul.LC_TabContent li {
1.911 bisitz 6062: vertical-align:middle;
6063: padding: 0 10px 0 10px;
6064: background-color:$tabbg;
6065: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6066: }
1.795 www 6067:
1.847 tempelho 6068: ul.LC_TabContent .right {
1.911 bisitz 6069: float:right;
1.847 tempelho 6070: }
6071:
1.911 bisitz 6072: ul.LC_TabContent li a,
6073: ul.LC_TabContent li {
6074: color:rgb(47,47,47);
6075: text-decoration:none;
6076: font-size:95%;
6077: font-weight:bold;
6078: padding-right: 16px;
1.721 harmsja 6079: }
1.795 www 6080:
1.911 bisitz 6081: ul.LC_TabContent li:hover,
6082: ul.LC_TabContent li.active {
6083: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6084: border-bottom:solid 2px #FFFFFF;
6085: padding-right: 16px;
1.744 ehlerst 6086: }
1.795 www 6087:
1.870 tempelho 6088: #maincoursedoc {
1.911 bisitz 6089: clear:both;
1.870 tempelho 6090: }
6091:
6092: ul.LC_TabContentBigger {
1.911 bisitz 6093: display:block;
6094: list-style:none;
6095: padding: 0;
1.870 tempelho 6096: }
6097:
1.795 www 6098: ul.LC_TabContentBigger li {
1.911 bisitz 6099: vertical-align:bottom;
6100: height: 30px;
6101: font-size:110%;
6102: font-weight:bold;
6103: color: #737373;
1.841 tempelho 6104: }
6105:
1.870 tempelho 6106:
6107: ul.LC_TabContentBigger li a {
1.911 bisitz 6108: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6109: height: 30px;
6110: line-height: 30px;
6111: text-align: center;
6112: display: block;
6113: text-decoration: none;
1.741 harmsja 6114: }
1.795 www 6115:
1.911 bisitz 6116: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6117: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6118: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6119: color:$font;
6120: text-decoration: underline;
1.744 ehlerst 6121: }
1.795 www 6122:
1.870 tempelho 6123:
6124: ul.LC_TabContentBigger li b {
1.911 bisitz 6125: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6126: display: block;
6127: float: left;
6128: padding: 0 30px;
1.870 tempelho 6129: }
6130:
6131: ul.LC_TabContentBigger li:hover b,
6132: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6133: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6134: color:$font;
6135: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6136: }
1.693 droeschl 6137:
1.870 tempelho 6138:
1.862 bisitz 6139: ul.LC_CourseBreadcrumbs {
6140: background: $sidebg;
6141: line-height: 32px;
6142: padding-left: 10px;
6143: margin: 0 0 10px 0;
6144: list-style-position: inside;
6145:
6146: }
6147:
1.911 bisitz 6148: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6149: ol#LC_PathBreadcrumbs {
1.911 bisitz 6150: padding-left: 10px;
6151: margin: 0;
1.933 droeschl 6152: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6153: }
6154:
1.911 bisitz 6155: ol#LC_MenuBreadcrumbs li,
6156: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6157: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6158: display: inline;
1.933 droeschl 6159: white-space: normal;
1.693 droeschl 6160: }
6161:
1.823 bisitz 6162: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6163: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6164: text-decoration: none;
6165: font-size:90%;
1.693 droeschl 6166: }
1.795 www 6167:
6168: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6169: text-decoration:none;
6170: font-size:100%;
6171: font-weight:bold;
1.693 droeschl 6172: }
1.795 www 6173:
1.840 bisitz 6174: .LC_Box {
1.911 bisitz 6175: border: solid 1px $lg_border_color;
6176: padding: 0 10px 10px 10px;
1.746 neumanie 6177: }
1.795 www 6178:
6179: .LC_AboutMe_Image {
1.911 bisitz 6180: float:left;
6181: margin-right:10px;
1.747 neumanie 6182: }
1.795 www 6183:
6184: .LC_Clear_AboutMe_Image {
1.911 bisitz 6185: clear:left;
1.747 neumanie 6186: }
1.795 www 6187:
1.721 harmsja 6188: dl.LC_ListStyleClean dt {
1.911 bisitz 6189: padding-right: 5px;
6190: display: table-header-group;
1.693 droeschl 6191: }
6192:
1.721 harmsja 6193: dl.LC_ListStyleClean dd {
1.911 bisitz 6194: display: table-row;
1.693 droeschl 6195: }
6196:
1.721 harmsja 6197: .LC_ListStyleClean,
6198: .LC_ListStyleSimple,
6199: .LC_ListStyleNormal,
1.795 www 6200: .LC_ListStyleSpecial {
1.911 bisitz 6201: /* display:block; */
6202: list-style-position: inside;
6203: list-style-type: none;
6204: overflow: hidden;
6205: padding: 0;
1.693 droeschl 6206: }
6207:
1.721 harmsja 6208: .LC_ListStyleSimple li,
6209: .LC_ListStyleSimple dd,
6210: .LC_ListStyleNormal li,
6211: .LC_ListStyleNormal dd,
6212: .LC_ListStyleSpecial li,
1.795 www 6213: .LC_ListStyleSpecial dd {
1.911 bisitz 6214: margin: 0;
6215: padding: 5px 5px 5px 10px;
6216: clear: both;
1.693 droeschl 6217: }
6218:
1.721 harmsja 6219: .LC_ListStyleClean li,
6220: .LC_ListStyleClean dd {
1.911 bisitz 6221: padding-top: 0;
6222: padding-bottom: 0;
1.693 droeschl 6223: }
6224:
1.721 harmsja 6225: .LC_ListStyleSimple dd,
1.795 www 6226: .LC_ListStyleSimple li {
1.911 bisitz 6227: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6228: }
6229:
1.721 harmsja 6230: .LC_ListStyleSpecial li,
6231: .LC_ListStyleSpecial dd {
1.911 bisitz 6232: list-style-type: none;
6233: background-color: RGB(220, 220, 220);
6234: margin-bottom: 4px;
1.693 droeschl 6235: }
6236:
1.721 harmsja 6237: table.LC_SimpleTable {
1.911 bisitz 6238: margin:5px;
6239: border:solid 1px $lg_border_color;
1.795 www 6240: }
1.693 droeschl 6241:
1.721 harmsja 6242: table.LC_SimpleTable tr {
1.911 bisitz 6243: padding: 0;
6244: border:solid 1px $lg_border_color;
1.693 droeschl 6245: }
1.795 www 6246:
6247: table.LC_SimpleTable thead {
1.911 bisitz 6248: background:rgb(220,220,220);
1.693 droeschl 6249: }
6250:
1.721 harmsja 6251: div.LC_columnSection {
1.911 bisitz 6252: display: block;
6253: clear: both;
6254: overflow: hidden;
6255: margin: 0;
1.693 droeschl 6256: }
6257:
1.721 harmsja 6258: div.LC_columnSection>* {
1.911 bisitz 6259: float: left;
6260: margin: 10px 20px 10px 0;
6261: overflow:hidden;
1.693 droeschl 6262: }
1.721 harmsja 6263:
1.694 tempelho 6264: .LC_loginpage_container {
1.911 bisitz 6265: text-align:left;
6266: margin : 0 auto;
6267: width:90%;
6268: padding: 10px;
6269: height: auto;
6270: background-color:#FFFFFF;
6271: border:1px solid #CCCCCC;
1.694 tempelho 6272: }
6273:
6274:
6275: .LC_loginpage_loginContainer {
1.911 bisitz 6276: float:left;
6277: width: 182px;
6278: padding: 2px;
6279: border:1px solid #CCCCCC;
6280: background-color:$loginbg;
1.694 tempelho 6281: }
6282:
1.795 www 6283: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6284: margin-top: 0;
6285: display:block;
6286: background:$bgcol;
6287: color:$textcol;
6288: padding-left:5px;
1.712 muellerd 6289: }
1.785 tempelho 6290:
1.694 tempelho 6291: .LC_loginpage_loginInfo {
1.911 bisitz 6292: float:left;
6293: width:182px;
6294: border:1px solid #CCCCCC;
6295: padding:2px;
1.712 muellerd 6296: }
6297:
1.694 tempelho 6298: .LC_loginpage_space {
1.911 bisitz 6299: clear: both;
6300: margin-bottom: 20px;
6301: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6302: }
6303:
1.785 tempelho 6304: .LC_loginpage_floatLeft {
1.911 bisitz 6305: float: left;
6306: width: 200px;
6307: margin: 0;
1.785 tempelho 6308: }
6309:
1.795 www 6310: table em {
1.911 bisitz 6311: font-weight: bold;
6312: font-style: normal;
1.748 schulted 6313: }
1.795 www 6314:
1.779 bisitz 6315: table.LC_tableBrowseRes,
1.795 www 6316: table.LC_tableOfContent {
1.911 bisitz 6317: border:none;
6318: border-spacing: 1px;
6319: padding: 3px;
6320: background-color: #FFFFFF;
6321: font-size: 90%;
1.753 droeschl 6322: }
1.789 droeschl 6323:
1.911 bisitz 6324: table.LC_tableOfContent {
6325: border-collapse: collapse;
1.789 droeschl 6326: }
6327:
1.771 droeschl 6328: table.LC_tableBrowseRes a,
1.768 schulted 6329: table.LC_tableOfContent a {
1.911 bisitz 6330: background-color: transparent;
6331: text-decoration: none;
1.753 droeschl 6332: }
6333:
1.795 www 6334: table.LC_tableOfContent img {
1.911 bisitz 6335: border: none;
6336: height: 1.3em;
6337: vertical-align: text-bottom;
6338: margin-right: 0.3em;
1.753 droeschl 6339: }
1.757 schulted 6340:
1.795 www 6341: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6342: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6343: }
6344:
1.795 www 6345: a#LC_content_toolbar_launchnav {
1.911 bisitz 6346: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6347: }
6348:
1.795 www 6349: a#LC_content_toolbar_closenav {
1.911 bisitz 6350: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6351: }
6352:
1.795 www 6353: a#LC_content_toolbar_everything {
1.911 bisitz 6354: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6355: }
6356:
1.795 www 6357: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6358: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6359: }
6360:
1.795 www 6361: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6362: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6363: }
6364:
1.795 www 6365: a#LC_content_toolbar_changefolder {
1.911 bisitz 6366: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6367: }
6368:
1.795 www 6369: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6370: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6371: }
6372:
1.795 www 6373: ul#LC_toolbar li a:hover {
1.911 bisitz 6374: background-position: bottom center;
1.757 schulted 6375: }
6376:
1.795 www 6377: ul#LC_toolbar {
1.911 bisitz 6378: padding: 0;
6379: margin: 2px;
6380: list-style:none;
6381: position:relative;
6382: background-color:white;
1.757 schulted 6383: }
6384:
1.795 www 6385: ul#LC_toolbar li {
1.911 bisitz 6386: border:1px solid white;
6387: padding: 0;
6388: margin: 0;
6389: float: left;
6390: display:inline;
6391: vertical-align:middle;
6392: }
1.757 schulted 6393:
1.783 amueller 6394:
1.795 www 6395: a.LC_toolbarItem {
1.911 bisitz 6396: display:block;
6397: padding: 0;
6398: margin: 0;
6399: height: 32px;
6400: width: 32px;
6401: color:white;
6402: border: none;
6403: background-repeat:no-repeat;
6404: background-color:transparent;
1.757 schulted 6405: }
6406:
1.915 droeschl 6407: ul.LC_funclist {
6408: margin: 0;
6409: padding: 0.5em 1em 0.5em 0;
6410: }
6411:
1.933 droeschl 6412: ul.LC_funclist > li:first-child {
6413: font-weight:bold;
6414: margin-left:0.8em;
6415: }
6416:
1.915 droeschl 6417: ul.LC_funclist + ul.LC_funclist {
6418: /*
6419: left border as a seperator if we have more than
6420: one list
6421: */
6422: border-left: 1px solid $sidebg;
6423: /*
6424: this hides the left border behind the border of the
6425: outer box if element is wrapped to the next 'line'
6426: */
6427: margin-left: -1px;
6428: }
6429:
1.843 bisitz 6430: ul.LC_funclist li {
1.915 droeschl 6431: display: inline;
1.782 bisitz 6432: white-space: nowrap;
1.915 droeschl 6433: margin: 0 0 0 25px;
6434: line-height: 150%;
1.782 bisitz 6435: }
6436:
1.930 faziophi 6437: .ui-accordion .LC_advanced_toggle {
6438: float: right;
6439: font-size: 90%;
6440: padding: 0px 4px
6441: }
1.757 schulted 6442:
1.343 albertel 6443: END
6444: }
6445:
1.306 albertel 6446: =pod
6447:
6448: =item * &headtag()
6449:
6450: Returns a uniform footer for LON-CAPA web pages.
6451:
1.307 albertel 6452: Inputs: $title - optional title for the head
6453: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6454: $args - optional arguments
1.319 albertel 6455: force_register - if is true call registerurl so the remote is
6456: informed
1.415 albertel 6457: redirect -> array ref of
6458: 1- seconds before redirect occurs
6459: 2- url to redirect to
6460: 3- whether the side effect should occur
1.315 albertel 6461: (side effect of setting
6462: $env{'internal.head.redirect'} to the url
6463: redirected too)
1.352 albertel 6464: domain -> force to color decorate a page for a specific
6465: domain
6466: function -> force usage of a specific rolish color scheme
6467: bgcolor -> override the default page bgcolor
1.460 albertel 6468: no_auto_mt_title
6469: -> prevent &mt()ing the title arg
1.464 albertel 6470:
1.306 albertel 6471: =cut
6472:
6473: sub headtag {
1.313 albertel 6474: my ($title,$head_extra,$args) = @_;
1.306 albertel 6475:
1.363 albertel 6476: my $function = $args->{'function'} || &get_users_function();
6477: my $domain = $args->{'domain'} || &determinedomain();
6478: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6479: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6480: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6481: #time(),
1.418 albertel 6482: $env{'environment.color.timestamp'},
1.363 albertel 6483: $function,$domain,$bgcolor);
6484:
1.369 www 6485: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6486:
1.308 albertel 6487: my $result =
6488: '<head>'.
1.461 albertel 6489: &font_settings();
1.319 albertel 6490:
1.461 albertel 6491: if (!$args->{'frameset'}) {
6492: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6493: }
1.319 albertel 6494: if ($args->{'force_register'}) {
6495: $result .= &Apache::lonmenu::registerurl(1);
6496: }
1.436 albertel 6497: if (!$args->{'no_nav_bar'}
6498: && !$args->{'only_body'}
6499: && !$args->{'frameset'}) {
6500: $result .= &help_menu_js();
6501: }
1.319 albertel 6502:
1.314 albertel 6503: if (ref($args->{'redirect'})) {
1.414 albertel 6504: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6505: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6506: if (!$inhibit_continue) {
6507: $env{'internal.head.redirect'} = $url;
6508: }
1.313 albertel 6509: $result.=<<ADDMETA
6510: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6511: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6512: ADDMETA
6513: }
1.306 albertel 6514: if (!defined($title)) {
6515: $title = 'The LearningOnline Network with CAPA';
6516: }
1.460 albertel 6517: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6518: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6519: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6520: .$head_extra;
1.306 albertel 6521: return $result;
6522: }
6523:
6524: =pod
6525:
1.340 albertel 6526: =item * &font_settings()
6527:
6528: Returns neccessary <meta> to set the proper encoding
6529:
6530: Inputs: none
6531:
6532: =cut
6533:
6534: sub font_settings {
6535: my $headerstring='';
1.647 www 6536: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6537: $headerstring.=
6538: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6539: }
6540: return $headerstring;
6541: }
6542:
1.341 albertel 6543: =pod
6544:
6545: =item * &xml_begin()
6546:
6547: Returns the needed doctype and <html>
6548:
6549: Inputs: none
6550:
6551: =cut
6552:
6553: sub xml_begin {
6554: my $output='';
6555:
1.592 albertel 6556: if ($env{'internal.start_page'}==1) {
6557: &Apache::lonhtmlcommon::init_htmlareafields();
6558: }
1.342 albertel 6559:
1.341 albertel 6560: if ($env{'browser.mathml'}) {
6561: $output='<?xml version="1.0"?>'
6562: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6563: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6564:
6565: # .'<!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">] >'
6566: .'<!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">'
6567: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6568: .'xmlns="http://www.w3.org/1999/xhtml">';
6569: } else {
1.849 bisitz 6570: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6571: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6572: }
6573: return $output;
6574: }
1.340 albertel 6575:
6576: =pod
6577:
1.306 albertel 6578: =item * &endheadtag()
6579:
6580: Returns a uniform </head> for LON-CAPA web pages.
6581:
6582: Inputs: none
6583:
6584: =cut
6585:
6586: sub endheadtag {
6587: return '</head>';
6588: }
6589:
6590: =pod
6591:
6592: =item * &head()
6593:
6594: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6595:
1.648 raeburn 6596: Inputs:
6597:
6598: =over 4
6599:
6600: $title - optional title for the page
6601:
6602: $head_extra - optional extra HTML to put inside the <head>
6603:
6604: =back
1.405 albertel 6605:
1.306 albertel 6606: =cut
6607:
6608: sub head {
1.325 albertel 6609: my ($title,$head_extra,$args) = @_;
6610: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6611: }
6612:
6613: =pod
6614:
6615: =item * &start_page()
6616:
6617: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6618:
1.648 raeburn 6619: Inputs:
6620:
6621: =over 4
6622:
6623: $title - optional title for the page
6624:
6625: $head_extra - optional extra HTML to incude inside the <head>
6626:
6627: $args - additional optional args supported are:
6628:
6629: =over 8
6630:
6631: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6632: arg on
1.814 bisitz 6633: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6634: add_entries -> additional attributes to add to the <body>
6635: domain -> force to color decorate a page for a
1.317 albertel 6636: specific domain
1.648 raeburn 6637: function -> force usage of a specific rolish color
1.317 albertel 6638: scheme
1.648 raeburn 6639: redirect -> see &headtag()
6640: bgcolor -> override the default page bg color
6641: js_ready -> return a string ready for being used in
1.317 albertel 6642: a javascript writeln
1.648 raeburn 6643: html_encode -> return a string ready for being used in
1.320 albertel 6644: a html attribute
1.648 raeburn 6645: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6646: $forcereg arg
1.648 raeburn 6647: frameset -> if true will start with a <frameset>
1.330 albertel 6648: rather than <body>
1.648 raeburn 6649: skip_phases -> hash ref of
1.338 albertel 6650: head -> skip the <html><head> generation
6651: body -> skip all <body> generation
1.648 raeburn 6652: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6653: 'Switch To Inline Menu' link
1.648 raeburn 6654: no_auto_mt_title -> prevent &mt()ing the title arg
6655: inherit_jsmath -> when creating popup window in a page,
6656: should it have jsmath forced on by the
6657: current page
1.867 kalberla 6658: bread_crumbs -> Array containing breadcrumbs
6659: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6660:
1.648 raeburn 6661: =back
1.460 albertel 6662:
1.648 raeburn 6663: =back
1.562 albertel 6664:
1.306 albertel 6665: =cut
6666:
6667: sub start_page {
1.309 albertel 6668: my ($title,$head_extra,$args) = @_;
1.318 albertel 6669: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6670: my %head_args;
1.352 albertel 6671: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6672: 'bgcolor','frameset','no_nav_bar','only_body',
6673: 'no_auto_mt_title') {
1.319 albertel 6674: if (defined($args->{$arg})) {
1.324 raeburn 6675: $head_args{$arg} = $args->{$arg};
1.319 albertel 6676: }
1.313 albertel 6677: }
1.319 albertel 6678:
1.315 albertel 6679: $env{'internal.start_page'}++;
1.338 albertel 6680: my $result;
6681: if (! exists($args->{'skip_phases'}{'head'}) ) {
6682: $result.=
1.341 albertel 6683: &xml_begin().
1.338 albertel 6684: &headtag($title,$head_extra,\%head_args).&endheadtag();
6685: }
6686:
6687: if (! exists($args->{'skip_phases'}{'body'}) ) {
6688: if ($args->{'frameset'}) {
6689: my $attr_string = &make_attr_string($args->{'force_register'},
6690: $args->{'add_entries'});
6691: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6692: } else {
6693: $result .=
6694: &bodytag($title,
6695: $args->{'function'}, $args->{'add_entries'},
6696: $args->{'only_body'}, $args->{'domain'},
6697: $args->{'force_register'}, $args->{'no_nav_bar'},
6698: $args->{'bgcolor'}, $args->{'no_inline_link'},
6699: $args);
6700: }
1.330 albertel 6701: }
1.338 albertel 6702:
1.315 albertel 6703: if ($args->{'js_ready'}) {
1.713 kaisler 6704: $result = &js_ready($result);
1.315 albertel 6705: }
1.320 albertel 6706: if ($args->{'html_encode'}) {
1.713 kaisler 6707: $result = &html_encode($result);
6708: }
6709:
1.813 bisitz 6710: # Preparation for new and consistent functionlist at top of screen
6711: # if ($args->{'functionlist'}) {
6712: # $result .= &build_functionlist();
6713: #}
6714:
6715: # Don't add anything more if only_body wanted
6716: return $result if $args->{'only_body'};
6717:
1.920 raeburn 6718: #Breadcrumbs for Construction Space provided by &bodytag.
6719: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6720: return $result;
6721: }
6722:
1.813 bisitz 6723: #Breadcrumbs
1.758 kaisler 6724: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6725: &Apache::lonhtmlcommon::clear_breadcrumbs();
6726: #if any br links exists, add them to the breadcrumbs
6727: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6728: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6729: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6730: }
6731: }
6732:
6733: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6734: if(exists($args->{'bread_crumbs_component'})){
6735: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6736: }else{
6737: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6738: }
1.320 albertel 6739: }
1.315 albertel 6740: return $result;
1.306 albertel 6741: }
6742:
1.330 albertel 6743:
1.306 albertel 6744: =pod
6745:
6746: =item * &head()
6747:
6748: Returns a complete </body></html> section for LON-CAPA web pages.
6749:
1.315 albertel 6750: Inputs: $args - additional optional args supported are:
6751: js_ready -> return a string ready for being used in
6752: a javascript writeln
1.320 albertel 6753: html_encode -> return a string ready for being used in
6754: a html attribute
1.330 albertel 6755: frameset -> if true will start with a <frameset>
6756: rather than <body>
1.493 albertel 6757: dicsussion -> if true will get discussion from
6758: lonxml::xmlend
6759: (you can pass the target and parser arguments
6760: through optional 'target' and 'parser' args
6761: to this routine)
1.306 albertel 6762:
6763: =cut
6764:
6765: sub end_page {
1.315 albertel 6766: my ($args) = @_;
6767: $env{'internal.end_page'}++;
1.330 albertel 6768: my $result;
1.335 albertel 6769: if ($args->{'discussion'}) {
6770: my ($target,$parser);
6771: if (ref($args->{'discussion'})) {
6772: ($target,$parser) =($args->{'discussion'}{'target'},
6773: $args->{'discussion'}{'parser'});
6774: }
6775: $result .= &Apache::lonxml::xmlend($target,$parser);
6776: }
6777:
1.330 albertel 6778: if ($args->{'frameset'}) {
6779: $result .= '</frameset>';
6780: } else {
1.635 raeburn 6781: $result .= &endbodytag($args);
1.330 albertel 6782: }
6783: $result .= "\n</html>";
6784:
1.315 albertel 6785: if ($args->{'js_ready'}) {
1.317 albertel 6786: $result = &js_ready($result);
1.315 albertel 6787: }
1.335 albertel 6788:
1.320 albertel 6789: if ($args->{'html_encode'}) {
6790: $result = &html_encode($result);
6791: }
1.335 albertel 6792:
1.315 albertel 6793: return $result;
6794: }
6795:
1.320 albertel 6796: sub html_encode {
6797: my ($result) = @_;
6798:
1.322 albertel 6799: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6800:
6801: return $result;
6802: }
1.317 albertel 6803: sub js_ready {
6804: my ($result) = @_;
6805:
1.323 albertel 6806: $result =~ s/[\n\r]/ /xmsg;
6807: $result =~ s/\\/\\\\/xmsg;
6808: $result =~ s/'/\\'/xmsg;
1.372 albertel 6809: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6810:
6811: return $result;
6812: }
6813:
1.315 albertel 6814: sub validate_page {
6815: if ( exists($env{'internal.start_page'})
1.316 albertel 6816: && $env{'internal.start_page'} > 1) {
6817: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6818: $env{'internal.start_page'}.' '.
1.316 albertel 6819: $ENV{'request.filename'});
1.315 albertel 6820: }
6821: if ( exists($env{'internal.end_page'})
1.316 albertel 6822: && $env{'internal.end_page'} > 1) {
6823: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6824: $env{'internal.end_page'}.' '.
1.316 albertel 6825: $env{'request.filename'});
1.315 albertel 6826: }
6827: if ( exists($env{'internal.start_page'})
6828: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6829: &Apache::lonnet::logthis('start_page called without end_page '.
6830: $env{'request.filename'});
1.315 albertel 6831: }
6832: if ( ! exists($env{'internal.start_page'})
6833: && exists($env{'internal.end_page'})) {
1.316 albertel 6834: &Apache::lonnet::logthis('end_page called without start_page'.
6835: $env{'request.filename'});
1.315 albertel 6836: }
1.306 albertel 6837: }
1.315 albertel 6838:
1.318 albertel 6839: sub simple_error_page {
6840: my ($r,$title,$msg) = @_;
6841: my $page =
6842: &Apache::loncommon::start_page($title).
6843: &mt($msg).
6844: &Apache::loncommon::end_page();
6845: if (ref($r)) {
6846: $r->print($page);
1.327 albertel 6847: return;
1.318 albertel 6848: }
6849: return $page;
6850: }
1.347 albertel 6851:
6852: {
1.610 albertel 6853: my @row_count;
1.347 albertel 6854: sub start_data_table {
1.422 albertel 6855: my ($add_class) = @_;
6856: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6857: unshift(@row_count,0);
1.422 albertel 6858: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6859: }
6860:
6861: sub end_data_table {
1.610 albertel 6862: shift(@row_count);
1.389 albertel 6863: return '</table>'."\n";;
1.347 albertel 6864: }
6865:
6866: sub start_data_table_row {
1.422 albertel 6867: my ($add_class) = @_;
1.610 albertel 6868: $row_count[0]++;
6869: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6870: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6871: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6872: }
1.471 banghart 6873:
6874: sub continue_data_table_row {
6875: my ($add_class) = @_;
1.610 albertel 6876: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6877: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6878: return '<tr class="'.$css_class.'">'."\n";;
6879: }
1.347 albertel 6880:
6881: sub end_data_table_row {
1.389 albertel 6882: return '</tr>'."\n";;
1.347 albertel 6883: }
1.367 www 6884:
1.421 albertel 6885: sub start_data_table_empty_row {
1.707 bisitz 6886: # $row_count[0]++;
1.421 albertel 6887: return '<tr class="LC_empty_row" >'."\n";;
6888: }
6889:
6890: sub end_data_table_empty_row {
6891: return '</tr>'."\n";;
6892: }
6893:
1.367 www 6894: sub start_data_table_header_row {
1.389 albertel 6895: return '<tr class="LC_header_row">'."\n";;
1.367 www 6896: }
6897:
6898: sub end_data_table_header_row {
1.389 albertel 6899: return '</tr>'."\n";;
1.367 www 6900: }
1.890 droeschl 6901:
6902: sub data_table_caption {
6903: my $caption = shift;
6904: return "<caption class=\"LC_caption\">$caption</caption>";
6905: }
1.347 albertel 6906: }
6907:
1.548 albertel 6908: =pod
6909:
6910: =item * &inhibit_menu_check($arg)
6911:
6912: Checks for a inhibitmenu state and generates output to preserve it
6913:
6914: Inputs: $arg - can be any of
6915: - undef - in which case the return value is a string
6916: to add into arguments list of a uri
6917: - 'input' - in which case the return value is a HTML
6918: <form> <input> field of type hidden to
6919: preserve the value
6920: - a url - in which case the return value is the url with
6921: the neccesary cgi args added to preserve the
6922: inhibitmenu state
6923: - a ref to a url - no return value, but the string is
6924: updated to include the neccessary cgi
6925: args to preserve the inhibitmenu state
6926:
6927: =cut
6928:
6929: sub inhibit_menu_check {
6930: my ($arg) = @_;
6931: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6932: if ($arg eq 'input') {
6933: if ($env{'form.inhibitmenu'}) {
6934: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6935: } else {
6936: return
6937: }
6938: }
6939: if ($env{'form.inhibitmenu'}) {
6940: if (ref($arg)) {
6941: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6942: } elsif ($arg eq '') {
6943: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6944: } else {
6945: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6946: }
6947: }
6948: if (!ref($arg)) {
6949: return $arg;
6950: }
6951: }
6952:
1.251 albertel 6953: ###############################################
1.182 matthew 6954:
6955: =pod
6956:
1.549 albertel 6957: =back
6958:
6959: =head1 User Information Routines
6960:
6961: =over 4
6962:
1.405 albertel 6963: =item * &get_users_function()
1.182 matthew 6964:
6965: Used by &bodytag to determine the current users primary role.
6966: Returns either 'student','coordinator','admin', or 'author'.
6967:
6968: =cut
6969:
6970: ###############################################
6971: sub get_users_function {
1.815 tempelho 6972: my $function = 'norole';
1.818 tempelho 6973: if ($env{'request.role'}=~/^(st)/) {
6974: $function='student';
6975: }
1.907 raeburn 6976: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6977: $function='coordinator';
6978: }
1.258 albertel 6979: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6980: $function='admin';
6981: }
1.826 bisitz 6982: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6983: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6984: $function='author';
6985: }
6986: return $function;
1.54 www 6987: }
1.99 www 6988:
6989: ###############################################
6990:
1.233 raeburn 6991: =pod
6992:
1.821 raeburn 6993: =item * &show_course()
6994:
6995: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6996: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6997:
6998: Inputs:
6999: None
7000:
7001: Outputs:
7002: Scalar: 1 if 'Course' to be used, 0 otherwise.
7003:
7004: =cut
7005:
7006: ###############################################
7007: sub show_course {
7008: my $course = !$env{'user.adv'};
7009: if (!$env{'user.adv'}) {
7010: foreach my $env (keys(%env)) {
7011: next if ($env !~ m/^user\.priv\./);
7012: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7013: $course = 0;
7014: last;
7015: }
7016: }
7017: }
7018: return $course;
7019: }
7020:
7021: ###############################################
7022:
7023: =pod
7024:
1.542 raeburn 7025: =item * &check_user_status()
1.274 raeburn 7026:
7027: Determines current status of supplied role for a
7028: specific user. Roles can be active, previous or future.
7029:
7030: Inputs:
7031: user's domain, user's username, course's domain,
1.375 raeburn 7032: course's number, optional section ID.
1.274 raeburn 7033:
7034: Outputs:
7035: role status: active, previous or future.
7036:
7037: =cut
7038:
7039: sub check_user_status {
1.412 raeburn 7040: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7041: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7042: my @uroles = keys %userinfo;
7043: my $srchstr;
7044: my $active_chk = 'none';
1.412 raeburn 7045: my $now = time;
1.274 raeburn 7046: if (@uroles > 0) {
1.908 raeburn 7047: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7048: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7049: } else {
1.412 raeburn 7050: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7051: }
7052: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7053: my $role_end = 0;
7054: my $role_start = 0;
7055: $active_chk = 'active';
1.412 raeburn 7056: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7057: $role_end = $1;
7058: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7059: $role_start = $1;
1.274 raeburn 7060: }
7061: }
7062: if ($role_start > 0) {
1.412 raeburn 7063: if ($now < $role_start) {
1.274 raeburn 7064: $active_chk = 'future';
7065: }
7066: }
7067: if ($role_end > 0) {
1.412 raeburn 7068: if ($now > $role_end) {
1.274 raeburn 7069: $active_chk = 'previous';
7070: }
7071: }
7072: }
7073: }
7074: return $active_chk;
7075: }
7076:
7077: ###############################################
7078:
7079: =pod
7080:
1.405 albertel 7081: =item * &get_sections()
1.233 raeburn 7082:
7083: Determines all the sections for a course including
7084: sections with students and sections containing other roles.
1.419 raeburn 7085: Incoming parameters:
7086:
7087: 1. domain
7088: 2. course number
7089: 3. reference to array containing roles for which sections should
7090: be gathered (optional).
7091: 4. reference to array containing status types for which sections
7092: should be gathered (optional).
7093:
7094: If the third argument is undefined, sections are gathered for any role.
7095: If the fourth argument is undefined, sections are gathered for any status.
7096: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7097:
1.374 raeburn 7098: Returns section hash (keys are section IDs, values are
7099: number of users in each section), subject to the
1.419 raeburn 7100: optional roles filter, optional status filter
1.233 raeburn 7101:
7102: =cut
7103:
7104: ###############################################
7105: sub get_sections {
1.419 raeburn 7106: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7107: if (!defined($cdom) || !defined($cnum)) {
7108: my $cid = $env{'request.course.id'};
7109:
7110: return if (!defined($cid));
7111:
7112: $cdom = $env{'course.'.$cid.'.domain'};
7113: $cnum = $env{'course.'.$cid.'.num'};
7114: }
7115:
7116: my %sectioncount;
1.419 raeburn 7117: my $now = time;
1.240 albertel 7118:
1.366 albertel 7119: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7120: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7121: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7122: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7123: my $start_index = &Apache::loncoursedata::CL_START();
7124: my $end_index = &Apache::loncoursedata::CL_END();
7125: my $status;
1.366 albertel 7126: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7127: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7128: $data->[$status_index],
7129: $data->[$start_index],
7130: $data->[$end_index]);
7131: if ($stu_status eq 'Active') {
7132: $status = 'active';
7133: } elsif ($end < $now) {
7134: $status = 'previous';
7135: } elsif ($start > $now) {
7136: $status = 'future';
7137: }
7138: if ($section ne '-1' && $section !~ /^\s*$/) {
7139: if ((!defined($possible_status)) || (($status ne '') &&
7140: (grep/^\Q$status\E$/,@{$possible_status}))) {
7141: $sectioncount{$section}++;
7142: }
1.240 albertel 7143: }
7144: }
7145: }
7146: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7147: foreach my $user (sort(keys(%courseroles))) {
7148: if ($user !~ /^(\w{2})/) { next; }
7149: my ($role) = ($user =~ /^(\w{2})/);
7150: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7151: my ($section,$status);
1.240 albertel 7152: if ($role eq 'cr' &&
7153: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7154: $section=$1;
7155: }
7156: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7157: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7158: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7159: if ($end == -1 && $start == -1) {
7160: next; #deleted role
7161: }
7162: if (!defined($possible_status)) {
7163: $sectioncount{$section}++;
7164: } else {
7165: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7166: $status = 'active';
7167: } elsif ($end < $now) {
7168: $status = 'future';
7169: } elsif ($start > $now) {
7170: $status = 'previous';
7171: }
7172: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7173: $sectioncount{$section}++;
7174: }
7175: }
1.233 raeburn 7176: }
1.366 albertel 7177: return %sectioncount;
1.233 raeburn 7178: }
7179:
1.274 raeburn 7180: ###############################################
1.294 raeburn 7181:
7182: =pod
1.405 albertel 7183:
7184: =item * &get_course_users()
7185:
1.275 raeburn 7186: Retrieves usernames:domains for users in the specified course
7187: with specific role(s), and access status.
7188:
7189: Incoming parameters:
1.277 albertel 7190: 1. course domain
7191: 2. course number
7192: 3. access status: users must have - either active,
1.275 raeburn 7193: previous, future, or all.
1.277 albertel 7194: 4. reference to array of permissible roles
1.288 raeburn 7195: 5. reference to array of section restrictions (optional)
7196: 6. reference to results object (hash of hashes).
7197: 7. reference to optional userdata hash
1.609 raeburn 7198: 8. reference to optional statushash
1.630 raeburn 7199: 9. flag if privileged users (except those set to unhide in
7200: course settings) should be excluded
1.609 raeburn 7201: Keys of top level results hash are roles.
1.275 raeburn 7202: Keys of inner hashes are username:domain, with
7203: values set to access type.
1.288 raeburn 7204: Optional userdata hash returns an array with arguments in the
7205: same order as loncoursedata::get_classlist() for student data.
7206:
1.609 raeburn 7207: Optional statushash returns
7208:
1.288 raeburn 7209: Entries for end, start, section and status are blank because
7210: of the possibility of multiple values for non-student roles.
7211:
1.275 raeburn 7212: =cut
1.405 albertel 7213:
1.275 raeburn 7214: ###############################################
1.405 albertel 7215:
1.275 raeburn 7216: sub get_course_users {
1.630 raeburn 7217: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7218: my %idx = ();
1.419 raeburn 7219: my %seclists;
1.288 raeburn 7220:
7221: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7222: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7223: $idx{end} = &Apache::loncoursedata::CL_END();
7224: $idx{start} = &Apache::loncoursedata::CL_START();
7225: $idx{id} = &Apache::loncoursedata::CL_ID();
7226: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7227: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7228: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7229:
1.290 albertel 7230: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7231: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7232: my $now = time;
1.277 albertel 7233: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7234: my $match = 0;
1.412 raeburn 7235: my $secmatch = 0;
1.419 raeburn 7236: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7237: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7238: if ($section eq '') {
7239: $section = 'none';
7240: }
1.291 albertel 7241: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7242: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7243: $secmatch = 1;
7244: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7245: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7246: $secmatch = 1;
7247: }
7248: } else {
1.419 raeburn 7249: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7250: $secmatch = 1;
7251: }
1.290 albertel 7252: }
1.412 raeburn 7253: if (!$secmatch) {
7254: next;
7255: }
1.419 raeburn 7256: }
1.275 raeburn 7257: if (defined($$types{'active'})) {
1.288 raeburn 7258: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7259: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7260: $match = 1;
1.275 raeburn 7261: }
7262: }
7263: if (defined($$types{'previous'})) {
1.609 raeburn 7264: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7265: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7266: $match = 1;
1.275 raeburn 7267: }
7268: }
7269: if (defined($$types{'future'})) {
1.609 raeburn 7270: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7271: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7272: $match = 1;
1.275 raeburn 7273: }
7274: }
1.609 raeburn 7275: if ($match) {
7276: push(@{$seclists{$student}},$section);
7277: if (ref($userdata) eq 'HASH') {
7278: $$userdata{$student} = $$classlist{$student};
7279: }
7280: if (ref($statushash) eq 'HASH') {
7281: $statushash->{$student}{'st'}{$section} = $status;
7282: }
1.288 raeburn 7283: }
1.275 raeburn 7284: }
7285: }
1.412 raeburn 7286: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7287: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7288: my $now = time;
1.609 raeburn 7289: my %displaystatus = ( previous => 'Expired',
7290: active => 'Active',
7291: future => 'Future',
7292: );
1.630 raeburn 7293: my %nothide;
7294: if ($hidepriv) {
7295: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7296: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7297: if ($user !~ /:/) {
7298: $nothide{join(':',split(/[\@]/,$user))}=1;
7299: } else {
7300: $nothide{$user} = 1;
7301: }
7302: }
7303: }
1.439 raeburn 7304: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7305: my $match = 0;
1.412 raeburn 7306: my $secmatch = 0;
1.439 raeburn 7307: my $status;
1.412 raeburn 7308: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7309: $user =~ s/:$//;
1.439 raeburn 7310: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7311: if ($end == -1 || $start == -1) {
7312: next;
7313: }
7314: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7315: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7316: my ($uname,$udom) = split(/:/,$user);
7317: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7318: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7319: $secmatch = 1;
7320: } elsif ($usec eq '') {
1.420 albertel 7321: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7322: $secmatch = 1;
7323: }
7324: } else {
7325: if (grep(/^\Q$usec\E$/,@{$sections})) {
7326: $secmatch = 1;
7327: }
7328: }
7329: if (!$secmatch) {
7330: next;
7331: }
1.288 raeburn 7332: }
1.419 raeburn 7333: if ($usec eq '') {
7334: $usec = 'none';
7335: }
1.275 raeburn 7336: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7337: if ($hidepriv) {
7338: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7339: (!$nothide{$uname.':'.$udom})) {
7340: next;
7341: }
7342: }
1.503 raeburn 7343: if ($end > 0 && $end < $now) {
1.439 raeburn 7344: $status = 'previous';
7345: } elsif ($start > $now) {
7346: $status = 'future';
7347: } else {
7348: $status = 'active';
7349: }
1.277 albertel 7350: foreach my $type (keys(%{$types})) {
1.275 raeburn 7351: if ($status eq $type) {
1.420 albertel 7352: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7353: push(@{$$users{$role}{$user}},$type);
7354: }
1.288 raeburn 7355: $match = 1;
7356: }
7357: }
1.419 raeburn 7358: if (($match) && (ref($userdata) eq 'HASH')) {
7359: if (!exists($$userdata{$uname.':'.$udom})) {
7360: &get_user_info($udom,$uname,\%idx,$userdata);
7361: }
1.420 albertel 7362: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7363: push(@{$seclists{$uname.':'.$udom}},$usec);
7364: }
1.609 raeburn 7365: if (ref($statushash) eq 'HASH') {
7366: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7367: }
1.275 raeburn 7368: }
7369: }
7370: }
7371: }
1.290 albertel 7372: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7373: if ((defined($cdom)) && (defined($cnum))) {
7374: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7375: if ( defined($csettings{'internal.courseowner'}) ) {
7376: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7377: next if ($owner eq '');
7378: my ($ownername,$ownerdom);
7379: if ($owner =~ /^([^:]+):([^:]+)$/) {
7380: $ownername = $1;
7381: $ownerdom = $2;
7382: } else {
7383: $ownername = $owner;
7384: $ownerdom = $cdom;
7385: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7386: }
7387: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7388: if (defined($userdata) &&
1.609 raeburn 7389: !exists($$userdata{$owner})) {
7390: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7391: if (!grep(/^none$/,@{$seclists{$owner}})) {
7392: push(@{$seclists{$owner}},'none');
7393: }
7394: if (ref($statushash) eq 'HASH') {
7395: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7396: }
1.290 albertel 7397: }
1.279 raeburn 7398: }
7399: }
7400: }
1.419 raeburn 7401: foreach my $user (keys(%seclists)) {
7402: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7403: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7404: }
1.275 raeburn 7405: }
7406: return;
7407: }
7408:
1.288 raeburn 7409: sub get_user_info {
7410: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7411: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7412: &plainname($uname,$udom,'lastname');
1.291 albertel 7413: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7414: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7415: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7416: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7417: return;
7418: }
1.275 raeburn 7419:
1.472 raeburn 7420: ###############################################
7421:
7422: =pod
7423:
7424: =item * &get_user_quota()
7425:
7426: Retrieves quota assigned for storage of portfolio files for a user
7427:
7428: Incoming parameters:
7429: 1. user's username
7430: 2. user's domain
7431:
7432: Returns:
1.536 raeburn 7433: 1. Disk quota (in Mb) assigned to student.
7434: 2. (Optional) Type of setting: custom or default
7435: (individually assigned or default for user's
7436: institutional status).
7437: 3. (Optional) - User's institutional status (e.g., faculty, staff
7438: or student - types as defined in localenroll::inst_usertypes
7439: for user's domain, which determines default quota for user.
7440: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7441:
7442: If a value has been stored in the user's environment,
1.536 raeburn 7443: it will return that, otherwise it returns the maximal default
7444: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7445:
7446: =cut
7447:
7448: ###############################################
7449:
7450:
7451: sub get_user_quota {
7452: my ($uname,$udom) = @_;
1.536 raeburn 7453: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7454: if (!defined($udom)) {
7455: $udom = $env{'user.domain'};
7456: }
7457: if (!defined($uname)) {
7458: $uname = $env{'user.name'};
7459: }
7460: if (($udom eq '' || $uname eq '') ||
7461: ($udom eq 'public') && ($uname eq 'public')) {
7462: $quota = 0;
1.536 raeburn 7463: $quotatype = 'default';
7464: $defquota = 0;
1.472 raeburn 7465: } else {
1.536 raeburn 7466: my $inststatus;
1.472 raeburn 7467: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7468: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7469: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7470: } else {
1.536 raeburn 7471: my %userenv =
7472: &Apache::lonnet::get('environment',['portfolioquota',
7473: 'inststatus'],$udom,$uname);
1.472 raeburn 7474: my ($tmp) = keys(%userenv);
7475: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7476: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7477: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7478: } else {
7479: undef(%userenv);
7480: }
7481: }
1.536 raeburn 7482: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7483: if ($quota eq '') {
1.536 raeburn 7484: $quota = $defquota;
7485: $quotatype = 'default';
7486: } else {
7487: $quotatype = 'custom';
1.472 raeburn 7488: }
7489: }
1.536 raeburn 7490: if (wantarray) {
7491: return ($quota,$quotatype,$settingstatus,$defquota);
7492: } else {
7493: return $quota;
7494: }
1.472 raeburn 7495: }
7496:
7497: ###############################################
7498:
7499: =pod
7500:
7501: =item * &default_quota()
7502:
1.536 raeburn 7503: Retrieves default quota assigned for storage of user portfolio files,
7504: given an (optional) user's institutional status.
1.472 raeburn 7505:
7506: Incoming parameters:
7507: 1. domain
1.536 raeburn 7508: 2. (Optional) institutional status(es). This is a : separated list of
7509: status types (e.g., faculty, staff, student etc.)
7510: which apply to the user for whom the default is being retrieved.
7511: If the institutional status string in undefined, the domain
7512: default quota will be returned.
1.472 raeburn 7513:
7514: Returns:
7515: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7516: 2. (Optional) institutional type which determined the value of the
7517: default quota.
1.472 raeburn 7518:
7519: If a value has been stored in the domain's configuration db,
7520: it will return that, otherwise it returns 20 (for backwards
7521: compatibility with domains which have not set up a configuration
7522: db file; the original statically defined portfolio quota was 20 Mb).
7523:
1.536 raeburn 7524: If the user's status includes multiple types (e.g., staff and student),
7525: the largest default quota which applies to the user determines the
7526: default quota returned.
7527:
1.780 raeburn 7528: =back
7529:
1.472 raeburn 7530: =cut
7531:
7532: ###############################################
7533:
7534:
7535: sub default_quota {
1.536 raeburn 7536: my ($udom,$inststatus) = @_;
7537: my ($defquota,$settingstatus);
7538: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7539: ['quotas'],$udom);
7540: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7541: if ($inststatus ne '') {
1.765 raeburn 7542: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7543: foreach my $item (@statuses) {
1.711 raeburn 7544: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7545: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7546: if ($defquota eq '') {
7547: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7548: $settingstatus = $item;
7549: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7550: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7551: $settingstatus = $item;
7552: }
7553: }
7554: } else {
7555: if ($quotahash{'quotas'}{$item} ne '') {
7556: if ($defquota eq '') {
7557: $defquota = $quotahash{'quotas'}{$item};
7558: $settingstatus = $item;
7559: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7560: $defquota = $quotahash{'quotas'}{$item};
7561: $settingstatus = $item;
7562: }
1.536 raeburn 7563: }
7564: }
7565: }
7566: }
7567: if ($defquota eq '') {
1.711 raeburn 7568: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7569: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7570: } else {
7571: $defquota = $quotahash{'quotas'}{'default'};
7572: }
1.536 raeburn 7573: $settingstatus = 'default';
7574: }
7575: } else {
7576: $settingstatus = 'default';
7577: $defquota = 20;
7578: }
7579: if (wantarray) {
7580: return ($defquota,$settingstatus);
1.472 raeburn 7581: } else {
1.536 raeburn 7582: return $defquota;
1.472 raeburn 7583: }
7584: }
7585:
1.384 raeburn 7586: sub get_secgrprole_info {
7587: my ($cdom,$cnum,$needroles,$type) = @_;
7588: my %sections_count = &get_sections($cdom,$cnum);
7589: my @sections = (sort {$a <=> $b} keys(%sections_count));
7590: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7591: my @groups = sort(keys(%curr_groups));
7592: my $allroles = [];
7593: my $rolehash;
7594: my $accesshash = {
7595: active => 'Currently has access',
7596: future => 'Will have future access',
7597: previous => 'Previously had access',
7598: };
7599: if ($needroles) {
7600: $rolehash = {'all' => 'all'};
1.385 albertel 7601: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7602: if (&Apache::lonnet::error(%user_roles)) {
7603: undef(%user_roles);
7604: }
7605: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7606: my ($role)=split(/\:/,$item,2);
7607: if ($role eq 'cr') { next; }
7608: if ($role =~ /^cr/) {
7609: $$rolehash{$role} = (split('/',$role))[3];
7610: } else {
7611: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7612: }
7613: }
7614: foreach my $key (sort(keys(%{$rolehash}))) {
7615: push(@{$allroles},$key);
7616: }
7617: push (@{$allroles},'st');
7618: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7619: }
7620: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7621: }
7622:
1.555 raeburn 7623: sub user_picker {
1.627 raeburn 7624: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7625: my $currdom = $dom;
7626: my %curr_selected = (
7627: srchin => 'dom',
1.580 raeburn 7628: srchby => 'lastname',
1.555 raeburn 7629: );
7630: my $srchterm;
1.625 raeburn 7631: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7632: if ($srch->{'srchby'} ne '') {
7633: $curr_selected{'srchby'} = $srch->{'srchby'};
7634: }
7635: if ($srch->{'srchin'} ne '') {
7636: $curr_selected{'srchin'} = $srch->{'srchin'};
7637: }
7638: if ($srch->{'srchtype'} ne '') {
7639: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7640: }
7641: if ($srch->{'srchdomain'} ne '') {
7642: $currdom = $srch->{'srchdomain'};
7643: }
7644: $srchterm = $srch->{'srchterm'};
7645: }
7646: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7647: 'usr' => 'Search criteria',
1.563 raeburn 7648: 'doma' => 'Domain/institution to search',
1.558 albertel 7649: 'uname' => 'username',
7650: 'lastname' => 'last name',
1.555 raeburn 7651: 'lastfirst' => 'last name, first name',
1.558 albertel 7652: 'crs' => 'in this course',
1.576 raeburn 7653: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7654: 'alc' => 'all LON-CAPA',
1.573 raeburn 7655: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7656: 'exact' => 'is',
7657: 'contains' => 'contains',
1.569 raeburn 7658: 'begins' => 'begins with',
1.571 raeburn 7659: 'youm' => "You must include some text to search for.",
7660: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7661: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7662: 'yomc' => "You must choose a domain when using an institutional directory search.",
7663: 'ymcd' => "You must choose a domain when using a domain search.",
7664: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7665: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7666: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7667: );
1.563 raeburn 7668: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7669: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7670:
7671: my @srchins = ('crs','dom','alc','instd');
7672:
7673: foreach my $option (@srchins) {
7674: # FIXME 'alc' option unavailable until
7675: # loncreateuser::print_user_query_page()
7676: # has been completed.
7677: next if ($option eq 'alc');
1.880 raeburn 7678: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7679: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7680: if ($curr_selected{'srchin'} eq $option) {
7681: $srchinsel .= '
7682: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7683: } else {
7684: $srchinsel .= '
7685: <option value="'.$option.'">'.$lt{$option}.'</option>';
7686: }
1.555 raeburn 7687: }
1.563 raeburn 7688: $srchinsel .= "\n </select>\n";
1.555 raeburn 7689:
7690: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7691: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7692: if ($curr_selected{'srchby'} eq $option) {
7693: $srchbysel .= '
7694: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7695: } else {
7696: $srchbysel .= '
7697: <option value="'.$option.'">'.$lt{$option}.'</option>';
7698: }
7699: }
7700: $srchbysel .= "\n </select>\n";
7701:
7702: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7703: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7704: if ($curr_selected{'srchtype'} eq $option) {
7705: $srchtypesel .= '
7706: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7707: } else {
7708: $srchtypesel .= '
7709: <option value="'.$option.'">'.$lt{$option}.'</option>';
7710: }
7711: }
7712: $srchtypesel .= "\n </select>\n";
7713:
1.558 albertel 7714: my ($newuserscript,$new_user_create);
1.556 raeburn 7715:
7716: if ($forcenewuser) {
1.576 raeburn 7717: if (ref($srch) eq 'HASH') {
7718: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7719: if ($cancreate) {
7720: $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>';
7721: } else {
1.799 bisitz 7722: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7723: my %usertypetext = (
7724: official => 'institutional',
7725: unofficial => 'non-institutional',
7726: );
1.799 bisitz 7727: $new_user_create = '<p class="LC_warning">'
7728: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7729: .' '
7730: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7731: ,'<a href="'.$helplink.'">','</a>')
7732: .'</p><br />';
1.627 raeburn 7733: }
1.576 raeburn 7734: }
7735: }
7736:
1.556 raeburn 7737: $newuserscript = <<"ENDSCRIPT";
7738:
1.570 raeburn 7739: function setSearch(createnew,callingForm) {
1.556 raeburn 7740: if (createnew == 1) {
1.570 raeburn 7741: for (var i=0; i<callingForm.srchby.length; i++) {
7742: if (callingForm.srchby.options[i].value == 'uname') {
7743: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7744: }
7745: }
1.570 raeburn 7746: for (var i=0; i<callingForm.srchin.length; i++) {
7747: if ( callingForm.srchin.options[i].value == 'dom') {
7748: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7749: }
7750: }
1.570 raeburn 7751: for (var i=0; i<callingForm.srchtype.length; i++) {
7752: if (callingForm.srchtype.options[i].value == 'exact') {
7753: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7754: }
7755: }
1.570 raeburn 7756: for (var i=0; i<callingForm.srchdomain.length; i++) {
7757: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7758: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7759: }
7760: }
7761: }
7762: }
7763: ENDSCRIPT
1.558 albertel 7764:
1.556 raeburn 7765: }
7766:
1.555 raeburn 7767: my $output = <<"END_BLOCK";
1.556 raeburn 7768: <script type="text/javascript">
1.824 bisitz 7769: // <![CDATA[
1.570 raeburn 7770: function validateEntry(callingForm) {
1.558 albertel 7771:
1.556 raeburn 7772: var checkok = 1;
1.558 albertel 7773: var srchin;
1.570 raeburn 7774: for (var i=0; i<callingForm.srchin.length; i++) {
7775: if ( callingForm.srchin[i].checked ) {
7776: srchin = callingForm.srchin[i].value;
1.558 albertel 7777: }
7778: }
7779:
1.570 raeburn 7780: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7781: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7782: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7783: var srchterm = callingForm.srchterm.value;
7784: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7785: var msg = "";
7786:
7787: if (srchterm == "") {
7788: checkok = 0;
1.571 raeburn 7789: msg += "$lt{'youm'}\\n";
1.556 raeburn 7790: }
7791:
1.569 raeburn 7792: if (srchtype== 'begins') {
7793: if (srchterm.length < 2) {
7794: checkok = 0;
1.571 raeburn 7795: msg += "$lt{'thte'}\\n";
1.569 raeburn 7796: }
7797: }
7798:
1.556 raeburn 7799: if (srchtype== 'contains') {
7800: if (srchterm.length < 3) {
7801: checkok = 0;
1.571 raeburn 7802: msg += "$lt{'thet'}\\n";
1.556 raeburn 7803: }
7804: }
7805: if (srchin == 'instd') {
7806: if (srchdomain == '') {
7807: checkok = 0;
1.571 raeburn 7808: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7809: }
7810: }
7811: if (srchin == 'dom') {
7812: if (srchdomain == '') {
7813: checkok = 0;
1.571 raeburn 7814: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7815: }
7816: }
7817: if (srchby == 'lastfirst') {
7818: if (srchterm.indexOf(",") == -1) {
7819: checkok = 0;
1.571 raeburn 7820: msg += "$lt{'whus'}\\n";
1.556 raeburn 7821: }
7822: if (srchterm.indexOf(",") == srchterm.length -1) {
7823: checkok = 0;
1.571 raeburn 7824: msg += "$lt{'whse'}\\n";
1.556 raeburn 7825: }
7826: }
7827: if (checkok == 0) {
1.571 raeburn 7828: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7829: return;
7830: }
7831: if (checkok == 1) {
1.570 raeburn 7832: callingForm.submit();
1.556 raeburn 7833: }
7834: }
7835:
7836: $newuserscript
7837:
1.824 bisitz 7838: // ]]>
1.556 raeburn 7839: </script>
1.558 albertel 7840:
7841: $new_user_create
7842:
1.555 raeburn 7843: END_BLOCK
1.558 albertel 7844:
1.876 raeburn 7845: $output .= &Apache::lonhtmlcommon::start_pick_box().
7846: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7847: $domform.
7848: &Apache::lonhtmlcommon::row_closure().
7849: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7850: $srchbysel.
7851: $srchtypesel.
7852: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7853: $srchinsel.
7854: &Apache::lonhtmlcommon::row_closure(1).
7855: &Apache::lonhtmlcommon::end_pick_box().
7856: '<br />';
1.555 raeburn 7857: return $output;
7858: }
7859:
1.612 raeburn 7860: sub user_rule_check {
1.615 raeburn 7861: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7862: my $response;
7863: if (ref($usershash) eq 'HASH') {
7864: foreach my $user (keys(%{$usershash})) {
7865: my ($uname,$udom) = split(/:/,$user);
7866: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7867: my ($id,$newuser);
1.612 raeburn 7868: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7869: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7870: $id = $usershash->{$user}->{'id'};
7871: }
7872: my $inst_response;
7873: if (ref($checks) eq 'HASH') {
7874: if (defined($checks->{'username'})) {
1.615 raeburn 7875: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7876: &Apache::lonnet::get_instuser($udom,$uname);
7877: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7878: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7879: &Apache::lonnet::get_instuser($udom,undef,$id);
7880: }
1.615 raeburn 7881: } else {
7882: ($inst_response,%{$inst_results->{$user}}) =
7883: &Apache::lonnet::get_instuser($udom,$uname);
7884: return;
1.612 raeburn 7885: }
1.615 raeburn 7886: if (!$got_rules->{$udom}) {
1.612 raeburn 7887: my %domconfig = &Apache::lonnet::get_dom('configuration',
7888: ['usercreation'],$udom);
7889: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7890: foreach my $item ('username','id') {
1.612 raeburn 7891: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7892: $$curr_rules{$udom}{$item} =
7893: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7894: }
7895: }
7896: }
1.615 raeburn 7897: $got_rules->{$udom} = 1;
1.585 raeburn 7898: }
1.612 raeburn 7899: foreach my $item (keys(%{$checks})) {
7900: if (ref($$curr_rules{$udom}) eq 'HASH') {
7901: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7902: if (@{$$curr_rules{$udom}{$item}} > 0) {
7903: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7904: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7905: if ($rule_check{$rule}) {
7906: $$rulematch{$user}{$item} = $rule;
7907: if ($inst_response eq 'ok') {
1.615 raeburn 7908: if (ref($inst_results) eq 'HASH') {
7909: if (ref($inst_results->{$user}) eq 'HASH') {
7910: if (keys(%{$inst_results->{$user}}) == 0) {
7911: $$alerts{$item}{$udom}{$uname} = 1;
7912: }
1.612 raeburn 7913: }
7914: }
1.615 raeburn 7915: }
7916: last;
1.585 raeburn 7917: }
7918: }
7919: }
7920: }
7921: }
7922: }
7923: }
7924: }
1.612 raeburn 7925: return;
7926: }
7927:
7928: sub user_rule_formats {
7929: my ($domain,$domdesc,$curr_rules,$check) = @_;
7930: my %text = (
7931: 'username' => 'Usernames',
7932: 'id' => 'IDs',
7933: );
7934: my $output;
7935: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7936: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7937: if (@{$ruleorder} > 0) {
7938: $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>';
7939: foreach my $rule (@{$ruleorder}) {
7940: if (ref($curr_rules) eq 'ARRAY') {
7941: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7942: if (ref($rules->{$rule}) eq 'HASH') {
7943: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7944: $rules->{$rule}{'desc'}.'</li>';
7945: }
7946: }
7947: }
7948: }
7949: $output .= '</ul>';
7950: }
7951: }
7952: return $output;
7953: }
7954:
7955: sub instrule_disallow_msg {
1.615 raeburn 7956: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7957: my $response;
7958: my %text = (
7959: item => 'username',
7960: items => 'usernames',
7961: match => 'matches',
7962: do => 'does',
7963: action => 'a username',
7964: one => 'one',
7965: );
7966: if ($count > 1) {
7967: $text{'item'} = 'usernames';
7968: $text{'match'} ='match';
7969: $text{'do'} = 'do';
7970: $text{'action'} = 'usernames',
7971: $text{'one'} = 'ones';
7972: }
7973: if ($checkitem eq 'id') {
7974: $text{'items'} = 'IDs';
7975: $text{'item'} = 'ID';
7976: $text{'action'} = 'an ID';
1.615 raeburn 7977: if ($count > 1) {
7978: $text{'item'} = 'IDs';
7979: $text{'action'} = 'IDs';
7980: }
1.612 raeburn 7981: }
1.674 bisitz 7982: $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 7983: if ($mode eq 'upload') {
7984: if ($checkitem eq 'username') {
7985: $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'}.");
7986: } elsif ($checkitem eq 'id') {
1.674 bisitz 7987: $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 7988: }
1.669 raeburn 7989: } elsif ($mode eq 'selfcreate') {
7990: if ($checkitem eq 'id') {
7991: $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.");
7992: }
1.615 raeburn 7993: } else {
7994: if ($checkitem eq 'username') {
7995: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7996: } elsif ($checkitem eq 'id') {
7997: $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.");
7998: }
1.612 raeburn 7999: }
8000: return $response;
1.585 raeburn 8001: }
8002:
1.624 raeburn 8003: sub personal_data_fieldtitles {
8004: my %fieldtitles = &Apache::lonlocal::texthash (
8005: id => 'Student/Employee ID',
8006: permanentemail => 'E-mail address',
8007: lastname => 'Last Name',
8008: firstname => 'First Name',
8009: middlename => 'Middle Name',
8010: generation => 'Generation',
8011: gen => 'Generation',
1.765 raeburn 8012: inststatus => 'Affiliation',
1.624 raeburn 8013: );
8014: return %fieldtitles;
8015: }
8016:
1.642 raeburn 8017: sub sorted_inst_types {
8018: my ($dom) = @_;
8019: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8020: my $othertitle = &mt('All users');
8021: if ($env{'request.course.id'}) {
1.668 raeburn 8022: $othertitle = &mt('Any users');
1.642 raeburn 8023: }
8024: my @types;
8025: if (ref($order) eq 'ARRAY') {
8026: @types = @{$order};
8027: }
8028: if (@types == 0) {
8029: if (ref($usertypes) eq 'HASH') {
8030: @types = sort(keys(%{$usertypes}));
8031: }
8032: }
8033: if (keys(%{$usertypes}) > 0) {
8034: $othertitle = &mt('Other users');
8035: }
8036: return ($othertitle,$usertypes,\@types);
8037: }
8038:
1.645 raeburn 8039: sub get_institutional_codes {
8040: my ($settings,$allcourses,$LC_code) = @_;
8041: # Get complete list of course sections to update
8042: my @currsections = ();
8043: my @currxlists = ();
8044: my $coursecode = $$settings{'internal.coursecode'};
8045:
8046: if ($$settings{'internal.sectionnums'} ne '') {
8047: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8048: }
8049:
8050: if ($$settings{'internal.crosslistings'} ne '') {
8051: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8052: }
8053:
8054: if (@currxlists > 0) {
8055: foreach (@currxlists) {
8056: if (m/^([^:]+):(\w*)$/) {
8057: unless (grep/^$1$/,@{$allcourses}) {
8058: push @{$allcourses},$1;
8059: $$LC_code{$1} = $2;
8060: }
8061: }
8062: }
8063: }
8064:
8065: if (@currsections > 0) {
8066: foreach (@currsections) {
8067: if (m/^(\w+):(\w*)$/) {
8068: my $sec = $coursecode.$1;
8069: my $lc_sec = $2;
8070: unless (grep/^$sec$/,@{$allcourses}) {
8071: push @{$allcourses},$sec;
8072: $$LC_code{$sec} = $lc_sec;
8073: }
8074: }
8075: }
8076: }
8077: return;
8078: }
8079:
1.112 bowersj2 8080: =pod
8081:
1.780 raeburn 8082: =head1 Slot Helpers
8083:
8084: =over 4
8085:
8086: =item * sorted_slots()
8087:
8088: Sorts an array of slot names in order of slot start time (earliest first).
8089:
8090: Inputs:
8091:
8092: =over 4
8093:
8094: slotsarr - Reference to array of unsorted slot names.
8095:
8096: slots - Reference to hash of hash, where outer hash keys are slot names.
8097:
1.549 albertel 8098: =back
8099:
1.780 raeburn 8100: Returns:
8101:
8102: =over 4
8103:
8104: sorted - An array of slot names sorted by the start time of the slot.
8105:
8106: =back
8107:
8108: =back
8109:
8110: =cut
8111:
8112:
8113: sub sorted_slots {
8114: my ($slotsarr,$slots) = @_;
8115: my @sorted;
8116: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8117: @sorted =
8118: sort {
8119: if (ref($slots->{$a}) && ref($slots->{$b})) {
8120: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8121: }
8122: if (ref($slots->{$a})) { return -1;}
8123: if (ref($slots->{$b})) { return 1;}
8124: return 0;
8125: } @{$slotsarr};
8126: }
8127: return @sorted;
8128: }
8129:
8130:
8131: =pod
8132:
1.549 albertel 8133: =head1 HTTP Helpers
8134:
8135: =over 4
8136:
1.648 raeburn 8137: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8138:
1.258 albertel 8139: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8140: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8141: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8142:
8143: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8144: $possible_names is an ref to an array of form element names. As an example:
8145: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8146: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8147:
8148: =cut
1.1 albertel 8149:
1.6 albertel 8150: sub get_unprocessed_cgi {
1.25 albertel 8151: my ($query,$possible_names)= @_;
1.26 matthew 8152: # $Apache::lonxml::debug=1;
1.356 albertel 8153: foreach my $pair (split(/&/,$query)) {
8154: my ($name, $value) = split(/=/,$pair);
1.369 www 8155: $name = &unescape($name);
1.25 albertel 8156: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8157: $value =~ tr/+/ /;
8158: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8159: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8160: }
1.16 harris41 8161: }
1.6 albertel 8162: }
8163:
1.112 bowersj2 8164: =pod
8165:
1.648 raeburn 8166: =item * &cacheheader()
1.112 bowersj2 8167:
8168: returns cache-controlling header code
8169:
8170: =cut
8171:
1.7 albertel 8172: sub cacheheader {
1.258 albertel 8173: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8174: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8175: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8176: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8177: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8178: return $output;
1.7 albertel 8179: }
8180:
1.112 bowersj2 8181: =pod
8182:
1.648 raeburn 8183: =item * &no_cache($r)
1.112 bowersj2 8184:
8185: specifies header code to not have cache
8186:
8187: =cut
8188:
1.9 albertel 8189: sub no_cache {
1.216 albertel 8190: my ($r) = @_;
8191: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8192: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8193: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8194: $r->no_cache(1);
8195: $r->header_out("Expires" => $date);
8196: $r->header_out("Pragma" => "no-cache");
1.123 www 8197: }
8198:
8199: sub content_type {
1.181 albertel 8200: my ($r,$type,$charset) = @_;
1.299 foxr 8201: if ($r) {
8202: # Note that printout.pl calls this with undef for $r.
8203: &no_cache($r);
8204: }
1.258 albertel 8205: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8206: unless ($charset) {
8207: $charset=&Apache::lonlocal::current_encoding;
8208: }
8209: if ($charset) { $type.='; charset='.$charset; }
8210: if ($r) {
8211: $r->content_type($type);
8212: } else {
8213: print("Content-type: $type\n\n");
8214: }
1.9 albertel 8215: }
1.25 albertel 8216:
1.112 bowersj2 8217: =pod
8218:
1.648 raeburn 8219: =item * &add_to_env($name,$value)
1.112 bowersj2 8220:
1.258 albertel 8221: adds $name to the %env hash with value
1.112 bowersj2 8222: $value, if $name already exists, the entry is converted to an array
8223: reference and $value is added to the array.
8224:
8225: =cut
8226:
1.25 albertel 8227: sub add_to_env {
8228: my ($name,$value)=@_;
1.258 albertel 8229: if (defined($env{$name})) {
8230: if (ref($env{$name})) {
1.25 albertel 8231: #already have multiple values
1.258 albertel 8232: push(@{ $env{$name} },$value);
1.25 albertel 8233: } else {
8234: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8235: my $first=$env{$name};
8236: undef($env{$name});
8237: push(@{ $env{$name} },$first,$value);
1.25 albertel 8238: }
8239: } else {
1.258 albertel 8240: $env{$name}=$value;
1.25 albertel 8241: }
1.31 albertel 8242: }
1.149 albertel 8243:
8244: =pod
8245:
1.648 raeburn 8246: =item * &get_env_multiple($name)
1.149 albertel 8247:
1.258 albertel 8248: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8249: values may be defined and end up as an array ref.
8250:
8251: returns an array of values
8252:
8253: =cut
8254:
8255: sub get_env_multiple {
8256: my ($name) = @_;
8257: my @values;
1.258 albertel 8258: if (defined($env{$name})) {
1.149 albertel 8259: # exists is it an array
1.258 albertel 8260: if (ref($env{$name})) {
8261: @values=@{ $env{$name} };
1.149 albertel 8262: } else {
1.258 albertel 8263: $values[0]=$env{$name};
1.149 albertel 8264: }
8265: }
8266: return(@values);
8267: }
8268:
1.660 raeburn 8269: sub ask_for_embedded_content {
8270: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8271: my $upload_output = '
8272: <form name="upload_embedded" action="'.$actionurl.'"
8273: method="post" enctype="multipart/form-data">';
8274: $upload_output .= $state;
1.661 raeburn 8275: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8276:
8277: my $num = 0;
8278: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8279: $upload_output .= &start_data_table_row().
8280: '<td>'.$embed_file.'</td><td>';
8281: if ($args->{'ignore_remote_references'}
8282: && $embed_file =~ m{^\w+://}) {
8283: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8284: } elsif ($args->{'error_on_invalid_names'}
8285: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8286:
8287: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8288:
8289: } else {
8290: $upload_output .='
1.661 raeburn 8291: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8292: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8293: my $attrib = join(':',@{$$allfiles{$embed_file}});
8294: $upload_output .=
8295: "\n\t\t".
8296: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8297: $attrib.'" />';
8298: if (exists($$codebase{$embed_file})) {
8299: $upload_output .=
8300: "\n\t\t".
8301: '<input name="codebase_'.$num.'" type="hidden" value="'.
8302: &escape($$codebase{$embed_file}).'" />';
8303: }
8304: }
8305: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8306: $num++;
8307: }
8308: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8309: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8310: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8311: '.&mt('(only files for which a location has been provided will be uploaded)').'
8312: </form>';
8313: return $upload_output;
8314: }
8315:
1.661 raeburn 8316: sub upload_embedded {
8317: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8318: $current_disk_usage) = @_;
8319: my $output;
8320: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8321: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8322: my $orig_uploaded_filename =
8323: $env{'form.embedded_item_'.$i.'.filename'};
8324:
8325: $env{'form.embedded_orig_'.$i} =
8326: &unescape($env{'form.embedded_orig_'.$i});
8327: my ($path,$fname) =
8328: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8329: # no path, whole string is fname
8330: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8331:
8332: $path = $env{'form.currentpath'}.$path;
8333: $fname = &Apache::lonnet::clean_filename($fname);
8334: # See if there is anything left
8335: next if ($fname eq '');
8336:
8337: # Check if file already exists as a file or directory.
8338: my ($state,$msg);
8339: if ($context eq 'portfolio') {
8340: my $port_path = $dirpath;
8341: if ($group ne '') {
8342: $port_path = "groups/$group/$port_path";
8343: }
8344: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8345: $dir_root,$port_path,$disk_quota,
8346: $current_disk_usage,$uname,$udom);
8347: if ($state eq 'will_exceed_quota'
8348: || $state eq 'file_locked'
8349: || $state eq 'file_exists' ) {
8350: $output .= $msg;
8351: next;
8352: }
8353: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8354: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8355: if ($state eq 'exists') {
8356: $output .= $msg;
8357: next;
8358: }
8359: }
8360: # Check if extension is valid
8361: if (($fname =~ /\.(\w+)$/) &&
8362: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8363: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8364: next;
8365: } elsif (($fname =~ /\.(\w+)$/) &&
8366: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8367: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8368: next;
8369: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8370: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8371: next;
8372: }
8373:
8374: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8375: if ($context eq 'portfolio') {
8376: my $result=
8377: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8378: $dirpath.$path);
8379: if ($result !~ m|^/uploaded/|) {
8380: $output .= '<span class="LC_error">'
8381: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8382: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8383: .'</span><br />';
8384: next;
8385: } else {
8386: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8387: $path.$fname.'</span>').'</p>';
8388: }
8389: } else {
8390: # Save the file
8391: my $target = $env{'form.embedded_item_'.$i};
8392: my $fullpath = $dir_root.$dirpath.'/'.$path;
8393: my $dest = $fullpath.$fname;
8394: my $url = $url_root.$dirpath.'/'.$path.$fname;
8395: my @parts=split(/\//,$fullpath);
8396: my $count;
8397: my $filepath = $dir_root;
8398: for ($count=4;$count<=$#parts;$count++) {
8399: $filepath .= "/$parts[$count]";
8400: if ((-e $filepath)!=1) {
8401: mkdir($filepath,0770);
8402: }
8403: }
8404: my $fh;
8405: if (!open($fh,'>'.$dest)) {
8406: &Apache::lonnet::logthis('Failed to create '.$dest);
8407: $output .= '<span class="LC_error">'.
8408: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8409: '</span><br />';
8410: } else {
8411: if (!print $fh $env{'form.embedded_item_'.$i}) {
8412: &Apache::lonnet::logthis('Failed to write to '.$dest);
8413: $output .= '<span class="LC_error">'.
8414: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8415: '</span><br />';
8416: } else {
8417: if ($context eq 'testbank') {
8418: $output .= &mt('Embedded file uploaded successfully:').
8419: ' <a href="'.$url.'">'.
8420: $orig_uploaded_filename.'</a><br />';
8421: } else {
1.705 tempelho 8422: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8423: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8424: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8425: }
8426: }
8427: close($fh);
8428: }
8429: }
8430: }
8431: return $output;
8432: }
8433:
8434: sub check_for_existing {
8435: my ($path,$fname,$element) = @_;
8436: my ($state,$msg);
8437: if (-d $path.'/'.$fname) {
8438: $state = 'exists';
8439: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8440: } elsif (-e $path.'/'.$fname) {
8441: $state = 'exists';
8442: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8443: }
8444: if ($state eq 'exists') {
8445: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8446: }
8447: return ($state,$msg);
8448: }
8449:
8450: sub check_for_upload {
8451: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8452: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8453: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8454: my $getpropath = 1;
8455: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8456: $getpropath);
8457: my $found_file = 0;
8458: my $locked_file = 0;
8459: foreach my $line (@dir_list) {
8460: my ($file_name)=split(/\&/,$line,2);
8461: if ($file_name eq $fname){
8462: $file_name = $path.$file_name;
8463: if ($group ne '') {
8464: $file_name = $group.$file_name;
8465: }
8466: $found_file = 1;
8467: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8468: $locked_file = 1;
8469: }
8470: }
8471: }
8472: if (($current_disk_usage + $filesize) > $disk_quota){
8473: my $msg = '<span class="LC_error">'.
8474: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8475: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8476: return ('will_exceed_quota',$msg);
8477: } elsif ($found_file) {
8478: if ($locked_file) {
8479: my $msg = '<span class="LC_error">';
8480: $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>');
8481: $msg .= '</span><br />';
8482: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8483: return ('file_locked',$msg);
8484: } else {
8485: my $msg = '<span class="LC_error">';
8486: $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'});
8487: $msg .= '</span>';
8488: $msg .= '<br />';
8489: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8490: return ('file_exists',$msg);
8491: }
8492: }
8493: }
8494:
1.31 albertel 8495:
1.41 ng 8496: =pod
1.45 matthew 8497:
1.464 albertel 8498: =back
1.41 ng 8499:
1.112 bowersj2 8500: =head1 CSV Upload/Handling functions
1.38 albertel 8501:
1.41 ng 8502: =over 4
8503:
1.648 raeburn 8504: =item * &upfile_store($r)
1.41 ng 8505:
8506: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8507: needs $env{'form.upfile'}
1.41 ng 8508: returns $datatoken to be put into hidden field
8509:
8510: =cut
1.31 albertel 8511:
8512: sub upfile_store {
8513: my $r=shift;
1.258 albertel 8514: $env{'form.upfile'}=~s/\r/\n/gs;
8515: $env{'form.upfile'}=~s/\f/\n/gs;
8516: $env{'form.upfile'}=~s/\n+/\n/gs;
8517: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8518:
1.258 albertel 8519: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8520: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8521: {
1.158 raeburn 8522: my $datafile = $r->dir_config('lonDaemons').
8523: '/tmp/'.$datatoken.'.tmp';
8524: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8525: print $fh $env{'form.upfile'};
1.158 raeburn 8526: close($fh);
8527: }
1.31 albertel 8528: }
8529: return $datatoken;
8530: }
8531:
1.56 matthew 8532: =pod
8533:
1.648 raeburn 8534: =item * &load_tmp_file($r)
1.41 ng 8535:
8536: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8537: needs $env{'form.datatoken'},
8538: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8539:
8540: =cut
1.31 albertel 8541:
8542: sub load_tmp_file {
8543: my $r=shift;
8544: my @studentdata=();
8545: {
1.158 raeburn 8546: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8547: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8548: if ( open(my $fh,"<$studentfile") ) {
8549: @studentdata=<$fh>;
8550: close($fh);
8551: }
1.31 albertel 8552: }
1.258 albertel 8553: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8554: }
8555:
1.56 matthew 8556: =pod
8557:
1.648 raeburn 8558: =item * &upfile_record_sep()
1.41 ng 8559:
8560: Separate uploaded file into records
8561: returns array of records,
1.258 albertel 8562: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8563:
8564: =cut
1.31 albertel 8565:
8566: sub upfile_record_sep {
1.258 albertel 8567: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8568: } else {
1.248 albertel 8569: my @records;
1.258 albertel 8570: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8571: if ($line=~/^\s*$/) { next; }
8572: push(@records,$line);
8573: }
8574: return @records;
1.31 albertel 8575: }
8576: }
8577:
1.56 matthew 8578: =pod
8579:
1.648 raeburn 8580: =item * &record_sep($record)
1.41 ng 8581:
1.258 albertel 8582: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8583:
8584: =cut
8585:
1.263 www 8586: sub takeleft {
8587: my $index=shift;
8588: return substr('0000'.$index,-4,4);
8589: }
8590:
1.31 albertel 8591: sub record_sep {
8592: my $record=shift;
8593: my %components=();
1.258 albertel 8594: if ($env{'form.upfiletype'} eq 'xml') {
8595: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8596: my $i=0;
1.356 albertel 8597: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8598: $field=~s/^(\"|\')//;
8599: $field=~s/(\"|\')$//;
1.263 www 8600: $components{&takeleft($i)}=$field;
1.31 albertel 8601: $i++;
8602: }
1.258 albertel 8603: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8604: my $i=0;
1.356 albertel 8605: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8606: $field=~s/^(\"|\')//;
8607: $field=~s/(\"|\')$//;
1.263 www 8608: $components{&takeleft($i)}=$field;
1.31 albertel 8609: $i++;
8610: }
8611: } else {
1.561 www 8612: my $separator=',';
1.480 banghart 8613: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8614: $separator=';';
1.480 banghart 8615: }
1.31 albertel 8616: my $i=0;
1.561 www 8617: # the character we are looking for to indicate the end of a quote or a record
8618: my $looking_for=$separator;
8619: # do not add the characters to the fields
8620: my $ignore=0;
8621: # we just encountered a separator (or the beginning of the record)
8622: my $just_found_separator=1;
8623: # store the field we are working on here
8624: my $field='';
8625: # work our way through all characters in record
8626: foreach my $character ($record=~/(.)/g) {
8627: if ($character eq $looking_for) {
8628: if ($character ne $separator) {
8629: # Found the end of a quote, again looking for separator
8630: $looking_for=$separator;
8631: $ignore=1;
8632: } else {
8633: # Found a separator, store away what we got
8634: $components{&takeleft($i)}=$field;
8635: $i++;
8636: $just_found_separator=1;
8637: $ignore=0;
8638: $field='';
8639: }
8640: next;
8641: }
8642: # single or double quotation marks after a separator indicate beginning of a quote
8643: # we are now looking for the end of the quote and need to ignore separators
8644: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8645: $looking_for=$character;
8646: next;
8647: }
8648: # ignore would be true after we reached the end of a quote
8649: if ($ignore) { next; }
8650: if (($just_found_separator) && ($character=~/\s/)) { next; }
8651: $field.=$character;
8652: $just_found_separator=0;
1.31 albertel 8653: }
1.561 www 8654: # catch the very last entry, since we never encountered the separator
8655: $components{&takeleft($i)}=$field;
1.31 albertel 8656: }
8657: return %components;
8658: }
8659:
1.144 matthew 8660: ######################################################
8661: ######################################################
8662:
1.56 matthew 8663: =pod
8664:
1.648 raeburn 8665: =item * &upfile_select_html()
1.41 ng 8666:
1.144 matthew 8667: Return HTML code to select a file from the users machine and specify
8668: the file type.
1.41 ng 8669:
8670: =cut
8671:
1.144 matthew 8672: ######################################################
8673: ######################################################
1.31 albertel 8674: sub upfile_select_html {
1.144 matthew 8675: my %Types = (
8676: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8677: semisv => &mt('Semicolon separated values'),
1.144 matthew 8678: space => &mt('Space separated'),
8679: tab => &mt('Tabulator separated'),
8680: # xml => &mt('HTML/XML'),
8681: );
8682: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8683: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8684: foreach my $type (sort(keys(%Types))) {
8685: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8686: }
8687: $Str .= "</select>\n";
8688: return $Str;
1.31 albertel 8689: }
8690:
1.301 albertel 8691: sub get_samples {
8692: my ($records,$toget) = @_;
8693: my @samples=({});
8694: my $got=0;
8695: foreach my $rec (@$records) {
8696: my %temp = &record_sep($rec);
8697: if (! grep(/\S/, values(%temp))) { next; }
8698: if (%temp) {
8699: $samples[$got]=\%temp;
8700: $got++;
8701: if ($got == $toget) { last; }
8702: }
8703: }
8704: return \@samples;
8705: }
8706:
1.144 matthew 8707: ######################################################
8708: ######################################################
8709:
1.56 matthew 8710: =pod
8711:
1.648 raeburn 8712: =item * &csv_print_samples($r,$records)
1.41 ng 8713:
8714: Prints a table of sample values from each column uploaded $r is an
8715: Apache Request ref, $records is an arrayref from
8716: &Apache::loncommon::upfile_record_sep
8717:
8718: =cut
8719:
1.144 matthew 8720: ######################################################
8721: ######################################################
1.31 albertel 8722: sub csv_print_samples {
8723: my ($r,$records) = @_;
1.662 bisitz 8724: my $samples = &get_samples($records,5);
1.301 albertel 8725:
1.594 raeburn 8726: $r->print(&mt('Samples').'<br />'.&start_data_table().
8727: &start_data_table_header_row());
1.356 albertel 8728: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8729: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8730: $r->print(&end_data_table_header_row());
1.301 albertel 8731: foreach my $hash (@$samples) {
1.594 raeburn 8732: $r->print(&start_data_table_row());
1.356 albertel 8733: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8734: $r->print('<td>');
1.356 albertel 8735: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8736: $r->print('</td>');
8737: }
1.594 raeburn 8738: $r->print(&end_data_table_row());
1.31 albertel 8739: }
1.594 raeburn 8740: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8741: }
8742:
1.144 matthew 8743: ######################################################
8744: ######################################################
8745:
1.56 matthew 8746: =pod
8747:
1.648 raeburn 8748: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8749:
8750: Prints a table to create associations between values and table columns.
1.144 matthew 8751:
1.41 ng 8752: $r is an Apache Request ref,
8753: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8754: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8755:
8756: =cut
8757:
1.144 matthew 8758: ######################################################
8759: ######################################################
1.31 albertel 8760: sub csv_print_select_table {
8761: my ($r,$records,$d) = @_;
1.301 albertel 8762: my $i=0;
8763: my $samples = &get_samples($records,1);
1.144 matthew 8764: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8765: &start_data_table().&start_data_table_header_row().
1.144 matthew 8766: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8767: '<th>'.&mt('Column').'</th>'.
8768: &end_data_table_header_row()."\n");
1.356 albertel 8769: foreach my $array_ref (@$d) {
8770: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8771: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8772:
1.875 bisitz 8773: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8774: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8775: $r->print('<option value="none"></option>');
1.356 albertel 8776: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8777: $r->print('<option value="'.$sample.'"'.
8778: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8779: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8780: }
1.594 raeburn 8781: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8782: $i++;
8783: }
1.594 raeburn 8784: $r->print(&end_data_table());
1.31 albertel 8785: $i--;
8786: return $i;
8787: }
1.56 matthew 8788:
1.144 matthew 8789: ######################################################
8790: ######################################################
8791:
1.56 matthew 8792: =pod
1.31 albertel 8793:
1.648 raeburn 8794: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8795:
8796: Prints a table of sample values from the upload and can make associate samples to internal names.
8797:
8798: $r is an Apache Request ref,
8799: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8800: $d is an array of 2 element arrays (internal name, displayed name)
8801:
8802: =cut
8803:
1.144 matthew 8804: ######################################################
8805: ######################################################
1.31 albertel 8806: sub csv_samples_select_table {
8807: my ($r,$records,$d) = @_;
8808: my $i=0;
1.144 matthew 8809: #
1.662 bisitz 8810: my $max_samples = 5;
8811: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8812: $r->print(&start_data_table().
8813: &start_data_table_header_row().'<th>'.
8814: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8815: &end_data_table_header_row());
1.301 albertel 8816:
8817: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8818: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8819: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8820: foreach my $option (@$d) {
8821: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8822: $r->print('<option value="'.$value.'"'.
1.253 albertel 8823: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8824: $display.'</option>');
1.31 albertel 8825: }
8826: $r->print('</select></td><td>');
1.662 bisitz 8827: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8828: if (defined($samples->[$line]{$key})) {
8829: $r->print($samples->[$line]{$key}."<br />\n");
8830: }
8831: }
1.594 raeburn 8832: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8833: $i++;
8834: }
1.594 raeburn 8835: $r->print(&end_data_table());
1.31 albertel 8836: $i--;
8837: return($i);
1.115 matthew 8838: }
8839:
1.144 matthew 8840: ######################################################
8841: ######################################################
8842:
1.115 matthew 8843: =pod
8844:
1.648 raeburn 8845: =item * &clean_excel_name($name)
1.115 matthew 8846:
8847: Returns a replacement for $name which does not contain any illegal characters.
8848:
8849: =cut
8850:
1.144 matthew 8851: ######################################################
8852: ######################################################
1.115 matthew 8853: sub clean_excel_name {
8854: my ($name) = @_;
8855: $name =~ s/[:\*\?\/\\]//g;
8856: if (length($name) > 31) {
8857: $name = substr($name,0,31);
8858: }
8859: return $name;
1.25 albertel 8860: }
1.84 albertel 8861:
1.85 albertel 8862: =pod
8863:
1.648 raeburn 8864: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8865:
8866: Returns either 1 or undef
8867:
8868: 1 if the part is to be hidden, undef if it is to be shown
8869:
8870: Arguments are:
8871:
8872: $id the id of the part to be checked
8873: $symb, optional the symb of the resource to check
8874: $udom, optional the domain of the user to check for
8875: $uname, optional the username of the user to check for
8876:
8877: =cut
1.84 albertel 8878:
8879: sub check_if_partid_hidden {
8880: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8881: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8882: $symb,$udom,$uname);
1.141 albertel 8883: my $truth=1;
8884: #if the string starts with !, then the list is the list to show not hide
8885: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8886: my @hiddenlist=split(/,/,$hiddenparts);
8887: foreach my $checkid (@hiddenlist) {
1.141 albertel 8888: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8889: }
1.141 albertel 8890: return !$truth;
1.84 albertel 8891: }
1.127 matthew 8892:
1.138 matthew 8893:
8894: ############################################################
8895: ############################################################
8896:
8897: =pod
8898:
1.157 matthew 8899: =back
8900:
1.138 matthew 8901: =head1 cgi-bin script and graphing routines
8902:
1.157 matthew 8903: =over 4
8904:
1.648 raeburn 8905: =item * &get_cgi_id()
1.138 matthew 8906:
8907: Inputs: none
8908:
8909: Returns an id which can be used to pass environment variables
8910: to various cgi-bin scripts. These environment variables will
8911: be removed from the users environment after a given time by
8912: the routine &Apache::lonnet::transfer_profile_to_env.
8913:
8914: =cut
8915:
8916: ############################################################
8917: ############################################################
1.152 albertel 8918: my $uniq=0;
1.136 matthew 8919: sub get_cgi_id {
1.154 albertel 8920: $uniq=($uniq+1)%100000;
1.280 albertel 8921: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8922: }
8923:
1.127 matthew 8924: ############################################################
8925: ############################################################
8926:
8927: =pod
8928:
1.648 raeburn 8929: =item * &DrawBarGraph()
1.127 matthew 8930:
1.138 matthew 8931: Facilitates the plotting of data in a (stacked) bar graph.
8932: Puts plot definition data into the users environment in order for
8933: graph.png to plot it. Returns an <img> tag for the plot.
8934: The bars on the plot are labeled '1','2',...,'n'.
8935:
8936: Inputs:
8937:
8938: =over 4
8939:
8940: =item $Title: string, the title of the plot
8941:
8942: =item $xlabel: string, text describing the X-axis of the plot
8943:
8944: =item $ylabel: string, text describing the Y-axis of the plot
8945:
8946: =item $Max: scalar, the maximum Y value to use in the plot
8947: If $Max is < any data point, the graph will not be rendered.
8948:
1.140 matthew 8949: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8950: they are plotted. If undefined, default values will be used.
8951:
1.178 matthew 8952: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8953:
1.138 matthew 8954: =item @Values: An array of array references. Each array reference holds data
8955: to be plotted in a stacked bar chart.
8956:
1.239 matthew 8957: =item If the final element of @Values is a hash reference the key/value
8958: pairs will be added to the graph definition.
8959:
1.138 matthew 8960: =back
8961:
8962: Returns:
8963:
8964: An <img> tag which references graph.png and the appropriate identifying
8965: information for the plot.
8966:
1.127 matthew 8967: =cut
8968:
8969: ############################################################
8970: ############################################################
1.134 matthew 8971: sub DrawBarGraph {
1.178 matthew 8972: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8973: #
8974: if (! defined($colors)) {
8975: $colors = ['#33ff00',
8976: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8977: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8978: ];
8979: }
1.228 matthew 8980: my $extra_settings = {};
8981: if (ref($Values[-1]) eq 'HASH') {
8982: $extra_settings = pop(@Values);
8983: }
1.127 matthew 8984: #
1.136 matthew 8985: my $identifier = &get_cgi_id();
8986: my $id = 'cgi.'.$identifier;
1.129 matthew 8987: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8988: return '';
8989: }
1.225 matthew 8990: #
8991: my @Labels;
8992: if (defined($labels)) {
8993: @Labels = @$labels;
8994: } else {
8995: for (my $i=0;$i<@{$Values[0]};$i++) {
8996: push (@Labels,$i+1);
8997: }
8998: }
8999: #
1.129 matthew 9000: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9001: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9002: my %ValuesHash;
9003: my $NumSets=1;
9004: foreach my $array (@Values) {
9005: next if (! ref($array));
1.136 matthew 9006: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9007: join(',',@$array);
1.129 matthew 9008: }
1.127 matthew 9009: #
1.136 matthew 9010: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9011: if ($NumBars < 3) {
9012: $width = 120+$NumBars*32;
1.220 matthew 9013: $xskip = 1;
1.225 matthew 9014: $bar_width = 30;
9015: } elsif ($NumBars < 5) {
9016: $width = 120+$NumBars*20;
9017: $xskip = 1;
9018: $bar_width = 20;
1.220 matthew 9019: } elsif ($NumBars < 10) {
1.136 matthew 9020: $width = 120+$NumBars*15;
9021: $xskip = 1;
9022: $bar_width = 15;
9023: } elsif ($NumBars <= 25) {
9024: $width = 120+$NumBars*11;
9025: $xskip = 5;
9026: $bar_width = 8;
9027: } elsif ($NumBars <= 50) {
9028: $width = 120+$NumBars*8;
9029: $xskip = 5;
9030: $bar_width = 4;
9031: } else {
9032: $width = 120+$NumBars*8;
9033: $xskip = 5;
9034: $bar_width = 4;
9035: }
9036: #
1.137 matthew 9037: $Max = 1 if ($Max < 1);
9038: if ( int($Max) < $Max ) {
9039: $Max++;
9040: $Max = int($Max);
9041: }
1.127 matthew 9042: $Title = '' if (! defined($Title));
9043: $xlabel = '' if (! defined($xlabel));
9044: $ylabel = '' if (! defined($ylabel));
1.369 www 9045: $ValuesHash{$id.'.title'} = &escape($Title);
9046: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9047: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9048: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9049: $ValuesHash{$id.'.NumBars'} = $NumBars;
9050: $ValuesHash{$id.'.NumSets'} = $NumSets;
9051: $ValuesHash{$id.'.PlotType'} = 'bar';
9052: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9053: $ValuesHash{$id.'.height'} = $height;
9054: $ValuesHash{$id.'.width'} = $width;
9055: $ValuesHash{$id.'.xskip'} = $xskip;
9056: $ValuesHash{$id.'.bar_width'} = $bar_width;
9057: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9058: #
1.228 matthew 9059: # Deal with other parameters
9060: while (my ($key,$value) = each(%$extra_settings)) {
9061: $ValuesHash{$id.'.'.$key} = $value;
9062: }
9063: #
1.646 raeburn 9064: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9065: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9066: }
9067:
9068: ############################################################
9069: ############################################################
9070:
9071: =pod
9072:
1.648 raeburn 9073: =item * &DrawXYGraph()
1.137 matthew 9074:
1.138 matthew 9075: Facilitates the plotting of data in an XY graph.
9076: Puts plot definition data into the users environment in order for
9077: graph.png to plot it. Returns an <img> tag for the plot.
9078:
9079: Inputs:
9080:
9081: =over 4
9082:
9083: =item $Title: string, the title of the plot
9084:
9085: =item $xlabel: string, text describing the X-axis of the plot
9086:
9087: =item $ylabel: string, text describing the Y-axis of the plot
9088:
9089: =item $Max: scalar, the maximum Y value to use in the plot
9090: If $Max is < any data point, the graph will not be rendered.
9091:
9092: =item $colors: Array ref containing the hex color codes for the data to be
9093: plotted in. If undefined, default values will be used.
9094:
9095: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9096:
9097: =item $Ydata: Array ref containing Array refs.
1.185 www 9098: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9099:
9100: =item %Values: hash indicating or overriding any default values which are
9101: passed to graph.png.
9102: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9103:
9104: =back
9105:
9106: Returns:
9107:
9108: An <img> tag which references graph.png and the appropriate identifying
9109: information for the plot.
9110:
1.137 matthew 9111: =cut
9112:
9113: ############################################################
9114: ############################################################
9115: sub DrawXYGraph {
9116: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9117: #
9118: # Create the identifier for the graph
9119: my $identifier = &get_cgi_id();
9120: my $id = 'cgi.'.$identifier;
9121: #
9122: $Title = '' if (! defined($Title));
9123: $xlabel = '' if (! defined($xlabel));
9124: $ylabel = '' if (! defined($ylabel));
9125: my %ValuesHash =
9126: (
1.369 www 9127: $id.'.title' => &escape($Title),
9128: $id.'.xlabel' => &escape($xlabel),
9129: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9130: $id.'.y_max_value'=> $Max,
9131: $id.'.labels' => join(',',@$Xlabels),
9132: $id.'.PlotType' => 'XY',
9133: );
9134: #
9135: if (defined($colors) && ref($colors) eq 'ARRAY') {
9136: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9137: }
9138: #
9139: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9140: return '';
9141: }
9142: my $NumSets=1;
1.138 matthew 9143: foreach my $array (@{$Ydata}){
1.137 matthew 9144: next if (! ref($array));
9145: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9146: }
1.138 matthew 9147: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9148: #
9149: # Deal with other parameters
9150: while (my ($key,$value) = each(%Values)) {
9151: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9152: }
9153: #
1.646 raeburn 9154: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9155: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9156: }
9157:
9158: ############################################################
9159: ############################################################
9160:
9161: =pod
9162:
1.648 raeburn 9163: =item * &DrawXYYGraph()
1.138 matthew 9164:
9165: Facilitates the plotting of data in an XY graph with two Y axes.
9166: Puts plot definition data into the users environment in order for
9167: graph.png to plot it. Returns an <img> tag for the plot.
9168:
9169: Inputs:
9170:
9171: =over 4
9172:
9173: =item $Title: string, the title of the plot
9174:
9175: =item $xlabel: string, text describing the X-axis of the plot
9176:
9177: =item $ylabel: string, text describing the Y-axis of the plot
9178:
9179: =item $colors: Array ref containing the hex color codes for the data to be
9180: plotted in. If undefined, default values will be used.
9181:
9182: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9183:
9184: =item $Ydata1: The first data set
9185:
9186: =item $Min1: The minimum value of the left Y-axis
9187:
9188: =item $Max1: The maximum value of the left Y-axis
9189:
9190: =item $Ydata2: The second data set
9191:
9192: =item $Min2: The minimum value of the right Y-axis
9193:
9194: =item $Max2: The maximum value of the left Y-axis
9195:
9196: =item %Values: hash indicating or overriding any default values which are
9197: passed to graph.png.
9198: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9199:
9200: =back
9201:
9202: Returns:
9203:
9204: An <img> tag which references graph.png and the appropriate identifying
9205: information for the plot.
1.136 matthew 9206:
9207: =cut
9208:
9209: ############################################################
9210: ############################################################
1.137 matthew 9211: sub DrawXYYGraph {
9212: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9213: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9214: #
9215: # Create the identifier for the graph
9216: my $identifier = &get_cgi_id();
9217: my $id = 'cgi.'.$identifier;
9218: #
9219: $Title = '' if (! defined($Title));
9220: $xlabel = '' if (! defined($xlabel));
9221: $ylabel = '' if (! defined($ylabel));
9222: my %ValuesHash =
9223: (
1.369 www 9224: $id.'.title' => &escape($Title),
9225: $id.'.xlabel' => &escape($xlabel),
9226: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9227: $id.'.labels' => join(',',@$Xlabels),
9228: $id.'.PlotType' => 'XY',
9229: $id.'.NumSets' => 2,
1.137 matthew 9230: $id.'.two_axes' => 1,
9231: $id.'.y1_max_value' => $Max1,
9232: $id.'.y1_min_value' => $Min1,
9233: $id.'.y2_max_value' => $Max2,
9234: $id.'.y2_min_value' => $Min2,
1.136 matthew 9235: );
9236: #
1.137 matthew 9237: if (defined($colors) && ref($colors) eq 'ARRAY') {
9238: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9239: }
9240: #
9241: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9242: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9243: return '';
9244: }
9245: my $NumSets=1;
1.137 matthew 9246: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9247: next if (! ref($array));
9248: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9249: }
9250: #
9251: # Deal with other parameters
9252: while (my ($key,$value) = each(%Values)) {
9253: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9254: }
9255: #
1.646 raeburn 9256: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9257: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9258: }
9259:
9260: ############################################################
9261: ############################################################
9262:
9263: =pod
9264:
1.157 matthew 9265: =back
9266:
1.139 matthew 9267: =head1 Statistics helper routines?
9268:
9269: Bad place for them but what the hell.
9270:
1.157 matthew 9271: =over 4
9272:
1.648 raeburn 9273: =item * &chartlink()
1.139 matthew 9274:
9275: Returns a link to the chart for a specific student.
9276:
9277: Inputs:
9278:
9279: =over 4
9280:
9281: =item $linktext: The text of the link
9282:
9283: =item $sname: The students username
9284:
9285: =item $sdomain: The students domain
9286:
9287: =back
9288:
1.157 matthew 9289: =back
9290:
1.139 matthew 9291: =cut
9292:
9293: ############################################################
9294: ############################################################
9295: sub chartlink {
9296: my ($linktext, $sname, $sdomain) = @_;
9297: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9298: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9299: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9300: '">'.$linktext.'</a>';
1.153 matthew 9301: }
9302:
9303: #######################################################
9304: #######################################################
9305:
9306: =pod
9307:
9308: =head1 Course Environment Routines
1.157 matthew 9309:
9310: =over 4
1.153 matthew 9311:
1.648 raeburn 9312: =item * &restore_course_settings()
1.153 matthew 9313:
1.648 raeburn 9314: =item * &store_course_settings()
1.153 matthew 9315:
9316: Restores/Store indicated form parameters from the course environment.
9317: Will not overwrite existing values of the form parameters.
9318:
9319: Inputs:
9320: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9321:
9322: a hash ref describing the data to be stored. For example:
9323:
9324: %Save_Parameters = ('Status' => 'scalar',
9325: 'chartoutputmode' => 'scalar',
9326: 'chartoutputdata' => 'scalar',
9327: 'Section' => 'array',
1.373 raeburn 9328: 'Group' => 'array',
1.153 matthew 9329: 'StudentData' => 'array',
9330: 'Maps' => 'array');
9331:
9332: Returns: both routines return nothing
9333:
1.631 raeburn 9334: =back
9335:
1.153 matthew 9336: =cut
9337:
9338: #######################################################
9339: #######################################################
9340: sub store_course_settings {
1.496 albertel 9341: return &store_settings($env{'request.course.id'},@_);
9342: }
9343:
9344: sub store_settings {
1.153 matthew 9345: # save to the environment
9346: # appenv the same items, just to be safe
1.300 albertel 9347: my $udom = $env{'user.domain'};
9348: my $uname = $env{'user.name'};
1.496 albertel 9349: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9350: my %SaveHash;
9351: my %AppHash;
9352: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9353: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9354: my $envname = 'environment.'.$basename;
1.258 albertel 9355: if (exists($env{'form.'.$setting})) {
1.153 matthew 9356: # Save this value away
9357: if ($type eq 'scalar' &&
1.258 albertel 9358: (! exists($env{$envname}) ||
9359: $env{$envname} ne $env{'form.'.$setting})) {
9360: $SaveHash{$basename} = $env{'form.'.$setting};
9361: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9362: } elsif ($type eq 'array') {
9363: my $stored_form;
1.258 albertel 9364: if (ref($env{'form.'.$setting})) {
1.153 matthew 9365: $stored_form = join(',',
9366: map {
1.369 www 9367: &escape($_);
1.258 albertel 9368: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9369: } else {
9370: $stored_form =
1.369 www 9371: &escape($env{'form.'.$setting});
1.153 matthew 9372: }
9373: # Determine if the array contents are the same.
1.258 albertel 9374: if ($stored_form ne $env{$envname}) {
1.153 matthew 9375: $SaveHash{$basename} = $stored_form;
9376: $AppHash{$envname} = $stored_form;
9377: }
9378: }
9379: }
9380: }
9381: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9382: $udom,$uname);
1.153 matthew 9383: if ($put_result !~ /^(ok|delayed)/) {
9384: &Apache::lonnet::logthis('unable to save form parameters, '.
9385: 'got error:'.$put_result);
9386: }
9387: # Make sure these settings stick around in this session, too
1.646 raeburn 9388: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9389: return;
9390: }
9391:
9392: sub restore_course_settings {
1.499 albertel 9393: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9394: }
9395:
9396: sub restore_settings {
9397: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9398: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9399: next if (exists($env{'form.'.$setting}));
1.496 albertel 9400: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9401: '.'.$setting;
1.258 albertel 9402: if (exists($env{$envname})) {
1.153 matthew 9403: if ($type eq 'scalar') {
1.258 albertel 9404: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9405: } elsif ($type eq 'array') {
1.258 albertel 9406: $env{'form.'.$setting} = [
1.153 matthew 9407: map {
1.369 www 9408: &unescape($_);
1.258 albertel 9409: } split(',',$env{$envname})
1.153 matthew 9410: ];
9411: }
9412: }
9413: }
1.127 matthew 9414: }
9415:
1.618 raeburn 9416: #######################################################
9417: #######################################################
9418:
9419: =pod
9420:
9421: =head1 Domain E-mail Routines
9422:
9423: =over 4
9424:
1.648 raeburn 9425: =item * &build_recipient_list()
1.618 raeburn 9426:
1.884 raeburn 9427: Build recipient lists for five types of e-mail:
1.766 raeburn 9428: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9429: (d) Help requests, (e) Course requests needing approval, generated by
9430: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9431: loncoursequeueadmin.pm respectively.
1.618 raeburn 9432:
9433: Inputs:
1.619 raeburn 9434: defmail (scalar - email address of default recipient),
1.618 raeburn 9435: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9436: defdom (domain for which to retrieve configuration settings),
9437: origmail (scalar - email address of recipient from loncapa.conf,
9438: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9439:
1.655 raeburn 9440: Returns: comma separated list of addresses to which to send e-mail.
9441:
9442: =back
1.618 raeburn 9443:
9444: =cut
9445:
9446: ############################################################
9447: ############################################################
9448: sub build_recipient_list {
1.619 raeburn 9449: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9450: my @recipients;
9451: my $otheremails;
9452: my %domconfig =
9453: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9454: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9455: if (exists($domconfig{'contacts'}{$mailing})) {
9456: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9457: my @contacts = ('adminemail','supportemail');
9458: foreach my $item (@contacts) {
9459: if ($domconfig{'contacts'}{$mailing}{$item}) {
9460: my $addr = $domconfig{'contacts'}{$item};
9461: if (!grep(/^\Q$addr\E$/,@recipients)) {
9462: push(@recipients,$addr);
9463: }
1.619 raeburn 9464: }
1.766 raeburn 9465: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9466: }
9467: }
1.766 raeburn 9468: } elsif ($origmail ne '') {
9469: push(@recipients,$origmail);
1.618 raeburn 9470: }
1.619 raeburn 9471: } elsif ($origmail ne '') {
9472: push(@recipients,$origmail);
1.618 raeburn 9473: }
1.688 raeburn 9474: if (defined($defmail)) {
9475: if ($defmail ne '') {
9476: push(@recipients,$defmail);
9477: }
1.618 raeburn 9478: }
9479: if ($otheremails) {
1.619 raeburn 9480: my @others;
9481: if ($otheremails =~ /,/) {
9482: @others = split(/,/,$otheremails);
1.618 raeburn 9483: } else {
1.619 raeburn 9484: push(@others,$otheremails);
9485: }
9486: foreach my $addr (@others) {
9487: if (!grep(/^\Q$addr\E$/,@recipients)) {
9488: push(@recipients,$addr);
9489: }
1.618 raeburn 9490: }
9491: }
1.619 raeburn 9492: my $recipientlist = join(',',@recipients);
1.618 raeburn 9493: return $recipientlist;
9494: }
9495:
1.127 matthew 9496: ############################################################
9497: ############################################################
1.154 albertel 9498:
1.655 raeburn 9499: =pod
9500:
9501: =head1 Course Catalog Routines
9502:
9503: =over 4
9504:
9505: =item * &gather_categories()
9506:
9507: Converts category definitions - keys of categories hash stored in
9508: coursecategories in configuration.db on the primary library server in a
9509: domain - to an array. Also generates javascript and idx hash used to
9510: generate Domain Coordinator interface for editing Course Categories.
9511:
9512: Inputs:
1.663 raeburn 9513:
1.655 raeburn 9514: categories (reference to hash of category definitions).
1.663 raeburn 9515:
1.655 raeburn 9516: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9517: categories and subcategories).
1.663 raeburn 9518:
1.655 raeburn 9519: idx (reference to hash of counters used in Domain Coordinator interface for
9520: editing Course Categories).
1.663 raeburn 9521:
1.655 raeburn 9522: jsarray (reference to array of categories used to create Javascript arrays for
9523: Domain Coordinator interface for editing Course Categories).
9524:
9525: Returns: nothing
9526:
9527: Side effects: populates cats, idx and jsarray.
9528:
9529: =cut
9530:
9531: sub gather_categories {
9532: my ($categories,$cats,$idx,$jsarray) = @_;
9533: my %counters;
9534: my $num = 0;
9535: foreach my $item (keys(%{$categories})) {
9536: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9537: if ($container eq '' && $depth == 0) {
9538: $cats->[$depth][$categories->{$item}] = $cat;
9539: } else {
9540: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9541: }
9542: my ($escitem,$tail) = split(/:/,$item,2);
9543: if ($counters{$tail} eq '') {
9544: $counters{$tail} = $num;
9545: $num ++;
9546: }
9547: if (ref($idx) eq 'HASH') {
9548: $idx->{$item} = $counters{$tail};
9549: }
9550: if (ref($jsarray) eq 'ARRAY') {
9551: push(@{$jsarray->[$counters{$tail}]},$item);
9552: }
9553: }
9554: return;
9555: }
9556:
9557: =pod
9558:
9559: =item * &extract_categories()
9560:
9561: Used to generate breadcrumb trails for course categories.
9562:
9563: Inputs:
1.663 raeburn 9564:
1.655 raeburn 9565: categories (reference to hash of category definitions).
1.663 raeburn 9566:
1.655 raeburn 9567: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9568: categories and subcategories).
1.663 raeburn 9569:
1.655 raeburn 9570: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9571:
1.655 raeburn 9572: allitems (reference to hash - key is category key
9573: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9574:
1.655 raeburn 9575: idx (reference to hash of counters used in Domain Coordinator interface for
9576: editing Course Categories).
1.663 raeburn 9577:
1.655 raeburn 9578: jsarray (reference to array of categories used to create Javascript arrays for
9579: Domain Coordinator interface for editing Course Categories).
9580:
1.665 raeburn 9581: subcats (reference to hash of arrays containing all subcategories within each
9582: category, -recursive)
9583:
1.655 raeburn 9584: Returns: nothing
9585:
9586: Side effects: populates trails and allitems hash references.
9587:
9588: =cut
9589:
9590: sub extract_categories {
1.665 raeburn 9591: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9592: if (ref($categories) eq 'HASH') {
9593: &gather_categories($categories,$cats,$idx,$jsarray);
9594: if (ref($cats->[0]) eq 'ARRAY') {
9595: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9596: my $name = $cats->[0][$i];
9597: my $item = &escape($name).'::0';
9598: my $trailstr;
9599: if ($name eq 'instcode') {
9600: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9601: } elsif ($name eq 'communities') {
9602: $trailstr = &mt('Communities');
1.655 raeburn 9603: } else {
9604: $trailstr = $name;
9605: }
9606: if ($allitems->{$item} eq '') {
9607: push(@{$trails},$trailstr);
9608: $allitems->{$item} = scalar(@{$trails})-1;
9609: }
9610: my @parents = ($name);
9611: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9612: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9613: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9614: if (ref($subcats) eq 'HASH') {
9615: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9616: }
9617: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9618: }
9619: } else {
9620: if (ref($subcats) eq 'HASH') {
9621: $subcats->{$item} = [];
1.655 raeburn 9622: }
9623: }
9624: }
9625: }
9626: }
9627: return;
9628: }
9629:
9630: =pod
9631:
9632: =item *&recurse_categories()
9633:
9634: Recursively used to generate breadcrumb trails for course categories.
9635:
9636: Inputs:
1.663 raeburn 9637:
1.655 raeburn 9638: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9639: categories and subcategories).
1.663 raeburn 9640:
1.655 raeburn 9641: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9642:
9643: category (current course category, for which breadcrumb trail is being generated).
9644:
9645: trails (reference to array of breadcrumb trails for each category).
9646:
1.655 raeburn 9647: allitems (reference to hash - key is category key
9648: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9649:
1.655 raeburn 9650: parents (array containing containers directories for current category,
9651: back to top level).
9652:
9653: Returns: nothing
9654:
9655: Side effects: populates trails and allitems hash references
9656:
9657: =cut
9658:
9659: sub recurse_categories {
1.665 raeburn 9660: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9661: my $shallower = $depth - 1;
9662: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9663: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9664: my $name = $cats->[$depth]{$category}[$k];
9665: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9666: my $trailstr = join(' -> ',(@{$parents},$category));
9667: if ($allitems->{$item} eq '') {
9668: push(@{$trails},$trailstr);
9669: $allitems->{$item} = scalar(@{$trails})-1;
9670: }
9671: my $deeper = $depth+1;
9672: push(@{$parents},$category);
1.665 raeburn 9673: if (ref($subcats) eq 'HASH') {
9674: my $subcat = &escape($name).':'.$category.':'.$depth;
9675: for (my $j=@{$parents}; $j>=0; $j--) {
9676: my $higher;
9677: if ($j > 0) {
9678: $higher = &escape($parents->[$j]).':'.
9679: &escape($parents->[$j-1]).':'.$j;
9680: } else {
9681: $higher = &escape($parents->[$j]).'::'.$j;
9682: }
9683: push(@{$subcats->{$higher}},$subcat);
9684: }
9685: }
9686: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9687: $subcats);
1.655 raeburn 9688: pop(@{$parents});
9689: }
9690: } else {
9691: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9692: my $trailstr = join(' -> ',(@{$parents},$category));
9693: if ($allitems->{$item} eq '') {
9694: push(@{$trails},$trailstr);
9695: $allitems->{$item} = scalar(@{$trails})-1;
9696: }
9697: }
9698: return;
9699: }
9700:
1.663 raeburn 9701: =pod
9702:
9703: =item *&assign_categories_table()
9704:
9705: Create a datatable for display of hierarchical categories in a domain,
9706: with checkboxes to allow a course to be categorized.
9707:
9708: Inputs:
9709:
9710: cathash - reference to hash of categories defined for the domain (from
9711: configuration.db)
9712:
9713: currcat - scalar with an & separated list of categories assigned to a course.
9714:
1.919 raeburn 9715: type - scalar contains course type (Course or Community).
9716:
1.663 raeburn 9717: Returns: $output (markup to be displayed)
9718:
9719: =cut
9720:
9721: sub assign_categories_table {
1.919 raeburn 9722: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9723: my $output;
9724: if (ref($cathash) eq 'HASH') {
9725: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9726: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9727: $maxdepth = scalar(@cats);
9728: if (@cats > 0) {
9729: my $itemcount = 0;
9730: if (ref($cats[0]) eq 'ARRAY') {
9731: my @currcategories;
9732: if ($currcat ne '') {
9733: @currcategories = split('&',$currcat);
9734: }
1.919 raeburn 9735: my $table;
1.663 raeburn 9736: for (my $i=0; $i<@{$cats[0]}; $i++) {
9737: my $parent = $cats[0][$i];
1.919 raeburn 9738: next if ($parent eq 'instcode');
9739: if ($type eq 'Community') {
9740: next unless ($parent eq 'communities');
9741: } else {
9742: next if ($parent eq 'communities');
9743: }
1.663 raeburn 9744: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9745: my $item = &escape($parent).'::0';
9746: my $checked = '';
9747: if (@currcategories > 0) {
9748: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9749: $checked = ' checked="checked"';
1.663 raeburn 9750: }
9751: }
1.919 raeburn 9752: my $parent_title = $parent;
9753: if ($parent eq 'communities') {
9754: $parent_title = &mt('Communities');
9755: }
9756: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9757: '<input type="checkbox" name="usecategory" value="'.
9758: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9759: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9760: my $depth = 1;
9761: push(@path,$parent);
1.919 raeburn 9762: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9763: pop(@path);
1.919 raeburn 9764: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9765: $itemcount ++;
9766: }
1.919 raeburn 9767: if ($itemcount) {
9768: $output = &Apache::loncommon::start_data_table().
9769: $table.
9770: &Apache::loncommon::end_data_table();
9771: }
1.663 raeburn 9772: }
9773: }
9774: }
9775: return $output;
9776: }
9777:
9778: =pod
9779:
9780: =item *&assign_category_rows()
9781:
9782: Create a datatable row for display of nested categories in a domain,
9783: with checkboxes to allow a course to be categorized,called recursively.
9784:
9785: Inputs:
9786:
9787: itemcount - track row number for alternating colors
9788:
9789: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9790: categories and subcategories.
9791:
9792: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9793:
9794: parent - parent of current category item
9795:
9796: path - Array containing all categories back up through the hierarchy from the
9797: current category to the top level.
9798:
9799: currcategories - reference to array of current categories assigned to the course
9800:
9801: Returns: $output (markup to be displayed).
9802:
9803: =cut
9804:
9805: sub assign_category_rows {
9806: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9807: my ($text,$name,$item,$chgstr);
9808: if (ref($cats) eq 'ARRAY') {
9809: my $maxdepth = scalar(@{$cats});
9810: if (ref($cats->[$depth]) eq 'HASH') {
9811: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9812: my $numchildren = @{$cats->[$depth]{$parent}};
9813: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9814: $text .= '<td><table class="LC_datatable">';
9815: for (my $j=0; $j<$numchildren; $j++) {
9816: $name = $cats->[$depth]{$parent}[$j];
9817: $item = &escape($name).':'.&escape($parent).':'.$depth;
9818: my $deeper = $depth+1;
9819: my $checked = '';
9820: if (ref($currcategories) eq 'ARRAY') {
9821: if (@{$currcategories} > 0) {
9822: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9823: $checked = ' checked="checked"';
1.663 raeburn 9824: }
9825: }
9826: }
1.664 raeburn 9827: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9828: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9829: $item.'"'.$checked.' />'.$name.'</label></span>'.
9830: '<input type="hidden" name="catname" value="'.$name.'" />'.
9831: '</td><td>';
1.663 raeburn 9832: if (ref($path) eq 'ARRAY') {
9833: push(@{$path},$name);
9834: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9835: pop(@{$path});
9836: }
9837: $text .= '</td></tr>';
9838: }
9839: $text .= '</table></td>';
9840: }
9841: }
9842: }
9843: return $text;
9844: }
9845:
1.655 raeburn 9846: ############################################################
9847: ############################################################
9848:
9849:
1.443 albertel 9850: sub commit_customrole {
1.664 raeburn 9851: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9852: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9853: ($start?', '.&mt('starting').' '.localtime($start):'').
9854: ($end?', ending '.localtime($end):'').': <b>'.
9855: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9856: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9857: '</b><br />';
9858: return $output;
9859: }
9860:
9861: sub commit_standardrole {
1.541 raeburn 9862: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9863: my ($output,$logmsg,$linefeed);
9864: if ($context eq 'auto') {
9865: $linefeed = "\n";
9866: } else {
9867: $linefeed = "<br />\n";
9868: }
1.443 albertel 9869: if ($three eq 'st') {
1.541 raeburn 9870: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9871: $one,$two,$sec,$context);
9872: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9873: ($result eq 'unknown_course') || ($result eq 'refused')) {
9874: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9875: } else {
1.541 raeburn 9876: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9877: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9878: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9879: if ($context eq 'auto') {
9880: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9881: } else {
9882: $output .= '<b>'.$result.'</b>'.$linefeed.
9883: &mt('Add to classlist').': <b>ok</b>';
9884: }
9885: $output .= $linefeed;
1.443 albertel 9886: }
9887: } else {
9888: $output = &mt('Assigning').' '.$three.' in '.$url.
9889: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9890: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9891: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9892: if ($context eq 'auto') {
9893: $output .= $result.$linefeed;
9894: } else {
9895: $output .= '<b>'.$result.'</b>'.$linefeed;
9896: }
1.443 albertel 9897: }
9898: return $output;
9899: }
9900:
9901: sub commit_studentrole {
1.541 raeburn 9902: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9903: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9904: if ($context eq 'auto') {
9905: $linefeed = "\n";
9906: } else {
9907: $linefeed = '<br />'."\n";
9908: }
1.443 albertel 9909: if (defined($one) && defined($two)) {
9910: my $cid=$one.'_'.$two;
9911: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9912: my $secchange = 0;
9913: my $expire_role_result;
9914: my $modify_section_result;
1.628 raeburn 9915: if ($oldsec ne '-1') {
9916: if ($oldsec ne $sec) {
1.443 albertel 9917: $secchange = 1;
1.628 raeburn 9918: my $now = time;
1.443 albertel 9919: my $uurl='/'.$cid;
9920: $uurl=~s/\_/\//g;
9921: if ($oldsec) {
9922: $uurl.='/'.$oldsec;
9923: }
1.626 raeburn 9924: $oldsecurl = $uurl;
1.628 raeburn 9925: $expire_role_result =
1.652 raeburn 9926: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9927: if ($env{'request.course.sec'} ne '') {
9928: if ($expire_role_result eq 'refused') {
9929: my @roles = ('st');
9930: my @statuses = ('previous');
9931: my @roledoms = ($one);
9932: my $withsec = 1;
9933: my %roleshash =
9934: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9935: \@statuses,\@roles,\@roledoms,$withsec);
9936: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9937: my ($oldstart,$oldend) =
9938: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9939: if ($oldend > 0 && $oldend <= $now) {
9940: $expire_role_result = 'ok';
9941: }
9942: }
9943: }
9944: }
1.443 albertel 9945: $result = $expire_role_result;
9946: }
9947: }
9948: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9949: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9950: if ($modify_section_result =~ /^ok/) {
9951: if ($secchange == 1) {
1.628 raeburn 9952: if ($sec eq '') {
9953: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9954: } else {
9955: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9956: }
1.443 albertel 9957: } elsif ($oldsec eq '-1') {
1.628 raeburn 9958: if ($sec eq '') {
9959: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9960: } else {
9961: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9962: }
1.443 albertel 9963: } else {
1.628 raeburn 9964: if ($sec eq '') {
9965: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9966: } else {
9967: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9968: }
1.443 albertel 9969: }
9970: } else {
1.628 raeburn 9971: if ($secchange) {
9972: $$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;
9973: } else {
9974: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9975: }
1.443 albertel 9976: }
9977: $result = $modify_section_result;
9978: } elsif ($secchange == 1) {
1.628 raeburn 9979: if ($oldsec eq '') {
9980: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9981: } else {
9982: $$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;
9983: }
1.626 raeburn 9984: if ($expire_role_result eq 'refused') {
9985: my $newsecurl = '/'.$cid;
9986: $newsecurl =~ s/\_/\//g;
9987: if ($sec ne '') {
9988: $newsecurl.='/'.$sec;
9989: }
9990: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9991: if ($sec eq '') {
9992: $$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;
9993: } else {
9994: $$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;
9995: }
9996: }
9997: }
1.443 albertel 9998: }
9999: } else {
1.626 raeburn 10000: $$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 10001: $result = "error: incomplete course id\n";
10002: }
10003: return $result;
10004: }
10005:
10006: ############################################################
10007: ############################################################
10008:
1.566 albertel 10009: sub check_clone {
1.578 raeburn 10010: my ($args,$linefeed) = @_;
1.566 albertel 10011: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10012: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10013: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10014: my $clonemsg;
10015: my $can_clone = 0;
1.908 raeburn 10016: my $lctype = lc($args->{'type'});
10017: if ($lctype ne 'community') {
10018: $lctype = 'course';
10019: }
1.566 albertel 10020: if ($clonehome eq 'no_host') {
1.908 raeburn 10021: if ($args->{'type'} eq 'Community') {
10022: $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'});
10023: } else {
10024: $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'});
10025: }
1.566 albertel 10026: } else {
10027: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10028: if ($args->{'type'} eq 'Community') {
10029: if ($clonedesc{'type'} ne 'Community') {
10030: $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'});
10031: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10032: }
10033: }
1.882 raeburn 10034: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10035: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10036: $can_clone = 1;
10037: } else {
10038: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10039: $args->{'clonedomain'},$args->{'clonecourse'});
10040: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10041: if (grep(/^\*$/,@cloners)) {
10042: $can_clone = 1;
10043: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10044: $can_clone = 1;
10045: } else {
1.908 raeburn 10046: my $ccrole = 'cc';
10047: if ($args->{'type'} eq 'Community') {
10048: $ccrole = 'co';
10049: }
1.578 raeburn 10050: my %roleshash =
10051: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10052: $args->{'ccdomain'},
1.908 raeburn 10053: 'userroles',['active'],[$ccrole],
1.578 raeburn 10054: [$args->{'clonedomain'}]);
1.908 raeburn 10055: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10056: $can_clone = 1;
10057: } else {
1.908 raeburn 10058: if ($args->{'type'} eq 'Community') {
10059: $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'});
10060: } else {
10061: $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'});
10062: }
1.578 raeburn 10063: }
1.566 albertel 10064: }
1.578 raeburn 10065: }
1.566 albertel 10066: }
10067: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10068: }
10069:
1.444 albertel 10070: sub construct_course {
1.885 raeburn 10071: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10072: my $outcome;
1.541 raeburn 10073: my $linefeed = '<br />'."\n";
10074: if ($context eq 'auto') {
10075: $linefeed = "\n";
10076: }
1.566 albertel 10077:
10078: #
10079: # Are we cloning?
10080: #
10081: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10082: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10083: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10084: if ($context ne 'auto') {
1.578 raeburn 10085: if ($clonemsg ne '') {
10086: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10087: }
1.566 albertel 10088: }
10089: $outcome .= $clonemsg.$linefeed;
10090:
10091: if (!$can_clone) {
10092: return (0,$outcome);
10093: }
10094: }
10095:
1.444 albertel 10096: #
10097: # Open course
10098: #
10099: my $crstype = lc($args->{'crstype'});
10100: my %cenv=();
10101: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10102: $args->{'cdescr'},
10103: $args->{'curl'},
10104: $args->{'course_home'},
10105: $args->{'nonstandard'},
10106: $args->{'crscode'},
10107: $args->{'ccuname'}.':'.
10108: $args->{'ccdomain'},
1.882 raeburn 10109: $args->{'crstype'},
1.885 raeburn 10110: $cnum,$context,$category);
1.444 albertel 10111:
10112: # Note: The testing routines depend on this being output; see
10113: # Utils::Course. This needs to at least be output as a comment
10114: # if anyone ever decides to not show this, and Utils::Course::new
10115: # will need to be suitably modified.
1.541 raeburn 10116: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10117: #
10118: # Check if created correctly
10119: #
1.479 albertel 10120: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10121: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10122: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10123:
1.444 albertel 10124: #
1.566 albertel 10125: # Do the cloning
10126: #
10127: if ($can_clone && $cloneid) {
10128: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10129: if ($context ne 'auto') {
10130: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10131: }
10132: $outcome .= $clonemsg.$linefeed;
10133: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10134: # Copy all files
1.637 www 10135: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10136: # Restore URL
1.566 albertel 10137: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10138: # Restore title
1.566 albertel 10139: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10140: # Mark as cloned
1.566 albertel 10141: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10142: # Need to clone grading mode
10143: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10144: $cenv{'grading'}=$newenv{'grading'};
10145: # Do not clone these environment entries
10146: &Apache::lonnet::del('environment',
10147: ['default_enrollment_start_date',
10148: 'default_enrollment_end_date',
10149: 'question.email',
10150: 'policy.email',
10151: 'comment.email',
10152: 'pch.users.denied',
1.725 raeburn 10153: 'plc.users.denied',
10154: 'hidefromcat',
10155: 'categories'],
1.638 www 10156: $$crsudom,$$crsunum);
1.444 albertel 10157: }
1.566 albertel 10158:
1.444 albertel 10159: #
10160: # Set environment (will override cloned, if existing)
10161: #
10162: my @sections = ();
10163: my @xlists = ();
10164: if ($args->{'crstype'}) {
10165: $cenv{'type'}=$args->{'crstype'};
10166: }
10167: if ($args->{'crsid'}) {
10168: $cenv{'courseid'}=$args->{'crsid'};
10169: }
10170: if ($args->{'crscode'}) {
10171: $cenv{'internal.coursecode'}=$args->{'crscode'};
10172: }
10173: if ($args->{'crsquota'} ne '') {
10174: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10175: } else {
10176: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10177: }
10178: if ($args->{'ccuname'}) {
10179: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10180: ':'.$args->{'ccdomain'};
10181: } else {
10182: $cenv{'internal.courseowner'} = $args->{'curruser'};
10183: }
10184: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10185: if ($args->{'crssections'}) {
10186: $cenv{'internal.sectionnums'} = '';
10187: if ($args->{'crssections'} =~ m/,/) {
10188: @sections = split/,/,$args->{'crssections'};
10189: } else {
10190: $sections[0] = $args->{'crssections'};
10191: }
10192: if (@sections > 0) {
10193: foreach my $item (@sections) {
10194: my ($sec,$gp) = split/:/,$item;
10195: my $class = $args->{'crscode'}.$sec;
10196: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10197: $cenv{'internal.sectionnums'} .= $item.',';
10198: unless ($addcheck eq 'ok') {
10199: push @badclasses, $class;
10200: }
10201: }
10202: $cenv{'internal.sectionnums'} =~ s/,$//;
10203: }
10204: }
10205: # do not hide course coordinator from staff listing,
10206: # even if privileged
10207: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10208: # add crosslistings
10209: if ($args->{'crsxlist'}) {
10210: $cenv{'internal.crosslistings'}='';
10211: if ($args->{'crsxlist'} =~ m/,/) {
10212: @xlists = split/,/,$args->{'crsxlist'};
10213: } else {
10214: $xlists[0] = $args->{'crsxlist'};
10215: }
10216: if (@xlists > 0) {
10217: foreach my $item (@xlists) {
10218: my ($xl,$gp) = split/:/,$item;
10219: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10220: $cenv{'internal.crosslistings'} .= $item.',';
10221: unless ($addcheck eq 'ok') {
10222: push @badclasses, $xl;
10223: }
10224: }
10225: $cenv{'internal.crosslistings'} =~ s/,$//;
10226: }
10227: }
10228: if ($args->{'autoadds'}) {
10229: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10230: }
10231: if ($args->{'autodrops'}) {
10232: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10233: }
10234: # check for notification of enrollment changes
10235: my @notified = ();
10236: if ($args->{'notify_owner'}) {
10237: if ($args->{'ccuname'} ne '') {
10238: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10239: }
10240: }
10241: if ($args->{'notify_dc'}) {
10242: if ($uname ne '') {
1.630 raeburn 10243: push(@notified,$uname.':'.$udom);
1.444 albertel 10244: }
10245: }
10246: if (@notified > 0) {
10247: my $notifylist;
10248: if (@notified > 1) {
10249: $notifylist = join(',',@notified);
10250: } else {
10251: $notifylist = $notified[0];
10252: }
10253: $cenv{'internal.notifylist'} = $notifylist;
10254: }
10255: if (@badclasses > 0) {
10256: my %lt=&Apache::lonlocal::texthash(
10257: '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',
10258: 'dnhr' => 'does not have rights to access enrollment in these classes',
10259: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10260: );
1.541 raeburn 10261: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10262: ' ('.$lt{'adby'}.')';
10263: if ($context eq 'auto') {
10264: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10265: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10266: foreach my $item (@badclasses) {
10267: if ($context eq 'auto') {
10268: $outcome .= " - $item\n";
10269: } else {
10270: $outcome .= "<li>$item</li>\n";
10271: }
10272: }
10273: if ($context eq 'auto') {
10274: $outcome .= $linefeed;
10275: } else {
1.566 albertel 10276: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10277: }
10278: }
1.444 albertel 10279: }
10280: if ($args->{'no_end_date'}) {
10281: $args->{'endaccess'} = 0;
10282: }
10283: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10284: $cenv{'internal.autoend'}=$args->{'enrollend'};
10285: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10286: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10287: if ($args->{'showphotos'}) {
10288: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10289: }
10290: $cenv{'internal.authtype'} = $args->{'authtype'};
10291: $cenv{'internal.autharg'} = $args->{'autharg'};
10292: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10293: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10294: 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');
10295: if ($context eq 'auto') {
10296: $outcome .= $krb_msg;
10297: } else {
1.566 albertel 10298: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10299: }
10300: $outcome .= $linefeed;
1.444 albertel 10301: }
10302: }
10303: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10304: if ($args->{'setpolicy'}) {
10305: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10306: }
10307: if ($args->{'setcontent'}) {
10308: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10309: }
10310: }
10311: if ($args->{'reshome'}) {
10312: $cenv{'reshome'}=$args->{'reshome'}.'/';
10313: $cenv{'reshome'}=~s/\/+$/\//;
10314: }
10315: #
10316: # course has keyed access
10317: #
10318: if ($args->{'setkeys'}) {
10319: $cenv{'keyaccess'}='yes';
10320: }
10321: # if specified, key authority is not course, but user
10322: # only active if keyaccess is yes
10323: if ($args->{'keyauth'}) {
1.487 albertel 10324: my ($user,$domain) = split(':',$args->{'keyauth'});
10325: $user = &LONCAPA::clean_username($user);
10326: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10327: if ($user ne '' && $domain ne '') {
1.487 albertel 10328: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10329: }
10330: }
10331:
10332: if ($args->{'disresdis'}) {
10333: $cenv{'pch.roles.denied'}='st';
10334: }
10335: if ($args->{'disablechat'}) {
10336: $cenv{'plc.roles.denied'}='st';
10337: }
10338:
10339: # Record we've not yet viewed the Course Initialization Helper for this
10340: # course
10341: $cenv{'course.helper.not.run'} = 1;
10342: #
10343: # Use new Randomseed
10344: #
10345: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10346: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10347: #
10348: # The encryption code and receipt prefix for this course
10349: #
10350: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10351: $cenv{'internal.encpref'}=100+int(9*rand(99));
10352: #
10353: # By default, use standard grading
10354: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10355:
1.541 raeburn 10356: $outcome .= $linefeed.&mt('Setting environment').': '.
10357: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10358: #
10359: # Open all assignments
10360: #
10361: if ($args->{'openall'}) {
10362: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10363: my %storecontent = ($storeunder => time,
10364: $storeunder.'.type' => 'date_start');
10365:
10366: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10367: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10368: }
10369: #
10370: # Set first page
10371: #
10372: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10373: || ($cloneid)) {
1.445 albertel 10374: use LONCAPA::map;
1.444 albertel 10375: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10376:
10377: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10378: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10379:
1.444 albertel 10380: $outcome .= ($fatal?$errtext:'read ok').' - ';
10381: my $title; my $url;
10382: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10383: $title=&mt('Syllabus');
1.444 albertel 10384: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10385: } else {
1.690 bisitz 10386: $title=&mt('Navigate Contents');
1.444 albertel 10387: $url='/adm/navmaps';
10388: }
1.445 albertel 10389:
10390: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10391: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10392:
10393: if ($errtext) { $fatal=2; }
1.541 raeburn 10394: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10395: }
1.566 albertel 10396:
10397: return (1,$outcome);
1.444 albertel 10398: }
10399:
10400: ############################################################
10401: ############################################################
10402:
1.378 raeburn 10403: sub course_type {
10404: my ($cid) = @_;
10405: if (!defined($cid)) {
10406: $cid = $env{'request.course.id'};
10407: }
1.404 albertel 10408: if (defined($env{'course.'.$cid.'.type'})) {
10409: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10410: } else {
10411: return 'Course';
1.377 raeburn 10412: }
10413: }
1.156 albertel 10414:
1.406 raeburn 10415: sub group_term {
10416: my $crstype = &course_type();
10417: my %names = (
10418: 'Course' => 'group',
1.865 raeburn 10419: 'Community' => 'group',
1.406 raeburn 10420: );
10421: return $names{$crstype};
10422: }
10423:
1.902 raeburn 10424: sub course_types {
10425: my @types = ('official','unofficial','community');
10426: my %typename = (
10427: official => 'Official course',
10428: unofficial => 'Unofficial course',
10429: community => 'Community',
10430: );
10431: return (\@types,\%typename);
10432: }
10433:
1.156 albertel 10434: sub icon {
10435: my ($file)=@_;
1.505 albertel 10436: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10437: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10438: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10439: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10440: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10441: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10442: $curfext.".gif") {
10443: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10444: $curfext.".gif";
10445: }
10446: }
1.249 albertel 10447: return &lonhttpdurl($iconname);
1.154 albertel 10448: }
1.84 albertel 10449:
1.575 albertel 10450: sub lonhttpdurl {
1.692 www 10451: #
10452: # Had been used for "small fry" static images on separate port 8080.
10453: # Modify here if lightweight http functionality desired again.
10454: # Currently eliminated due to increasing firewall issues.
10455: #
1.575 albertel 10456: my ($url)=@_;
1.692 www 10457: return $url;
1.215 albertel 10458: }
10459:
1.213 albertel 10460: sub connection_aborted {
10461: my ($r)=@_;
10462: $r->print(" ");$r->rflush();
10463: my $c = $r->connection;
10464: return $c->aborted();
10465: }
10466:
1.221 foxr 10467: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10468: # strings as 'strings'.
10469: sub escape_single {
1.221 foxr 10470: my ($input) = @_;
1.223 albertel 10471: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10472: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10473: return $input;
10474: }
1.223 albertel 10475:
1.222 foxr 10476: # Same as escape_single, but escape's "'s This
10477: # can be used for "strings"
10478: sub escape_double {
10479: my ($input) = @_;
10480: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10481: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10482: return $input;
10483: }
1.223 albertel 10484:
1.222 foxr 10485: # Escapes the last element of a full URL.
10486: sub escape_url {
10487: my ($url) = @_;
1.238 raeburn 10488: my @urlslices = split(/\//, $url,-1);
1.369 www 10489: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10490: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10491: }
1.462 albertel 10492:
1.820 raeburn 10493: sub compare_arrays {
10494: my ($arrayref1,$arrayref2) = @_;
10495: my (@difference,%count);
10496: @difference = ();
10497: %count = ();
10498: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10499: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10500: foreach my $element (keys(%count)) {
10501: if ($count{$element} == 1) {
10502: push(@difference,$element);
10503: }
10504: }
10505: }
10506: return @difference;
10507: }
10508:
1.817 bisitz 10509: # -------------------------------------------------------- Initialize user login
1.462 albertel 10510: sub init_user_environment {
1.463 albertel 10511: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10512: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10513:
10514: my $public=($username eq 'public' && $domain eq 'public');
10515:
10516: # See if old ID present, if so, remove
10517:
10518: my ($filename,$cookie,$userroles);
10519: my $now=time;
10520:
10521: if ($public) {
10522: my $max_public=100;
10523: my $oldest;
10524: my $oldest_time=0;
10525: for(my $next=1;$next<=$max_public;$next++) {
10526: if (-e $lonids."/publicuser_$next.id") {
10527: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10528: if ($mtime<$oldest_time || !$oldest_time) {
10529: $oldest_time=$mtime;
10530: $oldest=$next;
10531: }
10532: } else {
10533: $cookie="publicuser_$next";
10534: last;
10535: }
10536: }
10537: if (!$cookie) { $cookie="publicuser_$oldest"; }
10538: } else {
1.463 albertel 10539: # if this isn't a robot, kill any existing non-robot sessions
10540: if (!$args->{'robot'}) {
10541: opendir(DIR,$lonids);
10542: while ($filename=readdir(DIR)) {
10543: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10544: unlink($lonids.'/'.$filename);
10545: }
1.462 albertel 10546: }
1.463 albertel 10547: closedir(DIR);
1.462 albertel 10548: }
10549: # Give them a new cookie
1.463 albertel 10550: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10551: : $now.$$.int(rand(10000)));
1.463 albertel 10552: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10553:
10554: # Initialize roles
10555:
10556: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10557: }
10558: # ------------------------------------ Check browser type and MathML capability
10559:
10560: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10561: $clientunicode,$clientos) = &decode_user_agent($r);
10562:
10563: # ------------------------------------------------------------- Get environment
10564:
10565: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10566: my ($tmp) = keys(%userenv);
10567: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10568: # default remote control to off
10569: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10570: } else {
10571: undef(%userenv);
10572: }
10573: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10574: $form->{'interface'}=$userenv{'interface'};
10575: }
10576: $env{'environment.remote'}=$userenv{'remote'};
10577: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10578:
10579: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10580: foreach my $option ('interface','localpath','localres') {
10581: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10582: }
10583: # --------------------------------------------------------- Write first profile
10584:
10585: {
10586: my %initial_env =
10587: ("user.name" => $username,
10588: "user.domain" => $domain,
10589: "user.home" => $authhost,
10590: "browser.type" => $clientbrowser,
10591: "browser.version" => $clientversion,
10592: "browser.mathml" => $clientmathml,
10593: "browser.unicode" => $clientunicode,
10594: "browser.os" => $clientos,
10595: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10596: "request.course.fn" => '',
10597: "request.course.uri" => '',
10598: "request.course.sec" => '',
10599: "request.role" => 'cm',
10600: "request.role.adv" => $env{'user.adv'},
10601: "request.host" => $ENV{'REMOTE_ADDR'},);
10602:
10603: if ($form->{'localpath'}) {
10604: $initial_env{"browser.localpath"} = $form->{'localpath'};
10605: $initial_env{"browser.localres"} = $form->{'localres'};
10606: }
10607:
10608: if ($public) {
10609: $initial_env{"environment.remote"} = "off";
10610: }
10611: if ($form->{'interface'}) {
10612: $form->{'interface'}=~s/\W//gs;
10613: $initial_env{"browser.interface"} = $form->{'interface'};
10614: $env{'browser.interface'}=$form->{'interface'};
10615: }
10616:
1.724 raeburn 10617: foreach my $tool ('aboutme','blog','portfolio') {
10618: $userenv{'availabletools.'.$tool} =
10619: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10620: }
10621:
1.864 raeburn 10622: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10623: $userenv{'canrequest.'.$crstype} =
10624: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10625: 'reload','requestcourses');
10626: }
10627:
1.462 albertel 10628: $env{'user.environment'} = "$lonids/$cookie.id";
10629:
10630: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10631: &GDBM_WRCREAT(),0640)) {
10632: &_add_to_env(\%disk_env,\%initial_env);
10633: &_add_to_env(\%disk_env,\%userenv,'environment.');
10634: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10635: if (ref($args->{'extra_env'})) {
10636: &_add_to_env(\%disk_env,$args->{'extra_env'});
10637: }
1.462 albertel 10638: untie(%disk_env);
10639: } else {
1.705 tempelho 10640: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10641: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10642: return 'error: '.$!;
10643: }
10644: }
10645: $env{'request.role'}='cm';
10646: $env{'request.role.adv'}=$env{'user.adv'};
10647: $env{'browser.type'}=$clientbrowser;
10648:
10649: return $cookie;
10650:
10651: }
10652:
10653: sub _add_to_env {
10654: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10655: if (ref($env_data) eq 'HASH') {
10656: while (my ($key,$value) = each(%$env_data)) {
10657: $idf->{$prefix.$key} = $value;
10658: $env{$prefix.$key} = $value;
10659: }
1.462 albertel 10660: }
10661: }
10662:
1.685 tempelho 10663: # --- Get the symbolic name of a problem and the url
10664: sub get_symb {
10665: my ($request,$silent) = @_;
1.726 raeburn 10666: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10667: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10668: if ($symb eq '') {
10669: if (!$silent) {
10670: $request->print("Unable to handle ambiguous references:$url:.");
10671: return ();
10672: }
10673: }
10674: &Apache::lonenc::check_decrypt(\$symb);
10675: return ($symb);
10676: }
10677:
10678: # --------------------------------------------------------------Get annotation
10679:
10680: sub get_annotation {
10681: my ($symb,$enc) = @_;
10682:
10683: my $key = $symb;
10684: if (!$enc) {
10685: $key =
10686: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10687: }
10688: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10689: return $annotation{$key};
10690: }
10691:
10692: sub clean_symb {
1.731 raeburn 10693: my ($symb,$delete_enc) = @_;
1.685 tempelho 10694:
10695: &Apache::lonenc::check_decrypt(\$symb);
10696: my $enc = $env{'request.enc'};
1.731 raeburn 10697: if ($delete_enc) {
1.730 raeburn 10698: delete($env{'request.enc'});
10699: }
1.685 tempelho 10700:
10701: return ($symb,$enc);
10702: }
1.462 albertel 10703:
1.41 ng 10704: =pod
10705:
10706: =back
10707:
1.112 bowersj2 10708: =cut
1.41 ng 10709:
1.112 bowersj2 10710: 1;
10711: __END__;
1.41 ng 10712:
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