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