Annotation of loncom/interface/loncommon.pm, revision 1.971
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.971 ! raeburn 4: # $Id: loncommon.pm,v 1.970 2010/06/06 02:40:30 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: }
1.970 raeburn 903: return &select_form($selected,$name,\%langchoices);
1.792 raeburn 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.970 raeburn 1789: return &select_form($name,$value,\%domains);
1.169 www 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.970 raeburn 1851: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88 www 1852:
1853: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 1854: allow a user to select options from a ref to a hash containing:
1855: option_name => displayed text. An optional $onchange can include
1856: a javascript onchange item, e.g., onchange="this.form.submit();"
1857:
1.88 www 1858: See lonrights.pm for an example invocation and use.
1859:
1860: =cut
1861:
1862: #-------------------------------------------
1863: sub select_form {
1.970 raeburn 1864: my ($def,$name,$hashref,$onchange) = @_;
1865: return unless (ref($hashref) eq 'HASH');
1866: if ($onchange) {
1867: $onchange = ' onchange="'.$onchange.'"';
1868: }
1869: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128 albertel 1870: my @keys;
1.970 raeburn 1871: if (exists($hashref->{'select_form_order'})) {
1872: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 1873: } else {
1.970 raeburn 1874: @keys=sort(keys(%{$hashref}));
1.128 albertel 1875: }
1.356 albertel 1876: foreach my $key (@keys) {
1877: $selectform.=
1878: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1879: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 1880: ">".$hashref->{$key}."</option>\n";
1.88 www 1881: }
1882: $selectform.="</select>";
1883: return $selectform;
1884: }
1885:
1.475 www 1886: # For display filters
1887:
1888: sub display_filter {
1889: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1890: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1891: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1892: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1893: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1894: '</label></span> <span class="LC_nobreak">'.
1.475 www 1895: &mt('Filter [_1]',
1.477 www 1896: &select_form($env{'form.displayfilter'},
1897: 'displayfilter',
1.970 raeburn 1898: {'currentfolder' => 'Current folder/page',
1.477 www 1899: 'containing' => 'Containing phrase',
1.970 raeburn 1900: 'none' => 'None'})).
1.714 bisitz 1901: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1902: }
1903:
1.167 www 1904: sub gradeleveldescription {
1905: my $gradelevel=shift;
1906: my %gradelevels=(0 => 'Not specified',
1907: 1 => 'Grade 1',
1908: 2 => 'Grade 2',
1909: 3 => 'Grade 3',
1910: 4 => 'Grade 4',
1911: 5 => 'Grade 5',
1912: 6 => 'Grade 6',
1913: 7 => 'Grade 7',
1914: 8 => 'Grade 8',
1915: 9 => 'Grade 9',
1916: 10 => 'Grade 10',
1917: 11 => 'Grade 11',
1918: 12 => 'Grade 12',
1919: 13 => 'Grade 13',
1920: 14 => '100 Level',
1921: 15 => '200 Level',
1922: 16 => '300 Level',
1923: 17 => '400 Level',
1924: 18 => 'Graduate Level');
1925: return &mt($gradelevels{$gradelevel});
1926: }
1927:
1.163 www 1928: sub select_level_form {
1929: my ($deflevel,$name)=@_;
1930: unless ($deflevel) { $deflevel=0; }
1.167 www 1931: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1932: for (my $i=0; $i<=18; $i++) {
1933: $selectform.="<option value=\"$i\" ".
1.253 albertel 1934: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1935: ">".&gradeleveldescription($i)."</option>\n";
1936: }
1937: $selectform.="</select>";
1938: return $selectform;
1.163 www 1939: }
1.167 www 1940:
1.35 matthew 1941: #-------------------------------------------
1942:
1.45 matthew 1943: =pod
1944:
1.910 raeburn 1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1946:
1947: Returns a string containing a <select name='$name' size='1'> form to
1948: allow a user to select the domain to preform an operation in.
1949: See loncreateuser.pm for an example invocation and use.
1950:
1.90 www 1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
1952: selected");
1953:
1.743 raeburn 1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1955:
1.910 raeburn 1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1957:
1958: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1959:
1.35 matthew 1960: =cut
1961:
1962: #-------------------------------------------
1.34 matthew 1963: sub select_dom_form {
1.910 raeburn 1964: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1965: if ($onchange) {
1.874 raeburn 1966: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1967: }
1.910 raeburn 1968: my @domains;
1969: if (ref($incdoms) eq 'ARRAY') {
1970: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1971: } else {
1972: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1973: }
1.90 www 1974: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1975: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1976: foreach my $dom (@domains) {
1977: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1978: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1979: if ($showdomdesc) {
1980: if ($dom ne '') {
1981: my $domdesc = &Apache::lonnet::domain($dom,'description');
1982: if ($domdesc ne '') {
1983: $selectdomain .= ' ('.$domdesc.')';
1984: }
1985: }
1986: }
1987: $selectdomain .= "</option>\n";
1.34 matthew 1988: }
1989: $selectdomain.="</select>";
1990: return $selectdomain;
1991: }
1992:
1.35 matthew 1993: #-------------------------------------------
1994:
1.45 matthew 1995: =pod
1996:
1.648 raeburn 1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1998:
1.586 raeburn 1999: input: 4 arguments (two required, two optional) -
2000: $domain - domain of new user
2001: $name - name of form element
2002: $default - Value of 'default' causes a default item to be first
2003: option, and selected by default.
2004: $hide - Value of 'hide' causes hiding of the name of the server,
2005: if 1 server found, or default, if 0 found.
1.594 raeburn 2006: output: returns 2 items:
1.586 raeburn 2007: (a) form element which contains either:
2008: (i) <select name="$name">
2009: <option value="$hostid1">$hostid $servers{$hostid}</option>
2010: <option value="$hostid2">$hostid $servers{$hostid}</option>
2011: </select>
2012: form item if there are multiple library servers in $domain, or
2013: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2014: if there is only one library server in $domain.
2015:
2016: (b) number of library servers found.
2017:
2018: See loncreateuser.pm for example of use.
1.35 matthew 2019:
2020: =cut
2021:
2022: #-------------------------------------------
1.586 raeburn 2023: sub home_server_form_item {
2024: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2025: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2026: my $result;
2027: my $numlib = keys(%servers);
2028: if ($numlib > 1) {
2029: $result .= '<select name="'.$name.'" />'."\n";
2030: if ($default) {
1.804 bisitz 2031: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2032: '</option>'."\n";
2033: }
2034: foreach my $hostid (sort(keys(%servers))) {
2035: $result.= '<option value="'.$hostid.'">'.
2036: $hostid.' '.$servers{$hostid}."</option>\n";
2037: }
2038: $result .= '</select>'."\n";
2039: } elsif ($numlib == 1) {
2040: my $hostid;
2041: foreach my $item (keys(%servers)) {
2042: $hostid = $item;
2043: }
2044: $result .= '<input type="hidden" name="'.$name.'" value="'.
2045: $hostid.'" />';
2046: if (!$hide) {
2047: $result .= $hostid.' '.$servers{$hostid};
2048: }
2049: $result .= "\n";
2050: } elsif ($default) {
2051: $result .= '<input type="hidden" name="'.$name.
2052: '" value="default" />';
2053: if (!$hide) {
2054: $result .= &mt('default');
2055: }
2056: $result .= "\n";
1.33 matthew 2057: }
1.586 raeburn 2058: return ($result,$numlib);
1.33 matthew 2059: }
1.112 bowersj2 2060:
2061: =pod
2062:
1.534 albertel 2063: =back
2064:
1.112 bowersj2 2065: =cut
1.87 matthew 2066:
2067: ###############################################################
1.112 bowersj2 2068: ## Decoding User Agent ##
1.87 matthew 2069: ###############################################################
2070:
2071: =pod
2072:
1.112 bowersj2 2073: =head1 Decoding the User Agent
2074:
2075: =over 4
2076:
2077: =item * &decode_user_agent()
1.87 matthew 2078:
2079: Inputs: $r
2080:
2081: Outputs:
2082:
2083: =over 4
2084:
1.112 bowersj2 2085: =item * $httpbrowser
1.87 matthew 2086:
1.112 bowersj2 2087: =item * $clientbrowser
1.87 matthew 2088:
1.112 bowersj2 2089: =item * $clientversion
1.87 matthew 2090:
1.112 bowersj2 2091: =item * $clientmathml
1.87 matthew 2092:
1.112 bowersj2 2093: =item * $clientunicode
1.87 matthew 2094:
1.112 bowersj2 2095: =item * $clientos
1.87 matthew 2096:
2097: =back
2098:
1.157 matthew 2099: =back
2100:
1.87 matthew 2101: =cut
2102:
2103: ###############################################################
2104: ###############################################################
2105: sub decode_user_agent {
1.247 albertel 2106: my ($r)=@_;
1.87 matthew 2107: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2108: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2109: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2110: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2111: my $clientbrowser='unknown';
2112: my $clientversion='0';
2113: my $clientmathml='';
2114: my $clientunicode='0';
2115: for (my $i=0;$i<=$#browsertype;$i++) {
2116: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2117: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2118: $clientbrowser=$bname;
2119: $httpbrowser=~/$vreg/i;
2120: $clientversion=$1;
2121: $clientmathml=($clientversion>=$minv);
2122: $clientunicode=($clientversion>=$univ);
2123: }
2124: }
2125: my $clientos='unknown';
2126: if (($httpbrowser=~/linux/i) ||
2127: ($httpbrowser=~/unix/i) ||
2128: ($httpbrowser=~/ux/i) ||
2129: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2130: if (($httpbrowser=~/vax/i) ||
2131: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2132: if ($httpbrowser=~/next/i) { $clientos='next'; }
2133: if (($httpbrowser=~/mac/i) ||
2134: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2135: if ($httpbrowser=~/win/i) { $clientos='win'; }
2136: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2137: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2138: $clientunicode,$clientos,);
2139: }
2140:
1.32 matthew 2141: ###############################################################
2142: ## Authentication changing form generation subroutines ##
2143: ###############################################################
2144: ##
2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
2146: ## hash, and have reasonable default values.
2147: ##
2148: ## formname = the name given in the <form> tag.
1.35 matthew 2149: #-------------------------------------------
2150:
1.45 matthew 2151: =pod
2152:
1.112 bowersj2 2153: =head1 Authentication Routines
2154:
2155: =over 4
2156:
1.648 raeburn 2157: =item * &authform_xxxxxx()
1.35 matthew 2158:
2159: The authform_xxxxxx subroutines provide javascript and html forms which
2160: handle some of the conveniences required for authentication forms.
2161: This is not an optimal method, but it works.
2162:
2163: =over 4
2164:
1.112 bowersj2 2165: =item * authform_header
1.35 matthew 2166:
1.112 bowersj2 2167: =item * authform_authorwarning
1.35 matthew 2168:
1.112 bowersj2 2169: =item * authform_nochange
1.35 matthew 2170:
1.112 bowersj2 2171: =item * authform_kerberos
1.35 matthew 2172:
1.112 bowersj2 2173: =item * authform_internal
1.35 matthew 2174:
1.112 bowersj2 2175: =item * authform_filesystem
1.35 matthew 2176:
2177: =back
2178:
1.648 raeburn 2179: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2180:
1.35 matthew 2181: =cut
2182:
2183: #-------------------------------------------
1.32 matthew 2184: sub authform_header{
2185: my %in = (
2186: formname => 'cu',
1.80 albertel 2187: kerb_def_dom => '',
1.32 matthew 2188: @_,
2189: );
2190: $in{'formname'} = 'document.' . $in{'formname'};
2191: my $result='';
1.80 albertel 2192:
2193: #---------------------------------------------- Code for upper case translation
2194: my $Javascript_toUpperCase;
2195: unless ($in{kerb_def_dom}) {
2196: $Javascript_toUpperCase =<<"END";
2197: switch (choice) {
2198: case 'krb': currentform.elements[choicearg].value =
2199: currentform.elements[choicearg].value.toUpperCase();
2200: break;
2201: default:
2202: }
2203: END
2204: } else {
2205: $Javascript_toUpperCase = "";
2206: }
2207:
1.165 raeburn 2208: my $radioval = "'nochange'";
1.591 raeburn 2209: if (defined($in{'curr_authtype'})) {
2210: if ($in{'curr_authtype'} ne '') {
2211: $radioval = "'".$in{'curr_authtype'}."arg'";
2212: }
1.174 matthew 2213: }
1.165 raeburn 2214: my $argfield = 'null';
1.591 raeburn 2215: if (defined($in{'mode'})) {
1.165 raeburn 2216: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2217: if (defined($in{'curr_autharg'})) {
2218: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2219: $argfield = "'$in{'curr_autharg'}'";
2220: }
2221: }
2222: }
2223: }
2224:
1.32 matthew 2225: $result.=<<"END";
2226: var current = new Object();
1.165 raeburn 2227: current.radiovalue = $radioval;
2228: current.argfield = $argfield;
1.32 matthew 2229:
2230: function changed_radio(choice,currentform) {
2231: var choicearg = choice + 'arg';
2232: // If a radio button in changed, we need to change the argfield
2233: if (current.radiovalue != choice) {
2234: current.radiovalue = choice;
2235: if (current.argfield != null) {
2236: currentform.elements[current.argfield].value = '';
2237: }
2238: if (choice == 'nochange') {
2239: current.argfield = null;
2240: } else {
2241: current.argfield = choicearg;
2242: switch(choice) {
2243: case 'krb':
2244: currentform.elements[current.argfield].value =
2245: "$in{'kerb_def_dom'}";
2246: break;
2247: default:
2248: break;
2249: }
2250: }
2251: }
2252: return;
2253: }
1.22 www 2254:
1.32 matthew 2255: function changed_text(choice,currentform) {
2256: var choicearg = choice + 'arg';
2257: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2258: $Javascript_toUpperCase
1.32 matthew 2259: // clear old field
2260: if ((current.argfield != choicearg) && (current.argfield != null)) {
2261: currentform.elements[current.argfield].value = '';
2262: }
2263: current.argfield = choicearg;
2264: }
2265: set_auth_radio_buttons(choice,currentform);
2266: return;
1.20 www 2267: }
1.32 matthew 2268:
2269: function set_auth_radio_buttons(newvalue,currentform) {
2270: var i=0;
2271: while (i < currentform.login.length) {
2272: if (currentform.login[i].value == newvalue) { break; }
2273: i++;
2274: }
2275: if (i == currentform.login.length) {
2276: return;
2277: }
2278: current.radiovalue = newvalue;
2279: currentform.login[i].checked = true;
2280: return;
2281: }
2282: END
2283: return $result;
2284: }
2285:
2286: sub authform_authorwarning{
2287: my $result='';
1.144 matthew 2288: $result='<i>'.
2289: &mt('As a general rule, only authors or co-authors should be '.
2290: 'filesystem authenticated '.
2291: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2292: return $result;
2293: }
2294:
2295: sub authform_nochange{
2296: my %in = (
2297: formname => 'document.cu',
2298: kerb_def_dom => 'MSU.EDU',
2299: @_,
2300: );
1.586 raeburn 2301: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2302: my $result;
2303: if (keys(%can_assign) == 0) {
2304: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2305: } else {
2306: $result = '<label>'.&mt('[_1] Do not change login data',
2307: '<input type="radio" name="login" value="nochange" '.
2308: 'checked="checked" onclick="'.
1.281 albertel 2309: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2310: '</label>';
1.586 raeburn 2311: }
1.32 matthew 2312: return $result;
2313: }
2314:
1.591 raeburn 2315: sub authform_kerberos {
1.32 matthew 2316: my %in = (
2317: formname => 'document.cu',
2318: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2319: kerb_def_auth => 'krb4',
1.32 matthew 2320: @_,
2321: );
1.586 raeburn 2322: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2323: $autharg,$jscall);
2324: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2325: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2326: $check5 = ' checked="checked"';
1.80 albertel 2327: } else {
1.772 bisitz 2328: $check4 = ' checked="checked"';
1.80 albertel 2329: }
1.165 raeburn 2330: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2331: if (defined($in{'curr_authtype'})) {
2332: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2333: $krbcheck = ' checked="checked"';
1.623 raeburn 2334: if (defined($in{'mode'})) {
2335: if ($in{'mode'} eq 'modifyuser') {
2336: $krbcheck = '';
2337: }
2338: }
1.591 raeburn 2339: if (defined($in{'curr_kerb_ver'})) {
2340: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2341: $check5 = ' checked="checked"';
1.591 raeburn 2342: $check4 = '';
2343: } else {
1.772 bisitz 2344: $check4 = ' checked="checked"';
1.591 raeburn 2345: $check5 = '';
2346: }
1.586 raeburn 2347: }
1.591 raeburn 2348: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2349: $krbarg = $in{'curr_autharg'};
2350: }
1.586 raeburn 2351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2352: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2353: $result =
2354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2355: $in{'curr_autharg'},$krbver);
2356: } else {
2357: $result =
2358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2359: }
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
1.784 bisitz 2365: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2366: }
2367: }
1.586 raeburn 2368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2369: return;
1.587 raeburn 2370: } elsif ($authtype eq '') {
1.591 raeburn 2371: if (defined($in{'mode'})) {
1.587 raeburn 2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
1.784 bisitz 2374: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2375: }
2376: }
2377: }
1.586 raeburn 2378: }
2379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="krb" '.
2382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2383: $krbcheck.' />';
2384: }
2385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2387: $in{'curr_authtype'} eq 'krb5') ||
2388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2389: $in{'curr_authtype'} eq 'krb4')) {
2390: $result .= &mt
1.144 matthew 2391: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2392: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2393: '<label>'.$authtype,
1.281 albertel 2394: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2395: 'value="'.$krbarg.'" '.
1.144 matthew 2396: 'onchange="'.$jscall.'" />',
1.281 albertel 2397: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2399: '</label>');
1.586 raeburn 2400: } elsif ($can_assign{'krb4'}) {
2401: $result .= &mt
2402: ('[_1] Kerberos authenticated with domain [_2] '.
2403: '[_3] Version 4 [_4]',
2404: '<label>'.$authtype,
2405: '</label><input type="text" size="10" name="krbarg" '.
2406: 'value="'.$krbarg.'" '.
2407: 'onchange="'.$jscall.'" />',
2408: '<label><input type="hidden" name="krbver" value="4" />',
2409: '</label>');
2410: } elsif ($can_assign{'krb5'}) {
2411: $result .= &mt
2412: ('[_1] Kerberos authenticated with domain [_2] '.
2413: '[_3] Version 5 [_4]',
2414: '<label>'.$authtype,
2415: '</label><input type="text" size="10" name="krbarg" '.
2416: 'value="'.$krbarg.'" '.
2417: 'onchange="'.$jscall.'" />',
2418: '<label><input type="hidden" name="krbver" value="5" />',
2419: '</label>');
2420: }
1.32 matthew 2421: return $result;
2422: }
2423:
2424: sub authform_internal{
1.586 raeburn 2425: my %in = (
1.32 matthew 2426: formname => 'document.cu',
2427: kerb_def_dom => 'MSU.EDU',
2428: @_,
2429: );
1.586 raeburn 2430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2432: if (defined($in{'curr_authtype'})) {
2433: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2434: if ($can_assign{'int'}) {
1.772 bisitz 2435: $intcheck = 'checked="checked" ';
1.623 raeburn 2436: if (defined($in{'mode'})) {
2437: if ($in{'mode'} eq 'modifyuser') {
2438: $intcheck = '';
2439: }
2440: }
1.591 raeburn 2441: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2442: $intarg = $in{'curr_autharg'};
2443: }
2444: } else {
2445: $result = &mt('Currently internally authenticated.');
2446: return $result;
1.165 raeburn 2447: }
2448: }
1.586 raeburn 2449: } else {
2450: if ($authnum == 1) {
1.784 bisitz 2451: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2452: }
2453: }
2454: if (!$can_assign{'int'}) {
2455: return;
1.587 raeburn 2456: } elsif ($authtype eq '') {
1.591 raeburn 2457: if (defined($in{'mode'})) {
1.587 raeburn 2458: if ($in{'mode'} eq 'modifycourse') {
2459: if ($authnum == 1) {
1.784 bisitz 2460: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2461: }
2462: }
2463: }
1.165 raeburn 2464: }
1.586 raeburn 2465: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2466: if ($authtype eq '') {
2467: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2468: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2469: }
1.605 bisitz 2470: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2471: $intarg.'" onchange="'.$jscall.'" />';
2472: $result = &mt
1.144 matthew 2473: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2474: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2475: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2476: return $result;
2477: }
2478:
2479: sub authform_local{
2480: my %in = (
2481: formname => 'document.cu',
2482: kerb_def_dom => 'MSU.EDU',
2483: @_,
2484: );
1.586 raeburn 2485: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2486: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2487: if (defined($in{'curr_authtype'})) {
2488: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2489: if ($can_assign{'loc'}) {
1.772 bisitz 2490: $loccheck = 'checked="checked" ';
1.623 raeburn 2491: if (defined($in{'mode'})) {
2492: if ($in{'mode'} eq 'modifyuser') {
2493: $loccheck = '';
2494: }
2495: }
1.591 raeburn 2496: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2497: $locarg = $in{'curr_autharg'};
2498: }
2499: } else {
2500: $result = &mt('Currently using local (institutional) authentication.');
2501: return $result;
1.165 raeburn 2502: }
2503: }
1.586 raeburn 2504: } else {
2505: if ($authnum == 1) {
1.784 bisitz 2506: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2507: }
2508: }
2509: if (!$can_assign{'loc'}) {
2510: return;
1.587 raeburn 2511: } elsif ($authtype eq '') {
1.591 raeburn 2512: if (defined($in{'mode'})) {
1.587 raeburn 2513: if ($in{'mode'} eq 'modifycourse') {
2514: if ($authnum == 1) {
1.784 bisitz 2515: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2516: }
2517: }
2518: }
1.165 raeburn 2519: }
1.586 raeburn 2520: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2521: if ($authtype eq '') {
2522: $authtype = '<input type="radio" name="login" value="loc" '.
2523: $loccheck.' onchange="'.$jscall.'" onclick="'.
2524: $jscall.'" />';
2525: }
2526: $autharg = '<input type="text" size="10" name="locarg" value="'.
2527: $locarg.'" onchange="'.$jscall.'" />';
2528: $result = &mt('[_1] Local Authentication with argument [_2]',
2529: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2530: return $result;
2531: }
2532:
2533: sub authform_filesystem{
2534: my %in = (
2535: formname => 'document.cu',
2536: kerb_def_dom => 'MSU.EDU',
2537: @_,
2538: );
1.586 raeburn 2539: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2540: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2541: if (defined($in{'curr_authtype'})) {
2542: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2543: if ($can_assign{'fsys'}) {
1.772 bisitz 2544: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2545: if (defined($in{'mode'})) {
2546: if ($in{'mode'} eq 'modifyuser') {
2547: $fsyscheck = '';
2548: }
2549: }
1.586 raeburn 2550: } else {
2551: $result = &mt('Currently Filesystem Authenticated.');
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
1.784 bisitz 2557: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2558: }
2559: }
2560: if (!$can_assign{'fsys'}) {
2561: return;
1.587 raeburn 2562: } elsif ($authtype eq '') {
1.591 raeburn 2563: if (defined($in{'mode'})) {
1.587 raeburn 2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
1.784 bisitz 2566: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2567: }
2568: }
2569: }
1.586 raeburn 2570: }
2571: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="fsys" '.
2574: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2575: $jscall.'" />';
2576: }
2577: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2578: ' onchange="'.$jscall.'" />';
2579: $result = &mt
1.144 matthew 2580: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2581: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2582: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2583: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2584: 'onchange="'.$jscall.'" />');
1.32 matthew 2585: return $result;
2586: }
2587:
1.586 raeburn 2588: sub get_assignable_auth {
2589: my ($dom) = @_;
2590: if ($dom eq '') {
2591: $dom = $env{'request.role.domain'};
2592: }
2593: my %can_assign = (
2594: krb4 => 1,
2595: krb5 => 1,
2596: int => 1,
2597: loc => 1,
2598: );
2599: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2600: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2601: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2602: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2603: my $context;
2604: if ($env{'request.role'} =~ /^au/) {
2605: $context = 'author';
2606: } elsif ($env{'request.role'} =~ /^dc/) {
2607: $context = 'domain';
2608: } elsif ($env{'request.course.id'}) {
2609: $context = 'course';
2610: }
2611: if ($context) {
2612: if (ref($authhash->{$context}) eq 'HASH') {
2613: %can_assign = %{$authhash->{$context}};
2614: }
2615: }
2616: }
2617: }
2618: my $authnum = 0;
2619: foreach my $key (keys(%can_assign)) {
2620: if ($can_assign{$key}) {
2621: $authnum ++;
2622: }
2623: }
2624: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2625: $authnum --;
2626: }
2627: return ($authnum,%can_assign);
2628: }
2629:
1.80 albertel 2630: ###############################################################
2631: ## Get Kerberos Defaults for Domain ##
2632: ###############################################################
2633: ##
2634: ## Returns default kerberos version and an associated argument
2635: ## as listed in file domain.tab. If not listed, provides
2636: ## appropriate default domain and kerberos version.
2637: ##
2638: #-------------------------------------------
2639:
2640: =pod
2641:
1.648 raeburn 2642: =item * &get_kerberos_defaults()
1.80 albertel 2643:
2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2645: version and domain. If not found, it defaults to version 4 and the
2646: domain of the server.
1.80 albertel 2647:
1.648 raeburn 2648: =over 4
2649:
1.80 albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2651:
1.648 raeburn 2652: =back
2653:
2654: =back
2655:
1.80 albertel 2656: =cut
2657:
2658: #-------------------------------------------
2659: sub get_kerberos_defaults {
2660: my $domain=shift;
1.641 raeburn 2661: my ($krbdef,$krbdefdom);
2662: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2663: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2664: $krbdef = $domdefaults{'auth_def'};
2665: $krbdefdom = $domdefaults{'auth_arg_def'};
2666: } else {
1.80 albertel 2667: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2668: my $krbdefdom=$1;
2669: $krbdefdom=~tr/a-z/A-Z/;
2670: $krbdef = "krb4";
2671: }
2672: return ($krbdef,$krbdefdom);
2673: }
1.112 bowersj2 2674:
1.32 matthew 2675:
1.46 matthew 2676: ###############################################################
2677: ## Thesaurus Functions ##
2678: ###############################################################
1.20 www 2679:
1.46 matthew 2680: =pod
1.20 www 2681:
1.112 bowersj2 2682: =head1 Thesaurus Functions
2683:
2684: =over 4
2685:
1.648 raeburn 2686: =item * &initialize_keywords()
1.46 matthew 2687:
2688: Initializes the package variable %Keywords if it is empty. Uses the
2689: package variable $thesaurus_db_file.
2690:
2691: =cut
2692:
2693: ###################################################
2694:
2695: sub initialize_keywords {
2696: return 1 if (scalar keys(%Keywords));
2697: # If we are here, %Keywords is empty, so fill it up
2698: # Make sure the file we need exists...
2699: if (! -e $thesaurus_db_file) {
2700: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2701: " failed because it does not exist");
2702: return 0;
2703: }
2704: # Set up the hash as a database
2705: my %thesaurus_db;
2706: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2707: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2708: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2709: $thesaurus_db_file);
2710: return 0;
2711: }
2712: # Get the average number of appearances of a word.
2713: my $avecount = $thesaurus_db{'average.count'};
2714: # Put keywords (those that appear > average) into %Keywords
2715: while (my ($word,$data)=each (%thesaurus_db)) {
2716: my ($count,undef) = split /:/,$data;
2717: $Keywords{$word}++ if ($count > $avecount);
2718: }
2719: untie %thesaurus_db;
2720: # Remove special values from %Keywords.
1.356 albertel 2721: foreach my $value ('total.count','average.count') {
2722: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2723: }
1.46 matthew 2724: return 1;
2725: }
2726:
2727: ###################################################
2728:
2729: =pod
2730:
1.648 raeburn 2731: =item * &keyword($word)
1.46 matthew 2732:
2733: Returns true if $word is a keyword. A keyword is a word that appears more
2734: than the average number of times in the thesaurus database. Calls
2735: &initialize_keywords
2736:
2737: =cut
2738:
2739: ###################################################
1.20 www 2740:
2741: sub keyword {
1.46 matthew 2742: return if (!&initialize_keywords());
2743: my $word=lc(shift());
2744: $word=~s/\W//g;
2745: return exists($Keywords{$word});
1.20 www 2746: }
1.46 matthew 2747:
2748: ###############################################################
2749:
2750: =pod
1.20 www 2751:
1.648 raeburn 2752: =item * &get_related_words()
1.46 matthew 2753:
1.160 matthew 2754: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2755: an array of words. If the keyword is not in the thesaurus, an empty array
2756: will be returned. The order of the words returned is determined by the
2757: database which holds them.
2758:
2759: Uses global $thesaurus_db_file.
2760:
2761: =cut
2762:
2763: ###############################################################
2764: sub get_related_words {
2765: my $keyword = shift;
2766: my %thesaurus_db;
2767: if (! -e $thesaurus_db_file) {
2768: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2769: "failed because the file does not exist");
2770: return ();
2771: }
2772: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2773: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2774: return ();
2775: }
2776: my @Words=();
1.429 www 2777: my $count=0;
1.46 matthew 2778: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2779: # The first element is the number of times
2780: # the word appears. We do not need it now.
1.429 www 2781: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2782: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2783: my $threshold=$mostfrequentcount/10;
2784: foreach my $possibleword (@RelatedWords) {
2785: my ($word,$wordcount)=split(/\,/,$possibleword);
2786: if ($wordcount>$threshold) {
2787: push(@Words,$word);
2788: $count++;
2789: if ($count>10) { last; }
2790: }
1.20 www 2791: }
2792: }
1.46 matthew 2793: untie %thesaurus_db;
2794: return @Words;
1.14 harris41 2795: }
1.46 matthew 2796:
1.112 bowersj2 2797: =pod
2798:
2799: =back
2800:
2801: =cut
1.61 www 2802:
2803: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2804: =pod
2805:
1.112 bowersj2 2806: =head1 User Name Functions
2807:
2808: =over 4
2809:
1.648 raeburn 2810: =item * &plainname($uname,$udom,$first)
1.81 albertel 2811:
1.112 bowersj2 2812: Takes a users logon name and returns it as a string in
1.226 albertel 2813: "first middle last generation" form
2814: if $first is set to 'lastname' then it returns it as
2815: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2816:
2817: =cut
1.61 www 2818:
1.295 www 2819:
1.81 albertel 2820: ###############################################################
1.61 www 2821: sub plainname {
1.226 albertel 2822: my ($uname,$udom,$first)=@_;
1.537 albertel 2823: return if (!defined($uname) || !defined($udom));
1.295 www 2824: my %names=&getnames($uname,$udom);
1.226 albertel 2825: my $name=&Apache::lonnet::format_name($names{'firstname'},
2826: $names{'middlename'},
2827: $names{'lastname'},
2828: $names{'generation'},$first);
2829: $name=~s/^\s+//;
1.62 www 2830: $name=~s/\s+$//;
2831: $name=~s/\s+/ /g;
1.353 albertel 2832: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2833: return $name;
1.61 www 2834: }
1.66 www 2835:
2836: # -------------------------------------------------------------------- Nickname
1.81 albertel 2837: =pod
2838:
1.648 raeburn 2839: =item * &nickname($uname,$udom)
1.81 albertel 2840:
2841: Gets a users name and returns it as a string as
2842:
2843: ""nickname""
1.66 www 2844:
1.81 albertel 2845: if the user has a nickname or
2846:
2847: "first middle last generation"
2848:
2849: if the user does not
2850:
2851: =cut
1.66 www 2852:
2853: sub nickname {
2854: my ($uname,$udom)=@_;
1.537 albertel 2855: return if (!defined($uname) || !defined($udom));
1.295 www 2856: my %names=&getnames($uname,$udom);
1.68 albertel 2857: my $name=$names{'nickname'};
1.66 www 2858: if ($name) {
2859: $name='"'.$name.'"';
2860: } else {
2861: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2862: $names{'lastname'}.' '.$names{'generation'};
2863: $name=~s/\s+$//;
2864: $name=~s/\s+/ /g;
2865: }
2866: return $name;
2867: }
2868:
1.295 www 2869: sub getnames {
2870: my ($uname,$udom)=@_;
1.537 albertel 2871: return if (!defined($uname) || !defined($udom));
1.433 albertel 2872: if ($udom eq 'public' && $uname eq 'public') {
2873: return ('lastname' => &mt('Public'));
2874: }
1.295 www 2875: my $id=$uname.':'.$udom;
2876: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2877: if ($cached) {
2878: return %{$names};
2879: } else {
2880: my %loadnames=&Apache::lonnet::get('environment',
2881: ['firstname','middlename','lastname','generation','nickname'],
2882: $udom,$uname);
2883: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2884: return %loadnames;
2885: }
2886: }
1.61 www 2887:
1.542 raeburn 2888: # -------------------------------------------------------------------- getemails
1.648 raeburn 2889:
1.542 raeburn 2890: =pod
2891:
1.648 raeburn 2892: =item * &getemails($uname,$udom)
1.542 raeburn 2893:
2894: Gets a user's email information and returns it as a hash with keys:
2895: notification, critnotification, permanentemail
2896:
2897: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2899:
1.648 raeburn 2900:
1.542 raeburn 2901: =cut
2902:
1.648 raeburn 2903:
1.466 albertel 2904: sub getemails {
2905: my ($uname,$udom)=@_;
2906: if ($udom eq 'public' && $uname eq 'public') {
2907: return;
2908: }
1.467 www 2909: if (!$udom) { $udom=$env{'user.domain'}; }
2910: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2911: my $id=$uname.':'.$udom;
2912: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2913: if ($cached) {
2914: return %{$names};
2915: } else {
2916: my %loadnames=&Apache::lonnet::get('environment',
2917: ['notification','critnotification',
2918: 'permanentemail'],
2919: $udom,$uname);
2920: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2921: return %loadnames;
2922: }
2923: }
2924:
1.551 albertel 2925: sub flush_email_cache {
2926: my ($uname,$udom)=@_;
2927: if (!$udom) { $udom =$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: return if ($udom eq 'public' && $uname eq 'public');
2930: my $id=$uname.':'.$udom;
2931: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2932: }
2933:
1.728 raeburn 2934: # -------------------------------------------------------------------- getlangs
2935:
2936: =pod
2937:
2938: =item * &getlangs($uname,$udom)
2939:
2940: Gets a user's language preference and returns it as a hash with key:
2941: language.
2942:
2943: =cut
2944:
2945:
2946: sub getlangs {
2947: my ($uname,$udom) = @_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: my $id=$uname.':'.$udom;
2951: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2952: if ($cached) {
2953: return %{$langs};
2954: } else {
2955: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2956: $udom,$uname);
2957: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2958: return %loadlangs;
2959: }
2960: }
2961:
2962: sub flush_langs_cache {
2963: my ($uname,$udom)=@_;
2964: if (!$udom) { $udom =$env{'user.domain'}; }
2965: if (!$uname) { $uname=$env{'user.name'}; }
2966: return if ($udom eq 'public' && $uname eq 'public');
2967: my $id=$uname.':'.$udom;
2968: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2969: }
2970:
1.61 www 2971: # ------------------------------------------------------------------ Screenname
1.81 albertel 2972:
2973: =pod
2974:
1.648 raeburn 2975: =item * &screenname($uname,$udom)
1.81 albertel 2976:
2977: Gets a users screenname and returns it as a string
2978:
2979: =cut
1.61 www 2980:
2981: sub screenname {
2982: my ($uname,$udom)=@_;
1.258 albertel 2983: if ($uname eq $env{'user.name'} &&
2984: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2985: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2986: return $names{'screenname'};
1.62 www 2987: }
2988:
1.212 albertel 2989:
1.802 bisitz 2990: # ------------------------------------------------------------- Confirm Wrapper
2991: =pod
2992:
2993: =item confirmwrapper
2994:
2995: Wrap messages about completion of operation in box
2996:
2997: =cut
2998:
2999: sub confirmwrapper {
3000: my ($message)=@_;
3001: if ($message) {
3002: return "\n".'<div class="LC_confirm_box">'."\n"
3003: .$message."\n"
3004: .'</div>'."\n";
3005: } else {
3006: return $message;
3007: }
3008: }
3009:
1.62 www 3010: # ------------------------------------------------------------- Message Wrapper
3011:
3012: sub messagewrapper {
1.369 www 3013: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3014: return
1.441 albertel 3015: '<a href="/adm/email?compose=individual&'.
3016: 'recname='.$username.'&recdom='.$domain.
3017: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3018: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3019: }
1.802 bisitz 3020:
1.74 www 3021: # --------------------------------------------------------------- Notes Wrapper
3022:
3023: sub noteswrapper {
3024: my ($link,$un,$do)=@_;
3025: return
1.896 amueller 3026: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3027: }
1.802 bisitz 3028:
1.62 www 3029: # ------------------------------------------------------------- Aboutme Wrapper
3030:
3031: sub aboutmewrapper {
1.166 www 3032: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3033: if (!defined($username) && !defined($domain)) {
3034: return;
3035: }
1.892 amueller 3036: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3037: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3038: }
3039:
3040: # ------------------------------------------------------------ Syllabus Wrapper
3041:
3042: sub syllabuswrapper {
1.707 bisitz 3043: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3044: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3045: }
1.14 harris41 3046:
1.802 bisitz 3047: # -----------------------------------------------------------------------------
3048:
1.208 matthew 3049: sub track_student_link {
1.887 raeburn 3050: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3051: my $link ="/adm/trackstudent?";
1.208 matthew 3052: my $title = 'View recent activity';
3053: if (defined($sname) && $sname !~ /^\s*$/ &&
3054: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3055: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3056: $title .= ' of this student';
1.268 albertel 3057: }
1.208 matthew 3058: if (defined($target) && $target !~ /^\s*$/) {
3059: $target = qq{target="$target"};
3060: } else {
3061: $target = '';
3062: }
1.268 albertel 3063: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3064: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3065: $title = &mt($title);
3066: $linktext = &mt($linktext);
1.448 albertel 3067: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3068: &help_open_topic('View_recent_activity');
1.208 matthew 3069: }
3070:
1.781 raeburn 3071: sub slot_reservations_link {
3072: my ($linktext,$sname,$sdom,$target) = @_;
3073: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3074: my $title = 'View slot reservation history';
3075: if (defined($sname) && $sname !~ /^\s*$/ &&
3076: defined($sdom) && $sdom !~ /^\s*$/) {
3077: $link .= "&uname=$sname&udom=$sdom";
3078: $title .= ' of this student';
3079: }
3080: if (defined($target) && $target !~ /^\s*$/) {
3081: $target = qq{target="$target"};
3082: } else {
3083: $target = '';
3084: }
3085: $title = &mt($title);
3086: $linktext = &mt($linktext);
3087: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3089:
3090: }
3091:
1.508 www 3092: # ===================================================== Display a student photo
3093:
3094:
1.509 albertel 3095: sub student_image_tag {
1.508 www 3096: my ($domain,$user)=@_;
3097: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3098: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3099: return '<img src="'.$imgsrc.'" align="right" />';
3100: } else {
3101: return '';
3102: }
3103: }
3104:
1.112 bowersj2 3105: =pod
3106:
3107: =back
3108:
3109: =head1 Access .tab File Data
3110:
3111: =over 4
3112:
1.648 raeburn 3113: =item * &languageids()
1.112 bowersj2 3114:
3115: returns list of all language ids
3116:
3117: =cut
3118:
1.14 harris41 3119: sub languageids {
1.16 harris41 3120: return sort(keys(%language));
1.14 harris41 3121: }
3122:
1.112 bowersj2 3123: =pod
3124:
1.648 raeburn 3125: =item * &languagedescription()
1.112 bowersj2 3126:
3127: returns description of a specified language id
3128:
3129: =cut
3130:
1.14 harris41 3131: sub languagedescription {
1.125 www 3132: my $code=shift;
3133: return ($supported_language{$code}?'* ':'').
3134: $language{$code}.
1.126 www 3135: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3136: }
3137:
3138: sub plainlanguagedescription {
3139: my $code=shift;
3140: return $language{$code};
3141: }
3142:
3143: sub supportedlanguagecode {
3144: my $code=shift;
3145: return $supported_language{$code};
1.97 www 3146: }
3147:
1.112 bowersj2 3148: =pod
3149:
1.648 raeburn 3150: =item * ©rightids()
1.112 bowersj2 3151:
3152: returns list of all copyrights
3153:
3154: =cut
3155:
3156: sub copyrightids {
3157: return sort(keys(%cprtag));
3158: }
3159:
3160: =pod
3161:
1.648 raeburn 3162: =item * ©rightdescription()
1.112 bowersj2 3163:
3164: returns description of a specified copyright id
3165:
3166: =cut
3167:
3168: sub copyrightdescription {
1.166 www 3169: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3170: }
1.197 matthew 3171:
3172: =pod
3173:
1.648 raeburn 3174: =item * &source_copyrightids()
1.192 taceyjo1 3175:
3176: returns list of all source copyrights
3177:
3178: =cut
3179:
3180: sub source_copyrightids {
3181: return sort(keys(%scprtag));
3182: }
3183:
3184: =pod
3185:
1.648 raeburn 3186: =item * &source_copyrightdescription()
1.192 taceyjo1 3187:
3188: returns description of a specified source copyright id
3189:
3190: =cut
3191:
3192: sub source_copyrightdescription {
3193: return &mt($scprtag{shift(@_)});
3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.648 raeburn 3198: =item * &filecategories()
1.112 bowersj2 3199:
3200: returns list of all file categories
3201:
3202: =cut
3203:
3204: sub filecategories {
3205: return sort(keys(%category_extensions));
3206: }
3207:
3208: =pod
3209:
1.648 raeburn 3210: =item * &filecategorytypes()
1.112 bowersj2 3211:
3212: returns list of file types belonging to a given file
3213: category
3214:
3215: =cut
3216:
3217: sub filecategorytypes {
1.356 albertel 3218: my ($cat) = @_;
3219: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3220: }
3221:
3222: =pod
3223:
1.648 raeburn 3224: =item * &fileembstyle()
1.112 bowersj2 3225:
3226: returns embedding style for a specified file type
3227:
3228: =cut
3229:
3230: sub fileembstyle {
3231: return $fe{lc(shift(@_))};
1.169 www 3232: }
3233:
1.351 www 3234: sub filemimetype {
3235: return $fm{lc(shift(@_))};
3236: }
3237:
1.169 www 3238:
3239: sub filecategoryselect {
3240: my ($name,$value)=@_;
1.189 matthew 3241: return &select_form($value,$name,
1.970 raeburn 3242: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3243: }
3244:
3245: =pod
3246:
1.648 raeburn 3247: =item * &filedescription()
1.112 bowersj2 3248:
3249: returns description for a specified file type
3250:
3251: =cut
3252:
3253: sub filedescription {
1.188 matthew 3254: my $file_description = $fd{lc(shift())};
3255: $file_description =~ s:([\[\]]):~$1:g;
3256: return &mt($file_description);
1.112 bowersj2 3257: }
3258:
3259: =pod
3260:
1.648 raeburn 3261: =item * &filedescriptionex()
1.112 bowersj2 3262:
3263: returns description for a specified file type with
3264: extra formatting
3265:
3266: =cut
3267:
3268: sub filedescriptionex {
3269: my $ex=shift;
1.188 matthew 3270: my $file_description = $fd{lc($ex)};
3271: $file_description =~ s:([\[\]]):~$1:g;
3272: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3273: }
3274:
3275: # End of .tab access
3276: =pod
3277:
3278: =back
3279:
3280: =cut
3281:
3282: # ------------------------------------------------------------------ File Types
3283: sub fileextensions {
3284: return sort(keys(%fe));
3285: }
3286:
1.97 www 3287: # ----------------------------------------------------------- Display Languages
3288: # returns a hash with all desired display languages
3289: #
3290:
3291: sub display_languages {
3292: my %languages=();
1.695 raeburn 3293: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3294: $languages{$lang}=1;
1.97 www 3295: }
3296: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3297: if ($env{'form.displaylanguage'}) {
1.356 albertel 3298: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3299: $languages{$lang}=1;
1.97 www 3300: }
3301: }
3302: return %languages;
1.14 harris41 3303: }
3304:
1.582 albertel 3305: sub languages {
3306: my ($possible_langs) = @_;
1.695 raeburn 3307: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3308: if (!ref($possible_langs)) {
3309: if( wantarray ) {
3310: return @preferred_langs;
3311: } else {
3312: return $preferred_langs[0];
3313: }
3314: }
3315: my %possibilities = map { $_ => 1 } (@$possible_langs);
3316: my @preferred_possibilities;
3317: foreach my $preferred_lang (@preferred_langs) {
3318: if (exists($possibilities{$preferred_lang})) {
3319: push(@preferred_possibilities, $preferred_lang);
3320: }
3321: }
3322: if( wantarray ) {
3323: return @preferred_possibilities;
3324: }
3325: return $preferred_possibilities[0];
3326: }
3327:
1.742 raeburn 3328: sub user_lang {
3329: my ($touname,$toudom,$fromcid) = @_;
3330: my @userlangs;
3331: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3332: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3333: $env{'course.'.$fromcid.'.languages'}));
3334: } else {
3335: my %langhash = &getlangs($touname,$toudom);
3336: if ($langhash{'languages'} ne '') {
3337: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3338: } else {
3339: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3340: if ($domdefs{'lang_def'} ne '') {
3341: @userlangs = ($domdefs{'lang_def'});
3342: }
3343: }
3344: }
3345: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3346: my $user_lh = Apache::localize->get_handle(@languages);
3347: return $user_lh;
3348: }
3349:
3350:
1.112 bowersj2 3351: ###############################################################
3352: ## Student Answer Attempts ##
3353: ###############################################################
3354:
3355: =pod
3356:
3357: =head1 Alternate Problem Views
3358:
3359: =over 4
3360:
1.648 raeburn 3361: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3362: $getattempt, $regexp, $gradesub)
3363:
3364: Return string with previous attempt on problem. Arguments:
3365:
3366: =over 4
3367:
3368: =item * $symb: Problem, including path
3369:
3370: =item * $username: username of the desired student
3371:
3372: =item * $domain: domain of the desired student
1.14 harris41 3373:
1.112 bowersj2 3374: =item * $course: Course ID
1.14 harris41 3375:
1.112 bowersj2 3376: =item * $getattempt: Leave blank for all attempts, otherwise put
3377: something
1.14 harris41 3378:
1.112 bowersj2 3379: =item * $regexp: if string matches this regexp, the string will be
3380: sent to $gradesub
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3383:
1.112 bowersj2 3384: =back
1.14 harris41 3385:
1.112 bowersj2 3386: The output string is a table containing all desired attempts, if any.
1.16 harris41 3387:
1.112 bowersj2 3388: =cut
1.1 albertel 3389:
3390: sub get_previous_attempt {
1.43 ng 3391: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3392: my $prevattempts='';
1.43 ng 3393: no strict 'refs';
1.1 albertel 3394: if ($symb) {
1.3 albertel 3395: my (%returnhash)=
3396: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3397: if ($returnhash{'version'}) {
3398: my %lasthash=();
3399: my $version;
3400: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3401: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3402: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3403: }
1.1 albertel 3404: }
1.596 albertel 3405: $prevattempts=&start_data_table().&start_data_table_header_row();
3406: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 raeburn 3407: my %typeparts;
3408: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3409: foreach my $key (sort(keys(%lasthash))) {
3410: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3411: if ($#parts > 0) {
1.31 albertel 3412: my $data=$parts[-1];
3413: pop(@parts);
1.945 raeburn 3414: if ($data eq 'type') {
3415: unless ($showsurv) {
3416: my $id = join(',',@parts);
3417: $typeparts{$ign.'.'.$id} = $lasthash{$key};
3418: }
3419: delete($lasthash{$key});
3420: } else {
3421: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3422: }
1.31 albertel 3423: } else {
1.41 ng 3424: if ($#parts == 0) {
3425: $prevattempts.='<th>'.$parts[0].'</th>';
3426: } else {
3427: $prevattempts.='<th>'.$ign.'</th>';
3428: }
1.31 albertel 3429: }
1.16 harris41 3430: }
1.596 albertel 3431: $prevattempts.=&end_data_table_header_row();
1.945 raeburn 3432: my %lasthidden;
1.40 ng 3433: if ($getattempt eq '') {
3434: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 raeburn 3435: my @hidden;
3436: if (%typeparts) {
3437: foreach my $id (keys(%typeparts)) {
3438: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
3439: push(@hidden,$id);
3440: $lasthidden{$id} = 1;
3441: } elsif ($lasthidden{$id}) {
3442: if (exists($returnhash{$version.':'.$id.'.award'})) {
3443: delete($lasthidden{$id});
3444: }
3445: }
3446: }
3447: }
3448: $prevattempts.=&start_data_table_row().
3449: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3450: if (@hidden) {
3451: foreach my $key (sort(keys(%lasthash))) {
3452: my $hide;
3453: foreach my $id (@hidden) {
3454: if ($key =~ /^\Q$id\E/) {
3455: $hide = 1;
3456: last;
3457: }
3458: }
3459: if ($hide) {
3460: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3461: if (($data eq 'award') || ($data eq 'awarddetail')) {
3462: my $value = &format_previous_attempt_value($key,
3463: $returnhash{$version.':'.$key});
3464: $prevattempts.='<td>'.$value.' </td>';
3465: } else {
3466: $prevattempts.='<td> </td>';
3467: }
3468: } else {
3469: if ($key =~ /\./) {
3470: my $value = &format_previous_attempt_value($key,
3471: $returnhash{$version.':'.$key});
3472: $prevattempts.='<td>'.$value.' </td>';
3473: } else {
3474: $prevattempts.='<td> </td>';
3475: }
3476: }
3477: }
3478: } else {
3479: foreach my $key (sort(keys(%lasthash))) {
3480: my $value = &format_previous_attempt_value($key,
3481: $returnhash{$version.':'.$key});
3482: $prevattempts.='<td>'.$value.' </td>';
3483: }
3484: }
3485: $prevattempts.=&end_data_table_row();
1.40 ng 3486: }
1.1 albertel 3487: }
1.945 raeburn 3488: my @currhidden = keys(%lasthidden);
1.596 albertel 3489: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3490: foreach my $key (sort(keys(%lasthash))) {
1.945 raeburn 3491: if (%typeparts) {
3492: my $hidden;
3493: foreach my $id (@currhidden) {
3494: if ($key =~ /^\Q$id\E/) {
3495: $hidden = 1;
3496: last;
3497: }
3498: }
3499: if ($hidden) {
3500: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
3501: if (($data eq 'award') || ($data eq 'awarddetail')) {
3502: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3503: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3504: $value = &$gradesub($value);
3505: }
3506: $prevattempts.='<td>'.$value.' </td>';
3507: } else {
3508: $prevattempts.='<td> </td>';
3509: }
3510: } else {
3511: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3512: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3513: $value = &$gradesub($value);
3514: }
3515: $prevattempts.='<td>'.$value.' </td>';
3516: }
3517: } else {
3518: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3519: if ($key =~/$regexp$/ && (defined &$gradesub)) {
3520: $value = &$gradesub($value);
3521: }
3522: $prevattempts.='<td>'.$value.' </td>';
3523: }
1.16 harris41 3524: }
1.596 albertel 3525: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3526: } else {
1.596 albertel 3527: $prevattempts=
3528: &start_data_table().&start_data_table_row().
3529: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3530: &end_data_table_row().&end_data_table();
1.1 albertel 3531: }
3532: } else {
1.596 albertel 3533: $prevattempts=
3534: &start_data_table().&start_data_table_row().
3535: '<td>'.&mt('No data.').'</td>'.
3536: &end_data_table_row().&end_data_table();
1.1 albertel 3537: }
1.10 albertel 3538: }
3539:
1.581 albertel 3540: sub format_previous_attempt_value {
3541: my ($key,$value) = @_;
3542: if ($key =~ /timestamp/) {
3543: $value = &Apache::lonlocal::locallocaltime($value);
3544: } elsif (ref($value) eq 'ARRAY') {
3545: $value = '('.join(', ', @{ $value }).')';
3546: } else {
3547: $value = &unescape($value);
3548: }
3549: return $value;
3550: }
3551:
3552:
1.107 albertel 3553: sub relative_to_absolute {
3554: my ($url,$output)=@_;
3555: my $parser=HTML::TokeParser->new(\$output);
3556: my $token;
3557: my $thisdir=$url;
3558: my @rlinks=();
3559: while ($token=$parser->get_token) {
3560: if ($token->[0] eq 'S') {
3561: if ($token->[1] eq 'a') {
3562: if ($token->[2]->{'href'}) {
3563: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3564: }
3565: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3566: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3567: } elsif ($token->[1] eq 'base') {
3568: $thisdir=$token->[2]->{'href'};
3569: }
3570: }
3571: }
3572: $thisdir=~s-/[^/]*$--;
1.356 albertel 3573: foreach my $link (@rlinks) {
1.726 raeburn 3574: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3575: ($link=~/^\//) ||
3576: ($link=~/^javascript:/i) ||
3577: ($link=~/^mailto:/i) ||
3578: ($link=~/^\#/)) {
3579: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3580: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3581: }
3582: }
3583: # -------------------------------------------------- Deal with Applet codebases
3584: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3585: return $output;
3586: }
3587:
1.112 bowersj2 3588: =pod
3589:
1.648 raeburn 3590: =item * &get_student_view()
1.112 bowersj2 3591:
3592: show a snapshot of what student was looking at
3593:
3594: =cut
3595:
1.10 albertel 3596: sub get_student_view {
1.186 albertel 3597: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3598: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3599: my (%form);
1.10 albertel 3600: my @elements=('symb','courseid','domain','username');
3601: foreach my $element (@elements) {
1.186 albertel 3602: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3603: }
1.186 albertel 3604: if (defined($moreenv)) {
3605: %form=(%form,%{$moreenv});
3606: }
1.236 albertel 3607: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3608: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3609: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3610: $userview=~s/\<body[^\>]*\>//gi;
3611: $userview=~s/\<\/body\>//gi;
3612: $userview=~s/\<html\>//gi;
3613: $userview=~s/\<\/html\>//gi;
3614: $userview=~s/\<head\>//gi;
3615: $userview=~s/\<\/head\>//gi;
3616: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3617: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3618: if (wantarray) {
3619: return ($userview,$response);
3620: } else {
3621: return $userview;
3622: }
3623: }
3624:
3625: sub get_student_view_with_retries {
3626: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3627:
3628: my $ok = 0; # True if we got a good response.
3629: my $content;
3630: my $response;
3631:
3632: # Try to get the student_view done. within the retries count:
3633:
3634: do {
3635: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3636: $ok = $response->is_success;
3637: if (!$ok) {
3638: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3639: }
3640: $retries--;
3641: } while (!$ok && ($retries > 0));
3642:
3643: if (!$ok) {
3644: $content = ''; # On error return an empty content.
3645: }
1.651 www 3646: if (wantarray) {
3647: return ($content, $response);
3648: } else {
3649: return $content;
3650: }
1.11 albertel 3651: }
3652:
1.112 bowersj2 3653: =pod
3654:
1.648 raeburn 3655: =item * &get_student_answers()
1.112 bowersj2 3656:
3657: show a snapshot of how student was answering problem
3658:
3659: =cut
3660:
1.11 albertel 3661: sub get_student_answers {
1.100 sakharuk 3662: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3663: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3664: my (%moreenv);
1.11 albertel 3665: my @elements=('symb','courseid','domain','username');
3666: foreach my $element (@elements) {
1.186 albertel 3667: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3668: }
1.186 albertel 3669: $moreenv{'grade_target'}='answer';
3670: %moreenv=(%form,%moreenv);
1.497 raeburn 3671: $feedurl = &Apache::lonnet::clutter($feedurl);
3672: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3673: return $userview;
1.1 albertel 3674: }
1.116 albertel 3675:
3676: =pod
3677:
3678: =item * &submlink()
3679:
1.242 albertel 3680: Inputs: $text $uname $udom $symb $target
1.116 albertel 3681:
3682: Returns: A link to grades.pm such as to see the SUBM view of a student
3683:
3684: =cut
3685:
3686: ###############################################
3687: sub submlink {
1.242 albertel 3688: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3689: if (!($uname && $udom)) {
3690: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3691: &Apache::lonnet::whichuser($symb);
1.116 albertel 3692: if (!$symb) { $symb=$cursymb; }
3693: }
1.254 matthew 3694: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3695: $symb=&escape($symb);
1.960 bisitz 3696: if ($target) { $target=" target=\"$target\""; }
3697: return
3698: '<a href="/adm/grades?command=submission'.
3699: '&symb='.$symb.
3700: '&student='.$uname.
3701: '&userdom='.$udom.'"'.
3702: $target.'>'.$text.'</a>';
1.242 albertel 3703: }
3704: ##############################################
3705:
3706: =pod
3707:
3708: =item * &pgrdlink()
3709:
3710: Inputs: $text $uname $udom $symb $target
3711:
3712: Returns: A link to grades.pm such as to see the PGRD view of a student
3713:
3714: =cut
3715:
3716: ###############################################
3717: sub pgrdlink {
3718: my $link=&submlink(@_);
3719: $link=~s/(&command=submission)/$1&showgrading=yes/;
3720: return $link;
3721: }
3722: ##############################################
3723:
3724: =pod
3725:
3726: =item * &pprmlink()
3727:
3728: Inputs: $text $uname $udom $symb $target
3729:
3730: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3731: student and a specific resource
1.242 albertel 3732:
3733: =cut
3734:
3735: ###############################################
3736: sub pprmlink {
3737: my ($text,$uname,$udom,$symb,$target)=@_;
3738: if (!($uname && $udom)) {
3739: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3740: &Apache::lonnet::whichuser($symb);
1.242 albertel 3741: if (!$symb) { $symb=$cursymb; }
3742: }
1.254 matthew 3743: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3744: $symb=&escape($symb);
1.242 albertel 3745: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3746: return '<a href="/adm/parmset?command=set&'.
3747: 'symb='.$symb.'&uname='.$uname.
3748: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3749: }
3750: ##############################################
1.37 matthew 3751:
1.112 bowersj2 3752: =pod
3753:
3754: =back
3755:
3756: =cut
3757:
1.37 matthew 3758: ###############################################
1.51 www 3759:
3760:
3761: sub timehash {
1.687 raeburn 3762: my ($thistime) = @_;
3763: my $timezone = &Apache::lonlocal::gettimezone();
3764: my $dt = DateTime->from_epoch(epoch => $thistime)
3765: ->set_time_zone($timezone);
3766: my $wday = $dt->day_of_week();
3767: if ($wday == 7) { $wday = 0; }
3768: return ( 'second' => $dt->second(),
3769: 'minute' => $dt->minute(),
3770: 'hour' => $dt->hour(),
3771: 'day' => $dt->day_of_month(),
3772: 'month' => $dt->month(),
3773: 'year' => $dt->year(),
3774: 'weekday' => $wday,
3775: 'dayyear' => $dt->day_of_year(),
3776: 'dlsav' => $dt->is_dst() );
1.51 www 3777: }
3778:
1.370 www 3779: sub utc_string {
3780: my ($date)=@_;
1.371 www 3781: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3782: }
3783:
1.51 www 3784: sub maketime {
3785: my %th=@_;
1.687 raeburn 3786: my ($epoch_time,$timezone,$dt);
3787: $timezone = &Apache::lonlocal::gettimezone();
3788: eval {
3789: $dt = DateTime->new( year => $th{'year'},
3790: month => $th{'month'},
3791: day => $th{'day'},
3792: hour => $th{'hour'},
3793: minute => $th{'minute'},
3794: second => $th{'second'},
3795: time_zone => $timezone,
3796: );
3797: };
3798: if (!$@) {
3799: $epoch_time = $dt->epoch;
3800: if ($epoch_time) {
3801: return $epoch_time;
3802: }
3803: }
1.51 www 3804: return POSIX::mktime(
3805: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3806: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3807: }
3808:
3809: #########################################
1.51 www 3810:
3811: sub findallcourses {
1.482 raeburn 3812: my ($roles,$uname,$udom) = @_;
1.355 albertel 3813: my %roles;
3814: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3815: my %courses;
1.51 www 3816: my $now=time;
1.482 raeburn 3817: if (!defined($uname)) {
3818: $uname = $env{'user.name'};
3819: }
3820: if (!defined($udom)) {
3821: $udom = $env{'user.domain'};
3822: }
3823: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3824: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3825: if (!%roles) {
3826: %roles = (
3827: cc => 1,
1.907 raeburn 3828: co => 1,
1.482 raeburn 3829: in => 1,
3830: ep => 1,
3831: ta => 1,
3832: cr => 1,
3833: st => 1,
3834: );
3835: }
3836: foreach my $entry (keys(%roleshash)) {
3837: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3838: if ($trole =~ /^cr/) {
3839: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3840: } else {
3841: next if (!exists($roles{$trole}));
3842: }
3843: if ($tend) {
3844: next if ($tend < $now);
3845: }
3846: if ($tstart) {
3847: next if ($tstart > $now);
3848: }
3849: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3850: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3851: if ($secpart eq '') {
3852: ($cnum,$role) = split(/_/,$cnumpart);
3853: $sec = 'none';
3854: $realsec = '';
3855: } else {
3856: $cnum = $cnumpart;
3857: ($sec,$role) = split(/_/,$secpart);
3858: $realsec = $sec;
1.490 raeburn 3859: }
1.482 raeburn 3860: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3861: }
3862: } else {
3863: foreach my $key (keys(%env)) {
1.483 albertel 3864: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3865: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3866: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3867: next if ($role eq 'ca' || $role eq 'aa');
3868: next if (%roles && !exists($roles{$role}));
3869: my ($starttime,$endtime)=split(/\./,$env{$key});
3870: my $active=1;
3871: if ($starttime) {
3872: if ($now<$starttime) { $active=0; }
3873: }
3874: if ($endtime) {
3875: if ($now>$endtime) { $active=0; }
3876: }
3877: if ($active) {
3878: if ($sec eq '') {
3879: $sec = 'none';
3880: }
3881: $courses{$cdom.'_'.$cnum}{$sec} =
3882: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3883: }
3884: }
1.51 www 3885: }
3886: }
1.474 raeburn 3887: return %courses;
1.51 www 3888: }
1.37 matthew 3889:
1.54 www 3890: ###############################################
1.474 raeburn 3891:
3892: sub blockcheck {
1.482 raeburn 3893: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3894:
3895: if (!defined($udom)) {
3896: $udom = $env{'user.domain'};
3897: }
3898: if (!defined($uname)) {
3899: $uname = $env{'user.name'};
3900: }
3901:
3902: # If uname and udom are for a course, check for blocks in the course.
3903:
3904: if (&Apache::lonnet::is_course($udom,$uname)) {
3905: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3906: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3907: return ($startblock,$endblock);
3908: }
1.474 raeburn 3909:
1.502 raeburn 3910: my $startblock = 0;
3911: my $endblock = 0;
1.482 raeburn 3912: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3913:
1.490 raeburn 3914: # If uname is for a user, and activity is course-specific, i.e.,
3915: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3916:
1.490 raeburn 3917: if (($activity eq 'boards' || $activity eq 'chat' ||
3918: $activity eq 'groups') && ($env{'request.course.id'})) {
3919: foreach my $key (keys(%live_courses)) {
3920: if ($key ne $env{'request.course.id'}) {
3921: delete($live_courses{$key});
3922: }
3923: }
3924: }
3925:
3926: my $otheruser = 0;
3927: my %own_courses;
3928: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3929: # Resource belongs to user other than current user.
3930: $otheruser = 1;
3931: # Gather courses for current user
3932: %own_courses =
3933: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3934: }
3935:
3936: # Gather active course roles - course coordinator, instructor,
3937: # exam proctor, ta, student, or custom role.
1.474 raeburn 3938:
3939: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3940: my ($cdom,$cnum);
3941: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3942: $cdom = $env{'course.'.$course.'.domain'};
3943: $cnum = $env{'course.'.$course.'.num'};
3944: } else {
1.490 raeburn 3945: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3946: }
3947: my $no_ownblock = 0;
3948: my $no_userblock = 0;
1.533 raeburn 3949: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3950: # Check if current user has 'evb' priv for this
3951: if (defined($own_courses{$course})) {
3952: foreach my $sec (keys(%{$own_courses{$course}})) {
3953: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3954: if ($sec ne 'none') {
3955: $checkrole .= '/'.$sec;
3956: }
3957: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3958: $no_ownblock = 1;
3959: last;
3960: }
3961: }
3962: }
3963: # if they have 'evb' priv and are currently not playing student
3964: next if (($no_ownblock) &&
3965: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3966: }
1.474 raeburn 3967: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3968: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3969: if ($sec ne 'none') {
1.482 raeburn 3970: $checkrole .= '/'.$sec;
1.474 raeburn 3971: }
1.490 raeburn 3972: if ($otheruser) {
3973: # Resource belongs to user other than current user.
3974: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3975: my ($trole,$tdom,$tnum,$tsec);
3976: my $entry = $live_courses{$course}{$sec};
3977: if ($entry =~ /^cr/) {
3978: ($trole,$tdom,$tnum,$tsec) =
3979: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3980: } else {
3981: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3982: }
3983: my ($spec,$area,$trest,%allroles,%userroles);
3984: $area = '/'.$tdom.'/'.$tnum;
3985: $trest = $tnum;
3986: if ($tsec ne '') {
3987: $area .= '/'.$tsec;
3988: $trest .= '/'.$tsec;
3989: }
3990: $spec = $trole.'.'.$area;
3991: if ($trole =~ /^cr/) {
3992: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3993: $tdom,$spec,$trest,$area);
3994: } else {
3995: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3996: $tdom,$spec,$trest,$area);
3997: }
3998: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3999: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4000: if ($1) {
4001: $no_userblock = 1;
4002: last;
4003: }
4004: }
1.490 raeburn 4005: } else {
4006: # Resource belongs to current user
4007: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4008: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4009: $no_ownblock = 1;
4010: last;
4011: }
1.474 raeburn 4012: }
4013: }
4014: # if they have the evb priv and are currently not playing student
1.482 raeburn 4015: next if (($no_ownblock) &&
1.491 albertel 4016: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4017: next if ($no_userblock);
1.474 raeburn 4018:
1.866 kalberla 4019: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4020: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4021:
4022: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4023: if (($start != 0) &&
4024: (($startblock == 0) || ($startblock > $start))) {
4025: $startblock = $start;
4026: }
4027: if (($end != 0) &&
4028: (($endblock == 0) || ($endblock < $end))) {
4029: $endblock = $end;
4030: }
1.490 raeburn 4031: }
4032: return ($startblock,$endblock);
4033: }
4034:
4035: sub get_blocks {
4036: my ($setters,$activity,$cdom,$cnum) = @_;
4037: my $startblock = 0;
4038: my $endblock = 0;
4039: my $course = $cdom.'_'.$cnum;
4040: $setters->{$course} = {};
4041: $setters->{$course}{'staff'} = [];
4042: $setters->{$course}{'times'} = [];
4043: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4044: foreach my $record (keys(%records)) {
4045: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4046: if ($start <= time && $end >= time) {
4047: my ($staff_name,$staff_dom,$title,$blocks) =
4048: &parse_block_record($records{$record});
4049: if ($blocks->{$activity} eq 'on') {
4050: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4051: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4052: if ( ($startblock == 0) || ($startblock > $start) ) {
4053: $startblock = $start;
1.490 raeburn 4054: }
1.491 albertel 4055: if ( ($endblock == 0) || ($endblock < $end) ) {
4056: $endblock = $end;
1.474 raeburn 4057: }
4058: }
4059: }
4060: }
4061: return ($startblock,$endblock);
4062: }
4063:
4064: sub parse_block_record {
4065: my ($record) = @_;
4066: my ($setuname,$setudom,$title,$blocks);
4067: if (ref($record) eq 'HASH') {
4068: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4069: $title = &unescape($record->{'event'});
4070: $blocks = $record->{'blocks'};
4071: } else {
4072: my @data = split(/:/,$record,3);
4073: if (scalar(@data) eq 2) {
4074: $title = $data[1];
4075: ($setuname,$setudom) = split(/@/,$data[0]);
4076: } else {
4077: ($setuname,$setudom,$title) = @data;
4078: }
4079: $blocks = { 'com' => 'on' };
4080: }
4081: return ($setuname,$setudom,$title,$blocks);
4082: }
4083:
1.854 kalberla 4084: sub blocking_status {
4085: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4086: my %setters;
1.890 droeschl 4087:
4088: # check for active blocking
1.867 kalberla 4089: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4090:
1.890 droeschl 4091: my $blocked = $startblock && $endblock ? 1 : 0;
4092:
4093: # caller just wants to know whether a block is active
4094: if (!wantarray) { return $blocked; }
4095:
4096: # build a link to a popup window containing the details
4097: my $querystring = "?activity=$activity";
4098: # $uname and $udom decide whose portfolio the user is trying to look at
4099: $querystring .= "&udom=$udom" if $udom;
4100: $querystring .= "&uname=$uname" if $uname;
4101:
4102: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4103: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4104: var options = "width=" + w + ",height=" + h + ",";
4105: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4106: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4107: var newWin = window.open(url, wdwName, options);
4108: newWin.focus();
4109: }
1.890 droeschl 4110: END_MYBLOCK
1.854 kalberla 4111:
1.890 droeschl 4112: $output = Apache::lonhtmlcommon::scripttag($output);
4113:
1.854 kalberla 4114: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4115: my $text = mt('Communication Blocked');
4116:
1.867 kalberla 4117: $output .= <<"END_BLOCK";
4118: <div class='LC_comblock'>
1.869 kalberla 4119: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4120: title='$text'>
4121: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4122: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4123: title='$text'>$text</a>
1.867 kalberla 4124: </div>
4125:
4126: END_BLOCK
1.474 raeburn 4127:
1.854 kalberla 4128: return ($blocked, $output);
4129: }
1.490 raeburn 4130:
1.60 matthew 4131: ###############################################
4132:
1.682 raeburn 4133: sub check_ip_acc {
4134: my ($acc)=@_;
4135: &Apache::lonxml::debug("acc is $acc");
4136: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4137: return 1;
4138: }
4139: my $allowed=0;
4140: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4141:
4142: my $name;
4143: foreach my $pattern (split(',',$acc)) {
4144: $pattern =~ s/^\s*//;
4145: $pattern =~ s/\s*$//;
4146: if ($pattern =~ /\*$/) {
4147: #35.8.*
4148: $pattern=~s/\*//;
4149: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4150: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4151: #35.8.3.[34-56]
4152: my $low=$2;
4153: my $high=$3;
4154: $pattern=$1;
4155: if ($ip =~ /^\Q$pattern\E/) {
4156: my $last=(split(/\./,$ip))[3];
4157: if ($last <=$high && $last >=$low) { $allowed=1; }
4158: }
4159: } elsif ($pattern =~ /^\*/) {
4160: #*.msu.edu
4161: $pattern=~s/\*//;
4162: if (!defined($name)) {
4163: use Socket;
4164: my $netaddr=inet_aton($ip);
4165: ($name)=gethostbyaddr($netaddr,AF_INET);
4166: }
4167: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4168: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4169: #127.0.0.1
4170: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4171: } else {
4172: #some.name.com
4173: if (!defined($name)) {
4174: use Socket;
4175: my $netaddr=inet_aton($ip);
4176: ($name)=gethostbyaddr($netaddr,AF_INET);
4177: }
4178: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4179: }
4180: if ($allowed) { last; }
4181: }
4182: return $allowed;
4183: }
4184:
4185: ###############################################
4186:
1.60 matthew 4187: =pod
4188:
1.112 bowersj2 4189: =head1 Domain Template Functions
4190:
4191: =over 4
4192:
4193: =item * &determinedomain()
1.60 matthew 4194:
4195: Inputs: $domain (usually will be undef)
4196:
1.63 www 4197: Returns: Determines which domain should be used for designs
1.60 matthew 4198:
4199: =cut
1.54 www 4200:
1.60 matthew 4201: ###############################################
1.63 www 4202: sub determinedomain {
4203: my $domain=shift;
1.531 albertel 4204: if (! $domain) {
1.60 matthew 4205: # Determine domain if we have not been given one
1.893 raeburn 4206: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4207: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4208: if ($env{'request.role.domain'}) {
4209: $domain=$env{'request.role.domain'};
1.60 matthew 4210: }
4211: }
1.63 www 4212: return $domain;
4213: }
4214: ###############################################
1.517 raeburn 4215:
1.518 albertel 4216: sub devalidate_domconfig_cache {
4217: my ($udom)=@_;
4218: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4219: }
4220:
4221: # ---------------------- Get domain configuration for a domain
4222: sub get_domainconf {
4223: my ($udom) = @_;
4224: my $cachetime=1800;
4225: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4226: if (defined($cached)) { return %{$result}; }
4227:
4228: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 4229: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 4230: my (%designhash,%legacy);
1.518 albertel 4231: if (keys(%domconfig) > 0) {
4232: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4233: if (keys(%{$domconfig{'login'}})) {
4234: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4235: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946 raeburn 4236: if ($key eq 'loginvia') {
4237: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
4238: my @ids = &Apache::lonnet::current_machine_ids();
4239: foreach my $hostname (@ids) {
1.948 raeburn 4240: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
4241: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
4242: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
4243: $designhash{$udom.'.login.loginvia'} = $server;
4244: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
4245:
4246: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
4247: } else {
4248: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
4249: }
4250: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
4251: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
4252: }
1.946 raeburn 4253: }
4254: }
4255: }
4256: }
4257: } else {
4258: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4259: $designhash{$udom.'.login.'.$key.'_'.$img} =
4260: $domconfig{'login'}{$key}{$img};
4261: }
1.699 raeburn 4262: }
4263: } else {
4264: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4265: }
1.632 raeburn 4266: }
4267: } else {
4268: $legacy{'login'} = 1;
1.518 albertel 4269: }
1.632 raeburn 4270: } else {
4271: $legacy{'login'} = 1;
1.518 albertel 4272: }
4273: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4274: if (keys(%{$domconfig{'rolecolors'}})) {
4275: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4276: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4277: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4278: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4279: }
1.518 albertel 4280: }
4281: }
1.632 raeburn 4282: } else {
4283: $legacy{'rolecolors'} = 1;
1.518 albertel 4284: }
1.632 raeburn 4285: } else {
4286: $legacy{'rolecolors'} = 1;
1.518 albertel 4287: }
1.948 raeburn 4288: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4289: if ($domconfig{'autoenroll'}{'co-owners'}) {
4290: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
4291: }
4292: }
1.632 raeburn 4293: if (keys(%legacy) > 0) {
4294: my %legacyhash = &get_legacy_domconf($udom);
4295: foreach my $item (keys(%legacyhash)) {
4296: if ($item =~ /^\Q$udom\E\.login/) {
4297: if ($legacy{'login'}) {
4298: $designhash{$item} = $legacyhash{$item};
4299: }
4300: } else {
4301: if ($legacy{'rolecolors'}) {
4302: $designhash{$item} = $legacyhash{$item};
4303: }
1.518 albertel 4304: }
4305: }
4306: }
1.632 raeburn 4307: } else {
4308: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4309: }
4310: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4311: $cachetime);
4312: return %designhash;
4313: }
4314:
1.632 raeburn 4315: sub get_legacy_domconf {
4316: my ($udom) = @_;
4317: my %legacyhash;
4318: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4319: my $designfile = $designdir.'/'.$udom.'.tab';
4320: if (-e $designfile) {
4321: if ( open (my $fh,"<$designfile") ) {
4322: while (my $line = <$fh>) {
4323: next if ($line =~ /^\#/);
4324: chomp($line);
4325: my ($key,$val)=(split(/\=/,$line));
4326: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4327: }
4328: close($fh);
4329: }
4330: }
4331: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4332: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4333: }
4334: return %legacyhash;
4335: }
4336:
1.63 www 4337: =pod
4338:
1.112 bowersj2 4339: =item * &domainlogo()
1.63 www 4340:
4341: Inputs: $domain (usually will be undef)
4342:
4343: Returns: A link to a domain logo, if the domain logo exists.
4344: If the domain logo does not exist, a description of the domain.
4345:
4346: =cut
1.112 bowersj2 4347:
1.63 www 4348: ###############################################
4349: sub domainlogo {
1.517 raeburn 4350: my $domain = &determinedomain(shift);
1.518 albertel 4351: my %designhash = &get_domainconf($domain);
1.517 raeburn 4352: # See if there is a logo
4353: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4354: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4355: if ($imgsrc =~ m{^/(adm|res)/}) {
4356: if ($imgsrc =~ m{^/res/}) {
4357: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4358: &Apache::lonnet::repcopy($local_name);
4359: }
4360: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4361: }
4362: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4363: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4364: return &Apache::lonnet::domain($domain,'description');
1.59 www 4365: } else {
1.60 matthew 4366: return '';
1.59 www 4367: }
4368: }
1.63 www 4369: ##############################################
4370:
4371: =pod
4372:
1.112 bowersj2 4373: =item * &designparm()
1.63 www 4374:
4375: Inputs: $which parameter; $domain (usually will be undef)
4376:
4377: Returns: value of designparamter $which
4378:
4379: =cut
1.112 bowersj2 4380:
1.397 albertel 4381:
1.400 albertel 4382: ##############################################
1.397 albertel 4383: sub designparm {
4384: my ($which,$domain)=@_;
4385: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4386: return $env{'environment.color.'.$which};
1.96 www 4387: }
1.63 www 4388: $domain=&determinedomain($domain);
1.518 albertel 4389: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4390: my $output;
1.517 raeburn 4391: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4392: $output = $domdesign{$domain.'.'.$which};
1.63 www 4393: } else {
1.520 raeburn 4394: $output = $defaultdesign{$which};
4395: }
4396: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4397: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4398: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4399: if ($output =~ m{^/res/}) {
4400: my $local_name = &Apache::lonnet::filelocation('',$output);
4401: &Apache::lonnet::repcopy($local_name);
4402: }
1.520 raeburn 4403: $output = &lonhttpdurl($output);
4404: }
1.63 www 4405: }
1.520 raeburn 4406: return $output;
1.63 www 4407: }
1.59 www 4408:
1.822 bisitz 4409: ##############################################
4410: =pod
4411:
1.832 bisitz 4412: =item * &authorspace()
4413:
4414: Inputs: ./.
4415:
4416: Returns: Path to the Construction Space of the current user's
4417: accessed author space
4418: The author space will be that of the current user
4419: when accessing the own author space
4420: and that of the co-author/assistent co-author
4421: when accessing the co-author's/assistent co-author's
4422: space
4423:
4424: =cut
4425:
4426: sub authorspace {
4427: my $caname = '';
4428: if ($env{'request.role'} =~ /^ca|^aa/) {
4429: (undef,$caname) =
4430: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4431: } else {
4432: $caname = $env{'user.name'};
4433: }
4434: return '/priv/'.$caname.'/';
4435: }
4436:
4437: ##############################################
4438: =pod
4439:
1.822 bisitz 4440: =item * &head_subbox()
4441:
4442: Inputs: $content (contains HTML code with page functions, etc.)
4443:
4444: Returns: HTML div with $content
4445: To be included in page header
4446:
4447: =cut
4448:
4449: sub head_subbox {
4450: my ($content)=@_;
4451: my $output =
1.844 bisitz 4452: '<div id="LC_head_subbox">'
1.822 bisitz 4453: .$content
4454: .'</div>'
4455: }
4456:
4457: ##############################################
4458: =pod
4459:
4460: =item * &CSTR_pageheader()
4461:
4462: Inputs: ./.
4463:
4464: Returns: HTML div with CSTR path and recent box
4465: To be included on Construction Space pages
4466:
4467: =cut
4468:
4469: sub CSTR_pageheader {
4470: # this is for resources; directories have customtitle, and crumbs
4471: # and select recent are created in lonpubdir.pm
4472: my ($uname,$thisdisfn)=
4473: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4474: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4475: $formaction=~s/\/+/\//g;
4476:
4477: my $parentpath = '';
4478: my $lastitem = '';
4479: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4480: $parentpath = $1;
4481: $lastitem = $2;
4482: } else {
4483: $lastitem = $thisdisfn;
4484: }
1.921 bisitz 4485:
4486: my $output =
1.822 bisitz 4487: '<div>'
4488: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4489: .'<b>'.&mt('Construction Space:').'</b> '
4490: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4491: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4492: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4493:
4494: if ($lastitem) {
4495: $output .=
4496: '<span class="LC_filename">'
4497: .$lastitem
4498: .'</span>';
4499: }
4500: $output .=
4501: '<br />'
1.822 bisitz 4502: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4503: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4504: .'</form>'
4505: .&Apache::lonmenu::constspaceform()
4506: .'</div>';
1.921 bisitz 4507:
4508: return $output;
1.822 bisitz 4509: }
4510:
1.60 matthew 4511: ###############################################
4512: ###############################################
4513:
4514: =pod
4515:
1.112 bowersj2 4516: =back
4517:
1.549 albertel 4518: =head1 HTML Helpers
1.112 bowersj2 4519:
4520: =over 4
4521:
4522: =item * &bodytag()
1.60 matthew 4523:
4524: Returns a uniform header for LON-CAPA web pages.
4525:
4526: Inputs:
4527:
1.112 bowersj2 4528: =over 4
4529:
4530: =item * $title, A title to be displayed on the page.
4531:
4532: =item * $function, the current role (can be undef).
4533:
4534: =item * $addentries, extra parameters for the <body> tag.
4535:
4536: =item * $bodyonly, if defined, only return the <body> tag.
4537:
4538: =item * $domain, if defined, force a given domain.
4539:
4540: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4541: text interface only)
1.60 matthew 4542:
1.814 bisitz 4543: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4544: navigational links
1.317 albertel 4545:
1.338 albertel 4546: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4547:
1.460 albertel 4548: =item * $args, optional argument valid values are
4549: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4550: inherit_jsmath -> when creating popup window in a page,
4551: should it have jsmath forced on by the
4552: current page
1.460 albertel 4553:
1.112 bowersj2 4554: =back
4555:
1.60 matthew 4556: Returns: A uniform header for LON-CAPA web pages.
4557: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4558: If $bodyonly is undef or zero, an html string containing a <body> tag and
4559: other decorations will be returned.
4560:
4561: =cut
4562:
1.54 www 4563: sub bodytag {
1.831 bisitz 4564: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962 droeschl 4565: $no_nav_bar,$bgcolor,$args)=@_;
1.339 albertel 4566:
1.954 raeburn 4567: my $public;
4568: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
4569: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
4570: $public = 1;
4571: }
1.460 albertel 4572: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4573:
1.183 matthew 4574: $function = &get_users_function() if (!$function);
1.339 albertel 4575: my $img = &designparm($function.'.img',$domain);
4576: my $font = &designparm($function.'.font',$domain);
4577: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4578:
1.803 bisitz 4579: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4580: 'bgcolor' => $pgbg,
1.339 albertel 4581: 'text' => $font,
4582: 'alink' => &designparm($function.'.alink',$domain),
4583: 'vlink' => &designparm($function.'.vlink',$domain),
4584: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4585: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4586:
1.63 www 4587: # role and realm
1.378 raeburn 4588: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4589: if ($role eq 'ca') {
1.479 albertel 4590: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4591: $realm = &plainname($rname,$rdom);
1.378 raeburn 4592: }
1.55 www 4593: # realm
1.258 albertel 4594: if ($env{'request.course.id'}) {
1.378 raeburn 4595: if ($env{'request.role'} !~ /^cr/) {
4596: $role = &Apache::lonnet::plaintext($role,&course_type());
4597: }
1.898 raeburn 4598: if ($env{'request.course.sec'}) {
4599: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4600: }
1.359 albertel 4601: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4602: } else {
4603: $role = &Apache::lonnet::plaintext($role);
1.54 www 4604: }
1.433 albertel 4605:
1.359 albertel 4606: if (!$realm) { $realm=' '; }
1.330 albertel 4607:
1.438 albertel 4608: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4609:
1.101 www 4610: # construct main body tag
1.359 albertel 4611: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4612: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4613:
1.530 albertel 4614: if ($bodyonly) {
1.60 matthew 4615: return $bodytag;
1.798 tempelho 4616: }
1.359 albertel 4617:
1.410 albertel 4618: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954 raeburn 4619: if ($public) {
1.433 albertel 4620: undef($role);
1.434 albertel 4621: } else {
4622: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4623: }
1.359 albertel 4624:
1.762 bisitz 4625: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4626: #
4627: # Extra info if you are the DC
4628: my $dc_info = '';
4629: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4630: $env{'course.'.$env{'request.course.id'}.
4631: '.domain'}.'/'})) {
4632: my $cid = $env{'request.course.id'};
1.917 raeburn 4633: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4634: $dc_info =~ s/\s+$//;
1.359 albertel 4635: }
4636:
1.898 raeburn 4637: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4638: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4639:
1.916 droeschl 4640: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4641: return $bodytag;
4642: }
1.903 droeschl 4643:
4644: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4645:
4646: # if ($env{'request.state'} eq 'construct') {
4647: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4648: # }
4649:
1.359 albertel 4650:
4651:
1.916 droeschl 4652: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4653: if ($dc_info) {
4654: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4655: }
1.916 droeschl 4656: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4657: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4658: return $bodytag;
4659: }
1.894 droeschl 4660:
1.927 raeburn 4661: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4662: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4663: }
1.916 droeschl 4664:
1.903 droeschl 4665: $bodytag .= Apache::lonhtmlcommon::scripttag(
4666: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4667:
1.903 droeschl 4668: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4669:
1.917 raeburn 4670: if ($dc_info) {
4671: $dc_info = &dc_courseid_toggle($dc_info);
4672: }
4673: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4674:
1.903 droeschl 4675: #don't show menus for public users
1.954 raeburn 4676: if (!$public){
1.903 droeschl 4677: $bodytag .= Apache::lonmenu::secondary_menu();
4678: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4679: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4680: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 4681: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920 raeburn 4682: $args->{'bread_crumbs'});
4683: } elsif ($forcereg) {
4684: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4685: }
1.903 droeschl 4686: }else{
4687: # this is to seperate menu from content when there's no secondary
4688: # menu. Especially needed for public accessible ressources.
4689: $bodytag .= '<hr style="clear:both" />';
4690: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4691: }
1.903 droeschl 4692:
1.235 raeburn 4693: return $bodytag;
1.182 matthew 4694: }
4695:
1.917 raeburn 4696: sub dc_courseid_toggle {
4697: my ($dc_info) = @_;
4698: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4699: '<a href="javascript:showCourseID();">'.
4700: &mt('(More ...)').'</a></span>'.
4701: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4702: }
4703:
1.330 albertel 4704: sub make_attr_string {
4705: my ($register,$attr_ref) = @_;
4706:
4707: if ($attr_ref && !ref($attr_ref)) {
4708: die("addentries Must be a hash ref ".
4709: join(':',caller(1))." ".
4710: join(':',caller(0))." ");
4711: }
4712:
4713: if ($register) {
1.339 albertel 4714: my ($on_load,$on_unload);
4715: foreach my $key (keys(%{$attr_ref})) {
4716: if (lc($key) eq 'onload') {
4717: $on_load.=$attr_ref->{$key}.';';
4718: delete($attr_ref->{$key});
4719:
4720: } elsif (lc($key) eq 'onunload') {
4721: $on_unload.=$attr_ref->{$key}.';';
4722: delete($attr_ref->{$key});
4723: }
4724: }
1.953 droeschl 4725: $attr_ref->{'onload'} = $on_load;
4726: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 4727: }
1.339 albertel 4728:
1.330 albertel 4729: my $attr_string;
4730: foreach my $attr (keys(%$attr_ref)) {
4731: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4732: }
4733: return $attr_string;
4734: }
4735:
4736:
1.182 matthew 4737: ###############################################
1.251 albertel 4738: ###############################################
4739:
4740: =pod
4741:
4742: =item * &endbodytag()
4743:
4744: Returns a uniform footer for LON-CAPA web pages.
4745:
1.635 raeburn 4746: Inputs: 1 - optional reference to an args hash
4747: If in the hash, key for noredirectlink has a value which evaluates to true,
4748: a 'Continue' link is not displayed if the page contains an
4749: internal redirect in the <head></head> section,
4750: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4751:
4752: =cut
4753:
4754: sub endbodytag {
1.635 raeburn 4755: my ($args) = @_;
1.251 albertel 4756: my $endbodytag='</body>';
1.269 albertel 4757: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4758: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4759: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4760: $endbodytag=
4761: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4762: &mt('Continue').'</a>'.
4763: $endbodytag;
4764: }
1.315 albertel 4765: }
1.251 albertel 4766: return $endbodytag;
4767: }
4768:
1.352 albertel 4769: =pod
4770:
4771: =item * &standard_css()
4772:
4773: Returns a style sheet
4774:
4775: Inputs: (all optional)
4776: domain -> force to color decorate a page for a specific
4777: domain
4778: function -> force usage of a specific rolish color scheme
4779: bgcolor -> override the default page bgcolor
4780:
4781: =cut
4782:
1.343 albertel 4783: sub standard_css {
1.345 albertel 4784: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4785: $function = &get_users_function() if (!$function);
4786: my $img = &designparm($function.'.img', $domain);
4787: my $tabbg = &designparm($function.'.tabbg', $domain);
4788: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4789: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4790: #second colour for later usage
1.345 albertel 4791: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4792: my $pgbg_or_bgcolor =
4793: $bgcolor ||
1.352 albertel 4794: &designparm($function.'.pgbg', $domain);
1.382 albertel 4795: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4796: my $alink = &designparm($function.'.alink', $domain);
4797: my $vlink = &designparm($function.'.vlink', $domain);
4798: my $link = &designparm($function.'.link', $domain);
4799:
1.602 albertel 4800: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4801: my $mono = 'monospace';
1.850 bisitz 4802: my $data_table_head = $sidebg;
4803: my $data_table_light = '#FAFAFA';
4804: my $data_table_dark = '#F0F0F0';
1.470 banghart 4805: my $data_table_darker = '#CCCCCC';
1.349 albertel 4806: my $data_table_highlight = '#FFFF00';
1.352 albertel 4807: my $mail_new = '#FFBB77';
4808: my $mail_new_hover = '#DD9955';
4809: my $mail_read = '#BBBB77';
4810: my $mail_read_hover = '#999944';
4811: my $mail_replied = '#AAAA88';
4812: my $mail_replied_hover = '#888855';
4813: my $mail_other = '#99BBBB';
4814: my $mail_other_hover = '#669999';
1.391 albertel 4815: my $table_header = '#DDDDDD';
1.489 raeburn 4816: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4817: my $lg_border_color = '#C8C8C8';
1.952 onken 4818: my $button_hover = '#BF2317';
1.392 albertel 4819:
1.608 albertel 4820: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4821: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4822: : '0 3px 0 4px';
1.448 albertel 4823:
1.523 albertel 4824:
1.343 albertel 4825: return <<END;
1.947 droeschl 4826:
4827: /* needed for iframe to allow 100% height in FF */
4828: body, html {
4829: margin: 0;
4830: padding: 0 0.5%;
4831: height: 99%; /* to avoid scrollbars */
4832: }
4833:
1.795 www 4834: body {
1.911 bisitz 4835: font-family: $sans;
4836: line-height:130%;
4837: font-size:0.83em;
4838: color:$font;
1.795 www 4839: }
4840:
1.959 onken 4841: a:focus,
4842: a:focus img {
1.795 www 4843: color: red;
1.911 bisitz 4844: background: yellow;
1.795 www 4845: }
1.698 harmsja 4846:
1.911 bisitz 4847: form, .inline {
4848: display: inline;
1.795 www 4849: }
1.721 harmsja 4850:
1.795 www 4851: .LC_right {
1.911 bisitz 4852: text-align:right;
1.795 www 4853: }
4854:
4855: .LC_middle {
1.911 bisitz 4856: vertical-align:middle;
1.795 www 4857: }
1.721 harmsja 4858:
1.911 bisitz 4859: .LC_400Box {
4860: width:400px;
4861: }
1.721 harmsja 4862:
1.947 droeschl 4863: .LC_iframecontainer {
4864: width: 98%;
4865: margin: 0;
4866: position: fixed;
4867: top: 8.5em;
4868: bottom: 0;
4869: }
4870:
4871: .LC_iframecontainer iframe{
4872: border: none;
4873: width: 100%;
4874: height: 100%;
4875: }
4876:
1.778 bisitz 4877: .LC_filename {
4878: font-family: $mono;
4879: white-space:pre;
1.921 bisitz 4880: font-size: 120%;
1.778 bisitz 4881: }
4882:
4883: .LC_fileicon {
4884: border: none;
4885: height: 1.3em;
4886: vertical-align: text-bottom;
4887: margin-right: 0.3em;
4888: text-decoration:none;
4889: }
4890:
1.350 albertel 4891: .LC_error {
4892: color: red;
4893: font-size: larger;
4894: }
1.795 www 4895:
1.457 albertel 4896: .LC_warning,
4897: .LC_diff_removed {
1.733 bisitz 4898: color: red;
1.394 albertel 4899: }
1.532 albertel 4900:
4901: .LC_info,
1.457 albertel 4902: .LC_success,
4903: .LC_diff_added {
1.350 albertel 4904: color: green;
4905: }
1.795 www 4906:
1.802 bisitz 4907: div.LC_confirm_box {
4908: background-color: #FAFAFA;
4909: border: 1px solid $lg_border_color;
4910: margin-right: 0;
4911: padding: 5px;
4912: }
4913:
4914: div.LC_confirm_box .LC_error img,
4915: div.LC_confirm_box .LC_success img {
4916: vertical-align: middle;
4917: }
4918:
1.440 albertel 4919: .LC_icon {
1.771 droeschl 4920: border: none;
1.790 droeschl 4921: vertical-align: middle;
1.771 droeschl 4922: }
4923:
1.543 albertel 4924: .LC_docs_spacer {
4925: width: 25px;
4926: height: 1px;
1.771 droeschl 4927: border: none;
1.543 albertel 4928: }
1.346 albertel 4929:
1.532 albertel 4930: .LC_internal_info {
1.735 bisitz 4931: color: #999999;
1.532 albertel 4932: }
4933:
1.794 www 4934: .LC_discussion {
1.911 bisitz 4935: background: $tabbg;
4936: border: 1px solid black;
4937: margin: 2px;
1.794 www 4938: }
4939:
4940: .LC_disc_action_links_bar {
1.911 bisitz 4941: background: $tabbg;
4942: border: none;
4943: margin: 4px;
1.794 www 4944: }
4945:
4946: .LC_disc_action_left {
1.911 bisitz 4947: text-align: left;
1.794 www 4948: }
4949:
4950: .LC_disc_action_right {
1.911 bisitz 4951: text-align: right;
1.794 www 4952: }
4953:
4954: .LC_disc_new_item {
1.911 bisitz 4955: background: white;
4956: border: 2px solid red;
4957: margin: 2px;
1.794 www 4958: }
4959:
4960: .LC_disc_old_item {
1.911 bisitz 4961: background: white;
4962: border: 1px solid black;
4963: margin: 2px;
1.794 www 4964: }
4965:
1.458 albertel 4966: table.LC_pastsubmission {
4967: border: 1px solid black;
4968: margin: 2px;
4969: }
4970:
1.924 bisitz 4971: table#LC_menubuttons {
1.345 albertel 4972: width: 100%;
4973: background: $pgbg;
1.392 albertel 4974: border: 2px;
1.402 albertel 4975: border-collapse: separate;
1.803 bisitz 4976: padding: 0;
1.345 albertel 4977: }
1.392 albertel 4978:
1.801 tempelho 4979: table#LC_title_bar a {
4980: color: $fontmenu;
4981: }
1.836 bisitz 4982:
1.807 droeschl 4983: table#LC_title_bar {
1.819 tempelho 4984: clear: both;
1.836 bisitz 4985: display: none;
1.807 droeschl 4986: }
4987:
1.795 www 4988: table#LC_title_bar,
1.933 droeschl 4989: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4990: table#LC_title_bar.LC_with_remote {
1.359 albertel 4991: width: 100%;
1.392 albertel 4992: border-color: $pgbg;
4993: border-style: solid;
4994: border-width: $border;
1.379 albertel 4995: background: $pgbg;
1.801 tempelho 4996: color: $fontmenu;
1.392 albertel 4997: border-collapse: collapse;
1.803 bisitz 4998: padding: 0;
1.819 tempelho 4999: margin: 0;
1.359 albertel 5000: }
1.795 www 5001:
1.933 droeschl 5002: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5003: margin: 0;
5004: padding: 0;
1.933 droeschl 5005: position: relative;
5006: list-style: none;
1.913 droeschl 5007: }
1.933 droeschl 5008: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5009: display: inline;
5010: }
1.933 droeschl 5011:
5012: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5013: padding: 0;
1.933 droeschl 5014: margin: 0;
5015: float: left;
1.913 droeschl 5016: }
1.933 droeschl 5017: .LC_breadcrumb_tools_tools {
5018: padding: 0;
5019: margin: 0;
1.913 droeschl 5020: float: right;
5021: }
5022:
1.359 albertel 5023: table#LC_title_bar td {
5024: background: $tabbg;
5025: }
1.795 www 5026:
1.911 bisitz 5027: table#LC_menubuttons img {
1.803 bisitz 5028: border: none;
1.346 albertel 5029: }
1.795 www 5030:
1.842 droeschl 5031: .LC_breadcrumbs_component {
1.911 bisitz 5032: float: right;
5033: margin: 0 1em;
1.357 albertel 5034: }
1.842 droeschl 5035: .LC_breadcrumbs_component img {
1.911 bisitz 5036: vertical-align: middle;
1.777 tempelho 5037: }
1.795 www 5038:
1.383 albertel 5039: td.LC_table_cell_checkbox {
5040: text-align: center;
5041: }
1.795 www 5042:
5043: .LC_fontsize_small {
1.911 bisitz 5044: font-size: 70%;
1.705 tempelho 5045: }
5046:
1.844 bisitz 5047: #LC_breadcrumbs {
1.911 bisitz 5048: clear:both;
5049: background: $sidebg;
5050: border-bottom: 1px solid $lg_border_color;
5051: line-height: 2.5em;
1.933 droeschl 5052: overflow: hidden;
1.911 bisitz 5053: margin: 0;
5054: padding: 0;
1.819 tempelho 5055: }
1.862 bisitz 5056:
1.844 bisitz 5057: #LC_head_subbox {
1.911 bisitz 5058: clear:both;
5059: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5060: border: 1px solid $sidebg;
5061: margin: 0 0 10px 0;
1.966 bisitz 5062: padding: 3px;
1.822 bisitz 5063: }
5064:
1.795 www 5065: .LC_fontsize_medium {
1.911 bisitz 5066: font-size: 85%;
1.705 tempelho 5067: }
5068:
1.795 www 5069: .LC_fontsize_large {
1.911 bisitz 5070: font-size: 120%;
1.705 tempelho 5071: }
5072:
1.346 albertel 5073: .LC_menubuttons_inline_text {
5074: color: $font;
1.698 harmsja 5075: font-size: 90%;
1.701 harmsja 5076: padding-left:3px;
1.346 albertel 5077: }
5078:
1.934 droeschl 5079: .LC_menubuttons_inline_text img{
5080: vertical-align: middle;
5081: }
5082:
1.951 onken 5083: li.LC_menubuttons_inline_text img,a {
5084: cursor:pointer;
5085: }
5086:
1.526 www 5087: .LC_menubuttons_link {
5088: text-decoration: none;
5089: }
1.795 www 5090:
1.522 albertel 5091: .LC_menubuttons_category {
1.521 www 5092: color: $font;
1.526 www 5093: background: $pgbg;
1.521 www 5094: font-size: larger;
5095: font-weight: bold;
5096: }
5097:
1.346 albertel 5098: td.LC_menubuttons_text {
1.911 bisitz 5099: color: $font;
1.346 albertel 5100: }
1.706 harmsja 5101:
1.346 albertel 5102: .LC_current_location {
5103: background: $tabbg;
5104: }
1.795 www 5105:
1.938 bisitz 5106: table.LC_data_table {
1.347 albertel 5107: border: 1px solid #000000;
1.402 albertel 5108: border-collapse: separate;
1.426 albertel 5109: border-spacing: 1px;
1.610 albertel 5110: background: $pgbg;
1.347 albertel 5111: }
1.795 www 5112:
1.422 albertel 5113: .LC_data_table_dense {
5114: font-size: small;
5115: }
1.795 www 5116:
1.507 raeburn 5117: table.LC_nested_outer {
5118: border: 1px solid #000000;
1.589 raeburn 5119: border-collapse: collapse;
1.803 bisitz 5120: border-spacing: 0;
1.507 raeburn 5121: width: 100%;
5122: }
1.795 www 5123:
1.879 raeburn 5124: table.LC_innerpickbox,
1.507 raeburn 5125: table.LC_nested {
1.803 bisitz 5126: border: none;
1.589 raeburn 5127: border-collapse: collapse;
1.803 bisitz 5128: border-spacing: 0;
1.507 raeburn 5129: width: 100%;
5130: }
1.795 www 5131:
1.930 faziophi 5132: .ui-accordion,
5133: .ui-accordion table.LC_data_table,
5134: .ui-accordion table.LC_nested_outer{
5135: border: 0px;
5136: border-spacing: 0px;
5137: margin: 3px;
5138: }
5139:
1.911 bisitz 5140: table.LC_data_table tr th,
5141: table.LC_calendar tr th,
1.879 raeburn 5142: table.LC_prior_tries tr th,
5143: table.LC_innerpickbox tr th {
1.349 albertel 5144: font-weight: bold;
5145: background-color: $data_table_head;
1.801 tempelho 5146: color:$fontmenu;
1.701 harmsja 5147: font-size:90%;
1.347 albertel 5148: }
1.795 www 5149:
1.879 raeburn 5150: table.LC_innerpickbox tr th,
5151: table.LC_innerpickbox tr td {
5152: vertical-align: top;
5153: }
5154:
1.711 raeburn 5155: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5156: background-color: #CCCCCC;
1.711 raeburn 5157: font-weight: bold;
5158: text-align: left;
5159: }
1.795 www 5160:
1.912 bisitz 5161: table.LC_data_table tr.LC_odd_row > td {
5162: background-color: $data_table_light;
5163: padding: 2px;
5164: vertical-align: top;
5165: }
5166:
1.809 bisitz 5167: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5168: background-color: $data_table_light;
1.912 bisitz 5169: vertical-align: top;
5170: }
5171:
5172: table.LC_data_table tr.LC_even_row > td {
5173: background-color: $data_table_dark;
1.425 albertel 5174: padding: 2px;
1.900 bisitz 5175: vertical-align: top;
1.347 albertel 5176: }
1.795 www 5177:
1.809 bisitz 5178: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5179: background-color: $data_table_dark;
1.900 bisitz 5180: vertical-align: top;
1.347 albertel 5181: }
1.795 www 5182:
1.425 albertel 5183: table.LC_data_table tr.LC_data_table_highlight td {
5184: background-color: $data_table_darker;
5185: }
1.795 www 5186:
1.639 raeburn 5187: table.LC_data_table tr td.LC_leftcol_header {
5188: background-color: $data_table_head;
5189: font-weight: bold;
5190: }
1.795 www 5191:
1.451 albertel 5192: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5193: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5194: font-weight: bold;
5195: font-style: italic;
5196: text-align: center;
5197: padding: 8px;
1.347 albertel 5198: }
1.795 www 5199:
1.940 bisitz 5200: table.LC_data_table tr.LC_empty_row td {
5201: background-color: $sidebg;
5202: }
5203:
5204: table.LC_nested tr.LC_empty_row td {
5205: background-color: #FFFFFF;
5206: }
5207:
1.890 droeschl 5208: table.LC_caption {
5209: }
5210:
1.507 raeburn 5211: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5212: padding: 4ex
5213: }
1.795 www 5214:
1.507 raeburn 5215: table.LC_nested_outer tr th {
5216: font-weight: bold;
1.801 tempelho 5217: color:$fontmenu;
1.507 raeburn 5218: background-color: $data_table_head;
1.701 harmsja 5219: font-size: small;
1.507 raeburn 5220: border-bottom: 1px solid #000000;
5221: }
1.795 www 5222:
1.507 raeburn 5223: table.LC_nested_outer tr td.LC_subheader {
5224: background-color: $data_table_head;
5225: font-weight: bold;
5226: font-size: small;
5227: border-bottom: 1px solid #000000;
5228: text-align: right;
1.451 albertel 5229: }
1.795 www 5230:
1.507 raeburn 5231: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5232: background-color: #CCCCCC;
1.451 albertel 5233: font-weight: bold;
5234: font-size: small;
1.507 raeburn 5235: text-align: center;
5236: }
1.795 www 5237:
1.589 raeburn 5238: table.LC_nested tr.LC_info_row td.LC_left_item,
5239: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5240: text-align: left;
1.451 albertel 5241: }
1.795 www 5242:
1.507 raeburn 5243: table.LC_nested td {
1.735 bisitz 5244: background-color: #FFFFFF;
1.451 albertel 5245: font-size: small;
1.507 raeburn 5246: }
1.795 www 5247:
1.507 raeburn 5248: table.LC_nested_outer tr th.LC_right_item,
5249: table.LC_nested tr.LC_info_row td.LC_right_item,
5250: table.LC_nested tr.LC_odd_row td.LC_right_item,
5251: table.LC_nested tr td.LC_right_item {
1.451 albertel 5252: text-align: right;
5253: }
5254:
1.930 faziophi 5255: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5256: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5257: text-align: right;
5258: width: 40%;
5259: padding-right:10px;
5260: vertical-align: top;
5261: padding: 5px;
5262: }
5263:
5264: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5265: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5266: text-align: left;
5267: width: 60%;
5268: padding: 2px 4px;
5269: }
5270:
1.507 raeburn 5271: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5272: background-color: #EEEEEE;
1.451 albertel 5273: }
5274:
1.473 raeburn 5275: table.LC_createuser {
5276: }
5277:
5278: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5279: font-size: small;
1.473 raeburn 5280: }
5281:
5282: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5283: background-color: #CCCCCC;
1.473 raeburn 5284: font-weight: bold;
5285: text-align: center;
5286: }
5287:
1.349 albertel 5288: table.LC_calendar {
5289: border: 1px solid #000000;
5290: border-collapse: collapse;
1.917 raeburn 5291: width: 98%;
1.349 albertel 5292: }
1.795 www 5293:
1.349 albertel 5294: table.LC_calendar_pickdate {
5295: font-size: xx-small;
5296: }
1.795 www 5297:
1.349 albertel 5298: table.LC_calendar tr td {
5299: border: 1px solid #000000;
5300: vertical-align: top;
1.917 raeburn 5301: width: 14%;
1.349 albertel 5302: }
1.795 www 5303:
1.349 albertel 5304: table.LC_calendar tr td.LC_calendar_day_empty {
5305: background-color: $data_table_dark;
5306: }
1.795 www 5307:
1.779 bisitz 5308: table.LC_calendar tr td.LC_calendar_day_current {
5309: background-color: $data_table_highlight;
1.777 tempelho 5310: }
1.795 www 5311:
1.938 bisitz 5312: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5313: background-color: $mail_new;
5314: }
1.795 www 5315:
1.938 bisitz 5316: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5317: background-color: $mail_new_hover;
5318: }
1.795 www 5319:
1.938 bisitz 5320: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5321: background-color: $mail_read;
5322: }
1.795 www 5323:
1.938 bisitz 5324: /*
5325: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5326: background-color: $mail_read_hover;
5327: }
1.938 bisitz 5328: */
1.795 www 5329:
1.938 bisitz 5330: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5331: background-color: $mail_replied;
5332: }
1.795 www 5333:
1.938 bisitz 5334: /*
5335: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5336: background-color: $mail_replied_hover;
5337: }
1.938 bisitz 5338: */
1.795 www 5339:
1.938 bisitz 5340: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5341: background-color: $mail_other;
5342: }
1.795 www 5343:
1.938 bisitz 5344: /*
5345: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5346: background-color: $mail_other_hover;
5347: }
1.938 bisitz 5348: */
1.494 raeburn 5349:
1.777 tempelho 5350: table.LC_data_table tr > td.LC_browser_file,
5351: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5352: background: #AAEE77;
1.389 albertel 5353: }
1.795 www 5354:
1.777 tempelho 5355: table.LC_data_table tr > td.LC_browser_file_locked,
5356: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5357: background: #FFAA99;
1.387 albertel 5358: }
1.795 www 5359:
1.777 tempelho 5360: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5361: background: #888888;
1.779 bisitz 5362: }
1.795 www 5363:
1.777 tempelho 5364: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5365: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5366: background: #F8F866;
1.777 tempelho 5367: }
1.795 www 5368:
1.696 bisitz 5369: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5370: background: #E0E8FF;
1.387 albertel 5371: }
1.696 bisitz 5372:
1.707 bisitz 5373: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5374: /* background: #77FF77; */
1.707 bisitz 5375: }
1.795 www 5376:
1.707 bisitz 5377: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5378: border-right: 8px solid #FFFF77;
1.707 bisitz 5379: }
1.795 www 5380:
1.707 bisitz 5381: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5382: border-right: 8px solid #FFAA77;
1.707 bisitz 5383: }
1.795 www 5384:
1.707 bisitz 5385: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5386: border-right: 8px solid #FF7777;
1.707 bisitz 5387: }
1.795 www 5388:
1.707 bisitz 5389: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5390: border-right: 8px solid #AAFF77;
1.707 bisitz 5391: }
1.795 www 5392:
1.707 bisitz 5393: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5394: border-right: 8px solid #11CC55;
1.707 bisitz 5395: }
5396:
1.388 albertel 5397: span.LC_current_location {
1.701 harmsja 5398: font-size:larger;
1.388 albertel 5399: background: $pgbg;
5400: }
1.387 albertel 5401:
1.395 albertel 5402: span.LC_parm_menu_item {
5403: font-size: larger;
5404: }
1.795 www 5405:
1.395 albertel 5406: span.LC_parm_scope_all {
5407: color: red;
5408: }
1.795 www 5409:
1.395 albertel 5410: span.LC_parm_scope_folder {
5411: color: green;
5412: }
1.795 www 5413:
1.395 albertel 5414: span.LC_parm_scope_resource {
5415: color: orange;
5416: }
1.795 www 5417:
1.395 albertel 5418: span.LC_parm_part {
5419: color: blue;
5420: }
1.795 www 5421:
1.911 bisitz 5422: span.LC_parm_folder,
5423: span.LC_parm_symb {
1.395 albertel 5424: font-size: x-small;
5425: font-family: $mono;
5426: color: #AAAAAA;
5427: }
5428:
1.795 www 5429: td.LC_parm_overview_level_menu,
5430: td.LC_parm_overview_map_menu,
5431: td.LC_parm_overview_parm_selectors,
5432: td.LC_parm_overview_restrictions {
1.396 albertel 5433: border: 1px solid black;
5434: border-collapse: collapse;
5435: }
1.795 www 5436:
1.396 albertel 5437: table.LC_parm_overview_restrictions td {
5438: border-width: 1px 4px 1px 4px;
5439: border-style: solid;
5440: border-color: $pgbg;
5441: text-align: center;
5442: }
1.795 www 5443:
1.396 albertel 5444: table.LC_parm_overview_restrictions th {
5445: background: $tabbg;
5446: border-width: 1px 4px 1px 4px;
5447: border-style: solid;
5448: border-color: $pgbg;
5449: }
1.795 www 5450:
1.398 albertel 5451: table#LC_helpmenu {
1.803 bisitz 5452: border: none;
1.398 albertel 5453: height: 55px;
1.803 bisitz 5454: border-spacing: 0;
1.398 albertel 5455: }
5456:
5457: table#LC_helpmenu fieldset legend {
5458: font-size: larger;
5459: }
1.795 www 5460:
1.397 albertel 5461: table#LC_helpmenu_links {
5462: width: 100%;
5463: border: 1px solid black;
5464: background: $pgbg;
1.803 bisitz 5465: padding: 0;
1.397 albertel 5466: border-spacing: 1px;
5467: }
1.795 www 5468:
1.397 albertel 5469: table#LC_helpmenu_links tr td {
5470: padding: 1px;
5471: background: $tabbg;
1.399 albertel 5472: text-align: center;
5473: font-weight: bold;
1.397 albertel 5474: }
1.396 albertel 5475:
1.795 www 5476: table#LC_helpmenu_links a:link,
5477: table#LC_helpmenu_links a:visited,
1.397 albertel 5478: table#LC_helpmenu_links a:active {
5479: text-decoration: none;
5480: color: $font;
5481: }
1.795 www 5482:
1.397 albertel 5483: table#LC_helpmenu_links a:hover {
5484: text-decoration: underline;
5485: color: $vlink;
5486: }
1.396 albertel 5487:
1.417 albertel 5488: .LC_chrt_popup_exists {
5489: border: 1px solid #339933;
5490: margin: -1px;
5491: }
1.795 www 5492:
1.417 albertel 5493: .LC_chrt_popup_up {
5494: border: 1px solid yellow;
5495: margin: -1px;
5496: }
1.795 www 5497:
1.417 albertel 5498: .LC_chrt_popup {
5499: border: 1px solid #8888FF;
5500: background: #CCCCFF;
5501: }
1.795 www 5502:
1.421 albertel 5503: table.LC_pick_box {
5504: border-collapse: separate;
5505: background: white;
5506: border: 1px solid black;
5507: border-spacing: 1px;
5508: }
1.795 www 5509:
1.421 albertel 5510: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5511: background: $sidebg;
1.421 albertel 5512: font-weight: bold;
1.900 bisitz 5513: text-align: left;
1.740 bisitz 5514: vertical-align: top;
1.421 albertel 5515: width: 184px;
5516: padding: 8px;
5517: }
1.795 www 5518:
1.579 raeburn 5519: table.LC_pick_box td.LC_pick_box_value {
5520: text-align: left;
5521: padding: 8px;
5522: }
1.795 www 5523:
1.579 raeburn 5524: table.LC_pick_box td.LC_pick_box_select {
5525: text-align: left;
5526: padding: 8px;
5527: }
1.795 www 5528:
1.424 albertel 5529: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5530: padding: 0;
1.421 albertel 5531: height: 1px;
5532: background: black;
5533: }
1.795 www 5534:
1.421 albertel 5535: table.LC_pick_box td.LC_pick_box_submit {
5536: text-align: right;
5537: }
1.795 www 5538:
1.579 raeburn 5539: table.LC_pick_box td.LC_evenrow_value {
5540: text-align: left;
5541: padding: 8px;
5542: background-color: $data_table_light;
5543: }
1.795 www 5544:
1.579 raeburn 5545: table.LC_pick_box td.LC_oddrow_value {
5546: text-align: left;
5547: padding: 8px;
5548: background-color: $data_table_light;
5549: }
1.795 www 5550:
1.579 raeburn 5551: span.LC_helpform_receipt_cat {
5552: font-weight: bold;
5553: }
1.795 www 5554:
1.424 albertel 5555: table.LC_group_priv_box {
5556: background: white;
5557: border: 1px solid black;
5558: border-spacing: 1px;
5559: }
1.795 www 5560:
1.424 albertel 5561: table.LC_group_priv_box td.LC_pick_box_title {
5562: background: $tabbg;
5563: font-weight: bold;
5564: text-align: right;
5565: width: 184px;
5566: }
1.795 www 5567:
1.424 albertel 5568: table.LC_group_priv_box td.LC_groups_fixed {
5569: background: $data_table_light;
5570: text-align: center;
5571: }
1.795 www 5572:
1.424 albertel 5573: table.LC_group_priv_box td.LC_groups_optional {
5574: background: $data_table_dark;
5575: text-align: center;
5576: }
1.795 www 5577:
1.424 albertel 5578: table.LC_group_priv_box td.LC_groups_functionality {
5579: background: $data_table_darker;
5580: text-align: center;
5581: font-weight: bold;
5582: }
1.795 www 5583:
1.424 albertel 5584: table.LC_group_priv td {
5585: text-align: left;
1.803 bisitz 5586: padding: 0;
1.424 albertel 5587: }
5588:
5589: .LC_navbuttons {
5590: margin: 2ex 0ex 2ex 0ex;
5591: }
1.795 www 5592:
1.423 albertel 5593: .LC_topic_bar {
5594: font-weight: bold;
5595: background: $tabbg;
1.918 wenzelju 5596: margin: 1em 0em 1em 2em;
1.805 bisitz 5597: padding: 3px;
1.918 wenzelju 5598: font-size: 1.2em;
1.423 albertel 5599: }
1.795 www 5600:
1.423 albertel 5601: .LC_topic_bar span {
1.918 wenzelju 5602: left: 0.5em;
5603: position: absolute;
1.423 albertel 5604: vertical-align: middle;
1.918 wenzelju 5605: font-size: 1.2em;
1.423 albertel 5606: }
1.795 www 5607:
1.423 albertel 5608: table.LC_course_group_status {
5609: margin: 20px;
5610: }
1.795 www 5611:
1.423 albertel 5612: table.LC_status_selector td {
5613: vertical-align: top;
5614: text-align: center;
1.424 albertel 5615: padding: 4px;
5616: }
1.795 www 5617:
1.599 albertel 5618: div.LC_feedback_link {
1.616 albertel 5619: clear: both;
1.829 kalberla 5620: background: $sidebg;
1.779 bisitz 5621: width: 100%;
1.829 kalberla 5622: padding-bottom: 10px;
5623: border: 1px $tabbg solid;
1.833 kalberla 5624: height: 22px;
5625: line-height: 22px;
5626: padding-top: 5px;
5627: }
5628:
5629: div.LC_feedback_link img {
5630: height: 22px;
1.867 kalberla 5631: vertical-align:middle;
1.829 kalberla 5632: }
5633:
1.911 bisitz 5634: div.LC_feedback_link a {
1.829 kalberla 5635: text-decoration: none;
1.489 raeburn 5636: }
1.795 www 5637:
1.867 kalberla 5638: div.LC_comblock {
1.911 bisitz 5639: display:inline;
1.867 kalberla 5640: color:$font;
5641: font-size:90%;
5642: }
5643:
5644: div.LC_feedback_link div.LC_comblock {
5645: padding-left:5px;
5646: }
5647:
5648: div.LC_feedback_link div.LC_comblock a {
5649: color:$font;
5650: }
5651:
1.489 raeburn 5652: span.LC_feedback_link {
1.858 bisitz 5653: /* background: $feedback_link_bg; */
1.599 albertel 5654: font-size: larger;
5655: }
1.795 www 5656:
1.599 albertel 5657: span.LC_message_link {
1.858 bisitz 5658: /* background: $feedback_link_bg; */
1.599 albertel 5659: font-size: larger;
5660: position: absolute;
5661: right: 1em;
1.489 raeburn 5662: }
1.421 albertel 5663:
1.515 albertel 5664: table.LC_prior_tries {
1.524 albertel 5665: border: 1px solid #000000;
5666: border-collapse: separate;
5667: border-spacing: 1px;
1.515 albertel 5668: }
1.523 albertel 5669:
1.515 albertel 5670: table.LC_prior_tries td {
1.524 albertel 5671: padding: 2px;
1.515 albertel 5672: }
1.523 albertel 5673:
5674: .LC_answer_correct {
1.795 www 5675: background: lightgreen;
5676: color: darkgreen;
5677: padding: 6px;
1.523 albertel 5678: }
1.795 www 5679:
1.523 albertel 5680: .LC_answer_charged_try {
1.797 www 5681: background: #FFAAAA;
1.795 www 5682: color: darkred;
5683: padding: 6px;
1.523 albertel 5684: }
1.795 www 5685:
1.779 bisitz 5686: .LC_answer_not_charged_try,
1.523 albertel 5687: .LC_answer_no_grade,
5688: .LC_answer_late {
1.795 www 5689: background: lightyellow;
1.523 albertel 5690: color: black;
1.795 www 5691: padding: 6px;
1.523 albertel 5692: }
1.795 www 5693:
1.523 albertel 5694: .LC_answer_previous {
1.795 www 5695: background: lightblue;
5696: color: darkblue;
5697: padding: 6px;
1.523 albertel 5698: }
1.795 www 5699:
1.779 bisitz 5700: .LC_answer_no_message {
1.777 tempelho 5701: background: #FFFFFF;
5702: color: black;
1.795 www 5703: padding: 6px;
1.779 bisitz 5704: }
1.795 www 5705:
1.779 bisitz 5706: .LC_answer_unknown {
5707: background: orange;
5708: color: black;
1.795 www 5709: padding: 6px;
1.777 tempelho 5710: }
1.795 www 5711:
1.529 albertel 5712: span.LC_prior_numerical,
5713: span.LC_prior_string,
5714: span.LC_prior_custom,
5715: span.LC_prior_reaction,
5716: span.LC_prior_math {
1.925 bisitz 5717: font-family: $mono;
1.523 albertel 5718: white-space: pre;
5719: }
5720:
1.525 albertel 5721: span.LC_prior_string {
1.925 bisitz 5722: font-family: $mono;
1.525 albertel 5723: white-space: pre;
5724: }
5725:
1.523 albertel 5726: table.LC_prior_option {
5727: width: 100%;
5728: border-collapse: collapse;
5729: }
1.795 www 5730:
1.911 bisitz 5731: table.LC_prior_rank,
1.795 www 5732: table.LC_prior_match {
1.528 albertel 5733: border-collapse: collapse;
5734: }
1.795 www 5735:
1.528 albertel 5736: table.LC_prior_option tr td,
5737: table.LC_prior_rank tr td,
5738: table.LC_prior_match tr td {
1.524 albertel 5739: border: 1px solid #000000;
1.515 albertel 5740: }
5741:
1.855 bisitz 5742: .LC_nobreak {
1.544 albertel 5743: white-space: nowrap;
1.519 raeburn 5744: }
5745:
1.576 raeburn 5746: span.LC_cusr_emph {
5747: font-style: italic;
5748: }
5749:
1.633 raeburn 5750: span.LC_cusr_subheading {
5751: font-weight: normal;
5752: font-size: 85%;
5753: }
5754:
1.861 bisitz 5755: div.LC_docs_entry_move {
1.859 bisitz 5756: border: 1px solid #BBBBBB;
1.545 albertel 5757: background: #DDDDDD;
1.861 bisitz 5758: width: 22px;
1.859 bisitz 5759: padding: 1px;
5760: margin: 0;
1.545 albertel 5761: }
5762:
1.861 bisitz 5763: table.LC_data_table tr > td.LC_docs_entry_commands,
5764: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5765: background: #DDDDDD;
5766: font-size: x-small;
5767: }
1.795 www 5768:
1.861 bisitz 5769: .LC_docs_entry_parameter {
5770: white-space: nowrap;
5771: }
5772:
1.544 albertel 5773: .LC_docs_copy {
1.545 albertel 5774: color: #000099;
1.544 albertel 5775: }
1.795 www 5776:
1.544 albertel 5777: .LC_docs_cut {
1.545 albertel 5778: color: #550044;
1.544 albertel 5779: }
1.795 www 5780:
1.544 albertel 5781: .LC_docs_rename {
1.545 albertel 5782: color: #009900;
1.544 albertel 5783: }
1.795 www 5784:
1.544 albertel 5785: .LC_docs_remove {
1.545 albertel 5786: color: #990000;
5787: }
5788:
1.547 albertel 5789: .LC_docs_reinit_warn,
5790: .LC_docs_ext_edit {
5791: font-size: x-small;
5792: }
5793:
1.545 albertel 5794: table.LC_docs_adddocs td,
5795: table.LC_docs_adddocs th {
5796: border: 1px solid #BBBBBB;
5797: padding: 4px;
5798: background: #DDDDDD;
1.543 albertel 5799: }
5800:
1.584 albertel 5801: table.LC_sty_begin {
5802: background: #BBFFBB;
5803: }
1.795 www 5804:
1.584 albertel 5805: table.LC_sty_end {
5806: background: #FFBBBB;
5807: }
5808:
1.589 raeburn 5809: table.LC_double_column {
1.803 bisitz 5810: border-width: 0;
1.589 raeburn 5811: border-collapse: collapse;
5812: width: 100%;
5813: padding: 2px;
5814: }
5815:
5816: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5817: top: 2px;
1.589 raeburn 5818: left: 2px;
5819: width: 47%;
5820: vertical-align: top;
5821: }
5822:
5823: table.LC_double_column tr td.LC_right_col {
5824: top: 2px;
1.779 bisitz 5825: right: 2px;
1.589 raeburn 5826: width: 47%;
5827: vertical-align: top;
5828: }
5829:
1.591 raeburn 5830: div.LC_left_float {
5831: float: left;
5832: padding-right: 5%;
1.597 albertel 5833: padding-bottom: 4px;
1.591 raeburn 5834: }
5835:
5836: div.LC_clear_float_header {
1.597 albertel 5837: padding-bottom: 2px;
1.591 raeburn 5838: }
5839:
5840: div.LC_clear_float_footer {
1.597 albertel 5841: padding-top: 10px;
1.591 raeburn 5842: clear: both;
5843: }
5844:
1.597 albertel 5845: div.LC_grade_show_user {
1.941 bisitz 5846: /* border-left: 5px solid $sidebg; */
5847: border-top: 5px solid #000000;
5848: margin: 50px 0 0 0;
1.936 bisitz 5849: padding: 15px 0 5px 10px;
1.597 albertel 5850: }
1.795 www 5851:
1.936 bisitz 5852: div.LC_grade_show_user_odd_row {
1.941 bisitz 5853: /* border-left: 5px solid #000000; */
5854: }
5855:
5856: div.LC_grade_show_user div.LC_Box {
5857: margin-right: 50px;
1.597 albertel 5858: }
5859:
5860: div.LC_grade_submissions,
5861: div.LC_grade_message_center,
1.936 bisitz 5862: div.LC_grade_info_links {
1.597 albertel 5863: margin: 5px;
5864: width: 99%;
5865: background: #FFFFFF;
5866: }
1.795 www 5867:
1.597 albertel 5868: div.LC_grade_submissions_header,
1.936 bisitz 5869: div.LC_grade_message_center_header {
1.705 tempelho 5870: font-weight: bold;
5871: font-size: large;
1.597 albertel 5872: }
1.795 www 5873:
1.597 albertel 5874: div.LC_grade_submissions_body,
1.936 bisitz 5875: div.LC_grade_message_center_body {
1.597 albertel 5876: border: 1px solid black;
5877: width: 99%;
5878: background: #FFFFFF;
5879: }
1.795 www 5880:
1.613 albertel 5881: table.LC_scantron_action {
5882: width: 100%;
5883: }
1.795 www 5884:
1.613 albertel 5885: table.LC_scantron_action tr th {
1.698 harmsja 5886: font-weight:bold;
5887: font-style:normal;
1.613 albertel 5888: }
1.795 www 5889:
1.779 bisitz 5890: .LC_edit_problem_header,
1.614 albertel 5891: div.LC_edit_problem_footer {
1.705 tempelho 5892: font-weight: normal;
5893: font-size: medium;
1.602 albertel 5894: margin: 2px;
1.600 albertel 5895: }
1.795 www 5896:
1.600 albertel 5897: div.LC_edit_problem_header,
1.602 albertel 5898: div.LC_edit_problem_header div,
1.614 albertel 5899: div.LC_edit_problem_footer,
5900: div.LC_edit_problem_footer div,
1.602 albertel 5901: div.LC_edit_problem_editxml_header,
5902: div.LC_edit_problem_editxml_header div {
1.600 albertel 5903: margin-top: 5px;
5904: }
1.795 www 5905:
1.600 albertel 5906: div.LC_edit_problem_header_title {
1.705 tempelho 5907: font-weight: bold;
5908: font-size: larger;
1.602 albertel 5909: background: $tabbg;
5910: padding: 3px;
5911: }
1.795 www 5912:
1.602 albertel 5913: table.LC_edit_problem_header_title {
5914: width: 100%;
1.600 albertel 5915: background: $tabbg;
1.602 albertel 5916: }
5917:
5918: div.LC_edit_problem_discards {
5919: float: left;
5920: padding-bottom: 5px;
5921: }
1.795 www 5922:
1.602 albertel 5923: div.LC_edit_problem_saves {
5924: float: right;
5925: padding-bottom: 5px;
1.600 albertel 5926: }
1.795 www 5927:
1.911 bisitz 5928: img.stift {
1.803 bisitz 5929: border-width: 0;
5930: vertical-align: middle;
1.677 riegler 5931: }
1.680 riegler 5932:
1.923 bisitz 5933: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5934: vertical-align: top;
1.777 tempelho 5935: }
1.795 www 5936:
1.716 raeburn 5937: div.LC_createcourse {
1.911 bisitz 5938: margin: 10px 10px 10px 10px;
1.716 raeburn 5939: }
5940:
1.917 raeburn 5941: .LC_dccid {
5942: margin: 0.2em 0 0 0;
5943: padding: 0;
5944: font-size: 90%;
5945: display:none;
5946: }
5947:
1.698 harmsja 5948: a:hover,
1.897 wenzelju 5949: ol.LC_primary_menu a:hover,
1.721 harmsja 5950: ol#LC_MenuBreadcrumbs a:hover,
5951: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5952: ul#LC_secondary_menu a:hover,
1.721 harmsja 5953: .LC_FormSectionClearButton input:hover
1.795 www 5954: ul.LC_TabContent li:hover a {
1.952 onken 5955: color:$button_hover;
1.911 bisitz 5956: text-decoration:none;
1.693 droeschl 5957: }
5958:
1.779 bisitz 5959: h1 {
1.911 bisitz 5960: padding: 0;
5961: line-height:130%;
1.693 droeschl 5962: }
1.698 harmsja 5963:
1.911 bisitz 5964: h2,
5965: h3,
5966: h4,
5967: h5,
5968: h6 {
5969: margin: 5px 0 5px 0;
5970: padding: 0;
5971: line-height:130%;
1.693 droeschl 5972: }
1.795 www 5973:
5974: .LC_hcell {
1.911 bisitz 5975: padding:3px 15px 3px 15px;
5976: margin: 0;
5977: background-color:$tabbg;
5978: color:$fontmenu;
5979: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5980: }
1.795 www 5981:
1.840 bisitz 5982: .LC_Box > .LC_hcell {
1.911 bisitz 5983: margin: 0 -10px 10px -10px;
1.835 bisitz 5984: }
5985:
1.721 harmsja 5986: .LC_noBorder {
1.911 bisitz 5987: border: 0;
1.698 harmsja 5988: }
1.693 droeschl 5989:
1.721 harmsja 5990: .LC_FormSectionClearButton input {
1.911 bisitz 5991: background-color:transparent;
5992: border: none;
5993: cursor:pointer;
5994: text-decoration:underline;
1.693 droeschl 5995: }
1.763 bisitz 5996:
5997: .LC_help_open_topic {
1.911 bisitz 5998: color: #FFFFFF;
5999: background-color: #EEEEFF;
6000: margin: 1px;
6001: padding: 4px;
6002: border: 1px solid #000033;
6003: white-space: nowrap;
6004: /* vertical-align: middle; */
1.759 neumanie 6005: }
1.693 droeschl 6006:
1.911 bisitz 6007: dl,
6008: ul,
6009: div,
6010: fieldset {
6011: margin: 10px 10px 10px 0;
6012: /* overflow: hidden; */
1.693 droeschl 6013: }
1.795 www 6014:
1.838 bisitz 6015: fieldset > legend {
1.911 bisitz 6016: font-weight: bold;
6017: padding: 0 5px 0 5px;
1.838 bisitz 6018: }
6019:
1.813 bisitz 6020: #LC_nav_bar {
1.911 bisitz 6021: float: left;
1.966 bisitz 6022: margin: 0 0 2px 0;
1.807 droeschl 6023: }
6024:
1.916 droeschl 6025: #LC_realm {
6026: margin: 0.2em 0 0 0;
6027: padding: 0;
6028: font-weight: bold;
6029: text-align: center;
6030: }
6031:
1.911 bisitz 6032: #LC_nav_bar em {
6033: font-weight: bold;
6034: font-style: normal;
1.807 droeschl 6035: }
6036:
1.965 bisitz 6037: /* Preliminary fix to hide nav_bar inside bookmarks window */
6038: #LC_bookmarks #LC_nav_bar {
6039: display:none;
6040: }
6041:
1.897 wenzelju 6042: ol.LC_primary_menu {
1.911 bisitz 6043: float: right;
1.934 droeschl 6044: margin: 0;
1.807 droeschl 6045: }
6046:
1.852 droeschl 6047: ol#LC_PathBreadcrumbs {
1.911 bisitz 6048: margin: 0;
1.693 droeschl 6049: }
6050:
1.897 wenzelju 6051: ol.LC_primary_menu li {
1.911 bisitz 6052: display: inline;
6053: padding: 5px 5px 0 10px;
6054: vertical-align: top;
1.693 droeschl 6055: }
6056:
1.897 wenzelju 6057: ol.LC_primary_menu li img {
1.911 bisitz 6058: vertical-align: bottom;
1.934 droeschl 6059: height: 1.1em;
1.693 droeschl 6060: }
6061:
1.897 wenzelju 6062: ol.LC_primary_menu a {
1.911 bisitz 6063: color: RGB(80, 80, 80);
6064: text-decoration: none;
1.693 droeschl 6065: }
1.795 www 6066:
1.949 droeschl 6067: ol.LC_primary_menu a.LC_new_message {
6068: font-weight:bold;
6069: color: darkred;
6070: }
6071:
1.897 wenzelju 6072: ul#LC_secondary_menu {
1.911 bisitz 6073: clear: both;
6074: color: $fontmenu;
6075: background: $tabbg;
6076: list-style: none;
6077: padding: 0;
6078: margin: 0;
6079: width: 100%;
1.808 droeschl 6080: }
6081:
1.897 wenzelju 6082: ul#LC_secondary_menu li {
1.911 bisitz 6083: font-weight: bold;
6084: line-height: 1.8em;
6085: padding: 0 0.8em;
6086: border-right: 1px solid black;
6087: display: inline;
6088: vertical-align: middle;
1.807 droeschl 6089: }
6090:
1.847 tempelho 6091: ul.LC_TabContent {
1.911 bisitz 6092: display:block;
6093: background: $sidebg;
6094: border-bottom: solid 1px $lg_border_color;
6095: list-style:none;
6096: margin: 0 -10px;
6097: padding: 0;
1.693 droeschl 6098: }
6099:
1.795 www 6100: ul.LC_TabContent li,
6101: ul.LC_TabContentBigger li {
1.911 bisitz 6102: float:left;
1.741 harmsja 6103: }
1.795 www 6104:
1.897 wenzelju 6105: ul#LC_secondary_menu li a {
1.911 bisitz 6106: color: $fontmenu;
6107: text-decoration: none;
1.693 droeschl 6108: }
1.795 www 6109:
1.721 harmsja 6110: ul.LC_TabContent {
1.952 onken 6111: min-height:20px;
1.721 harmsja 6112: }
1.795 www 6113:
6114: ul.LC_TabContent li {
1.911 bisitz 6115: vertical-align:middle;
1.959 onken 6116: padding: 0 16px 0 10px;
1.911 bisitz 6117: background-color:$tabbg;
6118: border-bottom:solid 1px $lg_border_color;
1.952 onken 6119: border-right: solid 1px $font;
1.721 harmsja 6120: }
1.795 www 6121:
1.847 tempelho 6122: ul.LC_TabContent .right {
1.911 bisitz 6123: float:right;
1.847 tempelho 6124: }
6125:
1.911 bisitz 6126: ul.LC_TabContent li a,
6127: ul.LC_TabContent li {
6128: color:rgb(47,47,47);
6129: text-decoration:none;
6130: font-size:95%;
6131: font-weight:bold;
1.952 onken 6132: min-height:20px;
6133: }
6134:
1.959 onken 6135: ul.LC_TabContent li a:hover,
6136: ul.LC_TabContent li a:focus {
1.952 onken 6137: color: $button_hover;
1.959 onken 6138: background:none;
6139: outline:none;
1.952 onken 6140: }
6141:
6142: ul.LC_TabContent li:hover {
6143: color: $button_hover;
6144: cursor:pointer;
1.721 harmsja 6145: }
1.795 www 6146:
1.911 bisitz 6147: ul.LC_TabContent li.active {
1.952 onken 6148: color: $font;
1.911 bisitz 6149: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 6150: border-bottom:solid 1px #FFFFFF;
6151: cursor: default;
1.744 ehlerst 6152: }
1.795 www 6153:
1.959 onken 6154: ul.LC_TabContent li.active a {
6155: color:$font;
6156: background:#FFFFFF;
6157: outline: none;
6158: }
1.870 tempelho 6159: #maincoursedoc {
1.911 bisitz 6160: clear:both;
1.870 tempelho 6161: }
6162:
6163: ul.LC_TabContentBigger {
1.911 bisitz 6164: display:block;
6165: list-style:none;
6166: padding: 0;
1.870 tempelho 6167: }
6168:
1.795 www 6169: ul.LC_TabContentBigger li {
1.911 bisitz 6170: vertical-align:bottom;
6171: height: 30px;
6172: font-size:110%;
6173: font-weight:bold;
6174: color: #737373;
1.841 tempelho 6175: }
6176:
1.957 onken 6177: ul.LC_TabContentBigger li.active {
6178: position: relative;
6179: top: 1px;
6180: }
6181:
1.870 tempelho 6182: ul.LC_TabContentBigger li a {
1.911 bisitz 6183: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6184: height: 30px;
6185: line-height: 30px;
6186: text-align: center;
6187: display: block;
6188: text-decoration: none;
1.958 onken 6189: outline: none;
1.741 harmsja 6190: }
1.795 www 6191:
1.870 tempelho 6192: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6193: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6194: color:$font;
1.744 ehlerst 6195: }
1.795 www 6196:
1.870 tempelho 6197: ul.LC_TabContentBigger li b {
1.911 bisitz 6198: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6199: display: block;
6200: float: left;
6201: padding: 0 30px;
1.957 onken 6202: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 6203: }
6204:
1.956 onken 6205: ul.LC_TabContentBigger li:hover b {
6206: color:$button_hover;
6207: }
6208:
1.870 tempelho 6209: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6210: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6211: color:$font;
1.957 onken 6212: border: 0;
1.956 onken 6213: cursor:default;
1.741 harmsja 6214: }
1.693 droeschl 6215:
1.870 tempelho 6216:
1.862 bisitz 6217: ul.LC_CourseBreadcrumbs {
6218: background: $sidebg;
6219: line-height: 32px;
6220: padding-left: 10px;
6221: margin: 0 0 10px 0;
6222: list-style-position: inside;
6223:
6224: }
6225:
1.911 bisitz 6226: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6227: ol#LC_PathBreadcrumbs {
1.911 bisitz 6228: padding-left: 10px;
6229: margin: 0;
1.933 droeschl 6230: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6231: }
6232:
1.911 bisitz 6233: ol#LC_MenuBreadcrumbs li,
6234: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6235: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6236: display: inline;
1.933 droeschl 6237: white-space: normal;
1.693 droeschl 6238: }
6239:
1.823 bisitz 6240: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6241: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6242: text-decoration: none;
6243: font-size:90%;
1.693 droeschl 6244: }
1.795 www 6245:
1.969 droeschl 6246: ol#LC_MenuBreadcrumbs h1 {
6247: display: inline;
6248: font-size: 90%;
6249: line-height: 2.5em;
6250: margin: 0;
6251: padding: 0;
6252: }
6253:
1.795 www 6254: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6255: text-decoration:none;
6256: font-size:100%;
6257: font-weight:bold;
1.693 droeschl 6258: }
1.795 www 6259:
1.840 bisitz 6260: .LC_Box {
1.911 bisitz 6261: border: solid 1px $lg_border_color;
6262: padding: 0 10px 10px 10px;
1.746 neumanie 6263: }
1.795 www 6264:
6265: .LC_AboutMe_Image {
1.911 bisitz 6266: float:left;
6267: margin-right:10px;
1.747 neumanie 6268: }
1.795 www 6269:
6270: .LC_Clear_AboutMe_Image {
1.911 bisitz 6271: clear:left;
1.747 neumanie 6272: }
1.795 www 6273:
1.721 harmsja 6274: dl.LC_ListStyleClean dt {
1.911 bisitz 6275: padding-right: 5px;
6276: display: table-header-group;
1.693 droeschl 6277: }
6278:
1.721 harmsja 6279: dl.LC_ListStyleClean dd {
1.911 bisitz 6280: display: table-row;
1.693 droeschl 6281: }
6282:
1.721 harmsja 6283: .LC_ListStyleClean,
6284: .LC_ListStyleSimple,
6285: .LC_ListStyleNormal,
1.795 www 6286: .LC_ListStyleSpecial {
1.911 bisitz 6287: /* display:block; */
6288: list-style-position: inside;
6289: list-style-type: none;
6290: overflow: hidden;
6291: padding: 0;
1.693 droeschl 6292: }
6293:
1.721 harmsja 6294: .LC_ListStyleSimple li,
6295: .LC_ListStyleSimple dd,
6296: .LC_ListStyleNormal li,
6297: .LC_ListStyleNormal dd,
6298: .LC_ListStyleSpecial li,
1.795 www 6299: .LC_ListStyleSpecial dd {
1.911 bisitz 6300: margin: 0;
6301: padding: 5px 5px 5px 10px;
6302: clear: both;
1.693 droeschl 6303: }
6304:
1.721 harmsja 6305: .LC_ListStyleClean li,
6306: .LC_ListStyleClean dd {
1.911 bisitz 6307: padding-top: 0;
6308: padding-bottom: 0;
1.693 droeschl 6309: }
6310:
1.721 harmsja 6311: .LC_ListStyleSimple dd,
1.795 www 6312: .LC_ListStyleSimple li {
1.911 bisitz 6313: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6314: }
6315:
1.721 harmsja 6316: .LC_ListStyleSpecial li,
6317: .LC_ListStyleSpecial dd {
1.911 bisitz 6318: list-style-type: none;
6319: background-color: RGB(220, 220, 220);
6320: margin-bottom: 4px;
1.693 droeschl 6321: }
6322:
1.721 harmsja 6323: table.LC_SimpleTable {
1.911 bisitz 6324: margin:5px;
6325: border:solid 1px $lg_border_color;
1.795 www 6326: }
1.693 droeschl 6327:
1.721 harmsja 6328: table.LC_SimpleTable tr {
1.911 bisitz 6329: padding: 0;
6330: border:solid 1px $lg_border_color;
1.693 droeschl 6331: }
1.795 www 6332:
6333: table.LC_SimpleTable thead {
1.911 bisitz 6334: background:rgb(220,220,220);
1.693 droeschl 6335: }
6336:
1.721 harmsja 6337: div.LC_columnSection {
1.911 bisitz 6338: display: block;
6339: clear: both;
6340: overflow: hidden;
6341: margin: 0;
1.693 droeschl 6342: }
6343:
1.721 harmsja 6344: div.LC_columnSection>* {
1.911 bisitz 6345: float: left;
6346: margin: 10px 20px 10px 0;
6347: overflow:hidden;
1.693 droeschl 6348: }
1.721 harmsja 6349:
1.795 www 6350: table em {
1.911 bisitz 6351: font-weight: bold;
6352: font-style: normal;
1.748 schulted 6353: }
1.795 www 6354:
1.779 bisitz 6355: table.LC_tableBrowseRes,
1.795 www 6356: table.LC_tableOfContent {
1.911 bisitz 6357: border:none;
6358: border-spacing: 1px;
6359: padding: 3px;
6360: background-color: #FFFFFF;
6361: font-size: 90%;
1.753 droeschl 6362: }
1.789 droeschl 6363:
1.911 bisitz 6364: table.LC_tableOfContent {
6365: border-collapse: collapse;
1.789 droeschl 6366: }
6367:
1.771 droeschl 6368: table.LC_tableBrowseRes a,
1.768 schulted 6369: table.LC_tableOfContent a {
1.911 bisitz 6370: background-color: transparent;
6371: text-decoration: none;
1.753 droeschl 6372: }
6373:
1.795 www 6374: table.LC_tableOfContent img {
1.911 bisitz 6375: border: none;
6376: height: 1.3em;
6377: vertical-align: text-bottom;
6378: margin-right: 0.3em;
1.753 droeschl 6379: }
1.757 schulted 6380:
1.795 www 6381: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6382: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6383: }
6384:
1.795 www 6385: a#LC_content_toolbar_everything {
1.911 bisitz 6386: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6387: }
6388:
1.795 www 6389: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6390: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6391: }
6392:
1.795 www 6393: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6394: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6395: }
6396:
1.795 www 6397: a#LC_content_toolbar_changefolder {
1.911 bisitz 6398: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6399: }
6400:
1.795 www 6401: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6402: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6403: }
6404:
1.795 www 6405: ul#LC_toolbar li a:hover {
1.911 bisitz 6406: background-position: bottom center;
1.757 schulted 6407: }
6408:
1.795 www 6409: ul#LC_toolbar {
1.911 bisitz 6410: padding: 0;
6411: margin: 2px;
6412: list-style:none;
6413: position:relative;
6414: background-color:white;
1.757 schulted 6415: }
6416:
1.795 www 6417: ul#LC_toolbar li {
1.911 bisitz 6418: border:1px solid white;
6419: padding: 0;
6420: margin: 0;
6421: float: left;
6422: display:inline;
6423: vertical-align:middle;
6424: }
1.757 schulted 6425:
1.783 amueller 6426:
1.795 www 6427: a.LC_toolbarItem {
1.911 bisitz 6428: display:block;
6429: padding: 0;
6430: margin: 0;
6431: height: 32px;
6432: width: 32px;
6433: color:white;
6434: border: none;
6435: background-repeat:no-repeat;
6436: background-color:transparent;
1.757 schulted 6437: }
6438:
1.915 droeschl 6439: ul.LC_funclist {
6440: margin: 0;
6441: padding: 0.5em 1em 0.5em 0;
6442: }
6443:
1.933 droeschl 6444: ul.LC_funclist > li:first-child {
6445: font-weight:bold;
6446: margin-left:0.8em;
6447: }
6448:
1.915 droeschl 6449: ul.LC_funclist + ul.LC_funclist {
6450: /*
6451: left border as a seperator if we have more than
6452: one list
6453: */
6454: border-left: 1px solid $sidebg;
6455: /*
6456: this hides the left border behind the border of the
6457: outer box if element is wrapped to the next 'line'
6458: */
6459: margin-left: -1px;
6460: }
6461:
1.843 bisitz 6462: ul.LC_funclist li {
1.915 droeschl 6463: display: inline;
1.782 bisitz 6464: white-space: nowrap;
1.915 droeschl 6465: margin: 0 0 0 25px;
6466: line-height: 150%;
1.782 bisitz 6467: }
6468:
1.930 faziophi 6469: .ui-accordion .LC_advanced_toggle {
6470: float: right;
6471: font-size: 90%;
6472: padding: 0px 4px
6473: }
1.757 schulted 6474:
1.343 albertel 6475: END
6476: }
6477:
1.306 albertel 6478: =pod
6479:
6480: =item * &headtag()
6481:
6482: Returns a uniform footer for LON-CAPA web pages.
6483:
1.307 albertel 6484: Inputs: $title - optional title for the head
6485: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6486: $args - optional arguments
1.319 albertel 6487: force_register - if is true call registerurl so the remote is
6488: informed
1.415 albertel 6489: redirect -> array ref of
6490: 1- seconds before redirect occurs
6491: 2- url to redirect to
6492: 3- whether the side effect should occur
1.315 albertel 6493: (side effect of setting
6494: $env{'internal.head.redirect'} to the url
6495: redirected too)
1.352 albertel 6496: domain -> force to color decorate a page for a specific
6497: domain
6498: function -> force usage of a specific rolish color scheme
6499: bgcolor -> override the default page bgcolor
1.460 albertel 6500: no_auto_mt_title
6501: -> prevent &mt()ing the title arg
1.464 albertel 6502:
1.306 albertel 6503: =cut
6504:
6505: sub headtag {
1.313 albertel 6506: my ($title,$head_extra,$args) = @_;
1.306 albertel 6507:
1.363 albertel 6508: my $function = $args->{'function'} || &get_users_function();
6509: my $domain = $args->{'domain'} || &determinedomain();
6510: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6511: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6512: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6513: #time(),
1.418 albertel 6514: $env{'environment.color.timestamp'},
1.363 albertel 6515: $function,$domain,$bgcolor);
6516:
1.369 www 6517: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6518:
1.308 albertel 6519: my $result =
6520: '<head>'.
1.461 albertel 6521: &font_settings();
1.319 albertel 6522:
1.461 albertel 6523: if (!$args->{'frameset'}) {
6524: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6525: }
1.962 droeschl 6526: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
6527: $result .= Apache::lonxml::display_title();
1.319 albertel 6528: }
1.436 albertel 6529: if (!$args->{'no_nav_bar'}
6530: && !$args->{'only_body'}
6531: && !$args->{'frameset'}) {
6532: $result .= &help_menu_js();
6533: }
1.319 albertel 6534:
1.314 albertel 6535: if (ref($args->{'redirect'})) {
1.414 albertel 6536: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6537: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6538: if (!$inhibit_continue) {
6539: $env{'internal.head.redirect'} = $url;
6540: }
1.313 albertel 6541: $result.=<<ADDMETA
6542: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6543: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6544: ADDMETA
6545: }
1.306 albertel 6546: if (!defined($title)) {
6547: $title = 'The LearningOnline Network with CAPA';
6548: }
1.460 albertel 6549: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6550: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6551: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6552: .$head_extra;
1.962 droeschl 6553: return $result.'</head>';
1.306 albertel 6554: }
6555:
6556: =pod
6557:
1.340 albertel 6558: =item * &font_settings()
6559:
6560: Returns neccessary <meta> to set the proper encoding
6561:
6562: Inputs: none
6563:
6564: =cut
6565:
6566: sub font_settings {
6567: my $headerstring='';
1.647 www 6568: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6569: $headerstring.=
6570: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6571: }
6572: return $headerstring;
6573: }
6574:
1.341 albertel 6575: =pod
6576:
6577: =item * &xml_begin()
6578:
6579: Returns the needed doctype and <html>
6580:
6581: Inputs: none
6582:
6583: =cut
6584:
6585: sub xml_begin {
6586: my $output='';
6587:
1.592 albertel 6588: if ($env{'internal.start_page'}==1) {
6589: &Apache::lonhtmlcommon::init_htmlareafields();
6590: }
1.342 albertel 6591:
1.341 albertel 6592: if ($env{'browser.mathml'}) {
6593: $output='<?xml version="1.0"?>'
6594: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6595: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6596:
6597: # .'<!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">] >'
6598: .'<!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">'
6599: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6600: .'xmlns="http://www.w3.org/1999/xhtml">';
6601: } else {
1.849 bisitz 6602: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6603: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6604: }
6605: return $output;
6606: }
1.340 albertel 6607:
6608: =pod
6609:
1.306 albertel 6610: =item * &start_page()
6611:
6612: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6613:
1.648 raeburn 6614: Inputs:
6615:
6616: =over 4
6617:
6618: $title - optional title for the page
6619:
6620: $head_extra - optional extra HTML to incude inside the <head>
6621:
6622: $args - additional optional args supported are:
6623:
6624: =over 8
6625:
6626: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6627: arg on
1.814 bisitz 6628: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6629: add_entries -> additional attributes to add to the <body>
6630: domain -> force to color decorate a page for a
1.317 albertel 6631: specific domain
1.648 raeburn 6632: function -> force usage of a specific rolish color
1.317 albertel 6633: scheme
1.648 raeburn 6634: redirect -> see &headtag()
6635: bgcolor -> override the default page bg color
6636: js_ready -> return a string ready for being used in
1.317 albertel 6637: a javascript writeln
1.648 raeburn 6638: html_encode -> return a string ready for being used in
1.320 albertel 6639: a html attribute
1.648 raeburn 6640: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6641: $forcereg arg
1.648 raeburn 6642: frameset -> if true will start with a <frameset>
1.330 albertel 6643: rather than <body>
1.648 raeburn 6644: skip_phases -> hash ref of
1.338 albertel 6645: head -> skip the <html><head> generation
6646: body -> skip all <body> generation
1.648 raeburn 6647: no_auto_mt_title -> prevent &mt()ing the title arg
6648: inherit_jsmath -> when creating popup window in a page,
6649: should it have jsmath forced on by the
6650: current page
1.867 kalberla 6651: bread_crumbs -> Array containing breadcrumbs
6652: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6653:
1.648 raeburn 6654: =back
1.460 albertel 6655:
1.648 raeburn 6656: =back
1.562 albertel 6657:
1.306 albertel 6658: =cut
6659:
6660: sub start_page {
1.309 albertel 6661: my ($title,$head_extra,$args) = @_;
1.318 albertel 6662: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964 droeschl 6663: #SD
6664: #I don't see why we copy certain elements of %$args to %head_args
6665: #head args is passed to headtag() and this routine only reads those
6666: #keys that are needed. There doesn't happen any writes or any processing
6667: #of other keys.
6668: #proposal: just pass $args to headtag instead of \%head_args and delete
6669: #marked lines
6670: #<- MARK
1.313 albertel 6671: my %head_args;
1.352 albertel 6672: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6673: 'bgcolor','frameset','no_nav_bar','only_body',
6674: 'no_auto_mt_title') {
1.319 albertel 6675: if (defined($args->{$arg})) {
1.324 raeburn 6676: $head_args{$arg} = $args->{$arg};
1.319 albertel 6677: }
1.313 albertel 6678: }
1.964 droeschl 6679: #MARK ->
1.319 albertel 6680:
1.315 albertel 6681: $env{'internal.start_page'}++;
1.338 albertel 6682: my $result;
1.964 droeschl 6683:
1.338 albertel 6684: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964 droeschl 6685: $result .=
6686: &xml_begin() . &headtag($title,$head_extra,\%head_args);
6687: #replace prev line by
6688: # &xml_begin() . &headtag($title, $head_extra, $args);
1.338 albertel 6689: }
6690:
6691: if (! exists($args->{'skip_phases'}{'body'}) ) {
6692: if ($args->{'frameset'}) {
6693: my $attr_string = &make_attr_string($args->{'force_register'},
6694: $args->{'add_entries'});
6695: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6696: } else {
6697: $result .=
6698: &bodytag($title,
6699: $args->{'function'}, $args->{'add_entries'},
6700: $args->{'only_body'}, $args->{'domain'},
6701: $args->{'force_register'}, $args->{'no_nav_bar'},
1.962 droeschl 6702: $args->{'bgcolor'}, $args);
1.831 bisitz 6703: }
1.330 albertel 6704: }
1.338 albertel 6705:
1.315 albertel 6706: if ($args->{'js_ready'}) {
1.713 kaisler 6707: $result = &js_ready($result);
1.315 albertel 6708: }
1.320 albertel 6709: if ($args->{'html_encode'}) {
1.713 kaisler 6710: $result = &html_encode($result);
6711: }
6712:
1.813 bisitz 6713: # Preparation for new and consistent functionlist at top of screen
6714: # if ($args->{'functionlist'}) {
6715: # $result .= &build_functionlist();
6716: #}
6717:
1.964 droeschl 6718: # Don't add anything more if only_body wanted or in const space
6719: return $result if $args->{'only_body'}
6720: || $env{'request.state'} eq 'construct';
1.813 bisitz 6721:
6722: #Breadcrumbs
1.758 kaisler 6723: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6724: &Apache::lonhtmlcommon::clear_breadcrumbs();
6725: #if any br links exists, add them to the breadcrumbs
6726: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6727: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6728: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6729: }
6730: }
6731:
6732: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6733: if(exists($args->{'bread_crumbs_component'})){
6734: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6735: }else{
6736: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6737: }
1.320 albertel 6738: }
1.315 albertel 6739: return $result;
1.306 albertel 6740: }
6741:
6742: sub end_page {
1.315 albertel 6743: my ($args) = @_;
6744: $env{'internal.end_page'}++;
1.330 albertel 6745: my $result;
1.335 albertel 6746: if ($args->{'discussion'}) {
6747: my ($target,$parser);
6748: if (ref($args->{'discussion'})) {
6749: ($target,$parser) =($args->{'discussion'}{'target'},
6750: $args->{'discussion'}{'parser'});
6751: }
6752: $result .= &Apache::lonxml::xmlend($target,$parser);
6753: }
6754:
1.330 albertel 6755: if ($args->{'frameset'}) {
6756: $result .= '</frameset>';
6757: } else {
1.635 raeburn 6758: $result .= &endbodytag($args);
1.330 albertel 6759: }
6760: $result .= "\n</html>";
6761:
1.315 albertel 6762: if ($args->{'js_ready'}) {
1.317 albertel 6763: $result = &js_ready($result);
1.315 albertel 6764: }
1.335 albertel 6765:
1.320 albertel 6766: if ($args->{'html_encode'}) {
6767: $result = &html_encode($result);
6768: }
1.335 albertel 6769:
1.315 albertel 6770: return $result;
6771: }
6772:
1.320 albertel 6773: sub html_encode {
6774: my ($result) = @_;
6775:
1.322 albertel 6776: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6777:
6778: return $result;
6779: }
1.317 albertel 6780: sub js_ready {
6781: my ($result) = @_;
6782:
1.323 albertel 6783: $result =~ s/[\n\r]/ /xmsg;
6784: $result =~ s/\\/\\\\/xmsg;
6785: $result =~ s/'/\\'/xmsg;
1.372 albertel 6786: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6787:
6788: return $result;
6789: }
6790:
1.315 albertel 6791: sub validate_page {
6792: if ( exists($env{'internal.start_page'})
1.316 albertel 6793: && $env{'internal.start_page'} > 1) {
6794: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6795: $env{'internal.start_page'}.' '.
1.316 albertel 6796: $ENV{'request.filename'});
1.315 albertel 6797: }
6798: if ( exists($env{'internal.end_page'})
1.316 albertel 6799: && $env{'internal.end_page'} > 1) {
6800: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6801: $env{'internal.end_page'}.' '.
1.316 albertel 6802: $env{'request.filename'});
1.315 albertel 6803: }
6804: if ( exists($env{'internal.start_page'})
6805: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6806: &Apache::lonnet::logthis('start_page called without end_page '.
6807: $env{'request.filename'});
1.315 albertel 6808: }
6809: if ( ! exists($env{'internal.start_page'})
6810: && exists($env{'internal.end_page'})) {
1.316 albertel 6811: &Apache::lonnet::logthis('end_page called without start_page'.
6812: $env{'request.filename'});
1.315 albertel 6813: }
1.306 albertel 6814: }
1.315 albertel 6815:
1.318 albertel 6816: sub simple_error_page {
6817: my ($r,$title,$msg) = @_;
6818: my $page =
6819: &Apache::loncommon::start_page($title).
6820: &mt($msg).
6821: &Apache::loncommon::end_page();
6822: if (ref($r)) {
6823: $r->print($page);
1.327 albertel 6824: return;
1.318 albertel 6825: }
6826: return $page;
6827: }
1.347 albertel 6828:
6829: {
1.610 albertel 6830: my @row_count;
1.961 onken 6831:
6832: sub start_data_table_count {
6833: unshift(@row_count, 0);
6834: return;
6835: }
6836:
6837: sub end_data_table_count {
6838: shift(@row_count);
6839: return;
6840: }
6841:
1.347 albertel 6842: sub start_data_table {
1.422 albertel 6843: my ($add_class) = @_;
6844: my $css_class = (join(' ','LC_data_table',$add_class));
1.961 onken 6845: &start_data_table_count();
1.422 albertel 6846: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6847: }
6848:
6849: sub end_data_table {
1.961 onken 6850: &end_data_table_count();
1.389 albertel 6851: return '</table>'."\n";;
1.347 albertel 6852: }
6853:
6854: sub start_data_table_row {
1.422 albertel 6855: my ($add_class) = @_;
1.610 albertel 6856: $row_count[0]++;
6857: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6858: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6859: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6860: }
1.471 banghart 6861:
6862: sub continue_data_table_row {
6863: my ($add_class) = @_;
1.610 albertel 6864: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6865: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6866: return '<tr class="'.$css_class.'">'."\n";;
6867: }
1.347 albertel 6868:
6869: sub end_data_table_row {
1.389 albertel 6870: return '</tr>'."\n";;
1.347 albertel 6871: }
1.367 www 6872:
1.421 albertel 6873: sub start_data_table_empty_row {
1.707 bisitz 6874: # $row_count[0]++;
1.421 albertel 6875: return '<tr class="LC_empty_row" >'."\n";;
6876: }
6877:
6878: sub end_data_table_empty_row {
6879: return '</tr>'."\n";;
6880: }
6881:
1.367 www 6882: sub start_data_table_header_row {
1.389 albertel 6883: return '<tr class="LC_header_row">'."\n";;
1.367 www 6884: }
6885:
6886: sub end_data_table_header_row {
1.389 albertel 6887: return '</tr>'."\n";;
1.367 www 6888: }
1.890 droeschl 6889:
6890: sub data_table_caption {
6891: my $caption = shift;
6892: return "<caption class=\"LC_caption\">$caption</caption>";
6893: }
1.347 albertel 6894: }
6895:
1.548 albertel 6896: =pod
6897:
6898: =item * &inhibit_menu_check($arg)
6899:
6900: Checks for a inhibitmenu state and generates output to preserve it
6901:
6902: Inputs: $arg - can be any of
6903: - undef - in which case the return value is a string
6904: to add into arguments list of a uri
6905: - 'input' - in which case the return value is a HTML
6906: <form> <input> field of type hidden to
6907: preserve the value
6908: - a url - in which case the return value is the url with
6909: the neccesary cgi args added to preserve the
6910: inhibitmenu state
6911: - a ref to a url - no return value, but the string is
6912: updated to include the neccessary cgi
6913: args to preserve the inhibitmenu state
6914:
6915: =cut
6916:
6917: sub inhibit_menu_check {
6918: my ($arg) = @_;
6919: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6920: if ($arg eq 'input') {
6921: if ($env{'form.inhibitmenu'}) {
6922: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6923: } else {
6924: return
6925: }
6926: }
6927: if ($env{'form.inhibitmenu'}) {
6928: if (ref($arg)) {
6929: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6930: } elsif ($arg eq '') {
6931: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6932: } else {
6933: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6934: }
6935: }
6936: if (!ref($arg)) {
6937: return $arg;
6938: }
6939: }
6940:
1.251 albertel 6941: ###############################################
1.182 matthew 6942:
6943: =pod
6944:
1.549 albertel 6945: =back
6946:
6947: =head1 User Information Routines
6948:
6949: =over 4
6950:
1.405 albertel 6951: =item * &get_users_function()
1.182 matthew 6952:
6953: Used by &bodytag to determine the current users primary role.
6954: Returns either 'student','coordinator','admin', or 'author'.
6955:
6956: =cut
6957:
6958: ###############################################
6959: sub get_users_function {
1.815 tempelho 6960: my $function = 'norole';
1.818 tempelho 6961: if ($env{'request.role'}=~/^(st)/) {
6962: $function='student';
6963: }
1.907 raeburn 6964: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 6965: $function='coordinator';
6966: }
1.258 albertel 6967: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6968: $function='admin';
6969: }
1.826 bisitz 6970: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6971: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6972: $function='author';
6973: }
6974: return $function;
1.54 www 6975: }
1.99 www 6976:
6977: ###############################################
6978:
1.233 raeburn 6979: =pod
6980:
1.821 raeburn 6981: =item * &show_course()
6982:
6983: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6984: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6985:
6986: Inputs:
6987: None
6988:
6989: Outputs:
6990: Scalar: 1 if 'Course' to be used, 0 otherwise.
6991:
6992: =cut
6993:
6994: ###############################################
6995: sub show_course {
6996: my $course = !$env{'user.adv'};
6997: if (!$env{'user.adv'}) {
6998: foreach my $env (keys(%env)) {
6999: next if ($env !~ m/^user\.priv\./);
7000: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7001: $course = 0;
7002: last;
7003: }
7004: }
7005: }
7006: return $course;
7007: }
7008:
7009: ###############################################
7010:
7011: =pod
7012:
1.542 raeburn 7013: =item * &check_user_status()
1.274 raeburn 7014:
7015: Determines current status of supplied role for a
7016: specific user. Roles can be active, previous or future.
7017:
7018: Inputs:
7019: user's domain, user's username, course's domain,
1.375 raeburn 7020: course's number, optional section ID.
1.274 raeburn 7021:
7022: Outputs:
7023: role status: active, previous or future.
7024:
7025: =cut
7026:
7027: sub check_user_status {
1.412 raeburn 7028: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7029: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7030: my @uroles = keys %userinfo;
7031: my $srchstr;
7032: my $active_chk = 'none';
1.412 raeburn 7033: my $now = time;
1.274 raeburn 7034: if (@uroles > 0) {
1.908 raeburn 7035: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7036: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7037: } else {
1.412 raeburn 7038: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7039: }
7040: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7041: my $role_end = 0;
7042: my $role_start = 0;
7043: $active_chk = 'active';
1.412 raeburn 7044: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7045: $role_end = $1;
7046: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7047: $role_start = $1;
1.274 raeburn 7048: }
7049: }
7050: if ($role_start > 0) {
1.412 raeburn 7051: if ($now < $role_start) {
1.274 raeburn 7052: $active_chk = 'future';
7053: }
7054: }
7055: if ($role_end > 0) {
1.412 raeburn 7056: if ($now > $role_end) {
1.274 raeburn 7057: $active_chk = 'previous';
7058: }
7059: }
7060: }
7061: }
7062: return $active_chk;
7063: }
7064:
7065: ###############################################
7066:
7067: =pod
7068:
1.405 albertel 7069: =item * &get_sections()
1.233 raeburn 7070:
7071: Determines all the sections for a course including
7072: sections with students and sections containing other roles.
1.419 raeburn 7073: Incoming parameters:
7074:
7075: 1. domain
7076: 2. course number
7077: 3. reference to array containing roles for which sections should
7078: be gathered (optional).
7079: 4. reference to array containing status types for which sections
7080: should be gathered (optional).
7081:
7082: If the third argument is undefined, sections are gathered for any role.
7083: If the fourth argument is undefined, sections are gathered for any status.
7084: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7085:
1.374 raeburn 7086: Returns section hash (keys are section IDs, values are
7087: number of users in each section), subject to the
1.419 raeburn 7088: optional roles filter, optional status filter
1.233 raeburn 7089:
7090: =cut
7091:
7092: ###############################################
7093: sub get_sections {
1.419 raeburn 7094: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7095: if (!defined($cdom) || !defined($cnum)) {
7096: my $cid = $env{'request.course.id'};
7097:
7098: return if (!defined($cid));
7099:
7100: $cdom = $env{'course.'.$cid.'.domain'};
7101: $cnum = $env{'course.'.$cid.'.num'};
7102: }
7103:
7104: my %sectioncount;
1.419 raeburn 7105: my $now = time;
1.240 albertel 7106:
1.366 albertel 7107: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7108: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7109: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7110: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7111: my $start_index = &Apache::loncoursedata::CL_START();
7112: my $end_index = &Apache::loncoursedata::CL_END();
7113: my $status;
1.366 albertel 7114: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7115: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7116: $data->[$status_index],
7117: $data->[$start_index],
7118: $data->[$end_index]);
7119: if ($stu_status eq 'Active') {
7120: $status = 'active';
7121: } elsif ($end < $now) {
7122: $status = 'previous';
7123: } elsif ($start > $now) {
7124: $status = 'future';
7125: }
7126: if ($section ne '-1' && $section !~ /^\s*$/) {
7127: if ((!defined($possible_status)) || (($status ne '') &&
7128: (grep/^\Q$status\E$/,@{$possible_status}))) {
7129: $sectioncount{$section}++;
7130: }
1.240 albertel 7131: }
7132: }
7133: }
7134: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7135: foreach my $user (sort(keys(%courseroles))) {
7136: if ($user !~ /^(\w{2})/) { next; }
7137: my ($role) = ($user =~ /^(\w{2})/);
7138: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7139: my ($section,$status);
1.240 albertel 7140: if ($role eq 'cr' &&
7141: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7142: $section=$1;
7143: }
7144: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7145: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7146: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7147: if ($end == -1 && $start == -1) {
7148: next; #deleted role
7149: }
7150: if (!defined($possible_status)) {
7151: $sectioncount{$section}++;
7152: } else {
7153: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7154: $status = 'active';
7155: } elsif ($end < $now) {
7156: $status = 'future';
7157: } elsif ($start > $now) {
7158: $status = 'previous';
7159: }
7160: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7161: $sectioncount{$section}++;
7162: }
7163: }
1.233 raeburn 7164: }
1.366 albertel 7165: return %sectioncount;
1.233 raeburn 7166: }
7167:
1.274 raeburn 7168: ###############################################
1.294 raeburn 7169:
7170: =pod
1.405 albertel 7171:
7172: =item * &get_course_users()
7173:
1.275 raeburn 7174: Retrieves usernames:domains for users in the specified course
7175: with specific role(s), and access status.
7176:
7177: Incoming parameters:
1.277 albertel 7178: 1. course domain
7179: 2. course number
7180: 3. access status: users must have - either active,
1.275 raeburn 7181: previous, future, or all.
1.277 albertel 7182: 4. reference to array of permissible roles
1.288 raeburn 7183: 5. reference to array of section restrictions (optional)
7184: 6. reference to results object (hash of hashes).
7185: 7. reference to optional userdata hash
1.609 raeburn 7186: 8. reference to optional statushash
1.630 raeburn 7187: 9. flag if privileged users (except those set to unhide in
7188: course settings) should be excluded
1.609 raeburn 7189: Keys of top level results hash are roles.
1.275 raeburn 7190: Keys of inner hashes are username:domain, with
7191: values set to access type.
1.288 raeburn 7192: Optional userdata hash returns an array with arguments in the
7193: same order as loncoursedata::get_classlist() for student data.
7194:
1.609 raeburn 7195: Optional statushash returns
7196:
1.288 raeburn 7197: Entries for end, start, section and status are blank because
7198: of the possibility of multiple values for non-student roles.
7199:
1.275 raeburn 7200: =cut
1.405 albertel 7201:
1.275 raeburn 7202: ###############################################
1.405 albertel 7203:
1.275 raeburn 7204: sub get_course_users {
1.630 raeburn 7205: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7206: my %idx = ();
1.419 raeburn 7207: my %seclists;
1.288 raeburn 7208:
7209: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7210: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7211: $idx{end} = &Apache::loncoursedata::CL_END();
7212: $idx{start} = &Apache::loncoursedata::CL_START();
7213: $idx{id} = &Apache::loncoursedata::CL_ID();
7214: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7215: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7216: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7217:
1.290 albertel 7218: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7219: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7220: my $now = time;
1.277 albertel 7221: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7222: my $match = 0;
1.412 raeburn 7223: my $secmatch = 0;
1.419 raeburn 7224: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7225: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7226: if ($section eq '') {
7227: $section = 'none';
7228: }
1.291 albertel 7229: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7230: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7231: $secmatch = 1;
7232: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7233: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7234: $secmatch = 1;
7235: }
7236: } else {
1.419 raeburn 7237: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7238: $secmatch = 1;
7239: }
1.290 albertel 7240: }
1.412 raeburn 7241: if (!$secmatch) {
7242: next;
7243: }
1.419 raeburn 7244: }
1.275 raeburn 7245: if (defined($$types{'active'})) {
1.288 raeburn 7246: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7247: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7248: $match = 1;
1.275 raeburn 7249: }
7250: }
7251: if (defined($$types{'previous'})) {
1.609 raeburn 7252: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7253: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7254: $match = 1;
1.275 raeburn 7255: }
7256: }
7257: if (defined($$types{'future'})) {
1.609 raeburn 7258: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7259: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7260: $match = 1;
1.275 raeburn 7261: }
7262: }
1.609 raeburn 7263: if ($match) {
7264: push(@{$seclists{$student}},$section);
7265: if (ref($userdata) eq 'HASH') {
7266: $$userdata{$student} = $$classlist{$student};
7267: }
7268: if (ref($statushash) eq 'HASH') {
7269: $statushash->{$student}{'st'}{$section} = $status;
7270: }
1.288 raeburn 7271: }
1.275 raeburn 7272: }
7273: }
1.412 raeburn 7274: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7275: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7276: my $now = time;
1.609 raeburn 7277: my %displaystatus = ( previous => 'Expired',
7278: active => 'Active',
7279: future => 'Future',
7280: );
1.630 raeburn 7281: my %nothide;
7282: if ($hidepriv) {
7283: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7284: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7285: if ($user !~ /:/) {
7286: $nothide{join(':',split(/[\@]/,$user))}=1;
7287: } else {
7288: $nothide{$user} = 1;
7289: }
7290: }
7291: }
1.439 raeburn 7292: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7293: my $match = 0;
1.412 raeburn 7294: my $secmatch = 0;
1.439 raeburn 7295: my $status;
1.412 raeburn 7296: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7297: $user =~ s/:$//;
1.439 raeburn 7298: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7299: if ($end == -1 || $start == -1) {
7300: next;
7301: }
7302: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7303: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7304: my ($uname,$udom) = split(/:/,$user);
7305: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7306: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7307: $secmatch = 1;
7308: } elsif ($usec eq '') {
1.420 albertel 7309: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7310: $secmatch = 1;
7311: }
7312: } else {
7313: if (grep(/^\Q$usec\E$/,@{$sections})) {
7314: $secmatch = 1;
7315: }
7316: }
7317: if (!$secmatch) {
7318: next;
7319: }
1.288 raeburn 7320: }
1.419 raeburn 7321: if ($usec eq '') {
7322: $usec = 'none';
7323: }
1.275 raeburn 7324: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7325: if ($hidepriv) {
7326: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7327: (!$nothide{$uname.':'.$udom})) {
7328: next;
7329: }
7330: }
1.503 raeburn 7331: if ($end > 0 && $end < $now) {
1.439 raeburn 7332: $status = 'previous';
7333: } elsif ($start > $now) {
7334: $status = 'future';
7335: } else {
7336: $status = 'active';
7337: }
1.277 albertel 7338: foreach my $type (keys(%{$types})) {
1.275 raeburn 7339: if ($status eq $type) {
1.420 albertel 7340: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7341: push(@{$$users{$role}{$user}},$type);
7342: }
1.288 raeburn 7343: $match = 1;
7344: }
7345: }
1.419 raeburn 7346: if (($match) && (ref($userdata) eq 'HASH')) {
7347: if (!exists($$userdata{$uname.':'.$udom})) {
7348: &get_user_info($udom,$uname,\%idx,$userdata);
7349: }
1.420 albertel 7350: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7351: push(@{$seclists{$uname.':'.$udom}},$usec);
7352: }
1.609 raeburn 7353: if (ref($statushash) eq 'HASH') {
7354: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7355: }
1.275 raeburn 7356: }
7357: }
7358: }
7359: }
1.290 albertel 7360: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7361: if ((defined($cdom)) && (defined($cnum))) {
7362: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7363: if ( defined($csettings{'internal.courseowner'}) ) {
7364: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7365: next if ($owner eq '');
7366: my ($ownername,$ownerdom);
7367: if ($owner =~ /^([^:]+):([^:]+)$/) {
7368: $ownername = $1;
7369: $ownerdom = $2;
7370: } else {
7371: $ownername = $owner;
7372: $ownerdom = $cdom;
7373: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7374: }
7375: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7376: if (defined($userdata) &&
1.609 raeburn 7377: !exists($$userdata{$owner})) {
7378: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7379: if (!grep(/^none$/,@{$seclists{$owner}})) {
7380: push(@{$seclists{$owner}},'none');
7381: }
7382: if (ref($statushash) eq 'HASH') {
7383: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7384: }
1.290 albertel 7385: }
1.279 raeburn 7386: }
7387: }
7388: }
1.419 raeburn 7389: foreach my $user (keys(%seclists)) {
7390: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7391: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7392: }
1.275 raeburn 7393: }
7394: return;
7395: }
7396:
1.288 raeburn 7397: sub get_user_info {
7398: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7399: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7400: &plainname($uname,$udom,'lastname');
1.291 albertel 7401: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7402: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7403: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7404: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7405: return;
7406: }
1.275 raeburn 7407:
1.472 raeburn 7408: ###############################################
7409:
7410: =pod
7411:
7412: =item * &get_user_quota()
7413:
7414: Retrieves quota assigned for storage of portfolio files for a user
7415:
7416: Incoming parameters:
7417: 1. user's username
7418: 2. user's domain
7419:
7420: Returns:
1.536 raeburn 7421: 1. Disk quota (in Mb) assigned to student.
7422: 2. (Optional) Type of setting: custom or default
7423: (individually assigned or default for user's
7424: institutional status).
7425: 3. (Optional) - User's institutional status (e.g., faculty, staff
7426: or student - types as defined in localenroll::inst_usertypes
7427: for user's domain, which determines default quota for user.
7428: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7429:
7430: If a value has been stored in the user's environment,
1.536 raeburn 7431: it will return that, otherwise it returns the maximal default
7432: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7433:
7434: =cut
7435:
7436: ###############################################
7437:
7438:
7439: sub get_user_quota {
7440: my ($uname,$udom) = @_;
1.536 raeburn 7441: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7442: if (!defined($udom)) {
7443: $udom = $env{'user.domain'};
7444: }
7445: if (!defined($uname)) {
7446: $uname = $env{'user.name'};
7447: }
7448: if (($udom eq '' || $uname eq '') ||
7449: ($udom eq 'public') && ($uname eq 'public')) {
7450: $quota = 0;
1.536 raeburn 7451: $quotatype = 'default';
7452: $defquota = 0;
1.472 raeburn 7453: } else {
1.536 raeburn 7454: my $inststatus;
1.472 raeburn 7455: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7456: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7457: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7458: } else {
1.536 raeburn 7459: my %userenv =
7460: &Apache::lonnet::get('environment',['portfolioquota',
7461: 'inststatus'],$udom,$uname);
1.472 raeburn 7462: my ($tmp) = keys(%userenv);
7463: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7464: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7465: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7466: } else {
7467: undef(%userenv);
7468: }
7469: }
1.536 raeburn 7470: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7471: if ($quota eq '') {
1.536 raeburn 7472: $quota = $defquota;
7473: $quotatype = 'default';
7474: } else {
7475: $quotatype = 'custom';
1.472 raeburn 7476: }
7477: }
1.536 raeburn 7478: if (wantarray) {
7479: return ($quota,$quotatype,$settingstatus,$defquota);
7480: } else {
7481: return $quota;
7482: }
1.472 raeburn 7483: }
7484:
7485: ###############################################
7486:
7487: =pod
7488:
7489: =item * &default_quota()
7490:
1.536 raeburn 7491: Retrieves default quota assigned for storage of user portfolio files,
7492: given an (optional) user's institutional status.
1.472 raeburn 7493:
7494: Incoming parameters:
7495: 1. domain
1.536 raeburn 7496: 2. (Optional) institutional status(es). This is a : separated list of
7497: status types (e.g., faculty, staff, student etc.)
7498: which apply to the user for whom the default is being retrieved.
7499: If the institutional status string in undefined, the domain
7500: default quota will be returned.
1.472 raeburn 7501:
7502: Returns:
7503: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7504: 2. (Optional) institutional type which determined the value of the
7505: default quota.
1.472 raeburn 7506:
7507: If a value has been stored in the domain's configuration db,
7508: it will return that, otherwise it returns 20 (for backwards
7509: compatibility with domains which have not set up a configuration
7510: db file; the original statically defined portfolio quota was 20 Mb).
7511:
1.536 raeburn 7512: If the user's status includes multiple types (e.g., staff and student),
7513: the largest default quota which applies to the user determines the
7514: default quota returned.
7515:
1.780 raeburn 7516: =back
7517:
1.472 raeburn 7518: =cut
7519:
7520: ###############################################
7521:
7522:
7523: sub default_quota {
1.536 raeburn 7524: my ($udom,$inststatus) = @_;
7525: my ($defquota,$settingstatus);
7526: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7527: ['quotas'],$udom);
7528: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7529: if ($inststatus ne '') {
1.765 raeburn 7530: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7531: foreach my $item (@statuses) {
1.711 raeburn 7532: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7533: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7534: if ($defquota eq '') {
7535: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7536: $settingstatus = $item;
7537: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7538: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7539: $settingstatus = $item;
7540: }
7541: }
7542: } else {
7543: if ($quotahash{'quotas'}{$item} ne '') {
7544: if ($defquota eq '') {
7545: $defquota = $quotahash{'quotas'}{$item};
7546: $settingstatus = $item;
7547: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7548: $defquota = $quotahash{'quotas'}{$item};
7549: $settingstatus = $item;
7550: }
1.536 raeburn 7551: }
7552: }
7553: }
7554: }
7555: if ($defquota eq '') {
1.711 raeburn 7556: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7557: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7558: } else {
7559: $defquota = $quotahash{'quotas'}{'default'};
7560: }
1.536 raeburn 7561: $settingstatus = 'default';
7562: }
7563: } else {
7564: $settingstatus = 'default';
7565: $defquota = 20;
7566: }
7567: if (wantarray) {
7568: return ($defquota,$settingstatus);
1.472 raeburn 7569: } else {
1.536 raeburn 7570: return $defquota;
1.472 raeburn 7571: }
7572: }
7573:
1.384 raeburn 7574: sub get_secgrprole_info {
7575: my ($cdom,$cnum,$needroles,$type) = @_;
7576: my %sections_count = &get_sections($cdom,$cnum);
7577: my @sections = (sort {$a <=> $b} keys(%sections_count));
7578: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7579: my @groups = sort(keys(%curr_groups));
7580: my $allroles = [];
7581: my $rolehash;
7582: my $accesshash = {
7583: active => 'Currently has access',
7584: future => 'Will have future access',
7585: previous => 'Previously had access',
7586: };
7587: if ($needroles) {
7588: $rolehash = {'all' => 'all'};
1.385 albertel 7589: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7590: if (&Apache::lonnet::error(%user_roles)) {
7591: undef(%user_roles);
7592: }
7593: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7594: my ($role)=split(/\:/,$item,2);
7595: if ($role eq 'cr') { next; }
7596: if ($role =~ /^cr/) {
7597: $$rolehash{$role} = (split('/',$role))[3];
7598: } else {
7599: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7600: }
7601: }
7602: foreach my $key (sort(keys(%{$rolehash}))) {
7603: push(@{$allroles},$key);
7604: }
7605: push (@{$allroles},'st');
7606: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7607: }
7608: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7609: }
7610:
1.555 raeburn 7611: sub user_picker {
1.627 raeburn 7612: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7613: my $currdom = $dom;
7614: my %curr_selected = (
7615: srchin => 'dom',
1.580 raeburn 7616: srchby => 'lastname',
1.555 raeburn 7617: );
7618: my $srchterm;
1.625 raeburn 7619: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7620: if ($srch->{'srchby'} ne '') {
7621: $curr_selected{'srchby'} = $srch->{'srchby'};
7622: }
7623: if ($srch->{'srchin'} ne '') {
7624: $curr_selected{'srchin'} = $srch->{'srchin'};
7625: }
7626: if ($srch->{'srchtype'} ne '') {
7627: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7628: }
7629: if ($srch->{'srchdomain'} ne '') {
7630: $currdom = $srch->{'srchdomain'};
7631: }
7632: $srchterm = $srch->{'srchterm'};
7633: }
7634: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7635: 'usr' => 'Search criteria',
1.563 raeburn 7636: 'doma' => 'Domain/institution to search',
1.558 albertel 7637: 'uname' => 'username',
7638: 'lastname' => 'last name',
1.555 raeburn 7639: 'lastfirst' => 'last name, first name',
1.558 albertel 7640: 'crs' => 'in this course',
1.576 raeburn 7641: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7642: 'alc' => 'all LON-CAPA',
1.573 raeburn 7643: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7644: 'exact' => 'is',
7645: 'contains' => 'contains',
1.569 raeburn 7646: 'begins' => 'begins with',
1.571 raeburn 7647: 'youm' => "You must include some text to search for.",
7648: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7649: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7650: 'yomc' => "You must choose a domain when using an institutional directory search.",
7651: 'ymcd' => "You must choose a domain when using a domain search.",
7652: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7653: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7654: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7655: );
1.563 raeburn 7656: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7657: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7658:
7659: my @srchins = ('crs','dom','alc','instd');
7660:
7661: foreach my $option (@srchins) {
7662: # FIXME 'alc' option unavailable until
7663: # loncreateuser::print_user_query_page()
7664: # has been completed.
7665: next if ($option eq 'alc');
1.880 raeburn 7666: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7667: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7668: if ($curr_selected{'srchin'} eq $option) {
7669: $srchinsel .= '
7670: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7671: } else {
7672: $srchinsel .= '
7673: <option value="'.$option.'">'.$lt{$option}.'</option>';
7674: }
1.555 raeburn 7675: }
1.563 raeburn 7676: $srchinsel .= "\n </select>\n";
1.555 raeburn 7677:
7678: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7679: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7680: if ($curr_selected{'srchby'} eq $option) {
7681: $srchbysel .= '
7682: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7683: } else {
7684: $srchbysel .= '
7685: <option value="'.$option.'">'.$lt{$option}.'</option>';
7686: }
7687: }
7688: $srchbysel .= "\n </select>\n";
7689:
7690: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7691: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7692: if ($curr_selected{'srchtype'} eq $option) {
7693: $srchtypesel .= '
7694: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7695: } else {
7696: $srchtypesel .= '
7697: <option value="'.$option.'">'.$lt{$option}.'</option>';
7698: }
7699: }
7700: $srchtypesel .= "\n </select>\n";
7701:
1.558 albertel 7702: my ($newuserscript,$new_user_create);
1.556 raeburn 7703:
7704: if ($forcenewuser) {
1.576 raeburn 7705: if (ref($srch) eq 'HASH') {
7706: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7707: if ($cancreate) {
7708: $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>';
7709: } else {
1.799 bisitz 7710: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7711: my %usertypetext = (
7712: official => 'institutional',
7713: unofficial => 'non-institutional',
7714: );
1.799 bisitz 7715: $new_user_create = '<p class="LC_warning">'
7716: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7717: .' '
7718: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7719: ,'<a href="'.$helplink.'">','</a>')
7720: .'</p><br />';
1.627 raeburn 7721: }
1.576 raeburn 7722: }
7723: }
7724:
1.556 raeburn 7725: $newuserscript = <<"ENDSCRIPT";
7726:
1.570 raeburn 7727: function setSearch(createnew,callingForm) {
1.556 raeburn 7728: if (createnew == 1) {
1.570 raeburn 7729: for (var i=0; i<callingForm.srchby.length; i++) {
7730: if (callingForm.srchby.options[i].value == 'uname') {
7731: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7732: }
7733: }
1.570 raeburn 7734: for (var i=0; i<callingForm.srchin.length; i++) {
7735: if ( callingForm.srchin.options[i].value == 'dom') {
7736: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7737: }
7738: }
1.570 raeburn 7739: for (var i=0; i<callingForm.srchtype.length; i++) {
7740: if (callingForm.srchtype.options[i].value == 'exact') {
7741: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7742: }
7743: }
1.570 raeburn 7744: for (var i=0; i<callingForm.srchdomain.length; i++) {
7745: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7746: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7747: }
7748: }
7749: }
7750: }
7751: ENDSCRIPT
1.558 albertel 7752:
1.556 raeburn 7753: }
7754:
1.555 raeburn 7755: my $output = <<"END_BLOCK";
1.556 raeburn 7756: <script type="text/javascript">
1.824 bisitz 7757: // <![CDATA[
1.570 raeburn 7758: function validateEntry(callingForm) {
1.558 albertel 7759:
1.556 raeburn 7760: var checkok = 1;
1.558 albertel 7761: var srchin;
1.570 raeburn 7762: for (var i=0; i<callingForm.srchin.length; i++) {
7763: if ( callingForm.srchin[i].checked ) {
7764: srchin = callingForm.srchin[i].value;
1.558 albertel 7765: }
7766: }
7767:
1.570 raeburn 7768: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7769: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7770: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7771: var srchterm = callingForm.srchterm.value;
7772: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7773: var msg = "";
7774:
7775: if (srchterm == "") {
7776: checkok = 0;
1.571 raeburn 7777: msg += "$lt{'youm'}\\n";
1.556 raeburn 7778: }
7779:
1.569 raeburn 7780: if (srchtype== 'begins') {
7781: if (srchterm.length < 2) {
7782: checkok = 0;
1.571 raeburn 7783: msg += "$lt{'thte'}\\n";
1.569 raeburn 7784: }
7785: }
7786:
1.556 raeburn 7787: if (srchtype== 'contains') {
7788: if (srchterm.length < 3) {
7789: checkok = 0;
1.571 raeburn 7790: msg += "$lt{'thet'}\\n";
1.556 raeburn 7791: }
7792: }
7793: if (srchin == 'instd') {
7794: if (srchdomain == '') {
7795: checkok = 0;
1.571 raeburn 7796: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7797: }
7798: }
7799: if (srchin == 'dom') {
7800: if (srchdomain == '') {
7801: checkok = 0;
1.571 raeburn 7802: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7803: }
7804: }
7805: if (srchby == 'lastfirst') {
7806: if (srchterm.indexOf(",") == -1) {
7807: checkok = 0;
1.571 raeburn 7808: msg += "$lt{'whus'}\\n";
1.556 raeburn 7809: }
7810: if (srchterm.indexOf(",") == srchterm.length -1) {
7811: checkok = 0;
1.571 raeburn 7812: msg += "$lt{'whse'}\\n";
1.556 raeburn 7813: }
7814: }
7815: if (checkok == 0) {
1.571 raeburn 7816: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7817: return;
7818: }
7819: if (checkok == 1) {
1.570 raeburn 7820: callingForm.submit();
1.556 raeburn 7821: }
7822: }
7823:
7824: $newuserscript
7825:
1.824 bisitz 7826: // ]]>
1.556 raeburn 7827: </script>
1.558 albertel 7828:
7829: $new_user_create
7830:
1.555 raeburn 7831: END_BLOCK
1.558 albertel 7832:
1.876 raeburn 7833: $output .= &Apache::lonhtmlcommon::start_pick_box().
7834: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7835: $domform.
7836: &Apache::lonhtmlcommon::row_closure().
7837: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7838: $srchbysel.
7839: $srchtypesel.
7840: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7841: $srchinsel.
7842: &Apache::lonhtmlcommon::row_closure(1).
7843: &Apache::lonhtmlcommon::end_pick_box().
7844: '<br />';
1.555 raeburn 7845: return $output;
7846: }
7847:
1.612 raeburn 7848: sub user_rule_check {
1.615 raeburn 7849: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7850: my $response;
7851: if (ref($usershash) eq 'HASH') {
7852: foreach my $user (keys(%{$usershash})) {
7853: my ($uname,$udom) = split(/:/,$user);
7854: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7855: my ($id,$newuser);
1.612 raeburn 7856: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7857: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7858: $id = $usershash->{$user}->{'id'};
7859: }
7860: my $inst_response;
7861: if (ref($checks) eq 'HASH') {
7862: if (defined($checks->{'username'})) {
1.615 raeburn 7863: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7864: &Apache::lonnet::get_instuser($udom,$uname);
7865: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7866: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7867: &Apache::lonnet::get_instuser($udom,undef,$id);
7868: }
1.615 raeburn 7869: } else {
7870: ($inst_response,%{$inst_results->{$user}}) =
7871: &Apache::lonnet::get_instuser($udom,$uname);
7872: return;
1.612 raeburn 7873: }
1.615 raeburn 7874: if (!$got_rules->{$udom}) {
1.612 raeburn 7875: my %domconfig = &Apache::lonnet::get_dom('configuration',
7876: ['usercreation'],$udom);
7877: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7878: foreach my $item ('username','id') {
1.612 raeburn 7879: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7880: $$curr_rules{$udom}{$item} =
7881: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7882: }
7883: }
7884: }
1.615 raeburn 7885: $got_rules->{$udom} = 1;
1.585 raeburn 7886: }
1.612 raeburn 7887: foreach my $item (keys(%{$checks})) {
7888: if (ref($$curr_rules{$udom}) eq 'HASH') {
7889: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7890: if (@{$$curr_rules{$udom}{$item}} > 0) {
7891: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7892: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7893: if ($rule_check{$rule}) {
7894: $$rulematch{$user}{$item} = $rule;
7895: if ($inst_response eq 'ok') {
1.615 raeburn 7896: if (ref($inst_results) eq 'HASH') {
7897: if (ref($inst_results->{$user}) eq 'HASH') {
7898: if (keys(%{$inst_results->{$user}}) == 0) {
7899: $$alerts{$item}{$udom}{$uname} = 1;
7900: }
1.612 raeburn 7901: }
7902: }
1.615 raeburn 7903: }
7904: last;
1.585 raeburn 7905: }
7906: }
7907: }
7908: }
7909: }
7910: }
7911: }
7912: }
1.612 raeburn 7913: return;
7914: }
7915:
7916: sub user_rule_formats {
7917: my ($domain,$domdesc,$curr_rules,$check) = @_;
7918: my %text = (
7919: 'username' => 'Usernames',
7920: 'id' => 'IDs',
7921: );
7922: my $output;
7923: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7924: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7925: if (@{$ruleorder} > 0) {
7926: $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>';
7927: foreach my $rule (@{$ruleorder}) {
7928: if (ref($curr_rules) eq 'ARRAY') {
7929: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7930: if (ref($rules->{$rule}) eq 'HASH') {
7931: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7932: $rules->{$rule}{'desc'}.'</li>';
7933: }
7934: }
7935: }
7936: }
7937: $output .= '</ul>';
7938: }
7939: }
7940: return $output;
7941: }
7942:
7943: sub instrule_disallow_msg {
1.615 raeburn 7944: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7945: my $response;
7946: my %text = (
7947: item => 'username',
7948: items => 'usernames',
7949: match => 'matches',
7950: do => 'does',
7951: action => 'a username',
7952: one => 'one',
7953: );
7954: if ($count > 1) {
7955: $text{'item'} = 'usernames';
7956: $text{'match'} ='match';
7957: $text{'do'} = 'do';
7958: $text{'action'} = 'usernames',
7959: $text{'one'} = 'ones';
7960: }
7961: if ($checkitem eq 'id') {
7962: $text{'items'} = 'IDs';
7963: $text{'item'} = 'ID';
7964: $text{'action'} = 'an ID';
1.615 raeburn 7965: if ($count > 1) {
7966: $text{'item'} = 'IDs';
7967: $text{'action'} = 'IDs';
7968: }
1.612 raeburn 7969: }
1.674 bisitz 7970: $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 7971: if ($mode eq 'upload') {
7972: if ($checkitem eq 'username') {
7973: $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'}.");
7974: } elsif ($checkitem eq 'id') {
1.674 bisitz 7975: $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 7976: }
1.669 raeburn 7977: } elsif ($mode eq 'selfcreate') {
7978: if ($checkitem eq 'id') {
7979: $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.");
7980: }
1.615 raeburn 7981: } else {
7982: if ($checkitem eq 'username') {
7983: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7984: } elsif ($checkitem eq 'id') {
7985: $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.");
7986: }
1.612 raeburn 7987: }
7988: return $response;
1.585 raeburn 7989: }
7990:
1.624 raeburn 7991: sub personal_data_fieldtitles {
7992: my %fieldtitles = &Apache::lonlocal::texthash (
7993: id => 'Student/Employee ID',
7994: permanentemail => 'E-mail address',
7995: lastname => 'Last Name',
7996: firstname => 'First Name',
7997: middlename => 'Middle Name',
7998: generation => 'Generation',
7999: gen => 'Generation',
1.765 raeburn 8000: inststatus => 'Affiliation',
1.624 raeburn 8001: );
8002: return %fieldtitles;
8003: }
8004:
1.642 raeburn 8005: sub sorted_inst_types {
8006: my ($dom) = @_;
8007: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8008: my $othertitle = &mt('All users');
8009: if ($env{'request.course.id'}) {
1.668 raeburn 8010: $othertitle = &mt('Any users');
1.642 raeburn 8011: }
8012: my @types;
8013: if (ref($order) eq 'ARRAY') {
8014: @types = @{$order};
8015: }
8016: if (@types == 0) {
8017: if (ref($usertypes) eq 'HASH') {
8018: @types = sort(keys(%{$usertypes}));
8019: }
8020: }
8021: if (keys(%{$usertypes}) > 0) {
8022: $othertitle = &mt('Other users');
8023: }
8024: return ($othertitle,$usertypes,\@types);
8025: }
8026:
1.645 raeburn 8027: sub get_institutional_codes {
8028: my ($settings,$allcourses,$LC_code) = @_;
8029: # Get complete list of course sections to update
8030: my @currsections = ();
8031: my @currxlists = ();
8032: my $coursecode = $$settings{'internal.coursecode'};
8033:
8034: if ($$settings{'internal.sectionnums'} ne '') {
8035: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8036: }
8037:
8038: if ($$settings{'internal.crosslistings'} ne '') {
8039: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8040: }
8041:
8042: if (@currxlists > 0) {
8043: foreach (@currxlists) {
8044: if (m/^([^:]+):(\w*)$/) {
8045: unless (grep/^$1$/,@{$allcourses}) {
8046: push @{$allcourses},$1;
8047: $$LC_code{$1} = $2;
8048: }
8049: }
8050: }
8051: }
8052:
8053: if (@currsections > 0) {
8054: foreach (@currsections) {
8055: if (m/^(\w+):(\w*)$/) {
8056: my $sec = $coursecode.$1;
8057: my $lc_sec = $2;
8058: unless (grep/^$sec$/,@{$allcourses}) {
8059: push @{$allcourses},$sec;
8060: $$LC_code{$sec} = $lc_sec;
8061: }
8062: }
8063: }
8064: }
8065: return;
8066: }
8067:
1.971 ! raeburn 8068: sub get_standard_codeitems {
! 8069: return ('Year','Semester','Department','Number','Section');
! 8070: }
! 8071:
1.112 bowersj2 8072: =pod
8073:
1.780 raeburn 8074: =head1 Slot Helpers
8075:
8076: =over 4
8077:
8078: =item * sorted_slots()
8079:
8080: Sorts an array of slot names in order of slot start time (earliest first).
8081:
8082: Inputs:
8083:
8084: =over 4
8085:
8086: slotsarr - Reference to array of unsorted slot names.
8087:
8088: slots - Reference to hash of hash, where outer hash keys are slot names.
8089:
1.549 albertel 8090: =back
8091:
1.780 raeburn 8092: Returns:
8093:
8094: =over 4
8095:
8096: sorted - An array of slot names sorted by the start time of the slot.
8097:
8098: =back
8099:
8100: =back
8101:
8102: =cut
8103:
8104:
8105: sub sorted_slots {
8106: my ($slotsarr,$slots) = @_;
8107: my @sorted;
8108: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8109: @sorted =
8110: sort {
8111: if (ref($slots->{$a}) && ref($slots->{$b})) {
8112: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8113: }
8114: if (ref($slots->{$a})) { return -1;}
8115: if (ref($slots->{$b})) { return 1;}
8116: return 0;
8117: } @{$slotsarr};
8118: }
8119: return @sorted;
8120: }
8121:
8122:
8123: =pod
8124:
1.549 albertel 8125: =head1 HTTP Helpers
8126:
8127: =over 4
8128:
1.648 raeburn 8129: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8130:
1.258 albertel 8131: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8132: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8133: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8134:
8135: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8136: $possible_names is an ref to an array of form element names. As an example:
8137: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8138: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8139:
8140: =cut
1.1 albertel 8141:
1.6 albertel 8142: sub get_unprocessed_cgi {
1.25 albertel 8143: my ($query,$possible_names)= @_;
1.26 matthew 8144: # $Apache::lonxml::debug=1;
1.356 albertel 8145: foreach my $pair (split(/&/,$query)) {
8146: my ($name, $value) = split(/=/,$pair);
1.369 www 8147: $name = &unescape($name);
1.25 albertel 8148: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8149: $value =~ tr/+/ /;
8150: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8151: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8152: }
1.16 harris41 8153: }
1.6 albertel 8154: }
8155:
1.112 bowersj2 8156: =pod
8157:
1.648 raeburn 8158: =item * &cacheheader()
1.112 bowersj2 8159:
8160: returns cache-controlling header code
8161:
8162: =cut
8163:
1.7 albertel 8164: sub cacheheader {
1.258 albertel 8165: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8166: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8167: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8168: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8169: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8170: return $output;
1.7 albertel 8171: }
8172:
1.112 bowersj2 8173: =pod
8174:
1.648 raeburn 8175: =item * &no_cache($r)
1.112 bowersj2 8176:
8177: specifies header code to not have cache
8178:
8179: =cut
8180:
1.9 albertel 8181: sub no_cache {
1.216 albertel 8182: my ($r) = @_;
8183: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8184: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8185: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8186: $r->no_cache(1);
8187: $r->header_out("Expires" => $date);
8188: $r->header_out("Pragma" => "no-cache");
1.123 www 8189: }
8190:
8191: sub content_type {
1.181 albertel 8192: my ($r,$type,$charset) = @_;
1.299 foxr 8193: if ($r) {
8194: # Note that printout.pl calls this with undef for $r.
8195: &no_cache($r);
8196: }
1.258 albertel 8197: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8198: unless ($charset) {
8199: $charset=&Apache::lonlocal::current_encoding;
8200: }
8201: if ($charset) { $type.='; charset='.$charset; }
8202: if ($r) {
8203: $r->content_type($type);
8204: } else {
8205: print("Content-type: $type\n\n");
8206: }
1.9 albertel 8207: }
1.25 albertel 8208:
1.112 bowersj2 8209: =pod
8210:
1.648 raeburn 8211: =item * &add_to_env($name,$value)
1.112 bowersj2 8212:
1.258 albertel 8213: adds $name to the %env hash with value
1.112 bowersj2 8214: $value, if $name already exists, the entry is converted to an array
8215: reference and $value is added to the array.
8216:
8217: =cut
8218:
1.25 albertel 8219: sub add_to_env {
8220: my ($name,$value)=@_;
1.258 albertel 8221: if (defined($env{$name})) {
8222: if (ref($env{$name})) {
1.25 albertel 8223: #already have multiple values
1.258 albertel 8224: push(@{ $env{$name} },$value);
1.25 albertel 8225: } else {
8226: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8227: my $first=$env{$name};
8228: undef($env{$name});
8229: push(@{ $env{$name} },$first,$value);
1.25 albertel 8230: }
8231: } else {
1.258 albertel 8232: $env{$name}=$value;
1.25 albertel 8233: }
1.31 albertel 8234: }
1.149 albertel 8235:
8236: =pod
8237:
1.648 raeburn 8238: =item * &get_env_multiple($name)
1.149 albertel 8239:
1.258 albertel 8240: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8241: values may be defined and end up as an array ref.
8242:
8243: returns an array of values
8244:
8245: =cut
8246:
8247: sub get_env_multiple {
8248: my ($name) = @_;
8249: my @values;
1.258 albertel 8250: if (defined($env{$name})) {
1.149 albertel 8251: # exists is it an array
1.258 albertel 8252: if (ref($env{$name})) {
8253: @values=@{ $env{$name} };
1.149 albertel 8254: } else {
1.258 albertel 8255: $values[0]=$env{$name};
1.149 albertel 8256: }
8257: }
8258: return(@values);
8259: }
8260:
1.660 raeburn 8261: sub ask_for_embedded_content {
8262: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8263: my $upload_output = '
8264: <form name="upload_embedded" action="'.$actionurl.'"
8265: method="post" enctype="multipart/form-data">';
8266: $upload_output .= $state;
1.661 raeburn 8267: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8268:
8269: my $num = 0;
8270: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8271: $upload_output .= &start_data_table_row().
8272: '<td>'.$embed_file.'</td><td>';
8273: if ($args->{'ignore_remote_references'}
8274: && $embed_file =~ m{^\w+://}) {
8275: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8276: } elsif ($args->{'error_on_invalid_names'}
8277: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8278:
8279: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8280:
8281: } else {
8282: $upload_output .='
1.661 raeburn 8283: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8284: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8285: my $attrib = join(':',@{$$allfiles{$embed_file}});
8286: $upload_output .=
8287: "\n\t\t".
8288: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8289: $attrib.'" />';
8290: if (exists($$codebase{$embed_file})) {
8291: $upload_output .=
8292: "\n\t\t".
8293: '<input name="codebase_'.$num.'" type="hidden" value="'.
8294: &escape($$codebase{$embed_file}).'" />';
8295: }
8296: }
8297: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8298: $num++;
8299: }
8300: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8301: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8302: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8303: '.&mt('(only files for which a location has been provided will be uploaded)').'
8304: </form>';
8305: return $upload_output;
8306: }
8307:
1.661 raeburn 8308: sub upload_embedded {
8309: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8310: $current_disk_usage) = @_;
8311: my $output;
8312: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8313: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8314: my $orig_uploaded_filename =
8315: $env{'form.embedded_item_'.$i.'.filename'};
8316:
8317: $env{'form.embedded_orig_'.$i} =
8318: &unescape($env{'form.embedded_orig_'.$i});
8319: my ($path,$fname) =
8320: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8321: # no path, whole string is fname
8322: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8323:
8324: $path = $env{'form.currentpath'}.$path;
8325: $fname = &Apache::lonnet::clean_filename($fname);
8326: # See if there is anything left
8327: next if ($fname eq '');
8328:
8329: # Check if file already exists as a file or directory.
8330: my ($state,$msg);
8331: if ($context eq 'portfolio') {
8332: my $port_path = $dirpath;
8333: if ($group ne '') {
8334: $port_path = "groups/$group/$port_path";
8335: }
8336: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8337: $dir_root,$port_path,$disk_quota,
8338: $current_disk_usage,$uname,$udom);
8339: if ($state eq 'will_exceed_quota'
8340: || $state eq 'file_locked'
8341: || $state eq 'file_exists' ) {
8342: $output .= $msg;
8343: next;
8344: }
8345: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8346: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8347: if ($state eq 'exists') {
8348: $output .= $msg;
8349: next;
8350: }
8351: }
8352: # Check if extension is valid
8353: if (($fname =~ /\.(\w+)$/) &&
8354: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8355: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8356: next;
8357: } elsif (($fname =~ /\.(\w+)$/) &&
8358: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8359: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8360: next;
8361: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8362: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8363: next;
8364: }
8365:
8366: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8367: if ($context eq 'portfolio') {
8368: my $result=
8369: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8370: $dirpath.$path);
8371: if ($result !~ m|^/uploaded/|) {
8372: $output .= '<span class="LC_error">'
8373: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8374: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8375: .'</span><br />';
8376: next;
8377: } else {
8378: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8379: $path.$fname.'</span>').'</p>';
8380: }
8381: } else {
8382: # Save the file
8383: my $target = $env{'form.embedded_item_'.$i};
8384: my $fullpath = $dir_root.$dirpath.'/'.$path;
8385: my $dest = $fullpath.$fname;
8386: my $url = $url_root.$dirpath.'/'.$path.$fname;
8387: my @parts=split(/\//,$fullpath);
8388: my $count;
8389: my $filepath = $dir_root;
8390: for ($count=4;$count<=$#parts;$count++) {
8391: $filepath .= "/$parts[$count]";
8392: if ((-e $filepath)!=1) {
8393: mkdir($filepath,0770);
8394: }
8395: }
8396: my $fh;
8397: if (!open($fh,'>'.$dest)) {
8398: &Apache::lonnet::logthis('Failed to create '.$dest);
8399: $output .= '<span class="LC_error">'.
8400: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8401: '</span><br />';
8402: } else {
8403: if (!print $fh $env{'form.embedded_item_'.$i}) {
8404: &Apache::lonnet::logthis('Failed to write to '.$dest);
8405: $output .= '<span class="LC_error">'.
8406: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8407: '</span><br />';
8408: } else {
8409: if ($context eq 'testbank') {
8410: $output .= &mt('Embedded file uploaded successfully:').
8411: ' <a href="'.$url.'">'.
8412: $orig_uploaded_filename.'</a><br />';
8413: } else {
1.705 tempelho 8414: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8415: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8416: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8417: }
8418: }
8419: close($fh);
8420: }
8421: }
8422: }
8423: return $output;
8424: }
8425:
8426: sub check_for_existing {
8427: my ($path,$fname,$element) = @_;
8428: my ($state,$msg);
8429: if (-d $path.'/'.$fname) {
8430: $state = 'exists';
8431: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8432: } elsif (-e $path.'/'.$fname) {
8433: $state = 'exists';
8434: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8435: }
8436: if ($state eq 'exists') {
8437: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8438: }
8439: return ($state,$msg);
8440: }
8441:
8442: sub check_for_upload {
8443: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8444: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8445: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8446: my $getpropath = 1;
8447: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8448: $getpropath);
8449: my $found_file = 0;
8450: my $locked_file = 0;
8451: foreach my $line (@dir_list) {
8452: my ($file_name)=split(/\&/,$line,2);
8453: if ($file_name eq $fname){
8454: $file_name = $path.$file_name;
8455: if ($group ne '') {
8456: $file_name = $group.$file_name;
8457: }
8458: $found_file = 1;
8459: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8460: $locked_file = 1;
8461: }
8462: }
8463: }
8464: if (($current_disk_usage + $filesize) > $disk_quota){
8465: my $msg = '<span class="LC_error">'.
8466: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8467: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8468: return ('will_exceed_quota',$msg);
8469: } elsif ($found_file) {
8470: if ($locked_file) {
8471: my $msg = '<span class="LC_error">';
8472: $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>');
8473: $msg .= '</span><br />';
8474: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8475: return ('file_locked',$msg);
8476: } else {
8477: my $msg = '<span class="LC_error">';
8478: $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'});
8479: $msg .= '</span>';
8480: $msg .= '<br />';
8481: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8482: return ('file_exists',$msg);
8483: }
8484: }
8485: }
8486:
1.31 albertel 8487:
1.41 ng 8488: =pod
1.45 matthew 8489:
1.464 albertel 8490: =back
1.41 ng 8491:
1.112 bowersj2 8492: =head1 CSV Upload/Handling functions
1.38 albertel 8493:
1.41 ng 8494: =over 4
8495:
1.648 raeburn 8496: =item * &upfile_store($r)
1.41 ng 8497:
8498: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8499: needs $env{'form.upfile'}
1.41 ng 8500: returns $datatoken to be put into hidden field
8501:
8502: =cut
1.31 albertel 8503:
8504: sub upfile_store {
8505: my $r=shift;
1.258 albertel 8506: $env{'form.upfile'}=~s/\r/\n/gs;
8507: $env{'form.upfile'}=~s/\f/\n/gs;
8508: $env{'form.upfile'}=~s/\n+/\n/gs;
8509: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8510:
1.258 albertel 8511: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8512: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8513: {
1.158 raeburn 8514: my $datafile = $r->dir_config('lonDaemons').
8515: '/tmp/'.$datatoken.'.tmp';
8516: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8517: print $fh $env{'form.upfile'};
1.158 raeburn 8518: close($fh);
8519: }
1.31 albertel 8520: }
8521: return $datatoken;
8522: }
8523:
1.56 matthew 8524: =pod
8525:
1.648 raeburn 8526: =item * &load_tmp_file($r)
1.41 ng 8527:
8528: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8529: needs $env{'form.datatoken'},
8530: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8531:
8532: =cut
1.31 albertel 8533:
8534: sub load_tmp_file {
8535: my $r=shift;
8536: my @studentdata=();
8537: {
1.158 raeburn 8538: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8539: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8540: if ( open(my $fh,"<$studentfile") ) {
8541: @studentdata=<$fh>;
8542: close($fh);
8543: }
1.31 albertel 8544: }
1.258 albertel 8545: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8546: }
8547:
1.56 matthew 8548: =pod
8549:
1.648 raeburn 8550: =item * &upfile_record_sep()
1.41 ng 8551:
8552: Separate uploaded file into records
8553: returns array of records,
1.258 albertel 8554: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8555:
8556: =cut
1.31 albertel 8557:
8558: sub upfile_record_sep {
1.258 albertel 8559: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8560: } else {
1.248 albertel 8561: my @records;
1.258 albertel 8562: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8563: if ($line=~/^\s*$/) { next; }
8564: push(@records,$line);
8565: }
8566: return @records;
1.31 albertel 8567: }
8568: }
8569:
1.56 matthew 8570: =pod
8571:
1.648 raeburn 8572: =item * &record_sep($record)
1.41 ng 8573:
1.258 albertel 8574: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8575:
8576: =cut
8577:
1.263 www 8578: sub takeleft {
8579: my $index=shift;
8580: return substr('0000'.$index,-4,4);
8581: }
8582:
1.31 albertel 8583: sub record_sep {
8584: my $record=shift;
8585: my %components=();
1.258 albertel 8586: if ($env{'form.upfiletype'} eq 'xml') {
8587: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8588: my $i=0;
1.356 albertel 8589: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8590: $field=~s/^(\"|\')//;
8591: $field=~s/(\"|\')$//;
1.263 www 8592: $components{&takeleft($i)}=$field;
1.31 albertel 8593: $i++;
8594: }
1.258 albertel 8595: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8596: my $i=0;
1.356 albertel 8597: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8598: $field=~s/^(\"|\')//;
8599: $field=~s/(\"|\')$//;
1.263 www 8600: $components{&takeleft($i)}=$field;
1.31 albertel 8601: $i++;
8602: }
8603: } else {
1.561 www 8604: my $separator=',';
1.480 banghart 8605: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8606: $separator=';';
1.480 banghart 8607: }
1.31 albertel 8608: my $i=0;
1.561 www 8609: # the character we are looking for to indicate the end of a quote or a record
8610: my $looking_for=$separator;
8611: # do not add the characters to the fields
8612: my $ignore=0;
8613: # we just encountered a separator (or the beginning of the record)
8614: my $just_found_separator=1;
8615: # store the field we are working on here
8616: my $field='';
8617: # work our way through all characters in record
8618: foreach my $character ($record=~/(.)/g) {
8619: if ($character eq $looking_for) {
8620: if ($character ne $separator) {
8621: # Found the end of a quote, again looking for separator
8622: $looking_for=$separator;
8623: $ignore=1;
8624: } else {
8625: # Found a separator, store away what we got
8626: $components{&takeleft($i)}=$field;
8627: $i++;
8628: $just_found_separator=1;
8629: $ignore=0;
8630: $field='';
8631: }
8632: next;
8633: }
8634: # single or double quotation marks after a separator indicate beginning of a quote
8635: # we are now looking for the end of the quote and need to ignore separators
8636: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8637: $looking_for=$character;
8638: next;
8639: }
8640: # ignore would be true after we reached the end of a quote
8641: if ($ignore) { next; }
8642: if (($just_found_separator) && ($character=~/\s/)) { next; }
8643: $field.=$character;
8644: $just_found_separator=0;
1.31 albertel 8645: }
1.561 www 8646: # catch the very last entry, since we never encountered the separator
8647: $components{&takeleft($i)}=$field;
1.31 albertel 8648: }
8649: return %components;
8650: }
8651:
1.144 matthew 8652: ######################################################
8653: ######################################################
8654:
1.56 matthew 8655: =pod
8656:
1.648 raeburn 8657: =item * &upfile_select_html()
1.41 ng 8658:
1.144 matthew 8659: Return HTML code to select a file from the users machine and specify
8660: the file type.
1.41 ng 8661:
8662: =cut
8663:
1.144 matthew 8664: ######################################################
8665: ######################################################
1.31 albertel 8666: sub upfile_select_html {
1.144 matthew 8667: my %Types = (
8668: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8669: semisv => &mt('Semicolon separated values'),
1.144 matthew 8670: space => &mt('Space separated'),
8671: tab => &mt('Tabulator separated'),
8672: # xml => &mt('HTML/XML'),
8673: );
8674: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8675: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8676: foreach my $type (sort(keys(%Types))) {
8677: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8678: }
8679: $Str .= "</select>\n";
8680: return $Str;
1.31 albertel 8681: }
8682:
1.301 albertel 8683: sub get_samples {
8684: my ($records,$toget) = @_;
8685: my @samples=({});
8686: my $got=0;
8687: foreach my $rec (@$records) {
8688: my %temp = &record_sep($rec);
8689: if (! grep(/\S/, values(%temp))) { next; }
8690: if (%temp) {
8691: $samples[$got]=\%temp;
8692: $got++;
8693: if ($got == $toget) { last; }
8694: }
8695: }
8696: return \@samples;
8697: }
8698:
1.144 matthew 8699: ######################################################
8700: ######################################################
8701:
1.56 matthew 8702: =pod
8703:
1.648 raeburn 8704: =item * &csv_print_samples($r,$records)
1.41 ng 8705:
8706: Prints a table of sample values from each column uploaded $r is an
8707: Apache Request ref, $records is an arrayref from
8708: &Apache::loncommon::upfile_record_sep
8709:
8710: =cut
8711:
1.144 matthew 8712: ######################################################
8713: ######################################################
1.31 albertel 8714: sub csv_print_samples {
8715: my ($r,$records) = @_;
1.662 bisitz 8716: my $samples = &get_samples($records,5);
1.301 albertel 8717:
1.594 raeburn 8718: $r->print(&mt('Samples').'<br />'.&start_data_table().
8719: &start_data_table_header_row());
1.356 albertel 8720: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8721: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8722: $r->print(&end_data_table_header_row());
1.301 albertel 8723: foreach my $hash (@$samples) {
1.594 raeburn 8724: $r->print(&start_data_table_row());
1.356 albertel 8725: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8726: $r->print('<td>');
1.356 albertel 8727: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8728: $r->print('</td>');
8729: }
1.594 raeburn 8730: $r->print(&end_data_table_row());
1.31 albertel 8731: }
1.594 raeburn 8732: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8733: }
8734:
1.144 matthew 8735: ######################################################
8736: ######################################################
8737:
1.56 matthew 8738: =pod
8739:
1.648 raeburn 8740: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8741:
8742: Prints a table to create associations between values and table columns.
1.144 matthew 8743:
1.41 ng 8744: $r is an Apache Request ref,
8745: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8746: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8747:
8748: =cut
8749:
1.144 matthew 8750: ######################################################
8751: ######################################################
1.31 albertel 8752: sub csv_print_select_table {
8753: my ($r,$records,$d) = @_;
1.301 albertel 8754: my $i=0;
8755: my $samples = &get_samples($records,1);
1.144 matthew 8756: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8757: &start_data_table().&start_data_table_header_row().
1.144 matthew 8758: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8759: '<th>'.&mt('Column').'</th>'.
8760: &end_data_table_header_row()."\n");
1.356 albertel 8761: foreach my $array_ref (@$d) {
8762: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8763: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8764:
1.875 bisitz 8765: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8766: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8767: $r->print('<option value="none"></option>');
1.356 albertel 8768: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8769: $r->print('<option value="'.$sample.'"'.
8770: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8771: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8772: }
1.594 raeburn 8773: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8774: $i++;
8775: }
1.594 raeburn 8776: $r->print(&end_data_table());
1.31 albertel 8777: $i--;
8778: return $i;
8779: }
1.56 matthew 8780:
1.144 matthew 8781: ######################################################
8782: ######################################################
8783:
1.56 matthew 8784: =pod
1.31 albertel 8785:
1.648 raeburn 8786: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8787:
8788: Prints a table of sample values from the upload and can make associate samples to internal names.
8789:
8790: $r is an Apache Request ref,
8791: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8792: $d is an array of 2 element arrays (internal name, displayed name)
8793:
8794: =cut
8795:
1.144 matthew 8796: ######################################################
8797: ######################################################
1.31 albertel 8798: sub csv_samples_select_table {
8799: my ($r,$records,$d) = @_;
8800: my $i=0;
1.144 matthew 8801: #
1.662 bisitz 8802: my $max_samples = 5;
8803: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8804: $r->print(&start_data_table().
8805: &start_data_table_header_row().'<th>'.
8806: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8807: &end_data_table_header_row());
1.301 albertel 8808:
8809: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8810: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8811: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8812: foreach my $option (@$d) {
8813: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8814: $r->print('<option value="'.$value.'"'.
1.253 albertel 8815: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8816: $display.'</option>');
1.31 albertel 8817: }
8818: $r->print('</select></td><td>');
1.662 bisitz 8819: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8820: if (defined($samples->[$line]{$key})) {
8821: $r->print($samples->[$line]{$key}."<br />\n");
8822: }
8823: }
1.594 raeburn 8824: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8825: $i++;
8826: }
1.594 raeburn 8827: $r->print(&end_data_table());
1.31 albertel 8828: $i--;
8829: return($i);
1.115 matthew 8830: }
8831:
1.144 matthew 8832: ######################################################
8833: ######################################################
8834:
1.115 matthew 8835: =pod
8836:
1.648 raeburn 8837: =item * &clean_excel_name($name)
1.115 matthew 8838:
8839: Returns a replacement for $name which does not contain any illegal characters.
8840:
8841: =cut
8842:
1.144 matthew 8843: ######################################################
8844: ######################################################
1.115 matthew 8845: sub clean_excel_name {
8846: my ($name) = @_;
8847: $name =~ s/[:\*\?\/\\]//g;
8848: if (length($name) > 31) {
8849: $name = substr($name,0,31);
8850: }
8851: return $name;
1.25 albertel 8852: }
1.84 albertel 8853:
1.85 albertel 8854: =pod
8855:
1.648 raeburn 8856: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8857:
8858: Returns either 1 or undef
8859:
8860: 1 if the part is to be hidden, undef if it is to be shown
8861:
8862: Arguments are:
8863:
8864: $id the id of the part to be checked
8865: $symb, optional the symb of the resource to check
8866: $udom, optional the domain of the user to check for
8867: $uname, optional the username of the user to check for
8868:
8869: =cut
1.84 albertel 8870:
8871: sub check_if_partid_hidden {
8872: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8873: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8874: $symb,$udom,$uname);
1.141 albertel 8875: my $truth=1;
8876: #if the string starts with !, then the list is the list to show not hide
8877: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8878: my @hiddenlist=split(/,/,$hiddenparts);
8879: foreach my $checkid (@hiddenlist) {
1.141 albertel 8880: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8881: }
1.141 albertel 8882: return !$truth;
1.84 albertel 8883: }
1.127 matthew 8884:
1.138 matthew 8885:
8886: ############################################################
8887: ############################################################
8888:
8889: =pod
8890:
1.157 matthew 8891: =back
8892:
1.138 matthew 8893: =head1 cgi-bin script and graphing routines
8894:
1.157 matthew 8895: =over 4
8896:
1.648 raeburn 8897: =item * &get_cgi_id()
1.138 matthew 8898:
8899: Inputs: none
8900:
8901: Returns an id which can be used to pass environment variables
8902: to various cgi-bin scripts. These environment variables will
8903: be removed from the users environment after a given time by
8904: the routine &Apache::lonnet::transfer_profile_to_env.
8905:
8906: =cut
8907:
8908: ############################################################
8909: ############################################################
1.152 albertel 8910: my $uniq=0;
1.136 matthew 8911: sub get_cgi_id {
1.154 albertel 8912: $uniq=($uniq+1)%100000;
1.280 albertel 8913: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8914: }
8915:
1.127 matthew 8916: ############################################################
8917: ############################################################
8918:
8919: =pod
8920:
1.648 raeburn 8921: =item * &DrawBarGraph()
1.127 matthew 8922:
1.138 matthew 8923: Facilitates the plotting of data in a (stacked) bar graph.
8924: Puts plot definition data into the users environment in order for
8925: graph.png to plot it. Returns an <img> tag for the plot.
8926: The bars on the plot are labeled '1','2',...,'n'.
8927:
8928: Inputs:
8929:
8930: =over 4
8931:
8932: =item $Title: string, the title of the plot
8933:
8934: =item $xlabel: string, text describing the X-axis of the plot
8935:
8936: =item $ylabel: string, text describing the Y-axis of the plot
8937:
8938: =item $Max: scalar, the maximum Y value to use in the plot
8939: If $Max is < any data point, the graph will not be rendered.
8940:
1.140 matthew 8941: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8942: they are plotted. If undefined, default values will be used.
8943:
1.178 matthew 8944: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8945:
1.138 matthew 8946: =item @Values: An array of array references. Each array reference holds data
8947: to be plotted in a stacked bar chart.
8948:
1.239 matthew 8949: =item If the final element of @Values is a hash reference the key/value
8950: pairs will be added to the graph definition.
8951:
1.138 matthew 8952: =back
8953:
8954: Returns:
8955:
8956: An <img> tag which references graph.png and the appropriate identifying
8957: information for the plot.
8958:
1.127 matthew 8959: =cut
8960:
8961: ############################################################
8962: ############################################################
1.134 matthew 8963: sub DrawBarGraph {
1.178 matthew 8964: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8965: #
8966: if (! defined($colors)) {
8967: $colors = ['#33ff00',
8968: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8969: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8970: ];
8971: }
1.228 matthew 8972: my $extra_settings = {};
8973: if (ref($Values[-1]) eq 'HASH') {
8974: $extra_settings = pop(@Values);
8975: }
1.127 matthew 8976: #
1.136 matthew 8977: my $identifier = &get_cgi_id();
8978: my $id = 'cgi.'.$identifier;
1.129 matthew 8979: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8980: return '';
8981: }
1.225 matthew 8982: #
8983: my @Labels;
8984: if (defined($labels)) {
8985: @Labels = @$labels;
8986: } else {
8987: for (my $i=0;$i<@{$Values[0]};$i++) {
8988: push (@Labels,$i+1);
8989: }
8990: }
8991: #
1.129 matthew 8992: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8993: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8994: my %ValuesHash;
8995: my $NumSets=1;
8996: foreach my $array (@Values) {
8997: next if (! ref($array));
1.136 matthew 8998: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8999: join(',',@$array);
1.129 matthew 9000: }
1.127 matthew 9001: #
1.136 matthew 9002: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9003: if ($NumBars < 3) {
9004: $width = 120+$NumBars*32;
1.220 matthew 9005: $xskip = 1;
1.225 matthew 9006: $bar_width = 30;
9007: } elsif ($NumBars < 5) {
9008: $width = 120+$NumBars*20;
9009: $xskip = 1;
9010: $bar_width = 20;
1.220 matthew 9011: } elsif ($NumBars < 10) {
1.136 matthew 9012: $width = 120+$NumBars*15;
9013: $xskip = 1;
9014: $bar_width = 15;
9015: } elsif ($NumBars <= 25) {
9016: $width = 120+$NumBars*11;
9017: $xskip = 5;
9018: $bar_width = 8;
9019: } elsif ($NumBars <= 50) {
9020: $width = 120+$NumBars*8;
9021: $xskip = 5;
9022: $bar_width = 4;
9023: } else {
9024: $width = 120+$NumBars*8;
9025: $xskip = 5;
9026: $bar_width = 4;
9027: }
9028: #
1.137 matthew 9029: $Max = 1 if ($Max < 1);
9030: if ( int($Max) < $Max ) {
9031: $Max++;
9032: $Max = int($Max);
9033: }
1.127 matthew 9034: $Title = '' if (! defined($Title));
9035: $xlabel = '' if (! defined($xlabel));
9036: $ylabel = '' if (! defined($ylabel));
1.369 www 9037: $ValuesHash{$id.'.title'} = &escape($Title);
9038: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9039: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9040: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9041: $ValuesHash{$id.'.NumBars'} = $NumBars;
9042: $ValuesHash{$id.'.NumSets'} = $NumSets;
9043: $ValuesHash{$id.'.PlotType'} = 'bar';
9044: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9045: $ValuesHash{$id.'.height'} = $height;
9046: $ValuesHash{$id.'.width'} = $width;
9047: $ValuesHash{$id.'.xskip'} = $xskip;
9048: $ValuesHash{$id.'.bar_width'} = $bar_width;
9049: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9050: #
1.228 matthew 9051: # Deal with other parameters
9052: while (my ($key,$value) = each(%$extra_settings)) {
9053: $ValuesHash{$id.'.'.$key} = $value;
9054: }
9055: #
1.646 raeburn 9056: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9057: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9058: }
9059:
9060: ############################################################
9061: ############################################################
9062:
9063: =pod
9064:
1.648 raeburn 9065: =item * &DrawXYGraph()
1.137 matthew 9066:
1.138 matthew 9067: Facilitates the plotting of data in an XY graph.
9068: Puts plot definition data into the users environment in order for
9069: graph.png to plot it. Returns an <img> tag for the plot.
9070:
9071: Inputs:
9072:
9073: =over 4
9074:
9075: =item $Title: string, the title of the plot
9076:
9077: =item $xlabel: string, text describing the X-axis of the plot
9078:
9079: =item $ylabel: string, text describing the Y-axis of the plot
9080:
9081: =item $Max: scalar, the maximum Y value to use in the plot
9082: If $Max is < any data point, the graph will not be rendered.
9083:
9084: =item $colors: Array ref containing the hex color codes for the data to be
9085: plotted in. If undefined, default values will be used.
9086:
9087: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9088:
9089: =item $Ydata: Array ref containing Array refs.
1.185 www 9090: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9091:
9092: =item %Values: hash indicating or overriding any default values which are
9093: passed to graph.png.
9094: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9095:
9096: =back
9097:
9098: Returns:
9099:
9100: An <img> tag which references graph.png and the appropriate identifying
9101: information for the plot.
9102:
1.137 matthew 9103: =cut
9104:
9105: ############################################################
9106: ############################################################
9107: sub DrawXYGraph {
9108: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9109: #
9110: # Create the identifier for the graph
9111: my $identifier = &get_cgi_id();
9112: my $id = 'cgi.'.$identifier;
9113: #
9114: $Title = '' if (! defined($Title));
9115: $xlabel = '' if (! defined($xlabel));
9116: $ylabel = '' if (! defined($ylabel));
9117: my %ValuesHash =
9118: (
1.369 www 9119: $id.'.title' => &escape($Title),
9120: $id.'.xlabel' => &escape($xlabel),
9121: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9122: $id.'.y_max_value'=> $Max,
9123: $id.'.labels' => join(',',@$Xlabels),
9124: $id.'.PlotType' => 'XY',
9125: );
9126: #
9127: if (defined($colors) && ref($colors) eq 'ARRAY') {
9128: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9129: }
9130: #
9131: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9132: return '';
9133: }
9134: my $NumSets=1;
1.138 matthew 9135: foreach my $array (@{$Ydata}){
1.137 matthew 9136: next if (! ref($array));
9137: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9138: }
1.138 matthew 9139: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9140: #
9141: # Deal with other parameters
9142: while (my ($key,$value) = each(%Values)) {
9143: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9144: }
9145: #
1.646 raeburn 9146: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9147: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9148: }
9149:
9150: ############################################################
9151: ############################################################
9152:
9153: =pod
9154:
1.648 raeburn 9155: =item * &DrawXYYGraph()
1.138 matthew 9156:
9157: Facilitates the plotting of data in an XY graph with two Y axes.
9158: Puts plot definition data into the users environment in order for
9159: graph.png to plot it. Returns an <img> tag for the plot.
9160:
9161: Inputs:
9162:
9163: =over 4
9164:
9165: =item $Title: string, the title of the plot
9166:
9167: =item $xlabel: string, text describing the X-axis of the plot
9168:
9169: =item $ylabel: string, text describing the Y-axis of the plot
9170:
9171: =item $colors: Array ref containing the hex color codes for the data to be
9172: plotted in. If undefined, default values will be used.
9173:
9174: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9175:
9176: =item $Ydata1: The first data set
9177:
9178: =item $Min1: The minimum value of the left Y-axis
9179:
9180: =item $Max1: The maximum value of the left Y-axis
9181:
9182: =item $Ydata2: The second data set
9183:
9184: =item $Min2: The minimum value of the right Y-axis
9185:
9186: =item $Max2: The maximum value of the left Y-axis
9187:
9188: =item %Values: hash indicating or overriding any default values which are
9189: passed to graph.png.
9190: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9191:
9192: =back
9193:
9194: Returns:
9195:
9196: An <img> tag which references graph.png and the appropriate identifying
9197: information for the plot.
1.136 matthew 9198:
9199: =cut
9200:
9201: ############################################################
9202: ############################################################
1.137 matthew 9203: sub DrawXYYGraph {
9204: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9205: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9206: #
9207: # Create the identifier for the graph
9208: my $identifier = &get_cgi_id();
9209: my $id = 'cgi.'.$identifier;
9210: #
9211: $Title = '' if (! defined($Title));
9212: $xlabel = '' if (! defined($xlabel));
9213: $ylabel = '' if (! defined($ylabel));
9214: my %ValuesHash =
9215: (
1.369 www 9216: $id.'.title' => &escape($Title),
9217: $id.'.xlabel' => &escape($xlabel),
9218: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9219: $id.'.labels' => join(',',@$Xlabels),
9220: $id.'.PlotType' => 'XY',
9221: $id.'.NumSets' => 2,
1.137 matthew 9222: $id.'.two_axes' => 1,
9223: $id.'.y1_max_value' => $Max1,
9224: $id.'.y1_min_value' => $Min1,
9225: $id.'.y2_max_value' => $Max2,
9226: $id.'.y2_min_value' => $Min2,
1.136 matthew 9227: );
9228: #
1.137 matthew 9229: if (defined($colors) && ref($colors) eq 'ARRAY') {
9230: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9231: }
9232: #
9233: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9234: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9235: return '';
9236: }
9237: my $NumSets=1;
1.137 matthew 9238: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9239: next if (! ref($array));
9240: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9241: }
9242: #
9243: # Deal with other parameters
9244: while (my ($key,$value) = each(%Values)) {
9245: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9246: }
9247: #
1.646 raeburn 9248: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9249: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9250: }
9251:
9252: ############################################################
9253: ############################################################
9254:
9255: =pod
9256:
1.157 matthew 9257: =back
9258:
1.139 matthew 9259: =head1 Statistics helper routines?
9260:
9261: Bad place for them but what the hell.
9262:
1.157 matthew 9263: =over 4
9264:
1.648 raeburn 9265: =item * &chartlink()
1.139 matthew 9266:
9267: Returns a link to the chart for a specific student.
9268:
9269: Inputs:
9270:
9271: =over 4
9272:
9273: =item $linktext: The text of the link
9274:
9275: =item $sname: The students username
9276:
9277: =item $sdomain: The students domain
9278:
9279: =back
9280:
1.157 matthew 9281: =back
9282:
1.139 matthew 9283: =cut
9284:
9285: ############################################################
9286: ############################################################
9287: sub chartlink {
9288: my ($linktext, $sname, $sdomain) = @_;
9289: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9290: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9291: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9292: '">'.$linktext.'</a>';
1.153 matthew 9293: }
9294:
9295: #######################################################
9296: #######################################################
9297:
9298: =pod
9299:
9300: =head1 Course Environment Routines
1.157 matthew 9301:
9302: =over 4
1.153 matthew 9303:
1.648 raeburn 9304: =item * &restore_course_settings()
1.153 matthew 9305:
1.648 raeburn 9306: =item * &store_course_settings()
1.153 matthew 9307:
9308: Restores/Store indicated form parameters from the course environment.
9309: Will not overwrite existing values of the form parameters.
9310:
9311: Inputs:
9312: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9313:
9314: a hash ref describing the data to be stored. For example:
9315:
9316: %Save_Parameters = ('Status' => 'scalar',
9317: 'chartoutputmode' => 'scalar',
9318: 'chartoutputdata' => 'scalar',
9319: 'Section' => 'array',
1.373 raeburn 9320: 'Group' => 'array',
1.153 matthew 9321: 'StudentData' => 'array',
9322: 'Maps' => 'array');
9323:
9324: Returns: both routines return nothing
9325:
1.631 raeburn 9326: =back
9327:
1.153 matthew 9328: =cut
9329:
9330: #######################################################
9331: #######################################################
9332: sub store_course_settings {
1.496 albertel 9333: return &store_settings($env{'request.course.id'},@_);
9334: }
9335:
9336: sub store_settings {
1.153 matthew 9337: # save to the environment
9338: # appenv the same items, just to be safe
1.300 albertel 9339: my $udom = $env{'user.domain'};
9340: my $uname = $env{'user.name'};
1.496 albertel 9341: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9342: my %SaveHash;
9343: my %AppHash;
9344: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9345: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9346: my $envname = 'environment.'.$basename;
1.258 albertel 9347: if (exists($env{'form.'.$setting})) {
1.153 matthew 9348: # Save this value away
9349: if ($type eq 'scalar' &&
1.258 albertel 9350: (! exists($env{$envname}) ||
9351: $env{$envname} ne $env{'form.'.$setting})) {
9352: $SaveHash{$basename} = $env{'form.'.$setting};
9353: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9354: } elsif ($type eq 'array') {
9355: my $stored_form;
1.258 albertel 9356: if (ref($env{'form.'.$setting})) {
1.153 matthew 9357: $stored_form = join(',',
9358: map {
1.369 www 9359: &escape($_);
1.258 albertel 9360: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9361: } else {
9362: $stored_form =
1.369 www 9363: &escape($env{'form.'.$setting});
1.153 matthew 9364: }
9365: # Determine if the array contents are the same.
1.258 albertel 9366: if ($stored_form ne $env{$envname}) {
1.153 matthew 9367: $SaveHash{$basename} = $stored_form;
9368: $AppHash{$envname} = $stored_form;
9369: }
9370: }
9371: }
9372: }
9373: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9374: $udom,$uname);
1.153 matthew 9375: if ($put_result !~ /^(ok|delayed)/) {
9376: &Apache::lonnet::logthis('unable to save form parameters, '.
9377: 'got error:'.$put_result);
9378: }
9379: # Make sure these settings stick around in this session, too
1.646 raeburn 9380: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9381: return;
9382: }
9383:
9384: sub restore_course_settings {
1.499 albertel 9385: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9386: }
9387:
9388: sub restore_settings {
9389: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9390: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9391: next if (exists($env{'form.'.$setting}));
1.496 albertel 9392: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9393: '.'.$setting;
1.258 albertel 9394: if (exists($env{$envname})) {
1.153 matthew 9395: if ($type eq 'scalar') {
1.258 albertel 9396: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9397: } elsif ($type eq 'array') {
1.258 albertel 9398: $env{'form.'.$setting} = [
1.153 matthew 9399: map {
1.369 www 9400: &unescape($_);
1.258 albertel 9401: } split(',',$env{$envname})
1.153 matthew 9402: ];
9403: }
9404: }
9405: }
1.127 matthew 9406: }
9407:
1.618 raeburn 9408: #######################################################
9409: #######################################################
9410:
9411: =pod
9412:
9413: =head1 Domain E-mail Routines
9414:
9415: =over 4
9416:
1.648 raeburn 9417: =item * &build_recipient_list()
1.618 raeburn 9418:
1.884 raeburn 9419: Build recipient lists for five types of e-mail:
1.766 raeburn 9420: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9421: (d) Help requests, (e) Course requests needing approval, generated by
9422: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9423: loncoursequeueadmin.pm respectively.
1.618 raeburn 9424:
9425: Inputs:
1.619 raeburn 9426: defmail (scalar - email address of default recipient),
1.618 raeburn 9427: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9428: defdom (domain for which to retrieve configuration settings),
9429: origmail (scalar - email address of recipient from loncapa.conf,
9430: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9431:
1.655 raeburn 9432: Returns: comma separated list of addresses to which to send e-mail.
9433:
9434: =back
1.618 raeburn 9435:
9436: =cut
9437:
9438: ############################################################
9439: ############################################################
9440: sub build_recipient_list {
1.619 raeburn 9441: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9442: my @recipients;
9443: my $otheremails;
9444: my %domconfig =
9445: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9446: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9447: if (exists($domconfig{'contacts'}{$mailing})) {
9448: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9449: my @contacts = ('adminemail','supportemail');
9450: foreach my $item (@contacts) {
9451: if ($domconfig{'contacts'}{$mailing}{$item}) {
9452: my $addr = $domconfig{'contacts'}{$item};
9453: if (!grep(/^\Q$addr\E$/,@recipients)) {
9454: push(@recipients,$addr);
9455: }
1.619 raeburn 9456: }
1.766 raeburn 9457: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9458: }
9459: }
1.766 raeburn 9460: } elsif ($origmail ne '') {
9461: push(@recipients,$origmail);
1.618 raeburn 9462: }
1.619 raeburn 9463: } elsif ($origmail ne '') {
9464: push(@recipients,$origmail);
1.618 raeburn 9465: }
1.688 raeburn 9466: if (defined($defmail)) {
9467: if ($defmail ne '') {
9468: push(@recipients,$defmail);
9469: }
1.618 raeburn 9470: }
9471: if ($otheremails) {
1.619 raeburn 9472: my @others;
9473: if ($otheremails =~ /,/) {
9474: @others = split(/,/,$otheremails);
1.618 raeburn 9475: } else {
1.619 raeburn 9476: push(@others,$otheremails);
9477: }
9478: foreach my $addr (@others) {
9479: if (!grep(/^\Q$addr\E$/,@recipients)) {
9480: push(@recipients,$addr);
9481: }
1.618 raeburn 9482: }
9483: }
1.619 raeburn 9484: my $recipientlist = join(',',@recipients);
1.618 raeburn 9485: return $recipientlist;
9486: }
9487:
1.127 matthew 9488: ############################################################
9489: ############################################################
1.154 albertel 9490:
1.655 raeburn 9491: =pod
9492:
9493: =head1 Course Catalog Routines
9494:
9495: =over 4
9496:
9497: =item * &gather_categories()
9498:
9499: Converts category definitions - keys of categories hash stored in
9500: coursecategories in configuration.db on the primary library server in a
9501: domain - to an array. Also generates javascript and idx hash used to
9502: generate Domain Coordinator interface for editing Course Categories.
9503:
9504: Inputs:
1.663 raeburn 9505:
1.655 raeburn 9506: categories (reference to hash of category definitions).
1.663 raeburn 9507:
1.655 raeburn 9508: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9509: categories and subcategories).
1.663 raeburn 9510:
1.655 raeburn 9511: idx (reference to hash of counters used in Domain Coordinator interface for
9512: editing Course Categories).
1.663 raeburn 9513:
1.655 raeburn 9514: jsarray (reference to array of categories used to create Javascript arrays for
9515: Domain Coordinator interface for editing Course Categories).
9516:
9517: Returns: nothing
9518:
9519: Side effects: populates cats, idx and jsarray.
9520:
9521: =cut
9522:
9523: sub gather_categories {
9524: my ($categories,$cats,$idx,$jsarray) = @_;
9525: my %counters;
9526: my $num = 0;
9527: foreach my $item (keys(%{$categories})) {
9528: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9529: if ($container eq '' && $depth == 0) {
9530: $cats->[$depth][$categories->{$item}] = $cat;
9531: } else {
9532: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9533: }
9534: my ($escitem,$tail) = split(/:/,$item,2);
9535: if ($counters{$tail} eq '') {
9536: $counters{$tail} = $num;
9537: $num ++;
9538: }
9539: if (ref($idx) eq 'HASH') {
9540: $idx->{$item} = $counters{$tail};
9541: }
9542: if (ref($jsarray) eq 'ARRAY') {
9543: push(@{$jsarray->[$counters{$tail}]},$item);
9544: }
9545: }
9546: return;
9547: }
9548:
9549: =pod
9550:
9551: =item * &extract_categories()
9552:
9553: Used to generate breadcrumb trails for course categories.
9554:
9555: Inputs:
1.663 raeburn 9556:
1.655 raeburn 9557: categories (reference to hash of category definitions).
1.663 raeburn 9558:
1.655 raeburn 9559: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9560: categories and subcategories).
1.663 raeburn 9561:
1.655 raeburn 9562: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9563:
1.655 raeburn 9564: allitems (reference to hash - key is category key
9565: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9566:
1.655 raeburn 9567: idx (reference to hash of counters used in Domain Coordinator interface for
9568: editing Course Categories).
1.663 raeburn 9569:
1.655 raeburn 9570: jsarray (reference to array of categories used to create Javascript arrays for
9571: Domain Coordinator interface for editing Course Categories).
9572:
1.665 raeburn 9573: subcats (reference to hash of arrays containing all subcategories within each
9574: category, -recursive)
9575:
1.655 raeburn 9576: Returns: nothing
9577:
9578: Side effects: populates trails and allitems hash references.
9579:
9580: =cut
9581:
9582: sub extract_categories {
1.665 raeburn 9583: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9584: if (ref($categories) eq 'HASH') {
9585: &gather_categories($categories,$cats,$idx,$jsarray);
9586: if (ref($cats->[0]) eq 'ARRAY') {
9587: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9588: my $name = $cats->[0][$i];
9589: my $item = &escape($name).'::0';
9590: my $trailstr;
9591: if ($name eq 'instcode') {
9592: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9593: } elsif ($name eq 'communities') {
9594: $trailstr = &mt('Communities');
1.655 raeburn 9595: } else {
9596: $trailstr = $name;
9597: }
9598: if ($allitems->{$item} eq '') {
9599: push(@{$trails},$trailstr);
9600: $allitems->{$item} = scalar(@{$trails})-1;
9601: }
9602: my @parents = ($name);
9603: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9604: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9605: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9606: if (ref($subcats) eq 'HASH') {
9607: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9608: }
9609: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9610: }
9611: } else {
9612: if (ref($subcats) eq 'HASH') {
9613: $subcats->{$item} = [];
1.655 raeburn 9614: }
9615: }
9616: }
9617: }
9618: }
9619: return;
9620: }
9621:
9622: =pod
9623:
9624: =item *&recurse_categories()
9625:
9626: Recursively used to generate breadcrumb trails for course categories.
9627:
9628: Inputs:
1.663 raeburn 9629:
1.655 raeburn 9630: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9631: categories and subcategories).
1.663 raeburn 9632:
1.655 raeburn 9633: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9634:
9635: category (current course category, for which breadcrumb trail is being generated).
9636:
9637: trails (reference to array of breadcrumb trails for each category).
9638:
1.655 raeburn 9639: allitems (reference to hash - key is category key
9640: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9641:
1.655 raeburn 9642: parents (array containing containers directories for current category,
9643: back to top level).
9644:
9645: Returns: nothing
9646:
9647: Side effects: populates trails and allitems hash references
9648:
9649: =cut
9650:
9651: sub recurse_categories {
1.665 raeburn 9652: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9653: my $shallower = $depth - 1;
9654: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9655: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9656: my $name = $cats->[$depth]{$category}[$k];
9657: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9658: my $trailstr = join(' -> ',(@{$parents},$category));
9659: if ($allitems->{$item} eq '') {
9660: push(@{$trails},$trailstr);
9661: $allitems->{$item} = scalar(@{$trails})-1;
9662: }
9663: my $deeper = $depth+1;
9664: push(@{$parents},$category);
1.665 raeburn 9665: if (ref($subcats) eq 'HASH') {
9666: my $subcat = &escape($name).':'.$category.':'.$depth;
9667: for (my $j=@{$parents}; $j>=0; $j--) {
9668: my $higher;
9669: if ($j > 0) {
9670: $higher = &escape($parents->[$j]).':'.
9671: &escape($parents->[$j-1]).':'.$j;
9672: } else {
9673: $higher = &escape($parents->[$j]).'::'.$j;
9674: }
9675: push(@{$subcats->{$higher}},$subcat);
9676: }
9677: }
9678: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9679: $subcats);
1.655 raeburn 9680: pop(@{$parents});
9681: }
9682: } else {
9683: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9684: my $trailstr = join(' -> ',(@{$parents},$category));
9685: if ($allitems->{$item} eq '') {
9686: push(@{$trails},$trailstr);
9687: $allitems->{$item} = scalar(@{$trails})-1;
9688: }
9689: }
9690: return;
9691: }
9692:
1.663 raeburn 9693: =pod
9694:
9695: =item *&assign_categories_table()
9696:
9697: Create a datatable for display of hierarchical categories in a domain,
9698: with checkboxes to allow a course to be categorized.
9699:
9700: Inputs:
9701:
9702: cathash - reference to hash of categories defined for the domain (from
9703: configuration.db)
9704:
9705: currcat - scalar with an & separated list of categories assigned to a course.
9706:
1.919 raeburn 9707: type - scalar contains course type (Course or Community).
9708:
1.663 raeburn 9709: Returns: $output (markup to be displayed)
9710:
9711: =cut
9712:
9713: sub assign_categories_table {
1.919 raeburn 9714: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9715: my $output;
9716: if (ref($cathash) eq 'HASH') {
9717: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9718: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9719: $maxdepth = scalar(@cats);
9720: if (@cats > 0) {
9721: my $itemcount = 0;
9722: if (ref($cats[0]) eq 'ARRAY') {
9723: my @currcategories;
9724: if ($currcat ne '') {
9725: @currcategories = split('&',$currcat);
9726: }
1.919 raeburn 9727: my $table;
1.663 raeburn 9728: for (my $i=0; $i<@{$cats[0]}; $i++) {
9729: my $parent = $cats[0][$i];
1.919 raeburn 9730: next if ($parent eq 'instcode');
9731: if ($type eq 'Community') {
9732: next unless ($parent eq 'communities');
9733: } else {
9734: next if ($parent eq 'communities');
9735: }
1.663 raeburn 9736: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9737: my $item = &escape($parent).'::0';
9738: my $checked = '';
9739: if (@currcategories > 0) {
9740: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9741: $checked = ' checked="checked"';
1.663 raeburn 9742: }
9743: }
1.919 raeburn 9744: my $parent_title = $parent;
9745: if ($parent eq 'communities') {
9746: $parent_title = &mt('Communities');
9747: }
9748: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9749: '<input type="checkbox" name="usecategory" value="'.
9750: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9751: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9752: my $depth = 1;
9753: push(@path,$parent);
1.919 raeburn 9754: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9755: pop(@path);
1.919 raeburn 9756: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9757: $itemcount ++;
9758: }
1.919 raeburn 9759: if ($itemcount) {
9760: $output = &Apache::loncommon::start_data_table().
9761: $table.
9762: &Apache::loncommon::end_data_table();
9763: }
1.663 raeburn 9764: }
9765: }
9766: }
9767: return $output;
9768: }
9769:
9770: =pod
9771:
9772: =item *&assign_category_rows()
9773:
9774: Create a datatable row for display of nested categories in a domain,
9775: with checkboxes to allow a course to be categorized,called recursively.
9776:
9777: Inputs:
9778:
9779: itemcount - track row number for alternating colors
9780:
9781: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9782: categories and subcategories.
9783:
9784: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9785:
9786: parent - parent of current category item
9787:
9788: path - Array containing all categories back up through the hierarchy from the
9789: current category to the top level.
9790:
9791: currcategories - reference to array of current categories assigned to the course
9792:
9793: Returns: $output (markup to be displayed).
9794:
9795: =cut
9796:
9797: sub assign_category_rows {
9798: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9799: my ($text,$name,$item,$chgstr);
9800: if (ref($cats) eq 'ARRAY') {
9801: my $maxdepth = scalar(@{$cats});
9802: if (ref($cats->[$depth]) eq 'HASH') {
9803: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9804: my $numchildren = @{$cats->[$depth]{$parent}};
9805: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9806: $text .= '<td><table class="LC_datatable">';
9807: for (my $j=0; $j<$numchildren; $j++) {
9808: $name = $cats->[$depth]{$parent}[$j];
9809: $item = &escape($name).':'.&escape($parent).':'.$depth;
9810: my $deeper = $depth+1;
9811: my $checked = '';
9812: if (ref($currcategories) eq 'ARRAY') {
9813: if (@{$currcategories} > 0) {
9814: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9815: $checked = ' checked="checked"';
1.663 raeburn 9816: }
9817: }
9818: }
1.664 raeburn 9819: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9820: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9821: $item.'"'.$checked.' />'.$name.'</label></span>'.
9822: '<input type="hidden" name="catname" value="'.$name.'" />'.
9823: '</td><td>';
1.663 raeburn 9824: if (ref($path) eq 'ARRAY') {
9825: push(@{$path},$name);
9826: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9827: pop(@{$path});
9828: }
9829: $text .= '</td></tr>';
9830: }
9831: $text .= '</table></td>';
9832: }
9833: }
9834: }
9835: return $text;
9836: }
9837:
1.655 raeburn 9838: ############################################################
9839: ############################################################
9840:
9841:
1.443 albertel 9842: sub commit_customrole {
1.664 raeburn 9843: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9844: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9845: ($start?', '.&mt('starting').' '.localtime($start):'').
9846: ($end?', ending '.localtime($end):'').': <b>'.
9847: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9848: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9849: '</b><br />';
9850: return $output;
9851: }
9852:
9853: sub commit_standardrole {
1.541 raeburn 9854: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9855: my ($output,$logmsg,$linefeed);
9856: if ($context eq 'auto') {
9857: $linefeed = "\n";
9858: } else {
9859: $linefeed = "<br />\n";
9860: }
1.443 albertel 9861: if ($three eq 'st') {
1.541 raeburn 9862: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9863: $one,$two,$sec,$context);
9864: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9865: ($result eq 'unknown_course') || ($result eq 'refused')) {
9866: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9867: } else {
1.541 raeburn 9868: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9869: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9870: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9871: if ($context eq 'auto') {
9872: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9873: } else {
9874: $output .= '<b>'.$result.'</b>'.$linefeed.
9875: &mt('Add to classlist').': <b>ok</b>';
9876: }
9877: $output .= $linefeed;
1.443 albertel 9878: }
9879: } else {
9880: $output = &mt('Assigning').' '.$three.' in '.$url.
9881: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9882: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9883: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9884: if ($context eq 'auto') {
9885: $output .= $result.$linefeed;
9886: } else {
9887: $output .= '<b>'.$result.'</b>'.$linefeed;
9888: }
1.443 albertel 9889: }
9890: return $output;
9891: }
9892:
9893: sub commit_studentrole {
1.541 raeburn 9894: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9895: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9896: if ($context eq 'auto') {
9897: $linefeed = "\n";
9898: } else {
9899: $linefeed = '<br />'."\n";
9900: }
1.443 albertel 9901: if (defined($one) && defined($two)) {
9902: my $cid=$one.'_'.$two;
9903: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9904: my $secchange = 0;
9905: my $expire_role_result;
9906: my $modify_section_result;
1.628 raeburn 9907: if ($oldsec ne '-1') {
9908: if ($oldsec ne $sec) {
1.443 albertel 9909: $secchange = 1;
1.628 raeburn 9910: my $now = time;
1.443 albertel 9911: my $uurl='/'.$cid;
9912: $uurl=~s/\_/\//g;
9913: if ($oldsec) {
9914: $uurl.='/'.$oldsec;
9915: }
1.626 raeburn 9916: $oldsecurl = $uurl;
1.628 raeburn 9917: $expire_role_result =
1.652 raeburn 9918: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9919: if ($env{'request.course.sec'} ne '') {
9920: if ($expire_role_result eq 'refused') {
9921: my @roles = ('st');
9922: my @statuses = ('previous');
9923: my @roledoms = ($one);
9924: my $withsec = 1;
9925: my %roleshash =
9926: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9927: \@statuses,\@roles,\@roledoms,$withsec);
9928: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9929: my ($oldstart,$oldend) =
9930: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9931: if ($oldend > 0 && $oldend <= $now) {
9932: $expire_role_result = 'ok';
9933: }
9934: }
9935: }
9936: }
1.443 albertel 9937: $result = $expire_role_result;
9938: }
9939: }
9940: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9941: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9942: if ($modify_section_result =~ /^ok/) {
9943: if ($secchange == 1) {
1.628 raeburn 9944: if ($sec eq '') {
9945: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9946: } else {
9947: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9948: }
1.443 albertel 9949: } elsif ($oldsec eq '-1') {
1.628 raeburn 9950: if ($sec eq '') {
9951: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9952: } else {
9953: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9954: }
1.443 albertel 9955: } else {
1.628 raeburn 9956: if ($sec eq '') {
9957: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9958: } else {
9959: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9960: }
1.443 albertel 9961: }
9962: } else {
1.628 raeburn 9963: if ($secchange) {
9964: $$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;
9965: } else {
9966: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9967: }
1.443 albertel 9968: }
9969: $result = $modify_section_result;
9970: } elsif ($secchange == 1) {
1.628 raeburn 9971: if ($oldsec eq '') {
9972: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9973: } else {
9974: $$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;
9975: }
1.626 raeburn 9976: if ($expire_role_result eq 'refused') {
9977: my $newsecurl = '/'.$cid;
9978: $newsecurl =~ s/\_/\//g;
9979: if ($sec ne '') {
9980: $newsecurl.='/'.$sec;
9981: }
9982: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9983: if ($sec eq '') {
9984: $$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;
9985: } else {
9986: $$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;
9987: }
9988: }
9989: }
1.443 albertel 9990: }
9991: } else {
1.626 raeburn 9992: $$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 9993: $result = "error: incomplete course id\n";
9994: }
9995: return $result;
9996: }
9997:
9998: ############################################################
9999: ############################################################
10000:
1.566 albertel 10001: sub check_clone {
1.578 raeburn 10002: my ($args,$linefeed) = @_;
1.566 albertel 10003: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10004: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10005: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10006: my $clonemsg;
10007: my $can_clone = 0;
1.944 raeburn 10008: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10009: if ($lctype ne 'community') {
10010: $lctype = 'course';
10011: }
1.566 albertel 10012: if ($clonehome eq 'no_host') {
1.944 raeburn 10013: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10014: $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'});
10015: } else {
10016: $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'});
10017: }
1.566 albertel 10018: } else {
10019: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10020: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10021: if ($clonedesc{'type'} ne 'Community') {
10022: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
10023: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10024: }
10025: }
1.882 raeburn 10026: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10027: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10028: $can_clone = 1;
10029: } else {
10030: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10031: $args->{'clonedomain'},$args->{'clonecourse'});
10032: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10033: if (grep(/^\*$/,@cloners)) {
10034: $can_clone = 1;
10035: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10036: $can_clone = 1;
10037: } else {
1.908 raeburn 10038: my $ccrole = 'cc';
1.944 raeburn 10039: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10040: $ccrole = 'co';
10041: }
1.578 raeburn 10042: my %roleshash =
10043: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10044: $args->{'ccdomain'},
1.908 raeburn 10045: 'userroles',['active'],[$ccrole],
1.578 raeburn 10046: [$args->{'clonedomain'}]);
1.908 raeburn 10047: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10048: $can_clone = 1;
10049: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10050: $can_clone = 1;
10051: } else {
1.944 raeburn 10052: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10053: $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'});
10054: } else {
10055: $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'});
10056: }
1.578 raeburn 10057: }
1.566 albertel 10058: }
1.578 raeburn 10059: }
1.566 albertel 10060: }
10061: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10062: }
10063:
1.444 albertel 10064: sub construct_course {
1.885 raeburn 10065: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10066: my $outcome;
1.541 raeburn 10067: my $linefeed = '<br />'."\n";
10068: if ($context eq 'auto') {
10069: $linefeed = "\n";
10070: }
1.566 albertel 10071:
10072: #
10073: # Are we cloning?
10074: #
10075: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10076: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10077: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10078: if ($context ne 'auto') {
1.578 raeburn 10079: if ($clonemsg ne '') {
10080: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10081: }
1.566 albertel 10082: }
10083: $outcome .= $clonemsg.$linefeed;
10084:
10085: if (!$can_clone) {
10086: return (0,$outcome);
10087: }
10088: }
10089:
1.444 albertel 10090: #
10091: # Open course
10092: #
10093: my $crstype = lc($args->{'crstype'});
10094: my %cenv=();
10095: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10096: $args->{'cdescr'},
10097: $args->{'curl'},
10098: $args->{'course_home'},
10099: $args->{'nonstandard'},
10100: $args->{'crscode'},
10101: $args->{'ccuname'}.':'.
10102: $args->{'ccdomain'},
1.882 raeburn 10103: $args->{'crstype'},
1.885 raeburn 10104: $cnum,$context,$category);
1.444 albertel 10105:
10106: # Note: The testing routines depend on this being output; see
10107: # Utils::Course. This needs to at least be output as a comment
10108: # if anyone ever decides to not show this, and Utils::Course::new
10109: # will need to be suitably modified.
1.541 raeburn 10110: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10111: if ($$courseid =~ /^error:/) {
10112: return (0,$outcome);
10113: }
10114:
1.444 albertel 10115: #
10116: # Check if created correctly
10117: #
1.479 albertel 10118: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10119: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10120: if ($crsuhome eq 'no_host') {
10121: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10122: return (0,$outcome);
10123: }
1.541 raeburn 10124: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10125:
1.444 albertel 10126: #
1.566 albertel 10127: # Do the cloning
10128: #
10129: if ($can_clone && $cloneid) {
10130: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10131: if ($context ne 'auto') {
10132: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10133: }
10134: $outcome .= $clonemsg.$linefeed;
10135: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10136: # Copy all files
1.637 www 10137: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10138: # Restore URL
1.566 albertel 10139: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10140: # Restore title
1.566 albertel 10141: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 10142: # Restore creation date, creator and creation context.
10143: $cenv{'internal.created'}=$oldcenv{'internal.created'};
10144: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
10145: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 10146: # Mark as cloned
1.566 albertel 10147: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10148: # Need to clone grading mode
10149: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10150: $cenv{'grading'}=$newenv{'grading'};
10151: # Do not clone these environment entries
10152: &Apache::lonnet::del('environment',
10153: ['default_enrollment_start_date',
10154: 'default_enrollment_end_date',
10155: 'question.email',
10156: 'policy.email',
10157: 'comment.email',
10158: 'pch.users.denied',
1.725 raeburn 10159: 'plc.users.denied',
10160: 'hidefromcat',
10161: 'categories'],
1.638 www 10162: $$crsudom,$$crsunum);
1.444 albertel 10163: }
1.566 albertel 10164:
1.444 albertel 10165: #
10166: # Set environment (will override cloned, if existing)
10167: #
10168: my @sections = ();
10169: my @xlists = ();
10170: if ($args->{'crstype'}) {
10171: $cenv{'type'}=$args->{'crstype'};
10172: }
10173: if ($args->{'crsid'}) {
10174: $cenv{'courseid'}=$args->{'crsid'};
10175: }
10176: if ($args->{'crscode'}) {
10177: $cenv{'internal.coursecode'}=$args->{'crscode'};
10178: }
10179: if ($args->{'crsquota'} ne '') {
10180: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10181: } else {
10182: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10183: }
10184: if ($args->{'ccuname'}) {
10185: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10186: ':'.$args->{'ccdomain'};
10187: } else {
10188: $cenv{'internal.courseowner'} = $args->{'curruser'};
10189: }
10190: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10191: if ($args->{'crssections'}) {
10192: $cenv{'internal.sectionnums'} = '';
10193: if ($args->{'crssections'} =~ m/,/) {
10194: @sections = split/,/,$args->{'crssections'};
10195: } else {
10196: $sections[0] = $args->{'crssections'};
10197: }
10198: if (@sections > 0) {
10199: foreach my $item (@sections) {
10200: my ($sec,$gp) = split/:/,$item;
10201: my $class = $args->{'crscode'}.$sec;
10202: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10203: $cenv{'internal.sectionnums'} .= $item.',';
10204: unless ($addcheck eq 'ok') {
10205: push @badclasses, $class;
10206: }
10207: }
10208: $cenv{'internal.sectionnums'} =~ s/,$//;
10209: }
10210: }
10211: # do not hide course coordinator from staff listing,
10212: # even if privileged
10213: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10214: # add crosslistings
10215: if ($args->{'crsxlist'}) {
10216: $cenv{'internal.crosslistings'}='';
10217: if ($args->{'crsxlist'} =~ m/,/) {
10218: @xlists = split/,/,$args->{'crsxlist'};
10219: } else {
10220: $xlists[0] = $args->{'crsxlist'};
10221: }
10222: if (@xlists > 0) {
10223: foreach my $item (@xlists) {
10224: my ($xl,$gp) = split/:/,$item;
10225: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10226: $cenv{'internal.crosslistings'} .= $item.',';
10227: unless ($addcheck eq 'ok') {
10228: push @badclasses, $xl;
10229: }
10230: }
10231: $cenv{'internal.crosslistings'} =~ s/,$//;
10232: }
10233: }
10234: if ($args->{'autoadds'}) {
10235: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10236: }
10237: if ($args->{'autodrops'}) {
10238: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10239: }
10240: # check for notification of enrollment changes
10241: my @notified = ();
10242: if ($args->{'notify_owner'}) {
10243: if ($args->{'ccuname'} ne '') {
10244: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10245: }
10246: }
10247: if ($args->{'notify_dc'}) {
10248: if ($uname ne '') {
1.630 raeburn 10249: push(@notified,$uname.':'.$udom);
1.444 albertel 10250: }
10251: }
10252: if (@notified > 0) {
10253: my $notifylist;
10254: if (@notified > 1) {
10255: $notifylist = join(',',@notified);
10256: } else {
10257: $notifylist = $notified[0];
10258: }
10259: $cenv{'internal.notifylist'} = $notifylist;
10260: }
10261: if (@badclasses > 0) {
10262: my %lt=&Apache::lonlocal::texthash(
10263: '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',
10264: 'dnhr' => 'does not have rights to access enrollment in these classes',
10265: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10266: );
1.541 raeburn 10267: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10268: ' ('.$lt{'adby'}.')';
10269: if ($context eq 'auto') {
10270: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10271: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10272: foreach my $item (@badclasses) {
10273: if ($context eq 'auto') {
10274: $outcome .= " - $item\n";
10275: } else {
10276: $outcome .= "<li>$item</li>\n";
10277: }
10278: }
10279: if ($context eq 'auto') {
10280: $outcome .= $linefeed;
10281: } else {
1.566 albertel 10282: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10283: }
10284: }
1.444 albertel 10285: }
10286: if ($args->{'no_end_date'}) {
10287: $args->{'endaccess'} = 0;
10288: }
10289: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10290: $cenv{'internal.autoend'}=$args->{'enrollend'};
10291: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10292: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10293: if ($args->{'showphotos'}) {
10294: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10295: }
10296: $cenv{'internal.authtype'} = $args->{'authtype'};
10297: $cenv{'internal.autharg'} = $args->{'autharg'};
10298: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10299: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10300: 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');
10301: if ($context eq 'auto') {
10302: $outcome .= $krb_msg;
10303: } else {
1.566 albertel 10304: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10305: }
10306: $outcome .= $linefeed;
1.444 albertel 10307: }
10308: }
10309: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10310: if ($args->{'setpolicy'}) {
10311: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10312: }
10313: if ($args->{'setcontent'}) {
10314: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10315: }
10316: }
10317: if ($args->{'reshome'}) {
10318: $cenv{'reshome'}=$args->{'reshome'}.'/';
10319: $cenv{'reshome'}=~s/\/+$/\//;
10320: }
10321: #
10322: # course has keyed access
10323: #
10324: if ($args->{'setkeys'}) {
10325: $cenv{'keyaccess'}='yes';
10326: }
10327: # if specified, key authority is not course, but user
10328: # only active if keyaccess is yes
10329: if ($args->{'keyauth'}) {
1.487 albertel 10330: my ($user,$domain) = split(':',$args->{'keyauth'});
10331: $user = &LONCAPA::clean_username($user);
10332: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10333: if ($user ne '' && $domain ne '') {
1.487 albertel 10334: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10335: }
10336: }
10337:
10338: if ($args->{'disresdis'}) {
10339: $cenv{'pch.roles.denied'}='st';
10340: }
10341: if ($args->{'disablechat'}) {
10342: $cenv{'plc.roles.denied'}='st';
10343: }
10344:
10345: # Record we've not yet viewed the Course Initialization Helper for this
10346: # course
10347: $cenv{'course.helper.not.run'} = 1;
10348: #
10349: # Use new Randomseed
10350: #
10351: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10352: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10353: #
10354: # The encryption code and receipt prefix for this course
10355: #
10356: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10357: $cenv{'internal.encpref'}=100+int(9*rand(99));
10358: #
10359: # By default, use standard grading
10360: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10361:
1.541 raeburn 10362: $outcome .= $linefeed.&mt('Setting environment').': '.
10363: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10364: #
10365: # Open all assignments
10366: #
10367: if ($args->{'openall'}) {
10368: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10369: my %storecontent = ($storeunder => time,
10370: $storeunder.'.type' => 'date_start');
10371:
10372: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10373: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10374: }
10375: #
10376: # Set first page
10377: #
10378: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10379: || ($cloneid)) {
1.445 albertel 10380: use LONCAPA::map;
1.444 albertel 10381: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10382:
10383: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10384: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10385:
1.444 albertel 10386: $outcome .= ($fatal?$errtext:'read ok').' - ';
10387: my $title; my $url;
10388: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10389: $title=&mt('Syllabus');
1.444 albertel 10390: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10391: } else {
1.963 raeburn 10392: $title=&mt('Table of Contents');
1.444 albertel 10393: $url='/adm/navmaps';
10394: }
1.445 albertel 10395:
10396: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10397: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10398:
10399: if ($errtext) { $fatal=2; }
1.541 raeburn 10400: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10401: }
1.566 albertel 10402:
10403: return (1,$outcome);
1.444 albertel 10404: }
10405:
10406: ############################################################
10407: ############################################################
10408:
1.953 droeschl 10409: #SD
10410: # only Community and Course, or anything else?
1.378 raeburn 10411: sub course_type {
10412: my ($cid) = @_;
10413: if (!defined($cid)) {
10414: $cid = $env{'request.course.id'};
10415: }
1.404 albertel 10416: if (defined($env{'course.'.$cid.'.type'})) {
10417: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10418: } else {
10419: return 'Course';
1.377 raeburn 10420: }
10421: }
1.156 albertel 10422:
1.406 raeburn 10423: sub group_term {
10424: my $crstype = &course_type();
10425: my %names = (
10426: 'Course' => 'group',
1.865 raeburn 10427: 'Community' => 'group',
1.406 raeburn 10428: );
10429: return $names{$crstype};
10430: }
10431:
1.902 raeburn 10432: sub course_types {
10433: my @types = ('official','unofficial','community');
10434: my %typename = (
10435: official => 'Official course',
10436: unofficial => 'Unofficial course',
10437: community => 'Community',
10438: );
10439: return (\@types,\%typename);
10440: }
10441:
1.156 albertel 10442: sub icon {
10443: my ($file)=@_;
1.505 albertel 10444: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10445: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10446: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10447: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10448: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10449: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10450: $curfext.".gif") {
10451: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10452: $curfext.".gif";
10453: }
10454: }
1.249 albertel 10455: return &lonhttpdurl($iconname);
1.154 albertel 10456: }
1.84 albertel 10457:
1.575 albertel 10458: sub lonhttpdurl {
1.692 www 10459: #
10460: # Had been used for "small fry" static images on separate port 8080.
10461: # Modify here if lightweight http functionality desired again.
10462: # Currently eliminated due to increasing firewall issues.
10463: #
1.575 albertel 10464: my ($url)=@_;
1.692 www 10465: return $url;
1.215 albertel 10466: }
10467:
1.213 albertel 10468: sub connection_aborted {
10469: my ($r)=@_;
10470: $r->print(" ");$r->rflush();
10471: my $c = $r->connection;
10472: return $c->aborted();
10473: }
10474:
1.221 foxr 10475: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10476: # strings as 'strings'.
10477: sub escape_single {
1.221 foxr 10478: my ($input) = @_;
1.223 albertel 10479: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10480: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10481: return $input;
10482: }
1.223 albertel 10483:
1.222 foxr 10484: # Same as escape_single, but escape's "'s This
10485: # can be used for "strings"
10486: sub escape_double {
10487: my ($input) = @_;
10488: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10489: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10490: return $input;
10491: }
1.223 albertel 10492:
1.222 foxr 10493: # Escapes the last element of a full URL.
10494: sub escape_url {
10495: my ($url) = @_;
1.238 raeburn 10496: my @urlslices = split(/\//, $url,-1);
1.369 www 10497: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10498: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10499: }
1.462 albertel 10500:
1.820 raeburn 10501: sub compare_arrays {
10502: my ($arrayref1,$arrayref2) = @_;
10503: my (@difference,%count);
10504: @difference = ();
10505: %count = ();
10506: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10507: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10508: foreach my $element (keys(%count)) {
10509: if ($count{$element} == 1) {
10510: push(@difference,$element);
10511: }
10512: }
10513: }
10514: return @difference;
10515: }
10516:
1.817 bisitz 10517: # -------------------------------------------------------- Initialize user login
1.462 albertel 10518: sub init_user_environment {
1.463 albertel 10519: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10520: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10521:
10522: my $public=($username eq 'public' && $domain eq 'public');
10523:
10524: # See if old ID present, if so, remove
10525:
10526: my ($filename,$cookie,$userroles);
10527: my $now=time;
10528:
10529: if ($public) {
10530: my $max_public=100;
10531: my $oldest;
10532: my $oldest_time=0;
10533: for(my $next=1;$next<=$max_public;$next++) {
10534: if (-e $lonids."/publicuser_$next.id") {
10535: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10536: if ($mtime<$oldest_time || !$oldest_time) {
10537: $oldest_time=$mtime;
10538: $oldest=$next;
10539: }
10540: } else {
10541: $cookie="publicuser_$next";
10542: last;
10543: }
10544: }
10545: if (!$cookie) { $cookie="publicuser_$oldest"; }
10546: } else {
1.463 albertel 10547: # if this isn't a robot, kill any existing non-robot sessions
10548: if (!$args->{'robot'}) {
10549: opendir(DIR,$lonids);
10550: while ($filename=readdir(DIR)) {
10551: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10552: unlink($lonids.'/'.$filename);
10553: }
1.462 albertel 10554: }
1.463 albertel 10555: closedir(DIR);
1.462 albertel 10556: }
10557: # Give them a new cookie
1.463 albertel 10558: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10559: : $now.$$.int(rand(10000)));
1.463 albertel 10560: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10561:
10562: # Initialize roles
10563:
10564: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10565: }
10566: # ------------------------------------ Check browser type and MathML capability
10567:
10568: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10569: $clientunicode,$clientos) = &decode_user_agent($r);
10570:
10571: # ------------------------------------------------------------- Get environment
10572:
10573: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10574: my ($tmp) = keys(%userenv);
10575: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10576: } else {
10577: undef(%userenv);
10578: }
10579: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10580: $form->{'interface'}=$userenv{'interface'};
10581: }
10582: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10583:
10584: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10585: foreach my $option ('interface','localpath','localres') {
10586: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10587: }
10588: # --------------------------------------------------------- Write first profile
10589:
10590: {
10591: my %initial_env =
10592: ("user.name" => $username,
10593: "user.domain" => $domain,
10594: "user.home" => $authhost,
10595: "browser.type" => $clientbrowser,
10596: "browser.version" => $clientversion,
10597: "browser.mathml" => $clientmathml,
10598: "browser.unicode" => $clientunicode,
10599: "browser.os" => $clientos,
10600: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10601: "request.course.fn" => '',
10602: "request.course.uri" => '',
10603: "request.course.sec" => '',
10604: "request.role" => 'cm',
10605: "request.role.adv" => $env{'user.adv'},
10606: "request.host" => $ENV{'REMOTE_ADDR'},);
10607:
10608: if ($form->{'localpath'}) {
10609: $initial_env{"browser.localpath"} = $form->{'localpath'};
10610: $initial_env{"browser.localres"} = $form->{'localres'};
10611: }
10612:
10613: if ($form->{'interface'}) {
10614: $form->{'interface'}=~s/\W//gs;
10615: $initial_env{"browser.interface"} = $form->{'interface'};
10616: $env{'browser.interface'}=$form->{'interface'};
10617: }
10618:
1.724 raeburn 10619: foreach my $tool ('aboutme','blog','portfolio') {
10620: $userenv{'availabletools.'.$tool} =
10621: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10622: }
10623:
1.864 raeburn 10624: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10625: $userenv{'canrequest.'.$crstype} =
10626: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10627: 'reload','requestcourses');
10628: }
10629:
1.462 albertel 10630: $env{'user.environment'} = "$lonids/$cookie.id";
10631:
10632: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10633: &GDBM_WRCREAT(),0640)) {
10634: &_add_to_env(\%disk_env,\%initial_env);
10635: &_add_to_env(\%disk_env,\%userenv,'environment.');
10636: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10637: if (ref($args->{'extra_env'})) {
10638: &_add_to_env(\%disk_env,$args->{'extra_env'});
10639: }
1.462 albertel 10640: untie(%disk_env);
10641: } else {
1.705 tempelho 10642: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10643: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10644: return 'error: '.$!;
10645: }
10646: }
10647: $env{'request.role'}='cm';
10648: $env{'request.role.adv'}=$env{'user.adv'};
10649: $env{'browser.type'}=$clientbrowser;
10650:
10651: return $cookie;
10652:
10653: }
10654:
10655: sub _add_to_env {
10656: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10657: if (ref($env_data) eq 'HASH') {
10658: while (my ($key,$value) = each(%$env_data)) {
10659: $idf->{$prefix.$key} = $value;
10660: $env{$prefix.$key} = $value;
10661: }
1.462 albertel 10662: }
10663: }
10664:
1.685 tempelho 10665: # --- Get the symbolic name of a problem and the url
10666: sub get_symb {
10667: my ($request,$silent) = @_;
1.726 raeburn 10668: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10669: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10670: if ($symb eq '') {
10671: if (!$silent) {
10672: $request->print("Unable to handle ambiguous references:$url:.");
10673: return ();
10674: }
10675: }
10676: &Apache::lonenc::check_decrypt(\$symb);
10677: return ($symb);
10678: }
10679:
10680: # --------------------------------------------------------------Get annotation
10681:
10682: sub get_annotation {
10683: my ($symb,$enc) = @_;
10684:
10685: my $key = $symb;
10686: if (!$enc) {
10687: $key =
10688: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10689: }
10690: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10691: return $annotation{$key};
10692: }
10693:
10694: sub clean_symb {
1.731 raeburn 10695: my ($symb,$delete_enc) = @_;
1.685 tempelho 10696:
10697: &Apache::lonenc::check_decrypt(\$symb);
10698: my $enc = $env{'request.enc'};
1.731 raeburn 10699: if ($delete_enc) {
1.730 raeburn 10700: delete($env{'request.enc'});
10701: }
1.685 tempelho 10702:
10703: return ($symb,$enc);
10704: }
1.462 albertel 10705:
1.41 ng 10706: =pod
10707:
10708: =back
10709:
1.112 bowersj2 10710: =cut
1.41 ng 10711:
1.112 bowersj2 10712: 1;
10713: __END__;
1.41 ng 10714:
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