Annotation of loncom/interface/loncommon.pm, revision 1.828
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.828 ! bisitz 4: # $Id: loncommon.pm,v 1.827 2009/05/27 14:59:49 bisitz 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.468 raeburn 485: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 486: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 487: my $output = '
1.776 bisitz 488: <script type="text/javascript" language="JavaScript">
1.824 bisitz 489: // <![CDATA[
1.468 raeburn 490: var stdeditbrowser;'."\n";
491: $output .= <<"ENDSTDBRW";
1.377 raeburn 492: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 493: var url = '/adm/pickcourse?';
1.468 raeburn 494: var domainfilter = '';
495: var formid = getFormIdByName(formname);
496: if (formid > -1) {
497: var domid = getIndexByName(formid,udom);
498: if (domid > -1) {
499: if (document.forms[formid].elements[domid].type == 'select-one') {
500: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
501: }
502: if (document.forms[formid].elements[domid].type == 'hidden') {
503: domainfilter=document.forms[formid].elements[domid].value;
504: }
505: }
1.91 www 506: }
1.128 albertel 507: if (domainfilter != null) {
508: if (domainfilter != '') {
509: url += 'domainfilter='+domainfilter+'&';
510: }
511: }
1.91 www 512: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 513: '&cdomelement='+udom+
514: '&cnameelement='+desc;
1.468 raeburn 515: if (extra_element !=null && extra_element != '') {
1.594 raeburn 516: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 517: url += '&roleelement='+extra_element;
518: if (domainfilter == null || domainfilter == '') {
519: url += '&domainfilter='+extra_element;
520: }
1.234 raeburn 521: }
1.468 raeburn 522: else {
523: if (formname == 'portform') {
524: url += '&setroles='+extra_element;
1.800 raeburn 525: } else {
526: if (formname == 'rules') {
527: url += '&fixeddom='+extra_element;
528: }
1.468 raeburn 529: }
530: }
1.230 raeburn 531: }
1.293 raeburn 532: if (multflag !=null && multflag != '') {
533: url += '&multiple='+multflag;
534: }
1.377 raeburn 535: if (crstype == 'Course/Group') {
536: if (formname == 'cu') {
537: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
538: if (crstype == "") {
539: alert("$crs_or_grp_alert");
540: return;
541: }
542: }
543: }
544: if (crstype !=null && crstype != '') {
545: url += '&type='+crstype;
546: }
1.102 www 547: var title = 'Course_Browser';
1.91 www 548: var options = 'scrollbars=1,resizable=1,menubar=0';
549: options += ',width=700,height=600';
550: stdeditbrowser = open(url,title,options,'1');
551: stdeditbrowser.focus();
552: }
1.468 raeburn 553:
554: function getFormIdByName(formname) {
555: for (var i=0;i<document.forms.length;i++) {
556: if (document.forms[i].name == formname) {
557: return i;
558: }
559: }
560: return -1;
561: }
562:
563: function getIndexByName(formid,item) {
564: for (var i=0;i<document.forms[formid].elements.length;i++) {
565: if (document.forms[formid].elements[i].name == item) {
566: return i;
567: }
568: }
569: return -1;
570: }
1.91 www 571: ENDSTDBRW
1.468 raeburn 572: if ($sec_element ne '') {
573: $output .= &setsec_javascript($sec_element,$formname);
574: }
575: $output .= '
1.824 bisitz 576: // ]]>
1.468 raeburn 577: </script>';
578: return $output;
579: }
580:
581: sub setsec_javascript {
582: my ($sec_element,$formname) = @_;
583: my $setsections = qq|
584: function setSect(sectionlist) {
1.629 raeburn 585: var sectionsArray = new Array();
586: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
587: sectionsArray = sectionlist.split(",");
588: }
1.468 raeburn 589: var numSections = sectionsArray.length;
590: document.$formname.$sec_element.length = 0;
591: if (numSections == 0) {
592: document.$formname.$sec_element.multiple=false;
593: document.$formname.$sec_element.size=1;
594: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
595: } else {
596: if (numSections == 1) {
597: document.$formname.$sec_element.multiple=false;
598: document.$formname.$sec_element.size=1;
599: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
600: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
601: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
602: } else {
603: for (var i=0; i<numSections; i++) {
604: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
605: }
606: document.$formname.$sec_element.multiple=true
607: if (numSections < 3) {
608: document.$formname.$sec_element.size=numSections;
609: } else {
610: document.$formname.$sec_element.size=3;
611: }
612: document.$formname.$sec_element.options[0].selected = false
613: }
614: }
1.91 www 615: }
1.468 raeburn 616: |;
617: return $setsections;
618: }
619:
1.91 www 620:
621: sub selectcourse_link {
1.377 raeburn 622: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787 bisitz 623: return '<span class="LC_nobreak">'
624: ."<a href='"
625: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
626: .'","'.$udomele.'","'.$desc.'","'.$extra_element
627: .'","'.$multflag.'","'.$selecttype.'");'
628: ."'>".&mt('Select Course').'</a>'
629: .'</span>';
1.74 www 630: }
1.42 matthew 631:
1.653 raeburn 632: sub selectauthor_link {
633: my ($form,$udom)=@_;
634: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
635: &mt('Select Author').'</a>';
636: }
637:
1.273 raeburn 638: sub check_uncheck_jscript {
639: my $jscript = <<"ENDSCRT";
640: function checkAll(field) {
641: if (field.length > 0) {
642: for (i = 0; i < field.length; i++) {
643: field[i].checked = true ;
644: }
645: } else {
646: field.checked = true
647: }
648: }
649:
650: function uncheckAll(field) {
651: if (field.length > 0) {
652: for (i = 0; i < field.length; i++) {
653: field[i].checked = false ;
1.543 albertel 654: }
655: } else {
1.273 raeburn 656: field.checked = false ;
657: }
658: }
659: ENDSCRT
660: return $jscript;
661: }
662:
1.656 www 663: sub select_timezone {
1.659 raeburn 664: my ($name,$selected,$onchange,$includeempty)=@_;
665: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
666: if ($includeempty) {
667: $output .= '<option value=""';
668: if (($selected eq '') || ($selected eq 'local')) {
669: $output .= ' selected="selected" ';
670: }
671: $output .= '> </option>';
672: }
1.657 raeburn 673: my @timezones = DateTime::TimeZone->all_names;
674: foreach my $tzone (@timezones) {
675: $output.= '<option value="'.$tzone.'"';
676: if ($tzone eq $selected) {
677: $output.=' selected="selected"';
678: }
679: $output.=">$tzone</option>\n";
1.656 www 680: }
681: $output.="</select>";
682: return $output;
683: }
1.273 raeburn 684:
1.687 raeburn 685: sub select_datelocale {
686: my ($name,$selected,$onchange,$includeempty)=@_;
687: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
688: if ($includeempty) {
689: $output .= '<option value=""';
690: if ($selected eq '') {
691: $output .= ' selected="selected" ';
692: }
693: $output .= '> </option>';
694: }
695: my (@possibles,%locale_names);
696: my @locales = DateTime::Locale::Catalog::Locales;
697: foreach my $locale (@locales) {
698: if (ref($locale) eq 'HASH') {
699: my $id = $locale->{'id'};
700: if ($id ne '') {
701: my $en_terr = $locale->{'en_territory'};
702: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 703: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 704: if (grep(/^en$/,@languages) || !@languages) {
705: if ($en_terr ne '') {
706: $locale_names{$id} = '('.$en_terr.')';
707: } elsif ($native_terr ne '') {
708: $locale_names{$id} = $native_terr;
709: }
710: } else {
711: if ($native_terr ne '') {
712: $locale_names{$id} = $native_terr.' ';
713: } elsif ($en_terr ne '') {
714: $locale_names{$id} = '('.$en_terr.')';
715: }
716: }
717: push (@possibles,$id);
718: }
719: }
720: }
721: foreach my $item (sort(@possibles)) {
722: $output.= '<option value="'.$item.'"';
723: if ($item eq $selected) {
724: $output.=' selected="selected"';
725: }
726: $output.=">$item";
727: if ($locale_names{$item} ne '') {
728: $output.=" $locale_names{$item}</option>\n";
729: }
730: $output.="</option>\n";
731: }
732: $output.="</select>";
733: return $output;
734: }
735:
1.792 raeburn 736: sub select_language {
737: my ($name,$selected,$includeempty) = @_;
738: my %langchoices;
739: if ($includeempty) {
740: %langchoices = ('' => 'No language preference');
741: }
742: foreach my $id (&languageids()) {
743: my $code = &supportedlanguagecode($id);
744: if ($code) {
745: $langchoices{$code} = &plainlanguagedescription($id);
746: }
747: }
748: return &select_form($selected,$name,%langchoices);
749: }
750:
1.42 matthew 751: =pod
1.36 matthew 752:
1.648 raeburn 753: =item * &linked_select_forms(...)
1.36 matthew 754:
755: linked_select_forms returns a string containing a <script></script> block
756: and html for two <select> menus. The select menus will be linked in that
757: changing the value of the first menu will result in new values being placed
758: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 759: order unless a defined order is provided.
1.36 matthew 760:
761: linked_select_forms takes the following ordered inputs:
762:
763: =over 4
764:
1.112 bowersj2 765: =item * $formname, the name of the <form> tag
1.36 matthew 766:
1.112 bowersj2 767: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 768:
1.112 bowersj2 769: =item * $firstdefault, the default value for the first menu
1.36 matthew 770:
1.112 bowersj2 771: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 772:
1.112 bowersj2 773: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 774:
1.112 bowersj2 775: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 776:
1.609 raeburn 777: =item * $menuorder, the order of values in the first menu
778:
1.41 ng 779: =back
780:
1.36 matthew 781: Below is an example of such a hash. Only the 'text', 'default', and
782: 'select2' keys must appear as stated. keys(%menu) are the possible
783: values for the first select menu. The text that coincides with the
1.41 ng 784: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 785: and text for the second menu are given in the hash pointed to by
786: $menu{$choice1}->{'select2'}.
787:
1.112 bowersj2 788: my %menu = ( A1 => { text =>"Choice A1" ,
789: default => "B3",
790: select2 => {
791: B1 => "Choice B1",
792: B2 => "Choice B2",
793: B3 => "Choice B3",
794: B4 => "Choice B4"
1.609 raeburn 795: },
796: order => ['B4','B3','B1','B2'],
1.112 bowersj2 797: },
798: A2 => { text =>"Choice A2" ,
799: default => "C2",
800: select2 => {
801: C1 => "Choice C1",
802: C2 => "Choice C2",
803: C3 => "Choice C3"
1.609 raeburn 804: },
805: order => ['C2','C1','C3'],
1.112 bowersj2 806: },
807: A3 => { text =>"Choice A3" ,
808: default => "D6",
809: select2 => {
810: D1 => "Choice D1",
811: D2 => "Choice D2",
812: D3 => "Choice D3",
813: D4 => "Choice D4",
814: D5 => "Choice D5",
815: D6 => "Choice D6",
816: D7 => "Choice D7"
1.609 raeburn 817: },
818: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 819: }
820: );
1.36 matthew 821:
822: =cut
823:
824: sub linked_select_forms {
825: my ($formname,
826: $middletext,
827: $firstdefault,
828: $firstselectname,
829: $secondselectname,
1.609 raeburn 830: $hashref,
831: $menuorder,
1.36 matthew 832: ) = @_;
833: my $second = "document.$formname.$secondselectname";
834: my $first = "document.$formname.$firstselectname";
835: # output the javascript to do the changing
836: my $result = '';
1.776 bisitz 837: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 838: $result.="// <![CDATA[\n";
1.36 matthew 839: $result.="var select2data = new Object();\n";
840: $" = '","';
841: my $debug = '';
842: foreach my $s1 (sort(keys(%$hashref))) {
843: $result.="select2data.d_$s1 = new Object();\n";
844: $result.="select2data.d_$s1.def = new String('".
845: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 846: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 847: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 848: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
849: @s2values = @{$hashref->{$s1}->{'order'}};
850: }
1.36 matthew 851: $result.="\"@s2values\");\n";
852: $result.="select2data.d_$s1.texts = new Array(";
853: my @s2texts;
854: foreach my $value (@s2values) {
855: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
856: }
857: $result.="\"@s2texts\");\n";
858: }
859: $"=' ';
860: $result.= <<"END";
861:
862: function select1_changed() {
863: // Determine new choice
864: var newvalue = "d_" + $first.value;
865: // update select2
866: var values = select2data[newvalue].values;
867: var texts = select2data[newvalue].texts;
868: var select2def = select2data[newvalue].def;
869: var i;
870: // out with the old
871: for (i = 0; i < $second.options.length; i++) {
872: $second.options[i] = null;
873: }
874: // in with the nuclear
875: for (i=0;i<values.length; i++) {
876: $second.options[i] = new Option(values[i]);
1.143 matthew 877: $second.options[i].value = values[i];
1.36 matthew 878: $second.options[i].text = texts[i];
879: if (values[i] == select2def) {
880: $second.options[i].selected = true;
881: }
882: }
883: }
1.824 bisitz 884: // ]]>
1.36 matthew 885: </script>
886: END
887: # output the initial values for the selection lists
888: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 889: my @order = sort(keys(%{$hashref}));
890: if (ref($menuorder) eq 'ARRAY') {
891: @order = @{$menuorder};
892: }
893: foreach my $value (@order) {
1.36 matthew 894: $result.=" <option value=\"$value\" ";
1.253 albertel 895: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 896: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 897: }
898: $result .= "</select>\n";
899: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
900: $result .= $middletext;
901: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
902: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 903:
904: my @secondorder = sort(keys(%select2));
905: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
906: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
907: }
908: foreach my $value (@secondorder) {
1.36 matthew 909: $result.=" <option value=\"$value\" ";
1.253 albertel 910: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 911: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 912: }
913: $result .= "</select>\n";
914: # return $debug;
915: return $result;
916: } # end of sub linked_select_forms {
917:
1.45 matthew 918: =pod
1.44 bowersj2 919:
1.648 raeburn 920: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 921:
1.112 bowersj2 922: Returns a string corresponding to an HTML link to the given help
923: $topic, where $topic corresponds to the name of a .tex file in
924: /home/httpd/html/adm/help/tex, with underscores replaced by
925: spaces.
926:
927: $text will optionally be linked to the same topic, allowing you to
928: link text in addition to the graphic. If you do not want to link
929: text, but wish to specify one of the later parameters, pass an
930: empty string.
931:
932: $stayOnPage is a value that will be interpreted as a boolean. If true,
933: the link will not open a new window. If false, the link will open
934: a new window using Javascript. (Default is false.)
935:
936: $width and $height are optional numerical parameters that will
937: override the width and height of the popped up window, which may
938: be useful for certain help topics with big pictures included.
1.44 bowersj2 939:
940: =cut
941:
942: sub help_open_topic {
1.48 bowersj2 943: my ($topic, $text, $stayOnPage, $width, $height) = @_;
944: $text = "" if (not defined $text);
1.44 bowersj2 945: $stayOnPage = 0 if (not defined $stayOnPage);
946: $width = 350 if (not defined $width);
947: $height = 400 if (not defined $height);
948: my $filename = $topic;
949: $filename =~ s/ /_/g;
950:
1.48 bowersj2 951: my $template = "";
952: my $link;
1.572 banghart 953:
1.159 www 954: $topic=~s/\W/\_/g;
1.44 bowersj2 955:
1.572 banghart 956: if (!$stayOnPage) {
1.72 bowersj2 957: $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 958: } else {
1.48 bowersj2 959: $link = "/adm/help/${filename}.hlp";
960: }
961:
962: # Add the text
1.755 neumanie 963: if ($text ne "") {
1.763 bisitz 964: $template.='<span class="LC_help_open_topic">'
965: .'<a target="_top" href="'.$link.'">'
966: .$text.'</a>';
1.48 bowersj2 967: }
968:
1.763 bisitz 969: # (Always) Add the graphic
1.179 matthew 970: my $title = &mt('Online Help');
1.667 raeburn 971: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 972: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
973: .'<img src="'.$helpicon.'" border="0"'
974: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783 amueller 975: .' title="'.$title.'"'
1.763 bisitz 976: .' /></a>';
977: if ($text ne "") {
978: $template.='</span>';
979: }
1.44 bowersj2 980: return $template;
981:
1.106 bowersj2 982: }
983:
984: # This is a quicky function for Latex cheatsheet editing, since it
985: # appears in at least four places
986: sub helpLatexCheatsheet {
1.732 raeburn 987: my ($topic,$text,$not_author) = @_;
988: my $out;
1.106 bowersj2 989: my $addOther = '';
1.732 raeburn 990: if ($topic) {
1.763 bisitz 991: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
992: undef, undef, 600).
993: '</span> ';
994: }
995: $out = '<span>' # Start cheatsheet
996: .$addOther
997: .'<span>'
998: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
999: undef,undef,600)
1000: .'</span> <span>'
1001: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1002: undef,undef,600)
1003: .'</span>';
1.732 raeburn 1004: unless ($not_author) {
1.763 bisitz 1005: $out .= ' <span>'
1006: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1007: undef,undef,600)
1008: .'</span>';
1.732 raeburn 1009: }
1.763 bisitz 1010: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1011: return $out;
1.172 www 1012: }
1013:
1.430 albertel 1014: sub general_help {
1015: my $helptopic='Student_Intro';
1016: if ($env{'request.role'}=~/^(ca|au)/) {
1017: $helptopic='Authoring_Intro';
1018: } elsif ($env{'request.role'}=~/^cc/) {
1019: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1020: } elsif ($env{'request.role'}=~/^dc/) {
1021: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1022: }
1023: return $helptopic;
1024: }
1025:
1026: sub update_help_link {
1027: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1028: my $origurl = $ENV{'REQUEST_URI'};
1029: $origurl=~s|^/~|/priv/|;
1030: my $timestamp = time;
1031: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1032: $$datum = &escape($$datum);
1033: }
1034:
1035: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1036: my $output .= <<"ENDOUTPUT";
1037: <script type="text/javascript">
1.824 bisitz 1038: // <![CDATA[
1.430 albertel 1039: banner_link = '$banner_link';
1.824 bisitz 1040: // ]]>
1.430 albertel 1041: </script>
1042: ENDOUTPUT
1043: return $output;
1044: }
1045:
1046: # now just updates the help link and generates a blue icon
1.193 raeburn 1047: sub help_open_menu {
1.430 albertel 1048: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1049: = @_;
1.430 albertel 1050: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1051: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1052: # if environment.remote is on (using remote control UI)
1.798 tempelho 1053: if ($env{'environment.remote'} eq 'off' ) {
1.552 banghart 1054: $stayOnPage=1;
1.430 albertel 1055: }
1056: my $output;
1057: if ($component_help) {
1058: if (!$text) {
1059: $output=&help_open_topic($component_help,undef,$stayOnPage,
1060: $width,$height);
1061: } else {
1062: my $help_text;
1063: $help_text=&unescape($topic);
1064: $output='<table><tr><td>'.
1065: &help_open_topic($component_help,$help_text,$stayOnPage,
1066: $width,$height).'</td></tr></table>';
1067: }
1068: }
1069: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1070: return $output.$banner_link;
1071: }
1072:
1073: sub top_nav_help {
1074: my ($text) = @_;
1.436 albertel 1075: $text = &mt($text);
1.572 banghart 1076: my $stay_on_page =
1.798 tempelho 1077: ($env{'environment.remote'} eq 'off' );
1.572 banghart 1078: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1079: : "javascript:helpMenu('open')";
1.572 banghart 1080: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1081:
1.201 raeburn 1082: my $title = &mt('Get help');
1.436 albertel 1083:
1084: return <<"END";
1085: $banner_link
1086: <a href="$link" title="$title">$text</a>
1087: END
1088: }
1089:
1090: sub help_menu_js {
1091: my ($text) = @_;
1092:
1093: my $stayOnPage =
1.798 tempelho 1094: ($env{'environment.remote'} eq 'off' );
1.436 albertel 1095:
1096: my $width = 620;
1097: my $height = 600;
1.430 albertel 1098: my $helptopic=&general_help();
1099: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1100: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1101: my $start_page =
1102: &Apache::loncommon::start_page('Help Menu', undef,
1103: {'frameset' => 1,
1104: 'js_ready' => 1,
1105: 'add_entries' => {
1106: 'border' => '0',
1.579 raeburn 1107: 'rows' => "110,*",},});
1.331 albertel 1108: my $end_page =
1109: &Apache::loncommon::end_page({'frameset' => 1,
1110: 'js_ready' => 1,});
1111:
1.436 albertel 1112: my $template .= <<"ENDTEMPLATE";
1113: <script type="text/javascript">
1.253 albertel 1114: // <!-- BEGIN LON-CAPA Internal
1115: // <![CDATA[
1.430 albertel 1116: var banner_link = '';
1.243 raeburn 1117: function helpMenu(target) {
1118: var caller = this;
1119: if (target == 'open') {
1120: var newWindow = null;
1121: try {
1.262 albertel 1122: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1123: }
1124: catch(error) {
1125: writeHelp(caller);
1126: return;
1127: }
1128: if (newWindow) {
1129: caller = newWindow;
1130: }
1.193 raeburn 1131: }
1.243 raeburn 1132: writeHelp(caller);
1133: return;
1134: }
1135: function writeHelp(caller) {
1.430 albertel 1136: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1137: caller.document.close()
1138: caller.focus()
1.193 raeburn 1139: }
1.253 albertel 1140: // ]]>
1.219 albertel 1141: // END LON-CAPA Internal -->
1.436 albertel 1142: </script>
1.193 raeburn 1143: ENDTEMPLATE
1144: return $template;
1145: }
1146:
1.172 www 1147: sub help_open_bug {
1148: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1149: unless ($env{'user.adv'}) { return ''; }
1.172 www 1150: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1151: $text = "" if (not defined $text);
1152: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1153: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1154: $stayOnPage=1;
1155: }
1.184 albertel 1156: $width = 600 if (not defined $width);
1157: $height = 600 if (not defined $height);
1.172 www 1158:
1159: $topic=~s/\W+/\+/g;
1160: my $link='';
1161: my $template='';
1.379 albertel 1162: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1163: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1164: if (!$stayOnPage)
1165: {
1166: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1167: }
1168: else
1169: {
1170: $link = $url;
1171: }
1172: # Add the text
1173: if ($text ne "")
1174: {
1175: $template .=
1176: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1177: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1178: }
1179:
1180: # Add the graphic
1.179 matthew 1181: my $title = &mt('Report a Bug');
1.215 albertel 1182: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1183: $template .= <<"ENDTEMPLATE";
1.436 albertel 1184: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1185: ENDTEMPLATE
1186: if ($text ne '') { $template.='</td></tr></table>' };
1187: return $template;
1188:
1189: }
1190:
1191: sub help_open_faq {
1192: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1193: unless ($env{'user.adv'}) { return ''; }
1.172 www 1194: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1195: $text = "" if (not defined $text);
1196: $stayOnPage = 0 if (not defined $stayOnPage);
1.798 tempelho 1197: if ($env{'environment.remote'} eq 'off' ) {
1.172 www 1198: $stayOnPage=1;
1199: }
1200: $width = 350 if (not defined $width);
1201: $height = 400 if (not defined $height);
1202:
1203: $topic=~s/\W+/\+/g;
1204: my $link='';
1205: my $template='';
1206: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1207: if (!$stayOnPage)
1208: {
1209: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1210: }
1211: else
1212: {
1213: $link = $url;
1214: }
1215:
1216: # Add the text
1217: if ($text ne "")
1218: {
1219: $template .=
1.173 www 1220: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1221: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1222: }
1223:
1224: # Add the graphic
1.179 matthew 1225: my $title = &mt('View the FAQ');
1.215 albertel 1226: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1227: $template .= <<"ENDTEMPLATE";
1.436 albertel 1228: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1229: ENDTEMPLATE
1230: if ($text ne '') { $template.='</td></tr></table>' };
1231: return $template;
1232:
1.44 bowersj2 1233: }
1.37 matthew 1234:
1.180 matthew 1235: ###############################################################
1236: ###############################################################
1237:
1.45 matthew 1238: =pod
1239:
1.648 raeburn 1240: =item * &change_content_javascript():
1.256 matthew 1241:
1242: This and the next function allow you to create small sections of an
1243: otherwise static HTML page that you can update on the fly with
1244: Javascript, even in Netscape 4.
1245:
1246: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1247: must be written to the HTML page once. It will prove the Javascript
1248: function "change(name, content)". Calling the change function with the
1249: name of the section
1250: you want to update, matching the name passed to C<changable_area>, and
1251: the new content you want to put in there, will put the content into
1252: that area.
1253:
1254: B<Note>: Netscape 4 only reserves enough space for the changable area
1255: to contain room for the original contents. You need to "make space"
1256: for whatever changes you wish to make, and be B<sure> to check your
1257: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1258: it's adequate for updating a one-line status display, but little more.
1259: This script will set the space to 100% width, so you only need to
1260: worry about height in Netscape 4.
1261:
1262: Modern browsers are much less limiting, and if you can commit to the
1263: user not using Netscape 4, this feature may be used freely with
1264: pretty much any HTML.
1265:
1266: =cut
1267:
1268: sub change_content_javascript {
1269: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1270: if ($env{'browser.type'} eq 'netscape' &&
1271: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1272: return (<<NETSCAPE4);
1273: function change(name, content) {
1274: doc = document.layers[name+"___escape"].layers[0].document;
1275: doc.open();
1276: doc.write(content);
1277: doc.close();
1278: }
1279: NETSCAPE4
1280: } else {
1281: # Otherwise, we need to use semi-standards-compliant code
1282: # (technically, "innerHTML" isn't standard but the equivalent
1283: # is really scary, and every useful browser supports it
1284: return (<<DOMBASED);
1285: function change(name, content) {
1286: element = document.getElementById(name);
1287: element.innerHTML = content;
1288: }
1289: DOMBASED
1290: }
1291: }
1292:
1293: =pod
1294:
1.648 raeburn 1295: =item * &changable_area($name,$origContent):
1.256 matthew 1296:
1297: This provides a "changable area" that can be modified on the fly via
1298: the Javascript code provided in C<change_content_javascript>. $name is
1299: the name you will use to reference the area later; do not repeat the
1300: same name on a given HTML page more then once. $origContent is what
1301: the area will originally contain, which can be left blank.
1302:
1303: =cut
1304:
1305: sub changable_area {
1306: my ($name, $origContent) = @_;
1307:
1.258 albertel 1308: if ($env{'browser.type'} eq 'netscape' &&
1309: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1310: # If this is netscape 4, we need to use the Layer tag
1311: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1312: } else {
1313: return "<span id='$name'>$origContent</span>";
1314: }
1315: }
1316:
1317: =pod
1318:
1.648 raeburn 1319: =item * &viewport_geometry_js
1.590 raeburn 1320:
1321: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1322:
1323: =cut
1324:
1325:
1326: sub viewport_geometry_js {
1327: return <<"GEOMETRY";
1328: var Geometry = {};
1329: function init_geometry() {
1330: if (Geometry.init) { return };
1331: Geometry.init=1;
1332: if (window.innerHeight) {
1333: Geometry.getViewportHeight = function() { return window.innerHeight; };
1334: Geometry.getViewportWidth = function() { return window.innerWidth; };
1335: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1336: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1337: }
1338: else if (document.documentElement && document.documentElement.clientHeight) {
1339: Geometry.getViewportHeight =
1340: function() { return document.documentElement.clientHeight; };
1341: Geometry.getViewportWidth =
1342: function() { return document.documentElement.clientWidth; };
1343:
1344: Geometry.getHorizontalScroll =
1345: function() { return document.documentElement.scrollLeft; };
1346: Geometry.getVerticalScroll =
1347: function() { return document.documentElement.scrollTop; };
1348: }
1349: else if (document.body.clientHeight) {
1350: Geometry.getViewportHeight =
1351: function() { return document.body.clientHeight; };
1352: Geometry.getViewportWidth =
1353: function() { return document.body.clientWidth; };
1354: Geometry.getHorizontalScroll =
1355: function() { return document.body.scrollLeft; };
1356: Geometry.getVerticalScroll =
1357: function() { return document.body.scrollTop; };
1358: }
1359: }
1360:
1361: GEOMETRY
1362: }
1363:
1364: =pod
1365:
1.648 raeburn 1366: =item * &viewport_size_js()
1.590 raeburn 1367:
1368: 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.
1369:
1370: =cut
1371:
1372: sub viewport_size_js {
1373: my $geometry = &viewport_geometry_js();
1374: return <<"DIMS";
1375:
1376: $geometry
1377:
1378: function getViewportDims(width,height) {
1379: init_geometry();
1380: width.value = Geometry.getViewportWidth();
1381: height.value = Geometry.getViewportHeight();
1382: return;
1383: }
1384:
1385: DIMS
1386: }
1387:
1388: =pod
1389:
1.648 raeburn 1390: =item * &resize_textarea_js()
1.565 albertel 1391:
1392: emits the needed javascript to resize a textarea to be as big as possible
1393:
1394: creates a function resize_textrea that takes two IDs first should be
1395: the id of the element to resize, second should be the id of a div that
1396: surrounds everything that comes after the textarea, this routine needs
1397: to be attached to the <body> for the onload and onresize events.
1398:
1.648 raeburn 1399: =back
1.565 albertel 1400:
1401: =cut
1402:
1403: sub resize_textarea_js {
1.590 raeburn 1404: my $geometry = &viewport_geometry_js();
1.565 albertel 1405: return <<"RESIZE";
1406: <script type="text/javascript">
1.824 bisitz 1407: // <![CDATA[
1.590 raeburn 1408: $geometry
1.565 albertel 1409:
1.588 albertel 1410: function getX(element) {
1411: var x = 0;
1412: while (element) {
1413: x += element.offsetLeft;
1414: element = element.offsetParent;
1415: }
1416: return x;
1417: }
1418: function getY(element) {
1419: var y = 0;
1420: while (element) {
1421: y += element.offsetTop;
1422: element = element.offsetParent;
1423: }
1424: return y;
1425: }
1426:
1427:
1.565 albertel 1428: function resize_textarea(textarea_id,bottom_id) {
1429: init_geometry();
1430: var textarea = document.getElementById(textarea_id);
1431: //alert(textarea);
1432:
1.588 albertel 1433: var textarea_top = getY(textarea);
1.565 albertel 1434: var textarea_height = textarea.offsetHeight;
1435: var bottom = document.getElementById(bottom_id);
1.588 albertel 1436: var bottom_top = getY(bottom);
1.565 albertel 1437: var bottom_height = bottom.offsetHeight;
1438: var window_height = Geometry.getViewportHeight();
1.588 albertel 1439: var fudge = 23;
1.565 albertel 1440: var new_height = window_height-fudge-textarea_top-bottom_height;
1441: if (new_height < 300) {
1442: new_height = 300;
1443: }
1444: textarea.style.height=new_height+'px';
1445: }
1.824 bisitz 1446: // ]]>
1.565 albertel 1447: </script>
1448: RESIZE
1449:
1450: }
1451:
1452: =pod
1453:
1.256 matthew 1454: =head1 Excel and CSV file utility routines
1455:
1456: =over 4
1457:
1458: =cut
1459:
1460: ###############################################################
1461: ###############################################################
1462:
1463: =pod
1464:
1.648 raeburn 1465: =item * &csv_translate($text)
1.37 matthew 1466:
1.185 www 1467: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1468: format.
1469:
1470: =cut
1471:
1.180 matthew 1472: ###############################################################
1473: ###############################################################
1.37 matthew 1474: sub csv_translate {
1475: my $text = shift;
1476: $text =~ s/\"/\"\"/g;
1.209 albertel 1477: $text =~ s/\n/ /g;
1.37 matthew 1478: return $text;
1479: }
1.180 matthew 1480:
1481: ###############################################################
1482: ###############################################################
1483:
1484: =pod
1485:
1.648 raeburn 1486: =item * &define_excel_formats()
1.180 matthew 1487:
1488: Define some commonly used Excel cell formats.
1489:
1490: Currently supported formats:
1491:
1492: =over 4
1493:
1494: =item header
1495:
1496: =item bold
1497:
1498: =item h1
1499:
1500: =item h2
1501:
1502: =item h3
1503:
1.256 matthew 1504: =item h4
1505:
1506: =item i
1507:
1.180 matthew 1508: =item date
1509:
1510: =back
1511:
1512: Inputs: $workbook
1513:
1514: Returns: $format, a hash reference.
1515:
1516: =cut
1517:
1518: ###############################################################
1519: ###############################################################
1520: sub define_excel_formats {
1521: my ($workbook) = @_;
1522: my $format;
1523: $format->{'header'} = $workbook->add_format(bold => 1,
1524: bottom => 1,
1525: align => 'center');
1526: $format->{'bold'} = $workbook->add_format(bold=>1);
1527: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1528: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1529: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1530: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1531: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1532: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1533: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1534: return $format;
1535: }
1536:
1537: ###############################################################
1538: ###############################################################
1.113 bowersj2 1539:
1540: =pod
1541:
1.648 raeburn 1542: =item * &create_workbook()
1.255 matthew 1543:
1544: Create an Excel worksheet. If it fails, output message on the
1545: request object and return undefs.
1546:
1547: Inputs: Apache request object
1548:
1549: Returns (undef) on failure,
1550: Excel worksheet object, scalar with filename, and formats
1551: from &Apache::loncommon::define_excel_formats on success
1552:
1553: =cut
1554:
1555: ###############################################################
1556: ###############################################################
1557: sub create_workbook {
1558: my ($r) = @_;
1559: #
1560: # Create the excel spreadsheet
1561: my $filename = '/prtspool/'.
1.258 albertel 1562: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1563: time.'_'.rand(1000000000).'.xls';
1564: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1565: if (! defined($workbook)) {
1566: $r->log_error("Error creating excel spreadsheet $filename: $!");
1567: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1568: "This error has been logged. ".
1569: "Please alert your LON-CAPA administrator").
1570: '</p>');
1571: return (undef);
1572: }
1573: #
1574: $workbook->set_tempdir('/home/httpd/perl/tmp');
1575: #
1576: my $format = &Apache::loncommon::define_excel_formats($workbook);
1577: return ($workbook,$filename,$format);
1578: }
1579:
1580: ###############################################################
1581: ###############################################################
1582:
1583: =pod
1584:
1.648 raeburn 1585: =item * &create_text_file()
1.113 bowersj2 1586:
1.542 raeburn 1587: Create a file to write to and eventually make available to the user.
1.256 matthew 1588: If file creation fails, outputs an error message on the request object and
1589: return undefs.
1.113 bowersj2 1590:
1.256 matthew 1591: Inputs: Apache request object, and file suffix
1.113 bowersj2 1592:
1.256 matthew 1593: Returns (undef) on failure,
1594: Filehandle and filename on success.
1.113 bowersj2 1595:
1596: =cut
1597:
1.256 matthew 1598: ###############################################################
1599: ###############################################################
1600: sub create_text_file {
1601: my ($r,$suffix) = @_;
1602: if (! defined($suffix)) { $suffix = 'txt'; };
1603: my $fh;
1604: my $filename = '/prtspool/'.
1.258 albertel 1605: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1606: time.'_'.rand(1000000000).'.'.$suffix;
1607: $fh = Apache::File->new('>/home/httpd'.$filename);
1608: if (! defined($fh)) {
1609: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1610: $r->print(&mt('Problems occurred in creating the output file. '
1611: .'This error has been logged. '
1612: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1613: }
1.256 matthew 1614: return ($fh,$filename)
1.113 bowersj2 1615: }
1616:
1617:
1.256 matthew 1618: =pod
1.113 bowersj2 1619:
1620: =back
1621:
1622: =cut
1.37 matthew 1623:
1624: ###############################################################
1.33 matthew 1625: ## Home server <option> list generating code ##
1626: ###############################################################
1.35 matthew 1627:
1.169 www 1628: # ------------------------------------------
1629:
1630: sub domain_select {
1631: my ($name,$value,$multiple)=@_;
1632: my %domains=map {
1.514 albertel 1633: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1634: } &Apache::lonnet::all_domains();
1.169 www 1635: if ($multiple) {
1636: $domains{''}=&mt('Any domain');
1.550 albertel 1637: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1638: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1639: } else {
1.550 albertel 1640: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1641: return &select_form($name,$value,%domains);
1642: }
1643: }
1644:
1.282 albertel 1645: #-------------------------------------------
1646:
1647: =pod
1648:
1.519 raeburn 1649: =head1 Routines for form select boxes
1650:
1651: =over 4
1652:
1.648 raeburn 1653: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1654:
1655: Returns a string containing a <select> element int multiple mode
1656:
1657:
1658: Args:
1659: $name - name of the <select> element
1.506 raeburn 1660: $value - scalar or array ref of values that should already be selected
1.282 albertel 1661: $size - number of rows long the select element is
1.283 albertel 1662: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1663: (shown text should already have been &mt())
1.506 raeburn 1664: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1665:
1.282 albertel 1666: =cut
1667:
1668: #-------------------------------------------
1.169 www 1669: sub multiple_select_form {
1.284 albertel 1670: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1671: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1672: my $output='';
1.191 matthew 1673: if (! defined($size)) {
1674: $size = 4;
1.283 albertel 1675: if (scalar(keys(%$hash))<4) {
1676: $size = scalar(keys(%$hash));
1.191 matthew 1677: }
1678: }
1.734 bisitz 1679: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1680: my @order;
1.506 raeburn 1681: if (ref($order) eq 'ARRAY') {
1682: @order = @{$order};
1683: } else {
1684: @order = sort(keys(%$hash));
1.501 banghart 1685: }
1686: if (exists($$hash{'select_form_order'})) {
1687: @order = @{$$hash{'select_form_order'}};
1688: }
1689:
1.284 albertel 1690: foreach my $key (@order) {
1.356 albertel 1691: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1692: $output.='selected="selected" ' if ($selected{$key});
1693: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1694: }
1695: $output.="</select>\n";
1696: return $output;
1697: }
1698:
1.88 www 1699: #-------------------------------------------
1700:
1701: =pod
1702:
1.648 raeburn 1703: =item * &select_form($defdom,$name,%hash)
1.88 www 1704:
1705: Returns a string containing a <select name='$name' size='1'> form to
1706: allow a user to select options from a hash option_name => displayed text.
1707: See lonrights.pm for an example invocation and use.
1708:
1709: =cut
1710:
1711: #-------------------------------------------
1712: sub select_form {
1713: my ($def,$name,%hash) = @_;
1714: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1715: my @keys;
1716: if (exists($hash{'select_form_order'})) {
1717: @keys=@{$hash{'select_form_order'}};
1718: } else {
1719: @keys=sort(keys(%hash));
1720: }
1.356 albertel 1721: foreach my $key (@keys) {
1722: $selectform.=
1723: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1724: ($key eq $def ? 'selected="selected" ' : '').
1725: ">".&mt($hash{$key})."</option>\n";
1.88 www 1726: }
1727: $selectform.="</select>";
1728: return $selectform;
1729: }
1730:
1.475 www 1731: # For display filters
1732:
1733: sub display_filter {
1734: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1735: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1736: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1737: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1738: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1739: '</label></span> <span class="LC_nobreak">'.
1.475 www 1740: &mt('Filter [_1]',
1.477 www 1741: &select_form($env{'form.displayfilter'},
1742: 'displayfilter',
1743: ('currentfolder' => 'Current folder/page',
1744: 'containing' => 'Containing phrase',
1745: 'none' => 'None'))).
1.714 bisitz 1746: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1747: }
1748:
1.167 www 1749: sub gradeleveldescription {
1750: my $gradelevel=shift;
1751: my %gradelevels=(0 => 'Not specified',
1752: 1 => 'Grade 1',
1753: 2 => 'Grade 2',
1754: 3 => 'Grade 3',
1755: 4 => 'Grade 4',
1756: 5 => 'Grade 5',
1757: 6 => 'Grade 6',
1758: 7 => 'Grade 7',
1759: 8 => 'Grade 8',
1760: 9 => 'Grade 9',
1761: 10 => 'Grade 10',
1762: 11 => 'Grade 11',
1763: 12 => 'Grade 12',
1764: 13 => 'Grade 13',
1765: 14 => '100 Level',
1766: 15 => '200 Level',
1767: 16 => '300 Level',
1768: 17 => '400 Level',
1769: 18 => 'Graduate Level');
1770: return &mt($gradelevels{$gradelevel});
1771: }
1772:
1.163 www 1773: sub select_level_form {
1774: my ($deflevel,$name)=@_;
1775: unless ($deflevel) { $deflevel=0; }
1.167 www 1776: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1777: for (my $i=0; $i<=18; $i++) {
1778: $selectform.="<option value=\"$i\" ".
1.253 albertel 1779: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1780: ">".&gradeleveldescription($i)."</option>\n";
1781: }
1782: $selectform.="</select>";
1783: return $selectform;
1.163 www 1784: }
1.167 www 1785:
1.35 matthew 1786: #-------------------------------------------
1787:
1.45 matthew 1788: =pod
1789:
1.743 raeburn 1790: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1791:
1792: Returns a string containing a <select name='$name' size='1'> form to
1793: allow a user to select the domain to preform an operation in.
1794: See loncreateuser.pm for an example invocation and use.
1795:
1.90 www 1796: If the $includeempty flag is set, it also includes an empty choice ("no domain
1797: selected");
1798:
1.743 raeburn 1799: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1800:
1801: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1802:
1.35 matthew 1803: =cut
1804:
1805: #-------------------------------------------
1.34 matthew 1806: sub select_dom_form {
1.743 raeburn 1807: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1808: my $onchange;
1809: if ($autosubmit) {
1810: $onchange = ' onchange="this.form.submit()"';
1811: }
1.550 albertel 1812: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1813: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1814: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1815: foreach my $dom (@domains) {
1816: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1817: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1818: if ($showdomdesc) {
1819: if ($dom ne '') {
1820: my $domdesc = &Apache::lonnet::domain($dom,'description');
1821: if ($domdesc ne '') {
1822: $selectdomain .= ' ('.$domdesc.')';
1823: }
1824: }
1825: }
1826: $selectdomain .= "</option>\n";
1.34 matthew 1827: }
1828: $selectdomain.="</select>";
1829: return $selectdomain;
1830: }
1831:
1.35 matthew 1832: #-------------------------------------------
1833:
1.45 matthew 1834: =pod
1835:
1.648 raeburn 1836: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1837:
1.586 raeburn 1838: input: 4 arguments (two required, two optional) -
1839: $domain - domain of new user
1840: $name - name of form element
1841: $default - Value of 'default' causes a default item to be first
1842: option, and selected by default.
1843: $hide - Value of 'hide' causes hiding of the name of the server,
1844: if 1 server found, or default, if 0 found.
1.594 raeburn 1845: output: returns 2 items:
1.586 raeburn 1846: (a) form element which contains either:
1847: (i) <select name="$name">
1848: <option value="$hostid1">$hostid $servers{$hostid}</option>
1849: <option value="$hostid2">$hostid $servers{$hostid}</option>
1850: </select>
1851: form item if there are multiple library servers in $domain, or
1852: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1853: if there is only one library server in $domain.
1854:
1855: (b) number of library servers found.
1856:
1857: See loncreateuser.pm for example of use.
1.35 matthew 1858:
1859: =cut
1860:
1861: #-------------------------------------------
1.586 raeburn 1862: sub home_server_form_item {
1863: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1864: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1865: my $result;
1866: my $numlib = keys(%servers);
1867: if ($numlib > 1) {
1868: $result .= '<select name="'.$name.'" />'."\n";
1869: if ($default) {
1.804 bisitz 1870: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 1871: '</option>'."\n";
1872: }
1873: foreach my $hostid (sort(keys(%servers))) {
1874: $result.= '<option value="'.$hostid.'">'.
1875: $hostid.' '.$servers{$hostid}."</option>\n";
1876: }
1877: $result .= '</select>'."\n";
1878: } elsif ($numlib == 1) {
1879: my $hostid;
1880: foreach my $item (keys(%servers)) {
1881: $hostid = $item;
1882: }
1883: $result .= '<input type="hidden" name="'.$name.'" value="'.
1884: $hostid.'" />';
1885: if (!$hide) {
1886: $result .= $hostid.' '.$servers{$hostid};
1887: }
1888: $result .= "\n";
1889: } elsif ($default) {
1890: $result .= '<input type="hidden" name="'.$name.
1891: '" value="default" />';
1892: if (!$hide) {
1893: $result .= &mt('default');
1894: }
1895: $result .= "\n";
1.33 matthew 1896: }
1.586 raeburn 1897: return ($result,$numlib);
1.33 matthew 1898: }
1.112 bowersj2 1899:
1900: =pod
1901:
1.534 albertel 1902: =back
1903:
1.112 bowersj2 1904: =cut
1.87 matthew 1905:
1906: ###############################################################
1.112 bowersj2 1907: ## Decoding User Agent ##
1.87 matthew 1908: ###############################################################
1909:
1910: =pod
1911:
1.112 bowersj2 1912: =head1 Decoding the User Agent
1913:
1914: =over 4
1915:
1916: =item * &decode_user_agent()
1.87 matthew 1917:
1918: Inputs: $r
1919:
1920: Outputs:
1921:
1922: =over 4
1923:
1.112 bowersj2 1924: =item * $httpbrowser
1.87 matthew 1925:
1.112 bowersj2 1926: =item * $clientbrowser
1.87 matthew 1927:
1.112 bowersj2 1928: =item * $clientversion
1.87 matthew 1929:
1.112 bowersj2 1930: =item * $clientmathml
1.87 matthew 1931:
1.112 bowersj2 1932: =item * $clientunicode
1.87 matthew 1933:
1.112 bowersj2 1934: =item * $clientos
1.87 matthew 1935:
1936: =back
1937:
1.157 matthew 1938: =back
1939:
1.87 matthew 1940: =cut
1941:
1942: ###############################################################
1943: ###############################################################
1944: sub decode_user_agent {
1.247 albertel 1945: my ($r)=@_;
1.87 matthew 1946: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1947: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1948: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1949: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1950: my $clientbrowser='unknown';
1951: my $clientversion='0';
1952: my $clientmathml='';
1953: my $clientunicode='0';
1954: for (my $i=0;$i<=$#browsertype;$i++) {
1955: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1956: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1957: $clientbrowser=$bname;
1958: $httpbrowser=~/$vreg/i;
1959: $clientversion=$1;
1960: $clientmathml=($clientversion>=$minv);
1961: $clientunicode=($clientversion>=$univ);
1962: }
1963: }
1964: my $clientos='unknown';
1965: if (($httpbrowser=~/linux/i) ||
1966: ($httpbrowser=~/unix/i) ||
1967: ($httpbrowser=~/ux/i) ||
1968: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1969: if (($httpbrowser=~/vax/i) ||
1970: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1971: if ($httpbrowser=~/next/i) { $clientos='next'; }
1972: if (($httpbrowser=~/mac/i) ||
1973: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1974: if ($httpbrowser=~/win/i) { $clientos='win'; }
1975: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1976: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1977: $clientunicode,$clientos,);
1978: }
1979:
1.32 matthew 1980: ###############################################################
1981: ## Authentication changing form generation subroutines ##
1982: ###############################################################
1983: ##
1984: ## All of the authform_xxxxxxx subroutines take their inputs in a
1985: ## hash, and have reasonable default values.
1986: ##
1987: ## formname = the name given in the <form> tag.
1.35 matthew 1988: #-------------------------------------------
1989:
1.45 matthew 1990: =pod
1991:
1.112 bowersj2 1992: =head1 Authentication Routines
1993:
1994: =over 4
1995:
1.648 raeburn 1996: =item * &authform_xxxxxx()
1.35 matthew 1997:
1998: The authform_xxxxxx subroutines provide javascript and html forms which
1999: handle some of the conveniences required for authentication forms.
2000: This is not an optimal method, but it works.
2001:
2002: =over 4
2003:
1.112 bowersj2 2004: =item * authform_header
1.35 matthew 2005:
1.112 bowersj2 2006: =item * authform_authorwarning
1.35 matthew 2007:
1.112 bowersj2 2008: =item * authform_nochange
1.35 matthew 2009:
1.112 bowersj2 2010: =item * authform_kerberos
1.35 matthew 2011:
1.112 bowersj2 2012: =item * authform_internal
1.35 matthew 2013:
1.112 bowersj2 2014: =item * authform_filesystem
1.35 matthew 2015:
2016: =back
2017:
1.648 raeburn 2018: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2019:
1.35 matthew 2020: =cut
2021:
2022: #-------------------------------------------
1.32 matthew 2023: sub authform_header{
2024: my %in = (
2025: formname => 'cu',
1.80 albertel 2026: kerb_def_dom => '',
1.32 matthew 2027: @_,
2028: );
2029: $in{'formname'} = 'document.' . $in{'formname'};
2030: my $result='';
1.80 albertel 2031:
2032: #---------------------------------------------- Code for upper case translation
2033: my $Javascript_toUpperCase;
2034: unless ($in{kerb_def_dom}) {
2035: $Javascript_toUpperCase =<<"END";
2036: switch (choice) {
2037: case 'krb': currentform.elements[choicearg].value =
2038: currentform.elements[choicearg].value.toUpperCase();
2039: break;
2040: default:
2041: }
2042: END
2043: } else {
2044: $Javascript_toUpperCase = "";
2045: }
2046:
1.165 raeburn 2047: my $radioval = "'nochange'";
1.591 raeburn 2048: if (defined($in{'curr_authtype'})) {
2049: if ($in{'curr_authtype'} ne '') {
2050: $radioval = "'".$in{'curr_authtype'}."arg'";
2051: }
1.174 matthew 2052: }
1.165 raeburn 2053: my $argfield = 'null';
1.591 raeburn 2054: if (defined($in{'mode'})) {
1.165 raeburn 2055: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2056: if (defined($in{'curr_autharg'})) {
2057: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2058: $argfield = "'$in{'curr_autharg'}'";
2059: }
2060: }
2061: }
2062: }
2063:
1.32 matthew 2064: $result.=<<"END";
2065: var current = new Object();
1.165 raeburn 2066: current.radiovalue = $radioval;
2067: current.argfield = $argfield;
1.32 matthew 2068:
2069: function changed_radio(choice,currentform) {
2070: var choicearg = choice + 'arg';
2071: // If a radio button in changed, we need to change the argfield
2072: if (current.radiovalue != choice) {
2073: current.radiovalue = choice;
2074: if (current.argfield != null) {
2075: currentform.elements[current.argfield].value = '';
2076: }
2077: if (choice == 'nochange') {
2078: current.argfield = null;
2079: } else {
2080: current.argfield = choicearg;
2081: switch(choice) {
2082: case 'krb':
2083: currentform.elements[current.argfield].value =
2084: "$in{'kerb_def_dom'}";
2085: break;
2086: default:
2087: break;
2088: }
2089: }
2090: }
2091: return;
2092: }
1.22 www 2093:
1.32 matthew 2094: function changed_text(choice,currentform) {
2095: var choicearg = choice + 'arg';
2096: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2097: $Javascript_toUpperCase
1.32 matthew 2098: // clear old field
2099: if ((current.argfield != choicearg) && (current.argfield != null)) {
2100: currentform.elements[current.argfield].value = '';
2101: }
2102: current.argfield = choicearg;
2103: }
2104: set_auth_radio_buttons(choice,currentform);
2105: return;
1.20 www 2106: }
1.32 matthew 2107:
2108: function set_auth_radio_buttons(newvalue,currentform) {
2109: var i=0;
2110: while (i < currentform.login.length) {
2111: if (currentform.login[i].value == newvalue) { break; }
2112: i++;
2113: }
2114: if (i == currentform.login.length) {
2115: return;
2116: }
2117: current.radiovalue = newvalue;
2118: currentform.login[i].checked = true;
2119: return;
2120: }
2121: END
2122: return $result;
2123: }
2124:
2125: sub authform_authorwarning{
2126: my $result='';
1.144 matthew 2127: $result='<i>'.
2128: &mt('As a general rule, only authors or co-authors should be '.
2129: 'filesystem authenticated '.
2130: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2131: return $result;
2132: }
2133:
2134: sub authform_nochange{
2135: my %in = (
2136: formname => 'document.cu',
2137: kerb_def_dom => 'MSU.EDU',
2138: @_,
2139: );
1.586 raeburn 2140: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2141: my $result;
2142: if (keys(%can_assign) == 0) {
2143: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2144: } else {
2145: $result = '<label>'.&mt('[_1] Do not change login data',
2146: '<input type="radio" name="login" value="nochange" '.
2147: 'checked="checked" onclick="'.
1.281 albertel 2148: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2149: '</label>';
1.586 raeburn 2150: }
1.32 matthew 2151: return $result;
2152: }
2153:
1.591 raeburn 2154: sub authform_kerberos {
1.32 matthew 2155: my %in = (
2156: formname => 'document.cu',
2157: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2158: kerb_def_auth => 'krb4',
1.32 matthew 2159: @_,
2160: );
1.586 raeburn 2161: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2162: $autharg,$jscall);
2163: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2164: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2165: $check5 = ' checked="checked"';
1.80 albertel 2166: } else {
1.772 bisitz 2167: $check4 = ' checked="checked"';
1.80 albertel 2168: }
1.165 raeburn 2169: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2170: if (defined($in{'curr_authtype'})) {
2171: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2172: $krbcheck = ' checked="checked"';
1.623 raeburn 2173: if (defined($in{'mode'})) {
2174: if ($in{'mode'} eq 'modifyuser') {
2175: $krbcheck = '';
2176: }
2177: }
1.591 raeburn 2178: if (defined($in{'curr_kerb_ver'})) {
2179: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2180: $check5 = ' checked="checked"';
1.591 raeburn 2181: $check4 = '';
2182: } else {
1.772 bisitz 2183: $check4 = ' checked="checked"';
1.591 raeburn 2184: $check5 = '';
2185: }
1.586 raeburn 2186: }
1.591 raeburn 2187: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2188: $krbarg = $in{'curr_autharg'};
2189: }
1.586 raeburn 2190: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2191: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2192: $result =
2193: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2194: $in{'curr_autharg'},$krbver);
2195: } else {
2196: $result =
2197: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2198: }
2199: return $result;
2200: }
2201: }
2202: } else {
2203: if ($authnum == 1) {
1.784 bisitz 2204: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2205: }
2206: }
1.586 raeburn 2207: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2208: return;
1.587 raeburn 2209: } elsif ($authtype eq '') {
1.591 raeburn 2210: if (defined($in{'mode'})) {
1.587 raeburn 2211: if ($in{'mode'} eq 'modifycourse') {
2212: if ($authnum == 1) {
1.784 bisitz 2213: $authtype = '<input type="hidden" name="login" value="krb" />';
1.587 raeburn 2214: }
2215: }
2216: }
1.586 raeburn 2217: }
2218: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2219: if ($authtype eq '') {
2220: $authtype = '<input type="radio" name="login" value="krb" '.
2221: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2222: $krbcheck.' />';
2223: }
2224: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2225: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2226: $in{'curr_authtype'} eq 'krb5') ||
2227: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2228: $in{'curr_authtype'} eq 'krb4')) {
2229: $result .= &mt
1.144 matthew 2230: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2231: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2232: '<label>'.$authtype,
1.281 albertel 2233: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2234: 'value="'.$krbarg.'" '.
1.144 matthew 2235: 'onchange="'.$jscall.'" />',
1.281 albertel 2236: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2237: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2238: '</label>');
1.586 raeburn 2239: } elsif ($can_assign{'krb4'}) {
2240: $result .= &mt
2241: ('[_1] Kerberos authenticated with domain [_2] '.
2242: '[_3] Version 4 [_4]',
2243: '<label>'.$authtype,
2244: '</label><input type="text" size="10" name="krbarg" '.
2245: 'value="'.$krbarg.'" '.
2246: 'onchange="'.$jscall.'" />',
2247: '<label><input type="hidden" name="krbver" value="4" />',
2248: '</label>');
2249: } elsif ($can_assign{'krb5'}) {
2250: $result .= &mt
2251: ('[_1] Kerberos authenticated with domain [_2] '.
2252: '[_3] Version 5 [_4]',
2253: '<label>'.$authtype,
2254: '</label><input type="text" size="10" name="krbarg" '.
2255: 'value="'.$krbarg.'" '.
2256: 'onchange="'.$jscall.'" />',
2257: '<label><input type="hidden" name="krbver" value="5" />',
2258: '</label>');
2259: }
1.32 matthew 2260: return $result;
2261: }
2262:
2263: sub authform_internal{
1.586 raeburn 2264: my %in = (
1.32 matthew 2265: formname => 'document.cu',
2266: kerb_def_dom => 'MSU.EDU',
2267: @_,
2268: );
1.586 raeburn 2269: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2270: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2271: if (defined($in{'curr_authtype'})) {
2272: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2273: if ($can_assign{'int'}) {
1.772 bisitz 2274: $intcheck = 'checked="checked" ';
1.623 raeburn 2275: if (defined($in{'mode'})) {
2276: if ($in{'mode'} eq 'modifyuser') {
2277: $intcheck = '';
2278: }
2279: }
1.591 raeburn 2280: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2281: $intarg = $in{'curr_autharg'};
2282: }
2283: } else {
2284: $result = &mt('Currently internally authenticated.');
2285: return $result;
1.165 raeburn 2286: }
2287: }
1.586 raeburn 2288: } else {
2289: if ($authnum == 1) {
1.784 bisitz 2290: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2291: }
2292: }
2293: if (!$can_assign{'int'}) {
2294: return;
1.587 raeburn 2295: } elsif ($authtype eq '') {
1.591 raeburn 2296: if (defined($in{'mode'})) {
1.587 raeburn 2297: if ($in{'mode'} eq 'modifycourse') {
2298: if ($authnum == 1) {
1.784 bisitz 2299: $authtype = '<input type="hidden" name="login" value="int" />';
1.587 raeburn 2300: }
2301: }
2302: }
1.165 raeburn 2303: }
1.586 raeburn 2304: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2305: if ($authtype eq '') {
2306: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2307: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2308: }
1.605 bisitz 2309: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2310: $intarg.'" onchange="'.$jscall.'" />';
2311: $result = &mt
1.144 matthew 2312: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2313: '<label>'.$authtype,'</label>'.$autharg);
1.824 bisitz 2314: $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 2315: return $result;
2316: }
2317:
2318: sub authform_local{
2319: my %in = (
2320: formname => 'document.cu',
2321: kerb_def_dom => 'MSU.EDU',
2322: @_,
2323: );
1.586 raeburn 2324: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2325: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2326: if (defined($in{'curr_authtype'})) {
2327: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2328: if ($can_assign{'loc'}) {
1.772 bisitz 2329: $loccheck = 'checked="checked" ';
1.623 raeburn 2330: if (defined($in{'mode'})) {
2331: if ($in{'mode'} eq 'modifyuser') {
2332: $loccheck = '';
2333: }
2334: }
1.591 raeburn 2335: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2336: $locarg = $in{'curr_autharg'};
2337: }
2338: } else {
2339: $result = &mt('Currently using local (institutional) authentication.');
2340: return $result;
1.165 raeburn 2341: }
2342: }
1.586 raeburn 2343: } else {
2344: if ($authnum == 1) {
1.784 bisitz 2345: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 2346: }
2347: }
2348: if (!$can_assign{'loc'}) {
2349: return;
1.587 raeburn 2350: } elsif ($authtype eq '') {
1.591 raeburn 2351: if (defined($in{'mode'})) {
1.587 raeburn 2352: if ($in{'mode'} eq 'modifycourse') {
2353: if ($authnum == 1) {
1.784 bisitz 2354: $authtype = '<input type="hidden" name="login" value="loc" />';
1.587 raeburn 2355: }
2356: }
2357: }
1.165 raeburn 2358: }
1.586 raeburn 2359: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2360: if ($authtype eq '') {
2361: $authtype = '<input type="radio" name="login" value="loc" '.
2362: $loccheck.' onchange="'.$jscall.'" onclick="'.
2363: $jscall.'" />';
2364: }
2365: $autharg = '<input type="text" size="10" name="locarg" value="'.
2366: $locarg.'" onchange="'.$jscall.'" />';
2367: $result = &mt('[_1] Local Authentication with argument [_2]',
2368: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2369: return $result;
2370: }
2371:
2372: sub authform_filesystem{
2373: my %in = (
2374: formname => 'document.cu',
2375: kerb_def_dom => 'MSU.EDU',
2376: @_,
2377: );
1.586 raeburn 2378: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2379: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2380: if (defined($in{'curr_authtype'})) {
2381: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2382: if ($can_assign{'fsys'}) {
1.772 bisitz 2383: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2384: if (defined($in{'mode'})) {
2385: if ($in{'mode'} eq 'modifyuser') {
2386: $fsyscheck = '';
2387: }
2388: }
1.586 raeburn 2389: } else {
2390: $result = &mt('Currently Filesystem Authenticated.');
2391: return $result;
2392: }
2393: }
2394: } else {
2395: if ($authnum == 1) {
1.784 bisitz 2396: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 2397: }
2398: }
2399: if (!$can_assign{'fsys'}) {
2400: return;
1.587 raeburn 2401: } elsif ($authtype eq '') {
1.591 raeburn 2402: if (defined($in{'mode'})) {
1.587 raeburn 2403: if ($in{'mode'} eq 'modifycourse') {
2404: if ($authnum == 1) {
1.784 bisitz 2405: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587 raeburn 2406: }
2407: }
2408: }
1.586 raeburn 2409: }
2410: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2411: if ($authtype eq '') {
2412: $authtype = '<input type="radio" name="login" value="fsys" '.
2413: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2414: $jscall.'" />';
2415: }
2416: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2417: ' onchange="'.$jscall.'" />';
2418: $result = &mt
1.144 matthew 2419: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2420: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2421: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2422: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2423: 'onchange="'.$jscall.'" />');
1.32 matthew 2424: return $result;
2425: }
2426:
1.586 raeburn 2427: sub get_assignable_auth {
2428: my ($dom) = @_;
2429: if ($dom eq '') {
2430: $dom = $env{'request.role.domain'};
2431: }
2432: my %can_assign = (
2433: krb4 => 1,
2434: krb5 => 1,
2435: int => 1,
2436: loc => 1,
2437: );
2438: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2439: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2440: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2441: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2442: my $context;
2443: if ($env{'request.role'} =~ /^au/) {
2444: $context = 'author';
2445: } elsif ($env{'request.role'} =~ /^dc/) {
2446: $context = 'domain';
2447: } elsif ($env{'request.course.id'}) {
2448: $context = 'course';
2449: }
2450: if ($context) {
2451: if (ref($authhash->{$context}) eq 'HASH') {
2452: %can_assign = %{$authhash->{$context}};
2453: }
2454: }
2455: }
2456: }
2457: my $authnum = 0;
2458: foreach my $key (keys(%can_assign)) {
2459: if ($can_assign{$key}) {
2460: $authnum ++;
2461: }
2462: }
2463: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2464: $authnum --;
2465: }
2466: return ($authnum,%can_assign);
2467: }
2468:
1.80 albertel 2469: ###############################################################
2470: ## Get Kerberos Defaults for Domain ##
2471: ###############################################################
2472: ##
2473: ## Returns default kerberos version and an associated argument
2474: ## as listed in file domain.tab. If not listed, provides
2475: ## appropriate default domain and kerberos version.
2476: ##
2477: #-------------------------------------------
2478:
2479: =pod
2480:
1.648 raeburn 2481: =item * &get_kerberos_defaults()
1.80 albertel 2482:
2483: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2484: version and domain. If not found, it defaults to version 4 and the
2485: domain of the server.
1.80 albertel 2486:
1.648 raeburn 2487: =over 4
2488:
1.80 albertel 2489: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2490:
1.648 raeburn 2491: =back
2492:
2493: =back
2494:
1.80 albertel 2495: =cut
2496:
2497: #-------------------------------------------
2498: sub get_kerberos_defaults {
2499: my $domain=shift;
1.641 raeburn 2500: my ($krbdef,$krbdefdom);
2501: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2502: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2503: $krbdef = $domdefaults{'auth_def'};
2504: $krbdefdom = $domdefaults{'auth_arg_def'};
2505: } else {
1.80 albertel 2506: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2507: my $krbdefdom=$1;
2508: $krbdefdom=~tr/a-z/A-Z/;
2509: $krbdef = "krb4";
2510: }
2511: return ($krbdef,$krbdefdom);
2512: }
1.112 bowersj2 2513:
1.32 matthew 2514:
1.46 matthew 2515: ###############################################################
2516: ## Thesaurus Functions ##
2517: ###############################################################
1.20 www 2518:
1.46 matthew 2519: =pod
1.20 www 2520:
1.112 bowersj2 2521: =head1 Thesaurus Functions
2522:
2523: =over 4
2524:
1.648 raeburn 2525: =item * &initialize_keywords()
1.46 matthew 2526:
2527: Initializes the package variable %Keywords if it is empty. Uses the
2528: package variable $thesaurus_db_file.
2529:
2530: =cut
2531:
2532: ###################################################
2533:
2534: sub initialize_keywords {
2535: return 1 if (scalar keys(%Keywords));
2536: # If we are here, %Keywords is empty, so fill it up
2537: # Make sure the file we need exists...
2538: if (! -e $thesaurus_db_file) {
2539: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2540: " failed because it does not exist");
2541: return 0;
2542: }
2543: # Set up the hash as a database
2544: my %thesaurus_db;
2545: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2546: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2547: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2548: $thesaurus_db_file);
2549: return 0;
2550: }
2551: # Get the average number of appearances of a word.
2552: my $avecount = $thesaurus_db{'average.count'};
2553: # Put keywords (those that appear > average) into %Keywords
2554: while (my ($word,$data)=each (%thesaurus_db)) {
2555: my ($count,undef) = split /:/,$data;
2556: $Keywords{$word}++ if ($count > $avecount);
2557: }
2558: untie %thesaurus_db;
2559: # Remove special values from %Keywords.
1.356 albertel 2560: foreach my $value ('total.count','average.count') {
2561: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2562: }
1.46 matthew 2563: return 1;
2564: }
2565:
2566: ###################################################
2567:
2568: =pod
2569:
1.648 raeburn 2570: =item * &keyword($word)
1.46 matthew 2571:
2572: Returns true if $word is a keyword. A keyword is a word that appears more
2573: than the average number of times in the thesaurus database. Calls
2574: &initialize_keywords
2575:
2576: =cut
2577:
2578: ###################################################
1.20 www 2579:
2580: sub keyword {
1.46 matthew 2581: return if (!&initialize_keywords());
2582: my $word=lc(shift());
2583: $word=~s/\W//g;
2584: return exists($Keywords{$word});
1.20 www 2585: }
1.46 matthew 2586:
2587: ###############################################################
2588:
2589: =pod
1.20 www 2590:
1.648 raeburn 2591: =item * &get_related_words()
1.46 matthew 2592:
1.160 matthew 2593: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2594: an array of words. If the keyword is not in the thesaurus, an empty array
2595: will be returned. The order of the words returned is determined by the
2596: database which holds them.
2597:
2598: Uses global $thesaurus_db_file.
2599:
2600: =cut
2601:
2602: ###############################################################
2603: sub get_related_words {
2604: my $keyword = shift;
2605: my %thesaurus_db;
2606: if (! -e $thesaurus_db_file) {
2607: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2608: "failed because the file does not exist");
2609: return ();
2610: }
2611: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2612: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2613: return ();
2614: }
2615: my @Words=();
1.429 www 2616: my $count=0;
1.46 matthew 2617: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2618: # The first element is the number of times
2619: # the word appears. We do not need it now.
1.429 www 2620: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2621: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2622: my $threshold=$mostfrequentcount/10;
2623: foreach my $possibleword (@RelatedWords) {
2624: my ($word,$wordcount)=split(/\,/,$possibleword);
2625: if ($wordcount>$threshold) {
2626: push(@Words,$word);
2627: $count++;
2628: if ($count>10) { last; }
2629: }
1.20 www 2630: }
2631: }
1.46 matthew 2632: untie %thesaurus_db;
2633: return @Words;
1.14 harris41 2634: }
1.46 matthew 2635:
1.112 bowersj2 2636: =pod
2637:
2638: =back
2639:
2640: =cut
1.61 www 2641:
2642: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2643: =pod
2644:
1.112 bowersj2 2645: =head1 User Name Functions
2646:
2647: =over 4
2648:
1.648 raeburn 2649: =item * &plainname($uname,$udom,$first)
1.81 albertel 2650:
1.112 bowersj2 2651: Takes a users logon name and returns it as a string in
1.226 albertel 2652: "first middle last generation" form
2653: if $first is set to 'lastname' then it returns it as
2654: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2655:
2656: =cut
1.61 www 2657:
1.295 www 2658:
1.81 albertel 2659: ###############################################################
1.61 www 2660: sub plainname {
1.226 albertel 2661: my ($uname,$udom,$first)=@_;
1.537 albertel 2662: return if (!defined($uname) || !defined($udom));
1.295 www 2663: my %names=&getnames($uname,$udom);
1.226 albertel 2664: my $name=&Apache::lonnet::format_name($names{'firstname'},
2665: $names{'middlename'},
2666: $names{'lastname'},
2667: $names{'generation'},$first);
2668: $name=~s/^\s+//;
1.62 www 2669: $name=~s/\s+$//;
2670: $name=~s/\s+/ /g;
1.353 albertel 2671: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2672: return $name;
1.61 www 2673: }
1.66 www 2674:
2675: # -------------------------------------------------------------------- Nickname
1.81 albertel 2676: =pod
2677:
1.648 raeburn 2678: =item * &nickname($uname,$udom)
1.81 albertel 2679:
2680: Gets a users name and returns it as a string as
2681:
2682: ""nickname""
1.66 www 2683:
1.81 albertel 2684: if the user has a nickname or
2685:
2686: "first middle last generation"
2687:
2688: if the user does not
2689:
2690: =cut
1.66 www 2691:
2692: sub nickname {
2693: my ($uname,$udom)=@_;
1.537 albertel 2694: return if (!defined($uname) || !defined($udom));
1.295 www 2695: my %names=&getnames($uname,$udom);
1.68 albertel 2696: my $name=$names{'nickname'};
1.66 www 2697: if ($name) {
2698: $name='"'.$name.'"';
2699: } else {
2700: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2701: $names{'lastname'}.' '.$names{'generation'};
2702: $name=~s/\s+$//;
2703: $name=~s/\s+/ /g;
2704: }
2705: return $name;
2706: }
2707:
1.295 www 2708: sub getnames {
2709: my ($uname,$udom)=@_;
1.537 albertel 2710: return if (!defined($uname) || !defined($udom));
1.433 albertel 2711: if ($udom eq 'public' && $uname eq 'public') {
2712: return ('lastname' => &mt('Public'));
2713: }
1.295 www 2714: my $id=$uname.':'.$udom;
2715: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2716: if ($cached) {
2717: return %{$names};
2718: } else {
2719: my %loadnames=&Apache::lonnet::get('environment',
2720: ['firstname','middlename','lastname','generation','nickname'],
2721: $udom,$uname);
2722: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2723: return %loadnames;
2724: }
2725: }
1.61 www 2726:
1.542 raeburn 2727: # -------------------------------------------------------------------- getemails
1.648 raeburn 2728:
1.542 raeburn 2729: =pod
2730:
1.648 raeburn 2731: =item * &getemails($uname,$udom)
1.542 raeburn 2732:
2733: Gets a user's email information and returns it as a hash with keys:
2734: notification, critnotification, permanentemail
2735:
2736: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2737: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2738:
1.648 raeburn 2739:
1.542 raeburn 2740: =cut
2741:
1.648 raeburn 2742:
1.466 albertel 2743: sub getemails {
2744: my ($uname,$udom)=@_;
2745: if ($udom eq 'public' && $uname eq 'public') {
2746: return;
2747: }
1.467 www 2748: if (!$udom) { $udom=$env{'user.domain'}; }
2749: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2750: my $id=$uname.':'.$udom;
2751: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2752: if ($cached) {
2753: return %{$names};
2754: } else {
2755: my %loadnames=&Apache::lonnet::get('environment',
2756: ['notification','critnotification',
2757: 'permanentemail'],
2758: $udom,$uname);
2759: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2760: return %loadnames;
2761: }
2762: }
2763:
1.551 albertel 2764: sub flush_email_cache {
2765: my ($uname,$udom)=@_;
2766: if (!$udom) { $udom =$env{'user.domain'}; }
2767: if (!$uname) { $uname=$env{'user.name'}; }
2768: return if ($udom eq 'public' && $uname eq 'public');
2769: my $id=$uname.':'.$udom;
2770: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2771: }
2772:
1.728 raeburn 2773: # -------------------------------------------------------------------- getlangs
2774:
2775: =pod
2776:
2777: =item * &getlangs($uname,$udom)
2778:
2779: Gets a user's language preference and returns it as a hash with key:
2780: language.
2781:
2782: =cut
2783:
2784:
2785: sub getlangs {
2786: my ($uname,$udom) = @_;
2787: if (!$udom) { $udom =$env{'user.domain'}; }
2788: if (!$uname) { $uname=$env{'user.name'}; }
2789: my $id=$uname.':'.$udom;
2790: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2791: if ($cached) {
2792: return %{$langs};
2793: } else {
2794: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2795: $udom,$uname);
2796: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2797: return %loadlangs;
2798: }
2799: }
2800:
2801: sub flush_langs_cache {
2802: my ($uname,$udom)=@_;
2803: if (!$udom) { $udom =$env{'user.domain'}; }
2804: if (!$uname) { $uname=$env{'user.name'}; }
2805: return if ($udom eq 'public' && $uname eq 'public');
2806: my $id=$uname.':'.$udom;
2807: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2808: }
2809:
1.61 www 2810: # ------------------------------------------------------------------ Screenname
1.81 albertel 2811:
2812: =pod
2813:
1.648 raeburn 2814: =item * &screenname($uname,$udom)
1.81 albertel 2815:
2816: Gets a users screenname and returns it as a string
2817:
2818: =cut
1.61 www 2819:
2820: sub screenname {
2821: my ($uname,$udom)=@_;
1.258 albertel 2822: if ($uname eq $env{'user.name'} &&
2823: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2824: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2825: return $names{'screenname'};
1.62 www 2826: }
2827:
1.212 albertel 2828:
1.802 bisitz 2829: # ------------------------------------------------------------- Confirm Wrapper
2830: =pod
2831:
2832: =item confirmwrapper
2833:
2834: Wrap messages about completion of operation in box
2835:
2836: =cut
2837:
2838: sub confirmwrapper {
2839: my ($message)=@_;
2840: if ($message) {
2841: return "\n".'<div class="LC_confirm_box">'."\n"
2842: .$message."\n"
2843: .'</div>'."\n";
2844: } else {
2845: return $message;
2846: }
2847: }
2848:
1.62 www 2849: # ------------------------------------------------------------- Message Wrapper
2850:
2851: sub messagewrapper {
1.369 www 2852: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2853: return
1.441 albertel 2854: '<a href="/adm/email?compose=individual&'.
2855: 'recname='.$username.'&recdom='.$domain.
2856: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2857: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2858: }
1.802 bisitz 2859:
1.74 www 2860: # --------------------------------------------------------------- Notes Wrapper
2861:
2862: sub noteswrapper {
2863: my ($link,$un,$do)=@_;
2864: return
2865: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2866: }
1.802 bisitz 2867:
1.62 www 2868: # ------------------------------------------------------------- Aboutme Wrapper
2869:
2870: sub aboutmewrapper {
1.166 www 2871: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2872: if (!defined($username) && !defined($domain)) {
2873: return;
2874: }
1.205 www 2875: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2876: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2877: }
2878:
2879: # ------------------------------------------------------------ Syllabus Wrapper
2880:
2881: sub syllabuswrapper {
1.707 bisitz 2882: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2883: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2884: }
1.14 harris41 2885:
1.802 bisitz 2886: # -----------------------------------------------------------------------------
2887:
1.208 matthew 2888: sub track_student_link {
1.268 albertel 2889: my ($linktext,$sname,$sdom,$target,$start) = @_;
2890: my $link ="/adm/trackstudent?";
1.208 matthew 2891: my $title = 'View recent activity';
2892: if (defined($sname) && $sname !~ /^\s*$/ &&
2893: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2894: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2895: $title .= ' of this student';
1.268 albertel 2896: }
1.208 matthew 2897: if (defined($target) && $target !~ /^\s*$/) {
2898: $target = qq{target="$target"};
2899: } else {
2900: $target = '';
2901: }
1.268 albertel 2902: if ($start) { $link.='&start='.$start; }
1.554 albertel 2903: $title = &mt($title);
2904: $linktext = &mt($linktext);
1.448 albertel 2905: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2906: &help_open_topic('View_recent_activity');
1.208 matthew 2907: }
2908:
1.781 raeburn 2909: sub slot_reservations_link {
2910: my ($linktext,$sname,$sdom,$target) = @_;
2911: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
2912: my $title = 'View slot reservation history';
2913: if (defined($sname) && $sname !~ /^\s*$/ &&
2914: defined($sdom) && $sdom !~ /^\s*$/) {
2915: $link .= "&uname=$sname&udom=$sdom";
2916: $title .= ' of this student';
2917: }
2918: if (defined($target) && $target !~ /^\s*$/) {
2919: $target = qq{target="$target"};
2920: } else {
2921: $target = '';
2922: }
2923: $title = &mt($title);
2924: $linktext = &mt($linktext);
2925: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2926: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
2927:
2928: }
2929:
1.508 www 2930: # ===================================================== Display a student photo
2931:
2932:
1.509 albertel 2933: sub student_image_tag {
1.508 www 2934: my ($domain,$user)=@_;
2935: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2936: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2937: return '<img src="'.$imgsrc.'" align="right" />';
2938: } else {
2939: return '';
2940: }
2941: }
2942:
1.112 bowersj2 2943: =pod
2944:
2945: =back
2946:
2947: =head1 Access .tab File Data
2948:
2949: =over 4
2950:
1.648 raeburn 2951: =item * &languageids()
1.112 bowersj2 2952:
2953: returns list of all language ids
2954:
2955: =cut
2956:
1.14 harris41 2957: sub languageids {
1.16 harris41 2958: return sort(keys(%language));
1.14 harris41 2959: }
2960:
1.112 bowersj2 2961: =pod
2962:
1.648 raeburn 2963: =item * &languagedescription()
1.112 bowersj2 2964:
2965: returns description of a specified language id
2966:
2967: =cut
2968:
1.14 harris41 2969: sub languagedescription {
1.125 www 2970: my $code=shift;
2971: return ($supported_language{$code}?'* ':'').
2972: $language{$code}.
1.126 www 2973: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2974: }
2975:
2976: sub plainlanguagedescription {
2977: my $code=shift;
2978: return $language{$code};
2979: }
2980:
2981: sub supportedlanguagecode {
2982: my $code=shift;
2983: return $supported_language{$code};
1.97 www 2984: }
2985:
1.112 bowersj2 2986: =pod
2987:
1.648 raeburn 2988: =item * ©rightids()
1.112 bowersj2 2989:
2990: returns list of all copyrights
2991:
2992: =cut
2993:
2994: sub copyrightids {
2995: return sort(keys(%cprtag));
2996: }
2997:
2998: =pod
2999:
1.648 raeburn 3000: =item * ©rightdescription()
1.112 bowersj2 3001:
3002: returns description of a specified copyright id
3003:
3004: =cut
3005:
3006: sub copyrightdescription {
1.166 www 3007: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3008: }
1.197 matthew 3009:
3010: =pod
3011:
1.648 raeburn 3012: =item * &source_copyrightids()
1.192 taceyjo1 3013:
3014: returns list of all source copyrights
3015:
3016: =cut
3017:
3018: sub source_copyrightids {
3019: return sort(keys(%scprtag));
3020: }
3021:
3022: =pod
3023:
1.648 raeburn 3024: =item * &source_copyrightdescription()
1.192 taceyjo1 3025:
3026: returns description of a specified source copyright id
3027:
3028: =cut
3029:
3030: sub source_copyrightdescription {
3031: return &mt($scprtag{shift(@_)});
3032: }
1.112 bowersj2 3033:
3034: =pod
3035:
1.648 raeburn 3036: =item * &filecategories()
1.112 bowersj2 3037:
3038: returns list of all file categories
3039:
3040: =cut
3041:
3042: sub filecategories {
3043: return sort(keys(%category_extensions));
3044: }
3045:
3046: =pod
3047:
1.648 raeburn 3048: =item * &filecategorytypes()
1.112 bowersj2 3049:
3050: returns list of file types belonging to a given file
3051: category
3052:
3053: =cut
3054:
3055: sub filecategorytypes {
1.356 albertel 3056: my ($cat) = @_;
3057: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3058: }
3059:
3060: =pod
3061:
1.648 raeburn 3062: =item * &fileembstyle()
1.112 bowersj2 3063:
3064: returns embedding style for a specified file type
3065:
3066: =cut
3067:
3068: sub fileembstyle {
3069: return $fe{lc(shift(@_))};
1.169 www 3070: }
3071:
1.351 www 3072: sub filemimetype {
3073: return $fm{lc(shift(@_))};
3074: }
3075:
1.169 www 3076:
3077: sub filecategoryselect {
3078: my ($name,$value)=@_;
1.189 matthew 3079: return &select_form($value,$name,
1.169 www 3080: '' => &mt('Any category'),
3081: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3082: }
3083:
3084: =pod
3085:
1.648 raeburn 3086: =item * &filedescription()
1.112 bowersj2 3087:
3088: returns description for a specified file type
3089:
3090: =cut
3091:
3092: sub filedescription {
1.188 matthew 3093: my $file_description = $fd{lc(shift())};
3094: $file_description =~ s:([\[\]]):~$1:g;
3095: return &mt($file_description);
1.112 bowersj2 3096: }
3097:
3098: =pod
3099:
1.648 raeburn 3100: =item * &filedescriptionex()
1.112 bowersj2 3101:
3102: returns description for a specified file type with
3103: extra formatting
3104:
3105: =cut
3106:
3107: sub filedescriptionex {
3108: my $ex=shift;
1.188 matthew 3109: my $file_description = $fd{lc($ex)};
3110: $file_description =~ s:([\[\]]):~$1:g;
3111: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3112: }
3113:
3114: # End of .tab access
3115: =pod
3116:
3117: =back
3118:
3119: =cut
3120:
3121: # ------------------------------------------------------------------ File Types
3122: sub fileextensions {
3123: return sort(keys(%fe));
3124: }
3125:
1.97 www 3126: # ----------------------------------------------------------- Display Languages
3127: # returns a hash with all desired display languages
3128: #
3129:
3130: sub display_languages {
3131: my %languages=();
1.695 raeburn 3132: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3133: $languages{$lang}=1;
1.97 www 3134: }
3135: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3136: if ($env{'form.displaylanguage'}) {
1.356 albertel 3137: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3138: $languages{$lang}=1;
1.97 www 3139: }
3140: }
3141: return %languages;
1.14 harris41 3142: }
3143:
1.582 albertel 3144: sub languages {
3145: my ($possible_langs) = @_;
1.695 raeburn 3146: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3147: if (!ref($possible_langs)) {
3148: if( wantarray ) {
3149: return @preferred_langs;
3150: } else {
3151: return $preferred_langs[0];
3152: }
3153: }
3154: my %possibilities = map { $_ => 1 } (@$possible_langs);
3155: my @preferred_possibilities;
3156: foreach my $preferred_lang (@preferred_langs) {
3157: if (exists($possibilities{$preferred_lang})) {
3158: push(@preferred_possibilities, $preferred_lang);
3159: }
3160: }
3161: if( wantarray ) {
3162: return @preferred_possibilities;
3163: }
3164: return $preferred_possibilities[0];
3165: }
3166:
1.742 raeburn 3167: sub user_lang {
3168: my ($touname,$toudom,$fromcid) = @_;
3169: my @userlangs;
3170: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3171: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3172: $env{'course.'.$fromcid.'.languages'}));
3173: } else {
3174: my %langhash = &getlangs($touname,$toudom);
3175: if ($langhash{'languages'} ne '') {
3176: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3177: } else {
3178: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3179: if ($domdefs{'lang_def'} ne '') {
3180: @userlangs = ($domdefs{'lang_def'});
3181: }
3182: }
3183: }
3184: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3185: my $user_lh = Apache::localize->get_handle(@languages);
3186: return $user_lh;
3187: }
3188:
3189:
1.112 bowersj2 3190: ###############################################################
3191: ## Student Answer Attempts ##
3192: ###############################################################
3193:
3194: =pod
3195:
3196: =head1 Alternate Problem Views
3197:
3198: =over 4
3199:
1.648 raeburn 3200: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3201: $getattempt, $regexp, $gradesub)
3202:
3203: Return string with previous attempt on problem. Arguments:
3204:
3205: =over 4
3206:
3207: =item * $symb: Problem, including path
3208:
3209: =item * $username: username of the desired student
3210:
3211: =item * $domain: domain of the desired student
1.14 harris41 3212:
1.112 bowersj2 3213: =item * $course: Course ID
1.14 harris41 3214:
1.112 bowersj2 3215: =item * $getattempt: Leave blank for all attempts, otherwise put
3216: something
1.14 harris41 3217:
1.112 bowersj2 3218: =item * $regexp: if string matches this regexp, the string will be
3219: sent to $gradesub
1.14 harris41 3220:
1.112 bowersj2 3221: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3222:
1.112 bowersj2 3223: =back
1.14 harris41 3224:
1.112 bowersj2 3225: The output string is a table containing all desired attempts, if any.
1.16 harris41 3226:
1.112 bowersj2 3227: =cut
1.1 albertel 3228:
3229: sub get_previous_attempt {
1.43 ng 3230: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3231: my $prevattempts='';
1.43 ng 3232: no strict 'refs';
1.1 albertel 3233: if ($symb) {
1.3 albertel 3234: my (%returnhash)=
3235: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3236: if ($returnhash{'version'}) {
3237: my %lasthash=();
3238: my $version;
3239: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3240: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3241: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3242: }
1.1 albertel 3243: }
1.596 albertel 3244: $prevattempts=&start_data_table().&start_data_table_header_row();
3245: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3246: foreach my $key (sort(keys(%lasthash))) {
3247: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3248: if ($#parts > 0) {
1.31 albertel 3249: my $data=$parts[-1];
3250: pop(@parts);
1.596 albertel 3251: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3252: } else {
1.41 ng 3253: if ($#parts == 0) {
3254: $prevattempts.='<th>'.$parts[0].'</th>';
3255: } else {
3256: $prevattempts.='<th>'.$ign.'</th>';
3257: }
1.31 albertel 3258: }
1.16 harris41 3259: }
1.596 albertel 3260: $prevattempts.=&end_data_table_header_row();
1.40 ng 3261: if ($getattempt eq '') {
3262: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3263: $prevattempts.=&start_data_table_row().
3264: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3265: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3266: my $value = &format_previous_attempt_value($key,
3267: $returnhash{$version.':'.$key});
3268: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3269: }
1.596 albertel 3270: $prevattempts.=&end_data_table_row();
1.40 ng 3271: }
1.1 albertel 3272: }
1.596 albertel 3273: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3274: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3275: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3276: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3277: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3278: }
1.596 albertel 3279: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3280: } else {
1.596 albertel 3281: $prevattempts=
3282: &start_data_table().&start_data_table_row().
3283: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3284: &end_data_table_row().&end_data_table();
1.1 albertel 3285: }
3286: } else {
1.596 albertel 3287: $prevattempts=
3288: &start_data_table().&start_data_table_row().
3289: '<td>'.&mt('No data.').'</td>'.
3290: &end_data_table_row().&end_data_table();
1.1 albertel 3291: }
1.10 albertel 3292: }
3293:
1.581 albertel 3294: sub format_previous_attempt_value {
3295: my ($key,$value) = @_;
3296: if ($key =~ /timestamp/) {
3297: $value = &Apache::lonlocal::locallocaltime($value);
3298: } elsif (ref($value) eq 'ARRAY') {
3299: $value = '('.join(', ', @{ $value }).')';
3300: } else {
3301: $value = &unescape($value);
3302: }
3303: return $value;
3304: }
3305:
3306:
1.107 albertel 3307: sub relative_to_absolute {
3308: my ($url,$output)=@_;
3309: my $parser=HTML::TokeParser->new(\$output);
3310: my $token;
3311: my $thisdir=$url;
3312: my @rlinks=();
3313: while ($token=$parser->get_token) {
3314: if ($token->[0] eq 'S') {
3315: if ($token->[1] eq 'a') {
3316: if ($token->[2]->{'href'}) {
3317: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3318: }
3319: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3320: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3321: } elsif ($token->[1] eq 'base') {
3322: $thisdir=$token->[2]->{'href'};
3323: }
3324: }
3325: }
3326: $thisdir=~s-/[^/]*$--;
1.356 albertel 3327: foreach my $link (@rlinks) {
1.726 raeburn 3328: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3329: ($link=~/^\//) ||
3330: ($link=~/^javascript:/i) ||
3331: ($link=~/^mailto:/i) ||
3332: ($link=~/^\#/)) {
3333: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3334: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3335: }
3336: }
3337: # -------------------------------------------------- Deal with Applet codebases
3338: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3339: return $output;
3340: }
3341:
1.112 bowersj2 3342: =pod
3343:
1.648 raeburn 3344: =item * &get_student_view()
1.112 bowersj2 3345:
3346: show a snapshot of what student was looking at
3347:
3348: =cut
3349:
1.10 albertel 3350: sub get_student_view {
1.186 albertel 3351: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3352: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3353: my (%form);
1.10 albertel 3354: my @elements=('symb','courseid','domain','username');
3355: foreach my $element (@elements) {
1.186 albertel 3356: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3357: }
1.186 albertel 3358: if (defined($moreenv)) {
3359: %form=(%form,%{$moreenv});
3360: }
1.236 albertel 3361: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3362: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3363: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3364: $userview=~s/\<body[^\>]*\>//gi;
3365: $userview=~s/\<\/body\>//gi;
3366: $userview=~s/\<html\>//gi;
3367: $userview=~s/\<\/html\>//gi;
3368: $userview=~s/\<head\>//gi;
3369: $userview=~s/\<\/head\>//gi;
3370: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3371: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3372: if (wantarray) {
3373: return ($userview,$response);
3374: } else {
3375: return $userview;
3376: }
3377: }
3378:
3379: sub get_student_view_with_retries {
3380: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3381:
3382: my $ok = 0; # True if we got a good response.
3383: my $content;
3384: my $response;
3385:
3386: # Try to get the student_view done. within the retries count:
3387:
3388: do {
3389: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3390: $ok = $response->is_success;
3391: if (!$ok) {
3392: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3393: }
3394: $retries--;
3395: } while (!$ok && ($retries > 0));
3396:
3397: if (!$ok) {
3398: $content = ''; # On error return an empty content.
3399: }
1.651 www 3400: if (wantarray) {
3401: return ($content, $response);
3402: } else {
3403: return $content;
3404: }
1.11 albertel 3405: }
3406:
1.112 bowersj2 3407: =pod
3408:
1.648 raeburn 3409: =item * &get_student_answers()
1.112 bowersj2 3410:
3411: show a snapshot of how student was answering problem
3412:
3413: =cut
3414:
1.11 albertel 3415: sub get_student_answers {
1.100 sakharuk 3416: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3417: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3418: my (%moreenv);
1.11 albertel 3419: my @elements=('symb','courseid','domain','username');
3420: foreach my $element (@elements) {
1.186 albertel 3421: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3422: }
1.186 albertel 3423: $moreenv{'grade_target'}='answer';
3424: %moreenv=(%form,%moreenv);
1.497 raeburn 3425: $feedurl = &Apache::lonnet::clutter($feedurl);
3426: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3427: return $userview;
1.1 albertel 3428: }
1.116 albertel 3429:
3430: =pod
3431:
3432: =item * &submlink()
3433:
1.242 albertel 3434: Inputs: $text $uname $udom $symb $target
1.116 albertel 3435:
3436: Returns: A link to grades.pm such as to see the SUBM view of a student
3437:
3438: =cut
3439:
3440: ###############################################
3441: sub submlink {
1.242 albertel 3442: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3443: if (!($uname && $udom)) {
3444: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3445: &Apache::lonnet::whichuser($symb);
1.116 albertel 3446: if (!$symb) { $symb=$cursymb; }
3447: }
1.254 matthew 3448: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3449: $symb=&escape($symb);
1.242 albertel 3450: if ($target) { $target="target=\"$target\""; }
3451: return '<a href="/adm/grades?&command=submission&'.
3452: 'symb='.$symb.'&student='.$uname.
3453: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3454: }
3455: ##############################################
3456:
3457: =pod
3458:
3459: =item * &pgrdlink()
3460:
3461: Inputs: $text $uname $udom $symb $target
3462:
3463: Returns: A link to grades.pm such as to see the PGRD view of a student
3464:
3465: =cut
3466:
3467: ###############################################
3468: sub pgrdlink {
3469: my $link=&submlink(@_);
3470: $link=~s/(&command=submission)/$1&showgrading=yes/;
3471: return $link;
3472: }
3473: ##############################################
3474:
3475: =pod
3476:
3477: =item * &pprmlink()
3478:
3479: Inputs: $text $uname $udom $symb $target
3480:
3481: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3482: student and a specific resource
1.242 albertel 3483:
3484: =cut
3485:
3486: ###############################################
3487: sub pprmlink {
3488: my ($text,$uname,$udom,$symb,$target)=@_;
3489: if (!($uname && $udom)) {
3490: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3491: &Apache::lonnet::whichuser($symb);
1.242 albertel 3492: if (!$symb) { $symb=$cursymb; }
3493: }
1.254 matthew 3494: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3495: $symb=&escape($symb);
1.242 albertel 3496: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3497: return '<a href="/adm/parmset?command=set&'.
3498: 'symb='.$symb.'&uname='.$uname.
3499: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3500: }
3501: ##############################################
1.37 matthew 3502:
1.112 bowersj2 3503: =pod
3504:
3505: =back
3506:
3507: =cut
3508:
1.37 matthew 3509: ###############################################
1.51 www 3510:
3511:
3512: sub timehash {
1.687 raeburn 3513: my ($thistime) = @_;
3514: my $timezone = &Apache::lonlocal::gettimezone();
3515: my $dt = DateTime->from_epoch(epoch => $thistime)
3516: ->set_time_zone($timezone);
3517: my $wday = $dt->day_of_week();
3518: if ($wday == 7) { $wday = 0; }
3519: return ( 'second' => $dt->second(),
3520: 'minute' => $dt->minute(),
3521: 'hour' => $dt->hour(),
3522: 'day' => $dt->day_of_month(),
3523: 'month' => $dt->month(),
3524: 'year' => $dt->year(),
3525: 'weekday' => $wday,
3526: 'dayyear' => $dt->day_of_year(),
3527: 'dlsav' => $dt->is_dst() );
1.51 www 3528: }
3529:
1.370 www 3530: sub utc_string {
3531: my ($date)=@_;
1.371 www 3532: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3533: }
3534:
1.51 www 3535: sub maketime {
3536: my %th=@_;
1.687 raeburn 3537: my ($epoch_time,$timezone,$dt);
3538: $timezone = &Apache::lonlocal::gettimezone();
3539: eval {
3540: $dt = DateTime->new( year => $th{'year'},
3541: month => $th{'month'},
3542: day => $th{'day'},
3543: hour => $th{'hour'},
3544: minute => $th{'minute'},
3545: second => $th{'second'},
3546: time_zone => $timezone,
3547: );
3548: };
3549: if (!$@) {
3550: $epoch_time = $dt->epoch;
3551: if ($epoch_time) {
3552: return $epoch_time;
3553: }
3554: }
1.51 www 3555: return POSIX::mktime(
3556: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3557: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3558: }
3559:
3560: #########################################
1.51 www 3561:
3562: sub findallcourses {
1.482 raeburn 3563: my ($roles,$uname,$udom) = @_;
1.355 albertel 3564: my %roles;
3565: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3566: my %courses;
1.51 www 3567: my $now=time;
1.482 raeburn 3568: if (!defined($uname)) {
3569: $uname = $env{'user.name'};
3570: }
3571: if (!defined($udom)) {
3572: $udom = $env{'user.domain'};
3573: }
3574: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3575: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3576: if (!%roles) {
3577: %roles = (
3578: cc => 1,
3579: in => 1,
3580: ep => 1,
3581: ta => 1,
3582: cr => 1,
3583: st => 1,
3584: );
3585: }
3586: foreach my $entry (keys(%roleshash)) {
3587: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3588: if ($trole =~ /^cr/) {
3589: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3590: } else {
3591: next if (!exists($roles{$trole}));
3592: }
3593: if ($tend) {
3594: next if ($tend < $now);
3595: }
3596: if ($tstart) {
3597: next if ($tstart > $now);
3598: }
3599: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3600: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3601: if ($secpart eq '') {
3602: ($cnum,$role) = split(/_/,$cnumpart);
3603: $sec = 'none';
3604: $realsec = '';
3605: } else {
3606: $cnum = $cnumpart;
3607: ($sec,$role) = split(/_/,$secpart);
3608: $realsec = $sec;
1.490 raeburn 3609: }
1.482 raeburn 3610: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3611: }
3612: } else {
3613: foreach my $key (keys(%env)) {
1.483 albertel 3614: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3615: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3616: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3617: next if ($role eq 'ca' || $role eq 'aa');
3618: next if (%roles && !exists($roles{$role}));
3619: my ($starttime,$endtime)=split(/\./,$env{$key});
3620: my $active=1;
3621: if ($starttime) {
3622: if ($now<$starttime) { $active=0; }
3623: }
3624: if ($endtime) {
3625: if ($now>$endtime) { $active=0; }
3626: }
3627: if ($active) {
3628: if ($sec eq '') {
3629: $sec = 'none';
3630: }
3631: $courses{$cdom.'_'.$cnum}{$sec} =
3632: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3633: }
3634: }
1.51 www 3635: }
3636: }
1.474 raeburn 3637: return %courses;
1.51 www 3638: }
1.37 matthew 3639:
1.54 www 3640: ###############################################
1.474 raeburn 3641:
3642: sub blockcheck {
1.482 raeburn 3643: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3644:
3645: if (!defined($udom)) {
3646: $udom = $env{'user.domain'};
3647: }
3648: if (!defined($uname)) {
3649: $uname = $env{'user.name'};
3650: }
3651:
3652: # If uname and udom are for a course, check for blocks in the course.
3653:
3654: if (&Apache::lonnet::is_course($udom,$uname)) {
3655: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3656: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3657: return ($startblock,$endblock);
3658: }
1.474 raeburn 3659:
1.502 raeburn 3660: my $startblock = 0;
3661: my $endblock = 0;
1.482 raeburn 3662: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3663:
1.490 raeburn 3664: # If uname is for a user, and activity is course-specific, i.e.,
3665: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3666:
1.490 raeburn 3667: if (($activity eq 'boards' || $activity eq 'chat' ||
3668: $activity eq 'groups') && ($env{'request.course.id'})) {
3669: foreach my $key (keys(%live_courses)) {
3670: if ($key ne $env{'request.course.id'}) {
3671: delete($live_courses{$key});
3672: }
3673: }
3674: }
3675:
3676: my $otheruser = 0;
3677: my %own_courses;
3678: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3679: # Resource belongs to user other than current user.
3680: $otheruser = 1;
3681: # Gather courses for current user
3682: %own_courses =
3683: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3684: }
3685:
3686: # Gather active course roles - course coordinator, instructor,
3687: # exam proctor, ta, student, or custom role.
1.474 raeburn 3688:
3689: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3690: my ($cdom,$cnum);
3691: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3692: $cdom = $env{'course.'.$course.'.domain'};
3693: $cnum = $env{'course.'.$course.'.num'};
3694: } else {
1.490 raeburn 3695: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3696: }
3697: my $no_ownblock = 0;
3698: my $no_userblock = 0;
1.533 raeburn 3699: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3700: # Check if current user has 'evb' priv for this
3701: if (defined($own_courses{$course})) {
3702: foreach my $sec (keys(%{$own_courses{$course}})) {
3703: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3704: if ($sec ne 'none') {
3705: $checkrole .= '/'.$sec;
3706: }
3707: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3708: $no_ownblock = 1;
3709: last;
3710: }
3711: }
3712: }
3713: # if they have 'evb' priv and are currently not playing student
3714: next if (($no_ownblock) &&
3715: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3716: }
1.474 raeburn 3717: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3718: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3719: if ($sec ne 'none') {
1.482 raeburn 3720: $checkrole .= '/'.$sec;
1.474 raeburn 3721: }
1.490 raeburn 3722: if ($otheruser) {
3723: # Resource belongs to user other than current user.
3724: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3725: my ($trole,$tdom,$tnum,$tsec);
3726: my $entry = $live_courses{$course}{$sec};
3727: if ($entry =~ /^cr/) {
3728: ($trole,$tdom,$tnum,$tsec) =
3729: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3730: } else {
3731: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3732: }
3733: my ($spec,$area,$trest,%allroles,%userroles);
3734: $area = '/'.$tdom.'/'.$tnum;
3735: $trest = $tnum;
3736: if ($tsec ne '') {
3737: $area .= '/'.$tsec;
3738: $trest .= '/'.$tsec;
3739: }
3740: $spec = $trole.'.'.$area;
3741: if ($trole =~ /^cr/) {
3742: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3743: $tdom,$spec,$trest,$area);
3744: } else {
3745: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3746: $tdom,$spec,$trest,$area);
3747: }
3748: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3749: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3750: if ($1) {
3751: $no_userblock = 1;
3752: last;
3753: }
3754: }
1.490 raeburn 3755: } else {
3756: # Resource belongs to current user
3757: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3758: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3759: $no_ownblock = 1;
3760: last;
3761: }
1.474 raeburn 3762: }
3763: }
3764: # if they have the evb priv and are currently not playing student
1.482 raeburn 3765: next if (($no_ownblock) &&
1.491 albertel 3766: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3767: next if ($no_userblock);
1.474 raeburn 3768:
1.490 raeburn 3769: # Retrieve blocking times and identity of blocker for course
3770: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3771:
3772: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3773: if (($start != 0) &&
3774: (($startblock == 0) || ($startblock > $start))) {
3775: $startblock = $start;
3776: }
3777: if (($end != 0) &&
3778: (($endblock == 0) || ($endblock < $end))) {
3779: $endblock = $end;
3780: }
1.490 raeburn 3781: }
3782: return ($startblock,$endblock);
3783: }
3784:
3785: sub get_blocks {
3786: my ($setters,$activity,$cdom,$cnum) = @_;
3787: my $startblock = 0;
3788: my $endblock = 0;
3789: my $course = $cdom.'_'.$cnum;
3790: $setters->{$course} = {};
3791: $setters->{$course}{'staff'} = [];
3792: $setters->{$course}{'times'} = [];
3793: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3794: foreach my $record (keys(%records)) {
3795: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3796: if ($start <= time && $end >= time) {
3797: my ($staff_name,$staff_dom,$title,$blocks) =
3798: &parse_block_record($records{$record});
3799: if ($blocks->{$activity} eq 'on') {
3800: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3801: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3802: if ( ($startblock == 0) || ($startblock > $start) ) {
3803: $startblock = $start;
1.490 raeburn 3804: }
1.491 albertel 3805: if ( ($endblock == 0) || ($endblock < $end) ) {
3806: $endblock = $end;
1.474 raeburn 3807: }
3808: }
3809: }
3810: }
3811: return ($startblock,$endblock);
3812: }
3813:
3814: sub parse_block_record {
3815: my ($record) = @_;
3816: my ($setuname,$setudom,$title,$blocks);
3817: if (ref($record) eq 'HASH') {
3818: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3819: $title = &unescape($record->{'event'});
3820: $blocks = $record->{'blocks'};
3821: } else {
3822: my @data = split(/:/,$record,3);
3823: if (scalar(@data) eq 2) {
3824: $title = $data[1];
3825: ($setuname,$setudom) = split(/@/,$data[0]);
3826: } else {
3827: ($setuname,$setudom,$title) = @data;
3828: }
3829: $blocks = { 'com' => 'on' };
3830: }
3831: return ($setuname,$setudom,$title,$blocks);
3832: }
3833:
3834: sub build_block_table {
3835: my ($startblock,$endblock,$setters) = @_;
3836: my %lt = &Apache::lonlocal::texthash(
3837: 'cacb' => 'Currently active communication blocks',
3838: 'cour' => 'Course',
3839: 'dura' => 'Duration',
3840: 'blse' => 'Block set by'
3841: );
3842: my $output;
1.476 raeburn 3843: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3844: $output .= &start_data_table();
3845: $output .= '
3846: <tr>
3847: <th>'.$lt{'cour'}.'</th>
3848: <th>'.$lt{'dura'}.'</th>
3849: <th>'.$lt{'blse'}.'</th>
3850: </tr>
3851: ';
3852: foreach my $course (keys(%{$setters})) {
3853: my %courseinfo=&Apache::lonnet::coursedescription($course);
3854: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3855: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3856: my $fullname = &plainname($uname,$udom);
3857: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3858: && $env{'user.name'} ne 'public'
3859: && $env{'user.domain'} ne 'public') {
3860: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3861: }
1.474 raeburn 3862: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3863: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3864: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3865: $output .= &Apache::loncommon::start_data_table_row().
3866: '<td>'.$courseinfo{'description'}.'</td>'.
3867: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3868: '<td>'.$fullname.'</td>'.
1.474 raeburn 3869: &Apache::loncommon::end_data_table_row();
3870: }
3871: }
3872: $output .= &end_data_table();
3873: }
3874:
1.490 raeburn 3875: sub blocking_status {
3876: my ($activity,$uname,$udom) = @_;
3877: my %setters;
3878: my ($blocked,$output,$ownitem,$is_course);
3879: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3880: if ($startblock && $endblock) {
3881: $blocked = 1;
3882: if (wantarray) {
3883: my $category;
3884: if ($activity eq 'boards') {
3885: $category = 'Discussion posts in this course';
3886: } elsif ($activity eq 'blogs') {
3887: $category = 'Blogs';
3888: } elsif ($activity eq 'port') {
3889: if (defined($uname) && defined($udom)) {
3890: if ($uname eq $env{'user.name'} &&
3891: $udom eq $env{'user.domain'}) {
3892: $ownitem = 1;
3893: }
3894: }
3895: $is_course = &Apache::lonnet::is_course($udom,$uname);
3896: if ($ownitem) {
3897: $category = 'Your portfolio files';
3898: } elsif ($is_course) {
3899: my $coursedesc;
3900: foreach my $course (keys(%setters)) {
3901: my %courseinfo =
3902: &Apache::lonnet::coursedescription($course);
3903: $coursedesc = $courseinfo{'description'};
3904: }
1.764 weissno 3905: $category = "Group portfolio in the course '$coursedesc'";
1.490 raeburn 3906: } else {
3907: $category = 'Portfolio files belonging to ';
3908: if ($env{'user.name'} eq 'public' &&
3909: $env{'user.domain'} eq 'public') {
3910: $category .= &plainname($uname,$udom);
3911: } else {
3912: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3913: }
3914: }
3915: } elsif ($activity eq 'groups') {
3916: $category = 'Groups in this course';
3917: }
3918: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3919: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3920: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3921: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3922: $output .= &build_block_table($startblock,$endblock,\%setters);
3923: }
3924: }
3925: }
3926: if (wantarray) {
3927: return ($blocked,$output);
3928: } else {
3929: return $blocked;
3930: }
3931: }
3932:
1.60 matthew 3933: ###############################################
3934:
1.682 raeburn 3935: sub check_ip_acc {
3936: my ($acc)=@_;
3937: &Apache::lonxml::debug("acc is $acc");
3938: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3939: return 1;
3940: }
3941: my $allowed=0;
3942: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3943:
3944: my $name;
3945: foreach my $pattern (split(',',$acc)) {
3946: $pattern =~ s/^\s*//;
3947: $pattern =~ s/\s*$//;
3948: if ($pattern =~ /\*$/) {
3949: #35.8.*
3950: $pattern=~s/\*//;
3951: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3952: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3953: #35.8.3.[34-56]
3954: my $low=$2;
3955: my $high=$3;
3956: $pattern=$1;
3957: if ($ip =~ /^\Q$pattern\E/) {
3958: my $last=(split(/\./,$ip))[3];
3959: if ($last <=$high && $last >=$low) { $allowed=1; }
3960: }
3961: } elsif ($pattern =~ /^\*/) {
3962: #*.msu.edu
3963: $pattern=~s/\*//;
3964: if (!defined($name)) {
3965: use Socket;
3966: my $netaddr=inet_aton($ip);
3967: ($name)=gethostbyaddr($netaddr,AF_INET);
3968: }
3969: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3970: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3971: #127.0.0.1
3972: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3973: } else {
3974: #some.name.com
3975: if (!defined($name)) {
3976: use Socket;
3977: my $netaddr=inet_aton($ip);
3978: ($name)=gethostbyaddr($netaddr,AF_INET);
3979: }
3980: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3981: }
3982: if ($allowed) { last; }
3983: }
3984: return $allowed;
3985: }
3986:
3987: ###############################################
3988:
1.60 matthew 3989: =pod
3990:
1.112 bowersj2 3991: =head1 Domain Template Functions
3992:
3993: =over 4
3994:
3995: =item * &determinedomain()
1.60 matthew 3996:
3997: Inputs: $domain (usually will be undef)
3998:
1.63 www 3999: Returns: Determines which domain should be used for designs
1.60 matthew 4000:
4001: =cut
1.54 www 4002:
1.60 matthew 4003: ###############################################
1.63 www 4004: sub determinedomain {
4005: my $domain=shift;
1.531 albertel 4006: if (! $domain) {
1.60 matthew 4007: # Determine domain if we have not been given one
4008: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 4009: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4010: if ($env{'request.role.domain'}) {
4011: $domain=$env{'request.role.domain'};
1.60 matthew 4012: }
4013: }
1.63 www 4014: return $domain;
4015: }
4016: ###############################################
1.517 raeburn 4017:
1.518 albertel 4018: sub devalidate_domconfig_cache {
4019: my ($udom)=@_;
4020: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4021: }
4022:
4023: # ---------------------- Get domain configuration for a domain
4024: sub get_domainconf {
4025: my ($udom) = @_;
4026: my $cachetime=1800;
4027: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4028: if (defined($cached)) { return %{$result}; }
4029:
4030: my %domconfig = &Apache::lonnet::get_dom('configuration',
4031: ['login','rolecolors'],$udom);
1.632 raeburn 4032: my (%designhash,%legacy);
1.518 albertel 4033: if (keys(%domconfig) > 0) {
4034: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 4035: if (keys(%{$domconfig{'login'}})) {
4036: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 4037: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4038: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4039: $designhash{$udom.'.login.'.$key.'_'.$img} =
4040: $domconfig{'login'}{$key}{$img};
4041: }
4042: } else {
4043: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4044: }
1.632 raeburn 4045: }
4046: } else {
4047: $legacy{'login'} = 1;
1.518 albertel 4048: }
1.632 raeburn 4049: } else {
4050: $legacy{'login'} = 1;
1.518 albertel 4051: }
4052: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 4053: if (keys(%{$domconfig{'rolecolors'}})) {
4054: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4055: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4056: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4057: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4058: }
1.518 albertel 4059: }
4060: }
1.632 raeburn 4061: } else {
4062: $legacy{'rolecolors'} = 1;
1.518 albertel 4063: }
1.632 raeburn 4064: } else {
4065: $legacy{'rolecolors'} = 1;
1.518 albertel 4066: }
1.632 raeburn 4067: if (keys(%legacy) > 0) {
4068: my %legacyhash = &get_legacy_domconf($udom);
4069: foreach my $item (keys(%legacyhash)) {
4070: if ($item =~ /^\Q$udom\E\.login/) {
4071: if ($legacy{'login'}) {
4072: $designhash{$item} = $legacyhash{$item};
4073: }
4074: } else {
4075: if ($legacy{'rolecolors'}) {
4076: $designhash{$item} = $legacyhash{$item};
4077: }
1.518 albertel 4078: }
4079: }
4080: }
1.632 raeburn 4081: } else {
4082: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4083: }
4084: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4085: $cachetime);
4086: return %designhash;
4087: }
4088:
1.632 raeburn 4089: sub get_legacy_domconf {
4090: my ($udom) = @_;
4091: my %legacyhash;
4092: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4093: my $designfile = $designdir.'/'.$udom.'.tab';
4094: if (-e $designfile) {
4095: if ( open (my $fh,"<$designfile") ) {
4096: while (my $line = <$fh>) {
4097: next if ($line =~ /^\#/);
4098: chomp($line);
4099: my ($key,$val)=(split(/\=/,$line));
4100: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4101: }
4102: close($fh);
4103: }
4104: }
4105: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4106: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4107: }
4108: return %legacyhash;
4109: }
4110:
1.63 www 4111: =pod
4112:
1.112 bowersj2 4113: =item * &domainlogo()
1.63 www 4114:
4115: Inputs: $domain (usually will be undef)
4116:
4117: Returns: A link to a domain logo, if the domain logo exists.
4118: If the domain logo does not exist, a description of the domain.
4119:
4120: =cut
1.112 bowersj2 4121:
1.63 www 4122: ###############################################
4123: sub domainlogo {
1.517 raeburn 4124: my $domain = &determinedomain(shift);
1.518 albertel 4125: my %designhash = &get_domainconf($domain);
1.517 raeburn 4126: # See if there is a logo
4127: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4128: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4129: if ($imgsrc =~ m{^/(adm|res)/}) {
4130: if ($imgsrc =~ m{^/res/}) {
4131: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4132: &Apache::lonnet::repcopy($local_name);
4133: }
4134: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4135: }
4136: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4137: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4138: return &Apache::lonnet::domain($domain,'description');
1.59 www 4139: } else {
1.60 matthew 4140: return '';
1.59 www 4141: }
4142: }
1.63 www 4143: ##############################################
4144:
4145: =pod
4146:
1.112 bowersj2 4147: =item * &designparm()
1.63 www 4148:
4149: Inputs: $which parameter; $domain (usually will be undef)
4150:
4151: Returns: value of designparamter $which
4152:
4153: =cut
1.112 bowersj2 4154:
1.397 albertel 4155:
1.400 albertel 4156: ##############################################
1.397 albertel 4157: sub designparm {
4158: my ($which,$domain)=@_;
4159: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 4160: return $env{'environment.color.'.$which};
1.96 www 4161: }
1.63 www 4162: $domain=&determinedomain($domain);
1.518 albertel 4163: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4164: my $output;
1.517 raeburn 4165: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 4166: $output = $domdesign{$domain.'.'.$which};
1.63 www 4167: } else {
1.520 raeburn 4168: $output = $defaultdesign{$which};
4169: }
4170: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4171: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4172: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 4173: if ($output =~ m{^/res/}) {
4174: my $local_name = &Apache::lonnet::filelocation('',$output);
4175: &Apache::lonnet::repcopy($local_name);
4176: }
1.520 raeburn 4177: $output = &lonhttpdurl($output);
4178: }
1.63 www 4179: }
1.520 raeburn 4180: return $output;
1.63 www 4181: }
1.59 www 4182:
1.822 bisitz 4183: ##############################################
4184: =pod
4185:
4186: =item * &head_subbox()
4187:
4188: Inputs: $content (contains HTML code with page functions, etc.)
4189:
4190: Returns: HTML div with $content
4191: To be included in page header
4192:
4193: =cut
4194:
4195: sub head_subbox {
4196: my ($content)=@_;
4197: my $output =
4198: '<div id="LC_head_subbox2">' #FIXME: solve conflicts with lonhtmlcommon:breadcrumbs LC_head_subbox
4199: .$content
4200: .'</div>'
4201: }
4202:
4203: ##############################################
4204: =pod
4205:
4206: =item * &CSTR_pageheader()
4207:
4208: Inputs: ./.
4209:
4210: Returns: HTML div with CSTR path and recent box
4211: To be included on Construction Space pages
4212:
4213: =cut
4214:
4215: sub CSTR_pageheader {
4216: # this is for resources; directories have customtitle, and crumbs
4217: # and select recent are created in lonpubdir.pm
4218: my ($uname,$thisdisfn)=
4219: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4220: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4221: $formaction=~s/\/+/\//g;
4222:
4223: my $parentpath = '';
4224: my $lastitem = '';
4225: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4226: $parentpath = $1;
4227: $lastitem = $2;
4228: } else {
4229: $lastitem = $thisdisfn;
4230: }
4231: return
4232: '<div>'
4233: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4234: .'<b>'.&mt('Construction Space:').'</b> '
4235: .'<form name="dirs" method="post" action="'.$formaction
4236: .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
4237: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
4238: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4239: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4240: .'</form>'
4241: .&Apache::lonmenu::constspaceform()
4242: .'</div>';
4243: }
4244:
1.60 matthew 4245: ###############################################
4246: ###############################################
4247:
4248: =pod
4249:
1.112 bowersj2 4250: =back
4251:
1.549 albertel 4252: =head1 HTML Helpers
1.112 bowersj2 4253:
4254: =over 4
4255:
4256: =item * &bodytag()
1.60 matthew 4257:
4258: Returns a uniform header for LON-CAPA web pages.
4259:
4260: Inputs:
4261:
1.112 bowersj2 4262: =over 4
4263:
4264: =item * $title, A title to be displayed on the page.
4265:
4266: =item * $function, the current role (can be undef).
4267:
4268: =item * $addentries, extra parameters for the <body> tag.
4269:
4270: =item * $bodyonly, if defined, only return the <body> tag.
4271:
4272: =item * $domain, if defined, force a given domain.
4273:
4274: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4275: text interface only)
1.60 matthew 4276:
1.326 albertel 4277: =item * $customtitle, alternate text to use instead of $title
4278: in the title box that appears, this text
4279: is not auto translated like the $title is
1.309 albertel 4280:
1.814 bisitz 4281: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4282: navigational links
1.317 albertel 4283:
1.338 albertel 4284: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4285:
1.361 albertel 4286: =item * $no_inline_link, if true and in remote mode, don't show the
4287: 'Switch To Inline Menu' link
4288:
1.460 albertel 4289: =item * $args, optional argument valid values are
4290: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4291: inherit_jsmath -> when creating popup window in a page,
4292: should it have jsmath forced on by the
4293: current page
1.460 albertel 4294:
1.112 bowersj2 4295: =back
4296:
1.60 matthew 4297: Returns: A uniform header for LON-CAPA web pages.
4298: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4299: If $bodyonly is undef or zero, an html string containing a <body> tag and
4300: other decorations will be returned.
4301:
4302: =cut
4303:
1.54 www 4304: sub bodytag {
1.309 albertel 4305: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.816 bisitz 4306: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339 albertel 4307:
1.460 albertel 4308: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4309:
1.183 matthew 4310: $function = &get_users_function() if (!$function);
1.339 albertel 4311: my $img = &designparm($function.'.img',$domain);
4312: my $font = &designparm($function.'.font',$domain);
4313: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4314:
1.803 bisitz 4315: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 4316: 'bgcolor' => $pgbg,
1.339 albertel 4317: 'text' => $font,
4318: 'alink' => &designparm($function.'.alink',$domain),
4319: 'vlink' => &designparm($function.'.vlink',$domain),
4320: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4321: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4322:
1.63 www 4323: # role and realm
1.378 raeburn 4324: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4325: if ($role eq 'ca') {
1.479 albertel 4326: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4327: $realm = &plainname($rname,$rdom);
1.378 raeburn 4328: }
1.55 www 4329: # realm
1.258 albertel 4330: if ($env{'request.course.id'}) {
1.378 raeburn 4331: if ($env{'request.role'} !~ /^cr/) {
4332: $role = &Apache::lonnet::plaintext($role,&course_type());
4333: }
1.359 albertel 4334: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4335: } else {
4336: $role = &Apache::lonnet::plaintext($role);
1.54 www 4337: }
1.433 albertel 4338:
1.359 albertel 4339: if (!$realm) { $realm=' '; }
1.55 www 4340: # Set messages
1.60 matthew 4341: my $messages=&domainlogo($domain);
1.330 albertel 4342:
1.438 albertel 4343: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4344:
1.101 www 4345: # construct main body tag
1.359 albertel 4346: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4347: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4348:
1.530 albertel 4349: if ($bodyonly) {
1.60 matthew 4350: return $bodytag;
1.798 tempelho 4351: }
1.359 albertel 4352:
1.410 albertel 4353: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4354: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4355: undef($role);
1.434 albertel 4356: } else {
4357: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4358: }
1.359 albertel 4359:
4360: my $roleinfo=(<<ENDROLE);
4361: <td class="LC_title_bar_who">
4362: <div class="LC_title_bar_name">
1.410 albertel 4363: $name
1.361 albertel 4364:
1.359 albertel 4365: </div>
4366: <div class="LC_title_bar_role">
1.361 albertel 4367: $role
1.359 albertel 4368: </div>
4369: <div class="LC_title_bar_realm">
1.361 albertel 4370: $realm
1.359 albertel 4371: </div>
1.206 albertel 4372: </td>
4373: ENDROLE
1.235 raeburn 4374:
1.762 bisitz 4375: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4376: if ($customtitle) {
4377: $titleinfo = $customtitle;
4378: }
4379: #
4380: # Extra info if you are the DC
4381: my $dc_info = '';
4382: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4383: $env{'course.'.$env{'request.course.id'}.
4384: '.domain'}.'/'})) {
4385: my $cid = $env{'request.course.id'};
4386: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4387: $dc_info =~ s/\s+$//;
1.359 albertel 4388: $dc_info = '('.$dc_info.')';
4389: }
4390:
1.644 www 4391: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4392: # No Remote
1.258 albertel 4393: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4394: $forcereg=1;
4395: }
4396:
1.822 bisitz 4397: if (!$customtitle && $env{'request.state'} eq 'construct') {
4398: $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4399: }
1.359 albertel 4400:
1.816 bisitz 4401: my $titletable = '<table id="LC_title_bar">'
4402: ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
4403: .'</tr></table>';
4404:
1.814 bisitz 4405: if ($no_nav_bar) {
1.359 albertel 4406: $bodytag .= $titletable;
4407: } else {
1.813 bisitz 4408: $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
4409: <em>$realm</em> $dc_info</div>|;
1.359 albertel 4410: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4411: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4412: $titletable);
1.272 raeburn 4413: } else {
1.336 albertel 4414: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4415: $titletable;
1.272 raeburn 4416: }
1.235 raeburn 4417: }
4418: return $bodytag;
1.94 www 4419: }
1.95 www 4420:
1.93 www 4421: #
1.95 www 4422: # Top frame rendering, Remote is up
1.93 www 4423: #
1.359 albertel 4424:
1.517 raeburn 4425: my $imgsrc = $img;
4426: if ($img =~ /^\/adm/) {
1.575 albertel 4427: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4428: }
4429: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4430:
1.305 www 4431: # Explicit link to get inline menu
1.361 albertel 4432: my $menu= ($no_inline_link?''
4433: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4434: #
1.94 www 4435: return(<<ENDBODY);
1.60 matthew 4436: $bodytag
1.359 albertel 4437: <table id="LC_title_bar" class="LC_with_remote">
1.791 tempelho 4438: <tr><td>$upperleft</td>
4439: <td>$messages </td>
1.54 www 4440: </tr>
1.359 albertel 4441: <tr><td>$titleinfo $dc_info $menu</td>
4442: $roleinfo
1.368 albertel 4443: </tr>
1.356 albertel 4444: </table>
1.54 www 4445: ENDBODY
1.182 matthew 4446: }
4447:
1.330 albertel 4448: sub make_attr_string {
4449: my ($register,$attr_ref) = @_;
4450:
4451: if ($attr_ref && !ref($attr_ref)) {
4452: die("addentries Must be a hash ref ".
4453: join(':',caller(1))." ".
4454: join(':',caller(0))." ");
4455: }
4456:
4457: if ($register) {
1.339 albertel 4458: my ($on_load,$on_unload);
4459: foreach my $key (keys(%{$attr_ref})) {
4460: if (lc($key) eq 'onload') {
4461: $on_load.=$attr_ref->{$key}.';';
4462: delete($attr_ref->{$key});
4463:
4464: } elsif (lc($key) eq 'onunload') {
4465: $on_unload.=$attr_ref->{$key}.';';
4466: delete($attr_ref->{$key});
4467: }
4468: }
4469: $attr_ref->{'onload'} =
4470: &Apache::lonmenu::loadevents(). $on_load;
4471: $attr_ref->{'onunload'}=
4472: &Apache::lonmenu::unloadevents().$on_unload;
4473: }
4474:
4475: # Accessibility font enhance
4476: if ($env{'browser.fontenhance'} eq 'on') {
4477: my $style;
4478: foreach my $key (keys(%{$attr_ref})) {
4479: if (lc($key) eq 'style') {
4480: $style.=$attr_ref->{$key}.';';
4481: delete($attr_ref->{$key});
4482: }
4483: }
4484: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4485: }
1.339 albertel 4486:
1.330 albertel 4487: my $attr_string;
4488: foreach my $attr (keys(%$attr_ref)) {
4489: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4490: }
4491: return $attr_string;
4492: }
4493:
4494:
1.182 matthew 4495: ###############################################
1.251 albertel 4496: ###############################################
4497:
4498: =pod
4499:
4500: =item * &endbodytag()
4501:
4502: Returns a uniform footer for LON-CAPA web pages.
4503:
1.635 raeburn 4504: Inputs: 1 - optional reference to an args hash
4505: If in the hash, key for noredirectlink has a value which evaluates to true,
4506: a 'Continue' link is not displayed if the page contains an
4507: internal redirect in the <head></head> section,
4508: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4509:
4510: =cut
4511:
4512: sub endbodytag {
1.635 raeburn 4513: my ($args) = @_;
1.251 albertel 4514: my $endbodytag='</body>';
1.269 albertel 4515: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4516: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4517: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4518: $endbodytag=
4519: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4520: &mt('Continue').'</a>'.
4521: $endbodytag;
4522: }
1.315 albertel 4523: }
1.251 albertel 4524: return $endbodytag;
4525: }
4526:
1.352 albertel 4527: =pod
4528:
4529: =item * &standard_css()
4530:
4531: Returns a style sheet
4532:
4533: Inputs: (all optional)
4534: domain -> force to color decorate a page for a specific
4535: domain
4536: function -> force usage of a specific rolish color scheme
4537: bgcolor -> override the default page bgcolor
4538:
4539: =cut
4540:
1.343 albertel 4541: sub standard_css {
1.345 albertel 4542: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4543: $function = &get_users_function() if (!$function);
4544: my $img = &designparm($function.'.img', $domain);
4545: my $tabbg = &designparm($function.'.tabbg', $domain);
4546: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 4547: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 4548: #second colour for later usage
1.345 albertel 4549: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4550: my $pgbg_or_bgcolor =
4551: $bgcolor ||
1.352 albertel 4552: &designparm($function.'.pgbg', $domain);
1.382 albertel 4553: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4554: my $alink = &designparm($function.'.alink', $domain);
4555: my $vlink = &designparm($function.'.vlink', $domain);
4556: my $link = &designparm($function.'.link', $domain);
4557:
1.704 muellerd 4558: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4559: my $bgcol = &designparm('login.bgcol',$domain);
4560: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4561:
1.602 albertel 4562: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4563: my $mono = 'monospace';
1.352 albertel 4564: my $data_table_head = $tabbg;
4565: my $data_table_light = '#EEEEEE';
1.470 banghart 4566: my $data_table_dark = '#DDDDDD';
4567: my $data_table_darker = '#CCCCCC';
1.349 albertel 4568: my $data_table_highlight = '#FFFF00';
1.352 albertel 4569: my $mail_new = '#FFBB77';
4570: my $mail_new_hover = '#DD9955';
4571: my $mail_read = '#BBBB77';
4572: my $mail_read_hover = '#999944';
4573: my $mail_replied = '#AAAA88';
4574: my $mail_replied_hover = '#888855';
4575: my $mail_other = '#99BBBB';
4576: my $mail_other_hover = '#669999';
1.391 albertel 4577: my $table_header = '#DDDDDD';
1.489 raeburn 4578: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4579: my $lg_border_color = '#C8C8C8';
1.392 albertel 4580:
1.608 albertel 4581: my $border = ($env{'browser.type'} eq 'explorer' ||
1.803 bisitz 4582: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4583: : '0 3px 0 4px';
1.448 albertel 4584:
1.523 albertel 4585:
1.343 albertel 4586: return <<END;
1.795 www 4587: body {
4588: font-family: $sans;
4589: line-height:130%;
4590: font-size:0.83em;
4591: color:$font;
4592: }
4593:
4594: a:link, a:visited {
4595: font-size:100%;
4596: }
4597:
4598: a:focus {
4599: color: red;
4600: background: yellow
4601: }
1.698 harmsja 4602:
1.795 www 4603: form, .inline {
4604: display: inline;
4605: }
1.721 harmsja 4606:
1.795 www 4607: .LC_right {
4608: text-align:right;
4609: }
4610:
4611: .LC_middle {
4612: vertical-align:middle;
4613: }
1.721 harmsja 4614:
4615: /* just for tests */
1.754 droeschl 4616: .LC_400Box {width:400px; }
1.721 harmsja 4617: /* end */
4618:
1.778 bisitz 4619: .LC_filename {
4620: font-family: $mono;
4621: white-space:pre;
4622: }
4623:
4624: .LC_fileicon {
4625: border: none;
4626: height: 1.3em;
4627: vertical-align: text-bottom;
4628: margin-right: 0.3em;
4629: text-decoration:none;
4630: }
4631:
1.350 albertel 4632: .LC_error {
4633: color: red;
4634: font-size: larger;
4635: }
1.795 www 4636:
1.457 albertel 4637: .LC_warning,
4638: .LC_diff_removed {
1.733 bisitz 4639: color: red;
1.394 albertel 4640: }
1.532 albertel 4641:
4642: .LC_info,
1.457 albertel 4643: .LC_success,
4644: .LC_diff_added {
1.350 albertel 4645: color: green;
4646: }
1.795 www 4647:
1.802 bisitz 4648: div.LC_confirm_box {
4649: background-color: #FAFAFA;
4650: border: 1px solid $lg_border_color;
4651: margin-right: 0;
4652: padding: 5px;
4653: }
4654:
4655: div.LC_confirm_box .LC_error img,
4656: div.LC_confirm_box .LC_success img {
4657: vertical-align: middle;
4658: }
4659:
1.440 albertel 4660: .LC_icon {
1.771 droeschl 4661: border: none;
1.790 droeschl 4662: vertical-align: middle;
1.771 droeschl 4663: }
4664:
1.543 albertel 4665: .LC_docs_spacer {
4666: width: 25px;
4667: height: 1px;
1.771 droeschl 4668: border: none;
1.543 albertel 4669: }
1.346 albertel 4670:
1.532 albertel 4671: .LC_internal_info {
1.735 bisitz 4672: color: #999999;
1.532 albertel 4673: }
4674:
1.794 www 4675: .LC_discussion {
4676: background: $tabbg;
4677: border: 1px solid black;
4678: margin: 2px;
4679: }
4680:
4681: .LC_disc_action_links_bar {
4682: background: $tabbg;
1.803 bisitz 4683: border: none;
1.795 www 4684: margin: 4px;
1.794 www 4685: }
4686:
4687: .LC_disc_action_left {
4688: text-align: left;
4689: }
4690:
4691: .LC_disc_action_right {
4692: text-align: right;
4693: }
4694:
4695: .LC_disc_new_item {
4696: background: white;
4697: border: 2px solid red;
4698: margin: 2px;
4699: }
4700:
4701: .LC_disc_old_item {
4702: background: white;
4703: border: 1px solid black;
4704: margin: 2px;
4705: }
4706:
1.458 albertel 4707: table.LC_pastsubmission {
4708: border: 1px solid black;
4709: margin: 2px;
4710: }
4711:
1.795 www 4712: table#LC_top_nav,
4713: table#LC_menubuttons,
4714: table#LC_nav_location {
1.345 albertel 4715: width: 100%;
4716: background: $pgbg;
1.392 albertel 4717: border: 2px;
1.402 albertel 4718: border-collapse: separate;
1.803 bisitz 4719: padding: 0;
1.345 albertel 4720: }
1.392 albertel 4721:
1.801 tempelho 4722: table#LC_title_bar a {
4723: color: $fontmenu;
4724: }
1.808 droeschl 4725:
1.807 droeschl 4726: table#LC_title_bar {
1.819 tempelho 4727: clear: both;
1.807 droeschl 4728: /*display: none;*/
4729: }
4730:
1.795 www 4731: table#LC_title_bar,
4732: table.LC_breadcrumbs,
1.393 albertel 4733: table#LC_title_bar.LC_with_remote {
1.359 albertel 4734: width: 100%;
1.392 albertel 4735: border-color: $pgbg;
4736: border-style: solid;
4737: border-width: $border;
1.379 albertel 4738: background: $pgbg;
1.801 tempelho 4739: color: $fontmenu;
1.392 albertel 4740: border-collapse: collapse;
1.803 bisitz 4741: padding: 0;
1.819 tempelho 4742: margin: 0;
1.359 albertel 4743: }
1.795 www 4744:
1.409 albertel 4745: table.LC_docs_path {
4746: width: 100%;
4747: border: 0;
4748: background: $pgbg;
4749: border-collapse: collapse;
1.803 bisitz 4750: padding: 0;
1.409 albertel 4751: }
4752:
1.359 albertel 4753: table#LC_title_bar td {
4754: background: $tabbg;
4755: }
1.795 www 4756:
1.773 ehlerst 4757: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4758: background: $tabbg;
1.801 tempelho 4759: color: $fontmenu;
1.827 bisitz 4760: font: small;
1.359 albertel 4761: text-align: right;
1.803 bisitz 4762: margin: 0;
1.773 ehlerst 4763: }
1.795 www 4764:
1.819 tempelho 4765: table#LC_title_bar div.LC_title_bar_name {
1.803 bisitz 4766: margin: 0;
1.773 ehlerst 4767: }
1.795 www 4768:
1.819 tempelho 4769: table#LC_title_bar div.LC_title_bar_role {
1.803 bisitz 4770: margin: 0;
1.773 ehlerst 4771: }
1.795 www 4772:
1.819 tempelho 4773: table#LC_title_bar div.LC_title_bar_realm {
1.803 bisitz 4774: margin: 0;
1.359 albertel 4775: }
1.795 www 4776:
1.706 harmsja 4777: table#LC_menubuttons img{
1.803 bisitz 4778: border: none;
1.346 albertel 4779: }
1.795 www 4780:
1.345 albertel 4781: table#LC_top_nav td {
4782: background: $tabbg;
1.803 bisitz 4783: border: none;
1.407 albertel 4784: font-size: small;
1.706 harmsja 4785: vertical-align:top;
4786: padding:2px 5px 2px 5px;
1.345 albertel 4787: }
1.795 www 4788:
4789: table#LC_top_nav td a,
4790: div#LC_top_nav a {
1.345 albertel 4791: color: $font;
4792: }
1.795 www 4793:
1.364 albertel 4794: table#LC_top_nav td.LC_top_nav_logo {
4795: background: $tabbg;
1.432 albertel 4796: text-align: left;
1.408 albertel 4797: white-space: nowrap;
1.432 albertel 4798: width: 31px;
1.408 albertel 4799: }
1.795 www 4800:
1.408 albertel 4801: table#LC_top_nav td.LC_top_nav_logo img {
1.803 bisitz 4802: border: none;
1.408 albertel 4803: vertical-align: bottom;
1.364 albertel 4804: }
1.795 www 4805:
1.777 tempelho 4806: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4807: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4808: width: 2.0em;
4809: }
1.795 www 4810:
1.442 albertel 4811: table#LC_top_nav td.LC_top_nav_login {
4812: width: 4.0em;
4813: text-align: center;
4814: }
1.795 www 4815:
4816: table.LC_breadcrumbs td,
4817: table.LC_docs_path td {
1.357 albertel 4818: background: $tabbg;
1.801 tempelho 4819: color: $fontmenu;
1.358 albertel 4820: font-size: smaller;
1.357 albertel 4821: }
1.795 www 4822:
1.777 tempelho 4823: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4824: table.LC_docs_path td.LC_docs_path_component {
1.779 bisitz 4825: background: $tabbg;
1.801 tempelho 4826: color: $fontmenu;
1.779 bisitz 4827: font-size: larger;
4828: text-align: right;
1.777 tempelho 4829: }
1.795 www 4830:
1.383 albertel 4831: td.LC_table_cell_checkbox {
4832: text-align: center;
4833: }
1.795 www 4834:
1.779 bisitz 4835: table#LC_mainmenu td.LC_mainmenu_column {
4836: vertical-align: top;
1.777 tempelho 4837: }
1.522 albertel 4838:
1.795 www 4839: .LC_fontsize_small {
1.705 tempelho 4840: font-size: 70%;
4841: }
4842:
1.819 tempelho 4843: #LC_head_subbox {
4844: clear:both;
4845: background: $sidebg;
1.822 bisitz 4846: border-bottom: 1px solid $lg_border_color;
1.819 tempelho 4847: height: 32px;
4848: line-height: 32px;
1.822 bisitz 4849: margin: 0;
1.819 tempelho 4850: padding: 0;
4851: }
4852:
1.822 bisitz 4853: #LC_head_subbox2 { /* FIXME: replace by LC_head_subbox once lonhtmlcommon::breadcrumbs has been fixed */
4854: clear:both;
4855: background: #F8F8F8; /* $sidebg; */
4856: border-bottom: 1px solid $lg_border_color;
4857: margin: 0 0 10px 0;
4858: padding: 5px;
4859: }
4860:
1.795 www 4861: .LC_fontsize_medium {
1.705 tempelho 4862: font-size: 85%;
4863: }
4864:
1.795 www 4865: .LC_fontsize_large {
1.705 tempelho 4866: font-size: 120%;
4867: }
4868:
1.346 albertel 4869: .LC_menubuttons_inline_text {
4870: color: $font;
1.698 harmsja 4871: font-size: 90%;
1.701 harmsja 4872: padding-left:3px;
1.346 albertel 4873: }
4874:
1.526 www 4875: .LC_menubuttons_link {
4876: text-decoration: none;
4877: }
1.795 www 4878:
1.522 albertel 4879: .LC_menubuttons_category {
1.521 www 4880: color: $font;
1.526 www 4881: background: $pgbg;
1.521 www 4882: font-size: larger;
4883: font-weight: bold;
4884: }
4885:
1.346 albertel 4886: td.LC_menubuttons_text {
1.779 bisitz 4887: color: $font;
1.346 albertel 4888: }
1.706 harmsja 4889:
1.346 albertel 4890: .LC_current_location {
4891: background: $tabbg;
4892: }
1.795 www 4893:
1.346 albertel 4894: .LC_new_mail {
1.634 www 4895: background: $tabbg;
1.346 albertel 4896: font-weight: bold;
4897: }
1.347 albertel 4898:
1.666 raeburn 4899: .LC_roleslog_note {
1.701 harmsja 4900: font-size: small;
1.666 raeburn 4901: }
4902:
1.715 raeburn 4903: .LC_mail_functions {
4904: font-weight: bold;
4905: }
4906:
1.795 www 4907: table.LC_data_table,
4908: table.LC_mail_list {
1.347 albertel 4909: border: 1px solid #000000;
1.402 albertel 4910: border-collapse: separate;
1.426 albertel 4911: border-spacing: 1px;
1.610 albertel 4912: background: $pgbg;
1.347 albertel 4913: }
1.795 www 4914:
1.422 albertel 4915: .LC_data_table_dense {
4916: font-size: small;
4917: }
1.795 www 4918:
1.507 raeburn 4919: table.LC_nested_outer {
4920: border: 1px solid #000000;
1.589 raeburn 4921: border-collapse: collapse;
1.803 bisitz 4922: border-spacing: 0;
1.507 raeburn 4923: width: 100%;
4924: }
1.795 www 4925:
1.507 raeburn 4926: table.LC_nested {
1.803 bisitz 4927: border: none;
1.589 raeburn 4928: border-collapse: collapse;
1.803 bisitz 4929: border-spacing: 0;
1.507 raeburn 4930: width: 100%;
4931: }
1.795 www 4932:
4933: table.LC_data_table tr th,
4934: table.LC_calendar tr th,
4935: table.LC_mail_list tr th,
1.523 albertel 4936: table.LC_prior_tries tr th {
1.349 albertel 4937: font-weight: bold;
4938: background-color: $data_table_head;
1.801 tempelho 4939: color:$fontmenu;
1.701 harmsja 4940: font-size:90%;
1.347 albertel 4941: }
1.795 www 4942:
1.711 raeburn 4943: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4944: background-color: #CCCCCC;
1.711 raeburn 4945: font-weight: bold;
4946: text-align: left;
4947: }
1.795 www 4948:
1.779 bisitz 4949: table.LC_data_table tr.LC_odd_row > td,
1.809 bisitz 4950: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 4951: background-color: $data_table_light;
1.425 albertel 4952: padding: 2px;
1.347 albertel 4953: }
1.795 www 4954:
1.610 albertel 4955: table.LC_data_table tr.LC_even_row > td,
1.809 bisitz 4956: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 4957: background-color: $data_table_dark;
1.709 bisitz 4958: padding: 2px;
1.347 albertel 4959: }
1.795 www 4960:
1.425 albertel 4961: table.LC_data_table tr.LC_data_table_highlight td {
4962: background-color: $data_table_darker;
4963: }
1.795 www 4964:
1.639 raeburn 4965: table.LC_data_table tr td.LC_leftcol_header {
4966: background-color: $data_table_head;
4967: font-weight: bold;
4968: }
1.795 www 4969:
1.451 albertel 4970: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4971: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4972: background-color: #FFFFFF;
1.421 albertel 4973: font-weight: bold;
4974: font-style: italic;
4975: text-align: center;
4976: padding: 8px;
1.347 albertel 4977: }
1.795 www 4978:
1.507 raeburn 4979: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4980: padding: 4ex
4981: }
1.795 www 4982:
1.507 raeburn 4983: table.LC_nested_outer tr th {
4984: font-weight: bold;
1.801 tempelho 4985: color:$fontmenu;
1.507 raeburn 4986: background-color: $data_table_head;
1.701 harmsja 4987: font-size: small;
1.507 raeburn 4988: border-bottom: 1px solid #000000;
4989: }
1.795 www 4990:
1.507 raeburn 4991: table.LC_nested_outer tr td.LC_subheader {
4992: background-color: $data_table_head;
4993: font-weight: bold;
4994: font-size: small;
4995: border-bottom: 1px solid #000000;
4996: text-align: right;
1.451 albertel 4997: }
1.795 www 4998:
1.507 raeburn 4999: table.LC_nested tr.LC_info_row td {
1.735 bisitz 5000: background-color: #CCCCCC;
1.451 albertel 5001: font-weight: bold;
5002: font-size: small;
1.507 raeburn 5003: text-align: center;
5004: }
1.795 www 5005:
1.589 raeburn 5006: table.LC_nested tr.LC_info_row td.LC_left_item,
5007: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 5008: text-align: left;
1.451 albertel 5009: }
1.795 www 5010:
1.507 raeburn 5011: table.LC_nested td {
1.735 bisitz 5012: background-color: #FFFFFF;
1.451 albertel 5013: font-size: small;
1.507 raeburn 5014: }
1.795 www 5015:
1.507 raeburn 5016: table.LC_nested_outer tr th.LC_right_item,
5017: table.LC_nested tr.LC_info_row td.LC_right_item,
5018: table.LC_nested tr.LC_odd_row td.LC_right_item,
5019: table.LC_nested tr td.LC_right_item {
1.451 albertel 5020: text-align: right;
5021: }
5022:
1.507 raeburn 5023: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 5024: background-color: #EEEEEE;
1.451 albertel 5025: }
5026:
1.473 raeburn 5027: table.LC_createuser {
5028: }
5029:
5030: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 5031: font-size: small;
1.473 raeburn 5032: }
5033:
5034: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 5035: background-color: #CCCCCC;
1.473 raeburn 5036: font-weight: bold;
5037: text-align: center;
5038: }
5039:
1.349 albertel 5040: table.LC_calendar {
5041: border: 1px solid #000000;
5042: border-collapse: collapse;
5043: }
1.795 www 5044:
1.349 albertel 5045: table.LC_calendar_pickdate {
5046: font-size: xx-small;
5047: }
1.795 www 5048:
1.349 albertel 5049: table.LC_calendar tr td {
5050: border: 1px solid #000000;
5051: vertical-align: top;
5052: }
1.795 www 5053:
1.349 albertel 5054: table.LC_calendar tr td.LC_calendar_day_empty {
5055: background-color: $data_table_dark;
5056: }
1.795 www 5057:
1.779 bisitz 5058: table.LC_calendar tr td.LC_calendar_day_current {
5059: background-color: $data_table_highlight;
1.777 tempelho 5060: }
1.795 www 5061:
1.349 albertel 5062: table.LC_mail_list tr.LC_mail_new {
5063: background-color: $mail_new;
5064: }
1.795 www 5065:
1.349 albertel 5066: table.LC_mail_list tr.LC_mail_new:hover {
5067: background-color: $mail_new_hover;
5068: }
1.795 www 5069:
5070: table.LC_mail_list tr.LC_mail_even {
1.777 tempelho 5071: }
1.795 www 5072:
5073: table.LC_mail_list tr.LC_mail_odd {
1.777 tempelho 5074: }
1.795 www 5075:
1.349 albertel 5076: table.LC_mail_list tr.LC_mail_read {
5077: background-color: $mail_read;
5078: }
1.795 www 5079:
1.349 albertel 5080: table.LC_mail_list tr.LC_mail_read:hover {
5081: background-color: $mail_read_hover;
5082: }
1.795 www 5083:
1.349 albertel 5084: table.LC_mail_list tr.LC_mail_replied {
5085: background-color: $mail_replied;
5086: }
1.795 www 5087:
1.349 albertel 5088: table.LC_mail_list tr.LC_mail_replied:hover {
5089: background-color: $mail_replied_hover;
5090: }
1.795 www 5091:
1.349 albertel 5092: table.LC_mail_list tr.LC_mail_other {
5093: background-color: $mail_other;
5094: }
1.795 www 5095:
1.349 albertel 5096: table.LC_mail_list tr.LC_mail_other:hover {
5097: background-color: $mail_other_hover;
5098: }
1.494 raeburn 5099:
1.777 tempelho 5100: table.LC_data_table tr > td.LC_browser_file,
5101: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 5102: background: #CCFF88;
5103: }
1.795 www 5104:
1.777 tempelho 5105: table.LC_data_table tr > td.LC_browser_file_locked,
5106: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 5107: background: #FFAA99;
1.387 albertel 5108: }
1.795 www 5109:
1.777 tempelho 5110: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 bisitz 5111: background: #AAAAAA;
5112: }
1.795 www 5113:
1.777 tempelho 5114: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 5115: table.LC_data_table tr > td.LC_browser_file_metamodified {
5116: background: #FFFF77;
1.777 tempelho 5117: }
1.795 www 5118:
1.696 bisitz 5119: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 5120: background: #CCCCFF;
1.387 albertel 5121: }
1.696 bisitz 5122:
1.707 bisitz 5123: table.LC_data_table tr > td.LC_roles_is {
5124: /* background: #77FF77; */
5125: }
1.795 www 5126:
1.707 bisitz 5127: table.LC_data_table tr > td.LC_roles_future {
5128: background: #FFFF77;
5129: }
1.795 www 5130:
1.707 bisitz 5131: table.LC_data_table tr > td.LC_roles_will {
5132: background: #FFAA77;
5133: }
1.795 www 5134:
1.707 bisitz 5135: table.LC_data_table tr > td.LC_roles_expired {
5136: background: #FF7777;
5137: }
1.795 www 5138:
1.707 bisitz 5139: table.LC_data_table tr > td.LC_roles_will_not {
5140: background: #AAFF77;
5141: }
1.795 www 5142:
1.707 bisitz 5143: table.LC_data_table tr > td.LC_roles_selected {
5144: background: #11CC55;
5145: }
5146:
1.388 albertel 5147: span.LC_current_location {
1.701 harmsja 5148: font-size:larger;
1.388 albertel 5149: background: $pgbg;
5150: }
1.387 albertel 5151:
1.395 albertel 5152: span.LC_parm_menu_item {
5153: font-size: larger;
5154: }
1.795 www 5155:
1.395 albertel 5156: span.LC_parm_scope_all {
5157: color: red;
5158: }
1.795 www 5159:
1.395 albertel 5160: span.LC_parm_scope_folder {
5161: color: green;
5162: }
1.795 www 5163:
1.395 albertel 5164: span.LC_parm_scope_resource {
5165: color: orange;
5166: }
1.795 www 5167:
1.395 albertel 5168: span.LC_parm_part {
5169: color: blue;
5170: }
1.795 www 5171:
1.395 albertel 5172: span.LC_parm_folder, span.LC_parm_symb {
5173: font-size: x-small;
5174: font-family: $mono;
5175: color: #AAAAAA;
5176: }
5177:
1.795 www 5178: td.LC_parm_overview_level_menu,
5179: td.LC_parm_overview_map_menu,
5180: td.LC_parm_overview_parm_selectors,
5181: td.LC_parm_overview_restrictions {
1.396 albertel 5182: border: 1px solid black;
5183: border-collapse: collapse;
5184: }
1.795 www 5185:
1.396 albertel 5186: table.LC_parm_overview_restrictions td {
5187: border-width: 1px 4px 1px 4px;
5188: border-style: solid;
5189: border-color: $pgbg;
5190: text-align: center;
5191: }
1.795 www 5192:
1.396 albertel 5193: table.LC_parm_overview_restrictions th {
5194: background: $tabbg;
5195: border-width: 1px 4px 1px 4px;
5196: border-style: solid;
5197: border-color: $pgbg;
5198: }
1.795 www 5199:
1.398 albertel 5200: table#LC_helpmenu {
1.803 bisitz 5201: border: none;
1.398 albertel 5202: height: 55px;
1.803 bisitz 5203: border-spacing: 0;
1.398 albertel 5204: }
5205:
5206: table#LC_helpmenu fieldset legend {
5207: font-size: larger;
5208: font-weight: bold;
5209: }
1.795 www 5210:
1.397 albertel 5211: table#LC_helpmenu_links {
5212: width: 100%;
5213: border: 1px solid black;
5214: background: $pgbg;
1.803 bisitz 5215: padding: 0;
1.397 albertel 5216: border-spacing: 1px;
5217: }
1.795 www 5218:
1.397 albertel 5219: table#LC_helpmenu_links tr td {
5220: padding: 1px;
5221: background: $tabbg;
1.399 albertel 5222: text-align: center;
5223: font-weight: bold;
1.397 albertel 5224: }
1.396 albertel 5225:
1.795 www 5226: table#LC_helpmenu_links a:link,
5227: table#LC_helpmenu_links a:visited,
1.397 albertel 5228: table#LC_helpmenu_links a:active {
5229: text-decoration: none;
5230: color: $font;
5231: }
1.795 www 5232:
1.397 albertel 5233: table#LC_helpmenu_links a:hover {
5234: text-decoration: underline;
5235: color: $vlink;
5236: }
1.396 albertel 5237:
1.417 albertel 5238: .LC_chrt_popup_exists {
5239: border: 1px solid #339933;
5240: margin: -1px;
5241: }
1.795 www 5242:
1.417 albertel 5243: .LC_chrt_popup_up {
5244: border: 1px solid yellow;
5245: margin: -1px;
5246: }
1.795 www 5247:
1.417 albertel 5248: .LC_chrt_popup {
5249: border: 1px solid #8888FF;
5250: background: #CCCCFF;
5251: }
1.795 www 5252:
1.421 albertel 5253: table.LC_pick_box {
5254: border-collapse: separate;
5255: background: white;
5256: border: 1px solid black;
5257: border-spacing: 1px;
5258: }
1.795 www 5259:
1.421 albertel 5260: table.LC_pick_box td.LC_pick_box_title {
5261: background: $tabbg;
5262: font-weight: bold;
5263: text-align: right;
1.740 bisitz 5264: vertical-align: top;
1.421 albertel 5265: width: 184px;
5266: padding: 8px;
5267: }
1.795 www 5268:
1.645 raeburn 5269: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5270: background: $tabbg;
5271: font-weight: bold;
5272: text-align: right;
5273: width: 350px;
5274: padding: 8px;
5275: }
5276:
1.579 raeburn 5277: table.LC_pick_box td.LC_pick_box_value {
5278: text-align: left;
5279: padding: 8px;
5280: }
1.795 www 5281:
1.579 raeburn 5282: table.LC_pick_box td.LC_pick_box_select {
5283: text-align: left;
5284: padding: 8px;
5285: }
1.795 www 5286:
1.424 albertel 5287: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 5288: padding: 0;
1.421 albertel 5289: height: 1px;
5290: background: black;
5291: }
1.795 www 5292:
1.421 albertel 5293: table.LC_pick_box td.LC_pick_box_submit {
5294: text-align: right;
5295: }
1.795 www 5296:
1.579 raeburn 5297: table.LC_pick_box td.LC_evenrow_value {
5298: text-align: left;
5299: padding: 8px;
5300: background-color: $data_table_light;
5301: }
1.795 www 5302:
1.579 raeburn 5303: table.LC_pick_box td.LC_oddrow_value {
5304: text-align: left;
5305: padding: 8px;
5306: background-color: $data_table_light;
5307: }
1.795 www 5308:
1.579 raeburn 5309: table.LC_helpform_receipt {
5310: width: 620px;
5311: border-collapse: separate;
5312: background: white;
5313: border: 1px solid black;
5314: border-spacing: 1px;
5315: }
1.795 www 5316:
1.579 raeburn 5317: table.LC_helpform_receipt td.LC_pick_box_title {
5318: background: $tabbg;
5319: font-weight: bold;
5320: text-align: right;
5321: width: 184px;
5322: padding: 8px;
5323: }
1.795 www 5324:
1.579 raeburn 5325: table.LC_helpform_receipt td.LC_evenrow_value {
5326: text-align: left;
5327: padding: 8px;
5328: background-color: $data_table_light;
5329: }
1.795 www 5330:
1.579 raeburn 5331: table.LC_helpform_receipt td.LC_oddrow_value {
5332: text-align: left;
5333: padding: 8px;
5334: background-color: $data_table_light;
5335: }
1.795 www 5336:
1.579 raeburn 5337: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803 bisitz 5338: padding: 0;
1.579 raeburn 5339: height: 1px;
5340: background: black;
5341: }
1.795 www 5342:
1.579 raeburn 5343: span.LC_helpform_receipt_cat {
5344: font-weight: bold;
5345: }
1.795 www 5346:
1.424 albertel 5347: table.LC_group_priv_box {
5348: background: white;
5349: border: 1px solid black;
5350: border-spacing: 1px;
5351: }
1.795 www 5352:
1.424 albertel 5353: table.LC_group_priv_box td.LC_pick_box_title {
5354: background: $tabbg;
5355: font-weight: bold;
5356: text-align: right;
5357: width: 184px;
5358: }
1.795 www 5359:
1.424 albertel 5360: table.LC_group_priv_box td.LC_groups_fixed {
5361: background: $data_table_light;
5362: text-align: center;
5363: }
1.795 www 5364:
1.424 albertel 5365: table.LC_group_priv_box td.LC_groups_optional {
5366: background: $data_table_dark;
5367: text-align: center;
5368: }
1.795 www 5369:
1.424 albertel 5370: table.LC_group_priv_box td.LC_groups_functionality {
5371: background: $data_table_darker;
5372: text-align: center;
5373: font-weight: bold;
5374: }
1.795 www 5375:
1.424 albertel 5376: table.LC_group_priv td {
5377: text-align: left;
1.803 bisitz 5378: padding: 0;
1.424 albertel 5379: }
5380:
1.421 albertel 5381: table.LC_notify_front_page {
5382: background: white;
5383: border: 1px solid black;
5384: padding: 8px;
5385: }
1.795 www 5386:
1.421 albertel 5387: table.LC_notify_front_page td {
5388: padding: 8px;
5389: }
1.795 www 5390:
1.424 albertel 5391: .LC_navbuttons {
5392: margin: 2ex 0ex 2ex 0ex;
5393: }
1.795 www 5394:
1.423 albertel 5395: .LC_topic_bar {
5396: font-weight: bold;
5397: width: 100%;
5398: background: $tabbg;
5399: vertical-align: middle;
5400: margin: 2ex 0ex 2ex 0ex;
1.805 bisitz 5401: padding: 3px;
1.423 albertel 5402: }
1.795 www 5403:
1.423 albertel 5404: .LC_topic_bar span {
5405: vertical-align: middle;
5406: }
1.795 www 5407:
1.423 albertel 5408: .LC_topic_bar img {
5409: vertical-align: bottom;
5410: }
1.795 www 5411:
1.423 albertel 5412: table.LC_course_group_status {
5413: margin: 20px;
5414: }
1.795 www 5415:
1.423 albertel 5416: table.LC_status_selector td {
5417: vertical-align: top;
5418: text-align: center;
1.424 albertel 5419: padding: 4px;
5420: }
1.795 www 5421:
1.599 albertel 5422: div.LC_feedback_link {
1.616 albertel 5423: clear: both;
1.599 albertel 5424: background: white;
1.779 bisitz 5425: width: 100%;
1.489 raeburn 5426: }
1.795 www 5427:
1.489 raeburn 5428: span.LC_feedback_link {
1.599 albertel 5429: background: $feedback_link_bg;
5430: font-size: larger;
5431: }
1.795 www 5432:
1.599 albertel 5433: span.LC_message_link {
5434: background: $feedback_link_bg;
5435: font-size: larger;
5436: position: absolute;
5437: right: 1em;
1.489 raeburn 5438: }
1.421 albertel 5439:
1.515 albertel 5440: table.LC_prior_tries {
1.524 albertel 5441: border: 1px solid #000000;
5442: border-collapse: separate;
5443: border-spacing: 1px;
1.515 albertel 5444: }
1.523 albertel 5445:
1.515 albertel 5446: table.LC_prior_tries td {
1.524 albertel 5447: padding: 2px;
1.515 albertel 5448: }
1.523 albertel 5449:
5450: .LC_answer_correct {
1.795 www 5451: background: lightgreen;
5452: color: darkgreen;
5453: padding: 6px;
1.523 albertel 5454: }
1.795 www 5455:
1.523 albertel 5456: .LC_answer_charged_try {
1.797 www 5457: background: #FFAAAA;
1.795 www 5458: color: darkred;
5459: padding: 6px;
1.523 albertel 5460: }
1.795 www 5461:
1.779 bisitz 5462: .LC_answer_not_charged_try,
1.523 albertel 5463: .LC_answer_no_grade,
5464: .LC_answer_late {
1.795 www 5465: background: lightyellow;
1.523 albertel 5466: color: black;
1.795 www 5467: padding: 6px;
1.523 albertel 5468: }
1.795 www 5469:
1.523 albertel 5470: .LC_answer_previous {
1.795 www 5471: background: lightblue;
5472: color: darkblue;
5473: padding: 6px;
1.523 albertel 5474: }
1.795 www 5475:
1.779 bisitz 5476: .LC_answer_no_message {
1.777 tempelho 5477: background: #FFFFFF;
5478: color: black;
1.795 www 5479: padding: 6px;
1.779 bisitz 5480: }
1.795 www 5481:
1.779 bisitz 5482: .LC_answer_unknown {
5483: background: orange;
5484: color: black;
1.795 www 5485: padding: 6px;
1.777 tempelho 5486: }
1.795 www 5487:
1.529 albertel 5488: span.LC_prior_numerical,
5489: span.LC_prior_string,
5490: span.LC_prior_custom,
5491: span.LC_prior_reaction,
5492: span.LC_prior_math {
1.523 albertel 5493: font-family: monospace;
5494: white-space: pre;
5495: }
5496:
1.525 albertel 5497: span.LC_prior_string {
5498: font-family: monospace;
5499: white-space: pre;
5500: }
5501:
1.523 albertel 5502: table.LC_prior_option {
5503: width: 100%;
5504: border-collapse: collapse;
5505: }
1.795 www 5506:
5507: table.LC_prior_rank,
5508: table.LC_prior_match {
1.528 albertel 5509: border-collapse: collapse;
5510: }
1.795 www 5511:
1.528 albertel 5512: table.LC_prior_option tr td,
5513: table.LC_prior_rank tr td,
5514: table.LC_prior_match tr td {
1.524 albertel 5515: border: 1px solid #000000;
1.515 albertel 5516: }
5517:
1.770 droeschl 5518: td.LC_nobreak,
1.519 raeburn 5519: span.LC_nobreak {
1.544 albertel 5520: white-space: nowrap;
1.519 raeburn 5521: }
5522:
1.576 raeburn 5523: span.LC_cusr_emph {
5524: font-style: italic;
5525: }
5526:
1.633 raeburn 5527: span.LC_cusr_subheading {
5528: font-weight: normal;
5529: font-size: 85%;
5530: }
5531:
1.545 albertel 5532: table.LC_docs_documents {
5533: background: #BBBBBB;
1.803 bisitz 5534: border-width: 0;
1.545 albertel 5535: border-collapse: collapse;
5536: }
1.795 www 5537:
1.777 tempelho 5538: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5539: border: 2px solid black;
5540: padding: 4px;
1.777 tempelho 5541: }
1.795 www 5542:
1.545 albertel 5543: .LC_docs_entry_move {
1.803 bisitz 5544: border: none;
1.545 albertel 5545: border-collapse: collapse;
1.544 albertel 5546: }
5547:
1.545 albertel 5548: .LC_docs_entry_move td {
5549: border: 2px solid #BBBBBB;
5550: background: #DDDDDD;
5551: }
5552:
5553: .LC_docs_editor td.LC_docs_entry_commands {
5554: background: #DDDDDD;
5555: font-size: x-small;
5556: }
1.795 www 5557:
1.544 albertel 5558: .LC_docs_copy {
1.545 albertel 5559: color: #000099;
1.544 albertel 5560: }
1.795 www 5561:
1.544 albertel 5562: .LC_docs_cut {
1.545 albertel 5563: color: #550044;
1.544 albertel 5564: }
1.795 www 5565:
1.544 albertel 5566: .LC_docs_rename {
1.545 albertel 5567: color: #009900;
1.544 albertel 5568: }
1.795 www 5569:
1.544 albertel 5570: .LC_docs_remove {
1.545 albertel 5571: color: #990000;
5572: }
5573:
1.547 albertel 5574: .LC_docs_reinit_warn,
5575: .LC_docs_ext_edit {
5576: font-size: x-small;
5577: }
5578:
1.545 albertel 5579: .LC_docs_editor td.LC_docs_entry_title,
5580: .LC_docs_editor td.LC_docs_entry_icon {
5581: background: #FFFFBB;
5582: }
1.795 www 5583:
1.545 albertel 5584: .LC_docs_editor td.LC_docs_entry_parameter {
5585: background: #BBBBFF;
5586: font-size: x-small;
5587: white-space: nowrap;
5588: }
5589:
5590: table.LC_docs_adddocs td,
5591: table.LC_docs_adddocs th {
5592: border: 1px solid #BBBBBB;
5593: padding: 4px;
5594: background: #DDDDDD;
1.543 albertel 5595: }
5596:
1.584 albertel 5597: table.LC_sty_begin {
5598: background: #BBFFBB;
5599: }
1.795 www 5600:
1.584 albertel 5601: table.LC_sty_end {
5602: background: #FFBBBB;
5603: }
5604:
1.589 raeburn 5605: table.LC_double_column {
1.803 bisitz 5606: border-width: 0;
1.589 raeburn 5607: border-collapse: collapse;
5608: width: 100%;
5609: padding: 2px;
5610: }
5611:
5612: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5613: top: 2px;
1.589 raeburn 5614: left: 2px;
5615: width: 47%;
5616: vertical-align: top;
5617: }
5618:
5619: table.LC_double_column tr td.LC_right_col {
5620: top: 2px;
1.779 bisitz 5621: right: 2px;
1.589 raeburn 5622: width: 47%;
5623: vertical-align: top;
5624: }
5625:
1.594 raeburn 5626: span.LC_role_level {
5627: font-weight: bold;
5628: }
5629:
1.591 raeburn 5630: div.LC_left_float {
5631: float: left;
5632: padding-right: 5%;
1.597 albertel 5633: padding-bottom: 4px;
1.591 raeburn 5634: }
5635:
5636: div.LC_clear_float_header {
1.597 albertel 5637: padding-bottom: 2px;
1.591 raeburn 5638: }
5639:
5640: div.LC_clear_float_footer {
1.597 albertel 5641: padding-top: 10px;
1.591 raeburn 5642: clear: both;
5643: }
5644:
1.597 albertel 5645: div.LC_grade_show_user {
5646: margin-top: 20px;
5647: border: 1px solid black;
5648: }
1.795 www 5649:
1.597 albertel 5650: div.LC_grade_user_name {
5651: background: #DDDDEE;
5652: border-bottom: 1px solid black;
1.705 tempelho 5653: font-weight: bold;
5654: font-size: large;
1.597 albertel 5655: }
1.795 www 5656:
1.597 albertel 5657: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5658: background: #DDEEDD;
5659: }
5660:
5661: div.LC_grade_show_problem,
5662: div.LC_grade_submissions,
5663: div.LC_grade_message_center,
5664: div.LC_grade_info_links,
5665: div.LC_grade_assign {
5666: margin: 5px;
5667: width: 99%;
5668: background: #FFFFFF;
5669: }
1.795 www 5670:
1.597 albertel 5671: div.LC_grade_show_problem_header,
5672: div.LC_grade_submissions_header,
5673: div.LC_grade_message_center_header,
5674: div.LC_grade_assign_header {
1.705 tempelho 5675: font-weight: bold;
5676: font-size: large;
1.597 albertel 5677: }
1.795 www 5678:
1.597 albertel 5679: div.LC_grade_show_problem_problem,
5680: div.LC_grade_submissions_body,
5681: div.LC_grade_message_center_body,
5682: div.LC_grade_assign_body {
5683: border: 1px solid black;
5684: width: 99%;
5685: background: #FFFFFF;
5686: }
1.795 www 5687:
1.598 albertel 5688: span.LC_grade_check_note {
1.705 tempelho 5689: font-weight: normal;
5690: font-size: medium;
1.598 albertel 5691: display: inline;
5692: position: absolute;
5693: right: 1em;
5694: }
1.597 albertel 5695:
1.613 albertel 5696: table.LC_scantron_action {
5697: width: 100%;
5698: }
1.795 www 5699:
1.613 albertel 5700: table.LC_scantron_action tr th {
1.698 harmsja 5701: font-weight:bold;
5702: font-style:normal;
1.613 albertel 5703: }
1.795 www 5704:
1.779 bisitz 5705: .LC_edit_problem_header,
1.614 albertel 5706: div.LC_edit_problem_footer {
1.705 tempelho 5707: font-weight: normal;
5708: font-size: medium;
1.602 albertel 5709: margin: 2px;
1.600 albertel 5710: }
1.795 www 5711:
1.600 albertel 5712: div.LC_edit_problem_header,
1.602 albertel 5713: div.LC_edit_problem_header div,
1.614 albertel 5714: div.LC_edit_problem_footer,
5715: div.LC_edit_problem_footer div,
1.602 albertel 5716: div.LC_edit_problem_editxml_header,
5717: div.LC_edit_problem_editxml_header div {
1.600 albertel 5718: margin-top: 5px;
5719: }
1.795 www 5720:
1.602 albertel 5721: div.LC_edit_problem_header_edit_row {
5722: background: $tabbg;
5723: padding: 3px;
5724: margin-bottom: 5px;
5725: }
1.795 www 5726:
1.600 albertel 5727: div.LC_edit_problem_header_title {
1.705 tempelho 5728: font-weight: bold;
5729: font-size: larger;
1.602 albertel 5730: background: $tabbg;
5731: padding: 3px;
5732: }
1.795 www 5733:
1.602 albertel 5734: table.LC_edit_problem_header_title {
1.705 tempelho 5735: font-size: larger;
5736: font-weight: bold;
1.602 albertel 5737: width: 100%;
5738: border-color: $pgbg;
5739: border-style: solid;
5740: border-width: $border;
1.600 albertel 5741: background: $tabbg;
1.602 albertel 5742: border-collapse: collapse;
1.803 bisitz 5743: padding: 0;
1.602 albertel 5744: }
5745:
5746: div.LC_edit_problem_discards {
5747: float: left;
5748: padding-bottom: 5px;
5749: }
1.795 www 5750:
1.602 albertel 5751: div.LC_edit_problem_saves {
5752: float: right;
5753: padding-bottom: 5px;
1.600 albertel 5754: }
1.795 www 5755:
1.600 albertel 5756: hr.LC_edit_problem_divide {
1.602 albertel 5757: clear: both;
1.600 albertel 5758: color: $tabbg;
5759: background-color: $tabbg;
5760: height: 3px;
1.803 bisitz 5761: border: none;
1.600 albertel 5762: }
1.795 www 5763:
1.679 riegler 5764: img.stift{
1.803 bisitz 5765: border-width: 0;
5766: vertical-align: middle;
1.677 riegler 5767: }
1.680 riegler 5768:
1.681 riegler 5769: table#LC_mainmenu{
5770: margin-top:10px;
5771: width:80%;
5772: }
5773:
1.680 riegler 5774: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5775: vertical-align: top;
5776: width: 45%;
5777: }
1.795 www 5778:
1.779 bisitz 5779: .LC_mainmenu_fieldset_category {
5780: color: $font;
5781: background: $pgbg;
5782: font-size: small;
5783: font-weight: bold;
1.777 tempelho 5784: }
1.795 www 5785:
1.716 raeburn 5786: div.LC_createcourse {
5787: margin: 10px 10px 10px 10px;
5788: }
5789:
1.693 droeschl 5790: /* ---- Remove when done ----
5791: # The following styles is part of the redesign of LON-CAPA and are
5792: # subject to change during this project.
5793: # Don't rely on their current functionality as they might be
5794: # changed or removed.
5795: # --------------------------*/
5796:
1.698 harmsja 5797: a:hover,
1.721 harmsja 5798: ol.LC_smallMenu a:hover,
5799: ol#LC_MenuBreadcrumbs a:hover,
5800: ol#LC_PathBreadcrumbs a:hover,
5801: ul#LC_TabMainMenuContent a:hover,
5802: .LC_FormSectionClearButton input:hover
1.795 www 5803: ul.LC_TabContent li:hover a {
1.698 harmsja 5804: color:#BF2317;
5805: text-decoration:none;
1.693 droeschl 5806: }
5807:
1.779 bisitz 5808: h1 {
1.813 bisitz 5809: padding: 0;
1.693 droeschl 5810: line-height:130%;
5811: }
1.698 harmsja 5812:
1.795 www 5813: h2,h3,h4,h5,h6 {
1.803 bisitz 5814: margin: 5px 0 5px 0;
5815: padding: 0;
1.721 harmsja 5816: line-height:130%;
1.693 droeschl 5817: }
1.795 www 5818:
5819: .LC_hcell {
1.698 harmsja 5820: padding:3px 15px 3px 15px;
1.803 bisitz 5821: margin: 0;
1.703 harmsja 5822: background-color:$tabbg;
1.801 tempelho 5823: color:$fontmenu;
1.779 bisitz 5824: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5825: }
1.795 www 5826:
1.721 harmsja 5827: .LC_noBorder {
1.803 bisitz 5828: border: 0;
1.698 harmsja 5829: }
1.693 droeschl 5830:
5831:
1.698 harmsja 5832: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5833:
1.761 tempelho 5834: .LC_Right {
5835: float: right;
1.803 bisitz 5836: margin: 0;
5837: padding: 0;
1.761 tempelho 5838: }
5839:
1.721 harmsja 5840: .LC_FormSectionClearButton input {
1.779 bisitz 5841: background-color:transparent;
1.803 bisitz 5842: border: none;
1.698 harmsja 5843: cursor:pointer;
5844: text-decoration:underline;
1.693 droeschl 5845: }
1.763 bisitz 5846:
5847: .LC_help_open_topic {
5848: color: #FFFFFF;
5849: background-color: #EEEEFF;
5850: margin: 1px;
5851: padding: 4px;
5852: border: 1px solid #000033;
5853: white-space: nowrap;
1.783 amueller 5854: /* vertical-align: middle; */
1.759 neumanie 5855: }
1.693 droeschl 5856:
1.698 harmsja 5857: dl,ul,div,fieldset {
1.803 bisitz 5858: margin: 10px 10px 10px 0;
1.806 bisitz 5859: /* overflow: hidden; */
1.693 droeschl 5860: }
1.795 www 5861:
1.813 bisitz 5862: #LC_nav_bar {
1.807 droeschl 5863: float: left;
5864: margin: 0;
5865: }
5866:
1.813 bisitz 5867: #LC_nav_bar em{
1.807 droeschl 5868: font-weight: bold;
5869: font-style: normal;
5870: }
5871:
5872: ol.LC_smallMenu {
5873: float: right;
5874: }
5875:
1.721 harmsja 5876: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803 bisitz 5877: margin: 0;
1.693 droeschl 5878: }
5879:
1.721 harmsja 5880: ol.LC_smallMenu li {
1.693 droeschl 5881: display: inline;
1.803 bisitz 5882: padding: 5px 5px 0 10px;
1.693 droeschl 5883: vertical-align: top;
5884: }
5885:
1.721 harmsja 5886: ol.LC_smallMenu li img {
1.693 droeschl 5887: vertical-align: bottom;
5888: }
5889:
1.721 harmsja 5890: ol.LC_smallMenu a {
1.693 droeschl 5891: font-size: 90%;
5892: color: RGB(80, 80, 80);
5893: text-decoration: none;
5894: }
1.795 www 5895:
1.808 droeschl 5896: ul#LC_TabMainMenuContent {
1.807 droeschl 5897: clear: both;
1.808 droeschl 5898: color: $fontmenu;
5899: background: $tabbg;
5900: list-style: none;
5901: padding: 0;
5902: margin: 0;
5903: float:left;
5904: width: 100%;
5905: }
5906:
5907: ul#LC_TabMainMenuContent li {
5908: float: left;
5909: font-weight: bold;
5910: line-height: 1.8em;
5911: padding: 0 0.8em;
5912: border-right: 1px solid black;
5913: display: inline;
5914: vertical-align: middle;
1.807 droeschl 5915: }
5916:
1.795 www 5917: ul.LC_TabContent ,
1.741 harmsja 5918: ul.LC_TabContentBigger {
1.721 harmsja 5919: display:block;
5920: list-style:none;
1.803 bisitz 5921: margin: 0;
5922: padding: 0;
1.693 droeschl 5923: }
5924:
1.795 www 5925: ul.LC_TabContent li,
5926: ul.LC_TabContentBigger li {
1.693 droeschl 5927: display: inline;
1.741 harmsja 5928: border-right: solid 1px $lg_border_color;
5929: float:left;
5930: line-height:140%;
5931: white-space:nowrap;
5932: }
1.795 www 5933:
1.808 droeschl 5934: ul#LC_TabMainMenuContent li a {
5935: color: $fontmenu;
1.693 droeschl 5936: text-decoration: none;
5937: }
1.795 www 5938:
1.721 harmsja 5939: ul.LC_TabContent {
1.741 harmsja 5940: min-height:1.6em;
1.721 harmsja 5941: }
1.795 www 5942:
5943: ul.LC_TabContent li {
1.741 harmsja 5944: vertical-align:middle;
1.803 bisitz 5945: padding: 0 10px 0 10px;
1.745 ehlerst 5946: background-color:$tabbg;
5947: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5948: }
1.795 www 5949:
5950: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721 harmsja 5951: color:rgb(47,47,47);
5952: text-decoration:none;
5953: font-size:95%;
5954: font-weight:bold;
1.761 tempelho 5955: padding-right: 16px;
1.721 harmsja 5956: }
1.795 www 5957:
5958: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761 tempelho 5959: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5960: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5961: padding-right: 16px;
1.744 ehlerst 5962: }
1.795 www 5963:
5964: ul.LC_TabContentBigger li {
1.741 harmsja 5965: vertical-align:bottom;
5966: border-top:solid 1px $lg_border_color;
5967: border-left:solid 1px $lg_border_color;
5968: padding:5px 10px 5px 10px;
5969: margin-left:2px;
5970: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5971: }
1.795 www 5972:
5973: ul.LC_TabContentBigger li:hover,
5974: ul.LC_TabContentBigger li.active {
1.744 ehlerst 5975: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5976: }
1.795 www 5977:
5978: ul.LC_TabContentBigger li,
5979: ul.LC_TabContentBigger li a {
1.741 harmsja 5980: font-size:110%;
5981: font-weight:bold;
5982: }
1.693 droeschl 5983:
1.795 www 5984: ol#LC_MenuBreadcrumbs,
5985: ol#LC_PathBreadcrumbs,
1.823 bisitz 5986: ul#LC_CourseBreadcrumbs {
1.693 droeschl 5987: padding-left: 10px;
1.819 tempelho 5988: margin: 0;
1.693 droeschl 5989: list-style-position: inside;
5990: }
5991:
1.795 www 5992: ol#LC_MenuBreadcrumbs li,
5993: ol#LC_PathBreadcrumbs li,
1.823 bisitz 5994: ul#LC_CourseBreadcrumbs li {
1.693 droeschl 5995: display: inline;
1.803 bisitz 5996: padding: 0 0 0 10px;
1.693 droeschl 5997: overflow:hidden;
5998: }
5999:
1.823 bisitz 6000: ol#LC_MenuBreadcrumbs li a,
6001: ul#LC_CourseBreadcrumbs li a {
1.693 droeschl 6002: text-decoration: none;
6003: font-size:90%;
6004: }
1.795 www 6005:
6006: ol#LC_PathBreadcrumbs li a {
1.698 harmsja 6007: text-decoration:none;
6008: font-size:100%;
6009: font-weight:bold;
1.693 droeschl 6010: }
1.795 www 6011:
6012: .LC_BoxPadding {
1.786 neumanie 6013: padding: 10px;
6014: }
1.795 www 6015:
6016: .LC_ContentBoxSpecial {
1.701 harmsja 6017: border: solid 1px $lg_border_color;
1.746 neumanie 6018: }
1.795 www 6019:
6020: .LC_ContentBoxSpecialContactInfo {
1.746 neumanie 6021: border: solid 1px $lg_border_color;
6022: max-width:25%;
6023: min-width:25%;
1.698 harmsja 6024: }
1.795 www 6025:
6026: .LC_AboutMe_Image {
1.747 neumanie 6027: float:left;
6028: margin-right:10px;
6029: }
1.795 www 6030:
6031: .LC_Clear_AboutMe_Image {
1.747 neumanie 6032: clear:left;
6033: }
1.795 www 6034:
1.721 harmsja 6035: dl.LC_ListStyleClean dt {
1.693 droeschl 6036: padding-right: 5px;
6037: display: table-header-group;
6038: }
6039:
1.721 harmsja 6040: dl.LC_ListStyleClean dd {
1.693 droeschl 6041: display: table-row;
6042: }
6043:
1.721 harmsja 6044: .LC_ListStyleClean,
6045: .LC_ListStyleSimple,
6046: .LC_ListStyleNormal,
1.777 tempelho 6047: .LC_ListStyle_Border,
1.795 www 6048: .LC_ListStyleSpecial {
1.693 droeschl 6049: /*display:block; */
6050: list-style-position: inside;
6051: list-style-type: none;
6052: overflow: hidden;
1.803 bisitz 6053: padding: 0;
1.693 droeschl 6054: }
6055:
1.721 harmsja 6056: .LC_ListStyleSimple li,
6057: .LC_ListStyleSimple dd,
6058: .LC_ListStyleNormal li,
6059: .LC_ListStyleNormal dd,
6060: .LC_ListStyleSpecial li,
1.795 www 6061: .LC_ListStyleSpecial dd {
1.803 bisitz 6062: margin: 0;
1.693 droeschl 6063: padding: 5px 5px 5px 10px;
6064: clear: both;
6065: }
6066:
1.721 harmsja 6067: .LC_ListStyleClean li,
6068: .LC_ListStyleClean dd {
1.803 bisitz 6069: padding-top: 0;
6070: padding-bottom: 0;
1.693 droeschl 6071: }
6072:
1.721 harmsja 6073: .LC_ListStyleSimple dd,
1.795 www 6074: .LC_ListStyleSimple li {
1.698 harmsja 6075: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 6076: }
6077:
1.721 harmsja 6078: .LC_ListStyleSpecial li,
6079: .LC_ListStyleSpecial dd {
1.693 droeschl 6080: list-style-type: none;
6081: background-color: RGB(220, 220, 220);
6082: margin-bottom: 4px;
6083: }
6084:
1.721 harmsja 6085: table.LC_SimpleTable {
1.698 harmsja 6086: margin:5px;
6087: border:solid 1px $lg_border_color;
1.795 www 6088: }
1.693 droeschl 6089:
1.721 harmsja 6090: table.LC_SimpleTable tr {
1.803 bisitz 6091: padding: 0;
1.698 harmsja 6092: border:solid 1px $lg_border_color;
1.693 droeschl 6093: }
1.795 www 6094:
6095: table.LC_SimpleTable thead {
1.698 harmsja 6096: background:rgb(220,220,220);
1.693 droeschl 6097: }
6098:
1.721 harmsja 6099: div.LC_columnSection {
1.693 droeschl 6100: display: block;
6101: clear: both;
6102: overflow: hidden;
1.803 bisitz 6103: margin: 0;
1.693 droeschl 6104: }
6105:
1.721 harmsja 6106: div.LC_columnSection>* {
1.693 droeschl 6107: float: left;
1.803 bisitz 6108: margin: 10px 20px 10px 0;
1.747 neumanie 6109: overflow:hidden;
1.693 droeschl 6110: }
1.721 harmsja 6111:
1.795 www 6112: .ContentBoxSpecialTemplate {
1.747 neumanie 6113: border: solid 1px $lg_border_color;
1.719 ehlerst 6114: }
1.795 www 6115:
1.719 ehlerst 6116: .ContentBoxTemplate {
6117: padding:10px;
6118: }
6119:
1.721 harmsja 6120: div.LC_columnSection > .ContentBoxTemplate,
1.795 www 6121: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719 ehlerst 6122: width: 600px;
6123: }
1.753 droeschl 6124:
1.795 www 6125: .clear {
1.720 ehlerst 6126: clear: both;
1.803 bisitz 6127: line-height: 0;
6128: font-size: 0;
6129: height: 0;
1.720 ehlerst 6130: }
1.693 droeschl 6131:
1.694 tempelho 6132: .LC_loginpage_container {
6133: text-align:left;
6134: margin : 0 auto;
1.785 tempelho 6135: width:90%;
1.694 tempelho 6136: padding: 10px;
6137: height: auto;
1.712 muellerd 6138: background-color:#FFFFFF;
1.694 tempelho 6139: border:1px solid #CCCCCC;
6140: }
6141:
6142:
6143: .LC_loginpage_loginContainer {
6144: float:left;
1.712 muellerd 6145: width: 182px;
1.785 tempelho 6146: padding: 2px;
1.712 muellerd 6147: border:1px solid #CCCCCC;
6148: background-color:$loginbg;
1.694 tempelho 6149: }
6150:
1.795 www 6151: .LC_loginpage_loginContainer h2 {
1.803 bisitz 6152: margin-top: 0;
1.712 muellerd 6153: display:block;
6154: background:$bgcol;
6155: color:$textcol;
6156: padding-left:5px;
6157: }
1.785 tempelho 6158:
1.694 tempelho 6159: .LC_loginpage_loginInfo {
6160: float:left;
1.785 tempelho 6161: width:182px;
1.694 tempelho 6162: border:1px solid #CCCCCC;
1.785 tempelho 6163: padding:2px;
1.712 muellerd 6164: }
6165:
1.694 tempelho 6166: .LC_loginpage_space {
1.754 droeschl 6167: clear: both;
6168: margin-bottom: 20px;
1.694 tempelho 6169: border-bottom: 1px solid #CCCCCC;
6170: }
6171:
1.785 tempelho 6172: .LC_loginpage_floatLeft {
6173: float: left;
6174: width: 200px;
6175: margin: 0;
6176: }
6177:
1.795 www 6178: table em {
1.754 droeschl 6179: font-weight: bold;
6180: font-style: normal;
1.748 schulted 6181: }
1.795 www 6182:
1.779 bisitz 6183: table.LC_tableBrowseRes,
1.795 www 6184: table.LC_tableOfContent {
1.769 schulted 6185: border:none;
6186: border-spacing: 1;
1.754 droeschl 6187: padding: 3px;
6188: background-color: #FFFFFF;
6189: font-size: 90%;
1.753 droeschl 6190: }
1.789 droeschl 6191:
6192: table.LC_tableOfContent{
6193: border-collapse: collapse;
6194: }
6195:
1.771 droeschl 6196: table.LC_tableBrowseRes a,
1.768 schulted 6197: table.LC_tableOfContent a {
1.771 droeschl 6198: background-color: transparent;
1.753 droeschl 6199: text-decoration: none;
6200: }
6201:
1.771 droeschl 6202: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 6203: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 6204: background-color: #EEEEEE;
1.753 droeschl 6205: }
6206:
1.795 www 6207: table.LC_tableOfContent img {
1.753 droeschl 6208: border: none;
6209: height: 1.3em;
6210: vertical-align: text-bottom;
6211: margin-right: 0.3em;
6212: }
1.757 schulted 6213:
1.795 www 6214: a#LC_content_toolbar_firsthomework {
1.774 ehlerst 6215: background-image:url(/res/adm/pages/open-first-problem.gif);
6216: }
6217:
1.795 www 6218: a#LC_content_toolbar_launchnav {
1.774 ehlerst 6219: background-image:url(/res/adm/pages/start-navigation.gif);
6220: }
6221:
1.795 www 6222: a#LC_content_toolbar_closenav {
1.774 ehlerst 6223: background-image:url(/res/adm/pages/close-navigation.gif);
6224: }
6225:
1.795 www 6226: a#LC_content_toolbar_everything {
1.774 ehlerst 6227: background-image:url(/res/adm/pages/show-all.gif);
6228: }
6229:
1.795 www 6230: a#LC_content_toolbar_uncompleted {
1.774 ehlerst 6231: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
6232: }
6233:
1.795 www 6234: #LC_content_toolbar_clearbubbles {
1.774 ehlerst 6235: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
6236: }
6237:
1.795 www 6238: a#LC_content_toolbar_changefolder {
1.757 schulted 6239: background : url(/res/adm/pages/close-all-folders.gif) top center ;
6240: }
6241:
1.795 www 6242: a#LC_content_toolbar_changefolder_toggled {
1.757 schulted 6243: background-image:url(/res/adm/pages/open-all-folders.gif);
6244: }
6245:
1.795 www 6246: ul#LC_toolbar li a:hover {
1.757 schulted 6247: background-position: bottom center;
6248: }
6249:
1.795 www 6250: ul#LC_toolbar {
1.803 bisitz 6251: padding: 0;
1.757 schulted 6252: margin: 2px;
6253: list-style:none;
6254: position:relative;
6255: background-color:white;
6256: }
6257:
1.795 www 6258: ul#LC_toolbar li {
1.757 schulted 6259: border:1px solid white;
1.803 bisitz 6260: padding: 0;
1.757 schulted 6261: margin: 0;
1.795 www 6262: float: left;
1.767 droeschl 6263: display:inline;
1.757 schulted 6264: vertical-align:middle;
1.795 www 6265: }
1.757 schulted 6266:
1.783 amueller 6267:
1.795 www 6268: a.LC_toolbarItem {
1.767 droeschl 6269: display:block;
1.803 bisitz 6270: padding: 0;
6271: margin: 0;
1.757 schulted 6272: height: 32px;
6273: width: 32px;
1.779 bisitz 6274: color:white;
1.803 bisitz 6275: border: none;
1.757 schulted 6276: background-repeat:no-repeat;
6277: background-color:transparent;
6278: }
6279:
1.782 bisitz 6280: ul.LC_functionslist li {
6281: float: left;
6282: white-space: nowrap;
6283: height: 35px; /* at least as high as heighest list item */
1.803 bisitz 6284: margin: 0 15px 15px 10px;
1.782 bisitz 6285: }
6286:
1.757 schulted 6287:
1.343 albertel 6288: END
6289: }
6290:
1.306 albertel 6291: =pod
6292:
6293: =item * &headtag()
6294:
6295: Returns a uniform footer for LON-CAPA web pages.
6296:
1.307 albertel 6297: Inputs: $title - optional title for the head
6298: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6299: $args - optional arguments
1.319 albertel 6300: force_register - if is true call registerurl so the remote is
6301: informed
1.415 albertel 6302: redirect -> array ref of
6303: 1- seconds before redirect occurs
6304: 2- url to redirect to
6305: 3- whether the side effect should occur
1.315 albertel 6306: (side effect of setting
6307: $env{'internal.head.redirect'} to the url
6308: redirected too)
1.352 albertel 6309: domain -> force to color decorate a page for a specific
6310: domain
6311: function -> force usage of a specific rolish color scheme
6312: bgcolor -> override the default page bgcolor
1.460 albertel 6313: no_auto_mt_title
6314: -> prevent &mt()ing the title arg
1.464 albertel 6315:
1.306 albertel 6316: =cut
6317:
6318: sub headtag {
1.313 albertel 6319: my ($title,$head_extra,$args) = @_;
1.306 albertel 6320:
1.363 albertel 6321: my $function = $args->{'function'} || &get_users_function();
6322: my $domain = $args->{'domain'} || &determinedomain();
6323: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6324: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6325: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6326: #time(),
1.418 albertel 6327: $env{'environment.color.timestamp'},
1.363 albertel 6328: $function,$domain,$bgcolor);
6329:
1.369 www 6330: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6331:
1.308 albertel 6332: my $result =
6333: '<head>'.
1.461 albertel 6334: &font_settings();
1.319 albertel 6335:
1.461 albertel 6336: if (!$args->{'frameset'}) {
6337: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6338: }
1.319 albertel 6339: if ($args->{'force_register'}) {
6340: $result .= &Apache::lonmenu::registerurl(1);
6341: }
1.436 albertel 6342: if (!$args->{'no_nav_bar'}
6343: && !$args->{'only_body'}
6344: && !$args->{'frameset'}) {
6345: $result .= &help_menu_js();
6346: }
1.319 albertel 6347:
1.314 albertel 6348: if (ref($args->{'redirect'})) {
1.414 albertel 6349: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6350: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6351: if (!$inhibit_continue) {
6352: $env{'internal.head.redirect'} = $url;
6353: }
1.313 albertel 6354: $result.=<<ADDMETA
6355: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6356: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6357: ADDMETA
6358: }
1.306 albertel 6359: if (!defined($title)) {
6360: $title = 'The LearningOnline Network with CAPA';
6361: }
1.460 albertel 6362: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6363: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6364: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6365: .$head_extra;
1.306 albertel 6366: return $result;
6367: }
6368:
6369: =pod
6370:
1.340 albertel 6371: =item * &font_settings()
6372:
6373: Returns neccessary <meta> to set the proper encoding
6374:
6375: Inputs: none
6376:
6377: =cut
6378:
6379: sub font_settings {
6380: my $headerstring='';
1.647 www 6381: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6382: $headerstring.=
6383: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6384: }
6385: return $headerstring;
6386: }
6387:
1.341 albertel 6388: =pod
6389:
6390: =item * &xml_begin()
6391:
6392: Returns the needed doctype and <html>
6393:
6394: Inputs: none
6395:
6396: =cut
6397:
6398: sub xml_begin {
6399: my $output='';
6400:
1.592 albertel 6401: if ($env{'internal.start_page'}==1) {
6402: &Apache::lonhtmlcommon::init_htmlareafields();
6403: }
1.342 albertel 6404:
1.341 albertel 6405: if ($env{'browser.mathml'}) {
6406: $output='<?xml version="1.0"?>'
6407: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6408: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6409:
6410: # .'<!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">] >'
6411: .'<!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">'
6412: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6413: .'xmlns="http://www.w3.org/1999/xhtml">';
6414: } else {
6415: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6416: }
6417: return $output;
6418: }
1.340 albertel 6419:
6420: =pod
6421:
1.306 albertel 6422: =item * &endheadtag()
6423:
6424: Returns a uniform </head> for LON-CAPA web pages.
6425:
6426: Inputs: none
6427:
6428: =cut
6429:
6430: sub endheadtag {
6431: return '</head>';
6432: }
6433:
6434: =pod
6435:
6436: =item * &head()
6437:
6438: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6439:
1.648 raeburn 6440: Inputs:
6441:
6442: =over 4
6443:
6444: $title - optional title for the page
6445:
6446: $head_extra - optional extra HTML to put inside the <head>
6447:
6448: =back
1.405 albertel 6449:
1.306 albertel 6450: =cut
6451:
6452: sub head {
1.325 albertel 6453: my ($title,$head_extra,$args) = @_;
6454: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6455: }
6456:
6457: =pod
6458:
6459: =item * &start_page()
6460:
6461: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6462:
1.648 raeburn 6463: Inputs:
6464:
6465: =over 4
6466:
6467: $title - optional title for the page
6468:
6469: $head_extra - optional extra HTML to incude inside the <head>
6470:
6471: $args - additional optional args supported are:
6472:
6473: =over 8
6474:
6475: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6476: arg on
1.814 bisitz 6477: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 6478: add_entries -> additional attributes to add to the <body>
6479: domain -> force to color decorate a page for a
1.317 albertel 6480: specific domain
1.648 raeburn 6481: function -> force usage of a specific rolish color
1.317 albertel 6482: scheme
1.648 raeburn 6483: redirect -> see &headtag()
6484: bgcolor -> override the default page bg color
6485: js_ready -> return a string ready for being used in
1.317 albertel 6486: a javascript writeln
1.648 raeburn 6487: html_encode -> return a string ready for being used in
1.320 albertel 6488: a html attribute
1.648 raeburn 6489: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6490: $forcereg arg
1.648 raeburn 6491: body_title -> alternate text to use instead of $title
1.326 albertel 6492: in the title box that appears, this text
6493: is not auto translated like the $title is
1.648 raeburn 6494: frameset -> if true will start with a <frameset>
1.330 albertel 6495: rather than <body>
1.648 raeburn 6496: skip_phases -> hash ref of
1.338 albertel 6497: head -> skip the <html><head> generation
6498: body -> skip all <body> generation
1.648 raeburn 6499: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6500: 'Switch To Inline Menu' link
1.648 raeburn 6501: no_auto_mt_title -> prevent &mt()ing the title arg
6502: inherit_jsmath -> when creating popup window in a page,
6503: should it have jsmath forced on by the
6504: current page
1.361 albertel 6505:
1.648 raeburn 6506: =back
1.460 albertel 6507:
1.648 raeburn 6508: =back
1.562 albertel 6509:
1.306 albertel 6510: =cut
6511:
6512: sub start_page {
1.309 albertel 6513: my ($title,$head_extra,$args) = @_;
1.318 albertel 6514: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6515: my %head_args;
1.352 albertel 6516: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6517: 'bgcolor','frameset','no_nav_bar','only_body',
6518: 'no_auto_mt_title') {
1.319 albertel 6519: if (defined($args->{$arg})) {
1.324 raeburn 6520: $head_args{$arg} = $args->{$arg};
1.319 albertel 6521: }
1.313 albertel 6522: }
1.319 albertel 6523:
1.315 albertel 6524: $env{'internal.start_page'}++;
1.338 albertel 6525: my $result;
6526: if (! exists($args->{'skip_phases'}{'head'}) ) {
6527: $result.=
1.341 albertel 6528: &xml_begin().
1.338 albertel 6529: &headtag($title,$head_extra,\%head_args).&endheadtag();
6530: }
6531:
6532: if (! exists($args->{'skip_phases'}{'body'}) ) {
6533: if ($args->{'frameset'}) {
6534: my $attr_string = &make_attr_string($args->{'force_register'},
6535: $args->{'add_entries'});
6536: $result .= "\n<frameset $attr_string>\n";
6537: } else {
6538: $result .=
6539: &bodytag($title,
6540: $args->{'function'}, $args->{'add_entries'},
6541: $args->{'only_body'}, $args->{'domain'},
6542: $args->{'force_register'}, $args->{'body_title'},
6543: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.816 bisitz 6544: $args->{'no_inline_link'},
1.460 albertel 6545: $args);
1.338 albertel 6546: }
1.330 albertel 6547: }
1.338 albertel 6548:
1.315 albertel 6549: if ($args->{'js_ready'}) {
1.713 kaisler 6550: $result = &js_ready($result);
1.315 albertel 6551: }
1.320 albertel 6552: if ($args->{'html_encode'}) {
1.713 kaisler 6553: $result = &html_encode($result);
6554: }
6555:
1.813 bisitz 6556: # Preparation for new and consistent functionlist at top of screen
6557: # if ($args->{'functionlist'}) {
6558: # $result .= &build_functionlist();
6559: #}
6560:
6561: # Don't add anything more if only_body wanted
6562: return $result if $args->{'only_body'};
6563:
6564: #Breadcrumbs
1.758 kaisler 6565: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6566: &Apache::lonhtmlcommon::clear_breadcrumbs();
6567: #if any br links exists, add them to the breadcrumbs
6568: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6569: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6570: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6571: }
6572: }
6573:
6574: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6575: if(exists($args->{'bread_crumbs_component'})){
6576: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6577: }else{
6578: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6579: }
1.320 albertel 6580: }
1.315 albertel 6581: return $result;
1.306 albertel 6582: }
6583:
1.330 albertel 6584:
1.306 albertel 6585: =pod
6586:
6587: =item * &head()
6588:
6589: Returns a complete </body></html> section for LON-CAPA web pages.
6590:
1.315 albertel 6591: Inputs: $args - additional optional args supported are:
6592: js_ready -> return a string ready for being used in
6593: a javascript writeln
1.320 albertel 6594: html_encode -> return a string ready for being used in
6595: a html attribute
1.330 albertel 6596: frameset -> if true will start with a <frameset>
6597: rather than <body>
1.493 albertel 6598: dicsussion -> if true will get discussion from
6599: lonxml::xmlend
6600: (you can pass the target and parser arguments
6601: through optional 'target' and 'parser' args
6602: to this routine)
1.306 albertel 6603:
6604: =cut
6605:
6606: sub end_page {
1.315 albertel 6607: my ($args) = @_;
6608: $env{'internal.end_page'}++;
1.330 albertel 6609: my $result;
1.335 albertel 6610: if ($args->{'discussion'}) {
6611: my ($target,$parser);
6612: if (ref($args->{'discussion'})) {
6613: ($target,$parser) =($args->{'discussion'}{'target'},
6614: $args->{'discussion'}{'parser'});
6615: }
6616: $result .= &Apache::lonxml::xmlend($target,$parser);
6617: }
6618:
1.330 albertel 6619: if ($args->{'frameset'}) {
6620: $result .= '</frameset>';
6621: } else {
1.635 raeburn 6622: $result .= &endbodytag($args);
1.330 albertel 6623: }
6624: $result .= "\n</html>";
6625:
1.315 albertel 6626: if ($args->{'js_ready'}) {
1.317 albertel 6627: $result = &js_ready($result);
1.315 albertel 6628: }
1.335 albertel 6629:
1.320 albertel 6630: if ($args->{'html_encode'}) {
6631: $result = &html_encode($result);
6632: }
1.335 albertel 6633:
1.315 albertel 6634: return $result;
6635: }
6636:
1.320 albertel 6637: sub html_encode {
6638: my ($result) = @_;
6639:
1.322 albertel 6640: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6641:
6642: return $result;
6643: }
1.317 albertel 6644: sub js_ready {
6645: my ($result) = @_;
6646:
1.323 albertel 6647: $result =~ s/[\n\r]/ /xmsg;
6648: $result =~ s/\\/\\\\/xmsg;
6649: $result =~ s/'/\\'/xmsg;
1.372 albertel 6650: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6651:
6652: return $result;
6653: }
6654:
1.315 albertel 6655: sub validate_page {
6656: if ( exists($env{'internal.start_page'})
1.316 albertel 6657: && $env{'internal.start_page'} > 1) {
6658: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6659: $env{'internal.start_page'}.' '.
1.316 albertel 6660: $ENV{'request.filename'});
1.315 albertel 6661: }
6662: if ( exists($env{'internal.end_page'})
1.316 albertel 6663: && $env{'internal.end_page'} > 1) {
6664: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6665: $env{'internal.end_page'}.' '.
1.316 albertel 6666: $env{'request.filename'});
1.315 albertel 6667: }
6668: if ( exists($env{'internal.start_page'})
6669: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6670: &Apache::lonnet::logthis('start_page called without end_page '.
6671: $env{'request.filename'});
1.315 albertel 6672: }
6673: if ( ! exists($env{'internal.start_page'})
6674: && exists($env{'internal.end_page'})) {
1.316 albertel 6675: &Apache::lonnet::logthis('end_page called without start_page'.
6676: $env{'request.filename'});
1.315 albertel 6677: }
1.306 albertel 6678: }
1.315 albertel 6679:
1.318 albertel 6680: sub simple_error_page {
6681: my ($r,$title,$msg) = @_;
6682: my $page =
6683: &Apache::loncommon::start_page($title).
6684: &mt($msg).
6685: &Apache::loncommon::end_page();
6686: if (ref($r)) {
6687: $r->print($page);
1.327 albertel 6688: return;
1.318 albertel 6689: }
6690: return $page;
6691: }
1.347 albertel 6692:
6693: {
1.610 albertel 6694: my @row_count;
1.347 albertel 6695: sub start_data_table {
1.422 albertel 6696: my ($add_class) = @_;
6697: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6698: unshift(@row_count,0);
1.422 albertel 6699: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6700: }
6701:
6702: sub end_data_table {
1.610 albertel 6703: shift(@row_count);
1.389 albertel 6704: return '</table>'."\n";;
1.347 albertel 6705: }
6706:
6707: sub start_data_table_row {
1.422 albertel 6708: my ($add_class) = @_;
1.610 albertel 6709: $row_count[0]++;
6710: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6711: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6712: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6713: }
1.471 banghart 6714:
6715: sub continue_data_table_row {
6716: my ($add_class) = @_;
1.610 albertel 6717: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6718: $css_class = (join(' ',$css_class,$add_class));
6719: return '<tr class="'.$css_class.'">'."\n";;
6720: }
1.347 albertel 6721:
6722: sub end_data_table_row {
1.389 albertel 6723: return '</tr>'."\n";;
1.347 albertel 6724: }
1.367 www 6725:
1.421 albertel 6726: sub start_data_table_empty_row {
1.707 bisitz 6727: # $row_count[0]++;
1.421 albertel 6728: return '<tr class="LC_empty_row" >'."\n";;
6729: }
6730:
6731: sub end_data_table_empty_row {
6732: return '</tr>'."\n";;
6733: }
6734:
1.367 www 6735: sub start_data_table_header_row {
1.389 albertel 6736: return '<tr class="LC_header_row">'."\n";;
1.367 www 6737: }
6738:
6739: sub end_data_table_header_row {
1.389 albertel 6740: return '</tr>'."\n";;
1.367 www 6741: }
1.347 albertel 6742: }
6743:
1.548 albertel 6744: =pod
6745:
6746: =item * &inhibit_menu_check($arg)
6747:
6748: Checks for a inhibitmenu state and generates output to preserve it
6749:
6750: Inputs: $arg - can be any of
6751: - undef - in which case the return value is a string
6752: to add into arguments list of a uri
6753: - 'input' - in which case the return value is a HTML
6754: <form> <input> field of type hidden to
6755: preserve the value
6756: - a url - in which case the return value is the url with
6757: the neccesary cgi args added to preserve the
6758: inhibitmenu state
6759: - a ref to a url - no return value, but the string is
6760: updated to include the neccessary cgi
6761: args to preserve the inhibitmenu state
6762:
6763: =cut
6764:
6765: sub inhibit_menu_check {
6766: my ($arg) = @_;
6767: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6768: if ($arg eq 'input') {
6769: if ($env{'form.inhibitmenu'}) {
6770: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6771: } else {
6772: return
6773: }
6774: }
6775: if ($env{'form.inhibitmenu'}) {
6776: if (ref($arg)) {
6777: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6778: } elsif ($arg eq '') {
6779: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6780: } else {
6781: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6782: }
6783: }
6784: if (!ref($arg)) {
6785: return $arg;
6786: }
6787: }
6788:
1.251 albertel 6789: ###############################################
1.182 matthew 6790:
6791: =pod
6792:
1.549 albertel 6793: =back
6794:
6795: =head1 User Information Routines
6796:
6797: =over 4
6798:
1.405 albertel 6799: =item * &get_users_function()
1.182 matthew 6800:
6801: Used by &bodytag to determine the current users primary role.
6802: Returns either 'student','coordinator','admin', or 'author'.
6803:
6804: =cut
6805:
6806: ###############################################
6807: sub get_users_function {
1.815 tempelho 6808: my $function = 'norole';
1.818 tempelho 6809: if ($env{'request.role'}=~/^(st)/) {
6810: $function='student';
6811: }
1.258 albertel 6812: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6813: $function='coordinator';
6814: }
1.258 albertel 6815: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6816: $function='admin';
6817: }
1.826 bisitz 6818: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182 matthew 6819: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6820: $function='author';
6821: }
6822: return $function;
1.54 www 6823: }
1.99 www 6824:
6825: ###############################################
6826:
1.233 raeburn 6827: =pod
6828:
1.821 raeburn 6829: =item * &show_course()
6830:
6831: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
6832: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
6833:
6834: Inputs:
6835: None
6836:
6837: Outputs:
6838: Scalar: 1 if 'Course' to be used, 0 otherwise.
6839:
6840: =cut
6841:
6842: ###############################################
6843: sub show_course {
6844: my $course = !$env{'user.adv'};
6845: if (!$env{'user.adv'}) {
6846: foreach my $env (keys(%env)) {
6847: next if ($env !~ m/^user\.priv\./);
6848: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
6849: $course = 0;
6850: last;
6851: }
6852: }
6853: }
6854: return $course;
6855: }
6856:
6857: ###############################################
6858:
6859: =pod
6860:
1.542 raeburn 6861: =item * &check_user_status()
1.274 raeburn 6862:
6863: Determines current status of supplied role for a
6864: specific user. Roles can be active, previous or future.
6865:
6866: Inputs:
6867: user's domain, user's username, course's domain,
1.375 raeburn 6868: course's number, optional section ID.
1.274 raeburn 6869:
6870: Outputs:
6871: role status: active, previous or future.
6872:
6873: =cut
6874:
6875: sub check_user_status {
1.412 raeburn 6876: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6877: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6878: my @uroles = keys %userinfo;
6879: my $srchstr;
6880: my $active_chk = 'none';
1.412 raeburn 6881: my $now = time;
1.274 raeburn 6882: if (@uroles > 0) {
1.412 raeburn 6883: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6884: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6885: } else {
1.412 raeburn 6886: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6887: }
6888: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6889: my $role_end = 0;
6890: my $role_start = 0;
6891: $active_chk = 'active';
1.412 raeburn 6892: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6893: $role_end = $1;
6894: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6895: $role_start = $1;
1.274 raeburn 6896: }
6897: }
6898: if ($role_start > 0) {
1.412 raeburn 6899: if ($now < $role_start) {
1.274 raeburn 6900: $active_chk = 'future';
6901: }
6902: }
6903: if ($role_end > 0) {
1.412 raeburn 6904: if ($now > $role_end) {
1.274 raeburn 6905: $active_chk = 'previous';
6906: }
6907: }
6908: }
6909: }
6910: return $active_chk;
6911: }
6912:
6913: ###############################################
6914:
6915: =pod
6916:
1.405 albertel 6917: =item * &get_sections()
1.233 raeburn 6918:
6919: Determines all the sections for a course including
6920: sections with students and sections containing other roles.
1.419 raeburn 6921: Incoming parameters:
6922:
6923: 1. domain
6924: 2. course number
6925: 3. reference to array containing roles for which sections should
6926: be gathered (optional).
6927: 4. reference to array containing status types for which sections
6928: should be gathered (optional).
6929:
6930: If the third argument is undefined, sections are gathered for any role.
6931: If the fourth argument is undefined, sections are gathered for any status.
6932: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6933:
1.374 raeburn 6934: Returns section hash (keys are section IDs, values are
6935: number of users in each section), subject to the
1.419 raeburn 6936: optional roles filter, optional status filter
1.233 raeburn 6937:
6938: =cut
6939:
6940: ###############################################
6941: sub get_sections {
1.419 raeburn 6942: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6943: if (!defined($cdom) || !defined($cnum)) {
6944: my $cid = $env{'request.course.id'};
6945:
6946: return if (!defined($cid));
6947:
6948: $cdom = $env{'course.'.$cid.'.domain'};
6949: $cnum = $env{'course.'.$cid.'.num'};
6950: }
6951:
6952: my %sectioncount;
1.419 raeburn 6953: my $now = time;
1.240 albertel 6954:
1.366 albertel 6955: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6956: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6957: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6958: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6959: my $start_index = &Apache::loncoursedata::CL_START();
6960: my $end_index = &Apache::loncoursedata::CL_END();
6961: my $status;
1.366 albertel 6962: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6963: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6964: $data->[$status_index],
6965: $data->[$start_index],
6966: $data->[$end_index]);
6967: if ($stu_status eq 'Active') {
6968: $status = 'active';
6969: } elsif ($end < $now) {
6970: $status = 'previous';
6971: } elsif ($start > $now) {
6972: $status = 'future';
6973: }
6974: if ($section ne '-1' && $section !~ /^\s*$/) {
6975: if ((!defined($possible_status)) || (($status ne '') &&
6976: (grep/^\Q$status\E$/,@{$possible_status}))) {
6977: $sectioncount{$section}++;
6978: }
1.240 albertel 6979: }
6980: }
6981: }
6982: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6983: foreach my $user (sort(keys(%courseroles))) {
6984: if ($user !~ /^(\w{2})/) { next; }
6985: my ($role) = ($user =~ /^(\w{2})/);
6986: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6987: my ($section,$status);
1.240 albertel 6988: if ($role eq 'cr' &&
6989: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6990: $section=$1;
6991: }
6992: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6993: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6994: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6995: if ($end == -1 && $start == -1) {
6996: next; #deleted role
6997: }
6998: if (!defined($possible_status)) {
6999: $sectioncount{$section}++;
7000: } else {
7001: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7002: $status = 'active';
7003: } elsif ($end < $now) {
7004: $status = 'future';
7005: } elsif ($start > $now) {
7006: $status = 'previous';
7007: }
7008: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7009: $sectioncount{$section}++;
7010: }
7011: }
1.233 raeburn 7012: }
1.366 albertel 7013: return %sectioncount;
1.233 raeburn 7014: }
7015:
1.274 raeburn 7016: ###############################################
1.294 raeburn 7017:
7018: =pod
1.405 albertel 7019:
7020: =item * &get_course_users()
7021:
1.275 raeburn 7022: Retrieves usernames:domains for users in the specified course
7023: with specific role(s), and access status.
7024:
7025: Incoming parameters:
1.277 albertel 7026: 1. course domain
7027: 2. course number
7028: 3. access status: users must have - either active,
1.275 raeburn 7029: previous, future, or all.
1.277 albertel 7030: 4. reference to array of permissible roles
1.288 raeburn 7031: 5. reference to array of section restrictions (optional)
7032: 6. reference to results object (hash of hashes).
7033: 7. reference to optional userdata hash
1.609 raeburn 7034: 8. reference to optional statushash
1.630 raeburn 7035: 9. flag if privileged users (except those set to unhide in
7036: course settings) should be excluded
1.609 raeburn 7037: Keys of top level results hash are roles.
1.275 raeburn 7038: Keys of inner hashes are username:domain, with
7039: values set to access type.
1.288 raeburn 7040: Optional userdata hash returns an array with arguments in the
7041: same order as loncoursedata::get_classlist() for student data.
7042:
1.609 raeburn 7043: Optional statushash returns
7044:
1.288 raeburn 7045: Entries for end, start, section and status are blank because
7046: of the possibility of multiple values for non-student roles.
7047:
1.275 raeburn 7048: =cut
1.405 albertel 7049:
1.275 raeburn 7050: ###############################################
1.405 albertel 7051:
1.275 raeburn 7052: sub get_course_users {
1.630 raeburn 7053: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 7054: my %idx = ();
1.419 raeburn 7055: my %seclists;
1.288 raeburn 7056:
7057: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7058: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7059: $idx{end} = &Apache::loncoursedata::CL_END();
7060: $idx{start} = &Apache::loncoursedata::CL_START();
7061: $idx{id} = &Apache::loncoursedata::CL_ID();
7062: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7063: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7064: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7065:
1.290 albertel 7066: if (grep(/^st$/,@{$roles})) {
1.276 albertel 7067: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 7068: my $now = time;
1.277 albertel 7069: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 7070: my $match = 0;
1.412 raeburn 7071: my $secmatch = 0;
1.419 raeburn 7072: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 7073: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 7074: if ($section eq '') {
7075: $section = 'none';
7076: }
1.291 albertel 7077: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7078: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7079: $secmatch = 1;
7080: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 7081: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7082: $secmatch = 1;
7083: }
7084: } else {
1.419 raeburn 7085: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 7086: $secmatch = 1;
7087: }
1.290 albertel 7088: }
1.412 raeburn 7089: if (!$secmatch) {
7090: next;
7091: }
1.419 raeburn 7092: }
1.275 raeburn 7093: if (defined($$types{'active'})) {
1.288 raeburn 7094: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 7095: push(@{$$users{st}{$student}},'active');
1.288 raeburn 7096: $match = 1;
1.275 raeburn 7097: }
7098: }
7099: if (defined($$types{'previous'})) {
1.609 raeburn 7100: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 7101: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 7102: $match = 1;
1.275 raeburn 7103: }
7104: }
7105: if (defined($$types{'future'})) {
1.609 raeburn 7106: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 7107: push(@{$$users{st}{$student}},'future');
1.288 raeburn 7108: $match = 1;
1.275 raeburn 7109: }
7110: }
1.609 raeburn 7111: if ($match) {
7112: push(@{$seclists{$student}},$section);
7113: if (ref($userdata) eq 'HASH') {
7114: $$userdata{$student} = $$classlist{$student};
7115: }
7116: if (ref($statushash) eq 'HASH') {
7117: $statushash->{$student}{'st'}{$section} = $status;
7118: }
1.288 raeburn 7119: }
1.275 raeburn 7120: }
7121: }
1.412 raeburn 7122: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 7123: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7124: my $now = time;
1.609 raeburn 7125: my %displaystatus = ( previous => 'Expired',
7126: active => 'Active',
7127: future => 'Future',
7128: );
1.630 raeburn 7129: my %nothide;
7130: if ($hidepriv) {
7131: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7132: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7133: if ($user !~ /:/) {
7134: $nothide{join(':',split(/[\@]/,$user))}=1;
7135: } else {
7136: $nothide{$user} = 1;
7137: }
7138: }
7139: }
1.439 raeburn 7140: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 7141: my $match = 0;
1.412 raeburn 7142: my $secmatch = 0;
1.439 raeburn 7143: my $status;
1.412 raeburn 7144: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 7145: $user =~ s/:$//;
1.439 raeburn 7146: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7147: if ($end == -1 || $start == -1) {
7148: next;
7149: }
7150: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7151: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 7152: my ($uname,$udom) = split(/:/,$user);
7153: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 7154: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 7155: $secmatch = 1;
7156: } elsif ($usec eq '') {
1.420 albertel 7157: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 7158: $secmatch = 1;
7159: }
7160: } else {
7161: if (grep(/^\Q$usec\E$/,@{$sections})) {
7162: $secmatch = 1;
7163: }
7164: }
7165: if (!$secmatch) {
7166: next;
7167: }
1.288 raeburn 7168: }
1.419 raeburn 7169: if ($usec eq '') {
7170: $usec = 'none';
7171: }
1.275 raeburn 7172: if ($uname ne '' && $udom ne '') {
1.630 raeburn 7173: if ($hidepriv) {
7174: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7175: (!$nothide{$uname.':'.$udom})) {
7176: next;
7177: }
7178: }
1.503 raeburn 7179: if ($end > 0 && $end < $now) {
1.439 raeburn 7180: $status = 'previous';
7181: } elsif ($start > $now) {
7182: $status = 'future';
7183: } else {
7184: $status = 'active';
7185: }
1.277 albertel 7186: foreach my $type (keys(%{$types})) {
1.275 raeburn 7187: if ($status eq $type) {
1.420 albertel 7188: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 7189: push(@{$$users{$role}{$user}},$type);
7190: }
1.288 raeburn 7191: $match = 1;
7192: }
7193: }
1.419 raeburn 7194: if (($match) && (ref($userdata) eq 'HASH')) {
7195: if (!exists($$userdata{$uname.':'.$udom})) {
7196: &get_user_info($udom,$uname,\%idx,$userdata);
7197: }
1.420 albertel 7198: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 7199: push(@{$seclists{$uname.':'.$udom}},$usec);
7200: }
1.609 raeburn 7201: if (ref($statushash) eq 'HASH') {
7202: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7203: }
1.275 raeburn 7204: }
7205: }
7206: }
7207: }
1.290 albertel 7208: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 7209: if ((defined($cdom)) && (defined($cnum))) {
7210: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7211: if ( defined($csettings{'internal.courseowner'}) ) {
7212: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 7213: next if ($owner eq '');
7214: my ($ownername,$ownerdom);
7215: if ($owner =~ /^([^:]+):([^:]+)$/) {
7216: $ownername = $1;
7217: $ownerdom = $2;
7218: } else {
7219: $ownername = $owner;
7220: $ownerdom = $cdom;
7221: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 7222: }
7223: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 7224: if (defined($userdata) &&
1.609 raeburn 7225: !exists($$userdata{$owner})) {
7226: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7227: if (!grep(/^none$/,@{$seclists{$owner}})) {
7228: push(@{$seclists{$owner}},'none');
7229: }
7230: if (ref($statushash) eq 'HASH') {
7231: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 7232: }
1.290 albertel 7233: }
1.279 raeburn 7234: }
7235: }
7236: }
1.419 raeburn 7237: foreach my $user (keys(%seclists)) {
7238: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7239: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7240: }
1.275 raeburn 7241: }
7242: return;
7243: }
7244:
1.288 raeburn 7245: sub get_user_info {
7246: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 7247: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7248: &plainname($uname,$udom,'lastname');
1.291 albertel 7249: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 7250: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 7251: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7252: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 7253: return;
7254: }
1.275 raeburn 7255:
1.472 raeburn 7256: ###############################################
7257:
7258: =pod
7259:
7260: =item * &get_user_quota()
7261:
7262: Retrieves quota assigned for storage of portfolio files for a user
7263:
7264: Incoming parameters:
7265: 1. user's username
7266: 2. user's domain
7267:
7268: Returns:
1.536 raeburn 7269: 1. Disk quota (in Mb) assigned to student.
7270: 2. (Optional) Type of setting: custom or default
7271: (individually assigned or default for user's
7272: institutional status).
7273: 3. (Optional) - User's institutional status (e.g., faculty, staff
7274: or student - types as defined in localenroll::inst_usertypes
7275: for user's domain, which determines default quota for user.
7276: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 7277:
7278: If a value has been stored in the user's environment,
1.536 raeburn 7279: it will return that, otherwise it returns the maximal default
7280: defined for the user's instituional status(es) in the domain.
1.472 raeburn 7281:
7282: =cut
7283:
7284: ###############################################
7285:
7286:
7287: sub get_user_quota {
7288: my ($uname,$udom) = @_;
1.536 raeburn 7289: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 7290: if (!defined($udom)) {
7291: $udom = $env{'user.domain'};
7292: }
7293: if (!defined($uname)) {
7294: $uname = $env{'user.name'};
7295: }
7296: if (($udom eq '' || $uname eq '') ||
7297: ($udom eq 'public') && ($uname eq 'public')) {
7298: $quota = 0;
1.536 raeburn 7299: $quotatype = 'default';
7300: $defquota = 0;
1.472 raeburn 7301: } else {
1.536 raeburn 7302: my $inststatus;
1.472 raeburn 7303: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7304: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 7305: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 7306: } else {
1.536 raeburn 7307: my %userenv =
7308: &Apache::lonnet::get('environment',['portfolioquota',
7309: 'inststatus'],$udom,$uname);
1.472 raeburn 7310: my ($tmp) = keys(%userenv);
7311: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7312: $quota = $userenv{'portfolioquota'};
1.536 raeburn 7313: $inststatus = $userenv{'inststatus'};
1.472 raeburn 7314: } else {
7315: undef(%userenv);
7316: }
7317: }
1.536 raeburn 7318: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7319: if ($quota eq '') {
1.536 raeburn 7320: $quota = $defquota;
7321: $quotatype = 'default';
7322: } else {
7323: $quotatype = 'custom';
1.472 raeburn 7324: }
7325: }
1.536 raeburn 7326: if (wantarray) {
7327: return ($quota,$quotatype,$settingstatus,$defquota);
7328: } else {
7329: return $quota;
7330: }
1.472 raeburn 7331: }
7332:
7333: ###############################################
7334:
7335: =pod
7336:
7337: =item * &default_quota()
7338:
1.536 raeburn 7339: Retrieves default quota assigned for storage of user portfolio files,
7340: given an (optional) user's institutional status.
1.472 raeburn 7341:
7342: Incoming parameters:
7343: 1. domain
1.536 raeburn 7344: 2. (Optional) institutional status(es). This is a : separated list of
7345: status types (e.g., faculty, staff, student etc.)
7346: which apply to the user for whom the default is being retrieved.
7347: If the institutional status string in undefined, the domain
7348: default quota will be returned.
1.472 raeburn 7349:
7350: Returns:
7351: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7352: 2. (Optional) institutional type which determined the value of the
7353: default quota.
1.472 raeburn 7354:
7355: If a value has been stored in the domain's configuration db,
7356: it will return that, otherwise it returns 20 (for backwards
7357: compatibility with domains which have not set up a configuration
7358: db file; the original statically defined portfolio quota was 20 Mb).
7359:
1.536 raeburn 7360: If the user's status includes multiple types (e.g., staff and student),
7361: the largest default quota which applies to the user determines the
7362: default quota returned.
7363:
1.780 raeburn 7364: =back
7365:
1.472 raeburn 7366: =cut
7367:
7368: ###############################################
7369:
7370:
7371: sub default_quota {
1.536 raeburn 7372: my ($udom,$inststatus) = @_;
7373: my ($defquota,$settingstatus);
7374: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7375: ['quotas'],$udom);
7376: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7377: if ($inststatus ne '') {
1.765 raeburn 7378: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7379: foreach my $item (@statuses) {
1.711 raeburn 7380: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7381: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7382: if ($defquota eq '') {
7383: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7384: $settingstatus = $item;
7385: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7386: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7387: $settingstatus = $item;
7388: }
7389: }
7390: } else {
7391: if ($quotahash{'quotas'}{$item} ne '') {
7392: if ($defquota eq '') {
7393: $defquota = $quotahash{'quotas'}{$item};
7394: $settingstatus = $item;
7395: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7396: $defquota = $quotahash{'quotas'}{$item};
7397: $settingstatus = $item;
7398: }
1.536 raeburn 7399: }
7400: }
7401: }
7402: }
7403: if ($defquota eq '') {
1.711 raeburn 7404: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7405: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7406: } else {
7407: $defquota = $quotahash{'quotas'}{'default'};
7408: }
1.536 raeburn 7409: $settingstatus = 'default';
7410: }
7411: } else {
7412: $settingstatus = 'default';
7413: $defquota = 20;
7414: }
7415: if (wantarray) {
7416: return ($defquota,$settingstatus);
1.472 raeburn 7417: } else {
1.536 raeburn 7418: return $defquota;
1.472 raeburn 7419: }
7420: }
7421:
1.384 raeburn 7422: sub get_secgrprole_info {
7423: my ($cdom,$cnum,$needroles,$type) = @_;
7424: my %sections_count = &get_sections($cdom,$cnum);
7425: my @sections = (sort {$a <=> $b} keys(%sections_count));
7426: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7427: my @groups = sort(keys(%curr_groups));
7428: my $allroles = [];
7429: my $rolehash;
7430: my $accesshash = {
7431: active => 'Currently has access',
7432: future => 'Will have future access',
7433: previous => 'Previously had access',
7434: };
7435: if ($needroles) {
7436: $rolehash = {'all' => 'all'};
1.385 albertel 7437: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7438: if (&Apache::lonnet::error(%user_roles)) {
7439: undef(%user_roles);
7440: }
7441: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7442: my ($role)=split(/\:/,$item,2);
7443: if ($role eq 'cr') { next; }
7444: if ($role =~ /^cr/) {
7445: $$rolehash{$role} = (split('/',$role))[3];
7446: } else {
7447: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7448: }
7449: }
7450: foreach my $key (sort(keys(%{$rolehash}))) {
7451: push(@{$allroles},$key);
7452: }
7453: push (@{$allroles},'st');
7454: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7455: }
7456: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7457: }
7458:
1.555 raeburn 7459: sub user_picker {
1.627 raeburn 7460: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7461: my $currdom = $dom;
7462: my %curr_selected = (
7463: srchin => 'dom',
1.580 raeburn 7464: srchby => 'lastname',
1.555 raeburn 7465: );
7466: my $srchterm;
1.625 raeburn 7467: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7468: if ($srch->{'srchby'} ne '') {
7469: $curr_selected{'srchby'} = $srch->{'srchby'};
7470: }
7471: if ($srch->{'srchin'} ne '') {
7472: $curr_selected{'srchin'} = $srch->{'srchin'};
7473: }
7474: if ($srch->{'srchtype'} ne '') {
7475: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7476: }
7477: if ($srch->{'srchdomain'} ne '') {
7478: $currdom = $srch->{'srchdomain'};
7479: }
7480: $srchterm = $srch->{'srchterm'};
7481: }
7482: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7483: 'usr' => 'Search criteria',
1.563 raeburn 7484: 'doma' => 'Domain/institution to search',
1.558 albertel 7485: 'uname' => 'username',
7486: 'lastname' => 'last name',
1.555 raeburn 7487: 'lastfirst' => 'last name, first name',
1.558 albertel 7488: 'crs' => 'in this course',
1.576 raeburn 7489: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7490: 'alc' => 'all LON-CAPA',
1.573 raeburn 7491: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7492: 'exact' => 'is',
7493: 'contains' => 'contains',
1.569 raeburn 7494: 'begins' => 'begins with',
1.571 raeburn 7495: 'youm' => "You must include some text to search for.",
7496: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7497: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7498: 'yomc' => "You must choose a domain when using an institutional directory search.",
7499: 'ymcd' => "You must choose a domain when using a domain search.",
7500: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7501: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7502: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7503: );
1.563 raeburn 7504: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7505: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7506:
7507: my @srchins = ('crs','dom','alc','instd');
7508:
7509: foreach my $option (@srchins) {
7510: # FIXME 'alc' option unavailable until
7511: # loncreateuser::print_user_query_page()
7512: # has been completed.
7513: next if ($option eq 'alc');
7514: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7515: if ($curr_selected{'srchin'} eq $option) {
7516: $srchinsel .= '
7517: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7518: } else {
7519: $srchinsel .= '
7520: <option value="'.$option.'">'.$lt{$option}.'</option>';
7521: }
1.555 raeburn 7522: }
1.563 raeburn 7523: $srchinsel .= "\n </select>\n";
1.555 raeburn 7524:
7525: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7526: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7527: if ($curr_selected{'srchby'} eq $option) {
7528: $srchbysel .= '
7529: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7530: } else {
7531: $srchbysel .= '
7532: <option value="'.$option.'">'.$lt{$option}.'</option>';
7533: }
7534: }
7535: $srchbysel .= "\n </select>\n";
7536:
7537: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7538: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7539: if ($curr_selected{'srchtype'} eq $option) {
7540: $srchtypesel .= '
7541: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7542: } else {
7543: $srchtypesel .= '
7544: <option value="'.$option.'">'.$lt{$option}.'</option>';
7545: }
7546: }
7547: $srchtypesel .= "\n </select>\n";
7548:
1.558 albertel 7549: my ($newuserscript,$new_user_create);
1.556 raeburn 7550:
7551: if ($forcenewuser) {
1.576 raeburn 7552: if (ref($srch) eq 'HASH') {
7553: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7554: if ($cancreate) {
7555: $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>';
7556: } else {
1.799 bisitz 7557: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 7558: my %usertypetext = (
7559: official => 'institutional',
7560: unofficial => 'non-institutional',
7561: );
1.799 bisitz 7562: $new_user_create = '<p class="LC_warning">'
7563: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7564: .' '
7565: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7566: ,'<a href="'.$helplink.'">','</a>')
7567: .'</p><br />';
1.627 raeburn 7568: }
1.576 raeburn 7569: }
7570: }
7571:
1.556 raeburn 7572: $newuserscript = <<"ENDSCRIPT";
7573:
1.570 raeburn 7574: function setSearch(createnew,callingForm) {
1.556 raeburn 7575: if (createnew == 1) {
1.570 raeburn 7576: for (var i=0; i<callingForm.srchby.length; i++) {
7577: if (callingForm.srchby.options[i].value == 'uname') {
7578: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7579: }
7580: }
1.570 raeburn 7581: for (var i=0; i<callingForm.srchin.length; i++) {
7582: if ( callingForm.srchin.options[i].value == 'dom') {
7583: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7584: }
7585: }
1.570 raeburn 7586: for (var i=0; i<callingForm.srchtype.length; i++) {
7587: if (callingForm.srchtype.options[i].value == 'exact') {
7588: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7589: }
7590: }
1.570 raeburn 7591: for (var i=0; i<callingForm.srchdomain.length; i++) {
7592: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7593: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7594: }
7595: }
7596: }
7597: }
7598: ENDSCRIPT
1.558 albertel 7599:
1.556 raeburn 7600: }
7601:
1.555 raeburn 7602: my $output = <<"END_BLOCK";
1.556 raeburn 7603: <script type="text/javascript">
1.824 bisitz 7604: // <![CDATA[
1.570 raeburn 7605: function validateEntry(callingForm) {
1.558 albertel 7606:
1.556 raeburn 7607: var checkok = 1;
1.558 albertel 7608: var srchin;
1.570 raeburn 7609: for (var i=0; i<callingForm.srchin.length; i++) {
7610: if ( callingForm.srchin[i].checked ) {
7611: srchin = callingForm.srchin[i].value;
1.558 albertel 7612: }
7613: }
7614:
1.570 raeburn 7615: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7616: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7617: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7618: var srchterm = callingForm.srchterm.value;
7619: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7620: var msg = "";
7621:
7622: if (srchterm == "") {
7623: checkok = 0;
1.571 raeburn 7624: msg += "$lt{'youm'}\\n";
1.556 raeburn 7625: }
7626:
1.569 raeburn 7627: if (srchtype== 'begins') {
7628: if (srchterm.length < 2) {
7629: checkok = 0;
1.571 raeburn 7630: msg += "$lt{'thte'}\\n";
1.569 raeburn 7631: }
7632: }
7633:
1.556 raeburn 7634: if (srchtype== 'contains') {
7635: if (srchterm.length < 3) {
7636: checkok = 0;
1.571 raeburn 7637: msg += "$lt{'thet'}\\n";
1.556 raeburn 7638: }
7639: }
7640: if (srchin == 'instd') {
7641: if (srchdomain == '') {
7642: checkok = 0;
1.571 raeburn 7643: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7644: }
7645: }
7646: if (srchin == 'dom') {
7647: if (srchdomain == '') {
7648: checkok = 0;
1.571 raeburn 7649: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7650: }
7651: }
7652: if (srchby == 'lastfirst') {
7653: if (srchterm.indexOf(",") == -1) {
7654: checkok = 0;
1.571 raeburn 7655: msg += "$lt{'whus'}\\n";
1.556 raeburn 7656: }
7657: if (srchterm.indexOf(",") == srchterm.length -1) {
7658: checkok = 0;
1.571 raeburn 7659: msg += "$lt{'whse'}\\n";
1.556 raeburn 7660: }
7661: }
7662: if (checkok == 0) {
1.571 raeburn 7663: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7664: return;
7665: }
7666: if (checkok == 1) {
1.570 raeburn 7667: callingForm.submit();
1.556 raeburn 7668: }
7669: }
7670:
7671: $newuserscript
7672:
1.824 bisitz 7673: // ]]>
1.556 raeburn 7674: </script>
1.558 albertel 7675:
7676: $new_user_create
7677:
1.555 raeburn 7678: <table>
1.558 albertel 7679: <tr>
1.573 raeburn 7680: <td>$lt{'doma'}:</td>
7681: <td>$domform</td>
7682: </td>
7683: </tr>
7684: <tr>
7685: <td>$lt{'usr'}:</td>
1.563 raeburn 7686: <td>$srchbysel
7687: $srchtypesel
7688: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7689: $srchinsel
1.563 raeburn 7690: </td>
7691: </tr>
1.555 raeburn 7692: </table>
7693: <br />
7694: END_BLOCK
1.558 albertel 7695:
1.555 raeburn 7696: return $output;
7697: }
7698:
1.612 raeburn 7699: sub user_rule_check {
1.615 raeburn 7700: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7701: my $response;
7702: if (ref($usershash) eq 'HASH') {
7703: foreach my $user (keys(%{$usershash})) {
7704: my ($uname,$udom) = split(/:/,$user);
7705: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7706: my ($id,$newuser);
1.612 raeburn 7707: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7708: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7709: $id = $usershash->{$user}->{'id'};
7710: }
7711: my $inst_response;
7712: if (ref($checks) eq 'HASH') {
7713: if (defined($checks->{'username'})) {
1.615 raeburn 7714: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7715: &Apache::lonnet::get_instuser($udom,$uname);
7716: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7717: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7718: &Apache::lonnet::get_instuser($udom,undef,$id);
7719: }
1.615 raeburn 7720: } else {
7721: ($inst_response,%{$inst_results->{$user}}) =
7722: &Apache::lonnet::get_instuser($udom,$uname);
7723: return;
1.612 raeburn 7724: }
1.615 raeburn 7725: if (!$got_rules->{$udom}) {
1.612 raeburn 7726: my %domconfig = &Apache::lonnet::get_dom('configuration',
7727: ['usercreation'],$udom);
7728: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7729: foreach my $item ('username','id') {
1.612 raeburn 7730: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7731: $$curr_rules{$udom}{$item} =
7732: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7733: }
7734: }
7735: }
1.615 raeburn 7736: $got_rules->{$udom} = 1;
1.585 raeburn 7737: }
1.612 raeburn 7738: foreach my $item (keys(%{$checks})) {
7739: if (ref($$curr_rules{$udom}) eq 'HASH') {
7740: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7741: if (@{$$curr_rules{$udom}{$item}} > 0) {
7742: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7743: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7744: if ($rule_check{$rule}) {
7745: $$rulematch{$user}{$item} = $rule;
7746: if ($inst_response eq 'ok') {
1.615 raeburn 7747: if (ref($inst_results) eq 'HASH') {
7748: if (ref($inst_results->{$user}) eq 'HASH') {
7749: if (keys(%{$inst_results->{$user}}) == 0) {
7750: $$alerts{$item}{$udom}{$uname} = 1;
7751: }
1.612 raeburn 7752: }
7753: }
1.615 raeburn 7754: }
7755: last;
1.585 raeburn 7756: }
7757: }
7758: }
7759: }
7760: }
7761: }
7762: }
7763: }
1.612 raeburn 7764: return;
7765: }
7766:
7767: sub user_rule_formats {
7768: my ($domain,$domdesc,$curr_rules,$check) = @_;
7769: my %text = (
7770: 'username' => 'Usernames',
7771: 'id' => 'IDs',
7772: );
7773: my $output;
7774: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7775: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7776: if (@{$ruleorder} > 0) {
7777: $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>';
7778: foreach my $rule (@{$ruleorder}) {
7779: if (ref($curr_rules) eq 'ARRAY') {
7780: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7781: if (ref($rules->{$rule}) eq 'HASH') {
7782: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7783: $rules->{$rule}{'desc'}.'</li>';
7784: }
7785: }
7786: }
7787: }
7788: $output .= '</ul>';
7789: }
7790: }
7791: return $output;
7792: }
7793:
7794: sub instrule_disallow_msg {
1.615 raeburn 7795: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7796: my $response;
7797: my %text = (
7798: item => 'username',
7799: items => 'usernames',
7800: match => 'matches',
7801: do => 'does',
7802: action => 'a username',
7803: one => 'one',
7804: );
7805: if ($count > 1) {
7806: $text{'item'} = 'usernames';
7807: $text{'match'} ='match';
7808: $text{'do'} = 'do';
7809: $text{'action'} = 'usernames',
7810: $text{'one'} = 'ones';
7811: }
7812: if ($checkitem eq 'id') {
7813: $text{'items'} = 'IDs';
7814: $text{'item'} = 'ID';
7815: $text{'action'} = 'an ID';
1.615 raeburn 7816: if ($count > 1) {
7817: $text{'item'} = 'IDs';
7818: $text{'action'} = 'IDs';
7819: }
1.612 raeburn 7820: }
1.674 bisitz 7821: $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 7822: if ($mode eq 'upload') {
7823: if ($checkitem eq 'username') {
7824: $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'}.");
7825: } elsif ($checkitem eq 'id') {
1.674 bisitz 7826: $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 7827: }
1.669 raeburn 7828: } elsif ($mode eq 'selfcreate') {
7829: if ($checkitem eq 'id') {
7830: $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.");
7831: }
1.615 raeburn 7832: } else {
7833: if ($checkitem eq 'username') {
7834: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7835: } elsif ($checkitem eq 'id') {
7836: $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.");
7837: }
1.612 raeburn 7838: }
7839: return $response;
1.585 raeburn 7840: }
7841:
1.624 raeburn 7842: sub personal_data_fieldtitles {
7843: my %fieldtitles = &Apache::lonlocal::texthash (
7844: id => 'Student/Employee ID',
7845: permanentemail => 'E-mail address',
7846: lastname => 'Last Name',
7847: firstname => 'First Name',
7848: middlename => 'Middle Name',
7849: generation => 'Generation',
7850: gen => 'Generation',
1.765 raeburn 7851: inststatus => 'Affiliation',
1.624 raeburn 7852: );
7853: return %fieldtitles;
7854: }
7855:
1.642 raeburn 7856: sub sorted_inst_types {
7857: my ($dom) = @_;
7858: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7859: my $othertitle = &mt('All users');
7860: if ($env{'request.course.id'}) {
1.668 raeburn 7861: $othertitle = &mt('Any users');
1.642 raeburn 7862: }
7863: my @types;
7864: if (ref($order) eq 'ARRAY') {
7865: @types = @{$order};
7866: }
7867: if (@types == 0) {
7868: if (ref($usertypes) eq 'HASH') {
7869: @types = sort(keys(%{$usertypes}));
7870: }
7871: }
7872: if (keys(%{$usertypes}) > 0) {
7873: $othertitle = &mt('Other users');
7874: }
7875: return ($othertitle,$usertypes,\@types);
7876: }
7877:
1.645 raeburn 7878: sub get_institutional_codes {
7879: my ($settings,$allcourses,$LC_code) = @_;
7880: # Get complete list of course sections to update
7881: my @currsections = ();
7882: my @currxlists = ();
7883: my $coursecode = $$settings{'internal.coursecode'};
7884:
7885: if ($$settings{'internal.sectionnums'} ne '') {
7886: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7887: }
7888:
7889: if ($$settings{'internal.crosslistings'} ne '') {
7890: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7891: }
7892:
7893: if (@currxlists > 0) {
7894: foreach (@currxlists) {
7895: if (m/^([^:]+):(\w*)$/) {
7896: unless (grep/^$1$/,@{$allcourses}) {
7897: push @{$allcourses},$1;
7898: $$LC_code{$1} = $2;
7899: }
7900: }
7901: }
7902: }
7903:
7904: if (@currsections > 0) {
7905: foreach (@currsections) {
7906: if (m/^(\w+):(\w*)$/) {
7907: my $sec = $coursecode.$1;
7908: my $lc_sec = $2;
7909: unless (grep/^$sec$/,@{$allcourses}) {
7910: push @{$allcourses},$sec;
7911: $$LC_code{$sec} = $lc_sec;
7912: }
7913: }
7914: }
7915: }
7916: return;
7917: }
7918:
1.112 bowersj2 7919: =pod
7920:
1.780 raeburn 7921: =head1 Slot Helpers
7922:
7923: =over 4
7924:
7925: =item * sorted_slots()
7926:
7927: Sorts an array of slot names in order of slot start time (earliest first).
7928:
7929: Inputs:
7930:
7931: =over 4
7932:
7933: slotsarr - Reference to array of unsorted slot names.
7934:
7935: slots - Reference to hash of hash, where outer hash keys are slot names.
7936:
1.549 albertel 7937: =back
7938:
1.780 raeburn 7939: Returns:
7940:
7941: =over 4
7942:
7943: sorted - An array of slot names sorted by the start time of the slot.
7944:
7945: =back
7946:
7947: =back
7948:
7949: =cut
7950:
7951:
7952: sub sorted_slots {
7953: my ($slotsarr,$slots) = @_;
7954: my @sorted;
7955: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7956: @sorted =
7957: sort {
7958: if (ref($slots->{$a}) && ref($slots->{$b})) {
7959: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7960: }
7961: if (ref($slots->{$a})) { return -1;}
7962: if (ref($slots->{$b})) { return 1;}
7963: return 0;
7964: } @{$slotsarr};
7965: }
7966: return @sorted;
7967: }
7968:
7969:
7970: =pod
7971:
1.549 albertel 7972: =head1 HTTP Helpers
7973:
7974: =over 4
7975:
1.648 raeburn 7976: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7977:
1.258 albertel 7978: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7979: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7980: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7981:
7982: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7983: $possible_names is an ref to an array of form element names. As an example:
7984: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7985: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7986:
7987: =cut
1.1 albertel 7988:
1.6 albertel 7989: sub get_unprocessed_cgi {
1.25 albertel 7990: my ($query,$possible_names)= @_;
1.26 matthew 7991: # $Apache::lonxml::debug=1;
1.356 albertel 7992: foreach my $pair (split(/&/,$query)) {
7993: my ($name, $value) = split(/=/,$pair);
1.369 www 7994: $name = &unescape($name);
1.25 albertel 7995: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7996: $value =~ tr/+/ /;
7997: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7998: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7999: }
1.16 harris41 8000: }
1.6 albertel 8001: }
8002:
1.112 bowersj2 8003: =pod
8004:
1.648 raeburn 8005: =item * &cacheheader()
1.112 bowersj2 8006:
8007: returns cache-controlling header code
8008:
8009: =cut
8010:
1.7 albertel 8011: sub cacheheader {
1.258 albertel 8012: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 8013: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8014: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 8015: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8016: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 8017: return $output;
1.7 albertel 8018: }
8019:
1.112 bowersj2 8020: =pod
8021:
1.648 raeburn 8022: =item * &no_cache($r)
1.112 bowersj2 8023:
8024: specifies header code to not have cache
8025:
8026: =cut
8027:
1.9 albertel 8028: sub no_cache {
1.216 albertel 8029: my ($r) = @_;
8030: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 8031: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 8032: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8033: $r->no_cache(1);
8034: $r->header_out("Expires" => $date);
8035: $r->header_out("Pragma" => "no-cache");
1.123 www 8036: }
8037:
8038: sub content_type {
1.181 albertel 8039: my ($r,$type,$charset) = @_;
1.299 foxr 8040: if ($r) {
8041: # Note that printout.pl calls this with undef for $r.
8042: &no_cache($r);
8043: }
1.258 albertel 8044: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 8045: unless ($charset) {
8046: $charset=&Apache::lonlocal::current_encoding;
8047: }
8048: if ($charset) { $type.='; charset='.$charset; }
8049: if ($r) {
8050: $r->content_type($type);
8051: } else {
8052: print("Content-type: $type\n\n");
8053: }
1.9 albertel 8054: }
1.25 albertel 8055:
1.112 bowersj2 8056: =pod
8057:
1.648 raeburn 8058: =item * &add_to_env($name,$value)
1.112 bowersj2 8059:
1.258 albertel 8060: adds $name to the %env hash with value
1.112 bowersj2 8061: $value, if $name already exists, the entry is converted to an array
8062: reference and $value is added to the array.
8063:
8064: =cut
8065:
1.25 albertel 8066: sub add_to_env {
8067: my ($name,$value)=@_;
1.258 albertel 8068: if (defined($env{$name})) {
8069: if (ref($env{$name})) {
1.25 albertel 8070: #already have multiple values
1.258 albertel 8071: push(@{ $env{$name} },$value);
1.25 albertel 8072: } else {
8073: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 8074: my $first=$env{$name};
8075: undef($env{$name});
8076: push(@{ $env{$name} },$first,$value);
1.25 albertel 8077: }
8078: } else {
1.258 albertel 8079: $env{$name}=$value;
1.25 albertel 8080: }
1.31 albertel 8081: }
1.149 albertel 8082:
8083: =pod
8084:
1.648 raeburn 8085: =item * &get_env_multiple($name)
1.149 albertel 8086:
1.258 albertel 8087: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 8088: values may be defined and end up as an array ref.
8089:
8090: returns an array of values
8091:
8092: =cut
8093:
8094: sub get_env_multiple {
8095: my ($name) = @_;
8096: my @values;
1.258 albertel 8097: if (defined($env{$name})) {
1.149 albertel 8098: # exists is it an array
1.258 albertel 8099: if (ref($env{$name})) {
8100: @values=@{ $env{$name} };
1.149 albertel 8101: } else {
1.258 albertel 8102: $values[0]=$env{$name};
1.149 albertel 8103: }
8104: }
8105: return(@values);
8106: }
8107:
1.660 raeburn 8108: sub ask_for_embedded_content {
8109: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8110: my $upload_output = '
8111: <form name="upload_embedded" action="'.$actionurl.'"
8112: method="post" enctype="multipart/form-data">';
8113: $upload_output .= $state;
1.661 raeburn 8114: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 8115:
8116: my $num = 0;
8117: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8118: $upload_output .= &start_data_table_row().
8119: '<td>'.$embed_file.'</td><td>';
8120: if ($args->{'ignore_remote_references'}
8121: && $embed_file =~ m{^\w+://}) {
8122: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8123: } elsif ($args->{'error_on_invalid_names'}
8124: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8125:
8126: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8127:
8128: } else {
8129: $upload_output .='
1.661 raeburn 8130: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 8131: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8132: my $attrib = join(':',@{$$allfiles{$embed_file}});
8133: $upload_output .=
8134: "\n\t\t".
8135: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8136: $attrib.'" />';
8137: if (exists($$codebase{$embed_file})) {
8138: $upload_output .=
8139: "\n\t\t".
8140: '<input name="codebase_'.$num.'" type="hidden" value="'.
8141: &escape($$codebase{$embed_file}).'" />';
8142: }
8143: }
8144: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8145: $num++;
8146: }
8147: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8148: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8149: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8150: '.&mt('(only files for which a location has been provided will be uploaded)').'
8151: </form>';
8152: return $upload_output;
8153: }
8154:
1.661 raeburn 8155: sub upload_embedded {
8156: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8157: $current_disk_usage) = @_;
8158: my $output;
8159: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8160: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8161: my $orig_uploaded_filename =
8162: $env{'form.embedded_item_'.$i.'.filename'};
8163:
8164: $env{'form.embedded_orig_'.$i} =
8165: &unescape($env{'form.embedded_orig_'.$i});
8166: my ($path,$fname) =
8167: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8168: # no path, whole string is fname
8169: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8170:
8171: $path = $env{'form.currentpath'}.$path;
8172: $fname = &Apache::lonnet::clean_filename($fname);
8173: # See if there is anything left
8174: next if ($fname eq '');
8175:
8176: # Check if file already exists as a file or directory.
8177: my ($state,$msg);
8178: if ($context eq 'portfolio') {
8179: my $port_path = $dirpath;
8180: if ($group ne '') {
8181: $port_path = "groups/$group/$port_path";
8182: }
8183: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8184: $dir_root,$port_path,$disk_quota,
8185: $current_disk_usage,$uname,$udom);
8186: if ($state eq 'will_exceed_quota'
8187: || $state eq 'file_locked'
8188: || $state eq 'file_exists' ) {
8189: $output .= $msg;
8190: next;
8191: }
8192: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8193: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8194: if ($state eq 'exists') {
8195: $output .= $msg;
8196: next;
8197: }
8198: }
8199: # Check if extension is valid
8200: if (($fname =~ /\.(\w+)$/) &&
8201: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8202: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8203: next;
8204: } elsif (($fname =~ /\.(\w+)$/) &&
8205: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8206: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8207: next;
8208: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8209: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8210: next;
8211: }
8212:
8213: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8214: if ($context eq 'portfolio') {
8215: my $result=
8216: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8217: $dirpath.$path);
8218: if ($result !~ m|^/uploaded/|) {
8219: $output .= '<span class="LC_error">'
8220: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8221: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8222: .'</span><br />';
8223: next;
8224: } else {
8225: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8226: $path.$fname.'</span>').'</p>';
8227: }
8228: } else {
8229: # Save the file
8230: my $target = $env{'form.embedded_item_'.$i};
8231: my $fullpath = $dir_root.$dirpath.'/'.$path;
8232: my $dest = $fullpath.$fname;
8233: my $url = $url_root.$dirpath.'/'.$path.$fname;
8234: my @parts=split(/\//,$fullpath);
8235: my $count;
8236: my $filepath = $dir_root;
8237: for ($count=4;$count<=$#parts;$count++) {
8238: $filepath .= "/$parts[$count]";
8239: if ((-e $filepath)!=1) {
8240: mkdir($filepath,0770);
8241: }
8242: }
8243: my $fh;
8244: if (!open($fh,'>'.$dest)) {
8245: &Apache::lonnet::logthis('Failed to create '.$dest);
8246: $output .= '<span class="LC_error">'.
8247: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8248: '</span><br />';
8249: } else {
8250: if (!print $fh $env{'form.embedded_item_'.$i}) {
8251: &Apache::lonnet::logthis('Failed to write to '.$dest);
8252: $output .= '<span class="LC_error">'.
8253: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8254: '</span><br />';
8255: } else {
8256: if ($context eq 'testbank') {
8257: $output .= &mt('Embedded file uploaded successfully:').
8258: ' <a href="'.$url.'">'.
8259: $orig_uploaded_filename.'</a><br />';
8260: } else {
1.705 tempelho 8261: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 8262: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 8263: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 8264: }
8265: }
8266: close($fh);
8267: }
8268: }
8269: }
8270: return $output;
8271: }
8272:
8273: sub check_for_existing {
8274: my ($path,$fname,$element) = @_;
8275: my ($state,$msg);
8276: if (-d $path.'/'.$fname) {
8277: $state = 'exists';
8278: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8279: } elsif (-e $path.'/'.$fname) {
8280: $state = 'exists';
8281: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8282: }
8283: if ($state eq 'exists') {
8284: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8285: }
8286: return ($state,$msg);
8287: }
8288:
8289: sub check_for_upload {
8290: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8291: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8292: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8293: my $getpropath = 1;
8294: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8295: $getpropath);
8296: my $found_file = 0;
8297: my $locked_file = 0;
8298: foreach my $line (@dir_list) {
8299: my ($file_name)=split(/\&/,$line,2);
8300: if ($file_name eq $fname){
8301: $file_name = $path.$file_name;
8302: if ($group ne '') {
8303: $file_name = $group.$file_name;
8304: }
8305: $found_file = 1;
8306: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8307: $locked_file = 1;
8308: }
8309: }
8310: }
8311: if (($current_disk_usage + $filesize) > $disk_quota){
8312: my $msg = '<span class="LC_error">'.
8313: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8314: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8315: return ('will_exceed_quota',$msg);
8316: } elsif ($found_file) {
8317: if ($locked_file) {
8318: my $msg = '<span class="LC_error">';
8319: $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>');
8320: $msg .= '</span><br />';
8321: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8322: return ('file_locked',$msg);
8323: } else {
8324: my $msg = '<span class="LC_error">';
8325: $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'});
8326: $msg .= '</span>';
8327: $msg .= '<br />';
8328: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8329: return ('file_exists',$msg);
8330: }
8331: }
8332: }
8333:
1.31 albertel 8334:
1.41 ng 8335: =pod
1.45 matthew 8336:
1.464 albertel 8337: =back
1.41 ng 8338:
1.112 bowersj2 8339: =head1 CSV Upload/Handling functions
1.38 albertel 8340:
1.41 ng 8341: =over 4
8342:
1.648 raeburn 8343: =item * &upfile_store($r)
1.41 ng 8344:
8345: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8346: needs $env{'form.upfile'}
1.41 ng 8347: returns $datatoken to be put into hidden field
8348:
8349: =cut
1.31 albertel 8350:
8351: sub upfile_store {
8352: my $r=shift;
1.258 albertel 8353: $env{'form.upfile'}=~s/\r/\n/gs;
8354: $env{'form.upfile'}=~s/\f/\n/gs;
8355: $env{'form.upfile'}=~s/\n+/\n/gs;
8356: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8357:
1.258 albertel 8358: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8359: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8360: {
1.158 raeburn 8361: my $datafile = $r->dir_config('lonDaemons').
8362: '/tmp/'.$datatoken.'.tmp';
8363: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8364: print $fh $env{'form.upfile'};
1.158 raeburn 8365: close($fh);
8366: }
1.31 albertel 8367: }
8368: return $datatoken;
8369: }
8370:
1.56 matthew 8371: =pod
8372:
1.648 raeburn 8373: =item * &load_tmp_file($r)
1.41 ng 8374:
8375: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8376: needs $env{'form.datatoken'},
8377: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8378:
8379: =cut
1.31 albertel 8380:
8381: sub load_tmp_file {
8382: my $r=shift;
8383: my @studentdata=();
8384: {
1.158 raeburn 8385: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8386: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8387: if ( open(my $fh,"<$studentfile") ) {
8388: @studentdata=<$fh>;
8389: close($fh);
8390: }
1.31 albertel 8391: }
1.258 albertel 8392: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8393: }
8394:
1.56 matthew 8395: =pod
8396:
1.648 raeburn 8397: =item * &upfile_record_sep()
1.41 ng 8398:
8399: Separate uploaded file into records
8400: returns array of records,
1.258 albertel 8401: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8402:
8403: =cut
1.31 albertel 8404:
8405: sub upfile_record_sep {
1.258 albertel 8406: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8407: } else {
1.248 albertel 8408: my @records;
1.258 albertel 8409: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8410: if ($line=~/^\s*$/) { next; }
8411: push(@records,$line);
8412: }
8413: return @records;
1.31 albertel 8414: }
8415: }
8416:
1.56 matthew 8417: =pod
8418:
1.648 raeburn 8419: =item * &record_sep($record)
1.41 ng 8420:
1.258 albertel 8421: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8422:
8423: =cut
8424:
1.263 www 8425: sub takeleft {
8426: my $index=shift;
8427: return substr('0000'.$index,-4,4);
8428: }
8429:
1.31 albertel 8430: sub record_sep {
8431: my $record=shift;
8432: my %components=();
1.258 albertel 8433: if ($env{'form.upfiletype'} eq 'xml') {
8434: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8435: my $i=0;
1.356 albertel 8436: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8437: $field=~s/^(\"|\')//;
8438: $field=~s/(\"|\')$//;
1.263 www 8439: $components{&takeleft($i)}=$field;
1.31 albertel 8440: $i++;
8441: }
1.258 albertel 8442: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8443: my $i=0;
1.356 albertel 8444: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8445: $field=~s/^(\"|\')//;
8446: $field=~s/(\"|\')$//;
1.263 www 8447: $components{&takeleft($i)}=$field;
1.31 albertel 8448: $i++;
8449: }
8450: } else {
1.561 www 8451: my $separator=',';
1.480 banghart 8452: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8453: $separator=';';
1.480 banghart 8454: }
1.31 albertel 8455: my $i=0;
1.561 www 8456: # the character we are looking for to indicate the end of a quote or a record
8457: my $looking_for=$separator;
8458: # do not add the characters to the fields
8459: my $ignore=0;
8460: # we just encountered a separator (or the beginning of the record)
8461: my $just_found_separator=1;
8462: # store the field we are working on here
8463: my $field='';
8464: # work our way through all characters in record
8465: foreach my $character ($record=~/(.)/g) {
8466: if ($character eq $looking_for) {
8467: if ($character ne $separator) {
8468: # Found the end of a quote, again looking for separator
8469: $looking_for=$separator;
8470: $ignore=1;
8471: } else {
8472: # Found a separator, store away what we got
8473: $components{&takeleft($i)}=$field;
8474: $i++;
8475: $just_found_separator=1;
8476: $ignore=0;
8477: $field='';
8478: }
8479: next;
8480: }
8481: # single or double quotation marks after a separator indicate beginning of a quote
8482: # we are now looking for the end of the quote and need to ignore separators
8483: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8484: $looking_for=$character;
8485: next;
8486: }
8487: # ignore would be true after we reached the end of a quote
8488: if ($ignore) { next; }
8489: if (($just_found_separator) && ($character=~/\s/)) { next; }
8490: $field.=$character;
8491: $just_found_separator=0;
1.31 albertel 8492: }
1.561 www 8493: # catch the very last entry, since we never encountered the separator
8494: $components{&takeleft($i)}=$field;
1.31 albertel 8495: }
8496: return %components;
8497: }
8498:
1.144 matthew 8499: ######################################################
8500: ######################################################
8501:
1.56 matthew 8502: =pod
8503:
1.648 raeburn 8504: =item * &upfile_select_html()
1.41 ng 8505:
1.144 matthew 8506: Return HTML code to select a file from the users machine and specify
8507: the file type.
1.41 ng 8508:
8509: =cut
8510:
1.144 matthew 8511: ######################################################
8512: ######################################################
1.31 albertel 8513: sub upfile_select_html {
1.144 matthew 8514: my %Types = (
8515: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8516: semisv => &mt('Semicolon separated values'),
1.144 matthew 8517: space => &mt('Space separated'),
8518: tab => &mt('Tabulator separated'),
8519: # xml => &mt('HTML/XML'),
8520: );
8521: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8522: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8523: foreach my $type (sort(keys(%Types))) {
8524: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8525: }
8526: $Str .= "</select>\n";
8527: return $Str;
1.31 albertel 8528: }
8529:
1.301 albertel 8530: sub get_samples {
8531: my ($records,$toget) = @_;
8532: my @samples=({});
8533: my $got=0;
8534: foreach my $rec (@$records) {
8535: my %temp = &record_sep($rec);
8536: if (! grep(/\S/, values(%temp))) { next; }
8537: if (%temp) {
8538: $samples[$got]=\%temp;
8539: $got++;
8540: if ($got == $toget) { last; }
8541: }
8542: }
8543: return \@samples;
8544: }
8545:
1.144 matthew 8546: ######################################################
8547: ######################################################
8548:
1.56 matthew 8549: =pod
8550:
1.648 raeburn 8551: =item * &csv_print_samples($r,$records)
1.41 ng 8552:
8553: Prints a table of sample values from each column uploaded $r is an
8554: Apache Request ref, $records is an arrayref from
8555: &Apache::loncommon::upfile_record_sep
8556:
8557: =cut
8558:
1.144 matthew 8559: ######################################################
8560: ######################################################
1.31 albertel 8561: sub csv_print_samples {
8562: my ($r,$records) = @_;
1.662 bisitz 8563: my $samples = &get_samples($records,5);
1.301 albertel 8564:
1.594 raeburn 8565: $r->print(&mt('Samples').'<br />'.&start_data_table().
8566: &start_data_table_header_row());
1.356 albertel 8567: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8568: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8569: $r->print(&end_data_table_header_row());
1.301 albertel 8570: foreach my $hash (@$samples) {
1.594 raeburn 8571: $r->print(&start_data_table_row());
1.356 albertel 8572: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8573: $r->print('<td>');
1.356 albertel 8574: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8575: $r->print('</td>');
8576: }
1.594 raeburn 8577: $r->print(&end_data_table_row());
1.31 albertel 8578: }
1.594 raeburn 8579: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8580: }
8581:
1.144 matthew 8582: ######################################################
8583: ######################################################
8584:
1.56 matthew 8585: =pod
8586:
1.648 raeburn 8587: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8588:
8589: Prints a table to create associations between values and table columns.
1.144 matthew 8590:
1.41 ng 8591: $r is an Apache Request ref,
8592: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8593: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8594:
8595: =cut
8596:
1.144 matthew 8597: ######################################################
8598: ######################################################
1.31 albertel 8599: sub csv_print_select_table {
8600: my ($r,$records,$d) = @_;
1.301 albertel 8601: my $i=0;
8602: my $samples = &get_samples($records,1);
1.144 matthew 8603: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8604: &start_data_table().&start_data_table_header_row().
1.144 matthew 8605: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8606: '<th>'.&mt('Column').'</th>'.
8607: &end_data_table_header_row()."\n");
1.356 albertel 8608: foreach my $array_ref (@$d) {
8609: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8610: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8611:
8612: $r->print('<td><select name=f'.$i.
1.32 matthew 8613: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8614: $r->print('<option value="none"></option>');
1.356 albertel 8615: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8616: $r->print('<option value="'.$sample.'"'.
8617: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8618: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8619: }
1.594 raeburn 8620: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8621: $i++;
8622: }
1.594 raeburn 8623: $r->print(&end_data_table());
1.31 albertel 8624: $i--;
8625: return $i;
8626: }
1.56 matthew 8627:
1.144 matthew 8628: ######################################################
8629: ######################################################
8630:
1.56 matthew 8631: =pod
1.31 albertel 8632:
1.648 raeburn 8633: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8634:
8635: Prints a table of sample values from the upload and can make associate samples to internal names.
8636:
8637: $r is an Apache Request ref,
8638: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8639: $d is an array of 2 element arrays (internal name, displayed name)
8640:
8641: =cut
8642:
1.144 matthew 8643: ######################################################
8644: ######################################################
1.31 albertel 8645: sub csv_samples_select_table {
8646: my ($r,$records,$d) = @_;
8647: my $i=0;
1.144 matthew 8648: #
1.662 bisitz 8649: my $max_samples = 5;
8650: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8651: $r->print(&start_data_table().
8652: &start_data_table_header_row().'<th>'.
8653: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8654: &end_data_table_header_row());
1.301 albertel 8655:
8656: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8657: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8658: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8659: foreach my $option (@$d) {
8660: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8661: $r->print('<option value="'.$value.'"'.
1.253 albertel 8662: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8663: $display.'</option>');
1.31 albertel 8664: }
8665: $r->print('</select></td><td>');
1.662 bisitz 8666: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8667: if (defined($samples->[$line]{$key})) {
8668: $r->print($samples->[$line]{$key}."<br />\n");
8669: }
8670: }
1.594 raeburn 8671: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8672: $i++;
8673: }
1.594 raeburn 8674: $r->print(&end_data_table());
1.31 albertel 8675: $i--;
8676: return($i);
1.115 matthew 8677: }
8678:
1.144 matthew 8679: ######################################################
8680: ######################################################
8681:
1.115 matthew 8682: =pod
8683:
1.648 raeburn 8684: =item * &clean_excel_name($name)
1.115 matthew 8685:
8686: Returns a replacement for $name which does not contain any illegal characters.
8687:
8688: =cut
8689:
1.144 matthew 8690: ######################################################
8691: ######################################################
1.115 matthew 8692: sub clean_excel_name {
8693: my ($name) = @_;
8694: $name =~ s/[:\*\?\/\\]//g;
8695: if (length($name) > 31) {
8696: $name = substr($name,0,31);
8697: }
8698: return $name;
1.25 albertel 8699: }
1.84 albertel 8700:
1.85 albertel 8701: =pod
8702:
1.648 raeburn 8703: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8704:
8705: Returns either 1 or undef
8706:
8707: 1 if the part is to be hidden, undef if it is to be shown
8708:
8709: Arguments are:
8710:
8711: $id the id of the part to be checked
8712: $symb, optional the symb of the resource to check
8713: $udom, optional the domain of the user to check for
8714: $uname, optional the username of the user to check for
8715:
8716: =cut
1.84 albertel 8717:
8718: sub check_if_partid_hidden {
8719: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8720: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8721: $symb,$udom,$uname);
1.141 albertel 8722: my $truth=1;
8723: #if the string starts with !, then the list is the list to show not hide
8724: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8725: my @hiddenlist=split(/,/,$hiddenparts);
8726: foreach my $checkid (@hiddenlist) {
1.141 albertel 8727: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8728: }
1.141 albertel 8729: return !$truth;
1.84 albertel 8730: }
1.127 matthew 8731:
1.138 matthew 8732:
8733: ############################################################
8734: ############################################################
8735:
8736: =pod
8737:
1.157 matthew 8738: =back
8739:
1.138 matthew 8740: =head1 cgi-bin script and graphing routines
8741:
1.157 matthew 8742: =over 4
8743:
1.648 raeburn 8744: =item * &get_cgi_id()
1.138 matthew 8745:
8746: Inputs: none
8747:
8748: Returns an id which can be used to pass environment variables
8749: to various cgi-bin scripts. These environment variables will
8750: be removed from the users environment after a given time by
8751: the routine &Apache::lonnet::transfer_profile_to_env.
8752:
8753: =cut
8754:
8755: ############################################################
8756: ############################################################
1.152 albertel 8757: my $uniq=0;
1.136 matthew 8758: sub get_cgi_id {
1.154 albertel 8759: $uniq=($uniq+1)%100000;
1.280 albertel 8760: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8761: }
8762:
1.127 matthew 8763: ############################################################
8764: ############################################################
8765:
8766: =pod
8767:
1.648 raeburn 8768: =item * &DrawBarGraph()
1.127 matthew 8769:
1.138 matthew 8770: Facilitates the plotting of data in a (stacked) bar graph.
8771: Puts plot definition data into the users environment in order for
8772: graph.png to plot it. Returns an <img> tag for the plot.
8773: The bars on the plot are labeled '1','2',...,'n'.
8774:
8775: Inputs:
8776:
8777: =over 4
8778:
8779: =item $Title: string, the title of the plot
8780:
8781: =item $xlabel: string, text describing the X-axis of the plot
8782:
8783: =item $ylabel: string, text describing the Y-axis of the plot
8784:
8785: =item $Max: scalar, the maximum Y value to use in the plot
8786: If $Max is < any data point, the graph will not be rendered.
8787:
1.140 matthew 8788: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8789: they are plotted. If undefined, default values will be used.
8790:
1.178 matthew 8791: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8792:
1.138 matthew 8793: =item @Values: An array of array references. Each array reference holds data
8794: to be plotted in a stacked bar chart.
8795:
1.239 matthew 8796: =item If the final element of @Values is a hash reference the key/value
8797: pairs will be added to the graph definition.
8798:
1.138 matthew 8799: =back
8800:
8801: Returns:
8802:
8803: An <img> tag which references graph.png and the appropriate identifying
8804: information for the plot.
8805:
1.127 matthew 8806: =cut
8807:
8808: ############################################################
8809: ############################################################
1.134 matthew 8810: sub DrawBarGraph {
1.178 matthew 8811: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8812: #
8813: if (! defined($colors)) {
8814: $colors = ['#33ff00',
8815: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8816: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8817: ];
8818: }
1.228 matthew 8819: my $extra_settings = {};
8820: if (ref($Values[-1]) eq 'HASH') {
8821: $extra_settings = pop(@Values);
8822: }
1.127 matthew 8823: #
1.136 matthew 8824: my $identifier = &get_cgi_id();
8825: my $id = 'cgi.'.$identifier;
1.129 matthew 8826: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8827: return '';
8828: }
1.225 matthew 8829: #
8830: my @Labels;
8831: if (defined($labels)) {
8832: @Labels = @$labels;
8833: } else {
8834: for (my $i=0;$i<@{$Values[0]};$i++) {
8835: push (@Labels,$i+1);
8836: }
8837: }
8838: #
1.129 matthew 8839: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8840: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8841: my %ValuesHash;
8842: my $NumSets=1;
8843: foreach my $array (@Values) {
8844: next if (! ref($array));
1.136 matthew 8845: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8846: join(',',@$array);
1.129 matthew 8847: }
1.127 matthew 8848: #
1.136 matthew 8849: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8850: if ($NumBars < 3) {
8851: $width = 120+$NumBars*32;
1.220 matthew 8852: $xskip = 1;
1.225 matthew 8853: $bar_width = 30;
8854: } elsif ($NumBars < 5) {
8855: $width = 120+$NumBars*20;
8856: $xskip = 1;
8857: $bar_width = 20;
1.220 matthew 8858: } elsif ($NumBars < 10) {
1.136 matthew 8859: $width = 120+$NumBars*15;
8860: $xskip = 1;
8861: $bar_width = 15;
8862: } elsif ($NumBars <= 25) {
8863: $width = 120+$NumBars*11;
8864: $xskip = 5;
8865: $bar_width = 8;
8866: } elsif ($NumBars <= 50) {
8867: $width = 120+$NumBars*8;
8868: $xskip = 5;
8869: $bar_width = 4;
8870: } else {
8871: $width = 120+$NumBars*8;
8872: $xskip = 5;
8873: $bar_width = 4;
8874: }
8875: #
1.137 matthew 8876: $Max = 1 if ($Max < 1);
8877: if ( int($Max) < $Max ) {
8878: $Max++;
8879: $Max = int($Max);
8880: }
1.127 matthew 8881: $Title = '' if (! defined($Title));
8882: $xlabel = '' if (! defined($xlabel));
8883: $ylabel = '' if (! defined($ylabel));
1.369 www 8884: $ValuesHash{$id.'.title'} = &escape($Title);
8885: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8886: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8887: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8888: $ValuesHash{$id.'.NumBars'} = $NumBars;
8889: $ValuesHash{$id.'.NumSets'} = $NumSets;
8890: $ValuesHash{$id.'.PlotType'} = 'bar';
8891: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8892: $ValuesHash{$id.'.height'} = $height;
8893: $ValuesHash{$id.'.width'} = $width;
8894: $ValuesHash{$id.'.xskip'} = $xskip;
8895: $ValuesHash{$id.'.bar_width'} = $bar_width;
8896: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8897: #
1.228 matthew 8898: # Deal with other parameters
8899: while (my ($key,$value) = each(%$extra_settings)) {
8900: $ValuesHash{$id.'.'.$key} = $value;
8901: }
8902: #
1.646 raeburn 8903: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8904: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8905: }
8906:
8907: ############################################################
8908: ############################################################
8909:
8910: =pod
8911:
1.648 raeburn 8912: =item * &DrawXYGraph()
1.137 matthew 8913:
1.138 matthew 8914: Facilitates the plotting of data in an XY graph.
8915: Puts plot definition data into the users environment in order for
8916: graph.png to plot it. Returns an <img> tag for the plot.
8917:
8918: Inputs:
8919:
8920: =over 4
8921:
8922: =item $Title: string, the title of the plot
8923:
8924: =item $xlabel: string, text describing the X-axis of the plot
8925:
8926: =item $ylabel: string, text describing the Y-axis of the plot
8927:
8928: =item $Max: scalar, the maximum Y value to use in the plot
8929: If $Max is < any data point, the graph will not be rendered.
8930:
8931: =item $colors: Array ref containing the hex color codes for the data to be
8932: plotted in. If undefined, default values will be used.
8933:
8934: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8935:
8936: =item $Ydata: Array ref containing Array refs.
1.185 www 8937: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8938:
8939: =item %Values: hash indicating or overriding any default values which are
8940: passed to graph.png.
8941: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8942:
8943: =back
8944:
8945: Returns:
8946:
8947: An <img> tag which references graph.png and the appropriate identifying
8948: information for the plot.
8949:
1.137 matthew 8950: =cut
8951:
8952: ############################################################
8953: ############################################################
8954: sub DrawXYGraph {
8955: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8956: #
8957: # Create the identifier for the graph
8958: my $identifier = &get_cgi_id();
8959: my $id = 'cgi.'.$identifier;
8960: #
8961: $Title = '' if (! defined($Title));
8962: $xlabel = '' if (! defined($xlabel));
8963: $ylabel = '' if (! defined($ylabel));
8964: my %ValuesHash =
8965: (
1.369 www 8966: $id.'.title' => &escape($Title),
8967: $id.'.xlabel' => &escape($xlabel),
8968: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8969: $id.'.y_max_value'=> $Max,
8970: $id.'.labels' => join(',',@$Xlabels),
8971: $id.'.PlotType' => 'XY',
8972: );
8973: #
8974: if (defined($colors) && ref($colors) eq 'ARRAY') {
8975: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8976: }
8977: #
8978: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8979: return '';
8980: }
8981: my $NumSets=1;
1.138 matthew 8982: foreach my $array (@{$Ydata}){
1.137 matthew 8983: next if (! ref($array));
8984: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8985: }
1.138 matthew 8986: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8987: #
8988: # Deal with other parameters
8989: while (my ($key,$value) = each(%Values)) {
8990: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8991: }
8992: #
1.646 raeburn 8993: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8994: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8995: }
8996:
8997: ############################################################
8998: ############################################################
8999:
9000: =pod
9001:
1.648 raeburn 9002: =item * &DrawXYYGraph()
1.138 matthew 9003:
9004: Facilitates the plotting of data in an XY graph with two Y axes.
9005: Puts plot definition data into the users environment in order for
9006: graph.png to plot it. Returns an <img> tag for the plot.
9007:
9008: Inputs:
9009:
9010: =over 4
9011:
9012: =item $Title: string, the title of the plot
9013:
9014: =item $xlabel: string, text describing the X-axis of the plot
9015:
9016: =item $ylabel: string, text describing the Y-axis of the plot
9017:
9018: =item $colors: Array ref containing the hex color codes for the data to be
9019: plotted in. If undefined, default values will be used.
9020:
9021: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9022:
9023: =item $Ydata1: The first data set
9024:
9025: =item $Min1: The minimum value of the left Y-axis
9026:
9027: =item $Max1: The maximum value of the left Y-axis
9028:
9029: =item $Ydata2: The second data set
9030:
9031: =item $Min2: The minimum value of the right Y-axis
9032:
9033: =item $Max2: The maximum value of the left Y-axis
9034:
9035: =item %Values: hash indicating or overriding any default values which are
9036: passed to graph.png.
9037: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9038:
9039: =back
9040:
9041: Returns:
9042:
9043: An <img> tag which references graph.png and the appropriate identifying
9044: information for the plot.
1.136 matthew 9045:
9046: =cut
9047:
9048: ############################################################
9049: ############################################################
1.137 matthew 9050: sub DrawXYYGraph {
9051: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9052: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 9053: #
9054: # Create the identifier for the graph
9055: my $identifier = &get_cgi_id();
9056: my $id = 'cgi.'.$identifier;
9057: #
9058: $Title = '' if (! defined($Title));
9059: $xlabel = '' if (! defined($xlabel));
9060: $ylabel = '' if (! defined($ylabel));
9061: my %ValuesHash =
9062: (
1.369 www 9063: $id.'.title' => &escape($Title),
9064: $id.'.xlabel' => &escape($xlabel),
9065: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 9066: $id.'.labels' => join(',',@$Xlabels),
9067: $id.'.PlotType' => 'XY',
9068: $id.'.NumSets' => 2,
1.137 matthew 9069: $id.'.two_axes' => 1,
9070: $id.'.y1_max_value' => $Max1,
9071: $id.'.y1_min_value' => $Min1,
9072: $id.'.y2_max_value' => $Max2,
9073: $id.'.y2_min_value' => $Min2,
1.136 matthew 9074: );
9075: #
1.137 matthew 9076: if (defined($colors) && ref($colors) eq 'ARRAY') {
9077: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9078: }
9079: #
9080: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9081: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 9082: return '';
9083: }
9084: my $NumSets=1;
1.137 matthew 9085: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 9086: next if (! ref($array));
9087: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 9088: }
9089: #
9090: # Deal with other parameters
9091: while (my ($key,$value) = each(%Values)) {
9092: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 9093: }
9094: #
1.646 raeburn 9095: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 9096: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 9097: }
9098:
9099: ############################################################
9100: ############################################################
9101:
9102: =pod
9103:
1.157 matthew 9104: =back
9105:
1.139 matthew 9106: =head1 Statistics helper routines?
9107:
9108: Bad place for them but what the hell.
9109:
1.157 matthew 9110: =over 4
9111:
1.648 raeburn 9112: =item * &chartlink()
1.139 matthew 9113:
9114: Returns a link to the chart for a specific student.
9115:
9116: Inputs:
9117:
9118: =over 4
9119:
9120: =item $linktext: The text of the link
9121:
9122: =item $sname: The students username
9123:
9124: =item $sdomain: The students domain
9125:
9126: =back
9127:
1.157 matthew 9128: =back
9129:
1.139 matthew 9130: =cut
9131:
9132: ############################################################
9133: ############################################################
9134: sub chartlink {
9135: my ($linktext, $sname, $sdomain) = @_;
9136: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 9137: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 9138: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 9139: '">'.$linktext.'</a>';
1.153 matthew 9140: }
9141:
9142: #######################################################
9143: #######################################################
9144:
9145: =pod
9146:
9147: =head1 Course Environment Routines
1.157 matthew 9148:
9149: =over 4
1.153 matthew 9150:
1.648 raeburn 9151: =item * &restore_course_settings()
1.153 matthew 9152:
1.648 raeburn 9153: =item * &store_course_settings()
1.153 matthew 9154:
9155: Restores/Store indicated form parameters from the course environment.
9156: Will not overwrite existing values of the form parameters.
9157:
9158: Inputs:
9159: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9160:
9161: a hash ref describing the data to be stored. For example:
9162:
9163: %Save_Parameters = ('Status' => 'scalar',
9164: 'chartoutputmode' => 'scalar',
9165: 'chartoutputdata' => 'scalar',
9166: 'Section' => 'array',
1.373 raeburn 9167: 'Group' => 'array',
1.153 matthew 9168: 'StudentData' => 'array',
9169: 'Maps' => 'array');
9170:
9171: Returns: both routines return nothing
9172:
1.631 raeburn 9173: =back
9174:
1.153 matthew 9175: =cut
9176:
9177: #######################################################
9178: #######################################################
9179: sub store_course_settings {
1.496 albertel 9180: return &store_settings($env{'request.course.id'},@_);
9181: }
9182:
9183: sub store_settings {
1.153 matthew 9184: # save to the environment
9185: # appenv the same items, just to be safe
1.300 albertel 9186: my $udom = $env{'user.domain'};
9187: my $uname = $env{'user.name'};
1.496 albertel 9188: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9189: my %SaveHash;
9190: my %AppHash;
9191: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 9192: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 9193: my $envname = 'environment.'.$basename;
1.258 albertel 9194: if (exists($env{'form.'.$setting})) {
1.153 matthew 9195: # Save this value away
9196: if ($type eq 'scalar' &&
1.258 albertel 9197: (! exists($env{$envname}) ||
9198: $env{$envname} ne $env{'form.'.$setting})) {
9199: $SaveHash{$basename} = $env{'form.'.$setting};
9200: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 9201: } elsif ($type eq 'array') {
9202: my $stored_form;
1.258 albertel 9203: if (ref($env{'form.'.$setting})) {
1.153 matthew 9204: $stored_form = join(',',
9205: map {
1.369 www 9206: &escape($_);
1.258 albertel 9207: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 9208: } else {
9209: $stored_form =
1.369 www 9210: &escape($env{'form.'.$setting});
1.153 matthew 9211: }
9212: # Determine if the array contents are the same.
1.258 albertel 9213: if ($stored_form ne $env{$envname}) {
1.153 matthew 9214: $SaveHash{$basename} = $stored_form;
9215: $AppHash{$envname} = $stored_form;
9216: }
9217: }
9218: }
9219: }
9220: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 9221: $udom,$uname);
1.153 matthew 9222: if ($put_result !~ /^(ok|delayed)/) {
9223: &Apache::lonnet::logthis('unable to save form parameters, '.
9224: 'got error:'.$put_result);
9225: }
9226: # Make sure these settings stick around in this session, too
1.646 raeburn 9227: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 9228: return;
9229: }
9230:
9231: sub restore_course_settings {
1.499 albertel 9232: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 9233: }
9234:
9235: sub restore_settings {
9236: my ($context,$prefix,$Settings) = @_;
1.153 matthew 9237: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 9238: next if (exists($env{'form.'.$setting}));
1.496 albertel 9239: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 9240: '.'.$setting;
1.258 albertel 9241: if (exists($env{$envname})) {
1.153 matthew 9242: if ($type eq 'scalar') {
1.258 albertel 9243: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 9244: } elsif ($type eq 'array') {
1.258 albertel 9245: $env{'form.'.$setting} = [
1.153 matthew 9246: map {
1.369 www 9247: &unescape($_);
1.258 albertel 9248: } split(',',$env{$envname})
1.153 matthew 9249: ];
9250: }
9251: }
9252: }
1.127 matthew 9253: }
9254:
1.618 raeburn 9255: #######################################################
9256: #######################################################
9257:
9258: =pod
9259:
9260: =head1 Domain E-mail Routines
9261:
9262: =over 4
9263:
1.648 raeburn 9264: =item * &build_recipient_list()
1.618 raeburn 9265:
1.766 raeburn 9266: Build recipient lists for four types of e-mail:
9267: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
9268: (d) Help requests, generated by
9269: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 9270:
9271: Inputs:
1.619 raeburn 9272: defmail (scalar - email address of default recipient),
1.618 raeburn 9273: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 9274: defdom (domain for which to retrieve configuration settings),
9275: origmail (scalar - email address of recipient from loncapa.conf,
9276: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 9277:
1.655 raeburn 9278: Returns: comma separated list of addresses to which to send e-mail.
9279:
9280: =back
1.618 raeburn 9281:
9282: =cut
9283:
9284: ############################################################
9285: ############################################################
9286: sub build_recipient_list {
1.619 raeburn 9287: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 9288: my @recipients;
9289: my $otheremails;
9290: my %domconfig =
9291: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9292: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 9293: if (exists($domconfig{'contacts'}{$mailing})) {
9294: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9295: my @contacts = ('adminemail','supportemail');
9296: foreach my $item (@contacts) {
9297: if ($domconfig{'contacts'}{$mailing}{$item}) {
9298: my $addr = $domconfig{'contacts'}{$item};
9299: if (!grep(/^\Q$addr\E$/,@recipients)) {
9300: push(@recipients,$addr);
9301: }
1.619 raeburn 9302: }
1.766 raeburn 9303: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 9304: }
9305: }
1.766 raeburn 9306: } elsif ($origmail ne '') {
9307: push(@recipients,$origmail);
1.618 raeburn 9308: }
1.619 raeburn 9309: } elsif ($origmail ne '') {
9310: push(@recipients,$origmail);
1.618 raeburn 9311: }
1.688 raeburn 9312: if (defined($defmail)) {
9313: if ($defmail ne '') {
9314: push(@recipients,$defmail);
9315: }
1.618 raeburn 9316: }
9317: if ($otheremails) {
1.619 raeburn 9318: my @others;
9319: if ($otheremails =~ /,/) {
9320: @others = split(/,/,$otheremails);
1.618 raeburn 9321: } else {
1.619 raeburn 9322: push(@others,$otheremails);
9323: }
9324: foreach my $addr (@others) {
9325: if (!grep(/^\Q$addr\E$/,@recipients)) {
9326: push(@recipients,$addr);
9327: }
1.618 raeburn 9328: }
9329: }
1.619 raeburn 9330: my $recipientlist = join(',',@recipients);
1.618 raeburn 9331: return $recipientlist;
9332: }
9333:
1.127 matthew 9334: ############################################################
9335: ############################################################
1.154 albertel 9336:
1.655 raeburn 9337: =pod
9338:
9339: =head1 Course Catalog Routines
9340:
9341: =over 4
9342:
9343: =item * &gather_categories()
9344:
9345: Converts category definitions - keys of categories hash stored in
9346: coursecategories in configuration.db on the primary library server in a
9347: domain - to an array. Also generates javascript and idx hash used to
9348: generate Domain Coordinator interface for editing Course Categories.
9349:
9350: Inputs:
1.663 raeburn 9351:
1.655 raeburn 9352: categories (reference to hash of category definitions).
1.663 raeburn 9353:
1.655 raeburn 9354: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9355: categories and subcategories).
1.663 raeburn 9356:
1.655 raeburn 9357: idx (reference to hash of counters used in Domain Coordinator interface for
9358: editing Course Categories).
1.663 raeburn 9359:
1.655 raeburn 9360: jsarray (reference to array of categories used to create Javascript arrays for
9361: Domain Coordinator interface for editing Course Categories).
9362:
9363: Returns: nothing
9364:
9365: Side effects: populates cats, idx and jsarray.
9366:
9367: =cut
9368:
9369: sub gather_categories {
9370: my ($categories,$cats,$idx,$jsarray) = @_;
9371: my %counters;
9372: my $num = 0;
9373: foreach my $item (keys(%{$categories})) {
9374: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9375: if ($container eq '' && $depth == 0) {
9376: $cats->[$depth][$categories->{$item}] = $cat;
9377: } else {
9378: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9379: }
9380: my ($escitem,$tail) = split(/:/,$item,2);
9381: if ($counters{$tail} eq '') {
9382: $counters{$tail} = $num;
9383: $num ++;
9384: }
9385: if (ref($idx) eq 'HASH') {
9386: $idx->{$item} = $counters{$tail};
9387: }
9388: if (ref($jsarray) eq 'ARRAY') {
9389: push(@{$jsarray->[$counters{$tail}]},$item);
9390: }
9391: }
9392: return;
9393: }
9394:
9395: =pod
9396:
9397: =item * &extract_categories()
9398:
9399: Used to generate breadcrumb trails for course categories.
9400:
9401: Inputs:
1.663 raeburn 9402:
1.655 raeburn 9403: categories (reference to hash of category definitions).
1.663 raeburn 9404:
1.655 raeburn 9405: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9406: categories and subcategories).
1.663 raeburn 9407:
1.655 raeburn 9408: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9409:
1.655 raeburn 9410: allitems (reference to hash - key is category key
9411: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9412:
1.655 raeburn 9413: idx (reference to hash of counters used in Domain Coordinator interface for
9414: editing Course Categories).
1.663 raeburn 9415:
1.655 raeburn 9416: jsarray (reference to array of categories used to create Javascript arrays for
9417: Domain Coordinator interface for editing Course Categories).
9418:
1.665 raeburn 9419: subcats (reference to hash of arrays containing all subcategories within each
9420: category, -recursive)
9421:
1.655 raeburn 9422: Returns: nothing
9423:
9424: Side effects: populates trails and allitems hash references.
9425:
9426: =cut
9427:
9428: sub extract_categories {
1.665 raeburn 9429: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9430: if (ref($categories) eq 'HASH') {
9431: &gather_categories($categories,$cats,$idx,$jsarray);
9432: if (ref($cats->[0]) eq 'ARRAY') {
9433: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9434: my $name = $cats->[0][$i];
9435: my $item = &escape($name).'::0';
9436: my $trailstr;
9437: if ($name eq 'instcode') {
9438: $trailstr = &mt('Official courses (with institutional codes)');
9439: } else {
9440: $trailstr = $name;
9441: }
9442: if ($allitems->{$item} eq '') {
9443: push(@{$trails},$trailstr);
9444: $allitems->{$item} = scalar(@{$trails})-1;
9445: }
9446: my @parents = ($name);
9447: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9448: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9449: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9450: if (ref($subcats) eq 'HASH') {
9451: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9452: }
9453: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9454: }
9455: } else {
9456: if (ref($subcats) eq 'HASH') {
9457: $subcats->{$item} = [];
1.655 raeburn 9458: }
9459: }
9460: }
9461: }
9462: }
9463: return;
9464: }
9465:
9466: =pod
9467:
9468: =item *&recurse_categories()
9469:
9470: Recursively used to generate breadcrumb trails for course categories.
9471:
9472: Inputs:
1.663 raeburn 9473:
1.655 raeburn 9474: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9475: categories and subcategories).
1.663 raeburn 9476:
1.655 raeburn 9477: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9478:
9479: category (current course category, for which breadcrumb trail is being generated).
9480:
9481: trails (reference to array of breadcrumb trails for each category).
9482:
1.655 raeburn 9483: allitems (reference to hash - key is category key
9484: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9485:
1.655 raeburn 9486: parents (array containing containers directories for current category,
9487: back to top level).
9488:
9489: Returns: nothing
9490:
9491: Side effects: populates trails and allitems hash references
9492:
9493: =cut
9494:
9495: sub recurse_categories {
1.665 raeburn 9496: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9497: my $shallower = $depth - 1;
9498: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9499: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9500: my $name = $cats->[$depth]{$category}[$k];
9501: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9502: my $trailstr = join(' -> ',(@{$parents},$category));
9503: if ($allitems->{$item} eq '') {
9504: push(@{$trails},$trailstr);
9505: $allitems->{$item} = scalar(@{$trails})-1;
9506: }
9507: my $deeper = $depth+1;
9508: push(@{$parents},$category);
1.665 raeburn 9509: if (ref($subcats) eq 'HASH') {
9510: my $subcat = &escape($name).':'.$category.':'.$depth;
9511: for (my $j=@{$parents}; $j>=0; $j--) {
9512: my $higher;
9513: if ($j > 0) {
9514: $higher = &escape($parents->[$j]).':'.
9515: &escape($parents->[$j-1]).':'.$j;
9516: } else {
9517: $higher = &escape($parents->[$j]).'::'.$j;
9518: }
9519: push(@{$subcats->{$higher}},$subcat);
9520: }
9521: }
9522: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9523: $subcats);
1.655 raeburn 9524: pop(@{$parents});
9525: }
9526: } else {
9527: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9528: my $trailstr = join(' -> ',(@{$parents},$category));
9529: if ($allitems->{$item} eq '') {
9530: push(@{$trails},$trailstr);
9531: $allitems->{$item} = scalar(@{$trails})-1;
9532: }
9533: }
9534: return;
9535: }
9536:
1.663 raeburn 9537: =pod
9538:
9539: =item *&assign_categories_table()
9540:
9541: Create a datatable for display of hierarchical categories in a domain,
9542: with checkboxes to allow a course to be categorized.
9543:
9544: Inputs:
9545:
9546: cathash - reference to hash of categories defined for the domain (from
9547: configuration.db)
9548:
9549: currcat - scalar with an & separated list of categories assigned to a course.
9550:
9551: Returns: $output (markup to be displayed)
9552:
9553: =cut
9554:
9555: sub assign_categories_table {
9556: my ($cathash,$currcat) = @_;
9557: my $output;
9558: if (ref($cathash) eq 'HASH') {
9559: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9560: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9561: $maxdepth = scalar(@cats);
9562: if (@cats > 0) {
9563: my $itemcount = 0;
9564: if (ref($cats[0]) eq 'ARRAY') {
9565: $output = &Apache::loncommon::start_data_table();
9566: my @currcategories;
9567: if ($currcat ne '') {
9568: @currcategories = split('&',$currcat);
9569: }
9570: for (my $i=0; $i<@{$cats[0]}; $i++) {
9571: my $parent = $cats[0][$i];
9572: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9573: next if ($parent eq 'instcode');
9574: my $item = &escape($parent).'::0';
9575: my $checked = '';
9576: if (@currcategories > 0) {
9577: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9578: $checked = ' checked="checked"';
1.663 raeburn 9579: }
9580: }
1.675 raeburn 9581: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9582: '<input type="checkbox" name="usecategory" value="'.
9583: $item.'"'.$checked.' />'.$parent.'</span>'.
9584: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9585: my $depth = 1;
9586: push(@path,$parent);
9587: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9588: pop(@path);
9589: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9590: $itemcount ++;
9591: }
9592: $output .= &Apache::loncommon::end_data_table();
9593: }
9594: }
9595: }
9596: return $output;
9597: }
9598:
9599: =pod
9600:
9601: =item *&assign_category_rows()
9602:
9603: Create a datatable row for display of nested categories in a domain,
9604: with checkboxes to allow a course to be categorized,called recursively.
9605:
9606: Inputs:
9607:
9608: itemcount - track row number for alternating colors
9609:
9610: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9611: categories and subcategories.
9612:
9613: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9614:
9615: parent - parent of current category item
9616:
9617: path - Array containing all categories back up through the hierarchy from the
9618: current category to the top level.
9619:
9620: currcategories - reference to array of current categories assigned to the course
9621:
9622: Returns: $output (markup to be displayed).
9623:
9624: =cut
9625:
9626: sub assign_category_rows {
9627: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9628: my ($text,$name,$item,$chgstr);
9629: if (ref($cats) eq 'ARRAY') {
9630: my $maxdepth = scalar(@{$cats});
9631: if (ref($cats->[$depth]) eq 'HASH') {
9632: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9633: my $numchildren = @{$cats->[$depth]{$parent}};
9634: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9635: $text .= '<td><table class="LC_datatable">';
9636: for (my $j=0; $j<$numchildren; $j++) {
9637: $name = $cats->[$depth]{$parent}[$j];
9638: $item = &escape($name).':'.&escape($parent).':'.$depth;
9639: my $deeper = $depth+1;
9640: my $checked = '';
9641: if (ref($currcategories) eq 'ARRAY') {
9642: if (@{$currcategories} > 0) {
9643: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9644: $checked = ' checked="checked"';
1.663 raeburn 9645: }
9646: }
9647: }
1.664 raeburn 9648: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9649: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9650: $item.'"'.$checked.' />'.$name.'</label></span>'.
9651: '<input type="hidden" name="catname" value="'.$name.'" />'.
9652: '</td><td>';
1.663 raeburn 9653: if (ref($path) eq 'ARRAY') {
9654: push(@{$path},$name);
9655: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9656: pop(@{$path});
9657: }
9658: $text .= '</td></tr>';
9659: }
9660: $text .= '</table></td>';
9661: }
9662: }
9663: }
9664: return $text;
9665: }
9666:
1.655 raeburn 9667: ############################################################
9668: ############################################################
9669:
9670:
1.443 albertel 9671: sub commit_customrole {
1.664 raeburn 9672: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9673: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9674: ($start?', '.&mt('starting').' '.localtime($start):'').
9675: ($end?', ending '.localtime($end):'').': <b>'.
9676: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9677: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9678: '</b><br />';
9679: return $output;
9680: }
9681:
9682: sub commit_standardrole {
1.541 raeburn 9683: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9684: my ($output,$logmsg,$linefeed);
9685: if ($context eq 'auto') {
9686: $linefeed = "\n";
9687: } else {
9688: $linefeed = "<br />\n";
9689: }
1.443 albertel 9690: if ($three eq 'st') {
1.541 raeburn 9691: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9692: $one,$two,$sec,$context);
9693: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9694: ($result eq 'unknown_course') || ($result eq 'refused')) {
9695: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9696: } else {
1.541 raeburn 9697: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9698: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9699: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9700: if ($context eq 'auto') {
9701: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9702: } else {
9703: $output .= '<b>'.$result.'</b>'.$linefeed.
9704: &mt('Add to classlist').': <b>ok</b>';
9705: }
9706: $output .= $linefeed;
1.443 albertel 9707: }
9708: } else {
9709: $output = &mt('Assigning').' '.$three.' in '.$url.
9710: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9711: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9712: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9713: if ($context eq 'auto') {
9714: $output .= $result.$linefeed;
9715: } else {
9716: $output .= '<b>'.$result.'</b>'.$linefeed;
9717: }
1.443 albertel 9718: }
9719: return $output;
9720: }
9721:
9722: sub commit_studentrole {
1.541 raeburn 9723: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9724: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9725: if ($context eq 'auto') {
9726: $linefeed = "\n";
9727: } else {
9728: $linefeed = '<br />'."\n";
9729: }
1.443 albertel 9730: if (defined($one) && defined($two)) {
9731: my $cid=$one.'_'.$two;
9732: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9733: my $secchange = 0;
9734: my $expire_role_result;
9735: my $modify_section_result;
1.628 raeburn 9736: if ($oldsec ne '-1') {
9737: if ($oldsec ne $sec) {
1.443 albertel 9738: $secchange = 1;
1.628 raeburn 9739: my $now = time;
1.443 albertel 9740: my $uurl='/'.$cid;
9741: $uurl=~s/\_/\//g;
9742: if ($oldsec) {
9743: $uurl.='/'.$oldsec;
9744: }
1.626 raeburn 9745: $oldsecurl = $uurl;
1.628 raeburn 9746: $expire_role_result =
1.652 raeburn 9747: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9748: if ($env{'request.course.sec'} ne '') {
9749: if ($expire_role_result eq 'refused') {
9750: my @roles = ('st');
9751: my @statuses = ('previous');
9752: my @roledoms = ($one);
9753: my $withsec = 1;
9754: my %roleshash =
9755: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9756: \@statuses,\@roles,\@roledoms,$withsec);
9757: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9758: my ($oldstart,$oldend) =
9759: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9760: if ($oldend > 0 && $oldend <= $now) {
9761: $expire_role_result = 'ok';
9762: }
9763: }
9764: }
9765: }
1.443 albertel 9766: $result = $expire_role_result;
9767: }
9768: }
9769: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9770: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9771: if ($modify_section_result =~ /^ok/) {
9772: if ($secchange == 1) {
1.628 raeburn 9773: if ($sec eq '') {
9774: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9775: } else {
9776: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9777: }
1.443 albertel 9778: } elsif ($oldsec eq '-1') {
1.628 raeburn 9779: if ($sec eq '') {
9780: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9781: } else {
9782: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9783: }
1.443 albertel 9784: } else {
1.628 raeburn 9785: if ($sec eq '') {
9786: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9787: } else {
9788: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9789: }
1.443 albertel 9790: }
9791: } else {
1.628 raeburn 9792: if ($secchange) {
9793: $$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;
9794: } else {
9795: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9796: }
1.443 albertel 9797: }
9798: $result = $modify_section_result;
9799: } elsif ($secchange == 1) {
1.628 raeburn 9800: if ($oldsec eq '') {
9801: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9802: } else {
9803: $$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;
9804: }
1.626 raeburn 9805: if ($expire_role_result eq 'refused') {
9806: my $newsecurl = '/'.$cid;
9807: $newsecurl =~ s/\_/\//g;
9808: if ($sec ne '') {
9809: $newsecurl.='/'.$sec;
9810: }
9811: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9812: if ($sec eq '') {
9813: $$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;
9814: } else {
9815: $$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;
9816: }
9817: }
9818: }
1.443 albertel 9819: }
9820: } else {
1.626 raeburn 9821: $$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 9822: $result = "error: incomplete course id\n";
9823: }
9824: return $result;
9825: }
9826:
9827: ############################################################
9828: ############################################################
9829:
1.566 albertel 9830: sub check_clone {
1.578 raeburn 9831: my ($args,$linefeed) = @_;
1.566 albertel 9832: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9833: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9834: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9835: my $clonemsg;
9836: my $can_clone = 0;
9837:
9838: if ($clonehome eq 'no_host') {
1.578 raeburn 9839: $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'});
1.566 albertel 9840: } else {
9841: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9842: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9843: $can_clone = 1;
9844: } else {
9845: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9846: $args->{'clonedomain'},$args->{'clonecourse'});
9847: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9848: if (grep(/^\*$/,@cloners)) {
9849: $can_clone = 1;
9850: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9851: $can_clone = 1;
9852: } else {
9853: my %roleshash =
9854: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9855: $args->{'ccdomain'},
9856: 'userroles',['active'],['cc'],
9857: [$args->{'clonedomain'}]);
9858: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9859: $can_clone = 1;
9860: } else {
9861: $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'});
9862: }
1.566 albertel 9863: }
1.578 raeburn 9864: }
1.566 albertel 9865: }
9866: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9867: }
9868:
1.444 albertel 9869: sub construct_course {
1.541 raeburn 9870: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9871: my $outcome;
1.541 raeburn 9872: my $linefeed = '<br />'."\n";
9873: if ($context eq 'auto') {
9874: $linefeed = "\n";
9875: }
1.566 albertel 9876:
9877: #
9878: # Are we cloning?
9879: #
9880: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9881: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9882: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9883: if ($context ne 'auto') {
1.578 raeburn 9884: if ($clonemsg ne '') {
9885: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9886: }
1.566 albertel 9887: }
9888: $outcome .= $clonemsg.$linefeed;
9889:
9890: if (!$can_clone) {
9891: return (0,$outcome);
9892: }
9893: }
9894:
1.444 albertel 9895: #
9896: # Open course
9897: #
9898: my $crstype = lc($args->{'crstype'});
9899: my %cenv=();
9900: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9901: $args->{'cdescr'},
9902: $args->{'curl'},
9903: $args->{'course_home'},
9904: $args->{'nonstandard'},
9905: $args->{'crscode'},
9906: $args->{'ccuname'}.':'.
9907: $args->{'ccdomain'},
9908: $args->{'crstype'});
9909:
9910: # Note: The testing routines depend on this being output; see
9911: # Utils::Course. This needs to at least be output as a comment
9912: # if anyone ever decides to not show this, and Utils::Course::new
9913: # will need to be suitably modified.
1.541 raeburn 9914: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9915: #
9916: # Check if created correctly
9917: #
1.479 albertel 9918: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9919: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9920: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9921:
1.444 albertel 9922: #
1.566 albertel 9923: # Do the cloning
9924: #
9925: if ($can_clone && $cloneid) {
9926: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9927: if ($context ne 'auto') {
9928: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9929: }
9930: $outcome .= $clonemsg.$linefeed;
9931: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9932: # Copy all files
1.637 www 9933: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9934: # Restore URL
1.566 albertel 9935: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9936: # Restore title
1.566 albertel 9937: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9938: # Mark as cloned
1.566 albertel 9939: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9940: # Need to clone grading mode
9941: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9942: $cenv{'grading'}=$newenv{'grading'};
9943: # Do not clone these environment entries
9944: &Apache::lonnet::del('environment',
9945: ['default_enrollment_start_date',
9946: 'default_enrollment_end_date',
9947: 'question.email',
9948: 'policy.email',
9949: 'comment.email',
9950: 'pch.users.denied',
1.725 raeburn 9951: 'plc.users.denied',
9952: 'hidefromcat',
9953: 'categories'],
1.638 www 9954: $$crsudom,$$crsunum);
1.444 albertel 9955: }
1.566 albertel 9956:
1.444 albertel 9957: #
9958: # Set environment (will override cloned, if existing)
9959: #
9960: my @sections = ();
9961: my @xlists = ();
9962: if ($args->{'crstype'}) {
9963: $cenv{'type'}=$args->{'crstype'};
9964: }
9965: if ($args->{'crsid'}) {
9966: $cenv{'courseid'}=$args->{'crsid'};
9967: }
9968: if ($args->{'crscode'}) {
9969: $cenv{'internal.coursecode'}=$args->{'crscode'};
9970: }
9971: if ($args->{'crsquota'} ne '') {
9972: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9973: } else {
9974: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9975: }
9976: if ($args->{'ccuname'}) {
9977: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9978: ':'.$args->{'ccdomain'};
9979: } else {
9980: $cenv{'internal.courseowner'} = $args->{'curruser'};
9981: }
9982: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9983: if ($args->{'crssections'}) {
9984: $cenv{'internal.sectionnums'} = '';
9985: if ($args->{'crssections'} =~ m/,/) {
9986: @sections = split/,/,$args->{'crssections'};
9987: } else {
9988: $sections[0] = $args->{'crssections'};
9989: }
9990: if (@sections > 0) {
9991: foreach my $item (@sections) {
9992: my ($sec,$gp) = split/:/,$item;
9993: my $class = $args->{'crscode'}.$sec;
9994: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9995: $cenv{'internal.sectionnums'} .= $item.',';
9996: unless ($addcheck eq 'ok') {
9997: push @badclasses, $class;
9998: }
9999: }
10000: $cenv{'internal.sectionnums'} =~ s/,$//;
10001: }
10002: }
10003: # do not hide course coordinator from staff listing,
10004: # even if privileged
10005: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10006: # add crosslistings
10007: if ($args->{'crsxlist'}) {
10008: $cenv{'internal.crosslistings'}='';
10009: if ($args->{'crsxlist'} =~ m/,/) {
10010: @xlists = split/,/,$args->{'crsxlist'};
10011: } else {
10012: $xlists[0] = $args->{'crsxlist'};
10013: }
10014: if (@xlists > 0) {
10015: foreach my $item (@xlists) {
10016: my ($xl,$gp) = split/:/,$item;
10017: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10018: $cenv{'internal.crosslistings'} .= $item.',';
10019: unless ($addcheck eq 'ok') {
10020: push @badclasses, $xl;
10021: }
10022: }
10023: $cenv{'internal.crosslistings'} =~ s/,$//;
10024: }
10025: }
10026: if ($args->{'autoadds'}) {
10027: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10028: }
10029: if ($args->{'autodrops'}) {
10030: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10031: }
10032: # check for notification of enrollment changes
10033: my @notified = ();
10034: if ($args->{'notify_owner'}) {
10035: if ($args->{'ccuname'} ne '') {
10036: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10037: }
10038: }
10039: if ($args->{'notify_dc'}) {
10040: if ($uname ne '') {
1.630 raeburn 10041: push(@notified,$uname.':'.$udom);
1.444 albertel 10042: }
10043: }
10044: if (@notified > 0) {
10045: my $notifylist;
10046: if (@notified > 1) {
10047: $notifylist = join(',',@notified);
10048: } else {
10049: $notifylist = $notified[0];
10050: }
10051: $cenv{'internal.notifylist'} = $notifylist;
10052: }
10053: if (@badclasses > 0) {
10054: my %lt=&Apache::lonlocal::texthash(
10055: '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',
10056: 'dnhr' => 'does not have rights to access enrollment in these classes',
10057: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10058: );
1.541 raeburn 10059: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10060: ' ('.$lt{'adby'}.')';
10061: if ($context eq 'auto') {
10062: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 10063: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 10064: foreach my $item (@badclasses) {
10065: if ($context eq 'auto') {
10066: $outcome .= " - $item\n";
10067: } else {
10068: $outcome .= "<li>$item</li>\n";
10069: }
10070: }
10071: if ($context eq 'auto') {
10072: $outcome .= $linefeed;
10073: } else {
1.566 albertel 10074: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 10075: }
10076: }
1.444 albertel 10077: }
10078: if ($args->{'no_end_date'}) {
10079: $args->{'endaccess'} = 0;
10080: }
10081: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10082: $cenv{'internal.autoend'}=$args->{'enrollend'};
10083: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10084: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10085: if ($args->{'showphotos'}) {
10086: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10087: }
10088: $cenv{'internal.authtype'} = $args->{'authtype'};
10089: $cenv{'internal.autharg'} = $args->{'autharg'};
10090: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10091: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 10092: 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');
10093: if ($context eq 'auto') {
10094: $outcome .= $krb_msg;
10095: } else {
1.566 albertel 10096: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 10097: }
10098: $outcome .= $linefeed;
1.444 albertel 10099: }
10100: }
10101: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10102: if ($args->{'setpolicy'}) {
10103: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10104: }
10105: if ($args->{'setcontent'}) {
10106: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10107: }
10108: }
10109: if ($args->{'reshome'}) {
10110: $cenv{'reshome'}=$args->{'reshome'}.'/';
10111: $cenv{'reshome'}=~s/\/+$/\//;
10112: }
10113: #
10114: # course has keyed access
10115: #
10116: if ($args->{'setkeys'}) {
10117: $cenv{'keyaccess'}='yes';
10118: }
10119: # if specified, key authority is not course, but user
10120: # only active if keyaccess is yes
10121: if ($args->{'keyauth'}) {
1.487 albertel 10122: my ($user,$domain) = split(':',$args->{'keyauth'});
10123: $user = &LONCAPA::clean_username($user);
10124: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 10125: if ($user ne '' && $domain ne '') {
1.487 albertel 10126: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 10127: }
10128: }
10129:
10130: if ($args->{'disresdis'}) {
10131: $cenv{'pch.roles.denied'}='st';
10132: }
10133: if ($args->{'disablechat'}) {
10134: $cenv{'plc.roles.denied'}='st';
10135: }
10136:
10137: # Record we've not yet viewed the Course Initialization Helper for this
10138: # course
10139: $cenv{'course.helper.not.run'} = 1;
10140: #
10141: # Use new Randomseed
10142: #
10143: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10144: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10145: #
10146: # The encryption code and receipt prefix for this course
10147: #
10148: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10149: $cenv{'internal.encpref'}=100+int(9*rand(99));
10150: #
10151: # By default, use standard grading
10152: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10153:
1.541 raeburn 10154: $outcome .= $linefeed.&mt('Setting environment').': '.
10155: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10156: #
10157: # Open all assignments
10158: #
10159: if ($args->{'openall'}) {
10160: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10161: my %storecontent = ($storeunder => time,
10162: $storeunder.'.type' => 'date_start');
10163:
10164: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 10165: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 10166: }
10167: #
10168: # Set first page
10169: #
10170: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10171: || ($cloneid)) {
1.445 albertel 10172: use LONCAPA::map;
1.444 albertel 10173: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 10174:
10175: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10176: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10177:
1.444 albertel 10178: $outcome .= ($fatal?$errtext:'read ok').' - ';
10179: my $title; my $url;
10180: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 10181: $title=&mt('Syllabus');
1.444 albertel 10182: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10183: } else {
1.690 bisitz 10184: $title=&mt('Navigate Contents');
1.444 albertel 10185: $url='/adm/navmaps';
10186: }
1.445 albertel 10187:
10188: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10189: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10190:
10191: if ($errtext) { $fatal=2; }
1.541 raeburn 10192: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 10193: }
1.566 albertel 10194:
10195: return (1,$outcome);
1.444 albertel 10196: }
10197:
10198: ############################################################
10199: ############################################################
10200:
1.378 raeburn 10201: sub course_type {
10202: my ($cid) = @_;
10203: if (!defined($cid)) {
10204: $cid = $env{'request.course.id'};
10205: }
1.404 albertel 10206: if (defined($env{'course.'.$cid.'.type'})) {
10207: return $env{'course.'.$cid.'.type'};
1.378 raeburn 10208: } else {
10209: return 'Course';
1.377 raeburn 10210: }
10211: }
1.156 albertel 10212:
1.406 raeburn 10213: sub group_term {
10214: my $crstype = &course_type();
10215: my %names = (
10216: 'Course' => 'group',
10217: 'Group' => 'team',
10218: );
10219: return $names{$crstype};
10220: }
10221:
1.156 albertel 10222: sub icon {
10223: my ($file)=@_;
1.505 albertel 10224: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 10225: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 10226: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 10227: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10228: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10229: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10230: $curfext.".gif") {
10231: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10232: $curfext.".gif";
10233: }
10234: }
1.249 albertel 10235: return &lonhttpdurl($iconname);
1.154 albertel 10236: }
1.84 albertel 10237:
1.575 albertel 10238: sub lonhttpdurl {
1.692 www 10239: #
10240: # Had been used for "small fry" static images on separate port 8080.
10241: # Modify here if lightweight http functionality desired again.
10242: # Currently eliminated due to increasing firewall issues.
10243: #
1.575 albertel 10244: my ($url)=@_;
1.692 www 10245: return $url;
1.215 albertel 10246: }
10247:
1.213 albertel 10248: sub connection_aborted {
10249: my ($r)=@_;
10250: $r->print(" ");$r->rflush();
10251: my $c = $r->connection;
10252: return $c->aborted();
10253: }
10254:
1.221 foxr 10255: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 10256: # strings as 'strings'.
10257: sub escape_single {
1.221 foxr 10258: my ($input) = @_;
1.223 albertel 10259: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 10260: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10261: return $input;
10262: }
1.223 albertel 10263:
1.222 foxr 10264: # Same as escape_single, but escape's "'s This
10265: # can be used for "strings"
10266: sub escape_double {
10267: my ($input) = @_;
10268: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10269: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10270: return $input;
10271: }
1.223 albertel 10272:
1.222 foxr 10273: # Escapes the last element of a full URL.
10274: sub escape_url {
10275: my ($url) = @_;
1.238 raeburn 10276: my @urlslices = split(/\//, $url,-1);
1.369 www 10277: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 10278: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 10279: }
1.462 albertel 10280:
1.820 raeburn 10281: sub compare_arrays {
10282: my ($arrayref1,$arrayref2) = @_;
10283: my (@difference,%count);
10284: @difference = ();
10285: %count = ();
10286: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10287: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10288: foreach my $element (keys(%count)) {
10289: if ($count{$element} == 1) {
10290: push(@difference,$element);
10291: }
10292: }
10293: }
10294: return @difference;
10295: }
10296:
1.817 bisitz 10297: # -------------------------------------------------------- Initialize user login
1.462 albertel 10298: sub init_user_environment {
1.463 albertel 10299: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 10300: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10301:
10302: my $public=($username eq 'public' && $domain eq 'public');
10303:
10304: # See if old ID present, if so, remove
10305:
10306: my ($filename,$cookie,$userroles);
10307: my $now=time;
10308:
10309: if ($public) {
10310: my $max_public=100;
10311: my $oldest;
10312: my $oldest_time=0;
10313: for(my $next=1;$next<=$max_public;$next++) {
10314: if (-e $lonids."/publicuser_$next.id") {
10315: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10316: if ($mtime<$oldest_time || !$oldest_time) {
10317: $oldest_time=$mtime;
10318: $oldest=$next;
10319: }
10320: } else {
10321: $cookie="publicuser_$next";
10322: last;
10323: }
10324: }
10325: if (!$cookie) { $cookie="publicuser_$oldest"; }
10326: } else {
1.463 albertel 10327: # if this isn't a robot, kill any existing non-robot sessions
10328: if (!$args->{'robot'}) {
10329: opendir(DIR,$lonids);
10330: while ($filename=readdir(DIR)) {
10331: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10332: unlink($lonids.'/'.$filename);
10333: }
1.462 albertel 10334: }
1.463 albertel 10335: closedir(DIR);
1.462 albertel 10336: }
10337: # Give them a new cookie
1.463 albertel 10338: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10339: : $now.$$.int(rand(10000)));
1.463 albertel 10340: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10341:
10342: # Initialize roles
10343:
10344: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10345: }
10346: # ------------------------------------ Check browser type and MathML capability
10347:
10348: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10349: $clientunicode,$clientos) = &decode_user_agent($r);
10350:
10351: # ------------------------------------------------------------- Get environment
10352:
10353: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10354: my ($tmp) = keys(%userenv);
10355: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10356: # default remote control to off
10357: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10358: } else {
10359: undef(%userenv);
10360: }
10361: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10362: $form->{'interface'}=$userenv{'interface'};
10363: }
10364: $env{'environment.remote'}=$userenv{'remote'};
10365: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10366:
10367: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 10368: foreach my $option ('interface','localpath','localres') {
10369: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 10370: }
10371: # --------------------------------------------------------- Write first profile
10372:
10373: {
10374: my %initial_env =
10375: ("user.name" => $username,
10376: "user.domain" => $domain,
10377: "user.home" => $authhost,
10378: "browser.type" => $clientbrowser,
10379: "browser.version" => $clientversion,
10380: "browser.mathml" => $clientmathml,
10381: "browser.unicode" => $clientunicode,
10382: "browser.os" => $clientos,
10383: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10384: "request.course.fn" => '',
10385: "request.course.uri" => '',
10386: "request.course.sec" => '',
10387: "request.role" => 'cm',
10388: "request.role.adv" => $env{'user.adv'},
10389: "request.host" => $ENV{'REMOTE_ADDR'},);
10390:
10391: if ($form->{'localpath'}) {
10392: $initial_env{"browser.localpath"} = $form->{'localpath'};
10393: $initial_env{"browser.localres"} = $form->{'localres'};
10394: }
10395:
10396: if ($public) {
10397: $initial_env{"environment.remote"} = "off";
10398: }
10399: if ($form->{'interface'}) {
10400: $form->{'interface'}=~s/\W//gs;
10401: $initial_env{"browser.interface"} = $form->{'interface'};
10402: $env{'browser.interface'}=$form->{'interface'};
10403: }
10404:
1.724 raeburn 10405: foreach my $tool ('aboutme','blog','portfolio') {
10406: $userenv{'availabletools.'.$tool} =
10407: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10408: }
10409:
1.765 raeburn 10410: foreach my $crstype ('official','unofficial') {
10411: $userenv{'canrequest.'.$crstype} =
10412: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10413: 'reload','requestcourses');
10414: }
10415:
1.462 albertel 10416: $env{'user.environment'} = "$lonids/$cookie.id";
10417:
10418: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10419: &GDBM_WRCREAT(),0640)) {
10420: &_add_to_env(\%disk_env,\%initial_env);
10421: &_add_to_env(\%disk_env,\%userenv,'environment.');
10422: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10423: if (ref($args->{'extra_env'})) {
10424: &_add_to_env(\%disk_env,$args->{'extra_env'});
10425: }
1.462 albertel 10426: untie(%disk_env);
10427: } else {
1.705 tempelho 10428: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10429: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10430: return 'error: '.$!;
10431: }
10432: }
10433: $env{'request.role'}='cm';
10434: $env{'request.role.adv'}=$env{'user.adv'};
10435: $env{'browser.type'}=$clientbrowser;
10436:
10437: return $cookie;
10438:
10439: }
10440:
10441: sub _add_to_env {
10442: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10443: if (ref($env_data) eq 'HASH') {
10444: while (my ($key,$value) = each(%$env_data)) {
10445: $idf->{$prefix.$key} = $value;
10446: $env{$prefix.$key} = $value;
10447: }
1.462 albertel 10448: }
10449: }
10450:
1.685 tempelho 10451: # --- Get the symbolic name of a problem and the url
10452: sub get_symb {
10453: my ($request,$silent) = @_;
1.726 raeburn 10454: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10455: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10456: if ($symb eq '') {
10457: if (!$silent) {
10458: $request->print("Unable to handle ambiguous references:$url:.");
10459: return ();
10460: }
10461: }
10462: &Apache::lonenc::check_decrypt(\$symb);
10463: return ($symb);
10464: }
10465:
10466: # --------------------------------------------------------------Get annotation
10467:
10468: sub get_annotation {
10469: my ($symb,$enc) = @_;
10470:
10471: my $key = $symb;
10472: if (!$enc) {
10473: $key =
10474: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10475: }
10476: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10477: return $annotation{$key};
10478: }
10479:
10480: sub clean_symb {
1.731 raeburn 10481: my ($symb,$delete_enc) = @_;
1.685 tempelho 10482:
10483: &Apache::lonenc::check_decrypt(\$symb);
10484: my $enc = $env{'request.enc'};
1.731 raeburn 10485: if ($delete_enc) {
1.730 raeburn 10486: delete($env{'request.enc'});
10487: }
1.685 tempelho 10488:
10489: return ($symb,$enc);
10490: }
1.462 albertel 10491:
1.41 ng 10492: =pod
10493:
10494: =back
10495:
1.112 bowersj2 10496: =cut
1.41 ng 10497:
1.112 bowersj2 10498: 1;
10499: __END__;
1.41 ng 10500:
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