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