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