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