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