1: # The LearningOnline Network with CAPA
2: # a pile of common routines
3: #
4: # $Id: loncommon.pm,v 1.558 2007/08/02 01:07:00 albertel Exp $
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: #
28:
29: # Makes a table out of the previous attempts
30: # Inputs result_from_symbread, user, domain, course_id
31: # Reads in non-network-related .tab files
32:
33: # POD header:
34:
35: =pod
36:
37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
45:
46: =head1 OVERVIEW
47:
48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
55: package Apache::loncommon;
56:
57: use strict;
58: use Apache::lonnet;
59: use GDBM_File;
60: use POSIX qw(strftime mktime);
61: use Apache::lonmenu();
62: use Apache::lonenc();
63: use Apache::lonlocal;
64: use HTML::Entities;
65: use Apache::lonhtmlcommon();
66: use Apache::loncoursedata();
67: use Apache::lontexconvert();
68: use Apache::lonclonecourse();
69: use LONCAPA qw(:DEFAULT :match);
70:
71: # ---------------------------------------------- Designs
72: use vars qw(%defaultdesign);
73:
74: my $readit;
75:
76:
77: ##
78: ## Global Variables
79: ##
80:
81: # ----------------------------------------------- Filetypes/Languages/Copyright
82: my %language;
83: my %supported_language;
84: my %cprtag;
85: my %scprtag;
86: my %fe; my %fd; my %fm;
87: my %category_extensions;
88:
89: # ---------------------------------------------- Thesaurus variables
90: #
91: # %Keywords:
92: # A hash used by &keyword to determine if a word is considered a keyword.
93: # $thesaurus_db_file
94: # Scalar containing the full path to the thesaurus database.
95:
96: my %Keywords;
97: my $thesaurus_db_file;
98:
99: #
100: # Initialize values from language.tab, copyright.tab, filetypes.tab,
101: # thesaurus.tab, and filecategories.tab.
102: #
103: BEGIN {
104: # Variable initialization
105: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
106: #
107: unless ($readit) {
108: # ------------------------------------------------------------------- languages
109: {
110: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
111: '/language.tab';
112: if ( open(my $fh,"<$langtabfile") ) {
113: while (my $line = <$fh>) {
114: next if ($line=~/^\#/);
115: chomp($line);
116: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
117: $language{$key}=$val.' - '.$enc;
118: if ($sup) {
119: $supported_language{$key}=$sup;
120: }
121: }
122: close($fh);
123: }
124: }
125: # ------------------------------------------------------------------ copyrights
126: {
127: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
128: '/copyright.tab';
129: if ( open (my $fh,"<$copyrightfile") ) {
130: while (my $line = <$fh>) {
131: next if ($line=~/^\#/);
132: chomp($line);
133: my ($key,$val)=(split(/\s+/,$line,2));
134: $cprtag{$key}=$val;
135: }
136: close($fh);
137: }
138: }
139: # ----------------------------------------------------------- source copyrights
140: {
141: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
142: '/source_copyright.tab';
143: if ( open (my $fh,"<$sourcecopyrightfile") ) {
144: while (my $line = <$fh>) {
145: next if ($line =~ /^\#/);
146: chomp($line);
147: my ($key,$val)=(split(/\s+/,$line,2));
148: $scprtag{$key}=$val;
149: }
150: close($fh);
151: }
152: }
153:
154: # -------------------------------------------------------------- default domain designs
155: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
156: my $designfile = $designdir.'/default.tab';
157: if ( open (my $fh,"<$designfile") ) {
158: while (my $line = <$fh>) {
159: next if ($line =~ /^\#/);
160: chomp($line);
161: my ($key,$val)=(split(/\=/,$line));
162: if ($val) { $defaultdesign{$key}=$val; }
163: }
164: close($fh);
165: }
166:
167: # ------------------------------------------------------------- file categories
168: {
169: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
170: '/filecategories.tab';
171: if ( open (my $fh,"<$categoryfile") ) {
172: while (my $line = <$fh>) {
173: next if ($line =~ /^\#/);
174: chomp($line);
175: my ($extension,$category)=(split(/\s+/,$line,2));
176: push @{$category_extensions{lc($category)}},$extension;
177: }
178: close($fh);
179: }
180:
181: }
182: # ------------------------------------------------------------------ file types
183: {
184: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
185: '/filetypes.tab';
186: if ( open (my $fh,"<$typesfile") ) {
187: while (my $line = <$fh>) {
188: next if ($line =~ /^\#/);
189: chomp($line);
190: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
191: if ($descr ne '') {
192: $fe{$ending}=lc($emb);
193: $fd{$ending}=$descr;
194: if ($mime ne 'unk') { $fm{$ending}=$mime; }
195: }
196: }
197: close($fh);
198: }
199: }
200: &Apache::lonnet::logthis(
201: "<font color=yellow>INFO: Read file types</font>");
202: $readit=1;
203: } # end of unless($readit)
204:
205: }
206:
207: ###############################################################
208: ## HTML and Javascript Helper Functions ##
209: ###############################################################
210:
211: =pod
212:
213: =head1 HTML and Javascript Functions
214:
215: =over 4
216:
217: =item * browser_and_searcher_javascript ()
218:
219: X<browsing, javascript>X<searching, javascript>Returns a string
220: containing javascript with two functions, C<openbrowser> and
221: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
222: tags.
223:
224: =item * openbrowser(formname,elementname,only,omit) [javascript]
225:
226: inputs: formname, elementname, only, omit
227:
228: formname and elementname indicate the name of the html form and name of
229: the element that the results of the browsing selection are to be placed in.
230:
231: Specifying 'only' will restrict the browser to displaying only files
232: with the given extension. Can be a comma separated list.
233:
234: Specifying 'omit' will restrict the browser to NOT displaying files
235: with the given extension. Can be a comma separated list.
236:
237: =item * opensearcher(formname, elementname) [javascript]
238:
239: Inputs: formname, elementname
240:
241: formname and elementname specify the name of the html form and the name
242: of the element the selection from the search results will be placed in.
243:
244: =cut
245:
246: sub browser_and_searcher_javascript {
247: my ($mode)=@_;
248: if (!defined($mode)) { $mode='edit'; }
249: my $resurl=&escape_single(&lastresurl());
250: return <<END;
251: // <!-- BEGIN LON-CAPA Internal
252: var editbrowser = null;
253: function openbrowser(formname,elementname,only,omit,titleelement) {
254: var url = '$resurl/?';
255: if (editbrowser == null) {
256: url += 'launch=1&';
257: }
258: url += 'catalogmode=interactive&';
259: url += 'mode=$mode&';
260: url += 'form=' + formname + '&';
261: if (only != null) {
262: url += 'only=' + only + '&';
263: } else {
264: url += 'only=&';
265: }
266: if (omit != null) {
267: url += 'omit=' + omit + '&';
268: } else {
269: url += 'omit=&';
270: }
271: if (titleelement != null) {
272: url += 'titleelement=' + titleelement + '&';
273: } else {
274: url += 'titleelement=&';
275: }
276: url += 'element=' + elementname + '';
277: var title = 'Browser';
278: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
279: options += ',width=700,height=600';
280: editbrowser = open(url,title,options,'1');
281: editbrowser.focus();
282: }
283: var editsearcher;
284: function opensearcher(formname,elementname,titleelement) {
285: var url = '/adm/searchcat?';
286: if (editsearcher == null) {
287: url += 'launch=1&';
288: }
289: url += 'catalogmode=interactive&';
290: url += 'mode=$mode&';
291: url += 'form=' + formname + '&';
292: if (titleelement != null) {
293: url += 'titleelement=' + titleelement + '&';
294: } else {
295: url += 'titleelement=&';
296: }
297: url += 'element=' + elementname + '';
298: var title = 'Search';
299: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
300: options += ',width=700,height=600';
301: editsearcher = open(url,title,options,'1');
302: editsearcher.focus();
303: }
304: // END LON-CAPA Internal -->
305: END
306: }
307:
308: sub lastresurl {
309: if ($env{'environment.lastresurl'}) {
310: return $env{'environment.lastresurl'}
311: } else {
312: return '/res';
313: }
314: }
315:
316: sub storeresurl {
317: my $resurl=&Apache::lonnet::clutter(shift);
318: unless ($resurl=~/^\/res/) { return 0; }
319: $resurl=~s/\/$//;
320: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
321: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
322: return 1;
323: }
324:
325: sub studentbrowser_javascript {
326: unless (
327: (($env{'request.course.id'}) &&
328: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
329: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
330: '/'.$env{'request.course.sec'})
331: ))
332: || ($env{'request.role'}=~/^(au|dc|su)/)
333: ) { return ''; }
334: return (<<'ENDSTDBRW');
335: <script type="text/javascript" language="Javascript" >
336: var stdeditbrowser;
337: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
338: var url = '/adm/pickstudent?';
339: var filter;
340: if (!ignorefilter) {
341: eval('filter=document.'+formname+'.'+uname+'.value;');
342: }
343: if (filter != null) {
344: if (filter != '') {
345: url += 'filter='+filter+'&';
346: }
347: }
348: url += 'form=' + formname + '&unameelement='+uname+
349: '&udomelement='+udom;
350: if (roleflag) { url+="&roles=1"; }
351: var title = 'Student_Browser';
352: var options = 'scrollbars=1,resizable=1,menubar=0';
353: options += ',width=700,height=600';
354: stdeditbrowser = open(url,title,options,'1');
355: stdeditbrowser.focus();
356: }
357: </script>
358: ENDSTDBRW
359: }
360:
361: sub selectstudent_link {
362: my ($form,$unameele,$udomele)=@_;
363: if ($env{'request.course.id'}) {
364: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
365: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
366: '/'.$env{'request.course.sec'})) {
367: return '';
368: }
369: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
370: '","'.$udomele.'","","1");'."'>".&mt('Select User')."</a>";
371: }
372: if ($env{'request.role'}=~/^(au|dc|su)/) {
373: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
374: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
375: }
376: return '';
377: }
378:
379: sub coursebrowser_javascript {
380: my ($domainfilter,$sec_element,$formname)=@_;
381: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
382: my $output = '
383: <script type="text/javascript">
384: var stdeditbrowser;'."\n";
385: $output .= <<"ENDSTDBRW";
386: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
387: var url = '/adm/pickcourse?';
388: var domainfilter = '';
389: var formid = getFormIdByName(formname);
390: if (formid > -1) {
391: var domid = getIndexByName(formid,udom);
392: if (domid > -1) {
393: if (document.forms[formid].elements[domid].type == 'select-one') {
394: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
395: }
396: if (document.forms[formid].elements[domid].type == 'hidden') {
397: domainfilter=document.forms[formid].elements[domid].value;
398: }
399: }
400: }
401: if (domainfilter != null) {
402: if (domainfilter != '') {
403: url += 'domainfilter='+domainfilter+'&';
404: }
405: }
406: url += 'form=' + formname + '&cnumelement='+uname+
407: '&cdomelement='+udom+
408: '&cnameelement='+desc;
409: if (extra_element !=null && extra_element != '') {
410: if (formname == 'rolechoice') {
411: url += '&roleelement='+extra_element;
412: if (domainfilter == null || domainfilter == '') {
413: url += '&domainfilter='+extra_element;
414: }
415: }
416: else {
417: if (formname == 'portform') {
418: url += '&setroles='+extra_element;
419: }
420: }
421: }
422: if (multflag !=null && multflag != '') {
423: url += '&multiple='+multflag;
424: }
425: if (crstype == 'Course/Group') {
426: if (formname == 'cu') {
427: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
428: if (crstype == "") {
429: alert("$crs_or_grp_alert");
430: return;
431: }
432: }
433: }
434: if (crstype !=null && crstype != '') {
435: url += '&type='+crstype;
436: }
437: var title = 'Course_Browser';
438: var options = 'scrollbars=1,resizable=1,menubar=0';
439: options += ',width=700,height=600';
440: stdeditbrowser = open(url,title,options,'1');
441: stdeditbrowser.focus();
442: }
443:
444: function getFormIdByName(formname) {
445: for (var i=0;i<document.forms.length;i++) {
446: if (document.forms[i].name == formname) {
447: return i;
448: }
449: }
450: return -1;
451: }
452:
453: function getIndexByName(formid,item) {
454: for (var i=0;i<document.forms[formid].elements.length;i++) {
455: if (document.forms[formid].elements[i].name == item) {
456: return i;
457: }
458: }
459: return -1;
460: }
461: ENDSTDBRW
462: if ($sec_element ne '') {
463: $output .= &setsec_javascript($sec_element,$formname);
464: }
465: $output .= '
466: </script>';
467: return $output;
468: }
469:
470: sub setsec_javascript {
471: my ($sec_element,$formname) = @_;
472: my $setsections = qq|
473: function setSect(sectionlist) {
474: var sectionsArray = sectionlist.split(",");
475: var numSections = sectionsArray.length;
476: document.$formname.$sec_element.length = 0;
477: if (numSections == 0) {
478: document.$formname.$sec_element.multiple=false;
479: document.$formname.$sec_element.size=1;
480: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
481: } else {
482: if (numSections == 1) {
483: document.$formname.$sec_element.multiple=false;
484: document.$formname.$sec_element.size=1;
485: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
486: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
487: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
488: } else {
489: for (var i=0; i<numSections; i++) {
490: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
491: }
492: document.$formname.$sec_element.multiple=true
493: if (numSections < 3) {
494: document.$formname.$sec_element.size=numSections;
495: } else {
496: document.$formname.$sec_element.size=3;
497: }
498: document.$formname.$sec_element.options[0].selected = false
499: }
500: }
501: }
502: |;
503: return $setsections;
504: }
505:
506:
507: sub selectcourse_link {
508: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
509: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
510: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
511: }
512:
513: sub check_uncheck_jscript {
514: my $jscript = <<"ENDSCRT";
515: function checkAll(field) {
516: if (field.length > 0) {
517: for (i = 0; i < field.length; i++) {
518: field[i].checked = true ;
519: }
520: } else {
521: field.checked = true
522: }
523: }
524:
525: function uncheckAll(field) {
526: if (field.length > 0) {
527: for (i = 0; i < field.length; i++) {
528: field[i].checked = false ;
529: }
530: } else {
531: field.checked = false ;
532: }
533: }
534: ENDSCRT
535: return $jscript;
536: }
537:
538:
539: =pod
540:
541: =item * linked_select_forms(...)
542:
543: linked_select_forms returns a string containing a <script></script> block
544: and html for two <select> menus. The select menus will be linked in that
545: changing the value of the first menu will result in new values being placed
546: in the second menu. The values in the select menu will appear in alphabetical
547: order.
548:
549: linked_select_forms takes the following ordered inputs:
550:
551: =over 4
552:
553: =item * $formname, the name of the <form> tag
554:
555: =item * $middletext, the text which appears between the <select> tags
556:
557: =item * $firstdefault, the default value for the first menu
558:
559: =item * $firstselectname, the name of the first <select> tag
560:
561: =item * $secondselectname, the name of the second <select> tag
562:
563: =item * $hashref, a reference to a hash containing the data for the menus.
564:
565: =back
566:
567: Below is an example of such a hash. Only the 'text', 'default', and
568: 'select2' keys must appear as stated. keys(%menu) are the possible
569: values for the first select menu. The text that coincides with the
570: first menu value is given in $menu{$choice1}->{'text'}. The values
571: and text for the second menu are given in the hash pointed to by
572: $menu{$choice1}->{'select2'}.
573:
574: my %menu = ( A1 => { text =>"Choice A1" ,
575: default => "B3",
576: select2 => {
577: B1 => "Choice B1",
578: B2 => "Choice B2",
579: B3 => "Choice B3",
580: B4 => "Choice B4"
581: }
582: },
583: A2 => { text =>"Choice A2" ,
584: default => "C2",
585: select2 => {
586: C1 => "Choice C1",
587: C2 => "Choice C2",
588: C3 => "Choice C3"
589: }
590: },
591: A3 => { text =>"Choice A3" ,
592: default => "D6",
593: select2 => {
594: D1 => "Choice D1",
595: D2 => "Choice D2",
596: D3 => "Choice D3",
597: D4 => "Choice D4",
598: D5 => "Choice D5",
599: D6 => "Choice D6",
600: D7 => "Choice D7"
601: }
602: }
603: );
604:
605: =cut
606:
607: sub linked_select_forms {
608: my ($formname,
609: $middletext,
610: $firstdefault,
611: $firstselectname,
612: $secondselectname,
613: $hashref
614: ) = @_;
615: my $second = "document.$formname.$secondselectname";
616: my $first = "document.$formname.$firstselectname";
617: # output the javascript to do the changing
618: my $result = '';
619: $result.="<script type=\"text/javascript\">\n";
620: $result.="var select2data = new Object();\n";
621: $" = '","';
622: my $debug = '';
623: foreach my $s1 (sort(keys(%$hashref))) {
624: $result.="select2data.d_$s1 = new Object();\n";
625: $result.="select2data.d_$s1.def = new String('".
626: $hashref->{$s1}->{'default'}."');\n";
627: $result.="select2data.d_$s1.values = new Array(";
628: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
629: $result.="\"@s2values\");\n";
630: $result.="select2data.d_$s1.texts = new Array(";
631: my @s2texts;
632: foreach my $value (@s2values) {
633: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
634: }
635: $result.="\"@s2texts\");\n";
636: }
637: $"=' ';
638: $result.= <<"END";
639:
640: function select1_changed() {
641: // Determine new choice
642: var newvalue = "d_" + $first.value;
643: // update select2
644: var values = select2data[newvalue].values;
645: var texts = select2data[newvalue].texts;
646: var select2def = select2data[newvalue].def;
647: var i;
648: // out with the old
649: for (i = 0; i < $second.options.length; i++) {
650: $second.options[i] = null;
651: }
652: // in with the nuclear
653: for (i=0;i<values.length; i++) {
654: $second.options[i] = new Option(values[i]);
655: $second.options[i].value = values[i];
656: $second.options[i].text = texts[i];
657: if (values[i] == select2def) {
658: $second.options[i].selected = true;
659: }
660: }
661: }
662: </script>
663: END
664: # output the initial values for the selection lists
665: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
666: foreach my $value (sort(keys(%$hashref))) {
667: $result.=" <option value=\"$value\" ";
668: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
669: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
670: }
671: $result .= "</select>\n";
672: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
673: $result .= $middletext;
674: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
675: my $seconddefault = $hashref->{$firstdefault}->{'default'};
676: foreach my $value (sort(keys(%select2))) {
677: $result.=" <option value=\"$value\" ";
678: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
679: $result.=">".&mt($select2{$value})."</option>\n";
680: }
681: $result .= "</select>\n";
682: # return $debug;
683: return $result;
684: } # end of sub linked_select_forms {
685:
686: =pod
687:
688: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
689:
690: Returns a string corresponding to an HTML link to the given help
691: $topic, where $topic corresponds to the name of a .tex file in
692: /home/httpd/html/adm/help/tex, with underscores replaced by
693: spaces.
694:
695: $text will optionally be linked to the same topic, allowing you to
696: link text in addition to the graphic. If you do not want to link
697: text, but wish to specify one of the later parameters, pass an
698: empty string.
699:
700: $stayOnPage is a value that will be interpreted as a boolean. If true,
701: the link will not open a new window. If false, the link will open
702: a new window using Javascript. (Default is false.)
703:
704: $width and $height are optional numerical parameters that will
705: override the width and height of the popped up window, which may
706: be useful for certain help topics with big pictures included.
707:
708: =cut
709:
710: sub help_open_topic {
711: my ($topic, $text, $stayOnPage, $width, $height) = @_;
712: $text = "" if (not defined $text);
713: $stayOnPage = 0 if (not defined $stayOnPage);
714: if ($env{'browser.interface'} eq 'textual') {
715: $stayOnPage=1;
716: }
717: $width = 350 if (not defined $width);
718: $height = 400 if (not defined $height);
719: my $filename = $topic;
720: $filename =~ s/ /_/g;
721:
722: my $template = "";
723: my $link;
724:
725: $topic=~s/\W/\_/g;
726:
727: if (!$stayOnPage)
728: {
729: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
730: }
731: else
732: {
733: $link = "/adm/help/${filename}.hlp";
734: }
735:
736: # Add the text
737: if ($text ne "")
738: {
739: $template .=
740: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
741: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
742: }
743:
744: # Add the graphic
745: my $title = &mt('Online Help');
746: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
747: $template .= <<"ENDTEMPLATE";
748: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
749: ENDTEMPLATE
750: if ($text ne '') { $template.='</td></tr></table>' };
751: return $template;
752:
753: }
754:
755: # This is a quicky function for Latex cheatsheet editing, since it
756: # appears in at least four places
757: sub helpLatexCheatsheet {
758: my $other = shift;
759: my $addOther = '';
760: if ($other) {
761: $addOther = Apache::loncommon::help_open_topic($other, shift,
762: undef, undef, 600) .
763: '</td><td>';
764: }
765: return '<table><tr><td>'.
766: $addOther .
767: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
768: undef,undef,600)
769: .'</td><td>'.
770: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
771: undef,undef,600)
772: .'</td></tr></table>';
773: }
774:
775: sub general_help {
776: my $helptopic='Student_Intro';
777: if ($env{'request.role'}=~/^(ca|au)/) {
778: $helptopic='Authoring_Intro';
779: } elsif ($env{'request.role'}=~/^cc/) {
780: $helptopic='Course_Coordination_Intro';
781: }
782: return $helptopic;
783: }
784:
785: sub update_help_link {
786: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
787: my $origurl = $ENV{'REQUEST_URI'};
788: $origurl=~s|^/~|/priv/|;
789: my $timestamp = time;
790: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
791: $$datum = &escape($$datum);
792: }
793:
794: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
795: my $output .= <<"ENDOUTPUT";
796: <script type="text/javascript">
797: banner_link = '$banner_link';
798: </script>
799: ENDOUTPUT
800: return $output;
801: }
802:
803: # now just updates the help link and generates a blue icon
804: sub help_open_menu {
805: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
806: = @_;
807: $stayOnPage = 0 if (not defined $stayOnPage);
808: # formerly only used pop-up help (stayOnPage = 0)
809: # if environment.remote is on (using remote control UI)
810: # if ($env{'browser.interface'} eq 'textual' ||
811: # $env{'environment.remote'} eq 'off' ) {
812: # $stayOnPage=1;
813: #}
814: # Now making pop-up help the default even with remote control
815: if ($env{'browser.interface'} eq 'textual') {
816: $stayOnPage=1;
817: }
818: my $output;
819: if ($component_help) {
820: if (!$text) {
821: $output=&help_open_topic($component_help,undef,$stayOnPage,
822: $width,$height);
823: } else {
824: my $help_text;
825: $help_text=&unescape($topic);
826: $output='<table><tr><td>'.
827: &help_open_topic($component_help,$help_text,$stayOnPage,
828: $width,$height).'</td></tr></table>';
829: }
830: }
831: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
832: return $output.$banner_link;
833: }
834:
835: sub top_nav_help {
836: my ($text) = @_;
837:
838: $text = &mt($text);
839:
840: my $stayOnPage =
841: ($env{'browser.interface'} eq 'textual' ||
842: $env{'environment.remote'} eq 'off' );
843: my $link= ($stayOnPage) ? "javascript:helpMenu('display')"
844: : "javascript:helpMenu('open')";
845: my $banner_link = &update_help_link(undef,undef,undef,undef,$stayOnPage);
846:
847: my $title = &mt('Get help');
848:
849: return <<"END";
850: $banner_link
851: <a href="$link" title="$title">$text</a>
852: END
853: }
854:
855: sub help_menu_js {
856: my ($text) = @_;
857:
858: my $stayOnPage =
859: ($env{'browser.interface'} eq 'textual' ||
860: $env{'environment.remote'} eq 'off' );
861:
862: my $width = 620;
863: my $height = 600;
864: my $helptopic=&general_help();
865: my $details_link = '/adm/help/'.$helptopic.'.hlp';
866: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
867: my $start_page =
868: &Apache::loncommon::start_page('Help Menu', undef,
869: {'frameset' => 1,
870: 'js_ready' => 1,
871: 'add_entries' => {
872: 'border' => '0',
873: 'rows' => "105,*",},});
874: my $end_page =
875: &Apache::loncommon::end_page({'frameset' => 1,
876: 'js_ready' => 1,});
877:
878: my $template .= <<"ENDTEMPLATE";
879: <script type="text/javascript">
880: // <!-- BEGIN LON-CAPA Internal
881: // <![CDATA[
882: var banner_link = '';
883: function helpMenu(target) {
884: var caller = this;
885: if (target == 'open') {
886: var newWindow = null;
887: try {
888: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
889: }
890: catch(error) {
891: writeHelp(caller);
892: return;
893: }
894: if (newWindow) {
895: caller = newWindow;
896: }
897: }
898: writeHelp(caller);
899: return;
900: }
901: function writeHelp(caller) {
902: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
903: caller.document.close()
904: caller.focus()
905: }
906: // ]]>
907: // END LON-CAPA Internal -->
908: </script>
909: ENDTEMPLATE
910: return $template;
911: }
912:
913: sub help_open_bug {
914: my ($topic, $text, $stayOnPage, $width, $height) = @_;
915: unless ($env{'user.adv'}) { return ''; }
916: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
917: $text = "" if (not defined $text);
918: $stayOnPage = 0 if (not defined $stayOnPage);
919: if ($env{'browser.interface'} eq 'textual' ||
920: $env{'environment.remote'} eq 'off' ) {
921: $stayOnPage=1;
922: }
923: $width = 600 if (not defined $width);
924: $height = 600 if (not defined $height);
925:
926: $topic=~s/\W+/\+/g;
927: my $link='';
928: my $template='';
929: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
930: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
931: if (!$stayOnPage)
932: {
933: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
934: }
935: else
936: {
937: $link = $url;
938: }
939: # Add the text
940: if ($text ne "")
941: {
942: $template .=
943: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
944: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
945: }
946:
947: # Add the graphic
948: my $title = &mt('Report a Bug');
949: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
950: $template .= <<"ENDTEMPLATE";
951: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
952: ENDTEMPLATE
953: if ($text ne '') { $template.='</td></tr></table>' };
954: return $template;
955:
956: }
957:
958: sub help_open_faq {
959: my ($topic, $text, $stayOnPage, $width, $height) = @_;
960: unless ($env{'user.adv'}) { return ''; }
961: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
962: $text = "" if (not defined $text);
963: $stayOnPage = 0 if (not defined $stayOnPage);
964: if ($env{'browser.interface'} eq 'textual' ||
965: $env{'environment.remote'} eq 'off' ) {
966: $stayOnPage=1;
967: }
968: $width = 350 if (not defined $width);
969: $height = 400 if (not defined $height);
970:
971: $topic=~s/\W+/\+/g;
972: my $link='';
973: my $template='';
974: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
975: if (!$stayOnPage)
976: {
977: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
978: }
979: else
980: {
981: $link = $url;
982: }
983:
984: # Add the text
985: if ($text ne "")
986: {
987: $template .=
988: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
989: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
990: }
991:
992: # Add the graphic
993: my $title = &mt('View the FAQ');
994: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
995: $template .= <<"ENDTEMPLATE";
996: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
997: ENDTEMPLATE
998: if ($text ne '') { $template.='</td></tr></table>' };
999: return $template;
1000:
1001: }
1002:
1003: ###############################################################
1004: ###############################################################
1005:
1006: =pod
1007:
1008: =item * change_content_javascript():
1009:
1010: This and the next function allow you to create small sections of an
1011: otherwise static HTML page that you can update on the fly with
1012: Javascript, even in Netscape 4.
1013:
1014: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1015: must be written to the HTML page once. It will prove the Javascript
1016: function "change(name, content)". Calling the change function with the
1017: name of the section
1018: you want to update, matching the name passed to C<changable_area>, and
1019: the new content you want to put in there, will put the content into
1020: that area.
1021:
1022: B<Note>: Netscape 4 only reserves enough space for the changable area
1023: to contain room for the original contents. You need to "make space"
1024: for whatever changes you wish to make, and be B<sure> to check your
1025: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1026: it's adequate for updating a one-line status display, but little more.
1027: This script will set the space to 100% width, so you only need to
1028: worry about height in Netscape 4.
1029:
1030: Modern browsers are much less limiting, and if you can commit to the
1031: user not using Netscape 4, this feature may be used freely with
1032: pretty much any HTML.
1033:
1034: =cut
1035:
1036: sub change_content_javascript {
1037: # If we're on Netscape 4, we need to use Layer-based code
1038: if ($env{'browser.type'} eq 'netscape' &&
1039: $env{'browser.version'} =~ /^4\./) {
1040: return (<<NETSCAPE4);
1041: function change(name, content) {
1042: doc = document.layers[name+"___escape"].layers[0].document;
1043: doc.open();
1044: doc.write(content);
1045: doc.close();
1046: }
1047: NETSCAPE4
1048: } else {
1049: # Otherwise, we need to use semi-standards-compliant code
1050: # (technically, "innerHTML" isn't standard but the equivalent
1051: # is really scary, and every useful browser supports it
1052: return (<<DOMBASED);
1053: function change(name, content) {
1054: element = document.getElementById(name);
1055: element.innerHTML = content;
1056: }
1057: DOMBASED
1058: }
1059: }
1060:
1061: =pod
1062:
1063: =item * changable_area($name, $origContent):
1064:
1065: This provides a "changable area" that can be modified on the fly via
1066: the Javascript code provided in C<change_content_javascript>. $name is
1067: the name you will use to reference the area later; do not repeat the
1068: same name on a given HTML page more then once. $origContent is what
1069: the area will originally contain, which can be left blank.
1070:
1071: =cut
1072:
1073: sub changable_area {
1074: my ($name, $origContent) = @_;
1075:
1076: if ($env{'browser.type'} eq 'netscape' &&
1077: $env{'browser.version'} =~ /^4\./) {
1078: # If this is netscape 4, we need to use the Layer tag
1079: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1080: } else {
1081: return "<span id='$name'>$origContent</span>";
1082: }
1083: }
1084:
1085: =pod
1086:
1087: =back
1088:
1089: =head1 Excel and CSV file utility routines
1090:
1091: =over 4
1092:
1093: =cut
1094:
1095: ###############################################################
1096: ###############################################################
1097:
1098: =pod
1099:
1100: =item * csv_translate($text)
1101:
1102: Translate $text to allow it to be output as a 'comma separated values'
1103: format.
1104:
1105: =cut
1106:
1107: ###############################################################
1108: ###############################################################
1109: sub csv_translate {
1110: my $text = shift;
1111: $text =~ s/\"/\"\"/g;
1112: $text =~ s/\n/ /g;
1113: return $text;
1114: }
1115:
1116: ###############################################################
1117: ###############################################################
1118:
1119: =pod
1120:
1121: =item * define_excel_formats
1122:
1123: Define some commonly used Excel cell formats.
1124:
1125: Currently supported formats:
1126:
1127: =over 4
1128:
1129: =item header
1130:
1131: =item bold
1132:
1133: =item h1
1134:
1135: =item h2
1136:
1137: =item h3
1138:
1139: =item h4
1140:
1141: =item i
1142:
1143: =item date
1144:
1145: =back
1146:
1147: Inputs: $workbook
1148:
1149: Returns: $format, a hash reference.
1150:
1151: =cut
1152:
1153: ###############################################################
1154: ###############################################################
1155: sub define_excel_formats {
1156: my ($workbook) = @_;
1157: my $format;
1158: $format->{'header'} = $workbook->add_format(bold => 1,
1159: bottom => 1,
1160: align => 'center');
1161: $format->{'bold'} = $workbook->add_format(bold=>1);
1162: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1163: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1164: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1165: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1166: $format->{'i'} = $workbook->add_format(italic=>1);
1167: $format->{'date'} = $workbook->add_format(num_format=>
1168: 'mm/dd/yyyy hh:mm:ss');
1169: return $format;
1170: }
1171:
1172: ###############################################################
1173: ###############################################################
1174:
1175: =pod
1176:
1177: =item * create_workbook
1178:
1179: Create an Excel worksheet. If it fails, output message on the
1180: request object and return undefs.
1181:
1182: Inputs: Apache request object
1183:
1184: Returns (undef) on failure,
1185: Excel worksheet object, scalar with filename, and formats
1186: from &Apache::loncommon::define_excel_formats on success
1187:
1188: =cut
1189:
1190: ###############################################################
1191: ###############################################################
1192: sub create_workbook {
1193: my ($r) = @_;
1194: #
1195: # Create the excel spreadsheet
1196: my $filename = '/prtspool/'.
1197: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1198: time.'_'.rand(1000000000).'.xls';
1199: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1200: if (! defined($workbook)) {
1201: $r->log_error("Error creating excel spreadsheet $filename: $!");
1202: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1203: "This error has been logged. ".
1204: "Please alert your LON-CAPA administrator").
1205: '</p>');
1206: return (undef);
1207: }
1208: #
1209: $workbook->set_tempdir('/home/httpd/perl/tmp');
1210: #
1211: my $format = &Apache::loncommon::define_excel_formats($workbook);
1212: return ($workbook,$filename,$format);
1213: }
1214:
1215: ###############################################################
1216: ###############################################################
1217:
1218: =pod
1219:
1220: =item * create_text_file
1221:
1222: Create a file to write to and eventually make available to the user.
1223: If file creation fails, outputs an error message on the request object and
1224: return undefs.
1225:
1226: Inputs: Apache request object, and file suffix
1227:
1228: Returns (undef) on failure,
1229: Filehandle and filename on success.
1230:
1231: =cut
1232:
1233: ###############################################################
1234: ###############################################################
1235: sub create_text_file {
1236: my ($r,$suffix) = @_;
1237: if (! defined($suffix)) { $suffix = 'txt'; };
1238: my $fh;
1239: my $filename = '/prtspool/'.
1240: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1241: time.'_'.rand(1000000000).'.'.$suffix;
1242: $fh = Apache::File->new('>/home/httpd'.$filename);
1243: if (! defined($fh)) {
1244: $r->log_error("Couldn't open $filename for output $!");
1245: $r->print("Problems occured in creating the output file. ".
1246: "This error has been logged. ".
1247: "Please alert your LON-CAPA administrator.");
1248: }
1249: return ($fh,$filename)
1250: }
1251:
1252:
1253: =pod
1254:
1255: =back
1256:
1257: =cut
1258:
1259: ###############################################################
1260: ## Home server <option> list generating code ##
1261: ###############################################################
1262:
1263: # ------------------------------------------
1264:
1265: sub domain_select {
1266: my ($name,$value,$multiple)=@_;
1267: my %domains=map {
1268: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1269: } &Apache::lonnet::all_domains();
1270: if ($multiple) {
1271: $domains{''}=&mt('Any domain');
1272: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1273: return &multiple_select_form($name,$value,4,\%domains);
1274: } else {
1275: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1276: return &select_form($name,$value,%domains);
1277: }
1278: }
1279:
1280: #-------------------------------------------
1281:
1282: =pod
1283:
1284: =head1 Routines for form select boxes
1285:
1286: =over 4
1287:
1288: =cut
1289:
1290: =item * multiple_select_form($name,$value,$size,$hash,$order)
1291:
1292: Returns a string containing a <select> element int multiple mode
1293:
1294:
1295: Args:
1296: $name - name of the <select> element
1297: $value - scalar or array ref of values that should already be selected
1298: $size - number of rows long the select element is
1299: $hash - the elements should be 'option' => 'shown text'
1300: (shown text should already have been &mt())
1301: $order - (optional) array ref of the order to show the elements in
1302:
1303: =cut
1304:
1305: #-------------------------------------------
1306: sub multiple_select_form {
1307: my ($name,$value,$size,$hash,$order)=@_;
1308: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1309: my $output='';
1310: if (! defined($size)) {
1311: $size = 4;
1312: if (scalar(keys(%$hash))<4) {
1313: $size = scalar(keys(%$hash));
1314: }
1315: }
1316: $output.="\n<select name='$name' size='$size' multiple='1'>";
1317: my @order;
1318: if (ref($order) eq 'ARRAY') {
1319: @order = @{$order};
1320: } else {
1321: @order = sort(keys(%$hash));
1322: }
1323: if (exists($$hash{'select_form_order'})) {
1324: @order = @{$$hash{'select_form_order'}};
1325: }
1326:
1327: foreach my $key (@order) {
1328: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1329: $output.='selected="selected" ' if ($selected{$key});
1330: $output.='>'.$hash->{$key}."</option>\n";
1331: }
1332: $output.="</select>\n";
1333: return $output;
1334: }
1335:
1336: #-------------------------------------------
1337:
1338: =pod
1339:
1340: =item * select_form($defdom,$name,%hash)
1341:
1342: Returns a string containing a <select name='$name' size='1'> form to
1343: allow a user to select options from a hash option_name => displayed text.
1344: See lonrights.pm for an example invocation and use.
1345:
1346: =cut
1347:
1348: #-------------------------------------------
1349: sub select_form {
1350: my ($def,$name,%hash) = @_;
1351: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1352: my @keys;
1353: if (exists($hash{'select_form_order'})) {
1354: @keys=@{$hash{'select_form_order'}};
1355: } else {
1356: @keys=sort(keys(%hash));
1357: }
1358: foreach my $key (@keys) {
1359: $selectform.=
1360: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1361: ($key eq $def ? 'selected="selected" ' : '').
1362: ">".&mt($hash{$key})."</option>\n";
1363: }
1364: $selectform.="</select>";
1365: return $selectform;
1366: }
1367:
1368: # For display filters
1369:
1370: sub display_filter {
1371: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1372: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1373: return '<nobr><label>'.&mt('Records [_1]',
1374: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1375: (&mt('all'),10,20,50,100,1000,10000))).
1376: '</label></nobr> <nobr>'.
1377: &mt('Filter [_1]',
1378: &select_form($env{'form.displayfilter'},
1379: 'displayfilter',
1380: ('currentfolder' => 'Current folder/page',
1381: 'containing' => 'Containing phrase',
1382: 'none' => 'None'))).
1383: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1384: }
1385:
1386: sub gradeleveldescription {
1387: my $gradelevel=shift;
1388: my %gradelevels=(0 => 'Not specified',
1389: 1 => 'Grade 1',
1390: 2 => 'Grade 2',
1391: 3 => 'Grade 3',
1392: 4 => 'Grade 4',
1393: 5 => 'Grade 5',
1394: 6 => 'Grade 6',
1395: 7 => 'Grade 7',
1396: 8 => 'Grade 8',
1397: 9 => 'Grade 9',
1398: 10 => 'Grade 10',
1399: 11 => 'Grade 11',
1400: 12 => 'Grade 12',
1401: 13 => 'Grade 13',
1402: 14 => '100 Level',
1403: 15 => '200 Level',
1404: 16 => '300 Level',
1405: 17 => '400 Level',
1406: 18 => 'Graduate Level');
1407: return &mt($gradelevels{$gradelevel});
1408: }
1409:
1410: sub select_level_form {
1411: my ($deflevel,$name)=@_;
1412: unless ($deflevel) { $deflevel=0; }
1413: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1414: for (my $i=0; $i<=18; $i++) {
1415: $selectform.="<option value=\"$i\" ".
1416: ($i==$deflevel ? 'selected="selected" ' : '').
1417: ">".&gradeleveldescription($i)."</option>\n";
1418: }
1419: $selectform.="</select>";
1420: return $selectform;
1421: }
1422:
1423: #-------------------------------------------
1424:
1425: =pod
1426:
1427: =item * select_dom_form($defdom,$name,$includeempty)
1428:
1429: Returns a string containing a <select name='$name' size='1'> form to
1430: allow a user to select the domain to preform an operation in.
1431: See loncreateuser.pm for an example invocation and use.
1432:
1433: If the $includeempty flag is set, it also includes an empty choice ("no domain
1434: selected");
1435:
1436: =cut
1437:
1438: #-------------------------------------------
1439: sub select_dom_form {
1440: my ($defdom,$name,$includeempty) = @_;
1441: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1442: if ($includeempty) { @domains=('',@domains); }
1443: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1444: foreach my $dom (@domains) {
1445: $selectdomain.="<option value=\"$dom\" ".
1446: ($dom eq $defdom ? 'selected="selected" ' : '').
1447: ">$dom</option>\n";
1448: }
1449: $selectdomain.="</select>";
1450: return $selectdomain;
1451: }
1452:
1453: #-------------------------------------------
1454:
1455: =pod
1456:
1457: =item * home_server_option_list($domain)
1458:
1459: returns a string which contains an <option> list to be used in a
1460: <select> form input. See loncreateuser.pm for an example.
1461:
1462: =cut
1463:
1464: #-------------------------------------------
1465: sub home_server_option_list {
1466: my $domain = shift;
1467: my %servers = &Apache::lonnet::get_servers($domain,'library');
1468: my $result = '';
1469: foreach my $hostid (sort(keys(%servers))) {
1470: $result.=
1471: '<option value="'.$hostid.'">'.
1472: $hostid.' '.$servers{$hostid}."</option>\n";
1473: }
1474: return $result;
1475: }
1476:
1477: =pod
1478:
1479: =back
1480:
1481: =cut
1482:
1483: ###############################################################
1484: ## Decoding User Agent ##
1485: ###############################################################
1486:
1487: =pod
1488:
1489: =head1 Decoding the User Agent
1490:
1491: =over 4
1492:
1493: =item * &decode_user_agent()
1494:
1495: Inputs: $r
1496:
1497: Outputs:
1498:
1499: =over 4
1500:
1501: =item * $httpbrowser
1502:
1503: =item * $clientbrowser
1504:
1505: =item * $clientversion
1506:
1507: =item * $clientmathml
1508:
1509: =item * $clientunicode
1510:
1511: =item * $clientos
1512:
1513: =back
1514:
1515: =back
1516:
1517: =cut
1518:
1519: ###############################################################
1520: ###############################################################
1521: sub decode_user_agent {
1522: my ($r)=@_;
1523: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1524: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1525: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1526: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1527: my $clientbrowser='unknown';
1528: my $clientversion='0';
1529: my $clientmathml='';
1530: my $clientunicode='0';
1531: for (my $i=0;$i<=$#browsertype;$i++) {
1532: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1533: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1534: $clientbrowser=$bname;
1535: $httpbrowser=~/$vreg/i;
1536: $clientversion=$1;
1537: $clientmathml=($clientversion>=$minv);
1538: $clientunicode=($clientversion>=$univ);
1539: }
1540: }
1541: my $clientos='unknown';
1542: if (($httpbrowser=~/linux/i) ||
1543: ($httpbrowser=~/unix/i) ||
1544: ($httpbrowser=~/ux/i) ||
1545: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1546: if (($httpbrowser=~/vax/i) ||
1547: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1548: if ($httpbrowser=~/next/i) { $clientos='next'; }
1549: if (($httpbrowser=~/mac/i) ||
1550: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1551: if ($httpbrowser=~/win/i) { $clientos='win'; }
1552: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1553: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1554: $clientunicode,$clientos,);
1555: }
1556:
1557: ###############################################################
1558: ## Authentication changing form generation subroutines ##
1559: ###############################################################
1560: ##
1561: ## All of the authform_xxxxxxx subroutines take their inputs in a
1562: ## hash, and have reasonable default values.
1563: ##
1564: ## formname = the name given in the <form> tag.
1565: #-------------------------------------------
1566:
1567: =pod
1568:
1569: =head1 Authentication Routines
1570:
1571: =over 4
1572:
1573: =item * authform_xxxxxx
1574:
1575: The authform_xxxxxx subroutines provide javascript and html forms which
1576: handle some of the conveniences required for authentication forms.
1577: This is not an optimal method, but it works.
1578:
1579: See loncreateuser.pm for invocation and use examples.
1580:
1581: =over 4
1582:
1583: =item * authform_header
1584:
1585: =item * authform_authorwarning
1586:
1587: =item * authform_nochange
1588:
1589: =item * authform_kerberos
1590:
1591: =item * authform_internal
1592:
1593: =item * authform_filesystem
1594:
1595: =back
1596:
1597: =back
1598:
1599: =cut
1600:
1601: #-------------------------------------------
1602: sub authform_header{
1603: my %in = (
1604: formname => 'cu',
1605: kerb_def_dom => '',
1606: @_,
1607: );
1608: $in{'formname'} = 'document.' . $in{'formname'};
1609: my $result='';
1610:
1611: #---------------------------------------------- Code for upper case translation
1612: my $Javascript_toUpperCase;
1613: unless ($in{kerb_def_dom}) {
1614: $Javascript_toUpperCase =<<"END";
1615: switch (choice) {
1616: case 'krb': currentform.elements[choicearg].value =
1617: currentform.elements[choicearg].value.toUpperCase();
1618: break;
1619: default:
1620: }
1621: END
1622: } else {
1623: $Javascript_toUpperCase = "";
1624: }
1625:
1626: my $radioval = "'nochange'";
1627: if (exists($in{'curr_authtype'}) &&
1628: defined($in{'curr_authtype'}) &&
1629: $in{'curr_authtype'} ne '') {
1630: $radioval = "'$in{'curr_authtype'}arg'";
1631: }
1632: my $argfield = 'null';
1633: if ( grep/^mode$/,(keys %in) ) {
1634: if ($in{'mode'} eq 'modifycourse') {
1635: if ( grep/^curr_authtype$/,(keys %in) ) {
1636: $radioval = "'$in{'curr_authtype'}'";
1637: }
1638: if ( grep/^curr_autharg$/,(keys %in) ) {
1639: unless ($in{'curr_autharg'} eq '') {
1640: $argfield = "'$in{'curr_autharg'}'";
1641: }
1642: }
1643: }
1644: }
1645:
1646: $result.=<<"END";
1647: var current = new Object();
1648: current.radiovalue = $radioval;
1649: current.argfield = $argfield;
1650:
1651: function changed_radio(choice,currentform) {
1652: var choicearg = choice + 'arg';
1653: // If a radio button in changed, we need to change the argfield
1654: if (current.radiovalue != choice) {
1655: current.radiovalue = choice;
1656: if (current.argfield != null) {
1657: currentform.elements[current.argfield].value = '';
1658: }
1659: if (choice == 'nochange') {
1660: current.argfield = null;
1661: } else {
1662: current.argfield = choicearg;
1663: switch(choice) {
1664: case 'krb':
1665: currentform.elements[current.argfield].value =
1666: "$in{'kerb_def_dom'}";
1667: break;
1668: default:
1669: break;
1670: }
1671: }
1672: }
1673: return;
1674: }
1675:
1676: function changed_text(choice,currentform) {
1677: var choicearg = choice + 'arg';
1678: if (currentform.elements[choicearg].value !='') {
1679: $Javascript_toUpperCase
1680: // clear old field
1681: if ((current.argfield != choicearg) && (current.argfield != null)) {
1682: currentform.elements[current.argfield].value = '';
1683: }
1684: current.argfield = choicearg;
1685: }
1686: set_auth_radio_buttons(choice,currentform);
1687: return;
1688: }
1689:
1690: function set_auth_radio_buttons(newvalue,currentform) {
1691: var i=0;
1692: while (i < currentform.login.length) {
1693: if (currentform.login[i].value == newvalue) { break; }
1694: i++;
1695: }
1696: if (i == currentform.login.length) {
1697: return;
1698: }
1699: current.radiovalue = newvalue;
1700: currentform.login[i].checked = true;
1701: return;
1702: }
1703: END
1704: return $result;
1705: }
1706:
1707: sub authform_authorwarning{
1708: my $result='';
1709: $result='<i>'.
1710: &mt('As a general rule, only authors or co-authors should be '.
1711: 'filesystem authenticated '.
1712: '(which allows access to the server filesystem).')."</i>\n";
1713: return $result;
1714: }
1715:
1716: sub authform_nochange{
1717: my %in = (
1718: formname => 'document.cu',
1719: kerb_def_dom => 'MSU.EDU',
1720: @_,
1721: );
1722: my $result = '<label>'.&mt('[_1] Do not change login data',
1723: '<input type="radio" name="login" value="nochange" '.
1724: 'checked="checked" onclick="'.
1725: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1726: '</label>';
1727: return $result;
1728: }
1729:
1730: sub authform_kerberos{
1731: my %in = (
1732: formname => 'document.cu',
1733: kerb_def_dom => 'MSU.EDU',
1734: kerb_def_auth => 'krb4',
1735: @_,
1736: );
1737: my ($check4,$check5,$krbarg);
1738: if ($in{'kerb_def_auth'} eq 'krb5') {
1739: $check5 = " checked=\"on\"";
1740: } else {
1741: $check4 = " checked=\"on\"";
1742: }
1743: $krbarg = $in{'kerb_def_dom'};
1744:
1745: my $krbcheck = "";
1746: if ( grep/^curr_authtype$/,(keys %in) ) {
1747: if ($in{'curr_authtype'} =~ m/^krb/) {
1748: $krbcheck = " checked=\"on\"";
1749: if ( grep/^curr_autharg$/,(keys %in) ) {
1750: $krbarg = $in{'curr_autharg'};
1751: }
1752: }
1753: }
1754:
1755: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1756: my $result .= &mt
1757: ('[_1] Kerberos authenticated with domain [_2] '.
1758: '[_3] Version 4 [_4] Version 5 [_5]',
1759: '<label><input type="radio" name="login" value="krb" '.
1760: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1761: '</label><input type="text" size="10" name="krbarg" '.
1762: 'value="'.$krbarg.'" '.
1763: 'onchange="'.$jscall.'" />',
1764: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
1765: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
1766: '</label>');
1767: return $result;
1768: }
1769:
1770: sub authform_internal{
1771: my %args = (
1772: formname => 'document.cu',
1773: kerb_def_dom => 'MSU.EDU',
1774: @_,
1775: );
1776:
1777: my $intcheck = "";
1778: my $intarg = 'value=""';
1779: if ( grep/^curr_authtype$/,(keys %args) ) {
1780: if ($args{'curr_authtype'} eq 'int') {
1781: $intcheck = " checked=\"on\"";
1782: if ( grep/^curr_autharg$/,(keys %args) ) {
1783: $intarg = "value=\"$args{'curr_autharg'}\"";
1784: }
1785: }
1786: }
1787:
1788: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1789: my $result.=&mt
1790: ('[_1] Internally authenticated (with initial password [_2])',
1791: '<label><input type="radio" name="login" value="int" '.$intcheck.
1792: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1793: '</label><input type="text" size="10" name="intarg" '.$intarg.
1794: ' onchange="'.$jscall.'" />');
1795: return $result;
1796: }
1797:
1798: sub authform_local{
1799: my %in = (
1800: formname => 'document.cu',
1801: kerb_def_dom => 'MSU.EDU',
1802: @_,
1803: );
1804:
1805: my $loccheck = "";
1806: my $locarg = 'value=""';
1807: if ( grep/^curr_authtype$/,(keys %in) ) {
1808: if ($in{'curr_authtype'} eq 'loc') {
1809: $loccheck = " checked=\"on\"";
1810: if ( grep/^curr_autharg$/,(keys %in) ) {
1811: $locarg = "value=\"$in{'curr_autharg'}\"";
1812: }
1813: }
1814: }
1815:
1816: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1817: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1818: '<label><input type="radio" name="login" value="loc" '.$loccheck.
1819: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1820: '</label><input type="text" size="10" name="locarg" '.$locarg.
1821: ' onchange="'.$jscall.'" />');
1822: return $result;
1823: }
1824:
1825: sub authform_filesystem{
1826: my %in = (
1827: formname => 'document.cu',
1828: kerb_def_dom => 'MSU.EDU',
1829: @_,
1830: );
1831: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1832: my $result.= &mt
1833: ('[_1] Filesystem Authenticated (with initial password [_2])',
1834: '<label><input type="radio" name="login" value="fsys" '.
1835: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1836: '</label><input type="text" size="10" name="fsysarg" value="" '.
1837: 'onchange="'.$jscall.'" />');
1838: return $result;
1839: }
1840:
1841: ###############################################################
1842: ## Get Authentication Defaults for Domain ##
1843: ###############################################################
1844:
1845: =pod
1846:
1847: =head1 Domains and Authentication
1848:
1849: Returns default authentication type and an associated argument as
1850: listed in file 'domain.tab'.
1851:
1852: =over 4
1853:
1854: =item * get_auth_defaults
1855:
1856: get_auth_defaults($target_domain) returns the default authentication
1857: type and an associated argument (initial password or a kerberos domain).
1858: These values are stored in lonTabs/domain.tab
1859:
1860: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1861:
1862: If target_domain is not found in domain.tab, returns nothing ('').
1863:
1864: =cut
1865:
1866: #-------------------------------------------
1867: sub get_auth_defaults {
1868: my $domain=shift;
1869: return (&Apache::lonnet::domain($domain,'auth_def'),
1870: &Apache::lonnet::domain($domain,'auth_arg_def'));
1871:
1872: }
1873: ###############################################################
1874: ## End Get Authentication Defaults for Domain ##
1875: ###############################################################
1876:
1877: ###############################################################
1878: ## Get Kerberos Defaults for Domain ##
1879: ###############################################################
1880: ##
1881: ## Returns default kerberos version and an associated argument
1882: ## as listed in file domain.tab. If not listed, provides
1883: ## appropriate default domain and kerberos version.
1884: ##
1885: #-------------------------------------------
1886:
1887: =pod
1888:
1889: =item * get_kerberos_defaults
1890:
1891: get_kerberos_defaults($target_domain) returns the default kerberos
1892: version and domain. If not found in domain.tabs, it defaults to
1893: version 4 and the domain of the server.
1894:
1895: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1896:
1897: =cut
1898:
1899: #-------------------------------------------
1900: sub get_kerberos_defaults {
1901: my $domain=shift;
1902: my ($krbdef,$krbdefdom) =
1903: &Apache::loncommon::get_auth_defaults($domain);
1904: unless ($krbdef =~/^krb/ && $krbdefdom) {
1905: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1906: my $krbdefdom=$1;
1907: $krbdefdom=~tr/a-z/A-Z/;
1908: $krbdef = "krb4";
1909: }
1910: return ($krbdef,$krbdefdom);
1911: }
1912:
1913: =pod
1914:
1915: =back
1916:
1917: =cut
1918:
1919: ###############################################################
1920: ## Thesaurus Functions ##
1921: ###############################################################
1922:
1923: =pod
1924:
1925: =head1 Thesaurus Functions
1926:
1927: =over 4
1928:
1929: =item * initialize_keywords
1930:
1931: Initializes the package variable %Keywords if it is empty. Uses the
1932: package variable $thesaurus_db_file.
1933:
1934: =cut
1935:
1936: ###################################################
1937:
1938: sub initialize_keywords {
1939: return 1 if (scalar keys(%Keywords));
1940: # If we are here, %Keywords is empty, so fill it up
1941: # Make sure the file we need exists...
1942: if (! -e $thesaurus_db_file) {
1943: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
1944: " failed because it does not exist");
1945: return 0;
1946: }
1947: # Set up the hash as a database
1948: my %thesaurus_db;
1949: if (! tie(%thesaurus_db,'GDBM_File',
1950: $thesaurus_db_file,&GDBM_READER(),0640)){
1951: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
1952: $thesaurus_db_file);
1953: return 0;
1954: }
1955: # Get the average number of appearances of a word.
1956: my $avecount = $thesaurus_db{'average.count'};
1957: # Put keywords (those that appear > average) into %Keywords
1958: while (my ($word,$data)=each (%thesaurus_db)) {
1959: my ($count,undef) = split /:/,$data;
1960: $Keywords{$word}++ if ($count > $avecount);
1961: }
1962: untie %thesaurus_db;
1963: # Remove special values from %Keywords.
1964: foreach my $value ('total.count','average.count') {
1965: delete($Keywords{$value}) if (exists($Keywords{$value}));
1966: }
1967: return 1;
1968: }
1969:
1970: ###################################################
1971:
1972: =pod
1973:
1974: =item * keyword($word)
1975:
1976: Returns true if $word is a keyword. A keyword is a word that appears more
1977: than the average number of times in the thesaurus database. Calls
1978: &initialize_keywords
1979:
1980: =cut
1981:
1982: ###################################################
1983:
1984: sub keyword {
1985: return if (!&initialize_keywords());
1986: my $word=lc(shift());
1987: $word=~s/\W//g;
1988: return exists($Keywords{$word});
1989: }
1990:
1991: ###############################################################
1992:
1993: =pod
1994:
1995: =item * get_related_words
1996:
1997: Look up a word in the thesaurus. Takes a scalar argument and returns
1998: an array of words. If the keyword is not in the thesaurus, an empty array
1999: will be returned. The order of the words returned is determined by the
2000: database which holds them.
2001:
2002: Uses global $thesaurus_db_file.
2003:
2004: =cut
2005:
2006: ###############################################################
2007: sub get_related_words {
2008: my $keyword = shift;
2009: my %thesaurus_db;
2010: if (! -e $thesaurus_db_file) {
2011: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2012: "failed because the file does not exist");
2013: return ();
2014: }
2015: if (! tie(%thesaurus_db,'GDBM_File',
2016: $thesaurus_db_file,&GDBM_READER(),0640)){
2017: return ();
2018: }
2019: my @Words=();
2020: my $count=0;
2021: if (exists($thesaurus_db{$keyword})) {
2022: # The first element is the number of times
2023: # the word appears. We do not need it now.
2024: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2025: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2026: my $threshold=$mostfrequentcount/10;
2027: foreach my $possibleword (@RelatedWords) {
2028: my ($word,$wordcount)=split(/\,/,$possibleword);
2029: if ($wordcount>$threshold) {
2030: push(@Words,$word);
2031: $count++;
2032: if ($count>10) { last; }
2033: }
2034: }
2035: }
2036: untie %thesaurus_db;
2037: return @Words;
2038: }
2039:
2040: =pod
2041:
2042: =back
2043:
2044: =cut
2045:
2046: # -------------------------------------------------------------- Plaintext name
2047: =pod
2048:
2049: =head1 User Name Functions
2050:
2051: =over 4
2052:
2053: =item * plainname($uname,$udom,$first)
2054:
2055: Takes a users logon name and returns it as a string in
2056: "first middle last generation" form
2057: if $first is set to 'lastname' then it returns it as
2058: 'lastname generation, firstname middlename' if their is a lastname
2059:
2060: =cut
2061:
2062:
2063: ###############################################################
2064: sub plainname {
2065: my ($uname,$udom,$first)=@_;
2066: return if (!defined($uname) || !defined($udom));
2067: my %names=&getnames($uname,$udom);
2068: my $name=&Apache::lonnet::format_name($names{'firstname'},
2069: $names{'middlename'},
2070: $names{'lastname'},
2071: $names{'generation'},$first);
2072: $name=~s/^\s+//;
2073: $name=~s/\s+$//;
2074: $name=~s/\s+/ /g;
2075: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
2076: return $name;
2077: }
2078:
2079: # -------------------------------------------------------------------- Nickname
2080: =pod
2081:
2082: =item * nickname($uname,$udom)
2083:
2084: Gets a users name and returns it as a string as
2085:
2086: ""nickname""
2087:
2088: if the user has a nickname or
2089:
2090: "first middle last generation"
2091:
2092: if the user does not
2093:
2094: =cut
2095:
2096: sub nickname {
2097: my ($uname,$udom)=@_;
2098: return if (!defined($uname) || !defined($udom));
2099: my %names=&getnames($uname,$udom);
2100: my $name=$names{'nickname'};
2101: if ($name) {
2102: $name='"'.$name.'"';
2103: } else {
2104: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2105: $names{'lastname'}.' '.$names{'generation'};
2106: $name=~s/\s+$//;
2107: $name=~s/\s+/ /g;
2108: }
2109: return $name;
2110: }
2111:
2112: sub getnames {
2113: my ($uname,$udom)=@_;
2114: return if (!defined($uname) || !defined($udom));
2115: if ($udom eq 'public' && $uname eq 'public') {
2116: return ('lastname' => &mt('Public'));
2117: }
2118: my $id=$uname.':'.$udom;
2119: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2120: if ($cached) {
2121: return %{$names};
2122: } else {
2123: my %loadnames=&Apache::lonnet::get('environment',
2124: ['firstname','middlename','lastname','generation','nickname'],
2125: $udom,$uname);
2126: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2127: return %loadnames;
2128: }
2129: }
2130:
2131: # -------------------------------------------------------------------- getemails
2132: =pod
2133:
2134: =item * getemails($uname,$udom)
2135:
2136: Gets a user's email information and returns it as a hash with keys:
2137: notification, critnotification, permanentemail
2138:
2139: For notification and critnotification, values are comma-separated lists
2140: of e-mail address(es); for permanentemail, value is a single e-mail address.
2141:
2142: =cut
2143:
2144: sub getemails {
2145: my ($uname,$udom)=@_;
2146: if ($udom eq 'public' && $uname eq 'public') {
2147: return;
2148: }
2149: if (!$udom) { $udom=$env{'user.domain'}; }
2150: if (!$uname) { $uname=$env{'user.name'}; }
2151: my $id=$uname.':'.$udom;
2152: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2153: if ($cached) {
2154: return %{$names};
2155: } else {
2156: my %loadnames=&Apache::lonnet::get('environment',
2157: ['notification','critnotification',
2158: 'permanentemail'],
2159: $udom,$uname);
2160: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2161: return %loadnames;
2162: }
2163: }
2164:
2165: sub flush_email_cache {
2166: my ($uname,$udom)=@_;
2167: if (!$udom) { $udom =$env{'user.domain'}; }
2168: if (!$uname) { $uname=$env{'user.name'}; }
2169: return if ($udom eq 'public' && $uname eq 'public');
2170: my $id=$uname.':'.$udom;
2171: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2172: }
2173:
2174: # ------------------------------------------------------------------ Screenname
2175:
2176: =pod
2177:
2178: =item * screenname($uname,$udom)
2179:
2180: Gets a users screenname and returns it as a string
2181:
2182: =cut
2183:
2184: sub screenname {
2185: my ($uname,$udom)=@_;
2186: if ($uname eq $env{'user.name'} &&
2187: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
2188: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
2189: return $names{'screenname'};
2190: }
2191:
2192:
2193: # ------------------------------------------------------------- Message Wrapper
2194:
2195: sub messagewrapper {
2196: my ($link,$username,$domain,$subject,$text)=@_;
2197: return
2198: '<a href="/adm/email?compose=individual&'.
2199: 'recname='.$username.'&recdom='.$domain.
2200: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
2201: 'title="'.&mt('Send message').'">'.$link.'</a>';
2202: }
2203: # --------------------------------------------------------------- Notes Wrapper
2204:
2205: sub noteswrapper {
2206: my ($link,$un,$do)=@_;
2207: return
2208: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
2209: }
2210: # ------------------------------------------------------------- Aboutme Wrapper
2211:
2212: sub aboutmewrapper {
2213: my ($link,$username,$domain,$target)=@_;
2214: if (!defined($username) && !defined($domain)) {
2215: return;
2216: }
2217: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
2218: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
2219: }
2220:
2221: # ------------------------------------------------------------ Syllabus Wrapper
2222:
2223:
2224: sub syllabuswrapper {
2225: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2226: if ($fontcolor) {
2227: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2228: }
2229: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
2230: }
2231:
2232: sub track_student_link {
2233: my ($linktext,$sname,$sdom,$target,$start) = @_;
2234: my $link ="/adm/trackstudent?";
2235: my $title = 'View recent activity';
2236: if (defined($sname) && $sname !~ /^\s*$/ &&
2237: defined($sdom) && $sdom !~ /^\s*$/) {
2238: $link .= "selected_student=$sname:$sdom";
2239: $title .= ' of this student';
2240: }
2241: if (defined($target) && $target !~ /^\s*$/) {
2242: $target = qq{target="$target"};
2243: } else {
2244: $target = '';
2245: }
2246: if ($start) { $link.='&start='.$start; }
2247: $title = &mt($title);
2248: $linktext = &mt($linktext);
2249: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2250: &help_open_topic('View_recent_activity');
2251: }
2252:
2253: # ===================================================== Display a student photo
2254:
2255:
2256: sub student_image_tag {
2257: my ($domain,$user)=@_;
2258: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2259: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2260: return '<img src="'.$imgsrc.'" align="right" />';
2261: } else {
2262: return '';
2263: }
2264: }
2265:
2266: =pod
2267:
2268: =back
2269:
2270: =head1 Access .tab File Data
2271:
2272: =over 4
2273:
2274: =item * languageids()
2275:
2276: returns list of all language ids
2277:
2278: =cut
2279:
2280: sub languageids {
2281: return sort(keys(%language));
2282: }
2283:
2284: =pod
2285:
2286: =item * languagedescription()
2287:
2288: returns description of a specified language id
2289:
2290: =cut
2291:
2292: sub languagedescription {
2293: my $code=shift;
2294: return ($supported_language{$code}?'* ':'').
2295: $language{$code}.
2296: ($supported_language{$code}?' ('.&mt('interface available').')':'');
2297: }
2298:
2299: sub plainlanguagedescription {
2300: my $code=shift;
2301: return $language{$code};
2302: }
2303:
2304: sub supportedlanguagecode {
2305: my $code=shift;
2306: return $supported_language{$code};
2307: }
2308:
2309: =pod
2310:
2311: =item * copyrightids()
2312:
2313: returns list of all copyrights
2314:
2315: =cut
2316:
2317: sub copyrightids {
2318: return sort(keys(%cprtag));
2319: }
2320:
2321: =pod
2322:
2323: =item * copyrightdescription()
2324:
2325: returns description of a specified copyright id
2326:
2327: =cut
2328:
2329: sub copyrightdescription {
2330: return &mt($cprtag{shift(@_)});
2331: }
2332:
2333: =pod
2334:
2335: =item * source_copyrightids()
2336:
2337: returns list of all source copyrights
2338:
2339: =cut
2340:
2341: sub source_copyrightids {
2342: return sort(keys(%scprtag));
2343: }
2344:
2345: =pod
2346:
2347: =item * source_copyrightdescription()
2348:
2349: returns description of a specified source copyright id
2350:
2351: =cut
2352:
2353: sub source_copyrightdescription {
2354: return &mt($scprtag{shift(@_)});
2355: }
2356:
2357: =pod
2358:
2359: =item * filecategories()
2360:
2361: returns list of all file categories
2362:
2363: =cut
2364:
2365: sub filecategories {
2366: return sort(keys(%category_extensions));
2367: }
2368:
2369: =pod
2370:
2371: =item * filecategorytypes()
2372:
2373: returns list of file types belonging to a given file
2374: category
2375:
2376: =cut
2377:
2378: sub filecategorytypes {
2379: my ($cat) = @_;
2380: return @{$category_extensions{lc($cat)}};
2381: }
2382:
2383: =pod
2384:
2385: =item * fileembstyle()
2386:
2387: returns embedding style for a specified file type
2388:
2389: =cut
2390:
2391: sub fileembstyle {
2392: return $fe{lc(shift(@_))};
2393: }
2394:
2395: sub filemimetype {
2396: return $fm{lc(shift(@_))};
2397: }
2398:
2399:
2400: sub filecategoryselect {
2401: my ($name,$value)=@_;
2402: return &select_form($value,$name,
2403: '' => &mt('Any category'),
2404: map { $_,$_ } sort(keys(%category_extensions)));
2405: }
2406:
2407: =pod
2408:
2409: =item * filedescription()
2410:
2411: returns description for a specified file type
2412:
2413: =cut
2414:
2415: sub filedescription {
2416: my $file_description = $fd{lc(shift())};
2417: $file_description =~ s:([\[\]]):~$1:g;
2418: return &mt($file_description);
2419: }
2420:
2421: =pod
2422:
2423: =item * filedescriptionex()
2424:
2425: returns description for a specified file type with
2426: extra formatting
2427:
2428: =cut
2429:
2430: sub filedescriptionex {
2431: my $ex=shift;
2432: my $file_description = $fd{lc($ex)};
2433: $file_description =~ s:([\[\]]):~$1:g;
2434: return '.'.$ex.' '.&mt($file_description);
2435: }
2436:
2437: # End of .tab access
2438: =pod
2439:
2440: =back
2441:
2442: =cut
2443:
2444: # ------------------------------------------------------------------ File Types
2445: sub fileextensions {
2446: return sort(keys(%fe));
2447: }
2448:
2449: # ----------------------------------------------------------- Display Languages
2450: # returns a hash with all desired display languages
2451: #
2452:
2453: sub display_languages {
2454: my %languages=();
2455: foreach my $lang (&preferred_languages()) {
2456: $languages{$lang}=1;
2457: }
2458: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
2459: if ($env{'form.displaylanguage'}) {
2460: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
2461: $languages{$lang}=1;
2462: }
2463: }
2464: return %languages;
2465: }
2466:
2467: sub preferred_languages {
2468: my @languages=();
2469: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
2470: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
2471: $env{'course.'.$env{'request.course.id'}.'.languages'}));
2472: }
2473: if ($env{'environment.languages'}) {
2474: @languages=(@languages,
2475: split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
2476: }
2477: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2478: if ($browser) {
2479: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2480: }
2481: if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {
2482: @languages=(@languages,
2483: &Apache::lonnet::domain($env{'user.domain'},
2484: 'lang_def'));
2485: }
2486: if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
2487: @languages=(@languages,
2488: &Apache::lonnet::domain($env{'request.role.domain'},
2489: 'lang_def'));
2490: }
2491: if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2492: 'lang_def')) {
2493: @languages=(@languages,
2494: &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2495: 'lang_def'));
2496: }
2497: # turn "en-ca" into "en-ca,en"
2498: my @genlanguages;
2499: foreach my $lang (@languages) {
2500: unless ($lang=~/\w/) { next; }
2501: push (@genlanguages,$lang);
2502: if ($lang=~/(\-|\_)/) {
2503: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
2504: }
2505: }
2506: return @genlanguages;
2507: }
2508:
2509: ###############################################################
2510: ## Student Answer Attempts ##
2511: ###############################################################
2512:
2513: =pod
2514:
2515: =head1 Alternate Problem Views
2516:
2517: =over 4
2518:
2519: =item * get_previous_attempt($symb, $username, $domain, $course,
2520: $getattempt, $regexp, $gradesub)
2521:
2522: Return string with previous attempt on problem. Arguments:
2523:
2524: =over 4
2525:
2526: =item * $symb: Problem, including path
2527:
2528: =item * $username: username of the desired student
2529:
2530: =item * $domain: domain of the desired student
2531:
2532: =item * $course: Course ID
2533:
2534: =item * $getattempt: Leave blank for all attempts, otherwise put
2535: something
2536:
2537: =item * $regexp: if string matches this regexp, the string will be
2538: sent to $gradesub
2539:
2540: =item * $gradesub: routine that processes the string if it matches $regexp
2541:
2542: =back
2543:
2544: The output string is a table containing all desired attempts, if any.
2545:
2546: =cut
2547:
2548: sub get_previous_attempt {
2549: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
2550: my $prevattempts='';
2551: no strict 'refs';
2552: if ($symb) {
2553: my (%returnhash)=
2554: &Apache::lonnet::restore($symb,$course,$domain,$username);
2555: if ($returnhash{'version'}) {
2556: my %lasthash=();
2557: my $version;
2558: for ($version=1;$version<=$returnhash{'version'};$version++) {
2559: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2560: $lasthash{$key}=$returnhash{$version.':'.$key};
2561: }
2562: }
2563: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
2564: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
2565: foreach my $key (sort(keys(%lasthash))) {
2566: my ($ign,@parts) = split(/\./,$key);
2567: if ($#parts > 0) {
2568: my $data=$parts[-1];
2569: pop(@parts);
2570: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
2571: } else {
2572: if ($#parts == 0) {
2573: $prevattempts.='<th>'.$parts[0].'</th>';
2574: } else {
2575: $prevattempts.='<th>'.$ign.'</th>';
2576: }
2577: }
2578: }
2579: if ($getattempt eq '') {
2580: for ($version=1;$version<=$returnhash{'version'};$version++) {
2581: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
2582: foreach my $key (sort(keys(%lasthash))) {
2583: my $value;
2584: if ($key =~ /timestamp/) {
2585: $value=scalar(localtime($returnhash{$version.':'.$key}));
2586: } else {
2587: $value=$returnhash{$version.':'.$key};
2588: }
2589: $prevattempts.='<td>'.&unescape($value).' </td>';
2590: }
2591: }
2592: }
2593: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
2594: foreach my $key (sort(keys(%lasthash))) {
2595: my $value;
2596: if ($key =~ /timestamp/) {
2597: $value=scalar(localtime($lasthash{$key}));
2598: } else {
2599: $value=$lasthash{$key};
2600: }
2601: $value=&unescape($value);
2602: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
2603: $prevattempts.='<td>'.$value.' </td>';
2604: }
2605: $prevattempts.='</tr></table></td></tr></table>';
2606: } else {
2607: $prevattempts='Nothing submitted - no attempts.';
2608: }
2609: } else {
2610: $prevattempts='No data.';
2611: }
2612: }
2613:
2614: sub relative_to_absolute {
2615: my ($url,$output)=@_;
2616: my $parser=HTML::TokeParser->new(\$output);
2617: my $token;
2618: my $thisdir=$url;
2619: my @rlinks=();
2620: while ($token=$parser->get_token) {
2621: if ($token->[0] eq 'S') {
2622: if ($token->[1] eq 'a') {
2623: if ($token->[2]->{'href'}) {
2624: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2625: }
2626: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2627: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2628: } elsif ($token->[1] eq 'base') {
2629: $thisdir=$token->[2]->{'href'};
2630: }
2631: }
2632: }
2633: $thisdir=~s-/[^/]*$--;
2634: foreach my $link (@rlinks) {
2635: unless (($link=~/^http:\/\//i) ||
2636: ($link=~/^\//) ||
2637: ($link=~/^javascript:/i) ||
2638: ($link=~/^mailto:/i) ||
2639: ($link=~/^\#/)) {
2640: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
2641: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
2642: }
2643: }
2644: # -------------------------------------------------- Deal with Applet codebases
2645: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2646: return $output;
2647: }
2648:
2649: =pod
2650:
2651: =item * get_student_view
2652:
2653: show a snapshot of what student was looking at
2654:
2655: =cut
2656:
2657: sub get_student_view {
2658: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
2659: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
2660: my (%form);
2661: my @elements=('symb','courseid','domain','username');
2662: foreach my $element (@elements) {
2663: $form{'grade_'.$element}=eval '$'.$element #'
2664: }
2665: if (defined($moreenv)) {
2666: %form=(%form,%{$moreenv});
2667: }
2668: if (defined($target)) { $form{'grade_target'} = $target; }
2669: $feedurl=&Apache::lonnet::clutter($feedurl);
2670: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
2671: $userview=~s/\<body[^\>]*\>//gi;
2672: $userview=~s/\<\/body\>//gi;
2673: $userview=~s/\<html\>//gi;
2674: $userview=~s/\<\/html\>//gi;
2675: $userview=~s/\<head\>//gi;
2676: $userview=~s/\<\/head\>//gi;
2677: $userview=~s/action\s*\=/would_be_action\=/gi;
2678: $userview=&relative_to_absolute($feedurl,$userview);
2679: return $userview;
2680: }
2681:
2682: =pod
2683:
2684: =item * get_student_answers()
2685:
2686: show a snapshot of how student was answering problem
2687:
2688: =cut
2689:
2690: sub get_student_answers {
2691: my ($symb,$username,$domain,$courseid,%form) = @_;
2692: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
2693: my (%moreenv);
2694: my @elements=('symb','courseid','domain','username');
2695: foreach my $element (@elements) {
2696: $moreenv{'grade_'.$element}=eval '$'.$element #'
2697: }
2698: $moreenv{'grade_target'}='answer';
2699: %moreenv=(%form,%moreenv);
2700: $feedurl = &Apache::lonnet::clutter($feedurl);
2701: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
2702: return $userview;
2703: }
2704:
2705: =pod
2706:
2707: =item * &submlink()
2708:
2709: Inputs: $text $uname $udom $symb $target
2710:
2711: Returns: A link to grades.pm such as to see the SUBM view of a student
2712:
2713: =cut
2714:
2715: ###############################################
2716: sub submlink {
2717: my ($text,$uname,$udom,$symb,$target)=@_;
2718: if (!($uname && $udom)) {
2719: (my $cursymb, my $courseid,$udom,$uname)=
2720: &Apache::lonnet::whichuser($symb);
2721: if (!$symb) { $symb=$cursymb; }
2722: }
2723: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
2724: $symb=&escape($symb);
2725: if ($target) { $target="target=\"$target\""; }
2726: return '<a href="/adm/grades?&command=submission&'.
2727: 'symb='.$symb.'&student='.$uname.
2728: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2729: }
2730: ##############################################
2731:
2732: =pod
2733:
2734: =item * &pgrdlink()
2735:
2736: Inputs: $text $uname $udom $symb $target
2737:
2738: Returns: A link to grades.pm such as to see the PGRD view of a student
2739:
2740: =cut
2741:
2742: ###############################################
2743: sub pgrdlink {
2744: my $link=&submlink(@_);
2745: $link=~s/(&command=submission)/$1&showgrading=yes/;
2746: return $link;
2747: }
2748: ##############################################
2749:
2750: =pod
2751:
2752: =item * &pprmlink()
2753:
2754: Inputs: $text $uname $udom $symb $target
2755:
2756: Returns: A link to parmset.pm such as to see the PPRM view of a
2757: student and a specific resource
2758:
2759: =cut
2760:
2761: ###############################################
2762: sub pprmlink {
2763: my ($text,$uname,$udom,$symb,$target)=@_;
2764: if (!($uname && $udom)) {
2765: (my $cursymb, my $courseid,$udom,$uname)=
2766: &Apache::lonnet::whichuser($symb);
2767: if (!$symb) { $symb=$cursymb; }
2768: }
2769: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
2770: $symb=&escape($symb);
2771: if ($target) { $target="target=\"$target\""; }
2772: return '<a href="/adm/parmset?&command=set&'.
2773: 'symb='.$symb.'&uname='.$uname.
2774: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
2775: }
2776: ##############################################
2777:
2778: =pod
2779:
2780: =back
2781:
2782: =cut
2783:
2784: ###############################################
2785:
2786:
2787: sub timehash {
2788: my @ltime=localtime(shift);
2789: return ( 'seconds' => $ltime[0],
2790: 'minutes' => $ltime[1],
2791: 'hours' => $ltime[2],
2792: 'day' => $ltime[3],
2793: 'month' => $ltime[4]+1,
2794: 'year' => $ltime[5]+1900,
2795: 'weekday' => $ltime[6],
2796: 'dayyear' => $ltime[7]+1,
2797: 'dlsav' => $ltime[8] );
2798: }
2799:
2800: sub utc_string {
2801: my ($date)=@_;
2802: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
2803: }
2804:
2805: sub maketime {
2806: my %th=@_;
2807: return POSIX::mktime(
2808: ($th{'seconds'},$th{'minutes'},$th{'hours'},
2809: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
2810: }
2811:
2812: #########################################
2813:
2814: sub findallcourses {
2815: my ($roles,$uname,$udom) = @_;
2816: my %roles;
2817: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
2818: my %courses;
2819: my $now=time;
2820: if (!defined($uname)) {
2821: $uname = $env{'user.name'};
2822: }
2823: if (!defined($udom)) {
2824: $udom = $env{'user.domain'};
2825: }
2826: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
2827: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
2828: if (!%roles) {
2829: %roles = (
2830: cc => 1,
2831: in => 1,
2832: ep => 1,
2833: ta => 1,
2834: cr => 1,
2835: st => 1,
2836: );
2837: }
2838: foreach my $entry (keys(%roleshash)) {
2839: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
2840: if ($trole =~ /^cr/) {
2841: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
2842: } else {
2843: next if (!exists($roles{$trole}));
2844: }
2845: if ($tend) {
2846: next if ($tend < $now);
2847: }
2848: if ($tstart) {
2849: next if ($tstart > $now);
2850: }
2851: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
2852: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
2853: if ($secpart eq '') {
2854: ($cnum,$role) = split(/_/,$cnumpart);
2855: $sec = 'none';
2856: $realsec = '';
2857: } else {
2858: $cnum = $cnumpart;
2859: ($sec,$role) = split(/_/,$secpart);
2860: $realsec = $sec;
2861: }
2862: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
2863: }
2864: } else {
2865: foreach my $key (keys(%env)) {
2866: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
2867: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
2868: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
2869: next if ($role eq 'ca' || $role eq 'aa');
2870: next if (%roles && !exists($roles{$role}));
2871: my ($starttime,$endtime)=split(/\./,$env{$key});
2872: my $active=1;
2873: if ($starttime) {
2874: if ($now<$starttime) { $active=0; }
2875: }
2876: if ($endtime) {
2877: if ($now>$endtime) { $active=0; }
2878: }
2879: if ($active) {
2880: if ($sec eq '') {
2881: $sec = 'none';
2882: }
2883: $courses{$cdom.'_'.$cnum}{$sec} =
2884: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
2885: }
2886: }
2887: }
2888: }
2889: return %courses;
2890: }
2891:
2892: ###############################################
2893:
2894: sub blockcheck {
2895: my ($setters,$activity,$uname,$udom) = @_;
2896:
2897: if (!defined($udom)) {
2898: $udom = $env{'user.domain'};
2899: }
2900: if (!defined($uname)) {
2901: $uname = $env{'user.name'};
2902: }
2903:
2904: # If uname and udom are for a course, check for blocks in the course.
2905:
2906: if (&Apache::lonnet::is_course($udom,$uname)) {
2907: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
2908: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
2909: return ($startblock,$endblock);
2910: }
2911:
2912: my $startblock = 0;
2913: my $endblock = 0;
2914: my %live_courses = &findallcourses(undef,$uname,$udom);
2915:
2916: # If uname is for a user, and activity is course-specific, i.e.,
2917: # boards, chat or groups, check for blocking in current course only.
2918:
2919: if (($activity eq 'boards' || $activity eq 'chat' ||
2920: $activity eq 'groups') && ($env{'request.course.id'})) {
2921: foreach my $key (keys(%live_courses)) {
2922: if ($key ne $env{'request.course.id'}) {
2923: delete($live_courses{$key});
2924: }
2925: }
2926: }
2927:
2928: my $otheruser = 0;
2929: my %own_courses;
2930: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
2931: # Resource belongs to user other than current user.
2932: $otheruser = 1;
2933: # Gather courses for current user
2934: %own_courses =
2935: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
2936: }
2937:
2938: # Gather active course roles - course coordinator, instructor,
2939: # exam proctor, ta, student, or custom role.
2940:
2941: foreach my $course (keys(%live_courses)) {
2942: my ($cdom,$cnum);
2943: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
2944: $cdom = $env{'course.'.$course.'.domain'};
2945: $cnum = $env{'course.'.$course.'.num'};
2946: } else {
2947: ($cdom,$cnum) = split(/_/,$course);
2948: }
2949: my $no_ownblock = 0;
2950: my $no_userblock = 0;
2951: if ($otheruser && $activity ne 'com') {
2952: # Check if current user has 'evb' priv for this
2953: if (defined($own_courses{$course})) {
2954: foreach my $sec (keys(%{$own_courses{$course}})) {
2955: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
2956: if ($sec ne 'none') {
2957: $checkrole .= '/'.$sec;
2958: }
2959: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
2960: $no_ownblock = 1;
2961: last;
2962: }
2963: }
2964: }
2965: # if they have 'evb' priv and are currently not playing student
2966: next if (($no_ownblock) &&
2967: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
2968: }
2969: foreach my $sec (keys(%{$live_courses{$course}})) {
2970: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
2971: if ($sec ne 'none') {
2972: $checkrole .= '/'.$sec;
2973: }
2974: if ($otheruser) {
2975: # Resource belongs to user other than current user.
2976: # Assemble privs for that user, and check for 'evb' priv.
2977: my ($trole,$tdom,$tnum,$tsec);
2978: my $entry = $live_courses{$course}{$sec};
2979: if ($entry =~ /^cr/) {
2980: ($trole,$tdom,$tnum,$tsec) =
2981: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
2982: } else {
2983: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
2984: }
2985: my ($spec,$area,$trest,%allroles,%userroles);
2986: $area = '/'.$tdom.'/'.$tnum;
2987: $trest = $tnum;
2988: if ($tsec ne '') {
2989: $area .= '/'.$tsec;
2990: $trest .= '/'.$tsec;
2991: }
2992: $spec = $trole.'.'.$area;
2993: if ($trole =~ /^cr/) {
2994: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
2995: $tdom,$spec,$trest,$area);
2996: } else {
2997: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
2998: $tdom,$spec,$trest,$area);
2999: }
3000: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
3001: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3002: if ($1) {
3003: $no_userblock = 1;
3004: last;
3005: }
3006: }
3007: } else {
3008: # Resource belongs to current user
3009: # Check for 'evb' priv via lonnet::allowed().
3010: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3011: $no_ownblock = 1;
3012: last;
3013: }
3014: }
3015: }
3016: # if they have the evb priv and are currently not playing student
3017: next if (($no_ownblock) &&
3018: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
3019: next if ($no_userblock);
3020:
3021: # Retrieve blocking times and identity of blocker for course
3022: # of specified user, unless user has 'evb' privilege.
3023:
3024: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3025: if (($start != 0) &&
3026: (($startblock == 0) || ($startblock > $start))) {
3027: $startblock = $start;
3028: }
3029: if (($end != 0) &&
3030: (($endblock == 0) || ($endblock < $end))) {
3031: $endblock = $end;
3032: }
3033: }
3034: return ($startblock,$endblock);
3035: }
3036:
3037: sub get_blocks {
3038: my ($setters,$activity,$cdom,$cnum) = @_;
3039: my $startblock = 0;
3040: my $endblock = 0;
3041: my $course = $cdom.'_'.$cnum;
3042: $setters->{$course} = {};
3043: $setters->{$course}{'staff'} = [];
3044: $setters->{$course}{'times'} = [];
3045: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3046: foreach my $record (keys(%records)) {
3047: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3048: if ($start <= time && $end >= time) {
3049: my ($staff_name,$staff_dom,$title,$blocks) =
3050: &parse_block_record($records{$record});
3051: if ($blocks->{$activity} eq 'on') {
3052: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3053: push(@{$$setters{$course}{'times'}}, [$start,$end]);
3054: if ( ($startblock == 0) || ($startblock > $start) ) {
3055: $startblock = $start;
3056: }
3057: if ( ($endblock == 0) || ($endblock < $end) ) {
3058: $endblock = $end;
3059: }
3060: }
3061: }
3062: }
3063: return ($startblock,$endblock);
3064: }
3065:
3066: sub parse_block_record {
3067: my ($record) = @_;
3068: my ($setuname,$setudom,$title,$blocks);
3069: if (ref($record) eq 'HASH') {
3070: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3071: $title = &unescape($record->{'event'});
3072: $blocks = $record->{'blocks'};
3073: } else {
3074: my @data = split(/:/,$record,3);
3075: if (scalar(@data) eq 2) {
3076: $title = $data[1];
3077: ($setuname,$setudom) = split(/@/,$data[0]);
3078: } else {
3079: ($setuname,$setudom,$title) = @data;
3080: }
3081: $blocks = { 'com' => 'on' };
3082: }
3083: return ($setuname,$setudom,$title,$blocks);
3084: }
3085:
3086: sub build_block_table {
3087: my ($startblock,$endblock,$setters) = @_;
3088: my %lt = &Apache::lonlocal::texthash(
3089: 'cacb' => 'Currently active communication blocks',
3090: 'cour' => 'Course',
3091: 'dura' => 'Duration',
3092: 'blse' => 'Block set by'
3093: );
3094: my $output;
3095: $output = '<br />'.$lt{'cacb'}.':<br />';
3096: $output .= &start_data_table();
3097: $output .= '
3098: <tr>
3099: <th>'.$lt{'cour'}.'</th>
3100: <th>'.$lt{'dura'}.'</th>
3101: <th>'.$lt{'blse'}.'</th>
3102: </tr>
3103: ';
3104: foreach my $course (keys(%{$setters})) {
3105: my %courseinfo=&Apache::lonnet::coursedescription($course);
3106: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3107: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
3108: my $fullname = &plainname($uname,$udom);
3109: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3110: && $env{'user.name'} ne 'public'
3111: && $env{'user.domain'} ne 'public') {
3112: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3113: }
3114: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3115: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3116: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3117: $output .= &Apache::loncommon::start_data_table_row().
3118: '<td>'.$courseinfo{'description'}.'</td>'.
3119: '<td>'.$openblock.' to '.$closeblock.'</td>'.
3120: '<td>'.$fullname.'</td>'.
3121: &Apache::loncommon::end_data_table_row();
3122: }
3123: }
3124: $output .= &end_data_table();
3125: }
3126:
3127: sub blocking_status {
3128: my ($activity,$uname,$udom) = @_;
3129: my %setters;
3130: my ($blocked,$output,$ownitem,$is_course);
3131: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3132: if ($startblock && $endblock) {
3133: $blocked = 1;
3134: if (wantarray) {
3135: my $category;
3136: if ($activity eq 'boards') {
3137: $category = 'Discussion posts in this course';
3138: } elsif ($activity eq 'blogs') {
3139: $category = 'Blogs';
3140: } elsif ($activity eq 'port') {
3141: if (defined($uname) && defined($udom)) {
3142: if ($uname eq $env{'user.name'} &&
3143: $udom eq $env{'user.domain'}) {
3144: $ownitem = 1;
3145: }
3146: }
3147: $is_course = &Apache::lonnet::is_course($udom,$uname);
3148: if ($ownitem) {
3149: $category = 'Your portfolio files';
3150: } elsif ($is_course) {
3151: my $coursedesc;
3152: foreach my $course (keys(%setters)) {
3153: my %courseinfo =
3154: &Apache::lonnet::coursedescription($course);
3155: $coursedesc = $courseinfo{'description'};
3156: }
3157: $category = "Group files in the course '$coursedesc'";
3158: } else {
3159: $category = 'Portfolio files belonging to ';
3160: if ($env{'user.name'} eq 'public' &&
3161: $env{'user.domain'} eq 'public') {
3162: $category .= &plainname($uname,$udom);
3163: } else {
3164: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3165: }
3166: }
3167: } elsif ($activity eq 'groups') {
3168: $category = 'Groups in this course';
3169: }
3170: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3171: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3172: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3173: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3174: $output .= &build_block_table($startblock,$endblock,\%setters);
3175: }
3176: }
3177: }
3178: if (wantarray) {
3179: return ($blocked,$output);
3180: } else {
3181: return $blocked;
3182: }
3183: }
3184:
3185: ###############################################
3186:
3187: =pod
3188:
3189: =head1 Domain Template Functions
3190:
3191: =over 4
3192:
3193: =item * &determinedomain()
3194:
3195: Inputs: $domain (usually will be undef)
3196:
3197: Returns: Determines which domain should be used for designs
3198:
3199: =cut
3200:
3201: ###############################################
3202: sub determinedomain {
3203: my $domain=shift;
3204: if (! $domain) {
3205: # Determine domain if we have not been given one
3206: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
3207: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3208: if ($env{'request.role.domain'}) {
3209: $domain=$env{'request.role.domain'};
3210: }
3211: }
3212: return $domain;
3213: }
3214: ###############################################
3215:
3216: sub devalidate_domconfig_cache {
3217: my ($udom)=@_;
3218: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3219: }
3220:
3221: # ---------------------- Get domain configuration for a domain
3222: sub get_domainconf {
3223: my ($udom) = @_;
3224: my $cachetime=1800;
3225: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3226: if (defined($cached)) { return %{$result}; }
3227:
3228: my %domconfig = &Apache::lonnet::get_dom('configuration',
3229: ['login','rolecolors'],$udom);
3230: my %designhash;
3231: if (keys(%domconfig) > 0) {
3232: if (ref($domconfig{'login'}) eq 'HASH') {
3233: foreach my $key (keys(%{$domconfig{'login'}})) {
3234: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3235: }
3236: }
3237: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
3238: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3239: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3240: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3241: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3242: }
3243: }
3244: }
3245: }
3246: } else {
3247: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3248: my $designfile = $designdir.'/'.$udom.'.tab';
3249: if (-e $designfile) {
3250: if ( open (my $fh,"<$designfile") ) {
3251: while (my $line = <$fh>) {
3252: next if ($line =~ /^\#/);
3253: chomp($line);
3254: my ($key,$val)=(split(/\=/,$line));
3255: if ($val) { $designhash{$udom.'.'.$key}=$val; }
3256: }
3257: close($fh);
3258: }
3259: }
3260: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3261: $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3262: }
3263: }
3264: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3265: $cachetime);
3266: return %designhash;
3267: }
3268:
3269: =pod
3270:
3271: =item * &domainlogo()
3272:
3273: Inputs: $domain (usually will be undef)
3274:
3275: Returns: A link to a domain logo, if the domain logo exists.
3276: If the domain logo does not exist, a description of the domain.
3277:
3278: =cut
3279:
3280: ###############################################
3281: sub domainlogo {
3282: my $domain = &determinedomain(shift);
3283: my %designhash = &get_domainconf($domain);
3284: # See if there is a logo
3285: if ($designhash{$domain.'.login.domlogo'} ne '') {
3286: my $imgsrc = $designhash{$domain.'.login.domlogo'};
3287: if ($imgsrc =~ m{^/(adm|res)/}) {
3288: if ($imgsrc =~ m{^/res/}) {
3289: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3290: &Apache::lonnet::repcopy($local_name);
3291: }
3292: $imgsrc = &lonhttpdurl($imgsrc);
3293: }
3294: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
3295: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3296: return &Apache::lonnet::domain($domain,'description');
3297: } else {
3298: return '';
3299: }
3300: }
3301: ##############################################
3302:
3303: =pod
3304:
3305: =item * &designparm()
3306:
3307: Inputs: $which parameter; $domain (usually will be undef)
3308:
3309: Returns: value of designparamter $which
3310:
3311: =cut
3312:
3313:
3314: ##############################################
3315: sub designparm {
3316: my ($which,$domain)=@_;
3317: if ($env{'browser.blackwhite'} eq 'on') {
3318: if ($which=~/\.(font|alink|vlink|link)$/) {
3319: return '#000000';
3320: }
3321: if ($which=~/\.(pgbg|sidebg)$/) {
3322: return '#FFFFFF';
3323: }
3324: if ($which=~/\.tabbg$/) {
3325: return '#CCCCCC';
3326: }
3327: }
3328: if (exists($env{'environment.color.'.$which})) {
3329: return $env{'environment.color.'.$which};
3330: }
3331: $domain=&determinedomain($domain);
3332: my %domdesign = &get_domainconf($domain);
3333: my $output;
3334: if ($domdesign{$domain.'.'.$which} ne '') {
3335: $output = $domdesign{$domain.'.'.$which};
3336: } else {
3337: $output = $defaultdesign{$which};
3338: }
3339: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
3340: ($which =~ /login\.(img|logo|domlogo)/)) {
3341: if ($output =~ m{^/(adm|res)/}) {
3342: if ($output =~ m{^/res/}) {
3343: my $local_name = &Apache::lonnet::filelocation('',$output);
3344: &Apache::lonnet::repcopy($local_name);
3345: }
3346: $output = &lonhttpdurl($output);
3347: }
3348: }
3349: return $output;
3350: }
3351:
3352: ###############################################
3353: ###############################################
3354:
3355: =pod
3356:
3357: =back
3358:
3359: =head1 HTML Helpers
3360:
3361: =over 4
3362:
3363: =item * &bodytag()
3364:
3365: Returns a uniform header for LON-CAPA web pages.
3366:
3367: Inputs:
3368:
3369: =over 4
3370:
3371: =item * $title, A title to be displayed on the page.
3372:
3373: =item * $function, the current role (can be undef).
3374:
3375: =item * $addentries, extra parameters for the <body> tag.
3376:
3377: =item * $bodyonly, if defined, only return the <body> tag.
3378:
3379: =item * $domain, if defined, force a given domain.
3380:
3381: =item * $forcereg, if page should register as content page (relevant for
3382: text interface only)
3383:
3384: =item * $customtitle, alternate text to use instead of $title
3385: in the title box that appears, this text
3386: is not auto translated like the $title is
3387:
3388: =item * $notopbar, if true, keep the 'what is this' info but remove the
3389: navigational links
3390:
3391: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
3392:
3393: =item * $notitle, if true keep the nav controls, but remove the title bar
3394:
3395: =item * $no_inline_link, if true and in remote mode, don't show the
3396: 'Switch To Inline Menu' link
3397:
3398: =item * $args, optional argument valid values are
3399: no_auto_mt_title -> prevents &mt()ing the title arg
3400:
3401: =back
3402:
3403: Returns: A uniform header for LON-CAPA web pages.
3404: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
3405: If $bodyonly is undef or zero, an html string containing a <body> tag and
3406: other decorations will be returned.
3407:
3408: =cut
3409:
3410: sub bodytag {
3411: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
3412: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
3413:
3414: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
3415:
3416: $function = &get_users_function() if (!$function);
3417: my $img = &designparm($function.'.img',$domain);
3418: my $font = &designparm($function.'.font',$domain);
3419: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
3420:
3421: my %design = ( 'style' => 'margin-top: 0px',
3422: 'bgcolor' => $pgbg,
3423: 'text' => $font,
3424: 'alink' => &designparm($function.'.alink',$domain),
3425: 'vlink' => &designparm($function.'.vlink',$domain),
3426: 'link' => &designparm($function.'.link',$domain),);
3427: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
3428:
3429: # role and realm
3430: my ($role,$realm) = split(/\./,$env{'request.role'},2);
3431: if ($role eq 'ca') {
3432: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
3433: $realm = &plainname($rname,$rdom);
3434: }
3435: # realm
3436: if ($env{'request.course.id'}) {
3437: if ($env{'request.role'} !~ /^cr/) {
3438: $role = &Apache::lonnet::plaintext($role,&course_type());
3439: }
3440: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
3441: } else {
3442: $role = &Apache::lonnet::plaintext($role);
3443: }
3444:
3445: if (!$realm) { $realm=' '; }
3446: # Set messages
3447: my $messages=&domainlogo($domain);
3448: # Port for miniserver
3449: my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
3450: if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
3451:
3452: my $extra_body_attr = &make_attr_string($forcereg,\%design);
3453:
3454: # construct main body tag
3455: my $bodytag = "<body $extra_body_attr>".
3456: &Apache::lontexconvert::init_math_support();
3457:
3458: if ($bodyonly) {
3459: return $bodytag;
3460: } elsif ($env{'browser.interface'} eq 'textual') {
3461: # Accessibility
3462:
3463: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
3464: if (!$notitle) {
3465: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
3466: }
3467: return $bodytag;
3468: }
3469:
3470: my $name = &plainname($env{'user.name'},$env{'user.domain'});
3471: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3472: undef($role);
3473: } else {
3474: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
3475: }
3476:
3477: my $roleinfo=(<<ENDROLE);
3478: <td class="LC_title_bar_who">
3479: <div class="LC_title_bar_name">
3480: $name
3481:
3482: </div>
3483: <div class="LC_title_bar_role">
3484: $role
3485: </div>
3486: <div class="LC_title_bar_realm">
3487: $realm
3488: </div>
3489: </td>
3490: ENDROLE
3491:
3492: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
3493: if ($customtitle) {
3494: $titleinfo = $customtitle;
3495: }
3496: #
3497: # Extra info if you are the DC
3498: my $dc_info = '';
3499: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
3500: $env{'course.'.$env{'request.course.id'}.
3501: '.domain'}.'/'})) {
3502: my $cid = $env{'request.course.id'};
3503: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
3504: $dc_info =~ s/\s+$//;
3505: $dc_info = '('.$dc_info.')';
3506: }
3507:
3508: if ($env{'environment.remote'} eq 'off') {
3509: # No Remote
3510: if ($env{'request.state'} eq 'construct') {
3511: $forcereg=1;
3512: }
3513:
3514: if (!$customtitle && $env{'request.state'} eq 'construct') {
3515: # this is for resources; directories have customtitle, and crumbs
3516: # and select recent are created in lonpubdir.pm
3517: my ($uname,$thisdisfn)=
3518: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
3519: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3520: $formaction=~s/\/+/\//g;
3521:
3522: my $parentpath = '';
3523: my $lastitem = '';
3524: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
3525: $parentpath = $1;
3526: $lastitem = $2;
3527: } else {
3528: $lastitem = $thisdisfn;
3529: }
3530: $titleinfo =
3531: &Apache::loncommon::help_open_menu('','',3,'Authoring').
3532: '<b>Construction Space</b>: '.
3533: '<form name="dirs" method="post" action="'.$formaction
3534: .'" target="_top"><tt><b>'
3535: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
3536: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
3537: .'</form>'
3538: .&Apache::lonmenu::constspaceform();
3539: }
3540:
3541: my $titletable;
3542: if (!$notitle) {
3543: $titletable =
3544: '<table id="LC_title_bar">'.
3545: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
3546: '</tr></table>';
3547: }
3548: if ($notopbar) {
3549: $bodytag .= $titletable;
3550: } else {
3551: if ($env{'request.state'} eq 'construct') {
3552: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
3553: $titletable);
3554: } else {
3555: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
3556: $titletable;
3557: }
3558: }
3559: return $bodytag;
3560: }
3561:
3562: #
3563: # Top frame rendering, Remote is up
3564: #
3565:
3566: my $imgsrc = $img;
3567: if ($img =~ /^\/adm/) {
3568: $imgsrc = 'http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.$img;
3569: }
3570: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
3571:
3572: # Explicit link to get inline menu
3573: my $menu= ($no_inline_link?''
3574: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
3575: #
3576: if ($notitle) {
3577: return $bodytag;
3578: }
3579: return(<<ENDBODY);
3580: $bodytag
3581: <table id="LC_title_bar" class="LC_with_remote">
3582: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
3583: <td class="LC_title_bar_domain_logo">$messages </td>
3584: </tr>
3585: <tr><td>$titleinfo $dc_info $menu</td>
3586: $roleinfo
3587: </tr>
3588: </table>
3589: ENDBODY
3590: }
3591:
3592: sub make_attr_string {
3593: my ($register,$attr_ref) = @_;
3594:
3595: if ($attr_ref && !ref($attr_ref)) {
3596: die("addentries Must be a hash ref ".
3597: join(':',caller(1))." ".
3598: join(':',caller(0))." ");
3599: }
3600:
3601: if ($register) {
3602: my ($on_load,$on_unload);
3603: foreach my $key (keys(%{$attr_ref})) {
3604: if (lc($key) eq 'onload') {
3605: $on_load.=$attr_ref->{$key}.';';
3606: delete($attr_ref->{$key});
3607:
3608: } elsif (lc($key) eq 'onunload') {
3609: $on_unload.=$attr_ref->{$key}.';';
3610: delete($attr_ref->{$key});
3611: }
3612: }
3613: $attr_ref->{'onload'} =
3614: &Apache::lonmenu::loadevents(). $on_load;
3615: $attr_ref->{'onunload'}=
3616: &Apache::lonmenu::unloadevents().$on_unload;
3617: }
3618:
3619: # Accessibility font enhance
3620: if ($env{'browser.fontenhance'} eq 'on') {
3621: my $style;
3622: foreach my $key (keys(%{$attr_ref})) {
3623: if (lc($key) eq 'style') {
3624: $style.=$attr_ref->{$key}.';';
3625: delete($attr_ref->{$key});
3626: }
3627: }
3628: $attr_ref->{'style'}=$style.'; font-size: x-large;';
3629: }
3630:
3631: if ($env{'browser.blackwhite'} eq 'on') {
3632: delete($attr_ref->{'font'});
3633: delete($attr_ref->{'link'});
3634: delete($attr_ref->{'alink'});
3635: delete($attr_ref->{'vlink'});
3636: delete($attr_ref->{'bgcolor'});
3637: delete($attr_ref->{'background'});
3638: }
3639:
3640: my $attr_string;
3641: foreach my $attr (keys(%$attr_ref)) {
3642: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
3643: }
3644: return $attr_string;
3645: }
3646:
3647:
3648: ###############################################
3649: ###############################################
3650:
3651: =pod
3652:
3653: =item * &endbodytag()
3654:
3655: Returns a uniform footer for LON-CAPA web pages.
3656:
3657: Inputs: none
3658:
3659: =cut
3660:
3661: sub endbodytag {
3662: my $endbodytag='</body>';
3663: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
3664: if ( exists( $env{'internal.head.redirect'} ) ) {
3665: $endbodytag=
3666: "<br /><a href=\"$env{'internal.head.redirect'}\">".
3667: &mt('Continue').'</a>'.
3668: $endbodytag;
3669: }
3670: return $endbodytag;
3671: }
3672:
3673: =pod
3674:
3675: =item * &standard_css()
3676:
3677: Returns a style sheet
3678:
3679: Inputs: (all optional)
3680: domain -> force to color decorate a page for a specific
3681: domain
3682: function -> force usage of a specific rolish color scheme
3683: bgcolor -> override the default page bgcolor
3684:
3685: =cut
3686:
3687: sub standard_css {
3688: my ($function,$domain,$bgcolor) = @_;
3689: $function = &get_users_function() if (!$function);
3690: my $img = &designparm($function.'.img', $domain);
3691: my $tabbg = &designparm($function.'.tabbg', $domain);
3692: my $font = &designparm($function.'.font', $domain);
3693: my $sidebg = &designparm($function.'.sidebg',$domain);
3694: my $pgbg_or_bgcolor =
3695: $bgcolor ||
3696: &designparm($function.'.pgbg', $domain);
3697: my $pgbg = &designparm($function.'.pgbg', $domain);
3698: my $alink = &designparm($function.'.alink', $domain);
3699: my $vlink = &designparm($function.'.vlink', $domain);
3700: my $link = &designparm($function.'.link', $domain);
3701:
3702: my $sans = 'Arial,Helvetica,sans-serif';
3703: my $mono = 'monospace';
3704: my $data_table_head = $tabbg;
3705: my $data_table_light = '#EEEEEE';
3706: my $data_table_dark = '#DDDDDD';
3707: my $data_table_darker = '#CCCCCC';
3708: my $data_table_highlight = '#FFFF00';
3709: my $mail_new = '#FFBB77';
3710: my $mail_new_hover = '#DD9955';
3711: my $mail_read = '#BBBB77';
3712: my $mail_read_hover = '#999944';
3713: my $mail_replied = '#AAAA88';
3714: my $mail_replied_hover = '#888855';
3715: my $mail_other = '#99BBBB';
3716: my $mail_other_hover = '#669999';
3717: my $table_header = '#DDDDDD';
3718: my $feedback_link_bg = '#BBBBBB';
3719:
3720: my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
3721: : '0px 3px 0px 4px';
3722:
3723:
3724: return <<END;
3725: h1, h2, h3, th { font-family: $sans }
3726: a:focus { color: red; background: yellow }
3727: table.thinborder,
3728:
3729: table.thinborder tr th {
3730: border-style: solid;
3731: border-width: 1px;
3732: background: $tabbg;
3733: }
3734: table.thinborder tr td {
3735: border-style: solid;
3736: border-width: 1px
3737: }
3738:
3739: form, .inline { display: inline; }
3740: .center { text-align: center; }
3741: .LC_filename {font-family: $mono;}
3742: .LC_error {
3743: color: red;
3744: font-size: larger;
3745: }
3746: .LC_warning,
3747: .LC_diff_removed {
3748: color: red;
3749: }
3750:
3751: .LC_info,
3752: .LC_success,
3753: .LC_diff_added {
3754: color: green;
3755: }
3756: .LC_unknown {
3757: color: yellow;
3758: }
3759:
3760: .LC_icon {
3761: border: 0px;
3762: }
3763: .LC_indexer_icon {
3764: border: 0px;
3765: height: 22px;
3766: }
3767: .LC_docs_spacer {
3768: width: 25px;
3769: height: 1px;
3770: border: 0px;
3771: }
3772:
3773: .LC_internal_info {
3774: color: #999;
3775: }
3776:
3777: table.LC_pastsubmission {
3778: border: 1px solid black;
3779: margin: 2px;
3780: }
3781:
3782: table#LC_top_nav, table#LC_menubuttons {
3783: width: 100%;
3784: background: $pgbg;
3785: border: 2px;
3786: border-collapse: separate;
3787: padding: 0px;
3788: }
3789:
3790: table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
3791: table#LC_title_bar.LC_with_remote {
3792: width: 100%;
3793: border-color: $pgbg;
3794: border-style: solid;
3795: border-width: $border;
3796:
3797: background: $pgbg;
3798: font-family: $sans;
3799: border-collapse: collapse;
3800: padding: 0px;
3801: }
3802:
3803: table.LC_docs_path {
3804: width: 100%;
3805: border: 0;
3806: background: $pgbg;
3807: font-family: $sans;
3808: border-collapse: collapse;
3809: padding: 0px;
3810: }
3811:
3812: table#LC_title_bar td {
3813: background: $tabbg;
3814: }
3815: table#LC_title_bar td.LC_title_bar_who {
3816: background: $tabbg;
3817: color: $font;
3818: font: small $sans;
3819: text-align: right;
3820: }
3821: span.LC_metadata {
3822: font-family: $sans;
3823: }
3824: span.LC_title_bar_title {
3825: font: bold x-large $sans;
3826: }
3827: table#LC_title_bar td.LC_title_bar_domain_logo {
3828: background: $sidebg;
3829: text-align: right;
3830: padding: 0px;
3831: }
3832: table#LC_title_bar td.LC_title_bar_role_logo {
3833: background: $sidebg;
3834: padding: 0px;
3835: }
3836:
3837: table#LC_menubuttons_mainmenu {
3838: width: 100%;
3839: border: 0px;
3840: border-spacing: 1px;
3841: padding: 0px 1px;
3842: margin: 0px;
3843: border-collapse: separate;
3844: }
3845: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
3846: border: 0px;
3847: }
3848: table#LC_top_nav td {
3849: background: $tabbg;
3850: border: 0px;
3851: font-size: small;
3852: }
3853: table#LC_top_nav td a, div#LC_top_nav a {
3854: color: $font;
3855: font-family: $sans;
3856: }
3857: table#LC_top_nav td.LC_top_nav_logo {
3858: background: $tabbg;
3859: text-align: left;
3860: white-space: nowrap;
3861: width: 31px;
3862: }
3863: table#LC_top_nav td.LC_top_nav_logo img {
3864: border: 0px;
3865: vertical-align: bottom;
3866: }
3867: table#LC_top_nav td.LC_top_nav_exit,
3868: table#LC_top_nav td.LC_top_nav_help {
3869: width: 2.0em;
3870: }
3871: table#LC_top_nav td.LC_top_nav_login {
3872: width: 4.0em;
3873: text-align: center;
3874: }
3875: table.LC_breadcrumbs td, table.LC_docs_path td {
3876: background: $tabbg;
3877: color: $font;
3878: font-family: $sans;
3879: font-size: smaller;
3880: }
3881: table.LC_breadcrumbs td.LC_breadcrumbs_component,
3882: table.LC_docs_path td.LC_docs_path_component {
3883: background: $tabbg;
3884: color: $font;
3885: font-family: $sans;
3886: font-size: larger;
3887: text-align: right;
3888: }
3889: td.LC_table_cell_checkbox {
3890: text-align: center;
3891: }
3892:
3893: table#LC_mainmenu td.LC_mainmenu_column {
3894: vertical-align: top;
3895: }
3896:
3897: .LC_menubuttons_inline_text {
3898: color: $font;
3899: font-family: $sans;
3900: font-size: smaller;
3901: }
3902:
3903: .LC_menubuttons_link {
3904: text-decoration: none;
3905: }
3906:
3907: .LC_menubuttons_category {
3908: color: $font;
3909: background: $pgbg;
3910: font-family: $sans;
3911: font-size: larger;
3912: font-weight: bold;
3913: }
3914:
3915: td.LC_menubuttons_text {
3916: width: 90%;
3917: color: $font;
3918: font-family: $sans;
3919: }
3920:
3921: td.LC_menubuttons_img {
3922: }
3923:
3924: .LC_current_location {
3925: font-family: $sans;
3926: background: $tabbg;
3927: }
3928: .LC_new_mail {
3929: font-family: $sans;
3930: font-weight: bold;
3931: }
3932:
3933: .LC_rolesmenu_is {
3934: font-family: $sans;
3935: }
3936:
3937: .LC_rolesmenu_selected {
3938: font-family: $sans;
3939: }
3940:
3941: .LC_rolesmenu_future {
3942: font-family: $sans;
3943: }
3944:
3945:
3946: .LC_rolesmenu_will {
3947: font-family: $sans;
3948: }
3949:
3950: .LC_rolesmenu_will_not {
3951: font-family: $sans;
3952: }
3953:
3954: .LC_rolesmenu_expired {
3955: font-family: $sans;
3956: }
3957:
3958: .LC_rolesinfo {
3959: font-family: $sans;
3960: }
3961:
3962: .LC_dropadd_labeltext {
3963: font-family: $sans;
3964: text-align: right;
3965: }
3966:
3967: .LC_preferences_labeltext {
3968: font-family: $sans;
3969: text-align: right;
3970: }
3971:
3972: table.LC_aboutme_port {
3973: border: 0px;
3974: border-collapse: collapse;
3975: border-spacing: 0px;
3976: }
3977: table.LC_data_table, table.LC_mail_list {
3978: border: 1px solid #000000;
3979: border-collapse: separate;
3980: border-spacing: 1px;
3981: }
3982: .LC_data_table_dense {
3983: font-size: small;
3984: }
3985: table.LC_nested_outer {
3986: border: 1px solid #000000;
3987: border-collapse: separate;
3988: border-spacing: 0px;
3989: width: 100%;
3990: }
3991: table.LC_nested {
3992: border: 0px;
3993: border-collapse: separate;
3994: border-spacing: 0px;
3995: width: 100%;
3996: }
3997: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
3998: table.LC_prior_tries tr th {
3999: font-weight: bold;
4000: background-color: $data_table_head;
4001: font-size: smaller;
4002: }
4003: table.LC_data_table tr td,
4004: table.LC_aboutme_port tr td {
4005: background-color: $data_table_light;
4006: padding: 2px;
4007: }
4008: table.LC_data_table tr.LC_even_row td,
4009: table.LC_aboutme_port tr.LC_even_row td {
4010: background-color: $data_table_dark;
4011: }
4012: table.LC_data_table tr.LC_data_table_highlight td {
4013: background-color: $data_table_darker;
4014: }
4015: table.LC_data_table tr.LC_empty_row td,
4016: table.LC_nested tr.LC_empty_row td {
4017: background-color: #FFFFFF;
4018: font-weight: bold;
4019: font-style: italic;
4020: text-align: center;
4021: padding: 8px;
4022: }
4023: table.LC_nested tr.LC_empty_row td {
4024: padding: 4ex
4025: }
4026: table.LC_nested_outer tr th {
4027: font-weight: bold;
4028: background-color: $data_table_head;
4029: font-size: smaller;
4030: border-bottom: 1px solid #000000;
4031: }
4032: table.LC_nested_outer tr td.LC_subheader {
4033: background-color: $data_table_head;
4034: font-weight: bold;
4035: font-size: small;
4036: border-bottom: 1px solid #000000;
4037: text-align: right;
4038: }
4039: table.LC_nested tr.LC_info_row td {
4040: background-color: #CCC;
4041: font-weight: bold;
4042: font-size: small;
4043: text-align: center;
4044: }
4045: table.LC_nested tr.LC_info_row td.LC_left_item {
4046: text-align: left;
4047: }
4048: table.LC_nested td {
4049: background-color: #FFF;
4050: font-size: small;
4051: }
4052: table.LC_nested_outer tr th.LC_right_item,
4053: table.LC_nested tr.LC_info_row td.LC_right_item,
4054: table.LC_nested tr.LC_odd_row td.LC_right_item,
4055: table.LC_nested tr td.LC_right_item {
4056: text-align: right;
4057: }
4058:
4059: table.LC_nested tr.LC_odd_row td {
4060: background-color: #EEE;
4061: }
4062:
4063: table.LC_createuser {
4064: }
4065:
4066: table.LC_createuser tr.LC_section_row td {
4067: font-size: smaller;
4068: }
4069:
4070: table.LC_createuser tr.LC_info_row td {
4071: background-color: #CCC;
4072: font-weight: bold;
4073: text-align: center;
4074: }
4075:
4076: table.LC_calendar {
4077: border: 1px solid #000000;
4078: border-collapse: collapse;
4079: }
4080: table.LC_calendar_pickdate {
4081: font-size: xx-small;
4082: }
4083: table.LC_calendar tr td {
4084: border: 1px solid #000000;
4085: vertical-align: top;
4086: }
4087: table.LC_calendar tr td.LC_calendar_day_empty {
4088: background-color: $data_table_dark;
4089: }
4090: table.LC_calendar tr td.LC_calendar_day_current {
4091: background-color: $data_table_highlight;
4092: }
4093:
4094: table.LC_mail_list tr.LC_mail_new {
4095: background-color: $mail_new;
4096: }
4097: table.LC_mail_list tr.LC_mail_new:hover {
4098: background-color: $mail_new_hover;
4099: }
4100: table.LC_mail_list tr.LC_mail_read {
4101: background-color: $mail_read;
4102: }
4103: table.LC_mail_list tr.LC_mail_read:hover {
4104: background-color: $mail_read_hover;
4105: }
4106: table.LC_mail_list tr.LC_mail_replied {
4107: background-color: $mail_replied;
4108: }
4109: table.LC_mail_list tr.LC_mail_replied:hover {
4110: background-color: $mail_replied_hover;
4111: }
4112: table.LC_mail_list tr.LC_mail_other {
4113: background-color: $mail_other;
4114: }
4115: table.LC_mail_list tr.LC_mail_other:hover {
4116: background-color: $mail_other_hover;
4117: }
4118: table.LC_mail_list tr.LC_mail_even {
4119: }
4120: table.LC_mail_list tr.LC_mail_odd {
4121: }
4122:
4123:
4124: table#LC_portfolio_actions {
4125: width: auto;
4126: background: $pgbg;
4127: border: 0px;
4128: border-spacing: 2px 2px;
4129: padding: 0px;
4130: margin: 0px;
4131: border-collapse: separate;
4132: }
4133: table#LC_portfolio_actions td.LC_label {
4134: background: $tabbg;
4135: text-align: right;
4136: }
4137: table#LC_portfolio_actions td.LC_value {
4138: background: $tabbg;
4139: }
4140:
4141: table#LC_cstr_controls {
4142: width: 100%;
4143: border-collapse: collapse;
4144: }
4145: table#LC_cstr_controls tr td {
4146: border: 4px solid $pgbg;
4147: padding: 4px;
4148: text-align: center;
4149: background: $tabbg;
4150: }
4151: table#LC_cstr_controls tr th {
4152: border: 4px solid $pgbg;
4153: background: $table_header;
4154: text-align: center;
4155: font-family: $sans;
4156: font-size: smaller;
4157: }
4158:
4159: table#LC_browser {
4160:
4161: }
4162: table#LC_browser tr th {
4163: background: $table_header;
4164: }
4165: table#LC_browser tr td {
4166: padding: 2px;
4167: }
4168: table#LC_browser tr.LC_browser_file,
4169: table#LC_browser tr.LC_browser_file_published {
4170: background: #CCFF88;
4171: }
4172: table#LC_browser tr.LC_browser_file_locked,
4173: table#LC_browser tr.LC_browser_file_unpublished {
4174: background: #FFAA99;
4175: }
4176: table#LC_browser tr.LC_browser_file_obsolete {
4177: background: #AAAAAA;
4178: }
4179: table#LC_browser tr.LC_browser_file_modified,
4180: table#LC_browser tr.LC_browser_file_metamodified {
4181: background: #FFFF77;
4182: }
4183: table#LC_browser tr.LC_browser_folder {
4184: background: #CCCCFF;
4185: }
4186: span.LC_current_location {
4187: font-size: x-large;
4188: background: $pgbg;
4189: }
4190:
4191: span.LC_parm_menu_item {
4192: font-size: larger;
4193: font-family: $sans;
4194: }
4195: span.LC_parm_scope_all {
4196: color: red;
4197: }
4198: span.LC_parm_scope_folder {
4199: color: green;
4200: }
4201: span.LC_parm_scope_resource {
4202: color: orange;
4203: }
4204: span.LC_parm_part {
4205: color: blue;
4206: }
4207: span.LC_parm_folder, span.LC_parm_symb {
4208: font-size: x-small;
4209: font-family: $mono;
4210: color: #AAAAAA;
4211: }
4212:
4213: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4214: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4215: border: 1px solid black;
4216: border-collapse: collapse;
4217: }
4218: table.LC_parm_overview_restrictions td {
4219: border-width: 1px 4px 1px 4px;
4220: border-style: solid;
4221: border-color: $pgbg;
4222: text-align: center;
4223: }
4224: table.LC_parm_overview_restrictions th {
4225: background: $tabbg;
4226: border-width: 1px 4px 1px 4px;
4227: border-style: solid;
4228: border-color: $pgbg;
4229: }
4230: table#LC_helpmenu {
4231: border: 0px;
4232: height: 55px;
4233: border-spacing: 0px;
4234: }
4235:
4236: table#LC_helpmenu fieldset legend {
4237: font-size: larger;
4238: font-weight: bold;
4239: }
4240: table#LC_helpmenu_links {
4241: width: 100%;
4242: border: 1px solid black;
4243: background: $pgbg;
4244: padding: 0px;
4245: border-spacing: 1px;
4246: }
4247: table#LC_helpmenu_links tr td {
4248: padding: 1px;
4249: background: $tabbg;
4250: text-align: center;
4251: font-weight: bold;
4252: }
4253:
4254: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4255: table#LC_helpmenu_links a:active {
4256: text-decoration: none;
4257: color: $font;
4258: }
4259: table#LC_helpmenu_links a:hover {
4260: text-decoration: underline;
4261: color: $vlink;
4262: }
4263:
4264: .LC_chrt_popup_exists {
4265: border: 1px solid #339933;
4266: margin: -1px;
4267: }
4268: .LC_chrt_popup_up {
4269: border: 1px solid yellow;
4270: margin: -1px;
4271: }
4272: .LC_chrt_popup {
4273: border: 1px solid #8888FF;
4274: background: #CCCCFF;
4275: }
4276:
4277: table.LC_pick_box {
4278: width: 100%;
4279: border-collapse: separate;
4280: background: white;
4281: border: 1px solid black;
4282: border-spacing: 1px;
4283: }
4284: table.LC_pick_box td.LC_pick_box_title {
4285: background: $tabbg;
4286: font-weight: bold;
4287: text-align: right;
4288: width: 184px;
4289: padding: 8px;
4290: }
4291: table.LC_pick_box td.LC_pick_box_separator {
4292: padding: 0px;
4293: height: 1px;
4294: background: black;
4295: }
4296: table.LC_pick_box td.LC_pick_box_submit {
4297: text-align: right;
4298: }
4299:
4300: table.LC_group_priv_box {
4301: background: white;
4302: border: 1px solid black;
4303: border-spacing: 1px;
4304: }
4305: table.LC_group_priv_box td.LC_pick_box_title {
4306: background: $tabbg;
4307: font-weight: bold;
4308: text-align: right;
4309: width: 184px;
4310: }
4311: table.LC_group_priv_box td.LC_groups_fixed {
4312: background: $data_table_light;
4313: text-align: center;
4314: }
4315: table.LC_group_priv_box td.LC_groups_optional {
4316: background: $data_table_dark;
4317: text-align: center;
4318: }
4319: table.LC_group_priv_box td.LC_groups_functionality {
4320: background: $data_table_darker;
4321: text-align: center;
4322: font-weight: bold;
4323: }
4324: table.LC_group_priv td {
4325: text-align: left;
4326: padding: 0px;
4327: }
4328:
4329: table.LC_notify_front_page {
4330: background: white;
4331: border: 1px solid black;
4332: padding: 8px;
4333: }
4334: table.LC_notify_front_page td {
4335: padding: 8px;
4336: }
4337: .LC_navbuttons {
4338: margin: 2ex 0ex 2ex 0ex;
4339: }
4340: .LC_topic_bar {
4341: font-family: $sans;
4342: font-weight: bold;
4343: width: 100%;
4344: background: $tabbg;
4345: vertical-align: middle;
4346: margin: 2ex 0ex 2ex 0ex;
4347: }
4348: .LC_topic_bar span {
4349: vertical-align: middle;
4350: }
4351: .LC_topic_bar img {
4352: vertical-align: bottom;
4353: }
4354: table.LC_course_group_status {
4355: margin: 20px;
4356: }
4357: table.LC_status_selector td {
4358: vertical-align: top;
4359: text-align: center;
4360: padding: 4px;
4361: }
4362: table.LC_descriptive_input td.LC_description {
4363: vertical-align: top;
4364: text-align: right;
4365: font-weight: bold;
4366: }
4367: table.LC_feedback_link {
4368: background: $feedback_link_bg;
4369: }
4370: span.LC_feedback_link {
4371: background: $feedback_link_bg;
4372: font-size: larger;
4373: }
4374:
4375: table.LC_prior_tries {
4376: border: 1px solid #000000;
4377: border-collapse: separate;
4378: border-spacing: 1px;
4379: }
4380:
4381: table.LC_prior_tries td {
4382: padding: 2px;
4383: }
4384:
4385: .LC_answer_correct {
4386: background: #AAFFAA;
4387: color: black;
4388: }
4389: .LC_answer_charged_try {
4390: background: #FFAAAA ! important;
4391: color: black;
4392: }
4393: .LC_answer_not_charged_try,
4394: .LC_answer_no_grade,
4395: .LC_answer_late {
4396: background: #FFFFAA;
4397: color: black;
4398: }
4399: .LC_answer_previous {
4400: background: #AAAAFF;
4401: color: black;
4402: }
4403: .LC_answer_no_message {
4404: background: #FFFFFF;
4405: color: black;
4406: }
4407: .LC_answer_unknown {
4408: background: orange;
4409: color: black;
4410: }
4411:
4412:
4413: span.LC_prior_numerical,
4414: span.LC_prior_string,
4415: span.LC_prior_custom,
4416: span.LC_prior_reaction,
4417: span.LC_prior_math {
4418: font-family: monospace;
4419: white-space: pre;
4420: }
4421:
4422: span.LC_prior_string {
4423: font-family: monospace;
4424: white-space: pre;
4425: }
4426:
4427: table.LC_prior_option {
4428: width: 100%;
4429: border-collapse: collapse;
4430: }
4431: table.LC_prior_rank, table.LC_prior_match {
4432: border-collapse: collapse;
4433: }
4434: table.LC_prior_option tr td,
4435: table.LC_prior_rank tr td,
4436: table.LC_prior_match tr td {
4437: border: 1px solid #000000;
4438: }
4439:
4440: span.LC_nobreak {
4441: white-space: nowrap;
4442: }
4443:
4444: table.LC_docs_documents {
4445: background: #BBBBBB;
4446: border-width: 0px;
4447: border-collapse: collapse;
4448: }
4449:
4450: table.LC_docs_documents td.LC_docs_document {
4451: border: 2px solid black;
4452: padding: 4px;
4453: }
4454:
4455: .LC_docs_course_commands div {
4456: float: left;
4457: border: 4px solid #AAAAAA;
4458: padding: 4px;
4459: background: #DDDDCC;
4460: }
4461:
4462: .LC_docs_entry_move {
4463: border: 0px;
4464: border-collapse: collapse;
4465: }
4466:
4467: .LC_docs_entry_move td {
4468: border: 2px solid #BBBBBB;
4469: background: #DDDDDD;
4470: }
4471:
4472: .LC_docs_editor td.LC_docs_entry_commands {
4473: background: #DDDDDD;
4474: font-size: x-small;
4475: }
4476: .LC_docs_copy {
4477: color: #000099;
4478: }
4479: .LC_docs_cut {
4480: color: #550044;
4481: }
4482: .LC_docs_rename {
4483: color: #009900;
4484: }
4485: .LC_docs_remove {
4486: color: #990000;
4487: }
4488:
4489: .LC_docs_reinit_warn,
4490: .LC_docs_ext_edit {
4491: font-size: x-small;
4492: }
4493:
4494: .LC_docs_editor td.LC_docs_entry_title,
4495: .LC_docs_editor td.LC_docs_entry_icon {
4496: background: #FFFFBB;
4497: }
4498: .LC_docs_editor td.LC_docs_entry_parameter {
4499: background: #BBBBFF;
4500: font-size: x-small;
4501: white-space: nowrap;
4502: }
4503:
4504: table.LC_docs_adddocs td,
4505: table.LC_docs_adddocs th {
4506: border: 1px solid #BBBBBB;
4507: padding: 4px;
4508: background: #DDDDDD;
4509: }
4510:
4511: END
4512: }
4513:
4514: =pod
4515:
4516: =item * &headtag()
4517:
4518: Returns a uniform footer for LON-CAPA web pages.
4519:
4520: Inputs: $title - optional title for the head
4521: $head_extra - optional extra HTML to put inside the <head>
4522: $args - optional arguments
4523: force_register - if is true call registerurl so the remote is
4524: informed
4525: redirect -> array ref of
4526: 1- seconds before redirect occurs
4527: 2- url to redirect to
4528: 3- whether the side effect should occur
4529: (side effect of setting
4530: $env{'internal.head.redirect'} to the url
4531: redirected too)
4532: domain -> force to color decorate a page for a specific
4533: domain
4534: function -> force usage of a specific rolish color scheme
4535: bgcolor -> override the default page bgcolor
4536: no_auto_mt_title
4537: -> prevent &mt()ing the title arg
4538:
4539: =cut
4540:
4541: sub headtag {
4542: my ($title,$head_extra,$args) = @_;
4543:
4544: my $function = $args->{'function'} || &get_users_function();
4545: my $domain = $args->{'domain'} || &determinedomain();
4546: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
4547: my $url = join(':',$env{'user.name'},$env{'user.domain'},
4548: $Apache::lonnet::perlvar{'lonVersion'},
4549: #time(),
4550: $env{'environment.color.timestamp'},
4551: $function,$domain,$bgcolor);
4552:
4553: $url = '/adm/css/'.&escape($url).'.css';
4554:
4555: my $result =
4556: '<head>'.
4557: &font_settings();
4558:
4559: if (!$args->{'frameset'}) {
4560: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
4561: }
4562: if ($args->{'force_register'}) {
4563: $result .= &Apache::lonmenu::registerurl(1);
4564: }
4565: if (!$args->{'no_nav_bar'}
4566: && !$args->{'only_body'}
4567: && !$args->{'frameset'}) {
4568: $result .= &help_menu_js();
4569: }
4570:
4571: if (ref($args->{'redirect'})) {
4572: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
4573: $url = &Apache::lonenc::check_encrypt($url);
4574: if (!$inhibit_continue) {
4575: $env{'internal.head.redirect'} = $url;
4576: }
4577: $result.=<<ADDMETA
4578: <meta http-equiv="pragma" content="no-cache" />
4579: <meta http-equiv="Refresh" content="$time; url=$url" />
4580: ADDMETA
4581: }
4582: if (!defined($title)) {
4583: $title = 'The LearningOnline Network with CAPA';
4584: }
4585: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
4586: $result .= '<title> LON-CAPA '.$title.'</title>'
4587: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
4588: .$head_extra;
4589: return $result;
4590: }
4591:
4592: =pod
4593:
4594: =item * &font_settings()
4595:
4596: Returns neccessary <meta> to set the proper encoding
4597:
4598: Inputs: none
4599:
4600: =cut
4601:
4602: sub font_settings {
4603: my $headerstring='';
4604: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
4605: $headerstring.=
4606: '<meta Content-Type="text/html; charset=x-mac-roman" />';
4607: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
4608: $headerstring.=
4609: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
4610: }
4611: return $headerstring;
4612: }
4613:
4614: =pod
4615:
4616: =item * &xml_begin()
4617:
4618: Returns the needed doctype and <html>
4619:
4620: Inputs: none
4621:
4622: =cut
4623:
4624: sub xml_begin {
4625: my $output='';
4626:
4627: &Apache::lonhtmlcommon::init_htmlareafields();
4628:
4629: if ($env{'browser.mathml'}) {
4630: $output='<?xml version="1.0"?>'
4631: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
4632: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
4633:
4634: # .'<!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">] >'
4635: .'<!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">'
4636: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
4637: .'xmlns="http://www.w3.org/1999/xhtml">';
4638: } else {
4639: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
4640: }
4641: return $output;
4642: }
4643:
4644: =pod
4645:
4646: =item * &endheadtag()
4647:
4648: Returns a uniform </head> for LON-CAPA web pages.
4649:
4650: Inputs: none
4651:
4652: =cut
4653:
4654: sub endheadtag {
4655: return '</head>';
4656: }
4657:
4658: =pod
4659:
4660: =item * &head()
4661:
4662: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
4663:
4664: Inputs: $title - optional title for the page
4665: $head_extra - optional extra HTML to put inside the <head>
4666:
4667: =cut
4668:
4669: sub head {
4670: my ($title,$head_extra,$args) = @_;
4671: return &headtag($title,$head_extra,$args).&endheadtag();
4672: }
4673:
4674: =pod
4675:
4676: =item * &start_page()
4677:
4678: Returns a complete <html> .. <body> section for LON-CAPA web pages.
4679:
4680: Inputs: $title - optional title for the page
4681: $head_extra - optional extra HTML to incude inside the <head>
4682: $args - additional optional args supported are:
4683: only_body -> is true will set &bodytag() onlybodytag
4684: arg on
4685: no_nav_bar -> is true will set &bodytag() notopbar arg on
4686: add_entries -> additional attributes to add to the <body>
4687: domain -> force to color decorate a page for a
4688: specific domain
4689: function -> force usage of a specific rolish color
4690: scheme
4691: redirect -> see &headtag()
4692: bgcolor -> override the default page bg color
4693: js_ready -> return a string ready for being used in
4694: a javascript writeln
4695: html_encode -> return a string ready for being used in
4696: a html attribute
4697: force_register -> if is true will turn on the &bodytag()
4698: $forcereg arg
4699: body_title -> alternate text to use instead of $title
4700: in the title box that appears, this text
4701: is not auto translated like the $title is
4702: frameset -> if true will start with a <frameset>
4703: rather than <body>
4704: no_title -> if true the title bar won't be shown
4705: skip_phases -> hash ref of
4706: head -> skip the <html><head> generation
4707: body -> skip all <body> generation
4708:
4709: no_inline_link -> if true and in remote mode, don't show the
4710: 'Switch To Inline Menu' link
4711:
4712: no_auto_mt_title -> prevent &mt()ing the title arg
4713:
4714: =cut
4715:
4716: sub start_page {
4717: my ($title,$head_extra,$args) = @_;
4718: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
4719: my %head_args;
4720: foreach my $arg ('redirect','force_register','domain','function',
4721: 'bgcolor','frameset','no_nav_bar','only_body',
4722: 'no_auto_mt_title') {
4723: if (defined($args->{$arg})) {
4724: $head_args{$arg} = $args->{$arg};
4725: }
4726: }
4727:
4728: $env{'internal.start_page'}++;
4729: my $result;
4730: if (! exists($args->{'skip_phases'}{'head'}) ) {
4731: $result.=
4732: &xml_begin().
4733: &headtag($title,$head_extra,\%head_args).&endheadtag();
4734: }
4735:
4736: if (! exists($args->{'skip_phases'}{'body'}) ) {
4737: if ($args->{'frameset'}) {
4738: my $attr_string = &make_attr_string($args->{'force_register'},
4739: $args->{'add_entries'});
4740: $result .= "\n<frameset $attr_string>\n";
4741: } else {
4742: $result .=
4743: &bodytag($title,
4744: $args->{'function'}, $args->{'add_entries'},
4745: $args->{'only_body'}, $args->{'domain'},
4746: $args->{'force_register'}, $args->{'body_title'},
4747: $args->{'no_nav_bar'}, $args->{'bgcolor'},
4748: $args->{'no_title'}, $args->{'no_inline_link'},
4749: $args);
4750: }
4751: }
4752:
4753: if ($args->{'js_ready'}) {
4754: $result = &js_ready($result);
4755: }
4756: if ($args->{'html_encode'}) {
4757: $result = &html_encode($result);
4758: }
4759: return $result;
4760: }
4761:
4762:
4763: =pod
4764:
4765: =item * &head()
4766:
4767: Returns a complete </body></html> section for LON-CAPA web pages.
4768:
4769: Inputs: $args - additional optional args supported are:
4770: js_ready -> return a string ready for being used in
4771: a javascript writeln
4772: html_encode -> return a string ready for being used in
4773: a html attribute
4774: frameset -> if true will start with a <frameset>
4775: rather than <body>
4776: dicsussion -> if true will get discussion from
4777: lonxml::xmlend
4778: (you can pass the target and parser arguments
4779: through optional 'target' and 'parser' args
4780: to this routine)
4781:
4782: =cut
4783:
4784: sub end_page {
4785: my ($args) = @_;
4786: $env{'internal.end_page'}++;
4787: my $result;
4788: if ($args->{'discussion'}) {
4789: my ($target,$parser);
4790: if (ref($args->{'discussion'})) {
4791: ($target,$parser) =($args->{'discussion'}{'target'},
4792: $args->{'discussion'}{'parser'});
4793: }
4794: $result .= &Apache::lonxml::xmlend($target,$parser);
4795: }
4796:
4797: if ($args->{'frameset'}) {
4798: $result .= '</frameset>';
4799: } else {
4800: $result .= &endbodytag();
4801: }
4802: $result .= "\n</html>";
4803:
4804: if ($args->{'js_ready'}) {
4805: $result = &js_ready($result);
4806: }
4807:
4808: if ($args->{'html_encode'}) {
4809: $result = &html_encode($result);
4810: }
4811:
4812: return $result;
4813: }
4814:
4815: sub html_encode {
4816: my ($result) = @_;
4817:
4818: $result = &HTML::Entities::encode($result,'<>&"');
4819:
4820: return $result;
4821: }
4822: sub js_ready {
4823: my ($result) = @_;
4824:
4825: $result =~ s/[\n\r]/ /xmsg;
4826: $result =~ s/\\/\\\\/xmsg;
4827: $result =~ s/'/\\'/xmsg;
4828: $result =~ s{</}{<\\/}xmsg;
4829:
4830: return $result;
4831: }
4832:
4833: sub validate_page {
4834: if ( exists($env{'internal.start_page'})
4835: && $env{'internal.start_page'} > 1) {
4836: &Apache::lonnet::logthis('start_page called multiple times '.
4837: $env{'internal.start_page'}.' '.
4838: $ENV{'request.filename'});
4839: }
4840: if ( exists($env{'internal.end_page'})
4841: && $env{'internal.end_page'} > 1) {
4842: &Apache::lonnet::logthis('end_page called multiple times '.
4843: $env{'internal.end_page'}.' '.
4844: $env{'request.filename'});
4845: }
4846: if ( exists($env{'internal.start_page'})
4847: && ! exists($env{'internal.end_page'})) {
4848: &Apache::lonnet::logthis('start_page called without end_page '.
4849: $env{'request.filename'});
4850: }
4851: if ( ! exists($env{'internal.start_page'})
4852: && exists($env{'internal.end_page'})) {
4853: &Apache::lonnet::logthis('end_page called without start_page'.
4854: $env{'request.filename'});
4855: }
4856: }
4857:
4858: sub simple_error_page {
4859: my ($r,$title,$msg) = @_;
4860: my $page =
4861: &Apache::loncommon::start_page($title).
4862: &mt($msg).
4863: &Apache::loncommon::end_page();
4864: if (ref($r)) {
4865: $r->print($page);
4866: return;
4867: }
4868: return $page;
4869: }
4870:
4871: {
4872: my $row_count;
4873: sub start_data_table {
4874: my ($add_class) = @_;
4875: my $css_class = (join(' ','LC_data_table',$add_class));
4876: undef($row_count);
4877: return '<table class="'.$css_class.'">'."\n";
4878: }
4879:
4880: sub end_data_table {
4881: undef($row_count);
4882: return '</table>'."\n";;
4883: }
4884:
4885: sub start_data_table_row {
4886: my ($add_class) = @_;
4887: $row_count++;
4888: my $css_class = ($row_count % 2)?'':'LC_even_row';
4889: $css_class = (join(' ',$css_class,$add_class));
4890: return '<tr class="'.$css_class.'">'."\n";;
4891: }
4892:
4893: sub continue_data_table_row {
4894: my ($add_class) = @_;
4895: my $css_class = ($row_count % 2)?'':'LC_even_row';
4896: $css_class = (join(' ',$css_class,$add_class));
4897: return '<tr class="'.$css_class.'">'."\n";;
4898: }
4899:
4900: sub end_data_table_row {
4901: return '</tr>'."\n";;
4902: }
4903:
4904: sub start_data_table_empty_row {
4905: $row_count++;
4906: return '<tr class="LC_empty_row" >'."\n";;
4907: }
4908:
4909: sub end_data_table_empty_row {
4910: return '</tr>'."\n";;
4911: }
4912:
4913: sub start_data_table_header_row {
4914: return '<tr class="LC_header_row">'."\n";;
4915: }
4916:
4917: sub end_data_table_header_row {
4918: return '</tr>'."\n";;
4919: }
4920: }
4921:
4922: =pod
4923:
4924: =item * &inhibit_menu_check($arg)
4925:
4926: Checks for a inhibitmenu state and generates output to preserve it
4927:
4928: Inputs: $arg - can be any of
4929: - undef - in which case the return value is a string
4930: to add into arguments list of a uri
4931: - 'input' - in which case the return value is a HTML
4932: <form> <input> field of type hidden to
4933: preserve the value
4934: - a url - in which case the return value is the url with
4935: the neccesary cgi args added to preserve the
4936: inhibitmenu state
4937: - a ref to a url - no return value, but the string is
4938: updated to include the neccessary cgi
4939: args to preserve the inhibitmenu state
4940:
4941: =cut
4942:
4943: sub inhibit_menu_check {
4944: my ($arg) = @_;
4945: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4946: if ($arg eq 'input') {
4947: if ($env{'form.inhibitmenu'}) {
4948: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
4949: } else {
4950: return
4951: }
4952: }
4953: if ($env{'form.inhibitmenu'}) {
4954: if (ref($arg)) {
4955: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
4956: } elsif ($arg eq '') {
4957: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
4958: } else {
4959: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
4960: }
4961: }
4962: if (!ref($arg)) {
4963: return $arg;
4964: }
4965: }
4966:
4967: ###############################################
4968:
4969: =pod
4970:
4971: =back
4972:
4973: =head1 User Information Routines
4974:
4975: =over 4
4976:
4977: =item * &get_users_function()
4978:
4979: Used by &bodytag to determine the current users primary role.
4980: Returns either 'student','coordinator','admin', or 'author'.
4981:
4982: =cut
4983:
4984: ###############################################
4985: sub get_users_function {
4986: my $function = 'student';
4987: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
4988: $function='coordinator';
4989: }
4990: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
4991: $function='admin';
4992: }
4993: if (($env{'request.role'}=~/^(au|ca)/) ||
4994: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
4995: $function='author';
4996: }
4997: return $function;
4998: }
4999:
5000: ###############################################
5001:
5002: =pod
5003:
5004: =item * &check_user_status()
5005:
5006: Determines current status of supplied role for a
5007: specific user. Roles can be active, previous or future.
5008:
5009: Inputs:
5010: user's domain, user's username, course's domain,
5011: course's number, optional section ID.
5012:
5013: Outputs:
5014: role status: active, previous or future.
5015:
5016: =cut
5017:
5018: sub check_user_status {
5019: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
5020: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
5021: my @uroles = keys %userinfo;
5022: my $srchstr;
5023: my $active_chk = 'none';
5024: my $now = time;
5025: if (@uroles > 0) {
5026: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
5027: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
5028: } else {
5029: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
5030: }
5031: if (grep/^\Q$srchstr\E$/,@uroles) {
5032: my $role_end = 0;
5033: my $role_start = 0;
5034: $active_chk = 'active';
5035: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
5036: $role_end = $1;
5037: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
5038: $role_start = $1;
5039: }
5040: }
5041: if ($role_start > 0) {
5042: if ($now < $role_start) {
5043: $active_chk = 'future';
5044: }
5045: }
5046: if ($role_end > 0) {
5047: if ($now > $role_end) {
5048: $active_chk = 'previous';
5049: }
5050: }
5051: }
5052: }
5053: return $active_chk;
5054: }
5055:
5056: ###############################################
5057:
5058: =pod
5059:
5060: =item * &get_sections()
5061:
5062: Determines all the sections for a course including
5063: sections with students and sections containing other roles.
5064: Incoming parameters:
5065:
5066: 1. domain
5067: 2. course number
5068: 3. reference to array containing roles for which sections should
5069: be gathered (optional).
5070: 4. reference to array containing status types for which sections
5071: should be gathered (optional).
5072:
5073: If the third argument is undefined, sections are gathered for any role.
5074: If the fourth argument is undefined, sections are gathered for any status.
5075: Permissible values are 'active' or 'future' or 'previous'.
5076:
5077: Returns section hash (keys are section IDs, values are
5078: number of users in each section), subject to the
5079: optional roles filter, optional status filter
5080:
5081: =cut
5082:
5083: ###############################################
5084: sub get_sections {
5085: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
5086: if (!defined($cdom) || !defined($cnum)) {
5087: my $cid = $env{'request.course.id'};
5088:
5089: return if (!defined($cid));
5090:
5091: $cdom = $env{'course.'.$cid.'.domain'};
5092: $cnum = $env{'course.'.$cid.'.num'};
5093: }
5094:
5095: my %sectioncount;
5096: my $now = time;
5097:
5098: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
5099: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
5100: my $sec_index = &Apache::loncoursedata::CL_SECTION();
5101: my $status_index = &Apache::loncoursedata::CL_STATUS();
5102: my $start_index = &Apache::loncoursedata::CL_START();
5103: my $end_index = &Apache::loncoursedata::CL_END();
5104: my $status;
5105: while (my ($student,$data) = each(%$classlist)) {
5106: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
5107: $data->[$status_index],
5108: $data->[$start_index],
5109: $data->[$end_index]);
5110: if ($stu_status eq 'Active') {
5111: $status = 'active';
5112: } elsif ($end < $now) {
5113: $status = 'previous';
5114: } elsif ($start > $now) {
5115: $status = 'future';
5116: }
5117: if ($section ne '-1' && $section !~ /^\s*$/) {
5118: if ((!defined($possible_status)) || (($status ne '') &&
5119: (grep/^\Q$status\E$/,@{$possible_status}))) {
5120: $sectioncount{$section}++;
5121: }
5122: }
5123: }
5124: }
5125: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5126: foreach my $user (sort(keys(%courseroles))) {
5127: if ($user !~ /^(\w{2})/) { next; }
5128: my ($role) = ($user =~ /^(\w{2})/);
5129: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
5130: my ($section,$status);
5131: if ($role eq 'cr' &&
5132: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
5133: $section=$1;
5134: }
5135: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
5136: if (!defined($section) || $section eq '-1') { next; }
5137: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
5138: if ($end == -1 && $start == -1) {
5139: next; #deleted role
5140: }
5141: if (!defined($possible_status)) {
5142: $sectioncount{$section}++;
5143: } else {
5144: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
5145: $status = 'active';
5146: } elsif ($end < $now) {
5147: $status = 'future';
5148: } elsif ($start > $now) {
5149: $status = 'previous';
5150: }
5151: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
5152: $sectioncount{$section}++;
5153: }
5154: }
5155: }
5156: return %sectioncount;
5157: }
5158:
5159: ###############################################
5160:
5161: =pod
5162:
5163: =item * &get_course_users()
5164:
5165: Retrieves usernames:domains for users in the specified course
5166: with specific role(s), and access status.
5167:
5168: Incoming parameters:
5169: 1. course domain
5170: 2. course number
5171: 3. access status: users must have - either active,
5172: previous, future, or all.
5173: 4. reference to array of permissible roles
5174: 5. reference to array of section restrictions (optional)
5175: 6. reference to results object (hash of hashes).
5176: 7. reference to optional userdata hash
5177: Keys of top level hash are roles.
5178: Keys of inner hashes are username:domain, with
5179: values set to access type.
5180: Optional userdata hash returns an array with arguments in the
5181: same order as loncoursedata::get_classlist() for student data.
5182:
5183: Entries for end, start, section and status are blank because
5184: of the possibility of multiple values for non-student roles.
5185:
5186: =cut
5187:
5188: ###############################################
5189:
5190: sub get_course_users {
5191: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
5192: my %idx = ();
5193: my %seclists;
5194:
5195: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
5196: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
5197: $idx{end} = &Apache::loncoursedata::CL_END();
5198: $idx{start} = &Apache::loncoursedata::CL_START();
5199: $idx{id} = &Apache::loncoursedata::CL_ID();
5200: $idx{section} = &Apache::loncoursedata::CL_SECTION();
5201: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
5202: $idx{status} = &Apache::loncoursedata::CL_STATUS();
5203:
5204: if (grep(/^st$/,@{$roles})) {
5205: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
5206: my $now = time;
5207: foreach my $student (keys(%{$classlist})) {
5208: my $match = 0;
5209: my $secmatch = 0;
5210: my $section = $$classlist{$student}[$idx{section}];
5211: if ($section eq '') {
5212: $section = 'none';
5213: }
5214: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
5215: if (grep(/^all$/,@{$sections})) {
5216: $secmatch = 1;
5217: } elsif ($$classlist{$student}[$idx{section}] eq '') {
5218: if (grep(/^none$/,@{$sections})) {
5219: $secmatch = 1;
5220: }
5221: } else {
5222: if (grep(/^\Q$section\E$/,@{$sections})) {
5223: $secmatch = 1;
5224: }
5225: }
5226: if (!$secmatch) {
5227: next;
5228: }
5229: }
5230: push(@{$seclists{$student}},$section);
5231: if (defined($$types{'active'})) {
5232: if ($$classlist{$student}[$idx{status}] eq 'Active') {
5233: push(@{$$users{st}{$student}},'active');
5234: $match = 1;
5235: }
5236: }
5237: if (defined($$types{'previous'})) {
5238: if ($$classlist{$student}[$idx{end}] <= $now) {
5239: push(@{$$users{st}{$student}},'previous');
5240: $match = 1;
5241: }
5242: }
5243: if (defined($$types{'future'})) {
5244: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
5245: push(@{$$users{st}{$student}},'future');
5246: $match = 1;
5247: }
5248: }
5249: if ($match && ref($userdata) eq 'HASH') {
5250: $$userdata{$student} = $$classlist{$student};
5251: }
5252: }
5253: }
5254: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
5255: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5256: my $now = time;
5257: foreach my $person (sort(keys(%coursepersonnel))) {
5258: my $match = 0;
5259: my $secmatch = 0;
5260: my $status;
5261: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
5262: $user =~ s/:$//;
5263: my ($end,$start) = split(/:/,$coursepersonnel{$person});
5264: if ($end == -1 || $start == -1) {
5265: next;
5266: }
5267: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
5268: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
5269: my ($uname,$udom) = split(/:/,$user);
5270: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
5271: if (grep(/^all$/,@{$sections})) {
5272: $secmatch = 1;
5273: } elsif ($usec eq '') {
5274: if (grep(/^none$/,@{$sections})) {
5275: $secmatch = 1;
5276: }
5277: } else {
5278: if (grep(/^\Q$usec\E$/,@{$sections})) {
5279: $secmatch = 1;
5280: }
5281: }
5282: if (!$secmatch) {
5283: next;
5284: }
5285: }
5286: if ($usec eq '') {
5287: $usec = 'none';
5288: }
5289: if ($uname ne '' && $udom ne '') {
5290: if ($end > 0 && $end < $now) {
5291: $status = 'previous';
5292: } elsif ($start > $now) {
5293: $status = 'future';
5294: } else {
5295: $status = 'active';
5296: }
5297: foreach my $type (keys(%{$types})) {
5298: if ($status eq $type) {
5299: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
5300: push(@{$$users{$role}{$user}},$type);
5301: }
5302: $match = 1;
5303: }
5304: }
5305: if (($match) && (ref($userdata) eq 'HASH')) {
5306: if (!exists($$userdata{$uname.':'.$udom})) {
5307: &get_user_info($udom,$uname,\%idx,$userdata);
5308: }
5309: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
5310: push(@{$seclists{$uname.':'.$udom}},$usec);
5311: }
5312: }
5313: }
5314: }
5315: }
5316: if (grep(/^ow$/,@{$roles})) {
5317: if ((defined($cdom)) && (defined($cnum))) {
5318: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
5319: if ( defined($csettings{'internal.courseowner'}) ) {
5320: my $owner = $csettings{'internal.courseowner'};
5321: if ($owner !~ /^[^:]+:[^:]+$/) {
5322: $owner = $owner.':'.$cdom;
5323: }
5324: @{$$users{'ow'}{$owner}} = 'any';
5325: if (defined($userdata) &&
5326: !exists($$userdata{$owner.':'.$cdom})) {
5327: &get_user_info($cdom,$owner,\%idx,$userdata);
5328: if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
5329: push(@{$seclists{$owner.':'.$cdom}},'none');
5330: }
5331: }
5332: }
5333: }
5334: }
5335: foreach my $user (keys(%seclists)) {
5336: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
5337: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
5338: }
5339: }
5340: return;
5341: }
5342:
5343: sub get_user_info {
5344: my ($udom,$uname,$idx,$userdata) = @_;
5345: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
5346: &plainname($uname,$udom,'lastname');
5347: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
5348: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
5349: return;
5350: }
5351:
5352: ###############################################
5353:
5354: =pod
5355:
5356: =item * &get_user_quota()
5357:
5358: Retrieves quota assigned for storage of portfolio files for a user
5359:
5360: Incoming parameters:
5361: 1. user's username
5362: 2. user's domain
5363:
5364: Returns:
5365: 1. Disk quota (in Mb) assigned to student.
5366: 2. (Optional) Type of setting: custom or default
5367: (individually assigned or default for user's
5368: institutional status).
5369: 3. (Optional) - User's institutional status (e.g., faculty, staff
5370: or student - types as defined in localenroll::inst_usertypes
5371: for user's domain, which determines default quota for user.
5372: 4. (Optional) - Default quota which would apply to the user.
5373:
5374: If a value has been stored in the user's environment,
5375: it will return that, otherwise it returns the maximal default
5376: defined for the user's instituional status(es) in the domain.
5377:
5378: =cut
5379:
5380: ###############################################
5381:
5382:
5383: sub get_user_quota {
5384: my ($uname,$udom) = @_;
5385: my ($quota,$quotatype,$settingstatus,$defquota);
5386: if (!defined($udom)) {
5387: $udom = $env{'user.domain'};
5388: }
5389: if (!defined($uname)) {
5390: $uname = $env{'user.name'};
5391: }
5392: if (($udom eq '' || $uname eq '') ||
5393: ($udom eq 'public') && ($uname eq 'public')) {
5394: $quota = 0;
5395: $quotatype = 'default';
5396: $defquota = 0;
5397: } else {
5398: my $inststatus;
5399: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
5400: $quota = $env{'environment.portfolioquota'};
5401: $inststatus = $env{'environment.inststatus'};
5402: } else {
5403: my %userenv =
5404: &Apache::lonnet::get('environment',['portfolioquota',
5405: 'inststatus'],$udom,$uname);
5406: my ($tmp) = keys(%userenv);
5407: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5408: $quota = $userenv{'portfolioquota'};
5409: $inststatus = $userenv{'inststatus'};
5410: } else {
5411: undef(%userenv);
5412: }
5413: }
5414: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
5415: if ($quota eq '') {
5416: $quota = $defquota;
5417: $quotatype = 'default';
5418: } else {
5419: $quotatype = 'custom';
5420: }
5421: }
5422: if (wantarray) {
5423: return ($quota,$quotatype,$settingstatus,$defquota);
5424: } else {
5425: return $quota;
5426: }
5427: }
5428:
5429: ###############################################
5430:
5431: =pod
5432:
5433: =item * &default_quota()
5434:
5435: Retrieves default quota assigned for storage of user portfolio files,
5436: given an (optional) user's institutional status.
5437:
5438: Incoming parameters:
5439: 1. domain
5440: 2. (Optional) institutional status(es). This is a : separated list of
5441: status types (e.g., faculty, staff, student etc.)
5442: which apply to the user for whom the default is being retrieved.
5443: If the institutional status string in undefined, the domain
5444: default quota will be returned.
5445:
5446: Returns:
5447: 1. Default disk quota (in Mb) for user portfolios in the domain.
5448: 2. (Optional) institutional type which determined the value of the
5449: default quota.
5450:
5451: If a value has been stored in the domain's configuration db,
5452: it will return that, otherwise it returns 20 (for backwards
5453: compatibility with domains which have not set up a configuration
5454: db file; the original statically defined portfolio quota was 20 Mb).
5455:
5456: If the user's status includes multiple types (e.g., staff and student),
5457: the largest default quota which applies to the user determines the
5458: default quota returned.
5459:
5460: =cut
5461:
5462: ###############################################
5463:
5464:
5465: sub default_quota {
5466: my ($udom,$inststatus) = @_;
5467: my ($defquota,$settingstatus);
5468: my %quotahash = &Apache::lonnet::get_dom('configuration',
5469: ['quota'],$udom);
5470: if (ref($quotahash{'quota'}) eq 'HASH') {
5471: if ($inststatus ne '') {
5472: my @statuses = split(/:/,$inststatus);
5473: foreach my $item (@statuses) {
5474: if ($quotahash{'quota'}{$item} ne '') {
5475: if ($defquota eq '') {
5476: $defquota = $quotahash{'quota'}{$item};
5477: $settingstatus = $item;
5478: } elsif ($quotahash{'quota'}{$item} > $defquota) {
5479: $defquota = $quotahash{'quota'}{$item};
5480: $settingstatus = $item;
5481: }
5482: }
5483: }
5484: }
5485: if ($defquota eq '') {
5486: $defquota = $quotahash{'quota'}{'default'};
5487: $settingstatus = 'default';
5488: }
5489: } else {
5490: $settingstatus = 'default';
5491: $defquota = 20;
5492: }
5493: if (wantarray) {
5494: return ($defquota,$settingstatus);
5495: } else {
5496: return $defquota;
5497: }
5498: }
5499:
5500: sub get_secgrprole_info {
5501: my ($cdom,$cnum,$needroles,$type) = @_;
5502: my %sections_count = &get_sections($cdom,$cnum);
5503: my @sections = (sort {$a <=> $b} keys(%sections_count));
5504: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
5505: my @groups = sort(keys(%curr_groups));
5506: my $allroles = [];
5507: my $rolehash;
5508: my $accesshash = {
5509: active => 'Currently has access',
5510: future => 'Will have future access',
5511: previous => 'Previously had access',
5512: };
5513: if ($needroles) {
5514: $rolehash = {'all' => 'all'};
5515: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5516: if (&Apache::lonnet::error(%user_roles)) {
5517: undef(%user_roles);
5518: }
5519: foreach my $item (keys(%user_roles)) {
5520: my ($role)=split(/\:/,$item,2);
5521: if ($role eq 'cr') { next; }
5522: if ($role =~ /^cr/) {
5523: $$rolehash{$role} = (split('/',$role))[3];
5524: } else {
5525: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
5526: }
5527: }
5528: foreach my $key (sort(keys(%{$rolehash}))) {
5529: push(@{$allroles},$key);
5530: }
5531: push (@{$allroles},'st');
5532: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
5533: }
5534: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
5535: }
5536:
5537: sub user_picker {
5538: my ($dom,$srch,$forcenewuser) = @_;
5539: my $currdom = $dom;
5540: my %curr_selected = (
5541: srchin => 'dom',
5542: srchby => 'uname',
5543: );
5544: my $srchterm;
5545: if (ref($srch) eq 'HASH') {
5546: if ($srch->{'srchby'} ne '') {
5547: $curr_selected{'srchby'} = $srch->{'srchby'};
5548: }
5549: if ($srch->{'srchin'} ne '') {
5550: $curr_selected{'srchin'} = $srch->{'srchin'};
5551: }
5552: if ($srch->{'srchtype'} ne '') {
5553: $curr_selected{'srchtype'} = $srch->{'srchtype'};
5554: }
5555: if ($srch->{'srchdomain'} ne '') {
5556: $currdom = $srch->{'srchdomain'};
5557: }
5558: $srchterm = $srch->{'srchterm'};
5559: }
5560: use Data::Dumper;
5561: &Apache::lonnet::logthis(&Dumper($srch));
5562: my %lt=&Apache::lonlocal::texthash(
5563: 'usr' => 'Search for',
5564: 'or' => 'or',
5565: 'doma' => 'domain',
5566: 'uname' => 'username',
5567: 'lastname' => 'last name',
5568: 'lastfirst' => 'last name, first name',
5569: 'crs' => 'in this course',
5570: 'dom' => 'in this domain',
5571: 'alc' => 'all LON-CAPA',
5572: 'instd' => 'in institutional directory',
5573: 'exact' => 'is',
5574: 'contains' => 'contains',
5575: );
5576: my $domform = &select_dom_form($currdom,'srchdomain',1);
5577:
5578: my $srchin;
5579:
5580: my @srchins = ('crs','dom','alc','instd');
5581:
5582: foreach my $option (@srchins) {
5583: # FIXME 'alc' option unavailable until
5584: # loncreateuser::print_user_query_page()
5585: # has been completed.
5586: next if ($option eq 'alc');
5587: next if ($option eq 'crs' && !$env{'request.course.id'});
5588: my $checked =($curr_selected{'srchin'} eq $option) ?'checked="checked"'
5589: :'';
5590: my $extra = ($option eq 'dom') ? $domform
5591: : '';
5592: $srchin.=<<ROW
5593: <tr>
5594: <td>
5595: <label><input type="radio" name="srchin" value="$option" $checked /> $lt{$option}</label> $extra
5596: </td>
5597: </tr>
5598: ROW
5599: }
5600:
5601: my $srchbysel = ' <select name="srchby">';
5602: foreach my $option ('uname','lastname','lastfirst') {
5603: if ($curr_selected{'srchby'} eq $option) {
5604: $srchbysel .= '
5605: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5606: } else {
5607: $srchbysel .= '
5608: <option value="'.$option.'">'.$lt{$option}.'</option>';
5609: }
5610: }
5611: $srchbysel .= "\n </select>\n";
5612:
5613: my $srchtypesel = ' <select name="srchtype">';
5614: foreach my $option ('exact','contains') {
5615: if ($curr_selected{'srchtype'} eq $option) {
5616: $srchtypesel .= '
5617: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5618: } else {
5619: $srchtypesel .= '
5620: <option value="'.$option.'">'.$lt{$option}.'</option>';
5621: }
5622: }
5623: $srchtypesel .= "\n </select>\n";
5624:
5625: my ($newuserscript,$new_user_create);
5626:
5627: if ($forcenewuser) {
5628: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\');" /> </p>';
5629: $newuserscript = <<"ENDSCRIPT";
5630:
5631: function setSearch(createnew) {
5632: if (createnew == 1) {
5633: for (var i=0; i<document.crtuser.srchby.length; i++) {
5634: if (document.crtuser.srchby.options[i].value == 'uname') {
5635: document.crtuser.srchby.selectedIndex = i;
5636: }
5637: }
5638: for (var i=0; i<document.crtuser.srchin.length; i++) {
5639: if ( document.crtuser.srchin[i].value == 'dom') {
5640: document.crtuser.srchin[i].checked = 1;
5641: }
5642: }
5643: for (var i=0; i<document.crtuser.srchtype.length; i++) {
5644: if (document.crtuser.srchtype.options[i].value == 'exact') {
5645: document.crtuser.srchtype.selectedIndex = i;
5646: }
5647: }
5648: for (var i=0; i<document.crtuser.srchdomain.length; i++) {
5649: if (document.crtuser.srchdomain.options[i].value == '$env{'request.role.domain'}') {
5650: document.crtuser.srchdomain.selectedIndex = i;
5651: }
5652: }
5653: }
5654: }
5655: ENDSCRIPT
5656:
5657: }
5658:
5659: my $output = <<"END_BLOCK";
5660: <script type="text/javascript">
5661: function validateEntry() {
5662:
5663: var checkok = 1;
5664: var srchin;
5665: for (var i=0; i<document.crtuser.srchin.length; i++) {
5666: if ( document.crtuser.srchin[i].checked ) {
5667: srchin = document.crtuser.srchin[i].value;
5668: }
5669: }
5670:
5671: var srchtype = document.crtuser.srchtype.options[document.crtuser.srchtype.selectedIndex].value;
5672: var srchby = document.crtuser.srchby.options[document.crtuser.srchby.selectedIndex].value;
5673: var srchdomain = document.crtuser.srchdomain.options[document.crtuser.srchdomain.selectedIndex].value;
5674: var srchterm = document.crtuser.srchterm.value;
5675: var msg = "";
5676:
5677: if (srchterm == "") {
5678: checkok = 0;
5679: msg += "You must include some text to search for.\\n";
5680: }
5681:
5682: if (srchtype== 'contains') {
5683: if (srchterm.length < 3) {
5684: checkok = 0;
5685: msg += "The text you are searching for must contain at least three characters when using a 'contained in' type search.\\n";
5686: }
5687: }
5688: if (srchin == 'instd') {
5689: if (srchdomain == '') {
5690: checkok = 0;
5691: msg += "You must choose a domain when using an institutional directory search.\\n";
5692: }
5693: }
5694: if (srchin == 'dom') {
5695: if (srchdomain == '') {
5696: checkok = 0;
5697: msg += "You must choose a domain when using a domain search.\\n";
5698: }
5699: }
5700: if (srchby == 'lastfirst') {
5701: if (srchterm.indexOf(",") == -1) {
5702: checkok = 0;
5703: msg += "When using searching by last,first you must include a comma as separator between last name and first name.\\n";
5704: }
5705: if (srchterm.indexOf(",") == srchterm.length -1) {
5706: checkok = 0;
5707: msg += "When searching by last,first you must include at least one character in the first name.\\n";
5708: }
5709: }
5710: if (checkok == 0) {
5711: alert("The following need to be corrected before the search can be run:\\n"+msg);
5712: return;
5713: }
5714: if (checkok == 1) {
5715: document.crtuser.submit();
5716: }
5717: }
5718:
5719: $newuserscript
5720:
5721: </script>
5722:
5723: $new_user_create
5724:
5725: <table>
5726: <tr>
5727: <td> $srchbysel
5728: $srchtypesel
5729: <input type="text" size="15" name="srchterm" value="$srchterm" />
5730: </td>
5731: </tr>
5732: $srchin
5733: </table>
5734: <br />
5735: END_BLOCK
5736:
5737: return $output;
5738: }
5739:
5740:
5741:
5742: =pod
5743:
5744: =back
5745:
5746: =head1 HTTP Helpers
5747:
5748: =over 4
5749:
5750: =item * get_unprocessed_cgi($query,$possible_names)
5751:
5752: Modify the %env hash to contain unprocessed CGI form parameters held in
5753: $query. The parameters listed in $possible_names (an array reference),
5754: will be set in $env{'form.name'} if they do not already exist.
5755:
5756: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
5757: $possible_names is an ref to an array of form element names. As an example:
5758: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
5759: will result in $env{'form.uname'} and $env{'form.udom'} being set.
5760:
5761: =cut
5762:
5763: sub get_unprocessed_cgi {
5764: my ($query,$possible_names)= @_;
5765: # $Apache::lonxml::debug=1;
5766: foreach my $pair (split(/&/,$query)) {
5767: my ($name, $value) = split(/=/,$pair);
5768: $name = &unescape($name);
5769: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
5770: $value =~ tr/+/ /;
5771: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
5772: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
5773: }
5774: }
5775: }
5776:
5777: =pod
5778:
5779: =item * cacheheader()
5780:
5781: returns cache-controlling header code
5782:
5783: =cut
5784:
5785: sub cacheheader {
5786: unless ($env{'request.method'} eq 'GET') { return ''; }
5787: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
5788: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
5789: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
5790: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
5791: return $output;
5792: }
5793:
5794: =pod
5795:
5796: =item * no_cache($r)
5797:
5798: specifies header code to not have cache
5799:
5800: =cut
5801:
5802: sub no_cache {
5803: my ($r) = @_;
5804: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
5805: $env{'request.method'} ne 'GET') { return ''; }
5806: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
5807: $r->no_cache(1);
5808: $r->header_out("Expires" => $date);
5809: $r->header_out("Pragma" => "no-cache");
5810: }
5811:
5812: sub content_type {
5813: my ($r,$type,$charset) = @_;
5814: if ($r) {
5815: # Note that printout.pl calls this with undef for $r.
5816: &no_cache($r);
5817: }
5818: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
5819: unless ($charset) {
5820: $charset=&Apache::lonlocal::current_encoding;
5821: }
5822: if ($charset) { $type.='; charset='.$charset; }
5823: if ($r) {
5824: $r->content_type($type);
5825: } else {
5826: print("Content-type: $type\n\n");
5827: }
5828: }
5829:
5830: =pod
5831:
5832: =item * add_to_env($name,$value)
5833:
5834: adds $name to the %env hash with value
5835: $value, if $name already exists, the entry is converted to an array
5836: reference and $value is added to the array.
5837:
5838: =cut
5839:
5840: sub add_to_env {
5841: my ($name,$value)=@_;
5842: if (defined($env{$name})) {
5843: if (ref($env{$name})) {
5844: #already have multiple values
5845: push(@{ $env{$name} },$value);
5846: } else {
5847: #first time seeing multiple values, convert hash entry to an arrayref
5848: my $first=$env{$name};
5849: undef($env{$name});
5850: push(@{ $env{$name} },$first,$value);
5851: }
5852: } else {
5853: $env{$name}=$value;
5854: }
5855: }
5856:
5857: =pod
5858:
5859: =item * get_env_multiple($name)
5860:
5861: gets $name from the %env hash, it seemlessly handles the cases where multiple
5862: values may be defined and end up as an array ref.
5863:
5864: returns an array of values
5865:
5866: =cut
5867:
5868: sub get_env_multiple {
5869: my ($name) = @_;
5870: my @values;
5871: if (defined($env{$name})) {
5872: # exists is it an array
5873: if (ref($env{$name})) {
5874: @values=@{ $env{$name} };
5875: } else {
5876: $values[0]=$env{$name};
5877: }
5878: }
5879: return(@values);
5880: }
5881:
5882:
5883: =pod
5884:
5885: =back
5886:
5887: =head1 CSV Upload/Handling functions
5888:
5889: =over 4
5890:
5891: =item * upfile_store($r)
5892:
5893: Store uploaded file, $r should be the HTTP Request object,
5894: needs $env{'form.upfile'}
5895: returns $datatoken to be put into hidden field
5896:
5897: =cut
5898:
5899: sub upfile_store {
5900: my $r=shift;
5901: $env{'form.upfile'}=~s/\r/\n/gs;
5902: $env{'form.upfile'}=~s/\f/\n/gs;
5903: $env{'form.upfile'}=~s/\n+/\n/gs;
5904: $env{'form.upfile'}=~s/\n+$//gs;
5905:
5906: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
5907: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
5908: {
5909: my $datafile = $r->dir_config('lonDaemons').
5910: '/tmp/'.$datatoken.'.tmp';
5911: if ( open(my $fh,">$datafile") ) {
5912: print $fh $env{'form.upfile'};
5913: close($fh);
5914: }
5915: }
5916: return $datatoken;
5917: }
5918:
5919: =pod
5920:
5921: =item * load_tmp_file($r)
5922:
5923: Load uploaded file from tmp, $r should be the HTTP Request object,
5924: needs $env{'form.datatoken'},
5925: sets $env{'form.upfile'} to the contents of the file
5926:
5927: =cut
5928:
5929: sub load_tmp_file {
5930: my $r=shift;
5931: my @studentdata=();
5932: {
5933: my $studentfile = $r->dir_config('lonDaemons').
5934: '/tmp/'.$env{'form.datatoken'}.'.tmp';
5935: if ( open(my $fh,"<$studentfile") ) {
5936: @studentdata=<$fh>;
5937: close($fh);
5938: }
5939: }
5940: $env{'form.upfile'}=join('',@studentdata);
5941: }
5942:
5943: =pod
5944:
5945: =item * upfile_record_sep()
5946:
5947: Separate uploaded file into records
5948: returns array of records,
5949: needs $env{'form.upfile'} and $env{'form.upfiletype'}
5950:
5951: =cut
5952:
5953: sub upfile_record_sep {
5954: if ($env{'form.upfiletype'} eq 'xml') {
5955: } else {
5956: my @records;
5957: foreach my $line (split(/\n/,$env{'form.upfile'})) {
5958: if ($line=~/^\s*$/) { next; }
5959: push(@records,$line);
5960: }
5961: return @records;
5962: }
5963: }
5964:
5965: =pod
5966:
5967: =item * record_sep($record)
5968:
5969: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
5970:
5971: =cut
5972:
5973: sub takeleft {
5974: my $index=shift;
5975: return substr('0000'.$index,-4,4);
5976: }
5977:
5978: sub record_sep {
5979: my $record=shift;
5980: my %components=();
5981: if ($env{'form.upfiletype'} eq 'xml') {
5982: } elsif ($env{'form.upfiletype'} eq 'space') {
5983: my $i=0;
5984: foreach my $field (split(/\s+/,$record)) {
5985: $field=~s/^(\"|\')//;
5986: $field=~s/(\"|\')$//;
5987: $components{&takeleft($i)}=$field;
5988: $i++;
5989: }
5990: } elsif ($env{'form.upfiletype'} eq 'tab') {
5991: my $i=0;
5992: foreach my $field (split(/\t/,$record)) {
5993: $field=~s/^(\"|\')//;
5994: $field=~s/(\"|\')$//;
5995: $components{&takeleft($i)}=$field;
5996: $i++;
5997: }
5998: } else {
5999: my @allfields;
6000: if ($env{'form.upfiletype'} eq 'semisv') {
6001: @allfields=split(/;/,$record,-1);
6002: } else {
6003: @allfields=split(/\,/,$record,-1);
6004: }
6005: my $i=0;
6006: my $j;
6007: for ($j=0;$j<=$#allfields;$j++) {
6008: my $field=$allfields[$j];
6009: if ($field=~/^\s*(\"|\')/) {
6010: my $delimiter=$1;
6011: while (($field!~/$delimiter$/) && ($j<$#allfields)) {
6012: $j++;
6013: $field.=','.$allfields[$j];
6014: }
6015: $field=~s/^\s*$delimiter//;
6016: $field=~s/$delimiter\s*$//;
6017: }
6018: $components{&takeleft($i)}=$field;
6019: $i++;
6020: }
6021: }
6022: return %components;
6023: }
6024:
6025: ######################################################
6026: ######################################################
6027:
6028: =pod
6029:
6030: =item * upfile_select_html()
6031:
6032: Return HTML code to select a file from the users machine and specify
6033: the file type.
6034:
6035: =cut
6036:
6037: ######################################################
6038: ######################################################
6039: sub upfile_select_html {
6040: my %Types = (
6041: csv => &mt('CSV (comma separated values, spreadsheet)'),
6042: semisv => &mt('Semicolon separated values'),
6043: space => &mt('Space separated'),
6044: tab => &mt('Tabulator separated'),
6045: # xml => &mt('HTML/XML'),
6046: );
6047: my $Str = '<input type="file" name="upfile" size="50" />'.
6048: '<br />Type: <select name="upfiletype">';
6049: foreach my $type (sort(keys(%Types))) {
6050: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
6051: }
6052: $Str .= "</select>\n";
6053: return $Str;
6054: }
6055:
6056: sub get_samples {
6057: my ($records,$toget) = @_;
6058: my @samples=({});
6059: my $got=0;
6060: foreach my $rec (@$records) {
6061: my %temp = &record_sep($rec);
6062: if (! grep(/\S/, values(%temp))) { next; }
6063: if (%temp) {
6064: $samples[$got]=\%temp;
6065: $got++;
6066: if ($got == $toget) { last; }
6067: }
6068: }
6069: return \@samples;
6070: }
6071:
6072: ######################################################
6073: ######################################################
6074:
6075: =pod
6076:
6077: =item * csv_print_samples($r,$records)
6078:
6079: Prints a table of sample values from each column uploaded $r is an
6080: Apache Request ref, $records is an arrayref from
6081: &Apache::loncommon::upfile_record_sep
6082:
6083: =cut
6084:
6085: ######################################################
6086: ######################################################
6087: sub csv_print_samples {
6088: my ($r,$records) = @_;
6089: my $samples = &get_samples($records,3);
6090:
6091: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
6092: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6093: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
6094: $r->print('</tr>');
6095: foreach my $hash (@$samples) {
6096: $r->print('<tr>');
6097: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6098: $r->print('<td>');
6099: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
6100: $r->print('</td>');
6101: }
6102: $r->print('</tr>');
6103: }
6104: $r->print('</tr></table><br />'."\n");
6105: }
6106:
6107: ######################################################
6108: ######################################################
6109:
6110: =pod
6111:
6112: =item * csv_print_select_table($r,$records,$d)
6113:
6114: Prints a table to create associations between values and table columns.
6115:
6116: $r is an Apache Request ref,
6117: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
6118: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
6119:
6120: =cut
6121:
6122: ######################################################
6123: ######################################################
6124: sub csv_print_select_table {
6125: my ($r,$records,$d) = @_;
6126: my $i=0;
6127: my $samples = &get_samples($records,1);
6128: $r->print(&mt('Associate columns with student attributes.')."\n".
6129: '<table border="2"><tr>'.
6130: '<th>'.&mt('Attribute').'</th>'.
6131: '<th>'.&mt('Column').'</th></tr>'."\n");
6132: foreach my $array_ref (@$d) {
6133: my ($value,$display,$defaultcol)=@{ $array_ref };
6134: $r->print('<tr><td>'.$display.'</td>');
6135:
6136: $r->print('<td><select name=f'.$i.
6137: ' onchange="javascript:flip(this.form,'.$i.');">');
6138: $r->print('<option value="none"></option>');
6139: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6140: $r->print('<option value="'.$sample.'"'.
6141: ($sample eq $defaultcol ? ' selected="selected" ' : '').
6142: '>Column '.($sample+1).'</option>');
6143: }
6144: $r->print('</select></td></tr>'."\n");
6145: $i++;
6146: }
6147: $i--;
6148: return $i;
6149: }
6150:
6151: ######################################################
6152: ######################################################
6153:
6154: =pod
6155:
6156: =item * csv_samples_select_table($r,$records,$d)
6157:
6158: Prints a table of sample values from the upload and can make associate samples to internal names.
6159:
6160: $r is an Apache Request ref,
6161: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
6162: $d is an array of 2 element arrays (internal name, displayed name)
6163:
6164: =cut
6165:
6166: ######################################################
6167: ######################################################
6168: sub csv_samples_select_table {
6169: my ($r,$records,$d) = @_;
6170: my $i=0;
6171: #
6172: my $samples = &get_samples($records,3);
6173: $r->print('<table border=2><tr><th>'.
6174: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
6175:
6176: foreach my $key (sort(keys(%{ $samples->[0] }))) {
6177: $r->print('<tr><td><select name="f'.$i.'"'.
6178: ' onchange="javascript:flip(this.form,'.$i.');">');
6179: foreach my $option (@$d) {
6180: my ($value,$display,$defaultcol)=@{ $option };
6181: $r->print('<option value="'.$value.'"'.
6182: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
6183: $display.'</option>');
6184: }
6185: $r->print('</select></td><td>');
6186: foreach my $line (0..2) {
6187: if (defined($samples->[$line]{$key})) {
6188: $r->print($samples->[$line]{$key}."<br />\n");
6189: }
6190: }
6191: $r->print('</td></tr>');
6192: $i++;
6193: }
6194: $i--;
6195: return($i);
6196: }
6197:
6198: ######################################################
6199: ######################################################
6200:
6201: =pod
6202:
6203: =item clean_excel_name($name)
6204:
6205: Returns a replacement for $name which does not contain any illegal characters.
6206:
6207: =cut
6208:
6209: ######################################################
6210: ######################################################
6211: sub clean_excel_name {
6212: my ($name) = @_;
6213: $name =~ s/[:\*\?\/\\]//g;
6214: if (length($name) > 31) {
6215: $name = substr($name,0,31);
6216: }
6217: return $name;
6218: }
6219:
6220: =pod
6221:
6222: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
6223:
6224: Returns either 1 or undef
6225:
6226: 1 if the part is to be hidden, undef if it is to be shown
6227:
6228: Arguments are:
6229:
6230: $id the id of the part to be checked
6231: $symb, optional the symb of the resource to check
6232: $udom, optional the domain of the user to check for
6233: $uname, optional the username of the user to check for
6234:
6235: =cut
6236:
6237: sub check_if_partid_hidden {
6238: my ($id,$symb,$udom,$uname) = @_;
6239: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
6240: $symb,$udom,$uname);
6241: my $truth=1;
6242: #if the string starts with !, then the list is the list to show not hide
6243: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
6244: my @hiddenlist=split(/,/,$hiddenparts);
6245: foreach my $checkid (@hiddenlist) {
6246: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
6247: }
6248: return !$truth;
6249: }
6250:
6251:
6252: ############################################################
6253: ############################################################
6254:
6255: =pod
6256:
6257: =back
6258:
6259: =head1 cgi-bin script and graphing routines
6260:
6261: =over 4
6262:
6263: =item get_cgi_id
6264:
6265: Inputs: none
6266:
6267: Returns an id which can be used to pass environment variables
6268: to various cgi-bin scripts. These environment variables will
6269: be removed from the users environment after a given time by
6270: the routine &Apache::lonnet::transfer_profile_to_env.
6271:
6272: =cut
6273:
6274: ############################################################
6275: ############################################################
6276: my $uniq=0;
6277: sub get_cgi_id {
6278: $uniq=($uniq+1)%100000;
6279: return (time.'_'.$$.'_'.$uniq);
6280: }
6281:
6282: ############################################################
6283: ############################################################
6284:
6285: =pod
6286:
6287: =item DrawBarGraph
6288:
6289: Facilitates the plotting of data in a (stacked) bar graph.
6290: Puts plot definition data into the users environment in order for
6291: graph.png to plot it. Returns an <img> tag for the plot.
6292: The bars on the plot are labeled '1','2',...,'n'.
6293:
6294: Inputs:
6295:
6296: =over 4
6297:
6298: =item $Title: string, the title of the plot
6299:
6300: =item $xlabel: string, text describing the X-axis of the plot
6301:
6302: =item $ylabel: string, text describing the Y-axis of the plot
6303:
6304: =item $Max: scalar, the maximum Y value to use in the plot
6305: If $Max is < any data point, the graph will not be rendered.
6306:
6307: =item $colors: array ref holding the colors to be used for the data sets when
6308: they are plotted. If undefined, default values will be used.
6309:
6310: =item $labels: array ref holding the labels to use on the x-axis for the bars.
6311:
6312: =item @Values: An array of array references. Each array reference holds data
6313: to be plotted in a stacked bar chart.
6314:
6315: =item If the final element of @Values is a hash reference the key/value
6316: pairs will be added to the graph definition.
6317:
6318: =back
6319:
6320: Returns:
6321:
6322: An <img> tag which references graph.png and the appropriate identifying
6323: information for the plot.
6324:
6325: =cut
6326:
6327: ############################################################
6328: ############################################################
6329: sub DrawBarGraph {
6330: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
6331: #
6332: if (! defined($colors)) {
6333: $colors = ['#33ff00',
6334: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
6335: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
6336: ];
6337: }
6338: my $extra_settings = {};
6339: if (ref($Values[-1]) eq 'HASH') {
6340: $extra_settings = pop(@Values);
6341: }
6342: #
6343: my $identifier = &get_cgi_id();
6344: my $id = 'cgi.'.$identifier;
6345: if (! @Values || ref($Values[0]) ne 'ARRAY') {
6346: return '';
6347: }
6348: #
6349: my @Labels;
6350: if (defined($labels)) {
6351: @Labels = @$labels;
6352: } else {
6353: for (my $i=0;$i<@{$Values[0]};$i++) {
6354: push (@Labels,$i+1);
6355: }
6356: }
6357: #
6358: my $NumBars = scalar(@{$Values[0]});
6359: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
6360: my %ValuesHash;
6361: my $NumSets=1;
6362: foreach my $array (@Values) {
6363: next if (! ref($array));
6364: $ValuesHash{$id.'.data.'.$NumSets++} =
6365: join(',',@$array);
6366: }
6367: #
6368: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
6369: if ($NumBars < 3) {
6370: $width = 120+$NumBars*32;
6371: $xskip = 1;
6372: $bar_width = 30;
6373: } elsif ($NumBars < 5) {
6374: $width = 120+$NumBars*20;
6375: $xskip = 1;
6376: $bar_width = 20;
6377: } elsif ($NumBars < 10) {
6378: $width = 120+$NumBars*15;
6379: $xskip = 1;
6380: $bar_width = 15;
6381: } elsif ($NumBars <= 25) {
6382: $width = 120+$NumBars*11;
6383: $xskip = 5;
6384: $bar_width = 8;
6385: } elsif ($NumBars <= 50) {
6386: $width = 120+$NumBars*8;
6387: $xskip = 5;
6388: $bar_width = 4;
6389: } else {
6390: $width = 120+$NumBars*8;
6391: $xskip = 5;
6392: $bar_width = 4;
6393: }
6394: #
6395: $Max = 1 if ($Max < 1);
6396: if ( int($Max) < $Max ) {
6397: $Max++;
6398: $Max = int($Max);
6399: }
6400: $Title = '' if (! defined($Title));
6401: $xlabel = '' if (! defined($xlabel));
6402: $ylabel = '' if (! defined($ylabel));
6403: $ValuesHash{$id.'.title'} = &escape($Title);
6404: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
6405: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
6406: $ValuesHash{$id.'.y_max_value'} = $Max;
6407: $ValuesHash{$id.'.NumBars'} = $NumBars;
6408: $ValuesHash{$id.'.NumSets'} = $NumSets;
6409: $ValuesHash{$id.'.PlotType'} = 'bar';
6410: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6411: $ValuesHash{$id.'.height'} = $height;
6412: $ValuesHash{$id.'.width'} = $width;
6413: $ValuesHash{$id.'.xskip'} = $xskip;
6414: $ValuesHash{$id.'.bar_width'} = $bar_width;
6415: $ValuesHash{$id.'.labels'} = join(',',@Labels);
6416: #
6417: # Deal with other parameters
6418: while (my ($key,$value) = each(%$extra_settings)) {
6419: $ValuesHash{$id.'.'.$key} = $value;
6420: }
6421: #
6422: &Apache::lonnet::appenv(%ValuesHash);
6423: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6424: }
6425:
6426: ############################################################
6427: ############################################################
6428:
6429: =pod
6430:
6431: =item DrawXYGraph
6432:
6433: Facilitates the plotting of data in an XY graph.
6434: Puts plot definition data into the users environment in order for
6435: graph.png to plot it. Returns an <img> tag for the plot.
6436:
6437: Inputs:
6438:
6439: =over 4
6440:
6441: =item $Title: string, the title of the plot
6442:
6443: =item $xlabel: string, text describing the X-axis of the plot
6444:
6445: =item $ylabel: string, text describing the Y-axis of the plot
6446:
6447: =item $Max: scalar, the maximum Y value to use in the plot
6448: If $Max is < any data point, the graph will not be rendered.
6449:
6450: =item $colors: Array ref containing the hex color codes for the data to be
6451: plotted in. If undefined, default values will be used.
6452:
6453: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6454:
6455: =item $Ydata: Array ref containing Array refs.
6456: Each of the contained arrays will be plotted as a separate curve.
6457:
6458: =item %Values: hash indicating or overriding any default values which are
6459: passed to graph.png.
6460: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6461:
6462: =back
6463:
6464: Returns:
6465:
6466: An <img> tag which references graph.png and the appropriate identifying
6467: information for the plot.
6468:
6469: =cut
6470:
6471: ############################################################
6472: ############################################################
6473: sub DrawXYGraph {
6474: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
6475: #
6476: # Create the identifier for the graph
6477: my $identifier = &get_cgi_id();
6478: my $id = 'cgi.'.$identifier;
6479: #
6480: $Title = '' if (! defined($Title));
6481: $xlabel = '' if (! defined($xlabel));
6482: $ylabel = '' if (! defined($ylabel));
6483: my %ValuesHash =
6484: (
6485: $id.'.title' => &escape($Title),
6486: $id.'.xlabel' => &escape($xlabel),
6487: $id.'.ylabel' => &escape($ylabel),
6488: $id.'.y_max_value'=> $Max,
6489: $id.'.labels' => join(',',@$Xlabels),
6490: $id.'.PlotType' => 'XY',
6491: );
6492: #
6493: if (defined($colors) && ref($colors) eq 'ARRAY') {
6494: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6495: }
6496: #
6497: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
6498: return '';
6499: }
6500: my $NumSets=1;
6501: foreach my $array (@{$Ydata}){
6502: next if (! ref($array));
6503: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
6504: }
6505: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
6506: #
6507: # Deal with other parameters
6508: while (my ($key,$value) = each(%Values)) {
6509: $ValuesHash{$id.'.'.$key} = $value;
6510: }
6511: #
6512: &Apache::lonnet::appenv(%ValuesHash);
6513: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6514: }
6515:
6516: ############################################################
6517: ############################################################
6518:
6519: =pod
6520:
6521: =item DrawXYYGraph
6522:
6523: Facilitates the plotting of data in an XY graph with two Y axes.
6524: Puts plot definition data into the users environment in order for
6525: graph.png to plot it. Returns an <img> tag for the plot.
6526:
6527: Inputs:
6528:
6529: =over 4
6530:
6531: =item $Title: string, the title of the plot
6532:
6533: =item $xlabel: string, text describing the X-axis of the plot
6534:
6535: =item $ylabel: string, text describing the Y-axis of the plot
6536:
6537: =item $colors: Array ref containing the hex color codes for the data to be
6538: plotted in. If undefined, default values will be used.
6539:
6540: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6541:
6542: =item $Ydata1: The first data set
6543:
6544: =item $Min1: The minimum value of the left Y-axis
6545:
6546: =item $Max1: The maximum value of the left Y-axis
6547:
6548: =item $Ydata2: The second data set
6549:
6550: =item $Min2: The minimum value of the right Y-axis
6551:
6552: =item $Max2: The maximum value of the left Y-axis
6553:
6554: =item %Values: hash indicating or overriding any default values which are
6555: passed to graph.png.
6556: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6557:
6558: =back
6559:
6560: Returns:
6561:
6562: An <img> tag which references graph.png and the appropriate identifying
6563: information for the plot.
6564:
6565: =cut
6566:
6567: ############################################################
6568: ############################################################
6569: sub DrawXYYGraph {
6570: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
6571: $Ydata2,$Min2,$Max2,%Values)=@_;
6572: #
6573: # Create the identifier for the graph
6574: my $identifier = &get_cgi_id();
6575: my $id = 'cgi.'.$identifier;
6576: #
6577: $Title = '' if (! defined($Title));
6578: $xlabel = '' if (! defined($xlabel));
6579: $ylabel = '' if (! defined($ylabel));
6580: my %ValuesHash =
6581: (
6582: $id.'.title' => &escape($Title),
6583: $id.'.xlabel' => &escape($xlabel),
6584: $id.'.ylabel' => &escape($ylabel),
6585: $id.'.labels' => join(',',@$Xlabels),
6586: $id.'.PlotType' => 'XY',
6587: $id.'.NumSets' => 2,
6588: $id.'.two_axes' => 1,
6589: $id.'.y1_max_value' => $Max1,
6590: $id.'.y1_min_value' => $Min1,
6591: $id.'.y2_max_value' => $Max2,
6592: $id.'.y2_min_value' => $Min2,
6593: );
6594: #
6595: if (defined($colors) && ref($colors) eq 'ARRAY') {
6596: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6597: }
6598: #
6599: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
6600: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
6601: return '';
6602: }
6603: my $NumSets=1;
6604: foreach my $array ($Ydata1,$Ydata2){
6605: next if (! ref($array));
6606: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
6607: }
6608: #
6609: # Deal with other parameters
6610: while (my ($key,$value) = each(%Values)) {
6611: $ValuesHash{$id.'.'.$key} = $value;
6612: }
6613: #
6614: &Apache::lonnet::appenv(%ValuesHash);
6615: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6616: }
6617:
6618: ############################################################
6619: ############################################################
6620:
6621: =pod
6622:
6623: =back
6624:
6625: =head1 Statistics helper routines?
6626:
6627: Bad place for them but what the hell.
6628:
6629: =over 4
6630:
6631: =item &chartlink
6632:
6633: Returns a link to the chart for a specific student.
6634:
6635: Inputs:
6636:
6637: =over 4
6638:
6639: =item $linktext: The text of the link
6640:
6641: =item $sname: The students username
6642:
6643: =item $sdomain: The students domain
6644:
6645: =back
6646:
6647: =back
6648:
6649: =cut
6650:
6651: ############################################################
6652: ############################################################
6653: sub chartlink {
6654: my ($linktext, $sname, $sdomain) = @_;
6655: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
6656: '&SelectedStudent='.&escape($sname.':'.$sdomain).
6657: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
6658: '">'.$linktext.'</a>';
6659: }
6660:
6661: #######################################################
6662: #######################################################
6663:
6664: =pod
6665:
6666: =head1 Course Environment Routines
6667:
6668: =over 4
6669:
6670: =item &restore_course_settings
6671:
6672: =item &store_course_settings
6673:
6674: Restores/Store indicated form parameters from the course environment.
6675: Will not overwrite existing values of the form parameters.
6676:
6677: Inputs:
6678: a scalar describing the data (e.g. 'chart', 'problem_analysis')
6679:
6680: a hash ref describing the data to be stored. For example:
6681:
6682: %Save_Parameters = ('Status' => 'scalar',
6683: 'chartoutputmode' => 'scalar',
6684: 'chartoutputdata' => 'scalar',
6685: 'Section' => 'array',
6686: 'Group' => 'array',
6687: 'StudentData' => 'array',
6688: 'Maps' => 'array');
6689:
6690: Returns: both routines return nothing
6691:
6692: =cut
6693:
6694: #######################################################
6695: #######################################################
6696: sub store_course_settings {
6697: return &store_settings($env{'request.course.id'},@_);
6698: }
6699:
6700: sub store_settings {
6701: # save to the environment
6702: # appenv the same items, just to be safe
6703: my $udom = $env{'user.domain'};
6704: my $uname = $env{'user.name'};
6705: my ($context,$prefix,$Settings) = @_;
6706: my %SaveHash;
6707: my %AppHash;
6708: while (my ($setting,$type) = each(%$Settings)) {
6709: my $basename = join('.','internal',$context,$prefix,$setting);
6710: my $envname = 'environment.'.$basename;
6711: if (exists($env{'form.'.$setting})) {
6712: # Save this value away
6713: if ($type eq 'scalar' &&
6714: (! exists($env{$envname}) ||
6715: $env{$envname} ne $env{'form.'.$setting})) {
6716: $SaveHash{$basename} = $env{'form.'.$setting};
6717: $AppHash{$envname} = $env{'form.'.$setting};
6718: } elsif ($type eq 'array') {
6719: my $stored_form;
6720: if (ref($env{'form.'.$setting})) {
6721: $stored_form = join(',',
6722: map {
6723: &escape($_);
6724: } sort(@{$env{'form.'.$setting}}));
6725: } else {
6726: $stored_form =
6727: &escape($env{'form.'.$setting});
6728: }
6729: # Determine if the array contents are the same.
6730: if ($stored_form ne $env{$envname}) {
6731: $SaveHash{$basename} = $stored_form;
6732: $AppHash{$envname} = $stored_form;
6733: }
6734: }
6735: }
6736: }
6737: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
6738: $udom,$uname);
6739: if ($put_result !~ /^(ok|delayed)/) {
6740: &Apache::lonnet::logthis('unable to save form parameters, '.
6741: 'got error:'.$put_result);
6742: }
6743: # Make sure these settings stick around in this session, too
6744: &Apache::lonnet::appenv(%AppHash);
6745: return;
6746: }
6747:
6748: sub restore_course_settings {
6749: return &restore_settings($env{'request.course.id'},@_);
6750: }
6751:
6752: sub restore_settings {
6753: my ($context,$prefix,$Settings) = @_;
6754: while (my ($setting,$type) = each(%$Settings)) {
6755: next if (exists($env{'form.'.$setting}));
6756: my $envname = 'environment.internal.'.$context.'.'.$prefix.
6757: '.'.$setting;
6758: if (exists($env{$envname})) {
6759: if ($type eq 'scalar') {
6760: $env{'form.'.$setting} = $env{$envname};
6761: } elsif ($type eq 'array') {
6762: $env{'form.'.$setting} = [
6763: map {
6764: &unescape($_);
6765: } split(',',$env{$envname})
6766: ];
6767: }
6768: }
6769: }
6770: }
6771:
6772: ############################################################
6773: ############################################################
6774:
6775: sub commit_customrole {
6776: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
6777: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
6778: ($start?', '.&mt('starting').' '.localtime($start):'').
6779: ($end?', ending '.localtime($end):'').': <b>'.
6780: &Apache::lonnet::assigncustomrole(
6781: $udom,$uname,$url,$three,$four,$five,$end,$start).
6782: '</b><br />';
6783: return $output;
6784: }
6785:
6786: sub commit_standardrole {
6787: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
6788: my ($output,$logmsg,$linefeed);
6789: if ($context eq 'auto') {
6790: $linefeed = "\n";
6791: } else {
6792: $linefeed = "<br />\n";
6793: }
6794: if ($three eq 'st') {
6795: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
6796: $one,$two,$sec,$context);
6797: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
6798: ($result eq 'unknown_course')) {
6799: $output = "Error: $result\n";
6800: } else {
6801: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
6802: ($start?', '.&mt('starting').' '.localtime($start):'').
6803: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
6804: if ($context eq 'auto') {
6805: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
6806: } else {
6807: $output .= '<b>'.$result.'</b>'.$linefeed.
6808: &mt('Add to classlist').': <b>ok</b>';
6809: }
6810: $output .= $linefeed;
6811: }
6812: } else {
6813: $output = &mt('Assigning').' '.$three.' in '.$url.
6814: ($start?', '.&mt('starting').' '.localtime($start):'').
6815: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
6816: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);
6817: if ($context eq 'auto') {
6818: $output .= $result.$linefeed;
6819: } else {
6820: $output .= '<b>'.$result.'</b>'.$linefeed;
6821: }
6822: }
6823: return $output;
6824: }
6825:
6826: sub commit_studentrole {
6827: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
6828: my ($result,$linefeed);
6829: if ($context eq 'auto') {
6830: $linefeed = "\n";
6831: } else {
6832: $linefeed = '<br />'."\n";
6833: }
6834: if (defined($one) && defined($two)) {
6835: my $cid=$one.'_'.$two;
6836: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
6837: my $secchange = 0;
6838: my $expire_role_result;
6839: my $modify_section_result;
6840: unless ($oldsec eq '-1') {
6841: unless ($sec eq $oldsec) {
6842: $secchange = 1;
6843: my $uurl='/'.$cid;
6844: $uurl=~s/\_/\//g;
6845: if ($oldsec) {
6846: $uurl.='/'.$oldsec;
6847: }
6848: $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
6849: $result = $expire_role_result;
6850: }
6851: }
6852: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
6853: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
6854: if ($modify_section_result =~ /^ok/) {
6855: if ($secchange == 1) {
6856: $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
6857: } elsif ($oldsec eq '-1') {
6858: $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
6859: } else {
6860: $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
6861: }
6862: } else {
6863: $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
6864: }
6865: $result = $modify_section_result;
6866: } elsif ($secchange == 1) {
6867: $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
6868: }
6869: } else {
6870: $$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
6871: $result = "error: incomplete course id\n";
6872: }
6873: return $result;
6874: }
6875:
6876: ############################################################
6877: ############################################################
6878:
6879: sub construct_course {
6880: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
6881: my $outcome;
6882: my $linefeed = '<br />'."\n";
6883: if ($context eq 'auto') {
6884: $linefeed = "\n";
6885: }
6886: #
6887: # Open course
6888: #
6889: my $crstype = lc($args->{'crstype'});
6890: my %cenv=();
6891: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
6892: $args->{'cdescr'},
6893: $args->{'curl'},
6894: $args->{'course_home'},
6895: $args->{'nonstandard'},
6896: $args->{'crscode'},
6897: $args->{'ccuname'}.':'.
6898: $args->{'ccdomain'},
6899: $args->{'crstype'});
6900:
6901: # Note: The testing routines depend on this being output; see
6902: # Utils::Course. This needs to at least be output as a comment
6903: # if anyone ever decides to not show this, and Utils::Course::new
6904: # will need to be suitably modified.
6905: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
6906:
6907: #
6908: # Check if created correctly
6909: #
6910: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
6911: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
6912: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
6913: #
6914: # Are we cloning?
6915: #
6916: my $cloneid='';
6917: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
6918: my $can_clone = 0;
6919: $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
6920: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
6921: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
6922: my $clonemsg;
6923: if ($clonehome eq 'no_host') {
6924: $clonemsg = &mt('Attempting to clone non-existing [_1]',$crstype);
6925: if ($context eq 'auto') {
6926: $outcome .= $clonemsg;
6927: } else {
6928: $outcome .= '<font color="red">'.$clonemsg.'</font>';
6929: }
6930: $outcome .= $linefeed;
6931: } else {
6932: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
6933: if ($env{'request.role.domain'} eq $args->{'form.clonedomain'}) {
6934: $can_clone = 1;
6935: } else {
6936: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
6937: $args->{'clonedomain'},$args->{'clonecourse'});
6938: my @cloners = split(/,/,$clonehash{'cloners'});
6939: my %roleshash =
6940: &Apache::lonnet::get_my_roles($args->{'ccuname'},
6941: $args->{'ccdomain'},'userroles',['active'],['cc'],
6942: [$args->{'clonedomain'}]);
6943: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
6944: $can_clone = 1;
6945: } else {
6946: $clonemsg = &mt('The new course was not cloned from an existing course because the course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
6947: if ($context eq 'auto') {
6948: $outcome .= $clonemsg;
6949: } else {
6950: $outcome .= '<font color="red">'.$clonemsg.'</font>';
6951: }
6952: $outcome .= $linefeed;
6953: }
6954: }
6955: }
6956: if ($can_clone) {
6957: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
6958: if ($context eq 'auto') {
6959: $outcome = $clonemsg;
6960: } else {
6961: $outcome .= '<font color="green">'.$clonemsg.'</font>';
6962: }
6963: $outcome .= $linefeed;
6964: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
6965: # Copy all files
6966: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
6967: # Restore URL
6968: $cenv{'url'}=$oldcenv{'url'};
6969: # Restore title
6970: $cenv{'description'}=$oldcenv{'description'};
6971: # restore grading mode
6972: if (defined($oldcenv{'grading'})) {
6973: $cenv{'grading'}=$oldcenv{'grading'};
6974: }
6975: # Mark as cloned
6976: $cenv{'clonedfrom'}=$cloneid;
6977: delete($cenv{'default_enrollment_start_date'});
6978: delete($cenv{'default_enrollment_end_date'});
6979: }
6980: }
6981: #
6982: # Set environment (will override cloned, if existing)
6983: #
6984: my @sections = ();
6985: my @xlists = ();
6986: if ($args->{'crstype'}) {
6987: $cenv{'type'}=$args->{'crstype'};
6988: }
6989: if ($args->{'crsid'}) {
6990: $cenv{'courseid'}=$args->{'crsid'};
6991: }
6992: if ($args->{'crscode'}) {
6993: $cenv{'internal.coursecode'}=$args->{'crscode'};
6994: }
6995: if ($args->{'crsquota'} ne '') {
6996: $cenv{'internal.coursequota'}=$args->{'crsquota'};
6997: } else {
6998: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
6999: }
7000: if ($args->{'ccuname'}) {
7001: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
7002: ':'.$args->{'ccdomain'};
7003: } else {
7004: $cenv{'internal.courseowner'} = $args->{'curruser'};
7005: }
7006:
7007: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
7008: if ($args->{'crssections'}) {
7009: $cenv{'internal.sectionnums'} = '';
7010: if ($args->{'crssections'} =~ m/,/) {
7011: @sections = split/,/,$args->{'crssections'};
7012: } else {
7013: $sections[0] = $args->{'crssections'};
7014: }
7015: if (@sections > 0) {
7016: foreach my $item (@sections) {
7017: my ($sec,$gp) = split/:/,$item;
7018: my $class = $args->{'crscode'}.$sec;
7019: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
7020: $cenv{'internal.sectionnums'} .= $item.',';
7021: unless ($addcheck eq 'ok') {
7022: push @badclasses, $class;
7023: }
7024: }
7025: $cenv{'internal.sectionnums'} =~ s/,$//;
7026: }
7027: }
7028: # do not hide course coordinator from staff listing,
7029: # even if privileged
7030: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7031: # add crosslistings
7032: if ($args->{'crsxlist'}) {
7033: $cenv{'internal.crosslistings'}='';
7034: if ($args->{'crsxlist'} =~ m/,/) {
7035: @xlists = split/,/,$args->{'crsxlist'};
7036: } else {
7037: $xlists[0] = $args->{'crsxlist'};
7038: }
7039: if (@xlists > 0) {
7040: foreach my $item (@xlists) {
7041: my ($xl,$gp) = split/:/,$item;
7042: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
7043: $cenv{'internal.crosslistings'} .= $item.',';
7044: unless ($addcheck eq 'ok') {
7045: push @badclasses, $xl;
7046: }
7047: }
7048: $cenv{'internal.crosslistings'} =~ s/,$//;
7049: }
7050: }
7051: if ($args->{'autoadds'}) {
7052: $cenv{'internal.autoadds'}=$args->{'autoadds'};
7053: }
7054: if ($args->{'autodrops'}) {
7055: $cenv{'internal.autodrops'}=$args->{'autodrops'};
7056: }
7057: # check for notification of enrollment changes
7058: my @notified = ();
7059: if ($args->{'notify_owner'}) {
7060: if ($args->{'ccuname'} ne '') {
7061: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
7062: }
7063: }
7064: if ($args->{'notify_dc'}) {
7065: if ($uname ne '') {
7066: push(@notified,$uname.'@'.$udom);
7067: }
7068: }
7069: if (@notified > 0) {
7070: my $notifylist;
7071: if (@notified > 1) {
7072: $notifylist = join(',',@notified);
7073: } else {
7074: $notifylist = $notified[0];
7075: }
7076: $cenv{'internal.notifylist'} = $notifylist;
7077: }
7078: if (@badclasses > 0) {
7079: my %lt=&Apache::lonlocal::texthash(
7080: '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',
7081: 'dnhr' => 'does not have rights to access enrollment in these classes',
7082: 'adby' => 'as determined by the policies of your institution on access to official classlists'
7083: );
7084: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
7085: ' ('.$lt{'adby'}.')';
7086: if ($context eq 'auto') {
7087: $outcome .= $badclass_msg.$linefeed;
7088: $outcome .= '<font color="red">'.$badclass_msg.$linefeed.'<ul>'."\n";
7089: foreach my $item (@badclasses) {
7090: if ($context eq 'auto') {
7091: $outcome .= " - $item\n";
7092: } else {
7093: $outcome .= "<li>$item</li>\n";
7094: }
7095: }
7096: if ($context eq 'auto') {
7097: $outcome .= $linefeed;
7098: } else {
7099: $outcome .= "</ul><br /><br /></font>\n";
7100: }
7101: }
7102: }
7103: if ($args->{'no_end_date'}) {
7104: $args->{'endaccess'} = 0;
7105: }
7106: $cenv{'internal.autostart'}=$args->{'enrollstart'};
7107: $cenv{'internal.autoend'}=$args->{'enrollend'};
7108: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
7109: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
7110: if ($args->{'showphotos'}) {
7111: $cenv{'internal.showphotos'}=$args->{'showphotos'};
7112: }
7113: $cenv{'internal.authtype'} = $args->{'authtype'};
7114: $cenv{'internal.autharg'} = $args->{'autharg'};
7115: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
7116: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
7117: 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');
7118: if ($context eq 'auto') {
7119: $outcome .= $krb_msg;
7120: } else {
7121: $outcome .= '<font color="red" size="+1">'.$krb_msg.'</font>';
7122: }
7123: $outcome .= $linefeed;
7124: }
7125: }
7126: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
7127: if ($args->{'setpolicy'}) {
7128: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7129: }
7130: if ($args->{'setcontent'}) {
7131: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7132: }
7133: }
7134: if ($args->{'reshome'}) {
7135: $cenv{'reshome'}=$args->{'reshome'}.'/';
7136: $cenv{'reshome'}=~s/\/+$/\//;
7137: }
7138: #
7139: # course has keyed access
7140: #
7141: if ($args->{'setkeys'}) {
7142: $cenv{'keyaccess'}='yes';
7143: }
7144: # if specified, key authority is not course, but user
7145: # only active if keyaccess is yes
7146: if ($args->{'keyauth'}) {
7147: my ($user,$domain) = split(':',$args->{'keyauth'});
7148: $user = &LONCAPA::clean_username($user);
7149: $domain = &LONCAPA::clean_username($domain);
7150: if ($user ne '' && $domain ne '') {
7151: $cenv{'keyauth'}=$user.':'.$domain;
7152: }
7153: }
7154:
7155: if ($args->{'disresdis'}) {
7156: $cenv{'pch.roles.denied'}='st';
7157: }
7158: if ($args->{'disablechat'}) {
7159: $cenv{'plc.roles.denied'}='st';
7160: }
7161:
7162: # Record we've not yet viewed the Course Initialization Helper for this
7163: # course
7164: $cenv{'course.helper.not.run'} = 1;
7165: #
7166: # Use new Randomseed
7167: #
7168: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
7169: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
7170: #
7171: # The encryption code and receipt prefix for this course
7172: #
7173: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
7174: $cenv{'internal.encpref'}=100+int(9*rand(99));
7175: #
7176: # By default, use standard grading
7177: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
7178:
7179: $outcome .= $linefeed.&mt('Setting environment').': '.
7180: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
7181: #
7182: # Open all assignments
7183: #
7184: if ($args->{'openall'}) {
7185: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
7186: my %storecontent = ($storeunder => time,
7187: $storeunder.'.type' => 'date_start');
7188:
7189: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
7190: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
7191: }
7192: #
7193: # Set first page
7194: #
7195: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
7196: || ($cloneid)) {
7197: use LONCAPA::map;
7198: $outcome .= &mt('Setting first resource').': ';
7199:
7200: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
7201: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
7202:
7203: $outcome .= ($fatal?$errtext:'read ok').' - ';
7204: my $title; my $url;
7205: if ($args->{'firstres'} eq 'syl') {
7206: $title='Syllabus';
7207: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
7208: } else {
7209: $title='Navigate Contents';
7210: $url='/adm/navmaps';
7211: }
7212:
7213: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
7214: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
7215:
7216: if ($errtext) { $fatal=2; }
7217: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
7218: }
7219: return $outcome;
7220: }
7221:
7222: ############################################################
7223: ############################################################
7224:
7225: sub course_type {
7226: my ($cid) = @_;
7227: if (!defined($cid)) {
7228: $cid = $env{'request.course.id'};
7229: }
7230: if (defined($env{'course.'.$cid.'.type'})) {
7231: return $env{'course.'.$cid.'.type'};
7232: } else {
7233: return 'Course';
7234: }
7235: }
7236:
7237: sub group_term {
7238: my $crstype = &course_type();
7239: my %names = (
7240: 'Course' => 'group',
7241: 'Group' => 'team',
7242: );
7243: return $names{$crstype};
7244: }
7245:
7246: sub icon {
7247: my ($file)=@_;
7248: my $curfext = lc((split(/\./,$file))[-1]);
7249: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
7250: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
7251: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
7252: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
7253: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7254: $curfext.".gif") {
7255: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7256: $curfext.".gif";
7257: }
7258: }
7259: return &lonhttpdurl($iconname);
7260: }
7261:
7262: sub lonhttpdurl {
7263: my ($url)=@_;
7264: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
7265: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
7266: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
7267: }
7268:
7269: sub connection_aborted {
7270: my ($r)=@_;
7271: $r->print(" ");$r->rflush();
7272: my $c = $r->connection;
7273: return $c->aborted();
7274: }
7275:
7276: # Escapes strings that may have embedded 's that will be put into
7277: # strings as 'strings'.
7278: sub escape_single {
7279: my ($input) = @_;
7280: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
7281: $input =~ s/\'/\\\'/g; # Esacpe the 's....
7282: return $input;
7283: }
7284:
7285: # Same as escape_single, but escape's "'s This
7286: # can be used for "strings"
7287: sub escape_double {
7288: my ($input) = @_;
7289: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
7290: $input =~ s/\"/\\\"/g; # Esacpe the "s....
7291: return $input;
7292: }
7293:
7294: # Escapes the last element of a full URL.
7295: sub escape_url {
7296: my ($url) = @_;
7297: my @urlslices = split(/\//, $url,-1);
7298: my $lastitem = &escape(pop(@urlslices));
7299: return join('/',@urlslices).'/'.$lastitem;
7300: }
7301:
7302: # -------------------------------------------------------- Initliaze user login
7303: sub init_user_environment {
7304: my ($r, $username, $domain, $authhost, $form, $args) = @_;
7305: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
7306:
7307: my $public=($username eq 'public' && $domain eq 'public');
7308:
7309: # See if old ID present, if so, remove
7310:
7311: my ($filename,$cookie,$userroles);
7312: my $now=time;
7313:
7314: if ($public) {
7315: my $max_public=100;
7316: my $oldest;
7317: my $oldest_time=0;
7318: for(my $next=1;$next<=$max_public;$next++) {
7319: if (-e $lonids."/publicuser_$next.id") {
7320: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
7321: if ($mtime<$oldest_time || !$oldest_time) {
7322: $oldest_time=$mtime;
7323: $oldest=$next;
7324: }
7325: } else {
7326: $cookie="publicuser_$next";
7327: last;
7328: }
7329: }
7330: if (!$cookie) { $cookie="publicuser_$oldest"; }
7331: } else {
7332: # if this isn't a robot, kill any existing non-robot sessions
7333: if (!$args->{'robot'}) {
7334: opendir(DIR,$lonids);
7335: while ($filename=readdir(DIR)) {
7336: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
7337: unlink($lonids.'/'.$filename);
7338: }
7339: }
7340: closedir(DIR);
7341: }
7342: # Give them a new cookie
7343: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
7344: : $now);
7345: $cookie="$username\_$id\_$domain\_$authhost";
7346:
7347: # Initialize roles
7348:
7349: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
7350: }
7351: # ------------------------------------ Check browser type and MathML capability
7352:
7353: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
7354: $clientunicode,$clientos) = &decode_user_agent($r);
7355:
7356: # -------------------------------------- Any accessibility options to remember?
7357: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
7358: foreach my $option ('imagesuppress','appletsuppress',
7359: 'embedsuppress','fontenhance','blackwhite') {
7360: if ($form->{$option} eq 'true') {
7361: &Apache::lonnet::put('environment',{$option => 'on'},
7362: $domain,$username);
7363: } else {
7364: &Apache::lonnet::del('environment',[$option],
7365: $domain,$username);
7366: }
7367: }
7368: }
7369: # ------------------------------------------------------------- Get environment
7370:
7371: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
7372: my ($tmp) = keys(%userenv);
7373: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7374: # default remote control to off
7375: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
7376: } else {
7377: undef(%userenv);
7378: }
7379: if (($userenv{'interface'}) && (!$form->{'interface'})) {
7380: $form->{'interface'}=$userenv{'interface'};
7381: }
7382: $env{'environment.remote'}=$userenv{'remote'};
7383: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
7384:
7385: # --------------- Do not trust query string to be put directly into environment
7386: foreach my $option ('imagesuppress','appletsuppress',
7387: 'embedsuppress','fontenhance','blackwhite',
7388: 'interface','localpath','localres') {
7389: $form->{$option}=~s/[\n\r\=]//gs;
7390: }
7391: # --------------------------------------------------------- Write first profile
7392:
7393: {
7394: my %initial_env =
7395: ("user.name" => $username,
7396: "user.domain" => $domain,
7397: "user.home" => $authhost,
7398: "browser.type" => $clientbrowser,
7399: "browser.version" => $clientversion,
7400: "browser.mathml" => $clientmathml,
7401: "browser.unicode" => $clientunicode,
7402: "browser.os" => $clientos,
7403: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
7404: "request.course.fn" => '',
7405: "request.course.uri" => '',
7406: "request.course.sec" => '',
7407: "request.role" => 'cm',
7408: "request.role.adv" => $env{'user.adv'},
7409: "request.host" => $ENV{'REMOTE_ADDR'},);
7410:
7411: if ($form->{'localpath'}) {
7412: $initial_env{"browser.localpath"} = $form->{'localpath'};
7413: $initial_env{"browser.localres"} = $form->{'localres'};
7414: }
7415:
7416: if ($public) {
7417: $initial_env{"environment.remote"} = "off";
7418: }
7419: if ($form->{'interface'}) {
7420: $form->{'interface'}=~s/\W//gs;
7421: $initial_env{"browser.interface"} = $form->{'interface'};
7422: $env{'browser.interface'}=$form->{'interface'};
7423: foreach my $option ('imagesuppress','appletsuppress',
7424: 'embedsuppress','fontenhance','blackwhite') {
7425: if (($form->{$option} eq 'true') ||
7426: ($userenv{$option} eq 'on')) {
7427: $initial_env{"browser.$option"} = "on";
7428: }
7429: }
7430: }
7431:
7432: $env{'user.environment'} = "$lonids/$cookie.id";
7433:
7434: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
7435: &GDBM_WRCREAT(),0640)) {
7436: &_add_to_env(\%disk_env,\%initial_env);
7437: &_add_to_env(\%disk_env,\%userenv,'environment.');
7438: &_add_to_env(\%disk_env,$userroles);
7439: if (ref($args->{'extra_env'})) {
7440: &_add_to_env(\%disk_env,$args->{'extra_env'});
7441: }
7442: untie(%disk_env);
7443: } else {
7444: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
7445: 'Could not create environment storage in lonauth: '.$!.'</font>');
7446: return 'error: '.$!;
7447: }
7448: }
7449: $env{'request.role'}='cm';
7450: $env{'request.role.adv'}=$env{'user.adv'};
7451: $env{'browser.type'}=$clientbrowser;
7452:
7453: return $cookie;
7454:
7455: }
7456:
7457: sub _add_to_env {
7458: my ($idf,$env_data,$prefix) = @_;
7459: while (my ($key,$value) = each(%$env_data)) {
7460: $idf->{$prefix.$key} = $value;
7461: $env{$prefix.$key} = $value;
7462: }
7463: }
7464:
7465:
7466: =pod
7467:
7468: =back
7469:
7470: =cut
7471:
7472: 1;
7473: __END__;
7474:
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