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