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