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