Annotation of loncom/interface/loncommon.pm, revision 1.945
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.944 raeburn 4: # $Id: loncommon.pm,v 1.943 2010/02/25 03:43:20 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.824 bisitz 410: // <![CDATA[
1.74 www 411: var stdeditbrowser;
1.793 raeburn 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74 www 413: var url = '/adm/pickstudent?';
414: var filter;
1.558 albertel 415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
1.74 www 418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
1.111 www 425: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 426: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 427: var title = 'Student_Browser';
1.74 www 428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
1.824 bisitz 433: // ]]>
1.74 www 434: </script>
435: ENDSTDBRW
436: }
1.42 matthew 437:
1.74 www 438: sub selectstudent_link {
1.793 raeburn 439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258 albertel 441: if ($env{'request.course.id'}) {
1.302 albertel 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
1.111 www 445: return '';
446: }
1.793 raeburn 447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
1.74 www 453: }
1.258 albertel 454: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793 raeburn 455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
1.111 www 459: }
460: return '';
1.91 www 461: }
462:
1.653 raeburn 463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
1.776 bisitz 465: <script type="text/javascript" language="JavaScript">
1.824 bisitz 466: // <![CDATA[
1.653 raeburn 467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
1.824 bisitz 479: // ]]>
1.653 raeburn 480: </script>
481: ENDAUTHORBRW
482: }
483:
1.91 www 484: sub coursebrowser_javascript {
1.909 raeburn 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932 raeburn 486: my $wintitle = 'Course_Browser';
1.931 raeburn 487: if ($crstype eq 'Community') {
1.932 raeburn 488: $wintitle = 'Community_Browser';
1.909 raeburn 489: }
1.876 raeburn 490: my $id_functions = &javascript_index_functions();
491: my $output = '
1.776 bisitz 492: <script type="text/javascript" language="JavaScript">
1.824 bisitz 493: // <![CDATA[
1.468 raeburn 494: var stdeditbrowser;'."\n";
1.876 raeburn 495:
496: $output .= <<"ENDSTDBRW";
1.909 raeburn 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 498: var url = '/adm/pickcourse?';
1.895 raeburn 499: var formid = getFormIdByName(formname);
1.876 raeburn 500: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
1.91 www 506: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
1.468 raeburn 509: if (extra_element !=null && extra_element != '') {
1.594 raeburn 510: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
1.234 raeburn 515: }
1.468 raeburn 516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
1.800 raeburn 519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
1.468 raeburn 523: }
524: }
1.230 raeburn 525: }
1.909 raeburn 526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
1.872 raeburn 532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
1.293 raeburn 537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
1.909 raeburn 540: var title = '$wintitle';
1.91 www 541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
1.876 raeburn 546: $id_functions
547: ENDSTDBRW
1.905 raeburn 548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876 raeburn 550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
1.468 raeburn 577:
1.876 raeburn 578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 589: }
590: }
591: }
1.876 raeburn 592: return userdom;
593: }
594:
595: ENDJS
1.468 raeburn 596:
1.876 raeburn 597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
1.888 raeburn 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
1.881 raeburn 616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
1.888 raeburn 618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
1.876 raeburn 621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
1.888 raeburn 628: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
1.888 raeburn 631: var unameid = getIndexByName(formid,uname);
1.876 raeburn 632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
1.876 raeburn 648: }
649: }
1.468 raeburn 650: }
651: }
652: }
1.876 raeburn 653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
1.468 raeburn 658: }
659:
660: sub setsec_javascript {
1.905 raeburn 661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
1.468 raeburn 683: my $setsections = qq|
684: function setSect(sectionlist) {
1.629 raeburn 685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
1.468 raeburn 689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
1.91 www 715: }
1.905 raeburn 716:
717: function setRole(crstype) {
1.468 raeburn 718: |;
1.905 raeburn 719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
1.468 raeburn 756: return $setsections;
757: }
758:
1.91 www 759: sub selectcourse_link {
1.909 raeburn 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
1.871 raeburn 763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
1.909 raeburn 765: $linktext = &mt('Select Community');
1.906 raeburn 766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
1.909 raeburn 768: $type = '';
1.871 raeburn 769: }
1.787 bisitz 770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 775: ."'>".$linktext.'</a>'
1.787 bisitz 776: .'</span>';
1.74 www 777: }
1.42 matthew 778:
1.653 raeburn 779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
1.876 raeburn 785: sub selectuser_link {
1.881 raeburn 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 787: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 790: ');">'.$linktext.'</a>';
1.876 raeburn 791: }
792:
1.273 raeburn 793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
1.543 albertel 809: }
810: } else {
1.273 raeburn 811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
1.656 www 818: sub select_timezone {
1.659 raeburn 819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
1.657 raeburn 828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
1.656 www 835: }
836: $output.="</select>";
837: return $output;
838: }
1.273 raeburn 839:
1.687 raeburn 840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 858: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
1.792 raeburn 891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
1.42 matthew 906: =pod
1.36 matthew 907:
1.648 raeburn 908: =item * &linked_select_forms(...)
1.36 matthew 909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 914: order unless a defined order is provided.
1.36 matthew 915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
1.112 bowersj2 920: =item * $formname, the name of the <form> tag
1.36 matthew 921:
1.112 bowersj2 922: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 923:
1.112 bowersj2 924: =item * $firstdefault, the default value for the first menu
1.36 matthew 925:
1.112 bowersj2 926: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 927:
1.112 bowersj2 928: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 929:
1.112 bowersj2 930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 931:
1.609 raeburn 932: =item * $menuorder, the order of values in the first menu
933:
1.41 ng 934: =back
935:
1.36 matthew 936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
1.41 ng 939: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
1.112 bowersj2 943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
1.609 raeburn 950: },
951: order => ['B4','B3','B1','B2'],
1.112 bowersj2 952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
1.609 raeburn 959: },
960: order => ['C2','C1','C3'],
1.112 bowersj2 961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
1.609 raeburn 972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 974: }
975: );
1.36 matthew 976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
1.609 raeburn 985: $hashref,
986: $menuorder,
1.36 matthew 987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
1.776 bisitz 992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 993: $result.="// <![CDATA[\n";
1.36 matthew 994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1001: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1.36 matthew 1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1.143 matthew 1032: $second.options[i].value = values[i];
1.36 matthew 1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1.824 bisitz 1039: // ]]>
1.36 matthew 1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1.36 matthew 1049: $result.=" <option value=\"$value\" ";
1.253 albertel 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1.36 matthew 1064: $result.=" <option value=\"$value\" ";
1.253 albertel 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1066: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1.45 matthew 1073: =pod
1.44 bowersj2 1074:
1.648 raeburn 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 1076:
1.112 bowersj2 1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1.44 bowersj2 1094:
1095: =cut
1096:
1097: sub help_open_topic {
1.48 bowersj2 1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1.44 bowersj2 1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1.48 bowersj2 1106: my $template = "";
1107: my $link;
1.572 banghart 1108:
1.159 www 1109: $topic=~s/\W/\_/g;
1.44 bowersj2 1110:
1.572 banghart 1111: if (!$stayOnPage) {
1.72 bowersj2 1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1113: } else {
1.48 bowersj2 1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1.755 neumanie 1118: if ($text ne "") {
1.763 bisitz 1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1.48 bowersj2 1122: }
1123:
1.763 bisitz 1124: # (Always) Add the graphic
1.179 matthew 1125: my $title = &mt('Online Help');
1.667 raeburn 1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.934 droeschl 1130: .' title="'.$title.'" style="vertical-align:middle;"'
1.763 bisitz 1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1.44 bowersj2 1135: return $template;
1136:
1.106 bowersj2 1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1.732 raeburn 1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1.106 bowersj2 1144: my $addOther = '';
1.732 raeburn 1145: if ($topic) {
1.763 bisitz 1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1.732 raeburn 1159: unless ($not_author) {
1.763 bisitz 1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1.732 raeburn 1164: }
1.763 bisitz 1165: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1166: return $out;
1.172 www 1167: }
1168:
1.430 albertel 1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1.907 raeburn 1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1174: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1.824 bisitz 1193: // <![CDATA[
1.430 albertel 1194: banner_link = '$banner_link';
1.824 bisitz 1195: // ]]>
1.430 albertel 1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1.193 raeburn 1202: sub help_open_menu {
1.430 albertel 1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1204: = @_;
1.430 albertel 1205: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1206: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1207: # if environment.remote is on (using remote control UI)
1.798 tempelho 1208: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1209: $stayOnPage=1;
1.430 albertel 1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1.436 albertel 1230: $text = &mt($text);
1.572 banghart 1231: my $stay_on_page =
1.798 tempelho 1232: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1234: : "javascript:helpMenu('open')";
1.572 banghart 1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1236:
1.201 raeburn 1237: my $title = &mt('Get help');
1.436 albertel 1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1.798 tempelho 1249: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1250:
1251: my $width = 620;
1252: my $height = 600;
1.430 albertel 1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1.579 raeburn 1262: 'rows' => "110,*",},});
1.331 albertel 1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1.436 albertel 1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1.877 bisitz 1269: // <![CDATA[
1.253 albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1271: var banner_link = '';
1.243 raeburn 1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1.262 albertel 1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1.193 raeburn 1286: }
1.243 raeburn 1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1.430 albertel 1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1292: caller.document.close()
1293: caller.focus()
1.193 raeburn 1294: }
1.877 bisitz 1295: // END LON-CAPA Internal -->
1.253 albertel 1296: // ]]>
1.436 albertel 1297: </script>
1.193 raeburn 1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1.172 www 1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1304: unless ($env{'user.adv'}) { return ''; }
1.172 www 1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1308: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1309: $stayOnPage=1;
1310: }
1.184 albertel 1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1.172 www 1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1.379 albertel 1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1333: }
1334:
1335: # Add the graphic
1.179 matthew 1336: my $title = &mt('Report a Bug');
1.215 albertel 1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1338: $template .= <<"ENDTEMPLATE";
1.436 albertel 1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1348: unless ($env{'user.adv'}) { return ''; }
1.172 www 1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1352: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1.173 www 1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1377: }
1378:
1379: # Add the graphic
1.179 matthew 1380: my $title = &mt('View the FAQ');
1.215 albertel 1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1382: $template .= <<"ENDTEMPLATE";
1.436 albertel 1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1.44 bowersj2 1388: }
1.37 matthew 1389:
1.180 matthew 1390: ###############################################################
1391: ###############################################################
1392:
1.45 matthew 1393: =pod
1394:
1.648 raeburn 1395: =item * &change_content_javascript():
1.256 matthew 1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &changable_area($name,$origContent):
1.256 matthew 1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1.258 albertel 1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1.648 raeburn 1474: =item * &viewport_geometry_js
1.590 raeburn 1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1.648 raeburn 1521: =item * &viewport_size_js()
1.590 raeburn 1522:
1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1.648 raeburn 1545: =item * &resize_textarea_js()
1.565 albertel 1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1.648 raeburn 1554: =back
1.565 albertel 1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1.590 raeburn 1559: my $geometry = &viewport_geometry_js();
1.565 albertel 1560: return <<"RESIZE";
1561: <script type="text/javascript">
1.824 bisitz 1562: // <![CDATA[
1.590 raeburn 1563: $geometry
1.565 albertel 1564:
1.588 albertel 1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1.565 albertel 1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1.588 albertel 1588: var textarea_top = getY(textarea);
1.565 albertel 1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1.588 albertel 1591: var bottom_top = getY(bottom);
1.565 albertel 1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1.588 albertel 1594: var fudge = 23;
1.565 albertel 1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1.824 bisitz 1601: // ]]>
1.565 albertel 1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1.256 matthew 1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1.648 raeburn 1620: =item * &csv_translate($text)
1.37 matthew 1621:
1.185 www 1622: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1623: format.
1624:
1625: =cut
1626:
1.180 matthew 1627: ###############################################################
1628: ###############################################################
1.37 matthew 1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1.209 albertel 1632: $text =~ s/\n/ /g;
1.37 matthew 1633: return $text;
1634: }
1.180 matthew 1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1.648 raeburn 1641: =item * &define_excel_formats()
1.180 matthew 1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1.256 matthew 1659: =item h4
1660:
1661: =item i
1662:
1.180 matthew 1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1686: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1687: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1688: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1.113 bowersj2 1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &create_workbook()
1.255 matthew 1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1.258 albertel 1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 1722: $r->print(
1723: '<p class="LC_error">'
1724: .&mt('Problems occurred in creating the new Excel file.')
1725: .' '.&mt('This error has been logged.')
1726: .' '.&mt('Please alert your LON-CAPA administrator.')
1727: .'</p>'
1728: );
1.255 matthew 1729: return (undef);
1730: }
1731: #
1732: $workbook->set_tempdir('/home/httpd/perl/tmp');
1733: #
1734: my $format = &Apache::loncommon::define_excel_formats($workbook);
1735: return ($workbook,$filename,$format);
1736: }
1737:
1738: ###############################################################
1739: ###############################################################
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &create_text_file()
1.113 bowersj2 1744:
1.542 raeburn 1745: Create a file to write to and eventually make available to the user.
1.256 matthew 1746: If file creation fails, outputs an error message on the request object and
1747: return undefs.
1.113 bowersj2 1748:
1.256 matthew 1749: Inputs: Apache request object, and file suffix
1.113 bowersj2 1750:
1.256 matthew 1751: Returns (undef) on failure,
1752: Filehandle and filename on success.
1.113 bowersj2 1753:
1754: =cut
1755:
1.256 matthew 1756: ###############################################################
1757: ###############################################################
1758: sub create_text_file {
1759: my ($r,$suffix) = @_;
1760: if (! defined($suffix)) { $suffix = 'txt'; };
1761: my $fh;
1762: my $filename = '/prtspool/'.
1.258 albertel 1763: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1764: time.'_'.rand(1000000000).'.'.$suffix;
1765: $fh = Apache::File->new('>/home/httpd'.$filename);
1766: if (! defined($fh)) {
1767: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 1768: $r->print(
1769: '<p class="LC_error">'
1770: .&mt('Problems occurred in creating the output file.')
1771: .' '.&mt('This error has been logged.')
1772: .' '.&mt('Please alert your LON-CAPA administrator.')
1773: .'</p>'
1774: );
1.113 bowersj2 1775: }
1.256 matthew 1776: return ($fh,$filename)
1.113 bowersj2 1777: }
1778:
1779:
1.256 matthew 1780: =pod
1.113 bowersj2 1781:
1782: =back
1783:
1784: =cut
1.37 matthew 1785:
1786: ###############################################################
1.33 matthew 1787: ## Home server <option> list generating code ##
1788: ###############################################################
1.35 matthew 1789:
1.169 www 1790: # ------------------------------------------
1791:
1792: sub domain_select {
1793: my ($name,$value,$multiple)=@_;
1794: my %domains=map {
1.514 albertel 1795: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1796: } &Apache::lonnet::all_domains();
1.169 www 1797: if ($multiple) {
1798: $domains{''}=&mt('Any domain');
1.550 albertel 1799: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1800: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1801: } else {
1.550 albertel 1802: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1803: return &select_form($name,$value,%domains);
1804: }
1805: }
1806:
1.282 albertel 1807: #-------------------------------------------
1808:
1809: =pod
1810:
1.519 raeburn 1811: =head1 Routines for form select boxes
1812:
1813: =over 4
1814:
1.648 raeburn 1815: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1816:
1817: Returns a string containing a <select> element int multiple mode
1818:
1819:
1820: Args:
1821: $name - name of the <select> element
1.506 raeburn 1822: $value - scalar or array ref of values that should already be selected
1.282 albertel 1823: $size - number of rows long the select element is
1.283 albertel 1824: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1825: (shown text should already have been &mt())
1.506 raeburn 1826: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1827:
1.282 albertel 1828: =cut
1829:
1830: #-------------------------------------------
1.169 www 1831: sub multiple_select_form {
1.284 albertel 1832: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1833: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1834: my $output='';
1.191 matthew 1835: if (! defined($size)) {
1836: $size = 4;
1.283 albertel 1837: if (scalar(keys(%$hash))<4) {
1838: $size = scalar(keys(%$hash));
1.191 matthew 1839: }
1840: }
1.734 bisitz 1841: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1842: my @order;
1.506 raeburn 1843: if (ref($order) eq 'ARRAY') {
1844: @order = @{$order};
1845: } else {
1846: @order = sort(keys(%$hash));
1.501 banghart 1847: }
1848: if (exists($$hash{'select_form_order'})) {
1849: @order = @{$$hash{'select_form_order'}};
1850: }
1851:
1.284 albertel 1852: foreach my $key (@order) {
1.356 albertel 1853: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1854: $output.='selected="selected" ' if ($selected{$key});
1855: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1856: }
1857: $output.="</select>\n";
1858: return $output;
1859: }
1860:
1.88 www 1861: #-------------------------------------------
1862:
1863: =pod
1864:
1.648 raeburn 1865: =item * &select_form($defdom,$name,%hash)
1.88 www 1866:
1867: Returns a string containing a <select name='$name' size='1'> form to
1868: allow a user to select options from a hash option_name => displayed text.
1869: See lonrights.pm for an example invocation and use.
1870:
1871: =cut
1872:
1873: #-------------------------------------------
1874: sub select_form {
1875: my ($def,$name,%hash) = @_;
1876: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1877: my @keys;
1878: if (exists($hash{'select_form_order'})) {
1879: @keys=@{$hash{'select_form_order'}};
1880: } else {
1881: @keys=sort(keys(%hash));
1882: }
1.356 albertel 1883: foreach my $key (@keys) {
1884: $selectform.=
1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1886: ($key eq $def ? 'selected="selected" ' : '').
1.922 bisitz 1887: ">".$hash{$key}."</option>\n";
1.88 www 1888: }
1889: $selectform.="</select>";
1890: return $selectform;
1891: }
1892:
1.475 www 1893: # For display filters
1894:
1895: sub display_filter {
1896: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1900: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1901: '</label></span> <span class="LC_nobreak">'.
1.475 www 1902: &mt('Filter [_1]',
1.477 www 1903: &select_form($env{'form.displayfilter'},
1904: 'displayfilter',
1905: ('currentfolder' => 'Current folder/page',
1906: 'containing' => 'Containing phrase',
1907: 'none' => 'None'))).
1.714 bisitz 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1909: }
1910:
1.167 www 1911: sub gradeleveldescription {
1912: my $gradelevel=shift;
1913: my %gradelevels=(0 => 'Not specified',
1914: 1 => 'Grade 1',
1915: 2 => 'Grade 2',
1916: 3 => 'Grade 3',
1917: 4 => 'Grade 4',
1918: 5 => 'Grade 5',
1919: 6 => 'Grade 6',
1920: 7 => 'Grade 7',
1921: 8 => 'Grade 8',
1922: 9 => 'Grade 9',
1923: 10 => 'Grade 10',
1924: 11 => 'Grade 11',
1925: 12 => 'Grade 12',
1926: 13 => 'Grade 13',
1927: 14 => '100 Level',
1928: 15 => '200 Level',
1929: 16 => '300 Level',
1930: 17 => '400 Level',
1931: 18 => 'Graduate Level');
1932: return &mt($gradelevels{$gradelevel});
1933: }
1934:
1.163 www 1935: sub select_level_form {
1936: my ($deflevel,$name)=@_;
1937: unless ($deflevel) { $deflevel=0; }
1.167 www 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1939: for (my $i=0; $i<=18; $i++) {
1940: $selectform.="<option value=\"$i\" ".
1.253 albertel 1941: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1942: ">".&gradeleveldescription($i)."</option>\n";
1943: }
1944: $selectform.="</select>";
1945: return $selectform;
1.163 www 1946: }
1.167 www 1947:
1.35 matthew 1948: #-------------------------------------------
1949:
1.45 matthew 1950: =pod
1951:
1.910 raeburn 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35 matthew 1953:
1954: Returns a string containing a <select name='$name' size='1'> form to
1955: allow a user to select the domain to preform an operation in.
1956: See loncreateuser.pm for an example invocation and use.
1957:
1.90 www 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
1959: selected");
1960:
1.743 raeburn 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1962:
1.910 raeburn 1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1964:
1965: The optional $incdoms is a reference to an array of domains which will be the only available options.
1.563 raeburn 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.34 matthew 1970: sub select_dom_form {
1.910 raeburn 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872 raeburn 1972: if ($onchange) {
1.874 raeburn 1973: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 1974: }
1.910 raeburn 1975: my @domains;
1976: if (ref($incdoms) eq 'ARRAY') {
1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1978: } else {
1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1980: }
1.90 www 1981: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1983: foreach my $dom (@domains) {
1984: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1986: if ($showdomdesc) {
1987: if ($dom ne '') {
1988: my $domdesc = &Apache::lonnet::domain($dom,'description');
1989: if ($domdesc ne '') {
1990: $selectdomain .= ' ('.$domdesc.')';
1991: }
1992: }
1993: }
1994: $selectdomain .= "</option>\n";
1.34 matthew 1995: }
1996: $selectdomain.="</select>";
1997: return $selectdomain;
1998: }
1999:
1.35 matthew 2000: #-------------------------------------------
2001:
1.45 matthew 2002: =pod
2003:
1.648 raeburn 2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2005:
1.586 raeburn 2006: input: 4 arguments (two required, two optional) -
2007: $domain - domain of new user
2008: $name - name of form element
2009: $default - Value of 'default' causes a default item to be first
2010: option, and selected by default.
2011: $hide - Value of 'hide' causes hiding of the name of the server,
2012: if 1 server found, or default, if 0 found.
1.594 raeburn 2013: output: returns 2 items:
1.586 raeburn 2014: (a) form element which contains either:
2015: (i) <select name="$name">
2016: <option value="$hostid1">$hostid $servers{$hostid}</option>
2017: <option value="$hostid2">$hostid $servers{$hostid}</option>
2018: </select>
2019: form item if there are multiple library servers in $domain, or
2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2021: if there is only one library server in $domain.
2022:
2023: (b) number of library servers found.
2024:
2025: See loncreateuser.pm for example of use.
1.35 matthew 2026:
2027: =cut
2028:
2029: #-------------------------------------------
1.586 raeburn 2030: sub home_server_form_item {
2031: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2032: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2033: my $result;
2034: my $numlib = keys(%servers);
2035: if ($numlib > 1) {
2036: $result .= '<select name="'.$name.'" />'."\n";
2037: if ($default) {
1.804 bisitz 2038: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2039: '</option>'."\n";
2040: }
2041: foreach my $hostid (sort(keys(%servers))) {
2042: $result.= '<option value="'.$hostid.'">'.
2043: $hostid.' '.$servers{$hostid}."</option>\n";
2044: }
2045: $result .= '</select>'."\n";
2046: } elsif ($numlib == 1) {
2047: my $hostid;
2048: foreach my $item (keys(%servers)) {
2049: $hostid = $item;
2050: }
2051: $result .= '<input type="hidden" name="'.$name.'" value="'.
2052: $hostid.'" />';
2053: if (!$hide) {
2054: $result .= $hostid.' '.$servers{$hostid};
2055: }
2056: $result .= "\n";
2057: } elsif ($default) {
2058: $result .= '<input type="hidden" name="'.$name.
2059: '" value="default" />';
2060: if (!$hide) {
2061: $result .= &mt('default');
2062: }
2063: $result .= "\n";
1.33 matthew 2064: }
1.586 raeburn 2065: return ($result,$numlib);
1.33 matthew 2066: }
1.112 bowersj2 2067:
2068: =pod
2069:
1.534 albertel 2070: =back
2071:
1.112 bowersj2 2072: =cut
1.87 matthew 2073:
2074: ###############################################################
1.112 bowersj2 2075: ## Decoding User Agent ##
1.87 matthew 2076: ###############################################################
2077:
2078: =pod
2079:
1.112 bowersj2 2080: =head1 Decoding the User Agent
2081:
2082: =over 4
2083:
2084: =item * &decode_user_agent()
1.87 matthew 2085:
2086: Inputs: $r
2087:
2088: Outputs:
2089:
2090: =over 4
2091:
1.112 bowersj2 2092: =item * $httpbrowser
1.87 matthew 2093:
1.112 bowersj2 2094: =item * $clientbrowser
1.87 matthew 2095:
1.112 bowersj2 2096: =item * $clientversion
1.87 matthew 2097:
1.112 bowersj2 2098: =item * $clientmathml
1.87 matthew 2099:
1.112 bowersj2 2100: =item * $clientunicode
1.87 matthew 2101:
1.112 bowersj2 2102: =item * $clientos
1.87 matthew 2103:
2104: =back
2105:
1.157 matthew 2106: =back
2107:
1.87 matthew 2108: =cut
2109:
2110: ###############################################################
2111: ###############################################################
2112: sub decode_user_agent {
1.247 albertel 2113: my ($r)=@_;
1.87 matthew 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2118: my $clientbrowser='unknown';
2119: my $clientversion='0';
2120: my $clientmathml='';
2121: my $clientunicode='0';
2122: for (my $i=0;$i<=$#browsertype;$i++) {
2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2125: $clientbrowser=$bname;
2126: $httpbrowser=~/$vreg/i;
2127: $clientversion=$1;
2128: $clientmathml=($clientversion>=$minv);
2129: $clientunicode=($clientversion>=$univ);
2130: }
2131: }
2132: my $clientos='unknown';
2133: if (($httpbrowser=~/linux/i) ||
2134: ($httpbrowser=~/unix/i) ||
2135: ($httpbrowser=~/ux/i) ||
2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2137: if (($httpbrowser=~/vax/i) ||
2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2139: if ($httpbrowser=~/next/i) { $clientos='next'; }
2140: if (($httpbrowser=~/mac/i) ||
2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2142: if ($httpbrowser=~/win/i) { $clientos='win'; }
2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2145: $clientunicode,$clientos,);
2146: }
2147:
1.32 matthew 2148: ###############################################################
2149: ## Authentication changing form generation subroutines ##
2150: ###############################################################
2151: ##
2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
2153: ## hash, and have reasonable default values.
2154: ##
2155: ## formname = the name given in the <form> tag.
1.35 matthew 2156: #-------------------------------------------
2157:
1.45 matthew 2158: =pod
2159:
1.112 bowersj2 2160: =head1 Authentication Routines
2161:
2162: =over 4
2163:
1.648 raeburn 2164: =item * &authform_xxxxxx()
1.35 matthew 2165:
2166: The authform_xxxxxx subroutines provide javascript and html forms which
2167: handle some of the conveniences required for authentication forms.
2168: This is not an optimal method, but it works.
2169:
2170: =over 4
2171:
1.112 bowersj2 2172: =item * authform_header
1.35 matthew 2173:
1.112 bowersj2 2174: =item * authform_authorwarning
1.35 matthew 2175:
1.112 bowersj2 2176: =item * authform_nochange
1.35 matthew 2177:
1.112 bowersj2 2178: =item * authform_kerberos
1.35 matthew 2179:
1.112 bowersj2 2180: =item * authform_internal
1.35 matthew 2181:
1.112 bowersj2 2182: =item * authform_filesystem
1.35 matthew 2183:
2184: =back
2185:
1.648 raeburn 2186: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2187:
1.35 matthew 2188: =cut
2189:
2190: #-------------------------------------------
1.32 matthew 2191: sub authform_header{
2192: my %in = (
2193: formname => 'cu',
1.80 albertel 2194: kerb_def_dom => '',
1.32 matthew 2195: @_,
2196: );
2197: $in{'formname'} = 'document.' . $in{'formname'};
2198: my $result='';
1.80 albertel 2199:
2200: #---------------------------------------------- Code for upper case translation
2201: my $Javascript_toUpperCase;
2202: unless ($in{kerb_def_dom}) {
2203: $Javascript_toUpperCase =<<"END";
2204: switch (choice) {
2205: case 'krb': currentform.elements[choicearg].value =
2206: currentform.elements[choicearg].value.toUpperCase();
2207: break;
2208: default:
2209: }
2210: END
2211: } else {
2212: $Javascript_toUpperCase = "";
2213: }
2214:
1.165 raeburn 2215: my $radioval = "'nochange'";
1.591 raeburn 2216: if (defined($in{'curr_authtype'})) {
2217: if ($in{'curr_authtype'} ne '') {
2218: $radioval = "'".$in{'curr_authtype'}."arg'";
2219: }
1.174 matthew 2220: }
1.165 raeburn 2221: my $argfield = 'null';
1.591 raeburn 2222: if (defined($in{'mode'})) {
1.165 raeburn 2223: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2224: if (defined($in{'curr_autharg'})) {
2225: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2226: $argfield = "'$in{'curr_autharg'}'";
2227: }
2228: }
2229: }
2230: }
2231:
1.32 matthew 2232: $result.=<<"END";
2233: var current = new Object();
1.165 raeburn 2234: current.radiovalue = $radioval;
2235: current.argfield = $argfield;
1.32 matthew 2236:
2237: function changed_radio(choice,currentform) {
2238: var choicearg = choice + 'arg';
2239: // If a radio button in changed, we need to change the argfield
2240: if (current.radiovalue != choice) {
2241: current.radiovalue = choice;
2242: if (current.argfield != null) {
2243: currentform.elements[current.argfield].value = '';
2244: }
2245: if (choice == 'nochange') {
2246: current.argfield = null;
2247: } else {
2248: current.argfield = choicearg;
2249: switch(choice) {
2250: case 'krb':
2251: currentform.elements[current.argfield].value =
2252: "$in{'kerb_def_dom'}";
2253: break;
2254: default:
2255: break;
2256: }
2257: }
2258: }
2259: return;
2260: }
1.22 www 2261:
1.32 matthew 2262: function changed_text(choice,currentform) {
2263: var choicearg = choice + 'arg';
2264: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2265: $Javascript_toUpperCase
1.32 matthew 2266: // clear old field
2267: if ((current.argfield != choicearg) && (current.argfield != null)) {
2268: currentform.elements[current.argfield].value = '';
2269: }
2270: current.argfield = choicearg;
2271: }
2272: set_auth_radio_buttons(choice,currentform);
2273: return;
1.20 www 2274: }
1.32 matthew 2275:
2276: function set_auth_radio_buttons(newvalue,currentform) {
2277: var i=0;
2278: while (i < currentform.login.length) {
2279: if (currentform.login[i].value == newvalue) { break; }
2280: i++;
2281: }
2282: if (i == currentform.login.length) {
2283: return;
2284: }
2285: current.radiovalue = newvalue;
2286: currentform.login[i].checked = true;
2287: return;
2288: }
2289: END
2290: return $result;
2291: }
2292:
2293: sub authform_authorwarning{
2294: my $result='';
1.144 matthew 2295: $result='<i>'.
2296: &mt('As a general rule, only authors or co-authors should be '.
2297: 'filesystem authenticated '.
2298: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2299: return $result;
2300: }
2301:
2302: sub authform_nochange{
2303: my %in = (
2304: formname => 'document.cu',
2305: kerb_def_dom => 'MSU.EDU',
2306: @_,
2307: );
1.586 raeburn 2308: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2309: my $result;
2310: if (keys(%can_assign) == 0) {
2311: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2312: } else {
2313: $result = '<label>'.&mt('[_1] Do not change login data',
2314: '<input type="radio" name="login" value="nochange" '.
2315: 'checked="checked" onclick="'.
1.281 albertel 2316: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2317: '</label>';
1.586 raeburn 2318: }
1.32 matthew 2319: return $result;
2320: }
2321:
1.591 raeburn 2322: sub authform_kerberos {
1.32 matthew 2323: my %in = (
2324: formname => 'document.cu',
2325: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2326: kerb_def_auth => 'krb4',
1.32 matthew 2327: @_,
2328: );
1.586 raeburn 2329: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2330: $autharg,$jscall);
2331: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2332: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2333: $check5 = ' checked="checked"';
1.80 albertel 2334: } else {
1.772 bisitz 2335: $check4 = ' checked="checked"';
1.80 albertel 2336: }
1.165 raeburn 2337: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2338: if (defined($in{'curr_authtype'})) {
2339: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2340: $krbcheck = ' checked="checked"';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $krbcheck = '';
2344: }
2345: }
1.591 raeburn 2346: if (defined($in{'curr_kerb_ver'})) {
2347: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2348: $check5 = ' checked="checked"';
1.591 raeburn 2349: $check4 = '';
2350: } else {
1.772 bisitz 2351: $check4 = ' checked="checked"';
1.591 raeburn 2352: $check5 = '';
2353: }
1.586 raeburn 2354: }
1.591 raeburn 2355: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2356: $krbarg = $in{'curr_autharg'};
2357: }
1.586 raeburn 2358: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2359: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2360: $result =
2361: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2362: $in{'curr_autharg'},$krbver);
2363: } else {
2364: $result =
2365: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2366: }
2367: return $result;
2368: }
2369: }
2370: } else {
2371: if ($authnum == 1) {
1.784 bisitz 2372: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2373: }
2374: }
1.586 raeburn 2375: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2376: return;
1.587 raeburn 2377: } elsif ($authtype eq '') {
1.591 raeburn 2378: if (defined($in{'mode'})) {
1.587 raeburn 2379: if ($in{'mode'} eq 'modifycourse') {
2380: if ($authnum == 1) {
1.784 bisitz 2381: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2382: }
2383: }
2384: }
1.586 raeburn 2385: }
2386: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2387: if ($authtype eq '') {
2388: $authtype = '<input type="radio" name="login" value="krb" '.
2389: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2390: $krbcheck.' />';
2391: }
2392: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2393: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2394: $in{'curr_authtype'} eq 'krb5') ||
2395: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2396: $in{'curr_authtype'} eq 'krb4')) {
2397: $result .= &mt
1.144 matthew 2398: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2399: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2400: '<label>'.$authtype,
1.281 albertel 2401: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2402: 'value="'.$krbarg.'" '.
1.144 matthew 2403: 'onchange="'.$jscall.'" />',
1.281 albertel 2404: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2405: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2406: '</label>');
1.586 raeburn 2407: } elsif ($can_assign{'krb4'}) {
2408: $result .= &mt
2409: ('[_1] Kerberos authenticated with domain [_2] '.
2410: '[_3] Version 4 [_4]',
2411: '<label>'.$authtype,
2412: '</label><input type="text" size="10" name="krbarg" '.
2413: 'value="'.$krbarg.'" '.
2414: 'onchange="'.$jscall.'" />',
2415: '<label><input type="hidden" name="krbver" value="4" />',
2416: '</label>');
2417: } elsif ($can_assign{'krb5'}) {
2418: $result .= &mt
2419: ('[_1] Kerberos authenticated with domain [_2] '.
2420: '[_3] Version 5 [_4]',
2421: '<label>'.$authtype,
2422: '</label><input type="text" size="10" name="krbarg" '.
2423: 'value="'.$krbarg.'" '.
2424: 'onchange="'.$jscall.'" />',
2425: '<label><input type="hidden" name="krbver" value="5" />',
2426: '</label>');
2427: }
1.32 matthew 2428: return $result;
2429: }
2430:
2431: sub authform_internal{
1.586 raeburn 2432: my %in = (
1.32 matthew 2433: formname => 'document.cu',
2434: kerb_def_dom => 'MSU.EDU',
2435: @_,
2436: );
1.586 raeburn 2437: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2438: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2439: if (defined($in{'curr_authtype'})) {
2440: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2441: if ($can_assign{'int'}) {
1.772 bisitz 2442: $intcheck = 'checked="checked" ';
1.623 raeburn 2443: if (defined($in{'mode'})) {
2444: if ($in{'mode'} eq 'modifyuser') {
2445: $intcheck = '';
2446: }
2447: }
1.591 raeburn 2448: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2449: $intarg = $in{'curr_autharg'};
2450: }
2451: } else {
2452: $result = &mt('Currently internally authenticated.');
2453: return $result;
1.165 raeburn 2454: }
2455: }
1.586 raeburn 2456: } else {
2457: if ($authnum == 1) {
1.784 bisitz 2458: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2459: }
2460: }
2461: if (!$can_assign{'int'}) {
2462: return;
1.587 raeburn 2463: } elsif ($authtype eq '') {
1.591 raeburn 2464: if (defined($in{'mode'})) {
1.587 raeburn 2465: if ($in{'mode'} eq 'modifycourse') {
2466: if ($authnum == 1) {
1.784 bisitz 2467: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2468: }
2469: }
2470: }
1.165 raeburn 2471: }
1.586 raeburn 2472: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2473: if ($authtype eq '') {
2474: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2475: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2476: }
1.605 bisitz 2477: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2478: $intarg.'" onchange="'.$jscall.'" />';
2479: $result = &mt
1.144 matthew 2480: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2481: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2482: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2483: return $result;
2484: }
2485:
2486: sub authform_local{
2487: my %in = (
2488: formname => 'document.cu',
2489: kerb_def_dom => 'MSU.EDU',
2490: @_,
2491: );
1.586 raeburn 2492: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2493: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2494: if (defined($in{'curr_authtype'})) {
2495: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2496: if ($can_assign{'loc'}) {
1.772 bisitz 2497: $loccheck = 'checked="checked" ';
1.623 raeburn 2498: if (defined($in{'mode'})) {
2499: if ($in{'mode'} eq 'modifyuser') {
2500: $loccheck = '';
2501: }
2502: }
1.591 raeburn 2503: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2504: $locarg = $in{'curr_autharg'};
2505: }
2506: } else {
2507: $result = &mt('Currently using local (institutional) authentication.');
2508: return $result;
1.165 raeburn 2509: }
2510: }
1.586 raeburn 2511: } else {
2512: if ($authnum == 1) {
1.784 bisitz 2513: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2514: }
2515: }
2516: if (!$can_assign{'loc'}) {
2517: return;
1.587 raeburn 2518: } elsif ($authtype eq '') {
1.591 raeburn 2519: if (defined($in{'mode'})) {
1.587 raeburn 2520: if ($in{'mode'} eq 'modifycourse') {
2521: if ($authnum == 1) {
1.784 bisitz 2522: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2523: }
2524: }
2525: }
1.165 raeburn 2526: }
1.586 raeburn 2527: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2528: if ($authtype eq '') {
2529: $authtype = '<input type="radio" name="login" value="loc" '.
2530: $loccheck.' onchange="'.$jscall.'" onclick="'.
2531: $jscall.'" />';
2532: }
2533: $autharg = '<input type="text" size="10" name="locarg" value="'.
2534: $locarg.'" onchange="'.$jscall.'" />';
2535: $result = &mt('[_1] Local Authentication with argument [_2]',
2536: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2537: return $result;
2538: }
2539:
2540: sub authform_filesystem{
2541: my %in = (
2542: formname => 'document.cu',
2543: kerb_def_dom => 'MSU.EDU',
2544: @_,
2545: );
1.586 raeburn 2546: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2547: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2548: if (defined($in{'curr_authtype'})) {
2549: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2550: if ($can_assign{'fsys'}) {
1.772 bisitz 2551: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2552: if (defined($in{'mode'})) {
2553: if ($in{'mode'} eq 'modifyuser') {
2554: $fsyscheck = '';
2555: }
2556: }
1.586 raeburn 2557: } else {
2558: $result = &mt('Currently Filesystem Authenticated.');
2559: return $result;
2560: }
2561: }
2562: } else {
2563: if ($authnum == 1) {
1.784 bisitz 2564: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2565: }
2566: }
2567: if (!$can_assign{'fsys'}) {
2568: return;
1.587 raeburn 2569: } elsif ($authtype eq '') {
1.591 raeburn 2570: if (defined($in{'mode'})) {
1.587 raeburn 2571: if ($in{'mode'} eq 'modifycourse') {
2572: if ($authnum == 1) {
1.784 bisitz 2573: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2574: }
2575: }
2576: }
1.586 raeburn 2577: }
2578: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2579: if ($authtype eq '') {
2580: $authtype = '<input type="radio" name="login" value="fsys" '.
2581: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2582: $jscall.'" />';
2583: }
2584: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2585: ' onchange="'.$jscall.'" />';
2586: $result = &mt
1.144 matthew 2587: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2588: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2589: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2590: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2591: 'onchange="'.$jscall.'" />');
1.32 matthew 2592: return $result;
2593: }
2594:
1.586 raeburn 2595: sub get_assignable_auth {
2596: my ($dom) = @_;
2597: if ($dom eq '') {
2598: $dom = $env{'request.role.domain'};
2599: }
2600: my %can_assign = (
2601: krb4 => 1,
2602: krb5 => 1,
2603: int => 1,
2604: loc => 1,
2605: );
2606: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2607: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2608: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2609: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2610: my $context;
2611: if ($env{'request.role'} =~ /^au/) {
2612: $context = 'author';
2613: } elsif ($env{'request.role'} =~ /^dc/) {
2614: $context = 'domain';
2615: } elsif ($env{'request.course.id'}) {
2616: $context = 'course';
2617: }
2618: if ($context) {
2619: if (ref($authhash->{$context}) eq 'HASH') {
2620: %can_assign = %{$authhash->{$context}};
2621: }
2622: }
2623: }
2624: }
2625: my $authnum = 0;
2626: foreach my $key (keys(%can_assign)) {
2627: if ($can_assign{$key}) {
2628: $authnum ++;
2629: }
2630: }
2631: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2632: $authnum --;
2633: }
2634: return ($authnum,%can_assign);
2635: }
2636:
1.80 albertel 2637: ###############################################################
2638: ## Get Kerberos Defaults for Domain ##
2639: ###############################################################
2640: ##
2641: ## Returns default kerberos version and an associated argument
2642: ## as listed in file domain.tab. If not listed, provides
2643: ## appropriate default domain and kerberos version.
2644: ##
2645: #-------------------------------------------
2646:
2647: =pod
2648:
1.648 raeburn 2649: =item * &get_kerberos_defaults()
1.80 albertel 2650:
2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2652: version and domain. If not found, it defaults to version 4 and the
2653: domain of the server.
1.80 albertel 2654:
1.648 raeburn 2655: =over 4
2656:
1.80 albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2658:
1.648 raeburn 2659: =back
2660:
2661: =back
2662:
1.80 albertel 2663: =cut
2664:
2665: #-------------------------------------------
2666: sub get_kerberos_defaults {
2667: my $domain=shift;
1.641 raeburn 2668: my ($krbdef,$krbdefdom);
2669: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2670: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2671: $krbdef = $domdefaults{'auth_def'};
2672: $krbdefdom = $domdefaults{'auth_arg_def'};
2673: } else {
1.80 albertel 2674: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2675: my $krbdefdom=$1;
2676: $krbdefdom=~tr/a-z/A-Z/;
2677: $krbdef = "krb4";
2678: }
2679: return ($krbdef,$krbdefdom);
2680: }
1.112 bowersj2 2681:
1.32 matthew 2682:
1.46 matthew 2683: ###############################################################
2684: ## Thesaurus Functions ##
2685: ###############################################################
1.20 www 2686:
1.46 matthew 2687: =pod
1.20 www 2688:
1.112 bowersj2 2689: =head1 Thesaurus Functions
2690:
2691: =over 4
2692:
1.648 raeburn 2693: =item * &initialize_keywords()
1.46 matthew 2694:
2695: Initializes the package variable %Keywords if it is empty. Uses the
2696: package variable $thesaurus_db_file.
2697:
2698: =cut
2699:
2700: ###################################################
2701:
2702: sub initialize_keywords {
2703: return 1 if (scalar keys(%Keywords));
2704: # If we are here, %Keywords is empty, so fill it up
2705: # Make sure the file we need exists...
2706: if (! -e $thesaurus_db_file) {
2707: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2708: " failed because it does not exist");
2709: return 0;
2710: }
2711: # Set up the hash as a database
2712: my %thesaurus_db;
2713: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2714: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2715: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2716: $thesaurus_db_file);
2717: return 0;
2718: }
2719: # Get the average number of appearances of a word.
2720: my $avecount = $thesaurus_db{'average.count'};
2721: # Put keywords (those that appear > average) into %Keywords
2722: while (my ($word,$data)=each (%thesaurus_db)) {
2723: my ($count,undef) = split /:/,$data;
2724: $Keywords{$word}++ if ($count > $avecount);
2725: }
2726: untie %thesaurus_db;
2727: # Remove special values from %Keywords.
1.356 albertel 2728: foreach my $value ('total.count','average.count') {
2729: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2730: }
1.46 matthew 2731: return 1;
2732: }
2733:
2734: ###################################################
2735:
2736: =pod
2737:
1.648 raeburn 2738: =item * &keyword($word)
1.46 matthew 2739:
2740: Returns true if $word is a keyword. A keyword is a word that appears more
2741: than the average number of times in the thesaurus database. Calls
2742: &initialize_keywords
2743:
2744: =cut
2745:
2746: ###################################################
1.20 www 2747:
2748: sub keyword {
1.46 matthew 2749: return if (!&initialize_keywords());
2750: my $word=lc(shift());
2751: $word=~s/\W//g;
2752: return exists($Keywords{$word});
1.20 www 2753: }
1.46 matthew 2754:
2755: ###############################################################
2756:
2757: =pod
1.20 www 2758:
1.648 raeburn 2759: =item * &get_related_words()
1.46 matthew 2760:
1.160 matthew 2761: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2762: an array of words. If the keyword is not in the thesaurus, an empty array
2763: will be returned. The order of the words returned is determined by the
2764: database which holds them.
2765:
2766: Uses global $thesaurus_db_file.
2767:
2768: =cut
2769:
2770: ###############################################################
2771: sub get_related_words {
2772: my $keyword = shift;
2773: my %thesaurus_db;
2774: if (! -e $thesaurus_db_file) {
2775: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2776: "failed because the file does not exist");
2777: return ();
2778: }
2779: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2780: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2781: return ();
2782: }
2783: my @Words=();
1.429 www 2784: my $count=0;
1.46 matthew 2785: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2786: # The first element is the number of times
2787: # the word appears. We do not need it now.
1.429 www 2788: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2789: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2790: my $threshold=$mostfrequentcount/10;
2791: foreach my $possibleword (@RelatedWords) {
2792: my ($word,$wordcount)=split(/\,/,$possibleword);
2793: if ($wordcount>$threshold) {
2794: push(@Words,$word);
2795: $count++;
2796: if ($count>10) { last; }
2797: }
1.20 www 2798: }
2799: }
1.46 matthew 2800: untie %thesaurus_db;
2801: return @Words;
1.14 harris41 2802: }
1.46 matthew 2803:
1.112 bowersj2 2804: =pod
2805:
2806: =back
2807:
2808: =cut
1.61 www 2809:
2810: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2811: =pod
2812:
1.112 bowersj2 2813: =head1 User Name Functions
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &plainname($uname,$udom,$first)
1.81 albertel 2818:
1.112 bowersj2 2819: Takes a users logon name and returns it as a string in
1.226 albertel 2820: "first middle last generation" form
2821: if $first is set to 'lastname' then it returns it as
2822: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2823:
2824: =cut
1.61 www 2825:
1.295 www 2826:
1.81 albertel 2827: ###############################################################
1.61 www 2828: sub plainname {
1.226 albertel 2829: my ($uname,$udom,$first)=@_;
1.537 albertel 2830: return if (!defined($uname) || !defined($udom));
1.295 www 2831: my %names=&getnames($uname,$udom);
1.226 albertel 2832: my $name=&Apache::lonnet::format_name($names{'firstname'},
2833: $names{'middlename'},
2834: $names{'lastname'},
2835: $names{'generation'},$first);
2836: $name=~s/^\s+//;
1.62 www 2837: $name=~s/\s+$//;
2838: $name=~s/\s+/ /g;
1.353 albertel 2839: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2840: return $name;
1.61 www 2841: }
1.66 www 2842:
2843: # -------------------------------------------------------------------- Nickname
1.81 albertel 2844: =pod
2845:
1.648 raeburn 2846: =item * &nickname($uname,$udom)
1.81 albertel 2847:
2848: Gets a users name and returns it as a string as
2849:
2850: ""nickname""
1.66 www 2851:
1.81 albertel 2852: if the user has a nickname or
2853:
2854: "first middle last generation"
2855:
2856: if the user does not
2857:
2858: =cut
1.66 www 2859:
2860: sub nickname {
2861: my ($uname,$udom)=@_;
1.537 albertel 2862: return if (!defined($uname) || !defined($udom));
1.295 www 2863: my %names=&getnames($uname,$udom);
1.68 albertel 2864: my $name=$names{'nickname'};
1.66 www 2865: if ($name) {
2866: $name='"'.$name.'"';
2867: } else {
2868: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2869: $names{'lastname'}.' '.$names{'generation'};
2870: $name=~s/\s+$//;
2871: $name=~s/\s+/ /g;
2872: }
2873: return $name;
2874: }
2875:
1.295 www 2876: sub getnames {
2877: my ($uname,$udom)=@_;
1.537 albertel 2878: return if (!defined($uname) || !defined($udom));
1.433 albertel 2879: if ($udom eq 'public' && $uname eq 'public') {
2880: return ('lastname' => &mt('Public'));
2881: }
1.295 www 2882: my $id=$uname.':'.$udom;
2883: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2884: if ($cached) {
2885: return %{$names};
2886: } else {
2887: my %loadnames=&Apache::lonnet::get('environment',
2888: ['firstname','middlename','lastname','generation','nickname'],
2889: $udom,$uname);
2890: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2891: return %loadnames;
2892: }
2893: }
1.61 www 2894:
1.542 raeburn 2895: # -------------------------------------------------------------------- getemails
1.648 raeburn 2896:
1.542 raeburn 2897: =pod
2898:
1.648 raeburn 2899: =item * &getemails($uname,$udom)
1.542 raeburn 2900:
2901: Gets a user's email information and returns it as a hash with keys:
2902: notification, critnotification, permanentemail
2903:
2904: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2906:
1.648 raeburn 2907:
1.542 raeburn 2908: =cut
2909:
1.648 raeburn 2910:
1.466 albertel 2911: sub getemails {
2912: my ($uname,$udom)=@_;
2913: if ($udom eq 'public' && $uname eq 'public') {
2914: return;
2915: }
1.467 www 2916: if (!$udom) { $udom=$env{'user.domain'}; }
2917: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2918: my $id=$uname.':'.$udom;
2919: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2920: if ($cached) {
2921: return %{$names};
2922: } else {
2923: my %loadnames=&Apache::lonnet::get('environment',
2924: ['notification','critnotification',
2925: 'permanentemail'],
2926: $udom,$uname);
2927: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2928: return %loadnames;
2929: }
2930: }
2931:
1.551 albertel 2932: sub flush_email_cache {
2933: my ($uname,$udom)=@_;
2934: if (!$udom) { $udom =$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: return if ($udom eq 'public' && $uname eq 'public');
2937: my $id=$uname.':'.$udom;
2938: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2939: }
2940:
1.728 raeburn 2941: # -------------------------------------------------------------------- getlangs
2942:
2943: =pod
2944:
2945: =item * &getlangs($uname,$udom)
2946:
2947: Gets a user's language preference and returns it as a hash with key:
2948: language.
2949:
2950: =cut
2951:
2952:
2953: sub getlangs {
2954: my ($uname,$udom) = @_;
2955: if (!$udom) { $udom =$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $id=$uname.':'.$udom;
2958: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2959: if ($cached) {
2960: return %{$langs};
2961: } else {
2962: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2963: $udom,$uname);
2964: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2965: return %loadlangs;
2966: }
2967: }
2968:
2969: sub flush_langs_cache {
2970: my ($uname,$udom)=@_;
2971: if (!$udom) { $udom =$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: return if ($udom eq 'public' && $uname eq 'public');
2974: my $id=$uname.':'.$udom;
2975: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2976: }
2977:
1.61 www 2978: # ------------------------------------------------------------------ Screenname
1.81 albertel 2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &screenname($uname,$udom)
1.81 albertel 2983:
2984: Gets a users screenname and returns it as a string
2985:
2986: =cut
1.61 www 2987:
2988: sub screenname {
2989: my ($uname,$udom)=@_;
1.258 albertel 2990: if ($uname eq $env{'user.name'} &&
2991: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2992: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2993: return $names{'screenname'};
1.62 www 2994: }
2995:
1.212 albertel 2996:
1.802 bisitz 2997: # ------------------------------------------------------------- Confirm Wrapper
2998: =pod
2999:
3000: =item confirmwrapper
3001:
3002: Wrap messages about completion of operation in box
3003:
3004: =cut
3005:
3006: sub confirmwrapper {
3007: my ($message)=@_;
3008: if ($message) {
3009: return "\n".'<div class="LC_confirm_box">'."\n"
3010: .$message."\n"
3011: .'</div>'."\n";
3012: } else {
3013: return $message;
3014: }
3015: }
3016:
1.62 www 3017: # ------------------------------------------------------------- Message Wrapper
3018:
3019: sub messagewrapper {
1.369 www 3020: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3021: return
1.441 albertel 3022: '<a href="/adm/email?compose=individual&'.
3023: 'recname='.$username.'&recdom='.$domain.
3024: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3025: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3026: }
1.802 bisitz 3027:
1.74 www 3028: # --------------------------------------------------------------- Notes Wrapper
3029:
3030: sub noteswrapper {
3031: my ($link,$un,$do)=@_;
3032: return
1.896 amueller 3033: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3034: }
1.802 bisitz 3035:
1.62 www 3036: # ------------------------------------------------------------- Aboutme Wrapper
3037:
3038: sub aboutmewrapper {
1.166 www 3039: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 3040: if (!defined($username) && !defined($domain)) {
3041: return;
3042: }
1.892 amueller 3043: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756 weissno 3044: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3045: }
3046:
3047: # ------------------------------------------------------------ Syllabus Wrapper
3048:
3049: sub syllabuswrapper {
1.707 bisitz 3050: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3051: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3052: }
1.14 harris41 3053:
1.802 bisitz 3054: # -----------------------------------------------------------------------------
3055:
1.208 matthew 3056: sub track_student_link {
1.887 raeburn 3057: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3058: my $link ="/adm/trackstudent?";
1.208 matthew 3059: my $title = 'View recent activity';
3060: if (defined($sname) && $sname !~ /^\s*$/ &&
3061: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3062: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3063: $title .= ' of this student';
1.268 albertel 3064: }
1.208 matthew 3065: if (defined($target) && $target !~ /^\s*$/) {
3066: $target = qq{target="$target"};
3067: } else {
3068: $target = '';
3069: }
1.268 albertel 3070: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3071: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3072: $title = &mt($title);
3073: $linktext = &mt($linktext);
1.448 albertel 3074: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3075: &help_open_topic('View_recent_activity');
1.208 matthew 3076: }
3077:
1.781 raeburn 3078: sub slot_reservations_link {
3079: my ($linktext,$sname,$sdom,$target) = @_;
3080: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3081: my $title = 'View slot reservation history';
3082: if (defined($sname) && $sname !~ /^\s*$/ &&
3083: defined($sdom) && $sdom !~ /^\s*$/) {
3084: $link .= "&uname=$sname&udom=$sdom";
3085: $title .= ' of this student';
3086: }
3087: if (defined($target) && $target !~ /^\s*$/) {
3088: $target = qq{target="$target"};
3089: } else {
3090: $target = '';
3091: }
3092: $title = &mt($title);
3093: $linktext = &mt($linktext);
3094: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3096:
3097: }
3098:
1.508 www 3099: # ===================================================== Display a student photo
3100:
3101:
1.509 albertel 3102: sub student_image_tag {
1.508 www 3103: my ($domain,$user)=@_;
3104: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3105: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3106: return '<img src="'.$imgsrc.'" align="right" />';
3107: } else {
3108: return '';
3109: }
3110: }
3111:
1.112 bowersj2 3112: =pod
3113:
3114: =back
3115:
3116: =head1 Access .tab File Data
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &languageids()
1.112 bowersj2 3121:
3122: returns list of all language ids
3123:
3124: =cut
3125:
1.14 harris41 3126: sub languageids {
1.16 harris41 3127: return sort(keys(%language));
1.14 harris41 3128: }
3129:
1.112 bowersj2 3130: =pod
3131:
1.648 raeburn 3132: =item * &languagedescription()
1.112 bowersj2 3133:
3134: returns description of a specified language id
3135:
3136: =cut
3137:
1.14 harris41 3138: sub languagedescription {
1.125 www 3139: my $code=shift;
3140: return ($supported_language{$code}?'* ':'').
3141: $language{$code}.
1.126 www 3142: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3143: }
3144:
3145: sub plainlanguagedescription {
3146: my $code=shift;
3147: return $language{$code};
3148: }
3149:
3150: sub supportedlanguagecode {
3151: my $code=shift;
3152: return $supported_language{$code};
1.97 www 3153: }
3154:
1.112 bowersj2 3155: =pod
3156:
1.648 raeburn 3157: =item * ©rightids()
1.112 bowersj2 3158:
3159: returns list of all copyrights
3160:
3161: =cut
3162:
3163: sub copyrightids {
3164: return sort(keys(%cprtag));
3165: }
3166:
3167: =pod
3168:
1.648 raeburn 3169: =item * ©rightdescription()
1.112 bowersj2 3170:
3171: returns description of a specified copyright id
3172:
3173: =cut
3174:
3175: sub copyrightdescription {
1.166 www 3176: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3177: }
1.197 matthew 3178:
3179: =pod
3180:
1.648 raeburn 3181: =item * &source_copyrightids()
1.192 taceyjo1 3182:
3183: returns list of all source copyrights
3184:
3185: =cut
3186:
3187: sub source_copyrightids {
3188: return sort(keys(%scprtag));
3189: }
3190:
3191: =pod
3192:
1.648 raeburn 3193: =item * &source_copyrightdescription()
1.192 taceyjo1 3194:
3195: returns description of a specified source copyright id
3196:
3197: =cut
3198:
3199: sub source_copyrightdescription {
3200: return &mt($scprtag{shift(@_)});
3201: }
1.112 bowersj2 3202:
3203: =pod
3204:
1.648 raeburn 3205: =item * &filecategories()
1.112 bowersj2 3206:
3207: returns list of all file categories
3208:
3209: =cut
3210:
3211: sub filecategories {
3212: return sort(keys(%category_extensions));
3213: }
3214:
3215: =pod
3216:
1.648 raeburn 3217: =item * &filecategorytypes()
1.112 bowersj2 3218:
3219: returns list of file types belonging to a given file
3220: category
3221:
3222: =cut
3223:
3224: sub filecategorytypes {
1.356 albertel 3225: my ($cat) = @_;
3226: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3227: }
3228:
3229: =pod
3230:
1.648 raeburn 3231: =item * &fileembstyle()
1.112 bowersj2 3232:
3233: returns embedding style for a specified file type
3234:
3235: =cut
3236:
3237: sub fileembstyle {
3238: return $fe{lc(shift(@_))};
1.169 www 3239: }
3240:
1.351 www 3241: sub filemimetype {
3242: return $fm{lc(shift(@_))};
3243: }
3244:
1.169 www 3245:
3246: sub filecategoryselect {
3247: my ($name,$value)=@_;
1.189 matthew 3248: return &select_form($value,$name,
1.169 www 3249: '' => &mt('Any category'),
3250: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3251: }
3252:
3253: =pod
3254:
1.648 raeburn 3255: =item * &filedescription()
1.112 bowersj2 3256:
3257: returns description for a specified file type
3258:
3259: =cut
3260:
3261: sub filedescription {
1.188 matthew 3262: my $file_description = $fd{lc(shift())};
3263: $file_description =~ s:([\[\]]):~$1:g;
3264: return &mt($file_description);
1.112 bowersj2 3265: }
3266:
3267: =pod
3268:
1.648 raeburn 3269: =item * &filedescriptionex()
1.112 bowersj2 3270:
3271: returns description for a specified file type with
3272: extra formatting
3273:
3274: =cut
3275:
3276: sub filedescriptionex {
3277: my $ex=shift;
1.188 matthew 3278: my $file_description = $fd{lc($ex)};
3279: $file_description =~ s:([\[\]]):~$1:g;
3280: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3281: }
3282:
3283: # End of .tab access
3284: =pod
3285:
3286: =back
3287:
3288: =cut
3289:
3290: # ------------------------------------------------------------------ File Types
3291: sub fileextensions {
3292: return sort(keys(%fe));
3293: }
3294:
1.97 www 3295: # ----------------------------------------------------------- Display Languages
3296: # returns a hash with all desired display languages
3297: #
3298:
3299: sub display_languages {
3300: my %languages=();
1.695 raeburn 3301: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3302: $languages{$lang}=1;
1.97 www 3303: }
3304: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3305: if ($env{'form.displaylanguage'}) {
1.356 albertel 3306: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3307: $languages{$lang}=1;
1.97 www 3308: }
3309: }
3310: return %languages;
1.14 harris41 3311: }
3312:
1.582 albertel 3313: sub languages {
3314: my ($possible_langs) = @_;
1.695 raeburn 3315: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3316: if (!ref($possible_langs)) {
3317: if( wantarray ) {
3318: return @preferred_langs;
3319: } else {
3320: return $preferred_langs[0];
3321: }
3322: }
3323: my %possibilities = map { $_ => 1 } (@$possible_langs);
3324: my @preferred_possibilities;
3325: foreach my $preferred_lang (@preferred_langs) {
3326: if (exists($possibilities{$preferred_lang})) {
3327: push(@preferred_possibilities, $preferred_lang);
3328: }
3329: }
3330: if( wantarray ) {
3331: return @preferred_possibilities;
3332: }
3333: return $preferred_possibilities[0];
3334: }
3335:
1.742 raeburn 3336: sub user_lang {
3337: my ($touname,$toudom,$fromcid) = @_;
3338: my @userlangs;
3339: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3340: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3341: $env{'course.'.$fromcid.'.languages'}));
3342: } else {
3343: my %langhash = &getlangs($touname,$toudom);
3344: if ($langhash{'languages'} ne '') {
3345: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3346: } else {
3347: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3348: if ($domdefs{'lang_def'} ne '') {
3349: @userlangs = ($domdefs{'lang_def'});
3350: }
3351: }
3352: }
3353: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3354: my $user_lh = Apache::localize->get_handle(@languages);
3355: return $user_lh;
3356: }
3357:
3358:
1.112 bowersj2 3359: ###############################################################
3360: ## Student Answer Attempts ##
3361: ###############################################################
3362:
3363: =pod
3364:
3365: =head1 Alternate Problem Views
3366:
3367: =over 4
3368:
1.648 raeburn 3369: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3370: $getattempt, $regexp, $gradesub)
3371:
3372: Return string with previous attempt on problem. Arguments:
3373:
3374: =over 4
3375:
3376: =item * $symb: Problem, including path
3377:
3378: =item * $username: username of the desired student
3379:
3380: =item * $domain: domain of the desired student
1.14 harris41 3381:
1.112 bowersj2 3382: =item * $course: Course ID
1.14 harris41 3383:
1.112 bowersj2 3384: =item * $getattempt: Leave blank for all attempts, otherwise put
3385: something
1.14 harris41 3386:
1.112 bowersj2 3387: =item * $regexp: if string matches this regexp, the string will be
3388: sent to $gradesub
1.14 harris41 3389:
1.112 bowersj2 3390: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3391:
1.112 bowersj2 3392: =back
1.14 harris41 3393:
1.112 bowersj2 3394: The output string is a table containing all desired attempts, if any.
1.16 harris41 3395:
1.112 bowersj2 3396: =cut
1.1 albertel 3397:
3398: sub get_previous_attempt {
1.43 ng 3399: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3400: my $prevattempts='';
1.43 ng 3401: no strict 'refs';
1.1 albertel 3402: if ($symb) {
1.3 albertel 3403: my (%returnhash)=
3404: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3405: if ($returnhash{'version'}) {
3406: my %lasthash=();
3407: my $version;
3408: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3409: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3410: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3411: }
1.1 albertel 3412: }
1.596 albertel 3413: $prevattempts=&start_data_table().&start_data_table_header_row();
3414: $prevattempts.='<th>'.&mt('History').'</th>';
1.945 ! raeburn 3415: my %typeparts;
! 3416: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 3417: foreach my $key (sort(keys(%lasthash))) {
3418: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3419: if ($#parts > 0) {
1.31 albertel 3420: my $data=$parts[-1];
3421: pop(@parts);
1.945 ! raeburn 3422: if ($data eq 'type') {
! 3423: unless ($showsurv) {
! 3424: my $id = join(',',@parts);
! 3425: $typeparts{$ign.'.'.$id} = $lasthash{$key};
! 3426: }
! 3427: delete($lasthash{$key});
! 3428: } else {
! 3429: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
! 3430: }
1.31 albertel 3431: } else {
1.41 ng 3432: if ($#parts == 0) {
3433: $prevattempts.='<th>'.$parts[0].'</th>';
3434: } else {
3435: $prevattempts.='<th>'.$ign.'</th>';
3436: }
1.31 albertel 3437: }
1.16 harris41 3438: }
1.596 albertel 3439: $prevattempts.=&end_data_table_header_row();
1.945 ! raeburn 3440: my %lasthidden;
1.40 ng 3441: if ($getattempt eq '') {
3442: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945 ! raeburn 3443: my @hidden;
! 3444: if (%typeparts) {
! 3445: foreach my $id (keys(%typeparts)) {
! 3446: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
! 3447: push(@hidden,$id);
! 3448: $lasthidden{$id} = 1;
! 3449: } elsif ($lasthidden{$id}) {
! 3450: if (exists($returnhash{$version.':'.$id.'.award'})) {
! 3451: delete($lasthidden{$id});
! 3452: }
! 3453: }
! 3454: }
! 3455: }
! 3456: $prevattempts.=&start_data_table_row().
! 3457: '<td>'.&mt('Transaction [_1]',$version).'</td>';
! 3458: if (@hidden) {
! 3459: foreach my $key (sort(keys(%lasthash))) {
! 3460: my $hide;
! 3461: foreach my $id (@hidden) {
! 3462: if ($key =~ /^\Q$id\E/) {
! 3463: $hide = 1;
! 3464: last;
! 3465: }
! 3466: }
! 3467: if ($hide) {
! 3468: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
! 3469: if (($data eq 'award') || ($data eq 'awarddetail')) {
! 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: } else {
! 3477: if ($key =~ /\./) {
! 3478: my $value = &format_previous_attempt_value($key,
! 3479: $returnhash{$version.':'.$key});
! 3480: $prevattempts.='<td>'.$value.' </td>';
! 3481: } else {
! 3482: $prevattempts.='<td> </td>';
! 3483: }
! 3484: }
! 3485: }
! 3486: } else {
! 3487: foreach my $key (sort(keys(%lasthash))) {
! 3488: my $value = &format_previous_attempt_value($key,
! 3489: $returnhash{$version.':'.$key});
! 3490: $prevattempts.='<td>'.$value.' </td>';
! 3491: }
! 3492: }
! 3493: $prevattempts.=&end_data_table_row();
1.40 ng 3494: }
1.1 albertel 3495: }
1.945 ! raeburn 3496: my @currhidden = keys(%lasthidden);
1.596 albertel 3497: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3498: foreach my $key (sort(keys(%lasthash))) {
1.945 ! raeburn 3499: if (%typeparts) {
! 3500: my $hidden;
! 3501: foreach my $id (@currhidden) {
! 3502: if ($key =~ /^\Q$id\E/) {
! 3503: $hidden = 1;
! 3504: last;
! 3505: }
! 3506: }
! 3507: if ($hidden) {
! 3508: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
! 3509: if (($data eq 'award') || ($data eq 'awarddetail')) {
! 3510: my $value = &format_previous_attempt_value($key,$lasthash{$key});
! 3511: if ($key =~/$regexp$/ && (defined &$gradesub)) {
! 3512: $value = &$gradesub($value);
! 3513: }
! 3514: $prevattempts.='<td>'.$value.' </td>';
! 3515: } else {
! 3516: $prevattempts.='<td> </td>';
! 3517: }
! 3518: } else {
! 3519: my $value = &format_previous_attempt_value($key,$lasthash{$key});
! 3520: if ($key =~/$regexp$/ && (defined &$gradesub)) {
! 3521: $value = &$gradesub($value);
! 3522: }
! 3523: $prevattempts.='<td>'.$value.' </td>';
! 3524: }
! 3525: } else {
! 3526: my $value = &format_previous_attempt_value($key,$lasthash{$key});
! 3527: if ($key =~/$regexp$/ && (defined &$gradesub)) {
! 3528: $value = &$gradesub($value);
! 3529: }
! 3530: $prevattempts.='<td>'.$value.' </td>';
! 3531: }
1.16 harris41 3532: }
1.596 albertel 3533: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3534: } else {
1.596 albertel 3535: $prevattempts=
3536: &start_data_table().&start_data_table_row().
3537: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3538: &end_data_table_row().&end_data_table();
1.1 albertel 3539: }
3540: } else {
1.596 albertel 3541: $prevattempts=
3542: &start_data_table().&start_data_table_row().
3543: '<td>'.&mt('No data.').'</td>'.
3544: &end_data_table_row().&end_data_table();
1.1 albertel 3545: }
1.10 albertel 3546: }
3547:
1.581 albertel 3548: sub format_previous_attempt_value {
3549: my ($key,$value) = @_;
3550: if ($key =~ /timestamp/) {
3551: $value = &Apache::lonlocal::locallocaltime($value);
3552: } elsif (ref($value) eq 'ARRAY') {
3553: $value = '('.join(', ', @{ $value }).')';
3554: } else {
3555: $value = &unescape($value);
3556: }
3557: return $value;
3558: }
3559:
3560:
1.107 albertel 3561: sub relative_to_absolute {
3562: my ($url,$output)=@_;
3563: my $parser=HTML::TokeParser->new(\$output);
3564: my $token;
3565: my $thisdir=$url;
3566: my @rlinks=();
3567: while ($token=$parser->get_token) {
3568: if ($token->[0] eq 'S') {
3569: if ($token->[1] eq 'a') {
3570: if ($token->[2]->{'href'}) {
3571: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3572: }
3573: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3574: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3575: } elsif ($token->[1] eq 'base') {
3576: $thisdir=$token->[2]->{'href'};
3577: }
3578: }
3579: }
3580: $thisdir=~s-/[^/]*$--;
1.356 albertel 3581: foreach my $link (@rlinks) {
1.726 raeburn 3582: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3583: ($link=~/^\//) ||
3584: ($link=~/^javascript:/i) ||
3585: ($link=~/^mailto:/i) ||
3586: ($link=~/^\#/)) {
3587: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3588: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3589: }
3590: }
3591: # -------------------------------------------------- Deal with Applet codebases
3592: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3593: return $output;
3594: }
3595:
1.112 bowersj2 3596: =pod
3597:
1.648 raeburn 3598: =item * &get_student_view()
1.112 bowersj2 3599:
3600: show a snapshot of what student was looking at
3601:
3602: =cut
3603:
1.10 albertel 3604: sub get_student_view {
1.186 albertel 3605: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3606: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3607: my (%form);
1.10 albertel 3608: my @elements=('symb','courseid','domain','username');
3609: foreach my $element (@elements) {
1.186 albertel 3610: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3611: }
1.186 albertel 3612: if (defined($moreenv)) {
3613: %form=(%form,%{$moreenv});
3614: }
1.236 albertel 3615: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3616: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3617: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3618: $userview=~s/\<body[^\>]*\>//gi;
3619: $userview=~s/\<\/body\>//gi;
3620: $userview=~s/\<html\>//gi;
3621: $userview=~s/\<\/html\>//gi;
3622: $userview=~s/\<head\>//gi;
3623: $userview=~s/\<\/head\>//gi;
3624: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3625: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3626: if (wantarray) {
3627: return ($userview,$response);
3628: } else {
3629: return $userview;
3630: }
3631: }
3632:
3633: sub get_student_view_with_retries {
3634: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3635:
3636: my $ok = 0; # True if we got a good response.
3637: my $content;
3638: my $response;
3639:
3640: # Try to get the student_view done. within the retries count:
3641:
3642: do {
3643: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3644: $ok = $response->is_success;
3645: if (!$ok) {
3646: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3647: }
3648: $retries--;
3649: } while (!$ok && ($retries > 0));
3650:
3651: if (!$ok) {
3652: $content = ''; # On error return an empty content.
3653: }
1.651 www 3654: if (wantarray) {
3655: return ($content, $response);
3656: } else {
3657: return $content;
3658: }
1.11 albertel 3659: }
3660:
1.112 bowersj2 3661: =pod
3662:
1.648 raeburn 3663: =item * &get_student_answers()
1.112 bowersj2 3664:
3665: show a snapshot of how student was answering problem
3666:
3667: =cut
3668:
1.11 albertel 3669: sub get_student_answers {
1.100 sakharuk 3670: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3671: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3672: my (%moreenv);
1.11 albertel 3673: my @elements=('symb','courseid','domain','username');
3674: foreach my $element (@elements) {
1.186 albertel 3675: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3676: }
1.186 albertel 3677: $moreenv{'grade_target'}='answer';
3678: %moreenv=(%form,%moreenv);
1.497 raeburn 3679: $feedurl = &Apache::lonnet::clutter($feedurl);
3680: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3681: return $userview;
1.1 albertel 3682: }
1.116 albertel 3683:
3684: =pod
3685:
3686: =item * &submlink()
3687:
1.242 albertel 3688: Inputs: $text $uname $udom $symb $target
1.116 albertel 3689:
3690: Returns: A link to grades.pm such as to see the SUBM view of a student
3691:
3692: =cut
3693:
3694: ###############################################
3695: sub submlink {
1.242 albertel 3696: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3697: if (!($uname && $udom)) {
3698: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3699: &Apache::lonnet::whichuser($symb);
1.116 albertel 3700: if (!$symb) { $symb=$cursymb; }
3701: }
1.254 matthew 3702: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3703: $symb=&escape($symb);
1.242 albertel 3704: if ($target) { $target="target=\"$target\""; }
3705: return '<a href="/adm/grades?&command=submission&'.
3706: 'symb='.$symb.'&student='.$uname.
3707: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3708: }
3709: ##############################################
3710:
3711: =pod
3712:
3713: =item * &pgrdlink()
3714:
3715: Inputs: $text $uname $udom $symb $target
3716:
3717: Returns: A link to grades.pm such as to see the PGRD view of a student
3718:
3719: =cut
3720:
3721: ###############################################
3722: sub pgrdlink {
3723: my $link=&submlink(@_);
3724: $link=~s/(&command=submission)/$1&showgrading=yes/;
3725: return $link;
3726: }
3727: ##############################################
3728:
3729: =pod
3730:
3731: =item * &pprmlink()
3732:
3733: Inputs: $text $uname $udom $symb $target
3734:
3735: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3736: student and a specific resource
1.242 albertel 3737:
3738: =cut
3739:
3740: ###############################################
3741: sub pprmlink {
3742: my ($text,$uname,$udom,$symb,$target)=@_;
3743: if (!($uname && $udom)) {
3744: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3745: &Apache::lonnet::whichuser($symb);
1.242 albertel 3746: if (!$symb) { $symb=$cursymb; }
3747: }
1.254 matthew 3748: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3749: $symb=&escape($symb);
1.242 albertel 3750: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3751: return '<a href="/adm/parmset?command=set&'.
3752: 'symb='.$symb.'&uname='.$uname.
3753: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3754: }
3755: ##############################################
1.37 matthew 3756:
1.112 bowersj2 3757: =pod
3758:
3759: =back
3760:
3761: =cut
3762:
1.37 matthew 3763: ###############################################
1.51 www 3764:
3765:
3766: sub timehash {
1.687 raeburn 3767: my ($thistime) = @_;
3768: my $timezone = &Apache::lonlocal::gettimezone();
3769: my $dt = DateTime->from_epoch(epoch => $thistime)
3770: ->set_time_zone($timezone);
3771: my $wday = $dt->day_of_week();
3772: if ($wday == 7) { $wday = 0; }
3773: return ( 'second' => $dt->second(),
3774: 'minute' => $dt->minute(),
3775: 'hour' => $dt->hour(),
3776: 'day' => $dt->day_of_month(),
3777: 'month' => $dt->month(),
3778: 'year' => $dt->year(),
3779: 'weekday' => $wday,
3780: 'dayyear' => $dt->day_of_year(),
3781: 'dlsav' => $dt->is_dst() );
1.51 www 3782: }
3783:
1.370 www 3784: sub utc_string {
3785: my ($date)=@_;
1.371 www 3786: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3787: }
3788:
1.51 www 3789: sub maketime {
3790: my %th=@_;
1.687 raeburn 3791: my ($epoch_time,$timezone,$dt);
3792: $timezone = &Apache::lonlocal::gettimezone();
3793: eval {
3794: $dt = DateTime->new( year => $th{'year'},
3795: month => $th{'month'},
3796: day => $th{'day'},
3797: hour => $th{'hour'},
3798: minute => $th{'minute'},
3799: second => $th{'second'},
3800: time_zone => $timezone,
3801: );
3802: };
3803: if (!$@) {
3804: $epoch_time = $dt->epoch;
3805: if ($epoch_time) {
3806: return $epoch_time;
3807: }
3808: }
1.51 www 3809: return POSIX::mktime(
3810: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3811: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3812: }
3813:
3814: #########################################
1.51 www 3815:
3816: sub findallcourses {
1.482 raeburn 3817: my ($roles,$uname,$udom) = @_;
1.355 albertel 3818: my %roles;
3819: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3820: my %courses;
1.51 www 3821: my $now=time;
1.482 raeburn 3822: if (!defined($uname)) {
3823: $uname = $env{'user.name'};
3824: }
3825: if (!defined($udom)) {
3826: $udom = $env{'user.domain'};
3827: }
3828: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3829: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3830: if (!%roles) {
3831: %roles = (
3832: cc => 1,
1.907 raeburn 3833: co => 1,
1.482 raeburn 3834: in => 1,
3835: ep => 1,
3836: ta => 1,
3837: cr => 1,
3838: st => 1,
3839: );
3840: }
3841: foreach my $entry (keys(%roleshash)) {
3842: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3843: if ($trole =~ /^cr/) {
3844: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3845: } else {
3846: next if (!exists($roles{$trole}));
3847: }
3848: if ($tend) {
3849: next if ($tend < $now);
3850: }
3851: if ($tstart) {
3852: next if ($tstart > $now);
3853: }
3854: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3855: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3856: if ($secpart eq '') {
3857: ($cnum,$role) = split(/_/,$cnumpart);
3858: $sec = 'none';
3859: $realsec = '';
3860: } else {
3861: $cnum = $cnumpart;
3862: ($sec,$role) = split(/_/,$secpart);
3863: $realsec = $sec;
1.490 raeburn 3864: }
1.482 raeburn 3865: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3866: }
3867: } else {
3868: foreach my $key (keys(%env)) {
1.483 albertel 3869: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3870: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3871: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3872: next if ($role eq 'ca' || $role eq 'aa');
3873: next if (%roles && !exists($roles{$role}));
3874: my ($starttime,$endtime)=split(/\./,$env{$key});
3875: my $active=1;
3876: if ($starttime) {
3877: if ($now<$starttime) { $active=0; }
3878: }
3879: if ($endtime) {
3880: if ($now>$endtime) { $active=0; }
3881: }
3882: if ($active) {
3883: if ($sec eq '') {
3884: $sec = 'none';
3885: }
3886: $courses{$cdom.'_'.$cnum}{$sec} =
3887: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3888: }
3889: }
1.51 www 3890: }
3891: }
1.474 raeburn 3892: return %courses;
1.51 www 3893: }
1.37 matthew 3894:
1.54 www 3895: ###############################################
1.474 raeburn 3896:
3897: sub blockcheck {
1.482 raeburn 3898: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3899:
3900: if (!defined($udom)) {
3901: $udom = $env{'user.domain'};
3902: }
3903: if (!defined($uname)) {
3904: $uname = $env{'user.name'};
3905: }
3906:
3907: # If uname and udom are for a course, check for blocks in the course.
3908:
3909: if (&Apache::lonnet::is_course($udom,$uname)) {
3910: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3911: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3912: return ($startblock,$endblock);
3913: }
1.474 raeburn 3914:
1.502 raeburn 3915: my $startblock = 0;
3916: my $endblock = 0;
1.482 raeburn 3917: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3918:
1.490 raeburn 3919: # If uname is for a user, and activity is course-specific, i.e.,
3920: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3921:
1.490 raeburn 3922: if (($activity eq 'boards' || $activity eq 'chat' ||
3923: $activity eq 'groups') && ($env{'request.course.id'})) {
3924: foreach my $key (keys(%live_courses)) {
3925: if ($key ne $env{'request.course.id'}) {
3926: delete($live_courses{$key});
3927: }
3928: }
3929: }
3930:
3931: my $otheruser = 0;
3932: my %own_courses;
3933: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3934: # Resource belongs to user other than current user.
3935: $otheruser = 1;
3936: # Gather courses for current user
3937: %own_courses =
3938: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3939: }
3940:
3941: # Gather active course roles - course coordinator, instructor,
3942: # exam proctor, ta, student, or custom role.
1.474 raeburn 3943:
3944: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3945: my ($cdom,$cnum);
3946: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3947: $cdom = $env{'course.'.$course.'.domain'};
3948: $cnum = $env{'course.'.$course.'.num'};
3949: } else {
1.490 raeburn 3950: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3951: }
3952: my $no_ownblock = 0;
3953: my $no_userblock = 0;
1.533 raeburn 3954: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3955: # Check if current user has 'evb' priv for this
3956: if (defined($own_courses{$course})) {
3957: foreach my $sec (keys(%{$own_courses{$course}})) {
3958: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3959: if ($sec ne 'none') {
3960: $checkrole .= '/'.$sec;
3961: }
3962: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3963: $no_ownblock = 1;
3964: last;
3965: }
3966: }
3967: }
3968: # if they have 'evb' priv and are currently not playing student
3969: next if (($no_ownblock) &&
3970: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3971: }
1.474 raeburn 3972: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3973: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3974: if ($sec ne 'none') {
1.482 raeburn 3975: $checkrole .= '/'.$sec;
1.474 raeburn 3976: }
1.490 raeburn 3977: if ($otheruser) {
3978: # Resource belongs to user other than current user.
3979: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3980: my ($trole,$tdom,$tnum,$tsec);
3981: my $entry = $live_courses{$course}{$sec};
3982: if ($entry =~ /^cr/) {
3983: ($trole,$tdom,$tnum,$tsec) =
3984: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3985: } else {
3986: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3987: }
3988: my ($spec,$area,$trest,%allroles,%userroles);
3989: $area = '/'.$tdom.'/'.$tnum;
3990: $trest = $tnum;
3991: if ($tsec ne '') {
3992: $area .= '/'.$tsec;
3993: $trest .= '/'.$tsec;
3994: }
3995: $spec = $trole.'.'.$area;
3996: if ($trole =~ /^cr/) {
3997: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3998: $tdom,$spec,$trest,$area);
3999: } else {
4000: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4001: $tdom,$spec,$trest,$area);
4002: }
4003: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 4004: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4005: if ($1) {
4006: $no_userblock = 1;
4007: last;
4008: }
4009: }
1.490 raeburn 4010: } else {
4011: # Resource belongs to current user
4012: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4013: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4014: $no_ownblock = 1;
4015: last;
4016: }
1.474 raeburn 4017: }
4018: }
4019: # if they have the evb priv and are currently not playing student
1.482 raeburn 4020: next if (($no_ownblock) &&
1.491 albertel 4021: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4022: next if ($no_userblock);
1.474 raeburn 4023:
1.866 kalberla 4024: # Retrieve blocking times and identity of locker for course
1.490 raeburn 4025: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4026:
4027: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
4028: if (($start != 0) &&
4029: (($startblock == 0) || ($startblock > $start))) {
4030: $startblock = $start;
4031: }
4032: if (($end != 0) &&
4033: (($endblock == 0) || ($endblock < $end))) {
4034: $endblock = $end;
4035: }
1.490 raeburn 4036: }
4037: return ($startblock,$endblock);
4038: }
4039:
4040: sub get_blocks {
4041: my ($setters,$activity,$cdom,$cnum) = @_;
4042: my $startblock = 0;
4043: my $endblock = 0;
4044: my $course = $cdom.'_'.$cnum;
4045: $setters->{$course} = {};
4046: $setters->{$course}{'staff'} = [];
4047: $setters->{$course}{'times'} = [];
4048: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
4049: foreach my $record (keys(%records)) {
4050: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
4051: if ($start <= time && $end >= time) {
4052: my ($staff_name,$staff_dom,$title,$blocks) =
4053: &parse_block_record($records{$record});
4054: if ($blocks->{$activity} eq 'on') {
4055: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4056: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 4057: if ( ($startblock == 0) || ($startblock > $start) ) {
4058: $startblock = $start;
1.490 raeburn 4059: }
1.491 albertel 4060: if ( ($endblock == 0) || ($endblock < $end) ) {
4061: $endblock = $end;
1.474 raeburn 4062: }
4063: }
4064: }
4065: }
4066: return ($startblock,$endblock);
4067: }
4068:
4069: sub parse_block_record {
4070: my ($record) = @_;
4071: my ($setuname,$setudom,$title,$blocks);
4072: if (ref($record) eq 'HASH') {
4073: ($setuname,$setudom) = split(/:/,$record->{'setter'});
4074: $title = &unescape($record->{'event'});
4075: $blocks = $record->{'blocks'};
4076: } else {
4077: my @data = split(/:/,$record,3);
4078: if (scalar(@data) eq 2) {
4079: $title = $data[1];
4080: ($setuname,$setudom) = split(/@/,$data[0]);
4081: } else {
4082: ($setuname,$setudom,$title) = @data;
4083: }
4084: $blocks = { 'com' => 'on' };
4085: }
4086: return ($setuname,$setudom,$title,$blocks);
4087: }
4088:
1.854 kalberla 4089: sub blocking_status {
4090: my ($activity,$uname,$udom) = @_;
1.867 kalberla 4091: my %setters;
1.890 droeschl 4092:
4093: # check for active blocking
1.867 kalberla 4094: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854 kalberla 4095:
1.890 droeschl 4096: my $blocked = $startblock && $endblock ? 1 : 0;
4097:
4098: # caller just wants to know whether a block is active
4099: if (!wantarray) { return $blocked; }
4100:
4101: # build a link to a popup window containing the details
4102: my $querystring = "?activity=$activity";
4103: # $uname and $udom decide whose portfolio the user is trying to look at
4104: $querystring .= "&udom=$udom" if $udom;
4105: $querystring .= "&uname=$uname" if $uname;
4106:
4107: my $output .= <<'END_MYBLOCK';
1.854 kalberla 4108: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4109: var options = "width=" + w + ",height=" + h + ",";
4110: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4111: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4112: var newWin = window.open(url, wdwName, options);
4113: newWin.focus();
4114: }
1.890 droeschl 4115: END_MYBLOCK
1.854 kalberla 4116:
1.890 droeschl 4117: $output = Apache::lonhtmlcommon::scripttag($output);
4118:
1.854 kalberla 4119: my $popupUrl = "/adm/blockingstatus/$querystring";
1.890 droeschl 4120: my $text = mt('Communication Blocked');
4121:
1.867 kalberla 4122: $output .= <<"END_BLOCK";
4123: <div class='LC_comblock'>
1.869 kalberla 4124: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4125: title='$text'>
4126: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 4127: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 4128: title='$text'>$text</a>
1.867 kalberla 4129: </div>
4130:
4131: END_BLOCK
1.474 raeburn 4132:
1.854 kalberla 4133: return ($blocked, $output);
4134: }
1.490 raeburn 4135:
1.60 matthew 4136: ###############################################
4137:
1.682 raeburn 4138: sub check_ip_acc {
4139: my ($acc)=@_;
4140: &Apache::lonxml::debug("acc is $acc");
4141: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4142: return 1;
4143: }
4144: my $allowed=0;
4145: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4146:
4147: my $name;
4148: foreach my $pattern (split(',',$acc)) {
4149: $pattern =~ s/^\s*//;
4150: $pattern =~ s/\s*$//;
4151: if ($pattern =~ /\*$/) {
4152: #35.8.*
4153: $pattern=~s/\*//;
4154: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4155: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4156: #35.8.3.[34-56]
4157: my $low=$2;
4158: my $high=$3;
4159: $pattern=$1;
4160: if ($ip =~ /^\Q$pattern\E/) {
4161: my $last=(split(/\./,$ip))[3];
4162: if ($last <=$high && $last >=$low) { $allowed=1; }
4163: }
4164: } elsif ($pattern =~ /^\*/) {
4165: #*.msu.edu
4166: $pattern=~s/\*//;
4167: if (!defined($name)) {
4168: use Socket;
4169: my $netaddr=inet_aton($ip);
4170: ($name)=gethostbyaddr($netaddr,AF_INET);
4171: }
4172: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4173: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4174: #127.0.0.1
4175: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4176: } else {
4177: #some.name.com
4178: if (!defined($name)) {
4179: use Socket;
4180: my $netaddr=inet_aton($ip);
4181: ($name)=gethostbyaddr($netaddr,AF_INET);
4182: }
4183: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4184: }
4185: if ($allowed) { last; }
4186: }
4187: return $allowed;
4188: }
4189:
4190: ###############################################
4191:
1.60 matthew 4192: =pod
4193:
1.112 bowersj2 4194: =head1 Domain Template Functions
4195:
4196: =over 4
4197:
4198: =item * &determinedomain()
1.60 matthew 4199:
4200: Inputs: $domain (usually will be undef)
4201:
1.63 www 4202: Returns: Determines which domain should be used for designs
1.60 matthew 4203:
4204: =cut
1.54 www 4205:
1.60 matthew 4206: ###############################################
1.63 www 4207: sub determinedomain {
4208: my $domain=shift;
1.531 albertel 4209: if (! $domain) {
1.60 matthew 4210: # Determine domain if we have not been given one
1.893 raeburn 4211: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 4212: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4213: if ($env{'request.role.domain'}) {
4214: $domain=$env{'request.role.domain'};
1.60 matthew 4215: }
4216: }
1.63 www 4217: return $domain;
4218: }
4219: ###############################################
1.517 raeburn 4220:
1.518 albertel 4221: sub devalidate_domconfig_cache {
4222: my ($udom)=@_;
4223: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4224: }
4225:
4226: # ---------------------- Get domain configuration for a domain
4227: sub get_domainconf {
4228: my ($udom) = @_;
4229: my $cachetime=1800;
4230: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4231: if (defined($cached)) { return %{$result}; }
4232:
4233: my %domconfig = &Apache::lonnet::get_dom('configuration',
4234: ['login','rolecolors'],$udom);
1.632 raeburn 4235: my (%designhash,%legacy);
1.518 albertel 4236: if (keys(%domconfig) > 0) {
4237: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4238: if (keys(%{$domconfig{'login'}})) {
4239: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4240: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4241: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4242: $designhash{$udom.'.login.'.$key.'_'.$img} =
4243: $domconfig{'login'}{$key}{$img};
4244: }
4245: } else {
4246: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4247: }
1.632 raeburn 4248: }
4249: } else {
4250: $legacy{'login'} = 1;
1.518 albertel 4251: }
1.632 raeburn 4252: } else {
4253: $legacy{'login'} = 1;
1.518 albertel 4254: }
4255: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4256: if (keys(%{$domconfig{'rolecolors'}})) {
4257: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4258: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4259: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4260: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4261: }
1.518 albertel 4262: }
4263: }
1.632 raeburn 4264: } else {
4265: $legacy{'rolecolors'} = 1;
1.518 albertel 4266: }
1.632 raeburn 4267: } else {
4268: $legacy{'rolecolors'} = 1;
1.518 albertel 4269: }
1.632 raeburn 4270: if (keys(%legacy) > 0) {
4271: my %legacyhash = &get_legacy_domconf($udom);
4272: foreach my $item (keys(%legacyhash)) {
4273: if ($item =~ /^\Q$udom\E\.login/) {
4274: if ($legacy{'login'}) {
4275: $designhash{$item} = $legacyhash{$item};
4276: }
4277: } else {
4278: if ($legacy{'rolecolors'}) {
4279: $designhash{$item} = $legacyhash{$item};
4280: }
1.518 albertel 4281: }
4282: }
4283: }
1.632 raeburn 4284: } else {
4285: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4286: }
4287: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4288: $cachetime);
4289: return %designhash;
4290: }
4291:
1.632 raeburn 4292: sub get_legacy_domconf {
4293: my ($udom) = @_;
4294: my %legacyhash;
4295: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4296: my $designfile = $designdir.'/'.$udom.'.tab';
4297: if (-e $designfile) {
4298: if ( open (my $fh,"<$designfile") ) {
4299: while (my $line = <$fh>) {
4300: next if ($line =~ /^\#/);
4301: chomp($line);
4302: my ($key,$val)=(split(/\=/,$line));
4303: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4304: }
4305: close($fh);
4306: }
4307: }
4308: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4309: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4310: }
4311: return %legacyhash;
4312: }
4313:
1.63 www 4314: =pod
4315:
1.112 bowersj2 4316: =item * &domainlogo()
1.63 www 4317:
4318: Inputs: $domain (usually will be undef)
4319:
4320: Returns: A link to a domain logo, if the domain logo exists.
4321: If the domain logo does not exist, a description of the domain.
4322:
4323: =cut
1.112 bowersj2 4324:
1.63 www 4325: ###############################################
4326: sub domainlogo {
1.517 raeburn 4327: my $domain = &determinedomain(shift);
1.518 albertel 4328: my %designhash = &get_domainconf($domain);
1.517 raeburn 4329: # See if there is a logo
4330: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4331: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4332: if ($imgsrc =~ m{^/(adm|res)/}) {
4333: if ($imgsrc =~ m{^/res/}) {
4334: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4335: &Apache::lonnet::repcopy($local_name);
4336: }
4337: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4338: }
4339: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4340: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4341: return &Apache::lonnet::domain($domain,'description');
1.59 www 4342: } else {
1.60 matthew 4343: return '';
1.59 www 4344: }
4345: }
1.63 www 4346: ##############################################
4347:
4348: =pod
4349:
1.112 bowersj2 4350: =item * &designparm()
1.63 www 4351:
4352: Inputs: $which parameter; $domain (usually will be undef)
4353:
4354: Returns: value of designparamter $which
4355:
4356: =cut
1.112 bowersj2 4357:
1.397 albertel 4358:
1.400 albertel 4359: ##############################################
1.397 albertel 4360: sub designparm {
4361: my ($which,$domain)=@_;
4362: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4363: return $env{'environment.color.'.$which};
1.96 www 4364: }
1.63 www 4365: $domain=&determinedomain($domain);
1.518 albertel 4366: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4367: my $output;
1.517 raeburn 4368: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4369: $output = $domdesign{$domain.'.'.$which};
1.63 www 4370: } else {
1.520 raeburn 4371: $output = $defaultdesign{$which};
4372: }
4373: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4374: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4375: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4376: if ($output =~ m{^/res/}) {
4377: my $local_name = &Apache::lonnet::filelocation('',$output);
4378: &Apache::lonnet::repcopy($local_name);
4379: }
1.520 raeburn 4380: $output = &lonhttpdurl($output);
4381: }
1.63 www 4382: }
1.520 raeburn 4383: return $output;
1.63 www 4384: }
1.59 www 4385:
1.822 bisitz 4386: ##############################################
4387: =pod
4388:
1.832 bisitz 4389: =item * &authorspace()
4390:
4391: Inputs: ./.
4392:
4393: Returns: Path to the Construction Space of the current user's
4394: accessed author space
4395: The author space will be that of the current user
4396: when accessing the own author space
4397: and that of the co-author/assistent co-author
4398: when accessing the co-author's/assistent co-author's
4399: space
4400:
4401: =cut
4402:
4403: sub authorspace {
4404: my $caname = '';
4405: if ($env{'request.role'} =~ /^ca|^aa/) {
4406: (undef,$caname) =
4407: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4408: } else {
4409: $caname = $env{'user.name'};
4410: }
4411: return '/priv/'.$caname.'/';
4412: }
4413:
4414: ##############################################
4415: =pod
4416:
1.822 bisitz 4417: =item * &head_subbox()
4418:
4419: Inputs: $content (contains HTML code with page functions, etc.)
4420:
4421: Returns: HTML div with $content
4422: To be included in page header
4423:
4424: =cut
4425:
4426: sub head_subbox {
4427: my ($content)=@_;
4428: my $output =
1.844 bisitz 4429: '<div id="LC_head_subbox">'
1.822 bisitz 4430: .$content
4431: .'</div>'
4432: }
4433:
4434: ##############################################
4435: =pod
4436:
4437: =item * &CSTR_pageheader()
4438:
4439: Inputs: ./.
4440:
4441: Returns: HTML div with CSTR path and recent box
4442: To be included on Construction Space pages
4443:
4444: =cut
4445:
4446: sub CSTR_pageheader {
4447: # this is for resources; directories have customtitle, and crumbs
4448: # and select recent are created in lonpubdir.pm
4449: my ($uname,$thisdisfn)=
4450: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4451: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4452: $formaction=~s/\/+/\//g;
4453:
4454: my $parentpath = '';
4455: my $lastitem = '';
4456: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4457: $parentpath = $1;
4458: $lastitem = $2;
4459: } else {
4460: $lastitem = $thisdisfn;
4461: }
1.921 bisitz 4462:
4463: my $output =
1.822 bisitz 4464: '<div>'
4465: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4466: .'<b>'.&mt('Construction Space:').'</b> '
4467: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 4468: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4469: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4470:
4471: if ($lastitem) {
4472: $output .=
4473: '<span class="LC_filename">'
4474: .$lastitem
4475: .'</span>';
4476: }
4477: $output .=
4478: '<br />'
1.822 bisitz 4479: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4480: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4481: .'</form>'
4482: .&Apache::lonmenu::constspaceform()
4483: .'</div>';
1.921 bisitz 4484:
4485: return $output;
1.822 bisitz 4486: }
4487:
1.60 matthew 4488: ###############################################
4489: ###############################################
4490:
4491: =pod
4492:
1.112 bowersj2 4493: =back
4494:
1.549 albertel 4495: =head1 HTML Helpers
1.112 bowersj2 4496:
4497: =over 4
4498:
4499: =item * &bodytag()
1.60 matthew 4500:
4501: Returns a uniform header for LON-CAPA web pages.
4502:
4503: Inputs:
4504:
1.112 bowersj2 4505: =over 4
4506:
4507: =item * $title, A title to be displayed on the page.
4508:
4509: =item * $function, the current role (can be undef).
4510:
4511: =item * $addentries, extra parameters for the <body> tag.
4512:
4513: =item * $bodyonly, if defined, only return the <body> tag.
4514:
4515: =item * $domain, if defined, force a given domain.
4516:
4517: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4518: text interface only)
1.60 matthew 4519:
1.814 bisitz 4520: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4521: navigational links
1.317 albertel 4522:
1.338 albertel 4523: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4524:
1.361 albertel 4525: =item * $no_inline_link, if true and in remote mode, don't show the
4526: 'Switch To Inline Menu' link
4527:
1.460 albertel 4528: =item * $args, optional argument valid values are
4529: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4530: inherit_jsmath -> when creating popup window in a page,
4531: should it have jsmath forced on by the
4532: current page
1.460 albertel 4533:
1.112 bowersj2 4534: =back
4535:
1.60 matthew 4536: Returns: A uniform header for LON-CAPA web pages.
4537: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4538: If $bodyonly is undef or zero, an html string containing a <body> tag and
4539: other decorations will be returned.
4540:
4541: =cut
4542:
1.54 www 4543: sub bodytag {
1.831 bisitz 4544: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816 bisitz 4545: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4546:
1.460 albertel 4547: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4548:
1.183 matthew 4549: $function = &get_users_function() if (!$function);
1.339 albertel 4550: my $img = &designparm($function.'.img',$domain);
4551: my $font = &designparm($function.'.font',$domain);
4552: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4553:
1.803 bisitz 4554: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4555: 'bgcolor' => $pgbg,
1.339 albertel 4556: 'text' => $font,
4557: 'alink' => &designparm($function.'.alink',$domain),
4558: 'vlink' => &designparm($function.'.vlink',$domain),
4559: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4560: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4561:
1.63 www 4562: # role and realm
1.378 raeburn 4563: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4564: if ($role eq 'ca') {
1.479 albertel 4565: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4566: $realm = &plainname($rname,$rdom);
1.378 raeburn 4567: }
1.55 www 4568: # realm
1.258 albertel 4569: if ($env{'request.course.id'}) {
1.378 raeburn 4570: if ($env{'request.role'} !~ /^cr/) {
4571: $role = &Apache::lonnet::plaintext($role,&course_type());
4572: }
1.898 raeburn 4573: if ($env{'request.course.sec'}) {
4574: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4575: }
1.359 albertel 4576: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4577: } else {
4578: $role = &Apache::lonnet::plaintext($role);
1.54 www 4579: }
1.433 albertel 4580:
1.359 albertel 4581: if (!$realm) { $realm=' '; }
1.55 www 4582: # Set messages
1.60 matthew 4583: my $messages=&domainlogo($domain);
1.330 albertel 4584:
1.438 albertel 4585: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4586:
1.101 www 4587: # construct main body tag
1.359 albertel 4588: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4589: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4590:
1.530 albertel 4591: if ($bodyonly) {
1.60 matthew 4592: return $bodytag;
1.798 tempelho 4593: }
1.359 albertel 4594:
1.410 albertel 4595: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4596: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4597: undef($role);
1.434 albertel 4598: } else {
4599: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4600: }
1.359 albertel 4601:
1.762 bisitz 4602: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4603: #
4604: # Extra info if you are the DC
4605: my $dc_info = '';
4606: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4607: $env{'course.'.$env{'request.course.id'}.
4608: '.domain'}.'/'})) {
4609: my $cid = $env{'request.course.id'};
1.917 raeburn 4610: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4611: $dc_info =~ s/\s+$//;
1.359 albertel 4612: }
4613:
1.898 raeburn 4614: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853 droeschl 4615: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4616:
1.837 bisitz 4617: if ($env{'environment.remote'} eq 'off') {
1.359 albertel 4618: # No Remote
1.916 droeschl 4619: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4620: return $bodytag;
4621: }
1.903 droeschl 4622:
4623: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4624:
4625: # if ($env{'request.state'} eq 'construct') {
4626: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4627: # }
4628:
1.359 albertel 4629:
4630:
1.916 droeschl 4631: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 4632: if ($dc_info) {
4633: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4634: }
1.916 droeschl 4635: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4636: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 4637: return $bodytag;
4638: }
1.894 droeschl 4639:
1.927 raeburn 4640: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
4641: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
4642: }
1.916 droeschl 4643:
1.903 droeschl 4644: $bodytag .= Apache::lonhtmlcommon::scripttag(
4645: Apache::lonmenu::utilityfunctions(), 'start');
1.816 bisitz 4646:
1.903 droeschl 4647: $bodytag .= Apache::lonmenu::primary_menu();
1.852 droeschl 4648:
1.917 raeburn 4649: if ($dc_info) {
4650: $dc_info = &dc_courseid_toggle($dc_info);
4651: }
4652: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 4653:
1.903 droeschl 4654: #don't show menus for public users
4655: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4656: $bodytag .= Apache::lonmenu::secondary_menu();
4657: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 4658: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4659: if ($env{'request.state'} eq 'construct') {
4660: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4661: $args->{'bread_crumbs'});
4662: } elsif ($forcereg) {
4663: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4664: }
1.903 droeschl 4665: }else{
4666: # this is to seperate menu from content when there's no secondary
4667: # menu. Especially needed for public accessible ressources.
4668: $bodytag .= '<hr style="clear:both" />';
4669: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 4670: }
1.903 droeschl 4671:
1.235 raeburn 4672: return $bodytag;
1.94 www 4673: }
1.95 www 4674:
1.93 www 4675: #
1.95 www 4676: # Top frame rendering, Remote is up
1.93 www 4677: #
1.359 albertel 4678:
1.517 raeburn 4679: my $imgsrc = $img;
4680: if ($img =~ /^\/adm/) {
1.575 albertel 4681: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4682: }
4683: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4684:
1.305 www 4685: # Explicit link to get inline menu
1.361 albertel 4686: my $menu= ($no_inline_link?''
1.883 droeschl 4687: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917 raeburn 4688:
4689: if ($dc_info) {
4690: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4691: }
4692:
1.916 droeschl 4693: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897 wenzelju 4694: <ol class="LC_primary_menu LC_right">
1.853 droeschl 4695: <li>$menu</li>
1.917 raeburn 4696: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94 www 4697: return(<<ENDBODY);
1.60 matthew 4698: $bodytag
1.359 albertel 4699: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4700: <tr><td>$upperleft</td>
4701: <td>$messages </td>
1.54 www 4702: </tr>
1.359 albertel 4703: <tr><td>$titleinfo $dc_info $menu</td>
1.368 albertel 4704: </tr>
1.356 albertel 4705: </table>
1.54 www 4706: ENDBODY
1.182 matthew 4707: }
4708:
1.917 raeburn 4709: sub dc_courseid_toggle {
4710: my ($dc_info) = @_;
4711: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4712: '<a href="javascript:showCourseID();">'.
4713: &mt('(More ...)').'</a></span>'.
4714: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4715: }
4716:
1.330 albertel 4717: sub make_attr_string {
4718: my ($register,$attr_ref) = @_;
4719:
4720: if ($attr_ref && !ref($attr_ref)) {
4721: die("addentries Must be a hash ref ".
4722: join(':',caller(1))." ".
4723: join(':',caller(0))." ");
4724: }
4725:
4726: if ($register) {
1.339 albertel 4727: my ($on_load,$on_unload);
4728: foreach my $key (keys(%{$attr_ref})) {
4729: if (lc($key) eq 'onload') {
4730: $on_load.=$attr_ref->{$key}.';';
4731: delete($attr_ref->{$key});
4732:
4733: } elsif (lc($key) eq 'onunload') {
4734: $on_unload.=$attr_ref->{$key}.';';
4735: delete($attr_ref->{$key});
4736: }
4737: }
4738: $attr_ref->{'onload'} =
4739: &Apache::lonmenu::loadevents(). $on_load;
4740: $attr_ref->{'onunload'}=
4741: &Apache::lonmenu::unloadevents().$on_unload;
4742: }
4743:
4744: # Accessibility font enhance
4745: if ($env{'browser.fontenhance'} eq 'on') {
4746: my $style;
4747: foreach my $key (keys(%{$attr_ref})) {
4748: if (lc($key) eq 'style') {
4749: $style.=$attr_ref->{$key}.';';
4750: delete($attr_ref->{$key});
4751: }
4752: }
4753: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4754: }
1.339 albertel 4755:
1.330 albertel 4756: my $attr_string;
4757: foreach my $attr (keys(%$attr_ref)) {
4758: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4759: }
4760: return $attr_string;
4761: }
4762:
4763:
1.182 matthew 4764: ###############################################
1.251 albertel 4765: ###############################################
4766:
4767: =pod
4768:
4769: =item * &endbodytag()
4770:
4771: Returns a uniform footer for LON-CAPA web pages.
4772:
1.635 raeburn 4773: Inputs: 1 - optional reference to an args hash
4774: If in the hash, key for noredirectlink has a value which evaluates to true,
4775: a 'Continue' link is not displayed if the page contains an
4776: internal redirect in the <head></head> section,
4777: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4778:
4779: =cut
4780:
4781: sub endbodytag {
1.635 raeburn 4782: my ($args) = @_;
1.251 albertel 4783: my $endbodytag='</body>';
1.269 albertel 4784: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4785: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4786: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4787: $endbodytag=
4788: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4789: &mt('Continue').'</a>'.
4790: $endbodytag;
4791: }
1.315 albertel 4792: }
1.251 albertel 4793: return $endbodytag;
4794: }
4795:
1.352 albertel 4796: =pod
4797:
4798: =item * &standard_css()
4799:
4800: Returns a style sheet
4801:
4802: Inputs: (all optional)
4803: domain -> force to color decorate a page for a specific
4804: domain
4805: function -> force usage of a specific rolish color scheme
4806: bgcolor -> override the default page bgcolor
4807:
4808: =cut
4809:
1.343 albertel 4810: sub standard_css {
1.345 albertel 4811: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4812: $function = &get_users_function() if (!$function);
4813: my $img = &designparm($function.'.img', $domain);
4814: my $tabbg = &designparm($function.'.tabbg', $domain);
4815: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4816: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4817: #second colour for later usage
1.345 albertel 4818: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4819: my $pgbg_or_bgcolor =
4820: $bgcolor ||
1.352 albertel 4821: &designparm($function.'.pgbg', $domain);
1.382 albertel 4822: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4823: my $alink = &designparm($function.'.alink', $domain);
4824: my $vlink = &designparm($function.'.vlink', $domain);
4825: my $link = &designparm($function.'.link', $domain);
4826:
1.704 muellerd 4827: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4828: my $bgcol = &designparm('login.bgcol',$domain);
4829: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4830:
1.602 albertel 4831: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4832: my $mono = 'monospace';
1.850 bisitz 4833: my $data_table_head = $sidebg;
4834: my $data_table_light = '#FAFAFA';
4835: my $data_table_dark = '#F0F0F0';
1.470 banghart 4836: my $data_table_darker = '#CCCCCC';
1.349 albertel 4837: my $data_table_highlight = '#FFFF00';
1.352 albertel 4838: my $mail_new = '#FFBB77';
4839: my $mail_new_hover = '#DD9955';
4840: my $mail_read = '#BBBB77';
4841: my $mail_read_hover = '#999944';
4842: my $mail_replied = '#AAAA88';
4843: my $mail_replied_hover = '#888855';
4844: my $mail_other = '#99BBBB';
4845: my $mail_other_hover = '#669999';
1.391 albertel 4846: my $table_header = '#DDDDDD';
1.489 raeburn 4847: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 4848: my $lg_border_color = '#C8C8C8';
1.392 albertel 4849:
1.608 albertel 4850: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 4851: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4852: : '0 3px 0 4px';
1.448 albertel 4853:
1.523 albertel 4854:
1.343 albertel 4855: return <<END;
1.795 www 4856: body {
1.911 bisitz 4857: font-family: $sans;
4858: line-height:130%;
4859: font-size:0.83em;
4860: color:$font;
1.795 www 4861: }
4862:
1.911 bisitz 4863: a:focus {
1.795 www 4864: color: red;
1.911 bisitz 4865: background: yellow;
1.795 www 4866: }
1.698 harmsja 4867:
1.911 bisitz 4868: form, .inline {
4869: display: inline;
1.795 www 4870: }
1.721 harmsja 4871:
1.795 www 4872: .LC_right {
1.911 bisitz 4873: text-align:right;
1.795 www 4874: }
4875:
4876: .LC_middle {
1.911 bisitz 4877: vertical-align:middle;
1.795 www 4878: }
1.721 harmsja 4879:
1.911 bisitz 4880: .LC_400Box {
4881: width:400px;
4882: }
1.721 harmsja 4883:
1.778 bisitz 4884: .LC_filename {
4885: font-family: $mono;
4886: white-space:pre;
1.921 bisitz 4887: font-size: 120%;
1.778 bisitz 4888: }
4889:
4890: .LC_fileicon {
4891: border: none;
4892: height: 1.3em;
4893: vertical-align: text-bottom;
4894: margin-right: 0.3em;
4895: text-decoration:none;
4896: }
4897:
1.350 albertel 4898: .LC_error {
4899: color: red;
4900: font-size: larger;
4901: }
1.795 www 4902:
1.457 albertel 4903: .LC_warning,
4904: .LC_diff_removed {
1.733 bisitz 4905: color: red;
1.394 albertel 4906: }
1.532 albertel 4907:
4908: .LC_info,
1.457 albertel 4909: .LC_success,
4910: .LC_diff_added {
1.350 albertel 4911: color: green;
4912: }
1.795 www 4913:
1.802 bisitz 4914: div.LC_confirm_box {
4915: background-color: #FAFAFA;
4916: border: 1px solid $lg_border_color;
4917: margin-right: 0;
4918: padding: 5px;
4919: }
4920:
4921: div.LC_confirm_box .LC_error img,
4922: div.LC_confirm_box .LC_success img {
4923: vertical-align: middle;
4924: }
4925:
1.440 albertel 4926: .LC_icon {
1.771 droeschl 4927: border: none;
1.790 droeschl 4928: vertical-align: middle;
1.771 droeschl 4929: }
4930:
1.543 albertel 4931: .LC_docs_spacer {
4932: width: 25px;
4933: height: 1px;
1.771 droeschl 4934: border: none;
1.543 albertel 4935: }
1.346 albertel 4936:
1.532 albertel 4937: .LC_internal_info {
1.735 bisitz 4938: color: #999999;
1.532 albertel 4939: }
4940:
1.794 www 4941: .LC_discussion {
1.911 bisitz 4942: background: $tabbg;
4943: border: 1px solid black;
4944: margin: 2px;
1.794 www 4945: }
4946:
4947: .LC_disc_action_links_bar {
1.911 bisitz 4948: background: $tabbg;
4949: border: none;
4950: margin: 4px;
1.794 www 4951: }
4952:
4953: .LC_disc_action_left {
1.911 bisitz 4954: text-align: left;
1.794 www 4955: }
4956:
4957: .LC_disc_action_right {
1.911 bisitz 4958: text-align: right;
1.794 www 4959: }
4960:
4961: .LC_disc_new_item {
1.911 bisitz 4962: background: white;
4963: border: 2px solid red;
4964: margin: 2px;
1.794 www 4965: }
4966:
4967: .LC_disc_old_item {
1.911 bisitz 4968: background: white;
4969: border: 1px solid black;
4970: margin: 2px;
1.794 www 4971: }
4972:
1.458 albertel 4973: table.LC_pastsubmission {
4974: border: 1px solid black;
4975: margin: 2px;
4976: }
4977:
1.924 bisitz 4978: table#LC_menubuttons {
1.345 albertel 4979: width: 100%;
4980: background: $pgbg;
1.392 albertel 4981: border: 2px;
1.402 albertel 4982: border-collapse: separate;
1.803 bisitz 4983: padding: 0;
1.345 albertel 4984: }
1.392 albertel 4985:
1.801 tempelho 4986: table#LC_title_bar a {
4987: color: $fontmenu;
4988: }
1.836 bisitz 4989:
1.807 droeschl 4990: table#LC_title_bar {
1.819 tempelho 4991: clear: both;
1.836 bisitz 4992: display: none;
1.807 droeschl 4993: }
4994:
1.795 www 4995: table#LC_title_bar,
1.933 droeschl 4996: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 4997: table#LC_title_bar.LC_with_remote {
1.359 albertel 4998: width: 100%;
1.392 albertel 4999: border-color: $pgbg;
5000: border-style: solid;
5001: border-width: $border;
1.379 albertel 5002: background: $pgbg;
1.801 tempelho 5003: color: $fontmenu;
1.392 albertel 5004: border-collapse: collapse;
1.803 bisitz 5005: padding: 0;
1.819 tempelho 5006: margin: 0;
1.359 albertel 5007: }
1.795 www 5008:
1.933 droeschl 5009: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 5010: margin: 0;
5011: padding: 0;
1.933 droeschl 5012: position: relative;
5013: list-style: none;
1.913 droeschl 5014: }
1.933 droeschl 5015: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 5016: display: inline;
5017: }
1.933 droeschl 5018:
5019: .LC_breadcrumb_tools_navigation {
1.913 droeschl 5020: padding: 0;
1.933 droeschl 5021: margin: 0;
5022: float: left;
1.913 droeschl 5023: }
1.933 droeschl 5024: .LC_breadcrumb_tools_tools {
5025: padding: 0;
5026: margin: 0;
1.913 droeschl 5027: float: right;
5028: }
5029:
1.359 albertel 5030: table#LC_title_bar td {
5031: background: $tabbg;
5032: }
1.795 www 5033:
1.911 bisitz 5034: table#LC_menubuttons img {
1.803 bisitz 5035: border: none;
1.346 albertel 5036: }
1.795 www 5037:
1.842 droeschl 5038: .LC_breadcrumbs_component {
1.911 bisitz 5039: float: right;
5040: margin: 0 1em;
1.357 albertel 5041: }
1.842 droeschl 5042: .LC_breadcrumbs_component img {
1.911 bisitz 5043: vertical-align: middle;
1.777 tempelho 5044: }
1.795 www 5045:
1.383 albertel 5046: td.LC_table_cell_checkbox {
5047: text-align: center;
5048: }
1.795 www 5049:
5050: .LC_fontsize_small {
1.911 bisitz 5051: font-size: 70%;
1.705 tempelho 5052: }
5053:
1.844 bisitz 5054: #LC_breadcrumbs {
1.911 bisitz 5055: clear:both;
5056: background: $sidebg;
5057: border-bottom: 1px solid $lg_border_color;
5058: line-height: 2.5em;
1.933 droeschl 5059: overflow: hidden;
1.911 bisitz 5060: margin: 0;
5061: padding: 0;
1.819 tempelho 5062: }
1.862 bisitz 5063:
1.839 droeschl 5064: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844 bisitz 5065: #LC_remote #LC_breadcrumbs {
1.911 bisitz 5066: display:none;
1.839 droeschl 5067: }
1.819 tempelho 5068:
1.844 bisitz 5069: #LC_head_subbox {
1.911 bisitz 5070: clear:both;
5071: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 5072: border: 1px solid $sidebg;
5073: margin: 0 0 10px 0;
1.822 bisitz 5074: }
5075:
1.795 www 5076: .LC_fontsize_medium {
1.911 bisitz 5077: font-size: 85%;
1.705 tempelho 5078: }
5079:
1.795 www 5080: .LC_fontsize_large {
1.911 bisitz 5081: font-size: 120%;
1.705 tempelho 5082: }
5083:
1.346 albertel 5084: .LC_menubuttons_inline_text {
5085: color: $font;
1.698 harmsja 5086: font-size: 90%;
1.701 harmsja 5087: padding-left:3px;
1.346 albertel 5088: }
5089:
1.934 droeschl 5090: .LC_menubuttons_inline_text img{
5091: vertical-align: middle;
5092: }
5093:
1.526 www 5094: .LC_menubuttons_link {
5095: text-decoration: none;
5096: }
1.795 www 5097:
1.522 albertel 5098: .LC_menubuttons_category {
1.521 www 5099: color: $font;
1.526 www 5100: background: $pgbg;
1.521 www 5101: font-size: larger;
5102: font-weight: bold;
5103: }
5104:
1.346 albertel 5105: td.LC_menubuttons_text {
1.911 bisitz 5106: color: $font;
1.346 albertel 5107: }
1.706 harmsja 5108:
1.346 albertel 5109: .LC_current_location {
5110: background: $tabbg;
5111: }
1.795 www 5112:
1.938 bisitz 5113: table.LC_data_table {
1.347 albertel 5114: border: 1px solid #000000;
1.402 albertel 5115: border-collapse: separate;
1.426 albertel 5116: border-spacing: 1px;
1.610 albertel 5117: background: $pgbg;
1.347 albertel 5118: }
1.795 www 5119:
1.422 albertel 5120: .LC_data_table_dense {
5121: font-size: small;
5122: }
1.795 www 5123:
1.507 raeburn 5124: table.LC_nested_outer {
5125: border: 1px solid #000000;
1.589 raeburn 5126: border-collapse: collapse;
1.803 bisitz 5127: border-spacing: 0;
1.507 raeburn 5128: width: 100%;
5129: }
1.795 www 5130:
1.879 raeburn 5131: table.LC_innerpickbox,
1.507 raeburn 5132: table.LC_nested {
1.803 bisitz 5133: border: none;
1.589 raeburn 5134: border-collapse: collapse;
1.803 bisitz 5135: border-spacing: 0;
1.507 raeburn 5136: width: 100%;
5137: }
1.795 www 5138:
1.930 faziophi 5139: .ui-accordion,
5140: .ui-accordion table.LC_data_table,
5141: .ui-accordion table.LC_nested_outer{
5142: border: 0px;
5143: border-spacing: 0px;
5144: margin: 3px;
5145: }
5146:
1.911 bisitz 5147: table.LC_data_table tr th,
5148: table.LC_calendar tr th,
1.879 raeburn 5149: table.LC_prior_tries tr th,
5150: table.LC_innerpickbox tr th {
1.349 albertel 5151: font-weight: bold;
5152: background-color: $data_table_head;
1.801 tempelho 5153: color:$fontmenu;
1.701 harmsja 5154: font-size:90%;
1.347 albertel 5155: }
1.795 www 5156:
1.879 raeburn 5157: table.LC_innerpickbox tr th,
5158: table.LC_innerpickbox tr td {
5159: vertical-align: top;
5160: }
5161:
1.711 raeburn 5162: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 5163: background-color: #CCCCCC;
1.711 raeburn 5164: font-weight: bold;
5165: text-align: left;
5166: }
1.795 www 5167:
1.912 bisitz 5168: table.LC_data_table tr.LC_odd_row > td {
5169: background-color: $data_table_light;
5170: padding: 2px;
5171: vertical-align: top;
5172: }
5173:
1.809 bisitz 5174: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 5175: background-color: $data_table_light;
1.912 bisitz 5176: vertical-align: top;
5177: }
5178:
5179: table.LC_data_table tr.LC_even_row > td {
5180: background-color: $data_table_dark;
1.425 albertel 5181: padding: 2px;
1.900 bisitz 5182: vertical-align: top;
1.347 albertel 5183: }
1.795 www 5184:
1.809 bisitz 5185: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 5186: background-color: $data_table_dark;
1.900 bisitz 5187: vertical-align: top;
1.347 albertel 5188: }
1.795 www 5189:
1.425 albertel 5190: table.LC_data_table tr.LC_data_table_highlight td {
5191: background-color: $data_table_darker;
5192: }
1.795 www 5193:
1.639 raeburn 5194: table.LC_data_table tr td.LC_leftcol_header {
5195: background-color: $data_table_head;
5196: font-weight: bold;
5197: }
1.795 www 5198:
1.451 albertel 5199: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 5200: table.LC_nested tr.LC_empty_row td {
1.421 albertel 5201: font-weight: bold;
5202: font-style: italic;
5203: text-align: center;
5204: padding: 8px;
1.347 albertel 5205: }
1.795 www 5206:
1.940 bisitz 5207: table.LC_data_table tr.LC_empty_row td {
5208: background-color: $sidebg;
5209: }
5210:
5211: table.LC_nested tr.LC_empty_row td {
5212: background-color: #FFFFFF;
5213: }
5214:
1.890 droeschl 5215: table.LC_caption {
5216: }
5217:
1.507 raeburn 5218: table.LC_nested tr.LC_empty_row td {
1.465 albertel 5219: padding: 4ex
5220: }
1.795 www 5221:
1.507 raeburn 5222: table.LC_nested_outer tr th {
5223: font-weight: bold;
1.801 tempelho 5224: color:$fontmenu;
1.507 raeburn 5225: background-color: $data_table_head;
1.701 harmsja 5226: font-size: small;
1.507 raeburn 5227: border-bottom: 1px solid #000000;
5228: }
1.795 www 5229:
1.507 raeburn 5230: table.LC_nested_outer tr td.LC_subheader {
5231: background-color: $data_table_head;
5232: font-weight: bold;
5233: font-size: small;
5234: border-bottom: 1px solid #000000;
5235: text-align: right;
1.451 albertel 5236: }
1.795 www 5237:
1.507 raeburn 5238: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5239: background-color: #CCCCCC;
1.451 albertel 5240: font-weight: bold;
5241: font-size: small;
1.507 raeburn 5242: text-align: center;
5243: }
1.795 www 5244:
1.589 raeburn 5245: table.LC_nested tr.LC_info_row td.LC_left_item,
5246: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5247: text-align: left;
1.451 albertel 5248: }
1.795 www 5249:
1.507 raeburn 5250: table.LC_nested td {
1.735 bisitz 5251: background-color: #FFFFFF;
1.451 albertel 5252: font-size: small;
1.507 raeburn 5253: }
1.795 www 5254:
1.507 raeburn 5255: table.LC_nested_outer tr th.LC_right_item,
5256: table.LC_nested tr.LC_info_row td.LC_right_item,
5257: table.LC_nested tr.LC_odd_row td.LC_right_item,
5258: table.LC_nested tr td.LC_right_item {
1.451 albertel 5259: text-align: right;
5260: }
5261:
1.930 faziophi 5262: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
5263: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
5264: text-align: right;
5265: width: 40%;
5266: padding-right:10px;
5267: vertical-align: top;
5268: padding: 5px;
5269: }
5270:
5271: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
5272: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
5273: text-align: left;
5274: width: 60%;
5275: padding: 2px 4px;
5276: }
5277:
1.507 raeburn 5278: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5279: background-color: #EEEEEE;
1.451 albertel 5280: }
5281:
1.473 raeburn 5282: table.LC_createuser {
5283: }
5284:
5285: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5286: font-size: small;
1.473 raeburn 5287: }
5288:
5289: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5290: background-color: #CCCCCC;
1.473 raeburn 5291: font-weight: bold;
5292: text-align: center;
5293: }
5294:
1.349 albertel 5295: table.LC_calendar {
5296: border: 1px solid #000000;
5297: border-collapse: collapse;
1.917 raeburn 5298: width: 98%;
1.349 albertel 5299: }
1.795 www 5300:
1.349 albertel 5301: table.LC_calendar_pickdate {
5302: font-size: xx-small;
5303: }
1.795 www 5304:
1.349 albertel 5305: table.LC_calendar tr td {
5306: border: 1px solid #000000;
5307: vertical-align: top;
1.917 raeburn 5308: width: 14%;
1.349 albertel 5309: }
1.795 www 5310:
1.349 albertel 5311: table.LC_calendar tr td.LC_calendar_day_empty {
5312: background-color: $data_table_dark;
5313: }
1.795 www 5314:
1.779 bisitz 5315: table.LC_calendar tr td.LC_calendar_day_current {
5316: background-color: $data_table_highlight;
1.777 tempelho 5317: }
1.795 www 5318:
1.938 bisitz 5319: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 5320: background-color: $mail_new;
5321: }
1.795 www 5322:
1.938 bisitz 5323: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 5324: background-color: $mail_new_hover;
5325: }
1.795 www 5326:
1.938 bisitz 5327: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 5328: background-color: $mail_read;
5329: }
1.795 www 5330:
1.938 bisitz 5331: /*
5332: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 5333: background-color: $mail_read_hover;
5334: }
1.938 bisitz 5335: */
1.795 www 5336:
1.938 bisitz 5337: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 5338: background-color: $mail_replied;
5339: }
1.795 www 5340:
1.938 bisitz 5341: /*
5342: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 5343: background-color: $mail_replied_hover;
5344: }
1.938 bisitz 5345: */
1.795 www 5346:
1.938 bisitz 5347: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 5348: background-color: $mail_other;
5349: }
1.795 www 5350:
1.938 bisitz 5351: /*
5352: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 5353: background-color: $mail_other_hover;
5354: }
1.938 bisitz 5355: */
1.494 raeburn 5356:
1.777 tempelho 5357: table.LC_data_table tr > td.LC_browser_file,
5358: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 5359: background: #AAEE77;
1.389 albertel 5360: }
1.795 www 5361:
1.777 tempelho 5362: table.LC_data_table tr > td.LC_browser_file_locked,
5363: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5364: background: #FFAA99;
1.387 albertel 5365: }
1.795 www 5366:
1.777 tempelho 5367: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 5368: background: #888888;
1.779 bisitz 5369: }
1.795 www 5370:
1.777 tempelho 5371: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5372: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 5373: background: #F8F866;
1.777 tempelho 5374: }
1.795 www 5375:
1.696 bisitz 5376: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 5377: background: #E0E8FF;
1.387 albertel 5378: }
1.696 bisitz 5379:
1.707 bisitz 5380: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 5381: /* background: #77FF77; */
1.707 bisitz 5382: }
1.795 www 5383:
1.707 bisitz 5384: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 5385: border-right: 8px solid #FFFF77;
1.707 bisitz 5386: }
1.795 www 5387:
1.707 bisitz 5388: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 5389: border-right: 8px solid #FFAA77;
1.707 bisitz 5390: }
1.795 www 5391:
1.707 bisitz 5392: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 5393: border-right: 8px solid #FF7777;
1.707 bisitz 5394: }
1.795 www 5395:
1.707 bisitz 5396: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 5397: border-right: 8px solid #AAFF77;
1.707 bisitz 5398: }
1.795 www 5399:
1.707 bisitz 5400: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 5401: border-right: 8px solid #11CC55;
1.707 bisitz 5402: }
5403:
1.388 albertel 5404: span.LC_current_location {
1.701 harmsja 5405: font-size:larger;
1.388 albertel 5406: background: $pgbg;
5407: }
1.387 albertel 5408:
1.395 albertel 5409: span.LC_parm_menu_item {
5410: font-size: larger;
5411: }
1.795 www 5412:
1.395 albertel 5413: span.LC_parm_scope_all {
5414: color: red;
5415: }
1.795 www 5416:
1.395 albertel 5417: span.LC_parm_scope_folder {
5418: color: green;
5419: }
1.795 www 5420:
1.395 albertel 5421: span.LC_parm_scope_resource {
5422: color: orange;
5423: }
1.795 www 5424:
1.395 albertel 5425: span.LC_parm_part {
5426: color: blue;
5427: }
1.795 www 5428:
1.911 bisitz 5429: span.LC_parm_folder,
5430: span.LC_parm_symb {
1.395 albertel 5431: font-size: x-small;
5432: font-family: $mono;
5433: color: #AAAAAA;
5434: }
5435:
1.795 www 5436: td.LC_parm_overview_level_menu,
5437: td.LC_parm_overview_map_menu,
5438: td.LC_parm_overview_parm_selectors,
5439: td.LC_parm_overview_restrictions {
1.396 albertel 5440: border: 1px solid black;
5441: border-collapse: collapse;
5442: }
1.795 www 5443:
1.396 albertel 5444: table.LC_parm_overview_restrictions td {
5445: border-width: 1px 4px 1px 4px;
5446: border-style: solid;
5447: border-color: $pgbg;
5448: text-align: center;
5449: }
1.795 www 5450:
1.396 albertel 5451: table.LC_parm_overview_restrictions th {
5452: background: $tabbg;
5453: border-width: 1px 4px 1px 4px;
5454: border-style: solid;
5455: border-color: $pgbg;
5456: }
1.795 www 5457:
1.398 albertel 5458: table#LC_helpmenu {
1.803 bisitz 5459: border: none;
1.398 albertel 5460: height: 55px;
1.803 bisitz 5461: border-spacing: 0;
1.398 albertel 5462: }
5463:
5464: table#LC_helpmenu fieldset legend {
5465: font-size: larger;
5466: }
1.795 www 5467:
1.397 albertel 5468: table#LC_helpmenu_links {
5469: width: 100%;
5470: border: 1px solid black;
5471: background: $pgbg;
1.803 bisitz 5472: padding: 0;
1.397 albertel 5473: border-spacing: 1px;
5474: }
1.795 www 5475:
1.397 albertel 5476: table#LC_helpmenu_links tr td {
5477: padding: 1px;
5478: background: $tabbg;
1.399 albertel 5479: text-align: center;
5480: font-weight: bold;
1.397 albertel 5481: }
1.396 albertel 5482:
1.795 www 5483: table#LC_helpmenu_links a:link,
5484: table#LC_helpmenu_links a:visited,
1.397 albertel 5485: table#LC_helpmenu_links a:active {
5486: text-decoration: none;
5487: color: $font;
5488: }
1.795 www 5489:
1.397 albertel 5490: table#LC_helpmenu_links a:hover {
5491: text-decoration: underline;
5492: color: $vlink;
5493: }
1.396 albertel 5494:
1.417 albertel 5495: .LC_chrt_popup_exists {
5496: border: 1px solid #339933;
5497: margin: -1px;
5498: }
1.795 www 5499:
1.417 albertel 5500: .LC_chrt_popup_up {
5501: border: 1px solid yellow;
5502: margin: -1px;
5503: }
1.795 www 5504:
1.417 albertel 5505: .LC_chrt_popup {
5506: border: 1px solid #8888FF;
5507: background: #CCCCFF;
5508: }
1.795 www 5509:
1.421 albertel 5510: table.LC_pick_box {
5511: border-collapse: separate;
5512: background: white;
5513: border: 1px solid black;
5514: border-spacing: 1px;
5515: }
1.795 www 5516:
1.421 albertel 5517: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 5518: background: $sidebg;
1.421 albertel 5519: font-weight: bold;
1.900 bisitz 5520: text-align: left;
1.740 bisitz 5521: vertical-align: top;
1.421 albertel 5522: width: 184px;
5523: padding: 8px;
5524: }
1.795 www 5525:
1.579 raeburn 5526: table.LC_pick_box td.LC_pick_box_value {
5527: text-align: left;
5528: padding: 8px;
5529: }
1.795 www 5530:
1.579 raeburn 5531: table.LC_pick_box td.LC_pick_box_select {
5532: text-align: left;
5533: padding: 8px;
5534: }
1.795 www 5535:
1.424 albertel 5536: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5537: padding: 0;
1.421 albertel 5538: height: 1px;
5539: background: black;
5540: }
1.795 www 5541:
1.421 albertel 5542: table.LC_pick_box td.LC_pick_box_submit {
5543: text-align: right;
5544: }
1.795 www 5545:
1.579 raeburn 5546: table.LC_pick_box td.LC_evenrow_value {
5547: text-align: left;
5548: padding: 8px;
5549: background-color: $data_table_light;
5550: }
1.795 www 5551:
1.579 raeburn 5552: table.LC_pick_box td.LC_oddrow_value {
5553: text-align: left;
5554: padding: 8px;
5555: background-color: $data_table_light;
5556: }
1.795 www 5557:
1.579 raeburn 5558: span.LC_helpform_receipt_cat {
5559: font-weight: bold;
5560: }
1.795 www 5561:
1.424 albertel 5562: table.LC_group_priv_box {
5563: background: white;
5564: border: 1px solid black;
5565: border-spacing: 1px;
5566: }
1.795 www 5567:
1.424 albertel 5568: table.LC_group_priv_box td.LC_pick_box_title {
5569: background: $tabbg;
5570: font-weight: bold;
5571: text-align: right;
5572: width: 184px;
5573: }
1.795 www 5574:
1.424 albertel 5575: table.LC_group_priv_box td.LC_groups_fixed {
5576: background: $data_table_light;
5577: text-align: center;
5578: }
1.795 www 5579:
1.424 albertel 5580: table.LC_group_priv_box td.LC_groups_optional {
5581: background: $data_table_dark;
5582: text-align: center;
5583: }
1.795 www 5584:
1.424 albertel 5585: table.LC_group_priv_box td.LC_groups_functionality {
5586: background: $data_table_darker;
5587: text-align: center;
5588: font-weight: bold;
5589: }
1.795 www 5590:
1.424 albertel 5591: table.LC_group_priv td {
5592: text-align: left;
1.803 bisitz 5593: padding: 0;
1.424 albertel 5594: }
5595:
1.421 albertel 5596: table.LC_notify_front_page {
5597: background: white;
5598: border: 1px solid black;
5599: padding: 8px;
5600: }
1.795 www 5601:
1.421 albertel 5602: table.LC_notify_front_page td {
5603: padding: 8px;
5604: }
1.795 www 5605:
1.424 albertel 5606: .LC_navbuttons {
5607: margin: 2ex 0ex 2ex 0ex;
5608: }
1.795 www 5609:
1.423 albertel 5610: .LC_topic_bar {
5611: font-weight: bold;
5612: background: $tabbg;
1.918 wenzelju 5613: margin: 1em 0em 1em 2em;
1.805 bisitz 5614: padding: 3px;
1.918 wenzelju 5615: font-size: 1.2em;
1.423 albertel 5616: }
1.795 www 5617:
1.423 albertel 5618: .LC_topic_bar span {
1.918 wenzelju 5619: left: 0.5em;
5620: position: absolute;
1.423 albertel 5621: vertical-align: middle;
1.918 wenzelju 5622: font-size: 1.2em;
1.423 albertel 5623: }
1.795 www 5624:
1.423 albertel 5625: table.LC_course_group_status {
5626: margin: 20px;
5627: }
1.795 www 5628:
1.423 albertel 5629: table.LC_status_selector td {
5630: vertical-align: top;
5631: text-align: center;
1.424 albertel 5632: padding: 4px;
5633: }
1.795 www 5634:
1.599 albertel 5635: div.LC_feedback_link {
1.616 albertel 5636: clear: both;
1.829 kalberla 5637: background: $sidebg;
1.779 bisitz 5638: width: 100%;
1.829 kalberla 5639: padding-bottom: 10px;
5640: border: 1px $tabbg solid;
1.833 kalberla 5641: height: 22px;
5642: line-height: 22px;
5643: padding-top: 5px;
5644: }
5645:
5646: div.LC_feedback_link img {
5647: height: 22px;
1.867 kalberla 5648: vertical-align:middle;
1.829 kalberla 5649: }
5650:
1.911 bisitz 5651: div.LC_feedback_link a {
1.829 kalberla 5652: text-decoration: none;
1.489 raeburn 5653: }
1.795 www 5654:
1.867 kalberla 5655: div.LC_comblock {
1.911 bisitz 5656: display:inline;
1.867 kalberla 5657: color:$font;
5658: font-size:90%;
5659: }
5660:
5661: div.LC_feedback_link div.LC_comblock {
5662: padding-left:5px;
5663: }
5664:
5665: div.LC_feedback_link div.LC_comblock a {
5666: color:$font;
5667: }
5668:
1.489 raeburn 5669: span.LC_feedback_link {
1.858 bisitz 5670: /* background: $feedback_link_bg; */
1.599 albertel 5671: font-size: larger;
5672: }
1.795 www 5673:
1.599 albertel 5674: span.LC_message_link {
1.858 bisitz 5675: /* background: $feedback_link_bg; */
1.599 albertel 5676: font-size: larger;
5677: position: absolute;
5678: right: 1em;
1.489 raeburn 5679: }
1.421 albertel 5680:
1.515 albertel 5681: table.LC_prior_tries {
1.524 albertel 5682: border: 1px solid #000000;
5683: border-collapse: separate;
5684: border-spacing: 1px;
1.515 albertel 5685: }
1.523 albertel 5686:
1.515 albertel 5687: table.LC_prior_tries td {
1.524 albertel 5688: padding: 2px;
1.515 albertel 5689: }
1.523 albertel 5690:
5691: .LC_answer_correct {
1.795 www 5692: background: lightgreen;
5693: color: darkgreen;
5694: padding: 6px;
1.523 albertel 5695: }
1.795 www 5696:
1.523 albertel 5697: .LC_answer_charged_try {
1.797 www 5698: background: #FFAAAA;
1.795 www 5699: color: darkred;
5700: padding: 6px;
1.523 albertel 5701: }
1.795 www 5702:
1.779 bisitz 5703: .LC_answer_not_charged_try,
1.523 albertel 5704: .LC_answer_no_grade,
5705: .LC_answer_late {
1.795 www 5706: background: lightyellow;
1.523 albertel 5707: color: black;
1.795 www 5708: padding: 6px;
1.523 albertel 5709: }
1.795 www 5710:
1.523 albertel 5711: .LC_answer_previous {
1.795 www 5712: background: lightblue;
5713: color: darkblue;
5714: padding: 6px;
1.523 albertel 5715: }
1.795 www 5716:
1.779 bisitz 5717: .LC_answer_no_message {
1.777 tempelho 5718: background: #FFFFFF;
5719: color: black;
1.795 www 5720: padding: 6px;
1.779 bisitz 5721: }
1.795 www 5722:
1.779 bisitz 5723: .LC_answer_unknown {
5724: background: orange;
5725: color: black;
1.795 www 5726: padding: 6px;
1.777 tempelho 5727: }
1.795 www 5728:
1.529 albertel 5729: span.LC_prior_numerical,
5730: span.LC_prior_string,
5731: span.LC_prior_custom,
5732: span.LC_prior_reaction,
5733: span.LC_prior_math {
1.925 bisitz 5734: font-family: $mono;
1.523 albertel 5735: white-space: pre;
5736: }
5737:
1.525 albertel 5738: span.LC_prior_string {
1.925 bisitz 5739: font-family: $mono;
1.525 albertel 5740: white-space: pre;
5741: }
5742:
1.523 albertel 5743: table.LC_prior_option {
5744: width: 100%;
5745: border-collapse: collapse;
5746: }
1.795 www 5747:
1.911 bisitz 5748: table.LC_prior_rank,
1.795 www 5749: table.LC_prior_match {
1.528 albertel 5750: border-collapse: collapse;
5751: }
1.795 www 5752:
1.528 albertel 5753: table.LC_prior_option tr td,
5754: table.LC_prior_rank tr td,
5755: table.LC_prior_match tr td {
1.524 albertel 5756: border: 1px solid #000000;
1.515 albertel 5757: }
5758:
1.855 bisitz 5759: .LC_nobreak {
1.544 albertel 5760: white-space: nowrap;
1.519 raeburn 5761: }
5762:
1.576 raeburn 5763: span.LC_cusr_emph {
5764: font-style: italic;
5765: }
5766:
1.633 raeburn 5767: span.LC_cusr_subheading {
5768: font-weight: normal;
5769: font-size: 85%;
5770: }
5771:
1.861 bisitz 5772: div.LC_docs_entry_move {
1.859 bisitz 5773: border: 1px solid #BBBBBB;
1.545 albertel 5774: background: #DDDDDD;
1.861 bisitz 5775: width: 22px;
1.859 bisitz 5776: padding: 1px;
5777: margin: 0;
1.545 albertel 5778: }
5779:
1.861 bisitz 5780: table.LC_data_table tr > td.LC_docs_entry_commands,
5781: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 5782: background: #DDDDDD;
5783: font-size: x-small;
5784: }
1.795 www 5785:
1.861 bisitz 5786: .LC_docs_entry_parameter {
5787: white-space: nowrap;
5788: }
5789:
1.544 albertel 5790: .LC_docs_copy {
1.545 albertel 5791: color: #000099;
1.544 albertel 5792: }
1.795 www 5793:
1.544 albertel 5794: .LC_docs_cut {
1.545 albertel 5795: color: #550044;
1.544 albertel 5796: }
1.795 www 5797:
1.544 albertel 5798: .LC_docs_rename {
1.545 albertel 5799: color: #009900;
1.544 albertel 5800: }
1.795 www 5801:
1.544 albertel 5802: .LC_docs_remove {
1.545 albertel 5803: color: #990000;
5804: }
5805:
1.547 albertel 5806: .LC_docs_reinit_warn,
5807: .LC_docs_ext_edit {
5808: font-size: x-small;
5809: }
5810:
1.545 albertel 5811: table.LC_docs_adddocs td,
5812: table.LC_docs_adddocs th {
5813: border: 1px solid #BBBBBB;
5814: padding: 4px;
5815: background: #DDDDDD;
1.543 albertel 5816: }
5817:
1.584 albertel 5818: table.LC_sty_begin {
5819: background: #BBFFBB;
5820: }
1.795 www 5821:
1.584 albertel 5822: table.LC_sty_end {
5823: background: #FFBBBB;
5824: }
5825:
1.589 raeburn 5826: table.LC_double_column {
1.803 bisitz 5827: border-width: 0;
1.589 raeburn 5828: border-collapse: collapse;
5829: width: 100%;
5830: padding: 2px;
5831: }
5832:
5833: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5834: top: 2px;
1.589 raeburn 5835: left: 2px;
5836: width: 47%;
5837: vertical-align: top;
5838: }
5839:
5840: table.LC_double_column tr td.LC_right_col {
5841: top: 2px;
1.779 bisitz 5842: right: 2px;
1.589 raeburn 5843: width: 47%;
5844: vertical-align: top;
5845: }
5846:
1.591 raeburn 5847: div.LC_left_float {
5848: float: left;
5849: padding-right: 5%;
1.597 albertel 5850: padding-bottom: 4px;
1.591 raeburn 5851: }
5852:
5853: div.LC_clear_float_header {
1.597 albertel 5854: padding-bottom: 2px;
1.591 raeburn 5855: }
5856:
5857: div.LC_clear_float_footer {
1.597 albertel 5858: padding-top: 10px;
1.591 raeburn 5859: clear: both;
5860: }
5861:
1.597 albertel 5862: div.LC_grade_show_user {
1.941 bisitz 5863: /* border-left: 5px solid $sidebg; */
5864: border-top: 5px solid #000000;
5865: margin: 50px 0 0 0;
1.936 bisitz 5866: padding: 15px 0 5px 10px;
1.597 albertel 5867: }
1.795 www 5868:
1.936 bisitz 5869: div.LC_grade_show_user_odd_row {
1.941 bisitz 5870: /* border-left: 5px solid #000000; */
5871: }
5872:
5873: div.LC_grade_show_user div.LC_Box {
5874: margin-right: 50px;
1.597 albertel 5875: }
5876:
5877: div.LC_grade_submissions,
5878: div.LC_grade_message_center,
1.936 bisitz 5879: div.LC_grade_info_links {
1.597 albertel 5880: margin: 5px;
5881: width: 99%;
5882: background: #FFFFFF;
5883: }
1.795 www 5884:
1.597 albertel 5885: div.LC_grade_submissions_header,
1.936 bisitz 5886: div.LC_grade_message_center_header {
1.705 tempelho 5887: font-weight: bold;
5888: font-size: large;
1.597 albertel 5889: }
1.795 www 5890:
1.597 albertel 5891: div.LC_grade_submissions_body,
1.936 bisitz 5892: div.LC_grade_message_center_body {
1.597 albertel 5893: border: 1px solid black;
5894: width: 99%;
5895: background: #FFFFFF;
5896: }
1.795 www 5897:
1.613 albertel 5898: table.LC_scantron_action {
5899: width: 100%;
5900: }
1.795 www 5901:
1.613 albertel 5902: table.LC_scantron_action tr th {
1.698 harmsja 5903: font-weight:bold;
5904: font-style:normal;
1.613 albertel 5905: }
1.795 www 5906:
1.779 bisitz 5907: .LC_edit_problem_header,
1.614 albertel 5908: div.LC_edit_problem_footer {
1.705 tempelho 5909: font-weight: normal;
5910: font-size: medium;
1.602 albertel 5911: margin: 2px;
1.600 albertel 5912: }
1.795 www 5913:
1.600 albertel 5914: div.LC_edit_problem_header,
1.602 albertel 5915: div.LC_edit_problem_header div,
1.614 albertel 5916: div.LC_edit_problem_footer,
5917: div.LC_edit_problem_footer div,
1.602 albertel 5918: div.LC_edit_problem_editxml_header,
5919: div.LC_edit_problem_editxml_header div {
1.600 albertel 5920: margin-top: 5px;
5921: }
1.795 www 5922:
1.600 albertel 5923: div.LC_edit_problem_header_title {
1.705 tempelho 5924: font-weight: bold;
5925: font-size: larger;
1.602 albertel 5926: background: $tabbg;
5927: padding: 3px;
5928: }
1.795 www 5929:
1.602 albertel 5930: table.LC_edit_problem_header_title {
5931: width: 100%;
1.600 albertel 5932: background: $tabbg;
1.602 albertel 5933: }
5934:
5935: div.LC_edit_problem_discards {
5936: float: left;
5937: padding-bottom: 5px;
5938: }
1.795 www 5939:
1.602 albertel 5940: div.LC_edit_problem_saves {
5941: float: right;
5942: padding-bottom: 5px;
1.600 albertel 5943: }
1.795 www 5944:
1.911 bisitz 5945: img.stift {
1.803 bisitz 5946: border-width: 0;
5947: vertical-align: middle;
1.677 riegler 5948: }
1.680 riegler 5949:
1.923 bisitz 5950: table td.LC_mainmenu_col_fieldset {
1.680 riegler 5951: vertical-align: top;
1.777 tempelho 5952: }
1.795 www 5953:
1.716 raeburn 5954: div.LC_createcourse {
1.911 bisitz 5955: margin: 10px 10px 10px 10px;
1.716 raeburn 5956: }
5957:
1.917 raeburn 5958: .LC_dccid {
5959: margin: 0.2em 0 0 0;
5960: padding: 0;
5961: font-size: 90%;
5962: display:none;
5963: }
5964:
1.698 harmsja 5965: a:hover,
1.897 wenzelju 5966: ol.LC_primary_menu a:hover,
1.721 harmsja 5967: ol#LC_MenuBreadcrumbs a:hover,
5968: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 5969: ul#LC_secondary_menu a:hover,
1.721 harmsja 5970: .LC_FormSectionClearButton input:hover
1.795 www 5971: ul.LC_TabContent li:hover a {
1.911 bisitz 5972: color:#BF2317;
5973: text-decoration:none;
1.693 droeschl 5974: }
5975:
1.779 bisitz 5976: h1 {
1.911 bisitz 5977: padding: 0;
5978: line-height:130%;
1.693 droeschl 5979: }
1.698 harmsja 5980:
1.911 bisitz 5981: h2,
5982: h3,
5983: h4,
5984: h5,
5985: h6 {
5986: margin: 5px 0 5px 0;
5987: padding: 0;
5988: line-height:130%;
1.693 droeschl 5989: }
1.795 www 5990:
5991: .LC_hcell {
1.911 bisitz 5992: padding:3px 15px 3px 15px;
5993: margin: 0;
5994: background-color:$tabbg;
5995: color:$fontmenu;
5996: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5997: }
1.795 www 5998:
1.840 bisitz 5999: .LC_Box > .LC_hcell {
1.911 bisitz 6000: margin: 0 -10px 10px -10px;
1.835 bisitz 6001: }
6002:
1.721 harmsja 6003: .LC_noBorder {
1.911 bisitz 6004: border: 0;
1.698 harmsja 6005: }
1.693 droeschl 6006:
1.721 harmsja 6007: .LC_FormSectionClearButton input {
1.911 bisitz 6008: background-color:transparent;
6009: border: none;
6010: cursor:pointer;
6011: text-decoration:underline;
1.693 droeschl 6012: }
1.763 bisitz 6013:
6014: .LC_help_open_topic {
1.911 bisitz 6015: color: #FFFFFF;
6016: background-color: #EEEEFF;
6017: margin: 1px;
6018: padding: 4px;
6019: border: 1px solid #000033;
6020: white-space: nowrap;
6021: /* vertical-align: middle; */
1.759 neumanie 6022: }
1.693 droeschl 6023:
1.911 bisitz 6024: dl,
6025: ul,
6026: div,
6027: fieldset {
6028: margin: 10px 10px 10px 0;
6029: /* overflow: hidden; */
1.693 droeschl 6030: }
1.795 www 6031:
1.838 bisitz 6032: fieldset > legend {
1.911 bisitz 6033: font-weight: bold;
6034: padding: 0 5px 0 5px;
1.838 bisitz 6035: }
6036:
1.813 bisitz 6037: #LC_nav_bar {
1.911 bisitz 6038: float: left;
1.934 droeschl 6039: margin: 0;
1.807 droeschl 6040: }
6041:
1.916 droeschl 6042: #LC_realm {
6043: margin: 0.2em 0 0 0;
6044: padding: 0;
6045: font-weight: bold;
6046: text-align: center;
6047: }
6048:
1.911 bisitz 6049: #LC_nav_bar em {
6050: font-weight: bold;
6051: font-style: normal;
1.807 droeschl 6052: }
6053:
1.897 wenzelju 6054: ol.LC_primary_menu {
1.911 bisitz 6055: float: right;
1.934 droeschl 6056: margin: 0;
1.807 droeschl 6057: }
6058:
1.929 wenzelju 6059: span.LC_new_message{
6060: font-weight:bold;
6061: color: darkred;
6062: }
6063:
1.852 droeschl 6064: ol#LC_PathBreadcrumbs {
1.911 bisitz 6065: margin: 0;
1.693 droeschl 6066: }
6067:
1.897 wenzelju 6068: ol.LC_primary_menu li {
1.911 bisitz 6069: display: inline;
6070: padding: 5px 5px 0 10px;
6071: vertical-align: top;
1.693 droeschl 6072: }
6073:
1.897 wenzelju 6074: ol.LC_primary_menu li img {
1.911 bisitz 6075: vertical-align: bottom;
1.934 droeschl 6076: height: 1.1em;
1.693 droeschl 6077: }
6078:
1.897 wenzelju 6079: ol.LC_primary_menu a {
1.911 bisitz 6080: color: RGB(80, 80, 80);
6081: text-decoration: none;
1.693 droeschl 6082: }
1.795 www 6083:
1.897 wenzelju 6084: ul#LC_secondary_menu {
1.911 bisitz 6085: clear: both;
6086: color: $fontmenu;
6087: background: $tabbg;
6088: list-style: none;
6089: padding: 0;
6090: margin: 0;
6091: width: 100%;
1.808 droeschl 6092: }
6093:
1.897 wenzelju 6094: ul#LC_secondary_menu li {
1.911 bisitz 6095: font-weight: bold;
6096: line-height: 1.8em;
6097: padding: 0 0.8em;
6098: border-right: 1px solid black;
6099: display: inline;
6100: vertical-align: middle;
1.807 droeschl 6101: }
6102:
1.847 tempelho 6103: ul.LC_TabContent {
1.911 bisitz 6104: display:block;
6105: background: $sidebg;
6106: border-bottom: solid 1px $lg_border_color;
6107: list-style:none;
6108: margin: 0 -10px;
6109: padding: 0;
1.693 droeschl 6110: }
6111:
1.795 www 6112: ul.LC_TabContent li,
6113: ul.LC_TabContentBigger li {
1.911 bisitz 6114: float:left;
1.741 harmsja 6115: }
1.795 www 6116:
1.897 wenzelju 6117: ul#LC_secondary_menu li a {
1.911 bisitz 6118: color: $fontmenu;
6119: text-decoration: none;
1.693 droeschl 6120: }
1.795 www 6121:
1.721 harmsja 6122: ul.LC_TabContent {
1.911 bisitz 6123: min-height:1.5em;
1.721 harmsja 6124: }
1.795 www 6125:
6126: ul.LC_TabContent li {
1.911 bisitz 6127: vertical-align:middle;
6128: padding: 0 10px 0 10px;
6129: background-color:$tabbg;
6130: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 6131: }
1.795 www 6132:
1.847 tempelho 6133: ul.LC_TabContent .right {
1.911 bisitz 6134: float:right;
1.847 tempelho 6135: }
6136:
1.911 bisitz 6137: ul.LC_TabContent li a,
6138: ul.LC_TabContent li {
6139: color:rgb(47,47,47);
6140: text-decoration:none;
6141: font-size:95%;
6142: font-weight:bold;
6143: padding-right: 16px;
1.721 harmsja 6144: }
1.795 www 6145:
1.911 bisitz 6146: ul.LC_TabContent li:hover,
6147: ul.LC_TabContent li.active {
6148: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6149: border-bottom:solid 2px #FFFFFF;
6150: padding-right: 16px;
1.744 ehlerst 6151: }
1.795 www 6152:
1.870 tempelho 6153: #maincoursedoc {
1.911 bisitz 6154: clear:both;
1.870 tempelho 6155: }
6156:
6157: ul.LC_TabContentBigger {
1.911 bisitz 6158: display:block;
6159: list-style:none;
6160: padding: 0;
1.870 tempelho 6161: }
6162:
1.795 www 6163: ul.LC_TabContentBigger li {
1.911 bisitz 6164: vertical-align:bottom;
6165: height: 30px;
6166: font-size:110%;
6167: font-weight:bold;
6168: color: #737373;
1.841 tempelho 6169: }
6170:
1.870 tempelho 6171:
6172: ul.LC_TabContentBigger li a {
1.911 bisitz 6173: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6174: height: 30px;
6175: line-height: 30px;
6176: text-align: center;
6177: display: block;
6178: text-decoration: none;
1.741 harmsja 6179: }
1.795 www 6180:
1.911 bisitz 6181: ul.LC_TabContentBigger li:hover a,
1.870 tempelho 6182: ul.LC_TabContentBigger li.active a {
1.911 bisitz 6183: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6184: color:$font;
6185: text-decoration: underline;
1.744 ehlerst 6186: }
1.795 www 6187:
1.870 tempelho 6188:
6189: ul.LC_TabContentBigger li b {
1.911 bisitz 6190: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6191: display: block;
6192: float: left;
6193: padding: 0 30px;
1.870 tempelho 6194: }
6195:
6196: ul.LC_TabContentBigger li:hover b,
6197: ul.LC_TabContentBigger li.active b {
1.911 bisitz 6198: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6199: color:$font;
6200: border-bottom: 1px solid #FFFFFF;
1.741 harmsja 6201: }
1.693 droeschl 6202:
1.870 tempelho 6203:
1.862 bisitz 6204: ul.LC_CourseBreadcrumbs {
6205: background: $sidebg;
6206: line-height: 32px;
6207: padding-left: 10px;
6208: margin: 0 0 10px 0;
6209: list-style-position: inside;
6210:
6211: }
6212:
1.911 bisitz 6213: ol#LC_MenuBreadcrumbs,
1.862 bisitz 6214: ol#LC_PathBreadcrumbs {
1.911 bisitz 6215: padding-left: 10px;
6216: margin: 0;
1.933 droeschl 6217: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 6218: }
6219:
1.911 bisitz 6220: ol#LC_MenuBreadcrumbs li,
6221: ol#LC_PathBreadcrumbs li,
1.862 bisitz 6222: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 6223: display: inline;
1.933 droeschl 6224: white-space: normal;
1.693 droeschl 6225: }
6226:
1.823 bisitz 6227: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 6228: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 6229: text-decoration: none;
6230: font-size:90%;
1.693 droeschl 6231: }
1.795 www 6232:
6233: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 6234: text-decoration:none;
6235: font-size:100%;
6236: font-weight:bold;
1.693 droeschl 6237: }
1.795 www 6238:
1.840 bisitz 6239: .LC_Box {
1.911 bisitz 6240: border: solid 1px $lg_border_color;
6241: padding: 0 10px 10px 10px;
1.746 neumanie 6242: }
1.795 www 6243:
6244: .LC_AboutMe_Image {
1.911 bisitz 6245: float:left;
6246: margin-right:10px;
1.747 neumanie 6247: }
1.795 www 6248:
6249: .LC_Clear_AboutMe_Image {
1.911 bisitz 6250: clear:left;
1.747 neumanie 6251: }
1.795 www 6252:
1.721 harmsja 6253: dl.LC_ListStyleClean dt {
1.911 bisitz 6254: padding-right: 5px;
6255: display: table-header-group;
1.693 droeschl 6256: }
6257:
1.721 harmsja 6258: dl.LC_ListStyleClean dd {
1.911 bisitz 6259: display: table-row;
1.693 droeschl 6260: }
6261:
1.721 harmsja 6262: .LC_ListStyleClean,
6263: .LC_ListStyleSimple,
6264: .LC_ListStyleNormal,
1.795 www 6265: .LC_ListStyleSpecial {
1.911 bisitz 6266: /* display:block; */
6267: list-style-position: inside;
6268: list-style-type: none;
6269: overflow: hidden;
6270: padding: 0;
1.693 droeschl 6271: }
6272:
1.721 harmsja 6273: .LC_ListStyleSimple li,
6274: .LC_ListStyleSimple dd,
6275: .LC_ListStyleNormal li,
6276: .LC_ListStyleNormal dd,
6277: .LC_ListStyleSpecial li,
1.795 www 6278: .LC_ListStyleSpecial dd {
1.911 bisitz 6279: margin: 0;
6280: padding: 5px 5px 5px 10px;
6281: clear: both;
1.693 droeschl 6282: }
6283:
1.721 harmsja 6284: .LC_ListStyleClean li,
6285: .LC_ListStyleClean dd {
1.911 bisitz 6286: padding-top: 0;
6287: padding-bottom: 0;
1.693 droeschl 6288: }
6289:
1.721 harmsja 6290: .LC_ListStyleSimple dd,
1.795 www 6291: .LC_ListStyleSimple li {
1.911 bisitz 6292: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6293: }
6294:
1.721 harmsja 6295: .LC_ListStyleSpecial li,
6296: .LC_ListStyleSpecial dd {
1.911 bisitz 6297: list-style-type: none;
6298: background-color: RGB(220, 220, 220);
6299: margin-bottom: 4px;
1.693 droeschl 6300: }
6301:
1.721 harmsja 6302: table.LC_SimpleTable {
1.911 bisitz 6303: margin:5px;
6304: border:solid 1px $lg_border_color;
1.795 www 6305: }
1.693 droeschl 6306:
1.721 harmsja 6307: table.LC_SimpleTable tr {
1.911 bisitz 6308: padding: 0;
6309: border:solid 1px $lg_border_color;
1.693 droeschl 6310: }
1.795 www 6311:
6312: table.LC_SimpleTable thead {
1.911 bisitz 6313: background:rgb(220,220,220);
1.693 droeschl 6314: }
6315:
1.721 harmsja 6316: div.LC_columnSection {
1.911 bisitz 6317: display: block;
6318: clear: both;
6319: overflow: hidden;
6320: margin: 0;
1.693 droeschl 6321: }
6322:
1.721 harmsja 6323: div.LC_columnSection>* {
1.911 bisitz 6324: float: left;
6325: margin: 10px 20px 10px 0;
6326: overflow:hidden;
1.693 droeschl 6327: }
1.721 harmsja 6328:
1.694 tempelho 6329: .LC_loginpage_container {
1.911 bisitz 6330: text-align:left;
6331: margin : 0 auto;
6332: width:90%;
6333: padding: 10px;
6334: height: auto;
6335: background-color:#FFFFFF;
6336: border:1px solid #CCCCCC;
1.694 tempelho 6337: }
6338:
6339:
6340: .LC_loginpage_loginContainer {
1.911 bisitz 6341: float:left;
6342: width: 182px;
6343: padding: 2px;
6344: border:1px solid #CCCCCC;
6345: background-color:$loginbg;
1.694 tempelho 6346: }
6347:
1.795 www 6348: .LC_loginpage_loginContainer h2 {
1.911 bisitz 6349: margin-top: 0;
6350: display:block;
6351: background:$bgcol;
6352: color:$textcol;
6353: padding-left:5px;
1.712 muellerd 6354: }
1.785 tempelho 6355:
1.694 tempelho 6356: .LC_loginpage_loginInfo {
1.911 bisitz 6357: float:left;
6358: width:182px;
6359: border:1px solid #CCCCCC;
6360: padding:2px;
1.712 muellerd 6361: }
6362:
1.694 tempelho 6363: .LC_loginpage_space {
1.911 bisitz 6364: clear: both;
6365: margin-bottom: 20px;
6366: border-bottom: 1px solid #CCCCCC;
1.694 tempelho 6367: }
6368:
1.785 tempelho 6369: .LC_loginpage_floatLeft {
1.911 bisitz 6370: float: left;
6371: width: 200px;
6372: margin: 0;
1.785 tempelho 6373: }
6374:
1.795 www 6375: table em {
1.911 bisitz 6376: font-weight: bold;
6377: font-style: normal;
1.748 schulted 6378: }
1.795 www 6379:
1.779 bisitz 6380: table.LC_tableBrowseRes,
1.795 www 6381: table.LC_tableOfContent {
1.911 bisitz 6382: border:none;
6383: border-spacing: 1px;
6384: padding: 3px;
6385: background-color: #FFFFFF;
6386: font-size: 90%;
1.753 droeschl 6387: }
1.789 droeschl 6388:
1.911 bisitz 6389: table.LC_tableOfContent {
6390: border-collapse: collapse;
1.789 droeschl 6391: }
6392:
1.771 droeschl 6393: table.LC_tableBrowseRes a,
1.768 schulted 6394: table.LC_tableOfContent a {
1.911 bisitz 6395: background-color: transparent;
6396: text-decoration: none;
1.753 droeschl 6397: }
6398:
1.795 www 6399: table.LC_tableOfContent img {
1.911 bisitz 6400: border: none;
6401: height: 1.3em;
6402: vertical-align: text-bottom;
6403: margin-right: 0.3em;
1.753 droeschl 6404: }
1.757 schulted 6405:
1.795 www 6406: a#LC_content_toolbar_firsthomework {
1.911 bisitz 6407: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 6408: }
6409:
1.795 www 6410: a#LC_content_toolbar_launchnav {
1.911 bisitz 6411: background-image:url(/res/adm/pages/start-navigation.gif);
1.774 ehlerst 6412: }
6413:
1.795 www 6414: a#LC_content_toolbar_closenav {
1.911 bisitz 6415: background-image:url(/res/adm/pages/close-navigation.gif);
1.774 ehlerst 6416: }
6417:
1.795 www 6418: a#LC_content_toolbar_everything {
1.911 bisitz 6419: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 6420: }
6421:
1.795 www 6422: a#LC_content_toolbar_uncompleted {
1.911 bisitz 6423: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 6424: }
6425:
1.795 www 6426: #LC_content_toolbar_clearbubbles {
1.911 bisitz 6427: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 6428: }
6429:
1.795 www 6430: a#LC_content_toolbar_changefolder {
1.911 bisitz 6431: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 6432: }
6433:
1.795 www 6434: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 6435: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 6436: }
6437:
1.795 www 6438: ul#LC_toolbar li a:hover {
1.911 bisitz 6439: background-position: bottom center;
1.757 schulted 6440: }
6441:
1.795 www 6442: ul#LC_toolbar {
1.911 bisitz 6443: padding: 0;
6444: margin: 2px;
6445: list-style:none;
6446: position:relative;
6447: background-color:white;
1.757 schulted 6448: }
6449:
1.795 www 6450: ul#LC_toolbar li {
1.911 bisitz 6451: border:1px solid white;
6452: padding: 0;
6453: margin: 0;
6454: float: left;
6455: display:inline;
6456: vertical-align:middle;
6457: }
1.757 schulted 6458:
1.783 amueller 6459:
1.795 www 6460: a.LC_toolbarItem {
1.911 bisitz 6461: display:block;
6462: padding: 0;
6463: margin: 0;
6464: height: 32px;
6465: width: 32px;
6466: color:white;
6467: border: none;
6468: background-repeat:no-repeat;
6469: background-color:transparent;
1.757 schulted 6470: }
6471:
1.915 droeschl 6472: ul.LC_funclist {
6473: margin: 0;
6474: padding: 0.5em 1em 0.5em 0;
6475: }
6476:
1.933 droeschl 6477: ul.LC_funclist > li:first-child {
6478: font-weight:bold;
6479: margin-left:0.8em;
6480: }
6481:
1.915 droeschl 6482: ul.LC_funclist + ul.LC_funclist {
6483: /*
6484: left border as a seperator if we have more than
6485: one list
6486: */
6487: border-left: 1px solid $sidebg;
6488: /*
6489: this hides the left border behind the border of the
6490: outer box if element is wrapped to the next 'line'
6491: */
6492: margin-left: -1px;
6493: }
6494:
1.843 bisitz 6495: ul.LC_funclist li {
1.915 droeschl 6496: display: inline;
1.782 bisitz 6497: white-space: nowrap;
1.915 droeschl 6498: margin: 0 0 0 25px;
6499: line-height: 150%;
1.782 bisitz 6500: }
6501:
1.930 faziophi 6502: .ui-accordion .LC_advanced_toggle {
6503: float: right;
6504: font-size: 90%;
6505: padding: 0px 4px
6506: }
1.757 schulted 6507:
1.343 albertel 6508: END
6509: }
6510:
1.306 albertel 6511: =pod
6512:
6513: =item * &headtag()
6514:
6515: Returns a uniform footer for LON-CAPA web pages.
6516:
1.307 albertel 6517: Inputs: $title - optional title for the head
6518: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6519: $args - optional arguments
1.319 albertel 6520: force_register - if is true call registerurl so the remote is
6521: informed
1.415 albertel 6522: redirect -> array ref of
6523: 1- seconds before redirect occurs
6524: 2- url to redirect to
6525: 3- whether the side effect should occur
1.315 albertel 6526: (side effect of setting
6527: $env{'internal.head.redirect'} to the url
6528: redirected too)
1.352 albertel 6529: domain -> force to color decorate a page for a specific
6530: domain
6531: function -> force usage of a specific rolish color scheme
6532: bgcolor -> override the default page bgcolor
1.460 albertel 6533: no_auto_mt_title
6534: -> prevent &mt()ing the title arg
1.464 albertel 6535:
1.306 albertel 6536: =cut
6537:
6538: sub headtag {
1.313 albertel 6539: my ($title,$head_extra,$args) = @_;
1.306 albertel 6540:
1.363 albertel 6541: my $function = $args->{'function'} || &get_users_function();
6542: my $domain = $args->{'domain'} || &determinedomain();
6543: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6544: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6545: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6546: #time(),
1.418 albertel 6547: $env{'environment.color.timestamp'},
1.363 albertel 6548: $function,$domain,$bgcolor);
6549:
1.369 www 6550: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6551:
1.308 albertel 6552: my $result =
6553: '<head>'.
1.461 albertel 6554: &font_settings();
1.319 albertel 6555:
1.461 albertel 6556: if (!$args->{'frameset'}) {
6557: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6558: }
1.319 albertel 6559: if ($args->{'force_register'}) {
6560: $result .= &Apache::lonmenu::registerurl(1);
6561: }
1.436 albertel 6562: if (!$args->{'no_nav_bar'}
6563: && !$args->{'only_body'}
6564: && !$args->{'frameset'}) {
6565: $result .= &help_menu_js();
6566: }
1.319 albertel 6567:
1.314 albertel 6568: if (ref($args->{'redirect'})) {
1.414 albertel 6569: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6570: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6571: if (!$inhibit_continue) {
6572: $env{'internal.head.redirect'} = $url;
6573: }
1.313 albertel 6574: $result.=<<ADDMETA
6575: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6576: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6577: ADDMETA
6578: }
1.306 albertel 6579: if (!defined($title)) {
6580: $title = 'The LearningOnline Network with CAPA';
6581: }
1.460 albertel 6582: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6583: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6584: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6585: .$head_extra;
1.306 albertel 6586: return $result;
6587: }
6588:
6589: =pod
6590:
1.340 albertel 6591: =item * &font_settings()
6592:
6593: Returns neccessary <meta> to set the proper encoding
6594:
6595: Inputs: none
6596:
6597: =cut
6598:
6599: sub font_settings {
6600: my $headerstring='';
1.647 www 6601: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6602: $headerstring.=
6603: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6604: }
6605: return $headerstring;
6606: }
6607:
1.341 albertel 6608: =pod
6609:
6610: =item * &xml_begin()
6611:
6612: Returns the needed doctype and <html>
6613:
6614: Inputs: none
6615:
6616: =cut
6617:
6618: sub xml_begin {
6619: my $output='';
6620:
1.592 albertel 6621: if ($env{'internal.start_page'}==1) {
6622: &Apache::lonhtmlcommon::init_htmlareafields();
6623: }
1.342 albertel 6624:
1.341 albertel 6625: if ($env{'browser.mathml'}) {
6626: $output='<?xml version="1.0"?>'
6627: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6628: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6629:
6630: # .'<!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">] >'
6631: .'<!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">'
6632: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6633: .'xmlns="http://www.w3.org/1999/xhtml">';
6634: } else {
1.849 bisitz 6635: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6636: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341 albertel 6637: }
6638: return $output;
6639: }
1.340 albertel 6640:
6641: =pod
6642:
1.306 albertel 6643: =item * &endheadtag()
6644:
6645: Returns a uniform </head> for LON-CAPA web pages.
6646:
6647: Inputs: none
6648:
6649: =cut
6650:
6651: sub endheadtag {
6652: return '</head>';
6653: }
6654:
6655: =pod
6656:
6657: =item * &head()
6658:
6659: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6660:
1.648 raeburn 6661: Inputs:
6662:
6663: =over 4
6664:
6665: $title - optional title for the page
6666:
6667: $head_extra - optional extra HTML to put inside the <head>
6668:
6669: =back
1.405 albertel 6670:
1.306 albertel 6671: =cut
6672:
6673: sub head {
1.325 albertel 6674: my ($title,$head_extra,$args) = @_;
6675: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6676: }
6677:
6678: =pod
6679:
6680: =item * &start_page()
6681:
6682: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6683:
1.648 raeburn 6684: Inputs:
6685:
6686: =over 4
6687:
6688: $title - optional title for the page
6689:
6690: $head_extra - optional extra HTML to incude inside the <head>
6691:
6692: $args - additional optional args supported are:
6693:
6694: =over 8
6695:
6696: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6697: arg on
1.814 bisitz 6698: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6699: add_entries -> additional attributes to add to the <body>
6700: domain -> force to color decorate a page for a
1.317 albertel 6701: specific domain
1.648 raeburn 6702: function -> force usage of a specific rolish color
1.317 albertel 6703: scheme
1.648 raeburn 6704: redirect -> see &headtag()
6705: bgcolor -> override the default page bg color
6706: js_ready -> return a string ready for being used in
1.317 albertel 6707: a javascript writeln
1.648 raeburn 6708: html_encode -> return a string ready for being used in
1.320 albertel 6709: a html attribute
1.648 raeburn 6710: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6711: $forcereg arg
1.648 raeburn 6712: frameset -> if true will start with a <frameset>
1.330 albertel 6713: rather than <body>
1.648 raeburn 6714: skip_phases -> hash ref of
1.338 albertel 6715: head -> skip the <html><head> generation
6716: body -> skip all <body> generation
1.648 raeburn 6717: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6718: 'Switch To Inline Menu' link
1.648 raeburn 6719: no_auto_mt_title -> prevent &mt()ing the title arg
6720: inherit_jsmath -> when creating popup window in a page,
6721: should it have jsmath forced on by the
6722: current page
1.867 kalberla 6723: bread_crumbs -> Array containing breadcrumbs
6724: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
1.361 albertel 6725:
1.648 raeburn 6726: =back
1.460 albertel 6727:
1.648 raeburn 6728: =back
1.562 albertel 6729:
1.306 albertel 6730: =cut
6731:
6732: sub start_page {
1.309 albertel 6733: my ($title,$head_extra,$args) = @_;
1.318 albertel 6734: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6735: my %head_args;
1.352 albertel 6736: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6737: 'bgcolor','frameset','no_nav_bar','only_body',
6738: 'no_auto_mt_title') {
1.319 albertel 6739: if (defined($args->{$arg})) {
1.324 raeburn 6740: $head_args{$arg} = $args->{$arg};
1.319 albertel 6741: }
1.313 albertel 6742: }
1.319 albertel 6743:
1.315 albertel 6744: $env{'internal.start_page'}++;
1.338 albertel 6745: my $result;
6746: if (! exists($args->{'skip_phases'}{'head'}) ) {
6747: $result.=
1.341 albertel 6748: &xml_begin().
1.338 albertel 6749: &headtag($title,$head_extra,\%head_args).&endheadtag();
6750: }
6751:
6752: if (! exists($args->{'skip_phases'}{'body'}) ) {
6753: if ($args->{'frameset'}) {
6754: my $attr_string = &make_attr_string($args->{'force_register'},
6755: $args->{'add_entries'});
6756: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 6757: } else {
6758: $result .=
6759: &bodytag($title,
6760: $args->{'function'}, $args->{'add_entries'},
6761: $args->{'only_body'}, $args->{'domain'},
6762: $args->{'force_register'}, $args->{'no_nav_bar'},
6763: $args->{'bgcolor'}, $args->{'no_inline_link'},
6764: $args);
6765: }
1.330 albertel 6766: }
1.338 albertel 6767:
1.315 albertel 6768: if ($args->{'js_ready'}) {
1.713 kaisler 6769: $result = &js_ready($result);
1.315 albertel 6770: }
1.320 albertel 6771: if ($args->{'html_encode'}) {
1.713 kaisler 6772: $result = &html_encode($result);
6773: }
6774:
1.813 bisitz 6775: # Preparation for new and consistent functionlist at top of screen
6776: # if ($args->{'functionlist'}) {
6777: # $result .= &build_functionlist();
6778: #}
6779:
6780: # Don't add anything more if only_body wanted
6781: return $result if $args->{'only_body'};
6782:
1.920 raeburn 6783: #Breadcrumbs for Construction Space provided by &bodytag.
6784: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6785: return $result;
6786: }
6787:
1.813 bisitz 6788: #Breadcrumbs
1.758 kaisler 6789: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6790: &Apache::lonhtmlcommon::clear_breadcrumbs();
6791: #if any br links exists, add them to the breadcrumbs
6792: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6793: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6794: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6795: }
6796: }
6797:
6798: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6799: if(exists($args->{'bread_crumbs_component'})){
6800: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6801: }else{
6802: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6803: }
1.320 albertel 6804: }
1.315 albertel 6805: return $result;
1.306 albertel 6806: }
6807:
1.330 albertel 6808:
1.306 albertel 6809: =pod
6810:
6811: =item * &head()
6812:
6813: Returns a complete </body></html> section for LON-CAPA web pages.
6814:
1.315 albertel 6815: Inputs: $args - additional optional args supported are:
6816: js_ready -> return a string ready for being used in
6817: a javascript writeln
1.320 albertel 6818: html_encode -> return a string ready for being used in
6819: a html attribute
1.330 albertel 6820: frameset -> if true will start with a <frameset>
6821: rather than <body>
1.493 albertel 6822: dicsussion -> if true will get discussion from
6823: lonxml::xmlend
6824: (you can pass the target and parser arguments
6825: through optional 'target' and 'parser' args
6826: to this routine)
1.306 albertel 6827:
6828: =cut
6829:
6830: sub end_page {
1.315 albertel 6831: my ($args) = @_;
6832: $env{'internal.end_page'}++;
1.330 albertel 6833: my $result;
1.335 albertel 6834: if ($args->{'discussion'}) {
6835: my ($target,$parser);
6836: if (ref($args->{'discussion'})) {
6837: ($target,$parser) =($args->{'discussion'}{'target'},
6838: $args->{'discussion'}{'parser'});
6839: }
6840: $result .= &Apache::lonxml::xmlend($target,$parser);
6841: }
6842:
1.330 albertel 6843: if ($args->{'frameset'}) {
6844: $result .= '</frameset>';
6845: } else {
1.635 raeburn 6846: $result .= &endbodytag($args);
1.330 albertel 6847: }
6848: $result .= "\n</html>";
6849:
1.315 albertel 6850: if ($args->{'js_ready'}) {
1.317 albertel 6851: $result = &js_ready($result);
1.315 albertel 6852: }
1.335 albertel 6853:
1.320 albertel 6854: if ($args->{'html_encode'}) {
6855: $result = &html_encode($result);
6856: }
1.335 albertel 6857:
1.315 albertel 6858: return $result;
6859: }
6860:
1.320 albertel 6861: sub html_encode {
6862: my ($result) = @_;
6863:
1.322 albertel 6864: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6865:
6866: return $result;
6867: }
1.317 albertel 6868: sub js_ready {
6869: my ($result) = @_;
6870:
1.323 albertel 6871: $result =~ s/[\n\r]/ /xmsg;
6872: $result =~ s/\\/\\\\/xmsg;
6873: $result =~ s/'/\\'/xmsg;
1.372 albertel 6874: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6875:
6876: return $result;
6877: }
6878:
1.315 albertel 6879: sub validate_page {
6880: if ( exists($env{'internal.start_page'})
1.316 albertel 6881: && $env{'internal.start_page'} > 1) {
6882: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6883: $env{'internal.start_page'}.' '.
1.316 albertel 6884: $ENV{'request.filename'});
1.315 albertel 6885: }
6886: if ( exists($env{'internal.end_page'})
1.316 albertel 6887: && $env{'internal.end_page'} > 1) {
6888: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6889: $env{'internal.end_page'}.' '.
1.316 albertel 6890: $env{'request.filename'});
1.315 albertel 6891: }
6892: if ( exists($env{'internal.start_page'})
6893: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6894: &Apache::lonnet::logthis('start_page called without end_page '.
6895: $env{'request.filename'});
1.315 albertel 6896: }
6897: if ( ! exists($env{'internal.start_page'})
6898: && exists($env{'internal.end_page'})) {
1.316 albertel 6899: &Apache::lonnet::logthis('end_page called without start_page'.
6900: $env{'request.filename'});
1.315 albertel 6901: }
1.306 albertel 6902: }
1.315 albertel 6903:
1.318 albertel 6904: sub simple_error_page {
6905: my ($r,$title,$msg) = @_;
6906: my $page =
6907: &Apache::loncommon::start_page($title).
6908: &mt($msg).
6909: &Apache::loncommon::end_page();
6910: if (ref($r)) {
6911: $r->print($page);
1.327 albertel 6912: return;
1.318 albertel 6913: }
6914: return $page;
6915: }
1.347 albertel 6916:
6917: {
1.610 albertel 6918: my @row_count;
1.347 albertel 6919: sub start_data_table {
1.422 albertel 6920: my ($add_class) = @_;
6921: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6922: unshift(@row_count,0);
1.422 albertel 6923: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6924: }
6925:
6926: sub end_data_table {
1.610 albertel 6927: shift(@row_count);
1.389 albertel 6928: return '</table>'."\n";;
1.347 albertel 6929: }
6930:
6931: sub start_data_table_row {
1.422 albertel 6932: my ($add_class) = @_;
1.610 albertel 6933: $row_count[0]++;
6934: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6935: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422 albertel 6936: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6937: }
1.471 banghart 6938:
6939: sub continue_data_table_row {
6940: my ($add_class) = @_;
1.610 albertel 6941: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 6942: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471 banghart 6943: return '<tr class="'.$css_class.'">'."\n";;
6944: }
1.347 albertel 6945:
6946: sub end_data_table_row {
1.389 albertel 6947: return '</tr>'."\n";;
1.347 albertel 6948: }
1.367 www 6949:
1.421 albertel 6950: sub start_data_table_empty_row {
1.707 bisitz 6951: # $row_count[0]++;
1.421 albertel 6952: return '<tr class="LC_empty_row" >'."\n";;
6953: }
6954:
6955: sub end_data_table_empty_row {
6956: return '</tr>'."\n";;
6957: }
6958:
1.367 www 6959: sub start_data_table_header_row {
1.389 albertel 6960: return '<tr class="LC_header_row">'."\n";;
1.367 www 6961: }
6962:
6963: sub end_data_table_header_row {
1.389 albertel 6964: return '</tr>'."\n";;
1.367 www 6965: }
1.890 droeschl 6966:
6967: sub data_table_caption {
6968: my $caption = shift;
6969: return "<caption class=\"LC_caption\">$caption</caption>";
6970: }
1.347 albertel 6971: }
6972:
1.548 albertel 6973: =pod
6974:
6975: =item * &inhibit_menu_check($arg)
6976:
6977: Checks for a inhibitmenu state and generates output to preserve it
6978:
6979: Inputs: $arg - can be any of
6980: - undef - in which case the return value is a string
6981: to add into arguments list of a uri
6982: - 'input' - in which case the return value is a HTML
6983: <form> <input> field of type hidden to
6984: preserve the value
6985: - a url - in which case the return value is the url with
6986: the neccesary cgi args added to preserve the
6987: inhibitmenu state
6988: - a ref to a url - no return value, but the string is
6989: updated to include the neccessary cgi
6990: args to preserve the inhibitmenu state
6991:
6992: =cut
6993:
6994: sub inhibit_menu_check {
6995: my ($arg) = @_;
6996: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6997: if ($arg eq 'input') {
6998: if ($env{'form.inhibitmenu'}) {
6999: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
7000: } else {
7001: return
7002: }
7003: }
7004: if ($env{'form.inhibitmenu'}) {
7005: if (ref($arg)) {
7006: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7007: } elsif ($arg eq '') {
7008: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
7009: } else {
7010: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
7011: }
7012: }
7013: if (!ref($arg)) {
7014: return $arg;
7015: }
7016: }
7017:
1.251 albertel 7018: ###############################################
1.182 matthew 7019:
7020: =pod
7021:
1.549 albertel 7022: =back
7023:
7024: =head1 User Information Routines
7025:
7026: =over 4
7027:
1.405 albertel 7028: =item * &get_users_function()
1.182 matthew 7029:
7030: Used by &bodytag to determine the current users primary role.
7031: Returns either 'student','coordinator','admin', or 'author'.
7032:
7033: =cut
7034:
7035: ###############################################
7036: sub get_users_function {
1.815 tempelho 7037: my $function = 'norole';
1.818 tempelho 7038: if ($env{'request.role'}=~/^(st)/) {
7039: $function='student';
7040: }
1.907 raeburn 7041: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 7042: $function='coordinator';
7043: }
1.258 albertel 7044: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 7045: $function='admin';
7046: }
1.826 bisitz 7047: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 7048: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7049: $function='author';
7050: }
7051: return $function;
1.54 www 7052: }
1.99 www 7053:
7054: ###############################################
7055:
1.233 raeburn 7056: =pod
7057:
1.821 raeburn 7058: =item * &show_course()
7059:
7060: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7061: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7062:
7063: Inputs:
7064: None
7065:
7066: Outputs:
7067: Scalar: 1 if 'Course' to be used, 0 otherwise.
7068:
7069: =cut
7070:
7071: ###############################################
7072: sub show_course {
7073: my $course = !$env{'user.adv'};
7074: if (!$env{'user.adv'}) {
7075: foreach my $env (keys(%env)) {
7076: next if ($env !~ m/^user\.priv\./);
7077: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7078: $course = 0;
7079: last;
7080: }
7081: }
7082: }
7083: return $course;
7084: }
7085:
7086: ###############################################
7087:
7088: =pod
7089:
1.542 raeburn 7090: =item * &check_user_status()
1.274 raeburn 7091:
7092: Determines current status of supplied role for a
7093: specific user. Roles can be active, previous or future.
7094:
7095: Inputs:
7096: user's domain, user's username, course's domain,
1.375 raeburn 7097: course's number, optional section ID.
1.274 raeburn 7098:
7099: Outputs:
7100: role status: active, previous or future.
7101:
7102: =cut
7103:
7104: sub check_user_status {
1.412 raeburn 7105: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 7106: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7107: my @uroles = keys %userinfo;
7108: my $srchstr;
7109: my $active_chk = 'none';
1.412 raeburn 7110: my $now = time;
1.274 raeburn 7111: if (@uroles > 0) {
1.908 raeburn 7112: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 7113: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7114: } else {
1.412 raeburn 7115: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7116: }
7117: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 7118: my $role_end = 0;
7119: my $role_start = 0;
7120: $active_chk = 'active';
1.412 raeburn 7121: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7122: $role_end = $1;
7123: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7124: $role_start = $1;
1.274 raeburn 7125: }
7126: }
7127: if ($role_start > 0) {
1.412 raeburn 7128: if ($now < $role_start) {
1.274 raeburn 7129: $active_chk = 'future';
7130: }
7131: }
7132: if ($role_end > 0) {
1.412 raeburn 7133: if ($now > $role_end) {
1.274 raeburn 7134: $active_chk = 'previous';
7135: }
7136: }
7137: }
7138: }
7139: return $active_chk;
7140: }
7141:
7142: ###############################################
7143:
7144: =pod
7145:
1.405 albertel 7146: =item * &get_sections()
1.233 raeburn 7147:
7148: Determines all the sections for a course including
7149: sections with students and sections containing other roles.
1.419 raeburn 7150: Incoming parameters:
7151:
7152: 1. domain
7153: 2. course number
7154: 3. reference to array containing roles for which sections should
7155: be gathered (optional).
7156: 4. reference to array containing status types for which sections
7157: should be gathered (optional).
7158:
7159: If the third argument is undefined, sections are gathered for any role.
7160: If the fourth argument is undefined, sections are gathered for any status.
7161: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 7162:
1.374 raeburn 7163: Returns section hash (keys are section IDs, values are
7164: number of users in each section), subject to the
1.419 raeburn 7165: optional roles filter, optional status filter
1.233 raeburn 7166:
7167: =cut
7168:
7169: ###############################################
7170: sub get_sections {
1.419 raeburn 7171: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 7172: if (!defined($cdom) || !defined($cnum)) {
7173: my $cid = $env{'request.course.id'};
7174:
7175: return if (!defined($cid));
7176:
7177: $cdom = $env{'course.'.$cid.'.domain'};
7178: $cnum = $env{'course.'.$cid.'.num'};
7179: }
7180:
7181: my %sectioncount;
1.419 raeburn 7182: my $now = time;
1.240 albertel 7183:
1.366 albertel 7184: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 7185: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 7186: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7187: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 7188: my $start_index = &Apache::loncoursedata::CL_START();
7189: my $end_index = &Apache::loncoursedata::CL_END();
7190: my $status;
1.366 albertel 7191: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 7192: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7193: $data->[$status_index],
7194: $data->[$start_index],
7195: $data->[$end_index]);
7196: if ($stu_status eq 'Active') {
7197: $status = 'active';
7198: } elsif ($end < $now) {
7199: $status = 'previous';
7200: } elsif ($start > $now) {
7201: $status = 'future';
7202: }
7203: if ($section ne '-1' && $section !~ /^\s*$/) {
7204: if ((!defined($possible_status)) || (($status ne '') &&
7205: (grep/^\Q$status\E$/,@{$possible_status}))) {
7206: $sectioncount{$section}++;
7207: }
1.240 albertel 7208: }
7209: }
7210: }
7211: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7212: foreach my $user (sort(keys(%courseroles))) {
7213: if ($user !~ /^(\w{2})/) { next; }
7214: my ($role) = ($user =~ /^(\w{2})/);
7215: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 7216: my ($section,$status);
1.240 albertel 7217: if ($role eq 'cr' &&
7218: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7219: $section=$1;
7220: }
7221: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7222: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 7223: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7224: if ($end == -1 && $start == -1) {
7225: next; #deleted role
7226: }
7227: if (!defined($possible_status)) {
7228: $sectioncount{$section}++;
7229: } else {
7230: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7231: $status = 'active';
7232: } elsif ($end < $now) {
7233: $status = 'future';
7234: } elsif ($start > $now) {
7235: $status = 'previous';
7236: }
7237: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7238: $sectioncount{$section}++;
7239: }
7240: }
1.233 raeburn 7241: }
1.366 albertel 7242: return %sectioncount;
1.233 raeburn 7243: }
7244:
1.274 raeburn 7245: ###############################################
1.294 raeburn 7246:
7247: =pod
1.405 albertel 7248:
7249: =item * &get_course_users()
7250:
1.275 raeburn 7251: Retrieves usernames:domains for users in the specified course
7252: with specific role(s), and access status.
7253:
7254: Incoming parameters:
1.277 albertel 7255: 1. course domain
7256: 2. course number
7257: 3. access status: users must have - either active,
1.275 raeburn 7258: previous, future, or all.
1.277 albertel 7259: 4. reference to array of permissible roles
1.288 raeburn 7260: 5. reference to array of section restrictions (optional)
7261: 6. reference to results object (hash of hashes).
7262: 7. reference to optional userdata hash
1.609 raeburn 7263: 8. reference to optional statushash
1.630 raeburn 7264: 9. flag if privileged users (except those set to unhide in
7265: course settings) should be excluded
1.609 raeburn 7266: Keys of top level results hash are roles.
1.275 raeburn 7267: Keys of inner hashes are username:domain, with
7268: values set to access type.
1.288 raeburn 7269: Optional userdata hash returns an array with arguments in the
7270: same order as loncoursedata::get_classlist() for student data.
7271:
1.609 raeburn 7272: Optional statushash returns
7273:
1.288 raeburn 7274: Entries for end, start, section and status are blank because
7275: of the possibility of multiple values for non-student roles.
7276:
1.275 raeburn 7277: =cut
1.405 albertel 7278:
1.275 raeburn 7279: ###############################################
1.405 albertel 7280:
1.275 raeburn 7281: sub get_course_users {
1.630 raeburn 7282: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7283: my %idx = ();
1.419 raeburn 7284: my %seclists;
1.288 raeburn 7285:
7286: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7287: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7288: $idx{end} = &Apache::loncoursedata::CL_END();
7289: $idx{start} = &Apache::loncoursedata::CL_START();
7290: $idx{id} = &Apache::loncoursedata::CL_ID();
7291: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7292: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7293: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7294:
1.290 albertel 7295: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7296: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7297: my $now = time;
1.277 albertel 7298: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7299: my $match = 0;
1.412 raeburn 7300: my $secmatch = 0;
1.419 raeburn 7301: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7302: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7303: if ($section eq '') {
7304: $section = 'none';
7305: }
1.291 albertel 7306: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7307: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7308: $secmatch = 1;
7309: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7310: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7311: $secmatch = 1;
7312: }
7313: } else {
1.419 raeburn 7314: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7315: $secmatch = 1;
7316: }
1.290 albertel 7317: }
1.412 raeburn 7318: if (!$secmatch) {
7319: next;
7320: }
1.419 raeburn 7321: }
1.275 raeburn 7322: if (defined($$types{'active'})) {
1.288 raeburn 7323: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7324: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7325: $match = 1;
1.275 raeburn 7326: }
7327: }
7328: if (defined($$types{'previous'})) {
1.609 raeburn 7329: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7330: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7331: $match = 1;
1.275 raeburn 7332: }
7333: }
7334: if (defined($$types{'future'})) {
1.609 raeburn 7335: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7336: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7337: $match = 1;
1.275 raeburn 7338: }
7339: }
1.609 raeburn 7340: if ($match) {
7341: push(@{$seclists{$student}},$section);
7342: if (ref($userdata) eq 'HASH') {
7343: $$userdata{$student} = $$classlist{$student};
7344: }
7345: if (ref($statushash) eq 'HASH') {
7346: $statushash->{$student}{'st'}{$section} = $status;
7347: }
1.288 raeburn 7348: }
1.275 raeburn 7349: }
7350: }
1.412 raeburn 7351: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7352: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7353: my $now = time;
1.609 raeburn 7354: my %displaystatus = ( previous => 'Expired',
7355: active => 'Active',
7356: future => 'Future',
7357: );
1.630 raeburn 7358: my %nothide;
7359: if ($hidepriv) {
7360: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7361: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7362: if ($user !~ /:/) {
7363: $nothide{join(':',split(/[\@]/,$user))}=1;
7364: } else {
7365: $nothide{$user} = 1;
7366: }
7367: }
7368: }
1.439 raeburn 7369: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7370: my $match = 0;
1.412 raeburn 7371: my $secmatch = 0;
1.439 raeburn 7372: my $status;
1.412 raeburn 7373: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7374: $user =~ s/:$//;
1.439 raeburn 7375: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7376: if ($end == -1 || $start == -1) {
7377: next;
7378: }
7379: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7380: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7381: my ($uname,$udom) = split(/:/,$user);
7382: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7383: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7384: $secmatch = 1;
7385: } elsif ($usec eq '') {
1.420 albertel 7386: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7387: $secmatch = 1;
7388: }
7389: } else {
7390: if (grep(/^\Q$usec\E$/,@{$sections})) {
7391: $secmatch = 1;
7392: }
7393: }
7394: if (!$secmatch) {
7395: next;
7396: }
1.288 raeburn 7397: }
1.419 raeburn 7398: if ($usec eq '') {
7399: $usec = 'none';
7400: }
1.275 raeburn 7401: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7402: if ($hidepriv) {
7403: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7404: (!$nothide{$uname.':'.$udom})) {
7405: next;
7406: }
7407: }
1.503 raeburn 7408: if ($end > 0 && $end < $now) {
1.439 raeburn 7409: $status = 'previous';
7410: } elsif ($start > $now) {
7411: $status = 'future';
7412: } else {
7413: $status = 'active';
7414: }
1.277 albertel 7415: foreach my $type (keys(%{$types})) {
1.275 raeburn 7416: if ($status eq $type) {
1.420 albertel 7417: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7418: push(@{$$users{$role}{$user}},$type);
7419: }
1.288 raeburn 7420: $match = 1;
7421: }
7422: }
1.419 raeburn 7423: if (($match) && (ref($userdata) eq 'HASH')) {
7424: if (!exists($$userdata{$uname.':'.$udom})) {
7425: &get_user_info($udom,$uname,\%idx,$userdata);
7426: }
1.420 albertel 7427: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7428: push(@{$seclists{$uname.':'.$udom}},$usec);
7429: }
1.609 raeburn 7430: if (ref($statushash) eq 'HASH') {
7431: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7432: }
1.275 raeburn 7433: }
7434: }
7435: }
7436: }
1.290 albertel 7437: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7438: if ((defined($cdom)) && (defined($cnum))) {
7439: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7440: if ( defined($csettings{'internal.courseowner'}) ) {
7441: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7442: next if ($owner eq '');
7443: my ($ownername,$ownerdom);
7444: if ($owner =~ /^([^:]+):([^:]+)$/) {
7445: $ownername = $1;
7446: $ownerdom = $2;
7447: } else {
7448: $ownername = $owner;
7449: $ownerdom = $cdom;
7450: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7451: }
7452: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7453: if (defined($userdata) &&
1.609 raeburn 7454: !exists($$userdata{$owner})) {
7455: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7456: if (!grep(/^none$/,@{$seclists{$owner}})) {
7457: push(@{$seclists{$owner}},'none');
7458: }
7459: if (ref($statushash) eq 'HASH') {
7460: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7461: }
1.290 albertel 7462: }
1.279 raeburn 7463: }
7464: }
7465: }
1.419 raeburn 7466: foreach my $user (keys(%seclists)) {
7467: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7468: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7469: }
1.275 raeburn 7470: }
7471: return;
7472: }
7473:
1.288 raeburn 7474: sub get_user_info {
7475: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7476: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7477: &plainname($uname,$udom,'lastname');
1.291 albertel 7478: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7479: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7480: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7481: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7482: return;
7483: }
1.275 raeburn 7484:
1.472 raeburn 7485: ###############################################
7486:
7487: =pod
7488:
7489: =item * &get_user_quota()
7490:
7491: Retrieves quota assigned for storage of portfolio files for a user
7492:
7493: Incoming parameters:
7494: 1. user's username
7495: 2. user's domain
7496:
7497: Returns:
1.536 raeburn 7498: 1. Disk quota (in Mb) assigned to student.
7499: 2. (Optional) Type of setting: custom or default
7500: (individually assigned or default for user's
7501: institutional status).
7502: 3. (Optional) - User's institutional status (e.g., faculty, staff
7503: or student - types as defined in localenroll::inst_usertypes
7504: for user's domain, which determines default quota for user.
7505: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7506:
7507: If a value has been stored in the user's environment,
1.536 raeburn 7508: it will return that, otherwise it returns the maximal default
7509: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7510:
7511: =cut
7512:
7513: ###############################################
7514:
7515:
7516: sub get_user_quota {
7517: my ($uname,$udom) = @_;
1.536 raeburn 7518: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7519: if (!defined($udom)) {
7520: $udom = $env{'user.domain'};
7521: }
7522: if (!defined($uname)) {
7523: $uname = $env{'user.name'};
7524: }
7525: if (($udom eq '' || $uname eq '') ||
7526: ($udom eq 'public') && ($uname eq 'public')) {
7527: $quota = 0;
1.536 raeburn 7528: $quotatype = 'default';
7529: $defquota = 0;
1.472 raeburn 7530: } else {
1.536 raeburn 7531: my $inststatus;
1.472 raeburn 7532: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7533: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7534: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7535: } else {
1.536 raeburn 7536: my %userenv =
7537: &Apache::lonnet::get('environment',['portfolioquota',
7538: 'inststatus'],$udom,$uname);
1.472 raeburn 7539: my ($tmp) = keys(%userenv);
7540: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7541: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7542: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7543: } else {
7544: undef(%userenv);
7545: }
7546: }
1.536 raeburn 7547: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7548: if ($quota eq '') {
1.536 raeburn 7549: $quota = $defquota;
7550: $quotatype = 'default';
7551: } else {
7552: $quotatype = 'custom';
1.472 raeburn 7553: }
7554: }
1.536 raeburn 7555: if (wantarray) {
7556: return ($quota,$quotatype,$settingstatus,$defquota);
7557: } else {
7558: return $quota;
7559: }
1.472 raeburn 7560: }
7561:
7562: ###############################################
7563:
7564: =pod
7565:
7566: =item * &default_quota()
7567:
1.536 raeburn 7568: Retrieves default quota assigned for storage of user portfolio files,
7569: given an (optional) user's institutional status.
1.472 raeburn 7570:
7571: Incoming parameters:
7572: 1. domain
1.536 raeburn 7573: 2. (Optional) institutional status(es). This is a : separated list of
7574: status types (e.g., faculty, staff, student etc.)
7575: which apply to the user for whom the default is being retrieved.
7576: If the institutional status string in undefined, the domain
7577: default quota will be returned.
1.472 raeburn 7578:
7579: Returns:
7580: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7581: 2. (Optional) institutional type which determined the value of the
7582: default quota.
1.472 raeburn 7583:
7584: If a value has been stored in the domain's configuration db,
7585: it will return that, otherwise it returns 20 (for backwards
7586: compatibility with domains which have not set up a configuration
7587: db file; the original statically defined portfolio quota was 20 Mb).
7588:
1.536 raeburn 7589: If the user's status includes multiple types (e.g., staff and student),
7590: the largest default quota which applies to the user determines the
7591: default quota returned.
7592:
1.780 raeburn 7593: =back
7594:
1.472 raeburn 7595: =cut
7596:
7597: ###############################################
7598:
7599:
7600: sub default_quota {
1.536 raeburn 7601: my ($udom,$inststatus) = @_;
7602: my ($defquota,$settingstatus);
7603: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7604: ['quotas'],$udom);
7605: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7606: if ($inststatus ne '') {
1.765 raeburn 7607: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7608: foreach my $item (@statuses) {
1.711 raeburn 7609: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7610: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7611: if ($defquota eq '') {
7612: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7613: $settingstatus = $item;
7614: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7615: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7616: $settingstatus = $item;
7617: }
7618: }
7619: } else {
7620: if ($quotahash{'quotas'}{$item} ne '') {
7621: if ($defquota eq '') {
7622: $defquota = $quotahash{'quotas'}{$item};
7623: $settingstatus = $item;
7624: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7625: $defquota = $quotahash{'quotas'}{$item};
7626: $settingstatus = $item;
7627: }
1.536 raeburn 7628: }
7629: }
7630: }
7631: }
7632: if ($defquota eq '') {
1.711 raeburn 7633: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7634: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7635: } else {
7636: $defquota = $quotahash{'quotas'}{'default'};
7637: }
1.536 raeburn 7638: $settingstatus = 'default';
7639: }
7640: } else {
7641: $settingstatus = 'default';
7642: $defquota = 20;
7643: }
7644: if (wantarray) {
7645: return ($defquota,$settingstatus);
1.472 raeburn 7646: } else {
1.536 raeburn 7647: return $defquota;
1.472 raeburn 7648: }
7649: }
7650:
1.384 raeburn 7651: sub get_secgrprole_info {
7652: my ($cdom,$cnum,$needroles,$type) = @_;
7653: my %sections_count = &get_sections($cdom,$cnum);
7654: my @sections = (sort {$a <=> $b} keys(%sections_count));
7655: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7656: my @groups = sort(keys(%curr_groups));
7657: my $allroles = [];
7658: my $rolehash;
7659: my $accesshash = {
7660: active => 'Currently has access',
7661: future => 'Will have future access',
7662: previous => 'Previously had access',
7663: };
7664: if ($needroles) {
7665: $rolehash = {'all' => 'all'};
1.385 albertel 7666: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7667: if (&Apache::lonnet::error(%user_roles)) {
7668: undef(%user_roles);
7669: }
7670: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7671: my ($role)=split(/\:/,$item,2);
7672: if ($role eq 'cr') { next; }
7673: if ($role =~ /^cr/) {
7674: $$rolehash{$role} = (split('/',$role))[3];
7675: } else {
7676: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7677: }
7678: }
7679: foreach my $key (sort(keys(%{$rolehash}))) {
7680: push(@{$allroles},$key);
7681: }
7682: push (@{$allroles},'st');
7683: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7684: }
7685: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7686: }
7687:
1.555 raeburn 7688: sub user_picker {
1.627 raeburn 7689: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7690: my $currdom = $dom;
7691: my %curr_selected = (
7692: srchin => 'dom',
1.580 raeburn 7693: srchby => 'lastname',
1.555 raeburn 7694: );
7695: my $srchterm;
1.625 raeburn 7696: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7697: if ($srch->{'srchby'} ne '') {
7698: $curr_selected{'srchby'} = $srch->{'srchby'};
7699: }
7700: if ($srch->{'srchin'} ne '') {
7701: $curr_selected{'srchin'} = $srch->{'srchin'};
7702: }
7703: if ($srch->{'srchtype'} ne '') {
7704: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7705: }
7706: if ($srch->{'srchdomain'} ne '') {
7707: $currdom = $srch->{'srchdomain'};
7708: }
7709: $srchterm = $srch->{'srchterm'};
7710: }
7711: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7712: 'usr' => 'Search criteria',
1.563 raeburn 7713: 'doma' => 'Domain/institution to search',
1.558 albertel 7714: 'uname' => 'username',
7715: 'lastname' => 'last name',
1.555 raeburn 7716: 'lastfirst' => 'last name, first name',
1.558 albertel 7717: 'crs' => 'in this course',
1.576 raeburn 7718: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7719: 'alc' => 'all LON-CAPA',
1.573 raeburn 7720: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7721: 'exact' => 'is',
7722: 'contains' => 'contains',
1.569 raeburn 7723: 'begins' => 'begins with',
1.571 raeburn 7724: 'youm' => "You must include some text to search for.",
7725: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7726: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7727: 'yomc' => "You must choose a domain when using an institutional directory search.",
7728: 'ymcd' => "You must choose a domain when using a domain search.",
7729: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7730: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7731: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7732: );
1.563 raeburn 7733: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7734: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7735:
7736: my @srchins = ('crs','dom','alc','instd');
7737:
7738: foreach my $option (@srchins) {
7739: # FIXME 'alc' option unavailable until
7740: # loncreateuser::print_user_query_page()
7741: # has been completed.
7742: next if ($option eq 'alc');
1.880 raeburn 7743: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 7744: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7745: if ($curr_selected{'srchin'} eq $option) {
7746: $srchinsel .= '
7747: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7748: } else {
7749: $srchinsel .= '
7750: <option value="'.$option.'">'.$lt{$option}.'</option>';
7751: }
1.555 raeburn 7752: }
1.563 raeburn 7753: $srchinsel .= "\n </select>\n";
1.555 raeburn 7754:
7755: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7756: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7757: if ($curr_selected{'srchby'} eq $option) {
7758: $srchbysel .= '
7759: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7760: } else {
7761: $srchbysel .= '
7762: <option value="'.$option.'">'.$lt{$option}.'</option>';
7763: }
7764: }
7765: $srchbysel .= "\n </select>\n";
7766:
7767: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7768: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7769: if ($curr_selected{'srchtype'} eq $option) {
7770: $srchtypesel .= '
7771: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7772: } else {
7773: $srchtypesel .= '
7774: <option value="'.$option.'">'.$lt{$option}.'</option>';
7775: }
7776: }
7777: $srchtypesel .= "\n </select>\n";
7778:
1.558 albertel 7779: my ($newuserscript,$new_user_create);
1.556 raeburn 7780:
7781: if ($forcenewuser) {
1.576 raeburn 7782: if (ref($srch) eq 'HASH') {
7783: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7784: if ($cancreate) {
7785: $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>';
7786: } else {
1.799 bisitz 7787: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7788: my %usertypetext = (
7789: official => 'institutional',
7790: unofficial => 'non-institutional',
7791: );
1.799 bisitz 7792: $new_user_create = '<p class="LC_warning">'
7793: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7794: .' '
7795: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7796: ,'<a href="'.$helplink.'">','</a>')
7797: .'</p><br />';
1.627 raeburn 7798: }
1.576 raeburn 7799: }
7800: }
7801:
1.556 raeburn 7802: $newuserscript = <<"ENDSCRIPT";
7803:
1.570 raeburn 7804: function setSearch(createnew,callingForm) {
1.556 raeburn 7805: if (createnew == 1) {
1.570 raeburn 7806: for (var i=0; i<callingForm.srchby.length; i++) {
7807: if (callingForm.srchby.options[i].value == 'uname') {
7808: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7809: }
7810: }
1.570 raeburn 7811: for (var i=0; i<callingForm.srchin.length; i++) {
7812: if ( callingForm.srchin.options[i].value == 'dom') {
7813: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7814: }
7815: }
1.570 raeburn 7816: for (var i=0; i<callingForm.srchtype.length; i++) {
7817: if (callingForm.srchtype.options[i].value == 'exact') {
7818: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7819: }
7820: }
1.570 raeburn 7821: for (var i=0; i<callingForm.srchdomain.length; i++) {
7822: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7823: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7824: }
7825: }
7826: }
7827: }
7828: ENDSCRIPT
1.558 albertel 7829:
1.556 raeburn 7830: }
7831:
1.555 raeburn 7832: my $output = <<"END_BLOCK";
1.556 raeburn 7833: <script type="text/javascript">
1.824 bisitz 7834: // <![CDATA[
1.570 raeburn 7835: function validateEntry(callingForm) {
1.558 albertel 7836:
1.556 raeburn 7837: var checkok = 1;
1.558 albertel 7838: var srchin;
1.570 raeburn 7839: for (var i=0; i<callingForm.srchin.length; i++) {
7840: if ( callingForm.srchin[i].checked ) {
7841: srchin = callingForm.srchin[i].value;
1.558 albertel 7842: }
7843: }
7844:
1.570 raeburn 7845: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7846: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7847: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7848: var srchterm = callingForm.srchterm.value;
7849: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7850: var msg = "";
7851:
7852: if (srchterm == "") {
7853: checkok = 0;
1.571 raeburn 7854: msg += "$lt{'youm'}\\n";
1.556 raeburn 7855: }
7856:
1.569 raeburn 7857: if (srchtype== 'begins') {
7858: if (srchterm.length < 2) {
7859: checkok = 0;
1.571 raeburn 7860: msg += "$lt{'thte'}\\n";
1.569 raeburn 7861: }
7862: }
7863:
1.556 raeburn 7864: if (srchtype== 'contains') {
7865: if (srchterm.length < 3) {
7866: checkok = 0;
1.571 raeburn 7867: msg += "$lt{'thet'}\\n";
1.556 raeburn 7868: }
7869: }
7870: if (srchin == 'instd') {
7871: if (srchdomain == '') {
7872: checkok = 0;
1.571 raeburn 7873: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7874: }
7875: }
7876: if (srchin == 'dom') {
7877: if (srchdomain == '') {
7878: checkok = 0;
1.571 raeburn 7879: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7880: }
7881: }
7882: if (srchby == 'lastfirst') {
7883: if (srchterm.indexOf(",") == -1) {
7884: checkok = 0;
1.571 raeburn 7885: msg += "$lt{'whus'}\\n";
1.556 raeburn 7886: }
7887: if (srchterm.indexOf(",") == srchterm.length -1) {
7888: checkok = 0;
1.571 raeburn 7889: msg += "$lt{'whse'}\\n";
1.556 raeburn 7890: }
7891: }
7892: if (checkok == 0) {
1.571 raeburn 7893: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7894: return;
7895: }
7896: if (checkok == 1) {
1.570 raeburn 7897: callingForm.submit();
1.556 raeburn 7898: }
7899: }
7900:
7901: $newuserscript
7902:
1.824 bisitz 7903: // ]]>
1.556 raeburn 7904: </script>
1.558 albertel 7905:
7906: $new_user_create
7907:
1.555 raeburn 7908: END_BLOCK
1.558 albertel 7909:
1.876 raeburn 7910: $output .= &Apache::lonhtmlcommon::start_pick_box().
7911: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7912: $domform.
7913: &Apache::lonhtmlcommon::row_closure().
7914: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7915: $srchbysel.
7916: $srchtypesel.
7917: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7918: $srchinsel.
7919: &Apache::lonhtmlcommon::row_closure(1).
7920: &Apache::lonhtmlcommon::end_pick_box().
7921: '<br />';
1.555 raeburn 7922: return $output;
7923: }
7924:
1.612 raeburn 7925: sub user_rule_check {
1.615 raeburn 7926: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7927: my $response;
7928: if (ref($usershash) eq 'HASH') {
7929: foreach my $user (keys(%{$usershash})) {
7930: my ($uname,$udom) = split(/:/,$user);
7931: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7932: my ($id,$newuser);
1.612 raeburn 7933: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7934: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7935: $id = $usershash->{$user}->{'id'};
7936: }
7937: my $inst_response;
7938: if (ref($checks) eq 'HASH') {
7939: if (defined($checks->{'username'})) {
1.615 raeburn 7940: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7941: &Apache::lonnet::get_instuser($udom,$uname);
7942: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7943: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7944: &Apache::lonnet::get_instuser($udom,undef,$id);
7945: }
1.615 raeburn 7946: } else {
7947: ($inst_response,%{$inst_results->{$user}}) =
7948: &Apache::lonnet::get_instuser($udom,$uname);
7949: return;
1.612 raeburn 7950: }
1.615 raeburn 7951: if (!$got_rules->{$udom}) {
1.612 raeburn 7952: my %domconfig = &Apache::lonnet::get_dom('configuration',
7953: ['usercreation'],$udom);
7954: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7955: foreach my $item ('username','id') {
1.612 raeburn 7956: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7957: $$curr_rules{$udom}{$item} =
7958: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7959: }
7960: }
7961: }
1.615 raeburn 7962: $got_rules->{$udom} = 1;
1.585 raeburn 7963: }
1.612 raeburn 7964: foreach my $item (keys(%{$checks})) {
7965: if (ref($$curr_rules{$udom}) eq 'HASH') {
7966: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7967: if (@{$$curr_rules{$udom}{$item}} > 0) {
7968: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7969: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7970: if ($rule_check{$rule}) {
7971: $$rulematch{$user}{$item} = $rule;
7972: if ($inst_response eq 'ok') {
1.615 raeburn 7973: if (ref($inst_results) eq 'HASH') {
7974: if (ref($inst_results->{$user}) eq 'HASH') {
7975: if (keys(%{$inst_results->{$user}}) == 0) {
7976: $$alerts{$item}{$udom}{$uname} = 1;
7977: }
1.612 raeburn 7978: }
7979: }
1.615 raeburn 7980: }
7981: last;
1.585 raeburn 7982: }
7983: }
7984: }
7985: }
7986: }
7987: }
7988: }
7989: }
1.612 raeburn 7990: return;
7991: }
7992:
7993: sub user_rule_formats {
7994: my ($domain,$domdesc,$curr_rules,$check) = @_;
7995: my %text = (
7996: 'username' => 'Usernames',
7997: 'id' => 'IDs',
7998: );
7999: my $output;
8000: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
8001: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
8002: if (@{$ruleorder} > 0) {
8003: $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>';
8004: foreach my $rule (@{$ruleorder}) {
8005: if (ref($curr_rules) eq 'ARRAY') {
8006: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
8007: if (ref($rules->{$rule}) eq 'HASH') {
8008: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
8009: $rules->{$rule}{'desc'}.'</li>';
8010: }
8011: }
8012: }
8013: }
8014: $output .= '</ul>';
8015: }
8016: }
8017: return $output;
8018: }
8019:
8020: sub instrule_disallow_msg {
1.615 raeburn 8021: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 8022: my $response;
8023: my %text = (
8024: item => 'username',
8025: items => 'usernames',
8026: match => 'matches',
8027: do => 'does',
8028: action => 'a username',
8029: one => 'one',
8030: );
8031: if ($count > 1) {
8032: $text{'item'} = 'usernames';
8033: $text{'match'} ='match';
8034: $text{'do'} = 'do';
8035: $text{'action'} = 'usernames',
8036: $text{'one'} = 'ones';
8037: }
8038: if ($checkitem eq 'id') {
8039: $text{'items'} = 'IDs';
8040: $text{'item'} = 'ID';
8041: $text{'action'} = 'an ID';
1.615 raeburn 8042: if ($count > 1) {
8043: $text{'item'} = 'IDs';
8044: $text{'action'} = 'IDs';
8045: }
1.612 raeburn 8046: }
1.674 bisitz 8047: $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 8048: if ($mode eq 'upload') {
8049: if ($checkitem eq 'username') {
8050: $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'}.");
8051: } elsif ($checkitem eq 'id') {
1.674 bisitz 8052: $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 8053: }
1.669 raeburn 8054: } elsif ($mode eq 'selfcreate') {
8055: if ($checkitem eq 'id') {
8056: $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.");
8057: }
1.615 raeburn 8058: } else {
8059: if ($checkitem eq 'username') {
8060: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8061: } elsif ($checkitem eq 'id') {
8062: $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.");
8063: }
1.612 raeburn 8064: }
8065: return $response;
1.585 raeburn 8066: }
8067:
1.624 raeburn 8068: sub personal_data_fieldtitles {
8069: my %fieldtitles = &Apache::lonlocal::texthash (
8070: id => 'Student/Employee ID',
8071: permanentemail => 'E-mail address',
8072: lastname => 'Last Name',
8073: firstname => 'First Name',
8074: middlename => 'Middle Name',
8075: generation => 'Generation',
8076: gen => 'Generation',
1.765 raeburn 8077: inststatus => 'Affiliation',
1.624 raeburn 8078: );
8079: return %fieldtitles;
8080: }
8081:
1.642 raeburn 8082: sub sorted_inst_types {
8083: my ($dom) = @_;
8084: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8085: my $othertitle = &mt('All users');
8086: if ($env{'request.course.id'}) {
1.668 raeburn 8087: $othertitle = &mt('Any users');
1.642 raeburn 8088: }
8089: my @types;
8090: if (ref($order) eq 'ARRAY') {
8091: @types = @{$order};
8092: }
8093: if (@types == 0) {
8094: if (ref($usertypes) eq 'HASH') {
8095: @types = sort(keys(%{$usertypes}));
8096: }
8097: }
8098: if (keys(%{$usertypes}) > 0) {
8099: $othertitle = &mt('Other users');
8100: }
8101: return ($othertitle,$usertypes,\@types);
8102: }
8103:
1.645 raeburn 8104: sub get_institutional_codes {
8105: my ($settings,$allcourses,$LC_code) = @_;
8106: # Get complete list of course sections to update
8107: my @currsections = ();
8108: my @currxlists = ();
8109: my $coursecode = $$settings{'internal.coursecode'};
8110:
8111: if ($$settings{'internal.sectionnums'} ne '') {
8112: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8113: }
8114:
8115: if ($$settings{'internal.crosslistings'} ne '') {
8116: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8117: }
8118:
8119: if (@currxlists > 0) {
8120: foreach (@currxlists) {
8121: if (m/^([^:]+):(\w*)$/) {
8122: unless (grep/^$1$/,@{$allcourses}) {
8123: push @{$allcourses},$1;
8124: $$LC_code{$1} = $2;
8125: }
8126: }
8127: }
8128: }
8129:
8130: if (@currsections > 0) {
8131: foreach (@currsections) {
8132: if (m/^(\w+):(\w*)$/) {
8133: my $sec = $coursecode.$1;
8134: my $lc_sec = $2;
8135: unless (grep/^$sec$/,@{$allcourses}) {
8136: push @{$allcourses},$sec;
8137: $$LC_code{$sec} = $lc_sec;
8138: }
8139: }
8140: }
8141: }
8142: return;
8143: }
8144:
1.112 bowersj2 8145: =pod
8146:
1.780 raeburn 8147: =head1 Slot Helpers
8148:
8149: =over 4
8150:
8151: =item * sorted_slots()
8152:
8153: Sorts an array of slot names in order of slot start time (earliest first).
8154:
8155: Inputs:
8156:
8157: =over 4
8158:
8159: slotsarr - Reference to array of unsorted slot names.
8160:
8161: slots - Reference to hash of hash, where outer hash keys are slot names.
8162:
1.549 albertel 8163: =back
8164:
1.780 raeburn 8165: Returns:
8166:
8167: =over 4
8168:
8169: sorted - An array of slot names sorted by the start time of the slot.
8170:
8171: =back
8172:
8173: =back
8174:
8175: =cut
8176:
8177:
8178: sub sorted_slots {
8179: my ($slotsarr,$slots) = @_;
8180: my @sorted;
8181: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8182: @sorted =
8183: sort {
8184: if (ref($slots->{$a}) && ref($slots->{$b})) {
8185: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8186: }
8187: if (ref($slots->{$a})) { return -1;}
8188: if (ref($slots->{$b})) { return 1;}
8189: return 0;
8190: } @{$slotsarr};
8191: }
8192: return @sorted;
8193: }
8194:
8195:
8196: =pod
8197:
1.549 albertel 8198: =head1 HTTP Helpers
8199:
8200: =over 4
8201:
1.648 raeburn 8202: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 8203:
1.258 albertel 8204: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 8205: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 8206: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 8207:
8208: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8209: $possible_names is an ref to an array of form element names. As an example:
8210: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 8211: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 8212:
8213: =cut
1.1 albertel 8214:
1.6 albertel 8215: sub get_unprocessed_cgi {
1.25 albertel 8216: my ($query,$possible_names)= @_;
1.26 matthew 8217: # $Apache::lonxml::debug=1;
1.356 albertel 8218: foreach my $pair (split(/&/,$query)) {
8219: my ($name, $value) = split(/=/,$pair);
1.369 www 8220: $name = &unescape($name);
1.25 albertel 8221: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8222: $value =~ tr/+/ /;
8223: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 8224: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 8225: }
1.16 harris41 8226: }
1.6 albertel 8227: }
8228:
1.112 bowersj2 8229: =pod
8230:
1.648 raeburn 8231: =item * &cacheheader()
1.112 bowersj2 8232:
8233: returns cache-controlling header code
8234:
8235: =cut
8236:
1.7 albertel 8237: sub cacheheader {
1.258 albertel 8238: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8239: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8240: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8241: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8242: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8243: return $output;
1.7 albertel 8244: }
8245:
1.112 bowersj2 8246: =pod
8247:
1.648 raeburn 8248: =item * &no_cache($r)
1.112 bowersj2 8249:
8250: specifies header code to not have cache
8251:
8252: =cut
8253:
1.9 albertel 8254: sub no_cache {
1.216 albertel 8255: my ($r) = @_;
8256: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8257: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8258: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8259: $r->no_cache(1);
8260: $r->header_out("Expires" => $date);
8261: $r->header_out("Pragma" => "no-cache");
1.123 www 8262: }
8263:
8264: sub content_type {
1.181 albertel 8265: my ($r,$type,$charset) = @_;
1.299 foxr 8266: if ($r) {
8267: # Note that printout.pl calls this with undef for $r.
8268: &no_cache($r);
8269: }
1.258 albertel 8270: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8271: unless ($charset) {
8272: $charset=&Apache::lonlocal::current_encoding;
8273: }
8274: if ($charset) { $type.='; charset='.$charset; }
8275: if ($r) {
8276: $r->content_type($type);
8277: } else {
8278: print("Content-type: $type\n\n");
8279: }
1.9 albertel 8280: }
1.25 albertel 8281:
1.112 bowersj2 8282: =pod
8283:
1.648 raeburn 8284: =item * &add_to_env($name,$value)
1.112 bowersj2 8285:
1.258 albertel 8286: adds $name to the %env hash with value
1.112 bowersj2 8287: $value, if $name already exists, the entry is converted to an array
8288: reference and $value is added to the array.
8289:
8290: =cut
8291:
1.25 albertel 8292: sub add_to_env {
8293: my ($name,$value)=@_;
1.258 albertel 8294: if (defined($env{$name})) {
8295: if (ref($env{$name})) {
1.25 albertel 8296: #already have multiple values
1.258 albertel 8297: push(@{ $env{$name} },$value);
1.25 albertel 8298: } else {
8299: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8300: my $first=$env{$name};
8301: undef($env{$name});
8302: push(@{ $env{$name} },$first,$value);
1.25 albertel 8303: }
8304: } else {
1.258 albertel 8305: $env{$name}=$value;
1.25 albertel 8306: }
1.31 albertel 8307: }
1.149 albertel 8308:
8309: =pod
8310:
1.648 raeburn 8311: =item * &get_env_multiple($name)
1.149 albertel 8312:
1.258 albertel 8313: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8314: values may be defined and end up as an array ref.
8315:
8316: returns an array of values
8317:
8318: =cut
8319:
8320: sub get_env_multiple {
8321: my ($name) = @_;
8322: my @values;
1.258 albertel 8323: if (defined($env{$name})) {
1.149 albertel 8324: # exists is it an array
1.258 albertel 8325: if (ref($env{$name})) {
8326: @values=@{ $env{$name} };
1.149 albertel 8327: } else {
1.258 albertel 8328: $values[0]=$env{$name};
1.149 albertel 8329: }
8330: }
8331: return(@values);
8332: }
8333:
1.660 raeburn 8334: sub ask_for_embedded_content {
8335: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8336: my $upload_output = '
8337: <form name="upload_embedded" action="'.$actionurl.'"
8338: method="post" enctype="multipart/form-data">';
8339: $upload_output .= $state;
1.661 raeburn 8340: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8341:
8342: my $num = 0;
8343: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8344: $upload_output .= &start_data_table_row().
8345: '<td>'.$embed_file.'</td><td>';
8346: if ($args->{'ignore_remote_references'}
8347: && $embed_file =~ m{^\w+://}) {
8348: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8349: } elsif ($args->{'error_on_invalid_names'}
8350: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8351:
8352: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8353:
8354: } else {
8355: $upload_output .='
1.661 raeburn 8356: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8357: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8358: my $attrib = join(':',@{$$allfiles{$embed_file}});
8359: $upload_output .=
8360: "\n\t\t".
8361: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8362: $attrib.'" />';
8363: if (exists($$codebase{$embed_file})) {
8364: $upload_output .=
8365: "\n\t\t".
8366: '<input name="codebase_'.$num.'" type="hidden" value="'.
8367: &escape($$codebase{$embed_file}).'" />';
8368: }
8369: }
8370: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8371: $num++;
8372: }
8373: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8374: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8375: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8376: '.&mt('(only files for which a location has been provided will be uploaded)').'
8377: </form>';
8378: return $upload_output;
8379: }
8380:
1.661 raeburn 8381: sub upload_embedded {
8382: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8383: $current_disk_usage) = @_;
8384: my $output;
8385: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8386: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8387: my $orig_uploaded_filename =
8388: $env{'form.embedded_item_'.$i.'.filename'};
8389:
8390: $env{'form.embedded_orig_'.$i} =
8391: &unescape($env{'form.embedded_orig_'.$i});
8392: my ($path,$fname) =
8393: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8394: # no path, whole string is fname
8395: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8396:
8397: $path = $env{'form.currentpath'}.$path;
8398: $fname = &Apache::lonnet::clean_filename($fname);
8399: # See if there is anything left
8400: next if ($fname eq '');
8401:
8402: # Check if file already exists as a file or directory.
8403: my ($state,$msg);
8404: if ($context eq 'portfolio') {
8405: my $port_path = $dirpath;
8406: if ($group ne '') {
8407: $port_path = "groups/$group/$port_path";
8408: }
8409: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8410: $dir_root,$port_path,$disk_quota,
8411: $current_disk_usage,$uname,$udom);
8412: if ($state eq 'will_exceed_quota'
8413: || $state eq 'file_locked'
8414: || $state eq 'file_exists' ) {
8415: $output .= $msg;
8416: next;
8417: }
8418: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8419: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8420: if ($state eq 'exists') {
8421: $output .= $msg;
8422: next;
8423: }
8424: }
8425: # Check if extension is valid
8426: if (($fname =~ /\.(\w+)$/) &&
8427: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8428: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8429: next;
8430: } elsif (($fname =~ /\.(\w+)$/) &&
8431: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8432: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8433: next;
8434: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8435: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8436: next;
8437: }
8438:
8439: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8440: if ($context eq 'portfolio') {
8441: my $result=
8442: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8443: $dirpath.$path);
8444: if ($result !~ m|^/uploaded/|) {
8445: $output .= '<span class="LC_error">'
8446: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8447: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8448: .'</span><br />';
8449: next;
8450: } else {
8451: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8452: $path.$fname.'</span>').'</p>';
8453: }
8454: } else {
8455: # Save the file
8456: my $target = $env{'form.embedded_item_'.$i};
8457: my $fullpath = $dir_root.$dirpath.'/'.$path;
8458: my $dest = $fullpath.$fname;
8459: my $url = $url_root.$dirpath.'/'.$path.$fname;
8460: my @parts=split(/\//,$fullpath);
8461: my $count;
8462: my $filepath = $dir_root;
8463: for ($count=4;$count<=$#parts;$count++) {
8464: $filepath .= "/$parts[$count]";
8465: if ((-e $filepath)!=1) {
8466: mkdir($filepath,0770);
8467: }
8468: }
8469: my $fh;
8470: if (!open($fh,'>'.$dest)) {
8471: &Apache::lonnet::logthis('Failed to create '.$dest);
8472: $output .= '<span class="LC_error">'.
8473: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8474: '</span><br />';
8475: } else {
8476: if (!print $fh $env{'form.embedded_item_'.$i}) {
8477: &Apache::lonnet::logthis('Failed to write to '.$dest);
8478: $output .= '<span class="LC_error">'.
8479: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8480: '</span><br />';
8481: } else {
8482: if ($context eq 'testbank') {
8483: $output .= &mt('Embedded file uploaded successfully:').
8484: ' <a href="'.$url.'">'.
8485: $orig_uploaded_filename.'</a><br />';
8486: } else {
1.705 tempelho 8487: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8488: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8489: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8490: }
8491: }
8492: close($fh);
8493: }
8494: }
8495: }
8496: return $output;
8497: }
8498:
8499: sub check_for_existing {
8500: my ($path,$fname,$element) = @_;
8501: my ($state,$msg);
8502: if (-d $path.'/'.$fname) {
8503: $state = 'exists';
8504: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8505: } elsif (-e $path.'/'.$fname) {
8506: $state = 'exists';
8507: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8508: }
8509: if ($state eq 'exists') {
8510: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8511: }
8512: return ($state,$msg);
8513: }
8514:
8515: sub check_for_upload {
8516: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8517: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8518: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8519: my $getpropath = 1;
8520: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8521: $getpropath);
8522: my $found_file = 0;
8523: my $locked_file = 0;
8524: foreach my $line (@dir_list) {
8525: my ($file_name)=split(/\&/,$line,2);
8526: if ($file_name eq $fname){
8527: $file_name = $path.$file_name;
8528: if ($group ne '') {
8529: $file_name = $group.$file_name;
8530: }
8531: $found_file = 1;
8532: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8533: $locked_file = 1;
8534: }
8535: }
8536: }
8537: if (($current_disk_usage + $filesize) > $disk_quota){
8538: my $msg = '<span class="LC_error">'.
8539: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8540: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8541: return ('will_exceed_quota',$msg);
8542: } elsif ($found_file) {
8543: if ($locked_file) {
8544: my $msg = '<span class="LC_error">';
8545: $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>');
8546: $msg .= '</span><br />';
8547: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8548: return ('file_locked',$msg);
8549: } else {
8550: my $msg = '<span class="LC_error">';
8551: $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'});
8552: $msg .= '</span>';
8553: $msg .= '<br />';
8554: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8555: return ('file_exists',$msg);
8556: }
8557: }
8558: }
8559:
1.31 albertel 8560:
1.41 ng 8561: =pod
1.45 matthew 8562:
1.464 albertel 8563: =back
1.41 ng 8564:
1.112 bowersj2 8565: =head1 CSV Upload/Handling functions
1.38 albertel 8566:
1.41 ng 8567: =over 4
8568:
1.648 raeburn 8569: =item * &upfile_store($r)
1.41 ng 8570:
8571: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8572: needs $env{'form.upfile'}
1.41 ng 8573: returns $datatoken to be put into hidden field
8574:
8575: =cut
1.31 albertel 8576:
8577: sub upfile_store {
8578: my $r=shift;
1.258 albertel 8579: $env{'form.upfile'}=~s/\r/\n/gs;
8580: $env{'form.upfile'}=~s/\f/\n/gs;
8581: $env{'form.upfile'}=~s/\n+/\n/gs;
8582: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8583:
1.258 albertel 8584: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8585: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8586: {
1.158 raeburn 8587: my $datafile = $r->dir_config('lonDaemons').
8588: '/tmp/'.$datatoken.'.tmp';
8589: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8590: print $fh $env{'form.upfile'};
1.158 raeburn 8591: close($fh);
8592: }
1.31 albertel 8593: }
8594: return $datatoken;
8595: }
8596:
1.56 matthew 8597: =pod
8598:
1.648 raeburn 8599: =item * &load_tmp_file($r)
1.41 ng 8600:
8601: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8602: needs $env{'form.datatoken'},
8603: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8604:
8605: =cut
1.31 albertel 8606:
8607: sub load_tmp_file {
8608: my $r=shift;
8609: my @studentdata=();
8610: {
1.158 raeburn 8611: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8612: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8613: if ( open(my $fh,"<$studentfile") ) {
8614: @studentdata=<$fh>;
8615: close($fh);
8616: }
1.31 albertel 8617: }
1.258 albertel 8618: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8619: }
8620:
1.56 matthew 8621: =pod
8622:
1.648 raeburn 8623: =item * &upfile_record_sep()
1.41 ng 8624:
8625: Separate uploaded file into records
8626: returns array of records,
1.258 albertel 8627: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8628:
8629: =cut
1.31 albertel 8630:
8631: sub upfile_record_sep {
1.258 albertel 8632: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8633: } else {
1.248 albertel 8634: my @records;
1.258 albertel 8635: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8636: if ($line=~/^\s*$/) { next; }
8637: push(@records,$line);
8638: }
8639: return @records;
1.31 albertel 8640: }
8641: }
8642:
1.56 matthew 8643: =pod
8644:
1.648 raeburn 8645: =item * &record_sep($record)
1.41 ng 8646:
1.258 albertel 8647: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8648:
8649: =cut
8650:
1.263 www 8651: sub takeleft {
8652: my $index=shift;
8653: return substr('0000'.$index,-4,4);
8654: }
8655:
1.31 albertel 8656: sub record_sep {
8657: my $record=shift;
8658: my %components=();
1.258 albertel 8659: if ($env{'form.upfiletype'} eq 'xml') {
8660: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8661: my $i=0;
1.356 albertel 8662: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8663: $field=~s/^(\"|\')//;
8664: $field=~s/(\"|\')$//;
1.263 www 8665: $components{&takeleft($i)}=$field;
1.31 albertel 8666: $i++;
8667: }
1.258 albertel 8668: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8669: my $i=0;
1.356 albertel 8670: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8671: $field=~s/^(\"|\')//;
8672: $field=~s/(\"|\')$//;
1.263 www 8673: $components{&takeleft($i)}=$field;
1.31 albertel 8674: $i++;
8675: }
8676: } else {
1.561 www 8677: my $separator=',';
1.480 banghart 8678: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8679: $separator=';';
1.480 banghart 8680: }
1.31 albertel 8681: my $i=0;
1.561 www 8682: # the character we are looking for to indicate the end of a quote or a record
8683: my $looking_for=$separator;
8684: # do not add the characters to the fields
8685: my $ignore=0;
8686: # we just encountered a separator (or the beginning of the record)
8687: my $just_found_separator=1;
8688: # store the field we are working on here
8689: my $field='';
8690: # work our way through all characters in record
8691: foreach my $character ($record=~/(.)/g) {
8692: if ($character eq $looking_for) {
8693: if ($character ne $separator) {
8694: # Found the end of a quote, again looking for separator
8695: $looking_for=$separator;
8696: $ignore=1;
8697: } else {
8698: # Found a separator, store away what we got
8699: $components{&takeleft($i)}=$field;
8700: $i++;
8701: $just_found_separator=1;
8702: $ignore=0;
8703: $field='';
8704: }
8705: next;
8706: }
8707: # single or double quotation marks after a separator indicate beginning of a quote
8708: # we are now looking for the end of the quote and need to ignore separators
8709: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8710: $looking_for=$character;
8711: next;
8712: }
8713: # ignore would be true after we reached the end of a quote
8714: if ($ignore) { next; }
8715: if (($just_found_separator) && ($character=~/\s/)) { next; }
8716: $field.=$character;
8717: $just_found_separator=0;
1.31 albertel 8718: }
1.561 www 8719: # catch the very last entry, since we never encountered the separator
8720: $components{&takeleft($i)}=$field;
1.31 albertel 8721: }
8722: return %components;
8723: }
8724:
1.144 matthew 8725: ######################################################
8726: ######################################################
8727:
1.56 matthew 8728: =pod
8729:
1.648 raeburn 8730: =item * &upfile_select_html()
1.41 ng 8731:
1.144 matthew 8732: Return HTML code to select a file from the users machine and specify
8733: the file type.
1.41 ng 8734:
8735: =cut
8736:
1.144 matthew 8737: ######################################################
8738: ######################################################
1.31 albertel 8739: sub upfile_select_html {
1.144 matthew 8740: my %Types = (
8741: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8742: semisv => &mt('Semicolon separated values'),
1.144 matthew 8743: space => &mt('Space separated'),
8744: tab => &mt('Tabulator separated'),
8745: # xml => &mt('HTML/XML'),
8746: );
8747: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8748: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8749: foreach my $type (sort(keys(%Types))) {
8750: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8751: }
8752: $Str .= "</select>\n";
8753: return $Str;
1.31 albertel 8754: }
8755:
1.301 albertel 8756: sub get_samples {
8757: my ($records,$toget) = @_;
8758: my @samples=({});
8759: my $got=0;
8760: foreach my $rec (@$records) {
8761: my %temp = &record_sep($rec);
8762: if (! grep(/\S/, values(%temp))) { next; }
8763: if (%temp) {
8764: $samples[$got]=\%temp;
8765: $got++;
8766: if ($got == $toget) { last; }
8767: }
8768: }
8769: return \@samples;
8770: }
8771:
1.144 matthew 8772: ######################################################
8773: ######################################################
8774:
1.56 matthew 8775: =pod
8776:
1.648 raeburn 8777: =item * &csv_print_samples($r,$records)
1.41 ng 8778:
8779: Prints a table of sample values from each column uploaded $r is an
8780: Apache Request ref, $records is an arrayref from
8781: &Apache::loncommon::upfile_record_sep
8782:
8783: =cut
8784:
1.144 matthew 8785: ######################################################
8786: ######################################################
1.31 albertel 8787: sub csv_print_samples {
8788: my ($r,$records) = @_;
1.662 bisitz 8789: my $samples = &get_samples($records,5);
1.301 albertel 8790:
1.594 raeburn 8791: $r->print(&mt('Samples').'<br />'.&start_data_table().
8792: &start_data_table_header_row());
1.356 albertel 8793: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 8794: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8795: $r->print(&end_data_table_header_row());
1.301 albertel 8796: foreach my $hash (@$samples) {
1.594 raeburn 8797: $r->print(&start_data_table_row());
1.356 albertel 8798: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8799: $r->print('<td>');
1.356 albertel 8800: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8801: $r->print('</td>');
8802: }
1.594 raeburn 8803: $r->print(&end_data_table_row());
1.31 albertel 8804: }
1.594 raeburn 8805: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8806: }
8807:
1.144 matthew 8808: ######################################################
8809: ######################################################
8810:
1.56 matthew 8811: =pod
8812:
1.648 raeburn 8813: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8814:
8815: Prints a table to create associations between values and table columns.
1.144 matthew 8816:
1.41 ng 8817: $r is an Apache Request ref,
8818: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8819: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8820:
8821: =cut
8822:
1.144 matthew 8823: ######################################################
8824: ######################################################
1.31 albertel 8825: sub csv_print_select_table {
8826: my ($r,$records,$d) = @_;
1.301 albertel 8827: my $i=0;
8828: my $samples = &get_samples($records,1);
1.144 matthew 8829: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8830: &start_data_table().&start_data_table_header_row().
1.144 matthew 8831: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8832: '<th>'.&mt('Column').'</th>'.
8833: &end_data_table_header_row()."\n");
1.356 albertel 8834: foreach my $array_ref (@$d) {
8835: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8836: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8837:
1.875 bisitz 8838: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 8839: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8840: $r->print('<option value="none"></option>');
1.356 albertel 8841: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8842: $r->print('<option value="'.$sample.'"'.
8843: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8844: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8845: }
1.594 raeburn 8846: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8847: $i++;
8848: }
1.594 raeburn 8849: $r->print(&end_data_table());
1.31 albertel 8850: $i--;
8851: return $i;
8852: }
1.56 matthew 8853:
1.144 matthew 8854: ######################################################
8855: ######################################################
8856:
1.56 matthew 8857: =pod
1.31 albertel 8858:
1.648 raeburn 8859: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8860:
8861: Prints a table of sample values from the upload and can make associate samples to internal names.
8862:
8863: $r is an Apache Request ref,
8864: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8865: $d is an array of 2 element arrays (internal name, displayed name)
8866:
8867: =cut
8868:
1.144 matthew 8869: ######################################################
8870: ######################################################
1.31 albertel 8871: sub csv_samples_select_table {
8872: my ($r,$records,$d) = @_;
8873: my $i=0;
1.144 matthew 8874: #
1.662 bisitz 8875: my $max_samples = 5;
8876: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8877: $r->print(&start_data_table().
8878: &start_data_table_header_row().'<th>'.
8879: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8880: &end_data_table_header_row());
1.301 albertel 8881:
8882: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8883: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8884: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8885: foreach my $option (@$d) {
8886: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8887: $r->print('<option value="'.$value.'"'.
1.253 albertel 8888: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8889: $display.'</option>');
1.31 albertel 8890: }
8891: $r->print('</select></td><td>');
1.662 bisitz 8892: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8893: if (defined($samples->[$line]{$key})) {
8894: $r->print($samples->[$line]{$key}."<br />\n");
8895: }
8896: }
1.594 raeburn 8897: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8898: $i++;
8899: }
1.594 raeburn 8900: $r->print(&end_data_table());
1.31 albertel 8901: $i--;
8902: return($i);
1.115 matthew 8903: }
8904:
1.144 matthew 8905: ######################################################
8906: ######################################################
8907:
1.115 matthew 8908: =pod
8909:
1.648 raeburn 8910: =item * &clean_excel_name($name)
1.115 matthew 8911:
8912: Returns a replacement for $name which does not contain any illegal characters.
8913:
8914: =cut
8915:
1.144 matthew 8916: ######################################################
8917: ######################################################
1.115 matthew 8918: sub clean_excel_name {
8919: my ($name) = @_;
8920: $name =~ s/[:\*\?\/\\]//g;
8921: if (length($name) > 31) {
8922: $name = substr($name,0,31);
8923: }
8924: return $name;
1.25 albertel 8925: }
1.84 albertel 8926:
1.85 albertel 8927: =pod
8928:
1.648 raeburn 8929: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8930:
8931: Returns either 1 or undef
8932:
8933: 1 if the part is to be hidden, undef if it is to be shown
8934:
8935: Arguments are:
8936:
8937: $id the id of the part to be checked
8938: $symb, optional the symb of the resource to check
8939: $udom, optional the domain of the user to check for
8940: $uname, optional the username of the user to check for
8941:
8942: =cut
1.84 albertel 8943:
8944: sub check_if_partid_hidden {
8945: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8946: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8947: $symb,$udom,$uname);
1.141 albertel 8948: my $truth=1;
8949: #if the string starts with !, then the list is the list to show not hide
8950: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8951: my @hiddenlist=split(/,/,$hiddenparts);
8952: foreach my $checkid (@hiddenlist) {
1.141 albertel 8953: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8954: }
1.141 albertel 8955: return !$truth;
1.84 albertel 8956: }
1.127 matthew 8957:
1.138 matthew 8958:
8959: ############################################################
8960: ############################################################
8961:
8962: =pod
8963:
1.157 matthew 8964: =back
8965:
1.138 matthew 8966: =head1 cgi-bin script and graphing routines
8967:
1.157 matthew 8968: =over 4
8969:
1.648 raeburn 8970: =item * &get_cgi_id()
1.138 matthew 8971:
8972: Inputs: none
8973:
8974: Returns an id which can be used to pass environment variables
8975: to various cgi-bin scripts. These environment variables will
8976: be removed from the users environment after a given time by
8977: the routine &Apache::lonnet::transfer_profile_to_env.
8978:
8979: =cut
8980:
8981: ############################################################
8982: ############################################################
1.152 albertel 8983: my $uniq=0;
1.136 matthew 8984: sub get_cgi_id {
1.154 albertel 8985: $uniq=($uniq+1)%100000;
1.280 albertel 8986: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8987: }
8988:
1.127 matthew 8989: ############################################################
8990: ############################################################
8991:
8992: =pod
8993:
1.648 raeburn 8994: =item * &DrawBarGraph()
1.127 matthew 8995:
1.138 matthew 8996: Facilitates the plotting of data in a (stacked) bar graph.
8997: Puts plot definition data into the users environment in order for
8998: graph.png to plot it. Returns an <img> tag for the plot.
8999: The bars on the plot are labeled '1','2',...,'n'.
9000:
9001: Inputs:
9002:
9003: =over 4
9004:
9005: =item $Title: string, the title of the plot
9006:
9007: =item $xlabel: string, text describing the X-axis of the plot
9008:
9009: =item $ylabel: string, text describing the Y-axis of the plot
9010:
9011: =item $Max: scalar, the maximum Y value to use in the plot
9012: If $Max is < any data point, the graph will not be rendered.
9013:
1.140 matthew 9014: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 9015: they are plotted. If undefined, default values will be used.
9016:
1.178 matthew 9017: =item $labels: array ref holding the labels to use on the x-axis for the bars.
9018:
1.138 matthew 9019: =item @Values: An array of array references. Each array reference holds data
9020: to be plotted in a stacked bar chart.
9021:
1.239 matthew 9022: =item If the final element of @Values is a hash reference the key/value
9023: pairs will be added to the graph definition.
9024:
1.138 matthew 9025: =back
9026:
9027: Returns:
9028:
9029: An <img> tag which references graph.png and the appropriate identifying
9030: information for the plot.
9031:
1.127 matthew 9032: =cut
9033:
9034: ############################################################
9035: ############################################################
1.134 matthew 9036: sub DrawBarGraph {
1.178 matthew 9037: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 9038: #
9039: if (! defined($colors)) {
9040: $colors = ['#33ff00',
9041: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9042: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9043: ];
9044: }
1.228 matthew 9045: my $extra_settings = {};
9046: if (ref($Values[-1]) eq 'HASH') {
9047: $extra_settings = pop(@Values);
9048: }
1.127 matthew 9049: #
1.136 matthew 9050: my $identifier = &get_cgi_id();
9051: my $id = 'cgi.'.$identifier;
1.129 matthew 9052: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 9053: return '';
9054: }
1.225 matthew 9055: #
9056: my @Labels;
9057: if (defined($labels)) {
9058: @Labels = @$labels;
9059: } else {
9060: for (my $i=0;$i<@{$Values[0]};$i++) {
9061: push (@Labels,$i+1);
9062: }
9063: }
9064: #
1.129 matthew 9065: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 9066: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 9067: my %ValuesHash;
9068: my $NumSets=1;
9069: foreach my $array (@Values) {
9070: next if (! ref($array));
1.136 matthew 9071: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 9072: join(',',@$array);
1.129 matthew 9073: }
1.127 matthew 9074: #
1.136 matthew 9075: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 9076: if ($NumBars < 3) {
9077: $width = 120+$NumBars*32;
1.220 matthew 9078: $xskip = 1;
1.225 matthew 9079: $bar_width = 30;
9080: } elsif ($NumBars < 5) {
9081: $width = 120+$NumBars*20;
9082: $xskip = 1;
9083: $bar_width = 20;
1.220 matthew 9084: } elsif ($NumBars < 10) {
1.136 matthew 9085: $width = 120+$NumBars*15;
9086: $xskip = 1;
9087: $bar_width = 15;
9088: } elsif ($NumBars <= 25) {
9089: $width = 120+$NumBars*11;
9090: $xskip = 5;
9091: $bar_width = 8;
9092: } elsif ($NumBars <= 50) {
9093: $width = 120+$NumBars*8;
9094: $xskip = 5;
9095: $bar_width = 4;
9096: } else {
9097: $width = 120+$NumBars*8;
9098: $xskip = 5;
9099: $bar_width = 4;
9100: }
9101: #
1.137 matthew 9102: $Max = 1 if ($Max < 1);
9103: if ( int($Max) < $Max ) {
9104: $Max++;
9105: $Max = int($Max);
9106: }
1.127 matthew 9107: $Title = '' if (! defined($Title));
9108: $xlabel = '' if (! defined($xlabel));
9109: $ylabel = '' if (! defined($ylabel));
1.369 www 9110: $ValuesHash{$id.'.title'} = &escape($Title);
9111: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9112: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 9113: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 9114: $ValuesHash{$id.'.NumBars'} = $NumBars;
9115: $ValuesHash{$id.'.NumSets'} = $NumSets;
9116: $ValuesHash{$id.'.PlotType'} = 'bar';
9117: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9118: $ValuesHash{$id.'.height'} = $height;
9119: $ValuesHash{$id.'.width'} = $width;
9120: $ValuesHash{$id.'.xskip'} = $xskip;
9121: $ValuesHash{$id.'.bar_width'} = $bar_width;
9122: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 9123: #
1.228 matthew 9124: # Deal with other parameters
9125: while (my ($key,$value) = each(%$extra_settings)) {
9126: $ValuesHash{$id.'.'.$key} = $value;
9127: }
9128: #
1.646 raeburn 9129: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 9130: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9131: }
9132:
9133: ############################################################
9134: ############################################################
9135:
9136: =pod
9137:
1.648 raeburn 9138: =item * &DrawXYGraph()
1.137 matthew 9139:
1.138 matthew 9140: Facilitates the plotting of data in an XY graph.
9141: Puts plot definition data into the users environment in order for
9142: graph.png to plot it. Returns an <img> tag for the plot.
9143:
9144: Inputs:
9145:
9146: =over 4
9147:
9148: =item $Title: string, the title of the plot
9149:
9150: =item $xlabel: string, text describing the X-axis of the plot
9151:
9152: =item $ylabel: string, text describing the Y-axis of the plot
9153:
9154: =item $Max: scalar, the maximum Y value to use in the plot
9155: If $Max is < any data point, the graph will not be rendered.
9156:
9157: =item $colors: Array ref containing the hex color codes for the data to be
9158: plotted in. If undefined, default values will be used.
9159:
9160: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9161:
9162: =item $Ydata: Array ref containing Array refs.
1.185 www 9163: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 9164:
9165: =item %Values: hash indicating or overriding any default values which are
9166: passed to graph.png.
9167: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9168:
9169: =back
9170:
9171: Returns:
9172:
9173: An <img> tag which references graph.png and the appropriate identifying
9174: information for the plot.
9175:
1.137 matthew 9176: =cut
9177:
9178: ############################################################
9179: ############################################################
9180: sub DrawXYGraph {
9181: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9182: #
9183: # Create the identifier for the graph
9184: my $identifier = &get_cgi_id();
9185: my $id = 'cgi.'.$identifier;
9186: #
9187: $Title = '' if (! defined($Title));
9188: $xlabel = '' if (! defined($xlabel));
9189: $ylabel = '' if (! defined($ylabel));
9190: my %ValuesHash =
9191: (
1.369 www 9192: $id.'.title' => &escape($Title),
9193: $id.'.xlabel' => &escape($xlabel),
9194: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 9195: $id.'.y_max_value'=> $Max,
9196: $id.'.labels' => join(',',@$Xlabels),
9197: $id.'.PlotType' => 'XY',
9198: );
9199: #
9200: if (defined($colors) && ref($colors) eq 'ARRAY') {
9201: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9202: }
9203: #
9204: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9205: return '';
9206: }
9207: my $NumSets=1;
1.138 matthew 9208: foreach my $array (@{$Ydata}){
1.137 matthew 9209: next if (! ref($array));
9210: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9211: }
1.138 matthew 9212: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 9213: #
9214: # Deal with other parameters
9215: while (my ($key,$value) = each(%Values)) {
9216: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 9217: }
9218: #
1.646 raeburn 9219: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 9220: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9221: }
9222:
9223: ############################################################
9224: ############################################################
9225:
9226: =pod
9227:
1.648 raeburn 9228: =item * &DrawXYYGraph()
1.138 matthew 9229:
9230: Facilitates the plotting of data in an XY graph with two Y axes.
9231: Puts plot definition data into the users environment in order for
9232: graph.png to plot it. Returns an <img> tag for the plot.
9233:
9234: Inputs:
9235:
9236: =over 4
9237:
9238: =item $Title: string, the title of the plot
9239:
9240: =item $xlabel: string, text describing the X-axis of the plot
9241:
9242: =item $ylabel: string, text describing the Y-axis of the plot
9243:
9244: =item $colors: Array ref containing the hex color codes for the data to be
9245: plotted in. If undefined, default values will be used.
9246:
9247: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9248:
9249: =item $Ydata1: The first data set
9250:
9251: =item $Min1: The minimum value of the left Y-axis
9252:
9253: =item $Max1: The maximum value of the left Y-axis
9254:
9255: =item $Ydata2: The second data set
9256:
9257: =item $Min2: The minimum value of the right Y-axis
9258:
9259: =item $Max2: The maximum value of the left Y-axis
9260:
9261: =item %Values: hash indicating or overriding any default values which are
9262: passed to graph.png.
9263: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9264:
9265: =back
9266:
9267: Returns:
9268:
9269: An <img> tag which references graph.png and the appropriate identifying
9270: information for the plot.
1.136 matthew 9271:
9272: =cut
9273:
9274: ############################################################
9275: ############################################################
1.137 matthew 9276: sub DrawXYYGraph {
9277: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9278: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9279: #
9280: # Create the identifier for the graph
9281: my $identifier = &get_cgi_id();
9282: my $id = 'cgi.'.$identifier;
9283: #
9284: $Title = '' if (! defined($Title));
9285: $xlabel = '' if (! defined($xlabel));
9286: $ylabel = '' if (! defined($ylabel));
9287: my %ValuesHash =
9288: (
1.369 www 9289: $id.'.title' => &escape($Title),
9290: $id.'.xlabel' => &escape($xlabel),
9291: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9292: $id.'.labels' => join(',',@$Xlabels),
9293: $id.'.PlotType' => 'XY',
9294: $id.'.NumSets' => 2,
1.137 matthew 9295: $id.'.two_axes' => 1,
9296: $id.'.y1_max_value' => $Max1,
9297: $id.'.y1_min_value' => $Min1,
9298: $id.'.y2_max_value' => $Max2,
9299: $id.'.y2_min_value' => $Min2,
1.136 matthew 9300: );
9301: #
1.137 matthew 9302: if (defined($colors) && ref($colors) eq 'ARRAY') {
9303: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9304: }
9305: #
9306: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9307: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9308: return '';
9309: }
9310: my $NumSets=1;
1.137 matthew 9311: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9312: next if (! ref($array));
9313: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9314: }
9315: #
9316: # Deal with other parameters
9317: while (my ($key,$value) = each(%Values)) {
9318: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9319: }
9320: #
1.646 raeburn 9321: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9322: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9323: }
9324:
9325: ############################################################
9326: ############################################################
9327:
9328: =pod
9329:
1.157 matthew 9330: =back
9331:
1.139 matthew 9332: =head1 Statistics helper routines?
9333:
9334: Bad place for them but what the hell.
9335:
1.157 matthew 9336: =over 4
9337:
1.648 raeburn 9338: =item * &chartlink()
1.139 matthew 9339:
9340: Returns a link to the chart for a specific student.
9341:
9342: Inputs:
9343:
9344: =over 4
9345:
9346: =item $linktext: The text of the link
9347:
9348: =item $sname: The students username
9349:
9350: =item $sdomain: The students domain
9351:
9352: =back
9353:
1.157 matthew 9354: =back
9355:
1.139 matthew 9356: =cut
9357:
9358: ############################################################
9359: ############################################################
9360: sub chartlink {
9361: my ($linktext, $sname, $sdomain) = @_;
9362: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9363: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9364: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9365: '">'.$linktext.'</a>';
1.153 matthew 9366: }
9367:
9368: #######################################################
9369: #######################################################
9370:
9371: =pod
9372:
9373: =head1 Course Environment Routines
1.157 matthew 9374:
9375: =over 4
1.153 matthew 9376:
1.648 raeburn 9377: =item * &restore_course_settings()
1.153 matthew 9378:
1.648 raeburn 9379: =item * &store_course_settings()
1.153 matthew 9380:
9381: Restores/Store indicated form parameters from the course environment.
9382: Will not overwrite existing values of the form parameters.
9383:
9384: Inputs:
9385: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9386:
9387: a hash ref describing the data to be stored. For example:
9388:
9389: %Save_Parameters = ('Status' => 'scalar',
9390: 'chartoutputmode' => 'scalar',
9391: 'chartoutputdata' => 'scalar',
9392: 'Section' => 'array',
1.373 raeburn 9393: 'Group' => 'array',
1.153 matthew 9394: 'StudentData' => 'array',
9395: 'Maps' => 'array');
9396:
9397: Returns: both routines return nothing
9398:
1.631 raeburn 9399: =back
9400:
1.153 matthew 9401: =cut
9402:
9403: #######################################################
9404: #######################################################
9405: sub store_course_settings {
1.496 albertel 9406: return &store_settings($env{'request.course.id'},@_);
9407: }
9408:
9409: sub store_settings {
1.153 matthew 9410: # save to the environment
9411: # appenv the same items, just to be safe
1.300 albertel 9412: my $udom = $env{'user.domain'};
9413: my $uname = $env{'user.name'};
1.496 albertel 9414: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9415: my %SaveHash;
9416: my %AppHash;
9417: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9418: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9419: my $envname = 'environment.'.$basename;
1.258 albertel 9420: if (exists($env{'form.'.$setting})) {
1.153 matthew 9421: # Save this value away
9422: if ($type eq 'scalar' &&
1.258 albertel 9423: (! exists($env{$envname}) ||
9424: $env{$envname} ne $env{'form.'.$setting})) {
9425: $SaveHash{$basename} = $env{'form.'.$setting};
9426: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9427: } elsif ($type eq 'array') {
9428: my $stored_form;
1.258 albertel 9429: if (ref($env{'form.'.$setting})) {
1.153 matthew 9430: $stored_form = join(',',
9431: map {
1.369 www 9432: &escape($_);
1.258 albertel 9433: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9434: } else {
9435: $stored_form =
1.369 www 9436: &escape($env{'form.'.$setting});
1.153 matthew 9437: }
9438: # Determine if the array contents are the same.
1.258 albertel 9439: if ($stored_form ne $env{$envname}) {
1.153 matthew 9440: $SaveHash{$basename} = $stored_form;
9441: $AppHash{$envname} = $stored_form;
9442: }
9443: }
9444: }
9445: }
9446: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9447: $udom,$uname);
1.153 matthew 9448: if ($put_result !~ /^(ok|delayed)/) {
9449: &Apache::lonnet::logthis('unable to save form parameters, '.
9450: 'got error:'.$put_result);
9451: }
9452: # Make sure these settings stick around in this session, too
1.646 raeburn 9453: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9454: return;
9455: }
9456:
9457: sub restore_course_settings {
1.499 albertel 9458: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9459: }
9460:
9461: sub restore_settings {
9462: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9463: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9464: next if (exists($env{'form.'.$setting}));
1.496 albertel 9465: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9466: '.'.$setting;
1.258 albertel 9467: if (exists($env{$envname})) {
1.153 matthew 9468: if ($type eq 'scalar') {
1.258 albertel 9469: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9470: } elsif ($type eq 'array') {
1.258 albertel 9471: $env{'form.'.$setting} = [
1.153 matthew 9472: map {
1.369 www 9473: &unescape($_);
1.258 albertel 9474: } split(',',$env{$envname})
1.153 matthew 9475: ];
9476: }
9477: }
9478: }
1.127 matthew 9479: }
9480:
1.618 raeburn 9481: #######################################################
9482: #######################################################
9483:
9484: =pod
9485:
9486: =head1 Domain E-mail Routines
9487:
9488: =over 4
9489:
1.648 raeburn 9490: =item * &build_recipient_list()
1.618 raeburn 9491:
1.884 raeburn 9492: Build recipient lists for five types of e-mail:
1.766 raeburn 9493: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884 raeburn 9494: (d) Help requests, (e) Course requests needing approval, generated by
9495: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9496: loncoursequeueadmin.pm respectively.
1.618 raeburn 9497:
9498: Inputs:
1.619 raeburn 9499: defmail (scalar - email address of default recipient),
1.618 raeburn 9500: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9501: defdom (domain for which to retrieve configuration settings),
9502: origmail (scalar - email address of recipient from loncapa.conf,
9503: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9504:
1.655 raeburn 9505: Returns: comma separated list of addresses to which to send e-mail.
9506:
9507: =back
1.618 raeburn 9508:
9509: =cut
9510:
9511: ############################################################
9512: ############################################################
9513: sub build_recipient_list {
1.619 raeburn 9514: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9515: my @recipients;
9516: my $otheremails;
9517: my %domconfig =
9518: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9519: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9520: if (exists($domconfig{'contacts'}{$mailing})) {
9521: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9522: my @contacts = ('adminemail','supportemail');
9523: foreach my $item (@contacts) {
9524: if ($domconfig{'contacts'}{$mailing}{$item}) {
9525: my $addr = $domconfig{'contacts'}{$item};
9526: if (!grep(/^\Q$addr\E$/,@recipients)) {
9527: push(@recipients,$addr);
9528: }
1.619 raeburn 9529: }
1.766 raeburn 9530: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9531: }
9532: }
1.766 raeburn 9533: } elsif ($origmail ne '') {
9534: push(@recipients,$origmail);
1.618 raeburn 9535: }
1.619 raeburn 9536: } elsif ($origmail ne '') {
9537: push(@recipients,$origmail);
1.618 raeburn 9538: }
1.688 raeburn 9539: if (defined($defmail)) {
9540: if ($defmail ne '') {
9541: push(@recipients,$defmail);
9542: }
1.618 raeburn 9543: }
9544: if ($otheremails) {
1.619 raeburn 9545: my @others;
9546: if ($otheremails =~ /,/) {
9547: @others = split(/,/,$otheremails);
1.618 raeburn 9548: } else {
1.619 raeburn 9549: push(@others,$otheremails);
9550: }
9551: foreach my $addr (@others) {
9552: if (!grep(/^\Q$addr\E$/,@recipients)) {
9553: push(@recipients,$addr);
9554: }
1.618 raeburn 9555: }
9556: }
1.619 raeburn 9557: my $recipientlist = join(',',@recipients);
1.618 raeburn 9558: return $recipientlist;
9559: }
9560:
1.127 matthew 9561: ############################################################
9562: ############################################################
1.154 albertel 9563:
1.655 raeburn 9564: =pod
9565:
9566: =head1 Course Catalog Routines
9567:
9568: =over 4
9569:
9570: =item * &gather_categories()
9571:
9572: Converts category definitions - keys of categories hash stored in
9573: coursecategories in configuration.db on the primary library server in a
9574: domain - to an array. Also generates javascript and idx hash used to
9575: generate Domain Coordinator interface for editing Course Categories.
9576:
9577: Inputs:
1.663 raeburn 9578:
1.655 raeburn 9579: categories (reference to hash of category definitions).
1.663 raeburn 9580:
1.655 raeburn 9581: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9582: categories and subcategories).
1.663 raeburn 9583:
1.655 raeburn 9584: idx (reference to hash of counters used in Domain Coordinator interface for
9585: editing Course Categories).
1.663 raeburn 9586:
1.655 raeburn 9587: jsarray (reference to array of categories used to create Javascript arrays for
9588: Domain Coordinator interface for editing Course Categories).
9589:
9590: Returns: nothing
9591:
9592: Side effects: populates cats, idx and jsarray.
9593:
9594: =cut
9595:
9596: sub gather_categories {
9597: my ($categories,$cats,$idx,$jsarray) = @_;
9598: my %counters;
9599: my $num = 0;
9600: foreach my $item (keys(%{$categories})) {
9601: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9602: if ($container eq '' && $depth == 0) {
9603: $cats->[$depth][$categories->{$item}] = $cat;
9604: } else {
9605: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9606: }
9607: my ($escitem,$tail) = split(/:/,$item,2);
9608: if ($counters{$tail} eq '') {
9609: $counters{$tail} = $num;
9610: $num ++;
9611: }
9612: if (ref($idx) eq 'HASH') {
9613: $idx->{$item} = $counters{$tail};
9614: }
9615: if (ref($jsarray) eq 'ARRAY') {
9616: push(@{$jsarray->[$counters{$tail}]},$item);
9617: }
9618: }
9619: return;
9620: }
9621:
9622: =pod
9623:
9624: =item * &extract_categories()
9625:
9626: Used to generate breadcrumb trails for course categories.
9627:
9628: Inputs:
1.663 raeburn 9629:
1.655 raeburn 9630: categories (reference to hash of category definitions).
1.663 raeburn 9631:
1.655 raeburn 9632: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9633: categories and subcategories).
1.663 raeburn 9634:
1.655 raeburn 9635: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9636:
1.655 raeburn 9637: allitems (reference to hash - key is category key
9638: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9639:
1.655 raeburn 9640: idx (reference to hash of counters used in Domain Coordinator interface for
9641: editing Course Categories).
1.663 raeburn 9642:
1.655 raeburn 9643: jsarray (reference to array of categories used to create Javascript arrays for
9644: Domain Coordinator interface for editing Course Categories).
9645:
1.665 raeburn 9646: subcats (reference to hash of arrays containing all subcategories within each
9647: category, -recursive)
9648:
1.655 raeburn 9649: Returns: nothing
9650:
9651: Side effects: populates trails and allitems hash references.
9652:
9653: =cut
9654:
9655: sub extract_categories {
1.665 raeburn 9656: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9657: if (ref($categories) eq 'HASH') {
9658: &gather_categories($categories,$cats,$idx,$jsarray);
9659: if (ref($cats->[0]) eq 'ARRAY') {
9660: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9661: my $name = $cats->[0][$i];
9662: my $item = &escape($name).'::0';
9663: my $trailstr;
9664: if ($name eq 'instcode') {
9665: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 9666: } elsif ($name eq 'communities') {
9667: $trailstr = &mt('Communities');
1.655 raeburn 9668: } else {
9669: $trailstr = $name;
9670: }
9671: if ($allitems->{$item} eq '') {
9672: push(@{$trails},$trailstr);
9673: $allitems->{$item} = scalar(@{$trails})-1;
9674: }
9675: my @parents = ($name);
9676: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9677: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9678: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9679: if (ref($subcats) eq 'HASH') {
9680: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9681: }
9682: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9683: }
9684: } else {
9685: if (ref($subcats) eq 'HASH') {
9686: $subcats->{$item} = [];
1.655 raeburn 9687: }
9688: }
9689: }
9690: }
9691: }
9692: return;
9693: }
9694:
9695: =pod
9696:
9697: =item *&recurse_categories()
9698:
9699: Recursively used to generate breadcrumb trails for course categories.
9700:
9701: Inputs:
1.663 raeburn 9702:
1.655 raeburn 9703: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9704: categories and subcategories).
1.663 raeburn 9705:
1.655 raeburn 9706: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9707:
9708: category (current course category, for which breadcrumb trail is being generated).
9709:
9710: trails (reference to array of breadcrumb trails for each category).
9711:
1.655 raeburn 9712: allitems (reference to hash - key is category key
9713: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9714:
1.655 raeburn 9715: parents (array containing containers directories for current category,
9716: back to top level).
9717:
9718: Returns: nothing
9719:
9720: Side effects: populates trails and allitems hash references
9721:
9722: =cut
9723:
9724: sub recurse_categories {
1.665 raeburn 9725: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9726: my $shallower = $depth - 1;
9727: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9728: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9729: my $name = $cats->[$depth]{$category}[$k];
9730: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9731: my $trailstr = join(' -> ',(@{$parents},$category));
9732: if ($allitems->{$item} eq '') {
9733: push(@{$trails},$trailstr);
9734: $allitems->{$item} = scalar(@{$trails})-1;
9735: }
9736: my $deeper = $depth+1;
9737: push(@{$parents},$category);
1.665 raeburn 9738: if (ref($subcats) eq 'HASH') {
9739: my $subcat = &escape($name).':'.$category.':'.$depth;
9740: for (my $j=@{$parents}; $j>=0; $j--) {
9741: my $higher;
9742: if ($j > 0) {
9743: $higher = &escape($parents->[$j]).':'.
9744: &escape($parents->[$j-1]).':'.$j;
9745: } else {
9746: $higher = &escape($parents->[$j]).'::'.$j;
9747: }
9748: push(@{$subcats->{$higher}},$subcat);
9749: }
9750: }
9751: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9752: $subcats);
1.655 raeburn 9753: pop(@{$parents});
9754: }
9755: } else {
9756: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9757: my $trailstr = join(' -> ',(@{$parents},$category));
9758: if ($allitems->{$item} eq '') {
9759: push(@{$trails},$trailstr);
9760: $allitems->{$item} = scalar(@{$trails})-1;
9761: }
9762: }
9763: return;
9764: }
9765:
1.663 raeburn 9766: =pod
9767:
9768: =item *&assign_categories_table()
9769:
9770: Create a datatable for display of hierarchical categories in a domain,
9771: with checkboxes to allow a course to be categorized.
9772:
9773: Inputs:
9774:
9775: cathash - reference to hash of categories defined for the domain (from
9776: configuration.db)
9777:
9778: currcat - scalar with an & separated list of categories assigned to a course.
9779:
1.919 raeburn 9780: type - scalar contains course type (Course or Community).
9781:
1.663 raeburn 9782: Returns: $output (markup to be displayed)
9783:
9784: =cut
9785:
9786: sub assign_categories_table {
1.919 raeburn 9787: my ($cathash,$currcat,$type) = @_;
1.663 raeburn 9788: my $output;
9789: if (ref($cathash) eq 'HASH') {
9790: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9791: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9792: $maxdepth = scalar(@cats);
9793: if (@cats > 0) {
9794: my $itemcount = 0;
9795: if (ref($cats[0]) eq 'ARRAY') {
9796: my @currcategories;
9797: if ($currcat ne '') {
9798: @currcategories = split('&',$currcat);
9799: }
1.919 raeburn 9800: my $table;
1.663 raeburn 9801: for (my $i=0; $i<@{$cats[0]}; $i++) {
9802: my $parent = $cats[0][$i];
1.919 raeburn 9803: next if ($parent eq 'instcode');
9804: if ($type eq 'Community') {
9805: next unless ($parent eq 'communities');
9806: } else {
9807: next if ($parent eq 'communities');
9808: }
1.663 raeburn 9809: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9810: my $item = &escape($parent).'::0';
9811: my $checked = '';
9812: if (@currcategories > 0) {
9813: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9814: $checked = ' checked="checked"';
1.663 raeburn 9815: }
9816: }
1.919 raeburn 9817: my $parent_title = $parent;
9818: if ($parent eq 'communities') {
9819: $parent_title = &mt('Communities');
9820: }
9821: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9822: '<input type="checkbox" name="usecategory" value="'.
9823: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9824: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9825: my $depth = 1;
9826: push(@path,$parent);
1.919 raeburn 9827: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663 raeburn 9828: pop(@path);
1.919 raeburn 9829: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 9830: $itemcount ++;
9831: }
1.919 raeburn 9832: if ($itemcount) {
9833: $output = &Apache::loncommon::start_data_table().
9834: $table.
9835: &Apache::loncommon::end_data_table();
9836: }
1.663 raeburn 9837: }
9838: }
9839: }
9840: return $output;
9841: }
9842:
9843: =pod
9844:
9845: =item *&assign_category_rows()
9846:
9847: Create a datatable row for display of nested categories in a domain,
9848: with checkboxes to allow a course to be categorized,called recursively.
9849:
9850: Inputs:
9851:
9852: itemcount - track row number for alternating colors
9853:
9854: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9855: categories and subcategories.
9856:
9857: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9858:
9859: parent - parent of current category item
9860:
9861: path - Array containing all categories back up through the hierarchy from the
9862: current category to the top level.
9863:
9864: currcategories - reference to array of current categories assigned to the course
9865:
9866: Returns: $output (markup to be displayed).
9867:
9868: =cut
9869:
9870: sub assign_category_rows {
9871: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9872: my ($text,$name,$item,$chgstr);
9873: if (ref($cats) eq 'ARRAY') {
9874: my $maxdepth = scalar(@{$cats});
9875: if (ref($cats->[$depth]) eq 'HASH') {
9876: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9877: my $numchildren = @{$cats->[$depth]{$parent}};
9878: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9879: $text .= '<td><table class="LC_datatable">';
9880: for (my $j=0; $j<$numchildren; $j++) {
9881: $name = $cats->[$depth]{$parent}[$j];
9882: $item = &escape($name).':'.&escape($parent).':'.$depth;
9883: my $deeper = $depth+1;
9884: my $checked = '';
9885: if (ref($currcategories) eq 'ARRAY') {
9886: if (@{$currcategories} > 0) {
9887: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9888: $checked = ' checked="checked"';
1.663 raeburn 9889: }
9890: }
9891: }
1.664 raeburn 9892: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9893: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9894: $item.'"'.$checked.' />'.$name.'</label></span>'.
9895: '<input type="hidden" name="catname" value="'.$name.'" />'.
9896: '</td><td>';
1.663 raeburn 9897: if (ref($path) eq 'ARRAY') {
9898: push(@{$path},$name);
9899: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9900: pop(@{$path});
9901: }
9902: $text .= '</td></tr>';
9903: }
9904: $text .= '</table></td>';
9905: }
9906: }
9907: }
9908: return $text;
9909: }
9910:
1.655 raeburn 9911: ############################################################
9912: ############################################################
9913:
9914:
1.443 albertel 9915: sub commit_customrole {
1.664 raeburn 9916: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9917: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9918: ($start?', '.&mt('starting').' '.localtime($start):'').
9919: ($end?', ending '.localtime($end):'').': <b>'.
9920: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9921: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9922: '</b><br />';
9923: return $output;
9924: }
9925:
9926: sub commit_standardrole {
1.541 raeburn 9927: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9928: my ($output,$logmsg,$linefeed);
9929: if ($context eq 'auto') {
9930: $linefeed = "\n";
9931: } else {
9932: $linefeed = "<br />\n";
9933: }
1.443 albertel 9934: if ($three eq 'st') {
1.541 raeburn 9935: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9936: $one,$two,$sec,$context);
9937: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9938: ($result eq 'unknown_course') || ($result eq 'refused')) {
9939: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9940: } else {
1.541 raeburn 9941: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9942: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9943: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9944: if ($context eq 'auto') {
9945: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9946: } else {
9947: $output .= '<b>'.$result.'</b>'.$linefeed.
9948: &mt('Add to classlist').': <b>ok</b>';
9949: }
9950: $output .= $linefeed;
1.443 albertel 9951: }
9952: } else {
9953: $output = &mt('Assigning').' '.$three.' in '.$url.
9954: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9955: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9956: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9957: if ($context eq 'auto') {
9958: $output .= $result.$linefeed;
9959: } else {
9960: $output .= '<b>'.$result.'</b>'.$linefeed;
9961: }
1.443 albertel 9962: }
9963: return $output;
9964: }
9965:
9966: sub commit_studentrole {
1.541 raeburn 9967: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9968: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9969: if ($context eq 'auto') {
9970: $linefeed = "\n";
9971: } else {
9972: $linefeed = '<br />'."\n";
9973: }
1.443 albertel 9974: if (defined($one) && defined($two)) {
9975: my $cid=$one.'_'.$two;
9976: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9977: my $secchange = 0;
9978: my $expire_role_result;
9979: my $modify_section_result;
1.628 raeburn 9980: if ($oldsec ne '-1') {
9981: if ($oldsec ne $sec) {
1.443 albertel 9982: $secchange = 1;
1.628 raeburn 9983: my $now = time;
1.443 albertel 9984: my $uurl='/'.$cid;
9985: $uurl=~s/\_/\//g;
9986: if ($oldsec) {
9987: $uurl.='/'.$oldsec;
9988: }
1.626 raeburn 9989: $oldsecurl = $uurl;
1.628 raeburn 9990: $expire_role_result =
1.652 raeburn 9991: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9992: if ($env{'request.course.sec'} ne '') {
9993: if ($expire_role_result eq 'refused') {
9994: my @roles = ('st');
9995: my @statuses = ('previous');
9996: my @roledoms = ($one);
9997: my $withsec = 1;
9998: my %roleshash =
9999: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
10000: \@statuses,\@roles,\@roledoms,$withsec);
10001: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
10002: my ($oldstart,$oldend) =
10003: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
10004: if ($oldend > 0 && $oldend <= $now) {
10005: $expire_role_result = 'ok';
10006: }
10007: }
10008: }
10009: }
1.443 albertel 10010: $result = $expire_role_result;
10011: }
10012: }
10013: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 10014: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 10015: if ($modify_section_result =~ /^ok/) {
10016: if ($secchange == 1) {
1.628 raeburn 10017: if ($sec eq '') {
10018: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
10019: } else {
10020: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
10021: }
1.443 albertel 10022: } elsif ($oldsec eq '-1') {
1.628 raeburn 10023: if ($sec eq '') {
10024: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
10025: } else {
10026: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10027: }
1.443 albertel 10028: } else {
1.628 raeburn 10029: if ($sec eq '') {
10030: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10031: } else {
10032: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10033: }
1.443 albertel 10034: }
10035: } else {
1.628 raeburn 10036: if ($secchange) {
10037: $$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;
10038: } else {
10039: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10040: }
1.443 albertel 10041: }
10042: $result = $modify_section_result;
10043: } elsif ($secchange == 1) {
1.628 raeburn 10044: if ($oldsec eq '') {
10045: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10046: } else {
10047: $$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;
10048: }
1.626 raeburn 10049: if ($expire_role_result eq 'refused') {
10050: my $newsecurl = '/'.$cid;
10051: $newsecurl =~ s/\_/\//g;
10052: if ($sec ne '') {
10053: $newsecurl.='/'.$sec;
10054: }
10055: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10056: if ($sec eq '') {
10057: $$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;
10058: } else {
10059: $$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;
10060: }
10061: }
10062: }
1.443 albertel 10063: }
10064: } else {
1.626 raeburn 10065: $$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 10066: $result = "error: incomplete course id\n";
10067: }
10068: return $result;
10069: }
10070:
10071: ############################################################
10072: ############################################################
10073:
1.566 albertel 10074: sub check_clone {
1.578 raeburn 10075: my ($args,$linefeed) = @_;
1.566 albertel 10076: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10077: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10078: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10079: my $clonemsg;
10080: my $can_clone = 0;
1.944 raeburn 10081: my $lctype = lc($args->{'crstype'});
1.908 raeburn 10082: if ($lctype ne 'community') {
10083: $lctype = 'course';
10084: }
1.566 albertel 10085: if ($clonehome eq 'no_host') {
1.944 raeburn 10086: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10087: $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'});
10088: } else {
10089: $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'});
10090: }
1.566 albertel 10091: } else {
10092: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 10093: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10094: if ($clonedesc{'type'} ne 'Community') {
10095: $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'});
10096: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10097: }
10098: }
1.882 raeburn 10099: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10100: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 10101: $can_clone = 1;
10102: } else {
10103: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10104: $args->{'clonedomain'},$args->{'clonecourse'});
10105: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 10106: if (grep(/^\*$/,@cloners)) {
10107: $can_clone = 1;
10108: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10109: $can_clone = 1;
10110: } else {
1.908 raeburn 10111: my $ccrole = 'cc';
1.944 raeburn 10112: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10113: $ccrole = 'co';
10114: }
1.578 raeburn 10115: my %roleshash =
10116: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10117: $args->{'ccdomain'},
1.908 raeburn 10118: 'userroles',['active'],[$ccrole],
1.578 raeburn 10119: [$args->{'clonedomain'}]);
1.908 raeburn 10120: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942 raeburn 10121: $can_clone = 1;
10122: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
10123: $can_clone = 1;
10124: } else {
1.944 raeburn 10125: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 10126: $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'});
10127: } else {
10128: $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'});
10129: }
1.578 raeburn 10130: }
1.566 albertel 10131: }
1.578 raeburn 10132: }
1.566 albertel 10133: }
10134: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10135: }
10136:
1.444 albertel 10137: sub construct_course {
1.885 raeburn 10138: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444 albertel 10139: my $outcome;
1.541 raeburn 10140: my $linefeed = '<br />'."\n";
10141: if ($context eq 'auto') {
10142: $linefeed = "\n";
10143: }
1.566 albertel 10144:
10145: #
10146: # Are we cloning?
10147: #
10148: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10149: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 10150: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 10151: if ($context ne 'auto') {
1.578 raeburn 10152: if ($clonemsg ne '') {
10153: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10154: }
1.566 albertel 10155: }
10156: $outcome .= $clonemsg.$linefeed;
10157:
10158: if (!$can_clone) {
10159: return (0,$outcome);
10160: }
10161: }
10162:
1.444 albertel 10163: #
10164: # Open course
10165: #
10166: my $crstype = lc($args->{'crstype'});
10167: my %cenv=();
10168: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10169: $args->{'cdescr'},
10170: $args->{'curl'},
10171: $args->{'course_home'},
10172: $args->{'nonstandard'},
10173: $args->{'crscode'},
10174: $args->{'ccuname'}.':'.
10175: $args->{'ccdomain'},
1.882 raeburn 10176: $args->{'crstype'},
1.885 raeburn 10177: $cnum,$context,$category);
1.444 albertel 10178:
10179: # Note: The testing routines depend on this being output; see
10180: # Utils::Course. This needs to at least be output as a comment
10181: # if anyone ever decides to not show this, and Utils::Course::new
10182: # will need to be suitably modified.
1.541 raeburn 10183: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 10184: if ($$courseid =~ /^error:/) {
10185: return (0,$outcome);
10186: }
10187:
1.444 albertel 10188: #
10189: # Check if created correctly
10190: #
1.479 albertel 10191: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 10192: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 10193: if ($crsuhome eq 'no_host') {
10194: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
10195: return (0,$outcome);
10196: }
1.541 raeburn 10197: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 10198:
1.444 albertel 10199: #
1.566 albertel 10200: # Do the cloning
10201: #
10202: if ($can_clone && $cloneid) {
10203: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10204: if ($context ne 'auto') {
10205: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10206: }
10207: $outcome .= $clonemsg.$linefeed;
10208: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 10209: # Copy all files
1.637 www 10210: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 10211: # Restore URL
1.566 albertel 10212: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 10213: # Restore title
1.566 albertel 10214: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 10215: # Mark as cloned
1.566 albertel 10216: $cenv{'clonedfrom'}=$cloneid;
1.638 www 10217: # Need to clone grading mode
10218: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10219: $cenv{'grading'}=$newenv{'grading'};
10220: # Do not clone these environment entries
10221: &Apache::lonnet::del('environment',
10222: ['default_enrollment_start_date',
10223: 'default_enrollment_end_date',
10224: 'question.email',
10225: 'policy.email',
10226: 'comment.email',
10227: 'pch.users.denied',
1.725 raeburn 10228: 'plc.users.denied',
10229: 'hidefromcat',
10230: 'categories'],
1.638 www 10231: $$crsudom,$$crsunum);
1.444 albertel 10232: }
1.566 albertel 10233:
1.444 albertel 10234: #
10235: # Set environment (will override cloned, if existing)
10236: #
10237: my @sections = ();
10238: my @xlists = ();
10239: if ($args->{'crstype'}) {
10240: $cenv{'type'}=$args->{'crstype'};
10241: }
10242: if ($args->{'crsid'}) {
10243: $cenv{'courseid'}=$args->{'crsid'};
10244: }
10245: if ($args->{'crscode'}) {
10246: $cenv{'internal.coursecode'}=$args->{'crscode'};
10247: }
10248: if ($args->{'crsquota'} ne '') {
10249: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10250: } else {
10251: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10252: }
10253: if ($args->{'ccuname'}) {
10254: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10255: ':'.$args->{'ccdomain'};
10256: } else {
10257: $cenv{'internal.courseowner'} = $args->{'curruser'};
10258: }
10259: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10260: if ($args->{'crssections'}) {
10261: $cenv{'internal.sectionnums'} = '';
10262: if ($args->{'crssections'} =~ m/,/) {
10263: @sections = split/,/,$args->{'crssections'};
10264: } else {
10265: $sections[0] = $args->{'crssections'};
10266: }
10267: if (@sections > 0) {
10268: foreach my $item (@sections) {
10269: my ($sec,$gp) = split/:/,$item;
10270: my $class = $args->{'crscode'}.$sec;
10271: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10272: $cenv{'internal.sectionnums'} .= $item.',';
10273: unless ($addcheck eq 'ok') {
10274: push @badclasses, $class;
10275: }
10276: }
10277: $cenv{'internal.sectionnums'} =~ s/,$//;
10278: }
10279: }
10280: # do not hide course coordinator from staff listing,
10281: # even if privileged
10282: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10283: # add crosslistings
10284: if ($args->{'crsxlist'}) {
10285: $cenv{'internal.crosslistings'}='';
10286: if ($args->{'crsxlist'} =~ m/,/) {
10287: @xlists = split/,/,$args->{'crsxlist'};
10288: } else {
10289: $xlists[0] = $args->{'crsxlist'};
10290: }
10291: if (@xlists > 0) {
10292: foreach my $item (@xlists) {
10293: my ($xl,$gp) = split/:/,$item;
10294: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10295: $cenv{'internal.crosslistings'} .= $item.',';
10296: unless ($addcheck eq 'ok') {
10297: push @badclasses, $xl;
10298: }
10299: }
10300: $cenv{'internal.crosslistings'} =~ s/,$//;
10301: }
10302: }
10303: if ($args->{'autoadds'}) {
10304: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10305: }
10306: if ($args->{'autodrops'}) {
10307: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10308: }
10309: # check for notification of enrollment changes
10310: my @notified = ();
10311: if ($args->{'notify_owner'}) {
10312: if ($args->{'ccuname'} ne '') {
10313: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10314: }
10315: }
10316: if ($args->{'notify_dc'}) {
10317: if ($uname ne '') {
1.630 raeburn 10318: push(@notified,$uname.':'.$udom);
1.444 albertel 10319: }
10320: }
10321: if (@notified > 0) {
10322: my $notifylist;
10323: if (@notified > 1) {
10324: $notifylist = join(',',@notified);
10325: } else {
10326: $notifylist = $notified[0];
10327: }
10328: $cenv{'internal.notifylist'} = $notifylist;
10329: }
10330: if (@badclasses > 0) {
10331: my %lt=&Apache::lonlocal::texthash(
10332: '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',
10333: 'dnhr' => 'does not have rights to access enrollment in these classes',
10334: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10335: );
1.541 raeburn 10336: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10337: ' ('.$lt{'adby'}.')';
10338: if ($context eq 'auto') {
10339: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10340: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10341: foreach my $item (@badclasses) {
10342: if ($context eq 'auto') {
10343: $outcome .= " - $item\n";
10344: } else {
10345: $outcome .= "<li>$item</li>\n";
10346: }
10347: }
10348: if ($context eq 'auto') {
10349: $outcome .= $linefeed;
10350: } else {
1.566 albertel 10351: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10352: }
10353: }
1.444 albertel 10354: }
10355: if ($args->{'no_end_date'}) {
10356: $args->{'endaccess'} = 0;
10357: }
10358: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10359: $cenv{'internal.autoend'}=$args->{'enrollend'};
10360: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10361: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10362: if ($args->{'showphotos'}) {
10363: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10364: }
10365: $cenv{'internal.authtype'} = $args->{'authtype'};
10366: $cenv{'internal.autharg'} = $args->{'autharg'};
10367: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10368: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10369: 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');
10370: if ($context eq 'auto') {
10371: $outcome .= $krb_msg;
10372: } else {
1.566 albertel 10373: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10374: }
10375: $outcome .= $linefeed;
1.444 albertel 10376: }
10377: }
10378: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10379: if ($args->{'setpolicy'}) {
10380: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10381: }
10382: if ($args->{'setcontent'}) {
10383: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10384: }
10385: }
10386: if ($args->{'reshome'}) {
10387: $cenv{'reshome'}=$args->{'reshome'}.'/';
10388: $cenv{'reshome'}=~s/\/+$/\//;
10389: }
10390: #
10391: # course has keyed access
10392: #
10393: if ($args->{'setkeys'}) {
10394: $cenv{'keyaccess'}='yes';
10395: }
10396: # if specified, key authority is not course, but user
10397: # only active if keyaccess is yes
10398: if ($args->{'keyauth'}) {
1.487 albertel 10399: my ($user,$domain) = split(':',$args->{'keyauth'});
10400: $user = &LONCAPA::clean_username($user);
10401: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10402: if ($user ne '' && $domain ne '') {
1.487 albertel 10403: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10404: }
10405: }
10406:
10407: if ($args->{'disresdis'}) {
10408: $cenv{'pch.roles.denied'}='st';
10409: }
10410: if ($args->{'disablechat'}) {
10411: $cenv{'plc.roles.denied'}='st';
10412: }
10413:
10414: # Record we've not yet viewed the Course Initialization Helper for this
10415: # course
10416: $cenv{'course.helper.not.run'} = 1;
10417: #
10418: # Use new Randomseed
10419: #
10420: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10421: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10422: #
10423: # The encryption code and receipt prefix for this course
10424: #
10425: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10426: $cenv{'internal.encpref'}=100+int(9*rand(99));
10427: #
10428: # By default, use standard grading
10429: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10430:
1.541 raeburn 10431: $outcome .= $linefeed.&mt('Setting environment').': '.
10432: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10433: #
10434: # Open all assignments
10435: #
10436: if ($args->{'openall'}) {
10437: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10438: my %storecontent = ($storeunder => time,
10439: $storeunder.'.type' => 'date_start');
10440:
10441: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10442: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10443: }
10444: #
10445: # Set first page
10446: #
10447: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10448: || ($cloneid)) {
1.445 albertel 10449: use LONCAPA::map;
1.444 albertel 10450: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10451:
10452: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10453: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10454:
1.444 albertel 10455: $outcome .= ($fatal?$errtext:'read ok').' - ';
10456: my $title; my $url;
10457: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10458: $title=&mt('Syllabus');
1.444 albertel 10459: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10460: } else {
1.690 bisitz 10461: $title=&mt('Navigate Contents');
1.444 albertel 10462: $url='/adm/navmaps';
10463: }
1.445 albertel 10464:
10465: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10466: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10467:
10468: if ($errtext) { $fatal=2; }
1.541 raeburn 10469: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10470: }
1.566 albertel 10471:
10472: return (1,$outcome);
1.444 albertel 10473: }
10474:
10475: ############################################################
10476: ############################################################
10477:
1.378 raeburn 10478: sub course_type {
10479: my ($cid) = @_;
10480: if (!defined($cid)) {
10481: $cid = $env{'request.course.id'};
10482: }
1.404 albertel 10483: if (defined($env{'course.'.$cid.'.type'})) {
10484: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10485: } else {
10486: return 'Course';
1.377 raeburn 10487: }
10488: }
1.156 albertel 10489:
1.406 raeburn 10490: sub group_term {
10491: my $crstype = &course_type();
10492: my %names = (
10493: 'Course' => 'group',
1.865 raeburn 10494: 'Community' => 'group',
1.406 raeburn 10495: );
10496: return $names{$crstype};
10497: }
10498:
1.902 raeburn 10499: sub course_types {
10500: my @types = ('official','unofficial','community');
10501: my %typename = (
10502: official => 'Official course',
10503: unofficial => 'Unofficial course',
10504: community => 'Community',
10505: );
10506: return (\@types,\%typename);
10507: }
10508:
1.156 albertel 10509: sub icon {
10510: my ($file)=@_;
1.505 albertel 10511: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10512: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10513: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10514: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10515: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10516: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10517: $curfext.".gif") {
10518: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10519: $curfext.".gif";
10520: }
10521: }
1.249 albertel 10522: return &lonhttpdurl($iconname);
1.154 albertel 10523: }
1.84 albertel 10524:
1.575 albertel 10525: sub lonhttpdurl {
1.692 www 10526: #
10527: # Had been used for "small fry" static images on separate port 8080.
10528: # Modify here if lightweight http functionality desired again.
10529: # Currently eliminated due to increasing firewall issues.
10530: #
1.575 albertel 10531: my ($url)=@_;
1.692 www 10532: return $url;
1.215 albertel 10533: }
10534:
1.213 albertel 10535: sub connection_aborted {
10536: my ($r)=@_;
10537: $r->print(" ");$r->rflush();
10538: my $c = $r->connection;
10539: return $c->aborted();
10540: }
10541:
1.221 foxr 10542: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10543: # strings as 'strings'.
10544: sub escape_single {
1.221 foxr 10545: my ($input) = @_;
1.223 albertel 10546: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10547: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10548: return $input;
10549: }
1.223 albertel 10550:
1.222 foxr 10551: # Same as escape_single, but escape's "'s This
10552: # can be used for "strings"
10553: sub escape_double {
10554: my ($input) = @_;
10555: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10556: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10557: return $input;
10558: }
1.223 albertel 10559:
1.222 foxr 10560: # Escapes the last element of a full URL.
10561: sub escape_url {
10562: my ($url) = @_;
1.238 raeburn 10563: my @urlslices = split(/\//, $url,-1);
1.369 www 10564: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10565: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10566: }
1.462 albertel 10567:
1.820 raeburn 10568: sub compare_arrays {
10569: my ($arrayref1,$arrayref2) = @_;
10570: my (@difference,%count);
10571: @difference = ();
10572: %count = ();
10573: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10574: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10575: foreach my $element (keys(%count)) {
10576: if ($count{$element} == 1) {
10577: push(@difference,$element);
10578: }
10579: }
10580: }
10581: return @difference;
10582: }
10583:
1.817 bisitz 10584: # -------------------------------------------------------- Initialize user login
1.462 albertel 10585: sub init_user_environment {
1.463 albertel 10586: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10587: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10588:
10589: my $public=($username eq 'public' && $domain eq 'public');
10590:
10591: # See if old ID present, if so, remove
10592:
10593: my ($filename,$cookie,$userroles);
10594: my $now=time;
10595:
10596: if ($public) {
10597: my $max_public=100;
10598: my $oldest;
10599: my $oldest_time=0;
10600: for(my $next=1;$next<=$max_public;$next++) {
10601: if (-e $lonids."/publicuser_$next.id") {
10602: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10603: if ($mtime<$oldest_time || !$oldest_time) {
10604: $oldest_time=$mtime;
10605: $oldest=$next;
10606: }
10607: } else {
10608: $cookie="publicuser_$next";
10609: last;
10610: }
10611: }
10612: if (!$cookie) { $cookie="publicuser_$oldest"; }
10613: } else {
1.463 albertel 10614: # if this isn't a robot, kill any existing non-robot sessions
10615: if (!$args->{'robot'}) {
10616: opendir(DIR,$lonids);
10617: while ($filename=readdir(DIR)) {
10618: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10619: unlink($lonids.'/'.$filename);
10620: }
1.462 albertel 10621: }
1.463 albertel 10622: closedir(DIR);
1.462 albertel 10623: }
10624: # Give them a new cookie
1.463 albertel 10625: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10626: : $now.$$.int(rand(10000)));
1.463 albertel 10627: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10628:
10629: # Initialize roles
10630:
10631: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10632: }
10633: # ------------------------------------ Check browser type and MathML capability
10634:
10635: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10636: $clientunicode,$clientos) = &decode_user_agent($r);
10637:
10638: # ------------------------------------------------------------- Get environment
10639:
10640: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10641: my ($tmp) = keys(%userenv);
10642: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10643: # default remote control to off
10644: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10645: } else {
10646: undef(%userenv);
10647: }
10648: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10649: $form->{'interface'}=$userenv{'interface'};
10650: }
10651: $env{'environment.remote'}=$userenv{'remote'};
10652: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10653:
10654: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10655: foreach my $option ('interface','localpath','localres') {
10656: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10657: }
10658: # --------------------------------------------------------- Write first profile
10659:
10660: {
10661: my %initial_env =
10662: ("user.name" => $username,
10663: "user.domain" => $domain,
10664: "user.home" => $authhost,
10665: "browser.type" => $clientbrowser,
10666: "browser.version" => $clientversion,
10667: "browser.mathml" => $clientmathml,
10668: "browser.unicode" => $clientunicode,
10669: "browser.os" => $clientos,
10670: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10671: "request.course.fn" => '',
10672: "request.course.uri" => '',
10673: "request.course.sec" => '',
10674: "request.role" => 'cm',
10675: "request.role.adv" => $env{'user.adv'},
10676: "request.host" => $ENV{'REMOTE_ADDR'},);
10677:
10678: if ($form->{'localpath'}) {
10679: $initial_env{"browser.localpath"} = $form->{'localpath'};
10680: $initial_env{"browser.localres"} = $form->{'localres'};
10681: }
10682:
10683: if ($public) {
10684: $initial_env{"environment.remote"} = "off";
10685: }
10686: if ($form->{'interface'}) {
10687: $form->{'interface'}=~s/\W//gs;
10688: $initial_env{"browser.interface"} = $form->{'interface'};
10689: $env{'browser.interface'}=$form->{'interface'};
10690: }
10691:
1.724 raeburn 10692: foreach my $tool ('aboutme','blog','portfolio') {
10693: $userenv{'availabletools.'.$tool} =
10694: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10695: }
10696:
1.864 raeburn 10697: foreach my $crstype ('official','unofficial','community') {
1.765 raeburn 10698: $userenv{'canrequest.'.$crstype} =
10699: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10700: 'reload','requestcourses');
10701: }
10702:
1.462 albertel 10703: $env{'user.environment'} = "$lonids/$cookie.id";
10704:
10705: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10706: &GDBM_WRCREAT(),0640)) {
10707: &_add_to_env(\%disk_env,\%initial_env);
10708: &_add_to_env(\%disk_env,\%userenv,'environment.');
10709: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10710: if (ref($args->{'extra_env'})) {
10711: &_add_to_env(\%disk_env,$args->{'extra_env'});
10712: }
1.462 albertel 10713: untie(%disk_env);
10714: } else {
1.705 tempelho 10715: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10716: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10717: return 'error: '.$!;
10718: }
10719: }
10720: $env{'request.role'}='cm';
10721: $env{'request.role.adv'}=$env{'user.adv'};
10722: $env{'browser.type'}=$clientbrowser;
10723:
10724: return $cookie;
10725:
10726: }
10727:
10728: sub _add_to_env {
10729: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10730: if (ref($env_data) eq 'HASH') {
10731: while (my ($key,$value) = each(%$env_data)) {
10732: $idf->{$prefix.$key} = $value;
10733: $env{$prefix.$key} = $value;
10734: }
1.462 albertel 10735: }
10736: }
10737:
1.685 tempelho 10738: # --- Get the symbolic name of a problem and the url
10739: sub get_symb {
10740: my ($request,$silent) = @_;
1.726 raeburn 10741: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10742: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10743: if ($symb eq '') {
10744: if (!$silent) {
10745: $request->print("Unable to handle ambiguous references:$url:.");
10746: return ();
10747: }
10748: }
10749: &Apache::lonenc::check_decrypt(\$symb);
10750: return ($symb);
10751: }
10752:
10753: # --------------------------------------------------------------Get annotation
10754:
10755: sub get_annotation {
10756: my ($symb,$enc) = @_;
10757:
10758: my $key = $symb;
10759: if (!$enc) {
10760: $key =
10761: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10762: }
10763: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10764: return $annotation{$key};
10765: }
10766:
10767: sub clean_symb {
1.731 raeburn 10768: my ($symb,$delete_enc) = @_;
1.685 tempelho 10769:
10770: &Apache::lonenc::check_decrypt(\$symb);
10771: my $enc = $env{'request.enc'};
1.731 raeburn 10772: if ($delete_enc) {
1.730 raeburn 10773: delete($env{'request.enc'});
10774: }
1.685 tempelho 10775:
10776: return ($symb,$enc);
10777: }
1.462 albertel 10778:
1.41 ng 10779: =pod
10780:
10781: =back
10782:
1.112 bowersj2 10783: =cut
1.41 ng 10784:
1.112 bowersj2 10785: 1;
10786: __END__;
1.41 ng 10787:
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