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