Annotation of loncom/interface/loncommon.pm, revision 1.964
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.964 ! droeschl 4: # $Id: loncommon.pm,v 1.963 2010/03/29 13:40:03 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) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.949 droeschl 1205: $stayOnPage = 1;
1.430 albertel 1206: my $output;
1207: if ($component_help) {
1208: if (!$text) {
1209: $output=&help_open_topic($component_help,undef,$stayOnPage,
1210: $width,$height);
1211: } else {
1212: my $help_text;
1213: $help_text=&unescape($topic);
1214: $output='<table><tr><td>'.
1215: &help_open_topic($component_help,$help_text,$stayOnPage,
1216: $width,$height).'</td></tr></table>';
1217: }
1218: }
1219: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1220: return $output.$banner_link;
1221: }
1222:
1223: sub top_nav_help {
1224: my ($text) = @_;
1.436 albertel 1225: $text = &mt($text);
1.949 droeschl 1226: my $stay_on_page = 1;
1227:
1.572 banghart 1228: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1229: : "javascript:helpMenu('open')";
1.572 banghart 1230: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1231:
1.201 raeburn 1232: my $title = &mt('Get help');
1.436 albertel 1233:
1234: return <<"END";
1235: $banner_link
1236: <a href="$link" title="$title">$text</a>
1237: END
1238: }
1239:
1240: sub help_menu_js {
1241: my ($text) = @_;
1.949 droeschl 1242: my $stayOnPage = 1;
1.436 albertel 1243: my $width = 620;
1244: my $height = 600;
1.430 albertel 1245: my $helptopic=&general_help();
1246: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1247: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1248: my $start_page =
1249: &Apache::loncommon::start_page('Help Menu', undef,
1250: {'frameset' => 1,
1251: 'js_ready' => 1,
1252: 'add_entries' => {
1253: 'border' => '0',
1.579 raeburn 1254: 'rows' => "110,*",},});
1.331 albertel 1255: my $end_page =
1256: &Apache::loncommon::end_page({'frameset' => 1,
1257: 'js_ready' => 1,});
1258:
1.436 albertel 1259: my $template .= <<"ENDTEMPLATE";
1260: <script type="text/javascript">
1.877 bisitz 1261: // <![CDATA[
1.253 albertel 1262: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1263: var banner_link = '';
1.243 raeburn 1264: function helpMenu(target) {
1265: var caller = this;
1266: if (target == 'open') {
1267: var newWindow = null;
1268: try {
1.262 albertel 1269: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1270: }
1271: catch(error) {
1272: writeHelp(caller);
1273: return;
1274: }
1275: if (newWindow) {
1276: caller = newWindow;
1277: }
1.193 raeburn 1278: }
1.243 raeburn 1279: writeHelp(caller);
1280: return;
1281: }
1282: function writeHelp(caller) {
1.430 albertel 1283: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1284: caller.document.close()
1285: caller.focus()
1.193 raeburn 1286: }
1.877 bisitz 1287: // END LON-CAPA Internal -->
1.253 albertel 1288: // ]]>
1.436 albertel 1289: </script>
1.193 raeburn 1290: ENDTEMPLATE
1291: return $template;
1292: }
1293:
1.172 www 1294: sub help_open_bug {
1295: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1296: unless ($env{'user.adv'}) { return ''; }
1.172 www 1297: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1298: $text = "" if (not defined $text);
1299: $stayOnPage=1;
1.184 albertel 1300: $width = 600 if (not defined $width);
1301: $height = 600 if (not defined $height);
1.172 www 1302:
1303: $topic=~s/\W+/\+/g;
1304: my $link='';
1305: my $template='';
1.379 albertel 1306: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1307: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1308: if (!$stayOnPage)
1309: {
1310: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1311: }
1312: else
1313: {
1314: $link = $url;
1315: }
1316: # Add the text
1317: if ($text ne "")
1318: {
1319: $template .=
1320: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1321: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1322: }
1323:
1324: # Add the graphic
1.179 matthew 1325: my $title = &mt('Report a Bug');
1.215 albertel 1326: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1327: $template .= <<"ENDTEMPLATE";
1.436 albertel 1328: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1329: ENDTEMPLATE
1330: if ($text ne '') { $template.='</td></tr></table>' };
1331: return $template;
1332:
1333: }
1334:
1335: sub help_open_faq {
1336: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1337: unless ($env{'user.adv'}) { return ''; }
1.172 www 1338: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1339: $text = "" if (not defined $text);
1340: $stayOnPage=1;
1341: $width = 350 if (not defined $width);
1342: $height = 400 if (not defined $height);
1343:
1344: $topic=~s/\W+/\+/g;
1345: my $link='';
1346: my $template='';
1347: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1348: if (!$stayOnPage)
1349: {
1350: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1351: }
1352: else
1353: {
1354: $link = $url;
1355: }
1356:
1357: # Add the text
1358: if ($text ne "")
1359: {
1360: $template .=
1.173 www 1361: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1362: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1363: }
1364:
1365: # Add the graphic
1.179 matthew 1366: my $title = &mt('View the FAQ');
1.215 albertel 1367: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1368: $template .= <<"ENDTEMPLATE";
1.436 albertel 1369: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1370: ENDTEMPLATE
1371: if ($text ne '') { $template.='</td></tr></table>' };
1372: return $template;
1373:
1.44 bowersj2 1374: }
1.37 matthew 1375:
1.180 matthew 1376: ###############################################################
1377: ###############################################################
1378:
1.45 matthew 1379: =pod
1380:
1.648 raeburn 1381: =item * &change_content_javascript():
1.256 matthew 1382:
1383: This and the next function allow you to create small sections of an
1384: otherwise static HTML page that you can update on the fly with
1385: Javascript, even in Netscape 4.
1386:
1387: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1388: must be written to the HTML page once. It will prove the Javascript
1389: function "change(name, content)". Calling the change function with the
1390: name of the section
1391: you want to update, matching the name passed to C<changable_area>, and
1392: the new content you want to put in there, will put the content into
1393: that area.
1394:
1395: B<Note>: Netscape 4 only reserves enough space for the changable area
1396: to contain room for the original contents. You need to "make space"
1397: for whatever changes you wish to make, and be B<sure> to check your
1398: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1399: it's adequate for updating a one-line status display, but little more.
1400: This script will set the space to 100% width, so you only need to
1401: worry about height in Netscape 4.
1402:
1403: Modern browsers are much less limiting, and if you can commit to the
1404: user not using Netscape 4, this feature may be used freely with
1405: pretty much any HTML.
1406:
1407: =cut
1408:
1409: sub change_content_javascript {
1410: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1411: if ($env{'browser.type'} eq 'netscape' &&
1412: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1413: return (<<NETSCAPE4);
1414: function change(name, content) {
1415: doc = document.layers[name+"___escape"].layers[0].document;
1416: doc.open();
1417: doc.write(content);
1418: doc.close();
1419: }
1420: NETSCAPE4
1421: } else {
1422: # Otherwise, we need to use semi-standards-compliant code
1423: # (technically, "innerHTML" isn't standard but the equivalent
1424: # is really scary, and every useful browser supports it
1425: return (<<DOMBASED);
1426: function change(name, content) {
1427: element = document.getElementById(name);
1428: element.innerHTML = content;
1429: }
1430: DOMBASED
1431: }
1432: }
1433:
1434: =pod
1435:
1.648 raeburn 1436: =item * &changable_area($name,$origContent):
1.256 matthew 1437:
1438: This provides a "changable area" that can be modified on the fly via
1439: the Javascript code provided in C<change_content_javascript>. $name is
1440: the name you will use to reference the area later; do not repeat the
1441: same name on a given HTML page more then once. $origContent is what
1442: the area will originally contain, which can be left blank.
1443:
1444: =cut
1445:
1446: sub changable_area {
1447: my ($name, $origContent) = @_;
1448:
1.258 albertel 1449: if ($env{'browser.type'} eq 'netscape' &&
1450: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1451: # If this is netscape 4, we need to use the Layer tag
1452: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1453: } else {
1454: return "<span id='$name'>$origContent</span>";
1455: }
1456: }
1457:
1458: =pod
1459:
1.648 raeburn 1460: =item * &viewport_geometry_js
1.590 raeburn 1461:
1462: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1463:
1464: =cut
1465:
1466:
1467: sub viewport_geometry_js {
1468: return <<"GEOMETRY";
1469: var Geometry = {};
1470: function init_geometry() {
1471: if (Geometry.init) { return };
1472: Geometry.init=1;
1473: if (window.innerHeight) {
1474: Geometry.getViewportHeight = function() { return window.innerHeight; };
1475: Geometry.getViewportWidth = function() { return window.innerWidth; };
1476: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1477: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1478: }
1479: else if (document.documentElement && document.documentElement.clientHeight) {
1480: Geometry.getViewportHeight =
1481: function() { return document.documentElement.clientHeight; };
1482: Geometry.getViewportWidth =
1483: function() { return document.documentElement.clientWidth; };
1484:
1485: Geometry.getHorizontalScroll =
1486: function() { return document.documentElement.scrollLeft; };
1487: Geometry.getVerticalScroll =
1488: function() { return document.documentElement.scrollTop; };
1489: }
1490: else if (document.body.clientHeight) {
1491: Geometry.getViewportHeight =
1492: function() { return document.body.clientHeight; };
1493: Geometry.getViewportWidth =
1494: function() { return document.body.clientWidth; };
1495: Geometry.getHorizontalScroll =
1496: function() { return document.body.scrollLeft; };
1497: Geometry.getVerticalScroll =
1498: function() { return document.body.scrollTop; };
1499: }
1500: }
1501:
1502: GEOMETRY
1503: }
1504:
1505: =pod
1506:
1.648 raeburn 1507: =item * &viewport_size_js()
1.590 raeburn 1508:
1509: 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.
1510:
1511: =cut
1512:
1513: sub viewport_size_js {
1514: my $geometry = &viewport_geometry_js();
1515: return <<"DIMS";
1516:
1517: $geometry
1518:
1519: function getViewportDims(width,height) {
1520: init_geometry();
1521: width.value = Geometry.getViewportWidth();
1522: height.value = Geometry.getViewportHeight();
1523: return;
1524: }
1525:
1526: DIMS
1527: }
1528:
1529: =pod
1530:
1.648 raeburn 1531: =item * &resize_textarea_js()
1.565 albertel 1532:
1533: emits the needed javascript to resize a textarea to be as big as possible
1534:
1535: creates a function resize_textrea that takes two IDs first should be
1536: the id of the element to resize, second should be the id of a div that
1537: surrounds everything that comes after the textarea, this routine needs
1538: to be attached to the <body> for the onload and onresize events.
1539:
1.648 raeburn 1540: =back
1.565 albertel 1541:
1542: =cut
1543:
1544: sub resize_textarea_js {
1.590 raeburn 1545: my $geometry = &viewport_geometry_js();
1.565 albertel 1546: return <<"RESIZE";
1547: <script type="text/javascript">
1.824 bisitz 1548: // <![CDATA[
1.590 raeburn 1549: $geometry
1.565 albertel 1550:
1.588 albertel 1551: function getX(element) {
1552: var x = 0;
1553: while (element) {
1554: x += element.offsetLeft;
1555: element = element.offsetParent;
1556: }
1557: return x;
1558: }
1559: function getY(element) {
1560: var y = 0;
1561: while (element) {
1562: y += element.offsetTop;
1563: element = element.offsetParent;
1564: }
1565: return y;
1566: }
1567:
1568:
1.565 albertel 1569: function resize_textarea(textarea_id,bottom_id) {
1570: init_geometry();
1571: var textarea = document.getElementById(textarea_id);
1572: //alert(textarea);
1573:
1.588 albertel 1574: var textarea_top = getY(textarea);
1.565 albertel 1575: var textarea_height = textarea.offsetHeight;
1576: var bottom = document.getElementById(bottom_id);
1.588 albertel 1577: var bottom_top = getY(bottom);
1.565 albertel 1578: var bottom_height = bottom.offsetHeight;
1579: var window_height = Geometry.getViewportHeight();
1.588 albertel 1580: var fudge = 23;
1.565 albertel 1581: var new_height = window_height-fudge-textarea_top-bottom_height;
1582: if (new_height < 300) {
1583: new_height = 300;
1584: }
1585: textarea.style.height=new_height+'px';
1586: }
1.824 bisitz 1587: // ]]>
1.565 albertel 1588: </script>
1589: RESIZE
1590:
1591: }
1592:
1593: =pod
1594:
1.256 matthew 1595: =head1 Excel and CSV file utility routines
1596:
1597: =over 4
1598:
1599: =cut
1600:
1601: ###############################################################
1602: ###############################################################
1603:
1604: =pod
1605:
1.648 raeburn 1606: =item * &csv_translate($text)
1.37 matthew 1607:
1.185 www 1608: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1609: format.
1610:
1611: =cut
1612:
1.180 matthew 1613: ###############################################################
1614: ###############################################################
1.37 matthew 1615: sub csv_translate {
1616: my $text = shift;
1617: $text =~ s/\"/\"\"/g;
1.209 albertel 1618: $text =~ s/\n/ /g;
1.37 matthew 1619: return $text;
1620: }
1.180 matthew 1621:
1622: ###############################################################
1623: ###############################################################
1624:
1625: =pod
1626:
1.648 raeburn 1627: =item * &define_excel_formats()
1.180 matthew 1628:
1629: Define some commonly used Excel cell formats.
1630:
1631: Currently supported formats:
1632:
1633: =over 4
1634:
1635: =item header
1636:
1637: =item bold
1638:
1639: =item h1
1640:
1641: =item h2
1642:
1643: =item h3
1644:
1.256 matthew 1645: =item h4
1646:
1647: =item i
1648:
1.180 matthew 1649: =item date
1650:
1651: =back
1652:
1653: Inputs: $workbook
1654:
1655: Returns: $format, a hash reference.
1656:
1657: =cut
1658:
1659: ###############################################################
1660: ###############################################################
1661: sub define_excel_formats {
1662: my ($workbook) = @_;
1663: my $format;
1664: $format->{'header'} = $workbook->add_format(bold => 1,
1665: bottom => 1,
1666: align => 'center');
1667: $format->{'bold'} = $workbook->add_format(bold=>1);
1668: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1669: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1670: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1671: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1672: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1673: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1674: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1675: return $format;
1676: }
1677:
1678: ###############################################################
1679: ###############################################################
1.113 bowersj2 1680:
1681: =pod
1682:
1.648 raeburn 1683: =item * &create_workbook()
1.255 matthew 1684:
1685: Create an Excel worksheet. If it fails, output message on the
1686: request object and return undefs.
1687:
1688: Inputs: Apache request object
1689:
1690: Returns (undef) on failure,
1691: Excel worksheet object, scalar with filename, and formats
1692: from &Apache::loncommon::define_excel_formats on success
1693:
1694: =cut
1695:
1696: ###############################################################
1697: ###############################################################
1698: sub create_workbook {
1699: my ($r) = @_;
1700: #
1701: # Create the excel spreadsheet
1702: my $filename = '/prtspool/'.
1.258 albertel 1703: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1704: time.'_'.rand(1000000000).'.xls';
1705: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1706: if (! defined($workbook)) {
1707: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1708: $r->print(
1709: '<p class="LC_error">'
1710: .&mt('Problems occurred in creating the new Excel file.')
1711: .' '.&mt('This error has been logged.')
1712: .' '.&mt('Please alert your LON-CAPA administrator.')
1713: .'</p>'
1714: );
1.255 matthew 1715: return (undef);
1716: }
1717: #
1718: $workbook->set_tempdir('/home/httpd/perl/tmp');
1719: #
1720: my $format = &Apache::loncommon::define_excel_formats($workbook);
1721: return ($workbook,$filename,$format);
1722: }
1723:
1724: ###############################################################
1725: ###############################################################
1726:
1727: =pod
1728:
1.648 raeburn 1729: =item * &create_text_file()
1.113 bowersj2 1730:
1.542 raeburn 1731: Create a file to write to and eventually make available to the user.
1.256 matthew 1732: If file creation fails, outputs an error message on the request object and
1733: return undefs.
1.113 bowersj2 1734:
1.256 matthew 1735: Inputs: Apache request object, and file suffix
1.113 bowersj2 1736:
1.256 matthew 1737: Returns (undef) on failure,
1738: Filehandle and filename on success.
1.113 bowersj2 1739:
1740: =cut
1741:
1.256 matthew 1742: ###############################################################
1743: ###############################################################
1744: sub create_text_file {
1745: my ($r,$suffix) = @_;
1746: if (! defined($suffix)) { $suffix = 'txt'; };
1747: my $fh;
1748: my $filename = '/prtspool/'.
1.258 albertel 1749: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1750: time.'_'.rand(1000000000).'.'.$suffix;
1751: $fh = Apache::File->new('>/home/httpd'.$filename);
1752: if (! defined($fh)) {
1753: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1754: $r->print(
1755: '<p class="LC_error">'
1756: .&mt('Problems occurred in creating the output file.')
1757: .' '.&mt('This error has been logged.')
1758: .' '.&mt('Please alert your LON-CAPA administrator.')
1759: .'</p>'
1760: );
1.113 bowersj2 1761: }
1.256 matthew 1762: return ($fh,$filename)
1.113 bowersj2 1763: }
1764:
1765:
1.256 matthew 1766: =pod
1.113 bowersj2 1767:
1768: =back
1769:
1770: =cut
1.37 matthew 1771:
1772: ###############################################################
1.33 matthew 1773: ## Home server <option> list generating code ##
1774: ###############################################################
1.35 matthew 1775:
1.169 www 1776: # ------------------------------------------
1777:
1778: sub domain_select {
1779: my ($name,$value,$multiple)=@_;
1780: my %domains=map {
1.514 albertel 1781: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1782: } &Apache::lonnet::all_domains();
1.169 www 1783: if ($multiple) {
1784: $domains{''}=&mt('Any domain');
1.550 albertel 1785: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1786: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1787: } else {
1.550 albertel 1788: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1789: return &select_form($name,$value,%domains);
1790: }
1791: }
1792:
1.282 albertel 1793: #-------------------------------------------
1794:
1795: =pod
1796:
1.519 raeburn 1797: =head1 Routines for form select boxes
1798:
1799: =over 4
1800:
1.648 raeburn 1801: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1802:
1803: Returns a string containing a <select> element int multiple mode
1804:
1805:
1806: Args:
1807: $name - name of the <select> element
1.506 raeburn 1808: $value - scalar or array ref of values that should already be selected
1.282 albertel 1809: $size - number of rows long the select element is
1.283 albertel 1810: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1811: (shown text should already have been &mt())
1.506 raeburn 1812: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1813:
1.282 albertel 1814: =cut
1815:
1816: #-------------------------------------------
1.169 www 1817: sub multiple_select_form {
1.284 albertel 1818: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1819: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1820: my $output='';
1.191 matthew 1821: if (! defined($size)) {
1822: $size = 4;
1.283 albertel 1823: if (scalar(keys(%$hash))<4) {
1824: $size = scalar(keys(%$hash));
1.191 matthew 1825: }
1826: }
1.734 bisitz 1827: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1828: my @order;
1.506 raeburn 1829: if (ref($order) eq 'ARRAY') {
1830: @order = @{$order};
1831: } else {
1832: @order = sort(keys(%$hash));
1.501 banghart 1833: }
1834: if (exists($$hash{'select_form_order'})) {
1835: @order = @{$$hash{'select_form_order'}};
1836: }
1837:
1.284 albertel 1838: foreach my $key (@order) {
1.356 albertel 1839: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1840: $output.='selected="selected" ' if ($selected{$key});
1841: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1842: }
1843: $output.="</select>\n";
1844: return $output;
1845: }
1846:
1.88 www 1847: #-------------------------------------------
1848:
1849: =pod
1850:
1.648 raeburn 1851: =item * &select_form($defdom,$name,%hash)
1.88 www 1852:
1853: Returns a string containing a <select name='$name' size='1'> form to
1854: allow a user to select options from a hash option_name => displayed text.
1855: See lonrights.pm for an example invocation and use.
1856:
1857: =cut
1858:
1859: #-------------------------------------------
1860: sub select_form {
1861: my ($def,$name,%hash) = @_;
1862: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1863: my @keys;
1864: if (exists($hash{'select_form_order'})) {
1865: @keys=@{$hash{'select_form_order'}};
1866: } else {
1867: @keys=sort(keys(%hash));
1868: }
1.356 albertel 1869: foreach my $key (@keys) {
1870: $selectform.=
1871: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1872: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1873: ">".$hash{$key}."</option>\n";
1.88 www 1874: }
1875: $selectform.="</select>";
1876: return $selectform;
1877: }
1878:
1.475 www 1879: # For display filters
1880:
1881: sub display_filter {
1882: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1883: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1884: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1885: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1886: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1887: '</label></span> <span class="LC_nobreak">'.
1.475 www 1888: &mt('Filter [_1]',
1.477 www 1889: &select_form($env{'form.displayfilter'},
1890: 'displayfilter',
1891: ('currentfolder' => 'Current folder/page',
1892: 'containing' => 'Containing phrase',
1893: 'none' => 'None'))).
1.714 bisitz 1894: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1895: }
1896:
1.167 www 1897: sub gradeleveldescription {
1898: my $gradelevel=shift;
1899: my %gradelevels=(0 => 'Not specified',
1900: 1 => 'Grade 1',
1901: 2 => 'Grade 2',
1902: 3 => 'Grade 3',
1903: 4 => 'Grade 4',
1904: 5 => 'Grade 5',
1905: 6 => 'Grade 6',
1906: 7 => 'Grade 7',
1907: 8 => 'Grade 8',
1908: 9 => 'Grade 9',
1909: 10 => 'Grade 10',
1910: 11 => 'Grade 11',
1911: 12 => 'Grade 12',
1912: 13 => 'Grade 13',
1913: 14 => '100 Level',
1914: 15 => '200 Level',
1915: 16 => '300 Level',
1916: 17 => '400 Level',
1917: 18 => 'Graduate Level');
1918: return &mt($gradelevels{$gradelevel});
1919: }
1920:
1.163 www 1921: sub select_level_form {
1922: my ($deflevel,$name)=@_;
1923: unless ($deflevel) { $deflevel=0; }
1.167 www 1924: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1925: for (my $i=0; $i<=18; $i++) {
1926: $selectform.="<option value=\"$i\" ".
1.253 albertel 1927: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1928: ">".&gradeleveldescription($i)."</option>\n";
1929: }
1930: $selectform.="</select>";
1931: return $selectform;
1.163 www 1932: }
1.167 www 1933:
1.35 matthew 1934: #-------------------------------------------
1935:
1.45 matthew 1936: =pod
1937:
1.910 raeburn 1938: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1939:
1940: Returns a string containing a <select name='$name' size='1'> form to
1941: allow a user to select the domain to preform an operation in.
1942: See loncreateuser.pm for an example invocation and use.
1943:
1.90 www 1944: If the $includeempty flag is set, it also includes an empty choice ("no domain
1945: selected");
1946:
1.743 raeburn 1947: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1948:
1.910 raeburn 1949: 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.
1950:
1951: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1952:
1.35 matthew 1953: =cut
1954:
1955: #-------------------------------------------
1.34 matthew 1956: sub select_dom_form {
1.910 raeburn 1957: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1958: if ($onchange) {
1.874 raeburn 1959: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1960: }
1.910 raeburn 1961: my @domains;
1962: if (ref($incdoms) eq 'ARRAY') {
1963: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1964: } else {
1965: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1966: }
1.90 www 1967: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1968: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1969: foreach my $dom (@domains) {
1970: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1971: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1972: if ($showdomdesc) {
1973: if ($dom ne '') {
1974: my $domdesc = &Apache::lonnet::domain($dom,'description');
1975: if ($domdesc ne '') {
1976: $selectdomain .= ' ('.$domdesc.')';
1977: }
1978: }
1979: }
1980: $selectdomain .= "</option>\n";
1.34 matthew 1981: }
1982: $selectdomain.="</select>";
1983: return $selectdomain;
1984: }
1985:
1.35 matthew 1986: #-------------------------------------------
1987:
1.45 matthew 1988: =pod
1989:
1.648 raeburn 1990: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1991:
1.586 raeburn 1992: input: 4 arguments (two required, two optional) -
1993: $domain - domain of new user
1994: $name - name of form element
1995: $default - Value of 'default' causes a default item to be first
1996: option, and selected by default.
1997: $hide - Value of 'hide' causes hiding of the name of the server,
1998: if 1 server found, or default, if 0 found.
1.594 raeburn 1999: output: returns 2 items:
1.586 raeburn 2000: (a) form element which contains either:
2001: (i) <select name="$name">
2002: <option value="$hostid1">$hostid $servers{$hostid}</option>
2003: <option value="$hostid2">$hostid $servers{$hostid}</option>
2004: </select>
2005: form item if there are multiple library servers in $domain, or
2006: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2007: if there is only one library server in $domain.
2008:
2009: (b) number of library servers found.
2010:
2011: See loncreateuser.pm for example of use.
1.35 matthew 2012:
2013: =cut
2014:
2015: #-------------------------------------------
1.586 raeburn 2016: sub home_server_form_item {
2017: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2018: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2019: my $result;
2020: my $numlib = keys(%servers);
2021: if ($numlib > 1) {
2022: $result .= '<select name="'.$name.'" />'."\n";
2023: if ($default) {
1.804 bisitz 2024: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2025: '</option>'."\n";
2026: }
2027: foreach my $hostid (sort(keys(%servers))) {
2028: $result.= '<option value="'.$hostid.'">'.
2029: $hostid.' '.$servers{$hostid}."</option>\n";
2030: }
2031: $result .= '</select>'."\n";
2032: } elsif ($numlib == 1) {
2033: my $hostid;
2034: foreach my $item (keys(%servers)) {
2035: $hostid = $item;
2036: }
2037: $result .= '<input type="hidden" name="'.$name.'" value="'.
2038: $hostid.'" />';
2039: if (!$hide) {
2040: $result .= $hostid.' '.$servers{$hostid};
2041: }
2042: $result .= "\n";
2043: } elsif ($default) {
2044: $result .= '<input type="hidden" name="'.$name.
2045: '" value="default" />';
2046: if (!$hide) {
2047: $result .= &mt('default');
2048: }
2049: $result .= "\n";
1.33 matthew 2050: }
1.586 raeburn 2051: return ($result,$numlib);
1.33 matthew 2052: }
1.112 bowersj2 2053:
2054: =pod
2055:
1.534 albertel 2056: =back
2057:
1.112 bowersj2 2058: =cut
1.87 matthew 2059:
2060: ###############################################################
1.112 bowersj2 2061: ## Decoding User Agent ##
1.87 matthew 2062: ###############################################################
2063:
2064: =pod
2065:
1.112 bowersj2 2066: =head1 Decoding the User Agent
2067:
2068: =over 4
2069:
2070: =item * &decode_user_agent()
1.87 matthew 2071:
2072: Inputs: $r
2073:
2074: Outputs:
2075:
2076: =over 4
2077:
1.112 bowersj2 2078: =item * $httpbrowser
1.87 matthew 2079:
1.112 bowersj2 2080: =item * $clientbrowser
1.87 matthew 2081:
1.112 bowersj2 2082: =item * $clientversion
1.87 matthew 2083:
1.112 bowersj2 2084: =item * $clientmathml
1.87 matthew 2085:
1.112 bowersj2 2086: =item * $clientunicode
1.87 matthew 2087:
1.112 bowersj2 2088: =item * $clientos
1.87 matthew 2089:
2090: =back
2091:
1.157 matthew 2092: =back
2093:
1.87 matthew 2094: =cut
2095:
2096: ###############################################################
2097: ###############################################################
2098: sub decode_user_agent {
1.247 albertel 2099: my ($r)=@_;
1.87 matthew 2100: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2101: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2102: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2103: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2104: my $clientbrowser='unknown';
2105: my $clientversion='0';
2106: my $clientmathml='';
2107: my $clientunicode='0';
2108: for (my $i=0;$i<=$#browsertype;$i++) {
2109: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2110: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2111: $clientbrowser=$bname;
2112: $httpbrowser=~/$vreg/i;
2113: $clientversion=$1;
2114: $clientmathml=($clientversion>=$minv);
2115: $clientunicode=($clientversion>=$univ);
2116: }
2117: }
2118: my $clientos='unknown';
2119: if (($httpbrowser=~/linux/i) ||
2120: ($httpbrowser=~/unix/i) ||
2121: ($httpbrowser=~/ux/i) ||
2122: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2123: if (($httpbrowser=~/vax/i) ||
2124: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2125: if ($httpbrowser=~/next/i) { $clientos='next'; }
2126: if (($httpbrowser=~/mac/i) ||
2127: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2128: if ($httpbrowser=~/win/i) { $clientos='win'; }
2129: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2130: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2131: $clientunicode,$clientos,);
2132: }
2133:
1.32 matthew 2134: ###############################################################
2135: ## Authentication changing form generation subroutines ##
2136: ###############################################################
2137: ##
2138: ## All of the authform_xxxxxxx subroutines take their inputs in a
2139: ## hash, and have reasonable default values.
2140: ##
2141: ## formname = the name given in the <form> tag.
1.35 matthew 2142: #-------------------------------------------
2143:
1.45 matthew 2144: =pod
2145:
1.112 bowersj2 2146: =head1 Authentication Routines
2147:
2148: =over 4
2149:
1.648 raeburn 2150: =item * &authform_xxxxxx()
1.35 matthew 2151:
2152: The authform_xxxxxx subroutines provide javascript and html forms which
2153: handle some of the conveniences required for authentication forms.
2154: This is not an optimal method, but it works.
2155:
2156: =over 4
2157:
1.112 bowersj2 2158: =item * authform_header
1.35 matthew 2159:
1.112 bowersj2 2160: =item * authform_authorwarning
1.35 matthew 2161:
1.112 bowersj2 2162: =item * authform_nochange
1.35 matthew 2163:
1.112 bowersj2 2164: =item * authform_kerberos
1.35 matthew 2165:
1.112 bowersj2 2166: =item * authform_internal
1.35 matthew 2167:
1.112 bowersj2 2168: =item * authform_filesystem
1.35 matthew 2169:
2170: =back
2171:
1.648 raeburn 2172: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2173:
1.35 matthew 2174: =cut
2175:
2176: #-------------------------------------------
1.32 matthew 2177: sub authform_header{
2178: my %in = (
2179: formname => 'cu',
1.80 albertel 2180: kerb_def_dom => '',
1.32 matthew 2181: @_,
2182: );
2183: $in{'formname'} = 'document.' . $in{'formname'};
2184: my $result='';
1.80 albertel 2185:
2186: #---------------------------------------------- Code for upper case translation
2187: my $Javascript_toUpperCase;
2188: unless ($in{kerb_def_dom}) {
2189: $Javascript_toUpperCase =<<"END";
2190: switch (choice) {
2191: case 'krb': currentform.elements[choicearg].value =
2192: currentform.elements[choicearg].value.toUpperCase();
2193: break;
2194: default:
2195: }
2196: END
2197: } else {
2198: $Javascript_toUpperCase = "";
2199: }
2200:
1.165 raeburn 2201: my $radioval = "'nochange'";
1.591 raeburn 2202: if (defined($in{'curr_authtype'})) {
2203: if ($in{'curr_authtype'} ne '') {
2204: $radioval = "'".$in{'curr_authtype'}."arg'";
2205: }
1.174 matthew 2206: }
1.165 raeburn 2207: my $argfield = 'null';
1.591 raeburn 2208: if (defined($in{'mode'})) {
1.165 raeburn 2209: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2210: if (defined($in{'curr_autharg'})) {
2211: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2212: $argfield = "'$in{'curr_autharg'}'";
2213: }
2214: }
2215: }
2216: }
2217:
1.32 matthew 2218: $result.=<<"END";
2219: var current = new Object();
1.165 raeburn 2220: current.radiovalue = $radioval;
2221: current.argfield = $argfield;
1.32 matthew 2222:
2223: function changed_radio(choice,currentform) {
2224: var choicearg = choice + 'arg';
2225: // If a radio button in changed, we need to change the argfield
2226: if (current.radiovalue != choice) {
2227: current.radiovalue = choice;
2228: if (current.argfield != null) {
2229: currentform.elements[current.argfield].value = '';
2230: }
2231: if (choice == 'nochange') {
2232: current.argfield = null;
2233: } else {
2234: current.argfield = choicearg;
2235: switch(choice) {
2236: case 'krb':
2237: currentform.elements[current.argfield].value =
2238: "$in{'kerb_def_dom'}";
2239: break;
2240: default:
2241: break;
2242: }
2243: }
2244: }
2245: return;
2246: }
1.22 www 2247:
1.32 matthew 2248: function changed_text(choice,currentform) {
2249: var choicearg = choice + 'arg';
2250: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2251: $Javascript_toUpperCase
1.32 matthew 2252: // clear old field
2253: if ((current.argfield != choicearg) && (current.argfield != null)) {
2254: currentform.elements[current.argfield].value = '';
2255: }
2256: current.argfield = choicearg;
2257: }
2258: set_auth_radio_buttons(choice,currentform);
2259: return;
1.20 www 2260: }
1.32 matthew 2261:
2262: function set_auth_radio_buttons(newvalue,currentform) {
2263: var i=0;
2264: while (i < currentform.login.length) {
2265: if (currentform.login[i].value == newvalue) { break; }
2266: i++;
2267: }
2268: if (i == currentform.login.length) {
2269: return;
2270: }
2271: current.radiovalue = newvalue;
2272: currentform.login[i].checked = true;
2273: return;
2274: }
2275: END
2276: return $result;
2277: }
2278:
2279: sub authform_authorwarning{
2280: my $result='';
1.144 matthew 2281: $result='<i>'.
2282: &mt('As a general rule, only authors or co-authors should be '.
2283: 'filesystem authenticated '.
2284: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2285: return $result;
2286: }
2287:
2288: sub authform_nochange{
2289: my %in = (
2290: formname => 'document.cu',
2291: kerb_def_dom => 'MSU.EDU',
2292: @_,
2293: );
1.586 raeburn 2294: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2295: my $result;
2296: if (keys(%can_assign) == 0) {
2297: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2298: } else {
2299: $result = '<label>'.&mt('[_1] Do not change login data',
2300: '<input type="radio" name="login" value="nochange" '.
2301: 'checked="checked" onclick="'.
1.281 albertel 2302: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2303: '</label>';
1.586 raeburn 2304: }
1.32 matthew 2305: return $result;
2306: }
2307:
1.591 raeburn 2308: sub authform_kerberos {
1.32 matthew 2309: my %in = (
2310: formname => 'document.cu',
2311: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2312: kerb_def_auth => 'krb4',
1.32 matthew 2313: @_,
2314: );
1.586 raeburn 2315: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2316: $autharg,$jscall);
2317: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2318: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2319: $check5 = ' checked="checked"';
1.80 albertel 2320: } else {
1.772 bisitz 2321: $check4 = ' checked="checked"';
1.80 albertel 2322: }
1.165 raeburn 2323: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2324: if (defined($in{'curr_authtype'})) {
2325: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2326: $krbcheck = ' checked="checked"';
1.623 raeburn 2327: if (defined($in{'mode'})) {
2328: if ($in{'mode'} eq 'modifyuser') {
2329: $krbcheck = '';
2330: }
2331: }
1.591 raeburn 2332: if (defined($in{'curr_kerb_ver'})) {
2333: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2334: $check5 = ' checked="checked"';
1.591 raeburn 2335: $check4 = '';
2336: } else {
1.772 bisitz 2337: $check4 = ' checked="checked"';
1.591 raeburn 2338: $check5 = '';
2339: }
1.586 raeburn 2340: }
1.591 raeburn 2341: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2342: $krbarg = $in{'curr_autharg'};
2343: }
1.586 raeburn 2344: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2345: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2346: $result =
2347: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2348: $in{'curr_autharg'},$krbver);
2349: } else {
2350: $result =
2351: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2352: }
2353: return $result;
2354: }
2355: }
2356: } else {
2357: if ($authnum == 1) {
1.784 bisitz 2358: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2359: }
2360: }
1.586 raeburn 2361: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2362: return;
1.587 raeburn 2363: } elsif ($authtype eq '') {
1.591 raeburn 2364: if (defined($in{'mode'})) {
1.587 raeburn 2365: if ($in{'mode'} eq 'modifycourse') {
2366: if ($authnum == 1) {
1.784 bisitz 2367: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2368: }
2369: }
2370: }
1.586 raeburn 2371: }
2372: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2373: if ($authtype eq '') {
2374: $authtype = '<input type="radio" name="login" value="krb" '.
2375: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2376: $krbcheck.' />';
2377: }
2378: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2379: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2380: $in{'curr_authtype'} eq 'krb5') ||
2381: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2382: $in{'curr_authtype'} eq 'krb4')) {
2383: $result .= &mt
1.144 matthew 2384: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2385: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2386: '<label>'.$authtype,
1.281 albertel 2387: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2388: 'value="'.$krbarg.'" '.
1.144 matthew 2389: 'onchange="'.$jscall.'" />',
1.281 albertel 2390: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2391: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2392: '</label>');
1.586 raeburn 2393: } elsif ($can_assign{'krb4'}) {
2394: $result .= &mt
2395: ('[_1] Kerberos authenticated with domain [_2] '.
2396: '[_3] Version 4 [_4]',
2397: '<label>'.$authtype,
2398: '</label><input type="text" size="10" name="krbarg" '.
2399: 'value="'.$krbarg.'" '.
2400: 'onchange="'.$jscall.'" />',
2401: '<label><input type="hidden" name="krbver" value="4" />',
2402: '</label>');
2403: } elsif ($can_assign{'krb5'}) {
2404: $result .= &mt
2405: ('[_1] Kerberos authenticated with domain [_2] '.
2406: '[_3] Version 5 [_4]',
2407: '<label>'.$authtype,
2408: '</label><input type="text" size="10" name="krbarg" '.
2409: 'value="'.$krbarg.'" '.
2410: 'onchange="'.$jscall.'" />',
2411: '<label><input type="hidden" name="krbver" value="5" />',
2412: '</label>');
2413: }
1.32 matthew 2414: return $result;
2415: }
2416:
2417: sub authform_internal{
1.586 raeburn 2418: my %in = (
1.32 matthew 2419: formname => 'document.cu',
2420: kerb_def_dom => 'MSU.EDU',
2421: @_,
2422: );
1.586 raeburn 2423: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2424: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2425: if (defined($in{'curr_authtype'})) {
2426: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2427: if ($can_assign{'int'}) {
1.772 bisitz 2428: $intcheck = 'checked="checked" ';
1.623 raeburn 2429: if (defined($in{'mode'})) {
2430: if ($in{'mode'} eq 'modifyuser') {
2431: $intcheck = '';
2432: }
2433: }
1.591 raeburn 2434: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2435: $intarg = $in{'curr_autharg'};
2436: }
2437: } else {
2438: $result = &mt('Currently internally authenticated.');
2439: return $result;
1.165 raeburn 2440: }
2441: }
1.586 raeburn 2442: } else {
2443: if ($authnum == 1) {
1.784 bisitz 2444: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2445: }
2446: }
2447: if (!$can_assign{'int'}) {
2448: return;
1.587 raeburn 2449: } elsif ($authtype eq '') {
1.591 raeburn 2450: if (defined($in{'mode'})) {
1.587 raeburn 2451: if ($in{'mode'} eq 'modifycourse') {
2452: if ($authnum == 1) {
1.784 bisitz 2453: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2454: }
2455: }
2456: }
1.165 raeburn 2457: }
1.586 raeburn 2458: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2459: if ($authtype eq '') {
2460: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2461: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2462: }
1.605 bisitz 2463: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2464: $intarg.'" onchange="'.$jscall.'" />';
2465: $result = &mt
1.144 matthew 2466: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2467: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2468: $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 2469: return $result;
2470: }
2471:
2472: sub authform_local{
2473: my %in = (
2474: formname => 'document.cu',
2475: kerb_def_dom => 'MSU.EDU',
2476: @_,
2477: );
1.586 raeburn 2478: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2479: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2480: if (defined($in{'curr_authtype'})) {
2481: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2482: if ($can_assign{'loc'}) {
1.772 bisitz 2483: $loccheck = 'checked="checked" ';
1.623 raeburn 2484: if (defined($in{'mode'})) {
2485: if ($in{'mode'} eq 'modifyuser') {
2486: $loccheck = '';
2487: }
2488: }
1.591 raeburn 2489: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2490: $locarg = $in{'curr_autharg'};
2491: }
2492: } else {
2493: $result = &mt('Currently using local (institutional) authentication.');
2494: return $result;
1.165 raeburn 2495: }
2496: }
1.586 raeburn 2497: } else {
2498: if ($authnum == 1) {
1.784 bisitz 2499: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2500: }
2501: }
2502: if (!$can_assign{'loc'}) {
2503: return;
1.587 raeburn 2504: } elsif ($authtype eq '') {
1.591 raeburn 2505: if (defined($in{'mode'})) {
1.587 raeburn 2506: if ($in{'mode'} eq 'modifycourse') {
2507: if ($authnum == 1) {
1.784 bisitz 2508: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2509: }
2510: }
2511: }
1.165 raeburn 2512: }
1.586 raeburn 2513: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2514: if ($authtype eq '') {
2515: $authtype = '<input type="radio" name="login" value="loc" '.
2516: $loccheck.' onchange="'.$jscall.'" onclick="'.
2517: $jscall.'" />';
2518: }
2519: $autharg = '<input type="text" size="10" name="locarg" value="'.
2520: $locarg.'" onchange="'.$jscall.'" />';
2521: $result = &mt('[_1] Local Authentication with argument [_2]',
2522: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2523: return $result;
2524: }
2525:
2526: sub authform_filesystem{
2527: my %in = (
2528: formname => 'document.cu',
2529: kerb_def_dom => 'MSU.EDU',
2530: @_,
2531: );
1.586 raeburn 2532: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2533: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2534: if (defined($in{'curr_authtype'})) {
2535: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2536: if ($can_assign{'fsys'}) {
1.772 bisitz 2537: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2538: if (defined($in{'mode'})) {
2539: if ($in{'mode'} eq 'modifyuser') {
2540: $fsyscheck = '';
2541: }
2542: }
1.586 raeburn 2543: } else {
2544: $result = &mt('Currently Filesystem Authenticated.');
2545: return $result;
2546: }
2547: }
2548: } else {
2549: if ($authnum == 1) {
1.784 bisitz 2550: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2551: }
2552: }
2553: if (!$can_assign{'fsys'}) {
2554: return;
1.587 raeburn 2555: } elsif ($authtype eq '') {
1.591 raeburn 2556: if (defined($in{'mode'})) {
1.587 raeburn 2557: if ($in{'mode'} eq 'modifycourse') {
2558: if ($authnum == 1) {
1.784 bisitz 2559: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2560: }
2561: }
2562: }
1.586 raeburn 2563: }
2564: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2565: if ($authtype eq '') {
2566: $authtype = '<input type="radio" name="login" value="fsys" '.
2567: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2568: $jscall.'" />';
2569: }
2570: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2571: ' onchange="'.$jscall.'" />';
2572: $result = &mt
1.144 matthew 2573: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2574: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2575: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2576: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2577: 'onchange="'.$jscall.'" />');
1.32 matthew 2578: return $result;
2579: }
2580:
1.586 raeburn 2581: sub get_assignable_auth {
2582: my ($dom) = @_;
2583: if ($dom eq '') {
2584: $dom = $env{'request.role.domain'};
2585: }
2586: my %can_assign = (
2587: krb4 => 1,
2588: krb5 => 1,
2589: int => 1,
2590: loc => 1,
2591: );
2592: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2593: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2594: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2595: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2596: my $context;
2597: if ($env{'request.role'} =~ /^au/) {
2598: $context = 'author';
2599: } elsif ($env{'request.role'} =~ /^dc/) {
2600: $context = 'domain';
2601: } elsif ($env{'request.course.id'}) {
2602: $context = 'course';
2603: }
2604: if ($context) {
2605: if (ref($authhash->{$context}) eq 'HASH') {
2606: %can_assign = %{$authhash->{$context}};
2607: }
2608: }
2609: }
2610: }
2611: my $authnum = 0;
2612: foreach my $key (keys(%can_assign)) {
2613: if ($can_assign{$key}) {
2614: $authnum ++;
2615: }
2616: }
2617: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2618: $authnum --;
2619: }
2620: return ($authnum,%can_assign);
2621: }
2622:
1.80 albertel 2623: ###############################################################
2624: ## Get Kerberos Defaults for Domain ##
2625: ###############################################################
2626: ##
2627: ## Returns default kerberos version and an associated argument
2628: ## as listed in file domain.tab. If not listed, provides
2629: ## appropriate default domain and kerberos version.
2630: ##
2631: #-------------------------------------------
2632:
2633: =pod
2634:
1.648 raeburn 2635: =item * &get_kerberos_defaults()
1.80 albertel 2636:
2637: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2638: version and domain. If not found, it defaults to version 4 and the
2639: domain of the server.
1.80 albertel 2640:
1.648 raeburn 2641: =over 4
2642:
1.80 albertel 2643: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2644:
1.648 raeburn 2645: =back
2646:
2647: =back
2648:
1.80 albertel 2649: =cut
2650:
2651: #-------------------------------------------
2652: sub get_kerberos_defaults {
2653: my $domain=shift;
1.641 raeburn 2654: my ($krbdef,$krbdefdom);
2655: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2656: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2657: $krbdef = $domdefaults{'auth_def'};
2658: $krbdefdom = $domdefaults{'auth_arg_def'};
2659: } else {
1.80 albertel 2660: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2661: my $krbdefdom=$1;
2662: $krbdefdom=~tr/a-z/A-Z/;
2663: $krbdef = "krb4";
2664: }
2665: return ($krbdef,$krbdefdom);
2666: }
1.112 bowersj2 2667:
1.32 matthew 2668:
1.46 matthew 2669: ###############################################################
2670: ## Thesaurus Functions ##
2671: ###############################################################
1.20 www 2672:
1.46 matthew 2673: =pod
1.20 www 2674:
1.112 bowersj2 2675: =head1 Thesaurus Functions
2676:
2677: =over 4
2678:
1.648 raeburn 2679: =item * &initialize_keywords()
1.46 matthew 2680:
2681: Initializes the package variable %Keywords if it is empty. Uses the
2682: package variable $thesaurus_db_file.
2683:
2684: =cut
2685:
2686: ###################################################
2687:
2688: sub initialize_keywords {
2689: return 1 if (scalar keys(%Keywords));
2690: # If we are here, %Keywords is empty, so fill it up
2691: # Make sure the file we need exists...
2692: if (! -e $thesaurus_db_file) {
2693: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2694: " failed because it does not exist");
2695: return 0;
2696: }
2697: # Set up the hash as a database
2698: my %thesaurus_db;
2699: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2700: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2701: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2702: $thesaurus_db_file);
2703: return 0;
2704: }
2705: # Get the average number of appearances of a word.
2706: my $avecount = $thesaurus_db{'average.count'};
2707: # Put keywords (those that appear > average) into %Keywords
2708: while (my ($word,$data)=each (%thesaurus_db)) {
2709: my ($count,undef) = split /:/,$data;
2710: $Keywords{$word}++ if ($count > $avecount);
2711: }
2712: untie %thesaurus_db;
2713: # Remove special values from %Keywords.
1.356 albertel 2714: foreach my $value ('total.count','average.count') {
2715: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2716: }
1.46 matthew 2717: return 1;
2718: }
2719:
2720: ###################################################
2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &keyword($word)
1.46 matthew 2725:
2726: Returns true if $word is a keyword. A keyword is a word that appears more
2727: than the average number of times in the thesaurus database. Calls
2728: &initialize_keywords
2729:
2730: =cut
2731:
2732: ###################################################
1.20 www 2733:
2734: sub keyword {
1.46 matthew 2735: return if (!&initialize_keywords());
2736: my $word=lc(shift());
2737: $word=~s/\W//g;
2738: return exists($Keywords{$word});
1.20 www 2739: }
1.46 matthew 2740:
2741: ###############################################################
2742:
2743: =pod
1.20 www 2744:
1.648 raeburn 2745: =item * &get_related_words()
1.46 matthew 2746:
1.160 matthew 2747: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2748: an array of words. If the keyword is not in the thesaurus, an empty array
2749: will be returned. The order of the words returned is determined by the
2750: database which holds them.
2751:
2752: Uses global $thesaurus_db_file.
2753:
2754: =cut
2755:
2756: ###############################################################
2757: sub get_related_words {
2758: my $keyword = shift;
2759: my %thesaurus_db;
2760: if (! -e $thesaurus_db_file) {
2761: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2762: "failed because the file does not exist");
2763: return ();
2764: }
2765: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2766: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2767: return ();
2768: }
2769: my @Words=();
1.429 www 2770: my $count=0;
1.46 matthew 2771: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2772: # The first element is the number of times
2773: # the word appears. We do not need it now.
1.429 www 2774: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2775: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2776: my $threshold=$mostfrequentcount/10;
2777: foreach my $possibleword (@RelatedWords) {
2778: my ($word,$wordcount)=split(/\,/,$possibleword);
2779: if ($wordcount>$threshold) {
2780: push(@Words,$word);
2781: $count++;
2782: if ($count>10) { last; }
2783: }
1.20 www 2784: }
2785: }
1.46 matthew 2786: untie %thesaurus_db;
2787: return @Words;
1.14 harris41 2788: }
1.46 matthew 2789:
1.112 bowersj2 2790: =pod
2791:
2792: =back
2793:
2794: =cut
1.61 www 2795:
2796: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2797: =pod
2798:
1.112 bowersj2 2799: =head1 User Name Functions
2800:
2801: =over 4
2802:
1.648 raeburn 2803: =item * &plainname($uname,$udom,$first)
1.81 albertel 2804:
1.112 bowersj2 2805: Takes a users logon name and returns it as a string in
1.226 albertel 2806: "first middle last generation" form
2807: if $first is set to 'lastname' then it returns it as
2808: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2809:
2810: =cut
1.61 www 2811:
1.295 www 2812:
1.81 albertel 2813: ###############################################################
1.61 www 2814: sub plainname {
1.226 albertel 2815: my ($uname,$udom,$first)=@_;
1.537 albertel 2816: return if (!defined($uname) || !defined($udom));
1.295 www 2817: my %names=&getnames($uname,$udom);
1.226 albertel 2818: my $name=&Apache::lonnet::format_name($names{'firstname'},
2819: $names{'middlename'},
2820: $names{'lastname'},
2821: $names{'generation'},$first);
2822: $name=~s/^\s+//;
1.62 www 2823: $name=~s/\s+$//;
2824: $name=~s/\s+/ /g;
1.353 albertel 2825: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2826: return $name;
1.61 www 2827: }
1.66 www 2828:
2829: # -------------------------------------------------------------------- Nickname
1.81 albertel 2830: =pod
2831:
1.648 raeburn 2832: =item * &nickname($uname,$udom)
1.81 albertel 2833:
2834: Gets a users name and returns it as a string as
2835:
2836: ""nickname""
1.66 www 2837:
1.81 albertel 2838: if the user has a nickname or
2839:
2840: "first middle last generation"
2841:
2842: if the user does not
2843:
2844: =cut
1.66 www 2845:
2846: sub nickname {
2847: my ($uname,$udom)=@_;
1.537 albertel 2848: return if (!defined($uname) || !defined($udom));
1.295 www 2849: my %names=&getnames($uname,$udom);
1.68 albertel 2850: my $name=$names{'nickname'};
1.66 www 2851: if ($name) {
2852: $name='"'.$name.'"';
2853: } else {
2854: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2855: $names{'lastname'}.' '.$names{'generation'};
2856: $name=~s/\s+$//;
2857: $name=~s/\s+/ /g;
2858: }
2859: return $name;
2860: }
2861:
1.295 www 2862: sub getnames {
2863: my ($uname,$udom)=@_;
1.537 albertel 2864: return if (!defined($uname) || !defined($udom));
1.433 albertel 2865: if ($udom eq 'public' && $uname eq 'public') {
2866: return ('lastname' => &mt('Public'));
2867: }
1.295 www 2868: my $id=$uname.':'.$udom;
2869: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2870: if ($cached) {
2871: return %{$names};
2872: } else {
2873: my %loadnames=&Apache::lonnet::get('environment',
2874: ['firstname','middlename','lastname','generation','nickname'],
2875: $udom,$uname);
2876: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2877: return %loadnames;
2878: }
2879: }
1.61 www 2880:
1.542 raeburn 2881: # -------------------------------------------------------------------- getemails
1.648 raeburn 2882:
1.542 raeburn 2883: =pod
2884:
1.648 raeburn 2885: =item * &getemails($uname,$udom)
1.542 raeburn 2886:
2887: Gets a user's email information and returns it as a hash with keys:
2888: notification, critnotification, permanentemail
2889:
2890: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2891: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2892:
1.648 raeburn 2893:
1.542 raeburn 2894: =cut
2895:
1.648 raeburn 2896:
1.466 albertel 2897: sub getemails {
2898: my ($uname,$udom)=@_;
2899: if ($udom eq 'public' && $uname eq 'public') {
2900: return;
2901: }
1.467 www 2902: if (!$udom) { $udom=$env{'user.domain'}; }
2903: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2904: my $id=$uname.':'.$udom;
2905: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2906: if ($cached) {
2907: return %{$names};
2908: } else {
2909: my %loadnames=&Apache::lonnet::get('environment',
2910: ['notification','critnotification',
2911: 'permanentemail'],
2912: $udom,$uname);
2913: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2914: return %loadnames;
2915: }
2916: }
2917:
1.551 albertel 2918: sub flush_email_cache {
2919: my ($uname,$udom)=@_;
2920: if (!$udom) { $udom =$env{'user.domain'}; }
2921: if (!$uname) { $uname=$env{'user.name'}; }
2922: return if ($udom eq 'public' && $uname eq 'public');
2923: my $id=$uname.':'.$udom;
2924: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2925: }
2926:
1.728 raeburn 2927: # -------------------------------------------------------------------- getlangs
2928:
2929: =pod
2930:
2931: =item * &getlangs($uname,$udom)
2932:
2933: Gets a user's language preference and returns it as a hash with key:
2934: language.
2935:
2936: =cut
2937:
2938:
2939: sub getlangs {
2940: my ($uname,$udom) = @_;
2941: if (!$udom) { $udom =$env{'user.domain'}; }
2942: if (!$uname) { $uname=$env{'user.name'}; }
2943: my $id=$uname.':'.$udom;
2944: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2945: if ($cached) {
2946: return %{$langs};
2947: } else {
2948: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2949: $udom,$uname);
2950: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2951: return %loadlangs;
2952: }
2953: }
2954:
2955: sub flush_langs_cache {
2956: my ($uname,$udom)=@_;
2957: if (!$udom) { $udom =$env{'user.domain'}; }
2958: if (!$uname) { $uname=$env{'user.name'}; }
2959: return if ($udom eq 'public' && $uname eq 'public');
2960: my $id=$uname.':'.$udom;
2961: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2962: }
2963:
1.61 www 2964: # ------------------------------------------------------------------ Screenname
1.81 albertel 2965:
2966: =pod
2967:
1.648 raeburn 2968: =item * &screenname($uname,$udom)
1.81 albertel 2969:
2970: Gets a users screenname and returns it as a string
2971:
2972: =cut
1.61 www 2973:
2974: sub screenname {
2975: my ($uname,$udom)=@_;
1.258 albertel 2976: if ($uname eq $env{'user.name'} &&
2977: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2978: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2979: return $names{'screenname'};
1.62 www 2980: }
2981:
1.212 albertel 2982:
1.802 bisitz 2983: # ------------------------------------------------------------- Confirm Wrapper
2984: =pod
2985:
2986: =item confirmwrapper
2987:
2988: Wrap messages about completion of operation in box
2989:
2990: =cut
2991:
2992: sub confirmwrapper {
2993: my ($message)=@_;
2994: if ($message) {
2995: return "\n".'<div class="LC_confirm_box">'."\n"
2996: .$message."\n"
2997: .'</div>'."\n";
2998: } else {
2999: return $message;
3000: }
3001: }
3002:
1.62 www 3003: # ------------------------------------------------------------- Message Wrapper
3004:
3005: sub messagewrapper {
1.369 www 3006: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3007: return
1.441 albertel 3008: '<a href="/adm/email?compose=individual&'.
3009: 'recname='.$username.'&recdom='.$domain.
3010: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3011: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3012: }
1.802 bisitz 3013:
1.74 www 3014: # --------------------------------------------------------------- Notes Wrapper
3015:
3016: sub noteswrapper {
3017: my ($link,$un,$do)=@_;
3018: return
1.896 amueller 3019: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3020: }
1.802 bisitz 3021:
1.62 www 3022: # ------------------------------------------------------------- Aboutme Wrapper
3023:
3024: sub aboutmewrapper {
1.166 www 3025: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3026: if (!defined($username) && !defined($domain)) {
3027: return;
3028: }
1.892 amueller 3029: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3030: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3031: }
3032:
3033: # ------------------------------------------------------------ Syllabus Wrapper
3034:
3035: sub syllabuswrapper {
1.707 bisitz 3036: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3037: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3038: }
1.14 harris41 3039:
1.802 bisitz 3040: # -----------------------------------------------------------------------------
3041:
1.208 matthew 3042: sub track_student_link {
1.887 raeburn 3043: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3044: my $link ="/adm/trackstudent?";
1.208 matthew 3045: my $title = 'View recent activity';
3046: if (defined($sname) && $sname !~ /^\s*$/ &&
3047: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3048: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3049: $title .= ' of this student';
1.268 albertel 3050: }
1.208 matthew 3051: if (defined($target) && $target !~ /^\s*$/) {
3052: $target = qq{target="$target"};
3053: } else {
3054: $target = '';
3055: }
1.268 albertel 3056: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3057: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3058: $title = &mt($title);
3059: $linktext = &mt($linktext);
1.448 albertel 3060: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3061: &help_open_topic('View_recent_activity');
1.208 matthew 3062: }
3063:
1.781 raeburn 3064: sub slot_reservations_link {
3065: my ($linktext,$sname,$sdom,$target) = @_;
3066: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3067: my $title = 'View slot reservation history';
3068: if (defined($sname) && $sname !~ /^\s*$/ &&
3069: defined($sdom) && $sdom !~ /^\s*$/) {
3070: $link .= "&uname=$sname&udom=$sdom";
3071: $title .= ' of this student';
3072: }
3073: if (defined($target) && $target !~ /^\s*$/) {
3074: $target = qq{target="$target"};
3075: } else {
3076: $target = '';
3077: }
3078: $title = &mt($title);
3079: $linktext = &mt($linktext);
3080: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3081: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3082:
3083: }
3084:
1.508 www 3085: # ===================================================== Display a student photo
3086:
3087:
1.509 albertel 3088: sub student_image_tag {
1.508 www 3089: my ($domain,$user)=@_;
3090: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3091: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3092: return '<img src="'.$imgsrc.'" align="right" />';
3093: } else {
3094: return '';
3095: }
3096: }
3097:
1.112 bowersj2 3098: =pod
3099:
3100: =back
3101:
3102: =head1 Access .tab File Data
3103:
3104: =over 4
3105:
1.648 raeburn 3106: =item * &languageids()
1.112 bowersj2 3107:
3108: returns list of all language ids
3109:
3110: =cut
3111:
1.14 harris41 3112: sub languageids {
1.16 harris41 3113: return sort(keys(%language));
1.14 harris41 3114: }
3115:
1.112 bowersj2 3116: =pod
3117:
1.648 raeburn 3118: =item * &languagedescription()
1.112 bowersj2 3119:
3120: returns description of a specified language id
3121:
3122: =cut
3123:
1.14 harris41 3124: sub languagedescription {
1.125 www 3125: my $code=shift;
3126: return ($supported_language{$code}?'* ':'').
3127: $language{$code}.
1.126 www 3128: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3129: }
3130:
3131: sub plainlanguagedescription {
3132: my $code=shift;
3133: return $language{$code};
3134: }
3135:
3136: sub supportedlanguagecode {
3137: my $code=shift;
3138: return $supported_language{$code};
1.97 www 3139: }
3140:
1.112 bowersj2 3141: =pod
3142:
1.648 raeburn 3143: =item * ©rightids()
1.112 bowersj2 3144:
3145: returns list of all copyrights
3146:
3147: =cut
3148:
3149: sub copyrightids {
3150: return sort(keys(%cprtag));
3151: }
3152:
3153: =pod
3154:
1.648 raeburn 3155: =item * ©rightdescription()
1.112 bowersj2 3156:
3157: returns description of a specified copyright id
3158:
3159: =cut
3160:
3161: sub copyrightdescription {
1.166 www 3162: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3163: }
1.197 matthew 3164:
3165: =pod
3166:
1.648 raeburn 3167: =item * &source_copyrightids()
1.192 taceyjo1 3168:
3169: returns list of all source copyrights
3170:
3171: =cut
3172:
3173: sub source_copyrightids {
3174: return sort(keys(%scprtag));
3175: }
3176:
3177: =pod
3178:
1.648 raeburn 3179: =item * &source_copyrightdescription()
1.192 taceyjo1 3180:
3181: returns description of a specified source copyright id
3182:
3183: =cut
3184:
3185: sub source_copyrightdescription {
3186: return &mt($scprtag{shift(@_)});
3187: }
1.112 bowersj2 3188:
3189: =pod
3190:
1.648 raeburn 3191: =item * &filecategories()
1.112 bowersj2 3192:
3193: returns list of all file categories
3194:
3195: =cut
3196:
3197: sub filecategories {
3198: return sort(keys(%category_extensions));
3199: }
3200:
3201: =pod
3202:
1.648 raeburn 3203: =item * &filecategorytypes()
1.112 bowersj2 3204:
3205: returns list of file types belonging to a given file
3206: category
3207:
3208: =cut
3209:
3210: sub filecategorytypes {
1.356 albertel 3211: my ($cat) = @_;
3212: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &fileembstyle()
1.112 bowersj2 3218:
3219: returns embedding style for a specified file type
3220:
3221: =cut
3222:
3223: sub fileembstyle {
3224: return $fe{lc(shift(@_))};
1.169 www 3225: }
3226:
1.351 www 3227: sub filemimetype {
3228: return $fm{lc(shift(@_))};
3229: }
3230:
1.169 www 3231:
3232: sub filecategoryselect {
3233: my ($name,$value)=@_;
1.189 matthew 3234: return &select_form($value,$name,
1.169 www 3235: '' => &mt('Any category'),
3236: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3237: }
3238:
3239: =pod
3240:
1.648 raeburn 3241: =item * &filedescription()
1.112 bowersj2 3242:
3243: returns description for a specified file type
3244:
3245: =cut
3246:
3247: sub filedescription {
1.188 matthew 3248: my $file_description = $fd{lc(shift())};
3249: $file_description =~ s:([\[\]]):~$1:g;
3250: return &mt($file_description);
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescriptionex()
1.112 bowersj2 3256:
3257: returns description for a specified file type with
3258: extra formatting
3259:
3260: =cut
3261:
3262: sub filedescriptionex {
3263: my $ex=shift;
1.188 matthew 3264: my $file_description = $fd{lc($ex)};
3265: $file_description =~ s:([\[\]]):~$1:g;
3266: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3267: }
3268:
3269: # End of .tab access
3270: =pod
3271:
3272: =back
3273:
3274: =cut
3275:
3276: # ------------------------------------------------------------------ File Types
3277: sub fileextensions {
3278: return sort(keys(%fe));
3279: }
3280:
1.97 www 3281: # ----------------------------------------------------------- Display Languages
3282: # returns a hash with all desired display languages
3283: #
3284:
3285: sub display_languages {
3286: my %languages=();
1.695 raeburn 3287: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3288: $languages{$lang}=1;
1.97 www 3289: }
3290: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3291: if ($env{'form.displaylanguage'}) {
1.356 albertel 3292: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3293: $languages{$lang}=1;
1.97 www 3294: }
3295: }
3296: return %languages;
1.14 harris41 3297: }
3298:
1.582 albertel 3299: sub languages {
3300: my ($possible_langs) = @_;
1.695 raeburn 3301: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3302: if (!ref($possible_langs)) {
3303: if( wantarray ) {
3304: return @preferred_langs;
3305: } else {
3306: return $preferred_langs[0];
3307: }
3308: }
3309: my %possibilities = map { $_ => 1 } (@$possible_langs);
3310: my @preferred_possibilities;
3311: foreach my $preferred_lang (@preferred_langs) {
3312: if (exists($possibilities{$preferred_lang})) {
3313: push(@preferred_possibilities, $preferred_lang);
3314: }
3315: }
3316: if( wantarray ) {
3317: return @preferred_possibilities;
3318: }
3319: return $preferred_possibilities[0];
3320: }
3321:
1.742 raeburn 3322: sub user_lang {
3323: my ($touname,$toudom,$fromcid) = @_;
3324: my @userlangs;
3325: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3326: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3327: $env{'course.'.$fromcid.'.languages'}));
3328: } else {
3329: my %langhash = &getlangs($touname,$toudom);
3330: if ($langhash{'languages'} ne '') {
3331: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3332: } else {
3333: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3334: if ($domdefs{'lang_def'} ne '') {
3335: @userlangs = ($domdefs{'lang_def'});
3336: }
3337: }
3338: }
3339: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3340: my $user_lh = Apache::localize->get_handle(@languages);
3341: return $user_lh;
3342: }
3343:
3344:
1.112 bowersj2 3345: ###############################################################
3346: ## Student Answer Attempts ##
3347: ###############################################################
3348:
3349: =pod
3350:
3351: =head1 Alternate Problem Views
3352:
3353: =over 4
3354:
1.648 raeburn 3355: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3356: $getattempt, $regexp, $gradesub)
3357:
3358: Return string with previous attempt on problem. Arguments:
3359:
3360: =over 4
3361:
3362: =item * $symb: Problem, including path
3363:
3364: =item * $username: username of the desired student
3365:
3366: =item * $domain: domain of the desired student
1.14 harris41 3367:
1.112 bowersj2 3368: =item * $course: Course ID
1.14 harris41 3369:
1.112 bowersj2 3370: =item * $getattempt: Leave blank for all attempts, otherwise put
3371: something
1.14 harris41 3372:
1.112 bowersj2 3373: =item * $regexp: if string matches this regexp, the string will be
3374: sent to $gradesub
1.14 harris41 3375:
1.112 bowersj2 3376: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3377:
1.112 bowersj2 3378: =back
1.14 harris41 3379:
1.112 bowersj2 3380: The output string is a table containing all desired attempts, if any.
1.16 harris41 3381:
1.112 bowersj2 3382: =cut
1.1 albertel 3383:
3384: sub get_previous_attempt {
1.43 ng 3385: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3386: my $prevattempts='';
1.43 ng 3387: no strict 'refs';
1.1 albertel 3388: if ($symb) {
1.3 albertel 3389: my (%returnhash)=
3390: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3391: if ($returnhash{'version'}) {
3392: my %lasthash=();
3393: my $version;
3394: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3395: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3396: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3397: }
1.1 albertel 3398: }
1.596 albertel 3399: $prevattempts=&start_data_table().&start_data_table_header_row();
3400: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3401: my %typeparts;
3402: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3403: foreach my $key (sort(keys(%lasthash))) {
3404: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3405: if ($#parts > 0) {
1.31 albertel 3406: my $data=$parts[-1];
3407: pop(@parts);
1.945 raeburn 3408: if ($data eq 'type') {
3409: unless ($showsurv) {
3410: my $id = join(',',@parts);
3411: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3412: }
3413: delete($lasthash{$key});
3414: } else {
3415: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3416: }
1.31 albertel 3417: } else {
1.41 ng 3418: if ($#parts == 0) {
3419: $prevattempts.='<th>'.$parts[0].'</th>';
3420: } else {
3421: $prevattempts.='<th>'.$ign.'</th>';
3422: }
1.31 albertel 3423: }
1.16 harris41 3424: }
1.596 albertel 3425: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3426: my %lasthidden;
1.40 ng 3427: if ($getattempt eq '') {
3428: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3429: my @hidden;
3430: if (%typeparts) {
3431: foreach my $id (keys(%typeparts)) {
3432: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3433: push(@hidden,$id);
3434: $lasthidden{$id} = 1;
3435: } elsif ($lasthidden{$id}) {
3436: if (exists($returnhash{$version.':'.$id.'.award'})) {
3437: delete($lasthidden{$id});
3438: }
3439: }
3440: }
3441: }
3442: $prevattempts.=&start_data_table_row().
3443: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3444: if (@hidden) {
3445: foreach my $key (sort(keys(%lasthash))) {
3446: my $hide;
3447: foreach my $id (@hidden) {
3448: if ($key =~ /^\Q$id\E/) {
3449: $hide = 1;
3450: last;
3451: }
3452: }
3453: if ($hide) {
3454: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3455: if (($data eq 'award') || ($data eq 'awarddetail')) {
3456: my $value = &format_previous_attempt_value($key,
3457: $returnhash{$version.':'.$key});
3458: $prevattempts.='<td>'.$value.' </td>';
3459: } else {
3460: $prevattempts.='<td> </td>';
3461: }
3462: } else {
3463: if ($key =~ /\./) {
3464: my $value = &format_previous_attempt_value($key,
3465: $returnhash{$version.':'.$key});
3466: $prevattempts.='<td>'.$value.' </td>';
3467: } else {
3468: $prevattempts.='<td> </td>';
3469: }
3470: }
3471: }
3472: } else {
3473: foreach my $key (sort(keys(%lasthash))) {
3474: my $value = &format_previous_attempt_value($key,
3475: $returnhash{$version.':'.$key});
3476: $prevattempts.='<td>'.$value.' </td>';
3477: }
3478: }
3479: $prevattempts.=&end_data_table_row();
1.40 ng 3480: }
1.1 albertel 3481: }
1.945 raeburn 3482: my @currhidden = keys(%lasthidden);
1.596 albertel 3483: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3484: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3485: if (%typeparts) {
3486: my $hidden;
3487: foreach my $id (@currhidden) {
3488: if ($key =~ /^\Q$id\E/) {
3489: $hidden = 1;
3490: last;
3491: }
3492: }
3493: if ($hidden) {
3494: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3495: if (($data eq 'award') || ($data eq 'awarddetail')) {
3496: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3497: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3498: $value = &$gradesub($value);
3499: }
3500: $prevattempts.='<td>'.$value.' </td>';
3501: } else {
3502: $prevattempts.='<td> </td>';
3503: }
3504: } else {
3505: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3506: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3507: $value = &$gradesub($value);
3508: }
3509: $prevattempts.='<td>'.$value.' </td>';
3510: }
3511: } else {
3512: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3513: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3514: $value = &$gradesub($value);
3515: }
3516: $prevattempts.='<td>'.$value.' </td>';
3517: }
1.16 harris41 3518: }
1.596 albertel 3519: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3520: } else {
1.596 albertel 3521: $prevattempts=
3522: &start_data_table().&start_data_table_row().
3523: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3524: &end_data_table_row().&end_data_table();
1.1 albertel 3525: }
3526: } else {
1.596 albertel 3527: $prevattempts=
3528: &start_data_table().&start_data_table_row().
3529: '<td>'.&mt('No data.').'</td>'.
3530: &end_data_table_row().&end_data_table();
1.1 albertel 3531: }
1.10 albertel 3532: }
3533:
1.581 albertel 3534: sub format_previous_attempt_value {
3535: my ($key,$value) = @_;
3536: if ($key =~ /timestamp/) {
3537: $value = &Apache::lonlocal::locallocaltime($value);
3538: } elsif (ref($value) eq 'ARRAY') {
3539: $value = '('.join(', ', @{ $value }).')';
3540: } else {
3541: $value = &unescape($value);
3542: }
3543: return $value;
3544: }
3545:
3546:
1.107 albertel 3547: sub relative_to_absolute {
3548: my ($url,$output)=@_;
3549: my $parser=HTML::TokeParser->new(\$output);
3550: my $token;
3551: my $thisdir=$url;
3552: my @rlinks=();
3553: while ($token=$parser->get_token) {
3554: if ($token->[0] eq 'S') {
3555: if ($token->[1] eq 'a') {
3556: if ($token->[2]->{'href'}) {
3557: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3558: }
3559: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3560: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3561: } elsif ($token->[1] eq 'base') {
3562: $thisdir=$token->[2]->{'href'};
3563: }
3564: }
3565: }
3566: $thisdir=~s-/[^/]*$--;
1.356 albertel 3567: foreach my $link (@rlinks) {
1.726 raeburn 3568: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3569: ($link=~/^\//) ||
3570: ($link=~/^javascript:/i) ||
3571: ($link=~/^mailto:/i) ||
3572: ($link=~/^\#/)) {
3573: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3574: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3575: }
3576: }
3577: # -------------------------------------------------- Deal with Applet codebases
3578: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3579: return $output;
3580: }
3581:
1.112 bowersj2 3582: =pod
3583:
1.648 raeburn 3584: =item * &get_student_view()
1.112 bowersj2 3585:
3586: show a snapshot of what student was looking at
3587:
3588: =cut
3589:
1.10 albertel 3590: sub get_student_view {
1.186 albertel 3591: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3592: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3593: my (%form);
1.10 albertel 3594: my @elements=('symb','courseid','domain','username');
3595: foreach my $element (@elements) {
1.186 albertel 3596: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3597: }
1.186 albertel 3598: if (defined($moreenv)) {
3599: %form=(%form,%{$moreenv});
3600: }
1.236 albertel 3601: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3602: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3603: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3604: $userview=~s/\<body[^\>]*\>//gi;
3605: $userview=~s/\<\/body\>//gi;
3606: $userview=~s/\<html\>//gi;
3607: $userview=~s/\<\/html\>//gi;
3608: $userview=~s/\<head\>//gi;
3609: $userview=~s/\<\/head\>//gi;
3610: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3611: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3612: if (wantarray) {
3613: return ($userview,$response);
3614: } else {
3615: return $userview;
3616: }
3617: }
3618:
3619: sub get_student_view_with_retries {
3620: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3621:
3622: my $ok = 0; # True if we got a good response.
3623: my $content;
3624: my $response;
3625:
3626: # Try to get the student_view done. within the retries count:
3627:
3628: do {
3629: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3630: $ok = $response->is_success;
3631: if (!$ok) {
3632: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3633: }
3634: $retries--;
3635: } while (!$ok && ($retries > 0));
3636:
3637: if (!$ok) {
3638: $content = ''; # On error return an empty content.
3639: }
1.651 www 3640: if (wantarray) {
3641: return ($content, $response);
3642: } else {
3643: return $content;
3644: }
1.11 albertel 3645: }
3646:
1.112 bowersj2 3647: =pod
3648:
1.648 raeburn 3649: =item * &get_student_answers()
1.112 bowersj2 3650:
3651: show a snapshot of how student was answering problem
3652:
3653: =cut
3654:
1.11 albertel 3655: sub get_student_answers {
1.100 sakharuk 3656: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3657: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3658: my (%moreenv);
1.11 albertel 3659: my @elements=('symb','courseid','domain','username');
3660: foreach my $element (@elements) {
1.186 albertel 3661: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3662: }
1.186 albertel 3663: $moreenv{'grade_target'}='answer';
3664: %moreenv=(%form,%moreenv);
1.497 raeburn 3665: $feedurl = &Apache::lonnet::clutter($feedurl);
3666: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3667: return $userview;
1.1 albertel 3668: }
1.116 albertel 3669:
3670: =pod
3671:
3672: =item * &submlink()
3673:
1.242 albertel 3674: Inputs: $text $uname $udom $symb $target
1.116 albertel 3675:
3676: Returns: A link to grades.pm such as to see the SUBM view of a student
3677:
3678: =cut
3679:
3680: ###############################################
3681: sub submlink {
1.242 albertel 3682: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3683: if (!($uname && $udom)) {
3684: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3685: &Apache::lonnet::whichuser($symb);
1.116 albertel 3686: if (!$symb) { $symb=$cursymb; }
3687: }
1.254 matthew 3688: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3689: $symb=&escape($symb);
1.960 bisitz 3690: if ($target) { $target=" target=\"$target\""; }
3691: return
3692: '<a href="/adm/grades?command=submission'.
3693: '&symb='.$symb.
3694: '&student='.$uname.
3695: '&userdom='.$udom.'"'.
3696: $target.'>'.$text.'</a>';
1.242 albertel 3697: }
3698: ##############################################
3699:
3700: =pod
3701:
3702: =item * &pgrdlink()
3703:
3704: Inputs: $text $uname $udom $symb $target
3705:
3706: Returns: A link to grades.pm such as to see the PGRD view of a student
3707:
3708: =cut
3709:
3710: ###############################################
3711: sub pgrdlink {
3712: my $link=&submlink(@_);
3713: $link=~s/(&command=submission)/$1&showgrading=yes/;
3714: return $link;
3715: }
3716: ##############################################
3717:
3718: =pod
3719:
3720: =item * &pprmlink()
3721:
3722: Inputs: $text $uname $udom $symb $target
3723:
3724: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3725: student and a specific resource
1.242 albertel 3726:
3727: =cut
3728:
3729: ###############################################
3730: sub pprmlink {
3731: my ($text,$uname,$udom,$symb,$target)=@_;
3732: if (!($uname && $udom)) {
3733: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3734: &Apache::lonnet::whichuser($symb);
1.242 albertel 3735: if (!$symb) { $symb=$cursymb; }
3736: }
1.254 matthew 3737: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3738: $symb=&escape($symb);
1.242 albertel 3739: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3740: return '<a href="/adm/parmset?command=set&'.
3741: 'symb='.$symb.'&uname='.$uname.
3742: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3743: }
3744: ##############################################
1.37 matthew 3745:
1.112 bowersj2 3746: =pod
3747:
3748: =back
3749:
3750: =cut
3751:
1.37 matthew 3752: ###############################################
1.51 www 3753:
3754:
3755: sub timehash {
1.687 raeburn 3756: my ($thistime) = @_;
3757: my $timezone = &Apache::lonlocal::gettimezone();
3758: my $dt = DateTime->from_epoch(epoch => $thistime)
3759: ->set_time_zone($timezone);
3760: my $wday = $dt->day_of_week();
3761: if ($wday == 7) { $wday = 0; }
3762: return ( 'second' => $dt->second(),
3763: 'minute' => $dt->minute(),
3764: 'hour' => $dt->hour(),
3765: 'day' => $dt->day_of_month(),
3766: 'month' => $dt->month(),
3767: 'year' => $dt->year(),
3768: 'weekday' => $wday,
3769: 'dayyear' => $dt->day_of_year(),
3770: 'dlsav' => $dt->is_dst() );
1.51 www 3771: }
3772:
1.370 www 3773: sub utc_string {
3774: my ($date)=@_;
1.371 www 3775: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3776: }
3777:
1.51 www 3778: sub maketime {
3779: my %th=@_;
1.687 raeburn 3780: my ($epoch_time,$timezone,$dt);
3781: $timezone = &Apache::lonlocal::gettimezone();
3782: eval {
3783: $dt = DateTime->new( year => $th{'year'},
3784: month => $th{'month'},
3785: day => $th{'day'},
3786: hour => $th{'hour'},
3787: minute => $th{'minute'},
3788: second => $th{'second'},
3789: time_zone => $timezone,
3790: );
3791: };
3792: if (!$@) {
3793: $epoch_time = $dt->epoch;
3794: if ($epoch_time) {
3795: return $epoch_time;
3796: }
3797: }
1.51 www 3798: return POSIX::mktime(
3799: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3800: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3801: }
3802:
3803: #########################################
1.51 www 3804:
3805: sub findallcourses {
1.482 raeburn 3806: my ($roles,$uname,$udom) = @_;
1.355 albertel 3807: my %roles;
3808: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3809: my %courses;
1.51 www 3810: my $now=time;
1.482 raeburn 3811: if (!defined($uname)) {
3812: $uname = $env{'user.name'};
3813: }
3814: if (!defined($udom)) {
3815: $udom = $env{'user.domain'};
3816: }
3817: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3818: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3819: if (!%roles) {
3820: %roles = (
3821: cc => 1,
1.907 raeburn 3822: co => 1,
1.482 raeburn 3823: in => 1,
3824: ep => 1,
3825: ta => 1,
3826: cr => 1,
3827: st => 1,
3828: );
3829: }
3830: foreach my $entry (keys(%roleshash)) {
3831: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3832: if ($trole =~ /^cr/) {
3833: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3834: } else {
3835: next if (!exists($roles{$trole}));
3836: }
3837: if ($tend) {
3838: next if ($tend < $now);
3839: }
3840: if ($tstart) {
3841: next if ($tstart > $now);
3842: }
3843: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3844: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3845: if ($secpart eq '') {
3846: ($cnum,$role) = split(/_/,$cnumpart);
3847: $sec = 'none';
3848: $realsec = '';
3849: } else {
3850: $cnum = $cnumpart;
3851: ($sec,$role) = split(/_/,$secpart);
3852: $realsec = $sec;
1.490 raeburn 3853: }
1.482 raeburn 3854: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3855: }
3856: } else {
3857: foreach my $key (keys(%env)) {
1.483 albertel 3858: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3859: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3860: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3861: next if ($role eq 'ca' || $role eq 'aa');
3862: next if (%roles && !exists($roles{$role}));
3863: my ($starttime,$endtime)=split(/\./,$env{$key});
3864: my $active=1;
3865: if ($starttime) {
3866: if ($now<$starttime) { $active=0; }
3867: }
3868: if ($endtime) {
3869: if ($now>$endtime) { $active=0; }
3870: }
3871: if ($active) {
3872: if ($sec eq '') {
3873: $sec = 'none';
3874: }
3875: $courses{$cdom.'_'.$cnum}{$sec} =
3876: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3877: }
3878: }
1.51 www 3879: }
3880: }
1.474 raeburn 3881: return %courses;
1.51 www 3882: }
1.37 matthew 3883:
1.54 www 3884: ###############################################
1.474 raeburn 3885:
3886: sub blockcheck {
1.482 raeburn 3887: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3888:
3889: if (!defined($udom)) {
3890: $udom = $env{'user.domain'};
3891: }
3892: if (!defined($uname)) {
3893: $uname = $env{'user.name'};
3894: }
3895:
3896: # If uname and udom are for a course, check for blocks in the course.
3897:
3898: if (&Apache::lonnet::is_course($udom,$uname)) {
3899: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3900: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3901: return ($startblock,$endblock);
3902: }
1.474 raeburn 3903:
1.502 raeburn 3904: my $startblock = 0;
3905: my $endblock = 0;
1.482 raeburn 3906: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3907:
1.490 raeburn 3908: # If uname is for a user, and activity is course-specific, i.e.,
3909: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3910:
1.490 raeburn 3911: if (($activity eq 'boards' || $activity eq 'chat' ||
3912: $activity eq 'groups') && ($env{'request.course.id'})) {
3913: foreach my $key (keys(%live_courses)) {
3914: if ($key ne $env{'request.course.id'}) {
3915: delete($live_courses{$key});
3916: }
3917: }
3918: }
3919:
3920: my $otheruser = 0;
3921: my %own_courses;
3922: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3923: # Resource belongs to user other than current user.
3924: $otheruser = 1;
3925: # Gather courses for current user
3926: %own_courses =
3927: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3928: }
3929:
3930: # Gather active course roles - course coordinator, instructor,
3931: # exam proctor, ta, student, or custom role.
1.474 raeburn 3932:
3933: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3934: my ($cdom,$cnum);
3935: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3936: $cdom = $env{'course.'.$course.'.domain'};
3937: $cnum = $env{'course.'.$course.'.num'};
3938: } else {
1.490 raeburn 3939: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3940: }
3941: my $no_ownblock = 0;
3942: my $no_userblock = 0;
1.533 raeburn 3943: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3944: # Check if current user has 'evb' priv for this
3945: if (defined($own_courses{$course})) {
3946: foreach my $sec (keys(%{$own_courses{$course}})) {
3947: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3948: if ($sec ne 'none') {
3949: $checkrole .= '/'.$sec;
3950: }
3951: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3952: $no_ownblock = 1;
3953: last;
3954: }
3955: }
3956: }
3957: # if they have 'evb' priv and are currently not playing student
3958: next if (($no_ownblock) &&
3959: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3960: }
1.474 raeburn 3961: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3962: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3963: if ($sec ne 'none') {
1.482 raeburn 3964: $checkrole .= '/'.$sec;
1.474 raeburn 3965: }
1.490 raeburn 3966: if ($otheruser) {
3967: # Resource belongs to user other than current user.
3968: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3969: my ($trole,$tdom,$tnum,$tsec);
3970: my $entry = $live_courses{$course}{$sec};
3971: if ($entry =~ /^cr/) {
3972: ($trole,$tdom,$tnum,$tsec) =
3973: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3974: } else {
3975: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3976: }
3977: my ($spec,$area,$trest,%allroles,%userroles);
3978: $area = '/'.$tdom.'/'.$tnum;
3979: $trest = $tnum;
3980: if ($tsec ne '') {
3981: $area .= '/'.$tsec;
3982: $trest .= '/'.$tsec;
3983: }
3984: $spec = $trole.'.'.$area;
3985: if ($trole =~ /^cr/) {
3986: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3987: $tdom,$spec,$trest,$area);
3988: } else {
3989: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3990: $tdom,$spec,$trest,$area);
3991: }
3992: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3993: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3994: if ($1) {
3995: $no_userblock = 1;
3996: last;
3997: }
3998: }
1.490 raeburn 3999: } else {
4000: # Resource belongs to current user
4001: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4002: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4003: $no_ownblock = 1;
4004: last;
4005: }
1.474 raeburn 4006: }
4007: }
4008: # if they have the evb priv and are currently not playing student
1.482 raeburn 4009: next if (($no_ownblock) &&
1.491 albertel 4010: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4011: next if ($no_userblock);
1.474 raeburn 4012:
1.866 kalberla 4013: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4014: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4015:
4016: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4017: if (($start != 0) &&
4018: (($startblock == 0) || ($startblock > $start))) {
4019: $startblock = $start;
4020: }
4021: if (($end != 0) &&
4022: (($endblock == 0) || ($endblock < $end))) {
4023: $endblock = $end;
4024: }
1.490 raeburn 4025: }
4026: return ($startblock,$endblock);
4027: }
4028:
4029: sub get_blocks {
4030: my ($setters,$activity,$cdom,$cnum) = @_;
4031: my $startblock = 0;
4032: my $endblock = 0;
4033: my $course = $cdom.'_'.$cnum;
4034: $setters->{$course} = {};
4035: $setters->{$course}{'staff'} = [];
4036: $setters->{$course}{'times'} = [];
4037: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4038: foreach my $record (keys(%records)) {
4039: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4040: if ($start <= time && $end >= time) {
4041: my ($staff_name,$staff_dom,$title,$blocks) =
4042: &parse_block_record($records{$record});
4043: if ($blocks->{$activity} eq 'on') {
4044: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4045: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4046: if ( ($startblock == 0) || ($startblock > $start) ) {
4047: $startblock = $start;
1.490 raeburn 4048: }
1.491 albertel 4049: if ( ($endblock == 0) || ($endblock < $end) ) {
4050: $endblock = $end;
1.474 raeburn 4051: }
4052: }
4053: }
4054: }
4055: return ($startblock,$endblock);
4056: }
4057:
4058: sub parse_block_record {
4059: my ($record) = @_;
4060: my ($setuname,$setudom,$title,$blocks);
4061: if (ref($record) eq 'HASH') {
4062: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4063: $title = &unescape($record->{'event'});
4064: $blocks = $record->{'blocks'};
4065: } else {
4066: my @data = split(/:/,$record,3);
4067: if (scalar(@data) eq 2) {
4068: $title = $data[1];
4069: ($setuname,$setudom) = split(/@/,$data[0]);
4070: } else {
4071: ($setuname,$setudom,$title) = @data;
4072: }
4073: $blocks = { 'com' => 'on' };
4074: }
4075: return ($setuname,$setudom,$title,$blocks);
4076: }
4077:
1.854 kalberla 4078: sub blocking_status {
4079: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4080: my %setters;
1.890 droeschl 4081:
4082: # check for active blocking
1.867 kalberla 4083: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4084:
1.890 droeschl 4085: my $blocked = $startblock && $endblock ? 1 : 0;
4086:
4087: # caller just wants to know whether a block is active
4088: if (!wantarray) { return $blocked; }
4089:
4090: # build a link to a popup window containing the details
4091: my $querystring = "?activity=$activity";
4092: # $uname and $udom decide whose portfolio the user is trying to look at
4093: $querystring .= "&udom=$udom" if $udom;
4094: $querystring .= "&uname=$uname" if $uname;
4095:
4096: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4097: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4098: var options = "width=" + w + ",height=" + h + ",";
4099: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4100: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4101: var newWin = window.open(url, wdwName, options);
4102: newWin.focus();
4103: }
1.890 droeschl 4104: END_MYBLOCK
1.854 kalberla 4105:
1.890 droeschl 4106: $output = Apache::lonhtmlcommon::scripttag($output);
4107:
1.854 kalberla 4108: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4109: my $text = mt('Communication Blocked');
4110:
1.867 kalberla 4111: $output .= <<"END_BLOCK";
4112: <div class='LC_comblock'>
1.869 kalberla 4113: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4114: title='$text'>
4115: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4116: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4117: title='$text'>$text</a>
1.867 kalberla 4118: </div>
4119:
4120: END_BLOCK
1.474 raeburn 4121:
1.854 kalberla 4122: return ($blocked, $output);
4123: }
1.490 raeburn 4124:
1.60 matthew 4125: ###############################################
4126:
1.682 raeburn 4127: sub check_ip_acc {
4128: my ($acc)=@_;
4129: &Apache::lonxml::debug("acc is $acc");
4130: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4131: return 1;
4132: }
4133: my $allowed=0;
4134: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4135:
4136: my $name;
4137: foreach my $pattern (split(',',$acc)) {
4138: $pattern =~ s/^\s*//;
4139: $pattern =~ s/\s*$//;
4140: if ($pattern =~ /\*$/) {
4141: #35.8.*
4142: $pattern=~s/\*//;
4143: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4144: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4145: #35.8.3.[34-56]
4146: my $low=$2;
4147: my $high=$3;
4148: $pattern=$1;
4149: if ($ip =~ /^\Q$pattern\E/) {
4150: my $last=(split(/\./,$ip))[3];
4151: if ($last <=$high && $last >=$low) { $allowed=1; }
4152: }
4153: } elsif ($pattern =~ /^\*/) {
4154: #*.msu.edu
4155: $pattern=~s/\*//;
4156: if (!defined($name)) {
4157: use Socket;
4158: my $netaddr=inet_aton($ip);
4159: ($name)=gethostbyaddr($netaddr,AF_INET);
4160: }
4161: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4162: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4163: #127.0.0.1
4164: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4165: } else {
4166: #some.name.com
4167: if (!defined($name)) {
4168: use Socket;
4169: my $netaddr=inet_aton($ip);
4170: ($name)=gethostbyaddr($netaddr,AF_INET);
4171: }
4172: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4173: }
4174: if ($allowed) { last; }
4175: }
4176: return $allowed;
4177: }
4178:
4179: ###############################################
4180:
1.60 matthew 4181: =pod
4182:
1.112 bowersj2 4183: =head1 Domain Template Functions
4184:
4185: =over 4
4186:
4187: =item * &determinedomain()
1.60 matthew 4188:
4189: Inputs: $domain (usually will be undef)
4190:
1.63 www 4191: Returns: Determines which domain should be used for designs
1.60 matthew 4192:
4193: =cut
1.54 www 4194:
1.60 matthew 4195: ###############################################
1.63 www 4196: sub determinedomain {
4197: my $domain=shift;
1.531 albertel 4198: if (! $domain) {
1.60 matthew 4199: # Determine domain if we have not been given one
1.893 raeburn 4200: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4201: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4202: if ($env{'request.role.domain'}) {
4203: $domain=$env{'request.role.domain'};
1.60 matthew 4204: }
4205: }
1.63 www 4206: return $domain;
4207: }
4208: ###############################################
1.517 raeburn 4209:
1.518 albertel 4210: sub devalidate_domconfig_cache {
4211: my ($udom)=@_;
4212: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4213: }
4214:
4215: # ---------------------- Get domain configuration for a domain
4216: sub get_domainconf {
4217: my ($udom) = @_;
4218: my $cachetime=1800;
4219: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4220: if (defined($cached)) { return %{$result}; }
4221:
4222: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4223: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4224: my (%designhash,%legacy);
1.518 albertel 4225: if (keys(%domconfig) > 0) {
4226: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4227: if (keys(%{$domconfig{'login'}})) {
4228: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4229: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4230: if ($key eq 'loginvia') {
4231: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4232: my @ids = &Apache::lonnet::current_machine_ids();
4233: foreach my $hostname (@ids) {
1.948 raeburn 4234: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4235: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4236: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4237: $designhash{$udom.'.login.loginvia'} = $server;
4238: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4239:
4240: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4241: } else {
4242: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4243: }
4244: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4245: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4246: }
1.946 raeburn 4247: }
4248: }
4249: }
4250: }
4251: } else {
4252: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4253: $designhash{$udom.'.login.'.$key.'_'.$img} =
4254: $domconfig{'login'}{$key}{$img};
4255: }
1.699 raeburn 4256: }
4257: } else {
4258: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4259: }
1.632 raeburn 4260: }
4261: } else {
4262: $legacy{'login'} = 1;
1.518 albertel 4263: }
1.632 raeburn 4264: } else {
4265: $legacy{'login'} = 1;
1.518 albertel 4266: }
4267: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4268: if (keys(%{$domconfig{'rolecolors'}})) {
4269: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4270: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4271: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4272: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4273: }
1.518 albertel 4274: }
4275: }
1.632 raeburn 4276: } else {
4277: $legacy{'rolecolors'} = 1;
1.518 albertel 4278: }
1.632 raeburn 4279: } else {
4280: $legacy{'rolecolors'} = 1;
1.518 albertel 4281: }
1.948 raeburn 4282: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4283: if ($domconfig{'autoenroll'}{'co-owners'}) {
4284: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4285: }
4286: }
1.632 raeburn 4287: if (keys(%legacy) > 0) {
4288: my %legacyhash = &get_legacy_domconf($udom);
4289: foreach my $item (keys(%legacyhash)) {
4290: if ($item =~ /^\Q$udom\E\.login/) {
4291: if ($legacy{'login'}) {
4292: $designhash{$item} = $legacyhash{$item};
4293: }
4294: } else {
4295: if ($legacy{'rolecolors'}) {
4296: $designhash{$item} = $legacyhash{$item};
4297: }
1.518 albertel 4298: }
4299: }
4300: }
1.632 raeburn 4301: } else {
4302: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4303: }
4304: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4305: $cachetime);
4306: return %designhash;
4307: }
4308:
1.632 raeburn 4309: sub get_legacy_domconf {
4310: my ($udom) = @_;
4311: my %legacyhash;
4312: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4313: my $designfile = $designdir.'/'.$udom.'.tab';
4314: if (-e $designfile) {
4315: if ( open (my $fh,"<$designfile") ) {
4316: while (my $line = <$fh>) {
4317: next if ($line =~ /^\#/);
4318: chomp($line);
4319: my ($key,$val)=(split(/\=/,$line));
4320: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4321: }
4322: close($fh);
4323: }
4324: }
4325: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4326: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4327: }
4328: return %legacyhash;
4329: }
4330:
1.63 www 4331: =pod
4332:
1.112 bowersj2 4333: =item * &domainlogo()
1.63 www 4334:
4335: Inputs: $domain (usually will be undef)
4336:
4337: Returns: A link to a domain logo, if the domain logo exists.
4338: If the domain logo does not exist, a description of the domain.
4339:
4340: =cut
1.112 bowersj2 4341:
1.63 www 4342: ###############################################
4343: sub domainlogo {
1.517 raeburn 4344: my $domain = &determinedomain(shift);
1.518 albertel 4345: my %designhash = &get_domainconf($domain);
1.517 raeburn 4346: # See if there is a logo
4347: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4348: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4349: if ($imgsrc =~ m{^/(adm|res)/}) {
4350: if ($imgsrc =~ m{^/res/}) {
4351: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4352: &Apache::lonnet::repcopy($local_name);
4353: }
4354: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4355: }
4356: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4357: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4358: return &Apache::lonnet::domain($domain,'description');
1.59 www 4359: } else {
1.60 matthew 4360: return '';
1.59 www 4361: }
4362: }
1.63 www 4363: ##############################################
4364:
4365: =pod
4366:
1.112 bowersj2 4367: =item * &designparm()
1.63 www 4368:
4369: Inputs: $which parameter; $domain (usually will be undef)
4370:
4371: Returns: value of designparamter $which
4372:
4373: =cut
1.112 bowersj2 4374:
1.397 albertel 4375:
1.400 albertel 4376: ##############################################
1.397 albertel 4377: sub designparm {
4378: my ($which,$domain)=@_;
4379: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4380: return $env{'environment.color.'.$which};
1.96 www 4381: }
1.63 www 4382: $domain=&determinedomain($domain);
1.518 albertel 4383: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4384: my $output;
1.517 raeburn 4385: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4386: $output = $domdesign{$domain.'.'.$which};
1.63 www 4387: } else {
1.520 raeburn 4388: $output = $defaultdesign{$which};
4389: }
4390: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4391: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4392: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4393: if ($output =~ m{^/res/}) {
4394: my $local_name = &Apache::lonnet::filelocation('',$output);
4395: &Apache::lonnet::repcopy($local_name);
4396: }
1.520 raeburn 4397: $output = &lonhttpdurl($output);
4398: }
1.63 www 4399: }
1.520 raeburn 4400: return $output;
1.63 www 4401: }
1.59 www 4402:
1.822 bisitz 4403: ##############################################
4404: =pod
4405:
1.832 bisitz 4406: =item * &authorspace()
4407:
4408: Inputs: ./.
4409:
4410: Returns: Path to the Construction Space of the current user's
4411: accessed author space
4412: The author space will be that of the current user
4413: when accessing the own author space
4414: and that of the co-author/assistent co-author
4415: when accessing the co-author's/assistent co-author's
4416: space
4417:
4418: =cut
4419:
4420: sub authorspace {
4421: my $caname = '';
4422: if ($env{'request.role'} =~ /^ca|^aa/) {
4423: (undef,$caname) =
4424: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4425: } else {
4426: $caname = $env{'user.name'};
4427: }
4428: return '/priv/'.$caname.'/';
4429: }
4430:
4431: ##############################################
4432: =pod
4433:
1.822 bisitz 4434: =item * &head_subbox()
4435:
4436: Inputs: $content (contains HTML code with page functions, etc.)
4437:
4438: Returns: HTML div with $content
4439: To be included in page header
4440:
4441: =cut
4442:
4443: sub head_subbox {
4444: my ($content)=@_;
4445: my $output =
1.844 bisitz 4446: '<div id="LC_head_subbox">'
1.822 bisitz 4447: .$content
4448: .'</div>'
4449: }
4450:
4451: ##############################################
4452: =pod
4453:
4454: =item * &CSTR_pageheader()
4455:
4456: Inputs: ./.
4457:
4458: Returns: HTML div with CSTR path and recent box
4459: To be included on Construction Space pages
4460:
4461: =cut
4462:
4463: sub CSTR_pageheader {
4464: # this is for resources; directories have customtitle, and crumbs
4465: # and select recent are created in lonpubdir.pm
4466: my ($uname,$thisdisfn)=
4467: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4468: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4469: $formaction=~s/\/+/\//g;
4470:
4471: my $parentpath = '';
4472: my $lastitem = '';
4473: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4474: $parentpath = $1;
4475: $lastitem = $2;
4476: } else {
4477: $lastitem = $thisdisfn;
4478: }
1.921 bisitz 4479:
4480: my $output =
1.822 bisitz 4481: '<div>'
4482: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4483: .'<b>'.&mt('Construction Space:').'</b> '
4484: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4485: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4486: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4487:
4488: if ($lastitem) {
4489: $output .=
4490: '<span class="LC_filename">'
4491: .$lastitem
4492: .'</span>';
4493: }
4494: $output .=
4495: '<br />'
1.822 bisitz 4496: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4497: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4498: .'</form>'
4499: .&Apache::lonmenu::constspaceform()
4500: .'</div>';
1.921 bisitz 4501:
4502: return $output;
1.822 bisitz 4503: }
4504:
1.60 matthew 4505: ###############################################
4506: ###############################################
4507:
4508: =pod
4509:
1.112 bowersj2 4510: =back
4511:
1.549 albertel 4512: =head1 HTML Helpers
1.112 bowersj2 4513:
4514: =over 4
4515:
4516: =item * &bodytag()
1.60 matthew 4517:
4518: Returns a uniform header for LON-CAPA web pages.
4519:
4520: Inputs:
4521:
1.112 bowersj2 4522: =over 4
4523:
4524: =item * $title, A title to be displayed on the page.
4525:
4526: =item * $function, the current role (can be undef).
4527:
4528: =item * $addentries, extra parameters for the <body> tag.
4529:
4530: =item * $bodyonly, if defined, only return the <body> tag.
4531:
4532: =item * $domain, if defined, force a given domain.
4533:
4534: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4535: text interface only)
1.60 matthew 4536:
1.814 bisitz 4537: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4538: navigational links
1.317 albertel 4539:
1.338 albertel 4540: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4541:
1.460 albertel 4542: =item * $args, optional argument valid values are
4543: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4544: inherit_jsmath -> when creating popup window in a page,
4545: should it have jsmath forced on by the
4546: current page
1.460 albertel 4547:
1.112 bowersj2 4548: =back
4549:
1.60 matthew 4550: Returns: A uniform header for LON-CAPA web pages.
4551: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4552: If $bodyonly is undef or zero, an html string containing a <body> tag and
4553: other decorations will be returned.
4554:
4555: =cut
4556:
1.54 www 4557: sub bodytag {
1.831 bisitz 4558: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4559: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4560:
1.954 raeburn 4561: my $public;
4562: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4563: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4564: $public = 1;
4565: }
1.460 albertel 4566: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4567:
1.183 matthew 4568: $function = &get_users_function() if (!$function);
1.339 albertel 4569: my $img = &designparm($function.'.img',$domain);
4570: my $font = &designparm($function.'.font',$domain);
4571: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4572:
1.803 bisitz 4573: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4574: 'bgcolor' => $pgbg,
1.339 albertel 4575: 'text' => $font,
4576: 'alink' => &designparm($function.'.alink',$domain),
4577: 'vlink' => &designparm($function.'.vlink',$domain),
4578: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4579: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4580:
1.63 www 4581: # role and realm
1.378 raeburn 4582: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4583: if ($role eq 'ca') {
1.479 albertel 4584: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4585: $realm = &plainname($rname,$rdom);
1.378 raeburn 4586: }
1.55 www 4587: # realm
1.258 albertel 4588: if ($env{'request.course.id'}) {
1.378 raeburn 4589: if ($env{'request.role'} !~ /^cr/) {
4590: $role = &Apache::lonnet::plaintext($role,&course_type());
4591: }
1.898 raeburn 4592: if ($env{'request.course.sec'}) {
4593: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4594: }
1.359 albertel 4595: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4596: } else {
4597: $role = &Apache::lonnet::plaintext($role);
1.54 www 4598: }
1.433 albertel 4599:
1.359 albertel 4600: if (!$realm) { $realm=' '; }
1.330 albertel 4601:
1.438 albertel 4602: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4603:
1.101 www 4604: # construct main body tag
1.359 albertel 4605: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4606: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4607:
1.530 albertel 4608: if ($bodyonly) {
1.60 matthew 4609: return $bodytag;
1.798 tempelho 4610: }
1.359 albertel 4611:
1.410 albertel 4612: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4613: if ($public) {
1.433 albertel 4614: undef($role);
1.434 albertel 4615: } else {
4616: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4617: }
1.359 albertel 4618:
1.762 bisitz 4619: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4620: #
4621: # Extra info if you are the DC
4622: my $dc_info = '';
4623: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4624: $env{'course.'.$env{'request.course.id'}.
4625: '.domain'}.'/'})) {
4626: my $cid = $env{'request.course.id'};
1.917 raeburn 4627: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4628: $dc_info =~ s/\s+$//;
1.359 albertel 4629: }
4630:
1.898 raeburn 4631: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4632: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4633:
1.916 droeschl 4634: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4635: return $bodytag;
4636: }
1.903 droeschl 4637:
4638: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4639:
4640: # if ($env{'request.state'} eq 'construct') {
4641: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4642: # }
4643:
1.359 albertel 4644:
4645:
1.916 droeschl 4646: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4647: if ($dc_info) {
4648: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4649: }
1.916 droeschl 4650: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4651: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4652: return $bodytag;
4653: }
1.894 droeschl 4654:
1.927 raeburn 4655: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4656: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4657: }
1.916 droeschl 4658:
1.903 droeschl 4659: $bodytag .= Apache::lonhtmlcommon::scripttag(
4660: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4661:
1.903 droeschl 4662: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4663:
1.917 raeburn 4664: if ($dc_info) {
4665: $dc_info = &dc_courseid_toggle($dc_info);
4666: }
4667: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4668:
1.903 droeschl 4669: #don't show menus for public users
1.954 raeburn 4670: if (!$public){
1.903 droeschl 4671: $bodytag .= Apache::lonmenu::secondary_menu();
4672: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4673: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4674: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4675: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4676: $args->{'bread_crumbs'});
4677: } elsif ($forcereg) {
4678: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4679: }
1.903 droeschl 4680: }else{
4681: # this is to seperate menu from content when there's no secondary
4682: # menu. Especially needed for public accessible ressources.
4683: $bodytag .= '<hr style="clear:both" />';
4684: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4685: }
1.903 droeschl 4686:
1.235 raeburn 4687: return $bodytag;
1.182 matthew 4688: }
4689:
1.917 raeburn 4690: sub dc_courseid_toggle {
4691: my ($dc_info) = @_;
4692: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4693: '<a href="javascript:showCourseID();">'.
4694: &mt('(More ...)').'</a></span>'.
4695: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4696: }
4697:
1.330 albertel 4698: sub make_attr_string {
4699: my ($register,$attr_ref) = @_;
4700:
4701: if ($attr_ref && !ref($attr_ref)) {
4702: die("addentries Must be a hash ref ".
4703: join(':',caller(1))." ".
4704: join(':',caller(0))." ");
4705: }
4706:
4707: if ($register) {
1.339 albertel 4708: my ($on_load,$on_unload);
4709: foreach my $key (keys(%{$attr_ref})) {
4710: if (lc($key) eq 'onload') {
4711: $on_load.=$attr_ref->{$key}.';';
4712: delete($attr_ref->{$key});
4713:
4714: } elsif (lc($key) eq 'onunload') {
4715: $on_unload.=$attr_ref->{$key}.';';
4716: delete($attr_ref->{$key});
4717: }
4718: }
1.953 droeschl 4719: $attr_ref->{'onload'} = $on_load;
4720: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4721: }
1.339 albertel 4722:
1.330 albertel 4723: my $attr_string;
4724: foreach my $attr (keys(%$attr_ref)) {
4725: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4726: }
4727: return $attr_string;
4728: }
4729:
4730:
1.182 matthew 4731: ###############################################
1.251 albertel 4732: ###############################################
4733:
4734: =pod
4735:
4736: =item * &endbodytag()
4737:
4738: Returns a uniform footer for LON-CAPA web pages.
4739:
1.635 raeburn 4740: Inputs: 1 - optional reference to an args hash
4741: If in the hash, key for noredirectlink has a value which evaluates to true,
4742: a 'Continue' link is not displayed if the page contains an
4743: internal redirect in the <head></head> section,
4744: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4745:
4746: =cut
4747:
4748: sub endbodytag {
1.635 raeburn 4749: my ($args) = @_;
1.251 albertel 4750: my $endbodytag='</body>';
1.269 albertel 4751: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4752: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4753: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4754: $endbodytag=
4755: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4756: &mt('Continue').'</a>'.
4757: $endbodytag;
4758: }
1.315 albertel 4759: }
1.251 albertel 4760: return $endbodytag;
4761: }
4762:
1.352 albertel 4763: =pod
4764:
4765: =item * &standard_css()
4766:
4767: Returns a style sheet
4768:
4769: Inputs: (all optional)
4770: domain -> force to color decorate a page for a specific
4771: domain
4772: function -> force usage of a specific rolish color scheme
4773: bgcolor -> override the default page bgcolor
4774:
4775: =cut
4776:
1.343 albertel 4777: sub standard_css {
1.345 albertel 4778: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4779: $function = &get_users_function() if (!$function);
4780: my $img = &designparm($function.'.img', $domain);
4781: my $tabbg = &designparm($function.'.tabbg', $domain);
4782: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4783: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4784: #second colour for later usage
1.345 albertel 4785: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4786: my $pgbg_or_bgcolor =
4787: $bgcolor ||
1.352 albertel 4788: &designparm($function.'.pgbg', $domain);
1.382 albertel 4789: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4790: my $alink = &designparm($function.'.alink', $domain);
4791: my $vlink = &designparm($function.'.vlink', $domain);
4792: my $link = &designparm($function.'.link', $domain);
4793:
1.704 muellerd 4794: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4795: my $bgcol = &designparm('login.bgcol',$domain);
4796: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4797:
1.602 albertel 4798: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4799: my $mono = 'monospace';
1.850 bisitz 4800: my $data_table_head = $sidebg;
4801: my $data_table_light = '#FAFAFA';
4802: my $data_table_dark = '#F0F0F0';
1.470 banghart 4803: my $data_table_darker = '#CCCCCC';
1.349 albertel 4804: my $data_table_highlight = '#FFFF00';
1.352 albertel 4805: my $mail_new = '#FFBB77';
4806: my $mail_new_hover = '#DD9955';
4807: my $mail_read = '#BBBB77';
4808: my $mail_read_hover = '#999944';
4809: my $mail_replied = '#AAAA88';
4810: my $mail_replied_hover = '#888855';
4811: my $mail_other = '#99BBBB';
4812: my $mail_other_hover = '#669999';
1.391 albertel 4813: my $table_header = '#DDDDDD';
1.489 raeburn 4814: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4815: my $lg_border_color = '#C8C8C8';
1.952 onken 4816: my $button_hover = '#BF2317';
1.392 albertel 4817:
1.608 albertel 4818: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4819: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4820: : '0 3px 0 4px';
1.448 albertel 4821:
1.523 albertel 4822:
1.343 albertel 4823: return <<END;
1.947 droeschl 4824:
4825: /* needed for iframe to allow 100% height in FF */
4826: body, html {
4827: margin: 0;
4828: padding: 0 0.5%;
4829: height: 99%; /* to avoid scrollbars */
4830: }
4831:
1.795 www 4832: body {
1.911 bisitz 4833: font-family: $sans;
4834: line-height:130%;
4835: font-size:0.83em;
4836: color:$font;
1.795 www 4837: }
4838:
1.959 onken 4839: a:focus,
4840: a:focus img {
1.795 www 4841: color: red;
1.911 bisitz 4842: background: yellow;
1.795 www 4843: }
1.698 harmsja 4844:
1.911 bisitz 4845: form, .inline {
4846: display: inline;
1.795 www 4847: }
1.721 harmsja 4848:
1.795 www 4849: .LC_right {
1.911 bisitz 4850: text-align:right;
1.795 www 4851: }
4852:
4853: .LC_middle {
1.911 bisitz 4854: vertical-align:middle;
1.795 www 4855: }
1.721 harmsja 4856:
1.911 bisitz 4857: .LC_400Box {
4858: width:400px;
4859: }
1.721 harmsja 4860:
1.947 droeschl 4861: .LC_iframecontainer {
4862: width: 98%;
4863: margin: 0;
4864: position: fixed;
4865: top: 8.5em;
4866: bottom: 0;
4867: }
4868:
4869: .LC_iframecontainer iframe{
4870: border: none;
4871: width: 100%;
4872: height: 100%;
4873: }
4874:
1.778 bisitz 4875: .LC_filename {
4876: font-family: $mono;
4877: white-space:pre;
1.921 bisitz 4878: font-size: 120%;
1.778 bisitz 4879: }
4880:
4881: .LC_fileicon {
4882: border: none;
4883: height: 1.3em;
4884: vertical-align: text-bottom;
4885: margin-right: 0.3em;
4886: text-decoration:none;
4887: }
4888:
1.350 albertel 4889: .LC_error {
4890: color: red;
4891: font-size: larger;
4892: }
1.795 www 4893:
1.457 albertel 4894: .LC_warning,
4895: .LC_diff_removed {
1.733 bisitz 4896: color: red;
1.394 albertel 4897: }
1.532 albertel 4898:
4899: .LC_info,
1.457 albertel 4900: .LC_success,
4901: .LC_diff_added {
1.350 albertel 4902: color: green;
4903: }
1.795 www 4904:
1.802 bisitz 4905: div.LC_confirm_box {
4906: background-color: #FAFAFA;
4907: border: 1px solid $lg_border_color;
4908: margin-right: 0;
4909: padding: 5px;
4910: }
4911:
4912: div.LC_confirm_box .LC_error img,
4913: div.LC_confirm_box .LC_success img {
4914: vertical-align: middle;
4915: }
4916:
1.440 albertel 4917: .LC_icon {
1.771 droeschl 4918: border: none;
1.790 droeschl 4919: vertical-align: middle;
1.771 droeschl 4920: }
4921:
1.543 albertel 4922: .LC_docs_spacer {
4923: width: 25px;
4924: height: 1px;
1.771 droeschl 4925: border: none;
1.543 albertel 4926: }
1.346 albertel 4927:
1.532 albertel 4928: .LC_internal_info {
1.735 bisitz 4929: color: #999999;
1.532 albertel 4930: }
4931:
1.794 www 4932: .LC_discussion {
1.911 bisitz 4933: background: $tabbg;
4934: border: 1px solid black;
4935: margin: 2px;
1.794 www 4936: }
4937:
4938: .LC_disc_action_links_bar {
1.911 bisitz 4939: background: $tabbg;
4940: border: none;
4941: margin: 4px;
1.794 www 4942: }
4943:
4944: .LC_disc_action_left {
1.911 bisitz 4945: text-align: left;
1.794 www 4946: }
4947:
4948: .LC_disc_action_right {
1.911 bisitz 4949: text-align: right;
1.794 www 4950: }
4951:
4952: .LC_disc_new_item {
1.911 bisitz 4953: background: white;
4954: border: 2px solid red;
4955: margin: 2px;
1.794 www 4956: }
4957:
4958: .LC_disc_old_item {
1.911 bisitz 4959: background: white;
4960: border: 1px solid black;
4961: margin: 2px;
1.794 www 4962: }
4963:
1.458 albertel 4964: table.LC_pastsubmission {
4965: border: 1px solid black;
4966: margin: 2px;
4967: }
4968:
1.924 bisitz 4969: table#LC_menubuttons {
1.345 albertel 4970: width: 100%;
4971: background: $pgbg;
1.392 albertel 4972: border: 2px;
1.402 albertel 4973: border-collapse: separate;
1.803 bisitz 4974: padding: 0;
1.345 albertel 4975: }
1.392 albertel 4976:
1.801 tempelho 4977: table#LC_title_bar a {
4978: color: $fontmenu;
4979: }
1.836 bisitz 4980:
1.807 droeschl 4981: table#LC_title_bar {
1.819 tempelho 4982: clear: both;
1.836 bisitz 4983: display: none;
1.807 droeschl 4984: }
4985:
1.795 www 4986: table#LC_title_bar,
1.933 droeschl 4987: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4988: table#LC_title_bar.LC_with_remote {
1.359 albertel 4989: width: 100%;
1.392 albertel 4990: border-color: $pgbg;
4991: border-style: solid;
4992: border-width: $border;
1.379 albertel 4993: background: $pgbg;
1.801 tempelho 4994: color: $fontmenu;
1.392 albertel 4995: border-collapse: collapse;
1.803 bisitz 4996: padding: 0;
1.819 tempelho 4997: margin: 0;
1.359 albertel 4998: }
1.795 www 4999:
1.933 droeschl 5000: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5001: margin: 0;
5002: padding: 0;
1.933 droeschl 5003: position: relative;
5004: list-style: none;
1.913 droeschl 5005: }
1.933 droeschl 5006: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5007: display: inline;
5008: }
1.933 droeschl 5009:
5010: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5011: padding: 0;
1.933 droeschl 5012: margin: 0;
5013: float: left;
1.913 droeschl 5014: }
1.933 droeschl 5015: .LC_breadcrumb_tools_tools {
5016: padding: 0;
5017: margin: 0;
1.913 droeschl 5018: float: right;
5019: }
5020:
1.359 albertel 5021: table#LC_title_bar td {
5022: background: $tabbg;
5023: }
1.795 www 5024:
1.911 bisitz 5025: table#LC_menubuttons img {
1.803 bisitz 5026: border: none;
1.346 albertel 5027: }
1.795 www 5028:
1.842 droeschl 5029: .LC_breadcrumbs_component {
1.911 bisitz 5030: float: right;
5031: margin: 0 1em;
1.357 albertel 5032: }
1.842 droeschl 5033: .LC_breadcrumbs_component img {
1.911 bisitz 5034: vertical-align: middle;
1.777 tempelho 5035: }
1.795 www 5036:
1.383 albertel 5037: td.LC_table_cell_checkbox {
5038: text-align: center;
5039: }
1.795 www 5040:
5041: .LC_fontsize_small {
1.911 bisitz 5042: font-size: 70%;
1.705 tempelho 5043: }
5044:
1.844 bisitz 5045: #LC_breadcrumbs {
1.911 bisitz 5046: clear:both;
5047: background: $sidebg;
5048: border-bottom: 1px solid $lg_border_color;
5049: line-height: 2.5em;
1.933 droeschl 5050: overflow: hidden;
1.911 bisitz 5051: margin: 0;
5052: padding: 0;
1.819 tempelho 5053: }
1.862 bisitz 5054:
1.844 bisitz 5055: #LC_head_subbox {
1.911 bisitz 5056: clear:both;
5057: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5058: border: 1px solid $sidebg;
5059: margin: 0 0 10px 0;
1.822 bisitz 5060: }
5061:
1.795 www 5062: .LC_fontsize_medium {
1.911 bisitz 5063: font-size: 85%;
1.705 tempelho 5064: }
5065:
1.795 www 5066: .LC_fontsize_large {
1.911 bisitz 5067: font-size: 120%;
1.705 tempelho 5068: }
5069:
1.346 albertel 5070: .LC_menubuttons_inline_text {
5071: color: $font;
1.698 harmsja 5072: font-size: 90%;
1.701 harmsja 5073: padding-left:3px;
1.346 albertel 5074: }
5075:
1.934 droeschl 5076: .LC_menubuttons_inline_text img{
5077: vertical-align: middle;
5078: }
5079:
1.951 onken 5080: li.LC_menubuttons_inline_text img,a {
5081: cursor:pointer;
5082: }
5083:
1.526 www 5084: .LC_menubuttons_link {
5085: text-decoration: none;
5086: }
1.795 www 5087:
1.522 albertel 5088: .LC_menubuttons_category {
1.521 www 5089: color: $font;
1.526 www 5090: background: $pgbg;
1.521 www 5091: font-size: larger;
5092: font-weight: bold;
5093: }
5094:
1.346 albertel 5095: td.LC_menubuttons_text {
1.911 bisitz 5096: color: $font;
1.346 albertel 5097: }
1.706 harmsja 5098:
1.346 albertel 5099: .LC_current_location {
5100: background: $tabbg;
5101: }
1.795 www 5102:
1.938 bisitz 5103: table.LC_data_table {
1.347 albertel 5104: border: 1px solid #000000;
1.402 albertel 5105: border-collapse: separate;
1.426 albertel 5106: border-spacing: 1px;
1.610 albertel 5107: background: $pgbg;
1.347 albertel 5108: }
1.795 www 5109:
1.422 albertel 5110: .LC_data_table_dense {
5111: font-size: small;
5112: }
1.795 www 5113:
1.507 raeburn 5114: table.LC_nested_outer {
5115: border: 1px solid #000000;
1.589 raeburn 5116: border-collapse: collapse;
1.803 bisitz 5117: border-spacing: 0;
1.507 raeburn 5118: width: 100%;
5119: }
1.795 www 5120:
1.879 raeburn 5121: table.LC_innerpickbox,
1.507 raeburn 5122: table.LC_nested {
1.803 bisitz 5123: border: none;
1.589 raeburn 5124: border-collapse: collapse;
1.803 bisitz 5125: border-spacing: 0;
1.507 raeburn 5126: width: 100%;
5127: }
1.795 www 5128:
1.930 faziophi 5129: .ui-accordion,
5130: .ui-accordion table.LC_data_table,
5131: .ui-accordion table.LC_nested_outer{
5132: border: 0px;
5133: border-spacing: 0px;
5134: margin: 3px;
5135: }
5136:
1.911 bisitz 5137: table.LC_data_table tr th,
5138: table.LC_calendar tr th,
1.879 raeburn 5139: table.LC_prior_tries tr th,
5140: table.LC_innerpickbox tr th {
1.349 albertel 5141: font-weight: bold;
5142: background-color: $data_table_head;
1.801 tempelho 5143: color:$fontmenu;
1.701 harmsja 5144: font-size:90%;
1.347 albertel 5145: }
1.795 www 5146:
1.879 raeburn 5147: table.LC_innerpickbox tr th,
5148: table.LC_innerpickbox tr td {
5149: vertical-align: top;
5150: }
5151:
1.711 raeburn 5152: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5153: background-color: #CCCCCC;
1.711 raeburn 5154: font-weight: bold;
5155: text-align: left;
5156: }
1.795 www 5157:
1.912 bisitz 5158: table.LC_data_table tr.LC_odd_row > td {
5159: background-color: $data_table_light;
5160: padding: 2px;
5161: vertical-align: top;
5162: }
5163:
1.809 bisitz 5164: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5165: background-color: $data_table_light;
1.912 bisitz 5166: vertical-align: top;
5167: }
5168:
5169: table.LC_data_table tr.LC_even_row > td {
5170: background-color: $data_table_dark;
1.425 albertel 5171: padding: 2px;
1.900 bisitz 5172: vertical-align: top;
1.347 albertel 5173: }
1.795 www 5174:
1.809 bisitz 5175: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5176: background-color: $data_table_dark;
1.900 bisitz 5177: vertical-align: top;
1.347 albertel 5178: }
1.795 www 5179:
1.425 albertel 5180: table.LC_data_table tr.LC_data_table_highlight td {
5181: background-color: $data_table_darker;
5182: }
1.795 www 5183:
1.639 raeburn 5184: table.LC_data_table tr td.LC_leftcol_header {
5185: background-color: $data_table_head;
5186: font-weight: bold;
5187: }
1.795 www 5188:
1.451 albertel 5189: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5190: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5191: font-weight: bold;
5192: font-style: italic;
5193: text-align: center;
5194: padding: 8px;
1.347 albertel 5195: }
1.795 www 5196:
1.940 bisitz 5197: table.LC_data_table tr.LC_empty_row td {
5198: background-color: $sidebg;
5199: }
5200:
5201: table.LC_nested tr.LC_empty_row td {
5202: background-color: #FFFFFF;
5203: }
5204:
1.890 droeschl 5205: table.LC_caption {
5206: }
5207:
1.507 raeburn 5208: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5209: padding: 4ex
5210: }
1.795 www 5211:
1.507 raeburn 5212: table.LC_nested_outer tr th {
5213: font-weight: bold;
1.801 tempelho 5214: color:$fontmenu;
1.507 raeburn 5215: background-color: $data_table_head;
1.701 harmsja 5216: font-size: small;
1.507 raeburn 5217: border-bottom: 1px solid #000000;
5218: }
1.795 www 5219:
1.507 raeburn 5220: table.LC_nested_outer tr td.LC_subheader {
5221: background-color: $data_table_head;
5222: font-weight: bold;
5223: font-size: small;
5224: border-bottom: 1px solid #000000;
5225: text-align: right;
1.451 albertel 5226: }
1.795 www 5227:
1.507 raeburn 5228: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5229: background-color: #CCCCCC;
1.451 albertel 5230: font-weight: bold;
5231: font-size: small;
1.507 raeburn 5232: text-align: center;
5233: }
1.795 www 5234:
1.589 raeburn 5235: table.LC_nested tr.LC_info_row td.LC_left_item,
5236: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5237: text-align: left;
1.451 albertel 5238: }
1.795 www 5239:
1.507 raeburn 5240: table.LC_nested td {
1.735 bisitz 5241: background-color: #FFFFFF;
1.451 albertel 5242: font-size: small;
1.507 raeburn 5243: }
1.795 www 5244:
1.507 raeburn 5245: table.LC_nested_outer tr th.LC_right_item,
5246: table.LC_nested tr.LC_info_row td.LC_right_item,
5247: table.LC_nested tr.LC_odd_row td.LC_right_item,
5248: table.LC_nested tr td.LC_right_item {
1.451 albertel 5249: text-align: right;
5250: }
5251:
1.930 faziophi 5252: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5253: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5254: text-align: right;
5255: width: 40%;
5256: padding-right:10px;
5257: vertical-align: top;
5258: padding: 5px;
5259: }
5260:
5261: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5262: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5263: text-align: left;
5264: width: 60%;
5265: padding: 2px 4px;
5266: }
5267:
1.507 raeburn 5268: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5269: background-color: #EEEEEE;
1.451 albertel 5270: }
5271:
1.473 raeburn 5272: table.LC_createuser {
5273: }
5274:
5275: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5276: font-size: small;
1.473 raeburn 5277: }
5278:
5279: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5280: background-color: #CCCCCC;
1.473 raeburn 5281: font-weight: bold;
5282: text-align: center;
5283: }
5284:
1.349 albertel 5285: table.LC_calendar {
5286: border: 1px solid #000000;
5287: border-collapse: collapse;
1.917 raeburn 5288: width: 98%;
1.349 albertel 5289: }
1.795 www 5290:
1.349 albertel 5291: table.LC_calendar_pickdate {
5292: font-size: xx-small;
5293: }
1.795 www 5294:
1.349 albertel 5295: table.LC_calendar tr td {
5296: border: 1px solid #000000;
5297: vertical-align: top;
1.917 raeburn 5298: width: 14%;
1.349 albertel 5299: }
1.795 www 5300:
1.349 albertel 5301: table.LC_calendar tr td.LC_calendar_day_empty {
5302: background-color: $data_table_dark;
5303: }
1.795 www 5304:
1.779 bisitz 5305: table.LC_calendar tr td.LC_calendar_day_current {
5306: background-color: $data_table_highlight;
1.777 tempelho 5307: }
1.795 www 5308:
1.938 bisitz 5309: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5310: background-color: $mail_new;
5311: }
1.795 www 5312:
1.938 bisitz 5313: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5314: background-color: $mail_new_hover;
5315: }
1.795 www 5316:
1.938 bisitz 5317: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5318: background-color: $mail_read;
5319: }
1.795 www 5320:
1.938 bisitz 5321: /*
5322: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5323: background-color: $mail_read_hover;
5324: }
1.938 bisitz 5325: */
1.795 www 5326:
1.938 bisitz 5327: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5328: background-color: $mail_replied;
5329: }
1.795 www 5330:
1.938 bisitz 5331: /*
5332: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5333: background-color: $mail_replied_hover;
5334: }
1.938 bisitz 5335: */
1.795 www 5336:
1.938 bisitz 5337: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5338: background-color: $mail_other;
5339: }
1.795 www 5340:
1.938 bisitz 5341: /*
5342: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5343: background-color: $mail_other_hover;
5344: }
1.938 bisitz 5345: */
1.494 raeburn 5346:
1.777 tempelho 5347: table.LC_data_table tr > td.LC_browser_file,
5348: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5349: background: #AAEE77;
1.389 albertel 5350: }
1.795 www 5351:
1.777 tempelho 5352: table.LC_data_table tr > td.LC_browser_file_locked,
5353: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5354: background: #FFAA99;
1.387 albertel 5355: }
1.795 www 5356:
1.777 tempelho 5357: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5358: background: #888888;
1.779 bisitz 5359: }
1.795 www 5360:
1.777 tempelho 5361: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5362: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5363: background: #F8F866;
1.777 tempelho 5364: }
1.795 www 5365:
1.696 bisitz 5366: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5367: background: #E0E8FF;
1.387 albertel 5368: }
1.696 bisitz 5369:
1.707 bisitz 5370: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5371: /* background: #77FF77; */
1.707 bisitz 5372: }
1.795 www 5373:
1.707 bisitz 5374: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5375: border-right: 8px solid #FFFF77;
1.707 bisitz 5376: }
1.795 www 5377:
1.707 bisitz 5378: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5379: border-right: 8px solid #FFAA77;
1.707 bisitz 5380: }
1.795 www 5381:
1.707 bisitz 5382: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5383: border-right: 8px solid #FF7777;
1.707 bisitz 5384: }
1.795 www 5385:
1.707 bisitz 5386: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5387: border-right: 8px solid #AAFF77;
1.707 bisitz 5388: }
1.795 www 5389:
1.707 bisitz 5390: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5391: border-right: 8px solid #11CC55;
1.707 bisitz 5392: }
5393:
1.388 albertel 5394: span.LC_current_location {
1.701 harmsja 5395: font-size:larger;
1.388 albertel 5396: background: $pgbg;
5397: }
1.387 albertel 5398:
1.395 albertel 5399: span.LC_parm_menu_item {
5400: font-size: larger;
5401: }
1.795 www 5402:
1.395 albertel 5403: span.LC_parm_scope_all {
5404: color: red;
5405: }
1.795 www 5406:
1.395 albertel 5407: span.LC_parm_scope_folder {
5408: color: green;
5409: }
1.795 www 5410:
1.395 albertel 5411: span.LC_parm_scope_resource {
5412: color: orange;
5413: }
1.795 www 5414:
1.395 albertel 5415: span.LC_parm_part {
5416: color: blue;
5417: }
1.795 www 5418:
1.911 bisitz 5419: span.LC_parm_folder,
5420: span.LC_parm_symb {
1.395 albertel 5421: font-size: x-small;
5422: font-family: $mono;
5423: color: #AAAAAA;
5424: }
5425:
1.795 www 5426: td.LC_parm_overview_level_menu,
5427: td.LC_parm_overview_map_menu,
5428: td.LC_parm_overview_parm_selectors,
5429: td.LC_parm_overview_restrictions {
1.396 albertel 5430: border: 1px solid black;
5431: border-collapse: collapse;
5432: }
1.795 www 5433:
1.396 albertel 5434: table.LC_parm_overview_restrictions td {
5435: border-width: 1px 4px 1px 4px;
5436: border-style: solid;
5437: border-color: $pgbg;
5438: text-align: center;
5439: }
1.795 www 5440:
1.396 albertel 5441: table.LC_parm_overview_restrictions th {
5442: background: $tabbg;
5443: border-width: 1px 4px 1px 4px;
5444: border-style: solid;
5445: border-color: $pgbg;
5446: }
1.795 www 5447:
1.398 albertel 5448: table#LC_helpmenu {
1.803 bisitz 5449: border: none;
1.398 albertel 5450: height: 55px;
1.803 bisitz 5451: border-spacing: 0;
1.398 albertel 5452: }
5453:
5454: table#LC_helpmenu fieldset legend {
5455: font-size: larger;
5456: }
1.795 www 5457:
1.397 albertel 5458: table#LC_helpmenu_links {
5459: width: 100%;
5460: border: 1px solid black;
5461: background: $pgbg;
1.803 bisitz 5462: padding: 0;
1.397 albertel 5463: border-spacing: 1px;
5464: }
1.795 www 5465:
1.397 albertel 5466: table#LC_helpmenu_links tr td {
5467: padding: 1px;
5468: background: $tabbg;
1.399 albertel 5469: text-align: center;
5470: font-weight: bold;
1.397 albertel 5471: }
1.396 albertel 5472:
1.795 www 5473: table#LC_helpmenu_links a:link,
5474: table#LC_helpmenu_links a:visited,
1.397 albertel 5475: table#LC_helpmenu_links a:active {
5476: text-decoration: none;
5477: color: $font;
5478: }
1.795 www 5479:
1.397 albertel 5480: table#LC_helpmenu_links a:hover {
5481: text-decoration: underline;
5482: color: $vlink;
5483: }
1.396 albertel 5484:
1.417 albertel 5485: .LC_chrt_popup_exists {
5486: border: 1px solid #339933;
5487: margin: -1px;
5488: }
1.795 www 5489:
1.417 albertel 5490: .LC_chrt_popup_up {
5491: border: 1px solid yellow;
5492: margin: -1px;
5493: }
1.795 www 5494:
1.417 albertel 5495: .LC_chrt_popup {
5496: border: 1px solid #8888FF;
5497: background: #CCCCFF;
5498: }
1.795 www 5499:
1.421 albertel 5500: table.LC_pick_box {
5501: border-collapse: separate;
5502: background: white;
5503: border: 1px solid black;
5504: border-spacing: 1px;
5505: }
1.795 www 5506:
1.421 albertel 5507: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5508: background: $sidebg;
1.421 albertel 5509: font-weight: bold;
1.900 bisitz 5510: text-align: left;
1.740 bisitz 5511: vertical-align: top;
1.421 albertel 5512: width: 184px;
5513: padding: 8px;
5514: }
1.795 www 5515:
1.579 raeburn 5516: table.LC_pick_box td.LC_pick_box_value {
5517: text-align: left;
5518: padding: 8px;
5519: }
1.795 www 5520:
1.579 raeburn 5521: table.LC_pick_box td.LC_pick_box_select {
5522: text-align: left;
5523: padding: 8px;
5524: }
1.795 www 5525:
1.424 albertel 5526: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5527: padding: 0;
1.421 albertel 5528: height: 1px;
5529: background: black;
5530: }
1.795 www 5531:
1.421 albertel 5532: table.LC_pick_box td.LC_pick_box_submit {
5533: text-align: right;
5534: }
1.795 www 5535:
1.579 raeburn 5536: table.LC_pick_box td.LC_evenrow_value {
5537: text-align: left;
5538: padding: 8px;
5539: background-color: $data_table_light;
5540: }
1.795 www 5541:
1.579 raeburn 5542: table.LC_pick_box td.LC_oddrow_value {
5543: text-align: left;
5544: padding: 8px;
5545: background-color: $data_table_light;
5546: }
1.795 www 5547:
1.579 raeburn 5548: span.LC_helpform_receipt_cat {
5549: font-weight: bold;
5550: }
1.795 www 5551:
1.424 albertel 5552: table.LC_group_priv_box {
5553: background: white;
5554: border: 1px solid black;
5555: border-spacing: 1px;
5556: }
1.795 www 5557:
1.424 albertel 5558: table.LC_group_priv_box td.LC_pick_box_title {
5559: background: $tabbg;
5560: font-weight: bold;
5561: text-align: right;
5562: width: 184px;
5563: }
1.795 www 5564:
1.424 albertel 5565: table.LC_group_priv_box td.LC_groups_fixed {
5566: background: $data_table_light;
5567: text-align: center;
5568: }
1.795 www 5569:
1.424 albertel 5570: table.LC_group_priv_box td.LC_groups_optional {
5571: background: $data_table_dark;
5572: text-align: center;
5573: }
1.795 www 5574:
1.424 albertel 5575: table.LC_group_priv_box td.LC_groups_functionality {
5576: background: $data_table_darker;
5577: text-align: center;
5578: font-weight: bold;
5579: }
1.795 www 5580:
1.424 albertel 5581: table.LC_group_priv td {
5582: text-align: left;
1.803 bisitz 5583: padding: 0;
1.424 albertel 5584: }
5585:
1.421 albertel 5586: table.LC_notify_front_page {
5587: background: white;
5588: border: 1px solid black;
5589: padding: 8px;
5590: }
1.795 www 5591:
1.421 albertel 5592: table.LC_notify_front_page td {
5593: padding: 8px;
5594: }
1.795 www 5595:
1.424 albertel 5596: .LC_navbuttons {
5597: margin: 2ex 0ex 2ex 0ex;
5598: }
1.795 www 5599:
1.423 albertel 5600: .LC_topic_bar {
5601: font-weight: bold;
5602: background: $tabbg;
1.918 wenzelju 5603: margin: 1em 0em 1em 2em;
1.805 bisitz 5604: padding: 3px;
1.918 wenzelju 5605: font-size: 1.2em;
1.423 albertel 5606: }
1.795 www 5607:
1.423 albertel 5608: .LC_topic_bar span {
1.918 wenzelju 5609: left: 0.5em;
5610: position: absolute;
1.423 albertel 5611: vertical-align: middle;
1.918 wenzelju 5612: font-size: 1.2em;
1.423 albertel 5613: }
1.795 www 5614:
1.423 albertel 5615: table.LC_course_group_status {
5616: margin: 20px;
5617: }
1.795 www 5618:
1.423 albertel 5619: table.LC_status_selector td {
5620: vertical-align: top;
5621: text-align: center;
1.424 albertel 5622: padding: 4px;
5623: }
1.795 www 5624:
1.599 albertel 5625: div.LC_feedback_link {
1.616 albertel 5626: clear: both;
1.829 kalberla 5627: background: $sidebg;
1.779 bisitz 5628: width: 100%;
1.829 kalberla 5629: padding-bottom: 10px;
5630: border: 1px $tabbg solid;
1.833 kalberla 5631: height: 22px;
5632: line-height: 22px;
5633: padding-top: 5px;
5634: }
5635:
5636: div.LC_feedback_link img {
5637: height: 22px;
1.867 kalberla 5638: vertical-align:middle;
1.829 kalberla 5639: }
5640:
1.911 bisitz 5641: div.LC_feedback_link a {
1.829 kalberla 5642: text-decoration: none;
1.489 raeburn 5643: }
1.795 www 5644:
1.867 kalberla 5645: div.LC_comblock {
1.911 bisitz 5646: display:inline;
1.867 kalberla 5647: color:$font;
5648: font-size:90%;
5649: }
5650:
5651: div.LC_feedback_link div.LC_comblock {
5652: padding-left:5px;
5653: }
5654:
5655: div.LC_feedback_link div.LC_comblock a {
5656: color:$font;
5657: }
5658:
1.489 raeburn 5659: span.LC_feedback_link {
1.858 bisitz 5660: /* background: $feedback_link_bg; */
1.599 albertel 5661: font-size: larger;
5662: }
1.795 www 5663:
1.599 albertel 5664: span.LC_message_link {
1.858 bisitz 5665: /* background: $feedback_link_bg; */
1.599 albertel 5666: font-size: larger;
5667: position: absolute;
5668: right: 1em;
1.489 raeburn 5669: }
1.421 albertel 5670:
1.515 albertel 5671: table.LC_prior_tries {
1.524 albertel 5672: border: 1px solid #000000;
5673: border-collapse: separate;
5674: border-spacing: 1px;
1.515 albertel 5675: }
1.523 albertel 5676:
1.515 albertel 5677: table.LC_prior_tries td {
1.524 albertel 5678: padding: 2px;
1.515 albertel 5679: }
1.523 albertel 5680:
5681: .LC_answer_correct {
1.795 www 5682: background: lightgreen;
5683: color: darkgreen;
5684: padding: 6px;
1.523 albertel 5685: }
1.795 www 5686:
1.523 albertel 5687: .LC_answer_charged_try {
1.797 www 5688: background: #FFAAAA;
1.795 www 5689: color: darkred;
5690: padding: 6px;
1.523 albertel 5691: }
1.795 www 5692:
1.779 bisitz 5693: .LC_answer_not_charged_try,
1.523 albertel 5694: .LC_answer_no_grade,
5695: .LC_answer_late {
1.795 www 5696: background: lightyellow;
1.523 albertel 5697: color: black;
1.795 www 5698: padding: 6px;
1.523 albertel 5699: }
1.795 www 5700:
1.523 albertel 5701: .LC_answer_previous {
1.795 www 5702: background: lightblue;
5703: color: darkblue;
5704: padding: 6px;
1.523 albertel 5705: }
1.795 www 5706:
1.779 bisitz 5707: .LC_answer_no_message {
1.777 tempelho 5708: background: #FFFFFF;
5709: color: black;
1.795 www 5710: padding: 6px;
1.779 bisitz 5711: }
1.795 www 5712:
1.779 bisitz 5713: .LC_answer_unknown {
5714: background: orange;
5715: color: black;
1.795 www 5716: padding: 6px;
1.777 tempelho 5717: }
1.795 www 5718:
1.529 albertel 5719: span.LC_prior_numerical,
5720: span.LC_prior_string,
5721: span.LC_prior_custom,
5722: span.LC_prior_reaction,
5723: span.LC_prior_math {
1.925 bisitz 5724: font-family: $mono;
1.523 albertel 5725: white-space: pre;
5726: }
5727:
1.525 albertel 5728: span.LC_prior_string {
1.925 bisitz 5729: font-family: $mono;
1.525 albertel 5730: white-space: pre;
5731: }
5732:
1.523 albertel 5733: table.LC_prior_option {
5734: width: 100%;
5735: border-collapse: collapse;
5736: }
1.795 www 5737:
1.911 bisitz 5738: table.LC_prior_rank,
1.795 www 5739: table.LC_prior_match {
1.528 albertel 5740: border-collapse: collapse;
5741: }
1.795 www 5742:
1.528 albertel 5743: table.LC_prior_option tr td,
5744: table.LC_prior_rank tr td,
5745: table.LC_prior_match tr td {
1.524 albertel 5746: border: 1px solid #000000;
1.515 albertel 5747: }
5748:
1.855 bisitz 5749: .LC_nobreak {
1.544 albertel 5750: white-space: nowrap;
1.519 raeburn 5751: }
5752:
1.576 raeburn 5753: span.LC_cusr_emph {
5754: font-style: italic;
5755: }
5756:
1.633 raeburn 5757: span.LC_cusr_subheading {
5758: font-weight: normal;
5759: font-size: 85%;
5760: }
5761:
1.861 bisitz 5762: div.LC_docs_entry_move {
1.859 bisitz 5763: border: 1px solid #BBBBBB;
1.545 albertel 5764: background: #DDDDDD;
1.861 bisitz 5765: width: 22px;
1.859 bisitz 5766: padding: 1px;
5767: margin: 0;
1.545 albertel 5768: }
5769:
1.861 bisitz 5770: table.LC_data_table tr > td.LC_docs_entry_commands,
5771: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5772: background: #DDDDDD;
5773: font-size: x-small;
5774: }
1.795 www 5775:
1.861 bisitz 5776: .LC_docs_entry_parameter {
5777: white-space: nowrap;
5778: }
5779:
1.544 albertel 5780: .LC_docs_copy {
1.545 albertel 5781: color: #000099;
1.544 albertel 5782: }
1.795 www 5783:
1.544 albertel 5784: .LC_docs_cut {
1.545 albertel 5785: color: #550044;
1.544 albertel 5786: }
1.795 www 5787:
1.544 albertel 5788: .LC_docs_rename {
1.545 albertel 5789: color: #009900;
1.544 albertel 5790: }
1.795 www 5791:
1.544 albertel 5792: .LC_docs_remove {
1.545 albertel 5793: color: #990000;
5794: }
5795:
1.547 albertel 5796: .LC_docs_reinit_warn,
5797: .LC_docs_ext_edit {
5798: font-size: x-small;
5799: }
5800:
1.545 albertel 5801: table.LC_docs_adddocs td,
5802: table.LC_docs_adddocs th {
5803: border: 1px solid #BBBBBB;
5804: padding: 4px;
5805: background: #DDDDDD;
1.543 albertel 5806: }
5807:
1.584 albertel 5808: table.LC_sty_begin {
5809: background: #BBFFBB;
5810: }
1.795 www 5811:
1.584 albertel 5812: table.LC_sty_end {
5813: background: #FFBBBB;
5814: }
5815:
1.589 raeburn 5816: table.LC_double_column {
1.803 bisitz 5817: border-width: 0;
1.589 raeburn 5818: border-collapse: collapse;
5819: width: 100%;
5820: padding: 2px;
5821: }
5822:
5823: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5824: top: 2px;
1.589 raeburn 5825: left: 2px;
5826: width: 47%;
5827: vertical-align: top;
5828: }
5829:
5830: table.LC_double_column tr td.LC_right_col {
5831: top: 2px;
1.779 bisitz 5832: right: 2px;
1.589 raeburn 5833: width: 47%;
5834: vertical-align: top;
5835: }
5836:
1.591 raeburn 5837: div.LC_left_float {
5838: float: left;
5839: padding-right: 5%;
1.597 albertel 5840: padding-bottom: 4px;
1.591 raeburn 5841: }
5842:
5843: div.LC_clear_float_header {
1.597 albertel 5844: padding-bottom: 2px;
1.591 raeburn 5845: }
5846:
5847: div.LC_clear_float_footer {
1.597 albertel 5848: padding-top: 10px;
1.591 raeburn 5849: clear: both;
5850: }
5851:
1.597 albertel 5852: div.LC_grade_show_user {
1.941 bisitz 5853: /* border-left: 5px solid $sidebg; */
5854: border-top: 5px solid #000000;
5855: margin: 50px 0 0 0;
1.936 bisitz 5856: padding: 15px 0 5px 10px;
1.597 albertel 5857: }
1.795 www 5858:
1.936 bisitz 5859: div.LC_grade_show_user_odd_row {
1.941 bisitz 5860: /* border-left: 5px solid #000000; */
5861: }
5862:
5863: div.LC_grade_show_user div.LC_Box {
5864: margin-right: 50px;
1.597 albertel 5865: }
5866:
5867: div.LC_grade_submissions,
5868: div.LC_grade_message_center,
1.936 bisitz 5869: div.LC_grade_info_links {
1.597 albertel 5870: margin: 5px;
5871: width: 99%;
5872: background: #FFFFFF;
5873: }
1.795 www 5874:
1.597 albertel 5875: div.LC_grade_submissions_header,
1.936 bisitz 5876: div.LC_grade_message_center_header {
1.705 tempelho 5877: font-weight: bold;
5878: font-size: large;
1.597 albertel 5879: }
1.795 www 5880:
1.597 albertel 5881: div.LC_grade_submissions_body,
1.936 bisitz 5882: div.LC_grade_message_center_body {
1.597 albertel 5883: border: 1px solid black;
5884: width: 99%;
5885: background: #FFFFFF;
5886: }
1.795 www 5887:
1.613 albertel 5888: table.LC_scantron_action {
5889: width: 100%;
5890: }
1.795 www 5891:
1.613 albertel 5892: table.LC_scantron_action tr th {
1.698 harmsja 5893: font-weight:bold;
5894: font-style:normal;
1.613 albertel 5895: }
1.795 www 5896:
1.779 bisitz 5897: .LC_edit_problem_header,
1.614 albertel 5898: div.LC_edit_problem_footer {
1.705 tempelho 5899: font-weight: normal;
5900: font-size: medium;
1.602 albertel 5901: margin: 2px;
1.600 albertel 5902: }
1.795 www 5903:
1.600 albertel 5904: div.LC_edit_problem_header,
1.602 albertel 5905: div.LC_edit_problem_header div,
1.614 albertel 5906: div.LC_edit_problem_footer,
5907: div.LC_edit_problem_footer div,
1.602 albertel 5908: div.LC_edit_problem_editxml_header,
5909: div.LC_edit_problem_editxml_header div {
1.600 albertel 5910: margin-top: 5px;
5911: }
1.795 www 5912:
1.600 albertel 5913: div.LC_edit_problem_header_title {
1.705 tempelho 5914: font-weight: bold;
5915: font-size: larger;
1.602 albertel 5916: background: $tabbg;
5917: padding: 3px;
5918: }
1.795 www 5919:
1.602 albertel 5920: table.LC_edit_problem_header_title {
5921: width: 100%;
1.600 albertel 5922: background: $tabbg;
1.602 albertel 5923: }
5924:
5925: div.LC_edit_problem_discards {
5926: float: left;
5927: padding-bottom: 5px;
5928: }
1.795 www 5929:
1.602 albertel 5930: div.LC_edit_problem_saves {
5931: float: right;
5932: padding-bottom: 5px;
1.600 albertel 5933: }
1.795 www 5934:
1.911 bisitz 5935: img.stift {
1.803 bisitz 5936: border-width: 0;
5937: vertical-align: middle;
1.677 riegler 5938: }
1.680 riegler 5939:
1.923 bisitz 5940: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5941: vertical-align: top;
1.777 tempelho 5942: }
1.795 www 5943:
1.716 raeburn 5944: div.LC_createcourse {
1.911 bisitz 5945: margin: 10px 10px 10px 10px;
1.716 raeburn 5946: }
5947:
1.917 raeburn 5948: .LC_dccid {
5949: margin: 0.2em 0 0 0;
5950: padding: 0;
5951: font-size: 90%;
5952: display:none;
5953: }
5954:
1.698 harmsja 5955: a:hover,
1.897 wenzelju 5956: ol.LC_primary_menu a:hover,
1.721 harmsja 5957: ol#LC_MenuBreadcrumbs a:hover,
5958: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5959: ul#LC_secondary_menu a:hover,
1.721 harmsja 5960: .LC_FormSectionClearButton input:hover
1.795 www 5961: ul.LC_TabContent li:hover a {
1.952 onken 5962: color:$button_hover;
1.911 bisitz 5963: text-decoration:none;
1.693 droeschl 5964: }
5965:
1.779 bisitz 5966: h1 {
1.911 bisitz 5967: padding: 0;
5968: line-height:130%;
1.693 droeschl 5969: }
1.698 harmsja 5970:
1.911 bisitz 5971: h2,
5972: h3,
5973: h4,
5974: h5,
5975: h6 {
5976: margin: 5px 0 5px 0;
5977: padding: 0;
5978: line-height:130%;
1.693 droeschl 5979: }
1.795 www 5980:
5981: .LC_hcell {
1.911 bisitz 5982: padding:3px 15px 3px 15px;
5983: margin: 0;
5984: background-color:$tabbg;
5985: color:$fontmenu;
5986: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5987: }
1.795 www 5988:
1.840 bisitz 5989: .LC_Box > .LC_hcell {
1.911 bisitz 5990: margin: 0 -10px 10px -10px;
1.835 bisitz 5991: }
5992:
1.721 harmsja 5993: .LC_noBorder {
1.911 bisitz 5994: border: 0;
1.698 harmsja 5995: }
1.693 droeschl 5996:
1.721 harmsja 5997: .LC_FormSectionClearButton input {
1.911 bisitz 5998: background-color:transparent;
5999: border: none;
6000: cursor:pointer;
6001: text-decoration:underline;
1.693 droeschl 6002: }
1.763 bisitz 6003:
6004: .LC_help_open_topic {
1.911 bisitz 6005: color: #FFFFFF;
6006: background-color: #EEEEFF;
6007: margin: 1px;
6008: padding: 4px;
6009: border: 1px solid #000033;
6010: white-space: nowrap;
6011: /* vertical-align: middle; */
1.759 neumanie 6012: }
1.693 droeschl 6013:
1.911 bisitz 6014: dl,
6015: ul,
6016: div,
6017: fieldset {
6018: margin: 10px 10px 10px 0;
6019: /* overflow: hidden; */
1.693 droeschl 6020: }
1.795 www 6021:
1.838 bisitz 6022: fieldset > legend {
1.911 bisitz 6023: font-weight: bold;
6024: padding: 0 5px 0 5px;
1.838 bisitz 6025: }
6026:
1.813 bisitz 6027: #LC_nav_bar {
1.911 bisitz 6028: float: left;
1.934 droeschl 6029: margin: 0;
1.807 droeschl 6030: }
6031:
1.916 droeschl 6032: #LC_realm {
6033: margin: 0.2em 0 0 0;
6034: padding: 0;
6035: font-weight: bold;
6036: text-align: center;
6037: }
6038:
1.911 bisitz 6039: #LC_nav_bar em {
6040: font-weight: bold;
6041: font-style: normal;
1.807 droeschl 6042: }
6043:
1.897 wenzelju 6044: ol.LC_primary_menu {
1.911 bisitz 6045: float: right;
1.934 droeschl 6046: margin: 0;
1.807 droeschl 6047: }
6048:
1.852 droeschl 6049: ol#LC_PathBreadcrumbs {
1.911 bisitz 6050: margin: 0;
1.693 droeschl 6051: }
6052:
1.897 wenzelju 6053: ol.LC_primary_menu li {
1.911 bisitz 6054: display: inline;
6055: padding: 5px 5px 0 10px;
6056: vertical-align: top;
1.693 droeschl 6057: }
6058:
1.897 wenzelju 6059: ol.LC_primary_menu li img {
1.911 bisitz 6060: vertical-align: bottom;
1.934 droeschl 6061: height: 1.1em;
1.693 droeschl 6062: }
6063:
1.897 wenzelju 6064: ol.LC_primary_menu a {
1.911 bisitz 6065: color: RGB(80, 80, 80);
6066: text-decoration: none;
1.693 droeschl 6067: }
1.795 www 6068:
1.949 droeschl 6069: ol.LC_primary_menu a.LC_new_message {
6070: font-weight:bold;
6071: color: darkred;
6072: }
6073:
1.897 wenzelju 6074: ul#LC_secondary_menu {
1.911 bisitz 6075: clear: both;
6076: color: $fontmenu;
6077: background: $tabbg;
6078: list-style: none;
6079: padding: 0;
6080: margin: 0;
6081: width: 100%;
1.808 droeschl 6082: }
6083:
1.897 wenzelju 6084: ul#LC_secondary_menu li {
1.911 bisitz 6085: font-weight: bold;
6086: line-height: 1.8em;
6087: padding: 0 0.8em;
6088: border-right: 1px solid black;
6089: display: inline;
6090: vertical-align: middle;
1.807 droeschl 6091: }
6092:
1.847 tempelho 6093: ul.LC_TabContent {
1.911 bisitz 6094: display:block;
6095: background: $sidebg;
6096: border-bottom: solid 1px $lg_border_color;
6097: list-style:none;
6098: margin: 0 -10px;
6099: padding: 0;
1.693 droeschl 6100: }
6101:
1.795 www 6102: ul.LC_TabContent li,
6103: ul.LC_TabContentBigger li {
1.911 bisitz 6104: float:left;
1.741 harmsja 6105: }
1.795 www 6106:
1.897 wenzelju 6107: ul#LC_secondary_menu li a {
1.911 bisitz 6108: color: $fontmenu;
6109: text-decoration: none;
1.693 droeschl 6110: }
1.795 www 6111:
1.721 harmsja 6112: ul.LC_TabContent {
1.952 onken 6113: min-height:20px;
1.721 harmsja 6114: }
1.795 www 6115:
6116: ul.LC_TabContent li {
1.911 bisitz 6117: vertical-align:middle;
1.959 onken 6118: padding: 0 16px 0 10px;
1.911 bisitz 6119: background-color:$tabbg;
6120: border-bottom:solid 1px $lg_border_color;
1.952 onken 6121: border-right: solid 1px $font;
1.721 harmsja 6122: }
1.795 www 6123:
1.847 tempelho 6124: ul.LC_TabContent .right {
1.911 bisitz 6125: float:right;
1.847 tempelho 6126: }
6127:
1.911 bisitz 6128: ul.LC_TabContent li a,
6129: ul.LC_TabContent li {
6130: color:rgb(47,47,47);
6131: text-decoration:none;
6132: font-size:95%;
6133: font-weight:bold;
1.952 onken 6134: min-height:20px;
6135: }
6136:
1.959 onken 6137: ul.LC_TabContent li a:hover,
6138: ul.LC_TabContent li a:focus {
1.952 onken 6139: color: $button_hover;
1.959 onken 6140: background:none;
6141: outline:none;
1.952 onken 6142: }
6143:
6144: ul.LC_TabContent li:hover {
6145: color: $button_hover;
6146: cursor:pointer;
1.721 harmsja 6147: }
1.795 www 6148:
1.911 bisitz 6149: ul.LC_TabContent li.active {
1.952 onken 6150: color: $font;
1.911 bisitz 6151: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6152: border-bottom:solid 1px #FFFFFF;
6153: cursor: default;
1.744 ehlerst 6154: }
1.795 www 6155:
1.959 onken 6156: ul.LC_TabContent li.active a {
6157: color:$font;
6158: background:#FFFFFF;
6159: outline: none;
6160: }
1.870 tempelho 6161: #maincoursedoc {
1.911 bisitz 6162: clear:both;
1.870 tempelho 6163: }
6164:
6165: ul.LC_TabContentBigger {
1.911 bisitz 6166: display:block;
6167: list-style:none;
6168: padding: 0;
1.870 tempelho 6169: }
6170:
1.795 www 6171: ul.LC_TabContentBigger li {
1.911 bisitz 6172: vertical-align:bottom;
6173: height: 30px;
6174: font-size:110%;
6175: font-weight:bold;
6176: color: #737373;
1.841 tempelho 6177: }
6178:
1.957 onken 6179: ul.LC_TabContentBigger li.active {
6180: position: relative;
6181: top: 1px;
6182: }
6183:
1.870 tempelho 6184: ul.LC_TabContentBigger li a {
1.911 bisitz 6185: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6186: height: 30px;
6187: line-height: 30px;
6188: text-align: center;
6189: display: block;
6190: text-decoration: none;
1.958 onken 6191: outline: none;
1.741 harmsja 6192: }
1.795 www 6193:
1.870 tempelho 6194: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6195: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6196: color:$font;
1.744 ehlerst 6197: }
1.795 www 6198:
1.870 tempelho 6199: ul.LC_TabContentBigger li b {
1.911 bisitz 6200: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6201: display: block;
6202: float: left;
6203: padding: 0 30px;
1.957 onken 6204: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6205: }
6206:
1.956 onken 6207: ul.LC_TabContentBigger li:hover b {
6208: color:$button_hover;
6209: }
6210:
1.870 tempelho 6211: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6212: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6213: color:$font;
1.957 onken 6214: border: 0;
1.956 onken 6215: cursor:default;
1.741 harmsja 6216: }
1.693 droeschl 6217:
1.870 tempelho 6218:
1.862 bisitz 6219: ul.LC_CourseBreadcrumbs {
6220: background: $sidebg;
6221: line-height: 32px;
6222: padding-left: 10px;
6223: margin: 0 0 10px 0;
6224: list-style-position: inside;
6225:
6226: }
6227:
1.911 bisitz 6228: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6229: ol#LC_PathBreadcrumbs {
1.911 bisitz 6230: padding-left: 10px;
6231: margin: 0;
1.933 droeschl 6232: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6233: }
6234:
1.911 bisitz 6235: ol#LC_MenuBreadcrumbs li,
6236: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6237: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6238: display: inline;
1.933 droeschl 6239: white-space: normal;
1.693 droeschl 6240: }
6241:
1.823 bisitz 6242: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6243: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6244: text-decoration: none;
6245: font-size:90%;
1.693 droeschl 6246: }
1.795 www 6247:
6248: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6249: text-decoration:none;
6250: font-size:100%;
6251: font-weight:bold;
1.693 droeschl 6252: }
1.795 www 6253:
1.840 bisitz 6254: .LC_Box {
1.911 bisitz 6255: border: solid 1px $lg_border_color;
6256: padding: 0 10px 10px 10px;
1.746 neumanie 6257: }
1.795 www 6258:
6259: .LC_AboutMe_Image {
1.911 bisitz 6260: float:left;
6261: margin-right:10px;
1.747 neumanie 6262: }
1.795 www 6263:
6264: .LC_Clear_AboutMe_Image {
1.911 bisitz 6265: clear:left;
1.747 neumanie 6266: }
1.795 www 6267:
1.721 harmsja 6268: dl.LC_ListStyleClean dt {
1.911 bisitz 6269: padding-right: 5px;
6270: display: table-header-group;
1.693 droeschl 6271: }
6272:
1.721 harmsja 6273: dl.LC_ListStyleClean dd {
1.911 bisitz 6274: display: table-row;
1.693 droeschl 6275: }
6276:
1.721 harmsja 6277: .LC_ListStyleClean,
6278: .LC_ListStyleSimple,
6279: .LC_ListStyleNormal,
1.795 www 6280: .LC_ListStyleSpecial {
1.911 bisitz 6281: /* display:block; */
6282: list-style-position: inside;
6283: list-style-type: none;
6284: overflow: hidden;
6285: padding: 0;
1.693 droeschl 6286: }
6287:
1.721 harmsja 6288: .LC_ListStyleSimple li,
6289: .LC_ListStyleSimple dd,
6290: .LC_ListStyleNormal li,
6291: .LC_ListStyleNormal dd,
6292: .LC_ListStyleSpecial li,
1.795 www 6293: .LC_ListStyleSpecial dd {
1.911 bisitz 6294: margin: 0;
6295: padding: 5px 5px 5px 10px;
6296: clear: both;
1.693 droeschl 6297: }
6298:
1.721 harmsja 6299: .LC_ListStyleClean li,
6300: .LC_ListStyleClean dd {
1.911 bisitz 6301: padding-top: 0;
6302: padding-bottom: 0;
1.693 droeschl 6303: }
6304:
1.721 harmsja 6305: .LC_ListStyleSimple dd,
1.795 www 6306: .LC_ListStyleSimple li {
1.911 bisitz 6307: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6308: }
6309:
1.721 harmsja 6310: .LC_ListStyleSpecial li,
6311: .LC_ListStyleSpecial dd {
1.911 bisitz 6312: list-style-type: none;
6313: background-color: RGB(220, 220, 220);
6314: margin-bottom: 4px;
1.693 droeschl 6315: }
6316:
1.721 harmsja 6317: table.LC_SimpleTable {
1.911 bisitz 6318: margin:5px;
6319: border:solid 1px $lg_border_color;
1.795 www 6320: }
1.693 droeschl 6321:
1.721 harmsja 6322: table.LC_SimpleTable tr {
1.911 bisitz 6323: padding: 0;
6324: border:solid 1px $lg_border_color;
1.693 droeschl 6325: }
1.795 www 6326:
6327: table.LC_SimpleTable thead {
1.911 bisitz 6328: background:rgb(220,220,220);
1.693 droeschl 6329: }
6330:
1.721 harmsja 6331: div.LC_columnSection {
1.911 bisitz 6332: display: block;
6333: clear: both;
6334: overflow: hidden;
6335: margin: 0;
1.693 droeschl 6336: }
6337:
1.721 harmsja 6338: div.LC_columnSection>* {
1.911 bisitz 6339: float: left;
6340: margin: 10px 20px 10px 0;
6341: overflow:hidden;
1.693 droeschl 6342: }
1.721 harmsja 6343:
1.694 tempelho 6344: .LC_loginpage_container {
1.911 bisitz 6345: text-align:left;
6346: margin : 0 auto;
6347: width:90%;
6348: padding: 10px;
6349: height: auto;
6350: background-color:#FFFFFF;
6351: border:1px solid #CCCCCC;
1.694 tempelho 6352: }
6353:
6354:
6355: .LC_loginpage_loginContainer {
1.911 bisitz 6356: float:left;
6357: width: 182px;
6358: padding: 2px;
6359: border:1px solid #CCCCCC;
6360: background-color:$loginbg;
1.694 tempelho 6361: }
6362:
1.795 www 6363: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6364: margin-top: 0;
6365: display:block;
6366: background:$bgcol;
6367: color:$textcol;
6368: padding-left:5px;
1.712 muellerd 6369: }
1.785 tempelho 6370:
1.694 tempelho 6371: .LC_loginpage_loginInfo {
1.911 bisitz 6372: float:left;
6373: width:182px;
6374: border:1px solid #CCCCCC;
6375: padding:2px;
1.712 muellerd 6376: }
6377:
1.694 tempelho 6378: .LC_loginpage_space {
1.911 bisitz 6379: clear: both;
6380: margin-bottom: 20px;
6381: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6382: }
6383:
1.785 tempelho 6384: .LC_loginpage_floatLeft {
1.911 bisitz 6385: float: left;
6386: width: 200px;
6387: margin: 0;
1.785 tempelho 6388: }
6389:
1.795 www 6390: table em {
1.911 bisitz 6391: font-weight: bold;
6392: font-style: normal;
1.748 schulted 6393: }
1.795 www 6394:
1.779 bisitz 6395: table.LC_tableBrowseRes,
1.795 www 6396: table.LC_tableOfContent {
1.911 bisitz 6397: border:none;
6398: border-spacing: 1px;
6399: padding: 3px;
6400: background-color: #FFFFFF;
6401: font-size: 90%;
1.753 droeschl 6402: }
1.789 droeschl 6403:
1.911 bisitz 6404: table.LC_tableOfContent {
6405: border-collapse: collapse;
1.789 droeschl 6406: }
6407:
1.771 droeschl 6408: table.LC_tableBrowseRes a,
1.768 schulted 6409: table.LC_tableOfContent a {
1.911 bisitz 6410: background-color: transparent;
6411: text-decoration: none;
1.753 droeschl 6412: }
6413:
1.795 www 6414: table.LC_tableOfContent img {
1.911 bisitz 6415: border: none;
6416: height: 1.3em;
6417: vertical-align: text-bottom;
6418: margin-right: 0.3em;
1.753 droeschl 6419: }
1.757 schulted 6420:
1.795 www 6421: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6422: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6423: }
6424:
1.795 www 6425: a#LC_content_toolbar_everything {
1.911 bisitz 6426: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6427: }
6428:
1.795 www 6429: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6430: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6431: }
6432:
1.795 www 6433: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6434: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6435: }
6436:
1.795 www 6437: a#LC_content_toolbar_changefolder {
1.911 bisitz 6438: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6439: }
6440:
1.795 www 6441: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6442: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6443: }
6444:
1.795 www 6445: ul#LC_toolbar li a:hover {
1.911 bisitz 6446: background-position: bottom center;
1.757 schulted 6447: }
6448:
1.795 www 6449: ul#LC_toolbar {
1.911 bisitz 6450: padding: 0;
6451: margin: 2px;
6452: list-style:none;
6453: position:relative;
6454: background-color:white;
1.757 schulted 6455: }
6456:
1.795 www 6457: ul#LC_toolbar li {
1.911 bisitz 6458: border:1px solid white;
6459: padding: 0;
6460: margin: 0;
6461: float: left;
6462: display:inline;
6463: vertical-align:middle;
6464: }
1.757 schulted 6465:
1.783 amueller 6466:
1.795 www 6467: a.LC_toolbarItem {
1.911 bisitz 6468: display:block;
6469: padding: 0;
6470: margin: 0;
6471: height: 32px;
6472: width: 32px;
6473: color:white;
6474: border: none;
6475: background-repeat:no-repeat;
6476: background-color:transparent;
1.757 schulted 6477: }
6478:
1.915 droeschl 6479: ul.LC_funclist {
6480: margin: 0;
6481: padding: 0.5em 1em 0.5em 0;
6482: }
6483:
1.933 droeschl 6484: ul.LC_funclist > li:first-child {
6485: font-weight:bold;
6486: margin-left:0.8em;
6487: }
6488:
1.915 droeschl 6489: ul.LC_funclist + ul.LC_funclist {
6490: /*
6491: left border as a seperator if we have more than
6492: one list
6493: */
6494: border-left: 1px solid $sidebg;
6495: /*
6496: this hides the left border behind the border of the
6497: outer box if element is wrapped to the next 'line'
6498: */
6499: margin-left: -1px;
6500: }
6501:
1.843 bisitz 6502: ul.LC_funclist li {
1.915 droeschl 6503: display: inline;
1.782 bisitz 6504: white-space: nowrap;
1.915 droeschl 6505: margin: 0 0 0 25px;
6506: line-height: 150%;
1.782 bisitz 6507: }
6508:
1.930 faziophi 6509: .ui-accordion .LC_advanced_toggle {
6510: float: right;
6511: font-size: 90%;
6512: padding: 0px 4px
6513: }
1.757 schulted 6514:
1.343 albertel 6515: END
6516: }
6517:
1.306 albertel 6518: =pod
6519:
6520: =item * &headtag()
6521:
6522: Returns a uniform footer for LON-CAPA web pages.
6523:
1.307 albertel 6524: Inputs: $title - optional title for the head
6525: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6526: $args - optional arguments
1.319 albertel 6527: force_register - if is true call registerurl so the remote is
6528: informed
1.415 albertel 6529: redirect -> array ref of
6530: 1- seconds before redirect occurs
6531: 2- url to redirect to
6532: 3- whether the side effect should occur
1.315 albertel 6533: (side effect of setting
6534: $env{'internal.head.redirect'} to the url
6535: redirected too)
1.352 albertel 6536: domain -> force to color decorate a page for a specific
6537: domain
6538: function -> force usage of a specific rolish color scheme
6539: bgcolor -> override the default page bgcolor
1.460 albertel 6540: no_auto_mt_title
6541: -> prevent &mt()ing the title arg
1.464 albertel 6542:
1.306 albertel 6543: =cut
6544:
6545: sub headtag {
1.313 albertel 6546: my ($title,$head_extra,$args) = @_;
1.306 albertel 6547:
1.363 albertel 6548: my $function = $args->{'function'} || &get_users_function();
6549: my $domain = $args->{'domain'} || &determinedomain();
6550: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6551: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6552: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6553: #time(),
1.418 albertel 6554: $env{'environment.color.timestamp'},
1.363 albertel 6555: $function,$domain,$bgcolor);
6556:
1.369 www 6557: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6558:
1.308 albertel 6559: my $result =
6560: '<head>'.
1.461 albertel 6561: &font_settings();
1.319 albertel 6562:
1.461 albertel 6563: if (!$args->{'frameset'}) {
6564: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6565: }
1.962 droeschl 6566: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6567: $result .= Apache::lonxml::display_title();
1.319 albertel 6568: }
1.436 albertel 6569: if (!$args->{'no_nav_bar'}
6570: && !$args->{'only_body'}
6571: && !$args->{'frameset'}) {
6572: $result .= &help_menu_js();
6573: }
1.319 albertel 6574:
1.314 albertel 6575: if (ref($args->{'redirect'})) {
1.414 albertel 6576: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6577: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6578: if (!$inhibit_continue) {
6579: $env{'internal.head.redirect'} = $url;
6580: }
1.313 albertel 6581: $result.=<<ADDMETA
6582: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6583: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6584: ADDMETA
6585: }
1.306 albertel 6586: if (!defined($title)) {
6587: $title = 'The LearningOnline Network with CAPA';
6588: }
1.460 albertel 6589: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6590: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6591: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6592: .$head_extra;
1.962 droeschl 6593: return $result.'</head>';
1.306 albertel 6594: }
6595:
6596: =pod
6597:
1.340 albertel 6598: =item * &font_settings()
6599:
6600: Returns neccessary <meta> to set the proper encoding
6601:
6602: Inputs: none
6603:
6604: =cut
6605:
6606: sub font_settings {
6607: my $headerstring='';
1.647 www 6608: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6609: $headerstring.=
6610: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6611: }
6612: return $headerstring;
6613: }
6614:
1.341 albertel 6615: =pod
6616:
6617: =item * &xml_begin()
6618:
6619: Returns the needed doctype and <html>
6620:
6621: Inputs: none
6622:
6623: =cut
6624:
6625: sub xml_begin {
6626: my $output='';
6627:
1.592 albertel 6628: if ($env{'internal.start_page'}==1) {
6629: &Apache::lonhtmlcommon::init_htmlareafields();
6630: }
1.342 albertel 6631:
1.341 albertel 6632: if ($env{'browser.mathml'}) {
6633: $output='<?xml version="1.0"?>'
6634: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6635: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6636:
6637: # .'<!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">] >'
6638: .'<!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">'
6639: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6640: .'xmlns="http://www.w3.org/1999/xhtml">';
6641: } else {
1.849 bisitz 6642: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6643: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6644: }
6645: return $output;
6646: }
1.340 albertel 6647:
6648: =pod
6649:
1.306 albertel 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_auto_mt_title -> prevent &mt()ing the title arg
6688: inherit_jsmath -> when creating popup window in a page,
6689: should it have jsmath forced on by the
6690: current page
1.867 kalberla 6691: bread_crumbs -> Array containing breadcrumbs
6692: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6693:
1.648 raeburn 6694: =back
1.460 albertel 6695:
1.648 raeburn 6696: =back
1.562 albertel 6697:
1.306 albertel 6698: =cut
6699:
6700: sub start_page {
1.309 albertel 6701: my ($title,$head_extra,$args) = @_;
1.318 albertel 6702: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 ! droeschl 6703: #SD
! 6704: #I don't see why we copy certain elements of %$args to %head_args
! 6705: #head args is passed to headtag() and this routine only reads those
! 6706: #keys that are needed. There doesn't happen any writes or any processing
! 6707: #of other keys.
! 6708: #proposal: just pass $args to headtag instead of \%head_args and delete
! 6709: #marked lines
! 6710: #<- MARK
1.313 albertel 6711: my %head_args;
1.352 albertel 6712: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6713: 'bgcolor','frameset','no_nav_bar','only_body',
6714: 'no_auto_mt_title') {
1.319 albertel 6715: if (defined($args->{$arg})) {
1.324 raeburn 6716: $head_args{$arg} = $args->{$arg};
1.319 albertel 6717: }
1.313 albertel 6718: }
1.964 ! droeschl 6719: #MARK ->
1.319 albertel 6720:
1.315 albertel 6721: $env{'internal.start_page'}++;
1.338 albertel 6722: my $result;
1.964 ! droeschl 6723:
1.338 albertel 6724: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 ! droeschl 6725: $result .=
! 6726: &xml_begin() . &headtag($title,$head_extra,\%head_args);
! 6727: #replace prev line by
! 6728: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6729: }
6730:
6731: if (! exists($args->{'skip_phases'}{'body'}) ) {
6732: if ($args->{'frameset'}) {
6733: my $attr_string = &make_attr_string($args->{'force_register'},
6734: $args->{'add_entries'});
6735: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6736: } else {
6737: $result .=
6738: &bodytag($title,
6739: $args->{'function'}, $args->{'add_entries'},
6740: $args->{'only_body'}, $args->{'domain'},
6741: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6742: $args->{'bgcolor'}, $args);
1.831 bisitz 6743: }
1.330 albertel 6744: }
1.338 albertel 6745:
1.315 albertel 6746: if ($args->{'js_ready'}) {
1.713 kaisler 6747: $result = &js_ready($result);
1.315 albertel 6748: }
1.320 albertel 6749: if ($args->{'html_encode'}) {
1.713 kaisler 6750: $result = &html_encode($result);
6751: }
6752:
1.813 bisitz 6753: # Preparation for new and consistent functionlist at top of screen
6754: # if ($args->{'functionlist'}) {
6755: # $result .= &build_functionlist();
6756: #}
6757:
1.964 ! droeschl 6758: # Don't add anything more if only_body wanted or in const space
! 6759: return $result if $args->{'only_body'}
! 6760: || $env{'request.state'} eq 'construct';
1.813 bisitz 6761:
6762: #Breadcrumbs
1.758 kaisler 6763: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6764: &Apache::lonhtmlcommon::clear_breadcrumbs();
6765: #if any br links exists, add them to the breadcrumbs
6766: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6767: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6768: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6769: }
6770: }
6771:
6772: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6773: if(exists($args->{'bread_crumbs_component'})){
6774: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6775: }else{
6776: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6777: }
1.320 albertel 6778: }
1.315 albertel 6779: return $result;
1.306 albertel 6780: }
6781:
6782: sub end_page {
1.315 albertel 6783: my ($args) = @_;
6784: $env{'internal.end_page'}++;
1.330 albertel 6785: my $result;
1.335 albertel 6786: if ($args->{'discussion'}) {
6787: my ($target,$parser);
6788: if (ref($args->{'discussion'})) {
6789: ($target,$parser) =($args->{'discussion'}{'target'},
6790: $args->{'discussion'}{'parser'});
6791: }
6792: $result .= &Apache::lonxml::xmlend($target,$parser);
6793: }
6794:
1.330 albertel 6795: if ($args->{'frameset'}) {
6796: $result .= '</frameset>';
6797: } else {
1.635 raeburn 6798: $result .= &endbodytag($args);
1.330 albertel 6799: }
6800: $result .= "\n</html>";
6801:
1.315 albertel 6802: if ($args->{'js_ready'}) {
1.317 albertel 6803: $result = &js_ready($result);
1.315 albertel 6804: }
1.335 albertel 6805:
1.320 albertel 6806: if ($args->{'html_encode'}) {
6807: $result = &html_encode($result);
6808: }
1.335 albertel 6809:
1.315 albertel 6810: return $result;
6811: }
6812:
1.320 albertel 6813: sub html_encode {
6814: my ($result) = @_;
6815:
1.322 albertel 6816: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6817:
6818: return $result;
6819: }
1.317 albertel 6820: sub js_ready {
6821: my ($result) = @_;
6822:
1.323 albertel 6823: $result =~ s/[\n\r]/ /xmsg;
6824: $result =~ s/\\/\\\\/xmsg;
6825: $result =~ s/'/\\'/xmsg;
1.372 albertel 6826: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6827:
6828: return $result;
6829: }
6830:
1.315 albertel 6831: sub validate_page {
6832: if ( exists($env{'internal.start_page'})
1.316 albertel 6833: && $env{'internal.start_page'} > 1) {
6834: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6835: $env{'internal.start_page'}.' '.
1.316 albertel 6836: $ENV{'request.filename'});
1.315 albertel 6837: }
6838: if ( exists($env{'internal.end_page'})
1.316 albertel 6839: && $env{'internal.end_page'} > 1) {
6840: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6841: $env{'internal.end_page'}.' '.
1.316 albertel 6842: $env{'request.filename'});
1.315 albertel 6843: }
6844: if ( exists($env{'internal.start_page'})
6845: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6846: &Apache::lonnet::logthis('start_page called without end_page '.
6847: $env{'request.filename'});
1.315 albertel 6848: }
6849: if ( ! exists($env{'internal.start_page'})
6850: && exists($env{'internal.end_page'})) {
1.316 albertel 6851: &Apache::lonnet::logthis('end_page called without start_page'.
6852: $env{'request.filename'});
1.315 albertel 6853: }
1.306 albertel 6854: }
1.315 albertel 6855:
1.318 albertel 6856: sub simple_error_page {
6857: my ($r,$title,$msg) = @_;
6858: my $page =
6859: &Apache::loncommon::start_page($title).
6860: &mt($msg).
6861: &Apache::loncommon::end_page();
6862: if (ref($r)) {
6863: $r->print($page);
1.327 albertel 6864: return;
1.318 albertel 6865: }
6866: return $page;
6867: }
1.347 albertel 6868:
6869: {
1.610 albertel 6870: my @row_count;
1.961 onken 6871:
6872: sub start_data_table_count {
6873: unshift(@row_count, 0);
6874: return;
6875: }
6876:
6877: sub end_data_table_count {
6878: shift(@row_count);
6879: return;
6880: }
6881:
1.347 albertel 6882: sub start_data_table {
1.422 albertel 6883: my ($add_class) = @_;
6884: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6885: &start_data_table_count();
1.422 albertel 6886: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6887: }
6888:
6889: sub end_data_table {
1.961 onken 6890: &end_data_table_count();
1.389 albertel 6891: return '</table>'."\n";;
1.347 albertel 6892: }
6893:
6894: sub start_data_table_row {
1.422 albertel 6895: my ($add_class) = @_;
1.610 albertel 6896: $row_count[0]++;
6897: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6898: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6899: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6900: }
1.471 banghart 6901:
6902: sub continue_data_table_row {
6903: my ($add_class) = @_;
1.610 albertel 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.471 banghart 6906: return '<tr class="'.$css_class.'">'."\n";;
6907: }
1.347 albertel 6908:
6909: sub end_data_table_row {
1.389 albertel 6910: return '</tr>'."\n";;
1.347 albertel 6911: }
1.367 www 6912:
1.421 albertel 6913: sub start_data_table_empty_row {
1.707 bisitz 6914: # $row_count[0]++;
1.421 albertel 6915: return '<tr class="LC_empty_row" >'."\n";;
6916: }
6917:
6918: sub end_data_table_empty_row {
6919: return '</tr>'."\n";;
6920: }
6921:
1.367 www 6922: sub start_data_table_header_row {
1.389 albertel 6923: return '<tr class="LC_header_row">'."\n";;
1.367 www 6924: }
6925:
6926: sub end_data_table_header_row {
1.389 albertel 6927: return '</tr>'."\n";;
1.367 www 6928: }
1.890 droeschl 6929:
6930: sub data_table_caption {
6931: my $caption = shift;
6932: return "<caption class=\"LC_caption\">$caption</caption>";
6933: }
1.347 albertel 6934: }
6935:
1.548 albertel 6936: =pod
6937:
6938: =item * &inhibit_menu_check($arg)
6939:
6940: Checks for a inhibitmenu state and generates output to preserve it
6941:
6942: Inputs: $arg - can be any of
6943: - undef - in which case the return value is a string
6944: to add into arguments list of a uri
6945: - 'input' - in which case the return value is a HTML
6946: <form> <input> field of type hidden to
6947: preserve the value
6948: - a url - in which case the return value is the url with
6949: the neccesary cgi args added to preserve the
6950: inhibitmenu state
6951: - a ref to a url - no return value, but the string is
6952: updated to include the neccessary cgi
6953: args to preserve the inhibitmenu state
6954:
6955: =cut
6956:
6957: sub inhibit_menu_check {
6958: my ($arg) = @_;
6959: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6960: if ($arg eq 'input') {
6961: if ($env{'form.inhibitmenu'}) {
6962: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6963: } else {
6964: return
6965: }
6966: }
6967: if ($env{'form.inhibitmenu'}) {
6968: if (ref($arg)) {
6969: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6970: } elsif ($arg eq '') {
6971: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6972: } else {
6973: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6974: }
6975: }
6976: if (!ref($arg)) {
6977: return $arg;
6978: }
6979: }
6980:
1.251 albertel 6981: ###############################################
1.182 matthew 6982:
6983: =pod
6984:
1.549 albertel 6985: =back
6986:
6987: =head1 User Information Routines
6988:
6989: =over 4
6990:
1.405 albertel 6991: =item * &get_users_function()
1.182 matthew 6992:
6993: Used by &bodytag to determine the current users primary role.
6994: Returns either 'student','coordinator','admin', or 'author'.
6995:
6996: =cut
6997:
6998: ###############################################
6999: sub get_users_function {
1.815 tempelho 7000: my $function = 'norole';
1.818 tempelho 7001: if ($env{'request.role'}=~/^(st)/) {
7002: $function='student';
7003: }
1.907 raeburn 7004: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7005: $function='coordinator';
7006: }
1.258 albertel 7007: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7008: $function='admin';
7009: }
1.826 bisitz 7010: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7011: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7012: $function='author';
7013: }
7014: return $function;
1.54 www 7015: }
1.99 www 7016:
7017: ###############################################
7018:
1.233 raeburn 7019: =pod
7020:
1.821 raeburn 7021: =item * &show_course()
7022:
7023: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7024: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7025:
7026: Inputs:
7027: None
7028:
7029: Outputs:
7030: Scalar: 1 if 'Course' to be used, 0 otherwise.
7031:
7032: =cut
7033:
7034: ###############################################
7035: sub show_course {
7036: my $course = !$env{'user.adv'};
7037: if (!$env{'user.adv'}) {
7038: foreach my $env (keys(%env)) {
7039: next if ($env !~ m/^user\.priv\./);
7040: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7041: $course = 0;
7042: last;
7043: }
7044: }
7045: }
7046: return $course;
7047: }
7048:
7049: ###############################################
7050:
7051: =pod
7052:
1.542 raeburn 7053: =item * &check_user_status()
1.274 raeburn 7054:
7055: Determines current status of supplied role for a
7056: specific user. Roles can be active, previous or future.
7057:
7058: Inputs:
7059: user's domain, user's username, course's domain,
1.375 raeburn 7060: course's number, optional section ID.
1.274 raeburn 7061:
7062: Outputs:
7063: role status: active, previous or future.
7064:
7065: =cut
7066:
7067: sub check_user_status {
1.412 raeburn 7068: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7069: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7070: my @uroles = keys %userinfo;
7071: my $srchstr;
7072: my $active_chk = 'none';
1.412 raeburn 7073: my $now = time;
1.274 raeburn 7074: if (@uroles > 0) {
1.908 raeburn 7075: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7076: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7077: } else {
1.412 raeburn 7078: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7079: }
7080: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7081: my $role_end = 0;
7082: my $role_start = 0;
7083: $active_chk = 'active';
1.412 raeburn 7084: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7085: $role_end = $1;
7086: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7087: $role_start = $1;
1.274 raeburn 7088: }
7089: }
7090: if ($role_start > 0) {
1.412 raeburn 7091: if ($now < $role_start) {
1.274 raeburn 7092: $active_chk = 'future';
7093: }
7094: }
7095: if ($role_end > 0) {
1.412 raeburn 7096: if ($now > $role_end) {
1.274 raeburn 7097: $active_chk = 'previous';
7098: }
7099: }
7100: }
7101: }
7102: return $active_chk;
7103: }
7104:
7105: ###############################################
7106:
7107: =pod
7108:
1.405 albertel 7109: =item * &get_sections()
1.233 raeburn 7110:
7111: Determines all the sections for a course including
7112: sections with students and sections containing other roles.
1.419 raeburn 7113: Incoming parameters:
7114:
7115: 1. domain
7116: 2. course number
7117: 3. reference to array containing roles for which sections should
7118: be gathered (optional).
7119: 4. reference to array containing status types for which sections
7120: should be gathered (optional).
7121:
7122: If the third argument is undefined, sections are gathered for any role.
7123: If the fourth argument is undefined, sections are gathered for any status.
7124: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7125:
1.374 raeburn 7126: Returns section hash (keys are section IDs, values are
7127: number of users in each section), subject to the
1.419 raeburn 7128: optional roles filter, optional status filter
1.233 raeburn 7129:
7130: =cut
7131:
7132: ###############################################
7133: sub get_sections {
1.419 raeburn 7134: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7135: if (!defined($cdom) || !defined($cnum)) {
7136: my $cid = $env{'request.course.id'};
7137:
7138: return if (!defined($cid));
7139:
7140: $cdom = $env{'course.'.$cid.'.domain'};
7141: $cnum = $env{'course.'.$cid.'.num'};
7142: }
7143:
7144: my %sectioncount;
1.419 raeburn 7145: my $now = time;
1.240 albertel 7146:
1.366 albertel 7147: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7148: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7149: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7150: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7151: my $start_index = &Apache::loncoursedata::CL_START();
7152: my $end_index = &Apache::loncoursedata::CL_END();
7153: my $status;
1.366 albertel 7154: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7155: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7156: $data->[$status_index],
7157: $data->[$start_index],
7158: $data->[$end_index]);
7159: if ($stu_status eq 'Active') {
7160: $status = 'active';
7161: } elsif ($end < $now) {
7162: $status = 'previous';
7163: } elsif ($start > $now) {
7164: $status = 'future';
7165: }
7166: if ($section ne '-1' && $section !~ /^\s*$/) {
7167: if ((!defined($possible_status)) || (($status ne '') &&
7168: (grep/^\Q$status\E$/,@{$possible_status}))) {
7169: $sectioncount{$section}++;
7170: }
1.240 albertel 7171: }
7172: }
7173: }
7174: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7175: foreach my $user (sort(keys(%courseroles))) {
7176: if ($user !~ /^(\w{2})/) { next; }
7177: my ($role) = ($user =~ /^(\w{2})/);
7178: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7179: my ($section,$status);
1.240 albertel 7180: if ($role eq 'cr' &&
7181: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7182: $section=$1;
7183: }
7184: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7185: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7186: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7187: if ($end == -1 && $start == -1) {
7188: next; #deleted role
7189: }
7190: if (!defined($possible_status)) {
7191: $sectioncount{$section}++;
7192: } else {
7193: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7194: $status = 'active';
7195: } elsif ($end < $now) {
7196: $status = 'future';
7197: } elsif ($start > $now) {
7198: $status = 'previous';
7199: }
7200: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7201: $sectioncount{$section}++;
7202: }
7203: }
1.233 raeburn 7204: }
1.366 albertel 7205: return %sectioncount;
1.233 raeburn 7206: }
7207:
1.274 raeburn 7208: ###############################################
1.294 raeburn 7209:
7210: =pod
1.405 albertel 7211:
7212: =item * &get_course_users()
7213:
1.275 raeburn 7214: Retrieves usernames:domains for users in the specified course
7215: with specific role(s), and access status.
7216:
7217: Incoming parameters:
1.277 albertel 7218: 1. course domain
7219: 2. course number
7220: 3. access status: users must have - either active,
1.275 raeburn 7221: previous, future, or all.
1.277 albertel 7222: 4. reference to array of permissible roles
1.288 raeburn 7223: 5. reference to array of section restrictions (optional)
7224: 6. reference to results object (hash of hashes).
7225: 7. reference to optional userdata hash
1.609 raeburn 7226: 8. reference to optional statushash
1.630 raeburn 7227: 9. flag if privileged users (except those set to unhide in
7228: course settings) should be excluded
1.609 raeburn 7229: Keys of top level results hash are roles.
1.275 raeburn 7230: Keys of inner hashes are username:domain, with
7231: values set to access type.
1.288 raeburn 7232: Optional userdata hash returns an array with arguments in the
7233: same order as loncoursedata::get_classlist() for student data.
7234:
1.609 raeburn 7235: Optional statushash returns
7236:
1.288 raeburn 7237: Entries for end, start, section and status are blank because
7238: of the possibility of multiple values for non-student roles.
7239:
1.275 raeburn 7240: =cut
1.405 albertel 7241:
1.275 raeburn 7242: ###############################################
1.405 albertel 7243:
1.275 raeburn 7244: sub get_course_users {
1.630 raeburn 7245: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7246: my %idx = ();
1.419 raeburn 7247: my %seclists;
1.288 raeburn 7248:
7249: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7250: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7251: $idx{end} = &Apache::loncoursedata::CL_END();
7252: $idx{start} = &Apache::loncoursedata::CL_START();
7253: $idx{id} = &Apache::loncoursedata::CL_ID();
7254: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7255: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7256: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7257:
1.290 albertel 7258: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7259: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7260: my $now = time;
1.277 albertel 7261: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7262: my $match = 0;
1.412 raeburn 7263: my $secmatch = 0;
1.419 raeburn 7264: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7265: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7266: if ($section eq '') {
7267: $section = 'none';
7268: }
1.291 albertel 7269: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7270: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7271: $secmatch = 1;
7272: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7273: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7274: $secmatch = 1;
7275: }
7276: } else {
1.419 raeburn 7277: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7278: $secmatch = 1;
7279: }
1.290 albertel 7280: }
1.412 raeburn 7281: if (!$secmatch) {
7282: next;
7283: }
1.419 raeburn 7284: }
1.275 raeburn 7285: if (defined($$types{'active'})) {
1.288 raeburn 7286: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7287: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7288: $match = 1;
1.275 raeburn 7289: }
7290: }
7291: if (defined($$types{'previous'})) {
1.609 raeburn 7292: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7293: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7294: $match = 1;
1.275 raeburn 7295: }
7296: }
7297: if (defined($$types{'future'})) {
1.609 raeburn 7298: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7299: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7300: $match = 1;
1.275 raeburn 7301: }
7302: }
1.609 raeburn 7303: if ($match) {
7304: push(@{$seclists{$student}},$section);
7305: if (ref($userdata) eq 'HASH') {
7306: $$userdata{$student} = $$classlist{$student};
7307: }
7308: if (ref($statushash) eq 'HASH') {
7309: $statushash->{$student}{'st'}{$section} = $status;
7310: }
1.288 raeburn 7311: }
1.275 raeburn 7312: }
7313: }
1.412 raeburn 7314: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7315: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7316: my $now = time;
1.609 raeburn 7317: my %displaystatus = ( previous => 'Expired',
7318: active => 'Active',
7319: future => 'Future',
7320: );
1.630 raeburn 7321: my %nothide;
7322: if ($hidepriv) {
7323: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7324: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7325: if ($user !~ /:/) {
7326: $nothide{join(':',split(/[\@]/,$user))}=1;
7327: } else {
7328: $nothide{$user} = 1;
7329: }
7330: }
7331: }
1.439 raeburn 7332: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7333: my $match = 0;
1.412 raeburn 7334: my $secmatch = 0;
1.439 raeburn 7335: my $status;
1.412 raeburn 7336: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7337: $user =~ s/:$//;
1.439 raeburn 7338: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7339: if ($end == -1 || $start == -1) {
7340: next;
7341: }
7342: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7343: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7344: my ($uname,$udom) = split(/:/,$user);
7345: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7346: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7347: $secmatch = 1;
7348: } elsif ($usec eq '') {
1.420 albertel 7349: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7350: $secmatch = 1;
7351: }
7352: } else {
7353: if (grep(/^\Q$usec\E$/,@{$sections})) {
7354: $secmatch = 1;
7355: }
7356: }
7357: if (!$secmatch) {
7358: next;
7359: }
1.288 raeburn 7360: }
1.419 raeburn 7361: if ($usec eq '') {
7362: $usec = 'none';
7363: }
1.275 raeburn 7364: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7365: if ($hidepriv) {
7366: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7367: (!$nothide{$uname.':'.$udom})) {
7368: next;
7369: }
7370: }
1.503 raeburn 7371: if ($end > 0 && $end < $now) {
1.439 raeburn 7372: $status = 'previous';
7373: } elsif ($start > $now) {
7374: $status = 'future';
7375: } else {
7376: $status = 'active';
7377: }
1.277 albertel 7378: foreach my $type (keys(%{$types})) {
1.275 raeburn 7379: if ($status eq $type) {
1.420 albertel 7380: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7381: push(@{$$users{$role}{$user}},$type);
7382: }
1.288 raeburn 7383: $match = 1;
7384: }
7385: }
1.419 raeburn 7386: if (($match) && (ref($userdata) eq 'HASH')) {
7387: if (!exists($$userdata{$uname.':'.$udom})) {
7388: &get_user_info($udom,$uname,\%idx,$userdata);
7389: }
1.420 albertel 7390: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7391: push(@{$seclists{$uname.':'.$udom}},$usec);
7392: }
1.609 raeburn 7393: if (ref($statushash) eq 'HASH') {
7394: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7395: }
1.275 raeburn 7396: }
7397: }
7398: }
7399: }
1.290 albertel 7400: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7401: if ((defined($cdom)) && (defined($cnum))) {
7402: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7403: if ( defined($csettings{'internal.courseowner'}) ) {
7404: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7405: next if ($owner eq '');
7406: my ($ownername,$ownerdom);
7407: if ($owner =~ /^([^:]+):([^:]+)$/) {
7408: $ownername = $1;
7409: $ownerdom = $2;
7410: } else {
7411: $ownername = $owner;
7412: $ownerdom = $cdom;
7413: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7414: }
7415: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7416: if (defined($userdata) &&
1.609 raeburn 7417: !exists($$userdata{$owner})) {
7418: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7419: if (!grep(/^none$/,@{$seclists{$owner}})) {
7420: push(@{$seclists{$owner}},'none');
7421: }
7422: if (ref($statushash) eq 'HASH') {
7423: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7424: }
1.290 albertel 7425: }
1.279 raeburn 7426: }
7427: }
7428: }
1.419 raeburn 7429: foreach my $user (keys(%seclists)) {
7430: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7431: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7432: }
1.275 raeburn 7433: }
7434: return;
7435: }
7436:
1.288 raeburn 7437: sub get_user_info {
7438: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7439: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7440: &plainname($uname,$udom,'lastname');
1.291 albertel 7441: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7442: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7443: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7444: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7445: return;
7446: }
1.275 raeburn 7447:
1.472 raeburn 7448: ###############################################
7449:
7450: =pod
7451:
7452: =item * &get_user_quota()
7453:
7454: Retrieves quota assigned for storage of portfolio files for a user
7455:
7456: Incoming parameters:
7457: 1. user's username
7458: 2. user's domain
7459:
7460: Returns:
1.536 raeburn 7461: 1. Disk quota (in Mb) assigned to student.
7462: 2. (Optional) Type of setting: custom or default
7463: (individually assigned or default for user's
7464: institutional status).
7465: 3. (Optional) - User's institutional status (e.g., faculty, staff
7466: or student - types as defined in localenroll::inst_usertypes
7467: for user's domain, which determines default quota for user.
7468: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7469:
7470: If a value has been stored in the user's environment,
1.536 raeburn 7471: it will return that, otherwise it returns the maximal default
7472: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7473:
7474: =cut
7475:
7476: ###############################################
7477:
7478:
7479: sub get_user_quota {
7480: my ($uname,$udom) = @_;
1.536 raeburn 7481: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7482: if (!defined($udom)) {
7483: $udom = $env{'user.domain'};
7484: }
7485: if (!defined($uname)) {
7486: $uname = $env{'user.name'};
7487: }
7488: if (($udom eq '' || $uname eq '') ||
7489: ($udom eq 'public') && ($uname eq 'public')) {
7490: $quota = 0;
1.536 raeburn 7491: $quotatype = 'default';
7492: $defquota = 0;
1.472 raeburn 7493: } else {
1.536 raeburn 7494: my $inststatus;
1.472 raeburn 7495: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7496: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7497: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7498: } else {
1.536 raeburn 7499: my %userenv =
7500: &Apache::lonnet::get('environment',['portfolioquota',
7501: 'inststatus'],$udom,$uname);
1.472 raeburn 7502: my ($tmp) = keys(%userenv);
7503: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7504: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7505: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7506: } else {
7507: undef(%userenv);
7508: }
7509: }
1.536 raeburn 7510: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7511: if ($quota eq '') {
1.536 raeburn 7512: $quota = $defquota;
7513: $quotatype = 'default';
7514: } else {
7515: $quotatype = 'custom';
1.472 raeburn 7516: }
7517: }
1.536 raeburn 7518: if (wantarray) {
7519: return ($quota,$quotatype,$settingstatus,$defquota);
7520: } else {
7521: return $quota;
7522: }
1.472 raeburn 7523: }
7524:
7525: ###############################################
7526:
7527: =pod
7528:
7529: =item * &default_quota()
7530:
1.536 raeburn 7531: Retrieves default quota assigned for storage of user portfolio files,
7532: given an (optional) user's institutional status.
1.472 raeburn 7533:
7534: Incoming parameters:
7535: 1. domain
1.536 raeburn 7536: 2. (Optional) institutional status(es). This is a : separated list of
7537: status types (e.g., faculty, staff, student etc.)
7538: which apply to the user for whom the default is being retrieved.
7539: If the institutional status string in undefined, the domain
7540: default quota will be returned.
1.472 raeburn 7541:
7542: Returns:
7543: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7544: 2. (Optional) institutional type which determined the value of the
7545: default quota.
1.472 raeburn 7546:
7547: If a value has been stored in the domain's configuration db,
7548: it will return that, otherwise it returns 20 (for backwards
7549: compatibility with domains which have not set up a configuration
7550: db file; the original statically defined portfolio quota was 20 Mb).
7551:
1.536 raeburn 7552: If the user's status includes multiple types (e.g., staff and student),
7553: the largest default quota which applies to the user determines the
7554: default quota returned.
7555:
1.780 raeburn 7556: =back
7557:
1.472 raeburn 7558: =cut
7559:
7560: ###############################################
7561:
7562:
7563: sub default_quota {
1.536 raeburn 7564: my ($udom,$inststatus) = @_;
7565: my ($defquota,$settingstatus);
7566: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7567: ['quotas'],$udom);
7568: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7569: if ($inststatus ne '') {
1.765 raeburn 7570: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7571: foreach my $item (@statuses) {
1.711 raeburn 7572: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7573: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7574: if ($defquota eq '') {
7575: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7576: $settingstatus = $item;
7577: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7578: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7579: $settingstatus = $item;
7580: }
7581: }
7582: } else {
7583: if ($quotahash{'quotas'}{$item} ne '') {
7584: if ($defquota eq '') {
7585: $defquota = $quotahash{'quotas'}{$item};
7586: $settingstatus = $item;
7587: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7588: $defquota = $quotahash{'quotas'}{$item};
7589: $settingstatus = $item;
7590: }
1.536 raeburn 7591: }
7592: }
7593: }
7594: }
7595: if ($defquota eq '') {
1.711 raeburn 7596: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7597: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7598: } else {
7599: $defquota = $quotahash{'quotas'}{'default'};
7600: }
1.536 raeburn 7601: $settingstatus = 'default';
7602: }
7603: } else {
7604: $settingstatus = 'default';
7605: $defquota = 20;
7606: }
7607: if (wantarray) {
7608: return ($defquota,$settingstatus);
1.472 raeburn 7609: } else {
1.536 raeburn 7610: return $defquota;
1.472 raeburn 7611: }
7612: }
7613:
1.384 raeburn 7614: sub get_secgrprole_info {
7615: my ($cdom,$cnum,$needroles,$type) = @_;
7616: my %sections_count = &get_sections($cdom,$cnum);
7617: my @sections = (sort {$a <=> $b} keys(%sections_count));
7618: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7619: my @groups = sort(keys(%curr_groups));
7620: my $allroles = [];
7621: my $rolehash;
7622: my $accesshash = {
7623: active => 'Currently has access',
7624: future => 'Will have future access',
7625: previous => 'Previously had access',
7626: };
7627: if ($needroles) {
7628: $rolehash = {'all' => 'all'};
1.385 albertel 7629: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7630: if (&Apache::lonnet::error(%user_roles)) {
7631: undef(%user_roles);
7632: }
7633: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7634: my ($role)=split(/\:/,$item,2);
7635: if ($role eq 'cr') { next; }
7636: if ($role =~ /^cr/) {
7637: $$rolehash{$role} = (split('/',$role))[3];
7638: } else {
7639: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7640: }
7641: }
7642: foreach my $key (sort(keys(%{$rolehash}))) {
7643: push(@{$allroles},$key);
7644: }
7645: push (@{$allroles},'st');
7646: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7647: }
7648: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7649: }
7650:
1.555 raeburn 7651: sub user_picker {
1.627 raeburn 7652: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7653: my $currdom = $dom;
7654: my %curr_selected = (
7655: srchin => 'dom',
1.580 raeburn 7656: srchby => 'lastname',
1.555 raeburn 7657: );
7658: my $srchterm;
1.625 raeburn 7659: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7660: if ($srch->{'srchby'} ne '') {
7661: $curr_selected{'srchby'} = $srch->{'srchby'};
7662: }
7663: if ($srch->{'srchin'} ne '') {
7664: $curr_selected{'srchin'} = $srch->{'srchin'};
7665: }
7666: if ($srch->{'srchtype'} ne '') {
7667: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7668: }
7669: if ($srch->{'srchdomain'} ne '') {
7670: $currdom = $srch->{'srchdomain'};
7671: }
7672: $srchterm = $srch->{'srchterm'};
7673: }
7674: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7675: 'usr' => 'Search criteria',
1.563 raeburn 7676: 'doma' => 'Domain/institution to search',
1.558 albertel 7677: 'uname' => 'username',
7678: 'lastname' => 'last name',
1.555 raeburn 7679: 'lastfirst' => 'last name, first name',
1.558 albertel 7680: 'crs' => 'in this course',
1.576 raeburn 7681: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7682: 'alc' => 'all LON-CAPA',
1.573 raeburn 7683: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7684: 'exact' => 'is',
7685: 'contains' => 'contains',
1.569 raeburn 7686: 'begins' => 'begins with',
1.571 raeburn 7687: 'youm' => "You must include some text to search for.",
7688: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7689: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7690: 'yomc' => "You must choose a domain when using an institutional directory search.",
7691: 'ymcd' => "You must choose a domain when using a domain search.",
7692: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7693: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7694: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7695: );
1.563 raeburn 7696: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7697: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7698:
7699: my @srchins = ('crs','dom','alc','instd');
7700:
7701: foreach my $option (@srchins) {
7702: # FIXME 'alc' option unavailable until
7703: # loncreateuser::print_user_query_page()
7704: # has been completed.
7705: next if ($option eq 'alc');
1.880 raeburn 7706: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7707: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7708: if ($curr_selected{'srchin'} eq $option) {
7709: $srchinsel .= '
7710: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7711: } else {
7712: $srchinsel .= '
7713: <option value="'.$option.'">'.$lt{$option}.'</option>';
7714: }
1.555 raeburn 7715: }
1.563 raeburn 7716: $srchinsel .= "\n </select>\n";
1.555 raeburn 7717:
7718: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7719: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7720: if ($curr_selected{'srchby'} eq $option) {
7721: $srchbysel .= '
7722: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7723: } else {
7724: $srchbysel .= '
7725: <option value="'.$option.'">'.$lt{$option}.'</option>';
7726: }
7727: }
7728: $srchbysel .= "\n </select>\n";
7729:
7730: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7731: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7732: if ($curr_selected{'srchtype'} eq $option) {
7733: $srchtypesel .= '
7734: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7735: } else {
7736: $srchtypesel .= '
7737: <option value="'.$option.'">'.$lt{$option}.'</option>';
7738: }
7739: }
7740: $srchtypesel .= "\n </select>\n";
7741:
1.558 albertel 7742: my ($newuserscript,$new_user_create);
1.556 raeburn 7743:
7744: if ($forcenewuser) {
1.576 raeburn 7745: if (ref($srch) eq 'HASH') {
7746: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7747: if ($cancreate) {
7748: $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>';
7749: } else {
1.799 bisitz 7750: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7751: my %usertypetext = (
7752: official => 'institutional',
7753: unofficial => 'non-institutional',
7754: );
1.799 bisitz 7755: $new_user_create = '<p class="LC_warning">'
7756: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7757: .' '
7758: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7759: ,'<a href="'.$helplink.'">','</a>')
7760: .'</p><br />';
1.627 raeburn 7761: }
1.576 raeburn 7762: }
7763: }
7764:
1.556 raeburn 7765: $newuserscript = <<"ENDSCRIPT";
7766:
1.570 raeburn 7767: function setSearch(createnew,callingForm) {
1.556 raeburn 7768: if (createnew == 1) {
1.570 raeburn 7769: for (var i=0; i<callingForm.srchby.length; i++) {
7770: if (callingForm.srchby.options[i].value == 'uname') {
7771: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7772: }
7773: }
1.570 raeburn 7774: for (var i=0; i<callingForm.srchin.length; i++) {
7775: if ( callingForm.srchin.options[i].value == 'dom') {
7776: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7777: }
7778: }
1.570 raeburn 7779: for (var i=0; i<callingForm.srchtype.length; i++) {
7780: if (callingForm.srchtype.options[i].value == 'exact') {
7781: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7782: }
7783: }
1.570 raeburn 7784: for (var i=0; i<callingForm.srchdomain.length; i++) {
7785: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7786: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7787: }
7788: }
7789: }
7790: }
7791: ENDSCRIPT
1.558 albertel 7792:
1.556 raeburn 7793: }
7794:
1.555 raeburn 7795: my $output = <<"END_BLOCK";
1.556 raeburn 7796: <script type="text/javascript">
1.824 bisitz 7797: // <![CDATA[
1.570 raeburn 7798: function validateEntry(callingForm) {
1.558 albertel 7799:
1.556 raeburn 7800: var checkok = 1;
1.558 albertel 7801: var srchin;
1.570 raeburn 7802: for (var i=0; i<callingForm.srchin.length; i++) {
7803: if ( callingForm.srchin[i].checked ) {
7804: srchin = callingForm.srchin[i].value;
1.558 albertel 7805: }
7806: }
7807:
1.570 raeburn 7808: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7809: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7810: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7811: var srchterm = callingForm.srchterm.value;
7812: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7813: var msg = "";
7814:
7815: if (srchterm == "") {
7816: checkok = 0;
1.571 raeburn 7817: msg += "$lt{'youm'}\\n";
1.556 raeburn 7818: }
7819:
1.569 raeburn 7820: if (srchtype== 'begins') {
7821: if (srchterm.length < 2) {
7822: checkok = 0;
1.571 raeburn 7823: msg += "$lt{'thte'}\\n";
1.569 raeburn 7824: }
7825: }
7826:
1.556 raeburn 7827: if (srchtype== 'contains') {
7828: if (srchterm.length < 3) {
7829: checkok = 0;
1.571 raeburn 7830: msg += "$lt{'thet'}\\n";
1.556 raeburn 7831: }
7832: }
7833: if (srchin == 'instd') {
7834: if (srchdomain == '') {
7835: checkok = 0;
1.571 raeburn 7836: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7837: }
7838: }
7839: if (srchin == 'dom') {
7840: if (srchdomain == '') {
7841: checkok = 0;
1.571 raeburn 7842: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7843: }
7844: }
7845: if (srchby == 'lastfirst') {
7846: if (srchterm.indexOf(",") == -1) {
7847: checkok = 0;
1.571 raeburn 7848: msg += "$lt{'whus'}\\n";
1.556 raeburn 7849: }
7850: if (srchterm.indexOf(",") == srchterm.length -1) {
7851: checkok = 0;
1.571 raeburn 7852: msg += "$lt{'whse'}\\n";
1.556 raeburn 7853: }
7854: }
7855: if (checkok == 0) {
1.571 raeburn 7856: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7857: return;
7858: }
7859: if (checkok == 1) {
1.570 raeburn 7860: callingForm.submit();
1.556 raeburn 7861: }
7862: }
7863:
7864: $newuserscript
7865:
1.824 bisitz 7866: // ]]>
1.556 raeburn 7867: </script>
1.558 albertel 7868:
7869: $new_user_create
7870:
1.555 raeburn 7871: END_BLOCK
1.558 albertel 7872:
1.876 raeburn 7873: $output .= &Apache::lonhtmlcommon::start_pick_box().
7874: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7875: $domform.
7876: &Apache::lonhtmlcommon::row_closure().
7877: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7878: $srchbysel.
7879: $srchtypesel.
7880: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7881: $srchinsel.
7882: &Apache::lonhtmlcommon::row_closure(1).
7883: &Apache::lonhtmlcommon::end_pick_box().
7884: '<br />';
1.555 raeburn 7885: return $output;
7886: }
7887:
1.612 raeburn 7888: sub user_rule_check {
1.615 raeburn 7889: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7890: my $response;
7891: if (ref($usershash) eq 'HASH') {
7892: foreach my $user (keys(%{$usershash})) {
7893: my ($uname,$udom) = split(/:/,$user);
7894: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7895: my ($id,$newuser);
1.612 raeburn 7896: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7897: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7898: $id = $usershash->{$user}->{'id'};
7899: }
7900: my $inst_response;
7901: if (ref($checks) eq 'HASH') {
7902: if (defined($checks->{'username'})) {
1.615 raeburn 7903: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7904: &Apache::lonnet::get_instuser($udom,$uname);
7905: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7906: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7907: &Apache::lonnet::get_instuser($udom,undef,$id);
7908: }
1.615 raeburn 7909: } else {
7910: ($inst_response,%{$inst_results->{$user}}) =
7911: &Apache::lonnet::get_instuser($udom,$uname);
7912: return;
1.612 raeburn 7913: }
1.615 raeburn 7914: if (!$got_rules->{$udom}) {
1.612 raeburn 7915: my %domconfig = &Apache::lonnet::get_dom('configuration',
7916: ['usercreation'],$udom);
7917: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7918: foreach my $item ('username','id') {
1.612 raeburn 7919: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7920: $$curr_rules{$udom}{$item} =
7921: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7922: }
7923: }
7924: }
1.615 raeburn 7925: $got_rules->{$udom} = 1;
1.585 raeburn 7926: }
1.612 raeburn 7927: foreach my $item (keys(%{$checks})) {
7928: if (ref($$curr_rules{$udom}) eq 'HASH') {
7929: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7930: if (@{$$curr_rules{$udom}{$item}} > 0) {
7931: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7932: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7933: if ($rule_check{$rule}) {
7934: $$rulematch{$user}{$item} = $rule;
7935: if ($inst_response eq 'ok') {
1.615 raeburn 7936: if (ref($inst_results) eq 'HASH') {
7937: if (ref($inst_results->{$user}) eq 'HASH') {
7938: if (keys(%{$inst_results->{$user}}) == 0) {
7939: $$alerts{$item}{$udom}{$uname} = 1;
7940: }
1.612 raeburn 7941: }
7942: }
1.615 raeburn 7943: }
7944: last;
1.585 raeburn 7945: }
7946: }
7947: }
7948: }
7949: }
7950: }
7951: }
7952: }
1.612 raeburn 7953: return;
7954: }
7955:
7956: sub user_rule_formats {
7957: my ($domain,$domdesc,$curr_rules,$check) = @_;
7958: my %text = (
7959: 'username' => 'Usernames',
7960: 'id' => 'IDs',
7961: );
7962: my $output;
7963: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7964: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7965: if (@{$ruleorder} > 0) {
7966: $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>';
7967: foreach my $rule (@{$ruleorder}) {
7968: if (ref($curr_rules) eq 'ARRAY') {
7969: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7970: if (ref($rules->{$rule}) eq 'HASH') {
7971: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7972: $rules->{$rule}{'desc'}.'</li>';
7973: }
7974: }
7975: }
7976: }
7977: $output .= '</ul>';
7978: }
7979: }
7980: return $output;
7981: }
7982:
7983: sub instrule_disallow_msg {
1.615 raeburn 7984: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7985: my $response;
7986: my %text = (
7987: item => 'username',
7988: items => 'usernames',
7989: match => 'matches',
7990: do => 'does',
7991: action => 'a username',
7992: one => 'one',
7993: );
7994: if ($count > 1) {
7995: $text{'item'} = 'usernames';
7996: $text{'match'} ='match';
7997: $text{'do'} = 'do';
7998: $text{'action'} = 'usernames',
7999: $text{'one'} = 'ones';
8000: }
8001: if ($checkitem eq 'id') {
8002: $text{'items'} = 'IDs';
8003: $text{'item'} = 'ID';
8004: $text{'action'} = 'an ID';
1.615 raeburn 8005: if ($count > 1) {
8006: $text{'item'} = 'IDs';
8007: $text{'action'} = 'IDs';
8008: }
1.612 raeburn 8009: }
1.674 bisitz 8010: $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 8011: if ($mode eq 'upload') {
8012: if ($checkitem eq 'username') {
8013: $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'}.");
8014: } elsif ($checkitem eq 'id') {
1.674 bisitz 8015: $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 8016: }
1.669 raeburn 8017: } elsif ($mode eq 'selfcreate') {
8018: if ($checkitem eq 'id') {
8019: $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.");
8020: }
1.615 raeburn 8021: } else {
8022: if ($checkitem eq 'username') {
8023: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8024: } elsif ($checkitem eq 'id') {
8025: $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.");
8026: }
1.612 raeburn 8027: }
8028: return $response;
1.585 raeburn 8029: }
8030:
1.624 raeburn 8031: sub personal_data_fieldtitles {
8032: my %fieldtitles = &Apache::lonlocal::texthash (
8033: id => 'Student/Employee ID',
8034: permanentemail => 'E-mail address',
8035: lastname => 'Last Name',
8036: firstname => 'First Name',
8037: middlename => 'Middle Name',
8038: generation => 'Generation',
8039: gen => 'Generation',
1.765 raeburn 8040: inststatus => 'Affiliation',
1.624 raeburn 8041: );
8042: return %fieldtitles;
8043: }
8044:
1.642 raeburn 8045: sub sorted_inst_types {
8046: my ($dom) = @_;
8047: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8048: my $othertitle = &mt('All users');
8049: if ($env{'request.course.id'}) {
1.668 raeburn 8050: $othertitle = &mt('Any users');
1.642 raeburn 8051: }
8052: my @types;
8053: if (ref($order) eq 'ARRAY') {
8054: @types = @{$order};
8055: }
8056: if (@types == 0) {
8057: if (ref($usertypes) eq 'HASH') {
8058: @types = sort(keys(%{$usertypes}));
8059: }
8060: }
8061: if (keys(%{$usertypes}) > 0) {
8062: $othertitle = &mt('Other users');
8063: }
8064: return ($othertitle,$usertypes,\@types);
8065: }
8066:
1.645 raeburn 8067: sub get_institutional_codes {
8068: my ($settings,$allcourses,$LC_code) = @_;
8069: # Get complete list of course sections to update
8070: my @currsections = ();
8071: my @currxlists = ();
8072: my $coursecode = $$settings{'internal.coursecode'};
8073:
8074: if ($$settings{'internal.sectionnums'} ne '') {
8075: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8076: }
8077:
8078: if ($$settings{'internal.crosslistings'} ne '') {
8079: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8080: }
8081:
8082: if (@currxlists > 0) {
8083: foreach (@currxlists) {
8084: if (m/^([^:]+):(\w*)$/) {
8085: unless (grep/^$1$/,@{$allcourses}) {
8086: push @{$allcourses},$1;
8087: $$LC_code{$1} = $2;
8088: }
8089: }
8090: }
8091: }
8092:
8093: if (@currsections > 0) {
8094: foreach (@currsections) {
8095: if (m/^(\w+):(\w*)$/) {
8096: my $sec = $coursecode.$1;
8097: my $lc_sec = $2;
8098: unless (grep/^$sec$/,@{$allcourses}) {
8099: push @{$allcourses},$sec;
8100: $$LC_code{$sec} = $lc_sec;
8101: }
8102: }
8103: }
8104: }
8105: return;
8106: }
8107:
1.112 bowersj2 8108: =pod
8109:
1.780 raeburn 8110: =head1 Slot Helpers
8111:
8112: =over 4
8113:
8114: =item * sorted_slots()
8115:
8116: Sorts an array of slot names in order of slot start time (earliest first).
8117:
8118: Inputs:
8119:
8120: =over 4
8121:
8122: slotsarr - Reference to array of unsorted slot names.
8123:
8124: slots - Reference to hash of hash, where outer hash keys are slot names.
8125:
1.549 albertel 8126: =back
8127:
1.780 raeburn 8128: Returns:
8129:
8130: =over 4
8131:
8132: sorted - An array of slot names sorted by the start time of the slot.
8133:
8134: =back
8135:
8136: =back
8137:
8138: =cut
8139:
8140:
8141: sub sorted_slots {
8142: my ($slotsarr,$slots) = @_;
8143: my @sorted;
8144: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8145: @sorted =
8146: sort {
8147: if (ref($slots->{$a}) && ref($slots->{$b})) {
8148: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8149: }
8150: if (ref($slots->{$a})) { return -1;}
8151: if (ref($slots->{$b})) { return 1;}
8152: return 0;
8153: } @{$slotsarr};
8154: }
8155: return @sorted;
8156: }
8157:
8158:
8159: =pod
8160:
1.549 albertel 8161: =head1 HTTP Helpers
8162:
8163: =over 4
8164:
1.648 raeburn 8165: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8166:
1.258 albertel 8167: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8168: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8169: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8170:
8171: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8172: $possible_names is an ref to an array of form element names. As an example:
8173: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8174: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8175:
8176: =cut
1.1 albertel 8177:
1.6 albertel 8178: sub get_unprocessed_cgi {
1.25 albertel 8179: my ($query,$possible_names)= @_;
1.26 matthew 8180: # $Apache::lonxml::debug=1;
1.356 albertel 8181: foreach my $pair (split(/&/,$query)) {
8182: my ($name, $value) = split(/=/,$pair);
1.369 www 8183: $name = &unescape($name);
1.25 albertel 8184: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8185: $value =~ tr/+/ /;
8186: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8187: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8188: }
1.16 harris41 8189: }
1.6 albertel 8190: }
8191:
1.112 bowersj2 8192: =pod
8193:
1.648 raeburn 8194: =item * &cacheheader()
1.112 bowersj2 8195:
8196: returns cache-controlling header code
8197:
8198: =cut
8199:
1.7 albertel 8200: sub cacheheader {
1.258 albertel 8201: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8202: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8203: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8204: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8205: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8206: return $output;
1.7 albertel 8207: }
8208:
1.112 bowersj2 8209: =pod
8210:
1.648 raeburn 8211: =item * &no_cache($r)
1.112 bowersj2 8212:
8213: specifies header code to not have cache
8214:
8215: =cut
8216:
1.9 albertel 8217: sub no_cache {
1.216 albertel 8218: my ($r) = @_;
8219: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8220: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8221: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8222: $r->no_cache(1);
8223: $r->header_out("Expires" => $date);
8224: $r->header_out("Pragma" => "no-cache");
1.123 www 8225: }
8226:
8227: sub content_type {
1.181 albertel 8228: my ($r,$type,$charset) = @_;
1.299 foxr 8229: if ($r) {
8230: # Note that printout.pl calls this with undef for $r.
8231: &no_cache($r);
8232: }
1.258 albertel 8233: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8234: unless ($charset) {
8235: $charset=&Apache::lonlocal::current_encoding;
8236: }
8237: if ($charset) { $type.='; charset='.$charset; }
8238: if ($r) {
8239: $r->content_type($type);
8240: } else {
8241: print("Content-type: $type\n\n");
8242: }
1.9 albertel 8243: }
1.25 albertel 8244:
1.112 bowersj2 8245: =pod
8246:
1.648 raeburn 8247: =item * &add_to_env($name,$value)
1.112 bowersj2 8248:
1.258 albertel 8249: adds $name to the %env hash with value
1.112 bowersj2 8250: $value, if $name already exists, the entry is converted to an array
8251: reference and $value is added to the array.
8252:
8253: =cut
8254:
1.25 albertel 8255: sub add_to_env {
8256: my ($name,$value)=@_;
1.258 albertel 8257: if (defined($env{$name})) {
8258: if (ref($env{$name})) {
1.25 albertel 8259: #already have multiple values
1.258 albertel 8260: push(@{ $env{$name} },$value);
1.25 albertel 8261: } else {
8262: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8263: my $first=$env{$name};
8264: undef($env{$name});
8265: push(@{ $env{$name} },$first,$value);
1.25 albertel 8266: }
8267: } else {
1.258 albertel 8268: $env{$name}=$value;
1.25 albertel 8269: }
1.31 albertel 8270: }
1.149 albertel 8271:
8272: =pod
8273:
1.648 raeburn 8274: =item * &get_env_multiple($name)
1.149 albertel 8275:
1.258 albertel 8276: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8277: values may be defined and end up as an array ref.
8278:
8279: returns an array of values
8280:
8281: =cut
8282:
8283: sub get_env_multiple {
8284: my ($name) = @_;
8285: my @values;
1.258 albertel 8286: if (defined($env{$name})) {
1.149 albertel 8287: # exists is it an array
1.258 albertel 8288: if (ref($env{$name})) {
8289: @values=@{ $env{$name} };
1.149 albertel 8290: } else {
1.258 albertel 8291: $values[0]=$env{$name};
1.149 albertel 8292: }
8293: }
8294: return(@values);
8295: }
8296:
1.660 raeburn 8297: sub ask_for_embedded_content {
8298: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8299: my $upload_output = '
8300: <form name="upload_embedded" action="'.$actionurl.'"
8301: method="post" enctype="multipart/form-data">';
8302: $upload_output .= $state;
1.661 raeburn 8303: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8304:
8305: my $num = 0;
8306: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8307: $upload_output .= &start_data_table_row().
8308: '<td>'.$embed_file.'</td><td>';
8309: if ($args->{'ignore_remote_references'}
8310: && $embed_file =~ m{^\w+://}) {
8311: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8312: } elsif ($args->{'error_on_invalid_names'}
8313: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8314:
8315: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8316:
8317: } else {
8318: $upload_output .='
1.661 raeburn 8319: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8320: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8321: my $attrib = join(':',@{$$allfiles{$embed_file}});
8322: $upload_output .=
8323: "\n\t\t".
8324: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8325: $attrib.'" />';
8326: if (exists($$codebase{$embed_file})) {
8327: $upload_output .=
8328: "\n\t\t".
8329: '<input name="codebase_'.$num.'" type="hidden" value="'.
8330: &escape($$codebase{$embed_file}).'" />';
8331: }
8332: }
8333: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8334: $num++;
8335: }
8336: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8337: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8338: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8339: '.&mt('(only files for which a location has been provided will be uploaded)').'
8340: </form>';
8341: return $upload_output;
8342: }
8343:
1.661 raeburn 8344: sub upload_embedded {
8345: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8346: $current_disk_usage) = @_;
8347: my $output;
8348: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8349: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8350: my $orig_uploaded_filename =
8351: $env{'form.embedded_item_'.$i.'.filename'};
8352:
8353: $env{'form.embedded_orig_'.$i} =
8354: &unescape($env{'form.embedded_orig_'.$i});
8355: my ($path,$fname) =
8356: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8357: # no path, whole string is fname
8358: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8359:
8360: $path = $env{'form.currentpath'}.$path;
8361: $fname = &Apache::lonnet::clean_filename($fname);
8362: # See if there is anything left
8363: next if ($fname eq '');
8364:
8365: # Check if file already exists as a file or directory.
8366: my ($state,$msg);
8367: if ($context eq 'portfolio') {
8368: my $port_path = $dirpath;
8369: if ($group ne '') {
8370: $port_path = "groups/$group/$port_path";
8371: }
8372: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8373: $dir_root,$port_path,$disk_quota,
8374: $current_disk_usage,$uname,$udom);
8375: if ($state eq 'will_exceed_quota'
8376: || $state eq 'file_locked'
8377: || $state eq 'file_exists' ) {
8378: $output .= $msg;
8379: next;
8380: }
8381: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8382: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8383: if ($state eq 'exists') {
8384: $output .= $msg;
8385: next;
8386: }
8387: }
8388: # Check if extension is valid
8389: if (($fname =~ /\.(\w+)$/) &&
8390: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8391: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8392: next;
8393: } elsif (($fname =~ /\.(\w+)$/) &&
8394: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8395: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8396: next;
8397: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8398: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8399: next;
8400: }
8401:
8402: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8403: if ($context eq 'portfolio') {
8404: my $result=
8405: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8406: $dirpath.$path);
8407: if ($result !~ m|^/uploaded/|) {
8408: $output .= '<span class="LC_error">'
8409: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8410: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8411: .'</span><br />';
8412: next;
8413: } else {
8414: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8415: $path.$fname.'</span>').'</p>';
8416: }
8417: } else {
8418: # Save the file
8419: my $target = $env{'form.embedded_item_'.$i};
8420: my $fullpath = $dir_root.$dirpath.'/'.$path;
8421: my $dest = $fullpath.$fname;
8422: my $url = $url_root.$dirpath.'/'.$path.$fname;
8423: my @parts=split(/\//,$fullpath);
8424: my $count;
8425: my $filepath = $dir_root;
8426: for ($count=4;$count<=$#parts;$count++) {
8427: $filepath .= "/$parts[$count]";
8428: if ((-e $filepath)!=1) {
8429: mkdir($filepath,0770);
8430: }
8431: }
8432: my $fh;
8433: if (!open($fh,'>'.$dest)) {
8434: &Apache::lonnet::logthis('Failed to create '.$dest);
8435: $output .= '<span class="LC_error">'.
8436: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8437: '</span><br />';
8438: } else {
8439: if (!print $fh $env{'form.embedded_item_'.$i}) {
8440: &Apache::lonnet::logthis('Failed to write to '.$dest);
8441: $output .= '<span class="LC_error">'.
8442: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8443: '</span><br />';
8444: } else {
8445: if ($context eq 'testbank') {
8446: $output .= &mt('Embedded file uploaded successfully:').
8447: ' <a href="'.$url.'">'.
8448: $orig_uploaded_filename.'</a><br />';
8449: } else {
1.705 tempelho 8450: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8451: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8452: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8453: }
8454: }
8455: close($fh);
8456: }
8457: }
8458: }
8459: return $output;
8460: }
8461:
8462: sub check_for_existing {
8463: my ($path,$fname,$element) = @_;
8464: my ($state,$msg);
8465: if (-d $path.'/'.$fname) {
8466: $state = 'exists';
8467: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8468: } elsif (-e $path.'/'.$fname) {
8469: $state = 'exists';
8470: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8471: }
8472: if ($state eq 'exists') {
8473: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8474: }
8475: return ($state,$msg);
8476: }
8477:
8478: sub check_for_upload {
8479: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8480: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8481: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8482: my $getpropath = 1;
8483: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8484: $getpropath);
8485: my $found_file = 0;
8486: my $locked_file = 0;
8487: foreach my $line (@dir_list) {
8488: my ($file_name)=split(/\&/,$line,2);
8489: if ($file_name eq $fname){
8490: $file_name = $path.$file_name;
8491: if ($group ne '') {
8492: $file_name = $group.$file_name;
8493: }
8494: $found_file = 1;
8495: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8496: $locked_file = 1;
8497: }
8498: }
8499: }
8500: if (($current_disk_usage + $filesize) > $disk_quota){
8501: my $msg = '<span class="LC_error">'.
8502: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8503: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8504: return ('will_exceed_quota',$msg);
8505: } elsif ($found_file) {
8506: if ($locked_file) {
8507: my $msg = '<span class="LC_error">';
8508: $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>');
8509: $msg .= '</span><br />';
8510: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8511: return ('file_locked',$msg);
8512: } else {
8513: my $msg = '<span class="LC_error">';
8514: $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'});
8515: $msg .= '</span>';
8516: $msg .= '<br />';
8517: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8518: return ('file_exists',$msg);
8519: }
8520: }
8521: }
8522:
1.31 albertel 8523:
1.41 ng 8524: =pod
1.45 matthew 8525:
1.464 albertel 8526: =back
1.41 ng 8527:
1.112 bowersj2 8528: =head1 CSV Upload/Handling functions
1.38 albertel 8529:
1.41 ng 8530: =over 4
8531:
1.648 raeburn 8532: =item * &upfile_store($r)
1.41 ng 8533:
8534: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8535: needs $env{'form.upfile'}
1.41 ng 8536: returns $datatoken to be put into hidden field
8537:
8538: =cut
1.31 albertel 8539:
8540: sub upfile_store {
8541: my $r=shift;
1.258 albertel 8542: $env{'form.upfile'}=~s/\r/\n/gs;
8543: $env{'form.upfile'}=~s/\f/\n/gs;
8544: $env{'form.upfile'}=~s/\n+/\n/gs;
8545: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8546:
1.258 albertel 8547: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8548: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8549: {
1.158 raeburn 8550: my $datafile = $r->dir_config('lonDaemons').
8551: '/tmp/'.$datatoken.'.tmp';
8552: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8553: print $fh $env{'form.upfile'};
1.158 raeburn 8554: close($fh);
8555: }
1.31 albertel 8556: }
8557: return $datatoken;
8558: }
8559:
1.56 matthew 8560: =pod
8561:
1.648 raeburn 8562: =item * &load_tmp_file($r)
1.41 ng 8563:
8564: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8565: needs $env{'form.datatoken'},
8566: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8567:
8568: =cut
1.31 albertel 8569:
8570: sub load_tmp_file {
8571: my $r=shift;
8572: my @studentdata=();
8573: {
1.158 raeburn 8574: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8575: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8576: if ( open(my $fh,"<$studentfile") ) {
8577: @studentdata=<$fh>;
8578: close($fh);
8579: }
1.31 albertel 8580: }
1.258 albertel 8581: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8582: }
8583:
1.56 matthew 8584: =pod
8585:
1.648 raeburn 8586: =item * &upfile_record_sep()
1.41 ng 8587:
8588: Separate uploaded file into records
8589: returns array of records,
1.258 albertel 8590: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8591:
8592: =cut
1.31 albertel 8593:
8594: sub upfile_record_sep {
1.258 albertel 8595: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8596: } else {
1.248 albertel 8597: my @records;
1.258 albertel 8598: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8599: if ($line=~/^\s*$/) { next; }
8600: push(@records,$line);
8601: }
8602: return @records;
1.31 albertel 8603: }
8604: }
8605:
1.56 matthew 8606: =pod
8607:
1.648 raeburn 8608: =item * &record_sep($record)
1.41 ng 8609:
1.258 albertel 8610: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8611:
8612: =cut
8613:
1.263 www 8614: sub takeleft {
8615: my $index=shift;
8616: return substr('0000'.$index,-4,4);
8617: }
8618:
1.31 albertel 8619: sub record_sep {
8620: my $record=shift;
8621: my %components=();
1.258 albertel 8622: if ($env{'form.upfiletype'} eq 'xml') {
8623: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8624: my $i=0;
1.356 albertel 8625: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8626: $field=~s/^(\"|\')//;
8627: $field=~s/(\"|\')$//;
1.263 www 8628: $components{&takeleft($i)}=$field;
1.31 albertel 8629: $i++;
8630: }
1.258 albertel 8631: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8632: my $i=0;
1.356 albertel 8633: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8634: $field=~s/^(\"|\')//;
8635: $field=~s/(\"|\')$//;
1.263 www 8636: $components{&takeleft($i)}=$field;
1.31 albertel 8637: $i++;
8638: }
8639: } else {
1.561 www 8640: my $separator=',';
1.480 banghart 8641: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8642: $separator=';';
1.480 banghart 8643: }
1.31 albertel 8644: my $i=0;
1.561 www 8645: # the character we are looking for to indicate the end of a quote or a record
8646: my $looking_for=$separator;
8647: # do not add the characters to the fields
8648: my $ignore=0;
8649: # we just encountered a separator (or the beginning of the record)
8650: my $just_found_separator=1;
8651: # store the field we are working on here
8652: my $field='';
8653: # work our way through all characters in record
8654: foreach my $character ($record=~/(.)/g) {
8655: if ($character eq $looking_for) {
8656: if ($character ne $separator) {
8657: # Found the end of a quote, again looking for separator
8658: $looking_for=$separator;
8659: $ignore=1;
8660: } else {
8661: # Found a separator, store away what we got
8662: $components{&takeleft($i)}=$field;
8663: $i++;
8664: $just_found_separator=1;
8665: $ignore=0;
8666: $field='';
8667: }
8668: next;
8669: }
8670: # single or double quotation marks after a separator indicate beginning of a quote
8671: # we are now looking for the end of the quote and need to ignore separators
8672: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8673: $looking_for=$character;
8674: next;
8675: }
8676: # ignore would be true after we reached the end of a quote
8677: if ($ignore) { next; }
8678: if (($just_found_separator) && ($character=~/\s/)) { next; }
8679: $field.=$character;
8680: $just_found_separator=0;
1.31 albertel 8681: }
1.561 www 8682: # catch the very last entry, since we never encountered the separator
8683: $components{&takeleft($i)}=$field;
1.31 albertel 8684: }
8685: return %components;
8686: }
8687:
1.144 matthew 8688: ######################################################
8689: ######################################################
8690:
1.56 matthew 8691: =pod
8692:
1.648 raeburn 8693: =item * &upfile_select_html()
1.41 ng 8694:
1.144 matthew 8695: Return HTML code to select a file from the users machine and specify
8696: the file type.
1.41 ng 8697:
8698: =cut
8699:
1.144 matthew 8700: ######################################################
8701: ######################################################
1.31 albertel 8702: sub upfile_select_html {
1.144 matthew 8703: my %Types = (
8704: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8705: semisv => &mt('Semicolon separated values'),
1.144 matthew 8706: space => &mt('Space separated'),
8707: tab => &mt('Tabulator separated'),
8708: # xml => &mt('HTML/XML'),
8709: );
8710: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8711: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8712: foreach my $type (sort(keys(%Types))) {
8713: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8714: }
8715: $Str .= "</select>\n";
8716: return $Str;
1.31 albertel 8717: }
8718:
1.301 albertel 8719: sub get_samples {
8720: my ($records,$toget) = @_;
8721: my @samples=({});
8722: my $got=0;
8723: foreach my $rec (@$records) {
8724: my %temp = &record_sep($rec);
8725: if (! grep(/\S/, values(%temp))) { next; }
8726: if (%temp) {
8727: $samples[$got]=\%temp;
8728: $got++;
8729: if ($got == $toget) { last; }
8730: }
8731: }
8732: return \@samples;
8733: }
8734:
1.144 matthew 8735: ######################################################
8736: ######################################################
8737:
1.56 matthew 8738: =pod
8739:
1.648 raeburn 8740: =item * &csv_print_samples($r,$records)
1.41 ng 8741:
8742: Prints a table of sample values from each column uploaded $r is an
8743: Apache Request ref, $records is an arrayref from
8744: &Apache::loncommon::upfile_record_sep
8745:
8746: =cut
8747:
1.144 matthew 8748: ######################################################
8749: ######################################################
1.31 albertel 8750: sub csv_print_samples {
8751: my ($r,$records) = @_;
1.662 bisitz 8752: my $samples = &get_samples($records,5);
1.301 albertel 8753:
1.594 raeburn 8754: $r->print(&mt('Samples').'<br />'.&start_data_table().
8755: &start_data_table_header_row());
1.356 albertel 8756: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8757: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8758: $r->print(&end_data_table_header_row());
1.301 albertel 8759: foreach my $hash (@$samples) {
1.594 raeburn 8760: $r->print(&start_data_table_row());
1.356 albertel 8761: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8762: $r->print('<td>');
1.356 albertel 8763: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8764: $r->print('</td>');
8765: }
1.594 raeburn 8766: $r->print(&end_data_table_row());
1.31 albertel 8767: }
1.594 raeburn 8768: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8769: }
8770:
1.144 matthew 8771: ######################################################
8772: ######################################################
8773:
1.56 matthew 8774: =pod
8775:
1.648 raeburn 8776: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8777:
8778: Prints a table to create associations between values and table columns.
1.144 matthew 8779:
1.41 ng 8780: $r is an Apache Request ref,
8781: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8782: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8783:
8784: =cut
8785:
1.144 matthew 8786: ######################################################
8787: ######################################################
1.31 albertel 8788: sub csv_print_select_table {
8789: my ($r,$records,$d) = @_;
1.301 albertel 8790: my $i=0;
8791: my $samples = &get_samples($records,1);
1.144 matthew 8792: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8793: &start_data_table().&start_data_table_header_row().
1.144 matthew 8794: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8795: '<th>'.&mt('Column').'</th>'.
8796: &end_data_table_header_row()."\n");
1.356 albertel 8797: foreach my $array_ref (@$d) {
8798: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8799: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8800:
1.875 bisitz 8801: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8802: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8803: $r->print('<option value="none"></option>');
1.356 albertel 8804: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8805: $r->print('<option value="'.$sample.'"'.
8806: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8807: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8808: }
1.594 raeburn 8809: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8810: $i++;
8811: }
1.594 raeburn 8812: $r->print(&end_data_table());
1.31 albertel 8813: $i--;
8814: return $i;
8815: }
1.56 matthew 8816:
1.144 matthew 8817: ######################################################
8818: ######################################################
8819:
1.56 matthew 8820: =pod
1.31 albertel 8821:
1.648 raeburn 8822: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8823:
8824: Prints a table of sample values from the upload and can make associate samples to internal names.
8825:
8826: $r is an Apache Request ref,
8827: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8828: $d is an array of 2 element arrays (internal name, displayed name)
8829:
8830: =cut
8831:
1.144 matthew 8832: ######################################################
8833: ######################################################
1.31 albertel 8834: sub csv_samples_select_table {
8835: my ($r,$records,$d) = @_;
8836: my $i=0;
1.144 matthew 8837: #
1.662 bisitz 8838: my $max_samples = 5;
8839: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8840: $r->print(&start_data_table().
8841: &start_data_table_header_row().'<th>'.
8842: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8843: &end_data_table_header_row());
1.301 albertel 8844:
8845: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8846: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8847: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8848: foreach my $option (@$d) {
8849: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8850: $r->print('<option value="'.$value.'"'.
1.253 albertel 8851: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8852: $display.'</option>');
1.31 albertel 8853: }
8854: $r->print('</select></td><td>');
1.662 bisitz 8855: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8856: if (defined($samples->[$line]{$key})) {
8857: $r->print($samples->[$line]{$key}."<br />\n");
8858: }
8859: }
1.594 raeburn 8860: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8861: $i++;
8862: }
1.594 raeburn 8863: $r->print(&end_data_table());
1.31 albertel 8864: $i--;
8865: return($i);
1.115 matthew 8866: }
8867:
1.144 matthew 8868: ######################################################
8869: ######################################################
8870:
1.115 matthew 8871: =pod
8872:
1.648 raeburn 8873: =item * &clean_excel_name($name)
1.115 matthew 8874:
8875: Returns a replacement for $name which does not contain any illegal characters.
8876:
8877: =cut
8878:
1.144 matthew 8879: ######################################################
8880: ######################################################
1.115 matthew 8881: sub clean_excel_name {
8882: my ($name) = @_;
8883: $name =~ s/[:\*\?\/\\]//g;
8884: if (length($name) > 31) {
8885: $name = substr($name,0,31);
8886: }
8887: return $name;
1.25 albertel 8888: }
1.84 albertel 8889:
1.85 albertel 8890: =pod
8891:
1.648 raeburn 8892: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8893:
8894: Returns either 1 or undef
8895:
8896: 1 if the part is to be hidden, undef if it is to be shown
8897:
8898: Arguments are:
8899:
8900: $id the id of the part to be checked
8901: $symb, optional the symb of the resource to check
8902: $udom, optional the domain of the user to check for
8903: $uname, optional the username of the user to check for
8904:
8905: =cut
1.84 albertel 8906:
8907: sub check_if_partid_hidden {
8908: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8909: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8910: $symb,$udom,$uname);
1.141 albertel 8911: my $truth=1;
8912: #if the string starts with !, then the list is the list to show not hide
8913: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8914: my @hiddenlist=split(/,/,$hiddenparts);
8915: foreach my $checkid (@hiddenlist) {
1.141 albertel 8916: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8917: }
1.141 albertel 8918: return !$truth;
1.84 albertel 8919: }
1.127 matthew 8920:
1.138 matthew 8921:
8922: ############################################################
8923: ############################################################
8924:
8925: =pod
8926:
1.157 matthew 8927: =back
8928:
1.138 matthew 8929: =head1 cgi-bin script and graphing routines
8930:
1.157 matthew 8931: =over 4
8932:
1.648 raeburn 8933: =item * &get_cgi_id()
1.138 matthew 8934:
8935: Inputs: none
8936:
8937: Returns an id which can be used to pass environment variables
8938: to various cgi-bin scripts. These environment variables will
8939: be removed from the users environment after a given time by
8940: the routine &Apache::lonnet::transfer_profile_to_env.
8941:
8942: =cut
8943:
8944: ############################################################
8945: ############################################################
1.152 albertel 8946: my $uniq=0;
1.136 matthew 8947: sub get_cgi_id {
1.154 albertel 8948: $uniq=($uniq+1)%100000;
1.280 albertel 8949: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8950: }
8951:
1.127 matthew 8952: ############################################################
8953: ############################################################
8954:
8955: =pod
8956:
1.648 raeburn 8957: =item * &DrawBarGraph()
1.127 matthew 8958:
1.138 matthew 8959: Facilitates the plotting of data in a (stacked) bar graph.
8960: Puts plot definition data into the users environment in order for
8961: graph.png to plot it. Returns an <img> tag for the plot.
8962: The bars on the plot are labeled '1','2',...,'n'.
8963:
8964: Inputs:
8965:
8966: =over 4
8967:
8968: =item $Title: string, the title of the plot
8969:
8970: =item $xlabel: string, text describing the X-axis of the plot
8971:
8972: =item $ylabel: string, text describing the Y-axis of the plot
8973:
8974: =item $Max: scalar, the maximum Y value to use in the plot
8975: If $Max is < any data point, the graph will not be rendered.
8976:
1.140 matthew 8977: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8978: they are plotted. If undefined, default values will be used.
8979:
1.178 matthew 8980: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8981:
1.138 matthew 8982: =item @Values: An array of array references. Each array reference holds data
8983: to be plotted in a stacked bar chart.
8984:
1.239 matthew 8985: =item If the final element of @Values is a hash reference the key/value
8986: pairs will be added to the graph definition.
8987:
1.138 matthew 8988: =back
8989:
8990: Returns:
8991:
8992: An <img> tag which references graph.png and the appropriate identifying
8993: information for the plot.
8994:
1.127 matthew 8995: =cut
8996:
8997: ############################################################
8998: ############################################################
1.134 matthew 8999: sub DrawBarGraph {
1.178 matthew 9000: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9001: #
9002: if (! defined($colors)) {
9003: $colors = ['#33ff00',
9004: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9005: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9006: ];
9007: }
1.228 matthew 9008: my $extra_settings = {};
9009: if (ref($Values[-1]) eq 'HASH') {
9010: $extra_settings = pop(@Values);
9011: }
1.127 matthew 9012: #
1.136 matthew 9013: my $identifier = &get_cgi_id();
9014: my $id = 'cgi.'.$identifier;
1.129 matthew 9015: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9016: return '';
9017: }
1.225 matthew 9018: #
9019: my @Labels;
9020: if (defined($labels)) {
9021: @Labels = @$labels;
9022: } else {
9023: for (my $i=0;$i<@{$Values[0]};$i++) {
9024: push (@Labels,$i+1);
9025: }
9026: }
9027: #
1.129 matthew 9028: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9029: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9030: my %ValuesHash;
9031: my $NumSets=1;
9032: foreach my $array (@Values) {
9033: next if (! ref($array));
1.136 matthew 9034: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9035: join(',',@$array);
1.129 matthew 9036: }
1.127 matthew 9037: #
1.136 matthew 9038: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9039: if ($NumBars < 3) {
9040: $width = 120+$NumBars*32;
1.220 matthew 9041: $xskip = 1;
1.225 matthew 9042: $bar_width = 30;
9043: } elsif ($NumBars < 5) {
9044: $width = 120+$NumBars*20;
9045: $xskip = 1;
9046: $bar_width = 20;
1.220 matthew 9047: } elsif ($NumBars < 10) {
1.136 matthew 9048: $width = 120+$NumBars*15;
9049: $xskip = 1;
9050: $bar_width = 15;
9051: } elsif ($NumBars <= 25) {
9052: $width = 120+$NumBars*11;
9053: $xskip = 5;
9054: $bar_width = 8;
9055: } elsif ($NumBars <= 50) {
9056: $width = 120+$NumBars*8;
9057: $xskip = 5;
9058: $bar_width = 4;
9059: } else {
9060: $width = 120+$NumBars*8;
9061: $xskip = 5;
9062: $bar_width = 4;
9063: }
9064: #
1.137 matthew 9065: $Max = 1 if ($Max < 1);
9066: if ( int($Max) < $Max ) {
9067: $Max++;
9068: $Max = int($Max);
9069: }
1.127 matthew 9070: $Title = '' if (! defined($Title));
9071: $xlabel = '' if (! defined($xlabel));
9072: $ylabel = '' if (! defined($ylabel));
1.369 www 9073: $ValuesHash{$id.'.title'} = &escape($Title);
9074: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9075: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9076: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9077: $ValuesHash{$id.'.NumBars'} = $NumBars;
9078: $ValuesHash{$id.'.NumSets'} = $NumSets;
9079: $ValuesHash{$id.'.PlotType'} = 'bar';
9080: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9081: $ValuesHash{$id.'.height'} = $height;
9082: $ValuesHash{$id.'.width'} = $width;
9083: $ValuesHash{$id.'.xskip'} = $xskip;
9084: $ValuesHash{$id.'.bar_width'} = $bar_width;
9085: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9086: #
1.228 matthew 9087: # Deal with other parameters
9088: while (my ($key,$value) = each(%$extra_settings)) {
9089: $ValuesHash{$id.'.'.$key} = $value;
9090: }
9091: #
1.646 raeburn 9092: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9093: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9094: }
9095:
9096: ############################################################
9097: ############################################################
9098:
9099: =pod
9100:
1.648 raeburn 9101: =item * &DrawXYGraph()
1.137 matthew 9102:
1.138 matthew 9103: Facilitates the plotting of data in an XY graph.
9104: Puts plot definition data into the users environment in order for
9105: graph.png to plot it. Returns an <img> tag for the plot.
9106:
9107: Inputs:
9108:
9109: =over 4
9110:
9111: =item $Title: string, the title of the plot
9112:
9113: =item $xlabel: string, text describing the X-axis of the plot
9114:
9115: =item $ylabel: string, text describing the Y-axis of the plot
9116:
9117: =item $Max: scalar, the maximum Y value to use in the plot
9118: If $Max is < any data point, the graph will not be rendered.
9119:
9120: =item $colors: Array ref containing the hex color codes for the data to be
9121: plotted in. If undefined, default values will be used.
9122:
9123: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9124:
9125: =item $Ydata: Array ref containing Array refs.
1.185 www 9126: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9127:
9128: =item %Values: hash indicating or overriding any default values which are
9129: passed to graph.png.
9130: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9131:
9132: =back
9133:
9134: Returns:
9135:
9136: An <img> tag which references graph.png and the appropriate identifying
9137: information for the plot.
9138:
1.137 matthew 9139: =cut
9140:
9141: ############################################################
9142: ############################################################
9143: sub DrawXYGraph {
9144: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9145: #
9146: # Create the identifier for the graph
9147: my $identifier = &get_cgi_id();
9148: my $id = 'cgi.'.$identifier;
9149: #
9150: $Title = '' if (! defined($Title));
9151: $xlabel = '' if (! defined($xlabel));
9152: $ylabel = '' if (! defined($ylabel));
9153: my %ValuesHash =
9154: (
1.369 www 9155: $id.'.title' => &escape($Title),
9156: $id.'.xlabel' => &escape($xlabel),
9157: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9158: $id.'.y_max_value'=> $Max,
9159: $id.'.labels' => join(',',@$Xlabels),
9160: $id.'.PlotType' => 'XY',
9161: );
9162: #
9163: if (defined($colors) && ref($colors) eq 'ARRAY') {
9164: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9165: }
9166: #
9167: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9168: return '';
9169: }
9170: my $NumSets=1;
1.138 matthew 9171: foreach my $array (@{$Ydata}){
1.137 matthew 9172: next if (! ref($array));
9173: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9174: }
1.138 matthew 9175: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9176: #
9177: # Deal with other parameters
9178: while (my ($key,$value) = each(%Values)) {
9179: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9180: }
9181: #
1.646 raeburn 9182: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9183: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9184: }
9185:
9186: ############################################################
9187: ############################################################
9188:
9189: =pod
9190:
1.648 raeburn 9191: =item * &DrawXYYGraph()
1.138 matthew 9192:
9193: Facilitates the plotting of data in an XY graph with two Y axes.
9194: Puts plot definition data into the users environment in order for
9195: graph.png to plot it. Returns an <img> tag for the plot.
9196:
9197: Inputs:
9198:
9199: =over 4
9200:
9201: =item $Title: string, the title of the plot
9202:
9203: =item $xlabel: string, text describing the X-axis of the plot
9204:
9205: =item $ylabel: string, text describing the Y-axis of the plot
9206:
9207: =item $colors: Array ref containing the hex color codes for the data to be
9208: plotted in. If undefined, default values will be used.
9209:
9210: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9211:
9212: =item $Ydata1: The first data set
9213:
9214: =item $Min1: The minimum value of the left Y-axis
9215:
9216: =item $Max1: The maximum value of the left Y-axis
9217:
9218: =item $Ydata2: The second data set
9219:
9220: =item $Min2: The minimum value of the right Y-axis
9221:
9222: =item $Max2: The maximum value of the left Y-axis
9223:
9224: =item %Values: hash indicating or overriding any default values which are
9225: passed to graph.png.
9226: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9227:
9228: =back
9229:
9230: Returns:
9231:
9232: An <img> tag which references graph.png and the appropriate identifying
9233: information for the plot.
1.136 matthew 9234:
9235: =cut
9236:
9237: ############################################################
9238: ############################################################
1.137 matthew 9239: sub DrawXYYGraph {
9240: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9241: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9242: #
9243: # Create the identifier for the graph
9244: my $identifier = &get_cgi_id();
9245: my $id = 'cgi.'.$identifier;
9246: #
9247: $Title = '' if (! defined($Title));
9248: $xlabel = '' if (! defined($xlabel));
9249: $ylabel = '' if (! defined($ylabel));
9250: my %ValuesHash =
9251: (
1.369 www 9252: $id.'.title' => &escape($Title),
9253: $id.'.xlabel' => &escape($xlabel),
9254: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9255: $id.'.labels' => join(',',@$Xlabels),
9256: $id.'.PlotType' => 'XY',
9257: $id.'.NumSets' => 2,
1.137 matthew 9258: $id.'.two_axes' => 1,
9259: $id.'.y1_max_value' => $Max1,
9260: $id.'.y1_min_value' => $Min1,
9261: $id.'.y2_max_value' => $Max2,
9262: $id.'.y2_min_value' => $Min2,
1.136 matthew 9263: );
9264: #
1.137 matthew 9265: if (defined($colors) && ref($colors) eq 'ARRAY') {
9266: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9267: }
9268: #
9269: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9270: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9271: return '';
9272: }
9273: my $NumSets=1;
1.137 matthew 9274: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9275: next if (! ref($array));
9276: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9277: }
9278: #
9279: # Deal with other parameters
9280: while (my ($key,$value) = each(%Values)) {
9281: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9282: }
9283: #
1.646 raeburn 9284: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9285: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9286: }
9287:
9288: ############################################################
9289: ############################################################
9290:
9291: =pod
9292:
1.157 matthew 9293: =back
9294:
1.139 matthew 9295: =head1 Statistics helper routines?
9296:
9297: Bad place for them but what the hell.
9298:
1.157 matthew 9299: =over 4
9300:
1.648 raeburn 9301: =item * &chartlink()
1.139 matthew 9302:
9303: Returns a link to the chart for a specific student.
9304:
9305: Inputs:
9306:
9307: =over 4
9308:
9309: =item $linktext: The text of the link
9310:
9311: =item $sname: The students username
9312:
9313: =item $sdomain: The students domain
9314:
9315: =back
9316:
1.157 matthew 9317: =back
9318:
1.139 matthew 9319: =cut
9320:
9321: ############################################################
9322: ############################################################
9323: sub chartlink {
9324: my ($linktext, $sname, $sdomain) = @_;
9325: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9326: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9327: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9328: '">'.$linktext.'</a>';
1.153 matthew 9329: }
9330:
9331: #######################################################
9332: #######################################################
9333:
9334: =pod
9335:
9336: =head1 Course Environment Routines
1.157 matthew 9337:
9338: =over 4
1.153 matthew 9339:
1.648 raeburn 9340: =item * &restore_course_settings()
1.153 matthew 9341:
1.648 raeburn 9342: =item * &store_course_settings()
1.153 matthew 9343:
9344: Restores/Store indicated form parameters from the course environment.
9345: Will not overwrite existing values of the form parameters.
9346:
9347: Inputs:
9348: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9349:
9350: a hash ref describing the data to be stored. For example:
9351:
9352: %Save_Parameters = ('Status' => 'scalar',
9353: 'chartoutputmode' => 'scalar',
9354: 'chartoutputdata' => 'scalar',
9355: 'Section' => 'array',
1.373 raeburn 9356: 'Group' => 'array',
1.153 matthew 9357: 'StudentData' => 'array',
9358: 'Maps' => 'array');
9359:
9360: Returns: both routines return nothing
9361:
1.631 raeburn 9362: =back
9363:
1.153 matthew 9364: =cut
9365:
9366: #######################################################
9367: #######################################################
9368: sub store_course_settings {
1.496 albertel 9369: return &store_settings($env{'request.course.id'},@_);
9370: }
9371:
9372: sub store_settings {
1.153 matthew 9373: # save to the environment
9374: # appenv the same items, just to be safe
1.300 albertel 9375: my $udom = $env{'user.domain'};
9376: my $uname = $env{'user.name'};
1.496 albertel 9377: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9378: my %SaveHash;
9379: my %AppHash;
9380: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9381: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9382: my $envname = 'environment.'.$basename;
1.258 albertel 9383: if (exists($env{'form.'.$setting})) {
1.153 matthew 9384: # Save this value away
9385: if ($type eq 'scalar' &&
1.258 albertel 9386: (! exists($env{$envname}) ||
9387: $env{$envname} ne $env{'form.'.$setting})) {
9388: $SaveHash{$basename} = $env{'form.'.$setting};
9389: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9390: } elsif ($type eq 'array') {
9391: my $stored_form;
1.258 albertel 9392: if (ref($env{'form.'.$setting})) {
1.153 matthew 9393: $stored_form = join(',',
9394: map {
1.369 www 9395: &escape($_);
1.258 albertel 9396: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9397: } else {
9398: $stored_form =
1.369 www 9399: &escape($env{'form.'.$setting});
1.153 matthew 9400: }
9401: # Determine if the array contents are the same.
1.258 albertel 9402: if ($stored_form ne $env{$envname}) {
1.153 matthew 9403: $SaveHash{$basename} = $stored_form;
9404: $AppHash{$envname} = $stored_form;
9405: }
9406: }
9407: }
9408: }
9409: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9410: $udom,$uname);
1.153 matthew 9411: if ($put_result !~ /^(ok|delayed)/) {
9412: &Apache::lonnet::logthis('unable to save form parameters, '.
9413: 'got error:'.$put_result);
9414: }
9415: # Make sure these settings stick around in this session, too
1.646 raeburn 9416: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9417: return;
9418: }
9419:
9420: sub restore_course_settings {
1.499 albertel 9421: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9422: }
9423:
9424: sub restore_settings {
9425: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9426: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9427: next if (exists($env{'form.'.$setting}));
1.496 albertel 9428: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9429: '.'.$setting;
1.258 albertel 9430: if (exists($env{$envname})) {
1.153 matthew 9431: if ($type eq 'scalar') {
1.258 albertel 9432: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9433: } elsif ($type eq 'array') {
1.258 albertel 9434: $env{'form.'.$setting} = [
1.153 matthew 9435: map {
1.369 www 9436: &unescape($_);
1.258 albertel 9437: } split(',',$env{$envname})
1.153 matthew 9438: ];
9439: }
9440: }
9441: }
1.127 matthew 9442: }
9443:
1.618 raeburn 9444: #######################################################
9445: #######################################################
9446:
9447: =pod
9448:
9449: =head1 Domain E-mail Routines
9450:
9451: =over 4
9452:
1.648 raeburn 9453: =item * &build_recipient_list()
1.618 raeburn 9454:
1.884 raeburn 9455: Build recipient lists for five types of e-mail:
1.766 raeburn 9456: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9457: (d) Help requests, (e) Course requests needing approval, generated by
9458: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9459: loncoursequeueadmin.pm respectively.
1.618 raeburn 9460:
9461: Inputs:
1.619 raeburn 9462: defmail (scalar - email address of default recipient),
1.618 raeburn 9463: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9464: defdom (domain for which to retrieve configuration settings),
9465: origmail (scalar - email address of recipient from loncapa.conf,
9466: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9467:
1.655 raeburn 9468: Returns: comma separated list of addresses to which to send e-mail.
9469:
9470: =back
1.618 raeburn 9471:
9472: =cut
9473:
9474: ############################################################
9475: ############################################################
9476: sub build_recipient_list {
1.619 raeburn 9477: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9478: my @recipients;
9479: my $otheremails;
9480: my %domconfig =
9481: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9482: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9483: if (exists($domconfig{'contacts'}{$mailing})) {
9484: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9485: my @contacts = ('adminemail','supportemail');
9486: foreach my $item (@contacts) {
9487: if ($domconfig{'contacts'}{$mailing}{$item}) {
9488: my $addr = $domconfig{'contacts'}{$item};
9489: if (!grep(/^\Q$addr\E$/,@recipients)) {
9490: push(@recipients,$addr);
9491: }
1.619 raeburn 9492: }
1.766 raeburn 9493: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9494: }
9495: }
1.766 raeburn 9496: } elsif ($origmail ne '') {
9497: push(@recipients,$origmail);
1.618 raeburn 9498: }
1.619 raeburn 9499: } elsif ($origmail ne '') {
9500: push(@recipients,$origmail);
1.618 raeburn 9501: }
1.688 raeburn 9502: if (defined($defmail)) {
9503: if ($defmail ne '') {
9504: push(@recipients,$defmail);
9505: }
1.618 raeburn 9506: }
9507: if ($otheremails) {
1.619 raeburn 9508: my @others;
9509: if ($otheremails =~ /,/) {
9510: @others = split(/,/,$otheremails);
1.618 raeburn 9511: } else {
1.619 raeburn 9512: push(@others,$otheremails);
9513: }
9514: foreach my $addr (@others) {
9515: if (!grep(/^\Q$addr\E$/,@recipients)) {
9516: push(@recipients,$addr);
9517: }
1.618 raeburn 9518: }
9519: }
1.619 raeburn 9520: my $recipientlist = join(',',@recipients);
1.618 raeburn 9521: return $recipientlist;
9522: }
9523:
1.127 matthew 9524: ############################################################
9525: ############################################################
1.154 albertel 9526:
1.655 raeburn 9527: =pod
9528:
9529: =head1 Course Catalog Routines
9530:
9531: =over 4
9532:
9533: =item * &gather_categories()
9534:
9535: Converts category definitions - keys of categories hash stored in
9536: coursecategories in configuration.db on the primary library server in a
9537: domain - to an array. Also generates javascript and idx hash used to
9538: generate Domain Coordinator interface for editing Course Categories.
9539:
9540: Inputs:
1.663 raeburn 9541:
1.655 raeburn 9542: categories (reference to hash of category definitions).
1.663 raeburn 9543:
1.655 raeburn 9544: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9545: categories and subcategories).
1.663 raeburn 9546:
1.655 raeburn 9547: idx (reference to hash of counters used in Domain Coordinator interface for
9548: editing Course Categories).
1.663 raeburn 9549:
1.655 raeburn 9550: jsarray (reference to array of categories used to create Javascript arrays for
9551: Domain Coordinator interface for editing Course Categories).
9552:
9553: Returns: nothing
9554:
9555: Side effects: populates cats, idx and jsarray.
9556:
9557: =cut
9558:
9559: sub gather_categories {
9560: my ($categories,$cats,$idx,$jsarray) = @_;
9561: my %counters;
9562: my $num = 0;
9563: foreach my $item (keys(%{$categories})) {
9564: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9565: if ($container eq '' && $depth == 0) {
9566: $cats->[$depth][$categories->{$item}] = $cat;
9567: } else {
9568: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9569: }
9570: my ($escitem,$tail) = split(/:/,$item,2);
9571: if ($counters{$tail} eq '') {
9572: $counters{$tail} = $num;
9573: $num ++;
9574: }
9575: if (ref($idx) eq 'HASH') {
9576: $idx->{$item} = $counters{$tail};
9577: }
9578: if (ref($jsarray) eq 'ARRAY') {
9579: push(@{$jsarray->[$counters{$tail}]},$item);
9580: }
9581: }
9582: return;
9583: }
9584:
9585: =pod
9586:
9587: =item * &extract_categories()
9588:
9589: Used to generate breadcrumb trails for course categories.
9590:
9591: Inputs:
1.663 raeburn 9592:
1.655 raeburn 9593: categories (reference to hash of category definitions).
1.663 raeburn 9594:
1.655 raeburn 9595: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9596: categories and subcategories).
1.663 raeburn 9597:
1.655 raeburn 9598: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9599:
1.655 raeburn 9600: allitems (reference to hash - key is category key
9601: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9602:
1.655 raeburn 9603: idx (reference to hash of counters used in Domain Coordinator interface for
9604: editing Course Categories).
1.663 raeburn 9605:
1.655 raeburn 9606: jsarray (reference to array of categories used to create Javascript arrays for
9607: Domain Coordinator interface for editing Course Categories).
9608:
1.665 raeburn 9609: subcats (reference to hash of arrays containing all subcategories within each
9610: category, -recursive)
9611:
1.655 raeburn 9612: Returns: nothing
9613:
9614: Side effects: populates trails and allitems hash references.
9615:
9616: =cut
9617:
9618: sub extract_categories {
1.665 raeburn 9619: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9620: if (ref($categories) eq 'HASH') {
9621: &gather_categories($categories,$cats,$idx,$jsarray);
9622: if (ref($cats->[0]) eq 'ARRAY') {
9623: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9624: my $name = $cats->[0][$i];
9625: my $item = &escape($name).'::0';
9626: my $trailstr;
9627: if ($name eq 'instcode') {
9628: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9629: } elsif ($name eq 'communities') {
9630: $trailstr = &mt('Communities');
1.655 raeburn 9631: } else {
9632: $trailstr = $name;
9633: }
9634: if ($allitems->{$item} eq '') {
9635: push(@{$trails},$trailstr);
9636: $allitems->{$item} = scalar(@{$trails})-1;
9637: }
9638: my @parents = ($name);
9639: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9640: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9641: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9642: if (ref($subcats) eq 'HASH') {
9643: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9644: }
9645: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9646: }
9647: } else {
9648: if (ref($subcats) eq 'HASH') {
9649: $subcats->{$item} = [];
1.655 raeburn 9650: }
9651: }
9652: }
9653: }
9654: }
9655: return;
9656: }
9657:
9658: =pod
9659:
9660: =item *&recurse_categories()
9661:
9662: Recursively used to generate breadcrumb trails for course categories.
9663:
9664: Inputs:
1.663 raeburn 9665:
1.655 raeburn 9666: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9667: categories and subcategories).
1.663 raeburn 9668:
1.655 raeburn 9669: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9670:
9671: category (current course category, for which breadcrumb trail is being generated).
9672:
9673: trails (reference to array of breadcrumb trails for each category).
9674:
1.655 raeburn 9675: allitems (reference to hash - key is category key
9676: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9677:
1.655 raeburn 9678: parents (array containing containers directories for current category,
9679: back to top level).
9680:
9681: Returns: nothing
9682:
9683: Side effects: populates trails and allitems hash references
9684:
9685: =cut
9686:
9687: sub recurse_categories {
1.665 raeburn 9688: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9689: my $shallower = $depth - 1;
9690: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9691: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9692: my $name = $cats->[$depth]{$category}[$k];
9693: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9694: my $trailstr = join(' -> ',(@{$parents},$category));
9695: if ($allitems->{$item} eq '') {
9696: push(@{$trails},$trailstr);
9697: $allitems->{$item} = scalar(@{$trails})-1;
9698: }
9699: my $deeper = $depth+1;
9700: push(@{$parents},$category);
1.665 raeburn 9701: if (ref($subcats) eq 'HASH') {
9702: my $subcat = &escape($name).':'.$category.':'.$depth;
9703: for (my $j=@{$parents}; $j>=0; $j--) {
9704: my $higher;
9705: if ($j > 0) {
9706: $higher = &escape($parents->[$j]).':'.
9707: &escape($parents->[$j-1]).':'.$j;
9708: } else {
9709: $higher = &escape($parents->[$j]).'::'.$j;
9710: }
9711: push(@{$subcats->{$higher}},$subcat);
9712: }
9713: }
9714: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9715: $subcats);
1.655 raeburn 9716: pop(@{$parents});
9717: }
9718: } else {
9719: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9720: my $trailstr = join(' -> ',(@{$parents},$category));
9721: if ($allitems->{$item} eq '') {
9722: push(@{$trails},$trailstr);
9723: $allitems->{$item} = scalar(@{$trails})-1;
9724: }
9725: }
9726: return;
9727: }
9728:
1.663 raeburn 9729: =pod
9730:
9731: =item *&assign_categories_table()
9732:
9733: Create a datatable for display of hierarchical categories in a domain,
9734: with checkboxes to allow a course to be categorized.
9735:
9736: Inputs:
9737:
9738: cathash - reference to hash of categories defined for the domain (from
9739: configuration.db)
9740:
9741: currcat - scalar with an & separated list of categories assigned to a course.
9742:
1.919 raeburn 9743: type - scalar contains course type (Course or Community).
9744:
1.663 raeburn 9745: Returns: $output (markup to be displayed)
9746:
9747: =cut
9748:
9749: sub assign_categories_table {
1.919 raeburn 9750: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9751: my $output;
9752: if (ref($cathash) eq 'HASH') {
9753: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9754: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9755: $maxdepth = scalar(@cats);
9756: if (@cats > 0) {
9757: my $itemcount = 0;
9758: if (ref($cats[0]) eq 'ARRAY') {
9759: my @currcategories;
9760: if ($currcat ne '') {
9761: @currcategories = split('&',$currcat);
9762: }
1.919 raeburn 9763: my $table;
1.663 raeburn 9764: for (my $i=0; $i<@{$cats[0]}; $i++) {
9765: my $parent = $cats[0][$i];
1.919 raeburn 9766: next if ($parent eq 'instcode');
9767: if ($type eq 'Community') {
9768: next unless ($parent eq 'communities');
9769: } else {
9770: next if ($parent eq 'communities');
9771: }
1.663 raeburn 9772: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9773: my $item = &escape($parent).'::0';
9774: my $checked = '';
9775: if (@currcategories > 0) {
9776: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9777: $checked = ' checked="checked"';
1.663 raeburn 9778: }
9779: }
1.919 raeburn 9780: my $parent_title = $parent;
9781: if ($parent eq 'communities') {
9782: $parent_title = &mt('Communities');
9783: }
9784: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9785: '<input type="checkbox" name="usecategory" value="'.
9786: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9787: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9788: my $depth = 1;
9789: push(@path,$parent);
1.919 raeburn 9790: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9791: pop(@path);
1.919 raeburn 9792: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9793: $itemcount ++;
9794: }
1.919 raeburn 9795: if ($itemcount) {
9796: $output = &Apache::loncommon::start_data_table().
9797: $table.
9798: &Apache::loncommon::end_data_table();
9799: }
1.663 raeburn 9800: }
9801: }
9802: }
9803: return $output;
9804: }
9805:
9806: =pod
9807:
9808: =item *&assign_category_rows()
9809:
9810: Create a datatable row for display of nested categories in a domain,
9811: with checkboxes to allow a course to be categorized,called recursively.
9812:
9813: Inputs:
9814:
9815: itemcount - track row number for alternating colors
9816:
9817: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9818: categories and subcategories.
9819:
9820: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9821:
9822: parent - parent of current category item
9823:
9824: path - Array containing all categories back up through the hierarchy from the
9825: current category to the top level.
9826:
9827: currcategories - reference to array of current categories assigned to the course
9828:
9829: Returns: $output (markup to be displayed).
9830:
9831: =cut
9832:
9833: sub assign_category_rows {
9834: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9835: my ($text,$name,$item,$chgstr);
9836: if (ref($cats) eq 'ARRAY') {
9837: my $maxdepth = scalar(@{$cats});
9838: if (ref($cats->[$depth]) eq 'HASH') {
9839: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9840: my $numchildren = @{$cats->[$depth]{$parent}};
9841: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9842: $text .= '<td><table class="LC_datatable">';
9843: for (my $j=0; $j<$numchildren; $j++) {
9844: $name = $cats->[$depth]{$parent}[$j];
9845: $item = &escape($name).':'.&escape($parent).':'.$depth;
9846: my $deeper = $depth+1;
9847: my $checked = '';
9848: if (ref($currcategories) eq 'ARRAY') {
9849: if (@{$currcategories} > 0) {
9850: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9851: $checked = ' checked="checked"';
1.663 raeburn 9852: }
9853: }
9854: }
1.664 raeburn 9855: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9856: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9857: $item.'"'.$checked.' />'.$name.'</label></span>'.
9858: '<input type="hidden" name="catname" value="'.$name.'" />'.
9859: '</td><td>';
1.663 raeburn 9860: if (ref($path) eq 'ARRAY') {
9861: push(@{$path},$name);
9862: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9863: pop(@{$path});
9864: }
9865: $text .= '</td></tr>';
9866: }
9867: $text .= '</table></td>';
9868: }
9869: }
9870: }
9871: return $text;
9872: }
9873:
1.655 raeburn 9874: ############################################################
9875: ############################################################
9876:
9877:
1.443 albertel 9878: sub commit_customrole {
1.664 raeburn 9879: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9880: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9881: ($start?', '.&mt('starting').' '.localtime($start):'').
9882: ($end?', ending '.localtime($end):'').': <b>'.
9883: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9884: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9885: '</b><br />';
9886: return $output;
9887: }
9888:
9889: sub commit_standardrole {
1.541 raeburn 9890: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9891: my ($output,$logmsg,$linefeed);
9892: if ($context eq 'auto') {
9893: $linefeed = "\n";
9894: } else {
9895: $linefeed = "<br />\n";
9896: }
1.443 albertel 9897: if ($three eq 'st') {
1.541 raeburn 9898: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9899: $one,$two,$sec,$context);
9900: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9901: ($result eq 'unknown_course') || ($result eq 'refused')) {
9902: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9903: } else {
1.541 raeburn 9904: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9905: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9906: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9907: if ($context eq 'auto') {
9908: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9909: } else {
9910: $output .= '<b>'.$result.'</b>'.$linefeed.
9911: &mt('Add to classlist').': <b>ok</b>';
9912: }
9913: $output .= $linefeed;
1.443 albertel 9914: }
9915: } else {
9916: $output = &mt('Assigning').' '.$three.' in '.$url.
9917: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9918: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9919: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9920: if ($context eq 'auto') {
9921: $output .= $result.$linefeed;
9922: } else {
9923: $output .= '<b>'.$result.'</b>'.$linefeed;
9924: }
1.443 albertel 9925: }
9926: return $output;
9927: }
9928:
9929: sub commit_studentrole {
1.541 raeburn 9930: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9931: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9932: if ($context eq 'auto') {
9933: $linefeed = "\n";
9934: } else {
9935: $linefeed = '<br />'."\n";
9936: }
1.443 albertel 9937: if (defined($one) && defined($two)) {
9938: my $cid=$one.'_'.$two;
9939: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9940: my $secchange = 0;
9941: my $expire_role_result;
9942: my $modify_section_result;
1.628 raeburn 9943: if ($oldsec ne '-1') {
9944: if ($oldsec ne $sec) {
1.443 albertel 9945: $secchange = 1;
1.628 raeburn 9946: my $now = time;
1.443 albertel 9947: my $uurl='/'.$cid;
9948: $uurl=~s/\_/\//g;
9949: if ($oldsec) {
9950: $uurl.='/'.$oldsec;
9951: }
1.626 raeburn 9952: $oldsecurl = $uurl;
1.628 raeburn 9953: $expire_role_result =
1.652 raeburn 9954: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9955: if ($env{'request.course.sec'} ne '') {
9956: if ($expire_role_result eq 'refused') {
9957: my @roles = ('st');
9958: my @statuses = ('previous');
9959: my @roledoms = ($one);
9960: my $withsec = 1;
9961: my %roleshash =
9962: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9963: \@statuses,\@roles,\@roledoms,$withsec);
9964: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9965: my ($oldstart,$oldend) =
9966: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9967: if ($oldend > 0 && $oldend <= $now) {
9968: $expire_role_result = 'ok';
9969: }
9970: }
9971: }
9972: }
1.443 albertel 9973: $result = $expire_role_result;
9974: }
9975: }
9976: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9977: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9978: if ($modify_section_result =~ /^ok/) {
9979: if ($secchange == 1) {
1.628 raeburn 9980: if ($sec eq '') {
9981: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9982: } else {
9983: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9984: }
1.443 albertel 9985: } elsif ($oldsec eq '-1') {
1.628 raeburn 9986: if ($sec eq '') {
9987: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9988: } else {
9989: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9990: }
1.443 albertel 9991: } else {
1.628 raeburn 9992: if ($sec eq '') {
9993: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9994: } else {
9995: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9996: }
1.443 albertel 9997: }
9998: } else {
1.628 raeburn 9999: if ($secchange) {
10000: $$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;
10001: } else {
10002: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10003: }
1.443 albertel 10004: }
10005: $result = $modify_section_result;
10006: } elsif ($secchange == 1) {
1.628 raeburn 10007: if ($oldsec eq '') {
10008: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10009: } else {
10010: $$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;
10011: }
1.626 raeburn 10012: if ($expire_role_result eq 'refused') {
10013: my $newsecurl = '/'.$cid;
10014: $newsecurl =~ s/\_/\//g;
10015: if ($sec ne '') {
10016: $newsecurl.='/'.$sec;
10017: }
10018: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10019: if ($sec eq '') {
10020: $$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;
10021: } else {
10022: $$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;
10023: }
10024: }
10025: }
1.443 albertel 10026: }
10027: } else {
1.626 raeburn 10028: $$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 10029: $result = "error: incomplete course id\n";
10030: }
10031: return $result;
10032: }
10033:
10034: ############################################################
10035: ############################################################
10036:
1.566 albertel 10037: sub check_clone {
1.578 raeburn 10038: my ($args,$linefeed) = @_;
1.566 albertel 10039: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10040: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10041: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10042: my $clonemsg;
10043: my $can_clone = 0;
1.944 raeburn 10044: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10045: if ($lctype ne 'community') {
10046: $lctype = 'course';
10047: }
1.566 albertel 10048: if ($clonehome eq 'no_host') {
1.944 raeburn 10049: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10050: $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'});
10051: } else {
10052: $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'});
10053: }
1.566 albertel 10054: } else {
10055: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10056: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10057: if ($clonedesc{'type'} ne 'Community') {
10058: $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'});
10059: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10060: }
10061: }
1.882 raeburn 10062: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10063: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10064: $can_clone = 1;
10065: } else {
10066: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10067: $args->{'clonedomain'},$args->{'clonecourse'});
10068: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10069: if (grep(/^\*$/,@cloners)) {
10070: $can_clone = 1;
10071: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10072: $can_clone = 1;
10073: } else {
1.908 raeburn 10074: my $ccrole = 'cc';
1.944 raeburn 10075: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10076: $ccrole = 'co';
10077: }
1.578 raeburn 10078: my %roleshash =
10079: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10080: $args->{'ccdomain'},
1.908 raeburn 10081: 'userroles',['active'],[$ccrole],
1.578 raeburn 10082: [$args->{'clonedomain'}]);
1.908 raeburn 10083: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10084: $can_clone = 1;
10085: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10086: $can_clone = 1;
10087: } else {
1.944 raeburn 10088: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10089: $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'});
10090: } else {
10091: $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'});
10092: }
1.578 raeburn 10093: }
1.566 albertel 10094: }
1.578 raeburn 10095: }
1.566 albertel 10096: }
10097: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10098: }
10099:
1.444 albertel 10100: sub construct_course {
1.885 raeburn 10101: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10102: my $outcome;
1.541 raeburn 10103: my $linefeed = '<br />'."\n";
10104: if ($context eq 'auto') {
10105: $linefeed = "\n";
10106: }
1.566 albertel 10107:
10108: #
10109: # Are we cloning?
10110: #
10111: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10112: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10113: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10114: if ($context ne 'auto') {
1.578 raeburn 10115: if ($clonemsg ne '') {
10116: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10117: }
1.566 albertel 10118: }
10119: $outcome .= $clonemsg.$linefeed;
10120:
10121: if (!$can_clone) {
10122: return (0,$outcome);
10123: }
10124: }
10125:
1.444 albertel 10126: #
10127: # Open course
10128: #
10129: my $crstype = lc($args->{'crstype'});
10130: my %cenv=();
10131: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10132: $args->{'cdescr'},
10133: $args->{'curl'},
10134: $args->{'course_home'},
10135: $args->{'nonstandard'},
10136: $args->{'crscode'},
10137: $args->{'ccuname'}.':'.
10138: $args->{'ccdomain'},
1.882 raeburn 10139: $args->{'crstype'},
1.885 raeburn 10140: $cnum,$context,$category);
1.444 albertel 10141:
10142: # Note: The testing routines depend on this being output; see
10143: # Utils::Course. This needs to at least be output as a comment
10144: # if anyone ever decides to not show this, and Utils::Course::new
10145: # will need to be suitably modified.
1.541 raeburn 10146: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10147: if ($$courseid =~ /^error:/) {
10148: return (0,$outcome);
10149: }
10150:
1.444 albertel 10151: #
10152: # Check if created correctly
10153: #
1.479 albertel 10154: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10155: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10156: if ($crsuhome eq 'no_host') {
10157: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10158: return (0,$outcome);
10159: }
1.541 raeburn 10160: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10161:
1.444 albertel 10162: #
1.566 albertel 10163: # Do the cloning
10164: #
10165: if ($can_clone && $cloneid) {
10166: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10167: if ($context ne 'auto') {
10168: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10169: }
10170: $outcome .= $clonemsg.$linefeed;
10171: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10172: # Copy all files
1.637 www 10173: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10174: # Restore URL
1.566 albertel 10175: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10176: # Restore title
1.566 albertel 10177: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10178: # Restore creation date, creator and creation context.
10179: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10180: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10181: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10182: # Mark as cloned
1.566 albertel 10183: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10184: # Need to clone grading mode
10185: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10186: $cenv{'grading'}=$newenv{'grading'};
10187: # Do not clone these environment entries
10188: &Apache::lonnet::del('environment',
10189: ['default_enrollment_start_date',
10190: 'default_enrollment_end_date',
10191: 'question.email',
10192: 'policy.email',
10193: 'comment.email',
10194: 'pch.users.denied',
1.725 raeburn 10195: 'plc.users.denied',
10196: 'hidefromcat',
10197: 'categories'],
1.638 www 10198: $$crsudom,$$crsunum);
1.444 albertel 10199: }
1.566 albertel 10200:
1.444 albertel 10201: #
10202: # Set environment (will override cloned, if existing)
10203: #
10204: my @sections = ();
10205: my @xlists = ();
10206: if ($args->{'crstype'}) {
10207: $cenv{'type'}=$args->{'crstype'};
10208: }
10209: if ($args->{'crsid'}) {
10210: $cenv{'courseid'}=$args->{'crsid'};
10211: }
10212: if ($args->{'crscode'}) {
10213: $cenv{'internal.coursecode'}=$args->{'crscode'};
10214: }
10215: if ($args->{'crsquota'} ne '') {
10216: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10217: } else {
10218: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10219: }
10220: if ($args->{'ccuname'}) {
10221: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10222: ':'.$args->{'ccdomain'};
10223: } else {
10224: $cenv{'internal.courseowner'} = $args->{'curruser'};
10225: }
10226: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10227: if ($args->{'crssections'}) {
10228: $cenv{'internal.sectionnums'} = '';
10229: if ($args->{'crssections'} =~ m/,/) {
10230: @sections = split/,/,$args->{'crssections'};
10231: } else {
10232: $sections[0] = $args->{'crssections'};
10233: }
10234: if (@sections > 0) {
10235: foreach my $item (@sections) {
10236: my ($sec,$gp) = split/:/,$item;
10237: my $class = $args->{'crscode'}.$sec;
10238: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10239: $cenv{'internal.sectionnums'} .= $item.',';
10240: unless ($addcheck eq 'ok') {
10241: push @badclasses, $class;
10242: }
10243: }
10244: $cenv{'internal.sectionnums'} =~ s/,$//;
10245: }
10246: }
10247: # do not hide course coordinator from staff listing,
10248: # even if privileged
10249: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10250: # add crosslistings
10251: if ($args->{'crsxlist'}) {
10252: $cenv{'internal.crosslistings'}='';
10253: if ($args->{'crsxlist'} =~ m/,/) {
10254: @xlists = split/,/,$args->{'crsxlist'};
10255: } else {
10256: $xlists[0] = $args->{'crsxlist'};
10257: }
10258: if (@xlists > 0) {
10259: foreach my $item (@xlists) {
10260: my ($xl,$gp) = split/:/,$item;
10261: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10262: $cenv{'internal.crosslistings'} .= $item.',';
10263: unless ($addcheck eq 'ok') {
10264: push @badclasses, $xl;
10265: }
10266: }
10267: $cenv{'internal.crosslistings'} =~ s/,$//;
10268: }
10269: }
10270: if ($args->{'autoadds'}) {
10271: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10272: }
10273: if ($args->{'autodrops'}) {
10274: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10275: }
10276: # check for notification of enrollment changes
10277: my @notified = ();
10278: if ($args->{'notify_owner'}) {
10279: if ($args->{'ccuname'} ne '') {
10280: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10281: }
10282: }
10283: if ($args->{'notify_dc'}) {
10284: if ($uname ne '') {
1.630 raeburn 10285: push(@notified,$uname.':'.$udom);
1.444 albertel 10286: }
10287: }
10288: if (@notified > 0) {
10289: my $notifylist;
10290: if (@notified > 1) {
10291: $notifylist = join(',',@notified);
10292: } else {
10293: $notifylist = $notified[0];
10294: }
10295: $cenv{'internal.notifylist'} = $notifylist;
10296: }
10297: if (@badclasses > 0) {
10298: my %lt=&Apache::lonlocal::texthash(
10299: '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',
10300: 'dnhr' => 'does not have rights to access enrollment in these classes',
10301: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10302: );
1.541 raeburn 10303: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10304: ' ('.$lt{'adby'}.')';
10305: if ($context eq 'auto') {
10306: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10307: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10308: foreach my $item (@badclasses) {
10309: if ($context eq 'auto') {
10310: $outcome .= " - $item\n";
10311: } else {
10312: $outcome .= "<li>$item</li>\n";
10313: }
10314: }
10315: if ($context eq 'auto') {
10316: $outcome .= $linefeed;
10317: } else {
1.566 albertel 10318: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10319: }
10320: }
1.444 albertel 10321: }
10322: if ($args->{'no_end_date'}) {
10323: $args->{'endaccess'} = 0;
10324: }
10325: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10326: $cenv{'internal.autoend'}=$args->{'enrollend'};
10327: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10328: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10329: if ($args->{'showphotos'}) {
10330: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10331: }
10332: $cenv{'internal.authtype'} = $args->{'authtype'};
10333: $cenv{'internal.autharg'} = $args->{'autharg'};
10334: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10335: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10336: 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');
10337: if ($context eq 'auto') {
10338: $outcome .= $krb_msg;
10339: } else {
1.566 albertel 10340: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10341: }
10342: $outcome .= $linefeed;
1.444 albertel 10343: }
10344: }
10345: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10346: if ($args->{'setpolicy'}) {
10347: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10348: }
10349: if ($args->{'setcontent'}) {
10350: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10351: }
10352: }
10353: if ($args->{'reshome'}) {
10354: $cenv{'reshome'}=$args->{'reshome'}.'/';
10355: $cenv{'reshome'}=~s/\/+$/\//;
10356: }
10357: #
10358: # course has keyed access
10359: #
10360: if ($args->{'setkeys'}) {
10361: $cenv{'keyaccess'}='yes';
10362: }
10363: # if specified, key authority is not course, but user
10364: # only active if keyaccess is yes
10365: if ($args->{'keyauth'}) {
1.487 albertel 10366: my ($user,$domain) = split(':',$args->{'keyauth'});
10367: $user = &LONCAPA::clean_username($user);
10368: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10369: if ($user ne '' && $domain ne '') {
1.487 albertel 10370: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10371: }
10372: }
10373:
10374: if ($args->{'disresdis'}) {
10375: $cenv{'pch.roles.denied'}='st';
10376: }
10377: if ($args->{'disablechat'}) {
10378: $cenv{'plc.roles.denied'}='st';
10379: }
10380:
10381: # Record we've not yet viewed the Course Initialization Helper for this
10382: # course
10383: $cenv{'course.helper.not.run'} = 1;
10384: #
10385: # Use new Randomseed
10386: #
10387: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10388: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10389: #
10390: # The encryption code and receipt prefix for this course
10391: #
10392: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10393: $cenv{'internal.encpref'}=100+int(9*rand(99));
10394: #
10395: # By default, use standard grading
10396: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10397:
1.541 raeburn 10398: $outcome .= $linefeed.&mt('Setting environment').': '.
10399: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10400: #
10401: # Open all assignments
10402: #
10403: if ($args->{'openall'}) {
10404: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10405: my %storecontent = ($storeunder => time,
10406: $storeunder.'.type' => 'date_start');
10407:
10408: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10409: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10410: }
10411: #
10412: # Set first page
10413: #
10414: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10415: || ($cloneid)) {
1.445 albertel 10416: use LONCAPA::map;
1.444 albertel 10417: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10418:
10419: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10420: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10421:
1.444 albertel 10422: $outcome .= ($fatal?$errtext:'read ok').' - ';
10423: my $title; my $url;
10424: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10425: $title=&mt('Syllabus');
1.444 albertel 10426: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10427: } else {
1.963 raeburn 10428: $title=&mt('Table of Contents');
1.444 albertel 10429: $url='/adm/navmaps';
10430: }
1.445 albertel 10431:
10432: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10433: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10434:
10435: if ($errtext) { $fatal=2; }
1.541 raeburn 10436: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10437: }
1.566 albertel 10438:
10439: return (1,$outcome);
1.444 albertel 10440: }
10441:
10442: ############################################################
10443: ############################################################
10444:
1.953 droeschl 10445: #SD
10446: # only Community and Course, or anything else?
1.378 raeburn 10447: sub course_type {
10448: my ($cid) = @_;
10449: if (!defined($cid)) {
10450: $cid = $env{'request.course.id'};
10451: }
1.404 albertel 10452: if (defined($env{'course.'.$cid.'.type'})) {
10453: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10454: } else {
10455: return 'Course';
1.377 raeburn 10456: }
10457: }
1.156 albertel 10458:
1.406 raeburn 10459: sub group_term {
10460: my $crstype = &course_type();
10461: my %names = (
10462: 'Course' => 'group',
1.865 raeburn 10463: 'Community' => 'group',
1.406 raeburn 10464: );
10465: return $names{$crstype};
10466: }
10467:
1.902 raeburn 10468: sub course_types {
10469: my @types = ('official','unofficial','community');
10470: my %typename = (
10471: official => 'Official course',
10472: unofficial => 'Unofficial course',
10473: community => 'Community',
10474: );
10475: return (\@types,\%typename);
10476: }
10477:
1.156 albertel 10478: sub icon {
10479: my ($file)=@_;
1.505 albertel 10480: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10481: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10482: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10483: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10484: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10485: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10486: $curfext.".gif") {
10487: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10488: $curfext.".gif";
10489: }
10490: }
1.249 albertel 10491: return &lonhttpdurl($iconname);
1.154 albertel 10492: }
1.84 albertel 10493:
1.575 albertel 10494: sub lonhttpdurl {
1.692 www 10495: #
10496: # Had been used for "small fry" static images on separate port 8080.
10497: # Modify here if lightweight http functionality desired again.
10498: # Currently eliminated due to increasing firewall issues.
10499: #
1.575 albertel 10500: my ($url)=@_;
1.692 www 10501: return $url;
1.215 albertel 10502: }
10503:
1.213 albertel 10504: sub connection_aborted {
10505: my ($r)=@_;
10506: $r->print(" ");$r->rflush();
10507: my $c = $r->connection;
10508: return $c->aborted();
10509: }
10510:
1.221 foxr 10511: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10512: # strings as 'strings'.
10513: sub escape_single {
1.221 foxr 10514: my ($input) = @_;
1.223 albertel 10515: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10516: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10517: return $input;
10518: }
1.223 albertel 10519:
1.222 foxr 10520: # Same as escape_single, but escape's "'s This
10521: # can be used for "strings"
10522: sub escape_double {
10523: my ($input) = @_;
10524: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10525: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10526: return $input;
10527: }
1.223 albertel 10528:
1.222 foxr 10529: # Escapes the last element of a full URL.
10530: sub escape_url {
10531: my ($url) = @_;
1.238 raeburn 10532: my @urlslices = split(/\//, $url,-1);
1.369 www 10533: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10534: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10535: }
1.462 albertel 10536:
1.820 raeburn 10537: sub compare_arrays {
10538: my ($arrayref1,$arrayref2) = @_;
10539: my (@difference,%count);
10540: @difference = ();
10541: %count = ();
10542: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10543: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10544: foreach my $element (keys(%count)) {
10545: if ($count{$element} == 1) {
10546: push(@difference,$element);
10547: }
10548: }
10549: }
10550: return @difference;
10551: }
10552:
1.817 bisitz 10553: # -------------------------------------------------------- Initialize user login
1.462 albertel 10554: sub init_user_environment {
1.463 albertel 10555: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10556: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10557:
10558: my $public=($username eq 'public' && $domain eq 'public');
10559:
10560: # See if old ID present, if so, remove
10561:
10562: my ($filename,$cookie,$userroles);
10563: my $now=time;
10564:
10565: if ($public) {
10566: my $max_public=100;
10567: my $oldest;
10568: my $oldest_time=0;
10569: for(my $next=1;$next<=$max_public;$next++) {
10570: if (-e $lonids."/publicuser_$next.id") {
10571: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10572: if ($mtime<$oldest_time || !$oldest_time) {
10573: $oldest_time=$mtime;
10574: $oldest=$next;
10575: }
10576: } else {
10577: $cookie="publicuser_$next";
10578: last;
10579: }
10580: }
10581: if (!$cookie) { $cookie="publicuser_$oldest"; }
10582: } else {
1.463 albertel 10583: # if this isn't a robot, kill any existing non-robot sessions
10584: if (!$args->{'robot'}) {
10585: opendir(DIR,$lonids);
10586: while ($filename=readdir(DIR)) {
10587: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10588: unlink($lonids.'/'.$filename);
10589: }
1.462 albertel 10590: }
1.463 albertel 10591: closedir(DIR);
1.462 albertel 10592: }
10593: # Give them a new cookie
1.463 albertel 10594: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10595: : $now.$$.int(rand(10000)));
1.463 albertel 10596: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10597:
10598: # Initialize roles
10599:
10600: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10601: }
10602: # ------------------------------------ Check browser type and MathML capability
10603:
10604: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10605: $clientunicode,$clientos) = &decode_user_agent($r);
10606:
10607: # ------------------------------------------------------------- Get environment
10608:
10609: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10610: my ($tmp) = keys(%userenv);
10611: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10612: } else {
10613: undef(%userenv);
10614: }
10615: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10616: $form->{'interface'}=$userenv{'interface'};
10617: }
10618: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10619:
10620: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10621: foreach my $option ('interface','localpath','localres') {
10622: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10623: }
10624: # --------------------------------------------------------- Write first profile
10625:
10626: {
10627: my %initial_env =
10628: ("user.name" => $username,
10629: "user.domain" => $domain,
10630: "user.home" => $authhost,
10631: "browser.type" => $clientbrowser,
10632: "browser.version" => $clientversion,
10633: "browser.mathml" => $clientmathml,
10634: "browser.unicode" => $clientunicode,
10635: "browser.os" => $clientos,
10636: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10637: "request.course.fn" => '',
10638: "request.course.uri" => '',
10639: "request.course.sec" => '',
10640: "request.role" => 'cm',
10641: "request.role.adv" => $env{'user.adv'},
10642: "request.host" => $ENV{'REMOTE_ADDR'},);
10643:
10644: if ($form->{'localpath'}) {
10645: $initial_env{"browser.localpath"} = $form->{'localpath'};
10646: $initial_env{"browser.localres"} = $form->{'localres'};
10647: }
10648:
10649: if ($form->{'interface'}) {
10650: $form->{'interface'}=~s/\W//gs;
10651: $initial_env{"browser.interface"} = $form->{'interface'};
10652: $env{'browser.interface'}=$form->{'interface'};
10653: }
10654:
1.724 raeburn 10655: foreach my $tool ('aboutme','blog','portfolio') {
10656: $userenv{'availabletools.'.$tool} =
10657: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10658: }
10659:
1.864 raeburn 10660: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10661: $userenv{'canrequest.'.$crstype} =
10662: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10663: 'reload','requestcourses');
10664: }
10665:
1.462 albertel 10666: $env{'user.environment'} = "$lonids/$cookie.id";
10667:
10668: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10669: &GDBM_WRCREAT(),0640)) {
10670: &_add_to_env(\%disk_env,\%initial_env);
10671: &_add_to_env(\%disk_env,\%userenv,'environment.');
10672: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10673: if (ref($args->{'extra_env'})) {
10674: &_add_to_env(\%disk_env,$args->{'extra_env'});
10675: }
1.462 albertel 10676: untie(%disk_env);
10677: } else {
1.705 tempelho 10678: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10679: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10680: return 'error: '.$!;
10681: }
10682: }
10683: $env{'request.role'}='cm';
10684: $env{'request.role.adv'}=$env{'user.adv'};
10685: $env{'browser.type'}=$clientbrowser;
10686:
10687: return $cookie;
10688:
10689: }
10690:
10691: sub _add_to_env {
10692: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10693: if (ref($env_data) eq 'HASH') {
10694: while (my ($key,$value) = each(%$env_data)) {
10695: $idf->{$prefix.$key} = $value;
10696: $env{$prefix.$key} = $value;
10697: }
1.462 albertel 10698: }
10699: }
10700:
1.685 tempelho 10701: # --- Get the symbolic name of a problem and the url
10702: sub get_symb {
10703: my ($request,$silent) = @_;
1.726 raeburn 10704: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10705: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10706: if ($symb eq '') {
10707: if (!$silent) {
10708: $request->print("Unable to handle ambiguous references:$url:.");
10709: return ();
10710: }
10711: }
10712: &Apache::lonenc::check_decrypt(\$symb);
10713: return ($symb);
10714: }
10715:
10716: # --------------------------------------------------------------Get annotation
10717:
10718: sub get_annotation {
10719: my ($symb,$enc) = @_;
10720:
10721: my $key = $symb;
10722: if (!$enc) {
10723: $key =
10724: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10725: }
10726: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10727: return $annotation{$key};
10728: }
10729:
10730: sub clean_symb {
1.731 raeburn 10731: my ($symb,$delete_enc) = @_;
1.685 tempelho 10732:
10733: &Apache::lonenc::check_decrypt(\$symb);
10734: my $enc = $env{'request.enc'};
1.731 raeburn 10735: if ($delete_enc) {
1.730 raeburn 10736: delete($env{'request.enc'});
10737: }
1.685 tempelho 10738:
10739: return ($symb,$enc);
10740: }
1.462 albertel 10741:
1.41 ng 10742: =pod
10743:
10744: =back
10745:
1.112 bowersj2 10746: =cut
1.41 ng 10747:
1.112 bowersj2 10748: 1;
10749: __END__;
1.41 ng 10750:
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