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