1: # The LearningOnline Network with CAPA
2: # a pile of common routines
3: #
4: # $Id: loncommon.pm,v 1.692 2008/11/04 21:06:41 www 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 Apache::lonnet();
65: use HTML::Entities;
66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
68: use Apache::lontexconvert();
69: use Apache::lonclonecourse();
70: use LONCAPA qw(:DEFAULT :match);
71: use DateTime::TimeZone;
72: use DateTime::Locale::Catalog;
73:
74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
77: my $readit;
78:
79:
80: ##
81: ## Global Variables
82: ##
83:
84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
90: =head1 Server Side include with retries:
91:
92: =over 4
93:
94: =item * &ssi_with_retries(resource,retries form)
95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
101:
102: =over 4
103:
104: resource - Identifies the resource to insert.
105:
106: retries - Count of the number of retries allowed.
107:
108: form - Hash that identifies the rendering options.
109:
110: =back
111:
112: Returns:
113:
114: =over 4
115:
116: content - The content of the response. If retries were exhausted this is empty.
117:
118: response - The response from the last attempt (which may or may not have been successful.
119:
120: =back
121:
122: =back
123:
124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
154: # ----------------------------------------------- Filetypes/Languages/Copyright
155: my %language;
156: my %supported_language;
157: my %cprtag;
158: my %scprtag;
159: my %fe; my %fd; my %fm;
160: my %category_extensions;
161:
162: # ---------------------------------------------- Thesaurus variables
163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
176: BEGIN {
177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
180: unless ($readit) {
181: # ------------------------------------------------------------------- languages
182: {
183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
197: }
198: # ------------------------------------------------------------------ copyrights
199: {
200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
211: }
212: # ----------------------------------------------------------- source copyrights
213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
226:
227: # -------------------------------------------------------------- default domain designs
228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
238: }
239:
240: # ------------------------------------------------------------- file categories
241: {
242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
254: }
255: # ------------------------------------------------------------------ file types
256: {
257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
268: }
269: }
270: close($fh);
271: }
272: }
273: &Apache::lonnet::logthis(
274: "<font color=yellow>INFO: Read file types</font>");
275: $readit=1;
276: } # end of unless($readit)
277:
278: }
279:
280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
286: =head1 HTML and Javascript Functions
287:
288: =over 4
289:
290: =item * &browser_and_searcher_javascript()
291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
296:
297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
305: with the given extension. Can be a comma separated list.
306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
308: with the given extension. Can be a comma separated list.
309:
310: =item * &opensearcher(formname,elementname) [javascript]
311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
316:
317: =cut
318:
319: sub browser_and_searcher_javascript {
320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
322: my $resurl=&escape_single(&lastresurl());
323: return <<END;
324: // <!-- BEGIN LON-CAPA Internal
325: var editbrowser = null;
326: function openbrowser(formname,elementname,only,omit,titleelement) {
327: var url = '$resurl/?';
328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
332: url += 'mode=$mode&';
333: url += 'inhibitmenu=yes&';
334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
337: } else {
338: url += 'only=&';
339: }
340: if (omit != null) {
341: url += 'omit=' + omit + '&';
342: } else {
343: url += 'omit=&';
344: }
345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
347: } else {
348: url += 'titleelement=&';
349: }
350: url += 'element=' + elementname + '';
351: var title = 'Browser';
352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
358: function opensearcher(formname,elementname,titleelement) {
359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
364: url += 'mode=$mode&';
365: url += 'form=' + formname + '&';
366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
368: } else {
369: url += 'titleelement=&';
370: }
371: url += 'element=' + elementname + '';
372: var title = 'Search';
373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
378: // END LON-CAPA Internal -->
379: END
380: }
381:
382: sub lastresurl {
383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
396: return 1;
397: }
398:
399: sub studentbrowser_javascript {
400: unless (
401: (($env{'request.course.id'}) &&
402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
406: || ($env{'request.role'}=~/^(au|dc|su)/)
407: ) { return ''; }
408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
412: var url = '/adm/pickstudent?';
413: var filter;
414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
424: if (roleflag) { url+="&roles=1"; }
425: var title = 'Student_Browser';
426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
434:
435: sub selectstudent_link {
436: my ($form,$unameele,$udomele)=@_;
437: if ($env{'request.course.id'}) {
438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
445: }
446: if ($env{'request.role'}=~/^(au|dc|su)/) {
447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
449: }
450: return '';
451: }
452:
453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
472: sub coursebrowser_javascript {
473: my ($domainfilter,$sec_element,$formname)=@_;
474: 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');
475: my $output = '
476: <script type="text/javascript">
477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
480: var url = '/adm/pickcourse?';
481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
493: }
494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
499: url += 'form=' + formname + '&cnumelement='+uname+
500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
502: if (extra_element !=null && extra_element != '') {
503: if (formname == 'rolechoice' || formname == 'studentform') {
504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
508: }
509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
514: }
515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
530: var title = 'Course_Browser';
531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
554: ENDSTDBRW
555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
597: }
598: |;
599: return $setsections;
600: }
601:
602:
603: sub selectcourse_link {
604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
607: }
608:
609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
631: }
632: } else {
633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
640: sub select_timezone {
641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
657: }
658: $output.="</select>";
659: return $output;
660: }
661:
662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
680: my @languages = &preferred_languages();
681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
713: =pod
714:
715: =item * &linked_select_forms(...)
716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
721: order unless a defined order is provided.
722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
727: =item * $formname, the name of the <form> tag
728:
729: =item * $middletext, the text which appears between the <select> tags
730:
731: =item * $firstdefault, the default value for the first menu
732:
733: =item * $firstselectname, the name of the first <select> tag
734:
735: =item * $secondselectname, the name of the second <select> tag
736:
737: =item * $hashref, a reference to a hash containing the data for the menus.
738:
739: =item * $menuorder, the order of values in the first menu
740:
741: =back
742:
743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
746: first menu value is given in $menu{$choice1}->{'text'}. The values
747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
757: },
758: order => ['B4','B3','B1','B2'],
759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
766: },
767: order => ['C2','C1','C3'],
768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
781: }
782: );
783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
792: $hashref,
793: $menuorder,
794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
799: $result.="<script type=\"text/javascript\">\n";
800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
807: $result.="select2data.d_$s1.values = new Array(";
808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
838: $second.options[i].value = values[i];
839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
854: $result.=" <option value=\"$value\" ";
855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
869: $result.=" <option value=\"$value\" ";
870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
871: $result.=">".&mt($select2{$value})."</option>\n";
872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
878: =pod
879:
880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
881:
882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
899:
900: =cut
901:
902: sub help_open_topic {
903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
905: $stayOnPage = 0 if (not defined $stayOnPage);
906: if ($env{'browser.interface'} eq 'textual') {
907: $stayOnPage=1;
908: }
909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
914: my $template = "";
915: my $link;
916:
917: $topic=~s/\W/\_/g;
918:
919: if (!$stayOnPage) {
920: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
921: } else {
922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
926: if ($text ne "") {
927: $template .=
928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
929: "<td bgcolor='#5555FF'><span class=\"LC_nobreak\"><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
930: }
931:
932: # Add the graphic
933: my $title = &mt('Online Help');
934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
935: $template .= <<"ENDTEMPLATE";
936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
937: ENDTEMPLATE
938: if ($text ne '') { $template.='</span></td></tr></table>' };
939: return $template;
940:
941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
946: my $other = shift;
947: my $addOther = '';
948: if ($other) {
949: $addOther = Apache::loncommon::help_open_topic($other, shift,
950: undef, undef, 600) .
951: '</td><td>';
952: }
953: return '<table><tr><td>'.
954: $addOther .
955: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
956: undef,undef,600)
957: .'</td><td>'.
958: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
959: undef,undef,600)
960: .'</td><td>'.
961: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
962: undef,undef,600)
963: .'</td></tr></table>';
964: }
965:
966: sub general_help {
967: my $helptopic='Student_Intro';
968: if ($env{'request.role'}=~/^(ca|au)/) {
969: $helptopic='Authoring_Intro';
970: } elsif ($env{'request.role'}=~/^cc/) {
971: $helptopic='Course_Coordination_Intro';
972: } elsif ($env{'request.role'}=~/^dc/) {
973: $helptopic='Domain_Coordination_Intro';
974: }
975: return $helptopic;
976: }
977:
978: sub update_help_link {
979: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
980: my $origurl = $ENV{'REQUEST_URI'};
981: $origurl=~s|^/~|/priv/|;
982: my $timestamp = time;
983: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
984: $$datum = &escape($$datum);
985: }
986:
987: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
988: my $output .= <<"ENDOUTPUT";
989: <script type="text/javascript">
990: banner_link = '$banner_link';
991: </script>
992: ENDOUTPUT
993: return $output;
994: }
995:
996: # now just updates the help link and generates a blue icon
997: sub help_open_menu {
998: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
999: = @_;
1000: $stayOnPage = 0 if (not defined $stayOnPage);
1001: # only use pop-up help (stayOnPage == 0)
1002: # if environment.remote is on (using remote control UI)
1003: if ($env{'browser.interface'} eq 'textual' ||
1004: $env{'environment.remote'} eq 'off' ) {
1005: $stayOnPage=1;
1006: }
1007: my $output;
1008: if ($component_help) {
1009: if (!$text) {
1010: $output=&help_open_topic($component_help,undef,$stayOnPage,
1011: $width,$height);
1012: } else {
1013: my $help_text;
1014: $help_text=&unescape($topic);
1015: $output='<table><tr><td>'.
1016: &help_open_topic($component_help,$help_text,$stayOnPage,
1017: $width,$height).'</td></tr></table>';
1018: }
1019: }
1020: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1021: return $output.$banner_link;
1022: }
1023:
1024: sub top_nav_help {
1025: my ($text) = @_;
1026: $text = &mt($text);
1027: my $stay_on_page =
1028: ($env{'browser.interface'} eq 'textual' ||
1029: $env{'environment.remote'} eq 'off' );
1030: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1031: : "javascript:helpMenu('open')";
1032: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1033:
1034: my $title = &mt('Get help');
1035:
1036: return <<"END";
1037: $banner_link
1038: <a href="$link" title="$title">$text</a>
1039: END
1040: }
1041:
1042: sub help_menu_js {
1043: my ($text) = @_;
1044:
1045: my $stayOnPage =
1046: ($env{'browser.interface'} eq 'textual' ||
1047: $env{'environment.remote'} eq 'off' );
1048:
1049: my $width = 620;
1050: my $height = 600;
1051: my $helptopic=&general_help();
1052: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1053: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1054: my $start_page =
1055: &Apache::loncommon::start_page('Help Menu', undef,
1056: {'frameset' => 1,
1057: 'js_ready' => 1,
1058: 'add_entries' => {
1059: 'border' => '0',
1060: 'rows' => "110,*",},});
1061: my $end_page =
1062: &Apache::loncommon::end_page({'frameset' => 1,
1063: 'js_ready' => 1,});
1064:
1065: my $template .= <<"ENDTEMPLATE";
1066: <script type="text/javascript">
1067: // <!-- BEGIN LON-CAPA Internal
1068: // <![CDATA[
1069: var banner_link = '';
1070: function helpMenu(target) {
1071: var caller = this;
1072: if (target == 'open') {
1073: var newWindow = null;
1074: try {
1075: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1076: }
1077: catch(error) {
1078: writeHelp(caller);
1079: return;
1080: }
1081: if (newWindow) {
1082: caller = newWindow;
1083: }
1084: }
1085: writeHelp(caller);
1086: return;
1087: }
1088: function writeHelp(caller) {
1089: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1090: caller.document.close()
1091: caller.focus()
1092: }
1093: // ]]>
1094: // END LON-CAPA Internal -->
1095: </script>
1096: ENDTEMPLATE
1097: return $template;
1098: }
1099:
1100: sub help_open_bug {
1101: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1102: unless ($env{'user.adv'}) { return ''; }
1103: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1104: $text = "" if (not defined $text);
1105: $stayOnPage = 0 if (not defined $stayOnPage);
1106: if ($env{'browser.interface'} eq 'textual' ||
1107: $env{'environment.remote'} eq 'off' ) {
1108: $stayOnPage=1;
1109: }
1110: $width = 600 if (not defined $width);
1111: $height = 600 if (not defined $height);
1112:
1113: $topic=~s/\W+/\+/g;
1114: my $link='';
1115: my $template='';
1116: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1117: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1118: if (!$stayOnPage)
1119: {
1120: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1121: }
1122: else
1123: {
1124: $link = $url;
1125: }
1126: # Add the text
1127: if ($text ne "")
1128: {
1129: $template .=
1130: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1132: }
1133:
1134: # Add the graphic
1135: my $title = &mt('Report a Bug');
1136: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1137: $template .= <<"ENDTEMPLATE";
1138: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1139: ENDTEMPLATE
1140: if ($text ne '') { $template.='</td></tr></table>' };
1141: return $template;
1142:
1143: }
1144:
1145: sub help_open_faq {
1146: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1147: unless ($env{'user.adv'}) { return ''; }
1148: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1149: $text = "" if (not defined $text);
1150: $stayOnPage = 0 if (not defined $stayOnPage);
1151: if ($env{'browser.interface'} eq 'textual' ||
1152: $env{'environment.remote'} eq 'off' ) {
1153: $stayOnPage=1;
1154: }
1155: $width = 350 if (not defined $width);
1156: $height = 400 if (not defined $height);
1157:
1158: $topic=~s/\W+/\+/g;
1159: my $link='';
1160: my $template='';
1161: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1162: if (!$stayOnPage)
1163: {
1164: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1165: }
1166: else
1167: {
1168: $link = $url;
1169: }
1170:
1171: # Add the text
1172: if ($text ne "")
1173: {
1174: $template .=
1175: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1177: }
1178:
1179: # Add the graphic
1180: my $title = &mt('View the FAQ');
1181: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1182: $template .= <<"ENDTEMPLATE";
1183: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1184: ENDTEMPLATE
1185: if ($text ne '') { $template.='</td></tr></table>' };
1186: return $template;
1187:
1188: }
1189:
1190: ###############################################################
1191: ###############################################################
1192:
1193: =pod
1194:
1195: =item * &change_content_javascript():
1196:
1197: This and the next function allow you to create small sections of an
1198: otherwise static HTML page that you can update on the fly with
1199: Javascript, even in Netscape 4.
1200:
1201: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1202: must be written to the HTML page once. It will prove the Javascript
1203: function "change(name, content)". Calling the change function with the
1204: name of the section
1205: you want to update, matching the name passed to C<changable_area>, and
1206: the new content you want to put in there, will put the content into
1207: that area.
1208:
1209: B<Note>: Netscape 4 only reserves enough space for the changable area
1210: to contain room for the original contents. You need to "make space"
1211: for whatever changes you wish to make, and be B<sure> to check your
1212: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1213: it's adequate for updating a one-line status display, but little more.
1214: This script will set the space to 100% width, so you only need to
1215: worry about height in Netscape 4.
1216:
1217: Modern browsers are much less limiting, and if you can commit to the
1218: user not using Netscape 4, this feature may be used freely with
1219: pretty much any HTML.
1220:
1221: =cut
1222:
1223: sub change_content_javascript {
1224: # If we're on Netscape 4, we need to use Layer-based code
1225: if ($env{'browser.type'} eq 'netscape' &&
1226: $env{'browser.version'} =~ /^4\./) {
1227: return (<<NETSCAPE4);
1228: function change(name, content) {
1229: doc = document.layers[name+"___escape"].layers[0].document;
1230: doc.open();
1231: doc.write(content);
1232: doc.close();
1233: }
1234: NETSCAPE4
1235: } else {
1236: # Otherwise, we need to use semi-standards-compliant code
1237: # (technically, "innerHTML" isn't standard but the equivalent
1238: # is really scary, and every useful browser supports it
1239: return (<<DOMBASED);
1240: function change(name, content) {
1241: element = document.getElementById(name);
1242: element.innerHTML = content;
1243: }
1244: DOMBASED
1245: }
1246: }
1247:
1248: =pod
1249:
1250: =item * &changable_area($name,$origContent):
1251:
1252: This provides a "changable area" that can be modified on the fly via
1253: the Javascript code provided in C<change_content_javascript>. $name is
1254: the name you will use to reference the area later; do not repeat the
1255: same name on a given HTML page more then once. $origContent is what
1256: the area will originally contain, which can be left blank.
1257:
1258: =cut
1259:
1260: sub changable_area {
1261: my ($name, $origContent) = @_;
1262:
1263: if ($env{'browser.type'} eq 'netscape' &&
1264: $env{'browser.version'} =~ /^4\./) {
1265: # If this is netscape 4, we need to use the Layer tag
1266: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1267: } else {
1268: return "<span id='$name'>$origContent</span>";
1269: }
1270: }
1271:
1272: =pod
1273:
1274: =item * &viewport_geometry_js
1275:
1276: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1277:
1278: =cut
1279:
1280:
1281: sub viewport_geometry_js {
1282: return <<"GEOMETRY";
1283: var Geometry = {};
1284: function init_geometry() {
1285: if (Geometry.init) { return };
1286: Geometry.init=1;
1287: if (window.innerHeight) {
1288: Geometry.getViewportHeight = function() { return window.innerHeight; };
1289: Geometry.getViewportWidth = function() { return window.innerWidth; };
1290: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1291: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1292: }
1293: else if (document.documentElement && document.documentElement.clientHeight) {
1294: Geometry.getViewportHeight =
1295: function() { return document.documentElement.clientHeight; };
1296: Geometry.getViewportWidth =
1297: function() { return document.documentElement.clientWidth; };
1298:
1299: Geometry.getHorizontalScroll =
1300: function() { return document.documentElement.scrollLeft; };
1301: Geometry.getVerticalScroll =
1302: function() { return document.documentElement.scrollTop; };
1303: }
1304: else if (document.body.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.body.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.body.clientWidth; };
1309: Geometry.getHorizontalScroll =
1310: function() { return document.body.scrollLeft; };
1311: Geometry.getVerticalScroll =
1312: function() { return document.body.scrollTop; };
1313: }
1314: }
1315:
1316: GEOMETRY
1317: }
1318:
1319: =pod
1320:
1321: =item * &viewport_size_js()
1322:
1323: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1324:
1325: =cut
1326:
1327: sub viewport_size_js {
1328: my $geometry = &viewport_geometry_js();
1329: return <<"DIMS";
1330:
1331: $geometry
1332:
1333: function getViewportDims(width,height) {
1334: init_geometry();
1335: width.value = Geometry.getViewportWidth();
1336: height.value = Geometry.getViewportHeight();
1337: return;
1338: }
1339:
1340: DIMS
1341: }
1342:
1343: =pod
1344:
1345: =item * &resize_textarea_js()
1346:
1347: emits the needed javascript to resize a textarea to be as big as possible
1348:
1349: creates a function resize_textrea that takes two IDs first should be
1350: the id of the element to resize, second should be the id of a div that
1351: surrounds everything that comes after the textarea, this routine needs
1352: to be attached to the <body> for the onload and onresize events.
1353:
1354: =back
1355:
1356: =cut
1357:
1358: sub resize_textarea_js {
1359: my $geometry = &viewport_geometry_js();
1360: return <<"RESIZE";
1361: <script type="text/javascript">
1362: $geometry
1363:
1364: function getX(element) {
1365: var x = 0;
1366: while (element) {
1367: x += element.offsetLeft;
1368: element = element.offsetParent;
1369: }
1370: return x;
1371: }
1372: function getY(element) {
1373: var y = 0;
1374: while (element) {
1375: y += element.offsetTop;
1376: element = element.offsetParent;
1377: }
1378: return y;
1379: }
1380:
1381:
1382: function resize_textarea(textarea_id,bottom_id) {
1383: init_geometry();
1384: var textarea = document.getElementById(textarea_id);
1385: //alert(textarea);
1386:
1387: var textarea_top = getY(textarea);
1388: var textarea_height = textarea.offsetHeight;
1389: var bottom = document.getElementById(bottom_id);
1390: var bottom_top = getY(bottom);
1391: var bottom_height = bottom.offsetHeight;
1392: var window_height = Geometry.getViewportHeight();
1393: var fudge = 23;
1394: var new_height = window_height-fudge-textarea_top-bottom_height;
1395: if (new_height < 300) {
1396: new_height = 300;
1397: }
1398: textarea.style.height=new_height+'px';
1399: }
1400: </script>
1401: RESIZE
1402:
1403: }
1404:
1405: =pod
1406:
1407: =head1 Excel and CSV file utility routines
1408:
1409: =over 4
1410:
1411: =cut
1412:
1413: ###############################################################
1414: ###############################################################
1415:
1416: =pod
1417:
1418: =item * &csv_translate($text)
1419:
1420: Translate $text to allow it to be output as a 'comma separated values'
1421: format.
1422:
1423: =cut
1424:
1425: ###############################################################
1426: ###############################################################
1427: sub csv_translate {
1428: my $text = shift;
1429: $text =~ s/\"/\"\"/g;
1430: $text =~ s/\n/ /g;
1431: return $text;
1432: }
1433:
1434: ###############################################################
1435: ###############################################################
1436:
1437: =pod
1438:
1439: =item * &define_excel_formats()
1440:
1441: Define some commonly used Excel cell formats.
1442:
1443: Currently supported formats:
1444:
1445: =over 4
1446:
1447: =item header
1448:
1449: =item bold
1450:
1451: =item h1
1452:
1453: =item h2
1454:
1455: =item h3
1456:
1457: =item h4
1458:
1459: =item i
1460:
1461: =item date
1462:
1463: =back
1464:
1465: Inputs: $workbook
1466:
1467: Returns: $format, a hash reference.
1468:
1469: =cut
1470:
1471: ###############################################################
1472: ###############################################################
1473: sub define_excel_formats {
1474: my ($workbook) = @_;
1475: my $format;
1476: $format->{'header'} = $workbook->add_format(bold => 1,
1477: bottom => 1,
1478: align => 'center');
1479: $format->{'bold'} = $workbook->add_format(bold=>1);
1480: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1481: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1482: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1483: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1484: $format->{'i'} = $workbook->add_format(italic=>1);
1485: $format->{'date'} = $workbook->add_format(num_format=>
1486: 'mm/dd/yyyy hh:mm:ss');
1487: return $format;
1488: }
1489:
1490: ###############################################################
1491: ###############################################################
1492:
1493: =pod
1494:
1495: =item * &create_workbook()
1496:
1497: Create an Excel worksheet. If it fails, output message on the
1498: request object and return undefs.
1499:
1500: Inputs: Apache request object
1501:
1502: Returns (undef) on failure,
1503: Excel worksheet object, scalar with filename, and formats
1504: from &Apache::loncommon::define_excel_formats on success
1505:
1506: =cut
1507:
1508: ###############################################################
1509: ###############################################################
1510: sub create_workbook {
1511: my ($r) = @_;
1512: #
1513: # Create the excel spreadsheet
1514: my $filename = '/prtspool/'.
1515: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1516: time.'_'.rand(1000000000).'.xls';
1517: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1518: if (! defined($workbook)) {
1519: $r->log_error("Error creating excel spreadsheet $filename: $!");
1520: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1521: "This error has been logged. ".
1522: "Please alert your LON-CAPA administrator").
1523: '</p>');
1524: return (undef);
1525: }
1526: #
1527: $workbook->set_tempdir('/home/httpd/perl/tmp');
1528: #
1529: my $format = &Apache::loncommon::define_excel_formats($workbook);
1530: return ($workbook,$filename,$format);
1531: }
1532:
1533: ###############################################################
1534: ###############################################################
1535:
1536: =pod
1537:
1538: =item * &create_text_file()
1539:
1540: Create a file to write to and eventually make available to the user.
1541: If file creation fails, outputs an error message on the request object and
1542: return undefs.
1543:
1544: Inputs: Apache request object, and file suffix
1545:
1546: Returns (undef) on failure,
1547: Filehandle and filename on success.
1548:
1549: =cut
1550:
1551: ###############################################################
1552: ###############################################################
1553: sub create_text_file {
1554: my ($r,$suffix) = @_;
1555: if (! defined($suffix)) { $suffix = 'txt'; };
1556: my $fh;
1557: my $filename = '/prtspool/'.
1558: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1559: time.'_'.rand(1000000000).'.'.$suffix;
1560: $fh = Apache::File->new('>/home/httpd'.$filename);
1561: if (! defined($fh)) {
1562: $r->log_error("Couldn't open $filename for output $!");
1563: $r->print(&mt('Problems occurred in creating the output file. '
1564: .'This error has been logged. '
1565: .'Please alert your LON-CAPA administrator.'));
1566: }
1567: return ($fh,$filename)
1568: }
1569:
1570:
1571: =pod
1572:
1573: =back
1574:
1575: =cut
1576:
1577: ###############################################################
1578: ## Home server <option> list generating code ##
1579: ###############################################################
1580:
1581: # ------------------------------------------
1582:
1583: sub domain_select {
1584: my ($name,$value,$multiple)=@_;
1585: my %domains=map {
1586: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1587: } &Apache::lonnet::all_domains();
1588: if ($multiple) {
1589: $domains{''}=&mt('Any domain');
1590: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1591: return &multiple_select_form($name,$value,4,\%domains);
1592: } else {
1593: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1594: return &select_form($name,$value,%domains);
1595: }
1596: }
1597:
1598: #-------------------------------------------
1599:
1600: =pod
1601:
1602: =head1 Routines for form select boxes
1603:
1604: =over 4
1605:
1606: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1607:
1608: Returns a string containing a <select> element int multiple mode
1609:
1610:
1611: Args:
1612: $name - name of the <select> element
1613: $value - scalar or array ref of values that should already be selected
1614: $size - number of rows long the select element is
1615: $hash - the elements should be 'option' => 'shown text'
1616: (shown text should already have been &mt())
1617: $order - (optional) array ref of the order to show the elements in
1618:
1619: =cut
1620:
1621: #-------------------------------------------
1622: sub multiple_select_form {
1623: my ($name,$value,$size,$hash,$order)=@_;
1624: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1625: my $output='';
1626: if (! defined($size)) {
1627: $size = 4;
1628: if (scalar(keys(%$hash))<4) {
1629: $size = scalar(keys(%$hash));
1630: }
1631: }
1632: $output.="\n<select name='$name' size='$size' multiple='1'>";
1633: my @order;
1634: if (ref($order) eq 'ARRAY') {
1635: @order = @{$order};
1636: } else {
1637: @order = sort(keys(%$hash));
1638: }
1639: if (exists($$hash{'select_form_order'})) {
1640: @order = @{$$hash{'select_form_order'}};
1641: }
1642:
1643: foreach my $key (@order) {
1644: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1645: $output.='selected="selected" ' if ($selected{$key});
1646: $output.='>'.$hash->{$key}."</option>\n";
1647: }
1648: $output.="</select>\n";
1649: return $output;
1650: }
1651:
1652: #-------------------------------------------
1653:
1654: =pod
1655:
1656: =item * &select_form($defdom,$name,%hash)
1657:
1658: Returns a string containing a <select name='$name' size='1'> form to
1659: allow a user to select options from a hash option_name => displayed text.
1660: See lonrights.pm for an example invocation and use.
1661:
1662: =cut
1663:
1664: #-------------------------------------------
1665: sub select_form {
1666: my ($def,$name,%hash) = @_;
1667: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1668: my @keys;
1669: if (exists($hash{'select_form_order'})) {
1670: @keys=@{$hash{'select_form_order'}};
1671: } else {
1672: @keys=sort(keys(%hash));
1673: }
1674: foreach my $key (@keys) {
1675: $selectform.=
1676: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1677: ($key eq $def ? 'selected="selected" ' : '').
1678: ">".&mt($hash{$key})."</option>\n";
1679: }
1680: $selectform.="</select>";
1681: return $selectform;
1682: }
1683:
1684: # For display filters
1685:
1686: sub display_filter {
1687: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1688: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1689: return '<nobr><label>'.&mt('Records [_1]',
1690: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1691: (&mt('all'),10,20,50,100,1000,10000))).
1692: '</label></nobr> <nobr>'.
1693: &mt('Filter [_1]',
1694: &select_form($env{'form.displayfilter'},
1695: 'displayfilter',
1696: ('currentfolder' => 'Current folder/page',
1697: 'containing' => 'Containing phrase',
1698: 'none' => 'None'))).
1699: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1700: }
1701:
1702: sub gradeleveldescription {
1703: my $gradelevel=shift;
1704: my %gradelevels=(0 => 'Not specified',
1705: 1 => 'Grade 1',
1706: 2 => 'Grade 2',
1707: 3 => 'Grade 3',
1708: 4 => 'Grade 4',
1709: 5 => 'Grade 5',
1710: 6 => 'Grade 6',
1711: 7 => 'Grade 7',
1712: 8 => 'Grade 8',
1713: 9 => 'Grade 9',
1714: 10 => 'Grade 10',
1715: 11 => 'Grade 11',
1716: 12 => 'Grade 12',
1717: 13 => 'Grade 13',
1718: 14 => '100 Level',
1719: 15 => '200 Level',
1720: 16 => '300 Level',
1721: 17 => '400 Level',
1722: 18 => 'Graduate Level');
1723: return &mt($gradelevels{$gradelevel});
1724: }
1725:
1726: sub select_level_form {
1727: my ($deflevel,$name)=@_;
1728: unless ($deflevel) { $deflevel=0; }
1729: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1730: for (my $i=0; $i<=18; $i++) {
1731: $selectform.="<option value=\"$i\" ".
1732: ($i==$deflevel ? 'selected="selected" ' : '').
1733: ">".&gradeleveldescription($i)."</option>\n";
1734: }
1735: $selectform.="</select>";
1736: return $selectform;
1737: }
1738:
1739: #-------------------------------------------
1740:
1741: =pod
1742:
1743: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1744:
1745: Returns a string containing a <select name='$name' size='1'> form to
1746: allow a user to select the domain to preform an operation in.
1747: See loncreateuser.pm for an example invocation and use.
1748:
1749: If the $includeempty flag is set, it also includes an empty choice ("no domain
1750: selected");
1751:
1752: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1753:
1754: =cut
1755:
1756: #-------------------------------------------
1757: sub select_dom_form {
1758: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1759: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1760: if ($includeempty) { @domains=('',@domains); }
1761: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1762: foreach my $dom (@domains) {
1763: $selectdomain.="<option value=\"$dom\" ".
1764: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1765: if ($showdomdesc) {
1766: if ($dom ne '') {
1767: my $domdesc = &Apache::lonnet::domain($dom,'description');
1768: if ($domdesc ne '') {
1769: $selectdomain .= ' ('.$domdesc.')';
1770: }
1771: }
1772: }
1773: $selectdomain .= "</option>\n";
1774: }
1775: $selectdomain.="</select>";
1776: return $selectdomain;
1777: }
1778:
1779: #-------------------------------------------
1780:
1781: =pod
1782:
1783: =item * &home_server_form_item($domain,$name,$defaultflag)
1784:
1785: input: 4 arguments (two required, two optional) -
1786: $domain - domain of new user
1787: $name - name of form element
1788: $default - Value of 'default' causes a default item to be first
1789: option, and selected by default.
1790: $hide - Value of 'hide' causes hiding of the name of the server,
1791: if 1 server found, or default, if 0 found.
1792: output: returns 2 items:
1793: (a) form element which contains either:
1794: (i) <select name="$name">
1795: <option value="$hostid1">$hostid $servers{$hostid}</option>
1796: <option value="$hostid2">$hostid $servers{$hostid}</option>
1797: </select>
1798: form item if there are multiple library servers in $domain, or
1799: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1800: if there is only one library server in $domain.
1801:
1802: (b) number of library servers found.
1803:
1804: See loncreateuser.pm for example of use.
1805:
1806: =cut
1807:
1808: #-------------------------------------------
1809: sub home_server_form_item {
1810: my ($domain,$name,$default,$hide) = @_;
1811: my %servers = &Apache::lonnet::get_servers($domain,'library');
1812: my $result;
1813: my $numlib = keys(%servers);
1814: if ($numlib > 1) {
1815: $result .= '<select name="'.$name.'" />'."\n";
1816: if ($default) {
1817: $result .= '<option value="default" selected>'.&mt('default').
1818: '</option>'."\n";
1819: }
1820: foreach my $hostid (sort(keys(%servers))) {
1821: $result.= '<option value="'.$hostid.'">'.
1822: $hostid.' '.$servers{$hostid}."</option>\n";
1823: }
1824: $result .= '</select>'."\n";
1825: } elsif ($numlib == 1) {
1826: my $hostid;
1827: foreach my $item (keys(%servers)) {
1828: $hostid = $item;
1829: }
1830: $result .= '<input type="hidden" name="'.$name.'" value="'.
1831: $hostid.'" />';
1832: if (!$hide) {
1833: $result .= $hostid.' '.$servers{$hostid};
1834: }
1835: $result .= "\n";
1836: } elsif ($default) {
1837: $result .= '<input type="hidden" name="'.$name.
1838: '" value="default" />';
1839: if (!$hide) {
1840: $result .= &mt('default');
1841: }
1842: $result .= "\n";
1843: }
1844: return ($result,$numlib);
1845: }
1846:
1847: =pod
1848:
1849: =back
1850:
1851: =cut
1852:
1853: ###############################################################
1854: ## Decoding User Agent ##
1855: ###############################################################
1856:
1857: =pod
1858:
1859: =head1 Decoding the User Agent
1860:
1861: =over 4
1862:
1863: =item * &decode_user_agent()
1864:
1865: Inputs: $r
1866:
1867: Outputs:
1868:
1869: =over 4
1870:
1871: =item * $httpbrowser
1872:
1873: =item * $clientbrowser
1874:
1875: =item * $clientversion
1876:
1877: =item * $clientmathml
1878:
1879: =item * $clientunicode
1880:
1881: =item * $clientos
1882:
1883: =back
1884:
1885: =back
1886:
1887: =cut
1888:
1889: ###############################################################
1890: ###############################################################
1891: sub decode_user_agent {
1892: my ($r)=@_;
1893: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1894: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1895: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1896: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1897: my $clientbrowser='unknown';
1898: my $clientversion='0';
1899: my $clientmathml='';
1900: my $clientunicode='0';
1901: for (my $i=0;$i<=$#browsertype;$i++) {
1902: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1903: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1904: $clientbrowser=$bname;
1905: $httpbrowser=~/$vreg/i;
1906: $clientversion=$1;
1907: $clientmathml=($clientversion>=$minv);
1908: $clientunicode=($clientversion>=$univ);
1909: }
1910: }
1911: my $clientos='unknown';
1912: if (($httpbrowser=~/linux/i) ||
1913: ($httpbrowser=~/unix/i) ||
1914: ($httpbrowser=~/ux/i) ||
1915: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1916: if (($httpbrowser=~/vax/i) ||
1917: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1918: if ($httpbrowser=~/next/i) { $clientos='next'; }
1919: if (($httpbrowser=~/mac/i) ||
1920: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1921: if ($httpbrowser=~/win/i) { $clientos='win'; }
1922: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1923: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1924: $clientunicode,$clientos,);
1925: }
1926:
1927: ###############################################################
1928: ## Authentication changing form generation subroutines ##
1929: ###############################################################
1930: ##
1931: ## All of the authform_xxxxxxx subroutines take their inputs in a
1932: ## hash, and have reasonable default values.
1933: ##
1934: ## formname = the name given in the <form> tag.
1935: #-------------------------------------------
1936:
1937: =pod
1938:
1939: =head1 Authentication Routines
1940:
1941: =over 4
1942:
1943: =item * &authform_xxxxxx()
1944:
1945: The authform_xxxxxx subroutines provide javascript and html forms which
1946: handle some of the conveniences required for authentication forms.
1947: This is not an optimal method, but it works.
1948:
1949: =over 4
1950:
1951: =item * authform_header
1952:
1953: =item * authform_authorwarning
1954:
1955: =item * authform_nochange
1956:
1957: =item * authform_kerberos
1958:
1959: =item * authform_internal
1960:
1961: =item * authform_filesystem
1962:
1963: =back
1964:
1965: See loncreateuser.pm for invocation and use examples.
1966:
1967: =cut
1968:
1969: #-------------------------------------------
1970: sub authform_header{
1971: my %in = (
1972: formname => 'cu',
1973: kerb_def_dom => '',
1974: @_,
1975: );
1976: $in{'formname'} = 'document.' . $in{'formname'};
1977: my $result='';
1978:
1979: #---------------------------------------------- Code for upper case translation
1980: my $Javascript_toUpperCase;
1981: unless ($in{kerb_def_dom}) {
1982: $Javascript_toUpperCase =<<"END";
1983: switch (choice) {
1984: case 'krb': currentform.elements[choicearg].value =
1985: currentform.elements[choicearg].value.toUpperCase();
1986: break;
1987: default:
1988: }
1989: END
1990: } else {
1991: $Javascript_toUpperCase = "";
1992: }
1993:
1994: my $radioval = "'nochange'";
1995: if (defined($in{'curr_authtype'})) {
1996: if ($in{'curr_authtype'} ne '') {
1997: $radioval = "'".$in{'curr_authtype'}."arg'";
1998: }
1999: }
2000: my $argfield = 'null';
2001: if (defined($in{'mode'})) {
2002: if ($in{'mode'} eq 'modifycourse') {
2003: if (defined($in{'curr_autharg'})) {
2004: if ($in{'curr_autharg'} ne '') {
2005: $argfield = "'$in{'curr_autharg'}'";
2006: }
2007: }
2008: }
2009: }
2010:
2011: $result.=<<"END";
2012: var current = new Object();
2013: current.radiovalue = $radioval;
2014: current.argfield = $argfield;
2015:
2016: function changed_radio(choice,currentform) {
2017: var choicearg = choice + 'arg';
2018: // If a radio button in changed, we need to change the argfield
2019: if (current.radiovalue != choice) {
2020: current.radiovalue = choice;
2021: if (current.argfield != null) {
2022: currentform.elements[current.argfield].value = '';
2023: }
2024: if (choice == 'nochange') {
2025: current.argfield = null;
2026: } else {
2027: current.argfield = choicearg;
2028: switch(choice) {
2029: case 'krb':
2030: currentform.elements[current.argfield].value =
2031: "$in{'kerb_def_dom'}";
2032: break;
2033: default:
2034: break;
2035: }
2036: }
2037: }
2038: return;
2039: }
2040:
2041: function changed_text(choice,currentform) {
2042: var choicearg = choice + 'arg';
2043: if (currentform.elements[choicearg].value !='') {
2044: $Javascript_toUpperCase
2045: // clear old field
2046: if ((current.argfield != choicearg) && (current.argfield != null)) {
2047: currentform.elements[current.argfield].value = '';
2048: }
2049: current.argfield = choicearg;
2050: }
2051: set_auth_radio_buttons(choice,currentform);
2052: return;
2053: }
2054:
2055: function set_auth_radio_buttons(newvalue,currentform) {
2056: var i=0;
2057: while (i < currentform.login.length) {
2058: if (currentform.login[i].value == newvalue) { break; }
2059: i++;
2060: }
2061: if (i == currentform.login.length) {
2062: return;
2063: }
2064: current.radiovalue = newvalue;
2065: currentform.login[i].checked = true;
2066: return;
2067: }
2068: END
2069: return $result;
2070: }
2071:
2072: sub authform_authorwarning{
2073: my $result='';
2074: $result='<i>'.
2075: &mt('As a general rule, only authors or co-authors should be '.
2076: 'filesystem authenticated '.
2077: '(which allows access to the server filesystem).')."</i>\n";
2078: return $result;
2079: }
2080:
2081: sub authform_nochange{
2082: my %in = (
2083: formname => 'document.cu',
2084: kerb_def_dom => 'MSU.EDU',
2085: @_,
2086: );
2087: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2088: my $result;
2089: if (keys(%can_assign) == 0) {
2090: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2091: } else {
2092: $result = '<label>'.&mt('[_1] Do not change login data',
2093: '<input type="radio" name="login" value="nochange" '.
2094: 'checked="checked" onclick="'.
2095: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2096: '</label>';
2097: }
2098: return $result;
2099: }
2100:
2101: sub authform_kerberos {
2102: my %in = (
2103: formname => 'document.cu',
2104: kerb_def_dom => 'MSU.EDU',
2105: kerb_def_auth => 'krb4',
2106: @_,
2107: );
2108: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2109: $autharg,$jscall);
2110: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2111: if ($in{'kerb_def_auth'} eq 'krb5') {
2112: $check5 = ' checked="on"';
2113: } else {
2114: $check4 = ' checked="on"';
2115: }
2116: $krbarg = $in{'kerb_def_dom'};
2117: if (defined($in{'curr_authtype'})) {
2118: if ($in{'curr_authtype'} eq 'krb') {
2119: $krbcheck = ' checked="on"';
2120: if (defined($in{'mode'})) {
2121: if ($in{'mode'} eq 'modifyuser') {
2122: $krbcheck = '';
2123: }
2124: }
2125: if (defined($in{'curr_kerb_ver'})) {
2126: if ($in{'curr_krb_ver'} eq '5') {
2127: $check5 = ' checked="on"';
2128: $check4 = '';
2129: } else {
2130: $check4 = ' checked="on"';
2131: $check5 = '';
2132: }
2133: }
2134: if (defined($in{'curr_autharg'})) {
2135: $krbarg = $in{'curr_autharg'};
2136: }
2137: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2138: if (defined($in{'curr_autharg'})) {
2139: $result =
2140: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2141: $in{'curr_autharg'},$krbver);
2142: } else {
2143: $result =
2144: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2145: }
2146: return $result;
2147: }
2148: }
2149: } else {
2150: if ($authnum == 1) {
2151: $authtype = '<input type="hidden" name="login" value="krb">';
2152: }
2153: }
2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2155: return;
2156: } elsif ($authtype eq '') {
2157: if (defined($in{'mode'})) {
2158: if ($in{'mode'} eq 'modifycourse') {
2159: if ($authnum == 1) {
2160: $authtype = '<input type="hidden" name="login" value="krb">';
2161: }
2162: }
2163: }
2164: }
2165: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2166: if ($authtype eq '') {
2167: $authtype = '<input type="radio" name="login" value="krb" '.
2168: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2169: $krbcheck.' />';
2170: }
2171: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2172: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2173: $in{'curr_authtype'} eq 'krb5') ||
2174: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2175: $in{'curr_authtype'} eq 'krb4')) {
2176: $result .= &mt
2177: ('[_1] Kerberos authenticated with domain [_2] '.
2178: '[_3] Version 4 [_4] Version 5 [_5]',
2179: '<label>'.$authtype,
2180: '</label><input type="text" size="10" name="krbarg" '.
2181: 'value="'.$krbarg.'" '.
2182: 'onchange="'.$jscall.'" />',
2183: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2184: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2185: '</label>');
2186: } elsif ($can_assign{'krb4'}) {
2187: $result .= &mt
2188: ('[_1] Kerberos authenticated with domain [_2] '.
2189: '[_3] Version 4 [_4]',
2190: '<label>'.$authtype,
2191: '</label><input type="text" size="10" name="krbarg" '.
2192: 'value="'.$krbarg.'" '.
2193: 'onchange="'.$jscall.'" />',
2194: '<label><input type="hidden" name="krbver" value="4" />',
2195: '</label>');
2196: } elsif ($can_assign{'krb5'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 5 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="5" />',
2205: '</label>');
2206: }
2207: return $result;
2208: }
2209:
2210: sub authform_internal{
2211: my %in = (
2212: formname => 'document.cu',
2213: kerb_def_dom => 'MSU.EDU',
2214: @_,
2215: );
2216: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2217: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2218: if (defined($in{'curr_authtype'})) {
2219: if ($in{'curr_authtype'} eq 'int') {
2220: if ($can_assign{'int'}) {
2221: $intcheck = 'checked="on" ';
2222: if (defined($in{'mode'})) {
2223: if ($in{'mode'} eq 'modifyuser') {
2224: $intcheck = '';
2225: }
2226: }
2227: if (defined($in{'curr_autharg'})) {
2228: $intarg = $in{'curr_autharg'};
2229: }
2230: } else {
2231: $result = &mt('Currently internally authenticated.');
2232: return $result;
2233: }
2234: }
2235: } else {
2236: if ($authnum == 1) {
2237: $authtype = '<input type="hidden" name="login" value="int">';
2238: }
2239: }
2240: if (!$can_assign{'int'}) {
2241: return;
2242: } elsif ($authtype eq '') {
2243: if (defined($in{'mode'})) {
2244: if ($in{'mode'} eq 'modifycourse') {
2245: if ($authnum == 1) {
2246: $authtype = '<input type="hidden" name="login" value="int">';
2247: }
2248: }
2249: }
2250: }
2251: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2252: if ($authtype eq '') {
2253: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2254: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2255: }
2256: $autharg = '<input type="password" size="10" name="intarg" value="'.
2257: $intarg.'" onchange="'.$jscall.'" />';
2258: $result = &mt
2259: ('[_1] Internally authenticated (with initial password [_2])',
2260: '<label>'.$authtype,'</label>'.$autharg);
2261: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
2262: return $result;
2263: }
2264:
2265: sub authform_local{
2266: my %in = (
2267: formname => 'document.cu',
2268: kerb_def_dom => 'MSU.EDU',
2269: @_,
2270: );
2271: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2272: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2273: if (defined($in{'curr_authtype'})) {
2274: if ($in{'curr_authtype'} eq 'loc') {
2275: if ($can_assign{'loc'}) {
2276: $loccheck = 'checked="on" ';
2277: if (defined($in{'mode'})) {
2278: if ($in{'mode'} eq 'modifyuser') {
2279: $loccheck = '';
2280: }
2281: }
2282: if (defined($in{'curr_autharg'})) {
2283: $locarg = $in{'curr_autharg'};
2284: }
2285: } else {
2286: $result = &mt('Currently using local (institutional) authentication.');
2287: return $result;
2288: }
2289: }
2290: } else {
2291: if ($authnum == 1) {
2292: $authtype = '<input type="hidden" name="login" value="loc">';
2293: }
2294: }
2295: if (!$can_assign{'loc'}) {
2296: return;
2297: } elsif ($authtype eq '') {
2298: if (defined($in{'mode'})) {
2299: if ($in{'mode'} eq 'modifycourse') {
2300: if ($authnum == 1) {
2301: $authtype = '<input type="hidden" name="login" value="loc">';
2302: }
2303: }
2304: }
2305: }
2306: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2307: if ($authtype eq '') {
2308: $authtype = '<input type="radio" name="login" value="loc" '.
2309: $loccheck.' onchange="'.$jscall.'" onclick="'.
2310: $jscall.'" />';
2311: }
2312: $autharg = '<input type="text" size="10" name="locarg" value="'.
2313: $locarg.'" onchange="'.$jscall.'" />';
2314: $result = &mt('[_1] Local Authentication with argument [_2]',
2315: '<label>'.$authtype,'</label>'.$autharg);
2316: return $result;
2317: }
2318:
2319: sub authform_filesystem{
2320: my %in = (
2321: formname => 'document.cu',
2322: kerb_def_dom => 'MSU.EDU',
2323: @_,
2324: );
2325: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2326: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2327: if (defined($in{'curr_authtype'})) {
2328: if ($in{'curr_authtype'} eq 'fsys') {
2329: if ($can_assign{'fsys'}) {
2330: $fsyscheck = 'checked="on" ';
2331: if (defined($in{'mode'})) {
2332: if ($in{'mode'} eq 'modifyuser') {
2333: $fsyscheck = '';
2334: }
2335: }
2336: } else {
2337: $result = &mt('Currently Filesystem Authenticated.');
2338: return $result;
2339: }
2340: }
2341: } else {
2342: if ($authnum == 1) {
2343: $authtype = '<input type="hidden" name="login" value="fsys">';
2344: }
2345: }
2346: if (!$can_assign{'fsys'}) {
2347: return;
2348: } elsif ($authtype eq '') {
2349: if (defined($in{'mode'})) {
2350: if ($in{'mode'} eq 'modifycourse') {
2351: if ($authnum == 1) {
2352: $authtype = '<input type="hidden" name="login" value="fsys">';
2353: }
2354: }
2355: }
2356: }
2357: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2358: if ($authtype eq '') {
2359: $authtype = '<input type="radio" name="login" value="fsys" '.
2360: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2361: $jscall.'" />';
2362: }
2363: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2364: ' onchange="'.$jscall.'" />';
2365: $result = &mt
2366: ('[_1] Filesystem Authenticated (with initial password [_2])',
2367: '<label><input type="radio" name="login" value="fsys" '.
2368: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
2369: '</label><input type="password" size="10" name="fsysarg" value="" '.
2370: 'onchange="'.$jscall.'" />');
2371: return $result;
2372: }
2373:
2374: sub get_assignable_auth {
2375: my ($dom) = @_;
2376: if ($dom eq '') {
2377: $dom = $env{'request.role.domain'};
2378: }
2379: my %can_assign = (
2380: krb4 => 1,
2381: krb5 => 1,
2382: int => 1,
2383: loc => 1,
2384: );
2385: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2386: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2387: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2388: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2389: my $context;
2390: if ($env{'request.role'} =~ /^au/) {
2391: $context = 'author';
2392: } elsif ($env{'request.role'} =~ /^dc/) {
2393: $context = 'domain';
2394: } elsif ($env{'request.course.id'}) {
2395: $context = 'course';
2396: }
2397: if ($context) {
2398: if (ref($authhash->{$context}) eq 'HASH') {
2399: %can_assign = %{$authhash->{$context}};
2400: }
2401: }
2402: }
2403: }
2404: my $authnum = 0;
2405: foreach my $key (keys(%can_assign)) {
2406: if ($can_assign{$key}) {
2407: $authnum ++;
2408: }
2409: }
2410: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2411: $authnum --;
2412: }
2413: return ($authnum,%can_assign);
2414: }
2415:
2416: ###############################################################
2417: ## Get Kerberos Defaults for Domain ##
2418: ###############################################################
2419: ##
2420: ## Returns default kerberos version and an associated argument
2421: ## as listed in file domain.tab. If not listed, provides
2422: ## appropriate default domain and kerberos version.
2423: ##
2424: #-------------------------------------------
2425:
2426: =pod
2427:
2428: =item * &get_kerberos_defaults()
2429:
2430: get_kerberos_defaults($target_domain) returns the default kerberos
2431: version and domain. If not found, it defaults to version 4 and the
2432: domain of the server.
2433:
2434: =over 4
2435:
2436: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2437:
2438: =back
2439:
2440: =back
2441:
2442: =cut
2443:
2444: #-------------------------------------------
2445: sub get_kerberos_defaults {
2446: my $domain=shift;
2447: my ($krbdef,$krbdefdom);
2448: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2449: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2450: $krbdef = $domdefaults{'auth_def'};
2451: $krbdefdom = $domdefaults{'auth_arg_def'};
2452: } else {
2453: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2454: my $krbdefdom=$1;
2455: $krbdefdom=~tr/a-z/A-Z/;
2456: $krbdef = "krb4";
2457: }
2458: return ($krbdef,$krbdefdom);
2459: }
2460:
2461:
2462: ###############################################################
2463: ## Thesaurus Functions ##
2464: ###############################################################
2465:
2466: =pod
2467:
2468: =head1 Thesaurus Functions
2469:
2470: =over 4
2471:
2472: =item * &initialize_keywords()
2473:
2474: Initializes the package variable %Keywords if it is empty. Uses the
2475: package variable $thesaurus_db_file.
2476:
2477: =cut
2478:
2479: ###################################################
2480:
2481: sub initialize_keywords {
2482: return 1 if (scalar keys(%Keywords));
2483: # If we are here, %Keywords is empty, so fill it up
2484: # Make sure the file we need exists...
2485: if (! -e $thesaurus_db_file) {
2486: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2487: " failed because it does not exist");
2488: return 0;
2489: }
2490: # Set up the hash as a database
2491: my %thesaurus_db;
2492: if (! tie(%thesaurus_db,'GDBM_File',
2493: $thesaurus_db_file,&GDBM_READER(),0640)){
2494: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2495: $thesaurus_db_file);
2496: return 0;
2497: }
2498: # Get the average number of appearances of a word.
2499: my $avecount = $thesaurus_db{'average.count'};
2500: # Put keywords (those that appear > average) into %Keywords
2501: while (my ($word,$data)=each (%thesaurus_db)) {
2502: my ($count,undef) = split /:/,$data;
2503: $Keywords{$word}++ if ($count > $avecount);
2504: }
2505: untie %thesaurus_db;
2506: # Remove special values from %Keywords.
2507: foreach my $value ('total.count','average.count') {
2508: delete($Keywords{$value}) if (exists($Keywords{$value}));
2509: }
2510: return 1;
2511: }
2512:
2513: ###################################################
2514:
2515: =pod
2516:
2517: =item * &keyword($word)
2518:
2519: Returns true if $word is a keyword. A keyword is a word that appears more
2520: than the average number of times in the thesaurus database. Calls
2521: &initialize_keywords
2522:
2523: =cut
2524:
2525: ###################################################
2526:
2527: sub keyword {
2528: return if (!&initialize_keywords());
2529: my $word=lc(shift());
2530: $word=~s/\W//g;
2531: return exists($Keywords{$word});
2532: }
2533:
2534: ###############################################################
2535:
2536: =pod
2537:
2538: =item * &get_related_words()
2539:
2540: Look up a word in the thesaurus. Takes a scalar argument and returns
2541: an array of words. If the keyword is not in the thesaurus, an empty array
2542: will be returned. The order of the words returned is determined by the
2543: database which holds them.
2544:
2545: Uses global $thesaurus_db_file.
2546:
2547: =cut
2548:
2549: ###############################################################
2550: sub get_related_words {
2551: my $keyword = shift;
2552: my %thesaurus_db;
2553: if (! -e $thesaurus_db_file) {
2554: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2555: "failed because the file does not exist");
2556: return ();
2557: }
2558: if (! tie(%thesaurus_db,'GDBM_File',
2559: $thesaurus_db_file,&GDBM_READER(),0640)){
2560: return ();
2561: }
2562: my @Words=();
2563: my $count=0;
2564: if (exists($thesaurus_db{$keyword})) {
2565: # The first element is the number of times
2566: # the word appears. We do not need it now.
2567: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2568: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2569: my $threshold=$mostfrequentcount/10;
2570: foreach my $possibleword (@RelatedWords) {
2571: my ($word,$wordcount)=split(/\,/,$possibleword);
2572: if ($wordcount>$threshold) {
2573: push(@Words,$word);
2574: $count++;
2575: if ($count>10) { last; }
2576: }
2577: }
2578: }
2579: untie %thesaurus_db;
2580: return @Words;
2581: }
2582:
2583: =pod
2584:
2585: =back
2586:
2587: =cut
2588:
2589: # -------------------------------------------------------------- Plaintext name
2590: =pod
2591:
2592: =head1 User Name Functions
2593:
2594: =over 4
2595:
2596: =item * &plainname($uname,$udom,$first)
2597:
2598: Takes a users logon name and returns it as a string in
2599: "first middle last generation" form
2600: if $first is set to 'lastname' then it returns it as
2601: 'lastname generation, firstname middlename' if their is a lastname
2602:
2603: =cut
2604:
2605:
2606: ###############################################################
2607: sub plainname {
2608: my ($uname,$udom,$first)=@_;
2609: return if (!defined($uname) || !defined($udom));
2610: my %names=&getnames($uname,$udom);
2611: my $name=&Apache::lonnet::format_name($names{'firstname'},
2612: $names{'middlename'},
2613: $names{'lastname'},
2614: $names{'generation'},$first);
2615: $name=~s/^\s+//;
2616: $name=~s/\s+$//;
2617: $name=~s/\s+/ /g;
2618: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
2619: return $name;
2620: }
2621:
2622: # -------------------------------------------------------------------- Nickname
2623: =pod
2624:
2625: =item * &nickname($uname,$udom)
2626:
2627: Gets a users name and returns it as a string as
2628:
2629: ""nickname""
2630:
2631: if the user has a nickname or
2632:
2633: "first middle last generation"
2634:
2635: if the user does not
2636:
2637: =cut
2638:
2639: sub nickname {
2640: my ($uname,$udom)=@_;
2641: return if (!defined($uname) || !defined($udom));
2642: my %names=&getnames($uname,$udom);
2643: my $name=$names{'nickname'};
2644: if ($name) {
2645: $name='"'.$name.'"';
2646: } else {
2647: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2648: $names{'lastname'}.' '.$names{'generation'};
2649: $name=~s/\s+$//;
2650: $name=~s/\s+/ /g;
2651: }
2652: return $name;
2653: }
2654:
2655: sub getnames {
2656: my ($uname,$udom)=@_;
2657: return if (!defined($uname) || !defined($udom));
2658: if ($udom eq 'public' && $uname eq 'public') {
2659: return ('lastname' => &mt('Public'));
2660: }
2661: my $id=$uname.':'.$udom;
2662: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2663: if ($cached) {
2664: return %{$names};
2665: } else {
2666: my %loadnames=&Apache::lonnet::get('environment',
2667: ['firstname','middlename','lastname','generation','nickname'],
2668: $udom,$uname);
2669: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2670: return %loadnames;
2671: }
2672: }
2673:
2674: # -------------------------------------------------------------------- getemails
2675:
2676: =pod
2677:
2678: =item * &getemails($uname,$udom)
2679:
2680: Gets a user's email information and returns it as a hash with keys:
2681: notification, critnotification, permanentemail
2682:
2683: For notification and critnotification, values are comma-separated lists
2684: of e-mail addresses; for permanentemail, value is a single e-mail address.
2685:
2686:
2687: =cut
2688:
2689:
2690: sub getemails {
2691: my ($uname,$udom)=@_;
2692: if ($udom eq 'public' && $uname eq 'public') {
2693: return;
2694: }
2695: if (!$udom) { $udom=$env{'user.domain'}; }
2696: if (!$uname) { $uname=$env{'user.name'}; }
2697: my $id=$uname.':'.$udom;
2698: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2699: if ($cached) {
2700: return %{$names};
2701: } else {
2702: my %loadnames=&Apache::lonnet::get('environment',
2703: ['notification','critnotification',
2704: 'permanentemail'],
2705: $udom,$uname);
2706: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2707: return %loadnames;
2708: }
2709: }
2710:
2711: sub flush_email_cache {
2712: my ($uname,$udom)=@_;
2713: if (!$udom) { $udom =$env{'user.domain'}; }
2714: if (!$uname) { $uname=$env{'user.name'}; }
2715: return if ($udom eq 'public' && $uname eq 'public');
2716: my $id=$uname.':'.$udom;
2717: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2718: }
2719:
2720: # ------------------------------------------------------------------ Screenname
2721:
2722: =pod
2723:
2724: =item * &screenname($uname,$udom)
2725:
2726: Gets a users screenname and returns it as a string
2727:
2728: =cut
2729:
2730: sub screenname {
2731: my ($uname,$udom)=@_;
2732: if ($uname eq $env{'user.name'} &&
2733: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
2734: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
2735: return $names{'screenname'};
2736: }
2737:
2738:
2739: # ------------------------------------------------------------- Message Wrapper
2740:
2741: sub messagewrapper {
2742: my ($link,$username,$domain,$subject,$text)=@_;
2743: return
2744: '<a href="/adm/email?compose=individual&'.
2745: 'recname='.$username.'&recdom='.$domain.
2746: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
2747: 'title="'.&mt('Send message').'">'.$link.'</a>';
2748: }
2749: # --------------------------------------------------------------- Notes Wrapper
2750:
2751: sub noteswrapper {
2752: my ($link,$un,$do)=@_;
2753: return
2754: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
2755: }
2756: # ------------------------------------------------------------- Aboutme Wrapper
2757:
2758: sub aboutmewrapper {
2759: my ($link,$username,$domain,$target)=@_;
2760: if (!defined($username) && !defined($domain)) {
2761: return;
2762: }
2763: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
2764: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
2765: }
2766:
2767: # ------------------------------------------------------------ Syllabus Wrapper
2768:
2769:
2770: sub syllabuswrapper {
2771: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2772: if ($fontcolor) {
2773: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2774: }
2775: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
2776: }
2777:
2778: sub track_student_link {
2779: my ($linktext,$sname,$sdom,$target,$start) = @_;
2780: my $link ="/adm/trackstudent?";
2781: my $title = 'View recent activity';
2782: if (defined($sname) && $sname !~ /^\s*$/ &&
2783: defined($sdom) && $sdom !~ /^\s*$/) {
2784: $link .= "selected_student=$sname:$sdom";
2785: $title .= ' of this student';
2786: }
2787: if (defined($target) && $target !~ /^\s*$/) {
2788: $target = qq{target="$target"};
2789: } else {
2790: $target = '';
2791: }
2792: if ($start) { $link.='&start='.$start; }
2793: $title = &mt($title);
2794: $linktext = &mt($linktext);
2795: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2796: &help_open_topic('View_recent_activity');
2797: }
2798:
2799: # ===================================================== Display a student photo
2800:
2801:
2802: sub student_image_tag {
2803: my ($domain,$user)=@_;
2804: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2805: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2806: return '<img src="'.$imgsrc.'" align="right" />';
2807: } else {
2808: return '';
2809: }
2810: }
2811:
2812: =pod
2813:
2814: =back
2815:
2816: =head1 Access .tab File Data
2817:
2818: =over 4
2819:
2820: =item * &languageids()
2821:
2822: returns list of all language ids
2823:
2824: =cut
2825:
2826: sub languageids {
2827: return sort(keys(%language));
2828: }
2829:
2830: =pod
2831:
2832: =item * &languagedescription()
2833:
2834: returns description of a specified language id
2835:
2836: =cut
2837:
2838: sub languagedescription {
2839: my $code=shift;
2840: return ($supported_language{$code}?'* ':'').
2841: $language{$code}.
2842: ($supported_language{$code}?' ('.&mt('interface available').')':'');
2843: }
2844:
2845: sub plainlanguagedescription {
2846: my $code=shift;
2847: return $language{$code};
2848: }
2849:
2850: sub supportedlanguagecode {
2851: my $code=shift;
2852: return $supported_language{$code};
2853: }
2854:
2855: =pod
2856:
2857: =item * ©rightids()
2858:
2859: returns list of all copyrights
2860:
2861: =cut
2862:
2863: sub copyrightids {
2864: return sort(keys(%cprtag));
2865: }
2866:
2867: =pod
2868:
2869: =item * ©rightdescription()
2870:
2871: returns description of a specified copyright id
2872:
2873: =cut
2874:
2875: sub copyrightdescription {
2876: return &mt($cprtag{shift(@_)});
2877: }
2878:
2879: =pod
2880:
2881: =item * &source_copyrightids()
2882:
2883: returns list of all source copyrights
2884:
2885: =cut
2886:
2887: sub source_copyrightids {
2888: return sort(keys(%scprtag));
2889: }
2890:
2891: =pod
2892:
2893: =item * &source_copyrightdescription()
2894:
2895: returns description of a specified source copyright id
2896:
2897: =cut
2898:
2899: sub source_copyrightdescription {
2900: return &mt($scprtag{shift(@_)});
2901: }
2902:
2903: =pod
2904:
2905: =item * &filecategories()
2906:
2907: returns list of all file categories
2908:
2909: =cut
2910:
2911: sub filecategories {
2912: return sort(keys(%category_extensions));
2913: }
2914:
2915: =pod
2916:
2917: =item * &filecategorytypes()
2918:
2919: returns list of file types belonging to a given file
2920: category
2921:
2922: =cut
2923:
2924: sub filecategorytypes {
2925: my ($cat) = @_;
2926: return @{$category_extensions{lc($cat)}};
2927: }
2928:
2929: =pod
2930:
2931: =item * &fileembstyle()
2932:
2933: returns embedding style for a specified file type
2934:
2935: =cut
2936:
2937: sub fileembstyle {
2938: return $fe{lc(shift(@_))};
2939: }
2940:
2941: sub filemimetype {
2942: return $fm{lc(shift(@_))};
2943: }
2944:
2945:
2946: sub filecategoryselect {
2947: my ($name,$value)=@_;
2948: return &select_form($value,$name,
2949: '' => &mt('Any category'),
2950: map { $_,$_ } sort(keys(%category_extensions)));
2951: }
2952:
2953: =pod
2954:
2955: =item * &filedescription()
2956:
2957: returns description for a specified file type
2958:
2959: =cut
2960:
2961: sub filedescription {
2962: my $file_description = $fd{lc(shift())};
2963: $file_description =~ s:([\[\]]):~$1:g;
2964: return &mt($file_description);
2965: }
2966:
2967: =pod
2968:
2969: =item * &filedescriptionex()
2970:
2971: returns description for a specified file type with
2972: extra formatting
2973:
2974: =cut
2975:
2976: sub filedescriptionex {
2977: my $ex=shift;
2978: my $file_description = $fd{lc($ex)};
2979: $file_description =~ s:([\[\]]):~$1:g;
2980: return '.'.$ex.' '.&mt($file_description);
2981: }
2982:
2983: # End of .tab access
2984: =pod
2985:
2986: =back
2987:
2988: =cut
2989:
2990: # ------------------------------------------------------------------ File Types
2991: sub fileextensions {
2992: return sort(keys(%fe));
2993: }
2994:
2995: # ----------------------------------------------------------- Display Languages
2996: # returns a hash with all desired display languages
2997: #
2998:
2999: sub display_languages {
3000: my %languages=();
3001: foreach my $lang (&preferred_languages()) {
3002: $languages{$lang}=1;
3003: }
3004: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
3005: if ($env{'form.displaylanguage'}) {
3006: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3007: $languages{$lang}=1;
3008: }
3009: }
3010: return %languages;
3011: }
3012:
3013: sub preferred_languages {
3014: my @languages=();
3015: if (($env{'request.role.adv'}) && ($env{'form.languages'})) {
3016: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$env{'form.languages'}));
3017: }
3018: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
3019: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
3020: $env{'course.'.$env{'request.course.id'}.'.languages'}));
3021: }
3022:
3023: if ($env{'environment.languages'}) {
3024: @languages=(@languages,
3025: split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
3026: }
3027: my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
3028: if ($browser) {
3029: my @browser =
3030: map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
3031: push(@languages,@browser);
3032: }
3033:
3034: foreach my $domtype ($env{'user.domain'},$env{'request.role.domain'},
3035: $Apache::lonnet::perlvar{'lonDefDomain'}) {
3036: if ($domtype ne '') {
3037: my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
3038: if ($domdefs{'lang_def'} ne '') {
3039: push(@languages,$domdefs{'lang_def'});
3040: }
3041: }
3042: }
3043: return &get_genlanguages(@languages);
3044: }
3045:
3046: sub get_genlanguages {
3047: my (@languages) = @_;
3048: # turn "en-ca" into "en-ca,en"
3049: my @genlanguages;
3050: foreach my $lang (@languages) {
3051: unless ($lang=~/\w/) { next; }
3052: push(@genlanguages,$lang);
3053: if ($lang=~/(\-|\_)/) {
3054: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
3055: }
3056: }
3057: #uniqueify the languages list
3058: my %count;
3059: @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
3060: return @genlanguages;
3061: }
3062:
3063: sub languages {
3064: my ($possible_langs) = @_;
3065: my @preferred_langs = &preferred_languages();
3066: if (!ref($possible_langs)) {
3067: if( wantarray ) {
3068: return @preferred_langs;
3069: } else {
3070: return $preferred_langs[0];
3071: }
3072: }
3073: my %possibilities = map { $_ => 1 } (@$possible_langs);
3074: my @preferred_possibilities;
3075: foreach my $preferred_lang (@preferred_langs) {
3076: if (exists($possibilities{$preferred_lang})) {
3077: push(@preferred_possibilities, $preferred_lang);
3078: }
3079: }
3080: if( wantarray ) {
3081: return @preferred_possibilities;
3082: }
3083: return $preferred_possibilities[0];
3084: }
3085:
3086: ###############################################################
3087: ## Student Answer Attempts ##
3088: ###############################################################
3089:
3090: =pod
3091:
3092: =head1 Alternate Problem Views
3093:
3094: =over 4
3095:
3096: =item * &get_previous_attempt($symb, $username, $domain, $course,
3097: $getattempt, $regexp, $gradesub)
3098:
3099: Return string with previous attempt on problem. Arguments:
3100:
3101: =over 4
3102:
3103: =item * $symb: Problem, including path
3104:
3105: =item * $username: username of the desired student
3106:
3107: =item * $domain: domain of the desired student
3108:
3109: =item * $course: Course ID
3110:
3111: =item * $getattempt: Leave blank for all attempts, otherwise put
3112: something
3113:
3114: =item * $regexp: if string matches this regexp, the string will be
3115: sent to $gradesub
3116:
3117: =item * $gradesub: routine that processes the string if it matches $regexp
3118:
3119: =back
3120:
3121: The output string is a table containing all desired attempts, if any.
3122:
3123: =cut
3124:
3125: sub get_previous_attempt {
3126: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
3127: my $prevattempts='';
3128: no strict 'refs';
3129: if ($symb) {
3130: my (%returnhash)=
3131: &Apache::lonnet::restore($symb,$course,$domain,$username);
3132: if ($returnhash{'version'}) {
3133: my %lasthash=();
3134: my $version;
3135: for ($version=1;$version<=$returnhash{'version'};$version++) {
3136: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3137: $lasthash{$key}=$returnhash{$version.':'.$key};
3138: }
3139: }
3140: $prevattempts=&start_data_table().&start_data_table_header_row();
3141: $prevattempts.='<th>'.&mt('History').'</th>';
3142: foreach my $key (sort(keys(%lasthash))) {
3143: my ($ign,@parts) = split(/\./,$key);
3144: if ($#parts > 0) {
3145: my $data=$parts[-1];
3146: pop(@parts);
3147: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3148: } else {
3149: if ($#parts == 0) {
3150: $prevattempts.='<th>'.$parts[0].'</th>';
3151: } else {
3152: $prevattempts.='<th>'.$ign.'</th>';
3153: }
3154: }
3155: }
3156: $prevattempts.=&end_data_table_header_row();
3157: if ($getattempt eq '') {
3158: for ($version=1;$version<=$returnhash{'version'};$version++) {
3159: $prevattempts.=&start_data_table_row().
3160: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3161: foreach my $key (sort(keys(%lasthash))) {
3162: my $value = &format_previous_attempt_value($key,
3163: $returnhash{$version.':'.$key});
3164: $prevattempts.='<td>'.$value.' </td>';
3165: }
3166: $prevattempts.=&end_data_table_row();
3167: }
3168: }
3169: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
3170: foreach my $key (sort(keys(%lasthash))) {
3171: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3172: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
3173: $prevattempts.='<td>'.$value.' </td>';
3174: }
3175: $prevattempts.= &end_data_table_row().&end_data_table();
3176: } else {
3177: $prevattempts=
3178: &start_data_table().&start_data_table_row().
3179: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3180: &end_data_table_row().&end_data_table();
3181: }
3182: } else {
3183: $prevattempts=
3184: &start_data_table().&start_data_table_row().
3185: '<td>'.&mt('No data.').'</td>'.
3186: &end_data_table_row().&end_data_table();
3187: }
3188: }
3189:
3190: sub format_previous_attempt_value {
3191: my ($key,$value) = @_;
3192: if ($key =~ /timestamp/) {
3193: $value = &Apache::lonlocal::locallocaltime($value);
3194: } elsif (ref($value) eq 'ARRAY') {
3195: $value = '('.join(', ', @{ $value }).')';
3196: } else {
3197: $value = &unescape($value);
3198: }
3199: return $value;
3200: }
3201:
3202:
3203: sub relative_to_absolute {
3204: my ($url,$output)=@_;
3205: my $parser=HTML::TokeParser->new(\$output);
3206: my $token;
3207: my $thisdir=$url;
3208: my @rlinks=();
3209: while ($token=$parser->get_token) {
3210: if ($token->[0] eq 'S') {
3211: if ($token->[1] eq 'a') {
3212: if ($token->[2]->{'href'}) {
3213: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3214: }
3215: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3216: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3217: } elsif ($token->[1] eq 'base') {
3218: $thisdir=$token->[2]->{'href'};
3219: }
3220: }
3221: }
3222: $thisdir=~s-/[^/]*$--;
3223: foreach my $link (@rlinks) {
3224: unless (($link=~/^http:\/\//i) ||
3225: ($link=~/^\//) ||
3226: ($link=~/^javascript:/i) ||
3227: ($link=~/^mailto:/i) ||
3228: ($link=~/^\#/)) {
3229: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3230: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
3231: }
3232: }
3233: # -------------------------------------------------- Deal with Applet codebases
3234: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3235: return $output;
3236: }
3237:
3238: =pod
3239:
3240: =item * &get_student_view()
3241:
3242: show a snapshot of what student was looking at
3243:
3244: =cut
3245:
3246: sub get_student_view {
3247: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
3248: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
3249: my (%form);
3250: my @elements=('symb','courseid','domain','username');
3251: foreach my $element (@elements) {
3252: $form{'grade_'.$element}=eval '$'.$element #'
3253: }
3254: if (defined($moreenv)) {
3255: %form=(%form,%{$moreenv});
3256: }
3257: if (defined($target)) { $form{'grade_target'} = $target; }
3258: $feedurl=&Apache::lonnet::clutter($feedurl);
3259: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
3260: $userview=~s/\<body[^\>]*\>//gi;
3261: $userview=~s/\<\/body\>//gi;
3262: $userview=~s/\<html\>//gi;
3263: $userview=~s/\<\/html\>//gi;
3264: $userview=~s/\<head\>//gi;
3265: $userview=~s/\<\/head\>//gi;
3266: $userview=~s/action\s*\=/would_be_action\=/gi;
3267: $userview=&relative_to_absolute($feedurl,$userview);
3268: if (wantarray) {
3269: return ($userview,$response);
3270: } else {
3271: return $userview;
3272: }
3273: }
3274:
3275: sub get_student_view_with_retries {
3276: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3277:
3278: my $ok = 0; # True if we got a good response.
3279: my $content;
3280: my $response;
3281:
3282: # Try to get the student_view done. within the retries count:
3283:
3284: do {
3285: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3286: $ok = $response->is_success;
3287: if (!$ok) {
3288: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3289: }
3290: $retries--;
3291: } while (!$ok && ($retries > 0));
3292:
3293: if (!$ok) {
3294: $content = ''; # On error return an empty content.
3295: }
3296: if (wantarray) {
3297: return ($content, $response);
3298: } else {
3299: return $content;
3300: }
3301: }
3302:
3303: =pod
3304:
3305: =item * &get_student_answers()
3306:
3307: show a snapshot of how student was answering problem
3308:
3309: =cut
3310:
3311: sub get_student_answers {
3312: my ($symb,$username,$domain,$courseid,%form) = @_;
3313: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
3314: my (%moreenv);
3315: my @elements=('symb','courseid','domain','username');
3316: foreach my $element (@elements) {
3317: $moreenv{'grade_'.$element}=eval '$'.$element #'
3318: }
3319: $moreenv{'grade_target'}='answer';
3320: %moreenv=(%form,%moreenv);
3321: $feedurl = &Apache::lonnet::clutter($feedurl);
3322: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
3323: return $userview;
3324: }
3325:
3326: =pod
3327:
3328: =item * &submlink()
3329:
3330: Inputs: $text $uname $udom $symb $target
3331:
3332: Returns: A link to grades.pm such as to see the SUBM view of a student
3333:
3334: =cut
3335:
3336: ###############################################
3337: sub submlink {
3338: my ($text,$uname,$udom,$symb,$target)=@_;
3339: if (!($uname && $udom)) {
3340: (my $cursymb, my $courseid,$udom,$uname)=
3341: &Apache::lonnet::whichuser($symb);
3342: if (!$symb) { $symb=$cursymb; }
3343: }
3344: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
3345: $symb=&escape($symb);
3346: if ($target) { $target="target=\"$target\""; }
3347: return '<a href="/adm/grades?&command=submission&'.
3348: 'symb='.$symb.'&student='.$uname.
3349: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3350: }
3351: ##############################################
3352:
3353: =pod
3354:
3355: =item * &pgrdlink()
3356:
3357: Inputs: $text $uname $udom $symb $target
3358:
3359: Returns: A link to grades.pm such as to see the PGRD view of a student
3360:
3361: =cut
3362:
3363: ###############################################
3364: sub pgrdlink {
3365: my $link=&submlink(@_);
3366: $link=~s/(&command=submission)/$1&showgrading=yes/;
3367: return $link;
3368: }
3369: ##############################################
3370:
3371: =pod
3372:
3373: =item * &pprmlink()
3374:
3375: Inputs: $text $uname $udom $symb $target
3376:
3377: Returns: A link to parmset.pm such as to see the PPRM view of a
3378: student and a specific resource
3379:
3380: =cut
3381:
3382: ###############################################
3383: sub pprmlink {
3384: my ($text,$uname,$udom,$symb,$target)=@_;
3385: if (!($uname && $udom)) {
3386: (my $cursymb, my $courseid,$udom,$uname)=
3387: &Apache::lonnet::whichuser($symb);
3388: if (!$symb) { $symb=$cursymb; }
3389: }
3390: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
3391: $symb=&escape($symb);
3392: if ($target) { $target="target=\"$target\""; }
3393: return '<a href="/adm/parmset?command=set&'.
3394: 'symb='.$symb.'&uname='.$uname.
3395: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
3396: }
3397: ##############################################
3398:
3399: =pod
3400:
3401: =back
3402:
3403: =cut
3404:
3405: ###############################################
3406:
3407:
3408: sub timehash {
3409: my ($thistime) = @_;
3410: my $timezone = &Apache::lonlocal::gettimezone();
3411: my $dt = DateTime->from_epoch(epoch => $thistime)
3412: ->set_time_zone($timezone);
3413: my $wday = $dt->day_of_week();
3414: if ($wday == 7) { $wday = 0; }
3415: return ( 'second' => $dt->second(),
3416: 'minute' => $dt->minute(),
3417: 'hour' => $dt->hour(),
3418: 'day' => $dt->day_of_month(),
3419: 'month' => $dt->month(),
3420: 'year' => $dt->year(),
3421: 'weekday' => $wday,
3422: 'dayyear' => $dt->day_of_year(),
3423: 'dlsav' => $dt->is_dst() );
3424: }
3425:
3426: sub utc_string {
3427: my ($date)=@_;
3428: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
3429: }
3430:
3431: sub maketime {
3432: my %th=@_;
3433: my ($epoch_time,$timezone,$dt);
3434: $timezone = &Apache::lonlocal::gettimezone();
3435: eval {
3436: $dt = DateTime->new( year => $th{'year'},
3437: month => $th{'month'},
3438: day => $th{'day'},
3439: hour => $th{'hour'},
3440: minute => $th{'minute'},
3441: second => $th{'second'},
3442: time_zone => $timezone,
3443: );
3444: };
3445: if (!$@) {
3446: $epoch_time = $dt->epoch;
3447: if ($epoch_time) {
3448: return $epoch_time;
3449: }
3450: }
3451: return POSIX::mktime(
3452: ($th{'seconds'},$th{'minutes'},$th{'hours'},
3453: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
3454: }
3455:
3456: #########################################
3457:
3458: sub findallcourses {
3459: my ($roles,$uname,$udom) = @_;
3460: my %roles;
3461: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
3462: my %courses;
3463: my $now=time;
3464: if (!defined($uname)) {
3465: $uname = $env{'user.name'};
3466: }
3467: if (!defined($udom)) {
3468: $udom = $env{'user.domain'};
3469: }
3470: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3471: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3472: if (!%roles) {
3473: %roles = (
3474: cc => 1,
3475: in => 1,
3476: ep => 1,
3477: ta => 1,
3478: cr => 1,
3479: st => 1,
3480: );
3481: }
3482: foreach my $entry (keys(%roleshash)) {
3483: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3484: if ($trole =~ /^cr/) {
3485: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3486: } else {
3487: next if (!exists($roles{$trole}));
3488: }
3489: if ($tend) {
3490: next if ($tend < $now);
3491: }
3492: if ($tstart) {
3493: next if ($tstart > $now);
3494: }
3495: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3496: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3497: if ($secpart eq '') {
3498: ($cnum,$role) = split(/_/,$cnumpart);
3499: $sec = 'none';
3500: $realsec = '';
3501: } else {
3502: $cnum = $cnumpart;
3503: ($sec,$role) = split(/_/,$secpart);
3504: $realsec = $sec;
3505: }
3506: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3507: }
3508: } else {
3509: foreach my $key (keys(%env)) {
3510: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3511: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
3512: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3513: next if ($role eq 'ca' || $role eq 'aa');
3514: next if (%roles && !exists($roles{$role}));
3515: my ($starttime,$endtime)=split(/\./,$env{$key});
3516: my $active=1;
3517: if ($starttime) {
3518: if ($now<$starttime) { $active=0; }
3519: }
3520: if ($endtime) {
3521: if ($now>$endtime) { $active=0; }
3522: }
3523: if ($active) {
3524: if ($sec eq '') {
3525: $sec = 'none';
3526: }
3527: $courses{$cdom.'_'.$cnum}{$sec} =
3528: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
3529: }
3530: }
3531: }
3532: }
3533: return %courses;
3534: }
3535:
3536: ###############################################
3537:
3538: sub blockcheck {
3539: my ($setters,$activity,$uname,$udom) = @_;
3540:
3541: if (!defined($udom)) {
3542: $udom = $env{'user.domain'};
3543: }
3544: if (!defined($uname)) {
3545: $uname = $env{'user.name'};
3546: }
3547:
3548: # If uname and udom are for a course, check for blocks in the course.
3549:
3550: if (&Apache::lonnet::is_course($udom,$uname)) {
3551: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
3552: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
3553: return ($startblock,$endblock);
3554: }
3555:
3556: my $startblock = 0;
3557: my $endblock = 0;
3558: my %live_courses = &findallcourses(undef,$uname,$udom);
3559:
3560: # If uname is for a user, and activity is course-specific, i.e.,
3561: # boards, chat or groups, check for blocking in current course only.
3562:
3563: if (($activity eq 'boards' || $activity eq 'chat' ||
3564: $activity eq 'groups') && ($env{'request.course.id'})) {
3565: foreach my $key (keys(%live_courses)) {
3566: if ($key ne $env{'request.course.id'}) {
3567: delete($live_courses{$key});
3568: }
3569: }
3570: }
3571:
3572: my $otheruser = 0;
3573: my %own_courses;
3574: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3575: # Resource belongs to user other than current user.
3576: $otheruser = 1;
3577: # Gather courses for current user
3578: %own_courses =
3579: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3580: }
3581:
3582: # Gather active course roles - course coordinator, instructor,
3583: # exam proctor, ta, student, or custom role.
3584:
3585: foreach my $course (keys(%live_courses)) {
3586: my ($cdom,$cnum);
3587: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3588: $cdom = $env{'course.'.$course.'.domain'};
3589: $cnum = $env{'course.'.$course.'.num'};
3590: } else {
3591: ($cdom,$cnum) = split(/_/,$course);
3592: }
3593: my $no_ownblock = 0;
3594: my $no_userblock = 0;
3595: if ($otheruser && $activity ne 'com') {
3596: # Check if current user has 'evb' priv for this
3597: if (defined($own_courses{$course})) {
3598: foreach my $sec (keys(%{$own_courses{$course}})) {
3599: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3600: if ($sec ne 'none') {
3601: $checkrole .= '/'.$sec;
3602: }
3603: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3604: $no_ownblock = 1;
3605: last;
3606: }
3607: }
3608: }
3609: # if they have 'evb' priv and are currently not playing student
3610: next if (($no_ownblock) &&
3611: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3612: }
3613: foreach my $sec (keys(%{$live_courses{$course}})) {
3614: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3615: if ($sec ne 'none') {
3616: $checkrole .= '/'.$sec;
3617: }
3618: if ($otheruser) {
3619: # Resource belongs to user other than current user.
3620: # Assemble privs for that user, and check for 'evb' priv.
3621: my ($trole,$tdom,$tnum,$tsec);
3622: my $entry = $live_courses{$course}{$sec};
3623: if ($entry =~ /^cr/) {
3624: ($trole,$tdom,$tnum,$tsec) =
3625: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3626: } else {
3627: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3628: }
3629: my ($spec,$area,$trest,%allroles,%userroles);
3630: $area = '/'.$tdom.'/'.$tnum;
3631: $trest = $tnum;
3632: if ($tsec ne '') {
3633: $area .= '/'.$tsec;
3634: $trest .= '/'.$tsec;
3635: }
3636: $spec = $trole.'.'.$area;
3637: if ($trole =~ /^cr/) {
3638: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3639: $tdom,$spec,$trest,$area);
3640: } else {
3641: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3642: $tdom,$spec,$trest,$area);
3643: }
3644: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
3645: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3646: if ($1) {
3647: $no_userblock = 1;
3648: last;
3649: }
3650: }
3651: } else {
3652: # Resource belongs to current user
3653: # Check for 'evb' priv via lonnet::allowed().
3654: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3655: $no_ownblock = 1;
3656: last;
3657: }
3658: }
3659: }
3660: # if they have the evb priv and are currently not playing student
3661: next if (($no_ownblock) &&
3662: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
3663: next if ($no_userblock);
3664:
3665: # Retrieve blocking times and identity of blocker for course
3666: # of specified user, unless user has 'evb' privilege.
3667:
3668: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3669: if (($start != 0) &&
3670: (($startblock == 0) || ($startblock > $start))) {
3671: $startblock = $start;
3672: }
3673: if (($end != 0) &&
3674: (($endblock == 0) || ($endblock < $end))) {
3675: $endblock = $end;
3676: }
3677: }
3678: return ($startblock,$endblock);
3679: }
3680:
3681: sub get_blocks {
3682: my ($setters,$activity,$cdom,$cnum) = @_;
3683: my $startblock = 0;
3684: my $endblock = 0;
3685: my $course = $cdom.'_'.$cnum;
3686: $setters->{$course} = {};
3687: $setters->{$course}{'staff'} = [];
3688: $setters->{$course}{'times'} = [];
3689: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3690: foreach my $record (keys(%records)) {
3691: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3692: if ($start <= time && $end >= time) {
3693: my ($staff_name,$staff_dom,$title,$blocks) =
3694: &parse_block_record($records{$record});
3695: if ($blocks->{$activity} eq 'on') {
3696: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3697: push(@{$$setters{$course}{'times'}}, [$start,$end]);
3698: if ( ($startblock == 0) || ($startblock > $start) ) {
3699: $startblock = $start;
3700: }
3701: if ( ($endblock == 0) || ($endblock < $end) ) {
3702: $endblock = $end;
3703: }
3704: }
3705: }
3706: }
3707: return ($startblock,$endblock);
3708: }
3709:
3710: sub parse_block_record {
3711: my ($record) = @_;
3712: my ($setuname,$setudom,$title,$blocks);
3713: if (ref($record) eq 'HASH') {
3714: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3715: $title = &unescape($record->{'event'});
3716: $blocks = $record->{'blocks'};
3717: } else {
3718: my @data = split(/:/,$record,3);
3719: if (scalar(@data) eq 2) {
3720: $title = $data[1];
3721: ($setuname,$setudom) = split(/@/,$data[0]);
3722: } else {
3723: ($setuname,$setudom,$title) = @data;
3724: }
3725: $blocks = { 'com' => 'on' };
3726: }
3727: return ($setuname,$setudom,$title,$blocks);
3728: }
3729:
3730: sub build_block_table {
3731: my ($startblock,$endblock,$setters) = @_;
3732: my %lt = &Apache::lonlocal::texthash(
3733: 'cacb' => 'Currently active communication blocks',
3734: 'cour' => 'Course',
3735: 'dura' => 'Duration',
3736: 'blse' => 'Block set by'
3737: );
3738: my $output;
3739: $output = '<br />'.$lt{'cacb'}.':<br />';
3740: $output .= &start_data_table();
3741: $output .= '
3742: <tr>
3743: <th>'.$lt{'cour'}.'</th>
3744: <th>'.$lt{'dura'}.'</th>
3745: <th>'.$lt{'blse'}.'</th>
3746: </tr>
3747: ';
3748: foreach my $course (keys(%{$setters})) {
3749: my %courseinfo=&Apache::lonnet::coursedescription($course);
3750: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3751: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
3752: my $fullname = &plainname($uname,$udom);
3753: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3754: && $env{'user.name'} ne 'public'
3755: && $env{'user.domain'} ne 'public') {
3756: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3757: }
3758: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3759: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3760: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3761: $output .= &Apache::loncommon::start_data_table_row().
3762: '<td>'.$courseinfo{'description'}.'</td>'.
3763: '<td>'.$openblock.' to '.$closeblock.'</td>'.
3764: '<td>'.$fullname.'</td>'.
3765: &Apache::loncommon::end_data_table_row();
3766: }
3767: }
3768: $output .= &end_data_table();
3769: }
3770:
3771: sub blocking_status {
3772: my ($activity,$uname,$udom) = @_;
3773: my %setters;
3774: my ($blocked,$output,$ownitem,$is_course);
3775: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3776: if ($startblock && $endblock) {
3777: $blocked = 1;
3778: if (wantarray) {
3779: my $category;
3780: if ($activity eq 'boards') {
3781: $category = 'Discussion posts in this course';
3782: } elsif ($activity eq 'blogs') {
3783: $category = 'Blogs';
3784: } elsif ($activity eq 'port') {
3785: if (defined($uname) && defined($udom)) {
3786: if ($uname eq $env{'user.name'} &&
3787: $udom eq $env{'user.domain'}) {
3788: $ownitem = 1;
3789: }
3790: }
3791: $is_course = &Apache::lonnet::is_course($udom,$uname);
3792: if ($ownitem) {
3793: $category = 'Your portfolio files';
3794: } elsif ($is_course) {
3795: my $coursedesc;
3796: foreach my $course (keys(%setters)) {
3797: my %courseinfo =
3798: &Apache::lonnet::coursedescription($course);
3799: $coursedesc = $courseinfo{'description'};
3800: }
3801: $category = "Group files in the course '$coursedesc'";
3802: } else {
3803: $category = 'Portfolio files belonging to ';
3804: if ($env{'user.name'} eq 'public' &&
3805: $env{'user.domain'} eq 'public') {
3806: $category .= &plainname($uname,$udom);
3807: } else {
3808: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3809: }
3810: }
3811: } elsif ($activity eq 'groups') {
3812: $category = 'Groups in this course';
3813: }
3814: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3815: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3816: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3817: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3818: $output .= &build_block_table($startblock,$endblock,\%setters);
3819: }
3820: }
3821: }
3822: if (wantarray) {
3823: return ($blocked,$output);
3824: } else {
3825: return $blocked;
3826: }
3827: }
3828:
3829: ###############################################
3830:
3831: sub check_ip_acc {
3832: my ($acc)=@_;
3833: &Apache::lonxml::debug("acc is $acc");
3834: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3835: return 1;
3836: }
3837: my $allowed=0;
3838: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3839:
3840: my $name;
3841: foreach my $pattern (split(',',$acc)) {
3842: $pattern =~ s/^\s*//;
3843: $pattern =~ s/\s*$//;
3844: if ($pattern =~ /\*$/) {
3845: #35.8.*
3846: $pattern=~s/\*//;
3847: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3848: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3849: #35.8.3.[34-56]
3850: my $low=$2;
3851: my $high=$3;
3852: $pattern=$1;
3853: if ($ip =~ /^\Q$pattern\E/) {
3854: my $last=(split(/\./,$ip))[3];
3855: if ($last <=$high && $last >=$low) { $allowed=1; }
3856: }
3857: } elsif ($pattern =~ /^\*/) {
3858: #*.msu.edu
3859: $pattern=~s/\*//;
3860: if (!defined($name)) {
3861: use Socket;
3862: my $netaddr=inet_aton($ip);
3863: ($name)=gethostbyaddr($netaddr,AF_INET);
3864: }
3865: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3866: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3867: #127.0.0.1
3868: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3869: } else {
3870: #some.name.com
3871: if (!defined($name)) {
3872: use Socket;
3873: my $netaddr=inet_aton($ip);
3874: ($name)=gethostbyaddr($netaddr,AF_INET);
3875: }
3876: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3877: }
3878: if ($allowed) { last; }
3879: }
3880: return $allowed;
3881: }
3882:
3883: ###############################################
3884:
3885: =pod
3886:
3887: =head1 Domain Template Functions
3888:
3889: =over 4
3890:
3891: =item * &determinedomain()
3892:
3893: Inputs: $domain (usually will be undef)
3894:
3895: Returns: Determines which domain should be used for designs
3896:
3897: =cut
3898:
3899: ###############################################
3900: sub determinedomain {
3901: my $domain=shift;
3902: if (! $domain) {
3903: # Determine domain if we have not been given one
3904: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
3905: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3906: if ($env{'request.role.domain'}) {
3907: $domain=$env{'request.role.domain'};
3908: }
3909: }
3910: return $domain;
3911: }
3912: ###############################################
3913:
3914: sub devalidate_domconfig_cache {
3915: my ($udom)=@_;
3916: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3917: }
3918:
3919: # ---------------------- Get domain configuration for a domain
3920: sub get_domainconf {
3921: my ($udom) = @_;
3922: my $cachetime=1800;
3923: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3924: if (defined($cached)) { return %{$result}; }
3925:
3926: my %domconfig = &Apache::lonnet::get_dom('configuration',
3927: ['login','rolecolors'],$udom);
3928: my (%designhash,%legacy);
3929: if (keys(%domconfig) > 0) {
3930: if (ref($domconfig{'login'}) eq 'HASH') {
3931: if (keys(%{$domconfig{'login'}})) {
3932: foreach my $key (keys(%{$domconfig{'login'}})) {
3933: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3934: }
3935: } else {
3936: $legacy{'login'} = 1;
3937: }
3938: } else {
3939: $legacy{'login'} = 1;
3940: }
3941: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
3942: if (keys(%{$domconfig{'rolecolors'}})) {
3943: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3944: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3945: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3946: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3947: }
3948: }
3949: }
3950: } else {
3951: $legacy{'rolecolors'} = 1;
3952: }
3953: } else {
3954: $legacy{'rolecolors'} = 1;
3955: }
3956: if (keys(%legacy) > 0) {
3957: my %legacyhash = &get_legacy_domconf($udom);
3958: foreach my $item (keys(%legacyhash)) {
3959: if ($item =~ /^\Q$udom\E\.login/) {
3960: if ($legacy{'login'}) {
3961: $designhash{$item} = $legacyhash{$item};
3962: }
3963: } else {
3964: if ($legacy{'rolecolors'}) {
3965: $designhash{$item} = $legacyhash{$item};
3966: }
3967: }
3968: }
3969: }
3970: } else {
3971: %designhash = &get_legacy_domconf($udom);
3972: }
3973: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3974: $cachetime);
3975: return %designhash;
3976: }
3977:
3978: sub get_legacy_domconf {
3979: my ($udom) = @_;
3980: my %legacyhash;
3981: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3982: my $designfile = $designdir.'/'.$udom.'.tab';
3983: if (-e $designfile) {
3984: if ( open (my $fh,"<$designfile") ) {
3985: while (my $line = <$fh>) {
3986: next if ($line =~ /^\#/);
3987: chomp($line);
3988: my ($key,$val)=(split(/\=/,$line));
3989: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3990: }
3991: close($fh);
3992: }
3993: }
3994: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3995: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3996: }
3997: return %legacyhash;
3998: }
3999:
4000: =pod
4001:
4002: =item * &domainlogo()
4003:
4004: Inputs: $domain (usually will be undef)
4005:
4006: Returns: A link to a domain logo, if the domain logo exists.
4007: If the domain logo does not exist, a description of the domain.
4008:
4009: =cut
4010:
4011: ###############################################
4012: sub domainlogo {
4013: my $domain = &determinedomain(shift);
4014: my %designhash = &get_domainconf($domain);
4015: # See if there is a logo
4016: if ($designhash{$domain.'.login.domlogo'} ne '') {
4017: my $imgsrc = $designhash{$domain.'.login.domlogo'};
4018: if ($imgsrc =~ m{^/(adm|res)/}) {
4019: if ($imgsrc =~ m{^/res/}) {
4020: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4021: &Apache::lonnet::repcopy($local_name);
4022: }
4023: $imgsrc = &lonhttpdurl($imgsrc);
4024: }
4025: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
4026: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4027: return &Apache::lonnet::domain($domain,'description');
4028: } else {
4029: return '';
4030: }
4031: }
4032: ##############################################
4033:
4034: =pod
4035:
4036: =item * &designparm()
4037:
4038: Inputs: $which parameter; $domain (usually will be undef)
4039:
4040: Returns: value of designparamter $which
4041:
4042: =cut
4043:
4044:
4045: ##############################################
4046: sub designparm {
4047: my ($which,$domain)=@_;
4048: if ($env{'browser.blackwhite'} eq 'on') {
4049: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
4050: return '#000000';
4051: }
4052: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
4053: return '#FFFFFF';
4054: }
4055: if ($which=~/\.tabbg$/) {
4056: return '#CCCCCC';
4057: }
4058: }
4059: if (exists($env{'environment.color.'.$which})) {
4060: return $env{'environment.color.'.$which};
4061: }
4062: $domain=&determinedomain($domain);
4063: my %domdesign = &get_domainconf($domain);
4064: my $output;
4065: if ($domdesign{$domain.'.'.$which} ne '') {
4066: $output = $domdesign{$domain.'.'.$which};
4067: } else {
4068: $output = $defaultdesign{$which};
4069: }
4070: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
4071: ($which =~ /login\.(img|logo|domlogo|login)/)) {
4072: if ($output =~ m{^/(adm|res)/}) {
4073: if ($output =~ m{^/res/}) {
4074: my $local_name = &Apache::lonnet::filelocation('',$output);
4075: &Apache::lonnet::repcopy($local_name);
4076: }
4077: $output = &lonhttpdurl($output);
4078: }
4079: }
4080: return $output;
4081: }
4082:
4083: ###############################################
4084: ###############################################
4085:
4086: =pod
4087:
4088: =back
4089:
4090: =head1 HTML Helpers
4091:
4092: =over 4
4093:
4094: =item * &bodytag()
4095:
4096: Returns a uniform header for LON-CAPA web pages.
4097:
4098: Inputs:
4099:
4100: =over 4
4101:
4102: =item * $title, A title to be displayed on the page.
4103:
4104: =item * $function, the current role (can be undef).
4105:
4106: =item * $addentries, extra parameters for the <body> tag.
4107:
4108: =item * $bodyonly, if defined, only return the <body> tag.
4109:
4110: =item * $domain, if defined, force a given domain.
4111:
4112: =item * $forcereg, if page should register as content page (relevant for
4113: text interface only)
4114:
4115: =item * $customtitle, alternate text to use instead of $title
4116: in the title box that appears, this text
4117: is not auto translated like the $title is
4118:
4119: =item * $notopbar, if true, keep the 'what is this' info but remove the
4120: navigational links
4121:
4122: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4123:
4124: =item * $notitle, if true keep the nav controls, but remove the title bar
4125:
4126: =item * $no_inline_link, if true and in remote mode, don't show the
4127: 'Switch To Inline Menu' link
4128:
4129: =item * $args, optional argument valid values are
4130: no_auto_mt_title -> prevents &mt()ing the title arg
4131: inherit_jsmath -> when creating popup window in a page,
4132: should it have jsmath forced on by the
4133: current page
4134:
4135: =back
4136:
4137: Returns: A uniform header for LON-CAPA web pages.
4138: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4139: If $bodyonly is undef or zero, an html string containing a <body> tag and
4140: other decorations will be returned.
4141:
4142: =cut
4143:
4144: sub bodytag {
4145: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
4146: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
4147:
4148: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
4149:
4150: $function = &get_users_function() if (!$function);
4151: my $img = &designparm($function.'.img',$domain);
4152: my $font = &designparm($function.'.font',$domain);
4153: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4154:
4155: my %design = ( 'style' => 'margin-top: 0px',
4156: 'bgcolor' => $pgbg,
4157: 'text' => $font,
4158: 'alink' => &designparm($function.'.alink',$domain),
4159: 'vlink' => &designparm($function.'.vlink',$domain),
4160: 'link' => &designparm($function.'.link',$domain),);
4161: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
4162:
4163: # role and realm
4164: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4165: if ($role eq 'ca') {
4166: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
4167: $realm = &plainname($rname,$rdom);
4168: }
4169: # realm
4170: if ($env{'request.course.id'}) {
4171: if ($env{'request.role'} !~ /^cr/) {
4172: $role = &Apache::lonnet::plaintext($role,&course_type());
4173: }
4174: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
4175: } else {
4176: $role = &Apache::lonnet::plaintext($role);
4177: }
4178:
4179: if (!$realm) { $realm=' '; }
4180: # Set messages
4181: my $messages=&domainlogo($domain);
4182:
4183: my $extra_body_attr = &make_attr_string($forcereg,\%design);
4184:
4185: # construct main body tag
4186: my $bodytag = "<body $extra_body_attr>".
4187: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
4188:
4189: if ($bodyonly) {
4190: return $bodytag;
4191: } elsif ($env{'browser.interface'} eq 'textual') {
4192: # Accessibility
4193:
4194: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
4195: if (!$notitle) {
4196: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4197: }
4198: return $bodytag;
4199: }
4200:
4201: my $name = &plainname($env{'user.name'},$env{'user.domain'});
4202: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4203: undef($role);
4204: } else {
4205: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
4206: }
4207:
4208: my $roleinfo=(<<ENDROLE);
4209: <td class="LC_title_bar_who">
4210: <div class="LC_title_bar_name">
4211: $name
4212:
4213: </div>
4214: <div class="LC_title_bar_role">
4215: $role
4216: </div>
4217: <div class="LC_title_bar_realm">
4218: $realm
4219: </div>
4220: </td>
4221: ENDROLE
4222:
4223: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4224: if ($customtitle) {
4225: $titleinfo = $customtitle;
4226: }
4227: #
4228: # Extra info if you are the DC
4229: my $dc_info = '';
4230: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4231: $env{'course.'.$env{'request.course.id'}.
4232: '.domain'}.'/'})) {
4233: my $cid = $env{'request.course.id'};
4234: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
4235: $dc_info =~ s/\s+$//;
4236: $dc_info = '('.$dc_info.')';
4237: }
4238:
4239: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
4240: # No Remote
4241: if ($env{'request.state'} eq 'construct') {
4242: $forcereg=1;
4243: }
4244:
4245: if (!$customtitle && $env{'request.state'} eq 'construct') {
4246: # this is for resources; directories have customtitle, and crumbs
4247: # and select recent are created in lonpubdir.pm
4248: my ($uname,$thisdisfn)=
4249: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4250: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4251: $formaction=~s/\/+/\//g;
4252:
4253: my $parentpath = '';
4254: my $lastitem = '';
4255: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4256: $parentpath = $1;
4257: $lastitem = $2;
4258: } else {
4259: $lastitem = $thisdisfn;
4260: }
4261: $titleinfo =
4262: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4263: .'<b>'.&mt('Construction Space').'</b>: '
4264: .'<form name="dirs" method="post" action="'.$formaction
4265: .'" target="_top"><tt><b>'
4266: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
4267: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4268: .'</form>'
4269: .&Apache::lonmenu::constspaceform();
4270: }
4271:
4272: my $titletable;
4273: if (!$notitle) {
4274: $titletable =
4275: '<table id="LC_title_bar">'.
4276: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4277: '</tr></table>';
4278: }
4279: if ($notopbar) {
4280: $bodytag .= $titletable;
4281: } else {
4282: if ($env{'request.state'} eq 'construct') {
4283: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4284: $titletable);
4285: } else {
4286: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
4287: $titletable;
4288: }
4289: }
4290: return $bodytag;
4291: }
4292:
4293: #
4294: # Top frame rendering, Remote is up
4295: #
4296:
4297: my $imgsrc = $img;
4298: if ($img =~ /^\/adm/) {
4299: $imgsrc = &lonhttpdurl($img);
4300: }
4301: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
4302:
4303: # Explicit link to get inline menu
4304: my $menu= ($no_inline_link?''
4305: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
4306: #
4307: if ($notitle) {
4308: return $bodytag;
4309: }
4310: return(<<ENDBODY);
4311: $bodytag
4312: <table id="LC_title_bar" class="LC_with_remote">
4313: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
4314: <td class="LC_title_bar_domain_logo">$messages </td>
4315: </tr>
4316: <tr><td>$titleinfo $dc_info $menu</td>
4317: $roleinfo
4318: </tr>
4319: </table>
4320: ENDBODY
4321: }
4322:
4323: sub make_attr_string {
4324: my ($register,$attr_ref) = @_;
4325:
4326: if ($attr_ref && !ref($attr_ref)) {
4327: die("addentries Must be a hash ref ".
4328: join(':',caller(1))." ".
4329: join(':',caller(0))." ");
4330: }
4331:
4332: if ($register) {
4333: my ($on_load,$on_unload);
4334: foreach my $key (keys(%{$attr_ref})) {
4335: if (lc($key) eq 'onload') {
4336: $on_load.=$attr_ref->{$key}.';';
4337: delete($attr_ref->{$key});
4338:
4339: } elsif (lc($key) eq 'onunload') {
4340: $on_unload.=$attr_ref->{$key}.';';
4341: delete($attr_ref->{$key});
4342: }
4343: }
4344: $attr_ref->{'onload'} =
4345: &Apache::lonmenu::loadevents(). $on_load;
4346: $attr_ref->{'onunload'}=
4347: &Apache::lonmenu::unloadevents().$on_unload;
4348: }
4349:
4350: # Accessibility font enhance
4351: if ($env{'browser.fontenhance'} eq 'on') {
4352: my $style;
4353: foreach my $key (keys(%{$attr_ref})) {
4354: if (lc($key) eq 'style') {
4355: $style.=$attr_ref->{$key}.';';
4356: delete($attr_ref->{$key});
4357: }
4358: }
4359: $attr_ref->{'style'}=$style.'; font-size: x-large;';
4360: }
4361:
4362: if ($env{'browser.blackwhite'} eq 'on') {
4363: delete($attr_ref->{'font'});
4364: delete($attr_ref->{'link'});
4365: delete($attr_ref->{'alink'});
4366: delete($attr_ref->{'vlink'});
4367: delete($attr_ref->{'bgcolor'});
4368: delete($attr_ref->{'background'});
4369: }
4370:
4371: my $attr_string;
4372: foreach my $attr (keys(%$attr_ref)) {
4373: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4374: }
4375: return $attr_string;
4376: }
4377:
4378:
4379: ###############################################
4380: ###############################################
4381:
4382: =pod
4383:
4384: =item * &endbodytag()
4385:
4386: Returns a uniform footer for LON-CAPA web pages.
4387:
4388: Inputs: 1 - optional reference to an args hash
4389: If in the hash, key for noredirectlink has a value which evaluates to true,
4390: a 'Continue' link is not displayed if the page contains an
4391: internal redirect in the <head></head> section,
4392: i.e., $env{'internal.head.redirect'} exists
4393:
4394: =cut
4395:
4396: sub endbodytag {
4397: my ($args) = @_;
4398: my $endbodytag='</body>';
4399: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
4400: if ( exists( $env{'internal.head.redirect'} ) ) {
4401: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4402: $endbodytag=
4403: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4404: &mt('Continue').'</a>'.
4405: $endbodytag;
4406: }
4407: }
4408: return $endbodytag;
4409: }
4410:
4411: =pod
4412:
4413: =item * &standard_css()
4414:
4415: Returns a style sheet
4416:
4417: Inputs: (all optional)
4418: domain -> force to color decorate a page for a specific
4419: domain
4420: function -> force usage of a specific rolish color scheme
4421: bgcolor -> override the default page bgcolor
4422:
4423: =cut
4424:
4425: sub standard_css {
4426: my ($function,$domain,$bgcolor) = @_;
4427: $function = &get_users_function() if (!$function);
4428: my $img = &designparm($function.'.img', $domain);
4429: my $tabbg = &designparm($function.'.tabbg', $domain);
4430: my $font = &designparm($function.'.font', $domain);
4431: my $sidebg = &designparm($function.'.sidebg',$domain);
4432: my $pgbg_or_bgcolor =
4433: $bgcolor ||
4434: &designparm($function.'.pgbg', $domain);
4435: my $pgbg = &designparm($function.'.pgbg', $domain);
4436: my $alink = &designparm($function.'.alink', $domain);
4437: my $vlink = &designparm($function.'.vlink', $domain);
4438: my $link = &designparm($function.'.link', $domain);
4439:
4440: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
4441: my $mono = 'monospace';
4442: my $data_table_head = $tabbg;
4443: my $data_table_light = '#EEEEEE';
4444: my $data_table_dark = '#DDDDDD';
4445: my $data_table_darker = '#CCCCCC';
4446: my $data_table_highlight = '#FFFF00';
4447: my $mail_new = '#FFBB77';
4448: my $mail_new_hover = '#DD9955';
4449: my $mail_read = '#BBBB77';
4450: my $mail_read_hover = '#999944';
4451: my $mail_replied = '#AAAA88';
4452: my $mail_replied_hover = '#888855';
4453: my $mail_other = '#99BBBB';
4454: my $mail_other_hover = '#669999';
4455: my $table_header = '#DDDDDD';
4456: my $feedback_link_bg = '#BBBBBB';
4457:
4458: my $border = ($env{'browser.type'} eq 'explorer' ||
4459: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4460: : '0px 3px 0px 4px';
4461:
4462:
4463: return <<END;
4464: h1, h2, h3, th { font-family: $sans }
4465: a:focus { color: red; background: yellow }
4466: table.thinborder,
4467:
4468: table.thinborder tr th {
4469: border-style: solid;
4470: border-width: 1px;
4471: background: $tabbg;
4472: }
4473: table.thinborder tr td {
4474: border-style: solid;
4475: border-width: 1px
4476: }
4477:
4478: form, .inline { display: inline; }
4479: .center { text-align: center; }
4480: .LC_filename {font-family: $mono; white-space:pre;}
4481: .LC_error {
4482: color: red;
4483: font-size: larger;
4484: }
4485: .LC_warning,
4486: .LC_diff_removed {
4487: color: red;
4488: }
4489:
4490: .LC_info,
4491: .LC_success,
4492: .LC_diff_added {
4493: color: green;
4494: }
4495: .LC_unknown {
4496: color: yellow;
4497: }
4498:
4499: .LC_icon {
4500: border: 0px;
4501: }
4502: .LC_indexer_icon {
4503: border: 0px;
4504: height: 22px;
4505: }
4506: .LC_docs_spacer {
4507: width: 25px;
4508: height: 1px;
4509: border: 0px;
4510: }
4511:
4512: .LC_internal_info {
4513: color: #999;
4514: }
4515:
4516: table.LC_pastsubmission {
4517: border: 1px solid black;
4518: margin: 2px;
4519: }
4520:
4521: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
4522: width: 100%;
4523: background: $pgbg;
4524: border: 2px;
4525: border-collapse: separate;
4526: padding: 0px;
4527: }
4528:
4529: table#LC_title_bar, table.LC_breadcrumbs,
4530: table#LC_title_bar.LC_with_remote {
4531: width: 100%;
4532: border-color: $pgbg;
4533: border-style: solid;
4534: border-width: $border;
4535:
4536: background: $pgbg;
4537: font-family: $sans;
4538: border-collapse: collapse;
4539: padding: 0px;
4540: }
4541:
4542: table.LC_docs_path {
4543: width: 100%;
4544: border: 0;
4545: background: $pgbg;
4546: font-family: $sans;
4547: border-collapse: collapse;
4548: padding: 0px;
4549: }
4550:
4551: table#LC_title_bar td {
4552: background: $tabbg;
4553: }
4554: table#LC_title_bar td.LC_title_bar_who {
4555: background: $tabbg;
4556: color: $font;
4557: font: small $sans;
4558: text-align: right;
4559: }
4560: span.LC_metadata {
4561: font-family: $sans;
4562: }
4563: span.LC_title_bar_title {
4564: font: bold x-large $sans;
4565: }
4566: table#LC_title_bar td.LC_title_bar_domain_logo {
4567: background: $sidebg;
4568: text-align: right;
4569: padding: 0px;
4570: }
4571: table#LC_title_bar td.LC_title_bar_role_logo {
4572: background: $sidebg;
4573: padding: 0px;
4574: }
4575:
4576: table#LC_menubuttons_mainmenu {
4577: width: 100%;
4578: border: 0px;
4579: border-spacing: 1px;
4580: padding: 0px 1px;
4581: margin: 0px;
4582: border-collapse: separate;
4583: }
4584: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4585: border: 0px;
4586: }
4587: table#LC_top_nav td {
4588: background: $tabbg;
4589: border: 0px;
4590: font-size: small;
4591: }
4592: table#LC_top_nav td a, div#LC_top_nav a {
4593: color: $font;
4594: font-family: $sans;
4595: }
4596: table#LC_top_nav td.LC_top_nav_logo {
4597: background: $tabbg;
4598: text-align: left;
4599: white-space: nowrap;
4600: width: 31px;
4601: }
4602: table#LC_top_nav td.LC_top_nav_logo img {
4603: border: 0px;
4604: vertical-align: bottom;
4605: }
4606: table#LC_top_nav td.LC_top_nav_exit,
4607: table#LC_top_nav td.LC_top_nav_help {
4608: width: 2.0em;
4609: }
4610: table#LC_top_nav td.LC_top_nav_login {
4611: width: 4.0em;
4612: text-align: center;
4613: }
4614: table.LC_breadcrumbs td, table.LC_docs_path td {
4615: background: $tabbg;
4616: color: $font;
4617: font-family: $sans;
4618: font-size: smaller;
4619: }
4620: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4621: table.LC_docs_path td.LC_docs_path_component {
4622: background: $tabbg;
4623: color: $font;
4624: font-family: $sans;
4625: font-size: larger;
4626: text-align: right;
4627: }
4628: td.LC_table_cell_checkbox {
4629: text-align: center;
4630: }
4631: table#LC_mainmenu td.LC_mainmenu_column {
4632: vertical-align: top;
4633: }
4634:
4635: .LC_menubuttons_inline_text {
4636: color: $font;
4637: font-family: $sans;
4638: font-size: smaller;
4639: }
4640:
4641: .LC_menubuttons_link {
4642: text-decoration: none;
4643: }
4644: #2008--9-5: new menu style sheet.Changed category
4645: .LC_menubuttons_category {
4646: color: $font;
4647: background: $pgbg;
4648: font-family: $sans;
4649: font-size: larger;
4650: font-weight: bold;
4651: }
4652:
4653: td.LC_menubuttons_text {
4654: width: 90%;
4655: color: $font;
4656: font-family: $sans;
4657: }
4658:
4659: td.LC_menubuttons_img {
4660: }
4661:
4662: .LC_current_location {
4663: font-family: $sans;
4664: background: $tabbg;
4665: }
4666: .LC_new_mail {
4667: font-family: $sans;
4668: background: $tabbg;
4669: font-weight: bold;
4670: }
4671:
4672: .LC_rolesmenu_is {
4673: font-family: $sans;
4674: }
4675:
4676: .LC_rolesmenu_selected {
4677: font-family: $sans;
4678: }
4679:
4680: .LC_rolesmenu_future {
4681: font-family: $sans;
4682: }
4683:
4684:
4685: .LC_rolesmenu_will {
4686: font-family: $sans;
4687: }
4688:
4689: .LC_rolesmenu_will_not {
4690: font-family: $sans;
4691: }
4692:
4693: .LC_rolesmenu_expired {
4694: font-family: $sans;
4695: }
4696:
4697: .LC_rolesinfo {
4698: font-family: $sans;
4699: }
4700:
4701: .LC_dropadd_labeltext {
4702: font-family: $sans;
4703: text-align: right;
4704: }
4705:
4706: .LC_preferences_labeltext {
4707: font-family: $sans;
4708: text-align: right;
4709: }
4710:
4711: .LC_roleslog_note {
4712: font-size: smaller;
4713: }
4714:
4715: table.LC_aboutme_port {
4716: border: 0px;
4717: border-collapse: collapse;
4718: border-spacing: 0px;
4719: }
4720: table.LC_data_table, table.LC_mail_list {
4721: border: 1px solid #000000;
4722: border-collapse: separate;
4723: border-spacing: 1px;
4724: background: $pgbg;
4725: }
4726: .LC_data_table_dense {
4727: font-size: small;
4728: }
4729: table.LC_nested_outer {
4730: border: 1px solid #000000;
4731: border-collapse: collapse;
4732: border-spacing: 0px;
4733: width: 100%;
4734: }
4735: table.LC_nested {
4736: border: 0px;
4737: border-collapse: collapse;
4738: border-spacing: 0px;
4739: width: 100%;
4740: }
4741: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4742: table.LC_prior_tries tr th {
4743: font-weight: bold;
4744: background-color: $data_table_head;
4745: font-size: smaller;
4746: }
4747: table.LC_data_table tr.LC_odd_row > td,
4748: table.LC_aboutme_port tr td {
4749: background-color: $data_table_light;
4750: padding: 2px;
4751: }
4752: table.LC_data_table tr.LC_even_row > td,
4753: table.LC_aboutme_port tr.LC_even_row td {
4754: background-color: $data_table_dark;
4755: }
4756: table.LC_data_table tr.LC_data_table_highlight td {
4757: background-color: $data_table_darker;
4758: }
4759: table.LC_data_table tr td.LC_leftcol_header {
4760: background-color: $data_table_head;
4761: font-weight: bold;
4762: }
4763: table.LC_data_table tr.LC_empty_row td,
4764: table.LC_nested tr.LC_empty_row td {
4765: background-color: #FFFFFF;
4766: font-weight: bold;
4767: font-style: italic;
4768: text-align: center;
4769: padding: 8px;
4770: }
4771: table.LC_nested tr.LC_empty_row td {
4772: padding: 4ex
4773: }
4774: table.LC_nested_outer tr th {
4775: font-weight: bold;
4776: background-color: $data_table_head;
4777: font-size: smaller;
4778: border-bottom: 1px solid #000000;
4779: }
4780: table.LC_nested_outer tr td.LC_subheader {
4781: background-color: $data_table_head;
4782: font-weight: bold;
4783: font-size: small;
4784: border-bottom: 1px solid #000000;
4785: text-align: right;
4786: }
4787: table.LC_nested tr.LC_info_row td {
4788: background-color: #CCC;
4789: font-weight: bold;
4790: font-size: small;
4791: text-align: center;
4792: }
4793: table.LC_nested tr.LC_info_row td.LC_left_item,
4794: table.LC_nested_outer tr th.LC_left_item {
4795: text-align: left;
4796: }
4797: table.LC_nested td {
4798: background-color: #FFF;
4799: font-size: small;
4800: }
4801: table.LC_nested_outer tr th.LC_right_item,
4802: table.LC_nested tr.LC_info_row td.LC_right_item,
4803: table.LC_nested tr.LC_odd_row td.LC_right_item,
4804: table.LC_nested tr td.LC_right_item {
4805: text-align: right;
4806: }
4807:
4808: table.LC_nested tr.LC_odd_row td {
4809: background-color: #EEE;
4810: }
4811:
4812: table.LC_createuser {
4813: }
4814:
4815: table.LC_createuser tr.LC_section_row td {
4816: font-size: smaller;
4817: }
4818:
4819: table.LC_createuser tr.LC_info_row td {
4820: background-color: #CCC;
4821: font-weight: bold;
4822: text-align: center;
4823: }
4824:
4825: table.LC_calendar {
4826: border: 1px solid #000000;
4827: border-collapse: collapse;
4828: }
4829: table.LC_calendar_pickdate {
4830: font-size: xx-small;
4831: }
4832: table.LC_calendar tr td {
4833: border: 1px solid #000000;
4834: vertical-align: top;
4835: }
4836: table.LC_calendar tr td.LC_calendar_day_empty {
4837: background-color: $data_table_dark;
4838: }
4839: table.LC_calendar tr td.LC_calendar_day_current {
4840: background-color: $data_table_highlight;
4841: }
4842:
4843: table.LC_mail_list tr.LC_mail_new {
4844: background-color: $mail_new;
4845: }
4846: table.LC_mail_list tr.LC_mail_new:hover {
4847: background-color: $mail_new_hover;
4848: }
4849: table.LC_mail_list tr.LC_mail_read {
4850: background-color: $mail_read;
4851: }
4852: table.LC_mail_list tr.LC_mail_read:hover {
4853: background-color: $mail_read_hover;
4854: }
4855: table.LC_mail_list tr.LC_mail_replied {
4856: background-color: $mail_replied;
4857: }
4858: table.LC_mail_list tr.LC_mail_replied:hover {
4859: background-color: $mail_replied_hover;
4860: }
4861: table.LC_mail_list tr.LC_mail_other {
4862: background-color: $mail_other;
4863: }
4864: table.LC_mail_list tr.LC_mail_other:hover {
4865: background-color: $mail_other_hover;
4866: }
4867: table.LC_mail_list tr.LC_mail_even {
4868: }
4869: table.LC_mail_list tr.LC_mail_odd {
4870: }
4871:
4872:
4873: table#LC_portfolio_actions {
4874: width: auto;
4875: background: $pgbg;
4876: border: 0px;
4877: border-spacing: 2px 2px;
4878: padding: 0px;
4879: margin: 0px;
4880: border-collapse: separate;
4881: }
4882: table#LC_portfolio_actions td.LC_label {
4883: background: $tabbg;
4884: text-align: right;
4885: }
4886: table#LC_portfolio_actions td.LC_value {
4887: background: $tabbg;
4888: }
4889:
4890: table#LC_cstr_controls {
4891: width: 100%;
4892: border-collapse: collapse;
4893: }
4894: table#LC_cstr_controls tr td {
4895: border: 4px solid $pgbg;
4896: padding: 4px;
4897: text-align: center;
4898: background: $tabbg;
4899: }
4900: table#LC_cstr_controls tr th {
4901: border: 4px solid $pgbg;
4902: background: $table_header;
4903: text-align: center;
4904: font-family: $sans;
4905: font-size: smaller;
4906: }
4907:
4908: table#LC_browser {
4909:
4910: }
4911: table#LC_browser tr th {
4912: background: $table_header;
4913: }
4914: table#LC_browser tr td {
4915: padding: 2px;
4916: }
4917: table#LC_browser tr.LC_browser_file,
4918: table#LC_browser tr.LC_browser_file_published {
4919: background: #CCFF88;
4920: }
4921: table#LC_browser tr.LC_browser_file_locked,
4922: table#LC_browser tr.LC_browser_file_unpublished {
4923: background: #FFAA99;
4924: }
4925: table#LC_browser tr.LC_browser_file_obsolete {
4926: background: #AAAAAA;
4927: }
4928: table#LC_browser tr.LC_browser_file_modified,
4929: table#LC_browser tr.LC_browser_file_metamodified {
4930: background: #FFFF77;
4931: }
4932: table#LC_browser tr.LC_browser_folder {
4933: background: #CCCCFF;
4934: }
4935: span.LC_current_location {
4936: font-size: x-large;
4937: background: $pgbg;
4938: }
4939:
4940: span.LC_parm_menu_item {
4941: font-size: larger;
4942: font-family: $sans;
4943: }
4944: span.LC_parm_scope_all {
4945: color: red;
4946: }
4947: span.LC_parm_scope_folder {
4948: color: green;
4949: }
4950: span.LC_parm_scope_resource {
4951: color: orange;
4952: }
4953: span.LC_parm_part {
4954: color: blue;
4955: }
4956: span.LC_parm_folder, span.LC_parm_symb {
4957: font-size: x-small;
4958: font-family: $mono;
4959: color: #AAAAAA;
4960: }
4961:
4962: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4963: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4964: border: 1px solid black;
4965: border-collapse: collapse;
4966: }
4967: table.LC_parm_overview_restrictions td {
4968: border-width: 1px 4px 1px 4px;
4969: border-style: solid;
4970: border-color: $pgbg;
4971: text-align: center;
4972: }
4973: table.LC_parm_overview_restrictions th {
4974: background: $tabbg;
4975: border-width: 1px 4px 1px 4px;
4976: border-style: solid;
4977: border-color: $pgbg;
4978: }
4979: table#LC_helpmenu {
4980: border: 0px;
4981: height: 55px;
4982: border-spacing: 0px;
4983: }
4984:
4985: table#LC_helpmenu fieldset legend {
4986: font-size: larger;
4987: font-weight: bold;
4988: }
4989: table#LC_helpmenu_links {
4990: width: 100%;
4991: border: 1px solid black;
4992: background: $pgbg;
4993: padding: 0px;
4994: border-spacing: 1px;
4995: }
4996: table#LC_helpmenu_links tr td {
4997: padding: 1px;
4998: background: $tabbg;
4999: text-align: center;
5000: font-weight: bold;
5001: }
5002:
5003: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5004: table#LC_helpmenu_links a:active {
5005: text-decoration: none;
5006: color: $font;
5007: }
5008: table#LC_helpmenu_links a:hover {
5009: text-decoration: underline;
5010: color: $vlink;
5011: }
5012:
5013: .LC_chrt_popup_exists {
5014: border: 1px solid #339933;
5015: margin: -1px;
5016: }
5017: .LC_chrt_popup_up {
5018: border: 1px solid yellow;
5019: margin: -1px;
5020: }
5021: .LC_chrt_popup {
5022: border: 1px solid #8888FF;
5023: background: #CCCCFF;
5024: }
5025: table.LC_pick_box {
5026: border-collapse: separate;
5027: background: white;
5028: border: 1px solid black;
5029: border-spacing: 1px;
5030: }
5031: table.LC_pick_box td.LC_pick_box_title {
5032: background: $tabbg;
5033: font-weight: bold;
5034: text-align: right;
5035: width: 184px;
5036: padding: 8px;
5037: }
5038: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5039: background: $tabbg;
5040: font-weight: bold;
5041: text-align: right;
5042: width: 350px;
5043: padding: 8px;
5044: }
5045:
5046: table.LC_pick_box td.LC_pick_box_value {
5047: text-align: left;
5048: padding: 8px;
5049: }
5050: table.LC_pick_box td.LC_pick_box_select {
5051: text-align: left;
5052: padding: 8px;
5053: }
5054: table.LC_pick_box td.LC_pick_box_separator {
5055: padding: 0px;
5056: height: 1px;
5057: background: black;
5058: }
5059: table.LC_pick_box td.LC_pick_box_submit {
5060: text-align: right;
5061: }
5062: table.LC_pick_box td.LC_evenrow_value {
5063: text-align: left;
5064: padding: 8px;
5065: background-color: $data_table_light;
5066: }
5067: table.LC_pick_box td.LC_oddrow_value {
5068: text-align: left;
5069: padding: 8px;
5070: background-color: $data_table_light;
5071: }
5072: table.LC_helpform_receipt {
5073: width: 620px;
5074: border-collapse: separate;
5075: background: white;
5076: border: 1px solid black;
5077: border-spacing: 1px;
5078: }
5079: table.LC_helpform_receipt td.LC_pick_box_title {
5080: background: $tabbg;
5081: font-weight: bold;
5082: text-align: right;
5083: width: 184px;
5084: padding: 8px;
5085: }
5086: table.LC_helpform_receipt td.LC_evenrow_value {
5087: text-align: left;
5088: padding: 8px;
5089: background-color: $data_table_light;
5090: }
5091: table.LC_helpform_receipt td.LC_oddrow_value {
5092: text-align: left;
5093: padding: 8px;
5094: background-color: $data_table_light;
5095: }
5096: table.LC_helpform_receipt td.LC_pick_box_separator {
5097: padding: 0px;
5098: height: 1px;
5099: background: black;
5100: }
5101: span.LC_helpform_receipt_cat {
5102: font-weight: bold;
5103: }
5104: table.LC_group_priv_box {
5105: background: white;
5106: border: 1px solid black;
5107: border-spacing: 1px;
5108: }
5109: table.LC_group_priv_box td.LC_pick_box_title {
5110: background: $tabbg;
5111: font-weight: bold;
5112: text-align: right;
5113: width: 184px;
5114: }
5115: table.LC_group_priv_box td.LC_groups_fixed {
5116: background: $data_table_light;
5117: text-align: center;
5118: }
5119: table.LC_group_priv_box td.LC_groups_optional {
5120: background: $data_table_dark;
5121: text-align: center;
5122: }
5123: table.LC_group_priv_box td.LC_groups_functionality {
5124: background: $data_table_darker;
5125: text-align: center;
5126: font-weight: bold;
5127: }
5128: table.LC_group_priv td {
5129: text-align: left;
5130: padding: 0px;
5131: }
5132:
5133: table.LC_notify_front_page {
5134: background: white;
5135: border: 1px solid black;
5136: padding: 8px;
5137: }
5138: table.LC_notify_front_page td {
5139: padding: 8px;
5140: }
5141: .LC_navbuttons {
5142: margin: 2ex 0ex 2ex 0ex;
5143: }
5144: .LC_topic_bar {
5145: font-family: $sans;
5146: font-weight: bold;
5147: width: 100%;
5148: background: $tabbg;
5149: vertical-align: middle;
5150: margin: 2ex 0ex 2ex 0ex;
5151: }
5152: .LC_topic_bar span {
5153: vertical-align: middle;
5154: }
5155: .LC_topic_bar img {
5156: vertical-align: bottom;
5157: }
5158: table.LC_course_group_status {
5159: margin: 20px;
5160: }
5161: table.LC_status_selector td {
5162: vertical-align: top;
5163: text-align: center;
5164: padding: 4px;
5165: }
5166: table.LC_descriptive_input td.LC_description {
5167: vertical-align: top;
5168: text-align: right;
5169: font-weight: bold;
5170: }
5171: div.LC_feedback_link {
5172: clear: both;
5173: background: white;
5174: width: 100%;
5175: }
5176: span.LC_feedback_link {
5177: background: $feedback_link_bg;
5178: font-size: larger;
5179: }
5180: span.LC_message_link {
5181: background: $feedback_link_bg;
5182: font-size: larger;
5183: position: absolute;
5184: right: 1em;
5185: }
5186:
5187: table.LC_prior_tries {
5188: border: 1px solid #000000;
5189: border-collapse: separate;
5190: border-spacing: 1px;
5191: }
5192:
5193: table.LC_prior_tries td {
5194: padding: 2px;
5195: }
5196:
5197: .LC_answer_correct {
5198: background: #AAFFAA;
5199: color: black;
5200: }
5201: .LC_answer_charged_try {
5202: background: #FFAAAA ! important;
5203: color: black;
5204: }
5205: .LC_answer_not_charged_try,
5206: .LC_answer_no_grade,
5207: .LC_answer_late {
5208: background: #FFFFAA;
5209: color: black;
5210: }
5211: .LC_answer_previous {
5212: background: #AAAAFF;
5213: color: black;
5214: }
5215: .LC_answer_no_message {
5216: background: #FFFFFF;
5217: color: black;
5218: }
5219: .LC_answer_unknown {
5220: background: orange;
5221: color: black;
5222: }
5223:
5224:
5225: span.LC_prior_numerical,
5226: span.LC_prior_string,
5227: span.LC_prior_custom,
5228: span.LC_prior_reaction,
5229: span.LC_prior_math {
5230: font-family: monospace;
5231: white-space: pre;
5232: }
5233:
5234: span.LC_prior_string {
5235: font-family: monospace;
5236: white-space: pre;
5237: }
5238:
5239: table.LC_prior_option {
5240: width: 100%;
5241: border-collapse: collapse;
5242: }
5243: table.LC_prior_rank, table.LC_prior_match {
5244: border-collapse: collapse;
5245: }
5246: table.LC_prior_option tr td,
5247: table.LC_prior_rank tr td,
5248: table.LC_prior_match tr td {
5249: border: 1px solid #000000;
5250: }
5251:
5252: span.LC_nobreak {
5253: white-space: nowrap;
5254: }
5255:
5256: span.LC_cusr_emph {
5257: font-style: italic;
5258: }
5259:
5260: span.LC_cusr_subheading {
5261: font-weight: normal;
5262: font-size: 85%;
5263: }
5264:
5265: table.LC_docs_documents {
5266: background: #BBBBBB;
5267: border-width: 0px;
5268: border-collapse: collapse;
5269: }
5270:
5271: table.LC_docs_documents td.LC_docs_document {
5272: border: 2px solid black;
5273: padding: 4px;
5274: }
5275:
5276: .LC_docs_course_commands div {
5277: float: left;
5278: border: 4px solid #AAAAAA;
5279: padding: 4px;
5280: background: #DDDDCC;
5281: }
5282:
5283: .LC_docs_entry_move {
5284: border: 0px;
5285: border-collapse: collapse;
5286: }
5287:
5288: .LC_docs_entry_move td {
5289: border: 2px solid #BBBBBB;
5290: background: #DDDDDD;
5291: }
5292:
5293: .LC_docs_editor td.LC_docs_entry_commands {
5294: background: #DDDDDD;
5295: font-size: x-small;
5296: }
5297: .LC_docs_copy {
5298: color: #000099;
5299: }
5300: .LC_docs_cut {
5301: color: #550044;
5302: }
5303: .LC_docs_rename {
5304: color: #009900;
5305: }
5306: .LC_docs_remove {
5307: color: #990000;
5308: }
5309:
5310: .LC_docs_reinit_warn,
5311: .LC_docs_ext_edit {
5312: font-size: x-small;
5313: }
5314:
5315: .LC_docs_editor td.LC_docs_entry_title,
5316: .LC_docs_editor td.LC_docs_entry_icon {
5317: background: #FFFFBB;
5318: }
5319: .LC_docs_editor td.LC_docs_entry_parameter {
5320: background: #BBBBFF;
5321: font-size: x-small;
5322: white-space: nowrap;
5323: }
5324:
5325: table.LC_docs_adddocs td,
5326: table.LC_docs_adddocs th {
5327: border: 1px solid #BBBBBB;
5328: padding: 4px;
5329: background: #DDDDDD;
5330: }
5331:
5332: table.LC_sty_begin {
5333: background: #BBFFBB;
5334: }
5335: table.LC_sty_end {
5336: background: #FFBBBB;
5337: }
5338:
5339: table.LC_double_column {
5340: border-width: 0px;
5341: border-collapse: collapse;
5342: width: 100%;
5343: padding: 2px;
5344: }
5345:
5346: table.LC_double_column tr td.LC_left_col {
5347: top: 2px;
5348: left: 2px;
5349: width: 47%;
5350: vertical-align: top;
5351: }
5352:
5353: table.LC_double_column tr td.LC_right_col {
5354: top: 2px;
5355: right: 2px;
5356: width: 47%;
5357: vertical-align: top;
5358: }
5359:
5360: span.LC_role_level {
5361: font-weight: bold;
5362: }
5363:
5364: div.LC_left_float {
5365: float: left;
5366: padding-right: 5%;
5367: padding-bottom: 4px;
5368: }
5369:
5370: div.LC_clear_float_header {
5371: padding-bottom: 2px;
5372: }
5373:
5374: div.LC_clear_float_footer {
5375: padding-top: 10px;
5376: clear: both;
5377: }
5378:
5379:
5380: div.LC_grade_select_mode {
5381: font-family: $sans;
5382: }
5383: div.LC_grade_select_mode div div {
5384: margin: 5px;
5385: }
5386: div.LC_grade_select_mode_selector {
5387: margin: 5px;
5388: float: left;
5389: }
5390: div.LC_grade_select_mode_selector_header {
5391: font: bold medium $sans;
5392: }
5393: div.LC_grade_select_mode_type {
5394: clear: left;
5395: }
5396:
5397: div.LC_grade_show_user {
5398: margin-top: 20px;
5399: border: 1px solid black;
5400: }
5401: div.LC_grade_user_name {
5402: background: #DDDDEE;
5403: border-bottom: 1px solid black;
5404: font: bold large $sans;
5405: }
5406: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5407: background: #DDEEDD;
5408: }
5409:
5410: div.LC_grade_show_problem,
5411: div.LC_grade_submissions,
5412: div.LC_grade_message_center,
5413: div.LC_grade_info_links,
5414: div.LC_grade_assign {
5415: margin: 5px;
5416: width: 99%;
5417: background: #FFFFFF;
5418: }
5419: div.LC_grade_show_problem_header,
5420: div.LC_grade_submissions_header,
5421: div.LC_grade_message_center_header,
5422: div.LC_grade_assign_header {
5423: font: bold large $sans;
5424: }
5425: div.LC_grade_show_problem_problem,
5426: div.LC_grade_submissions_body,
5427: div.LC_grade_message_center_body,
5428: div.LC_grade_assign_body {
5429: border: 1px solid black;
5430: width: 99%;
5431: background: #FFFFFF;
5432: }
5433: span.LC_grade_check_note {
5434: font: normal medium $sans;
5435: display: inline;
5436: position: absolute;
5437: right: 1em;
5438: }
5439:
5440: table.LC_scantron_action {
5441: width: 100%;
5442: }
5443: table.LC_scantron_action tr th {
5444: font: normal bold $sans;
5445: }
5446:
5447: div.LC_edit_problem_header,
5448: div.LC_edit_problem_footer {
5449: font: normal medium $sans;
5450: margin: 2px;
5451: }
5452: div.LC_edit_problem_header,
5453: div.LC_edit_problem_header div,
5454: div.LC_edit_problem_footer,
5455: div.LC_edit_problem_footer div,
5456: div.LC_edit_problem_editxml_header,
5457: div.LC_edit_problem_editxml_header div {
5458: margin-top: 5px;
5459: }
5460: div.LC_edit_problem_header_edit_row {
5461: background: $tabbg;
5462: padding: 3px;
5463: margin-bottom: 5px;
5464: }
5465: div.LC_edit_problem_header_title {
5466: font: larger bold $sans;
5467: background: $tabbg;
5468: padding: 3px;
5469: }
5470: table.LC_edit_problem_header_title {
5471: font: larger bold $sans;
5472: width: 100%;
5473: border-color: $pgbg;
5474: border-style: solid;
5475: border-width: $border;
5476:
5477: background: $tabbg;
5478: border-collapse: collapse;
5479: padding: 0px
5480: }
5481:
5482: div.LC_edit_problem_discards {
5483: float: left;
5484: padding-bottom: 5px;
5485: }
5486: div.LC_edit_problem_saves {
5487: float: right;
5488: padding-bottom: 5px;
5489: }
5490: hr.LC_edit_problem_divide {
5491: clear: both;
5492: color: $tabbg;
5493: background-color: $tabbg;
5494: height: 3px;
5495: border: 0px;
5496: }
5497: img.stift{
5498: border-width:0;
5499: vertical-align:middle;
5500: }
5501:
5502: table#LC_mainmenu{
5503: margin-top:10px;
5504: width:80%;
5505:
5506: }
5507:
5508: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5509: vertical-align: top;
5510: width: 45%;
5511: }
5512: .LC_mainmenu_fieldset_category {
5513: color: $font;
5514: background: $pgbg;
5515: font-family: $sans;
5516: font-size: small;
5517: font-weight: bold;
5518: }
5519: fieldset#LC_mainmenu_fieldset {
5520: margin:0px 10px 10px 0px;
5521:
5522: }
5523: END
5524: }
5525:
5526: =pod
5527:
5528: =item * &headtag()
5529:
5530: Returns a uniform footer for LON-CAPA web pages.
5531:
5532: Inputs: $title - optional title for the head
5533: $head_extra - optional extra HTML to put inside the <head>
5534: $args - optional arguments
5535: force_register - if is true call registerurl so the remote is
5536: informed
5537: redirect -> array ref of
5538: 1- seconds before redirect occurs
5539: 2- url to redirect to
5540: 3- whether the side effect should occur
5541: (side effect of setting
5542: $env{'internal.head.redirect'} to the url
5543: redirected too)
5544: domain -> force to color decorate a page for a specific
5545: domain
5546: function -> force usage of a specific rolish color scheme
5547: bgcolor -> override the default page bgcolor
5548: no_auto_mt_title
5549: -> prevent &mt()ing the title arg
5550:
5551: =cut
5552:
5553: sub headtag {
5554: my ($title,$head_extra,$args) = @_;
5555:
5556: my $function = $args->{'function'} || &get_users_function();
5557: my $domain = $args->{'domain'} || &determinedomain();
5558: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
5559: my $url = join(':',$env{'user.name'},$env{'user.domain'},
5560: $Apache::lonnet::perlvar{'lonVersion'},
5561: #time(),
5562: $env{'environment.color.timestamp'},
5563: $function,$domain,$bgcolor);
5564:
5565: $url = '/adm/css/'.&escape($url).'.css';
5566:
5567: my $result =
5568: '<head>'.
5569: &font_settings();
5570:
5571: if (!$args->{'frameset'}) {
5572: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5573: }
5574: if ($args->{'force_register'}) {
5575: $result .= &Apache::lonmenu::registerurl(1);
5576: }
5577: if (!$args->{'no_nav_bar'}
5578: && !$args->{'only_body'}
5579: && !$args->{'frameset'}) {
5580: $result .= &help_menu_js();
5581: }
5582:
5583: if (ref($args->{'redirect'})) {
5584: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
5585: $url = &Apache::lonenc::check_encrypt($url);
5586: if (!$inhibit_continue) {
5587: $env{'internal.head.redirect'} = $url;
5588: }
5589: $result.=<<ADDMETA
5590: <meta http-equiv="pragma" content="no-cache" />
5591: <meta http-equiv="Refresh" content="$time; url=$url" />
5592: ADDMETA
5593: }
5594: if (!defined($title)) {
5595: $title = 'The LearningOnline Network with CAPA';
5596: }
5597: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5598: $result .= '<title> LON-CAPA '.$title.'</title>'
5599: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5600: .$head_extra;
5601: return $result;
5602: }
5603:
5604: =pod
5605:
5606: =item * &font_settings()
5607:
5608: Returns neccessary <meta> to set the proper encoding
5609:
5610: Inputs: none
5611:
5612: =cut
5613:
5614: sub font_settings {
5615: my $headerstring='';
5616: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
5617: $headerstring.=
5618: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5619: }
5620: return $headerstring;
5621: }
5622:
5623: =pod
5624:
5625: =item * &xml_begin()
5626:
5627: Returns the needed doctype and <html>
5628:
5629: Inputs: none
5630:
5631: =cut
5632:
5633: sub xml_begin {
5634: my $output='';
5635:
5636: if ($env{'internal.start_page'}==1) {
5637: &Apache::lonhtmlcommon::init_htmlareafields();
5638: }
5639:
5640: if ($env{'browser.mathml'}) {
5641: $output='<?xml version="1.0"?>'
5642: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5643: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5644:
5645: # .'<!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">] >'
5646: .'<!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">'
5647: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5648: .'xmlns="http://www.w3.org/1999/xhtml">';
5649: } else {
5650: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5651: }
5652: return $output;
5653: }
5654:
5655: =pod
5656:
5657: =item * &endheadtag()
5658:
5659: Returns a uniform </head> for LON-CAPA web pages.
5660:
5661: Inputs: none
5662:
5663: =cut
5664:
5665: sub endheadtag {
5666: return '</head>';
5667: }
5668:
5669: =pod
5670:
5671: =item * &head()
5672:
5673: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5674:
5675: Inputs:
5676:
5677: =over 4
5678:
5679: $title - optional title for the page
5680:
5681: $head_extra - optional extra HTML to put inside the <head>
5682:
5683: =back
5684:
5685: =cut
5686:
5687: sub head {
5688: my ($title,$head_extra,$args) = @_;
5689: return &headtag($title,$head_extra,$args).&endheadtag();
5690: }
5691:
5692: =pod
5693:
5694: =item * &start_page()
5695:
5696: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5697:
5698: Inputs:
5699:
5700: =over 4
5701:
5702: $title - optional title for the page
5703:
5704: $head_extra - optional extra HTML to incude inside the <head>
5705:
5706: $args - additional optional args supported are:
5707:
5708: =over 8
5709:
5710: only_body -> is true will set &bodytag() onlybodytag
5711: arg on
5712: no_nav_bar -> is true will set &bodytag() notopbar arg on
5713: add_entries -> additional attributes to add to the <body>
5714: domain -> force to color decorate a page for a
5715: specific domain
5716: function -> force usage of a specific rolish color
5717: scheme
5718: redirect -> see &headtag()
5719: bgcolor -> override the default page bg color
5720: js_ready -> return a string ready for being used in
5721: a javascript writeln
5722: html_encode -> return a string ready for being used in
5723: a html attribute
5724: force_register -> if is true will turn on the &bodytag()
5725: $forcereg arg
5726: body_title -> alternate text to use instead of $title
5727: in the title box that appears, this text
5728: is not auto translated like the $title is
5729: frameset -> if true will start with a <frameset>
5730: rather than <body>
5731: no_title -> if true the title bar won't be shown
5732: skip_phases -> hash ref of
5733: head -> skip the <html><head> generation
5734: body -> skip all <body> generation
5735: no_inline_link -> if true and in remote mode, don't show the
5736: 'Switch To Inline Menu' link
5737: no_auto_mt_title -> prevent &mt()ing the title arg
5738: inherit_jsmath -> when creating popup window in a page,
5739: should it have jsmath forced on by the
5740: current page
5741:
5742: =back
5743:
5744: =back
5745:
5746: =cut
5747:
5748: sub start_page {
5749: my ($title,$head_extra,$args) = @_;
5750: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
5751: my %head_args;
5752: foreach my $arg ('redirect','force_register','domain','function',
5753: 'bgcolor','frameset','no_nav_bar','only_body',
5754: 'no_auto_mt_title') {
5755: if (defined($args->{$arg})) {
5756: $head_args{$arg} = $args->{$arg};
5757: }
5758: }
5759:
5760: $env{'internal.start_page'}++;
5761: my $result;
5762: if (! exists($args->{'skip_phases'}{'head'}) ) {
5763: $result.=
5764: &xml_begin().
5765: &headtag($title,$head_extra,\%head_args).&endheadtag();
5766: }
5767:
5768: if (! exists($args->{'skip_phases'}{'body'}) ) {
5769: if ($args->{'frameset'}) {
5770: my $attr_string = &make_attr_string($args->{'force_register'},
5771: $args->{'add_entries'});
5772: $result .= "\n<frameset $attr_string>\n";
5773: } else {
5774: $result .=
5775: &bodytag($title,
5776: $args->{'function'}, $args->{'add_entries'},
5777: $args->{'only_body'}, $args->{'domain'},
5778: $args->{'force_register'}, $args->{'body_title'},
5779: $args->{'no_nav_bar'}, $args->{'bgcolor'},
5780: $args->{'no_title'}, $args->{'no_inline_link'},
5781: $args);
5782: }
5783: }
5784:
5785: if ($args->{'js_ready'}) {
5786: $result = &js_ready($result);
5787: }
5788: if ($args->{'html_encode'}) {
5789: $result = &html_encode($result);
5790: }
5791: return $result;
5792: }
5793:
5794:
5795: =pod
5796:
5797: =item * &head()
5798:
5799: Returns a complete </body></html> section for LON-CAPA web pages.
5800:
5801: Inputs: $args - additional optional args supported are:
5802: js_ready -> return a string ready for being used in
5803: a javascript writeln
5804: html_encode -> return a string ready for being used in
5805: a html attribute
5806: frameset -> if true will start with a <frameset>
5807: rather than <body>
5808: dicsussion -> if true will get discussion from
5809: lonxml::xmlend
5810: (you can pass the target and parser arguments
5811: through optional 'target' and 'parser' args
5812: to this routine)
5813:
5814: =cut
5815:
5816: sub end_page {
5817: my ($args) = @_;
5818: $env{'internal.end_page'}++;
5819: my $result;
5820: if ($args->{'discussion'}) {
5821: my ($target,$parser);
5822: if (ref($args->{'discussion'})) {
5823: ($target,$parser) =($args->{'discussion'}{'target'},
5824: $args->{'discussion'}{'parser'});
5825: }
5826: $result .= &Apache::lonxml::xmlend($target,$parser);
5827: }
5828:
5829: if ($args->{'frameset'}) {
5830: $result .= '</frameset>';
5831: } else {
5832: $result .= &endbodytag($args);
5833: }
5834: $result .= "\n</html>";
5835:
5836: if ($args->{'js_ready'}) {
5837: $result = &js_ready($result);
5838: }
5839:
5840: if ($args->{'html_encode'}) {
5841: $result = &html_encode($result);
5842: }
5843:
5844: return $result;
5845: }
5846:
5847: sub html_encode {
5848: my ($result) = @_;
5849:
5850: $result = &HTML::Entities::encode($result,'<>&"');
5851:
5852: return $result;
5853: }
5854: sub js_ready {
5855: my ($result) = @_;
5856:
5857: $result =~ s/[\n\r]/ /xmsg;
5858: $result =~ s/\\/\\\\/xmsg;
5859: $result =~ s/'/\\'/xmsg;
5860: $result =~ s{</}{<\\/}xmsg;
5861:
5862: return $result;
5863: }
5864:
5865: sub validate_page {
5866: if ( exists($env{'internal.start_page'})
5867: && $env{'internal.start_page'} > 1) {
5868: &Apache::lonnet::logthis('start_page called multiple times '.
5869: $env{'internal.start_page'}.' '.
5870: $ENV{'request.filename'});
5871: }
5872: if ( exists($env{'internal.end_page'})
5873: && $env{'internal.end_page'} > 1) {
5874: &Apache::lonnet::logthis('end_page called multiple times '.
5875: $env{'internal.end_page'}.' '.
5876: $env{'request.filename'});
5877: }
5878: if ( exists($env{'internal.start_page'})
5879: && ! exists($env{'internal.end_page'})) {
5880: &Apache::lonnet::logthis('start_page called without end_page '.
5881: $env{'request.filename'});
5882: }
5883: if ( ! exists($env{'internal.start_page'})
5884: && exists($env{'internal.end_page'})) {
5885: &Apache::lonnet::logthis('end_page called without start_page'.
5886: $env{'request.filename'});
5887: }
5888: }
5889:
5890: sub simple_error_page {
5891: my ($r,$title,$msg) = @_;
5892: my $page =
5893: &Apache::loncommon::start_page($title).
5894: &mt($msg).
5895: &Apache::loncommon::end_page();
5896: if (ref($r)) {
5897: $r->print($page);
5898: return;
5899: }
5900: return $page;
5901: }
5902:
5903: {
5904: my @row_count;
5905: sub start_data_table {
5906: my ($add_class) = @_;
5907: my $css_class = (join(' ','LC_data_table',$add_class));
5908: unshift(@row_count,0);
5909: return '<table class="'.$css_class.'">'."\n";
5910: }
5911:
5912: sub end_data_table {
5913: shift(@row_count);
5914: return '</table>'."\n";;
5915: }
5916:
5917: sub start_data_table_row {
5918: my ($add_class) = @_;
5919: $row_count[0]++;
5920: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
5921: $css_class = (join(' ',$css_class,$add_class));
5922: return '<tr class="'.$css_class.'">'."\n";;
5923: }
5924:
5925: sub continue_data_table_row {
5926: my ($add_class) = @_;
5927: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
5928: $css_class = (join(' ',$css_class,$add_class));
5929: return '<tr class="'.$css_class.'">'."\n";;
5930: }
5931:
5932: sub end_data_table_row {
5933: return '</tr>'."\n";;
5934: }
5935:
5936: sub start_data_table_empty_row {
5937: $row_count[0]++;
5938: return '<tr class="LC_empty_row" >'."\n";;
5939: }
5940:
5941: sub end_data_table_empty_row {
5942: return '</tr>'."\n";;
5943: }
5944:
5945: sub start_data_table_header_row {
5946: return '<tr class="LC_header_row">'."\n";;
5947: }
5948:
5949: sub end_data_table_header_row {
5950: return '</tr>'."\n";;
5951: }
5952: }
5953:
5954: =pod
5955:
5956: =item * &inhibit_menu_check($arg)
5957:
5958: Checks for a inhibitmenu state and generates output to preserve it
5959:
5960: Inputs: $arg - can be any of
5961: - undef - in which case the return value is a string
5962: to add into arguments list of a uri
5963: - 'input' - in which case the return value is a HTML
5964: <form> <input> field of type hidden to
5965: preserve the value
5966: - a url - in which case the return value is the url with
5967: the neccesary cgi args added to preserve the
5968: inhibitmenu state
5969: - a ref to a url - no return value, but the string is
5970: updated to include the neccessary cgi
5971: args to preserve the inhibitmenu state
5972:
5973: =cut
5974:
5975: sub inhibit_menu_check {
5976: my ($arg) = @_;
5977: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5978: if ($arg eq 'input') {
5979: if ($env{'form.inhibitmenu'}) {
5980: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5981: } else {
5982: return
5983: }
5984: }
5985: if ($env{'form.inhibitmenu'}) {
5986: if (ref($arg)) {
5987: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5988: } elsif ($arg eq '') {
5989: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5990: } else {
5991: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5992: }
5993: }
5994: if (!ref($arg)) {
5995: return $arg;
5996: }
5997: }
5998:
5999: ###############################################
6000:
6001: =pod
6002:
6003: =back
6004:
6005: =head1 User Information Routines
6006:
6007: =over 4
6008:
6009: =item * &get_users_function()
6010:
6011: Used by &bodytag to determine the current users primary role.
6012: Returns either 'student','coordinator','admin', or 'author'.
6013:
6014: =cut
6015:
6016: ###############################################
6017: sub get_users_function {
6018: my $function = 'student';
6019: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
6020: $function='coordinator';
6021: }
6022: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
6023: $function='admin';
6024: }
6025: if (($env{'request.role'}=~/^(au|ca)/) ||
6026: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6027: $function='author';
6028: }
6029: return $function;
6030: }
6031:
6032: ###############################################
6033:
6034: =pod
6035:
6036: =item * &check_user_status()
6037:
6038: Determines current status of supplied role for a
6039: specific user. Roles can be active, previous or future.
6040:
6041: Inputs:
6042: user's domain, user's username, course's domain,
6043: course's number, optional section ID.
6044:
6045: Outputs:
6046: role status: active, previous or future.
6047:
6048: =cut
6049:
6050: sub check_user_status {
6051: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
6052: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6053: my @uroles = keys %userinfo;
6054: my $srchstr;
6055: my $active_chk = 'none';
6056: my $now = time;
6057: if (@uroles > 0) {
6058: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
6059: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6060: } else {
6061: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6062: }
6063: if (grep/^\Q$srchstr\E$/,@uroles) {
6064: my $role_end = 0;
6065: my $role_start = 0;
6066: $active_chk = 'active';
6067: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6068: $role_end = $1;
6069: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6070: $role_start = $1;
6071: }
6072: }
6073: if ($role_start > 0) {
6074: if ($now < $role_start) {
6075: $active_chk = 'future';
6076: }
6077: }
6078: if ($role_end > 0) {
6079: if ($now > $role_end) {
6080: $active_chk = 'previous';
6081: }
6082: }
6083: }
6084: }
6085: return $active_chk;
6086: }
6087:
6088: ###############################################
6089:
6090: =pod
6091:
6092: =item * &get_sections()
6093:
6094: Determines all the sections for a course including
6095: sections with students and sections containing other roles.
6096: Incoming parameters:
6097:
6098: 1. domain
6099: 2. course number
6100: 3. reference to array containing roles for which sections should
6101: be gathered (optional).
6102: 4. reference to array containing status types for which sections
6103: should be gathered (optional).
6104:
6105: If the third argument is undefined, sections are gathered for any role.
6106: If the fourth argument is undefined, sections are gathered for any status.
6107: Permissible values are 'active' or 'future' or 'previous'.
6108:
6109: Returns section hash (keys are section IDs, values are
6110: number of users in each section), subject to the
6111: optional roles filter, optional status filter
6112:
6113: =cut
6114:
6115: ###############################################
6116: sub get_sections {
6117: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
6118: if (!defined($cdom) || !defined($cnum)) {
6119: my $cid = $env{'request.course.id'};
6120:
6121: return if (!defined($cid));
6122:
6123: $cdom = $env{'course.'.$cid.'.domain'};
6124: $cnum = $env{'course.'.$cid.'.num'};
6125: }
6126:
6127: my %sectioncount;
6128: my $now = time;
6129:
6130: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
6131: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
6132: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6133: my $status_index = &Apache::loncoursedata::CL_STATUS();
6134: my $start_index = &Apache::loncoursedata::CL_START();
6135: my $end_index = &Apache::loncoursedata::CL_END();
6136: my $status;
6137: while (my ($student,$data) = each(%$classlist)) {
6138: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6139: $data->[$status_index],
6140: $data->[$start_index],
6141: $data->[$end_index]);
6142: if ($stu_status eq 'Active') {
6143: $status = 'active';
6144: } elsif ($end < $now) {
6145: $status = 'previous';
6146: } elsif ($start > $now) {
6147: $status = 'future';
6148: }
6149: if ($section ne '-1' && $section !~ /^\s*$/) {
6150: if ((!defined($possible_status)) || (($status ne '') &&
6151: (grep/^\Q$status\E$/,@{$possible_status}))) {
6152: $sectioncount{$section}++;
6153: }
6154: }
6155: }
6156: }
6157: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6158: foreach my $user (sort(keys(%courseroles))) {
6159: if ($user !~ /^(\w{2})/) { next; }
6160: my ($role) = ($user =~ /^(\w{2})/);
6161: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
6162: my ($section,$status);
6163: if ($role eq 'cr' &&
6164: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6165: $section=$1;
6166: }
6167: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6168: if (!defined($section) || $section eq '-1') { next; }
6169: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6170: if ($end == -1 && $start == -1) {
6171: next; #deleted role
6172: }
6173: if (!defined($possible_status)) {
6174: $sectioncount{$section}++;
6175: } else {
6176: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6177: $status = 'active';
6178: } elsif ($end < $now) {
6179: $status = 'future';
6180: } elsif ($start > $now) {
6181: $status = 'previous';
6182: }
6183: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6184: $sectioncount{$section}++;
6185: }
6186: }
6187: }
6188: return %sectioncount;
6189: }
6190:
6191: ###############################################
6192:
6193: =pod
6194:
6195: =item * &get_course_users()
6196:
6197: Retrieves usernames:domains for users in the specified course
6198: with specific role(s), and access status.
6199:
6200: Incoming parameters:
6201: 1. course domain
6202: 2. course number
6203: 3. access status: users must have - either active,
6204: previous, future, or all.
6205: 4. reference to array of permissible roles
6206: 5. reference to array of section restrictions (optional)
6207: 6. reference to results object (hash of hashes).
6208: 7. reference to optional userdata hash
6209: 8. reference to optional statushash
6210: 9. flag if privileged users (except those set to unhide in
6211: course settings) should be excluded
6212: Keys of top level results hash are roles.
6213: Keys of inner hashes are username:domain, with
6214: values set to access type.
6215: Optional userdata hash returns an array with arguments in the
6216: same order as loncoursedata::get_classlist() for student data.
6217:
6218: Optional statushash returns
6219:
6220: Entries for end, start, section and status are blank because
6221: of the possibility of multiple values for non-student roles.
6222:
6223: =cut
6224:
6225: ###############################################
6226:
6227: sub get_course_users {
6228: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
6229: my %idx = ();
6230: my %seclists;
6231:
6232: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6233: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6234: $idx{end} = &Apache::loncoursedata::CL_END();
6235: $idx{start} = &Apache::loncoursedata::CL_START();
6236: $idx{id} = &Apache::loncoursedata::CL_ID();
6237: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6238: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6239: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6240:
6241: if (grep(/^st$/,@{$roles})) {
6242: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
6243: my $now = time;
6244: foreach my $student (keys(%{$classlist})) {
6245: my $match = 0;
6246: my $secmatch = 0;
6247: my $section = $$classlist{$student}[$idx{section}];
6248: my $status = $$classlist{$student}[$idx{status}];
6249: if ($section eq '') {
6250: $section = 'none';
6251: }
6252: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
6253: if (grep(/^all$/,@{$sections})) {
6254: $secmatch = 1;
6255: } elsif ($$classlist{$student}[$idx{section}] eq '') {
6256: if (grep(/^none$/,@{$sections})) {
6257: $secmatch = 1;
6258: }
6259: } else {
6260: if (grep(/^\Q$section\E$/,@{$sections})) {
6261: $secmatch = 1;
6262: }
6263: }
6264: if (!$secmatch) {
6265: next;
6266: }
6267: }
6268: if (defined($$types{'active'})) {
6269: if ($$classlist{$student}[$idx{status}] eq 'Active') {
6270: push(@{$$users{st}{$student}},'active');
6271: $match = 1;
6272: }
6273: }
6274: if (defined($$types{'previous'})) {
6275: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
6276: push(@{$$users{st}{$student}},'previous');
6277: $match = 1;
6278: }
6279: }
6280: if (defined($$types{'future'})) {
6281: if ($$classlist{$student}[$idx{status}] eq 'Future') {
6282: push(@{$$users{st}{$student}},'future');
6283: $match = 1;
6284: }
6285: }
6286: if ($match) {
6287: push(@{$seclists{$student}},$section);
6288: if (ref($userdata) eq 'HASH') {
6289: $$userdata{$student} = $$classlist{$student};
6290: }
6291: if (ref($statushash) eq 'HASH') {
6292: $statushash->{$student}{'st'}{$section} = $status;
6293: }
6294: }
6295: }
6296: }
6297: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
6298: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6299: my $now = time;
6300: my %displaystatus = ( previous => 'Expired',
6301: active => 'Active',
6302: future => 'Future',
6303: );
6304: my %nothide;
6305: if ($hidepriv) {
6306: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6307: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6308: if ($user !~ /:/) {
6309: $nothide{join(':',split(/[\@]/,$user))}=1;
6310: } else {
6311: $nothide{$user} = 1;
6312: }
6313: }
6314: }
6315: foreach my $person (sort(keys(%coursepersonnel))) {
6316: my $match = 0;
6317: my $secmatch = 0;
6318: my $status;
6319: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
6320: $user =~ s/:$//;
6321: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6322: if ($end == -1 || $start == -1) {
6323: next;
6324: }
6325: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6326: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
6327: my ($uname,$udom) = split(/:/,$user);
6328: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
6329: if (grep(/^all$/,@{$sections})) {
6330: $secmatch = 1;
6331: } elsif ($usec eq '') {
6332: if (grep(/^none$/,@{$sections})) {
6333: $secmatch = 1;
6334: }
6335: } else {
6336: if (grep(/^\Q$usec\E$/,@{$sections})) {
6337: $secmatch = 1;
6338: }
6339: }
6340: if (!$secmatch) {
6341: next;
6342: }
6343: }
6344: if ($usec eq '') {
6345: $usec = 'none';
6346: }
6347: if ($uname ne '' && $udom ne '') {
6348: if ($hidepriv) {
6349: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6350: (!$nothide{$uname.':'.$udom})) {
6351: next;
6352: }
6353: }
6354: if ($end > 0 && $end < $now) {
6355: $status = 'previous';
6356: } elsif ($start > $now) {
6357: $status = 'future';
6358: } else {
6359: $status = 'active';
6360: }
6361: foreach my $type (keys(%{$types})) {
6362: if ($status eq $type) {
6363: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
6364: push(@{$$users{$role}{$user}},$type);
6365: }
6366: $match = 1;
6367: }
6368: }
6369: if (($match) && (ref($userdata) eq 'HASH')) {
6370: if (!exists($$userdata{$uname.':'.$udom})) {
6371: &get_user_info($udom,$uname,\%idx,$userdata);
6372: }
6373: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
6374: push(@{$seclists{$uname.':'.$udom}},$usec);
6375: }
6376: if (ref($statushash) eq 'HASH') {
6377: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6378: }
6379: }
6380: }
6381: }
6382: }
6383: if (grep(/^ow$/,@{$roles})) {
6384: if ((defined($cdom)) && (defined($cnum))) {
6385: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6386: if ( defined($csettings{'internal.courseowner'}) ) {
6387: my $owner = $csettings{'internal.courseowner'};
6388: next if ($owner eq '');
6389: my ($ownername,$ownerdom);
6390: if ($owner =~ /^([^:]+):([^:]+)$/) {
6391: $ownername = $1;
6392: $ownerdom = $2;
6393: } else {
6394: $ownername = $owner;
6395: $ownerdom = $cdom;
6396: $owner = $ownername.':'.$ownerdom;
6397: }
6398: @{$$users{'ow'}{$owner}} = 'any';
6399: if (defined($userdata) &&
6400: !exists($$userdata{$owner})) {
6401: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6402: if (!grep(/^none$/,@{$seclists{$owner}})) {
6403: push(@{$seclists{$owner}},'none');
6404: }
6405: if (ref($statushash) eq 'HASH') {
6406: $statushash->{$owner}{'ow'}{'none'} = 'Any';
6407: }
6408: }
6409: }
6410: }
6411: }
6412: foreach my $user (keys(%seclists)) {
6413: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6414: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6415: }
6416: }
6417: return;
6418: }
6419:
6420: sub get_user_info {
6421: my ($udom,$uname,$idx,$userdata) = @_;
6422: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6423: &plainname($uname,$udom,'lastname');
6424: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
6425: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
6426: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6427: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
6428: return;
6429: }
6430:
6431: ###############################################
6432:
6433: =pod
6434:
6435: =item * &get_user_quota()
6436:
6437: Retrieves quota assigned for storage of portfolio files for a user
6438:
6439: Incoming parameters:
6440: 1. user's username
6441: 2. user's domain
6442:
6443: Returns:
6444: 1. Disk quota (in Mb) assigned to student.
6445: 2. (Optional) Type of setting: custom or default
6446: (individually assigned or default for user's
6447: institutional status).
6448: 3. (Optional) - User's institutional status (e.g., faculty, staff
6449: or student - types as defined in localenroll::inst_usertypes
6450: for user's domain, which determines default quota for user.
6451: 4. (Optional) - Default quota which would apply to the user.
6452:
6453: If a value has been stored in the user's environment,
6454: it will return that, otherwise it returns the maximal default
6455: defined for the user's instituional status(es) in the domain.
6456:
6457: =cut
6458:
6459: ###############################################
6460:
6461:
6462: sub get_user_quota {
6463: my ($uname,$udom) = @_;
6464: my ($quota,$quotatype,$settingstatus,$defquota);
6465: if (!defined($udom)) {
6466: $udom = $env{'user.domain'};
6467: }
6468: if (!defined($uname)) {
6469: $uname = $env{'user.name'};
6470: }
6471: if (($udom eq '' || $uname eq '') ||
6472: ($udom eq 'public') && ($uname eq 'public')) {
6473: $quota = 0;
6474: $quotatype = 'default';
6475: $defquota = 0;
6476: } else {
6477: my $inststatus;
6478: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6479: $quota = $env{'environment.portfolioquota'};
6480: $inststatus = $env{'environment.inststatus'};
6481: } else {
6482: my %userenv =
6483: &Apache::lonnet::get('environment',['portfolioquota',
6484: 'inststatus'],$udom,$uname);
6485: my ($tmp) = keys(%userenv);
6486: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6487: $quota = $userenv{'portfolioquota'};
6488: $inststatus = $userenv{'inststatus'};
6489: } else {
6490: undef(%userenv);
6491: }
6492: }
6493: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
6494: if ($quota eq '') {
6495: $quota = $defquota;
6496: $quotatype = 'default';
6497: } else {
6498: $quotatype = 'custom';
6499: }
6500: }
6501: if (wantarray) {
6502: return ($quota,$quotatype,$settingstatus,$defquota);
6503: } else {
6504: return $quota;
6505: }
6506: }
6507:
6508: ###############################################
6509:
6510: =pod
6511:
6512: =item * &default_quota()
6513:
6514: Retrieves default quota assigned for storage of user portfolio files,
6515: given an (optional) user's institutional status.
6516:
6517: Incoming parameters:
6518: 1. domain
6519: 2. (Optional) institutional status(es). This is a : separated list of
6520: status types (e.g., faculty, staff, student etc.)
6521: which apply to the user for whom the default is being retrieved.
6522: If the institutional status string in undefined, the domain
6523: default quota will be returned.
6524:
6525: Returns:
6526: 1. Default disk quota (in Mb) for user portfolios in the domain.
6527: 2. (Optional) institutional type which determined the value of the
6528: default quota.
6529:
6530: If a value has been stored in the domain's configuration db,
6531: it will return that, otherwise it returns 20 (for backwards
6532: compatibility with domains which have not set up a configuration
6533: db file; the original statically defined portfolio quota was 20 Mb).
6534:
6535: If the user's status includes multiple types (e.g., staff and student),
6536: the largest default quota which applies to the user determines the
6537: default quota returned.
6538:
6539: =cut
6540:
6541: ###############################################
6542:
6543:
6544: sub default_quota {
6545: my ($udom,$inststatus) = @_;
6546: my ($defquota,$settingstatus);
6547: my %quotahash = &Apache::lonnet::get_dom('configuration',
6548: ['quotas'],$udom);
6549: if (ref($quotahash{'quotas'}) eq 'HASH') {
6550: if ($inststatus ne '') {
6551: my @statuses = split(/:/,$inststatus);
6552: foreach my $item (@statuses) {
6553: if ($quotahash{'quotas'}{$item} ne '') {
6554: if ($defquota eq '') {
6555: $defquota = $quotahash{'quotas'}{$item};
6556: $settingstatus = $item;
6557: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6558: $defquota = $quotahash{'quotas'}{$item};
6559: $settingstatus = $item;
6560: }
6561: }
6562: }
6563: }
6564: if ($defquota eq '') {
6565: $defquota = $quotahash{'quotas'}{'default'};
6566: $settingstatus = 'default';
6567: }
6568: } else {
6569: $settingstatus = 'default';
6570: $defquota = 20;
6571: }
6572: if (wantarray) {
6573: return ($defquota,$settingstatus);
6574: } else {
6575: return $defquota;
6576: }
6577: }
6578:
6579: sub get_secgrprole_info {
6580: my ($cdom,$cnum,$needroles,$type) = @_;
6581: my %sections_count = &get_sections($cdom,$cnum);
6582: my @sections = (sort {$a <=> $b} keys(%sections_count));
6583: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6584: my @groups = sort(keys(%curr_groups));
6585: my $allroles = [];
6586: my $rolehash;
6587: my $accesshash = {
6588: active => 'Currently has access',
6589: future => 'Will have future access',
6590: previous => 'Previously had access',
6591: };
6592: if ($needroles) {
6593: $rolehash = {'all' => 'all'};
6594: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6595: if (&Apache::lonnet::error(%user_roles)) {
6596: undef(%user_roles);
6597: }
6598: foreach my $item (keys(%user_roles)) {
6599: my ($role)=split(/\:/,$item,2);
6600: if ($role eq 'cr') { next; }
6601: if ($role =~ /^cr/) {
6602: $$rolehash{$role} = (split('/',$role))[3];
6603: } else {
6604: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6605: }
6606: }
6607: foreach my $key (sort(keys(%{$rolehash}))) {
6608: push(@{$allroles},$key);
6609: }
6610: push (@{$allroles},'st');
6611: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6612: }
6613: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6614: }
6615:
6616: sub user_picker {
6617: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
6618: my $currdom = $dom;
6619: my %curr_selected = (
6620: srchin => 'dom',
6621: srchby => 'lastname',
6622: );
6623: my $srchterm;
6624: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
6625: if ($srch->{'srchby'} ne '') {
6626: $curr_selected{'srchby'} = $srch->{'srchby'};
6627: }
6628: if ($srch->{'srchin'} ne '') {
6629: $curr_selected{'srchin'} = $srch->{'srchin'};
6630: }
6631: if ($srch->{'srchtype'} ne '') {
6632: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6633: }
6634: if ($srch->{'srchdomain'} ne '') {
6635: $currdom = $srch->{'srchdomain'};
6636: }
6637: $srchterm = $srch->{'srchterm'};
6638: }
6639: my %lt=&Apache::lonlocal::texthash(
6640: 'usr' => 'Search criteria',
6641: 'doma' => 'Domain/institution to search',
6642: 'uname' => 'username',
6643: 'lastname' => 'last name',
6644: 'lastfirst' => 'last name, first name',
6645: 'crs' => 'in this course',
6646: 'dom' => 'in selected LON-CAPA domain',
6647: 'alc' => 'all LON-CAPA',
6648: 'instd' => 'in institutional directory for selected domain',
6649: 'exact' => 'is',
6650: 'contains' => 'contains',
6651: 'begins' => 'begins with',
6652: 'youm' => "You must include some text to search for.",
6653: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6654: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6655: 'yomc' => "You must choose a domain when using an institutional directory search.",
6656: 'ymcd' => "You must choose a domain when using a domain search.",
6657: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6658: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6659: 'thfo' => "The following need to be corrected before the search can be run:",
6660: );
6661: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6662: my $srchinsel = ' <select name="srchin">';
6663:
6664: my @srchins = ('crs','dom','alc','instd');
6665:
6666: foreach my $option (@srchins) {
6667: # FIXME 'alc' option unavailable until
6668: # loncreateuser::print_user_query_page()
6669: # has been completed.
6670: next if ($option eq 'alc');
6671: next if ($option eq 'crs' && !$env{'request.course.id'});
6672: if ($curr_selected{'srchin'} eq $option) {
6673: $srchinsel .= '
6674: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6675: } else {
6676: $srchinsel .= '
6677: <option value="'.$option.'">'.$lt{$option}.'</option>';
6678: }
6679: }
6680: $srchinsel .= "\n </select>\n";
6681:
6682: my $srchbysel = ' <select name="srchby">';
6683: foreach my $option ('lastname','lastfirst','uname') {
6684: if ($curr_selected{'srchby'} eq $option) {
6685: $srchbysel .= '
6686: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6687: } else {
6688: $srchbysel .= '
6689: <option value="'.$option.'">'.$lt{$option}.'</option>';
6690: }
6691: }
6692: $srchbysel .= "\n </select>\n";
6693:
6694: my $srchtypesel = ' <select name="srchtype">';
6695: foreach my $option ('begins','contains','exact') {
6696: if ($curr_selected{'srchtype'} eq $option) {
6697: $srchtypesel .= '
6698: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6699: } else {
6700: $srchtypesel .= '
6701: <option value="'.$option.'">'.$lt{$option}.'</option>';
6702: }
6703: }
6704: $srchtypesel .= "\n </select>\n";
6705:
6706: my ($newuserscript,$new_user_create);
6707:
6708: if ($forcenewuser) {
6709: if (ref($srch) eq 'HASH') {
6710: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
6711: if ($cancreate) {
6712: $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>';
6713: } else {
6714: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6715: my %usertypetext = (
6716: official => 'institutional',
6717: unofficial => 'non-institutional',
6718: );
6719: $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
6720: }
6721: }
6722: }
6723:
6724: $newuserscript = <<"ENDSCRIPT";
6725:
6726: function setSearch(createnew,callingForm) {
6727: if (createnew == 1) {
6728: for (var i=0; i<callingForm.srchby.length; i++) {
6729: if (callingForm.srchby.options[i].value == 'uname') {
6730: callingForm.srchby.selectedIndex = i;
6731: }
6732: }
6733: for (var i=0; i<callingForm.srchin.length; i++) {
6734: if ( callingForm.srchin.options[i].value == 'dom') {
6735: callingForm.srchin.selectedIndex = i;
6736: }
6737: }
6738: for (var i=0; i<callingForm.srchtype.length; i++) {
6739: if (callingForm.srchtype.options[i].value == 'exact') {
6740: callingForm.srchtype.selectedIndex = i;
6741: }
6742: }
6743: for (var i=0; i<callingForm.srchdomain.length; i++) {
6744: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6745: callingForm.srchdomain.selectedIndex = i;
6746: }
6747: }
6748: }
6749: }
6750: ENDSCRIPT
6751:
6752: }
6753:
6754: my $output = <<"END_BLOCK";
6755: <script type="text/javascript">
6756: function validateEntry(callingForm) {
6757:
6758: var checkok = 1;
6759: var srchin;
6760: for (var i=0; i<callingForm.srchin.length; i++) {
6761: if ( callingForm.srchin[i].checked ) {
6762: srchin = callingForm.srchin[i].value;
6763: }
6764: }
6765:
6766: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
6767: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
6768: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
6769: var srchterm = callingForm.srchterm.value;
6770: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
6771: var msg = "";
6772:
6773: if (srchterm == "") {
6774: checkok = 0;
6775: msg += "$lt{'youm'}\\n";
6776: }
6777:
6778: if (srchtype== 'begins') {
6779: if (srchterm.length < 2) {
6780: checkok = 0;
6781: msg += "$lt{'thte'}\\n";
6782: }
6783: }
6784:
6785: if (srchtype== 'contains') {
6786: if (srchterm.length < 3) {
6787: checkok = 0;
6788: msg += "$lt{'thet'}\\n";
6789: }
6790: }
6791: if (srchin == 'instd') {
6792: if (srchdomain == '') {
6793: checkok = 0;
6794: msg += "$lt{'yomc'}\\n";
6795: }
6796: }
6797: if (srchin == 'dom') {
6798: if (srchdomain == '') {
6799: checkok = 0;
6800: msg += "$lt{'ymcd'}\\n";
6801: }
6802: }
6803: if (srchby == 'lastfirst') {
6804: if (srchterm.indexOf(",") == -1) {
6805: checkok = 0;
6806: msg += "$lt{'whus'}\\n";
6807: }
6808: if (srchterm.indexOf(",") == srchterm.length -1) {
6809: checkok = 0;
6810: msg += "$lt{'whse'}\\n";
6811: }
6812: }
6813: if (checkok == 0) {
6814: alert("$lt{'thfo'}\\n"+msg);
6815: return;
6816: }
6817: if (checkok == 1) {
6818: callingForm.submit();
6819: }
6820: }
6821:
6822: $newuserscript
6823:
6824: </script>
6825:
6826: $new_user_create
6827:
6828: <table>
6829: <tr>
6830: <td>$lt{'doma'}:</td>
6831: <td>$domform</td>
6832: </td>
6833: </tr>
6834: <tr>
6835: <td>$lt{'usr'}:</td>
6836: <td>$srchbysel
6837: $srchtypesel
6838: <input type="text" size="15" name="srchterm" value="$srchterm" />
6839: $srchinsel
6840: </td>
6841: </tr>
6842: </table>
6843: <br />
6844: END_BLOCK
6845:
6846: return $output;
6847: }
6848:
6849: sub user_rule_check {
6850: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
6851: my $response;
6852: if (ref($usershash) eq 'HASH') {
6853: foreach my $user (keys(%{$usershash})) {
6854: my ($uname,$udom) = split(/:/,$user);
6855: next if ($udom eq '' || $uname eq '');
6856: my ($id,$newuser);
6857: if (ref($usershash->{$user}) eq 'HASH') {
6858: $newuser = $usershash->{$user}->{'newuser'};
6859: $id = $usershash->{$user}->{'id'};
6860: }
6861: my $inst_response;
6862: if (ref($checks) eq 'HASH') {
6863: if (defined($checks->{'username'})) {
6864: ($inst_response,%{$inst_results->{$user}}) =
6865: &Apache::lonnet::get_instuser($udom,$uname);
6866: } elsif (defined($checks->{'id'})) {
6867: ($inst_response,%{$inst_results->{$user}}) =
6868: &Apache::lonnet::get_instuser($udom,undef,$id);
6869: }
6870: } else {
6871: ($inst_response,%{$inst_results->{$user}}) =
6872: &Apache::lonnet::get_instuser($udom,$uname);
6873: return;
6874: }
6875: if (!$got_rules->{$udom}) {
6876: my %domconfig = &Apache::lonnet::get_dom('configuration',
6877: ['usercreation'],$udom);
6878: if (ref($domconfig{'usercreation'}) eq 'HASH') {
6879: foreach my $item ('username','id') {
6880: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
6881: $$curr_rules{$udom}{$item} =
6882: $domconfig{'usercreation'}{$item.'_rule'};
6883: }
6884: }
6885: }
6886: $got_rules->{$udom} = 1;
6887: }
6888: foreach my $item (keys(%{$checks})) {
6889: if (ref($$curr_rules{$udom}) eq 'HASH') {
6890: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
6891: if (@{$$curr_rules{$udom}{$item}} > 0) {
6892: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
6893: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
6894: if ($rule_check{$rule}) {
6895: $$rulematch{$user}{$item} = $rule;
6896: if ($inst_response eq 'ok') {
6897: if (ref($inst_results) eq 'HASH') {
6898: if (ref($inst_results->{$user}) eq 'HASH') {
6899: if (keys(%{$inst_results->{$user}}) == 0) {
6900: $$alerts{$item}{$udom}{$uname} = 1;
6901: }
6902: }
6903: }
6904: }
6905: last;
6906: }
6907: }
6908: }
6909: }
6910: }
6911: }
6912: }
6913: }
6914: return;
6915: }
6916:
6917: sub user_rule_formats {
6918: my ($domain,$domdesc,$curr_rules,$check) = @_;
6919: my %text = (
6920: 'username' => 'Usernames',
6921: 'id' => 'IDs',
6922: );
6923: my $output;
6924: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
6925: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
6926: if (@{$ruleorder} > 0) {
6927: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
6928: foreach my $rule (@{$ruleorder}) {
6929: if (ref($curr_rules) eq 'ARRAY') {
6930: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
6931: if (ref($rules->{$rule}) eq 'HASH') {
6932: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
6933: $rules->{$rule}{'desc'}.'</li>';
6934: }
6935: }
6936: }
6937: }
6938: $output .= '</ul>';
6939: }
6940: }
6941: return $output;
6942: }
6943:
6944: sub instrule_disallow_msg {
6945: my ($checkitem,$domdesc,$count,$mode) = @_;
6946: my $response;
6947: my %text = (
6948: item => 'username',
6949: items => 'usernames',
6950: match => 'matches',
6951: do => 'does',
6952: action => 'a username',
6953: one => 'one',
6954: );
6955: if ($count > 1) {
6956: $text{'item'} = 'usernames';
6957: $text{'match'} ='match';
6958: $text{'do'} = 'do';
6959: $text{'action'} = 'usernames',
6960: $text{'one'} = 'ones';
6961: }
6962: if ($checkitem eq 'id') {
6963: $text{'items'} = 'IDs';
6964: $text{'item'} = 'ID';
6965: $text{'action'} = 'an ID';
6966: if ($count > 1) {
6967: $text{'item'} = 'IDs';
6968: $text{'action'} = 'IDs';
6969: }
6970: }
6971: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
6972: if ($mode eq 'upload') {
6973: if ($checkitem eq 'username') {
6974: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6975: } elsif ($checkitem eq 'id') {
6976: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
6977: }
6978: } elsif ($mode eq 'selfcreate') {
6979: if ($checkitem eq 'id') {
6980: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
6981: }
6982: } else {
6983: if ($checkitem eq 'username') {
6984: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6985: } elsif ($checkitem eq 'id') {
6986: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
6987: }
6988: }
6989: return $response;
6990: }
6991:
6992: sub personal_data_fieldtitles {
6993: my %fieldtitles = &Apache::lonlocal::texthash (
6994: id => 'Student/Employee ID',
6995: permanentemail => 'E-mail address',
6996: lastname => 'Last Name',
6997: firstname => 'First Name',
6998: middlename => 'Middle Name',
6999: generation => 'Generation',
7000: gen => 'Generation',
7001: );
7002: return %fieldtitles;
7003: }
7004:
7005: sub sorted_inst_types {
7006: my ($dom) = @_;
7007: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7008: my $othertitle = &mt('All users');
7009: if ($env{'request.course.id'}) {
7010: $othertitle = &mt('Any users');
7011: }
7012: my @types;
7013: if (ref($order) eq 'ARRAY') {
7014: @types = @{$order};
7015: }
7016: if (@types == 0) {
7017: if (ref($usertypes) eq 'HASH') {
7018: @types = sort(keys(%{$usertypes}));
7019: }
7020: }
7021: if (keys(%{$usertypes}) > 0) {
7022: $othertitle = &mt('Other users');
7023: }
7024: return ($othertitle,$usertypes,\@types);
7025: }
7026:
7027: sub get_institutional_codes {
7028: my ($settings,$allcourses,$LC_code) = @_;
7029: # Get complete list of course sections to update
7030: my @currsections = ();
7031: my @currxlists = ();
7032: my $coursecode = $$settings{'internal.coursecode'};
7033:
7034: if ($$settings{'internal.sectionnums'} ne '') {
7035: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7036: }
7037:
7038: if ($$settings{'internal.crosslistings'} ne '') {
7039: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7040: }
7041:
7042: if (@currxlists > 0) {
7043: foreach (@currxlists) {
7044: if (m/^([^:]+):(\w*)$/) {
7045: unless (grep/^$1$/,@{$allcourses}) {
7046: push @{$allcourses},$1;
7047: $$LC_code{$1} = $2;
7048: }
7049: }
7050: }
7051: }
7052:
7053: if (@currsections > 0) {
7054: foreach (@currsections) {
7055: if (m/^(\w+):(\w*)$/) {
7056: my $sec = $coursecode.$1;
7057: my $lc_sec = $2;
7058: unless (grep/^$sec$/,@{$allcourses}) {
7059: push @{$allcourses},$sec;
7060: $$LC_code{$sec} = $lc_sec;
7061: }
7062: }
7063: }
7064: }
7065: return;
7066: }
7067:
7068: =pod
7069:
7070: =back
7071:
7072: =head1 HTTP Helpers
7073:
7074: =over 4
7075:
7076: =item * &get_unprocessed_cgi($query,$possible_names)
7077:
7078: Modify the %env hash to contain unprocessed CGI form parameters held in
7079: $query. The parameters listed in $possible_names (an array reference),
7080: will be set in $env{'form.name'} if they do not already exist.
7081:
7082: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7083: $possible_names is an ref to an array of form element names. As an example:
7084: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
7085: will result in $env{'form.uname'} and $env{'form.udom'} being set.
7086:
7087: =cut
7088:
7089: sub get_unprocessed_cgi {
7090: my ($query,$possible_names)= @_;
7091: # $Apache::lonxml::debug=1;
7092: foreach my $pair (split(/&/,$query)) {
7093: my ($name, $value) = split(/=/,$pair);
7094: $name = &unescape($name);
7095: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7096: $value =~ tr/+/ /;
7097: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
7098: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
7099: }
7100: }
7101: }
7102:
7103: =pod
7104:
7105: =item * &cacheheader()
7106:
7107: returns cache-controlling header code
7108:
7109: =cut
7110:
7111: sub cacheheader {
7112: unless ($env{'request.method'} eq 'GET') { return ''; }
7113: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7114: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
7115: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7116: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
7117: return $output;
7118: }
7119:
7120: =pod
7121:
7122: =item * &no_cache($r)
7123:
7124: specifies header code to not have cache
7125:
7126: =cut
7127:
7128: sub no_cache {
7129: my ($r) = @_;
7130: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
7131: $env{'request.method'} ne 'GET') { return ''; }
7132: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7133: $r->no_cache(1);
7134: $r->header_out("Expires" => $date);
7135: $r->header_out("Pragma" => "no-cache");
7136: }
7137:
7138: sub content_type {
7139: my ($r,$type,$charset) = @_;
7140: if ($r) {
7141: # Note that printout.pl calls this with undef for $r.
7142: &no_cache($r);
7143: }
7144: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
7145: unless ($charset) {
7146: $charset=&Apache::lonlocal::current_encoding;
7147: }
7148: if ($charset) { $type.='; charset='.$charset; }
7149: if ($r) {
7150: $r->content_type($type);
7151: } else {
7152: print("Content-type: $type\n\n");
7153: }
7154: }
7155:
7156: =pod
7157:
7158: =item * &add_to_env($name,$value)
7159:
7160: adds $name to the %env hash with value
7161: $value, if $name already exists, the entry is converted to an array
7162: reference and $value is added to the array.
7163:
7164: =cut
7165:
7166: sub add_to_env {
7167: my ($name,$value)=@_;
7168: if (defined($env{$name})) {
7169: if (ref($env{$name})) {
7170: #already have multiple values
7171: push(@{ $env{$name} },$value);
7172: } else {
7173: #first time seeing multiple values, convert hash entry to an arrayref
7174: my $first=$env{$name};
7175: undef($env{$name});
7176: push(@{ $env{$name} },$first,$value);
7177: }
7178: } else {
7179: $env{$name}=$value;
7180: }
7181: }
7182:
7183: =pod
7184:
7185: =item * &get_env_multiple($name)
7186:
7187: gets $name from the %env hash, it seemlessly handles the cases where multiple
7188: values may be defined and end up as an array ref.
7189:
7190: returns an array of values
7191:
7192: =cut
7193:
7194: sub get_env_multiple {
7195: my ($name) = @_;
7196: my @values;
7197: if (defined($env{$name})) {
7198: # exists is it an array
7199: if (ref($env{$name})) {
7200: @values=@{ $env{$name} };
7201: } else {
7202: $values[0]=$env{$name};
7203: }
7204: }
7205: return(@values);
7206: }
7207:
7208: sub ask_for_embedded_content {
7209: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7210: my $upload_output = '
7211: <form name="upload_embedded" action="'.$actionurl.'"
7212: method="post" enctype="multipart/form-data">';
7213: $upload_output .= $state;
7214: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
7215:
7216: my $num = 0;
7217: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7218: $upload_output .= &start_data_table_row().
7219: '<td>'.$embed_file.'</td><td>';
7220: if ($args->{'ignore_remote_references'}
7221: && $embed_file =~ m{^\w+://}) {
7222: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7223: } elsif ($args->{'error_on_invalid_names'}
7224: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7225:
7226: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7227:
7228: } else {
7229: $upload_output .='
7230: <input name="embedded_item_'.$num.'" type="file" value="" />
7231: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7232: my $attrib = join(':',@{$$allfiles{$embed_file}});
7233: $upload_output .=
7234: "\n\t\t".
7235: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7236: $attrib.'" />';
7237: if (exists($$codebase{$embed_file})) {
7238: $upload_output .=
7239: "\n\t\t".
7240: '<input name="codebase_'.$num.'" type="hidden" value="'.
7241: &escape($$codebase{$embed_file}).'" />';
7242: }
7243: }
7244: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7245: $num++;
7246: }
7247: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7248: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7249: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7250: '.&mt('(only files for which a location has been provided will be uploaded)').'
7251: </form>';
7252: return $upload_output;
7253: }
7254:
7255: sub upload_embedded {
7256: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7257: $current_disk_usage) = @_;
7258: my $output;
7259: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7260: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7261: my $orig_uploaded_filename =
7262: $env{'form.embedded_item_'.$i.'.filename'};
7263:
7264: $env{'form.embedded_orig_'.$i} =
7265: &unescape($env{'form.embedded_orig_'.$i});
7266: my ($path,$fname) =
7267: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7268: # no path, whole string is fname
7269: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7270:
7271: $path = $env{'form.currentpath'}.$path;
7272: $fname = &Apache::lonnet::clean_filename($fname);
7273: # See if there is anything left
7274: next if ($fname eq '');
7275:
7276: # Check if file already exists as a file or directory.
7277: my ($state,$msg);
7278: if ($context eq 'portfolio') {
7279: my $port_path = $dirpath;
7280: if ($group ne '') {
7281: $port_path = "groups/$group/$port_path";
7282: }
7283: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7284: $dir_root,$port_path,$disk_quota,
7285: $current_disk_usage,$uname,$udom);
7286: if ($state eq 'will_exceed_quota'
7287: || $state eq 'file_locked'
7288: || $state eq 'file_exists' ) {
7289: $output .= $msg;
7290: next;
7291: }
7292: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7293: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7294: if ($state eq 'exists') {
7295: $output .= $msg;
7296: next;
7297: }
7298: }
7299: # Check if extension is valid
7300: if (($fname =~ /\.(\w+)$/) &&
7301: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7302: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7303: next;
7304: } elsif (($fname =~ /\.(\w+)$/) &&
7305: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7306: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7307: next;
7308: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7309: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7310: next;
7311: }
7312:
7313: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7314: if ($context eq 'portfolio') {
7315: my $result=
7316: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7317: $dirpath.$path);
7318: if ($result !~ m|^/uploaded/|) {
7319: $output .= '<span class="LC_error">'
7320: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7321: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7322: .'</span><br />';
7323: next;
7324: } else {
7325: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7326: $path.$fname.'</span>').'</p>';
7327: }
7328: } else {
7329: # Save the file
7330: my $target = $env{'form.embedded_item_'.$i};
7331: my $fullpath = $dir_root.$dirpath.'/'.$path;
7332: my $dest = $fullpath.$fname;
7333: my $url = $url_root.$dirpath.'/'.$path.$fname;
7334: my @parts=split(/\//,$fullpath);
7335: my $count;
7336: my $filepath = $dir_root;
7337: for ($count=4;$count<=$#parts;$count++) {
7338: $filepath .= "/$parts[$count]";
7339: if ((-e $filepath)!=1) {
7340: mkdir($filepath,0770);
7341: }
7342: }
7343: my $fh;
7344: if (!open($fh,'>'.$dest)) {
7345: &Apache::lonnet::logthis('Failed to create '.$dest);
7346: $output .= '<span class="LC_error">'.
7347: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7348: '</span><br />';
7349: } else {
7350: if (!print $fh $env{'form.embedded_item_'.$i}) {
7351: &Apache::lonnet::logthis('Failed to write to '.$dest);
7352: $output .= '<span class="LC_error">'.
7353: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7354: '</span><br />';
7355: } else {
7356: if ($context eq 'testbank') {
7357: $output .= &mt('Embedded file uploaded successfully:').
7358: ' <a href="'.$url.'">'.
7359: $orig_uploaded_filename.'</a><br />';
7360: } else {
7361: $output .= '<font size="+2">'.
7362: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
7363: $orig_uploaded_filename.'</a>').'</font><br />';
7364: }
7365: }
7366: close($fh);
7367: }
7368: }
7369: }
7370: return $output;
7371: }
7372:
7373: sub check_for_existing {
7374: my ($path,$fname,$element) = @_;
7375: my ($state,$msg);
7376: if (-d $path.'/'.$fname) {
7377: $state = 'exists';
7378: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7379: } elsif (-e $path.'/'.$fname) {
7380: $state = 'exists';
7381: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7382: }
7383: if ($state eq 'exists') {
7384: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7385: }
7386: return ($state,$msg);
7387: }
7388:
7389: sub check_for_upload {
7390: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7391: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7392: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7393: my $getpropath = 1;
7394: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7395: $getpropath);
7396: my $found_file = 0;
7397: my $locked_file = 0;
7398: foreach my $line (@dir_list) {
7399: my ($file_name)=split(/\&/,$line,2);
7400: if ($file_name eq $fname){
7401: $file_name = $path.$file_name;
7402: if ($group ne '') {
7403: $file_name = $group.$file_name;
7404: }
7405: $found_file = 1;
7406: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7407: $locked_file = 1;
7408: }
7409: }
7410: }
7411: if (($current_disk_usage + $filesize) > $disk_quota){
7412: my $msg = '<span class="LC_error">'.
7413: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7414: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7415: return ('will_exceed_quota',$msg);
7416: } elsif ($found_file) {
7417: if ($locked_file) {
7418: my $msg = '<span class="LC_error">';
7419: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
7420: $msg .= '</span><br />';
7421: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7422: return ('file_locked',$msg);
7423: } else {
7424: my $msg = '<span class="LC_error">';
7425: $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
7426: $msg .= '</span>';
7427: $msg .= '<br />';
7428: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7429: return ('file_exists',$msg);
7430: }
7431: }
7432: }
7433:
7434:
7435: =pod
7436:
7437: =back
7438:
7439: =head1 CSV Upload/Handling functions
7440:
7441: =over 4
7442:
7443: =item * &upfile_store($r)
7444:
7445: Store uploaded file, $r should be the HTTP Request object,
7446: needs $env{'form.upfile'}
7447: returns $datatoken to be put into hidden field
7448:
7449: =cut
7450:
7451: sub upfile_store {
7452: my $r=shift;
7453: $env{'form.upfile'}=~s/\r/\n/gs;
7454: $env{'form.upfile'}=~s/\f/\n/gs;
7455: $env{'form.upfile'}=~s/\n+/\n/gs;
7456: $env{'form.upfile'}=~s/\n+$//gs;
7457:
7458: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7459: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
7460: {
7461: my $datafile = $r->dir_config('lonDaemons').
7462: '/tmp/'.$datatoken.'.tmp';
7463: if ( open(my $fh,">$datafile") ) {
7464: print $fh $env{'form.upfile'};
7465: close($fh);
7466: }
7467: }
7468: return $datatoken;
7469: }
7470:
7471: =pod
7472:
7473: =item * &load_tmp_file($r)
7474:
7475: Load uploaded file from tmp, $r should be the HTTP Request object,
7476: needs $env{'form.datatoken'},
7477: sets $env{'form.upfile'} to the contents of the file
7478:
7479: =cut
7480:
7481: sub load_tmp_file {
7482: my $r=shift;
7483: my @studentdata=();
7484: {
7485: my $studentfile = $r->dir_config('lonDaemons').
7486: '/tmp/'.$env{'form.datatoken'}.'.tmp';
7487: if ( open(my $fh,"<$studentfile") ) {
7488: @studentdata=<$fh>;
7489: close($fh);
7490: }
7491: }
7492: $env{'form.upfile'}=join('',@studentdata);
7493: }
7494:
7495: =pod
7496:
7497: =item * &upfile_record_sep()
7498:
7499: Separate uploaded file into records
7500: returns array of records,
7501: needs $env{'form.upfile'} and $env{'form.upfiletype'}
7502:
7503: =cut
7504:
7505: sub upfile_record_sep {
7506: if ($env{'form.upfiletype'} eq 'xml') {
7507: } else {
7508: my @records;
7509: foreach my $line (split(/\n/,$env{'form.upfile'})) {
7510: if ($line=~/^\s*$/) { next; }
7511: push(@records,$line);
7512: }
7513: return @records;
7514: }
7515: }
7516:
7517: =pod
7518:
7519: =item * &record_sep($record)
7520:
7521: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
7522:
7523: =cut
7524:
7525: sub takeleft {
7526: my $index=shift;
7527: return substr('0000'.$index,-4,4);
7528: }
7529:
7530: sub record_sep {
7531: my $record=shift;
7532: my %components=();
7533: if ($env{'form.upfiletype'} eq 'xml') {
7534: } elsif ($env{'form.upfiletype'} eq 'space') {
7535: my $i=0;
7536: foreach my $field (split(/\s+/,$record)) {
7537: $field=~s/^(\"|\')//;
7538: $field=~s/(\"|\')$//;
7539: $components{&takeleft($i)}=$field;
7540: $i++;
7541: }
7542: } elsif ($env{'form.upfiletype'} eq 'tab') {
7543: my $i=0;
7544: foreach my $field (split(/\t/,$record)) {
7545: $field=~s/^(\"|\')//;
7546: $field=~s/(\"|\')$//;
7547: $components{&takeleft($i)}=$field;
7548: $i++;
7549: }
7550: } else {
7551: my $separator=',';
7552: if ($env{'form.upfiletype'} eq 'semisv') {
7553: $separator=';';
7554: }
7555: my $i=0;
7556: # the character we are looking for to indicate the end of a quote or a record
7557: my $looking_for=$separator;
7558: # do not add the characters to the fields
7559: my $ignore=0;
7560: # we just encountered a separator (or the beginning of the record)
7561: my $just_found_separator=1;
7562: # store the field we are working on here
7563: my $field='';
7564: # work our way through all characters in record
7565: foreach my $character ($record=~/(.)/g) {
7566: if ($character eq $looking_for) {
7567: if ($character ne $separator) {
7568: # Found the end of a quote, again looking for separator
7569: $looking_for=$separator;
7570: $ignore=1;
7571: } else {
7572: # Found a separator, store away what we got
7573: $components{&takeleft($i)}=$field;
7574: $i++;
7575: $just_found_separator=1;
7576: $ignore=0;
7577: $field='';
7578: }
7579: next;
7580: }
7581: # single or double quotation marks after a separator indicate beginning of a quote
7582: # we are now looking for the end of the quote and need to ignore separators
7583: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7584: $looking_for=$character;
7585: next;
7586: }
7587: # ignore would be true after we reached the end of a quote
7588: if ($ignore) { next; }
7589: if (($just_found_separator) && ($character=~/\s/)) { next; }
7590: $field.=$character;
7591: $just_found_separator=0;
7592: }
7593: # catch the very last entry, since we never encountered the separator
7594: $components{&takeleft($i)}=$field;
7595: }
7596: return %components;
7597: }
7598:
7599: ######################################################
7600: ######################################################
7601:
7602: =pod
7603:
7604: =item * &upfile_select_html()
7605:
7606: Return HTML code to select a file from the users machine and specify
7607: the file type.
7608:
7609: =cut
7610:
7611: ######################################################
7612: ######################################################
7613: sub upfile_select_html {
7614: my %Types = (
7615: csv => &mt('CSV (comma separated values, spreadsheet)'),
7616: semisv => &mt('Semicolon separated values'),
7617: space => &mt('Space separated'),
7618: tab => &mt('Tabulator separated'),
7619: # xml => &mt('HTML/XML'),
7620: );
7621: my $Str = '<input type="file" name="upfile" size="50" />'.
7622: '<br />Type: <select name="upfiletype">';
7623: foreach my $type (sort(keys(%Types))) {
7624: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7625: }
7626: $Str .= "</select>\n";
7627: return $Str;
7628: }
7629:
7630: sub get_samples {
7631: my ($records,$toget) = @_;
7632: my @samples=({});
7633: my $got=0;
7634: foreach my $rec (@$records) {
7635: my %temp = &record_sep($rec);
7636: if (! grep(/\S/, values(%temp))) { next; }
7637: if (%temp) {
7638: $samples[$got]=\%temp;
7639: $got++;
7640: if ($got == $toget) { last; }
7641: }
7642: }
7643: return \@samples;
7644: }
7645:
7646: ######################################################
7647: ######################################################
7648:
7649: =pod
7650:
7651: =item * &csv_print_samples($r,$records)
7652:
7653: Prints a table of sample values from each column uploaded $r is an
7654: Apache Request ref, $records is an arrayref from
7655: &Apache::loncommon::upfile_record_sep
7656:
7657: =cut
7658:
7659: ######################################################
7660: ######################################################
7661: sub csv_print_samples {
7662: my ($r,$records) = @_;
7663: my $samples = &get_samples($records,5);
7664:
7665: $r->print(&mt('Samples').'<br />'.&start_data_table().
7666: &start_data_table_header_row());
7667: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7668: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
7669: $r->print(&end_data_table_header_row());
7670: foreach my $hash (@$samples) {
7671: $r->print(&start_data_table_row());
7672: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7673: $r->print('<td>');
7674: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
7675: $r->print('</td>');
7676: }
7677: $r->print(&end_data_table_row());
7678: }
7679: $r->print(&end_data_table().'<br />'."\n");
7680: }
7681:
7682: ######################################################
7683: ######################################################
7684:
7685: =pod
7686:
7687: =item * &csv_print_select_table($r,$records,$d)
7688:
7689: Prints a table to create associations between values and table columns.
7690:
7691: $r is an Apache Request ref,
7692: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7693: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
7694:
7695: =cut
7696:
7697: ######################################################
7698: ######################################################
7699: sub csv_print_select_table {
7700: my ($r,$records,$d) = @_;
7701: my $i=0;
7702: my $samples = &get_samples($records,1);
7703: $r->print(&mt('Associate columns with student attributes.')."\n".
7704: &start_data_table().&start_data_table_header_row().
7705: '<th>'.&mt('Attribute').'</th>'.
7706: '<th>'.&mt('Column').'</th>'.
7707: &end_data_table_header_row()."\n");
7708: foreach my $array_ref (@$d) {
7709: my ($value,$display,$defaultcol)=@{ $array_ref };
7710: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
7711:
7712: $r->print('<td><select name=f'.$i.
7713: ' onchange="javascript:flip(this.form,'.$i.');">');
7714: $r->print('<option value="none"></option>');
7715: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7716: $r->print('<option value="'.$sample.'"'.
7717: ($sample eq $defaultcol ? ' selected="selected" ' : '').
7718: '>'.&mt('Column [_1]',($sample+1)).'</option>');
7719: }
7720: $r->print('</select></td>'.&end_data_table_row()."\n");
7721: $i++;
7722: }
7723: $r->print(&end_data_table());
7724: $i--;
7725: return $i;
7726: }
7727:
7728: ######################################################
7729: ######################################################
7730:
7731: =pod
7732:
7733: =item * &csv_samples_select_table($r,$records,$d)
7734:
7735: Prints a table of sample values from the upload and can make associate samples to internal names.
7736:
7737: $r is an Apache Request ref,
7738: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7739: $d is an array of 2 element arrays (internal name, displayed name)
7740:
7741: =cut
7742:
7743: ######################################################
7744: ######################################################
7745: sub csv_samples_select_table {
7746: my ($r,$records,$d) = @_;
7747: my $i=0;
7748: #
7749: my $max_samples = 5;
7750: my $samples = &get_samples($records,$max_samples);
7751: $r->print(&start_data_table().
7752: &start_data_table_header_row().'<th>'.
7753: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7754: &end_data_table_header_row());
7755:
7756: foreach my $key (sort(keys(%{ $samples->[0] }))) {
7757: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
7758: ' onchange="javascript:flip(this.form,'.$i.');">');
7759: foreach my $option (@$d) {
7760: my ($value,$display,$defaultcol)=@{ $option };
7761: $r->print('<option value="'.$value.'"'.
7762: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
7763: $display.'</option>');
7764: }
7765: $r->print('</select></td><td>');
7766: foreach my $line (0..($max_samples-1)) {
7767: if (defined($samples->[$line]{$key})) {
7768: $r->print($samples->[$line]{$key}."<br />\n");
7769: }
7770: }
7771: $r->print('</td>'.&end_data_table_row());
7772: $i++;
7773: }
7774: $r->print(&end_data_table());
7775: $i--;
7776: return($i);
7777: }
7778:
7779: ######################################################
7780: ######################################################
7781:
7782: =pod
7783:
7784: =item * &clean_excel_name($name)
7785:
7786: Returns a replacement for $name which does not contain any illegal characters.
7787:
7788: =cut
7789:
7790: ######################################################
7791: ######################################################
7792: sub clean_excel_name {
7793: my ($name) = @_;
7794: $name =~ s/[:\*\?\/\\]//g;
7795: if (length($name) > 31) {
7796: $name = substr($name,0,31);
7797: }
7798: return $name;
7799: }
7800:
7801: =pod
7802:
7803: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
7804:
7805: Returns either 1 or undef
7806:
7807: 1 if the part is to be hidden, undef if it is to be shown
7808:
7809: Arguments are:
7810:
7811: $id the id of the part to be checked
7812: $symb, optional the symb of the resource to check
7813: $udom, optional the domain of the user to check for
7814: $uname, optional the username of the user to check for
7815:
7816: =cut
7817:
7818: sub check_if_partid_hidden {
7819: my ($id,$symb,$udom,$uname) = @_;
7820: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
7821: $symb,$udom,$uname);
7822: my $truth=1;
7823: #if the string starts with !, then the list is the list to show not hide
7824: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
7825: my @hiddenlist=split(/,/,$hiddenparts);
7826: foreach my $checkid (@hiddenlist) {
7827: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
7828: }
7829: return !$truth;
7830: }
7831:
7832:
7833: ############################################################
7834: ############################################################
7835:
7836: =pod
7837:
7838: =back
7839:
7840: =head1 cgi-bin script and graphing routines
7841:
7842: =over 4
7843:
7844: =item * &get_cgi_id()
7845:
7846: Inputs: none
7847:
7848: Returns an id which can be used to pass environment variables
7849: to various cgi-bin scripts. These environment variables will
7850: be removed from the users environment after a given time by
7851: the routine &Apache::lonnet::transfer_profile_to_env.
7852:
7853: =cut
7854:
7855: ############################################################
7856: ############################################################
7857: my $uniq=0;
7858: sub get_cgi_id {
7859: $uniq=($uniq+1)%100000;
7860: return (time.'_'.$$.'_'.$uniq);
7861: }
7862:
7863: ############################################################
7864: ############################################################
7865:
7866: =pod
7867:
7868: =item * &DrawBarGraph()
7869:
7870: Facilitates the plotting of data in a (stacked) bar graph.
7871: Puts plot definition data into the users environment in order for
7872: graph.png to plot it. Returns an <img> tag for the plot.
7873: The bars on the plot are labeled '1','2',...,'n'.
7874:
7875: Inputs:
7876:
7877: =over 4
7878:
7879: =item $Title: string, the title of the plot
7880:
7881: =item $xlabel: string, text describing the X-axis of the plot
7882:
7883: =item $ylabel: string, text describing the Y-axis of the plot
7884:
7885: =item $Max: scalar, the maximum Y value to use in the plot
7886: If $Max is < any data point, the graph will not be rendered.
7887:
7888: =item $colors: array ref holding the colors to be used for the data sets when
7889: they are plotted. If undefined, default values will be used.
7890:
7891: =item $labels: array ref holding the labels to use on the x-axis for the bars.
7892:
7893: =item @Values: An array of array references. Each array reference holds data
7894: to be plotted in a stacked bar chart.
7895:
7896: =item If the final element of @Values is a hash reference the key/value
7897: pairs will be added to the graph definition.
7898:
7899: =back
7900:
7901: Returns:
7902:
7903: An <img> tag which references graph.png and the appropriate identifying
7904: information for the plot.
7905:
7906: =cut
7907:
7908: ############################################################
7909: ############################################################
7910: sub DrawBarGraph {
7911: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
7912: #
7913: if (! defined($colors)) {
7914: $colors = ['#33ff00',
7915: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
7916: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
7917: ];
7918: }
7919: my $extra_settings = {};
7920: if (ref($Values[-1]) eq 'HASH') {
7921: $extra_settings = pop(@Values);
7922: }
7923: #
7924: my $identifier = &get_cgi_id();
7925: my $id = 'cgi.'.$identifier;
7926: if (! @Values || ref($Values[0]) ne 'ARRAY') {
7927: return '';
7928: }
7929: #
7930: my @Labels;
7931: if (defined($labels)) {
7932: @Labels = @$labels;
7933: } else {
7934: for (my $i=0;$i<@{$Values[0]};$i++) {
7935: push (@Labels,$i+1);
7936: }
7937: }
7938: #
7939: my $NumBars = scalar(@{$Values[0]});
7940: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
7941: my %ValuesHash;
7942: my $NumSets=1;
7943: foreach my $array (@Values) {
7944: next if (! ref($array));
7945: $ValuesHash{$id.'.data.'.$NumSets++} =
7946: join(',',@$array);
7947: }
7948: #
7949: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
7950: if ($NumBars < 3) {
7951: $width = 120+$NumBars*32;
7952: $xskip = 1;
7953: $bar_width = 30;
7954: } elsif ($NumBars < 5) {
7955: $width = 120+$NumBars*20;
7956: $xskip = 1;
7957: $bar_width = 20;
7958: } elsif ($NumBars < 10) {
7959: $width = 120+$NumBars*15;
7960: $xskip = 1;
7961: $bar_width = 15;
7962: } elsif ($NumBars <= 25) {
7963: $width = 120+$NumBars*11;
7964: $xskip = 5;
7965: $bar_width = 8;
7966: } elsif ($NumBars <= 50) {
7967: $width = 120+$NumBars*8;
7968: $xskip = 5;
7969: $bar_width = 4;
7970: } else {
7971: $width = 120+$NumBars*8;
7972: $xskip = 5;
7973: $bar_width = 4;
7974: }
7975: #
7976: $Max = 1 if ($Max < 1);
7977: if ( int($Max) < $Max ) {
7978: $Max++;
7979: $Max = int($Max);
7980: }
7981: $Title = '' if (! defined($Title));
7982: $xlabel = '' if (! defined($xlabel));
7983: $ylabel = '' if (! defined($ylabel));
7984: $ValuesHash{$id.'.title'} = &escape($Title);
7985: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
7986: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
7987: $ValuesHash{$id.'.y_max_value'} = $Max;
7988: $ValuesHash{$id.'.NumBars'} = $NumBars;
7989: $ValuesHash{$id.'.NumSets'} = $NumSets;
7990: $ValuesHash{$id.'.PlotType'} = 'bar';
7991: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7992: $ValuesHash{$id.'.height'} = $height;
7993: $ValuesHash{$id.'.width'} = $width;
7994: $ValuesHash{$id.'.xskip'} = $xskip;
7995: $ValuesHash{$id.'.bar_width'} = $bar_width;
7996: $ValuesHash{$id.'.labels'} = join(',',@Labels);
7997: #
7998: # Deal with other parameters
7999: while (my ($key,$value) = each(%$extra_settings)) {
8000: $ValuesHash{$id.'.'.$key} = $value;
8001: }
8002: #
8003: &Apache::lonnet::appenv(\%ValuesHash);
8004: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8005: }
8006:
8007: ############################################################
8008: ############################################################
8009:
8010: =pod
8011:
8012: =item * &DrawXYGraph()
8013:
8014: Facilitates the plotting of data in an XY graph.
8015: Puts plot definition data into the users environment in order for
8016: graph.png to plot it. Returns an <img> tag for the plot.
8017:
8018: Inputs:
8019:
8020: =over 4
8021:
8022: =item $Title: string, the title of the plot
8023:
8024: =item $xlabel: string, text describing the X-axis of the plot
8025:
8026: =item $ylabel: string, text describing the Y-axis of the plot
8027:
8028: =item $Max: scalar, the maximum Y value to use in the plot
8029: If $Max is < any data point, the graph will not be rendered.
8030:
8031: =item $colors: Array ref containing the hex color codes for the data to be
8032: plotted in. If undefined, default values will be used.
8033:
8034: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8035:
8036: =item $Ydata: Array ref containing Array refs.
8037: Each of the contained arrays will be plotted as a separate curve.
8038:
8039: =item %Values: hash indicating or overriding any default values which are
8040: passed to graph.png.
8041: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8042:
8043: =back
8044:
8045: Returns:
8046:
8047: An <img> tag which references graph.png and the appropriate identifying
8048: information for the plot.
8049:
8050: =cut
8051:
8052: ############################################################
8053: ############################################################
8054: sub DrawXYGraph {
8055: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8056: #
8057: # Create the identifier for the graph
8058: my $identifier = &get_cgi_id();
8059: my $id = 'cgi.'.$identifier;
8060: #
8061: $Title = '' if (! defined($Title));
8062: $xlabel = '' if (! defined($xlabel));
8063: $ylabel = '' if (! defined($ylabel));
8064: my %ValuesHash =
8065: (
8066: $id.'.title' => &escape($Title),
8067: $id.'.xlabel' => &escape($xlabel),
8068: $id.'.ylabel' => &escape($ylabel),
8069: $id.'.y_max_value'=> $Max,
8070: $id.'.labels' => join(',',@$Xlabels),
8071: $id.'.PlotType' => 'XY',
8072: );
8073: #
8074: if (defined($colors) && ref($colors) eq 'ARRAY') {
8075: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8076: }
8077: #
8078: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8079: return '';
8080: }
8081: my $NumSets=1;
8082: foreach my $array (@{$Ydata}){
8083: next if (! ref($array));
8084: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8085: }
8086: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
8087: #
8088: # Deal with other parameters
8089: while (my ($key,$value) = each(%Values)) {
8090: $ValuesHash{$id.'.'.$key} = $value;
8091: }
8092: #
8093: &Apache::lonnet::appenv(\%ValuesHash);
8094: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8095: }
8096:
8097: ############################################################
8098: ############################################################
8099:
8100: =pod
8101:
8102: =item * &DrawXYYGraph()
8103:
8104: Facilitates the plotting of data in an XY graph with two Y axes.
8105: Puts plot definition data into the users environment in order for
8106: graph.png to plot it. Returns an <img> tag for the plot.
8107:
8108: Inputs:
8109:
8110: =over 4
8111:
8112: =item $Title: string, the title of the plot
8113:
8114: =item $xlabel: string, text describing the X-axis of the plot
8115:
8116: =item $ylabel: string, text describing the Y-axis of the plot
8117:
8118: =item $colors: Array ref containing the hex color codes for the data to be
8119: plotted in. If undefined, default values will be used.
8120:
8121: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8122:
8123: =item $Ydata1: The first data set
8124:
8125: =item $Min1: The minimum value of the left Y-axis
8126:
8127: =item $Max1: The maximum value of the left Y-axis
8128:
8129: =item $Ydata2: The second data set
8130:
8131: =item $Min2: The minimum value of the right Y-axis
8132:
8133: =item $Max2: The maximum value of the left Y-axis
8134:
8135: =item %Values: hash indicating or overriding any default values which are
8136: passed to graph.png.
8137: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8138:
8139: =back
8140:
8141: Returns:
8142:
8143: An <img> tag which references graph.png and the appropriate identifying
8144: information for the plot.
8145:
8146: =cut
8147:
8148: ############################################################
8149: ############################################################
8150: sub DrawXYYGraph {
8151: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8152: $Ydata2,$Min2,$Max2,%Values)=@_;
8153: #
8154: # Create the identifier for the graph
8155: my $identifier = &get_cgi_id();
8156: my $id = 'cgi.'.$identifier;
8157: #
8158: $Title = '' if (! defined($Title));
8159: $xlabel = '' if (! defined($xlabel));
8160: $ylabel = '' if (! defined($ylabel));
8161: my %ValuesHash =
8162: (
8163: $id.'.title' => &escape($Title),
8164: $id.'.xlabel' => &escape($xlabel),
8165: $id.'.ylabel' => &escape($ylabel),
8166: $id.'.labels' => join(',',@$Xlabels),
8167: $id.'.PlotType' => 'XY',
8168: $id.'.NumSets' => 2,
8169: $id.'.two_axes' => 1,
8170: $id.'.y1_max_value' => $Max1,
8171: $id.'.y1_min_value' => $Min1,
8172: $id.'.y2_max_value' => $Max2,
8173: $id.'.y2_min_value' => $Min2,
8174: );
8175: #
8176: if (defined($colors) && ref($colors) eq 'ARRAY') {
8177: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8178: }
8179: #
8180: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8181: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
8182: return '';
8183: }
8184: my $NumSets=1;
8185: foreach my $array ($Ydata1,$Ydata2){
8186: next if (! ref($array));
8187: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8188: }
8189: #
8190: # Deal with other parameters
8191: while (my ($key,$value) = each(%Values)) {
8192: $ValuesHash{$id.'.'.$key} = $value;
8193: }
8194: #
8195: &Apache::lonnet::appenv(\%ValuesHash);
8196: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8197: }
8198:
8199: ############################################################
8200: ############################################################
8201:
8202: =pod
8203:
8204: =back
8205:
8206: =head1 Statistics helper routines?
8207:
8208: Bad place for them but what the hell.
8209:
8210: =over 4
8211:
8212: =item * &chartlink()
8213:
8214: Returns a link to the chart for a specific student.
8215:
8216: Inputs:
8217:
8218: =over 4
8219:
8220: =item $linktext: The text of the link
8221:
8222: =item $sname: The students username
8223:
8224: =item $sdomain: The students domain
8225:
8226: =back
8227:
8228: =back
8229:
8230: =cut
8231:
8232: ############################################################
8233: ############################################################
8234: sub chartlink {
8235: my ($linktext, $sname, $sdomain) = @_;
8236: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
8237: '&SelectedStudent='.&escape($sname.':'.$sdomain).
8238: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
8239: '">'.$linktext.'</a>';
8240: }
8241:
8242: #######################################################
8243: #######################################################
8244:
8245: =pod
8246:
8247: =head1 Course Environment Routines
8248:
8249: =over 4
8250:
8251: =item * &restore_course_settings()
8252:
8253: =item * &store_course_settings()
8254:
8255: Restores/Store indicated form parameters from the course environment.
8256: Will not overwrite existing values of the form parameters.
8257:
8258: Inputs:
8259: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8260:
8261: a hash ref describing the data to be stored. For example:
8262:
8263: %Save_Parameters = ('Status' => 'scalar',
8264: 'chartoutputmode' => 'scalar',
8265: 'chartoutputdata' => 'scalar',
8266: 'Section' => 'array',
8267: 'Group' => 'array',
8268: 'StudentData' => 'array',
8269: 'Maps' => 'array');
8270:
8271: Returns: both routines return nothing
8272:
8273: =back
8274:
8275: =cut
8276:
8277: #######################################################
8278: #######################################################
8279: sub store_course_settings {
8280: return &store_settings($env{'request.course.id'},@_);
8281: }
8282:
8283: sub store_settings {
8284: # save to the environment
8285: # appenv the same items, just to be safe
8286: my $udom = $env{'user.domain'};
8287: my $uname = $env{'user.name'};
8288: my ($context,$prefix,$Settings) = @_;
8289: my %SaveHash;
8290: my %AppHash;
8291: while (my ($setting,$type) = each(%$Settings)) {
8292: my $basename = join('.','internal',$context,$prefix,$setting);
8293: my $envname = 'environment.'.$basename;
8294: if (exists($env{'form.'.$setting})) {
8295: # Save this value away
8296: if ($type eq 'scalar' &&
8297: (! exists($env{$envname}) ||
8298: $env{$envname} ne $env{'form.'.$setting})) {
8299: $SaveHash{$basename} = $env{'form.'.$setting};
8300: $AppHash{$envname} = $env{'form.'.$setting};
8301: } elsif ($type eq 'array') {
8302: my $stored_form;
8303: if (ref($env{'form.'.$setting})) {
8304: $stored_form = join(',',
8305: map {
8306: &escape($_);
8307: } sort(@{$env{'form.'.$setting}}));
8308: } else {
8309: $stored_form =
8310: &escape($env{'form.'.$setting});
8311: }
8312: # Determine if the array contents are the same.
8313: if ($stored_form ne $env{$envname}) {
8314: $SaveHash{$basename} = $stored_form;
8315: $AppHash{$envname} = $stored_form;
8316: }
8317: }
8318: }
8319: }
8320: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
8321: $udom,$uname);
8322: if ($put_result !~ /^(ok|delayed)/) {
8323: &Apache::lonnet::logthis('unable to save form parameters, '.
8324: 'got error:'.$put_result);
8325: }
8326: # Make sure these settings stick around in this session, too
8327: &Apache::lonnet::appenv(\%AppHash);
8328: return;
8329: }
8330:
8331: sub restore_course_settings {
8332: return &restore_settings($env{'request.course.id'},@_);
8333: }
8334:
8335: sub restore_settings {
8336: my ($context,$prefix,$Settings) = @_;
8337: while (my ($setting,$type) = each(%$Settings)) {
8338: next if (exists($env{'form.'.$setting}));
8339: my $envname = 'environment.internal.'.$context.'.'.$prefix.
8340: '.'.$setting;
8341: if (exists($env{$envname})) {
8342: if ($type eq 'scalar') {
8343: $env{'form.'.$setting} = $env{$envname};
8344: } elsif ($type eq 'array') {
8345: $env{'form.'.$setting} = [
8346: map {
8347: &unescape($_);
8348: } split(',',$env{$envname})
8349: ];
8350: }
8351: }
8352: }
8353: }
8354:
8355: #######################################################
8356: #######################################################
8357:
8358: =pod
8359:
8360: =head1 Domain E-mail Routines
8361:
8362: =over 4
8363:
8364: =item * &build_recipient_list()
8365:
8366: Build recipient lists for three types of e-mail:
8367: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
8368: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
8369:
8370: Inputs:
8371: defmail (scalar - email address of default recipient),
8372: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
8373: defdom (domain for which to retrieve configuration settings),
8374: origmail (scalar - email address of recipient from loncapa.conf,
8375: i.e., predates configuration by DC via domainprefs.pm
8376:
8377: Returns: comma separated list of addresses to which to send e-mail.
8378:
8379: =back
8380:
8381: =cut
8382:
8383: ############################################################
8384: ############################################################
8385: sub build_recipient_list {
8386: my ($defmail,$mailing,$defdom,$origmail) = @_;
8387: my @recipients;
8388: my $otheremails;
8389: my %domconfig =
8390: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8391: if (ref($domconfig{'contacts'}) eq 'HASH') {
8392: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8393: my @contacts = ('adminemail','supportemail');
8394: foreach my $item (@contacts) {
8395: if ($domconfig{'contacts'}{$mailing}{$item}) {
8396: my $addr = $domconfig{'contacts'}{$item};
8397: if (!grep(/^\Q$addr\E$/,@recipients)) {
8398: push(@recipients,$addr);
8399: }
8400: }
8401: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8402: }
8403: }
8404: } elsif ($origmail ne '') {
8405: push(@recipients,$origmail);
8406: }
8407: if (defined($defmail)) {
8408: if ($defmail ne '') {
8409: push(@recipients,$defmail);
8410: }
8411: }
8412: if ($otheremails) {
8413: my @others;
8414: if ($otheremails =~ /,/) {
8415: @others = split(/,/,$otheremails);
8416: } else {
8417: push(@others,$otheremails);
8418: }
8419: foreach my $addr (@others) {
8420: if (!grep(/^\Q$addr\E$/,@recipients)) {
8421: push(@recipients,$addr);
8422: }
8423: }
8424: }
8425: my $recipientlist = join(',',@recipients);
8426: return $recipientlist;
8427: }
8428:
8429: ############################################################
8430: ############################################################
8431:
8432: =pod
8433:
8434: =head1 Course Catalog Routines
8435:
8436: =over 4
8437:
8438: =item * &gather_categories()
8439:
8440: Converts category definitions - keys of categories hash stored in
8441: coursecategories in configuration.db on the primary library server in a
8442: domain - to an array. Also generates javascript and idx hash used to
8443: generate Domain Coordinator interface for editing Course Categories.
8444:
8445: Inputs:
8446:
8447: categories (reference to hash of category definitions).
8448:
8449: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8450: categories and subcategories).
8451:
8452: idx (reference to hash of counters used in Domain Coordinator interface for
8453: editing Course Categories).
8454:
8455: jsarray (reference to array of categories used to create Javascript arrays for
8456: Domain Coordinator interface for editing Course Categories).
8457:
8458: Returns: nothing
8459:
8460: Side effects: populates cats, idx and jsarray.
8461:
8462: =cut
8463:
8464: sub gather_categories {
8465: my ($categories,$cats,$idx,$jsarray) = @_;
8466: my %counters;
8467: my $num = 0;
8468: foreach my $item (keys(%{$categories})) {
8469: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8470: if ($container eq '' && $depth == 0) {
8471: $cats->[$depth][$categories->{$item}] = $cat;
8472: } else {
8473: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8474: }
8475: my ($escitem,$tail) = split(/:/,$item,2);
8476: if ($counters{$tail} eq '') {
8477: $counters{$tail} = $num;
8478: $num ++;
8479: }
8480: if (ref($idx) eq 'HASH') {
8481: $idx->{$item} = $counters{$tail};
8482: }
8483: if (ref($jsarray) eq 'ARRAY') {
8484: push(@{$jsarray->[$counters{$tail}]},$item);
8485: }
8486: }
8487: return;
8488: }
8489:
8490: =pod
8491:
8492: =item * &extract_categories()
8493:
8494: Used to generate breadcrumb trails for course categories.
8495:
8496: Inputs:
8497:
8498: categories (reference to hash of category definitions).
8499:
8500: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8501: categories and subcategories).
8502:
8503: trails (reference to array of breacrumb trails for each category).
8504:
8505: allitems (reference to hash - key is category key
8506: (format: escaped(name):escaped(parent category):depth in hierarchy).
8507:
8508: idx (reference to hash of counters used in Domain Coordinator interface for
8509: editing Course Categories).
8510:
8511: jsarray (reference to array of categories used to create Javascript arrays for
8512: Domain Coordinator interface for editing Course Categories).
8513:
8514: subcats (reference to hash of arrays containing all subcategories within each
8515: category, -recursive)
8516:
8517: Returns: nothing
8518:
8519: Side effects: populates trails and allitems hash references.
8520:
8521: =cut
8522:
8523: sub extract_categories {
8524: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
8525: if (ref($categories) eq 'HASH') {
8526: &gather_categories($categories,$cats,$idx,$jsarray);
8527: if (ref($cats->[0]) eq 'ARRAY') {
8528: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8529: my $name = $cats->[0][$i];
8530: my $item = &escape($name).'::0';
8531: my $trailstr;
8532: if ($name eq 'instcode') {
8533: $trailstr = &mt('Official courses (with institutional codes)');
8534: } else {
8535: $trailstr = $name;
8536: }
8537: if ($allitems->{$item} eq '') {
8538: push(@{$trails},$trailstr);
8539: $allitems->{$item} = scalar(@{$trails})-1;
8540: }
8541: my @parents = ($name);
8542: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8543: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8544: my $category = $cats->[1]{$name}[$j];
8545: if (ref($subcats) eq 'HASH') {
8546: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8547: }
8548: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8549: }
8550: } else {
8551: if (ref($subcats) eq 'HASH') {
8552: $subcats->{$item} = [];
8553: }
8554: }
8555: }
8556: }
8557: }
8558: return;
8559: }
8560:
8561: =pod
8562:
8563: =item *&recurse_categories()
8564:
8565: Recursively used to generate breadcrumb trails for course categories.
8566:
8567: Inputs:
8568:
8569: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8570: categories and subcategories).
8571:
8572: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
8573:
8574: category (current course category, for which breadcrumb trail is being generated).
8575:
8576: trails (reference to array of breadcrumb trails for each category).
8577:
8578: allitems (reference to hash - key is category key
8579: (format: escaped(name):escaped(parent category):depth in hierarchy).
8580:
8581: parents (array containing containers directories for current category,
8582: back to top level).
8583:
8584: Returns: nothing
8585:
8586: Side effects: populates trails and allitems hash references
8587:
8588: =cut
8589:
8590: sub recurse_categories {
8591: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
8592: my $shallower = $depth - 1;
8593: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8594: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8595: my $name = $cats->[$depth]{$category}[$k];
8596: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8597: my $trailstr = join(' -> ',(@{$parents},$category));
8598: if ($allitems->{$item} eq '') {
8599: push(@{$trails},$trailstr);
8600: $allitems->{$item} = scalar(@{$trails})-1;
8601: }
8602: my $deeper = $depth+1;
8603: push(@{$parents},$category);
8604: if (ref($subcats) eq 'HASH') {
8605: my $subcat = &escape($name).':'.$category.':'.$depth;
8606: for (my $j=@{$parents}; $j>=0; $j--) {
8607: my $higher;
8608: if ($j > 0) {
8609: $higher = &escape($parents->[$j]).':'.
8610: &escape($parents->[$j-1]).':'.$j;
8611: } else {
8612: $higher = &escape($parents->[$j]).'::'.$j;
8613: }
8614: push(@{$subcats->{$higher}},$subcat);
8615: }
8616: }
8617: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8618: $subcats);
8619: pop(@{$parents});
8620: }
8621: } else {
8622: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8623: my $trailstr = join(' -> ',(@{$parents},$category));
8624: if ($allitems->{$item} eq '') {
8625: push(@{$trails},$trailstr);
8626: $allitems->{$item} = scalar(@{$trails})-1;
8627: }
8628: }
8629: return;
8630: }
8631:
8632: =pod
8633:
8634: =item *&assign_categories_table()
8635:
8636: Create a datatable for display of hierarchical categories in a domain,
8637: with checkboxes to allow a course to be categorized.
8638:
8639: Inputs:
8640:
8641: cathash - reference to hash of categories defined for the domain (from
8642: configuration.db)
8643:
8644: currcat - scalar with an & separated list of categories assigned to a course.
8645:
8646: Returns: $output (markup to be displayed)
8647:
8648: =cut
8649:
8650: sub assign_categories_table {
8651: my ($cathash,$currcat) = @_;
8652: my $output;
8653: if (ref($cathash) eq 'HASH') {
8654: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8655: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8656: $maxdepth = scalar(@cats);
8657: if (@cats > 0) {
8658: my $itemcount = 0;
8659: if (ref($cats[0]) eq 'ARRAY') {
8660: $output = &Apache::loncommon::start_data_table();
8661: my @currcategories;
8662: if ($currcat ne '') {
8663: @currcategories = split('&',$currcat);
8664: }
8665: for (my $i=0; $i<@{$cats[0]}; $i++) {
8666: my $parent = $cats[0][$i];
8667: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8668: next if ($parent eq 'instcode');
8669: my $item = &escape($parent).'::0';
8670: my $checked = '';
8671: if (@currcategories > 0) {
8672: if (grep(/^\Q$item\E$/,@currcategories)) {
8673: $checked = ' checked="checked" ';
8674: }
8675: }
8676: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8677: '<input type="checkbox" name="usecategory" value="'.
8678: $item.'"'.$checked.' />'.$parent.'</span>'.
8679: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
8680: my $depth = 1;
8681: push(@path,$parent);
8682: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8683: pop(@path);
8684: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8685: $itemcount ++;
8686: }
8687: $output .= &Apache::loncommon::end_data_table();
8688: }
8689: }
8690: }
8691: return $output;
8692: }
8693:
8694: =pod
8695:
8696: =item *&assign_category_rows()
8697:
8698: Create a datatable row for display of nested categories in a domain,
8699: with checkboxes to allow a course to be categorized,called recursively.
8700:
8701: Inputs:
8702:
8703: itemcount - track row number for alternating colors
8704:
8705: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8706: categories and subcategories.
8707:
8708: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8709:
8710: parent - parent of current category item
8711:
8712: path - Array containing all categories back up through the hierarchy from the
8713: current category to the top level.
8714:
8715: currcategories - reference to array of current categories assigned to the course
8716:
8717: Returns: $output (markup to be displayed).
8718:
8719: =cut
8720:
8721: sub assign_category_rows {
8722: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8723: my ($text,$name,$item,$chgstr);
8724: if (ref($cats) eq 'ARRAY') {
8725: my $maxdepth = scalar(@{$cats});
8726: if (ref($cats->[$depth]) eq 'HASH') {
8727: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8728: my $numchildren = @{$cats->[$depth]{$parent}};
8729: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8730: $text .= '<td><table class="LC_datatable">';
8731: for (my $j=0; $j<$numchildren; $j++) {
8732: $name = $cats->[$depth]{$parent}[$j];
8733: $item = &escape($name).':'.&escape($parent).':'.$depth;
8734: my $deeper = $depth+1;
8735: my $checked = '';
8736: if (ref($currcategories) eq 'ARRAY') {
8737: if (@{$currcategories} > 0) {
8738: if (grep(/^\Q$item\E$/,@{$currcategories})) {
8739: $checked = ' checked="checked" ';
8740: }
8741: }
8742: }
8743: $text .= '<tr><td><span class="LC_nobreak"><label>'.
8744: '<input type="checkbox" name="usecategory" value="'.
8745: $item.'"'.$checked.' />'.$name.'</label></span>'.
8746: '<input type="hidden" name="catname" value="'.$name.'" />'.
8747: '</td><td>';
8748: if (ref($path) eq 'ARRAY') {
8749: push(@{$path},$name);
8750: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
8751: pop(@{$path});
8752: }
8753: $text .= '</td></tr>';
8754: }
8755: $text .= '</table></td>';
8756: }
8757: }
8758: }
8759: return $text;
8760: }
8761:
8762: ############################################################
8763: ############################################################
8764:
8765:
8766: sub commit_customrole {
8767: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
8768: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
8769: ($start?', '.&mt('starting').' '.localtime($start):'').
8770: ($end?', ending '.localtime($end):'').': <b>'.
8771: &Apache::lonnet::assigncustomrole(
8772: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
8773: '</b><br />';
8774: return $output;
8775: }
8776:
8777: sub commit_standardrole {
8778: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
8779: my ($output,$logmsg,$linefeed);
8780: if ($context eq 'auto') {
8781: $linefeed = "\n";
8782: } else {
8783: $linefeed = "<br />\n";
8784: }
8785: if ($three eq 'st') {
8786: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
8787: $one,$two,$sec,$context);
8788: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
8789: ($result eq 'unknown_course') || ($result eq 'refused')) {
8790: $output = $logmsg.' '.&mt('Error: ').$result."\n";
8791: } else {
8792: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
8793: ($start?', '.&mt('starting').' '.localtime($start):'').
8794: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
8795: if ($context eq 'auto') {
8796: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
8797: } else {
8798: $output .= '<b>'.$result.'</b>'.$linefeed.
8799: &mt('Add to classlist').': <b>ok</b>';
8800: }
8801: $output .= $linefeed;
8802: }
8803: } else {
8804: $output = &mt('Assigning').' '.$three.' in '.$url.
8805: ($start?', '.&mt('starting').' '.localtime($start):'').
8806: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
8807: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
8808: if ($context eq 'auto') {
8809: $output .= $result.$linefeed;
8810: } else {
8811: $output .= '<b>'.$result.'</b>'.$linefeed;
8812: }
8813: }
8814: return $output;
8815: }
8816:
8817: sub commit_studentrole {
8818: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
8819: my ($result,$linefeed,$oldsecurl,$newsecurl);
8820: if ($context eq 'auto') {
8821: $linefeed = "\n";
8822: } else {
8823: $linefeed = '<br />'."\n";
8824: }
8825: if (defined($one) && defined($two)) {
8826: my $cid=$one.'_'.$two;
8827: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
8828: my $secchange = 0;
8829: my $expire_role_result;
8830: my $modify_section_result;
8831: if ($oldsec ne '-1') {
8832: if ($oldsec ne $sec) {
8833: $secchange = 1;
8834: my $now = time;
8835: my $uurl='/'.$cid;
8836: $uurl=~s/\_/\//g;
8837: if ($oldsec) {
8838: $uurl.='/'.$oldsec;
8839: }
8840: $oldsecurl = $uurl;
8841: $expire_role_result =
8842: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
8843: if ($env{'request.course.sec'} ne '') {
8844: if ($expire_role_result eq 'refused') {
8845: my @roles = ('st');
8846: my @statuses = ('previous');
8847: my @roledoms = ($one);
8848: my $withsec = 1;
8849: my %roleshash =
8850: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
8851: \@statuses,\@roles,\@roledoms,$withsec);
8852: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
8853: my ($oldstart,$oldend) =
8854: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
8855: if ($oldend > 0 && $oldend <= $now) {
8856: $expire_role_result = 'ok';
8857: }
8858: }
8859: }
8860: }
8861: $result = $expire_role_result;
8862: }
8863: }
8864: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
8865: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
8866: if ($modify_section_result =~ /^ok/) {
8867: if ($secchange == 1) {
8868: if ($sec eq '') {
8869: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
8870: } else {
8871: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
8872: }
8873: } elsif ($oldsec eq '-1') {
8874: if ($sec eq '') {
8875: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
8876: } else {
8877: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
8878: }
8879: } else {
8880: if ($sec eq '') {
8881: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
8882: } else {
8883: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
8884: }
8885: }
8886: } else {
8887: if ($secchange) {
8888: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
8889: } else {
8890: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
8891: }
8892: }
8893: $result = $modify_section_result;
8894: } elsif ($secchange == 1) {
8895: if ($oldsec eq '') {
8896: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
8897: } else {
8898: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
8899: }
8900: if ($expire_role_result eq 'refused') {
8901: my $newsecurl = '/'.$cid;
8902: $newsecurl =~ s/\_/\//g;
8903: if ($sec ne '') {
8904: $newsecurl.='/'.$sec;
8905: }
8906: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
8907: if ($sec eq '') {
8908: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
8909: } else {
8910: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
8911: }
8912: }
8913: }
8914: }
8915: } else {
8916: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
8917: $result = "error: incomplete course id\n";
8918: }
8919: return $result;
8920: }
8921:
8922: ############################################################
8923: ############################################################
8924:
8925: sub check_clone {
8926: my ($args,$linefeed) = @_;
8927: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
8928: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
8929: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
8930: my $clonemsg;
8931: my $can_clone = 0;
8932:
8933: if ($clonehome eq 'no_host') {
8934: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
8935: } else {
8936: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
8937: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
8938: $can_clone = 1;
8939: } else {
8940: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
8941: $args->{'clonedomain'},$args->{'clonecourse'});
8942: my @cloners = split(/,/,$clonehash{'cloners'});
8943: if (grep(/^\*$/,@cloners)) {
8944: $can_clone = 1;
8945: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
8946: $can_clone = 1;
8947: } else {
8948: my %roleshash =
8949: &Apache::lonnet::get_my_roles($args->{'ccuname'},
8950: $args->{'ccdomain'},
8951: 'userroles',['active'],['cc'],
8952: [$args->{'clonedomain'}]);
8953: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
8954: $can_clone = 1;
8955: } else {
8956: $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
8957: }
8958: }
8959: }
8960: }
8961: return ($can_clone, $clonemsg, $cloneid, $clonehome);
8962: }
8963:
8964: sub construct_course {
8965: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
8966: my $outcome;
8967: my $linefeed = '<br />'."\n";
8968: if ($context eq 'auto') {
8969: $linefeed = "\n";
8970: }
8971:
8972: #
8973: # Are we cloning?
8974: #
8975: my ($can_clone, $clonemsg, $cloneid, $clonehome);
8976: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
8977: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
8978: if ($context ne 'auto') {
8979: if ($clonemsg ne '') {
8980: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
8981: }
8982: }
8983: $outcome .= $clonemsg.$linefeed;
8984:
8985: if (!$can_clone) {
8986: return (0,$outcome);
8987: }
8988: }
8989:
8990: #
8991: # Open course
8992: #
8993: my $crstype = lc($args->{'crstype'});
8994: my %cenv=();
8995: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
8996: $args->{'cdescr'},
8997: $args->{'curl'},
8998: $args->{'course_home'},
8999: $args->{'nonstandard'},
9000: $args->{'crscode'},
9001: $args->{'ccuname'}.':'.
9002: $args->{'ccdomain'},
9003: $args->{'crstype'});
9004:
9005: # Note: The testing routines depend on this being output; see
9006: # Utils::Course. This needs to at least be output as a comment
9007: # if anyone ever decides to not show this, and Utils::Course::new
9008: # will need to be suitably modified.
9009: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
9010: #
9011: # Check if created correctly
9012: #
9013: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
9014: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
9015: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
9016:
9017: #
9018: # Do the cloning
9019: #
9020: if ($can_clone && $cloneid) {
9021: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9022: if ($context ne 'auto') {
9023: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9024: }
9025: $outcome .= $clonemsg.$linefeed;
9026: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
9027: # Copy all files
9028: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
9029: # Restore URL
9030: $cenv{'url'}=$oldcenv{'url'};
9031: # Restore title
9032: $cenv{'description'}=$oldcenv{'description'};
9033: # Mark as cloned
9034: $cenv{'clonedfrom'}=$cloneid;
9035: # Need to clone grading mode
9036: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9037: $cenv{'grading'}=$newenv{'grading'};
9038: # Do not clone these environment entries
9039: &Apache::lonnet::del('environment',
9040: ['default_enrollment_start_date',
9041: 'default_enrollment_end_date',
9042: 'question.email',
9043: 'policy.email',
9044: 'comment.email',
9045: 'pch.users.denied',
9046: 'plc.users.denied'],
9047: $$crsudom,$$crsunum);
9048: }
9049:
9050: #
9051: # Set environment (will override cloned, if existing)
9052: #
9053: my @sections = ();
9054: my @xlists = ();
9055: if ($args->{'crstype'}) {
9056: $cenv{'type'}=$args->{'crstype'};
9057: }
9058: if ($args->{'crsid'}) {
9059: $cenv{'courseid'}=$args->{'crsid'};
9060: }
9061: if ($args->{'crscode'}) {
9062: $cenv{'internal.coursecode'}=$args->{'crscode'};
9063: }
9064: if ($args->{'crsquota'} ne '') {
9065: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9066: } else {
9067: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9068: }
9069: if ($args->{'ccuname'}) {
9070: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9071: ':'.$args->{'ccdomain'};
9072: } else {
9073: $cenv{'internal.courseowner'} = $args->{'curruser'};
9074: }
9075: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9076: if ($args->{'crssections'}) {
9077: $cenv{'internal.sectionnums'} = '';
9078: if ($args->{'crssections'} =~ m/,/) {
9079: @sections = split/,/,$args->{'crssections'};
9080: } else {
9081: $sections[0] = $args->{'crssections'};
9082: }
9083: if (@sections > 0) {
9084: foreach my $item (@sections) {
9085: my ($sec,$gp) = split/:/,$item;
9086: my $class = $args->{'crscode'}.$sec;
9087: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9088: $cenv{'internal.sectionnums'} .= $item.',';
9089: unless ($addcheck eq 'ok') {
9090: push @badclasses, $class;
9091: }
9092: }
9093: $cenv{'internal.sectionnums'} =~ s/,$//;
9094: }
9095: }
9096: # do not hide course coordinator from staff listing,
9097: # even if privileged
9098: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9099: # add crosslistings
9100: if ($args->{'crsxlist'}) {
9101: $cenv{'internal.crosslistings'}='';
9102: if ($args->{'crsxlist'} =~ m/,/) {
9103: @xlists = split/,/,$args->{'crsxlist'};
9104: } else {
9105: $xlists[0] = $args->{'crsxlist'};
9106: }
9107: if (@xlists > 0) {
9108: foreach my $item (@xlists) {
9109: my ($xl,$gp) = split/:/,$item;
9110: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9111: $cenv{'internal.crosslistings'} .= $item.',';
9112: unless ($addcheck eq 'ok') {
9113: push @badclasses, $xl;
9114: }
9115: }
9116: $cenv{'internal.crosslistings'} =~ s/,$//;
9117: }
9118: }
9119: if ($args->{'autoadds'}) {
9120: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9121: }
9122: if ($args->{'autodrops'}) {
9123: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9124: }
9125: # check for notification of enrollment changes
9126: my @notified = ();
9127: if ($args->{'notify_owner'}) {
9128: if ($args->{'ccuname'} ne '') {
9129: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9130: }
9131: }
9132: if ($args->{'notify_dc'}) {
9133: if ($uname ne '') {
9134: push(@notified,$uname.':'.$udom);
9135: }
9136: }
9137: if (@notified > 0) {
9138: my $notifylist;
9139: if (@notified > 1) {
9140: $notifylist = join(',',@notified);
9141: } else {
9142: $notifylist = $notified[0];
9143: }
9144: $cenv{'internal.notifylist'} = $notifylist;
9145: }
9146: if (@badclasses > 0) {
9147: my %lt=&Apache::lonlocal::texthash(
9148: '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',
9149: 'dnhr' => 'does not have rights to access enrollment in these classes',
9150: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9151: );
9152: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9153: ' ('.$lt{'adby'}.')';
9154: if ($context eq 'auto') {
9155: $outcome .= $badclass_msg.$linefeed;
9156: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
9157: foreach my $item (@badclasses) {
9158: if ($context eq 'auto') {
9159: $outcome .= " - $item\n";
9160: } else {
9161: $outcome .= "<li>$item</li>\n";
9162: }
9163: }
9164: if ($context eq 'auto') {
9165: $outcome .= $linefeed;
9166: } else {
9167: $outcome .= "</ul><br /><br /></div>\n";
9168: }
9169: }
9170: }
9171: if ($args->{'no_end_date'}) {
9172: $args->{'endaccess'} = 0;
9173: }
9174: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9175: $cenv{'internal.autoend'}=$args->{'enrollend'};
9176: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9177: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9178: if ($args->{'showphotos'}) {
9179: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9180: }
9181: $cenv{'internal.authtype'} = $args->{'authtype'};
9182: $cenv{'internal.autharg'} = $args->{'autharg'};
9183: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9184: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
9185: 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');
9186: if ($context eq 'auto') {
9187: $outcome .= $krb_msg;
9188: } else {
9189: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
9190: }
9191: $outcome .= $linefeed;
9192: }
9193: }
9194: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9195: if ($args->{'setpolicy'}) {
9196: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9197: }
9198: if ($args->{'setcontent'}) {
9199: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9200: }
9201: }
9202: if ($args->{'reshome'}) {
9203: $cenv{'reshome'}=$args->{'reshome'}.'/';
9204: $cenv{'reshome'}=~s/\/+$/\//;
9205: }
9206: #
9207: # course has keyed access
9208: #
9209: if ($args->{'setkeys'}) {
9210: $cenv{'keyaccess'}='yes';
9211: }
9212: # if specified, key authority is not course, but user
9213: # only active if keyaccess is yes
9214: if ($args->{'keyauth'}) {
9215: my ($user,$domain) = split(':',$args->{'keyauth'});
9216: $user = &LONCAPA::clean_username($user);
9217: $domain = &LONCAPA::clean_username($domain);
9218: if ($user ne '' && $domain ne '') {
9219: $cenv{'keyauth'}=$user.':'.$domain;
9220: }
9221: }
9222:
9223: if ($args->{'disresdis'}) {
9224: $cenv{'pch.roles.denied'}='st';
9225: }
9226: if ($args->{'disablechat'}) {
9227: $cenv{'plc.roles.denied'}='st';
9228: }
9229:
9230: # Record we've not yet viewed the Course Initialization Helper for this
9231: # course
9232: $cenv{'course.helper.not.run'} = 1;
9233: #
9234: # Use new Randomseed
9235: #
9236: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9237: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9238: #
9239: # The encryption code and receipt prefix for this course
9240: #
9241: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9242: $cenv{'internal.encpref'}=100+int(9*rand(99));
9243: #
9244: # By default, use standard grading
9245: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9246:
9247: $outcome .= $linefeed.&mt('Setting environment').': '.
9248: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
9249: #
9250: # Open all assignments
9251: #
9252: if ($args->{'openall'}) {
9253: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9254: my %storecontent = ($storeunder => time,
9255: $storeunder.'.type' => 'date_start');
9256:
9257: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
9258: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
9259: }
9260: #
9261: # Set first page
9262: #
9263: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9264: || ($cloneid)) {
9265: use LONCAPA::map;
9266: $outcome .= &mt('Setting first resource').': ';
9267:
9268: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9269: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9270:
9271: $outcome .= ($fatal?$errtext:'read ok').' - ';
9272: my $title; my $url;
9273: if ($args->{'firstres'} eq 'syl') {
9274: $title=&mt('Syllabus');
9275: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9276: } else {
9277: $title=&mt('Navigate Contents');
9278: $url='/adm/navmaps';
9279: }
9280:
9281: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9282: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9283:
9284: if ($errtext) { $fatal=2; }
9285: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
9286: }
9287:
9288: return (1,$outcome);
9289: }
9290:
9291: ############################################################
9292: ############################################################
9293:
9294: sub course_type {
9295: my ($cid) = @_;
9296: if (!defined($cid)) {
9297: $cid = $env{'request.course.id'};
9298: }
9299: if (defined($env{'course.'.$cid.'.type'})) {
9300: return $env{'course.'.$cid.'.type'};
9301: } else {
9302: return 'Course';
9303: }
9304: }
9305:
9306: sub group_term {
9307: my $crstype = &course_type();
9308: my %names = (
9309: 'Course' => 'group',
9310: 'Group' => 'team',
9311: );
9312: return $names{$crstype};
9313: }
9314:
9315: sub icon {
9316: my ($file)=@_;
9317: my $curfext = lc((split(/\./,$file))[-1]);
9318: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
9319: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
9320: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9321: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9322: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9323: $curfext.".gif") {
9324: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9325: $curfext.".gif";
9326: }
9327: }
9328: return &lonhttpdurl($iconname);
9329: }
9330:
9331: sub lonhttpdurl {
9332: #
9333: # Had been used for "small fry" static images on separate port 8080.
9334: # Modify here if lightweight http functionality desired again.
9335: # Currently eliminated due to increasing firewall issues.
9336: #
9337: my ($url)=@_;
9338: return $url;
9339: }
9340:
9341: sub connection_aborted {
9342: my ($r)=@_;
9343: $r->print(" ");$r->rflush();
9344: my $c = $r->connection;
9345: return $c->aborted();
9346: }
9347:
9348: # Escapes strings that may have embedded 's that will be put into
9349: # strings as 'strings'.
9350: sub escape_single {
9351: my ($input) = @_;
9352: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
9353: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9354: return $input;
9355: }
9356:
9357: # Same as escape_single, but escape's "'s This
9358: # can be used for "strings"
9359: sub escape_double {
9360: my ($input) = @_;
9361: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9362: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9363: return $input;
9364: }
9365:
9366: # Escapes the last element of a full URL.
9367: sub escape_url {
9368: my ($url) = @_;
9369: my @urlslices = split(/\//, $url,-1);
9370: my $lastitem = &escape(pop(@urlslices));
9371: return join('/',@urlslices).'/'.$lastitem;
9372: }
9373:
9374: # -------------------------------------------------------- Initliaze user login
9375: sub init_user_environment {
9376: my ($r, $username, $domain, $authhost, $form, $args) = @_;
9377: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9378:
9379: my $public=($username eq 'public' && $domain eq 'public');
9380:
9381: # See if old ID present, if so, remove
9382:
9383: my ($filename,$cookie,$userroles);
9384: my $now=time;
9385:
9386: if ($public) {
9387: my $max_public=100;
9388: my $oldest;
9389: my $oldest_time=0;
9390: for(my $next=1;$next<=$max_public;$next++) {
9391: if (-e $lonids."/publicuser_$next.id") {
9392: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9393: if ($mtime<$oldest_time || !$oldest_time) {
9394: $oldest_time=$mtime;
9395: $oldest=$next;
9396: }
9397: } else {
9398: $cookie="publicuser_$next";
9399: last;
9400: }
9401: }
9402: if (!$cookie) { $cookie="publicuser_$oldest"; }
9403: } else {
9404: # if this isn't a robot, kill any existing non-robot sessions
9405: if (!$args->{'robot'}) {
9406: opendir(DIR,$lonids);
9407: while ($filename=readdir(DIR)) {
9408: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9409: unlink($lonids.'/'.$filename);
9410: }
9411: }
9412: closedir(DIR);
9413: }
9414: # Give them a new cookie
9415: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
9416: : $now.$$.int(rand(10000)));
9417: $cookie="$username\_$id\_$domain\_$authhost";
9418:
9419: # Initialize roles
9420:
9421: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9422: }
9423: # ------------------------------------ Check browser type and MathML capability
9424:
9425: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9426: $clientunicode,$clientos) = &decode_user_agent($r);
9427:
9428: # -------------------------------------- Any accessibility options to remember?
9429: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9430: foreach my $option ('imagesuppress','appletsuppress',
9431: 'embedsuppress','fontenhance','blackwhite') {
9432: if ($form->{$option} eq 'true') {
9433: &Apache::lonnet::put('environment',{$option => 'on'},
9434: $domain,$username);
9435: } else {
9436: &Apache::lonnet::del('environment',[$option],
9437: $domain,$username);
9438: }
9439: }
9440: }
9441: # ------------------------------------------------------------- Get environment
9442:
9443: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9444: my ($tmp) = keys(%userenv);
9445: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9446: # default remote control to off
9447: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9448: } else {
9449: undef(%userenv);
9450: }
9451: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9452: $form->{'interface'}=$userenv{'interface'};
9453: }
9454: $env{'environment.remote'}=$userenv{'remote'};
9455: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9456:
9457: # --------------- Do not trust query string to be put directly into environment
9458: foreach my $option ('imagesuppress','appletsuppress',
9459: 'embedsuppress','fontenhance','blackwhite',
9460: 'interface','localpath','localres') {
9461: $form->{$option}=~s/[\n\r\=]//gs;
9462: }
9463: # --------------------------------------------------------- Write first profile
9464:
9465: {
9466: my %initial_env =
9467: ("user.name" => $username,
9468: "user.domain" => $domain,
9469: "user.home" => $authhost,
9470: "browser.type" => $clientbrowser,
9471: "browser.version" => $clientversion,
9472: "browser.mathml" => $clientmathml,
9473: "browser.unicode" => $clientunicode,
9474: "browser.os" => $clientos,
9475: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9476: "request.course.fn" => '',
9477: "request.course.uri" => '',
9478: "request.course.sec" => '',
9479: "request.role" => 'cm',
9480: "request.role.adv" => $env{'user.adv'},
9481: "request.host" => $ENV{'REMOTE_ADDR'},);
9482:
9483: if ($form->{'localpath'}) {
9484: $initial_env{"browser.localpath"} = $form->{'localpath'};
9485: $initial_env{"browser.localres"} = $form->{'localres'};
9486: }
9487:
9488: if ($public) {
9489: $initial_env{"environment.remote"} = "off";
9490: }
9491: if ($form->{'interface'}) {
9492: $form->{'interface'}=~s/\W//gs;
9493: $initial_env{"browser.interface"} = $form->{'interface'};
9494: $env{'browser.interface'}=$form->{'interface'};
9495: foreach my $option ('imagesuppress','appletsuppress',
9496: 'embedsuppress','fontenhance','blackwhite') {
9497: if (($form->{$option} eq 'true') ||
9498: ($userenv{$option} eq 'on')) {
9499: $initial_env{"browser.$option"} = "on";
9500: }
9501: }
9502: }
9503:
9504: $env{'user.environment'} = "$lonids/$cookie.id";
9505:
9506: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9507: &GDBM_WRCREAT(),0640)) {
9508: &_add_to_env(\%disk_env,\%initial_env);
9509: &_add_to_env(\%disk_env,\%userenv,'environment.');
9510: &_add_to_env(\%disk_env,$userroles);
9511: if (ref($args->{'extra_env'})) {
9512: &_add_to_env(\%disk_env,$args->{'extra_env'});
9513: }
9514: untie(%disk_env);
9515: } else {
9516: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
9517: 'Could not create environment storage in lonauth: '.$!.'</font>');
9518: return 'error: '.$!;
9519: }
9520: }
9521: $env{'request.role'}='cm';
9522: $env{'request.role.adv'}=$env{'user.adv'};
9523: $env{'browser.type'}=$clientbrowser;
9524:
9525: return $cookie;
9526:
9527: }
9528:
9529: sub _add_to_env {
9530: my ($idf,$env_data,$prefix) = @_;
9531: if (ref($env_data) eq 'HASH') {
9532: while (my ($key,$value) = each(%$env_data)) {
9533: $idf->{$prefix.$key} = $value;
9534: $env{$prefix.$key} = $value;
9535: }
9536: }
9537: }
9538:
9539: # --- Get the symbolic name of a problem and the url
9540: sub get_symb {
9541: my ($request,$silent) = @_;
9542: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9543: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9544: if ($symb eq '') {
9545: if (!$silent) {
9546: $request->print("Unable to handle ambiguous references:$url:.");
9547: return ();
9548: }
9549: }
9550: &Apache::lonenc::check_decrypt(\$symb);
9551: return ($symb);
9552: }
9553:
9554: # --------------------------------------------------------------Get annotation
9555:
9556: sub get_annotation {
9557: my ($symb,$enc) = @_;
9558:
9559: my $key = $symb;
9560: if (!$enc) {
9561: $key =
9562: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9563: }
9564: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9565: return $annotation{$key};
9566: }
9567:
9568: sub clean_symb {
9569: my ($symb) = @_;
9570:
9571: &Apache::lonenc::check_decrypt(\$symb);
9572: my $enc = $env{'request.enc'};
9573: delete($env{'request.enc'});
9574:
9575: return ($symb,$enc);
9576: }
9577:
9578: =pod
9579:
9580: =back
9581:
9582: =cut
9583:
9584: 1;
9585: __END__;
9586:
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