Annotation of loncom/interface/loncommon.pm, revision 1.925.2.4
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.925.2.4! raeburn 4: # $Id: loncommon.pm,v 1.925.2.3 2009/12/08 05:00:15 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
486: my $wintitle = &mt('Course Browser');
487: if ($crstype ne '') {
488: $wintitle = &mt($crstype);
489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 1130: .' title="'.$title.'"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1722: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1723: "This error has been logged. ".
1724: "Please alert your LON-CAPA administrator").
1725: '</p>');
1726: return (undef);
1727: }
1728: #
1729: $workbook->set_tempdir('/home/httpd/perl/tmp');
1730: #
1731: my $format = &Apache::loncommon::define_excel_formats($workbook);
1732: return ($workbook,$filename,$format);
1733: }
1734:
1735: ###############################################################
1736: ###############################################################
1737:
1738: =pod
1739:
1.648 raeburn 1740: =item * &create_text_file()
1.113 bowersj2 1741:
1.542 raeburn 1742: Create a file to write to and eventually make available to the user.
1.256 matthew 1743: If file creation fails, outputs an error message on the request object and
1744: return undefs.
1.113 bowersj2 1745:
1.256 matthew 1746: Inputs: Apache request object, and file suffix
1.113 bowersj2 1747:
1.256 matthew 1748: Returns (undef) on failure,
1749: Filehandle and filename on success.
1.113 bowersj2 1750:
1751: =cut
1752:
1.256 matthew 1753: ###############################################################
1754: ###############################################################
1755: sub create_text_file {
1756: my ($r,$suffix) = @_;
1757: if (! defined($suffix)) { $suffix = 'txt'; };
1758: my $fh;
1759: my $filename = '/prtspool/'.
1.258 albertel 1760: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1761: time.'_'.rand(1000000000).'.'.$suffix;
1762: $fh = Apache::File->new('>/home/httpd'.$filename);
1763: if (! defined($fh)) {
1764: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1765: $r->print(&mt('Problems occurred in creating the output file. '
1766: .'This error has been logged. '
1767: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1768: }
1.256 matthew 1769: return ($fh,$filename)
1.113 bowersj2 1770: }
1771:
1772:
1.256 matthew 1773: =pod
1.113 bowersj2 1774:
1775: =back
1776:
1777: =cut
1.37 matthew 1778:
1779: ###############################################################
1.33 matthew 1780: ## Home server <option> list generating code ##
1781: ###############################################################
1.35 matthew 1782:
1.169 www 1783: # ------------------------------------------
1784:
1785: sub domain_select {
1786: my ($name,$value,$multiple)=@_;
1787: my %domains=map {
1.514 albertel 1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1789: } &Apache::lonnet::all_domains();
1.169 www 1790: if ($multiple) {
1791: $domains{''}=&mt('Any domain');
1.550 albertel 1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1793: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1794: } else {
1.550 albertel 1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1796: return &select_form($name,$value,%domains);
1797: }
1798: }
1799:
1.282 albertel 1800: #-------------------------------------------
1801:
1802: =pod
1803:
1.519 raeburn 1804: =head1 Routines for form select boxes
1805:
1806: =over 4
1807:
1.648 raeburn 1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1809:
1810: Returns a string containing a <select> element int multiple mode
1811:
1812:
1813: Args:
1814: $name - name of the <select> element
1.506 raeburn 1815: $value - scalar or array ref of values that should already be selected
1.282 albertel 1816: $size - number of rows long the select element is
1.283 albertel 1817: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1818: (shown text should already have been &mt())
1.506 raeburn 1819: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1820:
1.282 albertel 1821: =cut
1822:
1823: #-------------------------------------------
1.169 www 1824: sub multiple_select_form {
1.284 albertel 1825: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1827: my $output='';
1.191 matthew 1828: if (! defined($size)) {
1829: $size = 4;
1.283 albertel 1830: if (scalar(keys(%$hash))<4) {
1831: $size = scalar(keys(%$hash));
1.191 matthew 1832: }
1833: }
1.734 bisitz 1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1835: my @order;
1.506 raeburn 1836: if (ref($order) eq 'ARRAY') {
1837: @order = @{$order};
1838: } else {
1839: @order = sort(keys(%$hash));
1.501 banghart 1840: }
1841: if (exists($$hash{'select_form_order'})) {
1842: @order = @{$$hash{'select_form_order'}};
1843: }
1844:
1.284 albertel 1845: foreach my $key (@order) {
1.356 albertel 1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1847: $output.='selected="selected" ' if ($selected{$key});
1848: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1849: }
1850: $output.="</select>\n";
1851: return $output;
1852: }
1853:
1.88 www 1854: #-------------------------------------------
1855:
1856: =pod
1857:
1.648 raeburn 1858: =item * &select_form($defdom,$name,%hash)
1.88 www 1859:
1860: Returns a string containing a <select name='$name' size='1'> form to
1861: allow a user to select options from a hash option_name => displayed text.
1862: See lonrights.pm for an example invocation and use.
1863:
1864: =cut
1865:
1866: #-------------------------------------------
1867: sub select_form {
1868: my ($def,$name,%hash) = @_;
1869: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1870: my @keys;
1871: if (exists($hash{'select_form_order'})) {
1872: @keys=@{$hash{'select_form_order'}};
1873: } else {
1874: @keys=sort(keys(%hash));
1875: }
1.356 albertel 1876: foreach my $key (@keys) {
1877: $selectform.=
1878: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1879: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1880: ">".$hash{$key}."</option>\n";
1.88 www 1881: }
1882: $selectform.="</select>";
1883: return $selectform;
1884: }
1885:
1.475 www 1886: # For display filters
1887:
1888: sub display_filter {
1889: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1890: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1891: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1892: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1893: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1894: '</label></span> <span class="LC_nobreak">'.
1.475 www 1895: &mt('Filter [_1]',
1.477 www 1896: &select_form($env{'form.displayfilter'},
1897: 'displayfilter',
1898: ('currentfolder' => 'Current folder/page',
1899: 'containing' => 'Containing phrase',
1900: 'none' => 'None'))).
1.714 bisitz 1901: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1902: }
1903:
1.167 www 1904: sub gradeleveldescription {
1905: my $gradelevel=shift;
1906: my %gradelevels=(0 => 'Not specified',
1907: 1 => 'Grade 1',
1908: 2 => 'Grade 2',
1909: 3 => 'Grade 3',
1910: 4 => 'Grade 4',
1911: 5 => 'Grade 5',
1912: 6 => 'Grade 6',
1913: 7 => 'Grade 7',
1914: 8 => 'Grade 8',
1915: 9 => 'Grade 9',
1916: 10 => 'Grade 10',
1917: 11 => 'Grade 11',
1918: 12 => 'Grade 12',
1919: 13 => 'Grade 13',
1920: 14 => '100 Level',
1921: 15 => '200 Level',
1922: 16 => '300 Level',
1923: 17 => '400 Level',
1924: 18 => 'Graduate Level');
1925: return &mt($gradelevels{$gradelevel});
1926: }
1927:
1.163 www 1928: sub select_level_form {
1929: my ($deflevel,$name)=@_;
1930: unless ($deflevel) { $deflevel=0; }
1.167 www 1931: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1932: for (my $i=0; $i<=18; $i++) {
1933: $selectform.="<option value=\"$i\" ".
1.253 albertel 1934: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1935: ">".&gradeleveldescription($i)."</option>\n";
1936: }
1937: $selectform.="</select>";
1938: return $selectform;
1.163 www 1939: }
1.167 www 1940:
1.35 matthew 1941: #-------------------------------------------
1942:
1.45 matthew 1943: =pod
1944:
1.910 raeburn 1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1946:
1947: Returns a string containing a <select name='$name' size='1'> form to
1948: allow a user to select the domain to preform an operation in.
1949: See loncreateuser.pm for an example invocation and use.
1950:
1.90 www 1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
1952: selected");
1953:
1.743 raeburn 1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1955:
1.910 raeburn 1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1957:
1958: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1959:
1.35 matthew 1960: =cut
1961:
1962: #-------------------------------------------
1.34 matthew 1963: sub select_dom_form {
1.910 raeburn 1964: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1965: if ($onchange) {
1.874 raeburn 1966: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1967: }
1.910 raeburn 1968: my @domains;
1969: if (ref($incdoms) eq 'ARRAY') {
1970: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1971: } else {
1972: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1973: }
1.90 www 1974: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1975: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1976: foreach my $dom (@domains) {
1977: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1978: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1979: if ($showdomdesc) {
1980: if ($dom ne '') {
1981: my $domdesc = &Apache::lonnet::domain($dom,'description');
1982: if ($domdesc ne '') {
1983: $selectdomain .= ' ('.$domdesc.')';
1984: }
1985: }
1986: }
1987: $selectdomain .= "</option>\n";
1.34 matthew 1988: }
1989: $selectdomain.="</select>";
1990: return $selectdomain;
1991: }
1992:
1.35 matthew 1993: #-------------------------------------------
1994:
1.45 matthew 1995: =pod
1996:
1.648 raeburn 1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1998:
1.586 raeburn 1999: input: 4 arguments (two required, two optional) -
2000: $domain - domain of new user
2001: $name - name of form element
2002: $default - Value of 'default' causes a default item to be first
2003: option, and selected by default.
2004: $hide - Value of 'hide' causes hiding of the name of the server,
2005: if 1 server found, or default, if 0 found.
1.594 raeburn 2006: output: returns 2 items:
1.586 raeburn 2007: (a) form element which contains either:
2008: (i) <select name="$name">
2009: <option value="$hostid1">$hostid $servers{$hostid}</option>
2010: <option value="$hostid2">$hostid $servers{$hostid}</option>
2011: </select>
2012: form item if there are multiple library servers in $domain, or
2013: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2014: if there is only one library server in $domain.
2015:
2016: (b) number of library servers found.
2017:
2018: See loncreateuser.pm for example of use.
1.35 matthew 2019:
2020: =cut
2021:
2022: #-------------------------------------------
1.586 raeburn 2023: sub home_server_form_item {
2024: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2025: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2026: my $result;
2027: my $numlib = keys(%servers);
2028: if ($numlib > 1) {
2029: $result .= '<select name="'.$name.'" />'."\n";
2030: if ($default) {
1.804 bisitz 2031: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2032: '</option>'."\n";
2033: }
2034: foreach my $hostid (sort(keys(%servers))) {
2035: $result.= '<option value="'.$hostid.'">'.
2036: $hostid.' '.$servers{$hostid}."</option>\n";
2037: }
2038: $result .= '</select>'."\n";
2039: } elsif ($numlib == 1) {
2040: my $hostid;
2041: foreach my $item (keys(%servers)) {
2042: $hostid = $item;
2043: }
2044: $result .= '<input type="hidden" name="'.$name.'" value="'.
2045: $hostid.'" />';
2046: if (!$hide) {
2047: $result .= $hostid.' '.$servers{$hostid};
2048: }
2049: $result .= "\n";
2050: } elsif ($default) {
2051: $result .= '<input type="hidden" name="'.$name.
2052: '" value="default" />';
2053: if (!$hide) {
2054: $result .= &mt('default');
2055: }
2056: $result .= "\n";
1.33 matthew 2057: }
1.586 raeburn 2058: return ($result,$numlib);
1.33 matthew 2059: }
1.112 bowersj2 2060:
2061: =pod
2062:
1.534 albertel 2063: =back
2064:
1.112 bowersj2 2065: =cut
1.87 matthew 2066:
2067: ###############################################################
1.112 bowersj2 2068: ## Decoding User Agent ##
1.87 matthew 2069: ###############################################################
2070:
2071: =pod
2072:
1.112 bowersj2 2073: =head1 Decoding the User Agent
2074:
2075: =over 4
2076:
2077: =item * &decode_user_agent()
1.87 matthew 2078:
2079: Inputs: $r
2080:
2081: Outputs:
2082:
2083: =over 4
2084:
1.112 bowersj2 2085: =item * $httpbrowser
1.87 matthew 2086:
1.112 bowersj2 2087: =item * $clientbrowser
1.87 matthew 2088:
1.112 bowersj2 2089: =item * $clientversion
1.87 matthew 2090:
1.112 bowersj2 2091: =item * $clientmathml
1.87 matthew 2092:
1.112 bowersj2 2093: =item * $clientunicode
1.87 matthew 2094:
1.112 bowersj2 2095: =item * $clientos
1.87 matthew 2096:
2097: =back
2098:
1.157 matthew 2099: =back
2100:
1.87 matthew 2101: =cut
2102:
2103: ###############################################################
2104: ###############################################################
2105: sub decode_user_agent {
1.247 albertel 2106: my ($r)=@_;
1.87 matthew 2107: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2108: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2109: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2110: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2111: my $clientbrowser='unknown';
2112: my $clientversion='0';
2113: my $clientmathml='';
2114: my $clientunicode='0';
2115: for (my $i=0;$i<=$#browsertype;$i++) {
2116: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2117: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2118: $clientbrowser=$bname;
2119: $httpbrowser=~/$vreg/i;
2120: $clientversion=$1;
2121: $clientmathml=($clientversion>=$minv);
2122: $clientunicode=($clientversion>=$univ);
2123: }
2124: }
2125: my $clientos='unknown';
2126: if (($httpbrowser=~/linux/i) ||
2127: ($httpbrowser=~/unix/i) ||
2128: ($httpbrowser=~/ux/i) ||
2129: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2130: if (($httpbrowser=~/vax/i) ||
2131: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2132: if ($httpbrowser=~/next/i) { $clientos='next'; }
2133: if (($httpbrowser=~/mac/i) ||
2134: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2135: if ($httpbrowser=~/win/i) { $clientos='win'; }
2136: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2137: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2138: $clientunicode,$clientos,);
2139: }
2140:
1.32 matthew 2141: ###############################################################
2142: ## Authentication changing form generation subroutines ##
2143: ###############################################################
2144: ##
2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
2146: ## hash, and have reasonable default values.
2147: ##
2148: ## formname = the name given in the <form> tag.
1.35 matthew 2149: #-------------------------------------------
2150:
1.45 matthew 2151: =pod
2152:
1.112 bowersj2 2153: =head1 Authentication Routines
2154:
2155: =over 4
2156:
1.648 raeburn 2157: =item * &authform_xxxxxx()
1.35 matthew 2158:
2159: The authform_xxxxxx subroutines provide javascript and html forms which
2160: handle some of the conveniences required for authentication forms.
2161: This is not an optimal method, but it works.
2162:
2163: =over 4
2164:
1.112 bowersj2 2165: =item * authform_header
1.35 matthew 2166:
1.112 bowersj2 2167: =item * authform_authorwarning
1.35 matthew 2168:
1.112 bowersj2 2169: =item * authform_nochange
1.35 matthew 2170:
1.112 bowersj2 2171: =item * authform_kerberos
1.35 matthew 2172:
1.112 bowersj2 2173: =item * authform_internal
1.35 matthew 2174:
1.112 bowersj2 2175: =item * authform_filesystem
1.35 matthew 2176:
2177: =back
2178:
1.648 raeburn 2179: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2180:
1.35 matthew 2181: =cut
2182:
2183: #-------------------------------------------
1.32 matthew 2184: sub authform_header{
2185: my %in = (
2186: formname => 'cu',
1.80 albertel 2187: kerb_def_dom => '',
1.32 matthew 2188: @_,
2189: );
2190: $in{'formname'} = 'document.' . $in{'formname'};
2191: my $result='';
1.80 albertel 2192:
2193: #---------------------------------------------- Code for upper case translation
2194: my $Javascript_toUpperCase;
2195: unless ($in{kerb_def_dom}) {
2196: $Javascript_toUpperCase =<<"END";
2197: switch (choice) {
2198: case 'krb': currentform.elements[choicearg].value =
2199: currentform.elements[choicearg].value.toUpperCase();
2200: break;
2201: default:
2202: }
2203: END
2204: } else {
2205: $Javascript_toUpperCase = "";
2206: }
2207:
1.165 raeburn 2208: my $radioval = "'nochange'";
1.591 raeburn 2209: if (defined($in{'curr_authtype'})) {
2210: if ($in{'curr_authtype'} ne '') {
2211: $radioval = "'".$in{'curr_authtype'}."arg'";
2212: }
1.174 matthew 2213: }
1.165 raeburn 2214: my $argfield = 'null';
1.591 raeburn 2215: if (defined($in{'mode'})) {
1.165 raeburn 2216: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2217: if (defined($in{'curr_autharg'})) {
2218: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2219: $argfield = "'$in{'curr_autharg'}'";
2220: }
2221: }
2222: }
2223: }
2224:
1.32 matthew 2225: $result.=<<"END";
2226: var current = new Object();
1.165 raeburn 2227: current.radiovalue = $radioval;
2228: current.argfield = $argfield;
1.32 matthew 2229:
2230: function changed_radio(choice,currentform) {
2231: var choicearg = choice + 'arg';
2232: // If a radio button in changed, we need to change the argfield
2233: if (current.radiovalue != choice) {
2234: current.radiovalue = choice;
2235: if (current.argfield != null) {
2236: currentform.elements[current.argfield].value = '';
2237: }
2238: if (choice == 'nochange') {
2239: current.argfield = null;
2240: } else {
2241: current.argfield = choicearg;
2242: switch(choice) {
2243: case 'krb':
2244: currentform.elements[current.argfield].value =
2245: "$in{'kerb_def_dom'}";
2246: break;
2247: default:
2248: break;
2249: }
2250: }
2251: }
2252: return;
2253: }
1.22 www 2254:
1.32 matthew 2255: function changed_text(choice,currentform) {
2256: var choicearg = choice + 'arg';
2257: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2258: $Javascript_toUpperCase
1.32 matthew 2259: // clear old field
2260: if ((current.argfield != choicearg) && (current.argfield != null)) {
2261: currentform.elements[current.argfield].value = '';
2262: }
2263: current.argfield = choicearg;
2264: }
2265: set_auth_radio_buttons(choice,currentform);
2266: return;
1.20 www 2267: }
1.32 matthew 2268:
2269: function set_auth_radio_buttons(newvalue,currentform) {
2270: var i=0;
2271: while (i < currentform.login.length) {
2272: if (currentform.login[i].value == newvalue) { break; }
2273: i++;
2274: }
2275: if (i == currentform.login.length) {
2276: return;
2277: }
2278: current.radiovalue = newvalue;
2279: currentform.login[i].checked = true;
2280: return;
2281: }
2282: END
2283: return $result;
2284: }
2285:
2286: sub authform_authorwarning{
2287: my $result='';
1.144 matthew 2288: $result='<i>'.
2289: &mt('As a general rule, only authors or co-authors should be '.
2290: 'filesystem authenticated '.
2291: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2292: return $result;
2293: }
2294:
2295: sub authform_nochange{
2296: my %in = (
2297: formname => 'document.cu',
2298: kerb_def_dom => 'MSU.EDU',
2299: @_,
2300: );
1.586 raeburn 2301: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2302: my $result;
2303: if (keys(%can_assign) == 0) {
2304: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2305: } else {
2306: $result = '<label>'.&mt('[_1] Do not change login data',
2307: '<input type="radio" name="login" value="nochange" '.
2308: 'checked="checked" onclick="'.
1.281 albertel 2309: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2310: '</label>';
1.586 raeburn 2311: }
1.32 matthew 2312: return $result;
2313: }
2314:
1.591 raeburn 2315: sub authform_kerberos {
1.32 matthew 2316: my %in = (
2317: formname => 'document.cu',
2318: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2319: kerb_def_auth => 'krb4',
1.32 matthew 2320: @_,
2321: );
1.586 raeburn 2322: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2323: $autharg,$jscall);
2324: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2325: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2326: $check5 = ' checked="checked"';
1.80 albertel 2327: } else {
1.772 bisitz 2328: $check4 = ' checked="checked"';
1.80 albertel 2329: }
1.165 raeburn 2330: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2331: if (defined($in{'curr_authtype'})) {
2332: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2333: $krbcheck = ' checked="checked"';
1.623 raeburn 2334: if (defined($in{'mode'})) {
2335: if ($in{'mode'} eq 'modifyuser') {
2336: $krbcheck = '';
2337: }
2338: }
1.591 raeburn 2339: if (defined($in{'curr_kerb_ver'})) {
2340: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2341: $check5 = ' checked="checked"';
1.591 raeburn 2342: $check4 = '';
2343: } else {
1.772 bisitz 2344: $check4 = ' checked="checked"';
1.591 raeburn 2345: $check5 = '';
2346: }
1.586 raeburn 2347: }
1.591 raeburn 2348: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2349: $krbarg = $in{'curr_autharg'};
2350: }
1.586 raeburn 2351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2352: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2353: $result =
2354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2355: $in{'curr_autharg'},$krbver);
2356: } else {
2357: $result =
2358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2359: }
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
1.784 bisitz 2365: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2366: }
2367: }
1.586 raeburn 2368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2369: return;
1.587 raeburn 2370: } elsif ($authtype eq '') {
1.591 raeburn 2371: if (defined($in{'mode'})) {
1.587 raeburn 2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
1.784 bisitz 2374: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2375: }
2376: }
2377: }
1.586 raeburn 2378: }
2379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="krb" '.
2382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2383: $krbcheck.' />';
2384: }
2385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2387: $in{'curr_authtype'} eq 'krb5') ||
2388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2389: $in{'curr_authtype'} eq 'krb4')) {
2390: $result .= &mt
1.144 matthew 2391: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2392: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2393: '<label>'.$authtype,
1.281 albertel 2394: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2395: 'value="'.$krbarg.'" '.
1.144 matthew 2396: 'onchange="'.$jscall.'" />',
1.281 albertel 2397: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2399: '</label>');
1.586 raeburn 2400: } elsif ($can_assign{'krb4'}) {
2401: $result .= &mt
2402: ('[_1] Kerberos authenticated with domain [_2] '.
2403: '[_3] Version 4 [_4]',
2404: '<label>'.$authtype,
2405: '</label><input type="text" size="10" name="krbarg" '.
2406: 'value="'.$krbarg.'" '.
2407: 'onchange="'.$jscall.'" />',
2408: '<label><input type="hidden" name="krbver" value="4" />',
2409: '</label>');
2410: } elsif ($can_assign{'krb5'}) {
2411: $result .= &mt
2412: ('[_1] Kerberos authenticated with domain [_2] '.
2413: '[_3] Version 5 [_4]',
2414: '<label>'.$authtype,
2415: '</label><input type="text" size="10" name="krbarg" '.
2416: 'value="'.$krbarg.'" '.
2417: 'onchange="'.$jscall.'" />',
2418: '<label><input type="hidden" name="krbver" value="5" />',
2419: '</label>');
2420: }
1.32 matthew 2421: return $result;
2422: }
2423:
2424: sub authform_internal{
1.586 raeburn 2425: my %in = (
1.32 matthew 2426: formname => 'document.cu',
2427: kerb_def_dom => 'MSU.EDU',
2428: @_,
2429: );
1.586 raeburn 2430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2432: if (defined($in{'curr_authtype'})) {
2433: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2434: if ($can_assign{'int'}) {
1.772 bisitz 2435: $intcheck = 'checked="checked" ';
1.623 raeburn 2436: if (defined($in{'mode'})) {
2437: if ($in{'mode'} eq 'modifyuser') {
2438: $intcheck = '';
2439: }
2440: }
1.591 raeburn 2441: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2442: $intarg = $in{'curr_autharg'};
2443: }
2444: } else {
2445: $result = &mt('Currently internally authenticated.');
2446: return $result;
1.165 raeburn 2447: }
2448: }
1.586 raeburn 2449: } else {
2450: if ($authnum == 1) {
1.784 bisitz 2451: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2452: }
2453: }
2454: if (!$can_assign{'int'}) {
2455: return;
1.587 raeburn 2456: } elsif ($authtype eq '') {
1.591 raeburn 2457: if (defined($in{'mode'})) {
1.587 raeburn 2458: if ($in{'mode'} eq 'modifycourse') {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2461: }
2462: }
2463: }
1.165 raeburn 2464: }
1.586 raeburn 2465: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2466: if ($authtype eq '') {
2467: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2468: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2469: }
1.605 bisitz 2470: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2471: $intarg.'" onchange="'.$jscall.'" />';
2472: $result = &mt
1.144 matthew 2473: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2474: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2475: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2476: return $result;
2477: }
2478:
2479: sub authform_local{
2480: my %in = (
2481: formname => 'document.cu',
2482: kerb_def_dom => 'MSU.EDU',
2483: @_,
2484: );
1.586 raeburn 2485: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2486: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2487: if (defined($in{'curr_authtype'})) {
2488: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2489: if ($can_assign{'loc'}) {
1.772 bisitz 2490: $loccheck = 'checked="checked" ';
1.623 raeburn 2491: if (defined($in{'mode'})) {
2492: if ($in{'mode'} eq 'modifyuser') {
2493: $loccheck = '';
2494: }
2495: }
1.591 raeburn 2496: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2497: $locarg = $in{'curr_autharg'};
2498: }
2499: } else {
2500: $result = &mt('Currently using local (institutional) authentication.');
2501: return $result;
1.165 raeburn 2502: }
2503: }
1.586 raeburn 2504: } else {
2505: if ($authnum == 1) {
1.784 bisitz 2506: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2507: }
2508: }
2509: if (!$can_assign{'loc'}) {
2510: return;
1.587 raeburn 2511: } elsif ($authtype eq '') {
1.591 raeburn 2512: if (defined($in{'mode'})) {
1.587 raeburn 2513: if ($in{'mode'} eq 'modifycourse') {
2514: if ($authnum == 1) {
1.784 bisitz 2515: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2516: }
2517: }
2518: }
1.165 raeburn 2519: }
1.586 raeburn 2520: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2521: if ($authtype eq '') {
2522: $authtype = '<input type="radio" name="login" value="loc" '.
2523: $loccheck.' onchange="'.$jscall.'" onclick="'.
2524: $jscall.'" />';
2525: }
2526: $autharg = '<input type="text" size="10" name="locarg" value="'.
2527: $locarg.'" onchange="'.$jscall.'" />';
2528: $result = &mt('[_1] Local Authentication with argument [_2]',
2529: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2530: return $result;
2531: }
2532:
2533: sub authform_filesystem{
2534: my %in = (
2535: formname => 'document.cu',
2536: kerb_def_dom => 'MSU.EDU',
2537: @_,
2538: );
1.586 raeburn 2539: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2540: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2541: if (defined($in{'curr_authtype'})) {
2542: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2543: if ($can_assign{'fsys'}) {
1.772 bisitz 2544: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2545: if (defined($in{'mode'})) {
2546: if ($in{'mode'} eq 'modifyuser') {
2547: $fsyscheck = '';
2548: }
2549: }
1.586 raeburn 2550: } else {
2551: $result = &mt('Currently Filesystem Authenticated.');
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2558: }
2559: }
2560: if (!$can_assign{'fsys'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="fsys" '.
2574: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2575: $jscall.'" />';
2576: }
2577: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2578: ' onchange="'.$jscall.'" />';
2579: $result = &mt
1.144 matthew 2580: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2581: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2582: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2583: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2584: 'onchange="'.$jscall.'" />');
1.32 matthew 2585: return $result;
2586: }
2587:
1.586 raeburn 2588: sub get_assignable_auth {
2589: my ($dom) = @_;
2590: if ($dom eq '') {
2591: $dom = $env{'request.role.domain'};
2592: }
2593: my %can_assign = (
2594: krb4 => 1,
2595: krb5 => 1,
2596: int => 1,
2597: loc => 1,
2598: );
2599: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2600: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2601: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2602: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2603: my $context;
2604: if ($env{'request.role'} =~ /^au/) {
2605: $context = 'author';
2606: } elsif ($env{'request.role'} =~ /^dc/) {
2607: $context = 'domain';
2608: } elsif ($env{'request.course.id'}) {
2609: $context = 'course';
2610: }
2611: if ($context) {
2612: if (ref($authhash->{$context}) eq 'HASH') {
2613: %can_assign = %{$authhash->{$context}};
2614: }
2615: }
2616: }
2617: }
2618: my $authnum = 0;
2619: foreach my $key (keys(%can_assign)) {
2620: if ($can_assign{$key}) {
2621: $authnum ++;
2622: }
2623: }
2624: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2625: $authnum --;
2626: }
2627: return ($authnum,%can_assign);
2628: }
2629:
1.80 albertel 2630: ###############################################################
2631: ## Get Kerberos Defaults for Domain ##
2632: ###############################################################
2633: ##
2634: ## Returns default kerberos version and an associated argument
2635: ## as listed in file domain.tab. If not listed, provides
2636: ## appropriate default domain and kerberos version.
2637: ##
2638: #-------------------------------------------
2639:
2640: =pod
2641:
1.648 raeburn 2642: =item * &get_kerberos_defaults()
1.80 albertel 2643:
2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2645: version and domain. If not found, it defaults to version 4 and the
2646: domain of the server.
1.80 albertel 2647:
1.648 raeburn 2648: =over 4
2649:
1.80 albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2651:
1.648 raeburn 2652: =back
2653:
2654: =back
2655:
1.80 albertel 2656: =cut
2657:
2658: #-------------------------------------------
2659: sub get_kerberos_defaults {
2660: my $domain=shift;
1.641 raeburn 2661: my ($krbdef,$krbdefdom);
2662: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2663: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2664: $krbdef = $domdefaults{'auth_def'};
2665: $krbdefdom = $domdefaults{'auth_arg_def'};
2666: } else {
1.80 albertel 2667: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2668: my $krbdefdom=$1;
2669: $krbdefdom=~tr/a-z/A-Z/;
2670: $krbdef = "krb4";
2671: }
2672: return ($krbdef,$krbdefdom);
2673: }
1.112 bowersj2 2674:
1.32 matthew 2675:
1.46 matthew 2676: ###############################################################
2677: ## Thesaurus Functions ##
2678: ###############################################################
1.20 www 2679:
1.46 matthew 2680: =pod
1.20 www 2681:
1.112 bowersj2 2682: =head1 Thesaurus Functions
2683:
2684: =over 4
2685:
1.648 raeburn 2686: =item * &initialize_keywords()
1.46 matthew 2687:
2688: Initializes the package variable %Keywords if it is empty. Uses the
2689: package variable $thesaurus_db_file.
2690:
2691: =cut
2692:
2693: ###################################################
2694:
2695: sub initialize_keywords {
2696: return 1 if (scalar keys(%Keywords));
2697: # If we are here, %Keywords is empty, so fill it up
2698: # Make sure the file we need exists...
2699: if (! -e $thesaurus_db_file) {
2700: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2701: " failed because it does not exist");
2702: return 0;
2703: }
2704: # Set up the hash as a database
2705: my %thesaurus_db;
2706: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2707: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2708: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2709: $thesaurus_db_file);
2710: return 0;
2711: }
2712: # Get the average number of appearances of a word.
2713: my $avecount = $thesaurus_db{'average.count'};
2714: # Put keywords (those that appear > average) into %Keywords
2715: while (my ($word,$data)=each (%thesaurus_db)) {
2716: my ($count,undef) = split /:/,$data;
2717: $Keywords{$word}++ if ($count > $avecount);
2718: }
2719: untie %thesaurus_db;
2720: # Remove special values from %Keywords.
1.356 albertel 2721: foreach my $value ('total.count','average.count') {
2722: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2723: }
1.46 matthew 2724: return 1;
2725: }
2726:
2727: ###################################################
2728:
2729: =pod
2730:
1.648 raeburn 2731: =item * &keyword($word)
1.46 matthew 2732:
2733: Returns true if $word is a keyword. A keyword is a word that appears more
2734: than the average number of times in the thesaurus database. Calls
2735: &initialize_keywords
2736:
2737: =cut
2738:
2739: ###################################################
1.20 www 2740:
2741: sub keyword {
1.46 matthew 2742: return if (!&initialize_keywords());
2743: my $word=lc(shift());
2744: $word=~s/\W//g;
2745: return exists($Keywords{$word});
1.20 www 2746: }
1.46 matthew 2747:
2748: ###############################################################
2749:
2750: =pod
1.20 www 2751:
1.648 raeburn 2752: =item * &get_related_words()
1.46 matthew 2753:
1.160 matthew 2754: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2755: an array of words. If the keyword is not in the thesaurus, an empty array
2756: will be returned. The order of the words returned is determined by the
2757: database which holds them.
2758:
2759: Uses global $thesaurus_db_file.
2760:
2761: =cut
2762:
2763: ###############################################################
2764: sub get_related_words {
2765: my $keyword = shift;
2766: my %thesaurus_db;
2767: if (! -e $thesaurus_db_file) {
2768: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2769: "failed because the file does not exist");
2770: return ();
2771: }
2772: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2773: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2774: return ();
2775: }
2776: my @Words=();
1.429 www 2777: my $count=0;
1.46 matthew 2778: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2779: # The first element is the number of times
2780: # the word appears. We do not need it now.
1.429 www 2781: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2782: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2783: my $threshold=$mostfrequentcount/10;
2784: foreach my $possibleword (@RelatedWords) {
2785: my ($word,$wordcount)=split(/\,/,$possibleword);
2786: if ($wordcount>$threshold) {
2787: push(@Words,$word);
2788: $count++;
2789: if ($count>10) { last; }
2790: }
1.20 www 2791: }
2792: }
1.46 matthew 2793: untie %thesaurus_db;
2794: return @Words;
1.14 harris41 2795: }
1.46 matthew 2796:
1.112 bowersj2 2797: =pod
2798:
2799: =back
2800:
2801: =cut
1.61 www 2802:
2803: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2804: =pod
2805:
1.112 bowersj2 2806: =head1 User Name Functions
2807:
2808: =over 4
2809:
1.648 raeburn 2810: =item * &plainname($uname,$udom,$first)
1.81 albertel 2811:
1.112 bowersj2 2812: Takes a users logon name and returns it as a string in
1.226 albertel 2813: "first middle last generation" form
2814: if $first is set to 'lastname' then it returns it as
2815: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2816:
2817: =cut
1.61 www 2818:
1.295 www 2819:
1.81 albertel 2820: ###############################################################
1.61 www 2821: sub plainname {
1.226 albertel 2822: my ($uname,$udom,$first)=@_;
1.537 albertel 2823: return if (!defined($uname) || !defined($udom));
1.295 www 2824: my %names=&getnames($uname,$udom);
1.226 albertel 2825: my $name=&Apache::lonnet::format_name($names{'firstname'},
2826: $names{'middlename'},
2827: $names{'lastname'},
2828: $names{'generation'},$first);
2829: $name=~s/^\s+//;
1.62 www 2830: $name=~s/\s+$//;
2831: $name=~s/\s+/ /g;
1.353 albertel 2832: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2833: return $name;
1.61 www 2834: }
1.66 www 2835:
2836: # -------------------------------------------------------------------- Nickname
1.81 albertel 2837: =pod
2838:
1.648 raeburn 2839: =item * &nickname($uname,$udom)
1.81 albertel 2840:
2841: Gets a users name and returns it as a string as
2842:
2843: ""nickname""
1.66 www 2844:
1.81 albertel 2845: if the user has a nickname or
2846:
2847: "first middle last generation"
2848:
2849: if the user does not
2850:
2851: =cut
1.66 www 2852:
2853: sub nickname {
2854: my ($uname,$udom)=@_;
1.537 albertel 2855: return if (!defined($uname) || !defined($udom));
1.295 www 2856: my %names=&getnames($uname,$udom);
1.68 albertel 2857: my $name=$names{'nickname'};
1.66 www 2858: if ($name) {
2859: $name='"'.$name.'"';
2860: } else {
2861: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2862: $names{'lastname'}.' '.$names{'generation'};
2863: $name=~s/\s+$//;
2864: $name=~s/\s+/ /g;
2865: }
2866: return $name;
2867: }
2868:
1.295 www 2869: sub getnames {
2870: my ($uname,$udom)=@_;
1.537 albertel 2871: return if (!defined($uname) || !defined($udom));
1.433 albertel 2872: if ($udom eq 'public' && $uname eq 'public') {
2873: return ('lastname' => &mt('Public'));
2874: }
1.295 www 2875: my $id=$uname.':'.$udom;
2876: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2877: if ($cached) {
2878: return %{$names};
2879: } else {
2880: my %loadnames=&Apache::lonnet::get('environment',
2881: ['firstname','middlename','lastname','generation','nickname'],
2882: $udom,$uname);
2883: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2884: return %loadnames;
2885: }
2886: }
1.61 www 2887:
1.542 raeburn 2888: # -------------------------------------------------------------------- getemails
1.648 raeburn 2889:
1.542 raeburn 2890: =pod
2891:
1.648 raeburn 2892: =item * &getemails($uname,$udom)
1.542 raeburn 2893:
2894: Gets a user's email information and returns it as a hash with keys:
2895: notification, critnotification, permanentemail
2896:
2897: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2899:
1.648 raeburn 2900:
1.542 raeburn 2901: =cut
2902:
1.648 raeburn 2903:
1.466 albertel 2904: sub getemails {
2905: my ($uname,$udom)=@_;
2906: if ($udom eq 'public' && $uname eq 'public') {
2907: return;
2908: }
1.467 www 2909: if (!$udom) { $udom=$env{'user.domain'}; }
2910: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2911: my $id=$uname.':'.$udom;
2912: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2913: if ($cached) {
2914: return %{$names};
2915: } else {
2916: my %loadnames=&Apache::lonnet::get('environment',
2917: ['notification','critnotification',
2918: 'permanentemail'],
2919: $udom,$uname);
2920: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2921: return %loadnames;
2922: }
2923: }
2924:
1.551 albertel 2925: sub flush_email_cache {
2926: my ($uname,$udom)=@_;
2927: if (!$udom) { $udom =$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: return if ($udom eq 'public' && $uname eq 'public');
2930: my $id=$uname.':'.$udom;
2931: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2932: }
2933:
1.728 raeburn 2934: # -------------------------------------------------------------------- getlangs
2935:
2936: =pod
2937:
2938: =item * &getlangs($uname,$udom)
2939:
2940: Gets a user's language preference and returns it as a hash with key:
2941: language.
2942:
2943: =cut
2944:
2945:
2946: sub getlangs {
2947: my ($uname,$udom) = @_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: my $id=$uname.':'.$udom;
2951: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2952: if ($cached) {
2953: return %{$langs};
2954: } else {
2955: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2956: $udom,$uname);
2957: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2958: return %loadlangs;
2959: }
2960: }
2961:
2962: sub flush_langs_cache {
2963: my ($uname,$udom)=@_;
2964: if (!$udom) { $udom =$env{'user.domain'}; }
2965: if (!$uname) { $uname=$env{'user.name'}; }
2966: return if ($udom eq 'public' && $uname eq 'public');
2967: my $id=$uname.':'.$udom;
2968: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2969: }
2970:
1.61 www 2971: # ------------------------------------------------------------------ Screenname
1.81 albertel 2972:
2973: =pod
2974:
1.648 raeburn 2975: =item * &screenname($uname,$udom)
1.81 albertel 2976:
2977: Gets a users screenname and returns it as a string
2978:
2979: =cut
1.61 www 2980:
2981: sub screenname {
2982: my ($uname,$udom)=@_;
1.258 albertel 2983: if ($uname eq $env{'user.name'} &&
2984: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2985: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2986: return $names{'screenname'};
1.62 www 2987: }
2988:
1.212 albertel 2989:
1.802 bisitz 2990: # ------------------------------------------------------------- Confirm Wrapper
2991: =pod
2992:
2993: =item confirmwrapper
2994:
2995: Wrap messages about completion of operation in box
2996:
2997: =cut
2998:
2999: sub confirmwrapper {
3000: my ($message)=@_;
3001: if ($message) {
3002: return "\n".'<div class="LC_confirm_box">'."\n"
3003: .$message."\n"
3004: .'</div>'."\n";
3005: } else {
3006: return $message;
3007: }
3008: }
3009:
1.62 www 3010: # ------------------------------------------------------------- Message Wrapper
3011:
3012: sub messagewrapper {
1.369 www 3013: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3014: return
1.441 albertel 3015: '<a href="/adm/email?compose=individual&'.
3016: 'recname='.$username.'&recdom='.$domain.
3017: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3018: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3019: }
1.802 bisitz 3020:
1.74 www 3021: # --------------------------------------------------------------- Notes Wrapper
3022:
3023: sub noteswrapper {
3024: my ($link,$un,$do)=@_;
3025: return
1.896 amueller 3026: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3027: }
1.802 bisitz 3028:
1.62 www 3029: # ------------------------------------------------------------- Aboutme Wrapper
3030:
3031: sub aboutmewrapper {
1.166 www 3032: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3033: if (!defined($username) && !defined($domain)) {
3034: return;
3035: }
1.892 amueller 3036: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3037: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3038: }
3039:
3040: # ------------------------------------------------------------ Syllabus Wrapper
3041:
3042: sub syllabuswrapper {
1.707 bisitz 3043: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3044: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3045: }
1.14 harris41 3046:
1.802 bisitz 3047: # -----------------------------------------------------------------------------
3048:
1.208 matthew 3049: sub track_student_link {
1.887 raeburn 3050: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3051: my $link ="/adm/trackstudent?";
1.208 matthew 3052: my $title = 'View recent activity';
3053: if (defined($sname) && $sname !~ /^\s*$/ &&
3054: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3055: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3056: $title .= ' of this student';
1.268 albertel 3057: }
1.208 matthew 3058: if (defined($target) && $target !~ /^\s*$/) {
3059: $target = qq{target="$target"};
3060: } else {
3061: $target = '';
3062: }
1.268 albertel 3063: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3064: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3065: $title = &mt($title);
3066: $linktext = &mt($linktext);
1.448 albertel 3067: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3068: &help_open_topic('View_recent_activity');
1.208 matthew 3069: }
3070:
1.781 raeburn 3071: sub slot_reservations_link {
3072: my ($linktext,$sname,$sdom,$target) = @_;
3073: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3074: my $title = 'View slot reservation history';
3075: if (defined($sname) && $sname !~ /^\s*$/ &&
3076: defined($sdom) && $sdom !~ /^\s*$/) {
3077: $link .= "&uname=$sname&udom=$sdom";
3078: $title .= ' of this student';
3079: }
3080: if (defined($target) && $target !~ /^\s*$/) {
3081: $target = qq{target="$target"};
3082: } else {
3083: $target = '';
3084: }
3085: $title = &mt($title);
3086: $linktext = &mt($linktext);
3087: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3089:
3090: }
3091:
1.508 www 3092: # ===================================================== Display a student photo
3093:
3094:
1.509 albertel 3095: sub student_image_tag {
1.508 www 3096: my ($domain,$user)=@_;
3097: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3098: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3099: return '<img src="'.$imgsrc.'" align="right" />';
3100: } else {
3101: return '';
3102: }
3103: }
3104:
1.112 bowersj2 3105: =pod
3106:
3107: =back
3108:
3109: =head1 Access .tab File Data
3110:
3111: =over 4
3112:
1.648 raeburn 3113: =item * &languageids()
1.112 bowersj2 3114:
3115: returns list of all language ids
3116:
3117: =cut
3118:
1.14 harris41 3119: sub languageids {
1.16 harris41 3120: return sort(keys(%language));
1.14 harris41 3121: }
3122:
1.112 bowersj2 3123: =pod
3124:
1.648 raeburn 3125: =item * &languagedescription()
1.112 bowersj2 3126:
3127: returns description of a specified language id
3128:
3129: =cut
3130:
1.14 harris41 3131: sub languagedescription {
1.125 www 3132: my $code=shift;
3133: return ($supported_language{$code}?'* ':'').
3134: $language{$code}.
1.126 www 3135: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3136: }
3137:
3138: sub plainlanguagedescription {
3139: my $code=shift;
3140: return $language{$code};
3141: }
3142:
3143: sub supportedlanguagecode {
3144: my $code=shift;
3145: return $supported_language{$code};
1.97 www 3146: }
3147:
1.112 bowersj2 3148: =pod
3149:
1.648 raeburn 3150: =item * ©rightids()
1.112 bowersj2 3151:
3152: returns list of all copyrights
3153:
3154: =cut
3155:
3156: sub copyrightids {
3157: return sort(keys(%cprtag));
3158: }
3159:
3160: =pod
3161:
1.648 raeburn 3162: =item * ©rightdescription()
1.112 bowersj2 3163:
3164: returns description of a specified copyright id
3165:
3166: =cut
3167:
3168: sub copyrightdescription {
1.166 www 3169: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3170: }
1.197 matthew 3171:
3172: =pod
3173:
1.648 raeburn 3174: =item * &source_copyrightids()
1.192 taceyjo1 3175:
3176: returns list of all source copyrights
3177:
3178: =cut
3179:
3180: sub source_copyrightids {
3181: return sort(keys(%scprtag));
3182: }
3183:
3184: =pod
3185:
1.648 raeburn 3186: =item * &source_copyrightdescription()
1.192 taceyjo1 3187:
3188: returns description of a specified source copyright id
3189:
3190: =cut
3191:
3192: sub source_copyrightdescription {
3193: return &mt($scprtag{shift(@_)});
3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.648 raeburn 3198: =item * &filecategories()
1.112 bowersj2 3199:
3200: returns list of all file categories
3201:
3202: =cut
3203:
3204: sub filecategories {
3205: return sort(keys(%category_extensions));
3206: }
3207:
3208: =pod
3209:
1.648 raeburn 3210: =item * &filecategorytypes()
1.112 bowersj2 3211:
3212: returns list of file types belonging to a given file
3213: category
3214:
3215: =cut
3216:
3217: sub filecategorytypes {
1.356 albertel 3218: my ($cat) = @_;
3219: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3220: }
3221:
3222: =pod
3223:
1.648 raeburn 3224: =item * &fileembstyle()
1.112 bowersj2 3225:
3226: returns embedding style for a specified file type
3227:
3228: =cut
3229:
3230: sub fileembstyle {
3231: return $fe{lc(shift(@_))};
1.169 www 3232: }
3233:
1.351 www 3234: sub filemimetype {
3235: return $fm{lc(shift(@_))};
3236: }
3237:
1.169 www 3238:
3239: sub filecategoryselect {
3240: my ($name,$value)=@_;
1.189 matthew 3241: return &select_form($value,$name,
1.169 www 3242: '' => &mt('Any category'),
3243: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3244: }
3245:
3246: =pod
3247:
1.648 raeburn 3248: =item * &filedescription()
1.112 bowersj2 3249:
3250: returns description for a specified file type
3251:
3252: =cut
3253:
3254: sub filedescription {
1.188 matthew 3255: my $file_description = $fd{lc(shift())};
3256: $file_description =~ s:([\[\]]):~$1:g;
3257: return &mt($file_description);
1.112 bowersj2 3258: }
3259:
3260: =pod
3261:
1.648 raeburn 3262: =item * &filedescriptionex()
1.112 bowersj2 3263:
3264: returns description for a specified file type with
3265: extra formatting
3266:
3267: =cut
3268:
3269: sub filedescriptionex {
3270: my $ex=shift;
1.188 matthew 3271: my $file_description = $fd{lc($ex)};
3272: $file_description =~ s:([\[\]]):~$1:g;
3273: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3274: }
3275:
3276: # End of .tab access
3277: =pod
3278:
3279: =back
3280:
3281: =cut
3282:
3283: # ------------------------------------------------------------------ File Types
3284: sub fileextensions {
3285: return sort(keys(%fe));
3286: }
3287:
1.97 www 3288: # ----------------------------------------------------------- Display Languages
3289: # returns a hash with all desired display languages
3290: #
3291:
3292: sub display_languages {
3293: my %languages=();
1.695 raeburn 3294: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3295: $languages{$lang}=1;
1.97 www 3296: }
3297: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3298: if ($env{'form.displaylanguage'}) {
1.356 albertel 3299: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3300: $languages{$lang}=1;
1.97 www 3301: }
3302: }
3303: return %languages;
1.14 harris41 3304: }
3305:
1.582 albertel 3306: sub languages {
3307: my ($possible_langs) = @_;
1.695 raeburn 3308: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3309: if (!ref($possible_langs)) {
3310: if( wantarray ) {
3311: return @preferred_langs;
3312: } else {
3313: return $preferred_langs[0];
3314: }
3315: }
3316: my %possibilities = map { $_ => 1 } (@$possible_langs);
3317: my @preferred_possibilities;
3318: foreach my $preferred_lang (@preferred_langs) {
3319: if (exists($possibilities{$preferred_lang})) {
3320: push(@preferred_possibilities, $preferred_lang);
3321: }
3322: }
3323: if( wantarray ) {
3324: return @preferred_possibilities;
3325: }
3326: return $preferred_possibilities[0];
3327: }
3328:
1.742 raeburn 3329: sub user_lang {
3330: my ($touname,$toudom,$fromcid) = @_;
3331: my @userlangs;
3332: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3333: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3334: $env{'course.'.$fromcid.'.languages'}));
3335: } else {
3336: my %langhash = &getlangs($touname,$toudom);
3337: if ($langhash{'languages'} ne '') {
3338: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3339: } else {
3340: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3341: if ($domdefs{'lang_def'} ne '') {
3342: @userlangs = ($domdefs{'lang_def'});
3343: }
3344: }
3345: }
3346: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3347: my $user_lh = Apache::localize->get_handle(@languages);
3348: return $user_lh;
3349: }
3350:
3351:
1.112 bowersj2 3352: ###############################################################
3353: ## Student Answer Attempts ##
3354: ###############################################################
3355:
3356: =pod
3357:
3358: =head1 Alternate Problem Views
3359:
3360: =over 4
3361:
1.648 raeburn 3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3363: $getattempt, $regexp, $gradesub)
3364:
3365: Return string with previous attempt on problem. Arguments:
3366:
3367: =over 4
3368:
3369: =item * $symb: Problem, including path
3370:
3371: =item * $username: username of the desired student
3372:
3373: =item * $domain: domain of the desired student
1.14 harris41 3374:
1.112 bowersj2 3375: =item * $course: Course ID
1.14 harris41 3376:
1.112 bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
3378: something
1.14 harris41 3379:
1.112 bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
3381: sent to $gradesub
1.14 harris41 3382:
1.112 bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3384:
1.112 bowersj2 3385: =back
1.14 harris41 3386:
1.112 bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16 harris41 3388:
1.112 bowersj2 3389: =cut
1.1 albertel 3390:
3391: sub get_previous_attempt {
1.43 ng 3392: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3393: my $prevattempts='';
1.43 ng 3394: no strict 'refs';
1.1 albertel 3395: if ($symb) {
1.3 albertel 3396: my (%returnhash)=
3397: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3398: if ($returnhash{'version'}) {
3399: my %lasthash=();
3400: my $version;
3401: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3402: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3403: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3404: }
1.1 albertel 3405: }
1.596 albertel 3406: $prevattempts=&start_data_table().&start_data_table_header_row();
3407: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3408: foreach my $key (sort(keys(%lasthash))) {
3409: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3410: if ($#parts > 0) {
1.31 albertel 3411: my $data=$parts[-1];
3412: pop(@parts);
1.596 albertel 3413: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3414: } else {
1.41 ng 3415: if ($#parts == 0) {
3416: $prevattempts.='<th>'.$parts[0].'</th>';
3417: } else {
3418: $prevattempts.='<th>'.$ign.'</th>';
3419: }
1.31 albertel 3420: }
1.16 harris41 3421: }
1.596 albertel 3422: $prevattempts.=&end_data_table_header_row();
1.40 ng 3423: if ($getattempt eq '') {
3424: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3425: $prevattempts.=&start_data_table_row().
3426: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3427: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3428: my $value = &format_previous_attempt_value($key,
3429: $returnhash{$version.':'.$key});
3430: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3431: }
1.596 albertel 3432: $prevattempts.=&end_data_table_row();
1.40 ng 3433: }
1.1 albertel 3434: }
1.596 albertel 3435: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3436: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3437: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3438: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3439: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3440: }
1.596 albertel 3441: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3442: } else {
1.596 albertel 3443: $prevattempts=
3444: &start_data_table().&start_data_table_row().
3445: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3446: &end_data_table_row().&end_data_table();
1.1 albertel 3447: }
3448: } else {
1.596 albertel 3449: $prevattempts=
3450: &start_data_table().&start_data_table_row().
3451: '<td>'.&mt('No data.').'</td>'.
3452: &end_data_table_row().&end_data_table();
1.1 albertel 3453: }
1.10 albertel 3454: }
3455:
1.581 albertel 3456: sub format_previous_attempt_value {
3457: my ($key,$value) = @_;
3458: if ($key =~ /timestamp/) {
3459: $value = &Apache::lonlocal::locallocaltime($value);
3460: } elsif (ref($value) eq 'ARRAY') {
3461: $value = '('.join(', ', @{ $value }).')';
3462: } else {
3463: $value = &unescape($value);
3464: }
3465: return $value;
3466: }
3467:
3468:
1.107 albertel 3469: sub relative_to_absolute {
3470: my ($url,$output)=@_;
3471: my $parser=HTML::TokeParser->new(\$output);
3472: my $token;
3473: my $thisdir=$url;
3474: my @rlinks=();
3475: while ($token=$parser->get_token) {
3476: if ($token->[0] eq 'S') {
3477: if ($token->[1] eq 'a') {
3478: if ($token->[2]->{'href'}) {
3479: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3480: }
3481: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3482: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3483: } elsif ($token->[1] eq 'base') {
3484: $thisdir=$token->[2]->{'href'};
3485: }
3486: }
3487: }
3488: $thisdir=~s-/[^/]*$--;
1.356 albertel 3489: foreach my $link (@rlinks) {
1.726 raeburn 3490: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3491: ($link=~/^\//) ||
3492: ($link=~/^javascript:/i) ||
3493: ($link=~/^mailto:/i) ||
3494: ($link=~/^\#/)) {
3495: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3496: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3497: }
3498: }
3499: # -------------------------------------------------- Deal with Applet codebases
3500: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3501: return $output;
3502: }
3503:
1.112 bowersj2 3504: =pod
3505:
1.648 raeburn 3506: =item * &get_student_view()
1.112 bowersj2 3507:
3508: show a snapshot of what student was looking at
3509:
3510: =cut
3511:
1.10 albertel 3512: sub get_student_view {
1.186 albertel 3513: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3514: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3515: my (%form);
1.10 albertel 3516: my @elements=('symb','courseid','domain','username');
3517: foreach my $element (@elements) {
1.186 albertel 3518: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3519: }
1.186 albertel 3520: if (defined($moreenv)) {
3521: %form=(%form,%{$moreenv});
3522: }
1.236 albertel 3523: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3524: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3525: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3526: $userview=~s/\<body[^\>]*\>//gi;
3527: $userview=~s/\<\/body\>//gi;
3528: $userview=~s/\<html\>//gi;
3529: $userview=~s/\<\/html\>//gi;
3530: $userview=~s/\<head\>//gi;
3531: $userview=~s/\<\/head\>//gi;
3532: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3533: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3534: if (wantarray) {
3535: return ($userview,$response);
3536: } else {
3537: return $userview;
3538: }
3539: }
3540:
3541: sub get_student_view_with_retries {
3542: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3543:
3544: my $ok = 0; # True if we got a good response.
3545: my $content;
3546: my $response;
3547:
3548: # Try to get the student_view done. within the retries count:
3549:
3550: do {
3551: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3552: $ok = $response->is_success;
3553: if (!$ok) {
3554: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3555: }
3556: $retries--;
3557: } while (!$ok && ($retries > 0));
3558:
3559: if (!$ok) {
3560: $content = ''; # On error return an empty content.
3561: }
1.651 www 3562: if (wantarray) {
3563: return ($content, $response);
3564: } else {
3565: return $content;
3566: }
1.11 albertel 3567: }
3568:
1.112 bowersj2 3569: =pod
3570:
1.648 raeburn 3571: =item * &get_student_answers()
1.112 bowersj2 3572:
3573: show a snapshot of how student was answering problem
3574:
3575: =cut
3576:
1.11 albertel 3577: sub get_student_answers {
1.100 sakharuk 3578: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3579: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3580: my (%moreenv);
1.11 albertel 3581: my @elements=('symb','courseid','domain','username');
3582: foreach my $element (@elements) {
1.186 albertel 3583: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3584: }
1.186 albertel 3585: $moreenv{'grade_target'}='answer';
3586: %moreenv=(%form,%moreenv);
1.497 raeburn 3587: $feedurl = &Apache::lonnet::clutter($feedurl);
3588: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3589: return $userview;
1.1 albertel 3590: }
1.116 albertel 3591:
3592: =pod
3593:
3594: =item * &submlink()
3595:
1.242 albertel 3596: Inputs: $text $uname $udom $symb $target
1.116 albertel 3597:
3598: Returns: A link to grades.pm such as to see the SUBM view of a student
3599:
3600: =cut
3601:
3602: ###############################################
3603: sub submlink {
1.242 albertel 3604: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3605: if (!($uname && $udom)) {
3606: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3607: &Apache::lonnet::whichuser($symb);
1.116 albertel 3608: if (!$symb) { $symb=$cursymb; }
3609: }
1.254 matthew 3610: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3611: $symb=&escape($symb);
1.242 albertel 3612: if ($target) { $target="target=\"$target\""; }
3613: return '<a href="/adm/grades?&command=submission&'.
3614: 'symb='.$symb.'&student='.$uname.
3615: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3616: }
3617: ##############################################
3618:
3619: =pod
3620:
3621: =item * &pgrdlink()
3622:
3623: Inputs: $text $uname $udom $symb $target
3624:
3625: Returns: A link to grades.pm such as to see the PGRD view of a student
3626:
3627: =cut
3628:
3629: ###############################################
3630: sub pgrdlink {
3631: my $link=&submlink(@_);
3632: $link=~s/(&command=submission)/$1&showgrading=yes/;
3633: return $link;
3634: }
3635: ##############################################
3636:
3637: =pod
3638:
3639: =item * &pprmlink()
3640:
3641: Inputs: $text $uname $udom $symb $target
3642:
3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3644: student and a specific resource
1.242 albertel 3645:
3646: =cut
3647:
3648: ###############################################
3649: sub pprmlink {
3650: my ($text,$uname,$udom,$symb,$target)=@_;
3651: if (!($uname && $udom)) {
3652: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3653: &Apache::lonnet::whichuser($symb);
1.242 albertel 3654: if (!$symb) { $symb=$cursymb; }
3655: }
1.254 matthew 3656: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3657: $symb=&escape($symb);
1.242 albertel 3658: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3659: return '<a href="/adm/parmset?command=set&'.
3660: 'symb='.$symb.'&uname='.$uname.
3661: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3662: }
3663: ##############################################
1.37 matthew 3664:
1.112 bowersj2 3665: =pod
3666:
3667: =back
3668:
3669: =cut
3670:
1.37 matthew 3671: ###############################################
1.51 www 3672:
3673:
3674: sub timehash {
1.687 raeburn 3675: my ($thistime) = @_;
3676: my $timezone = &Apache::lonlocal::gettimezone();
3677: my $dt = DateTime->from_epoch(epoch => $thistime)
3678: ->set_time_zone($timezone);
3679: my $wday = $dt->day_of_week();
3680: if ($wday == 7) { $wday = 0; }
3681: return ( 'second' => $dt->second(),
3682: 'minute' => $dt->minute(),
3683: 'hour' => $dt->hour(),
3684: 'day' => $dt->day_of_month(),
3685: 'month' => $dt->month(),
3686: 'year' => $dt->year(),
3687: 'weekday' => $wday,
3688: 'dayyear' => $dt->day_of_year(),
3689: 'dlsav' => $dt->is_dst() );
1.51 www 3690: }
3691:
1.370 www 3692: sub utc_string {
3693: my ($date)=@_;
1.371 www 3694: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3695: }
3696:
1.51 www 3697: sub maketime {
3698: my %th=@_;
1.687 raeburn 3699: my ($epoch_time,$timezone,$dt);
3700: $timezone = &Apache::lonlocal::gettimezone();
3701: eval {
3702: $dt = DateTime->new( year => $th{'year'},
3703: month => $th{'month'},
3704: day => $th{'day'},
3705: hour => $th{'hour'},
3706: minute => $th{'minute'},
3707: second => $th{'second'},
3708: time_zone => $timezone,
3709: );
3710: };
3711: if (!$@) {
3712: $epoch_time = $dt->epoch;
3713: if ($epoch_time) {
3714: return $epoch_time;
3715: }
3716: }
1.51 www 3717: return POSIX::mktime(
3718: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3719: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3720: }
3721:
3722: #########################################
1.51 www 3723:
3724: sub findallcourses {
1.482 raeburn 3725: my ($roles,$uname,$udom) = @_;
1.355 albertel 3726: my %roles;
3727: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3728: my %courses;
1.51 www 3729: my $now=time;
1.482 raeburn 3730: if (!defined($uname)) {
3731: $uname = $env{'user.name'};
3732: }
3733: if (!defined($udom)) {
3734: $udom = $env{'user.domain'};
3735: }
3736: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3737: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3738: if (!%roles) {
3739: %roles = (
3740: cc => 1,
1.907 raeburn 3741: co => 1,
1.482 raeburn 3742: in => 1,
3743: ep => 1,
3744: ta => 1,
3745: cr => 1,
3746: st => 1,
3747: );
3748: }
3749: foreach my $entry (keys(%roleshash)) {
3750: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3751: if ($trole =~ /^cr/) {
3752: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3753: } else {
3754: next if (!exists($roles{$trole}));
3755: }
3756: if ($tend) {
3757: next if ($tend < $now);
3758: }
3759: if ($tstart) {
3760: next if ($tstart > $now);
3761: }
3762: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3763: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3764: if ($secpart eq '') {
3765: ($cnum,$role) = split(/_/,$cnumpart);
3766: $sec = 'none';
3767: $realsec = '';
3768: } else {
3769: $cnum = $cnumpart;
3770: ($sec,$role) = split(/_/,$secpart);
3771: $realsec = $sec;
1.490 raeburn 3772: }
1.482 raeburn 3773: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3774: }
3775: } else {
3776: foreach my $key (keys(%env)) {
1.483 albertel 3777: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3778: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3779: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3780: next if ($role eq 'ca' || $role eq 'aa');
3781: next if (%roles && !exists($roles{$role}));
3782: my ($starttime,$endtime)=split(/\./,$env{$key});
3783: my $active=1;
3784: if ($starttime) {
3785: if ($now<$starttime) { $active=0; }
3786: }
3787: if ($endtime) {
3788: if ($now>$endtime) { $active=0; }
3789: }
3790: if ($active) {
3791: if ($sec eq '') {
3792: $sec = 'none';
3793: }
3794: $courses{$cdom.'_'.$cnum}{$sec} =
3795: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3796: }
3797: }
1.51 www 3798: }
3799: }
1.474 raeburn 3800: return %courses;
1.51 www 3801: }
1.37 matthew 3802:
1.54 www 3803: ###############################################
1.474 raeburn 3804:
3805: sub blockcheck {
1.482 raeburn 3806: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3807:
3808: if (!defined($udom)) {
3809: $udom = $env{'user.domain'};
3810: }
3811: if (!defined($uname)) {
3812: $uname = $env{'user.name'};
3813: }
3814:
3815: # If uname and udom are for a course, check for blocks in the course.
3816:
3817: if (&Apache::lonnet::is_course($udom,$uname)) {
3818: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3819: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3820: return ($startblock,$endblock);
3821: }
1.474 raeburn 3822:
1.502 raeburn 3823: my $startblock = 0;
3824: my $endblock = 0;
1.482 raeburn 3825: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3826:
1.490 raeburn 3827: # If uname is for a user, and activity is course-specific, i.e.,
3828: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3829:
1.490 raeburn 3830: if (($activity eq 'boards' || $activity eq 'chat' ||
3831: $activity eq 'groups') && ($env{'request.course.id'})) {
3832: foreach my $key (keys(%live_courses)) {
3833: if ($key ne $env{'request.course.id'}) {
3834: delete($live_courses{$key});
3835: }
3836: }
3837: }
3838:
3839: my $otheruser = 0;
3840: my %own_courses;
3841: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3842: # Resource belongs to user other than current user.
3843: $otheruser = 1;
3844: # Gather courses for current user
3845: %own_courses =
3846: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3847: }
3848:
3849: # Gather active course roles - course coordinator, instructor,
3850: # exam proctor, ta, student, or custom role.
1.474 raeburn 3851:
3852: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3853: my ($cdom,$cnum);
3854: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3855: $cdom = $env{'course.'.$course.'.domain'};
3856: $cnum = $env{'course.'.$course.'.num'};
3857: } else {
1.490 raeburn 3858: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3859: }
3860: my $no_ownblock = 0;
3861: my $no_userblock = 0;
1.533 raeburn 3862: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3863: # Check if current user has 'evb' priv for this
3864: if (defined($own_courses{$course})) {
3865: foreach my $sec (keys(%{$own_courses{$course}})) {
3866: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3867: if ($sec ne 'none') {
3868: $checkrole .= '/'.$sec;
3869: }
3870: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3871: $no_ownblock = 1;
3872: last;
3873: }
3874: }
3875: }
3876: # if they have 'evb' priv and are currently not playing student
3877: next if (($no_ownblock) &&
3878: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3879: }
1.474 raeburn 3880: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3881: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3882: if ($sec ne 'none') {
1.482 raeburn 3883: $checkrole .= '/'.$sec;
1.474 raeburn 3884: }
1.490 raeburn 3885: if ($otheruser) {
3886: # Resource belongs to user other than current user.
3887: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3888: my ($trole,$tdom,$tnum,$tsec);
3889: my $entry = $live_courses{$course}{$sec};
3890: if ($entry =~ /^cr/) {
3891: ($trole,$tdom,$tnum,$tsec) =
3892: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3893: } else {
3894: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3895: }
3896: my ($spec,$area,$trest,%allroles,%userroles);
3897: $area = '/'.$tdom.'/'.$tnum;
3898: $trest = $tnum;
3899: if ($tsec ne '') {
3900: $area .= '/'.$tsec;
3901: $trest .= '/'.$tsec;
3902: }
3903: $spec = $trole.'.'.$area;
3904: if ($trole =~ /^cr/) {
3905: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3906: $tdom,$spec,$trest,$area);
3907: } else {
3908: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3909: $tdom,$spec,$trest,$area);
3910: }
3911: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3912: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3913: if ($1) {
3914: $no_userblock = 1;
3915: last;
3916: }
3917: }
1.490 raeburn 3918: } else {
3919: # Resource belongs to current user
3920: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3921: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3922: $no_ownblock = 1;
3923: last;
3924: }
1.474 raeburn 3925: }
3926: }
3927: # if they have the evb priv and are currently not playing student
1.482 raeburn 3928: next if (($no_ownblock) &&
1.491 albertel 3929: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3930: next if ($no_userblock);
1.474 raeburn 3931:
1.866 kalberla 3932: # Retrieve blocking times and identity of locker for course
1.490 raeburn 3933: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3934:
3935: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3936: if (($start != 0) &&
3937: (($startblock == 0) || ($startblock > $start))) {
3938: $startblock = $start;
3939: }
3940: if (($end != 0) &&
3941: (($endblock == 0) || ($endblock < $end))) {
3942: $endblock = $end;
3943: }
1.490 raeburn 3944: }
3945: return ($startblock,$endblock);
3946: }
3947:
3948: sub get_blocks {
3949: my ($setters,$activity,$cdom,$cnum) = @_;
3950: my $startblock = 0;
3951: my $endblock = 0;
3952: my $course = $cdom.'_'.$cnum;
3953: $setters->{$course} = {};
3954: $setters->{$course}{'staff'} = [];
3955: $setters->{$course}{'times'} = [];
3956: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3957: foreach my $record (keys(%records)) {
3958: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3959: if ($start <= time && $end >= time) {
3960: my ($staff_name,$staff_dom,$title,$blocks) =
3961: &parse_block_record($records{$record});
3962: if ($blocks->{$activity} eq 'on') {
3963: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3964: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3965: if ( ($startblock == 0) || ($startblock > $start) ) {
3966: $startblock = $start;
1.490 raeburn 3967: }
1.491 albertel 3968: if ( ($endblock == 0) || ($endblock < $end) ) {
3969: $endblock = $end;
1.474 raeburn 3970: }
3971: }
3972: }
3973: }
3974: return ($startblock,$endblock);
3975: }
3976:
3977: sub parse_block_record {
3978: my ($record) = @_;
3979: my ($setuname,$setudom,$title,$blocks);
3980: if (ref($record) eq 'HASH') {
3981: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3982: $title = &unescape($record->{'event'});
3983: $blocks = $record->{'blocks'};
3984: } else {
3985: my @data = split(/:/,$record,3);
3986: if (scalar(@data) eq 2) {
3987: $title = $data[1];
3988: ($setuname,$setudom) = split(/@/,$data[0]);
3989: } else {
3990: ($setuname,$setudom,$title) = @data;
3991: }
3992: $blocks = { 'com' => 'on' };
3993: }
3994: return ($setuname,$setudom,$title,$blocks);
3995: }
3996:
1.854 kalberla 3997: sub blocking_status {
3998: my ($activity,$uname,$udom) = @_;
1.867 kalberla 3999: my %setters;
1.890 droeschl 4000:
4001: # check for active blocking
1.867 kalberla 4002: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4003:
1.890 droeschl 4004: my $blocked = $startblock && $endblock ? 1 : 0;
4005:
4006: # caller just wants to know whether a block is active
4007: if (!wantarray) { return $blocked; }
4008:
4009: # build a link to a popup window containing the details
4010: my $querystring = "?activity=$activity";
4011: # $uname and $udom decide whose portfolio the user is trying to look at
4012: $querystring .= "&udom=$udom" if $udom;
4013: $querystring .= "&uname=$uname" if $uname;
4014:
4015: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4016: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4017: var options = "width=" + w + ",height=" + h + ",";
4018: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4019: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4020: var newWin = window.open(url, wdwName, options);
4021: newWin.focus();
4022: }
1.890 droeschl 4023: END_MYBLOCK
1.854 kalberla 4024:
1.890 droeschl 4025: $output = Apache::lonhtmlcommon::scripttag($output);
4026:
1.854 kalberla 4027: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4028: my $text = mt('Communication Blocked');
4029:
1.867 kalberla 4030: $output .= <<"END_BLOCK";
4031: <div class='LC_comblock'>
1.869 kalberla 4032: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4033: title='$text'>
4034: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4035: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4036: title='$text'>$text</a>
1.867 kalberla 4037: </div>
4038:
4039: END_BLOCK
1.474 raeburn 4040:
1.854 kalberla 4041: return ($blocked, $output);
4042: }
1.490 raeburn 4043:
1.60 matthew 4044: ###############################################
4045:
1.682 raeburn 4046: sub check_ip_acc {
4047: my ($acc)=@_;
4048: &Apache::lonxml::debug("acc is $acc");
4049: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4050: return 1;
4051: }
4052: my $allowed=0;
4053: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4054:
4055: my $name;
4056: foreach my $pattern (split(',',$acc)) {
4057: $pattern =~ s/^\s*//;
4058: $pattern =~ s/\s*$//;
4059: if ($pattern =~ /\*$/) {
4060: #35.8.*
4061: $pattern=~s/\*//;
4062: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4063: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4064: #35.8.3.[34-56]
4065: my $low=$2;
4066: my $high=$3;
4067: $pattern=$1;
4068: if ($ip =~ /^\Q$pattern\E/) {
4069: my $last=(split(/\./,$ip))[3];
4070: if ($last <=$high && $last >=$low) { $allowed=1; }
4071: }
4072: } elsif ($pattern =~ /^\*/) {
4073: #*.msu.edu
4074: $pattern=~s/\*//;
4075: if (!defined($name)) {
4076: use Socket;
4077: my $netaddr=inet_aton($ip);
4078: ($name)=gethostbyaddr($netaddr,AF_INET);
4079: }
4080: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4081: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4082: #127.0.0.1
4083: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4084: } else {
4085: #some.name.com
4086: if (!defined($name)) {
4087: use Socket;
4088: my $netaddr=inet_aton($ip);
4089: ($name)=gethostbyaddr($netaddr,AF_INET);
4090: }
4091: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4092: }
4093: if ($allowed) { last; }
4094: }
4095: return $allowed;
4096: }
4097:
4098: ###############################################
4099:
1.60 matthew 4100: =pod
4101:
1.112 bowersj2 4102: =head1 Domain Template Functions
4103:
4104: =over 4
4105:
4106: =item * &determinedomain()
1.60 matthew 4107:
4108: Inputs: $domain (usually will be undef)
4109:
1.63 www 4110: Returns: Determines which domain should be used for designs
1.60 matthew 4111:
4112: =cut
1.54 www 4113:
1.60 matthew 4114: ###############################################
1.63 www 4115: sub determinedomain {
4116: my $domain=shift;
1.531 albertel 4117: if (! $domain) {
1.60 matthew 4118: # Determine domain if we have not been given one
1.893 raeburn 4119: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4120: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4121: if ($env{'request.role.domain'}) {
4122: $domain=$env{'request.role.domain'};
1.60 matthew 4123: }
4124: }
1.63 www 4125: return $domain;
4126: }
4127: ###############################################
1.517 raeburn 4128:
1.518 albertel 4129: sub devalidate_domconfig_cache {
4130: my ($udom)=@_;
4131: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4132: }
4133:
4134: # ---------------------- Get domain configuration for a domain
4135: sub get_domainconf {
4136: my ($udom) = @_;
4137: my $cachetime=1800;
4138: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4139: if (defined($cached)) { return %{$result}; }
4140:
4141: my %domconfig = &Apache::lonnet::get_dom('configuration',
4142: ['login','rolecolors'],$udom);
1.632 raeburn 4143: my (%designhash,%legacy);
1.518 albertel 4144: if (keys(%domconfig) > 0) {
4145: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4146: if (keys(%{$domconfig{'login'}})) {
4147: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4148: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4149: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4150: $designhash{$udom.'.login.'.$key.'_'.$img} =
4151: $domconfig{'login'}{$key}{$img};
4152: }
4153: } else {
4154: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4155: }
1.632 raeburn 4156: }
4157: } else {
4158: $legacy{'login'} = 1;
1.518 albertel 4159: }
1.632 raeburn 4160: } else {
4161: $legacy{'login'} = 1;
1.518 albertel 4162: }
4163: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4164: if (keys(%{$domconfig{'rolecolors'}})) {
4165: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4166: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4167: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4168: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4169: }
1.518 albertel 4170: }
4171: }
1.632 raeburn 4172: } else {
4173: $legacy{'rolecolors'} = 1;
1.518 albertel 4174: }
1.632 raeburn 4175: } else {
4176: $legacy{'rolecolors'} = 1;
1.518 albertel 4177: }
1.632 raeburn 4178: if (keys(%legacy) > 0) {
4179: my %legacyhash = &get_legacy_domconf($udom);
4180: foreach my $item (keys(%legacyhash)) {
4181: if ($item =~ /^\Q$udom\E\.login/) {
4182: if ($legacy{'login'}) {
4183: $designhash{$item} = $legacyhash{$item};
4184: }
4185: } else {
4186: if ($legacy{'rolecolors'}) {
4187: $designhash{$item} = $legacyhash{$item};
4188: }
1.518 albertel 4189: }
4190: }
4191: }
1.632 raeburn 4192: } else {
4193: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4194: }
4195: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4196: $cachetime);
4197: return %designhash;
4198: }
4199:
1.632 raeburn 4200: sub get_legacy_domconf {
4201: my ($udom) = @_;
4202: my %legacyhash;
4203: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4204: my $designfile = $designdir.'/'.$udom.'.tab';
4205: if (-e $designfile) {
4206: if ( open (my $fh,"<$designfile") ) {
4207: while (my $line = <$fh>) {
4208: next if ($line =~ /^\#/);
4209: chomp($line);
4210: my ($key,$val)=(split(/\=/,$line));
4211: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4212: }
4213: close($fh);
4214: }
4215: }
4216: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4217: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4218: }
4219: return %legacyhash;
4220: }
4221:
1.63 www 4222: =pod
4223:
1.112 bowersj2 4224: =item * &domainlogo()
1.63 www 4225:
4226: Inputs: $domain (usually will be undef)
4227:
4228: Returns: A link to a domain logo, if the domain logo exists.
4229: If the domain logo does not exist, a description of the domain.
4230:
4231: =cut
1.112 bowersj2 4232:
1.63 www 4233: ###############################################
4234: sub domainlogo {
1.517 raeburn 4235: my $domain = &determinedomain(shift);
1.518 albertel 4236: my %designhash = &get_domainconf($domain);
1.517 raeburn 4237: # See if there is a logo
4238: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4239: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4240: if ($imgsrc =~ m{^/(adm|res)/}) {
4241: if ($imgsrc =~ m{^/res/}) {
4242: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4243: &Apache::lonnet::repcopy($local_name);
4244: }
4245: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4246: }
4247: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4248: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4249: return &Apache::lonnet::domain($domain,'description');
1.59 www 4250: } else {
1.60 matthew 4251: return '';
1.59 www 4252: }
4253: }
1.63 www 4254: ##############################################
4255:
4256: =pod
4257:
1.112 bowersj2 4258: =item * &designparm()
1.63 www 4259:
4260: Inputs: $which parameter; $domain (usually will be undef)
4261:
4262: Returns: value of designparamter $which
4263:
4264: =cut
1.112 bowersj2 4265:
1.397 albertel 4266:
1.400 albertel 4267: ##############################################
1.397 albertel 4268: sub designparm {
4269: my ($which,$domain)=@_;
4270: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4271: return $env{'environment.color.'.$which};
1.96 www 4272: }
1.63 www 4273: $domain=&determinedomain($domain);
1.518 albertel 4274: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4275: my $output;
1.517 raeburn 4276: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4277: $output = $domdesign{$domain.'.'.$which};
1.63 www 4278: } else {
1.520 raeburn 4279: $output = $defaultdesign{$which};
4280: }
4281: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4282: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4283: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4284: if ($output =~ m{^/res/}) {
4285: my $local_name = &Apache::lonnet::filelocation('',$output);
4286: &Apache::lonnet::repcopy($local_name);
4287: }
1.520 raeburn 4288: $output = &lonhttpdurl($output);
4289: }
1.63 www 4290: }
1.520 raeburn 4291: return $output;
1.63 www 4292: }
1.59 www 4293:
1.822 bisitz 4294: ##############################################
4295: =pod
4296:
1.832 bisitz 4297: =item * &authorspace()
4298:
4299: Inputs: ./.
4300:
4301: Returns: Path to the Construction Space of the current user's
4302: accessed author space
4303: The author space will be that of the current user
4304: when accessing the own author space
4305: and that of the co-author/assistent co-author
4306: when accessing the co-author's/assistent co-author's
4307: space
4308:
4309: =cut
4310:
4311: sub authorspace {
4312: my $caname = '';
4313: if ($env{'request.role'} =~ /^ca|^aa/) {
4314: (undef,$caname) =
4315: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4316: } else {
4317: $caname = $env{'user.name'};
4318: }
4319: return '/priv/'.$caname.'/';
4320: }
4321:
4322: ##############################################
4323: =pod
4324:
1.822 bisitz 4325: =item * &head_subbox()
4326:
4327: Inputs: $content (contains HTML code with page functions, etc.)
4328:
4329: Returns: HTML div with $content
4330: To be included in page header
4331:
4332: =cut
4333:
4334: sub head_subbox {
4335: my ($content)=@_;
4336: my $output =
1.844 bisitz 4337: '<div id="LC_head_subbox">'
1.822 bisitz 4338: .$content
4339: .'</div>'
4340: }
4341:
4342: ##############################################
4343: =pod
4344:
4345: =item * &CSTR_pageheader()
4346:
4347: Inputs: ./.
4348:
4349: Returns: HTML div with CSTR path and recent box
4350: To be included on Construction Space pages
4351:
4352: =cut
4353:
4354: sub CSTR_pageheader {
4355: # this is for resources; directories have customtitle, and crumbs
4356: # and select recent are created in lonpubdir.pm
4357: my ($uname,$thisdisfn)=
4358: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4359: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4360: $formaction=~s/\/+/\//g;
4361:
4362: my $parentpath = '';
4363: my $lastitem = '';
4364: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4365: $parentpath = $1;
4366: $lastitem = $2;
4367: } else {
4368: $lastitem = $thisdisfn;
4369: }
1.921 bisitz 4370:
4371: my $output =
1.822 bisitz 4372: '<div>'
4373: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4374: .'<b>'.&mt('Construction Space:').'</b> '
4375: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4376: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4377: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4378:
4379: if ($lastitem) {
4380: $output .=
4381: '<span class="LC_filename">'
4382: .$lastitem
4383: .'</span>';
4384: }
4385: $output .=
4386: '<br />'
1.822 bisitz 4387: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4388: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4389: .'</form>'
4390: .&Apache::lonmenu::constspaceform()
4391: .'</div>';
1.921 bisitz 4392:
4393: return $output;
1.822 bisitz 4394: }
4395:
1.60 matthew 4396: ###############################################
4397: ###############################################
4398:
4399: =pod
4400:
1.112 bowersj2 4401: =back
4402:
1.549 albertel 4403: =head1 HTML Helpers
1.112 bowersj2 4404:
4405: =over 4
4406:
4407: =item * &bodytag()
1.60 matthew 4408:
4409: Returns a uniform header for LON-CAPA web pages.
4410:
4411: Inputs:
4412:
1.112 bowersj2 4413: =over 4
4414:
4415: =item * $title, A title to be displayed on the page.
4416:
4417: =item * $function, the current role (can be undef).
4418:
4419: =item * $addentries, extra parameters for the <body> tag.
4420:
4421: =item * $bodyonly, if defined, only return the <body> tag.
4422:
4423: =item * $domain, if defined, force a given domain.
4424:
4425: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4426: text interface only)
1.60 matthew 4427:
1.814 bisitz 4428: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4429: navigational links
1.317 albertel 4430:
1.338 albertel 4431: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4432:
1.361 albertel 4433: =item * $no_inline_link, if true and in remote mode, don't show the
4434: 'Switch To Inline Menu' link
4435:
1.460 albertel 4436: =item * $args, optional argument valid values are
4437: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4438: inherit_jsmath -> when creating popup window in a page,
4439: should it have jsmath forced on by the
4440: current page
1.460 albertel 4441:
1.112 bowersj2 4442: =back
4443:
1.60 matthew 4444: Returns: A uniform header for LON-CAPA web pages.
4445: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4446: If $bodyonly is undef or zero, an html string containing a <body> tag and
4447: other decorations will be returned.
4448:
4449: =cut
4450:
1.54 www 4451: sub bodytag {
1.831 bisitz 4452: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4453: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4454:
1.460 albertel 4455: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4456:
1.183 matthew 4457: $function = &get_users_function() if (!$function);
1.339 albertel 4458: my $img = &designparm($function.'.img',$domain);
4459: my $font = &designparm($function.'.font',$domain);
4460: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4461:
1.803 bisitz 4462: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4463: 'bgcolor' => $pgbg,
1.339 albertel 4464: 'text' => $font,
4465: 'alink' => &designparm($function.'.alink',$domain),
4466: 'vlink' => &designparm($function.'.vlink',$domain),
4467: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4468: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4469:
1.925.2.4! raeburn 4470: my $custommenu;
! 4471: if ($env{'environment.remote'} eq 'off') {
! 4472: $custommenu = &needs_gci_custom();
! 4473: }
1.63 www 4474: # role and realm
1.378 raeburn 4475: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4476: if ($role eq 'ca') {
1.479 albertel 4477: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4478: $realm = &plainname($rname,$rdom);
1.378 raeburn 4479: }
1.55 www 4480: # realm
1.258 albertel 4481: if ($env{'request.course.id'}) {
1.378 raeburn 4482: if ($env{'request.role'} !~ /^cr/) {
1.925.2.4! raeburn 4483: if (($custommenu) && ($role eq 'cm')) {
! 4484: undef($role);
! 4485: } else {
! 4486: $role = &Apache::lonnet::plaintext($role,&course_type());
! 4487: }
1.378 raeburn 4488: }
1.898 raeburn 4489: if ($env{'request.course.sec'}) {
4490: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4491: }
1.359 albertel 4492: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4493: } else {
1.925.2.4! raeburn 4494: if (($custommenu) && ($role eq 'cm')) {
! 4495: undef($role);
! 4496: } else {
! 4497: $role = &Apache::lonnet::plaintext($role);
! 4498: }
1.54 www 4499: }
1.433 albertel 4500:
1.359 albertel 4501: if (!$realm) { $realm=' '; }
1.55 www 4502: # Set messages
1.60 matthew 4503: my $messages=&domainlogo($domain);
1.330 albertel 4504:
1.438 albertel 4505: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4506:
1.101 www 4507: # construct main body tag
1.359 albertel 4508: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4509: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4510:
1.530 albertel 4511: if ($bodyonly) {
1.60 matthew 4512: return $bodytag;
1.798 tempelho 4513: }
1.359 albertel 4514:
1.410 albertel 4515: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4516: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4517: undef($role);
1.434 albertel 4518: } else {
4519: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4520: }
1.359 albertel 4521:
1.762 bisitz 4522: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4523: #
4524: # Extra info if you are the DC
4525: my $dc_info = '';
4526: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4527: $env{'course.'.$env{'request.course.id'}.
4528: '.domain'}.'/'})) {
4529: my $cid = $env{'request.course.id'};
1.917 raeburn 4530: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4531: $dc_info =~ s/\s+$//;
1.359 albertel 4532: }
4533:
1.898 raeburn 4534: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4535: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4536:
1.837 bisitz 4537: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4538: # No Remote
1.916 droeschl 4539: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4540: return $bodytag;
4541: }
1.903 droeschl 4542:
4543: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4544:
4545: # if ($env{'request.state'} eq 'construct') {
4546: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4547: # }
4548:
1.925.2.4! raeburn 4549: my $role_selector;
! 4550: if (($custommenu) && ($env{'request.course.id'}) &&
! 4551: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq 'gcitest')) {
! 4552: $role_selector = &Apache::lonmenu::roles_selector(
! 4553: $env{'course.' . $env{'request.course.id'} . '.domain'},
! 4554: $env{'course.' . $env{'request.course.id'} . '.num'} );
! 4555: if ($role_selector) {
! 4556: $role_selector = '<br />'.$role_selector;
! 4557: }
! 4558: }
1.359 albertel 4559:
1.916 droeschl 4560: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4561: if ($dc_info) {
4562: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4563: }
1.916 droeschl 4564: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4565: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4566: return $bodytag;
4567: }
1.894 droeschl 4568:
1.925.2.4! raeburn 4569: $bodytag .= qq|<div id="LC_nav_bar">$name $role $role_selector</div>|;
1.916 droeschl 4570:
1.903 droeschl 4571: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.925.2.2 raeburn 4572: Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
1.816 bisitz 4573:
1.903 droeschl 4574: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4575:
1.917 raeburn 4576: if ($dc_info) {
4577: $dc_info = &dc_courseid_toggle($dc_info);
4578: }
4579: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4580:
1.903 droeschl 4581: #don't show menus for public users
4582: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
1.925.2.2 raeburn 4583: if ($custommenu) {
4584: $bodytag .= &Apache::lonmenu::gci_secondary_menu();
4585: } else {
4586: $bodytag .= Apache::lonmenu::secondary_menu();
4587: }
1.903 droeschl 4588: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4589: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4590: if ($env{'request.state'} eq 'construct') {
4591: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4592: $args->{'bread_crumbs'});
4593: } elsif ($forcereg) {
4594: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4595: }
1.903 droeschl 4596: }else{
4597: # this is to seperate menu from content when there's no secondary
4598: # menu. Especially needed for public accessible ressources.
4599: $bodytag .= '<hr style="clear:both" />';
4600: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4601: }
1.903 droeschl 4602:
4603: #SD testing
4604: #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235 raeburn 4605: return $bodytag;
1.94 www 4606: }
1.95 www 4607:
1.93 www 4608: #
1.95 www 4609: # Top frame rendering, Remote is up
1.93 www 4610: #
1.359 albertel 4611:
1.517 raeburn 4612: my $imgsrc = $img;
4613: if ($img =~ /^\/adm/) {
1.575 albertel 4614: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4615: }
4616: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4617:
1.305 www 4618: # Explicit link to get inline menu
1.361 albertel 4619: my $menu= ($no_inline_link?''
1.883 droeschl 4620: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4621:
4622: if ($dc_info) {
4623: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4624: }
4625:
1.916 droeschl 4626: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4627: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4628: <li>$menu</li>
1.917 raeburn 4629: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4630: return(<<ENDBODY);
1.60 matthew 4631: $bodytag
1.359 albertel 4632: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4633: <tr><td>$upperleft</td>
4634: <td>$messages </td>
1.54 www 4635: </tr>
1.359 albertel 4636: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4637: </tr>
1.356 albertel 4638: </table>
1.54 www 4639: ENDBODY
1.182 matthew 4640: }
4641:
1.917 raeburn 4642: sub dc_courseid_toggle {
4643: my ($dc_info) = @_;
4644: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4645: '<a href="javascript:showCourseID();">'.
4646: &mt('(More ...)').'</a></span>'.
4647: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4648: }
4649:
1.330 albertel 4650: sub make_attr_string {
4651: my ($register,$attr_ref) = @_;
4652:
4653: if ($attr_ref && !ref($attr_ref)) {
4654: die("addentries Must be a hash ref ".
4655: join(':',caller(1))." ".
4656: join(':',caller(0))." ");
4657: }
4658:
4659: if ($register) {
1.339 albertel 4660: my ($on_load,$on_unload);
4661: foreach my $key (keys(%{$attr_ref})) {
4662: if (lc($key) eq 'onload') {
4663: $on_load.=$attr_ref->{$key}.';';
4664: delete($attr_ref->{$key});
4665:
4666: } elsif (lc($key) eq 'onunload') {
4667: $on_unload.=$attr_ref->{$key}.';';
4668: delete($attr_ref->{$key});
4669: }
4670: }
4671: $attr_ref->{'onload'} =
4672: &Apache::lonmenu::loadevents(). $on_load;
4673: $attr_ref->{'onunload'}=
4674: &Apache::lonmenu::unloadevents().$on_unload;
4675: }
4676:
4677: # Accessibility font enhance
4678: if ($env{'browser.fontenhance'} eq 'on') {
4679: my $style;
4680: foreach my $key (keys(%{$attr_ref})) {
4681: if (lc($key) eq 'style') {
4682: $style.=$attr_ref->{$key}.';';
4683: delete($attr_ref->{$key});
4684: }
4685: }
4686: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4687: }
1.339 albertel 4688:
1.330 albertel 4689: my $attr_string;
4690: foreach my $attr (keys(%$attr_ref)) {
4691: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4692: }
4693: return $attr_string;
4694: }
4695:
4696:
1.182 matthew 4697: ###############################################
1.251 albertel 4698: ###############################################
4699:
4700: =pod
4701:
4702: =item * &endbodytag()
4703:
4704: Returns a uniform footer for LON-CAPA web pages.
4705:
1.635 raeburn 4706: Inputs: 1 - optional reference to an args hash
4707: If in the hash, key for noredirectlink has a value which evaluates to true,
4708: a 'Continue' link is not displayed if the page contains an
4709: internal redirect in the <head></head> section,
4710: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4711:
4712: =cut
4713:
4714: sub endbodytag {
1.635 raeburn 4715: my ($args) = @_;
1.251 albertel 4716: my $endbodytag='</body>';
1.269 albertel 4717: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4718: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4719: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4720: $endbodytag=
4721: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4722: &mt('Continue').'</a>'.
4723: $endbodytag;
4724: }
1.315 albertel 4725: }
1.251 albertel 4726: return $endbodytag;
4727: }
4728:
1.352 albertel 4729: =pod
4730:
4731: =item * &standard_css()
4732:
4733: Returns a style sheet
4734:
4735: Inputs: (all optional)
4736: domain -> force to color decorate a page for a specific
4737: domain
4738: function -> force usage of a specific rolish color scheme
4739: bgcolor -> override the default page bgcolor
4740:
4741: =cut
4742:
1.343 albertel 4743: sub standard_css {
1.345 albertel 4744: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4745: $function = &get_users_function() if (!$function);
4746: my $img = &designparm($function.'.img', $domain);
4747: my $tabbg = &designparm($function.'.tabbg', $domain);
4748: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4749: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4750: #second colour for later usage
1.345 albertel 4751: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4752: my $pgbg_or_bgcolor =
4753: $bgcolor ||
1.352 albertel 4754: &designparm($function.'.pgbg', $domain);
1.382 albertel 4755: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4756: my $alink = &designparm($function.'.alink', $domain);
4757: my $vlink = &designparm($function.'.vlink', $domain);
4758: my $link = &designparm($function.'.link', $domain);
4759:
1.704 muellerd 4760: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4761: my $bgcol = &designparm('login.bgcol',$domain);
4762: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4763:
1.602 albertel 4764: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4765: my $mono = 'monospace';
1.850 bisitz 4766: my $data_table_head = $sidebg;
4767: my $data_table_light = '#FAFAFA';
4768: my $data_table_dark = '#F0F0F0';
1.470 banghart 4769: my $data_table_darker = '#CCCCCC';
1.349 albertel 4770: my $data_table_highlight = '#FFFF00';
1.352 albertel 4771: my $mail_new = '#FFBB77';
4772: my $mail_new_hover = '#DD9955';
4773: my $mail_read = '#BBBB77';
4774: my $mail_read_hover = '#999944';
4775: my $mail_replied = '#AAAA88';
4776: my $mail_replied_hover = '#888855';
4777: my $mail_other = '#99BBBB';
4778: my $mail_other_hover = '#669999';
1.391 albertel 4779: my $table_header = '#DDDDDD';
1.489 raeburn 4780: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4781: my $lg_border_color = '#C8C8C8';
1.392 albertel 4782:
1.608 albertel 4783: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4784: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4785: : '0 3px 0 4px';
1.448 albertel 4786:
1.523 albertel 4787:
1.343 albertel 4788: return <<END;
1.795 www 4789: body {
1.911 bisitz 4790: font-family: $sans;
4791: line-height:130%;
4792: font-size:0.83em;
4793: color:$font;
1.795 www 4794: }
4795:
1.911 bisitz 4796: a:focus {
1.795 www 4797: color: red;
1.911 bisitz 4798: background: yellow;
1.795 www 4799: }
1.698 harmsja 4800:
1.911 bisitz 4801: form, .inline {
4802: display: inline;
1.795 www 4803: }
1.721 harmsja 4804:
1.795 www 4805: .LC_right {
1.911 bisitz 4806: text-align:right;
1.795 www 4807: }
4808:
4809: .LC_middle {
1.911 bisitz 4810: vertical-align:middle;
1.795 www 4811: }
1.721 harmsja 4812:
4813: /* just for tests */
1.911 bisitz 4814: .LC_400Box {
4815: width:400px;
4816: }
1.721 harmsja 4817: /* end */
4818:
1.778 bisitz 4819: .LC_filename {
4820: font-family: $mono;
4821: white-space:pre;
1.921 bisitz 4822: font-size: 120%;
1.778 bisitz 4823: }
4824:
4825: .LC_fileicon {
4826: border: none;
4827: height: 1.3em;
4828: vertical-align: text-bottom;
4829: margin-right: 0.3em;
4830: text-decoration:none;
4831: }
4832:
1.350 albertel 4833: .LC_error {
4834: color: red;
4835: font-size: larger;
4836: }
1.795 www 4837:
1.457 albertel 4838: .LC_warning,
4839: .LC_diff_removed {
1.733 bisitz 4840: color: red;
1.394 albertel 4841: }
1.532 albertel 4842:
4843: .LC_info,
1.457 albertel 4844: .LC_success,
4845: .LC_diff_added {
1.350 albertel 4846: color: green;
4847: }
1.795 www 4848:
1.802 bisitz 4849: div.LC_confirm_box {
4850: background-color: #FAFAFA;
4851: border: 1px solid $lg_border_color;
4852: margin-right: 0;
4853: padding: 5px;
4854: }
4855:
4856: div.LC_confirm_box .LC_error img,
4857: div.LC_confirm_box .LC_success img {
4858: vertical-align: middle;
4859: }
4860:
1.440 albertel 4861: .LC_icon {
1.771 droeschl 4862: border: none;
1.790 droeschl 4863: vertical-align: middle;
1.771 droeschl 4864: }
4865:
1.543 albertel 4866: .LC_docs_spacer {
4867: width: 25px;
4868: height: 1px;
1.771 droeschl 4869: border: none;
1.543 albertel 4870: }
1.346 albertel 4871:
1.532 albertel 4872: .LC_internal_info {
1.735 bisitz 4873: color: #999999;
1.532 albertel 4874: }
4875:
1.794 www 4876: .LC_discussion {
1.911 bisitz 4877: background: $tabbg;
4878: border: 1px solid black;
4879: margin: 2px;
1.794 www 4880: }
4881:
4882: .LC_disc_action_links_bar {
1.911 bisitz 4883: background: $tabbg;
4884: border: none;
4885: margin: 4px;
1.794 www 4886: }
4887:
4888: .LC_disc_action_left {
1.911 bisitz 4889: text-align: left;
1.794 www 4890: }
4891:
4892: .LC_disc_action_right {
1.911 bisitz 4893: text-align: right;
1.794 www 4894: }
4895:
4896: .LC_disc_new_item {
1.911 bisitz 4897: background: white;
4898: border: 2px solid red;
4899: margin: 2px;
1.794 www 4900: }
4901:
4902: .LC_disc_old_item {
1.911 bisitz 4903: background: white;
4904: border: 1px solid black;
4905: margin: 2px;
1.794 www 4906: }
4907:
1.458 albertel 4908: table.LC_pastsubmission {
4909: border: 1px solid black;
4910: margin: 2px;
4911: }
4912:
1.924 bisitz 4913: table#LC_menubuttons {
1.345 albertel 4914: width: 100%;
4915: background: $pgbg;
1.392 albertel 4916: border: 2px;
1.402 albertel 4917: border-collapse: separate;
1.803 bisitz 4918: padding: 0;
1.345 albertel 4919: }
1.392 albertel 4920:
1.801 tempelho 4921: table#LC_title_bar a {
4922: color: $fontmenu;
4923: }
1.836 bisitz 4924:
1.807 droeschl 4925: table#LC_title_bar {
1.819 tempelho 4926: clear: both;
1.836 bisitz 4927: display: none;
1.807 droeschl 4928: }
4929:
1.795 www 4930: table#LC_title_bar,
4931: table.LC_breadcrumbs,
1.393 albertel 4932: table#LC_title_bar.LC_with_remote {
1.359 albertel 4933: width: 100%;
1.392 albertel 4934: border-color: $pgbg;
4935: border-style: solid;
4936: border-width: $border;
1.379 albertel 4937: background: $pgbg;
1.801 tempelho 4938: color: $fontmenu;
1.392 albertel 4939: border-collapse: collapse;
1.803 bisitz 4940: padding: 0;
1.819 tempelho 4941: margin: 0;
1.359 albertel 4942: }
1.795 www 4943:
1.913 droeschl 4944: /* #SD START (work in progress)*/
4945:
4946: ul.LC_bct {
4947: margin: 0;
4948: padding: 0;
4949: }
4950: ul.LC_bct ol {
4951: display: inline;
4952: }
4953: ul.LC_bct ul {
4954: display: inline;
4955: padding: 0;
4956: }
4957: ul.LC_bct li {
4958: list-style-type: none;
4959: display: inline;
4960: }
4961:
4962:
4963: ul.LC_breadcrumb_tools {
4964: }
4965:
4966: li.LC_breadcrumb_tools {
4967: }
4968: li.LC_breadcrumb_tools img{
4969: vertical-align: middle;
4970: }
4971:
4972: .LC_breadcrumb_tools_A {
4973: margin: 0 0 0 1em;
4974: }
4975: .LC_breadcrumb_tools_B {
4976: float: right;
4977: margin-top: 0.4em;
4978: }
4979: .LC_breadcrumb_tools_C {
4980: margin: 0 1em 0 0;
4981: float: right;
4982: }
4983: /* #SD END */
4984:
1.359 albertel 4985: table#LC_title_bar td {
4986: background: $tabbg;
4987: }
1.795 www 4988:
1.911 bisitz 4989: table#LC_menubuttons img {
1.803 bisitz 4990: border: none;
1.346 albertel 4991: }
1.795 www 4992:
1.842 droeschl 4993: .LC_breadcrumbs_component {
1.911 bisitz 4994: float: right;
4995: margin: 0 1em;
1.357 albertel 4996: }
1.842 droeschl 4997: .LC_breadcrumbs_component img {
1.911 bisitz 4998: vertical-align: middle;
1.777 tempelho 4999: }
1.795 www 5000:
1.383 albertel 5001: td.LC_table_cell_checkbox {
5002: text-align: center;
5003: }
1.795 www 5004:
5005: .LC_fontsize_small {
1.911 bisitz 5006: font-size: 70%;
1.705 tempelho 5007: }
5008:
1.844 bisitz 5009: #LC_breadcrumbs {
1.911 bisitz 5010: clear:both;
5011: background: $sidebg;
5012: border-bottom: 1px solid $lg_border_color;
5013: line-height: 2.5em;
1.915 droeschl 5014: /* SD working here
5015: height: 2.5em;
5016: overflow: hidden; */
1.911 bisitz 5017: margin: 0;
5018: padding: 0;
1.819 tempelho 5019: }
1.862 bisitz 5020:
1.839 droeschl 5021: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5022: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5023: display:none;
1.839 droeschl 5024: }
1.819 tempelho 5025:
1.844 bisitz 5026: #LC_head_subbox {
1.911 bisitz 5027: clear:both;
5028: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5029: border: 1px solid $sidebg;
5030: margin: 0 0 10px 0;
1.822 bisitz 5031: }
5032:
1.795 www 5033: .LC_fontsize_medium {
1.911 bisitz 5034: font-size: 85%;
1.705 tempelho 5035: }
5036:
1.795 www 5037: .LC_fontsize_large {
1.911 bisitz 5038: font-size: 120%;
1.705 tempelho 5039: }
5040:
1.346 albertel 5041: .LC_menubuttons_inline_text {
5042: color: $font;
1.698 harmsja 5043: font-size: 90%;
1.701 harmsja 5044: padding-left:3px;
1.346 albertel 5045: }
5046:
1.526 www 5047: .LC_menubuttons_link {
5048: text-decoration: none;
5049: }
1.795 www 5050:
1.522 albertel 5051: .LC_menubuttons_category {
1.521 www 5052: color: $font;
1.526 www 5053: background: $pgbg;
1.521 www 5054: font-size: larger;
5055: font-weight: bold;
5056: }
5057:
1.346 albertel 5058: td.LC_menubuttons_text {
1.911 bisitz 5059: color: $font;
1.346 albertel 5060: }
1.706 harmsja 5061:
1.346 albertel 5062: .LC_current_location {
5063: background: $tabbg;
5064: }
1.795 www 5065:
5066: table.LC_data_table,
5067: table.LC_mail_list {
1.347 albertel 5068: border: 1px solid #000000;
1.402 albertel 5069: border-collapse: separate;
1.426 albertel 5070: border-spacing: 1px;
1.610 albertel 5071: background: $pgbg;
1.347 albertel 5072: }
1.795 www 5073:
1.422 albertel 5074: .LC_data_table_dense {
5075: font-size: small;
5076: }
1.795 www 5077:
1.507 raeburn 5078: table.LC_nested_outer {
5079: border: 1px solid #000000;
1.589 raeburn 5080: border-collapse: collapse;
1.803 bisitz 5081: border-spacing: 0;
1.507 raeburn 5082: width: 100%;
5083: }
1.795 www 5084:
1.879 raeburn 5085: table.LC_innerpickbox,
1.507 raeburn 5086: table.LC_nested {
1.803 bisitz 5087: border: none;
1.589 raeburn 5088: border-collapse: collapse;
1.803 bisitz 5089: border-spacing: 0;
1.507 raeburn 5090: width: 100%;
5091: }
1.795 www 5092:
1.911 bisitz 5093: table.LC_data_table tr th,
5094: table.LC_calendar tr th,
1.795 www 5095: table.LC_mail_list tr th,
1.879 raeburn 5096: table.LC_prior_tries tr th,
5097: table.LC_innerpickbox tr th {
1.349 albertel 5098: font-weight: bold;
5099: background-color: $data_table_head;
1.801 tempelho 5100: color:$fontmenu;
1.701 harmsja 5101: font-size:90%;
1.347 albertel 5102: }
1.795 www 5103:
1.879 raeburn 5104: table.LC_innerpickbox tr th,
5105: table.LC_innerpickbox tr td {
5106: vertical-align: top;
5107: }
5108:
1.711 raeburn 5109: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5110: background-color: #CCCCCC;
1.711 raeburn 5111: font-weight: bold;
5112: text-align: left;
5113: }
1.795 www 5114:
1.912 bisitz 5115: table.LC_data_table tr.LC_odd_row > td {
5116: background-color: $data_table_light;
5117: padding: 2px;
5118: vertical-align: top;
5119: }
5120:
1.809 bisitz 5121: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5122: background-color: $data_table_light;
1.912 bisitz 5123: vertical-align: top;
5124: }
5125:
5126: table.LC_data_table tr.LC_even_row > td {
5127: background-color: $data_table_dark;
1.425 albertel 5128: padding: 2px;
1.900 bisitz 5129: vertical-align: top;
1.347 albertel 5130: }
1.795 www 5131:
1.809 bisitz 5132: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5133: background-color: $data_table_dark;
1.900 bisitz 5134: vertical-align: top;
1.347 albertel 5135: }
1.795 www 5136:
1.425 albertel 5137: table.LC_data_table tr.LC_data_table_highlight td {
5138: background-color: $data_table_darker;
5139: }
1.795 www 5140:
1.639 raeburn 5141: table.LC_data_table tr td.LC_leftcol_header {
5142: background-color: $data_table_head;
5143: font-weight: bold;
5144: }
1.795 www 5145:
1.451 albertel 5146: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5147: table.LC_nested tr.LC_empty_row td {
1.347 albertel 5148: background-color: #FFFFFF;
1.421 albertel 5149: font-weight: bold;
5150: font-style: italic;
5151: text-align: center;
5152: padding: 8px;
1.347 albertel 5153: }
1.795 www 5154:
1.890 droeschl 5155: table.LC_caption {
5156: }
5157:
1.507 raeburn 5158: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5159: padding: 4ex
5160: }
1.795 www 5161:
1.507 raeburn 5162: table.LC_nested_outer tr th {
5163: font-weight: bold;
1.801 tempelho 5164: color:$fontmenu;
1.507 raeburn 5165: background-color: $data_table_head;
1.701 harmsja 5166: font-size: small;
1.507 raeburn 5167: border-bottom: 1px solid #000000;
5168: }
1.795 www 5169:
1.507 raeburn 5170: table.LC_nested_outer tr td.LC_subheader {
5171: background-color: $data_table_head;
5172: font-weight: bold;
5173: font-size: small;
5174: border-bottom: 1px solid #000000;
5175: text-align: right;
1.451 albertel 5176: }
1.795 www 5177:
1.507 raeburn 5178: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5179: background-color: #CCCCCC;
1.451 albertel 5180: font-weight: bold;
5181: font-size: small;
1.507 raeburn 5182: text-align: center;
5183: }
1.795 www 5184:
1.589 raeburn 5185: table.LC_nested tr.LC_info_row td.LC_left_item,
5186: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5187: text-align: left;
1.451 albertel 5188: }
1.795 www 5189:
1.507 raeburn 5190: table.LC_nested td {
1.735 bisitz 5191: background-color: #FFFFFF;
1.451 albertel 5192: font-size: small;
1.507 raeburn 5193: }
1.795 www 5194:
1.507 raeburn 5195: table.LC_nested_outer tr th.LC_right_item,
5196: table.LC_nested tr.LC_info_row td.LC_right_item,
5197: table.LC_nested tr.LC_odd_row td.LC_right_item,
5198: table.LC_nested tr td.LC_right_item {
1.451 albertel 5199: text-align: right;
5200: }
5201:
1.507 raeburn 5202: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5203: background-color: #EEEEEE;
1.451 albertel 5204: }
5205:
1.473 raeburn 5206: table.LC_createuser {
5207: }
5208:
5209: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5210: font-size: small;
1.473 raeburn 5211: }
5212:
5213: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5214: background-color: #CCCCCC;
1.473 raeburn 5215: font-weight: bold;
5216: text-align: center;
5217: }
5218:
1.349 albertel 5219: table.LC_calendar {
5220: border: 1px solid #000000;
5221: border-collapse: collapse;
1.917 raeburn 5222: width: 98%;
1.349 albertel 5223: }
1.795 www 5224:
1.349 albertel 5225: table.LC_calendar_pickdate {
5226: font-size: xx-small;
5227: }
1.795 www 5228:
1.349 albertel 5229: table.LC_calendar tr td {
5230: border: 1px solid #000000;
5231: vertical-align: top;
1.917 raeburn 5232: width: 14%;
1.349 albertel 5233: }
1.795 www 5234:
1.349 albertel 5235: table.LC_calendar tr td.LC_calendar_day_empty {
5236: background-color: $data_table_dark;
5237: }
1.795 www 5238:
1.779 bisitz 5239: table.LC_calendar tr td.LC_calendar_day_current {
5240: background-color: $data_table_highlight;
1.777 tempelho 5241: }
1.795 www 5242:
1.349 albertel 5243: table.LC_mail_list tr.LC_mail_new {
5244: background-color: $mail_new;
5245: }
1.795 www 5246:
1.349 albertel 5247: table.LC_mail_list tr.LC_mail_new:hover {
5248: background-color: $mail_new_hover;
5249: }
1.795 www 5250:
1.349 albertel 5251: table.LC_mail_list tr.LC_mail_read {
5252: background-color: $mail_read;
5253: }
1.795 www 5254:
1.349 albertel 5255: table.LC_mail_list tr.LC_mail_read:hover {
5256: background-color: $mail_read_hover;
5257: }
1.795 www 5258:
1.349 albertel 5259: table.LC_mail_list tr.LC_mail_replied {
5260: background-color: $mail_replied;
5261: }
1.795 www 5262:
1.349 albertel 5263: table.LC_mail_list tr.LC_mail_replied:hover {
5264: background-color: $mail_replied_hover;
5265: }
1.795 www 5266:
1.349 albertel 5267: table.LC_mail_list tr.LC_mail_other {
5268: background-color: $mail_other;
5269: }
1.795 www 5270:
1.349 albertel 5271: table.LC_mail_list tr.LC_mail_other:hover {
5272: background-color: $mail_other_hover;
5273: }
1.494 raeburn 5274:
1.777 tempelho 5275: table.LC_data_table tr > td.LC_browser_file,
5276: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5277: background: #AAEE77;
1.389 albertel 5278: }
1.795 www 5279:
1.777 tempelho 5280: table.LC_data_table tr > td.LC_browser_file_locked,
5281: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5282: background: #FFAA99;
1.387 albertel 5283: }
1.795 www 5284:
1.777 tempelho 5285: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5286: background: #888888;
1.779 bisitz 5287: }
1.795 www 5288:
1.777 tempelho 5289: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5290: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5291: background: #F8F866;
1.777 tempelho 5292: }
1.795 www 5293:
1.696 bisitz 5294: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5295: background: #E0E8FF;
1.387 albertel 5296: }
1.696 bisitz 5297:
1.707 bisitz 5298: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5299: /* background: #77FF77; */
1.707 bisitz 5300: }
1.795 www 5301:
1.707 bisitz 5302: table.LC_data_table tr > td.LC_roles_future {
5303: background: #FFFF77;
5304: }
1.795 www 5305:
1.707 bisitz 5306: table.LC_data_table tr > td.LC_roles_will {
5307: background: #FFAA77;
5308: }
1.795 www 5309:
1.707 bisitz 5310: table.LC_data_table tr > td.LC_roles_expired {
5311: background: #FF7777;
5312: }
1.795 www 5313:
1.707 bisitz 5314: table.LC_data_table tr > td.LC_roles_will_not {
5315: background: #AAFF77;
5316: }
1.795 www 5317:
1.707 bisitz 5318: table.LC_data_table tr > td.LC_roles_selected {
5319: background: #11CC55;
5320: }
5321:
1.388 albertel 5322: span.LC_current_location {
1.701 harmsja 5323: font-size:larger;
1.388 albertel 5324: background: $pgbg;
5325: }
1.387 albertel 5326:
1.395 albertel 5327: span.LC_parm_menu_item {
5328: font-size: larger;
5329: }
1.795 www 5330:
1.395 albertel 5331: span.LC_parm_scope_all {
5332: color: red;
5333: }
1.795 www 5334:
1.395 albertel 5335: span.LC_parm_scope_folder {
5336: color: green;
5337: }
1.795 www 5338:
1.395 albertel 5339: span.LC_parm_scope_resource {
5340: color: orange;
5341: }
1.795 www 5342:
1.395 albertel 5343: span.LC_parm_part {
5344: color: blue;
5345: }
1.795 www 5346:
1.911 bisitz 5347: span.LC_parm_folder,
5348: span.LC_parm_symb {
1.395 albertel 5349: font-size: x-small;
5350: font-family: $mono;
5351: color: #AAAAAA;
5352: }
5353:
1.795 www 5354: td.LC_parm_overview_level_menu,
5355: td.LC_parm_overview_map_menu,
5356: td.LC_parm_overview_parm_selectors,
5357: td.LC_parm_overview_restrictions {
1.396 albertel 5358: border: 1px solid black;
5359: border-collapse: collapse;
5360: }
1.795 www 5361:
1.396 albertel 5362: table.LC_parm_overview_restrictions td {
5363: border-width: 1px 4px 1px 4px;
5364: border-style: solid;
5365: border-color: $pgbg;
5366: text-align: center;
5367: }
1.795 www 5368:
1.396 albertel 5369: table.LC_parm_overview_restrictions th {
5370: background: $tabbg;
5371: border-width: 1px 4px 1px 4px;
5372: border-style: solid;
5373: border-color: $pgbg;
5374: }
1.795 www 5375:
1.398 albertel 5376: table#LC_helpmenu {
1.803 bisitz 5377: border: none;
1.398 albertel 5378: height: 55px;
1.803 bisitz 5379: border-spacing: 0;
1.398 albertel 5380: }
5381:
5382: table#LC_helpmenu fieldset legend {
5383: font-size: larger;
5384: }
1.795 www 5385:
1.397 albertel 5386: table#LC_helpmenu_links {
5387: width: 100%;
5388: border: 1px solid black;
5389: background: $pgbg;
1.803 bisitz 5390: padding: 0;
1.397 albertel 5391: border-spacing: 1px;
5392: }
1.795 www 5393:
1.397 albertel 5394: table#LC_helpmenu_links tr td {
5395: padding: 1px;
5396: background: $tabbg;
1.399 albertel 5397: text-align: center;
5398: font-weight: bold;
1.397 albertel 5399: }
1.396 albertel 5400:
1.795 www 5401: table#LC_helpmenu_links a:link,
5402: table#LC_helpmenu_links a:visited,
1.397 albertel 5403: table#LC_helpmenu_links a:active {
5404: text-decoration: none;
5405: color: $font;
5406: }
1.795 www 5407:
1.397 albertel 5408: table#LC_helpmenu_links a:hover {
5409: text-decoration: underline;
5410: color: $vlink;
5411: }
1.396 albertel 5412:
1.417 albertel 5413: .LC_chrt_popup_exists {
5414: border: 1px solid #339933;
5415: margin: -1px;
5416: }
1.795 www 5417:
1.417 albertel 5418: .LC_chrt_popup_up {
5419: border: 1px solid yellow;
5420: margin: -1px;
5421: }
1.795 www 5422:
1.417 albertel 5423: .LC_chrt_popup {
5424: border: 1px solid #8888FF;
5425: background: #CCCCFF;
5426: }
1.795 www 5427:
1.421 albertel 5428: table.LC_pick_box {
5429: border-collapse: separate;
5430: background: white;
5431: border: 1px solid black;
5432: border-spacing: 1px;
5433: }
1.795 www 5434:
1.421 albertel 5435: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5436: background: $sidebg;
1.421 albertel 5437: font-weight: bold;
1.900 bisitz 5438: text-align: left;
1.740 bisitz 5439: vertical-align: top;
1.421 albertel 5440: width: 184px;
5441: padding: 8px;
5442: }
1.795 www 5443:
1.579 raeburn 5444: table.LC_pick_box td.LC_pick_box_value {
5445: text-align: left;
5446: padding: 8px;
5447: }
1.795 www 5448:
1.579 raeburn 5449: table.LC_pick_box td.LC_pick_box_select {
5450: text-align: left;
5451: padding: 8px;
5452: }
1.795 www 5453:
1.424 albertel 5454: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5455: padding: 0;
1.421 albertel 5456: height: 1px;
5457: background: black;
5458: }
1.795 www 5459:
1.421 albertel 5460: table.LC_pick_box td.LC_pick_box_submit {
5461: text-align: right;
5462: }
1.795 www 5463:
1.579 raeburn 5464: table.LC_pick_box td.LC_evenrow_value {
5465: text-align: left;
5466: padding: 8px;
5467: background-color: $data_table_light;
5468: }
1.795 www 5469:
1.579 raeburn 5470: table.LC_pick_box td.LC_oddrow_value {
5471: text-align: left;
5472: padding: 8px;
5473: background-color: $data_table_light;
5474: }
1.795 www 5475:
1.579 raeburn 5476: span.LC_helpform_receipt_cat {
5477: font-weight: bold;
5478: }
1.795 www 5479:
1.424 albertel 5480: table.LC_group_priv_box {
5481: background: white;
5482: border: 1px solid black;
5483: border-spacing: 1px;
5484: }
1.795 www 5485:
1.424 albertel 5486: table.LC_group_priv_box td.LC_pick_box_title {
5487: background: $tabbg;
5488: font-weight: bold;
5489: text-align: right;
5490: width: 184px;
5491: }
1.795 www 5492:
1.424 albertel 5493: table.LC_group_priv_box td.LC_groups_fixed {
5494: background: $data_table_light;
5495: text-align: center;
5496: }
1.795 www 5497:
1.424 albertel 5498: table.LC_group_priv_box td.LC_groups_optional {
5499: background: $data_table_dark;
5500: text-align: center;
5501: }
1.795 www 5502:
1.424 albertel 5503: table.LC_group_priv_box td.LC_groups_functionality {
5504: background: $data_table_darker;
5505: text-align: center;
5506: font-weight: bold;
5507: }
1.795 www 5508:
1.424 albertel 5509: table.LC_group_priv td {
5510: text-align: left;
1.803 bisitz 5511: padding: 0;
1.424 albertel 5512: }
5513:
1.421 albertel 5514: table.LC_notify_front_page {
5515: background: white;
5516: border: 1px solid black;
5517: padding: 8px;
5518: }
1.795 www 5519:
1.421 albertel 5520: table.LC_notify_front_page td {
5521: padding: 8px;
5522: }
1.795 www 5523:
1.424 albertel 5524: .LC_navbuttons {
5525: margin: 2ex 0ex 2ex 0ex;
5526: }
1.795 www 5527:
1.423 albertel 5528: .LC_topic_bar {
5529: font-weight: bold;
5530: background: $tabbg;
1.918 wenzelju 5531: margin: 1em 0em 1em 2em;
1.805 bisitz 5532: padding: 3px;
1.918 wenzelju 5533: font-size: 1.2em;
1.423 albertel 5534: }
1.795 www 5535:
1.423 albertel 5536: .LC_topic_bar span {
1.918 wenzelju 5537: left: 0.5em;
5538: position: absolute;
1.423 albertel 5539: vertical-align: middle;
1.918 wenzelju 5540: font-size: 1.2em;
1.423 albertel 5541: }
1.795 www 5542:
1.423 albertel 5543: .LC_topic_bar img {
5544: vertical-align: bottom;
5545: }
1.795 www 5546:
1.423 albertel 5547: table.LC_course_group_status {
5548: margin: 20px;
5549: }
1.795 www 5550:
1.423 albertel 5551: table.LC_status_selector td {
5552: vertical-align: top;
5553: text-align: center;
1.424 albertel 5554: padding: 4px;
5555: }
1.795 www 5556:
1.599 albertel 5557: div.LC_feedback_link {
1.616 albertel 5558: clear: both;
1.829 kalberla 5559: background: $sidebg;
1.779 bisitz 5560: width: 100%;
1.829 kalberla 5561: padding-bottom: 10px;
5562: border: 1px $tabbg solid;
1.833 kalberla 5563: height: 22px;
5564: line-height: 22px;
5565: padding-top: 5px;
5566: }
5567:
5568: div.LC_feedback_link img {
5569: height: 22px;
1.867 kalberla 5570: vertical-align:middle;
1.829 kalberla 5571: }
5572:
1.911 bisitz 5573: div.LC_feedback_link a {
1.829 kalberla 5574: text-decoration: none;
1.489 raeburn 5575: }
1.795 www 5576:
1.867 kalberla 5577: div.LC_comblock {
1.911 bisitz 5578: display:inline;
1.867 kalberla 5579: color:$font;
5580: font-size:90%;
5581: }
5582:
5583: div.LC_feedback_link div.LC_comblock {
5584: padding-left:5px;
5585: }
5586:
5587: div.LC_feedback_link div.LC_comblock a {
5588: color:$font;
5589: }
5590:
1.489 raeburn 5591: span.LC_feedback_link {
1.858 bisitz 5592: /* background: $feedback_link_bg; */
1.599 albertel 5593: font-size: larger;
5594: }
1.795 www 5595:
1.599 albertel 5596: span.LC_message_link {
1.858 bisitz 5597: /* background: $feedback_link_bg; */
1.599 albertel 5598: font-size: larger;
5599: position: absolute;
5600: right: 1em;
1.489 raeburn 5601: }
1.421 albertel 5602:
1.515 albertel 5603: table.LC_prior_tries {
1.524 albertel 5604: border: 1px solid #000000;
5605: border-collapse: separate;
5606: border-spacing: 1px;
1.515 albertel 5607: }
1.523 albertel 5608:
1.515 albertel 5609: table.LC_prior_tries td {
1.524 albertel 5610: padding: 2px;
1.515 albertel 5611: }
1.523 albertel 5612:
5613: .LC_answer_correct {
1.795 www 5614: background: lightgreen;
5615: color: darkgreen;
5616: padding: 6px;
1.523 albertel 5617: }
1.795 www 5618:
1.523 albertel 5619: .LC_answer_charged_try {
1.797 www 5620: background: #FFAAAA;
1.795 www 5621: color: darkred;
5622: padding: 6px;
1.523 albertel 5623: }
1.795 www 5624:
1.779 bisitz 5625: .LC_answer_not_charged_try,
1.523 albertel 5626: .LC_answer_no_grade,
5627: .LC_answer_late {
1.795 www 5628: background: lightyellow;
1.523 albertel 5629: color: black;
1.795 www 5630: padding: 6px;
1.523 albertel 5631: }
1.795 www 5632:
1.523 albertel 5633: .LC_answer_previous {
1.795 www 5634: background: lightblue;
5635: color: darkblue;
5636: padding: 6px;
1.523 albertel 5637: }
1.795 www 5638:
1.779 bisitz 5639: .LC_answer_no_message {
1.777 tempelho 5640: background: #FFFFFF;
5641: color: black;
1.795 www 5642: padding: 6px;
1.779 bisitz 5643: }
1.795 www 5644:
1.779 bisitz 5645: .LC_answer_unknown {
5646: background: orange;
5647: color: black;
1.795 www 5648: padding: 6px;
1.777 tempelho 5649: }
1.795 www 5650:
1.529 albertel 5651: span.LC_prior_numerical,
5652: span.LC_prior_string,
5653: span.LC_prior_custom,
5654: span.LC_prior_reaction,
5655: span.LC_prior_math {
1.925 bisitz 5656: font-family: $mono;
1.523 albertel 5657: white-space: pre;
5658: }
5659:
1.525 albertel 5660: span.LC_prior_string {
1.925 bisitz 5661: font-family: $mono;
1.525 albertel 5662: white-space: pre;
5663: }
5664:
1.523 albertel 5665: table.LC_prior_option {
5666: width: 100%;
5667: border-collapse: collapse;
5668: }
1.795 www 5669:
1.911 bisitz 5670: table.LC_prior_rank,
1.795 www 5671: table.LC_prior_match {
1.528 albertel 5672: border-collapse: collapse;
5673: }
1.795 www 5674:
1.528 albertel 5675: table.LC_prior_option tr td,
5676: table.LC_prior_rank tr td,
5677: table.LC_prior_match tr td {
1.524 albertel 5678: border: 1px solid #000000;
1.515 albertel 5679: }
5680:
1.855 bisitz 5681: .LC_nobreak {
1.544 albertel 5682: white-space: nowrap;
1.519 raeburn 5683: }
5684:
1.576 raeburn 5685: span.LC_cusr_emph {
5686: font-style: italic;
5687: }
5688:
1.633 raeburn 5689: span.LC_cusr_subheading {
5690: font-weight: normal;
5691: font-size: 85%;
5692: }
5693:
1.861 bisitz 5694: div.LC_docs_entry_move {
1.859 bisitz 5695: border: 1px solid #BBBBBB;
1.545 albertel 5696: background: #DDDDDD;
1.861 bisitz 5697: width: 22px;
1.859 bisitz 5698: padding: 1px;
5699: margin: 0;
1.545 albertel 5700: }
5701:
1.861 bisitz 5702: table.LC_data_table tr > td.LC_docs_entry_commands,
5703: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5704: background: #DDDDDD;
5705: font-size: x-small;
5706: }
1.795 www 5707:
1.861 bisitz 5708: .LC_docs_entry_parameter {
5709: white-space: nowrap;
5710: }
5711:
1.544 albertel 5712: .LC_docs_copy {
1.545 albertel 5713: color: #000099;
1.544 albertel 5714: }
1.795 www 5715:
1.544 albertel 5716: .LC_docs_cut {
1.545 albertel 5717: color: #550044;
1.544 albertel 5718: }
1.795 www 5719:
1.544 albertel 5720: .LC_docs_rename {
1.545 albertel 5721: color: #009900;
1.544 albertel 5722: }
1.795 www 5723:
1.544 albertel 5724: .LC_docs_remove {
1.545 albertel 5725: color: #990000;
5726: }
5727:
1.547 albertel 5728: .LC_docs_reinit_warn,
5729: .LC_docs_ext_edit {
5730: font-size: x-small;
5731: }
5732:
1.545 albertel 5733: table.LC_docs_adddocs td,
5734: table.LC_docs_adddocs th {
5735: border: 1px solid #BBBBBB;
5736: padding: 4px;
5737: background: #DDDDDD;
1.543 albertel 5738: }
5739:
1.584 albertel 5740: table.LC_sty_begin {
5741: background: #BBFFBB;
5742: }
1.795 www 5743:
1.584 albertel 5744: table.LC_sty_end {
5745: background: #FFBBBB;
5746: }
5747:
1.589 raeburn 5748: table.LC_double_column {
1.803 bisitz 5749: border-width: 0;
1.589 raeburn 5750: border-collapse: collapse;
5751: width: 100%;
5752: padding: 2px;
5753: }
5754:
5755: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5756: top: 2px;
1.589 raeburn 5757: left: 2px;
5758: width: 47%;
5759: vertical-align: top;
5760: }
5761:
5762: table.LC_double_column tr td.LC_right_col {
5763: top: 2px;
1.779 bisitz 5764: right: 2px;
1.589 raeburn 5765: width: 47%;
5766: vertical-align: top;
5767: }
5768:
1.591 raeburn 5769: div.LC_left_float {
5770: float: left;
5771: padding-right: 5%;
1.597 albertel 5772: padding-bottom: 4px;
1.591 raeburn 5773: }
5774:
5775: div.LC_clear_float_header {
1.597 albertel 5776: padding-bottom: 2px;
1.591 raeburn 5777: }
5778:
5779: div.LC_clear_float_footer {
1.597 albertel 5780: padding-top: 10px;
1.591 raeburn 5781: clear: both;
5782: }
5783:
1.597 albertel 5784: div.LC_grade_show_user {
5785: margin-top: 20px;
5786: border: 1px solid black;
5787: }
1.795 www 5788:
1.597 albertel 5789: div.LC_grade_user_name {
5790: background: #DDDDEE;
5791: border-bottom: 1px solid black;
1.705 tempelho 5792: font-weight: bold;
5793: font-size: large;
1.597 albertel 5794: }
1.795 www 5795:
1.597 albertel 5796: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5797: background: #DDEEDD;
5798: }
5799:
5800: div.LC_grade_show_problem,
5801: div.LC_grade_submissions,
5802: div.LC_grade_message_center,
5803: div.LC_grade_info_links,
5804: div.LC_grade_assign {
5805: margin: 5px;
5806: width: 99%;
5807: background: #FFFFFF;
5808: }
1.795 www 5809:
1.597 albertel 5810: div.LC_grade_show_problem_header,
5811: div.LC_grade_submissions_header,
5812: div.LC_grade_message_center_header,
5813: div.LC_grade_assign_header {
1.705 tempelho 5814: font-weight: bold;
5815: font-size: large;
1.597 albertel 5816: }
1.795 www 5817:
1.597 albertel 5818: div.LC_grade_show_problem_problem,
5819: div.LC_grade_submissions_body,
5820: div.LC_grade_message_center_body,
5821: div.LC_grade_assign_body {
5822: border: 1px solid black;
5823: width: 99%;
5824: background: #FFFFFF;
5825: }
1.795 www 5826:
1.598 albertel 5827: span.LC_grade_check_note {
1.705 tempelho 5828: font-weight: normal;
5829: font-size: medium;
1.598 albertel 5830: display: inline;
5831: position: absolute;
5832: right: 1em;
5833: }
1.597 albertel 5834:
1.613 albertel 5835: table.LC_scantron_action {
5836: width: 100%;
5837: }
1.795 www 5838:
1.613 albertel 5839: table.LC_scantron_action tr th {
1.698 harmsja 5840: font-weight:bold;
5841: font-style:normal;
1.613 albertel 5842: }
1.795 www 5843:
1.779 bisitz 5844: .LC_edit_problem_header,
1.614 albertel 5845: div.LC_edit_problem_footer {
1.705 tempelho 5846: font-weight: normal;
5847: font-size: medium;
1.602 albertel 5848: margin: 2px;
1.600 albertel 5849: }
1.795 www 5850:
1.600 albertel 5851: div.LC_edit_problem_header,
1.602 albertel 5852: div.LC_edit_problem_header div,
1.614 albertel 5853: div.LC_edit_problem_footer,
5854: div.LC_edit_problem_footer div,
1.602 albertel 5855: div.LC_edit_problem_editxml_header,
5856: div.LC_edit_problem_editxml_header div {
1.600 albertel 5857: margin-top: 5px;
5858: }
1.795 www 5859:
1.600 albertel 5860: div.LC_edit_problem_header_title {
1.705 tempelho 5861: font-weight: bold;
5862: font-size: larger;
1.602 albertel 5863: background: $tabbg;
5864: padding: 3px;
5865: }
1.795 www 5866:
1.602 albertel 5867: table.LC_edit_problem_header_title {
1.705 tempelho 5868: font-size: larger;
5869: font-weight: bold;
1.602 albertel 5870: width: 100%;
5871: border-color: $pgbg;
5872: border-style: solid;
5873: border-width: $border;
1.600 albertel 5874: background: $tabbg;
1.602 albertel 5875: border-collapse: collapse;
1.803 bisitz 5876: padding: 0;
1.602 albertel 5877: }
5878:
5879: div.LC_edit_problem_discards {
5880: float: left;
5881: padding-bottom: 5px;
5882: }
1.795 www 5883:
1.602 albertel 5884: div.LC_edit_problem_saves {
5885: float: right;
5886: padding-bottom: 5px;
1.600 albertel 5887: }
1.795 www 5888:
1.911 bisitz 5889: img.stift {
1.803 bisitz 5890: border-width: 0;
5891: vertical-align: middle;
1.677 riegler 5892: }
1.680 riegler 5893:
1.923 bisitz 5894: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5895: vertical-align: top;
1.777 tempelho 5896: }
1.795 www 5897:
1.716 raeburn 5898: div.LC_createcourse {
1.911 bisitz 5899: margin: 10px 10px 10px 10px;
1.716 raeburn 5900: }
5901:
1.917 raeburn 5902: .LC_dccid {
5903: margin: 0.2em 0 0 0;
5904: padding: 0;
5905: font-size: 90%;
5906: display:none;
5907: }
5908:
1.693 droeschl 5909: /* ---- Remove when done ----
5910: # The following styles is part of the redesign of LON-CAPA and are
5911: # subject to change during this project.
5912: # Don't rely on their current functionality as they might be
5913: # changed or removed.
5914: # --------------------------*/
5915:
1.698 harmsja 5916: a:hover,
1.897 wenzelju 5917: ol.LC_primary_menu a:hover,
1.721 harmsja 5918: ol#LC_MenuBreadcrumbs a:hover,
5919: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5920: ul#LC_secondary_menu a:hover,
1.721 harmsja 5921: .LC_FormSectionClearButton input:hover
1.795 www 5922: ul.LC_TabContent li:hover a {
1.911 bisitz 5923: color:#BF2317;
5924: text-decoration:none;
1.693 droeschl 5925: }
5926:
1.779 bisitz 5927: h1 {
1.911 bisitz 5928: padding: 0;
5929: line-height:130%;
1.693 droeschl 5930: }
1.698 harmsja 5931:
1.911 bisitz 5932: h2,
5933: h3,
5934: h4,
5935: h5,
5936: h6 {
5937: margin: 5px 0 5px 0;
5938: padding: 0;
5939: line-height:130%;
1.693 droeschl 5940: }
1.795 www 5941:
5942: .LC_hcell {
1.911 bisitz 5943: padding:3px 15px 3px 15px;
5944: margin: 0;
5945: background-color:$tabbg;
5946: color:$fontmenu;
5947: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5948: }
1.795 www 5949:
1.840 bisitz 5950: .LC_Box > .LC_hcell {
1.911 bisitz 5951: margin: 0 -10px 10px -10px;
1.835 bisitz 5952: }
5953:
1.721 harmsja 5954: .LC_noBorder {
1.911 bisitz 5955: border: 0;
1.698 harmsja 5956: }
1.693 droeschl 5957:
1.721 harmsja 5958: .LC_FormSectionClearButton input {
1.911 bisitz 5959: background-color:transparent;
5960: border: none;
5961: cursor:pointer;
5962: text-decoration:underline;
1.693 droeschl 5963: }
1.763 bisitz 5964:
5965: .LC_help_open_topic {
1.911 bisitz 5966: color: #FFFFFF;
5967: background-color: #EEEEFF;
5968: margin: 1px;
5969: padding: 4px;
5970: border: 1px solid #000033;
5971: white-space: nowrap;
5972: /* vertical-align: middle; */
1.759 neumanie 5973: }
1.693 droeschl 5974:
1.911 bisitz 5975: dl,
5976: ul,
5977: div,
5978: fieldset {
5979: margin: 10px 10px 10px 0;
5980: /* overflow: hidden; */
1.693 droeschl 5981: }
1.795 www 5982:
1.838 bisitz 5983: fieldset > legend {
1.911 bisitz 5984: font-weight: bold;
5985: padding: 0 5px 0 5px;
1.838 bisitz 5986: }
5987:
1.813 bisitz 5988: #LC_nav_bar {
1.911 bisitz 5989: float: left;
5990: margin: 0.2em 0 0 0;
1.807 droeschl 5991: }
5992:
1.916 droeschl 5993: #LC_realm {
5994: margin: 0.2em 0 0 0;
5995: padding: 0;
5996: font-weight: bold;
5997: text-align: center;
5998: }
5999:
1.911 bisitz 6000: #LC_nav_bar em {
6001: font-weight: bold;
6002: font-style: normal;
1.807 droeschl 6003: }
6004:
1.897 wenzelju 6005: ol.LC_primary_menu {
1.911 bisitz 6006: float: right;
6007: margin: 0.2em 0 0 0;
1.807 droeschl 6008: }
6009:
1.852 droeschl 6010: ol#LC_PathBreadcrumbs {
1.911 bisitz 6011: margin: 0;
1.693 droeschl 6012: }
6013:
1.897 wenzelju 6014: ol.LC_primary_menu li {
1.911 bisitz 6015: display: inline;
6016: padding: 5px 5px 0 10px;
6017: vertical-align: top;
1.693 droeschl 6018: }
6019:
1.897 wenzelju 6020: ol.LC_primary_menu li img {
1.911 bisitz 6021: vertical-align: bottom;
1.693 droeschl 6022: }
6023:
1.897 wenzelju 6024: ol.LC_primary_menu a {
1.911 bisitz 6025: font-size: 90%;
6026: color: RGB(80, 80, 80);
6027: text-decoration: none;
1.693 droeschl 6028: }
1.795 www 6029:
1.897 wenzelju 6030: ul#LC_secondary_menu {
1.911 bisitz 6031: clear: both;
6032: color: $fontmenu;
6033: background: $tabbg;
6034: list-style: none;
6035: padding: 0;
6036: margin: 0;
6037: width: 100%;
1.808 droeschl 6038: }
6039:
1.897 wenzelju 6040: ul#LC_secondary_menu li {
1.911 bisitz 6041: font-weight: bold;
6042: line-height: 1.8em;
6043: padding: 0 0.8em;
6044: border-right: 1px solid black;
6045: display: inline;
6046: vertical-align: middle;
1.807 droeschl 6047: }
6048:
1.847 tempelho 6049: ul.LC_TabContent {
1.911 bisitz 6050: display:block;
6051: background: $sidebg;
6052: border-bottom: solid 1px $lg_border_color;
6053: list-style:none;
6054: margin: 0 -10px;
6055: padding: 0;
1.693 droeschl 6056: }
6057:
1.795 www 6058: ul.LC_TabContent li,
6059: ul.LC_TabContentBigger li {
1.911 bisitz 6060: float:left;
1.741 harmsja 6061: }
1.795 www 6062:
1.897 wenzelju 6063: ul#LC_secondary_menu li a {
1.911 bisitz 6064: color: $fontmenu;
6065: text-decoration: none;
1.693 droeschl 6066: }
1.795 www 6067:
1.721 harmsja 6068: ul.LC_TabContent {
1.911 bisitz 6069: min-height:1.5em;
1.721 harmsja 6070: }
1.795 www 6071:
6072: ul.LC_TabContent li {
1.911 bisitz 6073: vertical-align:middle;
6074: padding: 0 10px 0 10px;
6075: background-color:$tabbg;
6076: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6077: }
1.795 www 6078:
1.847 tempelho 6079: ul.LC_TabContent .right {
1.911 bisitz 6080: float:right;
1.847 tempelho 6081: }
6082:
1.911 bisitz 6083: ul.LC_TabContent li a,
6084: ul.LC_TabContent li {
6085: color:rgb(47,47,47);
6086: text-decoration:none;
6087: font-size:95%;
6088: font-weight:bold;
6089: padding-right: 16px;
1.721 harmsja 6090: }
1.795 www 6091:
1.911 bisitz 6092: ul.LC_TabContent li:hover,
6093: ul.LC_TabContent li.active {
6094: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6095: border-bottom:solid 2px #FFFFFF;
6096: padding-right: 16px;
1.744 ehlerst 6097: }
1.795 www 6098:
1.870 tempelho 6099: #maincoursedoc {
1.911 bisitz 6100: clear:both;
1.870 tempelho 6101: }
6102:
6103: ul.LC_TabContentBigger {
1.911 bisitz 6104: display:block;
6105: list-style:none;
6106: padding: 0;
1.870 tempelho 6107: }
6108:
1.795 www 6109: ul.LC_TabContentBigger li {
1.911 bisitz 6110: vertical-align:bottom;
6111: height: 30px;
6112: font-size:110%;
6113: font-weight:bold;
6114: color: #737373;
1.841 tempelho 6115: }
6116:
1.870 tempelho 6117:
6118: ul.LC_TabContentBigger li a {
1.911 bisitz 6119: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6120: height: 30px;
6121: line-height: 30px;
6122: text-align: center;
6123: display: block;
6124: text-decoration: none;
1.741 harmsja 6125: }
1.795 www 6126:
1.911 bisitz 6127: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6128: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6129: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6130: color:$font;
6131: text-decoration: underline;
1.744 ehlerst 6132: }
1.795 www 6133:
1.870 tempelho 6134:
6135: ul.LC_TabContentBigger li b {
1.911 bisitz 6136: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6137: display: block;
6138: float: left;
6139: padding: 0 30px;
1.870 tempelho 6140: }
6141:
6142: ul.LC_TabContentBigger li:hover b,
6143: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6144: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6145: color:$font;
6146: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6147: }
1.693 droeschl 6148:
1.870 tempelho 6149:
1.862 bisitz 6150: ul.LC_CourseBreadcrumbs {
6151: background: $sidebg;
6152: line-height: 32px;
6153: padding-left: 10px;
6154: margin: 0 0 10px 0;
6155: list-style-position: inside;
6156:
6157: }
6158:
1.911 bisitz 6159: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6160: ol#LC_PathBreadcrumbs {
1.911 bisitz 6161: padding-left: 10px;
6162: margin: 0;
6163: list-style-position: inside;
1.915 droeschl 6164: /* SD working here
1.904 droeschl 6165: white-space: nowrap; */
1.693 droeschl 6166: }
6167:
1.911 bisitz 6168: ol#LC_MenuBreadcrumbs li,
6169: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6170: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6171: display: inline;
6172: white-space: nowrap;
1.915 droeschl 6173: /* SD working here
6174: white-space: normal; */
1.693 droeschl 6175: }
6176:
1.823 bisitz 6177: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6178: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6179: text-decoration: none;
6180: font-size:90%;
1.693 droeschl 6181: }
1.795 www 6182:
6183: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6184: text-decoration:none;
6185: font-size:100%;
6186: font-weight:bold;
1.693 droeschl 6187: }
1.795 www 6188:
1.840 bisitz 6189: .LC_Box {
1.911 bisitz 6190: border: solid 1px $lg_border_color;
6191: padding: 0 10px 10px 10px;
1.746 neumanie 6192: }
1.795 www 6193:
6194: .LC_AboutMe_Image {
1.911 bisitz 6195: float:left;
6196: margin-right:10px;
1.747 neumanie 6197: }
1.795 www 6198:
6199: .LC_Clear_AboutMe_Image {
1.911 bisitz 6200: clear:left;
1.747 neumanie 6201: }
1.795 www 6202:
1.721 harmsja 6203: dl.LC_ListStyleClean dt {
1.911 bisitz 6204: padding-right: 5px;
6205: display: table-header-group;
1.693 droeschl 6206: }
6207:
1.721 harmsja 6208: dl.LC_ListStyleClean dd {
1.911 bisitz 6209: display: table-row;
1.693 droeschl 6210: }
6211:
1.721 harmsja 6212: .LC_ListStyleClean,
6213: .LC_ListStyleSimple,
6214: .LC_ListStyleNormal,
1.795 www 6215: .LC_ListStyleSpecial {
1.911 bisitz 6216: /* display:block; */
6217: list-style-position: inside;
6218: list-style-type: none;
6219: overflow: hidden;
6220: padding: 0;
1.693 droeschl 6221: }
6222:
1.721 harmsja 6223: .LC_ListStyleSimple li,
6224: .LC_ListStyleSimple dd,
6225: .LC_ListStyleNormal li,
6226: .LC_ListStyleNormal dd,
6227: .LC_ListStyleSpecial li,
1.795 www 6228: .LC_ListStyleSpecial dd {
1.911 bisitz 6229: margin: 0;
6230: padding: 5px 5px 5px 10px;
6231: clear: both;
1.693 droeschl 6232: }
6233:
1.721 harmsja 6234: .LC_ListStyleClean li,
6235: .LC_ListStyleClean dd {
1.911 bisitz 6236: padding-top: 0;
6237: padding-bottom: 0;
1.693 droeschl 6238: }
6239:
1.721 harmsja 6240: .LC_ListStyleSimple dd,
1.795 www 6241: .LC_ListStyleSimple li {
1.911 bisitz 6242: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6243: }
6244:
1.721 harmsja 6245: .LC_ListStyleSpecial li,
6246: .LC_ListStyleSpecial dd {
1.911 bisitz 6247: list-style-type: none;
6248: background-color: RGB(220, 220, 220);
6249: margin-bottom: 4px;
1.693 droeschl 6250: }
6251:
1.721 harmsja 6252: table.LC_SimpleTable {
1.911 bisitz 6253: margin:5px;
6254: border:solid 1px $lg_border_color;
1.795 www 6255: }
1.693 droeschl 6256:
1.721 harmsja 6257: table.LC_SimpleTable tr {
1.911 bisitz 6258: padding: 0;
6259: border:solid 1px $lg_border_color;
1.693 droeschl 6260: }
1.795 www 6261:
6262: table.LC_SimpleTable thead {
1.911 bisitz 6263: background:rgb(220,220,220);
1.693 droeschl 6264: }
6265:
1.721 harmsja 6266: div.LC_columnSection {
1.911 bisitz 6267: display: block;
6268: clear: both;
6269: overflow: hidden;
6270: margin: 0;
1.693 droeschl 6271: }
6272:
1.721 harmsja 6273: div.LC_columnSection>* {
1.911 bisitz 6274: float: left;
6275: margin: 10px 20px 10px 0;
6276: overflow:hidden;
1.693 droeschl 6277: }
1.721 harmsja 6278:
1.694 tempelho 6279: .LC_loginpage_container {
1.911 bisitz 6280: text-align:left;
6281: margin : 0 auto;
6282: width:90%;
6283: padding: 10px;
6284: height: auto;
6285: background-color:#FFFFFF;
6286: border:1px solid #CCCCCC;
1.694 tempelho 6287: }
6288:
6289:
6290: .LC_loginpage_loginContainer {
1.911 bisitz 6291: float:left;
6292: width: 182px;
6293: padding: 2px;
6294: border:1px solid #CCCCCC;
6295: background-color:$loginbg;
1.694 tempelho 6296: }
6297:
1.795 www 6298: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6299: margin-top: 0;
6300: display:block;
6301: background:$bgcol;
6302: color:$textcol;
6303: padding-left:5px;
1.712 muellerd 6304: }
1.785 tempelho 6305:
1.694 tempelho 6306: .LC_loginpage_loginInfo {
1.911 bisitz 6307: float:left;
6308: width:182px;
6309: border:1px solid #CCCCCC;
6310: padding:2px;
1.712 muellerd 6311: }
6312:
1.694 tempelho 6313: .LC_loginpage_space {
1.911 bisitz 6314: clear: both;
6315: margin-bottom: 20px;
6316: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6317: }
6318:
1.785 tempelho 6319: .LC_loginpage_floatLeft {
1.911 bisitz 6320: float: left;
6321: width: 200px;
6322: margin: 0;
1.785 tempelho 6323: }
6324:
1.795 www 6325: table em {
1.911 bisitz 6326: font-weight: bold;
6327: font-style: normal;
1.748 schulted 6328: }
1.795 www 6329:
1.779 bisitz 6330: table.LC_tableBrowseRes,
1.795 www 6331: table.LC_tableOfContent {
1.911 bisitz 6332: border:none;
6333: border-spacing: 1px;
6334: padding: 3px;
6335: background-color: #FFFFFF;
6336: font-size: 90%;
1.753 droeschl 6337: }
1.789 droeschl 6338:
1.911 bisitz 6339: table.LC_tableOfContent {
6340: border-collapse: collapse;
1.789 droeschl 6341: }
6342:
1.771 droeschl 6343: table.LC_tableBrowseRes a,
1.768 schulted 6344: table.LC_tableOfContent a {
1.911 bisitz 6345: background-color: transparent;
6346: text-decoration: none;
1.753 droeschl 6347: }
6348:
1.795 www 6349: table.LC_tableOfContent img {
1.911 bisitz 6350: border: none;
6351: height: 1.3em;
6352: vertical-align: text-bottom;
6353: margin-right: 0.3em;
1.753 droeschl 6354: }
1.757 schulted 6355:
1.795 www 6356: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6357: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6358: }
6359:
1.795 www 6360: a#LC_content_toolbar_launchnav {
1.911 bisitz 6361: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6362: }
6363:
1.795 www 6364: a#LC_content_toolbar_closenav {
1.911 bisitz 6365: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6366: }
6367:
1.795 www 6368: a#LC_content_toolbar_everything {
1.911 bisitz 6369: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6370: }
6371:
1.795 www 6372: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6373: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6374: }
6375:
1.795 www 6376: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6377: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6378: }
6379:
1.795 www 6380: a#LC_content_toolbar_changefolder {
1.911 bisitz 6381: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6382: }
6383:
1.795 www 6384: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6385: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6386: }
6387:
1.795 www 6388: ul#LC_toolbar li a:hover {
1.911 bisitz 6389: background-position: bottom center;
1.757 schulted 6390: }
6391:
1.795 www 6392: ul#LC_toolbar {
1.911 bisitz 6393: padding: 0;
6394: margin: 2px;
6395: list-style:none;
6396: position:relative;
6397: background-color:white;
1.757 schulted 6398: }
6399:
1.795 www 6400: ul#LC_toolbar li {
1.911 bisitz 6401: border:1px solid white;
6402: padding: 0;
6403: margin: 0;
6404: float: left;
6405: display:inline;
6406: vertical-align:middle;
6407: }
1.757 schulted 6408:
1.783 amueller 6409:
1.795 www 6410: a.LC_toolbarItem {
1.911 bisitz 6411: display:block;
6412: padding: 0;
6413: margin: 0;
6414: height: 32px;
6415: width: 32px;
6416: color:white;
6417: border: none;
6418: background-repeat:no-repeat;
6419: background-color:transparent;
1.757 schulted 6420: }
6421:
1.915 droeschl 6422: ul.LC_funclist {
6423: margin: 0;
6424: padding: 0.5em 1em 0.5em 0;
6425: }
6426:
6427: ul.LC_funclist + ul.LC_funclist {
6428: /*
6429: left border as a seperator if we have more than
6430: one list
6431: */
6432: border-left: 1px solid $sidebg;
6433: /*
6434: this hides the left border behind the border of the
6435: outer box if element is wrapped to the next 'line'
6436: */
6437: margin-left: -1px;
6438: }
6439:
1.843 bisitz 6440: ul.LC_funclist li {
1.915 droeschl 6441: display: inline;
1.782 bisitz 6442: white-space: nowrap;
1.915 droeschl 6443: margin: 0 0 0 25px;
6444: line-height: 150%;
1.782 bisitz 6445: }
6446:
1.925.2.1 raeburn 6447: #gciheader {
6448: float:left;
6449: width:100%;
6450: background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
6451: font-size:93%;
6452: line-height:normal;
6453: }
6454: #gciheader ul {
6455: margin:0;
6456: padding:10px 10px 0;
6457: list-style:none;
6458: }
6459: #gciheader li {
6460: float:left;
6461: background:url("/gcimenu_left.gif") no-repeat left top;
6462: margin:0;
6463: padding:0 0 0 9px;
6464: }
6465: #gciheader a {
6466: display:block;
6467: background:url("/gcimenu_right.gif") no-repeat right top;
6468: padding:5px 15px 4px 6px;
6469: }
6470: #gciheader #current {
6471: background-image:url("/gcimenu_left_on.gif");
6472: }
6473: #gciheader #current a {
6474: background-image:url("/gcimenu_right_on.gif");
6475: padding-bottom:5px;
6476: }
1.757 schulted 6477:
1.343 albertel 6478: END
6479: }
6480:
1.306 albertel 6481: =pod
6482:
6483: =item * &headtag()
6484:
6485: Returns a uniform footer for LON-CAPA web pages.
6486:
1.307 albertel 6487: Inputs: $title - optional title for the head
6488: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6489: $args - optional arguments
1.319 albertel 6490: force_register - if is true call registerurl so the remote is
6491: informed
1.415 albertel 6492: redirect -> array ref of
6493: 1- seconds before redirect occurs
6494: 2- url to redirect to
6495: 3- whether the side effect should occur
1.315 albertel 6496: (side effect of setting
6497: $env{'internal.head.redirect'} to the url
6498: redirected too)
1.352 albertel 6499: domain -> force to color decorate a page for a specific
6500: domain
6501: function -> force usage of a specific rolish color scheme
6502: bgcolor -> override the default page bgcolor
1.460 albertel 6503: no_auto_mt_title
6504: -> prevent &mt()ing the title arg
1.464 albertel 6505:
1.306 albertel 6506: =cut
6507:
6508: sub headtag {
1.313 albertel 6509: my ($title,$head_extra,$args) = @_;
1.306 albertel 6510:
1.363 albertel 6511: my $function = $args->{'function'} || &get_users_function();
6512: my $domain = $args->{'domain'} || &determinedomain();
6513: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6514: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6515: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6516: #time(),
1.418 albertel 6517: $env{'environment.color.timestamp'},
1.363 albertel 6518: $function,$domain,$bgcolor);
6519:
1.369 www 6520: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6521:
1.308 albertel 6522: my $result =
6523: '<head>'.
1.461 albertel 6524: &font_settings();
1.319 albertel 6525:
1.461 albertel 6526: if (!$args->{'frameset'}) {
6527: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6528: }
1.319 albertel 6529: if ($args->{'force_register'}) {
6530: $result .= &Apache::lonmenu::registerurl(1);
6531: }
1.436 albertel 6532: if (!$args->{'no_nav_bar'}
6533: && !$args->{'only_body'}
6534: && !$args->{'frameset'}) {
6535: $result .= &help_menu_js();
6536: }
1.319 albertel 6537:
1.314 albertel 6538: if (ref($args->{'redirect'})) {
1.414 albertel 6539: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6540: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6541: if (!$inhibit_continue) {
6542: $env{'internal.head.redirect'} = $url;
6543: }
1.313 albertel 6544: $result.=<<ADDMETA
6545: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6546: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6547: ADDMETA
6548: }
1.306 albertel 6549: if (!defined($title)) {
6550: $title = 'The LearningOnline Network with CAPA';
6551: }
1.460 albertel 6552: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6553: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6554: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6555: .$head_extra;
1.306 albertel 6556: return $result;
6557: }
6558:
6559: =pod
6560:
1.340 albertel 6561: =item * &font_settings()
6562:
6563: Returns neccessary <meta> to set the proper encoding
6564:
6565: Inputs: none
6566:
6567: =cut
6568:
6569: sub font_settings {
6570: my $headerstring='';
1.647 www 6571: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6572: $headerstring.=
6573: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6574: }
6575: return $headerstring;
6576: }
6577:
1.341 albertel 6578: =pod
6579:
6580: =item * &xml_begin()
6581:
6582: Returns the needed doctype and <html>
6583:
6584: Inputs: none
6585:
6586: =cut
6587:
6588: sub xml_begin {
6589: my $output='';
6590:
1.592 albertel 6591: if ($env{'internal.start_page'}==1) {
6592: &Apache::lonhtmlcommon::init_htmlareafields();
6593: }
1.342 albertel 6594:
1.341 albertel 6595: if ($env{'browser.mathml'}) {
6596: $output='<?xml version="1.0"?>'
6597: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6598: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6599:
6600: # .'<!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">] >'
6601: .'<!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">'
6602: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6603: .'xmlns="http://www.w3.org/1999/xhtml">';
6604: } else {
1.849 bisitz 6605: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6606: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6607: }
6608: return $output;
6609: }
1.340 albertel 6610:
6611: =pod
6612:
1.306 albertel 6613: =item * &endheadtag()
6614:
6615: Returns a uniform </head> for LON-CAPA web pages.
6616:
6617: Inputs: none
6618:
6619: =cut
6620:
6621: sub endheadtag {
6622: return '</head>';
6623: }
6624:
6625: =pod
6626:
6627: =item * &head()
6628:
6629: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6630:
1.648 raeburn 6631: Inputs:
6632:
6633: =over 4
6634:
6635: $title - optional title for the page
6636:
6637: $head_extra - optional extra HTML to put inside the <head>
6638:
6639: =back
1.405 albertel 6640:
1.306 albertel 6641: =cut
6642:
6643: sub head {
1.325 albertel 6644: my ($title,$head_extra,$args) = @_;
6645: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6646: }
6647:
6648: =pod
6649:
6650: =item * &start_page()
6651:
6652: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6653:
1.648 raeburn 6654: Inputs:
6655:
6656: =over 4
6657:
6658: $title - optional title for the page
6659:
6660: $head_extra - optional extra HTML to incude inside the <head>
6661:
6662: $args - additional optional args supported are:
6663:
6664: =over 8
6665:
6666: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6667: arg on
1.814 bisitz 6668: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6669: add_entries -> additional attributes to add to the <body>
6670: domain -> force to color decorate a page for a
1.317 albertel 6671: specific domain
1.648 raeburn 6672: function -> force usage of a specific rolish color
1.317 albertel 6673: scheme
1.648 raeburn 6674: redirect -> see &headtag()
6675: bgcolor -> override the default page bg color
6676: js_ready -> return a string ready for being used in
1.317 albertel 6677: a javascript writeln
1.648 raeburn 6678: html_encode -> return a string ready for being used in
1.320 albertel 6679: a html attribute
1.648 raeburn 6680: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6681: $forcereg arg
1.648 raeburn 6682: frameset -> if true will start with a <frameset>
1.330 albertel 6683: rather than <body>
1.648 raeburn 6684: skip_phases -> hash ref of
1.338 albertel 6685: head -> skip the <html><head> generation
6686: body -> skip all <body> generation
1.648 raeburn 6687: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6688: 'Switch To Inline Menu' link
1.648 raeburn 6689: no_auto_mt_title -> prevent &mt()ing the title arg
6690: inherit_jsmath -> when creating popup window in a page,
6691: should it have jsmath forced on by the
6692: current page
1.867 kalberla 6693: bread_crumbs -> Array containing breadcrumbs
6694: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6695:
1.648 raeburn 6696: =back
1.460 albertel 6697:
1.648 raeburn 6698: =back
1.562 albertel 6699:
1.306 albertel 6700: =cut
6701:
6702: sub start_page {
1.309 albertel 6703: my ($title,$head_extra,$args) = @_;
1.318 albertel 6704: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6705: my %head_args;
1.352 albertel 6706: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6707: 'bgcolor','frameset','no_nav_bar','only_body',
6708: 'no_auto_mt_title') {
1.319 albertel 6709: if (defined($args->{$arg})) {
1.324 raeburn 6710: $head_args{$arg} = $args->{$arg};
1.319 albertel 6711: }
1.313 albertel 6712: }
1.319 albertel 6713:
1.315 albertel 6714: $env{'internal.start_page'}++;
1.338 albertel 6715: my $result;
6716: if (! exists($args->{'skip_phases'}{'head'}) ) {
6717: $result.=
1.341 albertel 6718: &xml_begin().
1.338 albertel 6719: &headtag($title,$head_extra,\%head_args).&endheadtag();
6720: }
6721:
6722: if (! exists($args->{'skip_phases'}{'body'}) ) {
6723: if ($args->{'frameset'}) {
6724: my $attr_string = &make_attr_string($args->{'force_register'},
6725: $args->{'add_entries'});
6726: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6727: } else {
6728: $result .=
6729: &bodytag($title,
6730: $args->{'function'}, $args->{'add_entries'},
6731: $args->{'only_body'}, $args->{'domain'},
6732: $args->{'force_register'}, $args->{'no_nav_bar'},
6733: $args->{'bgcolor'}, $args->{'no_inline_link'},
6734: $args);
6735: }
1.330 albertel 6736: }
1.338 albertel 6737:
1.315 albertel 6738: if ($args->{'js_ready'}) {
1.713 kaisler 6739: $result = &js_ready($result);
1.315 albertel 6740: }
1.320 albertel 6741: if ($args->{'html_encode'}) {
1.713 kaisler 6742: $result = &html_encode($result);
6743: }
6744:
1.813 bisitz 6745: # Preparation for new and consistent functionlist at top of screen
6746: # if ($args->{'functionlist'}) {
6747: # $result .= &build_functionlist();
6748: #}
6749:
6750: # Don't add anything more if only_body wanted
6751: return $result if $args->{'only_body'};
6752:
1.920 raeburn 6753: #Breadcrumbs for Construction Space provided by &bodytag.
6754: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6755: return $result;
6756: }
6757:
1.813 bisitz 6758: #Breadcrumbs
1.758 kaisler 6759: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6760: &Apache::lonhtmlcommon::clear_breadcrumbs();
6761: #if any br links exists, add them to the breadcrumbs
6762: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6763: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6764: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6765: }
6766: }
6767:
6768: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6769: if(exists($args->{'bread_crumbs_component'})){
6770: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6771: }else{
6772: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6773: }
1.320 albertel 6774: }
1.315 albertel 6775: return $result;
1.306 albertel 6776: }
6777:
1.330 albertel 6778:
1.306 albertel 6779: =pod
6780:
6781: =item * &head()
6782:
6783: Returns a complete </body></html> section for LON-CAPA web pages.
6784:
1.315 albertel 6785: Inputs: $args - additional optional args supported are:
6786: js_ready -> return a string ready for being used in
6787: a javascript writeln
1.320 albertel 6788: html_encode -> return a string ready for being used in
6789: a html attribute
1.330 albertel 6790: frameset -> if true will start with a <frameset>
6791: rather than <body>
1.493 albertel 6792: dicsussion -> if true will get discussion from
6793: lonxml::xmlend
6794: (you can pass the target and parser arguments
6795: through optional 'target' and 'parser' args
6796: to this routine)
1.306 albertel 6797:
6798: =cut
6799:
6800: sub end_page {
1.315 albertel 6801: my ($args) = @_;
6802: $env{'internal.end_page'}++;
1.330 albertel 6803: my $result;
1.335 albertel 6804: if ($args->{'discussion'}) {
6805: my ($target,$parser);
6806: if (ref($args->{'discussion'})) {
6807: ($target,$parser) =($args->{'discussion'}{'target'},
6808: $args->{'discussion'}{'parser'});
6809: }
6810: $result .= &Apache::lonxml::xmlend($target,$parser);
6811: }
6812:
1.330 albertel 6813: if ($args->{'frameset'}) {
6814: $result .= '</frameset>';
6815: } else {
1.635 raeburn 6816: $result .= &endbodytag($args);
1.330 albertel 6817: }
6818: $result .= "\n</html>";
6819:
1.315 albertel 6820: if ($args->{'js_ready'}) {
1.317 albertel 6821: $result = &js_ready($result);
1.315 albertel 6822: }
1.335 albertel 6823:
1.320 albertel 6824: if ($args->{'html_encode'}) {
6825: $result = &html_encode($result);
6826: }
1.335 albertel 6827:
1.315 albertel 6828: return $result;
6829: }
6830:
1.320 albertel 6831: sub html_encode {
6832: my ($result) = @_;
6833:
1.322 albertel 6834: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6835:
6836: return $result;
6837: }
1.317 albertel 6838: sub js_ready {
6839: my ($result) = @_;
6840:
1.323 albertel 6841: $result =~ s/[\n\r]/ /xmsg;
6842: $result =~ s/\\/\\\\/xmsg;
6843: $result =~ s/'/\\'/xmsg;
1.372 albertel 6844: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6845:
6846: return $result;
6847: }
6848:
1.315 albertel 6849: sub validate_page {
6850: if ( exists($env{'internal.start_page'})
1.316 albertel 6851: && $env{'internal.start_page'} > 1) {
6852: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6853: $env{'internal.start_page'}.' '.
1.316 albertel 6854: $ENV{'request.filename'});
1.315 albertel 6855: }
6856: if ( exists($env{'internal.end_page'})
1.316 albertel 6857: && $env{'internal.end_page'} > 1) {
6858: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6859: $env{'internal.end_page'}.' '.
1.316 albertel 6860: $env{'request.filename'});
1.315 albertel 6861: }
6862: if ( exists($env{'internal.start_page'})
6863: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6864: &Apache::lonnet::logthis('start_page called without end_page '.
6865: $env{'request.filename'});
1.315 albertel 6866: }
6867: if ( ! exists($env{'internal.start_page'})
6868: && exists($env{'internal.end_page'})) {
1.316 albertel 6869: &Apache::lonnet::logthis('end_page called without start_page'.
6870: $env{'request.filename'});
1.315 albertel 6871: }
1.306 albertel 6872: }
1.315 albertel 6873:
1.318 albertel 6874: sub simple_error_page {
6875: my ($r,$title,$msg) = @_;
6876: my $page =
6877: &Apache::loncommon::start_page($title).
6878: &mt($msg).
6879: &Apache::loncommon::end_page();
6880: if (ref($r)) {
6881: $r->print($page);
1.327 albertel 6882: return;
1.318 albertel 6883: }
6884: return $page;
6885: }
1.347 albertel 6886:
6887: {
1.610 albertel 6888: my @row_count;
1.347 albertel 6889: sub start_data_table {
1.422 albertel 6890: my ($add_class) = @_;
6891: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6892: unshift(@row_count,0);
1.422 albertel 6893: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6894: }
6895:
6896: sub end_data_table {
1.610 albertel 6897: shift(@row_count);
1.389 albertel 6898: return '</table>'."\n";;
1.347 albertel 6899: }
6900:
6901: sub start_data_table_row {
1.422 albertel 6902: my ($add_class) = @_;
1.610 albertel 6903: $row_count[0]++;
6904: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6905: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6906: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6907: }
1.471 banghart 6908:
6909: sub continue_data_table_row {
6910: my ($add_class) = @_;
1.610 albertel 6911: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6912: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6913: return '<tr class="'.$css_class.'">'."\n";;
6914: }
1.347 albertel 6915:
6916: sub end_data_table_row {
1.389 albertel 6917: return '</tr>'."\n";;
1.347 albertel 6918: }
1.367 www 6919:
1.421 albertel 6920: sub start_data_table_empty_row {
1.707 bisitz 6921: # $row_count[0]++;
1.421 albertel 6922: return '<tr class="LC_empty_row" >'."\n";;
6923: }
6924:
6925: sub end_data_table_empty_row {
6926: return '</tr>'."\n";;
6927: }
6928:
1.367 www 6929: sub start_data_table_header_row {
1.389 albertel 6930: return '<tr class="LC_header_row">'."\n";;
1.367 www 6931: }
6932:
6933: sub end_data_table_header_row {
1.389 albertel 6934: return '</tr>'."\n";;
1.367 www 6935: }
1.890 droeschl 6936:
6937: sub data_table_caption {
6938: my $caption = shift;
6939: return "<caption class=\"LC_caption\">$caption</caption>";
6940: }
1.347 albertel 6941: }
6942:
1.548 albertel 6943: =pod
6944:
6945: =item * &inhibit_menu_check($arg)
6946:
6947: Checks for a inhibitmenu state and generates output to preserve it
6948:
6949: Inputs: $arg - can be any of
6950: - undef - in which case the return value is a string
6951: to add into arguments list of a uri
6952: - 'input' - in which case the return value is a HTML
6953: <form> <input> field of type hidden to
6954: preserve the value
6955: - a url - in which case the return value is the url with
6956: the neccesary cgi args added to preserve the
6957: inhibitmenu state
6958: - a ref to a url - no return value, but the string is
6959: updated to include the neccessary cgi
6960: args to preserve the inhibitmenu state
6961:
6962: =cut
6963:
6964: sub inhibit_menu_check {
6965: my ($arg) = @_;
6966: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6967: if ($arg eq 'input') {
6968: if ($env{'form.inhibitmenu'}) {
6969: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6970: } else {
6971: return
6972: }
6973: }
6974: if ($env{'form.inhibitmenu'}) {
6975: if (ref($arg)) {
6976: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6977: } elsif ($arg eq '') {
6978: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6979: } else {
6980: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6981: }
6982: }
6983: if (!ref($arg)) {
6984: return $arg;
6985: }
6986: }
6987:
1.251 albertel 6988: ###############################################
1.182 matthew 6989:
6990: =pod
6991:
1.549 albertel 6992: =back
6993:
6994: =head1 User Information Routines
6995:
6996: =over 4
6997:
1.405 albertel 6998: =item * &get_users_function()
1.182 matthew 6999:
7000: Used by &bodytag to determine the current users primary role.
7001: Returns either 'student','coordinator','admin', or 'author'.
7002:
7003: =cut
7004:
7005: ###############################################
7006: sub get_users_function {
1.815 tempelho 7007: my $function = 'norole';
1.818 tempelho 7008: if ($env{'request.role'}=~/^(st)/) {
7009: $function='student';
7010: }
1.907 raeburn 7011: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7012: $function='coordinator';
7013: }
1.258 albertel 7014: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7015: $function='admin';
7016: }
1.826 bisitz 7017: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7018: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7019: $function='author';
7020: }
7021: return $function;
1.54 www 7022: }
1.99 www 7023:
7024: ###############################################
7025:
1.233 raeburn 7026: =pod
7027:
1.821 raeburn 7028: =item * &show_course()
7029:
7030: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7031: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7032:
7033: Inputs:
7034: None
7035:
7036: Outputs:
7037: Scalar: 1 if 'Course' to be used, 0 otherwise.
7038:
7039: =cut
7040:
7041: ###############################################
7042: sub show_course {
7043: my $course = !$env{'user.adv'};
7044: if (!$env{'user.adv'}) {
7045: foreach my $env (keys(%env)) {
7046: next if ($env !~ m/^user\.priv\./);
7047: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7048: $course = 0;
7049: last;
7050: }
7051: }
7052: }
7053: return $course;
7054: }
7055:
7056: ###############################################
7057:
7058: =pod
7059:
1.542 raeburn 7060: =item * &check_user_status()
1.274 raeburn 7061:
7062: Determines current status of supplied role for a
7063: specific user. Roles can be active, previous or future.
7064:
7065: Inputs:
7066: user's domain, user's username, course's domain,
1.375 raeburn 7067: course's number, optional section ID.
1.274 raeburn 7068:
7069: Outputs:
7070: role status: active, previous or future.
7071:
7072: =cut
7073:
7074: sub check_user_status {
1.412 raeburn 7075: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7076: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7077: my @uroles = keys %userinfo;
7078: my $srchstr;
7079: my $active_chk = 'none';
1.412 raeburn 7080: my $now = time;
1.274 raeburn 7081: if (@uroles > 0) {
1.908 raeburn 7082: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7083: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7084: } else {
1.412 raeburn 7085: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7086: }
7087: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7088: my $role_end = 0;
7089: my $role_start = 0;
7090: $active_chk = 'active';
1.412 raeburn 7091: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7092: $role_end = $1;
7093: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7094: $role_start = $1;
1.274 raeburn 7095: }
7096: }
7097: if ($role_start > 0) {
1.412 raeburn 7098: if ($now < $role_start) {
1.274 raeburn 7099: $active_chk = 'future';
7100: }
7101: }
7102: if ($role_end > 0) {
1.412 raeburn 7103: if ($now > $role_end) {
1.274 raeburn 7104: $active_chk = 'previous';
7105: }
7106: }
7107: }
7108: }
7109: return $active_chk;
7110: }
7111:
7112: ###############################################
7113:
7114: =pod
7115:
1.405 albertel 7116: =item * &get_sections()
1.233 raeburn 7117:
7118: Determines all the sections for a course including
7119: sections with students and sections containing other roles.
1.419 raeburn 7120: Incoming parameters:
7121:
7122: 1. domain
7123: 2. course number
7124: 3. reference to array containing roles for which sections should
7125: be gathered (optional).
7126: 4. reference to array containing status types for which sections
7127: should be gathered (optional).
7128:
7129: If the third argument is undefined, sections are gathered for any role.
7130: If the fourth argument is undefined, sections are gathered for any status.
7131: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7132:
1.374 raeburn 7133: Returns section hash (keys are section IDs, values are
7134: number of users in each section), subject to the
1.419 raeburn 7135: optional roles filter, optional status filter
1.233 raeburn 7136:
7137: =cut
7138:
7139: ###############################################
7140: sub get_sections {
1.419 raeburn 7141: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7142: if (!defined($cdom) || !defined($cnum)) {
7143: my $cid = $env{'request.course.id'};
7144:
7145: return if (!defined($cid));
7146:
7147: $cdom = $env{'course.'.$cid.'.domain'};
7148: $cnum = $env{'course.'.$cid.'.num'};
7149: }
7150:
7151: my %sectioncount;
1.419 raeburn 7152: my $now = time;
1.240 albertel 7153:
1.366 albertel 7154: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7155: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7156: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7157: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7158: my $start_index = &Apache::loncoursedata::CL_START();
7159: my $end_index = &Apache::loncoursedata::CL_END();
7160: my $status;
1.366 albertel 7161: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7162: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7163: $data->[$status_index],
7164: $data->[$start_index],
7165: $data->[$end_index]);
7166: if ($stu_status eq 'Active') {
7167: $status = 'active';
7168: } elsif ($end < $now) {
7169: $status = 'previous';
7170: } elsif ($start > $now) {
7171: $status = 'future';
7172: }
7173: if ($section ne '-1' && $section !~ /^\s*$/) {
7174: if ((!defined($possible_status)) || (($status ne '') &&
7175: (grep/^\Q$status\E$/,@{$possible_status}))) {
7176: $sectioncount{$section}++;
7177: }
1.240 albertel 7178: }
7179: }
7180: }
7181: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7182: foreach my $user (sort(keys(%courseroles))) {
7183: if ($user !~ /^(\w{2})/) { next; }
7184: my ($role) = ($user =~ /^(\w{2})/);
7185: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7186: my ($section,$status);
1.240 albertel 7187: if ($role eq 'cr' &&
7188: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7189: $section=$1;
7190: }
7191: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7192: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7193: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7194: if ($end == -1 && $start == -1) {
7195: next; #deleted role
7196: }
7197: if (!defined($possible_status)) {
7198: $sectioncount{$section}++;
7199: } else {
7200: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7201: $status = 'active';
7202: } elsif ($end < $now) {
7203: $status = 'future';
7204: } elsif ($start > $now) {
7205: $status = 'previous';
7206: }
7207: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7208: $sectioncount{$section}++;
7209: }
7210: }
1.233 raeburn 7211: }
1.366 albertel 7212: return %sectioncount;
1.233 raeburn 7213: }
7214:
1.274 raeburn 7215: ###############################################
1.294 raeburn 7216:
7217: =pod
1.405 albertel 7218:
7219: =item * &get_course_users()
7220:
1.275 raeburn 7221: Retrieves usernames:domains for users in the specified course
7222: with specific role(s), and access status.
7223:
7224: Incoming parameters:
1.277 albertel 7225: 1. course domain
7226: 2. course number
7227: 3. access status: users must have - either active,
1.275 raeburn 7228: previous, future, or all.
1.277 albertel 7229: 4. reference to array of permissible roles
1.288 raeburn 7230: 5. reference to array of section restrictions (optional)
7231: 6. reference to results object (hash of hashes).
7232: 7. reference to optional userdata hash
1.609 raeburn 7233: 8. reference to optional statushash
1.630 raeburn 7234: 9. flag if privileged users (except those set to unhide in
7235: course settings) should be excluded
1.609 raeburn 7236: Keys of top level results hash are roles.
1.275 raeburn 7237: Keys of inner hashes are username:domain, with
7238: values set to access type.
1.288 raeburn 7239: Optional userdata hash returns an array with arguments in the
7240: same order as loncoursedata::get_classlist() for student data.
7241:
1.609 raeburn 7242: Optional statushash returns
7243:
1.288 raeburn 7244: Entries for end, start, section and status are blank because
7245: of the possibility of multiple values for non-student roles.
7246:
1.275 raeburn 7247: =cut
1.405 albertel 7248:
1.275 raeburn 7249: ###############################################
1.405 albertel 7250:
1.275 raeburn 7251: sub get_course_users {
1.630 raeburn 7252: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7253: my %idx = ();
1.419 raeburn 7254: my %seclists;
1.288 raeburn 7255:
7256: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7257: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7258: $idx{end} = &Apache::loncoursedata::CL_END();
7259: $idx{start} = &Apache::loncoursedata::CL_START();
7260: $idx{id} = &Apache::loncoursedata::CL_ID();
7261: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7262: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7263: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7264:
1.290 albertel 7265: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7266: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7267: my $now = time;
1.277 albertel 7268: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7269: my $match = 0;
1.412 raeburn 7270: my $secmatch = 0;
1.419 raeburn 7271: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7272: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7273: if ($section eq '') {
7274: $section = 'none';
7275: }
1.291 albertel 7276: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7277: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7278: $secmatch = 1;
7279: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7280: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7281: $secmatch = 1;
7282: }
7283: } else {
1.419 raeburn 7284: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7285: $secmatch = 1;
7286: }
1.290 albertel 7287: }
1.412 raeburn 7288: if (!$secmatch) {
7289: next;
7290: }
1.419 raeburn 7291: }
1.275 raeburn 7292: if (defined($$types{'active'})) {
1.288 raeburn 7293: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7294: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7295: $match = 1;
1.275 raeburn 7296: }
7297: }
7298: if (defined($$types{'previous'})) {
1.609 raeburn 7299: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7300: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7301: $match = 1;
1.275 raeburn 7302: }
7303: }
7304: if (defined($$types{'future'})) {
1.609 raeburn 7305: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7306: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7307: $match = 1;
1.275 raeburn 7308: }
7309: }
1.609 raeburn 7310: if ($match) {
7311: push(@{$seclists{$student}},$section);
7312: if (ref($userdata) eq 'HASH') {
7313: $$userdata{$student} = $$classlist{$student};
7314: }
7315: if (ref($statushash) eq 'HASH') {
7316: $statushash->{$student}{'st'}{$section} = $status;
7317: }
1.288 raeburn 7318: }
1.275 raeburn 7319: }
7320: }
1.412 raeburn 7321: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7322: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7323: my $now = time;
1.609 raeburn 7324: my %displaystatus = ( previous => 'Expired',
7325: active => 'Active',
7326: future => 'Future',
7327: );
1.630 raeburn 7328: my %nothide;
7329: if ($hidepriv) {
7330: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7331: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7332: if ($user !~ /:/) {
7333: $nothide{join(':',split(/[\@]/,$user))}=1;
7334: } else {
7335: $nothide{$user} = 1;
7336: }
7337: }
7338: }
1.439 raeburn 7339: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7340: my $match = 0;
1.412 raeburn 7341: my $secmatch = 0;
1.439 raeburn 7342: my $status;
1.412 raeburn 7343: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7344: $user =~ s/:$//;
1.439 raeburn 7345: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7346: if ($end == -1 || $start == -1) {
7347: next;
7348: }
7349: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7350: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7351: my ($uname,$udom) = split(/:/,$user);
7352: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7353: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7354: $secmatch = 1;
7355: } elsif ($usec eq '') {
1.420 albertel 7356: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7357: $secmatch = 1;
7358: }
7359: } else {
7360: if (grep(/^\Q$usec\E$/,@{$sections})) {
7361: $secmatch = 1;
7362: }
7363: }
7364: if (!$secmatch) {
7365: next;
7366: }
1.288 raeburn 7367: }
1.419 raeburn 7368: if ($usec eq '') {
7369: $usec = 'none';
7370: }
1.275 raeburn 7371: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7372: if ($hidepriv) {
7373: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7374: (!$nothide{$uname.':'.$udom})) {
7375: next;
7376: }
7377: }
1.503 raeburn 7378: if ($end > 0 && $end < $now) {
1.439 raeburn 7379: $status = 'previous';
7380: } elsif ($start > $now) {
7381: $status = 'future';
7382: } else {
7383: $status = 'active';
7384: }
1.277 albertel 7385: foreach my $type (keys(%{$types})) {
1.275 raeburn 7386: if ($status eq $type) {
1.420 albertel 7387: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7388: push(@{$$users{$role}{$user}},$type);
7389: }
1.288 raeburn 7390: $match = 1;
7391: }
7392: }
1.419 raeburn 7393: if (($match) && (ref($userdata) eq 'HASH')) {
7394: if (!exists($$userdata{$uname.':'.$udom})) {
7395: &get_user_info($udom,$uname,\%idx,$userdata);
7396: }
1.420 albertel 7397: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7398: push(@{$seclists{$uname.':'.$udom}},$usec);
7399: }
1.609 raeburn 7400: if (ref($statushash) eq 'HASH') {
7401: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7402: }
1.275 raeburn 7403: }
7404: }
7405: }
7406: }
1.290 albertel 7407: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7408: if ((defined($cdom)) && (defined($cnum))) {
7409: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7410: if ( defined($csettings{'internal.courseowner'}) ) {
7411: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7412: next if ($owner eq '');
7413: my ($ownername,$ownerdom);
7414: if ($owner =~ /^([^:]+):([^:]+)$/) {
7415: $ownername = $1;
7416: $ownerdom = $2;
7417: } else {
7418: $ownername = $owner;
7419: $ownerdom = $cdom;
7420: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7421: }
7422: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7423: if (defined($userdata) &&
1.609 raeburn 7424: !exists($$userdata{$owner})) {
7425: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7426: if (!grep(/^none$/,@{$seclists{$owner}})) {
7427: push(@{$seclists{$owner}},'none');
7428: }
7429: if (ref($statushash) eq 'HASH') {
7430: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7431: }
1.290 albertel 7432: }
1.279 raeburn 7433: }
7434: }
7435: }
1.419 raeburn 7436: foreach my $user (keys(%seclists)) {
7437: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7438: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7439: }
1.275 raeburn 7440: }
7441: return;
7442: }
7443:
1.288 raeburn 7444: sub get_user_info {
7445: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7446: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7447: &plainname($uname,$udom,'lastname');
1.291 albertel 7448: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7449: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7450: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7451: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7452: return;
7453: }
1.275 raeburn 7454:
1.472 raeburn 7455: ###############################################
7456:
7457: =pod
7458:
7459: =item * &get_user_quota()
7460:
7461: Retrieves quota assigned for storage of portfolio files for a user
7462:
7463: Incoming parameters:
7464: 1. user's username
7465: 2. user's domain
7466:
7467: Returns:
1.536 raeburn 7468: 1. Disk quota (in Mb) assigned to student.
7469: 2. (Optional) Type of setting: custom or default
7470: (individually assigned or default for user's
7471: institutional status).
7472: 3. (Optional) - User's institutional status (e.g., faculty, staff
7473: or student - types as defined in localenroll::inst_usertypes
7474: for user's domain, which determines default quota for user.
7475: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7476:
7477: If a value has been stored in the user's environment,
1.536 raeburn 7478: it will return that, otherwise it returns the maximal default
7479: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7480:
7481: =cut
7482:
7483: ###############################################
7484:
7485:
7486: sub get_user_quota {
7487: my ($uname,$udom) = @_;
1.536 raeburn 7488: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7489: if (!defined($udom)) {
7490: $udom = $env{'user.domain'};
7491: }
7492: if (!defined($uname)) {
7493: $uname = $env{'user.name'};
7494: }
7495: if (($udom eq '' || $uname eq '') ||
7496: ($udom eq 'public') && ($uname eq 'public')) {
7497: $quota = 0;
1.536 raeburn 7498: $quotatype = 'default';
7499: $defquota = 0;
1.472 raeburn 7500: } else {
1.536 raeburn 7501: my $inststatus;
1.472 raeburn 7502: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7503: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7504: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7505: } else {
1.536 raeburn 7506: my %userenv =
7507: &Apache::lonnet::get('environment',['portfolioquota',
7508: 'inststatus'],$udom,$uname);
1.472 raeburn 7509: my ($tmp) = keys(%userenv);
7510: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7511: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7512: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7513: } else {
7514: undef(%userenv);
7515: }
7516: }
1.536 raeburn 7517: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7518: if ($quota eq '') {
1.536 raeburn 7519: $quota = $defquota;
7520: $quotatype = 'default';
7521: } else {
7522: $quotatype = 'custom';
1.472 raeburn 7523: }
7524: }
1.536 raeburn 7525: if (wantarray) {
7526: return ($quota,$quotatype,$settingstatus,$defquota);
7527: } else {
7528: return $quota;
7529: }
1.472 raeburn 7530: }
7531:
7532: ###############################################
7533:
7534: =pod
7535:
7536: =item * &default_quota()
7537:
1.536 raeburn 7538: Retrieves default quota assigned for storage of user portfolio files,
7539: given an (optional) user's institutional status.
1.472 raeburn 7540:
7541: Incoming parameters:
7542: 1. domain
1.536 raeburn 7543: 2. (Optional) institutional status(es). This is a : separated list of
7544: status types (e.g., faculty, staff, student etc.)
7545: which apply to the user for whom the default is being retrieved.
7546: If the institutional status string in undefined, the domain
7547: default quota will be returned.
1.472 raeburn 7548:
7549: Returns:
7550: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7551: 2. (Optional) institutional type which determined the value of the
7552: default quota.
1.472 raeburn 7553:
7554: If a value has been stored in the domain's configuration db,
7555: it will return that, otherwise it returns 20 (for backwards
7556: compatibility with domains which have not set up a configuration
7557: db file; the original statically defined portfolio quota was 20 Mb).
7558:
1.536 raeburn 7559: If the user's status includes multiple types (e.g., staff and student),
7560: the largest default quota which applies to the user determines the
7561: default quota returned.
7562:
1.780 raeburn 7563: =back
7564:
1.472 raeburn 7565: =cut
7566:
7567: ###############################################
7568:
7569:
7570: sub default_quota {
1.536 raeburn 7571: my ($udom,$inststatus) = @_;
7572: my ($defquota,$settingstatus);
7573: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7574: ['quotas'],$udom);
7575: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7576: if ($inststatus ne '') {
1.765 raeburn 7577: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7578: foreach my $item (@statuses) {
1.711 raeburn 7579: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7580: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7581: if ($defquota eq '') {
7582: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7583: $settingstatus = $item;
7584: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7585: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7586: $settingstatus = $item;
7587: }
7588: }
7589: } else {
7590: if ($quotahash{'quotas'}{$item} ne '') {
7591: if ($defquota eq '') {
7592: $defquota = $quotahash{'quotas'}{$item};
7593: $settingstatus = $item;
7594: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7595: $defquota = $quotahash{'quotas'}{$item};
7596: $settingstatus = $item;
7597: }
1.536 raeburn 7598: }
7599: }
7600: }
7601: }
7602: if ($defquota eq '') {
1.711 raeburn 7603: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7604: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7605: } else {
7606: $defquota = $quotahash{'quotas'}{'default'};
7607: }
1.536 raeburn 7608: $settingstatus = 'default';
7609: }
7610: } else {
7611: $settingstatus = 'default';
7612: $defquota = 20;
7613: }
7614: if (wantarray) {
7615: return ($defquota,$settingstatus);
1.472 raeburn 7616: } else {
1.536 raeburn 7617: return $defquota;
1.472 raeburn 7618: }
7619: }
7620:
1.384 raeburn 7621: sub get_secgrprole_info {
7622: my ($cdom,$cnum,$needroles,$type) = @_;
7623: my %sections_count = &get_sections($cdom,$cnum);
7624: my @sections = (sort {$a <=> $b} keys(%sections_count));
7625: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7626: my @groups = sort(keys(%curr_groups));
7627: my $allroles = [];
7628: my $rolehash;
7629: my $accesshash = {
7630: active => 'Currently has access',
7631: future => 'Will have future access',
7632: previous => 'Previously had access',
7633: };
7634: if ($needroles) {
7635: $rolehash = {'all' => 'all'};
1.385 albertel 7636: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7637: if (&Apache::lonnet::error(%user_roles)) {
7638: undef(%user_roles);
7639: }
7640: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7641: my ($role)=split(/\:/,$item,2);
7642: if ($role eq 'cr') { next; }
7643: if ($role =~ /^cr/) {
7644: $$rolehash{$role} = (split('/',$role))[3];
7645: } else {
7646: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7647: }
7648: }
7649: foreach my $key (sort(keys(%{$rolehash}))) {
7650: push(@{$allroles},$key);
7651: }
7652: push (@{$allroles},'st');
7653: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7654: }
7655: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7656: }
7657:
1.555 raeburn 7658: sub user_picker {
1.627 raeburn 7659: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7660: my $currdom = $dom;
7661: my %curr_selected = (
7662: srchin => 'dom',
1.580 raeburn 7663: srchby => 'lastname',
1.555 raeburn 7664: );
7665: my $srchterm;
1.625 raeburn 7666: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7667: if ($srch->{'srchby'} ne '') {
7668: $curr_selected{'srchby'} = $srch->{'srchby'};
7669: }
7670: if ($srch->{'srchin'} ne '') {
7671: $curr_selected{'srchin'} = $srch->{'srchin'};
7672: }
7673: if ($srch->{'srchtype'} ne '') {
7674: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7675: }
7676: if ($srch->{'srchdomain'} ne '') {
7677: $currdom = $srch->{'srchdomain'};
7678: }
7679: $srchterm = $srch->{'srchterm'};
7680: }
7681: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7682: 'usr' => 'Search criteria',
1.563 raeburn 7683: 'doma' => 'Domain/institution to search',
1.558 albertel 7684: 'uname' => 'username',
7685: 'lastname' => 'last name',
1.555 raeburn 7686: 'lastfirst' => 'last name, first name',
1.558 albertel 7687: 'crs' => 'in this course',
1.576 raeburn 7688: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7689: 'alc' => 'all LON-CAPA',
1.573 raeburn 7690: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7691: 'exact' => 'is',
7692: 'contains' => 'contains',
1.569 raeburn 7693: 'begins' => 'begins with',
1.571 raeburn 7694: 'youm' => "You must include some text to search for.",
7695: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7696: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7697: 'yomc' => "You must choose a domain when using an institutional directory search.",
7698: 'ymcd' => "You must choose a domain when using a domain search.",
7699: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7700: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7701: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7702: );
1.563 raeburn 7703: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7704: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7705:
7706: my @srchins = ('crs','dom','alc','instd');
7707:
7708: foreach my $option (@srchins) {
7709: # FIXME 'alc' option unavailable until
7710: # loncreateuser::print_user_query_page()
7711: # has been completed.
7712: next if ($option eq 'alc');
1.880 raeburn 7713: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7714: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7715: if ($curr_selected{'srchin'} eq $option) {
7716: $srchinsel .= '
7717: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7718: } else {
7719: $srchinsel .= '
7720: <option value="'.$option.'">'.$lt{$option}.'</option>';
7721: }
1.555 raeburn 7722: }
1.563 raeburn 7723: $srchinsel .= "\n </select>\n";
1.555 raeburn 7724:
7725: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7726: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7727: if ($curr_selected{'srchby'} eq $option) {
7728: $srchbysel .= '
7729: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7730: } else {
7731: $srchbysel .= '
7732: <option value="'.$option.'">'.$lt{$option}.'</option>';
7733: }
7734: }
7735: $srchbysel .= "\n </select>\n";
7736:
7737: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7738: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7739: if ($curr_selected{'srchtype'} eq $option) {
7740: $srchtypesel .= '
7741: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7742: } else {
7743: $srchtypesel .= '
7744: <option value="'.$option.'">'.$lt{$option}.'</option>';
7745: }
7746: }
7747: $srchtypesel .= "\n </select>\n";
7748:
1.558 albertel 7749: my ($newuserscript,$new_user_create);
1.556 raeburn 7750:
7751: if ($forcenewuser) {
1.576 raeburn 7752: if (ref($srch) eq 'HASH') {
7753: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7754: if ($cancreate) {
7755: $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>';
7756: } else {
1.799 bisitz 7757: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7758: my %usertypetext = (
7759: official => 'institutional',
7760: unofficial => 'non-institutional',
7761: );
1.799 bisitz 7762: $new_user_create = '<p class="LC_warning">'
7763: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7764: .' '
7765: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7766: ,'<a href="'.$helplink.'">','</a>')
7767: .'</p><br />';
1.627 raeburn 7768: }
1.576 raeburn 7769: }
7770: }
7771:
1.556 raeburn 7772: $newuserscript = <<"ENDSCRIPT";
7773:
1.570 raeburn 7774: function setSearch(createnew,callingForm) {
1.556 raeburn 7775: if (createnew == 1) {
1.570 raeburn 7776: for (var i=0; i<callingForm.srchby.length; i++) {
7777: if (callingForm.srchby.options[i].value == 'uname') {
7778: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7779: }
7780: }
1.570 raeburn 7781: for (var i=0; i<callingForm.srchin.length; i++) {
7782: if ( callingForm.srchin.options[i].value == 'dom') {
7783: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7784: }
7785: }
1.570 raeburn 7786: for (var i=0; i<callingForm.srchtype.length; i++) {
7787: if (callingForm.srchtype.options[i].value == 'exact') {
7788: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7789: }
7790: }
1.570 raeburn 7791: for (var i=0; i<callingForm.srchdomain.length; i++) {
7792: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7793: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7794: }
7795: }
7796: }
7797: }
7798: ENDSCRIPT
1.558 albertel 7799:
1.556 raeburn 7800: }
7801:
1.555 raeburn 7802: my $output = <<"END_BLOCK";
1.556 raeburn 7803: <script type="text/javascript">
1.824 bisitz 7804: // <![CDATA[
1.570 raeburn 7805: function validateEntry(callingForm) {
1.558 albertel 7806:
1.556 raeburn 7807: var checkok = 1;
1.558 albertel 7808: var srchin;
1.570 raeburn 7809: for (var i=0; i<callingForm.srchin.length; i++) {
7810: if ( callingForm.srchin[i].checked ) {
7811: srchin = callingForm.srchin[i].value;
1.558 albertel 7812: }
7813: }
7814:
1.570 raeburn 7815: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7816: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7817: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7818: var srchterm = callingForm.srchterm.value;
7819: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7820: var msg = "";
7821:
7822: if (srchterm == "") {
7823: checkok = 0;
1.571 raeburn 7824: msg += "$lt{'youm'}\\n";
1.556 raeburn 7825: }
7826:
1.569 raeburn 7827: if (srchtype== 'begins') {
7828: if (srchterm.length < 2) {
7829: checkok = 0;
1.571 raeburn 7830: msg += "$lt{'thte'}\\n";
1.569 raeburn 7831: }
7832: }
7833:
1.556 raeburn 7834: if (srchtype== 'contains') {
7835: if (srchterm.length < 3) {
7836: checkok = 0;
1.571 raeburn 7837: msg += "$lt{'thet'}\\n";
1.556 raeburn 7838: }
7839: }
7840: if (srchin == 'instd') {
7841: if (srchdomain == '') {
7842: checkok = 0;
1.571 raeburn 7843: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7844: }
7845: }
7846: if (srchin == 'dom') {
7847: if (srchdomain == '') {
7848: checkok = 0;
1.571 raeburn 7849: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7850: }
7851: }
7852: if (srchby == 'lastfirst') {
7853: if (srchterm.indexOf(",") == -1) {
7854: checkok = 0;
1.571 raeburn 7855: msg += "$lt{'whus'}\\n";
1.556 raeburn 7856: }
7857: if (srchterm.indexOf(",") == srchterm.length -1) {
7858: checkok = 0;
1.571 raeburn 7859: msg += "$lt{'whse'}\\n";
1.556 raeburn 7860: }
7861: }
7862: if (checkok == 0) {
1.571 raeburn 7863: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7864: return;
7865: }
7866: if (checkok == 1) {
1.570 raeburn 7867: callingForm.submit();
1.556 raeburn 7868: }
7869: }
7870:
7871: $newuserscript
7872:
1.824 bisitz 7873: // ]]>
1.556 raeburn 7874: </script>
1.558 albertel 7875:
7876: $new_user_create
7877:
1.555 raeburn 7878: END_BLOCK
1.558 albertel 7879:
1.876 raeburn 7880: $output .= &Apache::lonhtmlcommon::start_pick_box().
7881: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7882: $domform.
7883: &Apache::lonhtmlcommon::row_closure().
7884: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7885: $srchbysel.
7886: $srchtypesel.
7887: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7888: $srchinsel.
7889: &Apache::lonhtmlcommon::row_closure(1).
7890: &Apache::lonhtmlcommon::end_pick_box().
7891: '<br />';
1.555 raeburn 7892: return $output;
7893: }
7894:
1.612 raeburn 7895: sub user_rule_check {
1.615 raeburn 7896: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7897: my $response;
7898: if (ref($usershash) eq 'HASH') {
7899: foreach my $user (keys(%{$usershash})) {
7900: my ($uname,$udom) = split(/:/,$user);
7901: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7902: my ($id,$newuser);
1.612 raeburn 7903: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7904: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7905: $id = $usershash->{$user}->{'id'};
7906: }
7907: my $inst_response;
7908: if (ref($checks) eq 'HASH') {
7909: if (defined($checks->{'username'})) {
1.615 raeburn 7910: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7911: &Apache::lonnet::get_instuser($udom,$uname);
7912: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7913: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7914: &Apache::lonnet::get_instuser($udom,undef,$id);
7915: }
1.615 raeburn 7916: } else {
7917: ($inst_response,%{$inst_results->{$user}}) =
7918: &Apache::lonnet::get_instuser($udom,$uname);
7919: return;
1.612 raeburn 7920: }
1.615 raeburn 7921: if (!$got_rules->{$udom}) {
1.612 raeburn 7922: my %domconfig = &Apache::lonnet::get_dom('configuration',
7923: ['usercreation'],$udom);
7924: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7925: foreach my $item ('username','id') {
1.612 raeburn 7926: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7927: $$curr_rules{$udom}{$item} =
7928: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7929: }
7930: }
7931: }
1.615 raeburn 7932: $got_rules->{$udom} = 1;
1.585 raeburn 7933: }
1.612 raeburn 7934: foreach my $item (keys(%{$checks})) {
7935: if (ref($$curr_rules{$udom}) eq 'HASH') {
7936: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7937: if (@{$$curr_rules{$udom}{$item}} > 0) {
7938: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7939: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7940: if ($rule_check{$rule}) {
7941: $$rulematch{$user}{$item} = $rule;
7942: if ($inst_response eq 'ok') {
1.615 raeburn 7943: if (ref($inst_results) eq 'HASH') {
7944: if (ref($inst_results->{$user}) eq 'HASH') {
7945: if (keys(%{$inst_results->{$user}}) == 0) {
7946: $$alerts{$item}{$udom}{$uname} = 1;
7947: }
1.612 raeburn 7948: }
7949: }
1.615 raeburn 7950: }
7951: last;
1.585 raeburn 7952: }
7953: }
7954: }
7955: }
7956: }
7957: }
7958: }
7959: }
1.612 raeburn 7960: return;
7961: }
7962:
7963: sub user_rule_formats {
7964: my ($domain,$domdesc,$curr_rules,$check) = @_;
7965: my %text = (
7966: 'username' => 'Usernames',
7967: 'id' => 'IDs',
7968: );
7969: my $output;
7970: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7971: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7972: if (@{$ruleorder} > 0) {
7973: $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>';
7974: foreach my $rule (@{$ruleorder}) {
7975: if (ref($curr_rules) eq 'ARRAY') {
7976: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7977: if (ref($rules->{$rule}) eq 'HASH') {
7978: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7979: $rules->{$rule}{'desc'}.'</li>';
7980: }
7981: }
7982: }
7983: }
7984: $output .= '</ul>';
7985: }
7986: }
7987: return $output;
7988: }
7989:
7990: sub instrule_disallow_msg {
1.615 raeburn 7991: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7992: my $response;
7993: my %text = (
7994: item => 'username',
7995: items => 'usernames',
7996: match => 'matches',
7997: do => 'does',
7998: action => 'a username',
7999: one => 'one',
8000: );
8001: if ($count > 1) {
8002: $text{'item'} = 'usernames';
8003: $text{'match'} ='match';
8004: $text{'do'} = 'do';
8005: $text{'action'} = 'usernames',
8006: $text{'one'} = 'ones';
8007: }
8008: if ($checkitem eq 'id') {
8009: $text{'items'} = 'IDs';
8010: $text{'item'} = 'ID';
8011: $text{'action'} = 'an ID';
1.615 raeburn 8012: if ($count > 1) {
8013: $text{'item'} = 'IDs';
8014: $text{'action'} = 'IDs';
8015: }
1.612 raeburn 8016: }
1.674 bisitz 8017: $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 8018: if ($mode eq 'upload') {
8019: if ($checkitem eq 'username') {
8020: $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'}.");
8021: } elsif ($checkitem eq 'id') {
1.674 bisitz 8022: $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 8023: }
1.669 raeburn 8024: } elsif ($mode eq 'selfcreate') {
8025: if ($checkitem eq 'id') {
8026: $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.");
8027: }
1.615 raeburn 8028: } else {
8029: if ($checkitem eq 'username') {
8030: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8031: } elsif ($checkitem eq 'id') {
8032: $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.");
8033: }
1.612 raeburn 8034: }
8035: return $response;
1.585 raeburn 8036: }
8037:
1.624 raeburn 8038: sub personal_data_fieldtitles {
8039: my %fieldtitles = &Apache::lonlocal::texthash (
8040: id => 'Student/Employee ID',
8041: permanentemail => 'E-mail address',
8042: lastname => 'Last Name',
8043: firstname => 'First Name',
8044: middlename => 'Middle Name',
8045: generation => 'Generation',
8046: gen => 'Generation',
1.765 raeburn 8047: inststatus => 'Affiliation',
1.624 raeburn 8048: );
8049: return %fieldtitles;
8050: }
8051:
1.642 raeburn 8052: sub sorted_inst_types {
8053: my ($dom) = @_;
8054: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8055: my $othertitle = &mt('All users');
8056: if ($env{'request.course.id'}) {
1.668 raeburn 8057: $othertitle = &mt('Any users');
1.642 raeburn 8058: }
8059: my @types;
8060: if (ref($order) eq 'ARRAY') {
8061: @types = @{$order};
8062: }
8063: if (@types == 0) {
8064: if (ref($usertypes) eq 'HASH') {
8065: @types = sort(keys(%{$usertypes}));
8066: }
8067: }
8068: if (keys(%{$usertypes}) > 0) {
8069: $othertitle = &mt('Other users');
8070: }
8071: return ($othertitle,$usertypes,\@types);
8072: }
8073:
1.645 raeburn 8074: sub get_institutional_codes {
8075: my ($settings,$allcourses,$LC_code) = @_;
8076: # Get complete list of course sections to update
8077: my @currsections = ();
8078: my @currxlists = ();
8079: my $coursecode = $$settings{'internal.coursecode'};
8080:
8081: if ($$settings{'internal.sectionnums'} ne '') {
8082: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8083: }
8084:
8085: if ($$settings{'internal.crosslistings'} ne '') {
8086: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8087: }
8088:
8089: if (@currxlists > 0) {
8090: foreach (@currxlists) {
8091: if (m/^([^:]+):(\w*)$/) {
8092: unless (grep/^$1$/,@{$allcourses}) {
8093: push @{$allcourses},$1;
8094: $$LC_code{$1} = $2;
8095: }
8096: }
8097: }
8098: }
8099:
8100: if (@currsections > 0) {
8101: foreach (@currsections) {
8102: if (m/^(\w+):(\w*)$/) {
8103: my $sec = $coursecode.$1;
8104: my $lc_sec = $2;
8105: unless (grep/^$sec$/,@{$allcourses}) {
8106: push @{$allcourses},$sec;
8107: $$LC_code{$sec} = $lc_sec;
8108: }
8109: }
8110: }
8111: }
8112: return;
8113: }
8114:
1.112 bowersj2 8115: =pod
8116:
1.780 raeburn 8117: =head1 Slot Helpers
8118:
8119: =over 4
8120:
8121: =item * sorted_slots()
8122:
8123: Sorts an array of slot names in order of slot start time (earliest first).
8124:
8125: Inputs:
8126:
8127: =over 4
8128:
8129: slotsarr - Reference to array of unsorted slot names.
8130:
8131: slots - Reference to hash of hash, where outer hash keys are slot names.
8132:
1.549 albertel 8133: =back
8134:
1.780 raeburn 8135: Returns:
8136:
8137: =over 4
8138:
8139: sorted - An array of slot names sorted by the start time of the slot.
8140:
8141: =back
8142:
8143: =back
8144:
8145: =cut
8146:
8147:
8148: sub sorted_slots {
8149: my ($slotsarr,$slots) = @_;
8150: my @sorted;
8151: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8152: @sorted =
8153: sort {
8154: if (ref($slots->{$a}) && ref($slots->{$b})) {
8155: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8156: }
8157: if (ref($slots->{$a})) { return -1;}
8158: if (ref($slots->{$b})) { return 1;}
8159: return 0;
8160: } @{$slotsarr};
8161: }
8162: return @sorted;
8163: }
8164:
8165:
8166: =pod
8167:
1.549 albertel 8168: =head1 HTTP Helpers
8169:
8170: =over 4
8171:
1.648 raeburn 8172: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8173:
1.258 albertel 8174: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8175: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8176: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8177:
8178: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8179: $possible_names is an ref to an array of form element names. As an example:
8180: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8181: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8182:
8183: =cut
1.1 albertel 8184:
1.6 albertel 8185: sub get_unprocessed_cgi {
1.25 albertel 8186: my ($query,$possible_names)= @_;
1.26 matthew 8187: # $Apache::lonxml::debug=1;
1.356 albertel 8188: foreach my $pair (split(/&/,$query)) {
8189: my ($name, $value) = split(/=/,$pair);
1.369 www 8190: $name = &unescape($name);
1.25 albertel 8191: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8192: $value =~ tr/+/ /;
8193: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8194: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8195: }
1.16 harris41 8196: }
1.6 albertel 8197: }
8198:
1.112 bowersj2 8199: =pod
8200:
1.648 raeburn 8201: =item * &cacheheader()
1.112 bowersj2 8202:
8203: returns cache-controlling header code
8204:
8205: =cut
8206:
1.7 albertel 8207: sub cacheheader {
1.258 albertel 8208: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8209: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8210: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8211: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8212: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8213: return $output;
1.7 albertel 8214: }
8215:
1.112 bowersj2 8216: =pod
8217:
1.648 raeburn 8218: =item * &no_cache($r)
1.112 bowersj2 8219:
8220: specifies header code to not have cache
8221:
8222: =cut
8223:
1.9 albertel 8224: sub no_cache {
1.216 albertel 8225: my ($r) = @_;
8226: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8227: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8228: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8229: $r->no_cache(1);
8230: $r->header_out("Expires" => $date);
8231: $r->header_out("Pragma" => "no-cache");
1.123 www 8232: }
8233:
8234: sub content_type {
1.181 albertel 8235: my ($r,$type,$charset) = @_;
1.299 foxr 8236: if ($r) {
8237: # Note that printout.pl calls this with undef for $r.
8238: &no_cache($r);
8239: }
1.258 albertel 8240: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8241: unless ($charset) {
8242: $charset=&Apache::lonlocal::current_encoding;
8243: }
8244: if ($charset) { $type.='; charset='.$charset; }
8245: if ($r) {
8246: $r->content_type($type);
8247: } else {
8248: print("Content-type: $type\n\n");
8249: }
1.9 albertel 8250: }
1.25 albertel 8251:
1.112 bowersj2 8252: =pod
8253:
1.648 raeburn 8254: =item * &add_to_env($name,$value)
1.112 bowersj2 8255:
1.258 albertel 8256: adds $name to the %env hash with value
1.112 bowersj2 8257: $value, if $name already exists, the entry is converted to an array
8258: reference and $value is added to the array.
8259:
8260: =cut
8261:
1.25 albertel 8262: sub add_to_env {
8263: my ($name,$value)=@_;
1.258 albertel 8264: if (defined($env{$name})) {
8265: if (ref($env{$name})) {
1.25 albertel 8266: #already have multiple values
1.258 albertel 8267: push(@{ $env{$name} },$value);
1.25 albertel 8268: } else {
8269: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8270: my $first=$env{$name};
8271: undef($env{$name});
8272: push(@{ $env{$name} },$first,$value);
1.25 albertel 8273: }
8274: } else {
1.258 albertel 8275: $env{$name}=$value;
1.25 albertel 8276: }
1.31 albertel 8277: }
1.149 albertel 8278:
8279: =pod
8280:
1.648 raeburn 8281: =item * &get_env_multiple($name)
1.149 albertel 8282:
1.258 albertel 8283: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8284: values may be defined and end up as an array ref.
8285:
8286: returns an array of values
8287:
8288: =cut
8289:
8290: sub get_env_multiple {
8291: my ($name) = @_;
8292: my @values;
1.258 albertel 8293: if (defined($env{$name})) {
1.149 albertel 8294: # exists is it an array
1.258 albertel 8295: if (ref($env{$name})) {
8296: @values=@{ $env{$name} };
1.149 albertel 8297: } else {
1.258 albertel 8298: $values[0]=$env{$name};
1.149 albertel 8299: }
8300: }
8301: return(@values);
8302: }
8303:
1.660 raeburn 8304: sub ask_for_embedded_content {
8305: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8306: my $upload_output = '
8307: <form name="upload_embedded" action="'.$actionurl.'"
8308: method="post" enctype="multipart/form-data">';
8309: $upload_output .= $state;
1.661 raeburn 8310: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8311:
8312: my $num = 0;
8313: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8314: $upload_output .= &start_data_table_row().
8315: '<td>'.$embed_file.'</td><td>';
8316: if ($args->{'ignore_remote_references'}
8317: && $embed_file =~ m{^\w+://}) {
8318: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8319: } elsif ($args->{'error_on_invalid_names'}
8320: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8321:
8322: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8323:
8324: } else {
8325: $upload_output .='
1.661 raeburn 8326: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8327: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8328: my $attrib = join(':',@{$$allfiles{$embed_file}});
8329: $upload_output .=
8330: "\n\t\t".
8331: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8332: $attrib.'" />';
8333: if (exists($$codebase{$embed_file})) {
8334: $upload_output .=
8335: "\n\t\t".
8336: '<input name="codebase_'.$num.'" type="hidden" value="'.
8337: &escape($$codebase{$embed_file}).'" />';
8338: }
8339: }
8340: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8341: $num++;
8342: }
8343: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8344: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8345: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8346: '.&mt('(only files for which a location has been provided will be uploaded)').'
8347: </form>';
8348: return $upload_output;
8349: }
8350:
1.661 raeburn 8351: sub upload_embedded {
8352: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8353: $current_disk_usage) = @_;
8354: my $output;
8355: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8356: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8357: my $orig_uploaded_filename =
8358: $env{'form.embedded_item_'.$i.'.filename'};
8359:
8360: $env{'form.embedded_orig_'.$i} =
8361: &unescape($env{'form.embedded_orig_'.$i});
8362: my ($path,$fname) =
8363: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8364: # no path, whole string is fname
8365: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8366:
8367: $path = $env{'form.currentpath'}.$path;
8368: $fname = &Apache::lonnet::clean_filename($fname);
8369: # See if there is anything left
8370: next if ($fname eq '');
8371:
8372: # Check if file already exists as a file or directory.
8373: my ($state,$msg);
8374: if ($context eq 'portfolio') {
8375: my $port_path = $dirpath;
8376: if ($group ne '') {
8377: $port_path = "groups/$group/$port_path";
8378: }
8379: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8380: $dir_root,$port_path,$disk_quota,
8381: $current_disk_usage,$uname,$udom);
8382: if ($state eq 'will_exceed_quota'
8383: || $state eq 'file_locked'
8384: || $state eq 'file_exists' ) {
8385: $output .= $msg;
8386: next;
8387: }
8388: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8389: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8390: if ($state eq 'exists') {
8391: $output .= $msg;
8392: next;
8393: }
8394: }
8395: # Check if extension is valid
8396: if (($fname =~ /\.(\w+)$/) &&
8397: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8398: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8399: next;
8400: } elsif (($fname =~ /\.(\w+)$/) &&
8401: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8402: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8403: next;
8404: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8405: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8406: next;
8407: }
8408:
8409: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8410: if ($context eq 'portfolio') {
8411: my $result=
8412: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8413: $dirpath.$path);
8414: if ($result !~ m|^/uploaded/|) {
8415: $output .= '<span class="LC_error">'
8416: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8417: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8418: .'</span><br />';
8419: next;
8420: } else {
8421: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8422: $path.$fname.'</span>').'</p>';
8423: }
8424: } else {
8425: # Save the file
8426: my $target = $env{'form.embedded_item_'.$i};
8427: my $fullpath = $dir_root.$dirpath.'/'.$path;
8428: my $dest = $fullpath.$fname;
8429: my $url = $url_root.$dirpath.'/'.$path.$fname;
8430: my @parts=split(/\//,$fullpath);
8431: my $count;
8432: my $filepath = $dir_root;
8433: for ($count=4;$count<=$#parts;$count++) {
8434: $filepath .= "/$parts[$count]";
8435: if ((-e $filepath)!=1) {
8436: mkdir($filepath,0770);
8437: }
8438: }
8439: my $fh;
8440: if (!open($fh,'>'.$dest)) {
8441: &Apache::lonnet::logthis('Failed to create '.$dest);
8442: $output .= '<span class="LC_error">'.
8443: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8444: '</span><br />';
8445: } else {
8446: if (!print $fh $env{'form.embedded_item_'.$i}) {
8447: &Apache::lonnet::logthis('Failed to write to '.$dest);
8448: $output .= '<span class="LC_error">'.
8449: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8450: '</span><br />';
8451: } else {
8452: if ($context eq 'testbank') {
8453: $output .= &mt('Embedded file uploaded successfully:').
8454: ' <a href="'.$url.'">'.
8455: $orig_uploaded_filename.'</a><br />';
8456: } else {
1.705 tempelho 8457: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8458: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8459: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8460: }
8461: }
8462: close($fh);
8463: }
8464: }
8465: }
8466: return $output;
8467: }
8468:
8469: sub check_for_existing {
8470: my ($path,$fname,$element) = @_;
8471: my ($state,$msg);
8472: if (-d $path.'/'.$fname) {
8473: $state = 'exists';
8474: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8475: } elsif (-e $path.'/'.$fname) {
8476: $state = 'exists';
8477: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8478: }
8479: if ($state eq 'exists') {
8480: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8481: }
8482: return ($state,$msg);
8483: }
8484:
8485: sub check_for_upload {
8486: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8487: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8488: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8489: my $getpropath = 1;
8490: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8491: $getpropath);
8492: my $found_file = 0;
8493: my $locked_file = 0;
8494: foreach my $line (@dir_list) {
8495: my ($file_name)=split(/\&/,$line,2);
8496: if ($file_name eq $fname){
8497: $file_name = $path.$file_name;
8498: if ($group ne '') {
8499: $file_name = $group.$file_name;
8500: }
8501: $found_file = 1;
8502: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8503: $locked_file = 1;
8504: }
8505: }
8506: }
8507: if (($current_disk_usage + $filesize) > $disk_quota){
8508: my $msg = '<span class="LC_error">'.
8509: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8510: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8511: return ('will_exceed_quota',$msg);
8512: } elsif ($found_file) {
8513: if ($locked_file) {
8514: my $msg = '<span class="LC_error">';
8515: $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>');
8516: $msg .= '</span><br />';
8517: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8518: return ('file_locked',$msg);
8519: } else {
8520: my $msg = '<span class="LC_error">';
8521: $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'});
8522: $msg .= '</span>';
8523: $msg .= '<br />';
8524: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8525: return ('file_exists',$msg);
8526: }
8527: }
8528: }
8529:
1.31 albertel 8530:
1.41 ng 8531: =pod
1.45 matthew 8532:
1.464 albertel 8533: =back
1.41 ng 8534:
1.112 bowersj2 8535: =head1 CSV Upload/Handling functions
1.38 albertel 8536:
1.41 ng 8537: =over 4
8538:
1.648 raeburn 8539: =item * &upfile_store($r)
1.41 ng 8540:
8541: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8542: needs $env{'form.upfile'}
1.41 ng 8543: returns $datatoken to be put into hidden field
8544:
8545: =cut
1.31 albertel 8546:
8547: sub upfile_store {
8548: my $r=shift;
1.258 albertel 8549: $env{'form.upfile'}=~s/\r/\n/gs;
8550: $env{'form.upfile'}=~s/\f/\n/gs;
8551: $env{'form.upfile'}=~s/\n+/\n/gs;
8552: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8553:
1.258 albertel 8554: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8555: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8556: {
1.158 raeburn 8557: my $datafile = $r->dir_config('lonDaemons').
8558: '/tmp/'.$datatoken.'.tmp';
8559: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8560: print $fh $env{'form.upfile'};
1.158 raeburn 8561: close($fh);
8562: }
1.31 albertel 8563: }
8564: return $datatoken;
8565: }
8566:
1.56 matthew 8567: =pod
8568:
1.648 raeburn 8569: =item * &load_tmp_file($r)
1.41 ng 8570:
8571: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8572: needs $env{'form.datatoken'},
8573: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8574:
8575: =cut
1.31 albertel 8576:
8577: sub load_tmp_file {
8578: my $r=shift;
8579: my @studentdata=();
8580: {
1.158 raeburn 8581: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8582: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8583: if ( open(my $fh,"<$studentfile") ) {
8584: @studentdata=<$fh>;
8585: close($fh);
8586: }
1.31 albertel 8587: }
1.258 albertel 8588: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8589: }
8590:
1.56 matthew 8591: =pod
8592:
1.648 raeburn 8593: =item * &upfile_record_sep()
1.41 ng 8594:
8595: Separate uploaded file into records
8596: returns array of records,
1.258 albertel 8597: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8598:
8599: =cut
1.31 albertel 8600:
8601: sub upfile_record_sep {
1.258 albertel 8602: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8603: } else {
1.248 albertel 8604: my @records;
1.258 albertel 8605: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8606: if ($line=~/^\s*$/) { next; }
8607: push(@records,$line);
8608: }
8609: return @records;
1.31 albertel 8610: }
8611: }
8612:
1.56 matthew 8613: =pod
8614:
1.648 raeburn 8615: =item * &record_sep($record)
1.41 ng 8616:
1.258 albertel 8617: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8618:
8619: =cut
8620:
1.263 www 8621: sub takeleft {
8622: my $index=shift;
8623: return substr('0000'.$index,-4,4);
8624: }
8625:
1.31 albertel 8626: sub record_sep {
8627: my $record=shift;
8628: my %components=();
1.258 albertel 8629: if ($env{'form.upfiletype'} eq 'xml') {
8630: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8631: my $i=0;
1.356 albertel 8632: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8633: $field=~s/^(\"|\')//;
8634: $field=~s/(\"|\')$//;
1.263 www 8635: $components{&takeleft($i)}=$field;
1.31 albertel 8636: $i++;
8637: }
1.258 albertel 8638: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8639: my $i=0;
1.356 albertel 8640: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8641: $field=~s/^(\"|\')//;
8642: $field=~s/(\"|\')$//;
1.263 www 8643: $components{&takeleft($i)}=$field;
1.31 albertel 8644: $i++;
8645: }
8646: } else {
1.561 www 8647: my $separator=',';
1.480 banghart 8648: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8649: $separator=';';
1.480 banghart 8650: }
1.31 albertel 8651: my $i=0;
1.561 www 8652: # the character we are looking for to indicate the end of a quote or a record
8653: my $looking_for=$separator;
8654: # do not add the characters to the fields
8655: my $ignore=0;
8656: # we just encountered a separator (or the beginning of the record)
8657: my $just_found_separator=1;
8658: # store the field we are working on here
8659: my $field='';
8660: # work our way through all characters in record
8661: foreach my $character ($record=~/(.)/g) {
8662: if ($character eq $looking_for) {
8663: if ($character ne $separator) {
8664: # Found the end of a quote, again looking for separator
8665: $looking_for=$separator;
8666: $ignore=1;
8667: } else {
8668: # Found a separator, store away what we got
8669: $components{&takeleft($i)}=$field;
8670: $i++;
8671: $just_found_separator=1;
8672: $ignore=0;
8673: $field='';
8674: }
8675: next;
8676: }
8677: # single or double quotation marks after a separator indicate beginning of a quote
8678: # we are now looking for the end of the quote and need to ignore separators
8679: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8680: $looking_for=$character;
8681: next;
8682: }
8683: # ignore would be true after we reached the end of a quote
8684: if ($ignore) { next; }
8685: if (($just_found_separator) && ($character=~/\s/)) { next; }
8686: $field.=$character;
8687: $just_found_separator=0;
1.31 albertel 8688: }
1.561 www 8689: # catch the very last entry, since we never encountered the separator
8690: $components{&takeleft($i)}=$field;
1.31 albertel 8691: }
8692: return %components;
8693: }
8694:
1.144 matthew 8695: ######################################################
8696: ######################################################
8697:
1.56 matthew 8698: =pod
8699:
1.648 raeburn 8700: =item * &upfile_select_html()
1.41 ng 8701:
1.144 matthew 8702: Return HTML code to select a file from the users machine and specify
8703: the file type.
1.41 ng 8704:
8705: =cut
8706:
1.144 matthew 8707: ######################################################
8708: ######################################################
1.31 albertel 8709: sub upfile_select_html {
1.144 matthew 8710: my %Types = (
8711: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8712: semisv => &mt('Semicolon separated values'),
1.144 matthew 8713: space => &mt('Space separated'),
8714: tab => &mt('Tabulator separated'),
8715: # xml => &mt('HTML/XML'),
8716: );
8717: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8718: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8719: foreach my $type (sort(keys(%Types))) {
8720: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8721: }
8722: $Str .= "</select>\n";
8723: return $Str;
1.31 albertel 8724: }
8725:
1.301 albertel 8726: sub get_samples {
8727: my ($records,$toget) = @_;
8728: my @samples=({});
8729: my $got=0;
8730: foreach my $rec (@$records) {
8731: my %temp = &record_sep($rec);
8732: if (! grep(/\S/, values(%temp))) { next; }
8733: if (%temp) {
8734: $samples[$got]=\%temp;
8735: $got++;
8736: if ($got == $toget) { last; }
8737: }
8738: }
8739: return \@samples;
8740: }
8741:
1.144 matthew 8742: ######################################################
8743: ######################################################
8744:
1.56 matthew 8745: =pod
8746:
1.648 raeburn 8747: =item * &csv_print_samples($r,$records)
1.41 ng 8748:
8749: Prints a table of sample values from each column uploaded $r is an
8750: Apache Request ref, $records is an arrayref from
8751: &Apache::loncommon::upfile_record_sep
8752:
8753: =cut
8754:
1.144 matthew 8755: ######################################################
8756: ######################################################
1.31 albertel 8757: sub csv_print_samples {
8758: my ($r,$records) = @_;
1.662 bisitz 8759: my $samples = &get_samples($records,5);
1.301 albertel 8760:
1.594 raeburn 8761: $r->print(&mt('Samples').'<br />'.&start_data_table().
8762: &start_data_table_header_row());
1.356 albertel 8763: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8764: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8765: $r->print(&end_data_table_header_row());
1.301 albertel 8766: foreach my $hash (@$samples) {
1.594 raeburn 8767: $r->print(&start_data_table_row());
1.356 albertel 8768: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8769: $r->print('<td>');
1.356 albertel 8770: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8771: $r->print('</td>');
8772: }
1.594 raeburn 8773: $r->print(&end_data_table_row());
1.31 albertel 8774: }
1.594 raeburn 8775: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8776: }
8777:
1.144 matthew 8778: ######################################################
8779: ######################################################
8780:
1.56 matthew 8781: =pod
8782:
1.648 raeburn 8783: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8784:
8785: Prints a table to create associations between values and table columns.
1.144 matthew 8786:
1.41 ng 8787: $r is an Apache Request ref,
8788: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8789: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8790:
8791: =cut
8792:
1.144 matthew 8793: ######################################################
8794: ######################################################
1.31 albertel 8795: sub csv_print_select_table {
8796: my ($r,$records,$d) = @_;
1.301 albertel 8797: my $i=0;
8798: my $samples = &get_samples($records,1);
1.144 matthew 8799: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8800: &start_data_table().&start_data_table_header_row().
1.144 matthew 8801: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8802: '<th>'.&mt('Column').'</th>'.
8803: &end_data_table_header_row()."\n");
1.356 albertel 8804: foreach my $array_ref (@$d) {
8805: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8806: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8807:
1.875 bisitz 8808: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8809: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8810: $r->print('<option value="none"></option>');
1.356 albertel 8811: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8812: $r->print('<option value="'.$sample.'"'.
8813: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8814: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8815: }
1.594 raeburn 8816: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8817: $i++;
8818: }
1.594 raeburn 8819: $r->print(&end_data_table());
1.31 albertel 8820: $i--;
8821: return $i;
8822: }
1.56 matthew 8823:
1.144 matthew 8824: ######################################################
8825: ######################################################
8826:
1.56 matthew 8827: =pod
1.31 albertel 8828:
1.648 raeburn 8829: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8830:
8831: Prints a table of sample values from the upload and can make associate samples to internal names.
8832:
8833: $r is an Apache Request ref,
8834: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8835: $d is an array of 2 element arrays (internal name, displayed name)
8836:
8837: =cut
8838:
1.144 matthew 8839: ######################################################
8840: ######################################################
1.31 albertel 8841: sub csv_samples_select_table {
8842: my ($r,$records,$d) = @_;
8843: my $i=0;
1.144 matthew 8844: #
1.662 bisitz 8845: my $max_samples = 5;
8846: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8847: $r->print(&start_data_table().
8848: &start_data_table_header_row().'<th>'.
8849: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8850: &end_data_table_header_row());
1.301 albertel 8851:
8852: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8853: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8854: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8855: foreach my $option (@$d) {
8856: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8857: $r->print('<option value="'.$value.'"'.
1.253 albertel 8858: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8859: $display.'</option>');
1.31 albertel 8860: }
8861: $r->print('</select></td><td>');
1.662 bisitz 8862: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8863: if (defined($samples->[$line]{$key})) {
8864: $r->print($samples->[$line]{$key}."<br />\n");
8865: }
8866: }
1.594 raeburn 8867: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8868: $i++;
8869: }
1.594 raeburn 8870: $r->print(&end_data_table());
1.31 albertel 8871: $i--;
8872: return($i);
1.115 matthew 8873: }
8874:
1.144 matthew 8875: ######################################################
8876: ######################################################
8877:
1.115 matthew 8878: =pod
8879:
1.648 raeburn 8880: =item * &clean_excel_name($name)
1.115 matthew 8881:
8882: Returns a replacement for $name which does not contain any illegal characters.
8883:
8884: =cut
8885:
1.144 matthew 8886: ######################################################
8887: ######################################################
1.115 matthew 8888: sub clean_excel_name {
8889: my ($name) = @_;
8890: $name =~ s/[:\*\?\/\\]//g;
8891: if (length($name) > 31) {
8892: $name = substr($name,0,31);
8893: }
8894: return $name;
1.25 albertel 8895: }
1.84 albertel 8896:
1.85 albertel 8897: =pod
8898:
1.648 raeburn 8899: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8900:
8901: Returns either 1 or undef
8902:
8903: 1 if the part is to be hidden, undef if it is to be shown
8904:
8905: Arguments are:
8906:
8907: $id the id of the part to be checked
8908: $symb, optional the symb of the resource to check
8909: $udom, optional the domain of the user to check for
8910: $uname, optional the username of the user to check for
8911:
8912: =cut
1.84 albertel 8913:
8914: sub check_if_partid_hidden {
8915: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8916: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8917: $symb,$udom,$uname);
1.141 albertel 8918: my $truth=1;
8919: #if the string starts with !, then the list is the list to show not hide
8920: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8921: my @hiddenlist=split(/,/,$hiddenparts);
8922: foreach my $checkid (@hiddenlist) {
1.141 albertel 8923: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8924: }
1.141 albertel 8925: return !$truth;
1.84 albertel 8926: }
1.127 matthew 8927:
1.138 matthew 8928:
8929: ############################################################
8930: ############################################################
8931:
8932: =pod
8933:
1.157 matthew 8934: =back
8935:
1.138 matthew 8936: =head1 cgi-bin script and graphing routines
8937:
1.157 matthew 8938: =over 4
8939:
1.648 raeburn 8940: =item * &get_cgi_id()
1.138 matthew 8941:
8942: Inputs: none
8943:
8944: Returns an id which can be used to pass environment variables
8945: to various cgi-bin scripts. These environment variables will
8946: be removed from the users environment after a given time by
8947: the routine &Apache::lonnet::transfer_profile_to_env.
8948:
8949: =cut
8950:
8951: ############################################################
8952: ############################################################
1.152 albertel 8953: my $uniq=0;
1.136 matthew 8954: sub get_cgi_id {
1.154 albertel 8955: $uniq=($uniq+1)%100000;
1.280 albertel 8956: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8957: }
8958:
1.127 matthew 8959: ############################################################
8960: ############################################################
8961:
8962: =pod
8963:
1.648 raeburn 8964: =item * &DrawBarGraph()
1.127 matthew 8965:
1.138 matthew 8966: Facilitates the plotting of data in a (stacked) bar graph.
8967: Puts plot definition data into the users environment in order for
8968: graph.png to plot it. Returns an <img> tag for the plot.
8969: The bars on the plot are labeled '1','2',...,'n'.
8970:
8971: Inputs:
8972:
8973: =over 4
8974:
8975: =item $Title: string, the title of the plot
8976:
8977: =item $xlabel: string, text describing the X-axis of the plot
8978:
8979: =item $ylabel: string, text describing the Y-axis of the plot
8980:
8981: =item $Max: scalar, the maximum Y value to use in the plot
8982: If $Max is < any data point, the graph will not be rendered.
8983:
1.140 matthew 8984: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8985: they are plotted. If undefined, default values will be used.
8986:
1.178 matthew 8987: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8988:
1.138 matthew 8989: =item @Values: An array of array references. Each array reference holds data
8990: to be plotted in a stacked bar chart.
8991:
1.239 matthew 8992: =item If the final element of @Values is a hash reference the key/value
8993: pairs will be added to the graph definition.
8994:
1.138 matthew 8995: =back
8996:
8997: Returns:
8998:
8999: An <img> tag which references graph.png and the appropriate identifying
9000: information for the plot.
9001:
1.127 matthew 9002: =cut
9003:
9004: ############################################################
9005: ############################################################
1.134 matthew 9006: sub DrawBarGraph {
1.178 matthew 9007: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9008: #
9009: if (! defined($colors)) {
9010: $colors = ['#33ff00',
9011: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9012: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9013: ];
9014: }
1.228 matthew 9015: my $extra_settings = {};
9016: if (ref($Values[-1]) eq 'HASH') {
9017: $extra_settings = pop(@Values);
9018: }
1.127 matthew 9019: #
1.136 matthew 9020: my $identifier = &get_cgi_id();
9021: my $id = 'cgi.'.$identifier;
1.129 matthew 9022: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9023: return '';
9024: }
1.225 matthew 9025: #
9026: my @Labels;
9027: if (defined($labels)) {
9028: @Labels = @$labels;
9029: } else {
9030: for (my $i=0;$i<@{$Values[0]};$i++) {
9031: push (@Labels,$i+1);
9032: }
9033: }
9034: #
1.129 matthew 9035: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9036: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9037: my %ValuesHash;
9038: my $NumSets=1;
9039: foreach my $array (@Values) {
9040: next if (! ref($array));
1.136 matthew 9041: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9042: join(',',@$array);
1.129 matthew 9043: }
1.127 matthew 9044: #
1.136 matthew 9045: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9046: if ($NumBars < 3) {
9047: $width = 120+$NumBars*32;
1.220 matthew 9048: $xskip = 1;
1.225 matthew 9049: $bar_width = 30;
9050: } elsif ($NumBars < 5) {
9051: $width = 120+$NumBars*20;
9052: $xskip = 1;
9053: $bar_width = 20;
1.220 matthew 9054: } elsif ($NumBars < 10) {
1.136 matthew 9055: $width = 120+$NumBars*15;
9056: $xskip = 1;
9057: $bar_width = 15;
9058: } elsif ($NumBars <= 25) {
9059: $width = 120+$NumBars*11;
9060: $xskip = 5;
9061: $bar_width = 8;
9062: } elsif ($NumBars <= 50) {
9063: $width = 120+$NumBars*8;
9064: $xskip = 5;
9065: $bar_width = 4;
9066: } else {
9067: $width = 120+$NumBars*8;
9068: $xskip = 5;
9069: $bar_width = 4;
9070: }
9071: #
1.137 matthew 9072: $Max = 1 if ($Max < 1);
9073: if ( int($Max) < $Max ) {
9074: $Max++;
9075: $Max = int($Max);
9076: }
1.127 matthew 9077: $Title = '' if (! defined($Title));
9078: $xlabel = '' if (! defined($xlabel));
9079: $ylabel = '' if (! defined($ylabel));
1.369 www 9080: $ValuesHash{$id.'.title'} = &escape($Title);
9081: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9082: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9083: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9084: $ValuesHash{$id.'.NumBars'} = $NumBars;
9085: $ValuesHash{$id.'.NumSets'} = $NumSets;
9086: $ValuesHash{$id.'.PlotType'} = 'bar';
9087: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9088: $ValuesHash{$id.'.height'} = $height;
9089: $ValuesHash{$id.'.width'} = $width;
9090: $ValuesHash{$id.'.xskip'} = $xskip;
9091: $ValuesHash{$id.'.bar_width'} = $bar_width;
9092: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9093: #
1.228 matthew 9094: # Deal with other parameters
9095: while (my ($key,$value) = each(%$extra_settings)) {
9096: $ValuesHash{$id.'.'.$key} = $value;
9097: }
9098: #
1.646 raeburn 9099: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9100: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9101: }
9102:
9103: ############################################################
9104: ############################################################
9105:
9106: =pod
9107:
1.648 raeburn 9108: =item * &DrawXYGraph()
1.137 matthew 9109:
1.138 matthew 9110: Facilitates the plotting of data in an XY graph.
9111: Puts plot definition data into the users environment in order for
9112: graph.png to plot it. Returns an <img> tag for the plot.
9113:
9114: Inputs:
9115:
9116: =over 4
9117:
9118: =item $Title: string, the title of the plot
9119:
9120: =item $xlabel: string, text describing the X-axis of the plot
9121:
9122: =item $ylabel: string, text describing the Y-axis of the plot
9123:
9124: =item $Max: scalar, the maximum Y value to use in the plot
9125: If $Max is < any data point, the graph will not be rendered.
9126:
9127: =item $colors: Array ref containing the hex color codes for the data to be
9128: plotted in. If undefined, default values will be used.
9129:
9130: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9131:
9132: =item $Ydata: Array ref containing Array refs.
1.185 www 9133: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9134:
9135: =item %Values: hash indicating or overriding any default values which are
9136: passed to graph.png.
9137: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9138:
9139: =back
9140:
9141: Returns:
9142:
9143: An <img> tag which references graph.png and the appropriate identifying
9144: information for the plot.
9145:
1.137 matthew 9146: =cut
9147:
9148: ############################################################
9149: ############################################################
9150: sub DrawXYGraph {
9151: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9152: #
9153: # Create the identifier for the graph
9154: my $identifier = &get_cgi_id();
9155: my $id = 'cgi.'.$identifier;
9156: #
9157: $Title = '' if (! defined($Title));
9158: $xlabel = '' if (! defined($xlabel));
9159: $ylabel = '' if (! defined($ylabel));
9160: my %ValuesHash =
9161: (
1.369 www 9162: $id.'.title' => &escape($Title),
9163: $id.'.xlabel' => &escape($xlabel),
9164: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9165: $id.'.y_max_value'=> $Max,
9166: $id.'.labels' => join(',',@$Xlabels),
9167: $id.'.PlotType' => 'XY',
9168: );
9169: #
9170: if (defined($colors) && ref($colors) eq 'ARRAY') {
9171: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9172: }
9173: #
9174: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9175: return '';
9176: }
9177: my $NumSets=1;
1.138 matthew 9178: foreach my $array (@{$Ydata}){
1.137 matthew 9179: next if (! ref($array));
9180: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9181: }
1.138 matthew 9182: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9183: #
9184: # Deal with other parameters
9185: while (my ($key,$value) = each(%Values)) {
9186: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9187: }
9188: #
1.646 raeburn 9189: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9190: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9191: }
9192:
9193: ############################################################
9194: ############################################################
9195:
9196: =pod
9197:
1.648 raeburn 9198: =item * &DrawXYYGraph()
1.138 matthew 9199:
9200: Facilitates the plotting of data in an XY graph with two Y axes.
9201: Puts plot definition data into the users environment in order for
9202: graph.png to plot it. Returns an <img> tag for the plot.
9203:
9204: Inputs:
9205:
9206: =over 4
9207:
9208: =item $Title: string, the title of the plot
9209:
9210: =item $xlabel: string, text describing the X-axis of the plot
9211:
9212: =item $ylabel: string, text describing the Y-axis of the plot
9213:
9214: =item $colors: Array ref containing the hex color codes for the data to be
9215: plotted in. If undefined, default values will be used.
9216:
9217: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9218:
9219: =item $Ydata1: The first data set
9220:
9221: =item $Min1: The minimum value of the left Y-axis
9222:
9223: =item $Max1: The maximum value of the left Y-axis
9224:
9225: =item $Ydata2: The second data set
9226:
9227: =item $Min2: The minimum value of the right Y-axis
9228:
9229: =item $Max2: The maximum value of the left Y-axis
9230:
9231: =item %Values: hash indicating or overriding any default values which are
9232: passed to graph.png.
9233: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9234:
9235: =back
9236:
9237: Returns:
9238:
9239: An <img> tag which references graph.png and the appropriate identifying
9240: information for the plot.
1.136 matthew 9241:
9242: =cut
9243:
9244: ############################################################
9245: ############################################################
1.137 matthew 9246: sub DrawXYYGraph {
9247: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9248: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9249: #
9250: # Create the identifier for the graph
9251: my $identifier = &get_cgi_id();
9252: my $id = 'cgi.'.$identifier;
9253: #
9254: $Title = '' if (! defined($Title));
9255: $xlabel = '' if (! defined($xlabel));
9256: $ylabel = '' if (! defined($ylabel));
9257: my %ValuesHash =
9258: (
1.369 www 9259: $id.'.title' => &escape($Title),
9260: $id.'.xlabel' => &escape($xlabel),
9261: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9262: $id.'.labels' => join(',',@$Xlabels),
9263: $id.'.PlotType' => 'XY',
9264: $id.'.NumSets' => 2,
1.137 matthew 9265: $id.'.two_axes' => 1,
9266: $id.'.y1_max_value' => $Max1,
9267: $id.'.y1_min_value' => $Min1,
9268: $id.'.y2_max_value' => $Max2,
9269: $id.'.y2_min_value' => $Min2,
1.136 matthew 9270: );
9271: #
1.137 matthew 9272: if (defined($colors) && ref($colors) eq 'ARRAY') {
9273: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9274: }
9275: #
9276: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9277: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9278: return '';
9279: }
9280: my $NumSets=1;
1.137 matthew 9281: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9282: next if (! ref($array));
9283: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9284: }
9285: #
9286: # Deal with other parameters
9287: while (my ($key,$value) = each(%Values)) {
9288: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9289: }
9290: #
1.646 raeburn 9291: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9292: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9293: }
9294:
9295: ############################################################
9296: ############################################################
9297:
9298: =pod
9299:
1.157 matthew 9300: =back
9301:
1.139 matthew 9302: =head1 Statistics helper routines?
9303:
9304: Bad place for them but what the hell.
9305:
1.157 matthew 9306: =over 4
9307:
1.648 raeburn 9308: =item * &chartlink()
1.139 matthew 9309:
9310: Returns a link to the chart for a specific student.
9311:
9312: Inputs:
9313:
9314: =over 4
9315:
9316: =item $linktext: The text of the link
9317:
9318: =item $sname: The students username
9319:
9320: =item $sdomain: The students domain
9321:
9322: =back
9323:
1.157 matthew 9324: =back
9325:
1.139 matthew 9326: =cut
9327:
9328: ############################################################
9329: ############################################################
9330: sub chartlink {
9331: my ($linktext, $sname, $sdomain) = @_;
9332: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9333: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9334: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9335: '">'.$linktext.'</a>';
1.153 matthew 9336: }
9337:
9338: #######################################################
9339: #######################################################
9340:
9341: =pod
9342:
9343: =head1 Course Environment Routines
1.157 matthew 9344:
9345: =over 4
1.153 matthew 9346:
1.648 raeburn 9347: =item * &restore_course_settings()
1.153 matthew 9348:
1.648 raeburn 9349: =item * &store_course_settings()
1.153 matthew 9350:
9351: Restores/Store indicated form parameters from the course environment.
9352: Will not overwrite existing values of the form parameters.
9353:
9354: Inputs:
9355: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9356:
9357: a hash ref describing the data to be stored. For example:
9358:
9359: %Save_Parameters = ('Status' => 'scalar',
9360: 'chartoutputmode' => 'scalar',
9361: 'chartoutputdata' => 'scalar',
9362: 'Section' => 'array',
1.373 raeburn 9363: 'Group' => 'array',
1.153 matthew 9364: 'StudentData' => 'array',
9365: 'Maps' => 'array');
9366:
9367: Returns: both routines return nothing
9368:
1.631 raeburn 9369: =back
9370:
1.153 matthew 9371: =cut
9372:
9373: #######################################################
9374: #######################################################
9375: sub store_course_settings {
1.496 albertel 9376: return &store_settings($env{'request.course.id'},@_);
9377: }
9378:
9379: sub store_settings {
1.153 matthew 9380: # save to the environment
9381: # appenv the same items, just to be safe
1.300 albertel 9382: my $udom = $env{'user.domain'};
9383: my $uname = $env{'user.name'};
1.496 albertel 9384: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9385: my %SaveHash;
9386: my %AppHash;
9387: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9388: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9389: my $envname = 'environment.'.$basename;
1.258 albertel 9390: if (exists($env{'form.'.$setting})) {
1.153 matthew 9391: # Save this value away
9392: if ($type eq 'scalar' &&
1.258 albertel 9393: (! exists($env{$envname}) ||
9394: $env{$envname} ne $env{'form.'.$setting})) {
9395: $SaveHash{$basename} = $env{'form.'.$setting};
9396: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9397: } elsif ($type eq 'array') {
9398: my $stored_form;
1.258 albertel 9399: if (ref($env{'form.'.$setting})) {
1.153 matthew 9400: $stored_form = join(',',
9401: map {
1.369 www 9402: &escape($_);
1.258 albertel 9403: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9404: } else {
9405: $stored_form =
1.369 www 9406: &escape($env{'form.'.$setting});
1.153 matthew 9407: }
9408: # Determine if the array contents are the same.
1.258 albertel 9409: if ($stored_form ne $env{$envname}) {
1.153 matthew 9410: $SaveHash{$basename} = $stored_form;
9411: $AppHash{$envname} = $stored_form;
9412: }
9413: }
9414: }
9415: }
9416: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9417: $udom,$uname);
1.153 matthew 9418: if ($put_result !~ /^(ok|delayed)/) {
9419: &Apache::lonnet::logthis('unable to save form parameters, '.
9420: 'got error:'.$put_result);
9421: }
9422: # Make sure these settings stick around in this session, too
1.646 raeburn 9423: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9424: return;
9425: }
9426:
9427: sub restore_course_settings {
1.499 albertel 9428: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9429: }
9430:
9431: sub restore_settings {
9432: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9433: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9434: next if (exists($env{'form.'.$setting}));
1.496 albertel 9435: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9436: '.'.$setting;
1.258 albertel 9437: if (exists($env{$envname})) {
1.153 matthew 9438: if ($type eq 'scalar') {
1.258 albertel 9439: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9440: } elsif ($type eq 'array') {
1.258 albertel 9441: $env{'form.'.$setting} = [
1.153 matthew 9442: map {
1.369 www 9443: &unescape($_);
1.258 albertel 9444: } split(',',$env{$envname})
1.153 matthew 9445: ];
9446: }
9447: }
9448: }
1.127 matthew 9449: }
9450:
1.618 raeburn 9451: #######################################################
9452: #######################################################
9453:
9454: =pod
9455:
9456: =head1 Domain E-mail Routines
9457:
9458: =over 4
9459:
1.648 raeburn 9460: =item * &build_recipient_list()
1.618 raeburn 9461:
1.884 raeburn 9462: Build recipient lists for five types of e-mail:
1.766 raeburn 9463: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9464: (d) Help requests, (e) Course requests needing approval, generated by
9465: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9466: loncoursequeueadmin.pm respectively.
1.618 raeburn 9467:
9468: Inputs:
1.619 raeburn 9469: defmail (scalar - email address of default recipient),
1.618 raeburn 9470: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9471: defdom (domain for which to retrieve configuration settings),
9472: origmail (scalar - email address of recipient from loncapa.conf,
9473: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9474:
1.655 raeburn 9475: Returns: comma separated list of addresses to which to send e-mail.
9476:
9477: =back
1.618 raeburn 9478:
9479: =cut
9480:
9481: ############################################################
9482: ############################################################
9483: sub build_recipient_list {
1.619 raeburn 9484: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9485: my @recipients;
9486: my $otheremails;
9487: my %domconfig =
9488: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9489: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9490: if (exists($domconfig{'contacts'}{$mailing})) {
9491: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9492: my @contacts = ('adminemail','supportemail');
9493: foreach my $item (@contacts) {
9494: if ($domconfig{'contacts'}{$mailing}{$item}) {
9495: my $addr = $domconfig{'contacts'}{$item};
9496: if (!grep(/^\Q$addr\E$/,@recipients)) {
9497: push(@recipients,$addr);
9498: }
1.619 raeburn 9499: }
1.766 raeburn 9500: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9501: }
9502: }
1.766 raeburn 9503: } elsif ($origmail ne '') {
9504: push(@recipients,$origmail);
1.618 raeburn 9505: }
1.619 raeburn 9506: } elsif ($origmail ne '') {
9507: push(@recipients,$origmail);
1.618 raeburn 9508: }
1.688 raeburn 9509: if (defined($defmail)) {
9510: if ($defmail ne '') {
9511: push(@recipients,$defmail);
9512: }
1.618 raeburn 9513: }
9514: if ($otheremails) {
1.619 raeburn 9515: my @others;
9516: if ($otheremails =~ /,/) {
9517: @others = split(/,/,$otheremails);
1.618 raeburn 9518: } else {
1.619 raeburn 9519: push(@others,$otheremails);
9520: }
9521: foreach my $addr (@others) {
9522: if (!grep(/^\Q$addr\E$/,@recipients)) {
9523: push(@recipients,$addr);
9524: }
1.618 raeburn 9525: }
9526: }
1.619 raeburn 9527: my $recipientlist = join(',',@recipients);
1.618 raeburn 9528: return $recipientlist;
9529: }
9530:
1.127 matthew 9531: ############################################################
9532: ############################################################
1.154 albertel 9533:
1.655 raeburn 9534: =pod
9535:
9536: =head1 Course Catalog Routines
9537:
9538: =over 4
9539:
9540: =item * &gather_categories()
9541:
9542: Converts category definitions - keys of categories hash stored in
9543: coursecategories in configuration.db on the primary library server in a
9544: domain - to an array. Also generates javascript and idx hash used to
9545: generate Domain Coordinator interface for editing Course Categories.
9546:
9547: Inputs:
1.663 raeburn 9548:
1.655 raeburn 9549: categories (reference to hash of category definitions).
1.663 raeburn 9550:
1.655 raeburn 9551: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9552: categories and subcategories).
1.663 raeburn 9553:
1.655 raeburn 9554: idx (reference to hash of counters used in Domain Coordinator interface for
9555: editing Course Categories).
1.663 raeburn 9556:
1.655 raeburn 9557: jsarray (reference to array of categories used to create Javascript arrays for
9558: Domain Coordinator interface for editing Course Categories).
9559:
9560: Returns: nothing
9561:
9562: Side effects: populates cats, idx and jsarray.
9563:
9564: =cut
9565:
9566: sub gather_categories {
9567: my ($categories,$cats,$idx,$jsarray) = @_;
9568: my %counters;
9569: my $num = 0;
9570: foreach my $item (keys(%{$categories})) {
9571: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9572: if ($container eq '' && $depth == 0) {
9573: $cats->[$depth][$categories->{$item}] = $cat;
9574: } else {
9575: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9576: }
9577: my ($escitem,$tail) = split(/:/,$item,2);
9578: if ($counters{$tail} eq '') {
9579: $counters{$tail} = $num;
9580: $num ++;
9581: }
9582: if (ref($idx) eq 'HASH') {
9583: $idx->{$item} = $counters{$tail};
9584: }
9585: if (ref($jsarray) eq 'ARRAY') {
9586: push(@{$jsarray->[$counters{$tail}]},$item);
9587: }
9588: }
9589: return;
9590: }
9591:
9592: =pod
9593:
9594: =item * &extract_categories()
9595:
9596: Used to generate breadcrumb trails for course categories.
9597:
9598: Inputs:
1.663 raeburn 9599:
1.655 raeburn 9600: categories (reference to hash of category definitions).
1.663 raeburn 9601:
1.655 raeburn 9602: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9603: categories and subcategories).
1.663 raeburn 9604:
1.655 raeburn 9605: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9606:
1.655 raeburn 9607: allitems (reference to hash - key is category key
9608: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9609:
1.655 raeburn 9610: idx (reference to hash of counters used in Domain Coordinator interface for
9611: editing Course Categories).
1.663 raeburn 9612:
1.655 raeburn 9613: jsarray (reference to array of categories used to create Javascript arrays for
9614: Domain Coordinator interface for editing Course Categories).
9615:
1.665 raeburn 9616: subcats (reference to hash of arrays containing all subcategories within each
9617: category, -recursive)
9618:
1.655 raeburn 9619: Returns: nothing
9620:
9621: Side effects: populates trails and allitems hash references.
9622:
9623: =cut
9624:
9625: sub extract_categories {
1.665 raeburn 9626: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9627: if (ref($categories) eq 'HASH') {
9628: &gather_categories($categories,$cats,$idx,$jsarray);
9629: if (ref($cats->[0]) eq 'ARRAY') {
9630: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9631: my $name = $cats->[0][$i];
9632: my $item = &escape($name).'::0';
9633: my $trailstr;
9634: if ($name eq 'instcode') {
9635: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9636: } elsif ($name eq 'communities') {
9637: $trailstr = &mt('Communities');
1.655 raeburn 9638: } else {
9639: $trailstr = $name;
9640: }
9641: if ($allitems->{$item} eq '') {
9642: push(@{$trails},$trailstr);
9643: $allitems->{$item} = scalar(@{$trails})-1;
9644: }
9645: my @parents = ($name);
9646: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9647: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9648: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9649: if (ref($subcats) eq 'HASH') {
9650: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9651: }
9652: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9653: }
9654: } else {
9655: if (ref($subcats) eq 'HASH') {
9656: $subcats->{$item} = [];
1.655 raeburn 9657: }
9658: }
9659: }
9660: }
9661: }
9662: return;
9663: }
9664:
9665: =pod
9666:
9667: =item *&recurse_categories()
9668:
9669: Recursively used to generate breadcrumb trails for course categories.
9670:
9671: Inputs:
1.663 raeburn 9672:
1.655 raeburn 9673: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9674: categories and subcategories).
1.663 raeburn 9675:
1.655 raeburn 9676: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9677:
9678: category (current course category, for which breadcrumb trail is being generated).
9679:
9680: trails (reference to array of breadcrumb trails for each category).
9681:
1.655 raeburn 9682: allitems (reference to hash - key is category key
9683: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9684:
1.655 raeburn 9685: parents (array containing containers directories for current category,
9686: back to top level).
9687:
9688: Returns: nothing
9689:
9690: Side effects: populates trails and allitems hash references
9691:
9692: =cut
9693:
9694: sub recurse_categories {
1.665 raeburn 9695: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9696: my $shallower = $depth - 1;
9697: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9698: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9699: my $name = $cats->[$depth]{$category}[$k];
9700: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9701: my $trailstr = join(' -> ',(@{$parents},$category));
9702: if ($allitems->{$item} eq '') {
9703: push(@{$trails},$trailstr);
9704: $allitems->{$item} = scalar(@{$trails})-1;
9705: }
9706: my $deeper = $depth+1;
9707: push(@{$parents},$category);
1.665 raeburn 9708: if (ref($subcats) eq 'HASH') {
9709: my $subcat = &escape($name).':'.$category.':'.$depth;
9710: for (my $j=@{$parents}; $j>=0; $j--) {
9711: my $higher;
9712: if ($j > 0) {
9713: $higher = &escape($parents->[$j]).':'.
9714: &escape($parents->[$j-1]).':'.$j;
9715: } else {
9716: $higher = &escape($parents->[$j]).'::'.$j;
9717: }
9718: push(@{$subcats->{$higher}},$subcat);
9719: }
9720: }
9721: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9722: $subcats);
1.655 raeburn 9723: pop(@{$parents});
9724: }
9725: } else {
9726: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9727: my $trailstr = join(' -> ',(@{$parents},$category));
9728: if ($allitems->{$item} eq '') {
9729: push(@{$trails},$trailstr);
9730: $allitems->{$item} = scalar(@{$trails})-1;
9731: }
9732: }
9733: return;
9734: }
9735:
1.663 raeburn 9736: =pod
9737:
9738: =item *&assign_categories_table()
9739:
9740: Create a datatable for display of hierarchical categories in a domain,
9741: with checkboxes to allow a course to be categorized.
9742:
9743: Inputs:
9744:
9745: cathash - reference to hash of categories defined for the domain (from
9746: configuration.db)
9747:
9748: currcat - scalar with an & separated list of categories assigned to a course.
9749:
1.919 raeburn 9750: type - scalar contains course type (Course or Community).
9751:
1.663 raeburn 9752: Returns: $output (markup to be displayed)
9753:
9754: =cut
9755:
9756: sub assign_categories_table {
1.919 raeburn 9757: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9758: my $output;
9759: if (ref($cathash) eq 'HASH') {
9760: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9761: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9762: $maxdepth = scalar(@cats);
9763: if (@cats > 0) {
9764: my $itemcount = 0;
9765: if (ref($cats[0]) eq 'ARRAY') {
9766: my @currcategories;
9767: if ($currcat ne '') {
9768: @currcategories = split('&',$currcat);
9769: }
1.919 raeburn 9770: my $table;
1.663 raeburn 9771: for (my $i=0; $i<@{$cats[0]}; $i++) {
9772: my $parent = $cats[0][$i];
1.919 raeburn 9773: next if ($parent eq 'instcode');
9774: if ($type eq 'Community') {
9775: next unless ($parent eq 'communities');
9776: } else {
9777: next if ($parent eq 'communities');
9778: }
1.663 raeburn 9779: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9780: my $item = &escape($parent).'::0';
9781: my $checked = '';
9782: if (@currcategories > 0) {
9783: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9784: $checked = ' checked="checked"';
1.663 raeburn 9785: }
9786: }
1.919 raeburn 9787: my $parent_title = $parent;
9788: if ($parent eq 'communities') {
9789: $parent_title = &mt('Communities');
9790: }
9791: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9792: '<input type="checkbox" name="usecategory" value="'.
9793: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9794: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9795: my $depth = 1;
9796: push(@path,$parent);
1.919 raeburn 9797: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9798: pop(@path);
1.919 raeburn 9799: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9800: $itemcount ++;
9801: }
1.919 raeburn 9802: if ($itemcount) {
9803: $output = &Apache::loncommon::start_data_table().
9804: $table.
9805: &Apache::loncommon::end_data_table();
9806: }
1.663 raeburn 9807: }
9808: }
9809: }
9810: return $output;
9811: }
9812:
9813: =pod
9814:
9815: =item *&assign_category_rows()
9816:
9817: Create a datatable row for display of nested categories in a domain,
9818: with checkboxes to allow a course to be categorized,called recursively.
9819:
9820: Inputs:
9821:
9822: itemcount - track row number for alternating colors
9823:
9824: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9825: categories and subcategories.
9826:
9827: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9828:
9829: parent - parent of current category item
9830:
9831: path - Array containing all categories back up through the hierarchy from the
9832: current category to the top level.
9833:
9834: currcategories - reference to array of current categories assigned to the course
9835:
9836: Returns: $output (markup to be displayed).
9837:
9838: =cut
9839:
9840: sub assign_category_rows {
9841: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9842: my ($text,$name,$item,$chgstr);
9843: if (ref($cats) eq 'ARRAY') {
9844: my $maxdepth = scalar(@{$cats});
9845: if (ref($cats->[$depth]) eq 'HASH') {
9846: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9847: my $numchildren = @{$cats->[$depth]{$parent}};
9848: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9849: $text .= '<td><table class="LC_datatable">';
9850: for (my $j=0; $j<$numchildren; $j++) {
9851: $name = $cats->[$depth]{$parent}[$j];
9852: $item = &escape($name).':'.&escape($parent).':'.$depth;
9853: my $deeper = $depth+1;
9854: my $checked = '';
9855: if (ref($currcategories) eq 'ARRAY') {
9856: if (@{$currcategories} > 0) {
9857: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9858: $checked = ' checked="checked"';
1.663 raeburn 9859: }
9860: }
9861: }
1.664 raeburn 9862: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9863: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9864: $item.'"'.$checked.' />'.$name.'</label></span>'.
9865: '<input type="hidden" name="catname" value="'.$name.'" />'.
9866: '</td><td>';
1.663 raeburn 9867: if (ref($path) eq 'ARRAY') {
9868: push(@{$path},$name);
9869: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9870: pop(@{$path});
9871: }
9872: $text .= '</td></tr>';
9873: }
9874: $text .= '</table></td>';
9875: }
9876: }
9877: }
9878: return $text;
9879: }
9880:
1.655 raeburn 9881: ############################################################
9882: ############################################################
9883:
9884:
1.443 albertel 9885: sub commit_customrole {
1.664 raeburn 9886: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9887: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9888: ($start?', '.&mt('starting').' '.localtime($start):'').
9889: ($end?', ending '.localtime($end):'').': <b>'.
9890: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9891: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9892: '</b><br />';
9893: return $output;
9894: }
9895:
9896: sub commit_standardrole {
1.541 raeburn 9897: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9898: my ($output,$logmsg,$linefeed);
9899: if ($context eq 'auto') {
9900: $linefeed = "\n";
9901: } else {
9902: $linefeed = "<br />\n";
9903: }
1.443 albertel 9904: if ($three eq 'st') {
1.541 raeburn 9905: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9906: $one,$two,$sec,$context);
9907: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9908: ($result eq 'unknown_course') || ($result eq 'refused')) {
9909: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9910: } else {
1.541 raeburn 9911: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9912: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9913: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9914: if ($context eq 'auto') {
9915: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9916: } else {
9917: $output .= '<b>'.$result.'</b>'.$linefeed.
9918: &mt('Add to classlist').': <b>ok</b>';
9919: }
9920: $output .= $linefeed;
1.443 albertel 9921: }
9922: } else {
9923: $output = &mt('Assigning').' '.$three.' in '.$url.
9924: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9925: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9926: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9927: if ($context eq 'auto') {
9928: $output .= $result.$linefeed;
9929: } else {
9930: $output .= '<b>'.$result.'</b>'.$linefeed;
9931: }
1.443 albertel 9932: }
9933: return $output;
9934: }
9935:
9936: sub commit_studentrole {
1.541 raeburn 9937: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9938: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9939: if ($context eq 'auto') {
9940: $linefeed = "\n";
9941: } else {
9942: $linefeed = '<br />'."\n";
9943: }
1.443 albertel 9944: if (defined($one) && defined($two)) {
9945: my $cid=$one.'_'.$two;
9946: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9947: my $secchange = 0;
9948: my $expire_role_result;
9949: my $modify_section_result;
1.628 raeburn 9950: if ($oldsec ne '-1') {
9951: if ($oldsec ne $sec) {
1.443 albertel 9952: $secchange = 1;
1.628 raeburn 9953: my $now = time;
1.443 albertel 9954: my $uurl='/'.$cid;
9955: $uurl=~s/\_/\//g;
9956: if ($oldsec) {
9957: $uurl.='/'.$oldsec;
9958: }
1.626 raeburn 9959: $oldsecurl = $uurl;
1.628 raeburn 9960: $expire_role_result =
1.652 raeburn 9961: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9962: if ($env{'request.course.sec'} ne '') {
9963: if ($expire_role_result eq 'refused') {
9964: my @roles = ('st');
9965: my @statuses = ('previous');
9966: my @roledoms = ($one);
9967: my $withsec = 1;
9968: my %roleshash =
9969: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9970: \@statuses,\@roles,\@roledoms,$withsec);
9971: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9972: my ($oldstart,$oldend) =
9973: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9974: if ($oldend > 0 && $oldend <= $now) {
9975: $expire_role_result = 'ok';
9976: }
9977: }
9978: }
9979: }
1.443 albertel 9980: $result = $expire_role_result;
9981: }
9982: }
9983: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9984: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9985: if ($modify_section_result =~ /^ok/) {
9986: if ($secchange == 1) {
1.628 raeburn 9987: if ($sec eq '') {
9988: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9989: } else {
9990: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9991: }
1.443 albertel 9992: } elsif ($oldsec eq '-1') {
1.628 raeburn 9993: if ($sec eq '') {
9994: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9995: } else {
9996: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9997: }
1.443 albertel 9998: } else {
1.628 raeburn 9999: if ($sec eq '') {
10000: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10001: } else {
10002: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10003: }
1.443 albertel 10004: }
10005: } else {
1.628 raeburn 10006: if ($secchange) {
10007: $$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;
10008: } else {
10009: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10010: }
1.443 albertel 10011: }
10012: $result = $modify_section_result;
10013: } elsif ($secchange == 1) {
1.628 raeburn 10014: if ($oldsec eq '') {
10015: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10016: } else {
10017: $$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;
10018: }
1.626 raeburn 10019: if ($expire_role_result eq 'refused') {
10020: my $newsecurl = '/'.$cid;
10021: $newsecurl =~ s/\_/\//g;
10022: if ($sec ne '') {
10023: $newsecurl.='/'.$sec;
10024: }
10025: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10026: if ($sec eq '') {
10027: $$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;
10028: } else {
10029: $$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;
10030: }
10031: }
10032: }
1.443 albertel 10033: }
10034: } else {
1.626 raeburn 10035: $$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 10036: $result = "error: incomplete course id\n";
10037: }
10038: return $result;
10039: }
10040:
10041: ############################################################
10042: ############################################################
10043:
1.566 albertel 10044: sub check_clone {
1.578 raeburn 10045: my ($args,$linefeed) = @_;
1.566 albertel 10046: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10047: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10048: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10049: my $clonemsg;
10050: my $can_clone = 0;
1.908 raeburn 10051: my $lctype = lc($args->{'type'});
10052: if ($lctype ne 'community') {
10053: $lctype = 'course';
10054: }
1.566 albertel 10055: if ($clonehome eq 'no_host') {
1.908 raeburn 10056: if ($args->{'type'} eq 'Community') {
10057: $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'});
10058: } else {
10059: $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'});
10060: }
1.566 albertel 10061: } else {
10062: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908 raeburn 10063: if ($args->{'type'} eq 'Community') {
10064: if ($clonedesc{'type'} ne 'Community') {
10065: $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'});
10066: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10067: }
10068: }
1.882 raeburn 10069: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10070: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10071: $can_clone = 1;
10072: } else {
10073: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10074: $args->{'clonedomain'},$args->{'clonecourse'});
10075: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10076: if (grep(/^\*$/,@cloners)) {
10077: $can_clone = 1;
10078: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10079: $can_clone = 1;
10080: } else {
1.908 raeburn 10081: my $ccrole = 'cc';
10082: if ($args->{'type'} eq 'Community') {
10083: $ccrole = 'co';
10084: }
1.578 raeburn 10085: my %roleshash =
10086: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10087: $args->{'ccdomain'},
1.908 raeburn 10088: 'userroles',['active'],[$ccrole],
1.578 raeburn 10089: [$args->{'clonedomain'}]);
1.908 raeburn 10090: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578 raeburn 10091: $can_clone = 1;
10092: } else {
1.908 raeburn 10093: if ($args->{'type'} eq 'Community') {
10094: $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'});
10095: } else {
10096: $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'});
10097: }
1.578 raeburn 10098: }
1.566 albertel 10099: }
1.578 raeburn 10100: }
1.566 albertel 10101: }
10102: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10103: }
10104:
1.444 albertel 10105: sub construct_course {
1.885 raeburn 10106: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10107: my $outcome;
1.541 raeburn 10108: my $linefeed = '<br />'."\n";
10109: if ($context eq 'auto') {
10110: $linefeed = "\n";
10111: }
1.566 albertel 10112:
10113: #
10114: # Are we cloning?
10115: #
10116: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10117: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10118: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10119: if ($context ne 'auto') {
1.578 raeburn 10120: if ($clonemsg ne '') {
10121: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10122: }
1.566 albertel 10123: }
10124: $outcome .= $clonemsg.$linefeed;
10125:
10126: if (!$can_clone) {
10127: return (0,$outcome);
10128: }
10129: }
10130:
1.444 albertel 10131: #
10132: # Open course
10133: #
10134: my $crstype = lc($args->{'crstype'});
10135: my %cenv=();
10136: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10137: $args->{'cdescr'},
10138: $args->{'curl'},
10139: $args->{'course_home'},
10140: $args->{'nonstandard'},
10141: $args->{'crscode'},
10142: $args->{'ccuname'}.':'.
10143: $args->{'ccdomain'},
1.882 raeburn 10144: $args->{'crstype'},
1.885 raeburn 10145: $cnum,$context,$category);
1.444 albertel 10146:
10147: # Note: The testing routines depend on this being output; see
10148: # Utils::Course. This needs to at least be output as a comment
10149: # if anyone ever decides to not show this, and Utils::Course::new
10150: # will need to be suitably modified.
1.541 raeburn 10151: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 10152: #
10153: # Check if created correctly
10154: #
1.479 albertel 10155: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10156: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 10157: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10158:
1.444 albertel 10159: #
1.566 albertel 10160: # Do the cloning
10161: #
10162: if ($can_clone && $cloneid) {
10163: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10164: if ($context ne 'auto') {
10165: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10166: }
10167: $outcome .= $clonemsg.$linefeed;
10168: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10169: # Copy all files
1.637 www 10170: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10171: # Restore URL
1.566 albertel 10172: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10173: # Restore title
1.566 albertel 10174: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10175: # Mark as cloned
1.566 albertel 10176: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10177: # Need to clone grading mode
10178: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10179: $cenv{'grading'}=$newenv{'grading'};
10180: # Do not clone these environment entries
10181: &Apache::lonnet::del('environment',
10182: ['default_enrollment_start_date',
10183: 'default_enrollment_end_date',
10184: 'question.email',
10185: 'policy.email',
10186: 'comment.email',
10187: 'pch.users.denied',
1.725 raeburn 10188: 'plc.users.denied',
10189: 'hidefromcat',
10190: 'categories'],
1.638 www 10191: $$crsudom,$$crsunum);
1.444 albertel 10192: }
1.566 albertel 10193:
1.444 albertel 10194: #
10195: # Set environment (will override cloned, if existing)
10196: #
10197: my @sections = ();
10198: my @xlists = ();
10199: if ($args->{'crstype'}) {
10200: $cenv{'type'}=$args->{'crstype'};
10201: }
10202: if ($args->{'crsid'}) {
10203: $cenv{'courseid'}=$args->{'crsid'};
10204: }
10205: if ($args->{'crscode'}) {
10206: $cenv{'internal.coursecode'}=$args->{'crscode'};
10207: }
10208: if ($args->{'crsquota'} ne '') {
10209: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10210: } else {
10211: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10212: }
10213: if ($args->{'ccuname'}) {
10214: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10215: ':'.$args->{'ccdomain'};
10216: } else {
10217: $cenv{'internal.courseowner'} = $args->{'curruser'};
10218: }
10219: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10220: if ($args->{'crssections'}) {
10221: $cenv{'internal.sectionnums'} = '';
10222: if ($args->{'crssections'} =~ m/,/) {
10223: @sections = split/,/,$args->{'crssections'};
10224: } else {
10225: $sections[0] = $args->{'crssections'};
10226: }
10227: if (@sections > 0) {
10228: foreach my $item (@sections) {
10229: my ($sec,$gp) = split/:/,$item;
10230: my $class = $args->{'crscode'}.$sec;
10231: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10232: $cenv{'internal.sectionnums'} .= $item.',';
10233: unless ($addcheck eq 'ok') {
10234: push @badclasses, $class;
10235: }
10236: }
10237: $cenv{'internal.sectionnums'} =~ s/,$//;
10238: }
10239: }
10240: # do not hide course coordinator from staff listing,
10241: # even if privileged
10242: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10243: # add crosslistings
10244: if ($args->{'crsxlist'}) {
10245: $cenv{'internal.crosslistings'}='';
10246: if ($args->{'crsxlist'} =~ m/,/) {
10247: @xlists = split/,/,$args->{'crsxlist'};
10248: } else {
10249: $xlists[0] = $args->{'crsxlist'};
10250: }
10251: if (@xlists > 0) {
10252: foreach my $item (@xlists) {
10253: my ($xl,$gp) = split/:/,$item;
10254: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10255: $cenv{'internal.crosslistings'} .= $item.',';
10256: unless ($addcheck eq 'ok') {
10257: push @badclasses, $xl;
10258: }
10259: }
10260: $cenv{'internal.crosslistings'} =~ s/,$//;
10261: }
10262: }
10263: if ($args->{'autoadds'}) {
10264: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10265: }
10266: if ($args->{'autodrops'}) {
10267: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10268: }
10269: # check for notification of enrollment changes
10270: my @notified = ();
10271: if ($args->{'notify_owner'}) {
10272: if ($args->{'ccuname'} ne '') {
10273: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10274: }
10275: }
10276: if ($args->{'notify_dc'}) {
10277: if ($uname ne '') {
1.630 raeburn 10278: push(@notified,$uname.':'.$udom);
1.444 albertel 10279: }
10280: }
10281: if (@notified > 0) {
10282: my $notifylist;
10283: if (@notified > 1) {
10284: $notifylist = join(',',@notified);
10285: } else {
10286: $notifylist = $notified[0];
10287: }
10288: $cenv{'internal.notifylist'} = $notifylist;
10289: }
10290: if (@badclasses > 0) {
10291: my %lt=&Apache::lonlocal::texthash(
10292: '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',
10293: 'dnhr' => 'does not have rights to access enrollment in these classes',
10294: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10295: );
1.541 raeburn 10296: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10297: ' ('.$lt{'adby'}.')';
10298: if ($context eq 'auto') {
10299: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10300: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10301: foreach my $item (@badclasses) {
10302: if ($context eq 'auto') {
10303: $outcome .= " - $item\n";
10304: } else {
10305: $outcome .= "<li>$item</li>\n";
10306: }
10307: }
10308: if ($context eq 'auto') {
10309: $outcome .= $linefeed;
10310: } else {
1.566 albertel 10311: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10312: }
10313: }
1.444 albertel 10314: }
10315: if ($args->{'no_end_date'}) {
10316: $args->{'endaccess'} = 0;
10317: }
10318: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10319: $cenv{'internal.autoend'}=$args->{'enrollend'};
10320: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10321: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10322: if ($args->{'showphotos'}) {
10323: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10324: }
10325: $cenv{'internal.authtype'} = $args->{'authtype'};
10326: $cenv{'internal.autharg'} = $args->{'autharg'};
10327: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10328: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10329: 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');
10330: if ($context eq 'auto') {
10331: $outcome .= $krb_msg;
10332: } else {
1.566 albertel 10333: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10334: }
10335: $outcome .= $linefeed;
1.444 albertel 10336: }
10337: }
10338: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10339: if ($args->{'setpolicy'}) {
10340: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10341: }
10342: if ($args->{'setcontent'}) {
10343: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10344: }
10345: }
10346: if ($args->{'reshome'}) {
10347: $cenv{'reshome'}=$args->{'reshome'}.'/';
10348: $cenv{'reshome'}=~s/\/+$/\//;
10349: }
10350: #
10351: # course has keyed access
10352: #
10353: if ($args->{'setkeys'}) {
10354: $cenv{'keyaccess'}='yes';
10355: }
10356: # if specified, key authority is not course, but user
10357: # only active if keyaccess is yes
10358: if ($args->{'keyauth'}) {
1.487 albertel 10359: my ($user,$domain) = split(':',$args->{'keyauth'});
10360: $user = &LONCAPA::clean_username($user);
10361: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10362: if ($user ne '' && $domain ne '') {
1.487 albertel 10363: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10364: }
10365: }
10366:
10367: if ($args->{'disresdis'}) {
10368: $cenv{'pch.roles.denied'}='st';
10369: }
10370: if ($args->{'disablechat'}) {
10371: $cenv{'plc.roles.denied'}='st';
10372: }
10373:
10374: # Record we've not yet viewed the Course Initialization Helper for this
10375: # course
10376: $cenv{'course.helper.not.run'} = 1;
10377: #
10378: # Use new Randomseed
10379: #
10380: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10381: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10382: #
10383: # The encryption code and receipt prefix for this course
10384: #
10385: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10386: $cenv{'internal.encpref'}=100+int(9*rand(99));
10387: #
10388: # By default, use standard grading
10389: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10390:
1.541 raeburn 10391: $outcome .= $linefeed.&mt('Setting environment').': '.
10392: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10393: #
10394: # Open all assignments
10395: #
10396: if ($args->{'openall'}) {
10397: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10398: my %storecontent = ($storeunder => time,
10399: $storeunder.'.type' => 'date_start');
10400:
10401: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10402: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10403: }
10404: #
10405: # Set first page
10406: #
10407: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10408: || ($cloneid)) {
1.445 albertel 10409: use LONCAPA::map;
1.444 albertel 10410: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10411:
10412: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10413: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10414:
1.444 albertel 10415: $outcome .= ($fatal?$errtext:'read ok').' - ';
10416: my $title; my $url;
10417: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10418: $title=&mt('Syllabus');
1.444 albertel 10419: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10420: } else {
1.690 bisitz 10421: $title=&mt('Navigate Contents');
1.444 albertel 10422: $url='/adm/navmaps';
10423: }
1.445 albertel 10424:
10425: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10426: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10427:
10428: if ($errtext) { $fatal=2; }
1.541 raeburn 10429: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10430: }
1.566 albertel 10431:
10432: return (1,$outcome);
1.444 albertel 10433: }
10434:
10435: ############################################################
10436: ############################################################
10437:
1.378 raeburn 10438: sub course_type {
10439: my ($cid) = @_;
10440: if (!defined($cid)) {
10441: $cid = $env{'request.course.id'};
10442: }
1.404 albertel 10443: if (defined($env{'course.'.$cid.'.type'})) {
10444: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10445: } else {
10446: return 'Course';
1.377 raeburn 10447: }
10448: }
1.156 albertel 10449:
1.406 raeburn 10450: sub group_term {
10451: my $crstype = &course_type();
10452: my %names = (
10453: 'Course' => 'group',
1.865 raeburn 10454: 'Community' => 'group',
1.406 raeburn 10455: );
10456: return $names{$crstype};
10457: }
10458:
1.902 raeburn 10459: sub course_types {
10460: my @types = ('official','unofficial','community');
10461: my %typename = (
10462: official => 'Official course',
10463: unofficial => 'Unofficial course',
10464: community => 'Community',
10465: );
10466: return (\@types,\%typename);
10467: }
10468:
1.156 albertel 10469: sub icon {
10470: my ($file)=@_;
1.505 albertel 10471: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10472: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10473: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10474: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10475: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10476: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10477: $curfext.".gif") {
10478: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10479: $curfext.".gif";
10480: }
10481: }
1.249 albertel 10482: return &lonhttpdurl($iconname);
1.154 albertel 10483: }
1.84 albertel 10484:
1.575 albertel 10485: sub lonhttpdurl {
1.692 www 10486: #
10487: # Had been used for "small fry" static images on separate port 8080.
10488: # Modify here if lightweight http functionality desired again.
10489: # Currently eliminated due to increasing firewall issues.
10490: #
1.575 albertel 10491: my ($url)=@_;
1.692 www 10492: return $url;
1.215 albertel 10493: }
10494:
1.213 albertel 10495: sub connection_aborted {
10496: my ($r)=@_;
10497: $r->print(" ");$r->rflush();
10498: my $c = $r->connection;
10499: return $c->aborted();
10500: }
10501:
1.221 foxr 10502: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10503: # strings as 'strings'.
10504: sub escape_single {
1.221 foxr 10505: my ($input) = @_;
1.223 albertel 10506: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10507: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10508: return $input;
10509: }
1.223 albertel 10510:
1.222 foxr 10511: # Same as escape_single, but escape's "'s This
10512: # can be used for "strings"
10513: sub escape_double {
10514: my ($input) = @_;
10515: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10516: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10517: return $input;
10518: }
1.223 albertel 10519:
1.222 foxr 10520: # Escapes the last element of a full URL.
10521: sub escape_url {
10522: my ($url) = @_;
1.238 raeburn 10523: my @urlslices = split(/\//, $url,-1);
1.369 www 10524: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10525: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10526: }
1.462 albertel 10527:
1.820 raeburn 10528: sub compare_arrays {
10529: my ($arrayref1,$arrayref2) = @_;
10530: my (@difference,%count);
10531: @difference = ();
10532: %count = ();
10533: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10534: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10535: foreach my $element (keys(%count)) {
10536: if ($count{$element} == 1) {
10537: push(@difference,$element);
10538: }
10539: }
10540: }
10541: return @difference;
10542: }
10543:
1.817 bisitz 10544: # -------------------------------------------------------- Initialize user login
1.462 albertel 10545: sub init_user_environment {
1.463 albertel 10546: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10547: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10548:
10549: my $public=($username eq 'public' && $domain eq 'public');
10550:
10551: # See if old ID present, if so, remove
10552:
10553: my ($filename,$cookie,$userroles);
10554: my $now=time;
10555:
10556: if ($public) {
10557: my $max_public=100;
10558: my $oldest;
10559: my $oldest_time=0;
10560: for(my $next=1;$next<=$max_public;$next++) {
10561: if (-e $lonids."/publicuser_$next.id") {
10562: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10563: if ($mtime<$oldest_time || !$oldest_time) {
10564: $oldest_time=$mtime;
10565: $oldest=$next;
10566: }
10567: } else {
10568: $cookie="publicuser_$next";
10569: last;
10570: }
10571: }
10572: if (!$cookie) { $cookie="publicuser_$oldest"; }
10573: } else {
1.463 albertel 10574: # if this isn't a robot, kill any existing non-robot sessions
10575: if (!$args->{'robot'}) {
10576: opendir(DIR,$lonids);
10577: while ($filename=readdir(DIR)) {
10578: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10579: unlink($lonids.'/'.$filename);
10580: }
1.462 albertel 10581: }
1.463 albertel 10582: closedir(DIR);
1.462 albertel 10583: }
10584: # Give them a new cookie
1.463 albertel 10585: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10586: : $now.$$.int(rand(10000)));
1.463 albertel 10587: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10588:
10589: # Initialize roles
10590:
10591: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10592: }
10593: # ------------------------------------ Check browser type and MathML capability
10594:
10595: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10596: $clientunicode,$clientos) = &decode_user_agent($r);
10597:
10598: # ------------------------------------------------------------- Get environment
10599:
10600: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10601: my ($tmp) = keys(%userenv);
10602: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10603: # default remote control to off
10604: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10605: } else {
10606: undef(%userenv);
10607: }
10608: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10609: $form->{'interface'}=$userenv{'interface'};
10610: }
10611: $env{'environment.remote'}=$userenv{'remote'};
10612: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10613:
10614: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10615: foreach my $option ('interface','localpath','localres') {
10616: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10617: }
10618: # --------------------------------------------------------- Write first profile
10619:
10620: {
10621: my %initial_env =
10622: ("user.name" => $username,
10623: "user.domain" => $domain,
10624: "user.home" => $authhost,
10625: "browser.type" => $clientbrowser,
10626: "browser.version" => $clientversion,
10627: "browser.mathml" => $clientmathml,
10628: "browser.unicode" => $clientunicode,
10629: "browser.os" => $clientos,
10630: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10631: "request.course.fn" => '',
10632: "request.course.uri" => '',
10633: "request.course.sec" => '',
10634: "request.role" => 'cm',
10635: "request.role.adv" => $env{'user.adv'},
10636: "request.host" => $ENV{'REMOTE_ADDR'},);
10637:
10638: if ($form->{'localpath'}) {
10639: $initial_env{"browser.localpath"} = $form->{'localpath'};
10640: $initial_env{"browser.localres"} = $form->{'localres'};
10641: }
10642:
10643: if ($public) {
10644: $initial_env{"environment.remote"} = "off";
10645: }
10646: if ($form->{'interface'}) {
10647: $form->{'interface'}=~s/\W//gs;
10648: $initial_env{"browser.interface"} = $form->{'interface'};
10649: $env{'browser.interface'}=$form->{'interface'};
10650: }
10651:
1.724 raeburn 10652: foreach my $tool ('aboutme','blog','portfolio') {
10653: $userenv{'availabletools.'.$tool} =
10654: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10655: }
10656:
1.864 raeburn 10657: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10658: $userenv{'canrequest.'.$crstype} =
10659: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10660: 'reload','requestcourses');
10661: }
10662:
1.462 albertel 10663: $env{'user.environment'} = "$lonids/$cookie.id";
10664:
10665: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10666: &GDBM_WRCREAT(),0640)) {
10667: &_add_to_env(\%disk_env,\%initial_env);
10668: &_add_to_env(\%disk_env,\%userenv,'environment.');
10669: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10670: if (ref($args->{'extra_env'})) {
10671: &_add_to_env(\%disk_env,$args->{'extra_env'});
10672: }
1.462 albertel 10673: untie(%disk_env);
10674: } else {
1.705 tempelho 10675: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10676: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10677: return 'error: '.$!;
10678: }
10679: }
10680: $env{'request.role'}='cm';
10681: $env{'request.role.adv'}=$env{'user.adv'};
10682: $env{'browser.type'}=$clientbrowser;
10683:
10684: return $cookie;
10685:
10686: }
10687:
10688: sub _add_to_env {
10689: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10690: if (ref($env_data) eq 'HASH') {
10691: while (my ($key,$value) = each(%$env_data)) {
10692: $idf->{$prefix.$key} = $value;
10693: $env{$prefix.$key} = $value;
10694: }
1.462 albertel 10695: }
10696: }
10697:
1.685 tempelho 10698: # --- Get the symbolic name of a problem and the url
10699: sub get_symb {
10700: my ($request,$silent) = @_;
1.726 raeburn 10701: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10702: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10703: if ($symb eq '') {
10704: if (!$silent) {
10705: $request->print("Unable to handle ambiguous references:$url:.");
10706: return ();
10707: }
10708: }
10709: &Apache::lonenc::check_decrypt(\$symb);
10710: return ($symb);
10711: }
10712:
10713: # --------------------------------------------------------------Get annotation
10714:
10715: sub get_annotation {
10716: my ($symb,$enc) = @_;
10717:
10718: my $key = $symb;
10719: if (!$enc) {
10720: $key =
10721: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10722: }
10723: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10724: return $annotation{$key};
10725: }
10726:
10727: sub clean_symb {
1.731 raeburn 10728: my ($symb,$delete_enc) = @_;
1.685 tempelho 10729:
10730: &Apache::lonenc::check_decrypt(\$symb);
10731: my $enc = $env{'request.enc'};
1.731 raeburn 10732: if ($delete_enc) {
1.730 raeburn 10733: delete($env{'request.enc'});
10734: }
1.685 tempelho 10735:
10736: return ($symb,$enc);
10737: }
1.462 albertel 10738:
1.925.2.1 raeburn 10739: sub needs_gci_custom {
10740: my $custommenu;
10741: my $numdc = &check_for_gci_dc();
10742: unless ($numdc) {
10743: my $then=$env{'user.login.time'};
10744: my $now = time;
10745: my %cnums = (
10746: review => '9615072b469884921gcil1',
10747: submit => '1H96711d710194bfegcil1',
10748: );
10749: if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
10750: my ($start,$end) =
10751: split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
10752: if (((!$start) || ($start && $start <= $now)) &&
10753: ((!$end) || ($end > $now))) {
10754: $custommenu = 1;
10755: if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
10756: my ($ccstart,$ccend) =
10757: split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
10758: if (((!$start) || ($start && $start <= $now)) &&
10759: ((!$end) || ($end > $now))) {
10760: $custommenu = '';
10761: }
10762: }
10763: }
10764: }
10765: }
10766: return $custommenu;
10767: }
10768:
10769: sub check_for_gci_dc {
10770: my $then=$env{'user.login.time'};
10771: my $numdc = 0;
10772: foreach my $dom ('gci','gcitest') {
10773: if ($env{'user.role.dc./'.$dom.'/'}) {
10774: my $livedc = 1;
10775: my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
10776: if ($tstart && $tstart>$then) { $livedc = 0; }
10777: if ($tend && $tend <$then) { $livedc = 0; }
10778: if ($livedc) {
10779: $numdc++;
10780: }
10781: }
10782: }
10783: return $numdc;
10784: }
10785:
10786: sub existing_gcitest_courses {
10787: my %courses;
10788: my $cdom = 'gcitest';
10789: my $role = 'cc';
10790: my $now = time;
10791: foreach my $envkey (keys(%env)) {
10792: my $cnum;
10793: if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
10794: $cnum = $1;
10795: } else {
10796: next;
10797: }
10798: my ($tstart,$tend) = split(':',$env{$envkey});
10799: if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
1.925.2.3 raeburn 10800: my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
10801: if ($descr ne '') {
10802: $courses{$cdom.'_'.$cnum}{'description'} = $descr;
1.925.2.1 raeburn 10803: }
10804: }
10805: }
10806: return %courses;
10807: }
10808:
1.41 ng 10809: =pod
10810:
10811: =back
10812:
1.112 bowersj2 10813: =cut
1.41 ng 10814:
1.112 bowersj2 10815: 1;
10816: __END__;
1.41 ng 10817:
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