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