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