1: # The LearningOnline Network with CAPA
2: # a pile of common routines
3: #
4: # $Id: loncommon.pm,v 1.925.2.10 2010/01/18 15:44:35 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28:
29: # Makes a table out of the previous attempts
30: # Inputs result_from_symbread, user, domain, course_id
31: # Reads in non-network-related .tab files
32:
33: # POD header:
34:
35: =pod
36:
37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
45:
46: =head1 OVERVIEW
47:
48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
55: package Apache::loncommon;
56:
57: use strict;
58: use Apache::lonnet;
59: use GDBM_File;
60: use POSIX qw(strftime mktime);
61: use Apache::lonmenu();
62: use Apache::lonenc();
63: use Apache::lonlocal;
64: use 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: "<span style='color:yellow;'>INFO: Read file types</span>");
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: // <![CDATA[
411: var stdeditbrowser;
412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
413: var url = '/adm/pickstudent?';
414: var filter;
415: if (!ignorefilter) {
416: eval('filter=document.'+formname+'.'+uname+'.value;');
417: }
418: if (filter != null) {
419: if (filter != '') {
420: url += 'filter='+filter+'&';
421: }
422: }
423: url += 'form=' + formname + '&unameelement='+uname+
424: '&udomelement='+udom;
425: if (roleflag) { url+="&roles=1"; }
426: if (courseadvonly) { url+="&courseadvonly=1"; }
427: var title = 'Student_Browser';
428: var options = 'scrollbars=1,resizable=1,menubar=0';
429: options += ',width=700,height=600';
430: stdeditbrowser = open(url,title,options,'1');
431: stdeditbrowser.focus();
432: }
433: // ]]>
434: </script>
435: ENDSTDBRW
436: }
437:
438: sub selectstudent_link {
439: my ($form,$unameele,$udomele,$courseadvonly)=@_;
440: my $callargs = "'".$form."','".$unameele."','".$udomele."'";
441: if ($env{'request.course.id'}) {
442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
444: '/'.$env{'request.course.sec'})) {
445: return '';
446: }
447: if ($courseadvonly) {
448: $callargs .= ",'',1,1";
449: }
450: return '<span class="LC_nobreak">'.
451: '<a href="javascript:openstdbrowser('.$callargs.');">'.
452: &mt('Select User').'</a></span>';
453: }
454: if ($env{'request.role'}=~/^(au|dc|su)/) {
455: $callargs .= ",1";
456: return '<span class="LC_nobreak">'.
457: '<a href="javascript:openstdbrowser('.$callargs.');">'.
458: &mt('Select User').'</a></span>';
459: }
460: return '';
461: }
462:
463: sub authorbrowser_javascript {
464: return <<"ENDAUTHORBRW";
465: <script type="text/javascript" language="JavaScript">
466: // <![CDATA[
467: var stdeditbrowser;
468:
469: function openauthorbrowser(formname,udom) {
470: var url = '/adm/pickauthor?';
471: url += 'form='+formname+'&roledom='+udom;
472: var title = 'Author_Browser';
473: var options = 'scrollbars=1,resizable=1,menubar=0';
474: options += ',width=700,height=600';
475: stdeditbrowser = open(url,title,options,'1');
476: stdeditbrowser.focus();
477: }
478:
479: // ]]>
480: </script>
481: ENDAUTHORBRW
482: }
483:
484: sub coursebrowser_javascript {
485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
486: my $wintitle = &mt('Course Browser');
487: if ($crstype ne '') {
488: $wintitle = &mt($crstype);
489: }
490: my $id_functions = &javascript_index_functions();
491: my $output = '
492: <script type="text/javascript" language="JavaScript">
493: // <![CDATA[
494: var stdeditbrowser;'."\n";
495:
496: $output .= <<"ENDSTDBRW";
497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
498: var url = '/adm/pickcourse?';
499: var formid = getFormIdByName(formname);
500: var domainfilter = getDomainFromSelectbox(formname,udom);
501: if (domainfilter != null) {
502: if (domainfilter != '') {
503: url += 'domainfilter='+domainfilter+'&';
504: }
505: }
506: url += 'form=' + formname + '&cnumelement='+uname+
507: '&cdomelement='+udom+
508: '&cnameelement='+desc;
509: if (extra_element !=null && extra_element != '') {
510: if (formname == 'rolechoice' || formname == 'studentform') {
511: url += '&roleelement='+extra_element;
512: if (domainfilter == null || domainfilter == '') {
513: url += '&domainfilter='+extra_element;
514: }
515: }
516: else {
517: if (formname == 'portform') {
518: url += '&setroles='+extra_element;
519: } else {
520: if (formname == 'rules') {
521: url += '&fixeddom='+extra_element;
522: }
523: }
524: }
525: }
526: if (type != null && type != '') {
527: url += '&type='+type;
528: }
529: if (type_elem != null && type_elem != '') {
530: url += '&typeelement='+type_elem;
531: }
532: if (formname == 'ccrs') {
533: var ownername = document.forms[formid].ccuname.value;
534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
535: url += '&cloner='+ownername+':'+ownerdom;
536: }
537: if (multflag !=null && multflag != '') {
538: url += '&multiple='+multflag;
539: }
540: var title = '$wintitle';
541: var options = 'scrollbars=1,resizable=1,menubar=0';
542: options += ',width=700,height=600';
543: stdeditbrowser = open(url,title,options,'1');
544: stdeditbrowser.focus();
545: }
546: $id_functions
547: ENDSTDBRW
548: if (($sec_element ne '') || ($role_element ne '')) {
549: $output .= &setsec_javascript($sec_element,$formname,$role_element);
550: }
551: $output .= '
552: // ]]>
553: </script>';
554: return $output;
555: }
556:
557: sub javascript_index_functions {
558: return <<"ENDJS";
559:
560: function getFormIdByName(formname) {
561: for (var i=0;i<document.forms.length;i++) {
562: if (document.forms[i].name == formname) {
563: return i;
564: }
565: }
566: return -1;
567: }
568:
569: function getIndexByName(formid,item) {
570: for (var i=0;i<document.forms[formid].elements.length;i++) {
571: if (document.forms[formid].elements[i].name == item) {
572: return i;
573: }
574: }
575: return -1;
576: }
577:
578: function getDomainFromSelectbox(formname,udom) {
579: var userdom;
580: var formid = getFormIdByName(formname);
581: if (formid > -1) {
582: var domid = getIndexByName(formid,udom);
583: if (domid > -1) {
584: if (document.forms[formid].elements[domid].type == 'select-one') {
585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
586: }
587: if (document.forms[formid].elements[domid].type == 'hidden') {
588: userdom=document.forms[formid].elements[domid].value;
589: }
590: }
591: }
592: return userdom;
593: }
594:
595: ENDJS
596:
597: }
598:
599: sub userbrowser_javascript {
600: my $id_functions = &javascript_index_functions();
601: return <<"ENDUSERBRW";
602:
603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
604: var url = '/adm/pickuser?';
605: var userdom = getDomainFromSelectbox(formname,udom);
606: if (userdom != null) {
607: if (userdom != '') {
608: url += 'srchdom='+userdom+'&';
609: }
610: }
611: url += 'form=' + formname + '&unameelement='+uname+
612: '&udomelement='+udom+
613: '&ulastelement='+ulast+
614: '&ufirstelement='+ufirst+
615: '&uemailelement='+uemail+
616: '&hideudomelement='+hideudom+
617: '&coursedom='+crsdom;
618: if ((caller != null) && (caller != undefined)) {
619: url += '&caller='+caller;
620: }
621: var title = 'User_Browser';
622: var options = 'scrollbars=1,resizable=1,menubar=0';
623: options += ',width=700,height=600';
624: var stdeditbrowser = open(url,title,options,'1');
625: stdeditbrowser.focus();
626: }
627:
628: function fix_domain (formname,udom,origdom,uname) {
629: var formid = getFormIdByName(formname);
630: if (formid > -1) {
631: var unameid = getIndexByName(formid,uname);
632: var domid = getIndexByName(formid,udom);
633: var hidedomid = getIndexByName(formid,origdom);
634: if (hidedomid > -1) {
635: var fixeddom = document.forms[formid].elements[hidedomid].value;
636: var unameval = document.forms[formid].elements[unameid].value;
637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
638: if (domid > -1) {
639: var slct = document.forms[formid].elements[domid];
640: if (slct.type == 'select-one') {
641: var i;
642: for (i=0;i<slct.length;i++) {
643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
644: }
645: }
646: if (slct.type == 'hidden') {
647: slct.value = fixeddom;
648: }
649: }
650: }
651: }
652: }
653: return;
654: }
655:
656: $id_functions
657: ENDUSERBRW
658: }
659:
660: sub setsec_javascript {
661: my ($sec_element,$formname,$role_element) = @_;
662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
663: $communityrolestr);
664: if ($role_element ne '') {
665: my @allroles = ('st','ta','ep','in','ad');
666: foreach my $crstype ('Course','Community') {
667: if ($crstype eq 'Community') {
668: foreach my $role (@allroles) {
669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
670: }
671: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
672: } else {
673: foreach my $role (@allroles) {
674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
675: }
676: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
677: }
678: }
679: $rolestr = '"'.join('","',@allroles).'"';
680: $courserolestr = '"'.join('","',@courserolenames).'"';
681: $communityrolestr = '"'.join('","',@communityrolenames).'"';
682: }
683: my $setsections = qq|
684: function setSect(sectionlist) {
685: var sectionsArray = new Array();
686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
687: sectionsArray = sectionlist.split(",");
688: }
689: var numSections = sectionsArray.length;
690: document.$formname.$sec_element.length = 0;
691: if (numSections == 0) {
692: document.$formname.$sec_element.multiple=false;
693: document.$formname.$sec_element.size=1;
694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
695: } else {
696: if (numSections == 1) {
697: document.$formname.$sec_element.multiple=false;
698: document.$formname.$sec_element.size=1;
699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
702: } else {
703: for (var i=0; i<numSections; i++) {
704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
705: }
706: document.$formname.$sec_element.multiple=true
707: if (numSections < 3) {
708: document.$formname.$sec_element.size=numSections;
709: } else {
710: document.$formname.$sec_element.size=3;
711: }
712: document.$formname.$sec_element.options[0].selected = false
713: }
714: }
715: }
716:
717: function setRole(crstype) {
718: |;
719: if ($role_element eq '') {
720: $setsections .= ' return;
721: }
722: ';
723: } else {
724: $setsections .= qq|
725: var elementLength = document.$formname.$role_element.length;
726: var allroles = Array($rolestr);
727: var courserolenames = Array($courserolestr);
728: var communityrolenames = Array($communityrolestr);
729: if (elementLength != undefined) {
730: if (document.$formname.$role_element.options[5].value == 'cc') {
731: if (crstype == 'Course') {
732: return;
733: } else {
734: allroles[5] = 'co';
735: for (var i=0; i<6; i++) {
736: document.$formname.$role_element.options[i].value = allroles[i];
737: document.$formname.$role_element.options[i].text = communityrolenames[i];
738: }
739: }
740: } else {
741: if (crstype == 'Community') {
742: return;
743: } else {
744: allroles[5] = 'cc';
745: for (var i=0; i<6; i++) {
746: document.$formname.$role_element.options[i].value = allroles[i];
747: document.$formname.$role_element.options[i].text = courserolenames[i];
748: }
749: }
750: }
751: }
752: return;
753: }
754: |;
755: }
756: return $setsections;
757: }
758:
759: sub selectcourse_link {
760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
761: $typeelement) = @_;
762: my $type = $selecttype;
763: my $linktext = &mt('Select Course');
764: if ($selecttype eq 'Community') {
765: $linktext = &mt('Select Community');
766: } elsif ($selecttype eq 'Course/Community') {
767: $linktext = &mt('Select Course/Community');
768: $type = '';
769: }
770: return '<span class="LC_nobreak">'
771: ."<a href='"
772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
773: .'","'.$udomele.'","'.$desc.'","'.$extra_element
774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
775: ."'>".$linktext.'</a>'
776: .'</span>';
777: }
778:
779: sub selectauthor_link {
780: my ($form,$udom)=@_;
781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
782: &mt('Select Author').'</a>';
783: }
784:
785: sub selectuser_link {
786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
787: $coursedom,$linktext,$caller) = @_;
788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
790: ');">'.$linktext.'</a>';
791: }
792:
793: sub check_uncheck_jscript {
794: my $jscript = <<"ENDSCRT";
795: function checkAll(field) {
796: if (field.length > 0) {
797: for (i = 0; i < field.length; i++) {
798: field[i].checked = true ;
799: }
800: } else {
801: field.checked = true
802: }
803: }
804:
805: function uncheckAll(field) {
806: if (field.length > 0) {
807: for (i = 0; i < field.length; i++) {
808: field[i].checked = false ;
809: }
810: } else {
811: field.checked = false ;
812: }
813: }
814: ENDSCRT
815: return $jscript;
816: }
817:
818: sub select_timezone {
819: my ($name,$selected,$onchange,$includeempty)=@_;
820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
821: if ($includeempty) {
822: $output .= '<option value=""';
823: if (($selected eq '') || ($selected eq 'local')) {
824: $output .= ' selected="selected" ';
825: }
826: $output .= '> </option>';
827: }
828: my @timezones = DateTime::TimeZone->all_names;
829: foreach my $tzone (@timezones) {
830: $output.= '<option value="'.$tzone.'"';
831: if ($tzone eq $selected) {
832: $output.=' selected="selected"';
833: }
834: $output.=">$tzone</option>\n";
835: }
836: $output.="</select>";
837: return $output;
838: }
839:
840: sub select_datelocale {
841: my ($name,$selected,$onchange,$includeempty)=@_;
842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
843: if ($includeempty) {
844: $output .= '<option value=""';
845: if ($selected eq '') {
846: $output .= ' selected="selected" ';
847: }
848: $output .= '> </option>';
849: }
850: my (@possibles,%locale_names);
851: my @locales = DateTime::Locale::Catalog::Locales;
852: foreach my $locale (@locales) {
853: if (ref($locale) eq 'HASH') {
854: my $id = $locale->{'id'};
855: if ($id ne '') {
856: my $en_terr = $locale->{'en_territory'};
857: my $native_terr = $locale->{'native_territory'};
858: my @languages = &Apache::lonlocal::preferred_languages();
859: if (grep(/^en$/,@languages) || !@languages) {
860: if ($en_terr ne '') {
861: $locale_names{$id} = '('.$en_terr.')';
862: } elsif ($native_terr ne '') {
863: $locale_names{$id} = $native_terr;
864: }
865: } else {
866: if ($native_terr ne '') {
867: $locale_names{$id} = $native_terr.' ';
868: } elsif ($en_terr ne '') {
869: $locale_names{$id} = '('.$en_terr.')';
870: }
871: }
872: push (@possibles,$id);
873: }
874: }
875: }
876: foreach my $item (sort(@possibles)) {
877: $output.= '<option value="'.$item.'"';
878: if ($item eq $selected) {
879: $output.=' selected="selected"';
880: }
881: $output.=">$item";
882: if ($locale_names{$item} ne '') {
883: $output.=" $locale_names{$item}</option>\n";
884: }
885: $output.="</option>\n";
886: }
887: $output.="</select>";
888: return $output;
889: }
890:
891: sub select_language {
892: my ($name,$selected,$includeempty) = @_;
893: my %langchoices;
894: if ($includeempty) {
895: %langchoices = ('' => 'No language preference');
896: }
897: foreach my $id (&languageids()) {
898: my $code = &supportedlanguagecode($id);
899: if ($code) {
900: $langchoices{$code} = &plainlanguagedescription($id);
901: }
902: }
903: return &select_form($selected,$name,%langchoices);
904: }
905:
906: =pod
907:
908: =item * &linked_select_forms(...)
909:
910: linked_select_forms returns a string containing a <script></script> block
911: and html for two <select> menus. The select menus will be linked in that
912: changing the value of the first menu will result in new values being placed
913: in the second menu. The values in the select menu will appear in alphabetical
914: order unless a defined order is provided.
915:
916: linked_select_forms takes the following ordered inputs:
917:
918: =over 4
919:
920: =item * $formname, the name of the <form> tag
921:
922: =item * $middletext, the text which appears between the <select> tags
923:
924: =item * $firstdefault, the default value for the first menu
925:
926: =item * $firstselectname, the name of the first <select> tag
927:
928: =item * $secondselectname, the name of the second <select> tag
929:
930: =item * $hashref, a reference to a hash containing the data for the menus.
931:
932: =item * $menuorder, the order of values in the first menu
933:
934: =back
935:
936: Below is an example of such a hash. Only the 'text', 'default', and
937: 'select2' keys must appear as stated. keys(%menu) are the possible
938: values for the first select menu. The text that coincides with the
939: first menu value is given in $menu{$choice1}->{'text'}. The values
940: and text for the second menu are given in the hash pointed to by
941: $menu{$choice1}->{'select2'}.
942:
943: my %menu = ( A1 => { text =>"Choice A1" ,
944: default => "B3",
945: select2 => {
946: B1 => "Choice B1",
947: B2 => "Choice B2",
948: B3 => "Choice B3",
949: B4 => "Choice B4"
950: },
951: order => ['B4','B3','B1','B2'],
952: },
953: A2 => { text =>"Choice A2" ,
954: default => "C2",
955: select2 => {
956: C1 => "Choice C1",
957: C2 => "Choice C2",
958: C3 => "Choice C3"
959: },
960: order => ['C2','C1','C3'],
961: },
962: A3 => { text =>"Choice A3" ,
963: default => "D6",
964: select2 => {
965: D1 => "Choice D1",
966: D2 => "Choice D2",
967: D3 => "Choice D3",
968: D4 => "Choice D4",
969: D5 => "Choice D5",
970: D6 => "Choice D6",
971: D7 => "Choice D7"
972: },
973: order => ['D4','D3','D2','D1','D7','D6','D5'],
974: }
975: );
976:
977: =cut
978:
979: sub linked_select_forms {
980: my ($formname,
981: $middletext,
982: $firstdefault,
983: $firstselectname,
984: $secondselectname,
985: $hashref,
986: $menuorder,
987: ) = @_;
988: my $second = "document.$formname.$secondselectname";
989: my $first = "document.$formname.$firstselectname";
990: # output the javascript to do the changing
991: my $result = '';
992: $result.='<script type="text/javascript" language="JavaScript">'."\n";
993: $result.="// <![CDATA[\n";
994: $result.="var select2data = new Object();\n";
995: $" = '","';
996: my $debug = '';
997: foreach my $s1 (sort(keys(%$hashref))) {
998: $result.="select2data.d_$s1 = new Object();\n";
999: $result.="select2data.d_$s1.def = new String('".
1000: $hashref->{$s1}->{'default'}."');\n";
1001: $result.="select2data.d_$s1.values = new Array(";
1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1004: @s2values = @{$hashref->{$s1}->{'order'}};
1005: }
1006: $result.="\"@s2values\");\n";
1007: $result.="select2data.d_$s1.texts = new Array(";
1008: my @s2texts;
1009: foreach my $value (@s2values) {
1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
1011: }
1012: $result.="\"@s2texts\");\n";
1013: }
1014: $"=' ';
1015: $result.= <<"END";
1016:
1017: function select1_changed() {
1018: // Determine new choice
1019: var newvalue = "d_" + $first.value;
1020: // update select2
1021: var values = select2data[newvalue].values;
1022: var texts = select2data[newvalue].texts;
1023: var select2def = select2data[newvalue].def;
1024: var i;
1025: // out with the old
1026: for (i = 0; i < $second.options.length; i++) {
1027: $second.options[i] = null;
1028: }
1029: // in with the nuclear
1030: for (i=0;i<values.length; i++) {
1031: $second.options[i] = new Option(values[i]);
1032: $second.options[i].value = values[i];
1033: $second.options[i].text = texts[i];
1034: if (values[i] == select2def) {
1035: $second.options[i].selected = true;
1036: }
1037: }
1038: }
1039: // ]]>
1040: </script>
1041: END
1042: # output the initial values for the selection lists
1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1044: my @order = sort(keys(%{$hashref}));
1045: if (ref($menuorder) eq 'ARRAY') {
1046: @order = @{$menuorder};
1047: }
1048: foreach my $value (@order) {
1049: $result.=" <option value=\"$value\" ";
1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1052: }
1053: $result .= "</select>\n";
1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1055: $result .= $middletext;
1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
1057: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1058:
1059: my @secondorder = sort(keys(%select2));
1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1062: }
1063: foreach my $value (@secondorder) {
1064: $result.=" <option value=\"$value\" ";
1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1066: $result.=">".&mt($select2{$value})."</option>\n";
1067: }
1068: $result .= "</select>\n";
1069: # return $debug;
1070: return $result;
1071: } # end of sub linked_select_forms {
1072:
1073: =pod
1074:
1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1076:
1077: Returns a string corresponding to an HTML link to the given help
1078: $topic, where $topic corresponds to the name of a .tex file in
1079: /home/httpd/html/adm/help/tex, with underscores replaced by
1080: spaces.
1081:
1082: $text will optionally be linked to the same topic, allowing you to
1083: link text in addition to the graphic. If you do not want to link
1084: text, but wish to specify one of the later parameters, pass an
1085: empty string.
1086:
1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
1088: the link will not open a new window. If false, the link will open
1089: a new window using Javascript. (Default is false.)
1090:
1091: $width and $height are optional numerical parameters that will
1092: override the width and height of the popped up window, which may
1093: be useful for certain help topics with big pictures included.
1094:
1095: =cut
1096:
1097: sub help_open_topic {
1098: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1099: $text = "" if (not defined $text);
1100: $stayOnPage = 0 if (not defined $stayOnPage);
1101: $width = 350 if (not defined $width);
1102: $height = 400 if (not defined $height);
1103: my $filename = $topic;
1104: $filename =~ s/ /_/g;
1105:
1106: my $template = "";
1107: my $link;
1108:
1109: $topic=~s/\W/\_/g;
1110:
1111: if (!$stayOnPage) {
1112: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1113: } else {
1114: $link = "/adm/help/${filename}.hlp";
1115: }
1116:
1117: # Add the text
1118: if ($text ne "") {
1119: $template.='<span class="LC_help_open_topic">'
1120: .'<a target="_top" href="'.$link.'">'
1121: .$text.'</a>';
1122: }
1123:
1124: # (Always) Add the graphic
1125: my $title = &mt('Online Help');
1126: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1127: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1128: .'<img src="'.$helpicon.'" border="0"'
1129: .' alt="'.&mt('Help: [_1]',$topic).'"'
1130: .' title="'.$title.'"'
1131: .' /></a>';
1132: if ($text ne "") {
1133: $template.='</span>';
1134: }
1135: return $template;
1136:
1137: }
1138:
1139: # This is a quicky function for Latex cheatsheet editing, since it
1140: # appears in at least four places
1141: sub helpLatexCheatsheet {
1142: my ($topic,$text,$not_author) = @_;
1143: my $out;
1144: my $addOther = '';
1145: if ($topic) {
1146: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
1147: undef, undef, 600).
1148: '</span> ';
1149: }
1150: $out = '<span>' # Start cheatsheet
1151: .$addOther
1152: .'<span>'
1153: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
1154: undef,undef,600)
1155: .'</span> <span>'
1156: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
1157: undef,undef,600)
1158: .'</span>';
1159: unless ($not_author) {
1160: $out .= ' <span>'
1161: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
1162: undef,undef,600)
1163: .'</span>';
1164: }
1165: $out .= '</span>'; # End cheatsheet
1166: return $out;
1167: }
1168:
1169: sub general_help {
1170: my $helptopic='Student_Intro';
1171: if ($env{'request.role'}=~/^(ca|au)/) {
1172: $helptopic='Authoring_Intro';
1173: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1174: $helptopic='Course_Coordination_Intro';
1175: } elsif ($env{'request.role'}=~/^dc/) {
1176: $helptopic='Domain_Coordination_Intro';
1177: }
1178: return $helptopic;
1179: }
1180:
1181: sub update_help_link {
1182: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1183: my $origurl = $ENV{'REQUEST_URI'};
1184: $origurl=~s|^/~|/priv/|;
1185: my $timestamp = time;
1186: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1187: $$datum = &escape($$datum);
1188: }
1189:
1190: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1191: my $output .= <<"ENDOUTPUT";
1192: <script type="text/javascript">
1193: // <![CDATA[
1194: banner_link = '$banner_link';
1195: // ]]>
1196: </script>
1197: ENDOUTPUT
1198: return $output;
1199: }
1200:
1201: # now just updates the help link and generates a blue icon
1202: sub help_open_menu {
1203: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1204: = @_;
1205: $stayOnPage = 0 if (not defined $stayOnPage);
1206: # only use pop-up help (stayOnPage == 0)
1207: # if environment.remote is on (using remote control UI)
1208: if ($env{'environment.remote'} eq 'off' ) {
1209: $stayOnPage=1;
1210: }
1211: my $output;
1212: if ($component_help) {
1213: if (!$text) {
1214: $output=&help_open_topic($component_help,undef,$stayOnPage,
1215: $width,$height);
1216: } else {
1217: my $help_text;
1218: $help_text=&unescape($topic);
1219: $output='<table><tr><td>'.
1220: &help_open_topic($component_help,$help_text,$stayOnPage,
1221: $width,$height).'</td></tr></table>';
1222: }
1223: }
1224: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1225: return $output.$banner_link;
1226: }
1227:
1228: sub top_nav_help {
1229: my ($text) = @_;
1230: $text = &mt($text);
1231: my $stay_on_page =
1232: ($env{'environment.remote'} eq 'off' );
1233: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1234: : "javascript:helpMenu('open')";
1235: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1236:
1237: my $title = &mt('Get help');
1238:
1239: return <<"END";
1240: $banner_link
1241: <a href="$link" title="$title">$text</a>
1242: END
1243: }
1244:
1245: sub help_menu_js {
1246: my ($text) = @_;
1247:
1248: my $stayOnPage =
1249: ($env{'environment.remote'} eq 'off' );
1250:
1251: my $width = 620;
1252: my $height = 600;
1253: my $helptopic=&general_help();
1254: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1255: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1256: my $start_page =
1257: &Apache::loncommon::start_page('Help Menu', undef,
1258: {'frameset' => 1,
1259: 'js_ready' => 1,
1260: 'add_entries' => {
1261: 'border' => '0',
1262: 'rows' => "110,*",},});
1263: my $end_page =
1264: &Apache::loncommon::end_page({'frameset' => 1,
1265: 'js_ready' => 1,});
1266:
1267: my $template .= <<"ENDTEMPLATE";
1268: <script type="text/javascript">
1269: // <![CDATA[
1270: // <!-- BEGIN LON-CAPA Internal
1271: var banner_link = '';
1272: function helpMenu(target) {
1273: var caller = this;
1274: if (target == 'open') {
1275: var newWindow = null;
1276: try {
1277: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1278: }
1279: catch(error) {
1280: writeHelp(caller);
1281: return;
1282: }
1283: if (newWindow) {
1284: caller = newWindow;
1285: }
1286: }
1287: writeHelp(caller);
1288: return;
1289: }
1290: function writeHelp(caller) {
1291: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1292: caller.document.close()
1293: caller.focus()
1294: }
1295: // END LON-CAPA Internal -->
1296: // ]]>
1297: </script>
1298: ENDTEMPLATE
1299: return $template;
1300: }
1301:
1302: sub help_open_bug {
1303: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1304: unless ($env{'user.adv'}) { return ''; }
1305: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1306: $text = "" if (not defined $text);
1307: $stayOnPage = 0 if (not defined $stayOnPage);
1308: if ($env{'environment.remote'} eq 'off' ) {
1309: $stayOnPage=1;
1310: }
1311: $width = 600 if (not defined $width);
1312: $height = 600 if (not defined $height);
1313:
1314: $topic=~s/\W+/\+/g;
1315: my $link='';
1316: my $template='';
1317: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1318: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1319: if (!$stayOnPage)
1320: {
1321: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1322: }
1323: else
1324: {
1325: $link = $url;
1326: }
1327: # Add the text
1328: if ($text ne "")
1329: {
1330: $template .=
1331: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1332: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1333: }
1334:
1335: # Add the graphic
1336: my $title = &mt('Report a Bug');
1337: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1338: $template .= <<"ENDTEMPLATE";
1339: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1340: ENDTEMPLATE
1341: if ($text ne '') { $template.='</td></tr></table>' };
1342: return $template;
1343:
1344: }
1345:
1346: sub help_open_faq {
1347: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1348: unless ($env{'user.adv'}) { return ''; }
1349: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1350: $text = "" if (not defined $text);
1351: $stayOnPage = 0 if (not defined $stayOnPage);
1352: if ($env{'environment.remote'} eq 'off' ) {
1353: $stayOnPage=1;
1354: }
1355: $width = 350 if (not defined $width);
1356: $height = 400 if (not defined $height);
1357:
1358: $topic=~s/\W+/\+/g;
1359: my $link='';
1360: my $template='';
1361: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1362: if (!$stayOnPage)
1363: {
1364: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1365: }
1366: else
1367: {
1368: $link = $url;
1369: }
1370:
1371: # Add the text
1372: if ($text ne "")
1373: {
1374: $template .=
1375: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1376: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1377: }
1378:
1379: # Add the graphic
1380: my $title = &mt('View the FAQ');
1381: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1382: $template .= <<"ENDTEMPLATE";
1383: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1384: ENDTEMPLATE
1385: if ($text ne '') { $template.='</td></tr></table>' };
1386: return $template;
1387:
1388: }
1389:
1390: ###############################################################
1391: ###############################################################
1392:
1393: =pod
1394:
1395: =item * &change_content_javascript():
1396:
1397: This and the next function allow you to create small sections of an
1398: otherwise static HTML page that you can update on the fly with
1399: Javascript, even in Netscape 4.
1400:
1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1402: must be written to the HTML page once. It will prove the Javascript
1403: function "change(name, content)". Calling the change function with the
1404: name of the section
1405: you want to update, matching the name passed to C<changable_area>, and
1406: the new content you want to put in there, will put the content into
1407: that area.
1408:
1409: B<Note>: Netscape 4 only reserves enough space for the changable area
1410: to contain room for the original contents. You need to "make space"
1411: for whatever changes you wish to make, and be B<sure> to check your
1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1413: it's adequate for updating a one-line status display, but little more.
1414: This script will set the space to 100% width, so you only need to
1415: worry about height in Netscape 4.
1416:
1417: Modern browsers are much less limiting, and if you can commit to the
1418: user not using Netscape 4, this feature may be used freely with
1419: pretty much any HTML.
1420:
1421: =cut
1422:
1423: sub change_content_javascript {
1424: # If we're on Netscape 4, we need to use Layer-based code
1425: if ($env{'browser.type'} eq 'netscape' &&
1426: $env{'browser.version'} =~ /^4\./) {
1427: return (<<NETSCAPE4);
1428: function change(name, content) {
1429: doc = document.layers[name+"___escape"].layers[0].document;
1430: doc.open();
1431: doc.write(content);
1432: doc.close();
1433: }
1434: NETSCAPE4
1435: } else {
1436: # Otherwise, we need to use semi-standards-compliant code
1437: # (technically, "innerHTML" isn't standard but the equivalent
1438: # is really scary, and every useful browser supports it
1439: return (<<DOMBASED);
1440: function change(name, content) {
1441: element = document.getElementById(name);
1442: element.innerHTML = content;
1443: }
1444: DOMBASED
1445: }
1446: }
1447:
1448: =pod
1449:
1450: =item * &changable_area($name,$origContent):
1451:
1452: This provides a "changable area" that can be modified on the fly via
1453: the Javascript code provided in C<change_content_javascript>. $name is
1454: the name you will use to reference the area later; do not repeat the
1455: same name on a given HTML page more then once. $origContent is what
1456: the area will originally contain, which can be left blank.
1457:
1458: =cut
1459:
1460: sub changable_area {
1461: my ($name, $origContent) = @_;
1462:
1463: if ($env{'browser.type'} eq 'netscape' &&
1464: $env{'browser.version'} =~ /^4\./) {
1465: # If this is netscape 4, we need to use the Layer tag
1466: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1467: } else {
1468: return "<span id='$name'>$origContent</span>";
1469: }
1470: }
1471:
1472: =pod
1473:
1474: =item * &viewport_geometry_js
1475:
1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1477:
1478: =cut
1479:
1480:
1481: sub viewport_geometry_js {
1482: return <<"GEOMETRY";
1483: var Geometry = {};
1484: function init_geometry() {
1485: if (Geometry.init) { return };
1486: Geometry.init=1;
1487: if (window.innerHeight) {
1488: Geometry.getViewportHeight = function() { return window.innerHeight; };
1489: Geometry.getViewportWidth = function() { return window.innerWidth; };
1490: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1491: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1492: }
1493: else if (document.documentElement && document.documentElement.clientHeight) {
1494: Geometry.getViewportHeight =
1495: function() { return document.documentElement.clientHeight; };
1496: Geometry.getViewportWidth =
1497: function() { return document.documentElement.clientWidth; };
1498:
1499: Geometry.getHorizontalScroll =
1500: function() { return document.documentElement.scrollLeft; };
1501: Geometry.getVerticalScroll =
1502: function() { return document.documentElement.scrollTop; };
1503: }
1504: else if (document.body.clientHeight) {
1505: Geometry.getViewportHeight =
1506: function() { return document.body.clientHeight; };
1507: Geometry.getViewportWidth =
1508: function() { return document.body.clientWidth; };
1509: Geometry.getHorizontalScroll =
1510: function() { return document.body.scrollLeft; };
1511: Geometry.getVerticalScroll =
1512: function() { return document.body.scrollTop; };
1513: }
1514: }
1515:
1516: GEOMETRY
1517: }
1518:
1519: =pod
1520:
1521: =item * &viewport_size_js()
1522:
1523: 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.
1524:
1525: =cut
1526:
1527: sub viewport_size_js {
1528: my $geometry = &viewport_geometry_js();
1529: return <<"DIMS";
1530:
1531: $geometry
1532:
1533: function getViewportDims(width,height) {
1534: init_geometry();
1535: width.value = Geometry.getViewportWidth();
1536: height.value = Geometry.getViewportHeight();
1537: return;
1538: }
1539:
1540: DIMS
1541: }
1542:
1543: =pod
1544:
1545: =item * &resize_textarea_js()
1546:
1547: emits the needed javascript to resize a textarea to be as big as possible
1548:
1549: creates a function resize_textrea that takes two IDs first should be
1550: the id of the element to resize, second should be the id of a div that
1551: surrounds everything that comes after the textarea, this routine needs
1552: to be attached to the <body> for the onload and onresize events.
1553:
1554: =back
1555:
1556: =cut
1557:
1558: sub resize_textarea_js {
1559: my $geometry = &viewport_geometry_js();
1560: return <<"RESIZE";
1561: <script type="text/javascript">
1562: // <![CDATA[
1563: $geometry
1564:
1565: function getX(element) {
1566: var x = 0;
1567: while (element) {
1568: x += element.offsetLeft;
1569: element = element.offsetParent;
1570: }
1571: return x;
1572: }
1573: function getY(element) {
1574: var y = 0;
1575: while (element) {
1576: y += element.offsetTop;
1577: element = element.offsetParent;
1578: }
1579: return y;
1580: }
1581:
1582:
1583: function resize_textarea(textarea_id,bottom_id) {
1584: init_geometry();
1585: var textarea = document.getElementById(textarea_id);
1586: //alert(textarea);
1587:
1588: var textarea_top = getY(textarea);
1589: var textarea_height = textarea.offsetHeight;
1590: var bottom = document.getElementById(bottom_id);
1591: var bottom_top = getY(bottom);
1592: var bottom_height = bottom.offsetHeight;
1593: var window_height = Geometry.getViewportHeight();
1594: var fudge = 23;
1595: var new_height = window_height-fudge-textarea_top-bottom_height;
1596: if (new_height < 300) {
1597: new_height = 300;
1598: }
1599: textarea.style.height=new_height+'px';
1600: }
1601: // ]]>
1602: </script>
1603: RESIZE
1604:
1605: }
1606:
1607: =pod
1608:
1609: =head1 Excel and CSV file utility routines
1610:
1611: =over 4
1612:
1613: =cut
1614:
1615: ###############################################################
1616: ###############################################################
1617:
1618: =pod
1619:
1620: =item * &csv_translate($text)
1621:
1622: Translate $text to allow it to be output as a 'comma separated values'
1623: format.
1624:
1625: =cut
1626:
1627: ###############################################################
1628: ###############################################################
1629: sub csv_translate {
1630: my $text = shift;
1631: $text =~ s/\"/\"\"/g;
1632: $text =~ s/\n/ /g;
1633: return $text;
1634: }
1635:
1636: ###############################################################
1637: ###############################################################
1638:
1639: =pod
1640:
1641: =item * &define_excel_formats()
1642:
1643: Define some commonly used Excel cell formats.
1644:
1645: Currently supported formats:
1646:
1647: =over 4
1648:
1649: =item header
1650:
1651: =item bold
1652:
1653: =item h1
1654:
1655: =item h2
1656:
1657: =item h3
1658:
1659: =item h4
1660:
1661: =item i
1662:
1663: =item date
1664:
1665: =back
1666:
1667: Inputs: $workbook
1668:
1669: Returns: $format, a hash reference.
1670:
1671: =cut
1672:
1673: ###############################################################
1674: ###############################################################
1675: sub define_excel_formats {
1676: my ($workbook) = @_;
1677: my $format;
1678: $format->{'header'} = $workbook->add_format(bold => 1,
1679: bottom => 1,
1680: align => 'center');
1681: $format->{'bold'} = $workbook->add_format(bold=>1);
1682: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1683: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1684: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1685: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1686: $format->{'i'} = $workbook->add_format(italic=>1);
1687: $format->{'date'} = $workbook->add_format(num_format=>
1688: 'mm/dd/yyyy hh:mm:ss');
1689: return $format;
1690: }
1691:
1692: ###############################################################
1693: ###############################################################
1694:
1695: =pod
1696:
1697: =item * &create_workbook()
1698:
1699: Create an Excel worksheet. If it fails, output message on the
1700: request object and return undefs.
1701:
1702: Inputs: Apache request object
1703:
1704: Returns (undef) on failure,
1705: Excel worksheet object, scalar with filename, and formats
1706: from &Apache::loncommon::define_excel_formats on success
1707:
1708: =cut
1709:
1710: ###############################################################
1711: ###############################################################
1712: sub create_workbook {
1713: my ($r) = @_;
1714: #
1715: # Create the excel spreadsheet
1716: my $filename = '/prtspool/'.
1717: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1718: time.'_'.rand(1000000000).'.xls';
1719: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1720: if (! defined($workbook)) {
1721: $r->log_error("Error creating excel spreadsheet $filename: $!");
1722: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1723: "This error has been logged. ".
1724: "Please alert your LON-CAPA administrator").
1725: '</p>');
1726: return (undef);
1727: }
1728: #
1729: $workbook->set_tempdir('/home/httpd/perl/tmp');
1730: #
1731: my $format = &Apache::loncommon::define_excel_formats($workbook);
1732: return ($workbook,$filename,$format);
1733: }
1734:
1735: ###############################################################
1736: ###############################################################
1737:
1738: =pod
1739:
1740: =item * &create_text_file()
1741:
1742: Create a file to write to and eventually make available to the user.
1743: If file creation fails, outputs an error message on the request object and
1744: return undefs.
1745:
1746: Inputs: Apache request object, and file suffix
1747:
1748: Returns (undef) on failure,
1749: Filehandle and filename on success.
1750:
1751: =cut
1752:
1753: ###############################################################
1754: ###############################################################
1755: sub create_text_file {
1756: my ($r,$suffix) = @_;
1757: if (! defined($suffix)) { $suffix = 'txt'; };
1758: my $fh;
1759: my $filename = '/prtspool/'.
1760: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1761: time.'_'.rand(1000000000).'.'.$suffix;
1762: $fh = Apache::File->new('>/home/httpd'.$filename);
1763: if (! defined($fh)) {
1764: $r->log_error("Couldn't open $filename for output $!");
1765: $r->print(&mt('Problems occurred in creating the output file. '
1766: .'This error has been logged. '
1767: .'Please alert your LON-CAPA administrator.'));
1768: }
1769: return ($fh,$filename)
1770: }
1771:
1772:
1773: =pod
1774:
1775: =back
1776:
1777: =cut
1778:
1779: ###############################################################
1780: ## Home server <option> list generating code ##
1781: ###############################################################
1782:
1783: # ------------------------------------------
1784:
1785: sub domain_select {
1786: my ($name,$value,$multiple)=@_;
1787: my %domains=map {
1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1789: } &Apache::lonnet::all_domains();
1790: if ($multiple) {
1791: $domains{''}=&mt('Any domain');
1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1793: return &multiple_select_form($name,$value,4,\%domains);
1794: } else {
1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1796: return &select_form($name,$value,%domains);
1797: }
1798: }
1799:
1800: #-------------------------------------------
1801:
1802: =pod
1803:
1804: =head1 Routines for form select boxes
1805:
1806: =over 4
1807:
1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1809:
1810: Returns a string containing a <select> element int multiple mode
1811:
1812:
1813: Args:
1814: $name - name of the <select> element
1815: $value - scalar or array ref of values that should already be selected
1816: $size - number of rows long the select element is
1817: $hash - the elements should be 'option' => 'shown text'
1818: (shown text should already have been &mt())
1819: $order - (optional) array ref of the order to show the elements in
1820:
1821: =cut
1822:
1823: #-------------------------------------------
1824: sub multiple_select_form {
1825: my ($name,$value,$size,$hash,$order)=@_;
1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1827: my $output='';
1828: if (! defined($size)) {
1829: $size = 4;
1830: if (scalar(keys(%$hash))<4) {
1831: $size = scalar(keys(%$hash));
1832: }
1833: }
1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1835: my @order;
1836: if (ref($order) eq 'ARRAY') {
1837: @order = @{$order};
1838: } else {
1839: @order = sort(keys(%$hash));
1840: }
1841: if (exists($$hash{'select_form_order'})) {
1842: @order = @{$$hash{'select_form_order'}};
1843: }
1844:
1845: foreach my $key (@order) {
1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1847: $output.='selected="selected" ' if ($selected{$key});
1848: $output.='>'.$hash->{$key}."</option>\n";
1849: }
1850: $output.="</select>\n";
1851: return $output;
1852: }
1853:
1854: #-------------------------------------------
1855:
1856: =pod
1857:
1858: =item * &select_form($defdom,$name,%hash)
1859:
1860: Returns a string containing a <select name='$name' size='1'> form to
1861: allow a user to select options from a hash option_name => displayed text.
1862: See lonrights.pm for an example invocation and use.
1863:
1864: =cut
1865:
1866: #-------------------------------------------
1867: sub select_form {
1868: my ($def,$name,%hash) = @_;
1869: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1870: my @keys;
1871: if (exists($hash{'select_form_order'})) {
1872: @keys=@{$hash{'select_form_order'}};
1873: } else {
1874: @keys=sort(keys(%hash));
1875: }
1876: foreach my $key (@keys) {
1877: $selectform.=
1878: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1879: ($key eq $def ? 'selected="selected" ' : '').
1880: ">".$hash{$key}."</option>\n";
1881: }
1882: $selectform.="</select>";
1883: return $selectform;
1884: }
1885:
1886: # For display filters
1887:
1888: sub display_filter {
1889: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1890: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1891: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1892: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1893: (&mt('all'),10,20,50,100,1000,10000))).
1894: '</label></span> <span class="LC_nobreak">'.
1895: &mt('Filter [_1]',
1896: &select_form($env{'form.displayfilter'},
1897: 'displayfilter',
1898: ('currentfolder' => 'Current folder/page',
1899: 'containing' => 'Containing phrase',
1900: 'none' => 'None'))).
1901: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1902: }
1903:
1904: sub gradeleveldescription {
1905: my $gradelevel=shift;
1906: my %gradelevels=(0 => 'Not specified',
1907: 1 => 'Grade 1',
1908: 2 => 'Grade 2',
1909: 3 => 'Grade 3',
1910: 4 => 'Grade 4',
1911: 5 => 'Grade 5',
1912: 6 => 'Grade 6',
1913: 7 => 'Grade 7',
1914: 8 => 'Grade 8',
1915: 9 => 'Grade 9',
1916: 10 => 'Grade 10',
1917: 11 => 'Grade 11',
1918: 12 => 'Grade 12',
1919: 13 => 'Grade 13',
1920: 14 => '100 Level',
1921: 15 => '200 Level',
1922: 16 => '300 Level',
1923: 17 => '400 Level',
1924: 18 => 'Graduate Level');
1925: return &mt($gradelevels{$gradelevel});
1926: }
1927:
1928: sub select_level_form {
1929: my ($deflevel,$name)=@_;
1930: unless ($deflevel) { $deflevel=0; }
1931: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1932: for (my $i=0; $i<=18; $i++) {
1933: $selectform.="<option value=\"$i\" ".
1934: ($i==$deflevel ? 'selected="selected" ' : '').
1935: ">".&gradeleveldescription($i)."</option>\n";
1936: }
1937: $selectform.="</select>";
1938: return $selectform;
1939: }
1940:
1941: #-------------------------------------------
1942:
1943: =pod
1944:
1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1946:
1947: Returns a string containing a <select name='$name' size='1'> form to
1948: allow a user to select the domain to preform an operation in.
1949: See loncreateuser.pm for an example invocation and use.
1950:
1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
1952: selected");
1953:
1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1955:
1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
1957:
1958: The optional $incdoms is a reference to an array of domains which will be the only available options.
1959:
1960: =cut
1961:
1962: #-------------------------------------------
1963: sub select_dom_form {
1964: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1965: if ($onchange) {
1966: $onchange = ' onchange="'.$onchange.'"';
1967: }
1968: my @domains;
1969: if (ref($incdoms) eq 'ARRAY') {
1970: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
1971: } else {
1972: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1973: }
1974: if ($includeempty) { @domains=('',@domains); }
1975: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1976: foreach my $dom (@domains) {
1977: $selectdomain.="<option value=\"$dom\" ".
1978: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1979: if ($showdomdesc) {
1980: if ($dom ne '') {
1981: my $domdesc = &Apache::lonnet::domain($dom,'description');
1982: if ($domdesc ne '') {
1983: $selectdomain .= ' ('.$domdesc.')';
1984: }
1985: }
1986: }
1987: $selectdomain .= "</option>\n";
1988: }
1989: $selectdomain.="</select>";
1990: return $selectdomain;
1991: }
1992:
1993: #-------------------------------------------
1994:
1995: =pod
1996:
1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1998:
1999: input: 4 arguments (two required, two optional) -
2000: $domain - domain of new user
2001: $name - name of form element
2002: $default - Value of 'default' causes a default item to be first
2003: option, and selected by default.
2004: $hide - Value of 'hide' causes hiding of the name of the server,
2005: if 1 server found, or default, if 0 found.
2006: output: returns 2 items:
2007: (a) form element which contains either:
2008: (i) <select name="$name">
2009: <option value="$hostid1">$hostid $servers{$hostid}</option>
2010: <option value="$hostid2">$hostid $servers{$hostid}</option>
2011: </select>
2012: form item if there are multiple library servers in $domain, or
2013: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2014: if there is only one library server in $domain.
2015:
2016: (b) number of library servers found.
2017:
2018: See loncreateuser.pm for example of use.
2019:
2020: =cut
2021:
2022: #-------------------------------------------
2023: sub home_server_form_item {
2024: my ($domain,$name,$default,$hide) = @_;
2025: my %servers = &Apache::lonnet::get_servers($domain,'library');
2026: my $result;
2027: my $numlib = keys(%servers);
2028: if ($numlib > 1) {
2029: $result .= '<select name="'.$name.'" />'."\n";
2030: if ($default) {
2031: $result .= '<option value="default" selected="selected">'.&mt('default').
2032: '</option>'."\n";
2033: }
2034: foreach my $hostid (sort(keys(%servers))) {
2035: $result.= '<option value="'.$hostid.'">'.
2036: $hostid.' '.$servers{$hostid}."</option>\n";
2037: }
2038: $result .= '</select>'."\n";
2039: } elsif ($numlib == 1) {
2040: my $hostid;
2041: foreach my $item (keys(%servers)) {
2042: $hostid = $item;
2043: }
2044: $result .= '<input type="hidden" name="'.$name.'" value="'.
2045: $hostid.'" />';
2046: if (!$hide) {
2047: $result .= $hostid.' '.$servers{$hostid};
2048: }
2049: $result .= "\n";
2050: } elsif ($default) {
2051: $result .= '<input type="hidden" name="'.$name.
2052: '" value="default" />';
2053: if (!$hide) {
2054: $result .= &mt('default');
2055: }
2056: $result .= "\n";
2057: }
2058: return ($result,$numlib);
2059: }
2060:
2061: =pod
2062:
2063: =back
2064:
2065: =cut
2066:
2067: ###############################################################
2068: ## Decoding User Agent ##
2069: ###############################################################
2070:
2071: =pod
2072:
2073: =head1 Decoding the User Agent
2074:
2075: =over 4
2076:
2077: =item * &decode_user_agent()
2078:
2079: Inputs: $r
2080:
2081: Outputs:
2082:
2083: =over 4
2084:
2085: =item * $httpbrowser
2086:
2087: =item * $clientbrowser
2088:
2089: =item * $clientversion
2090:
2091: =item * $clientmathml
2092:
2093: =item * $clientunicode
2094:
2095: =item * $clientos
2096:
2097: =back
2098:
2099: =back
2100:
2101: =cut
2102:
2103: ###############################################################
2104: ###############################################################
2105: sub decode_user_agent {
2106: my ($r)=@_;
2107: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2108: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2109: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
2110: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
2111: my $clientbrowser='unknown';
2112: my $clientversion='0';
2113: my $clientmathml='';
2114: my $clientunicode='0';
2115: for (my $i=0;$i<=$#browsertype;$i++) {
2116: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
2117: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2118: $clientbrowser=$bname;
2119: $httpbrowser=~/$vreg/i;
2120: $clientversion=$1;
2121: $clientmathml=($clientversion>=$minv);
2122: $clientunicode=($clientversion>=$univ);
2123: }
2124: }
2125: my $clientos='unknown';
2126: if (($httpbrowser=~/linux/i) ||
2127: ($httpbrowser=~/unix/i) ||
2128: ($httpbrowser=~/ux/i) ||
2129: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2130: if (($httpbrowser=~/vax/i) ||
2131: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2132: if ($httpbrowser=~/next/i) { $clientos='next'; }
2133: if (($httpbrowser=~/mac/i) ||
2134: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
2135: if ($httpbrowser=~/win/i) { $clientos='win'; }
2136: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
2137: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
2138: $clientunicode,$clientos,);
2139: }
2140:
2141: ###############################################################
2142: ## Authentication changing form generation subroutines ##
2143: ###############################################################
2144: ##
2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
2146: ## hash, and have reasonable default values.
2147: ##
2148: ## formname = the name given in the <form> tag.
2149: #-------------------------------------------
2150:
2151: =pod
2152:
2153: =head1 Authentication Routines
2154:
2155: =over 4
2156:
2157: =item * &authform_xxxxxx()
2158:
2159: The authform_xxxxxx subroutines provide javascript and html forms which
2160: handle some of the conveniences required for authentication forms.
2161: This is not an optimal method, but it works.
2162:
2163: =over 4
2164:
2165: =item * authform_header
2166:
2167: =item * authform_authorwarning
2168:
2169: =item * authform_nochange
2170:
2171: =item * authform_kerberos
2172:
2173: =item * authform_internal
2174:
2175: =item * authform_filesystem
2176:
2177: =back
2178:
2179: See loncreateuser.pm for invocation and use examples.
2180:
2181: =cut
2182:
2183: #-------------------------------------------
2184: sub authform_header{
2185: my %in = (
2186: formname => 'cu',
2187: kerb_def_dom => '',
2188: @_,
2189: );
2190: $in{'formname'} = 'document.' . $in{'formname'};
2191: my $result='';
2192:
2193: #---------------------------------------------- Code for upper case translation
2194: my $Javascript_toUpperCase;
2195: unless ($in{kerb_def_dom}) {
2196: $Javascript_toUpperCase =<<"END";
2197: switch (choice) {
2198: case 'krb': currentform.elements[choicearg].value =
2199: currentform.elements[choicearg].value.toUpperCase();
2200: break;
2201: default:
2202: }
2203: END
2204: } else {
2205: $Javascript_toUpperCase = "";
2206: }
2207:
2208: my $radioval = "'nochange'";
2209: if (defined($in{'curr_authtype'})) {
2210: if ($in{'curr_authtype'} ne '') {
2211: $radioval = "'".$in{'curr_authtype'}."arg'";
2212: }
2213: }
2214: my $argfield = 'null';
2215: if (defined($in{'mode'})) {
2216: if ($in{'mode'} eq 'modifycourse') {
2217: if (defined($in{'curr_autharg'})) {
2218: if ($in{'curr_autharg'} ne '') {
2219: $argfield = "'$in{'curr_autharg'}'";
2220: }
2221: }
2222: }
2223: }
2224:
2225: $result.=<<"END";
2226: var current = new Object();
2227: current.radiovalue = $radioval;
2228: current.argfield = $argfield;
2229:
2230: function changed_radio(choice,currentform) {
2231: var choicearg = choice + 'arg';
2232: // If a radio button in changed, we need to change the argfield
2233: if (current.radiovalue != choice) {
2234: current.radiovalue = choice;
2235: if (current.argfield != null) {
2236: currentform.elements[current.argfield].value = '';
2237: }
2238: if (choice == 'nochange') {
2239: current.argfield = null;
2240: } else {
2241: current.argfield = choicearg;
2242: switch(choice) {
2243: case 'krb':
2244: currentform.elements[current.argfield].value =
2245: "$in{'kerb_def_dom'}";
2246: break;
2247: default:
2248: break;
2249: }
2250: }
2251: }
2252: return;
2253: }
2254:
2255: function changed_text(choice,currentform) {
2256: var choicearg = choice + 'arg';
2257: if (currentform.elements[choicearg].value !='') {
2258: $Javascript_toUpperCase
2259: // clear old field
2260: if ((current.argfield != choicearg) && (current.argfield != null)) {
2261: currentform.elements[current.argfield].value = '';
2262: }
2263: current.argfield = choicearg;
2264: }
2265: set_auth_radio_buttons(choice,currentform);
2266: return;
2267: }
2268:
2269: function set_auth_radio_buttons(newvalue,currentform) {
2270: var i=0;
2271: while (i < currentform.login.length) {
2272: if (currentform.login[i].value == newvalue) { break; }
2273: i++;
2274: }
2275: if (i == currentform.login.length) {
2276: return;
2277: }
2278: current.radiovalue = newvalue;
2279: currentform.login[i].checked = true;
2280: return;
2281: }
2282: END
2283: return $result;
2284: }
2285:
2286: sub authform_authorwarning{
2287: my $result='';
2288: $result='<i>'.
2289: &mt('As a general rule, only authors or co-authors should be '.
2290: 'filesystem authenticated '.
2291: '(which allows access to the server filesystem).')."</i>\n";
2292: return $result;
2293: }
2294:
2295: sub authform_nochange{
2296: my %in = (
2297: formname => 'document.cu',
2298: kerb_def_dom => 'MSU.EDU',
2299: @_,
2300: );
2301: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2302: my $result;
2303: if (keys(%can_assign) == 0) {
2304: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2305: } else {
2306: $result = '<label>'.&mt('[_1] Do not change login data',
2307: '<input type="radio" name="login" value="nochange" '.
2308: 'checked="checked" onclick="'.
2309: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2310: '</label>';
2311: }
2312: return $result;
2313: }
2314:
2315: sub authform_kerberos {
2316: my %in = (
2317: formname => 'document.cu',
2318: kerb_def_dom => 'MSU.EDU',
2319: kerb_def_auth => 'krb4',
2320: @_,
2321: );
2322: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2323: $autharg,$jscall);
2324: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2325: if ($in{'kerb_def_auth'} eq 'krb5') {
2326: $check5 = ' checked="checked"';
2327: } else {
2328: $check4 = ' checked="checked"';
2329: }
2330: $krbarg = $in{'kerb_def_dom'};
2331: if (defined($in{'curr_authtype'})) {
2332: if ($in{'curr_authtype'} eq 'krb') {
2333: $krbcheck = ' checked="checked"';
2334: if (defined($in{'mode'})) {
2335: if ($in{'mode'} eq 'modifyuser') {
2336: $krbcheck = '';
2337: }
2338: }
2339: if (defined($in{'curr_kerb_ver'})) {
2340: if ($in{'curr_krb_ver'} eq '5') {
2341: $check5 = ' checked="checked"';
2342: $check4 = '';
2343: } else {
2344: $check4 = ' checked="checked"';
2345: $check5 = '';
2346: }
2347: }
2348: if (defined($in{'curr_autharg'})) {
2349: $krbarg = $in{'curr_autharg'};
2350: }
2351: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2352: if (defined($in{'curr_autharg'})) {
2353: $result =
2354: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2355: $in{'curr_autharg'},$krbver);
2356: } else {
2357: $result =
2358: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2359: }
2360: return $result;
2361: }
2362: }
2363: } else {
2364: if ($authnum == 1) {
2365: $authtype = '<input type="hidden" name="login" value="krb" />';
2366: }
2367: }
2368: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2369: return;
2370: } elsif ($authtype eq '') {
2371: if (defined($in{'mode'})) {
2372: if ($in{'mode'} eq 'modifycourse') {
2373: if ($authnum == 1) {
2374: $authtype = '<input type="hidden" name="login" value="krb" />';
2375: }
2376: }
2377: }
2378: }
2379: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2380: if ($authtype eq '') {
2381: $authtype = '<input type="radio" name="login" value="krb" '.
2382: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2383: $krbcheck.' />';
2384: }
2385: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2386: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2387: $in{'curr_authtype'} eq 'krb5') ||
2388: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2389: $in{'curr_authtype'} eq 'krb4')) {
2390: $result .= &mt
2391: ('[_1] Kerberos authenticated with domain [_2] '.
2392: '[_3] Version 4 [_4] Version 5 [_5]',
2393: '<label>'.$authtype,
2394: '</label><input type="text" size="10" name="krbarg" '.
2395: 'value="'.$krbarg.'" '.
2396: 'onchange="'.$jscall.'" />',
2397: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2398: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2399: '</label>');
2400: } elsif ($can_assign{'krb4'}) {
2401: $result .= &mt
2402: ('[_1] Kerberos authenticated with domain [_2] '.
2403: '[_3] Version 4 [_4]',
2404: '<label>'.$authtype,
2405: '</label><input type="text" size="10" name="krbarg" '.
2406: 'value="'.$krbarg.'" '.
2407: 'onchange="'.$jscall.'" />',
2408: '<label><input type="hidden" name="krbver" value="4" />',
2409: '</label>');
2410: } elsif ($can_assign{'krb5'}) {
2411: $result .= &mt
2412: ('[_1] Kerberos authenticated with domain [_2] '.
2413: '[_3] Version 5 [_4]',
2414: '<label>'.$authtype,
2415: '</label><input type="text" size="10" name="krbarg" '.
2416: 'value="'.$krbarg.'" '.
2417: 'onchange="'.$jscall.'" />',
2418: '<label><input type="hidden" name="krbver" value="5" />',
2419: '</label>');
2420: }
2421: return $result;
2422: }
2423:
2424: sub authform_internal{
2425: my %in = (
2426: formname => 'document.cu',
2427: kerb_def_dom => 'MSU.EDU',
2428: @_,
2429: );
2430: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2431: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2432: if (defined($in{'curr_authtype'})) {
2433: if ($in{'curr_authtype'} eq 'int') {
2434: if ($can_assign{'int'}) {
2435: $intcheck = 'checked="checked" ';
2436: if (defined($in{'mode'})) {
2437: if ($in{'mode'} eq 'modifyuser') {
2438: $intcheck = '';
2439: }
2440: }
2441: if (defined($in{'curr_autharg'})) {
2442: $intarg = $in{'curr_autharg'};
2443: }
2444: } else {
2445: $result = &mt('Currently internally authenticated.');
2446: return $result;
2447: }
2448: }
2449: } else {
2450: if ($authnum == 1) {
2451: $authtype = '<input type="hidden" name="login" value="int" />';
2452: }
2453: }
2454: if (!$can_assign{'int'}) {
2455: return;
2456: } elsif ($authtype eq '') {
2457: if (defined($in{'mode'})) {
2458: if ($in{'mode'} eq 'modifycourse') {
2459: if ($authnum == 1) {
2460: $authtype = '<input type="hidden" name="login" value="int" />';
2461: }
2462: }
2463: }
2464: }
2465: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2466: if ($authtype eq '') {
2467: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2468: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2469: }
2470: $autharg = '<input type="password" size="10" name="intarg" value="'.
2471: $intarg.'" onchange="'.$jscall.'" />';
2472: $result = &mt
2473: ('[_1] Internally authenticated (with initial password [_2])',
2474: '<label>'.$authtype,'</label>'.$autharg);
2475: $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>';
2476: return $result;
2477: }
2478:
2479: sub authform_local{
2480: my %in = (
2481: formname => 'document.cu',
2482: kerb_def_dom => 'MSU.EDU',
2483: @_,
2484: );
2485: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2486: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2487: if (defined($in{'curr_authtype'})) {
2488: if ($in{'curr_authtype'} eq 'loc') {
2489: if ($can_assign{'loc'}) {
2490: $loccheck = 'checked="checked" ';
2491: if (defined($in{'mode'})) {
2492: if ($in{'mode'} eq 'modifyuser') {
2493: $loccheck = '';
2494: }
2495: }
2496: if (defined($in{'curr_autharg'})) {
2497: $locarg = $in{'curr_autharg'};
2498: }
2499: } else {
2500: $result = &mt('Currently using local (institutional) authentication.');
2501: return $result;
2502: }
2503: }
2504: } else {
2505: if ($authnum == 1) {
2506: $authtype = '<input type="hidden" name="login" value="loc" />';
2507: }
2508: }
2509: if (!$can_assign{'loc'}) {
2510: return;
2511: } elsif ($authtype eq '') {
2512: if (defined($in{'mode'})) {
2513: if ($in{'mode'} eq 'modifycourse') {
2514: if ($authnum == 1) {
2515: $authtype = '<input type="hidden" name="login" value="loc" />';
2516: }
2517: }
2518: }
2519: }
2520: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2521: if ($authtype eq '') {
2522: $authtype = '<input type="radio" name="login" value="loc" '.
2523: $loccheck.' onchange="'.$jscall.'" onclick="'.
2524: $jscall.'" />';
2525: }
2526: $autharg = '<input type="text" size="10" name="locarg" value="'.
2527: $locarg.'" onchange="'.$jscall.'" />';
2528: $result = &mt('[_1] Local Authentication with argument [_2]',
2529: '<label>'.$authtype,'</label>'.$autharg);
2530: return $result;
2531: }
2532:
2533: sub authform_filesystem{
2534: my %in = (
2535: formname => 'document.cu',
2536: kerb_def_dom => 'MSU.EDU',
2537: @_,
2538: );
2539: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2540: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2541: if (defined($in{'curr_authtype'})) {
2542: if ($in{'curr_authtype'} eq 'fsys') {
2543: if ($can_assign{'fsys'}) {
2544: $fsyscheck = 'checked="checked" ';
2545: if (defined($in{'mode'})) {
2546: if ($in{'mode'} eq 'modifyuser') {
2547: $fsyscheck = '';
2548: }
2549: }
2550: } else {
2551: $result = &mt('Currently Filesystem Authenticated.');
2552: return $result;
2553: }
2554: }
2555: } else {
2556: if ($authnum == 1) {
2557: $authtype = '<input type="hidden" name="login" value="fsys" />';
2558: }
2559: }
2560: if (!$can_assign{'fsys'}) {
2561: return;
2562: } elsif ($authtype eq '') {
2563: if (defined($in{'mode'})) {
2564: if ($in{'mode'} eq 'modifycourse') {
2565: if ($authnum == 1) {
2566: $authtype = '<input type="hidden" name="login" value="fsys" />';
2567: }
2568: }
2569: }
2570: }
2571: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2572: if ($authtype eq '') {
2573: $authtype = '<input type="radio" name="login" value="fsys" '.
2574: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2575: $jscall.'" />';
2576: }
2577: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2578: ' onchange="'.$jscall.'" />';
2579: $result = &mt
2580: ('[_1] Filesystem Authenticated (with initial password [_2])',
2581: '<label><input type="radio" name="login" value="fsys" '.
2582: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
2583: '</label><input type="password" size="10" name="fsysarg" value="" '.
2584: 'onchange="'.$jscall.'" />');
2585: return $result;
2586: }
2587:
2588: sub get_assignable_auth {
2589: my ($dom) = @_;
2590: if ($dom eq '') {
2591: $dom = $env{'request.role.domain'};
2592: }
2593: my %can_assign = (
2594: krb4 => 1,
2595: krb5 => 1,
2596: int => 1,
2597: loc => 1,
2598: );
2599: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2600: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2601: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2602: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2603: my $context;
2604: if ($env{'request.role'} =~ /^au/) {
2605: $context = 'author';
2606: } elsif ($env{'request.role'} =~ /^dc/) {
2607: $context = 'domain';
2608: } elsif ($env{'request.course.id'}) {
2609: $context = 'course';
2610: }
2611: if ($context) {
2612: if (ref($authhash->{$context}) eq 'HASH') {
2613: %can_assign = %{$authhash->{$context}};
2614: }
2615: }
2616: }
2617: }
2618: my $authnum = 0;
2619: foreach my $key (keys(%can_assign)) {
2620: if ($can_assign{$key}) {
2621: $authnum ++;
2622: }
2623: }
2624: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2625: $authnum --;
2626: }
2627: return ($authnum,%can_assign);
2628: }
2629:
2630: ###############################################################
2631: ## Get Kerberos Defaults for Domain ##
2632: ###############################################################
2633: ##
2634: ## Returns default kerberos version and an associated argument
2635: ## as listed in file domain.tab. If not listed, provides
2636: ## appropriate default domain and kerberos version.
2637: ##
2638: #-------------------------------------------
2639:
2640: =pod
2641:
2642: =item * &get_kerberos_defaults()
2643:
2644: get_kerberos_defaults($target_domain) returns the default kerberos
2645: version and domain. If not found, it defaults to version 4 and the
2646: domain of the server.
2647:
2648: =over 4
2649:
2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2651:
2652: =back
2653:
2654: =back
2655:
2656: =cut
2657:
2658: #-------------------------------------------
2659: sub get_kerberos_defaults {
2660: my $domain=shift;
2661: my ($krbdef,$krbdefdom);
2662: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2663: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2664: $krbdef = $domdefaults{'auth_def'};
2665: $krbdefdom = $domdefaults{'auth_arg_def'};
2666: } else {
2667: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2668: my $krbdefdom=$1;
2669: $krbdefdom=~tr/a-z/A-Z/;
2670: $krbdef = "krb4";
2671: }
2672: return ($krbdef,$krbdefdom);
2673: }
2674:
2675:
2676: ###############################################################
2677: ## Thesaurus Functions ##
2678: ###############################################################
2679:
2680: =pod
2681:
2682: =head1 Thesaurus Functions
2683:
2684: =over 4
2685:
2686: =item * &initialize_keywords()
2687:
2688: Initializes the package variable %Keywords if it is empty. Uses the
2689: package variable $thesaurus_db_file.
2690:
2691: =cut
2692:
2693: ###################################################
2694:
2695: sub initialize_keywords {
2696: return 1 if (scalar keys(%Keywords));
2697: # If we are here, %Keywords is empty, so fill it up
2698: # Make sure the file we need exists...
2699: if (! -e $thesaurus_db_file) {
2700: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2701: " failed because it does not exist");
2702: return 0;
2703: }
2704: # Set up the hash as a database
2705: my %thesaurus_db;
2706: if (! tie(%thesaurus_db,'GDBM_File',
2707: $thesaurus_db_file,&GDBM_READER(),0640)){
2708: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2709: $thesaurus_db_file);
2710: return 0;
2711: }
2712: # Get the average number of appearances of a word.
2713: my $avecount = $thesaurus_db{'average.count'};
2714: # Put keywords (those that appear > average) into %Keywords
2715: while (my ($word,$data)=each (%thesaurus_db)) {
2716: my ($count,undef) = split /:/,$data;
2717: $Keywords{$word}++ if ($count > $avecount);
2718: }
2719: untie %thesaurus_db;
2720: # Remove special values from %Keywords.
2721: foreach my $value ('total.count','average.count') {
2722: delete($Keywords{$value}) if (exists($Keywords{$value}));
2723: }
2724: return 1;
2725: }
2726:
2727: ###################################################
2728:
2729: =pod
2730:
2731: =item * &keyword($word)
2732:
2733: Returns true if $word is a keyword. A keyword is a word that appears more
2734: than the average number of times in the thesaurus database. Calls
2735: &initialize_keywords
2736:
2737: =cut
2738:
2739: ###################################################
2740:
2741: sub keyword {
2742: return if (!&initialize_keywords());
2743: my $word=lc(shift());
2744: $word=~s/\W//g;
2745: return exists($Keywords{$word});
2746: }
2747:
2748: ###############################################################
2749:
2750: =pod
2751:
2752: =item * &get_related_words()
2753:
2754: Look up a word in the thesaurus. Takes a scalar argument and returns
2755: an array of words. If the keyword is not in the thesaurus, an empty array
2756: will be returned. The order of the words returned is determined by the
2757: database which holds them.
2758:
2759: Uses global $thesaurus_db_file.
2760:
2761: =cut
2762:
2763: ###############################################################
2764: sub get_related_words {
2765: my $keyword = shift;
2766: my %thesaurus_db;
2767: if (! -e $thesaurus_db_file) {
2768: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2769: "failed because the file does not exist");
2770: return ();
2771: }
2772: if (! tie(%thesaurus_db,'GDBM_File',
2773: $thesaurus_db_file,&GDBM_READER(),0640)){
2774: return ();
2775: }
2776: my @Words=();
2777: my $count=0;
2778: if (exists($thesaurus_db{$keyword})) {
2779: # The first element is the number of times
2780: # the word appears. We do not need it now.
2781: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2782: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2783: my $threshold=$mostfrequentcount/10;
2784: foreach my $possibleword (@RelatedWords) {
2785: my ($word,$wordcount)=split(/\,/,$possibleword);
2786: if ($wordcount>$threshold) {
2787: push(@Words,$word);
2788: $count++;
2789: if ($count>10) { last; }
2790: }
2791: }
2792: }
2793: untie %thesaurus_db;
2794: return @Words;
2795: }
2796:
2797: =pod
2798:
2799: =back
2800:
2801: =cut
2802:
2803: # -------------------------------------------------------------- Plaintext name
2804: =pod
2805:
2806: =head1 User Name Functions
2807:
2808: =over 4
2809:
2810: =item * &plainname($uname,$udom,$first)
2811:
2812: Takes a users logon name and returns it as a string in
2813: "first middle last generation" form
2814: if $first is set to 'lastname' then it returns it as
2815: 'lastname generation, firstname middlename' if their is a lastname
2816:
2817: =cut
2818:
2819:
2820: ###############################################################
2821: sub plainname {
2822: my ($uname,$udom,$first)=@_;
2823: return if (!defined($uname) || !defined($udom));
2824: my %names=&getnames($uname,$udom);
2825: my $name=&Apache::lonnet::format_name($names{'firstname'},
2826: $names{'middlename'},
2827: $names{'lastname'},
2828: $names{'generation'},$first);
2829: $name=~s/^\s+//;
2830: $name=~s/\s+$//;
2831: $name=~s/\s+/ /g;
2832: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
2833: return $name;
2834: }
2835:
2836: # -------------------------------------------------------------------- Nickname
2837: =pod
2838:
2839: =item * &nickname($uname,$udom)
2840:
2841: Gets a users name and returns it as a string as
2842:
2843: ""nickname""
2844:
2845: if the user has a nickname or
2846:
2847: "first middle last generation"
2848:
2849: if the user does not
2850:
2851: =cut
2852:
2853: sub nickname {
2854: my ($uname,$udom)=@_;
2855: return if (!defined($uname) || !defined($udom));
2856: my %names=&getnames($uname,$udom);
2857: my $name=$names{'nickname'};
2858: if ($name) {
2859: $name='"'.$name.'"';
2860: } else {
2861: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2862: $names{'lastname'}.' '.$names{'generation'};
2863: $name=~s/\s+$//;
2864: $name=~s/\s+/ /g;
2865: }
2866: return $name;
2867: }
2868:
2869: sub getnames {
2870: my ($uname,$udom)=@_;
2871: return if (!defined($uname) || !defined($udom));
2872: if ($udom eq 'public' && $uname eq 'public') {
2873: return ('lastname' => &mt('Public'));
2874: }
2875: my $id=$uname.':'.$udom;
2876: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2877: if ($cached) {
2878: return %{$names};
2879: } else {
2880: my %loadnames=&Apache::lonnet::get('environment',
2881: ['firstname','middlename','lastname','generation','nickname'],
2882: $udom,$uname);
2883: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2884: return %loadnames;
2885: }
2886: }
2887:
2888: # -------------------------------------------------------------------- getemails
2889:
2890: =pod
2891:
2892: =item * &getemails($uname,$udom)
2893:
2894: Gets a user's email information and returns it as a hash with keys:
2895: notification, critnotification, permanentemail
2896:
2897: For notification and critnotification, values are comma-separated lists
2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
2899:
2900:
2901: =cut
2902:
2903:
2904: sub getemails {
2905: my ($uname,$udom)=@_;
2906: if ($udom eq 'public' && $uname eq 'public') {
2907: return;
2908: }
2909: if (!$udom) { $udom=$env{'user.domain'}; }
2910: if (!$uname) { $uname=$env{'user.name'}; }
2911: my $id=$uname.':'.$udom;
2912: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2913: if ($cached) {
2914: return %{$names};
2915: } else {
2916: my %loadnames=&Apache::lonnet::get('environment',
2917: ['notification','critnotification',
2918: 'permanentemail'],
2919: $udom,$uname);
2920: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2921: return %loadnames;
2922: }
2923: }
2924:
2925: sub flush_email_cache {
2926: my ($uname,$udom)=@_;
2927: if (!$udom) { $udom =$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: return if ($udom eq 'public' && $uname eq 'public');
2930: my $id=$uname.':'.$udom;
2931: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2932: }
2933:
2934: # -------------------------------------------------------------------- getlangs
2935:
2936: =pod
2937:
2938: =item * &getlangs($uname,$udom)
2939:
2940: Gets a user's language preference and returns it as a hash with key:
2941: language.
2942:
2943: =cut
2944:
2945:
2946: sub getlangs {
2947: my ($uname,$udom) = @_;
2948: if (!$udom) { $udom =$env{'user.domain'}; }
2949: if (!$uname) { $uname=$env{'user.name'}; }
2950: my $id=$uname.':'.$udom;
2951: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2952: if ($cached) {
2953: return %{$langs};
2954: } else {
2955: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2956: $udom,$uname);
2957: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2958: return %loadlangs;
2959: }
2960: }
2961:
2962: sub flush_langs_cache {
2963: my ($uname,$udom)=@_;
2964: if (!$udom) { $udom =$env{'user.domain'}; }
2965: if (!$uname) { $uname=$env{'user.name'}; }
2966: return if ($udom eq 'public' && $uname eq 'public');
2967: my $id=$uname.':'.$udom;
2968: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2969: }
2970:
2971: # ------------------------------------------------------------------ Screenname
2972:
2973: =pod
2974:
2975: =item * &screenname($uname,$udom)
2976:
2977: Gets a users screenname and returns it as a string
2978:
2979: =cut
2980:
2981: sub screenname {
2982: my ($uname,$udom)=@_;
2983: if ($uname eq $env{'user.name'} &&
2984: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
2985: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
2986: return $names{'screenname'};
2987: }
2988:
2989:
2990: # ------------------------------------------------------------- Confirm Wrapper
2991: =pod
2992:
2993: =item confirmwrapper
2994:
2995: Wrap messages about completion of operation in box
2996:
2997: =cut
2998:
2999: sub confirmwrapper {
3000: my ($message)=@_;
3001: if ($message) {
3002: return "\n".'<div class="LC_confirm_box">'."\n"
3003: .$message."\n"
3004: .'</div>'."\n";
3005: } else {
3006: return $message;
3007: }
3008: }
3009:
3010: # ------------------------------------------------------------- Message Wrapper
3011:
3012: sub messagewrapper {
3013: my ($link,$username,$domain,$subject,$text)=@_;
3014: return
3015: '<a href="/adm/email?compose=individual&'.
3016: 'recname='.$username.'&recdom='.$domain.
3017: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
3018: 'title="'.&mt('Send message').'">'.$link.'</a>';
3019: }
3020:
3021: # --------------------------------------------------------------- Notes Wrapper
3022:
3023: sub noteswrapper {
3024: my ($link,$un,$do)=@_;
3025: return
3026: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
3027: }
3028:
3029: # ------------------------------------------------------------- Aboutme Wrapper
3030:
3031: sub aboutmewrapper {
3032: my ($link,$username,$domain,$target)=@_;
3033: if (!defined($username) && !defined($domain)) {
3034: return;
3035: }
3036: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
3037: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
3038: }
3039:
3040: # ------------------------------------------------------------ Syllabus Wrapper
3041:
3042: sub syllabuswrapper {
3043: my ($linktext,$coursedir,$domain)=@_;
3044: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
3045: }
3046:
3047: # -----------------------------------------------------------------------------
3048:
3049: sub track_student_link {
3050: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
3051: my $link ="/adm/trackstudent?";
3052: my $title = 'View recent activity';
3053: if (defined($sname) && $sname !~ /^\s*$/ &&
3054: defined($sdom) && $sdom !~ /^\s*$/) {
3055: $link .= "selected_student=$sname:$sdom";
3056: $title .= ' of this student';
3057: }
3058: if (defined($target) && $target !~ /^\s*$/) {
3059: $target = qq{target="$target"};
3060: } else {
3061: $target = '';
3062: }
3063: if ($start) { $link.='&start='.$start; }
3064: if ($only_body) { $link .= '&only_body=1'; }
3065: $title = &mt($title);
3066: $linktext = &mt($linktext);
3067: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3068: &help_open_topic('View_recent_activity');
3069: }
3070:
3071: sub slot_reservations_link {
3072: my ($linktext,$sname,$sdom,$target) = @_;
3073: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3074: my $title = 'View slot reservation history';
3075: if (defined($sname) && $sname !~ /^\s*$/ &&
3076: defined($sdom) && $sdom !~ /^\s*$/) {
3077: $link .= "&uname=$sname&udom=$sdom";
3078: $title .= ' of this student';
3079: }
3080: if (defined($target) && $target !~ /^\s*$/) {
3081: $target = qq{target="$target"};
3082: } else {
3083: $target = '';
3084: }
3085: $title = &mt($title);
3086: $linktext = &mt($linktext);
3087: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3089:
3090: }
3091:
3092: # ===================================================== Display a student photo
3093:
3094:
3095: sub student_image_tag {
3096: my ($domain,$user)=@_;
3097: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3098: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3099: return '<img src="'.$imgsrc.'" align="right" />';
3100: } else {
3101: return '';
3102: }
3103: }
3104:
3105: =pod
3106:
3107: =back
3108:
3109: =head1 Access .tab File Data
3110:
3111: =over 4
3112:
3113: =item * &languageids()
3114:
3115: returns list of all language ids
3116:
3117: =cut
3118:
3119: sub languageids {
3120: return sort(keys(%language));
3121: }
3122:
3123: =pod
3124:
3125: =item * &languagedescription()
3126:
3127: returns description of a specified language id
3128:
3129: =cut
3130:
3131: sub languagedescription {
3132: my $code=shift;
3133: return ($supported_language{$code}?'* ':'').
3134: $language{$code}.
3135: ($supported_language{$code}?' ('.&mt('interface available').')':'');
3136: }
3137:
3138: sub plainlanguagedescription {
3139: my $code=shift;
3140: return $language{$code};
3141: }
3142:
3143: sub supportedlanguagecode {
3144: my $code=shift;
3145: return $supported_language{$code};
3146: }
3147:
3148: =pod
3149:
3150: =item * ©rightids()
3151:
3152: returns list of all copyrights
3153:
3154: =cut
3155:
3156: sub copyrightids {
3157: return sort(keys(%cprtag));
3158: }
3159:
3160: =pod
3161:
3162: =item * ©rightdescription()
3163:
3164: returns description of a specified copyright id
3165:
3166: =cut
3167:
3168: sub copyrightdescription {
3169: return &mt($cprtag{shift(@_)});
3170: }
3171:
3172: =pod
3173:
3174: =item * &source_copyrightids()
3175:
3176: returns list of all source copyrights
3177:
3178: =cut
3179:
3180: sub source_copyrightids {
3181: return sort(keys(%scprtag));
3182: }
3183:
3184: =pod
3185:
3186: =item * &source_copyrightdescription()
3187:
3188: returns description of a specified source copyright id
3189:
3190: =cut
3191:
3192: sub source_copyrightdescription {
3193: return &mt($scprtag{shift(@_)});
3194: }
3195:
3196: =pod
3197:
3198: =item * &filecategories()
3199:
3200: returns list of all file categories
3201:
3202: =cut
3203:
3204: sub filecategories {
3205: return sort(keys(%category_extensions));
3206: }
3207:
3208: =pod
3209:
3210: =item * &filecategorytypes()
3211:
3212: returns list of file types belonging to a given file
3213: category
3214:
3215: =cut
3216:
3217: sub filecategorytypes {
3218: my ($cat) = @_;
3219: return @{$category_extensions{lc($cat)}};
3220: }
3221:
3222: =pod
3223:
3224: =item * &fileembstyle()
3225:
3226: returns embedding style for a specified file type
3227:
3228: =cut
3229:
3230: sub fileembstyle {
3231: return $fe{lc(shift(@_))};
3232: }
3233:
3234: sub filemimetype {
3235: return $fm{lc(shift(@_))};
3236: }
3237:
3238:
3239: sub filecategoryselect {
3240: my ($name,$value)=@_;
3241: return &select_form($value,$name,
3242: '' => &mt('Any category'),
3243: map { $_,$_ } sort(keys(%category_extensions)));
3244: }
3245:
3246: =pod
3247:
3248: =item * &filedescription()
3249:
3250: returns description for a specified file type
3251:
3252: =cut
3253:
3254: sub filedescription {
3255: my $file_description = $fd{lc(shift())};
3256: $file_description =~ s:([\[\]]):~$1:g;
3257: return &mt($file_description);
3258: }
3259:
3260: =pod
3261:
3262: =item * &filedescriptionex()
3263:
3264: returns description for a specified file type with
3265: extra formatting
3266:
3267: =cut
3268:
3269: sub filedescriptionex {
3270: my $ex=shift;
3271: my $file_description = $fd{lc($ex)};
3272: $file_description =~ s:([\[\]]):~$1:g;
3273: return '.'.$ex.' '.&mt($file_description);
3274: }
3275:
3276: # End of .tab access
3277: =pod
3278:
3279: =back
3280:
3281: =cut
3282:
3283: # ------------------------------------------------------------------ File Types
3284: sub fileextensions {
3285: return sort(keys(%fe));
3286: }
3287:
3288: # ----------------------------------------------------------- Display Languages
3289: # returns a hash with all desired display languages
3290: #
3291:
3292: sub display_languages {
3293: my %languages=();
3294: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
3295: $languages{$lang}=1;
3296: }
3297: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
3298: if ($env{'form.displaylanguage'}) {
3299: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3300: $languages{$lang}=1;
3301: }
3302: }
3303: return %languages;
3304: }
3305:
3306: sub languages {
3307: my ($possible_langs) = @_;
3308: my @preferred_langs = &Apache::lonlocal::preferred_languages();
3309: if (!ref($possible_langs)) {
3310: if( wantarray ) {
3311: return @preferred_langs;
3312: } else {
3313: return $preferred_langs[0];
3314: }
3315: }
3316: my %possibilities = map { $_ => 1 } (@$possible_langs);
3317: my @preferred_possibilities;
3318: foreach my $preferred_lang (@preferred_langs) {
3319: if (exists($possibilities{$preferred_lang})) {
3320: push(@preferred_possibilities, $preferred_lang);
3321: }
3322: }
3323: if( wantarray ) {
3324: return @preferred_possibilities;
3325: }
3326: return $preferred_possibilities[0];
3327: }
3328:
3329: sub user_lang {
3330: my ($touname,$toudom,$fromcid) = @_;
3331: my @userlangs;
3332: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3333: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3334: $env{'course.'.$fromcid.'.languages'}));
3335: } else {
3336: my %langhash = &getlangs($touname,$toudom);
3337: if ($langhash{'languages'} ne '') {
3338: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3339: } else {
3340: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3341: if ($domdefs{'lang_def'} ne '') {
3342: @userlangs = ($domdefs{'lang_def'});
3343: }
3344: }
3345: }
3346: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3347: my $user_lh = Apache::localize->get_handle(@languages);
3348: return $user_lh;
3349: }
3350:
3351:
3352: ###############################################################
3353: ## Student Answer Attempts ##
3354: ###############################################################
3355:
3356: =pod
3357:
3358: =head1 Alternate Problem Views
3359:
3360: =over 4
3361:
3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
3363: $getattempt, $regexp, $gradesub)
3364:
3365: Return string with previous attempt on problem. Arguments:
3366:
3367: =over 4
3368:
3369: =item * $symb: Problem, including path
3370:
3371: =item * $username: username of the desired student
3372:
3373: =item * $domain: domain of the desired student
3374:
3375: =item * $course: Course ID
3376:
3377: =item * $getattempt: Leave blank for all attempts, otherwise put
3378: something
3379:
3380: =item * $regexp: if string matches this regexp, the string will be
3381: sent to $gradesub
3382:
3383: =item * $gradesub: routine that processes the string if it matches $regexp
3384:
3385: =back
3386:
3387: The output string is a table containing all desired attempts, if any.
3388:
3389: =cut
3390:
3391: sub get_previous_attempt {
3392: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
3393: my $prevattempts='';
3394: no strict 'refs';
3395: if ($symb) {
3396: my (%returnhash)=
3397: &Apache::lonnet::restore($symb,$course,$domain,$username);
3398: if ($returnhash{'version'}) {
3399: my %lasthash=();
3400: my $version;
3401: for ($version=1;$version<=$returnhash{'version'};$version++) {
3402: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3403: $lasthash{$key}=$returnhash{$version.':'.$key};
3404: }
3405: }
3406: $prevattempts=&start_data_table().&start_data_table_header_row();
3407: $prevattempts.='<th>'.&mt('History').'</th>';
3408: foreach my $key (sort(keys(%lasthash))) {
3409: my ($ign,@parts) = split(/\./,$key);
3410: if ($#parts > 0) {
3411: my $data=$parts[-1];
3412: pop(@parts);
3413: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
3414: } else {
3415: if ($#parts == 0) {
3416: $prevattempts.='<th>'.$parts[0].'</th>';
3417: } else {
3418: $prevattempts.='<th>'.$ign.'</th>';
3419: }
3420: }
3421: }
3422: $prevattempts.=&end_data_table_header_row();
3423: if ($getattempt eq '') {
3424: for ($version=1;$version<=$returnhash{'version'};$version++) {
3425: $prevattempts.=&start_data_table_row().
3426: '<td>'.&mt('Transaction [_1]',$version).'</td>';
3427: foreach my $key (sort(keys(%lasthash))) {
3428: my $value = &format_previous_attempt_value($key,
3429: $returnhash{$version.':'.$key});
3430: $prevattempts.='<td>'.$value.' </td>';
3431: }
3432: $prevattempts.=&end_data_table_row();
3433: }
3434: }
3435: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
3436: foreach my $key (sort(keys(%lasthash))) {
3437: my $value = &format_previous_attempt_value($key,$lasthash{$key});
3438: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
3439: $prevattempts.='<td>'.$value.' </td>';
3440: }
3441: $prevattempts.= &end_data_table_row().&end_data_table();
3442: } else {
3443: $prevattempts=
3444: &start_data_table().&start_data_table_row().
3445: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3446: &end_data_table_row().&end_data_table();
3447: }
3448: } else {
3449: $prevattempts=
3450: &start_data_table().&start_data_table_row().
3451: '<td>'.&mt('No data.').'</td>'.
3452: &end_data_table_row().&end_data_table();
3453: }
3454: }
3455:
3456: sub format_previous_attempt_value {
3457: my ($key,$value) = @_;
3458: if ($key =~ /timestamp/) {
3459: $value = &Apache::lonlocal::locallocaltime($value);
3460: } elsif (ref($value) eq 'ARRAY') {
3461: $value = '('.join(', ', @{ $value }).')';
3462: } else {
3463: $value = &unescape($value);
3464: }
3465: return $value;
3466: }
3467:
3468:
3469: sub relative_to_absolute {
3470: my ($url,$output)=@_;
3471: my $parser=HTML::TokeParser->new(\$output);
3472: my $token;
3473: my $thisdir=$url;
3474: my @rlinks=();
3475: while ($token=$parser->get_token) {
3476: if ($token->[0] eq 'S') {
3477: if ($token->[1] eq 'a') {
3478: if ($token->[2]->{'href'}) {
3479: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3480: }
3481: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3482: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3483: } elsif ($token->[1] eq 'base') {
3484: $thisdir=$token->[2]->{'href'};
3485: }
3486: }
3487: }
3488: $thisdir=~s-/[^/]*$--;
3489: foreach my $link (@rlinks) {
3490: unless (($link=~/^https?\:\/\//i) ||
3491: ($link=~/^\//) ||
3492: ($link=~/^javascript:/i) ||
3493: ($link=~/^mailto:/i) ||
3494: ($link=~/^\#/)) {
3495: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3496: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
3497: }
3498: }
3499: # -------------------------------------------------- Deal with Applet codebases
3500: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3501: return $output;
3502: }
3503:
3504: =pod
3505:
3506: =item * &get_student_view()
3507:
3508: show a snapshot of what student was looking at
3509:
3510: =cut
3511:
3512: sub get_student_view {
3513: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
3514: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
3515: my (%form);
3516: my @elements=('symb','courseid','domain','username');
3517: foreach my $element (@elements) {
3518: $form{'grade_'.$element}=eval '$'.$element #'
3519: }
3520: if (defined($moreenv)) {
3521: %form=(%form,%{$moreenv});
3522: }
3523: if (defined($target)) { $form{'grade_target'} = $target; }
3524: $feedurl=&Apache::lonnet::clutter($feedurl);
3525: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
3526: $userview=~s/\<body[^\>]*\>//gi;
3527: $userview=~s/\<\/body\>//gi;
3528: $userview=~s/\<html\>//gi;
3529: $userview=~s/\<\/html\>//gi;
3530: $userview=~s/\<head\>//gi;
3531: $userview=~s/\<\/head\>//gi;
3532: $userview=~s/action\s*\=/would_be_action\=/gi;
3533: $userview=&relative_to_absolute($feedurl,$userview);
3534: if (wantarray) {
3535: return ($userview,$response);
3536: } else {
3537: return $userview;
3538: }
3539: }
3540:
3541: sub get_student_view_with_retries {
3542: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3543:
3544: my $ok = 0; # True if we got a good response.
3545: my $content;
3546: my $response;
3547:
3548: # Try to get the student_view done. within the retries count:
3549:
3550: do {
3551: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3552: $ok = $response->is_success;
3553: if (!$ok) {
3554: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3555: }
3556: $retries--;
3557: } while (!$ok && ($retries > 0));
3558:
3559: if (!$ok) {
3560: $content = ''; # On error return an empty content.
3561: }
3562: if (wantarray) {
3563: return ($content, $response);
3564: } else {
3565: return $content;
3566: }
3567: }
3568:
3569: =pod
3570:
3571: =item * &get_student_answers()
3572:
3573: show a snapshot of how student was answering problem
3574:
3575: =cut
3576:
3577: sub get_student_answers {
3578: my ($symb,$username,$domain,$courseid,%form) = @_;
3579: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
3580: my (%moreenv);
3581: my @elements=('symb','courseid','domain','username');
3582: foreach my $element (@elements) {
3583: $moreenv{'grade_'.$element}=eval '$'.$element #'
3584: }
3585: $moreenv{'grade_target'}='answer';
3586: %moreenv=(%form,%moreenv);
3587: $feedurl = &Apache::lonnet::clutter($feedurl);
3588: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
3589: return $userview;
3590: }
3591:
3592: =pod
3593:
3594: =item * &submlink()
3595:
3596: Inputs: $text $uname $udom $symb $target
3597:
3598: Returns: A link to grades.pm such as to see the SUBM view of a student
3599:
3600: =cut
3601:
3602: ###############################################
3603: sub submlink {
3604: my ($text,$uname,$udom,$symb,$target)=@_;
3605: if (!($uname && $udom)) {
3606: (my $cursymb, my $courseid,$udom,$uname)=
3607: &Apache::lonnet::whichuser($symb);
3608: if (!$symb) { $symb=$cursymb; }
3609: }
3610: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
3611: $symb=&escape($symb);
3612: if ($target) { $target="target=\"$target\""; }
3613: return '<a href="/adm/grades?&command=submission&'.
3614: 'symb='.$symb.'&student='.$uname.
3615: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3616: }
3617: ##############################################
3618:
3619: =pod
3620:
3621: =item * &pgrdlink()
3622:
3623: Inputs: $text $uname $udom $symb $target
3624:
3625: Returns: A link to grades.pm such as to see the PGRD view of a student
3626:
3627: =cut
3628:
3629: ###############################################
3630: sub pgrdlink {
3631: my $link=&submlink(@_);
3632: $link=~s/(&command=submission)/$1&showgrading=yes/;
3633: return $link;
3634: }
3635: ##############################################
3636:
3637: =pod
3638:
3639: =item * &pprmlink()
3640:
3641: Inputs: $text $uname $udom $symb $target
3642:
3643: Returns: A link to parmset.pm such as to see the PPRM view of a
3644: student and a specific resource
3645:
3646: =cut
3647:
3648: ###############################################
3649: sub pprmlink {
3650: my ($text,$uname,$udom,$symb,$target)=@_;
3651: if (!($uname && $udom)) {
3652: (my $cursymb, my $courseid,$udom,$uname)=
3653: &Apache::lonnet::whichuser($symb);
3654: if (!$symb) { $symb=$cursymb; }
3655: }
3656: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
3657: $symb=&escape($symb);
3658: if ($target) { $target="target=\"$target\""; }
3659: return '<a href="/adm/parmset?command=set&'.
3660: 'symb='.$symb.'&uname='.$uname.
3661: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
3662: }
3663: ##############################################
3664:
3665: =pod
3666:
3667: =back
3668:
3669: =cut
3670:
3671: ###############################################
3672:
3673:
3674: sub timehash {
3675: my ($thistime) = @_;
3676: my $timezone = &Apache::lonlocal::gettimezone();
3677: my $dt = DateTime->from_epoch(epoch => $thistime)
3678: ->set_time_zone($timezone);
3679: my $wday = $dt->day_of_week();
3680: if ($wday == 7) { $wday = 0; }
3681: return ( 'second' => $dt->second(),
3682: 'minute' => $dt->minute(),
3683: 'hour' => $dt->hour(),
3684: 'day' => $dt->day_of_month(),
3685: 'month' => $dt->month(),
3686: 'year' => $dt->year(),
3687: 'weekday' => $wday,
3688: 'dayyear' => $dt->day_of_year(),
3689: 'dlsav' => $dt->is_dst() );
3690: }
3691:
3692: sub utc_string {
3693: my ($date)=@_;
3694: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
3695: }
3696:
3697: sub maketime {
3698: my %th=@_;
3699: my ($epoch_time,$timezone,$dt);
3700: $timezone = &Apache::lonlocal::gettimezone();
3701: eval {
3702: $dt = DateTime->new( year => $th{'year'},
3703: month => $th{'month'},
3704: day => $th{'day'},
3705: hour => $th{'hour'},
3706: minute => $th{'minute'},
3707: second => $th{'second'},
3708: time_zone => $timezone,
3709: );
3710: };
3711: if (!$@) {
3712: $epoch_time = $dt->epoch;
3713: if ($epoch_time) {
3714: return $epoch_time;
3715: }
3716: }
3717: return POSIX::mktime(
3718: ($th{'seconds'},$th{'minutes'},$th{'hours'},
3719: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
3720: }
3721:
3722: #########################################
3723:
3724: sub findallcourses {
3725: my ($roles,$uname,$udom) = @_;
3726: my %roles;
3727: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
3728: my %courses;
3729: my $now=time;
3730: if (!defined($uname)) {
3731: $uname = $env{'user.name'};
3732: }
3733: if (!defined($udom)) {
3734: $udom = $env{'user.domain'};
3735: }
3736: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3737: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3738: if (!%roles) {
3739: %roles = (
3740: cc => 1,
3741: co => 1,
3742: in => 1,
3743: ep => 1,
3744: ta => 1,
3745: cr => 1,
3746: st => 1,
3747: );
3748: }
3749: foreach my $entry (keys(%roleshash)) {
3750: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3751: if ($trole =~ /^cr/) {
3752: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3753: } else {
3754: next if (!exists($roles{$trole}));
3755: }
3756: if ($tend) {
3757: next if ($tend < $now);
3758: }
3759: if ($tstart) {
3760: next if ($tstart > $now);
3761: }
3762: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3763: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3764: if ($secpart eq '') {
3765: ($cnum,$role) = split(/_/,$cnumpart);
3766: $sec = 'none';
3767: $realsec = '';
3768: } else {
3769: $cnum = $cnumpart;
3770: ($sec,$role) = split(/_/,$secpart);
3771: $realsec = $sec;
3772: }
3773: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3774: }
3775: } else {
3776: foreach my $key (keys(%env)) {
3777: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3778: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
3779: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3780: next if ($role eq 'ca' || $role eq 'aa');
3781: next if (%roles && !exists($roles{$role}));
3782: my ($starttime,$endtime)=split(/\./,$env{$key});
3783: my $active=1;
3784: if ($starttime) {
3785: if ($now<$starttime) { $active=0; }
3786: }
3787: if ($endtime) {
3788: if ($now>$endtime) { $active=0; }
3789: }
3790: if ($active) {
3791: if ($sec eq '') {
3792: $sec = 'none';
3793: }
3794: $courses{$cdom.'_'.$cnum}{$sec} =
3795: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
3796: }
3797: }
3798: }
3799: }
3800: return %courses;
3801: }
3802:
3803: ###############################################
3804:
3805: sub blockcheck {
3806: my ($setters,$activity,$uname,$udom) = @_;
3807:
3808: if (!defined($udom)) {
3809: $udom = $env{'user.domain'};
3810: }
3811: if (!defined($uname)) {
3812: $uname = $env{'user.name'};
3813: }
3814:
3815: # If uname and udom are for a course, check for blocks in the course.
3816:
3817: if (&Apache::lonnet::is_course($udom,$uname)) {
3818: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
3819: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
3820: return ($startblock,$endblock);
3821: }
3822:
3823: my $startblock = 0;
3824: my $endblock = 0;
3825: my %live_courses = &findallcourses(undef,$uname,$udom);
3826:
3827: # If uname is for a user, and activity is course-specific, i.e.,
3828: # boards, chat or groups, check for blocking in current course only.
3829:
3830: if (($activity eq 'boards' || $activity eq 'chat' ||
3831: $activity eq 'groups') && ($env{'request.course.id'})) {
3832: foreach my $key (keys(%live_courses)) {
3833: if ($key ne $env{'request.course.id'}) {
3834: delete($live_courses{$key});
3835: }
3836: }
3837: }
3838:
3839: my $otheruser = 0;
3840: my %own_courses;
3841: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3842: # Resource belongs to user other than current user.
3843: $otheruser = 1;
3844: # Gather courses for current user
3845: %own_courses =
3846: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3847: }
3848:
3849: # Gather active course roles - course coordinator, instructor,
3850: # exam proctor, ta, student, or custom role.
3851:
3852: foreach my $course (keys(%live_courses)) {
3853: my ($cdom,$cnum);
3854: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3855: $cdom = $env{'course.'.$course.'.domain'};
3856: $cnum = $env{'course.'.$course.'.num'};
3857: } else {
3858: ($cdom,$cnum) = split(/_/,$course);
3859: }
3860: my $no_ownblock = 0;
3861: my $no_userblock = 0;
3862: if ($otheruser && $activity ne 'com') {
3863: # Check if current user has 'evb' priv for this
3864: if (defined($own_courses{$course})) {
3865: foreach my $sec (keys(%{$own_courses{$course}})) {
3866: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3867: if ($sec ne 'none') {
3868: $checkrole .= '/'.$sec;
3869: }
3870: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3871: $no_ownblock = 1;
3872: last;
3873: }
3874: }
3875: }
3876: # if they have 'evb' priv and are currently not playing student
3877: next if (($no_ownblock) &&
3878: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3879: }
3880: foreach my $sec (keys(%{$live_courses{$course}})) {
3881: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3882: if ($sec ne 'none') {
3883: $checkrole .= '/'.$sec;
3884: }
3885: if ($otheruser) {
3886: # Resource belongs to user other than current user.
3887: # Assemble privs for that user, and check for 'evb' priv.
3888: my ($trole,$tdom,$tnum,$tsec);
3889: my $entry = $live_courses{$course}{$sec};
3890: if ($entry =~ /^cr/) {
3891: ($trole,$tdom,$tnum,$tsec) =
3892: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3893: } else {
3894: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3895: }
3896: my ($spec,$area,$trest,%allroles,%userroles);
3897: $area = '/'.$tdom.'/'.$tnum;
3898: $trest = $tnum;
3899: if ($tsec ne '') {
3900: $area .= '/'.$tsec;
3901: $trest .= '/'.$tsec;
3902: }
3903: $spec = $trole.'.'.$area;
3904: if ($trole =~ /^cr/) {
3905: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3906: $tdom,$spec,$trest,$area);
3907: } else {
3908: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3909: $tdom,$spec,$trest,$area);
3910: }
3911: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
3912: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3913: if ($1) {
3914: $no_userblock = 1;
3915: last;
3916: }
3917: }
3918: } else {
3919: # Resource belongs to current user
3920: # Check for 'evb' priv via lonnet::allowed().
3921: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3922: $no_ownblock = 1;
3923: last;
3924: }
3925: }
3926: }
3927: # if they have the evb priv and are currently not playing student
3928: next if (($no_ownblock) &&
3929: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
3930: next if ($no_userblock);
3931:
3932: # Retrieve blocking times and identity of locker for course
3933: # of specified user, unless user has 'evb' privilege.
3934:
3935: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3936: if (($start != 0) &&
3937: (($startblock == 0) || ($startblock > $start))) {
3938: $startblock = $start;
3939: }
3940: if (($end != 0) &&
3941: (($endblock == 0) || ($endblock < $end))) {
3942: $endblock = $end;
3943: }
3944: }
3945: return ($startblock,$endblock);
3946: }
3947:
3948: sub get_blocks {
3949: my ($setters,$activity,$cdom,$cnum) = @_;
3950: my $startblock = 0;
3951: my $endblock = 0;
3952: my $course = $cdom.'_'.$cnum;
3953: $setters->{$course} = {};
3954: $setters->{$course}{'staff'} = [];
3955: $setters->{$course}{'times'} = [];
3956: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3957: foreach my $record (keys(%records)) {
3958: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3959: if ($start <= time && $end >= time) {
3960: my ($staff_name,$staff_dom,$title,$blocks) =
3961: &parse_block_record($records{$record});
3962: if ($blocks->{$activity} eq 'on') {
3963: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3964: push(@{$$setters{$course}{'times'}}, [$start,$end]);
3965: if ( ($startblock == 0) || ($startblock > $start) ) {
3966: $startblock = $start;
3967: }
3968: if ( ($endblock == 0) || ($endblock < $end) ) {
3969: $endblock = $end;
3970: }
3971: }
3972: }
3973: }
3974: return ($startblock,$endblock);
3975: }
3976:
3977: sub parse_block_record {
3978: my ($record) = @_;
3979: my ($setuname,$setudom,$title,$blocks);
3980: if (ref($record) eq 'HASH') {
3981: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3982: $title = &unescape($record->{'event'});
3983: $blocks = $record->{'blocks'};
3984: } else {
3985: my @data = split(/:/,$record,3);
3986: if (scalar(@data) eq 2) {
3987: $title = $data[1];
3988: ($setuname,$setudom) = split(/@/,$data[0]);
3989: } else {
3990: ($setuname,$setudom,$title) = @data;
3991: }
3992: $blocks = { 'com' => 'on' };
3993: }
3994: return ($setuname,$setudom,$title,$blocks);
3995: }
3996:
3997: sub blocking_status {
3998: my ($activity,$uname,$udom) = @_;
3999: my %setters;
4000:
4001: # check for active blocking
4002: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
4003:
4004: my $blocked = $startblock && $endblock ? 1 : 0;
4005:
4006: # caller just wants to know whether a block is active
4007: if (!wantarray) { return $blocked; }
4008:
4009: # build a link to a popup window containing the details
4010: my $querystring = "?activity=$activity";
4011: # $uname and $udom decide whose portfolio the user is trying to look at
4012: $querystring .= "&udom=$udom" if $udom;
4013: $querystring .= "&uname=$uname" if $uname;
4014:
4015: my $output .= <<'END_MYBLOCK';
4016: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
4017: var options = "width=" + w + ",height=" + h + ",";
4018: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
4019: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
4020: var newWin = window.open(url, wdwName, options);
4021: newWin.focus();
4022: }
4023: END_MYBLOCK
4024:
4025: $output = Apache::lonhtmlcommon::scripttag($output);
4026:
4027: my $popupUrl = "/adm/blockingstatus/$querystring";
4028: my $text = mt('Communication Blocked');
4029:
4030: $output .= <<"END_BLOCK";
4031: <div class='LC_comblock'>
4032: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
4033: title='$text'>
4034: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
4035: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
4036: title='$text'>$text</a>
4037: </div>
4038:
4039: END_BLOCK
4040:
4041: return ($blocked, $output);
4042: }
4043:
4044: ###############################################
4045:
4046: sub check_ip_acc {
4047: my ($acc)=@_;
4048: &Apache::lonxml::debug("acc is $acc");
4049: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
4050: return 1;
4051: }
4052: my $allowed=0;
4053: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
4054:
4055: my $name;
4056: foreach my $pattern (split(',',$acc)) {
4057: $pattern =~ s/^\s*//;
4058: $pattern =~ s/\s*$//;
4059: if ($pattern =~ /\*$/) {
4060: #35.8.*
4061: $pattern=~s/\*//;
4062: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4063: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
4064: #35.8.3.[34-56]
4065: my $low=$2;
4066: my $high=$3;
4067: $pattern=$1;
4068: if ($ip =~ /^\Q$pattern\E/) {
4069: my $last=(split(/\./,$ip))[3];
4070: if ($last <=$high && $last >=$low) { $allowed=1; }
4071: }
4072: } elsif ($pattern =~ /^\*/) {
4073: #*.msu.edu
4074: $pattern=~s/\*//;
4075: if (!defined($name)) {
4076: use Socket;
4077: my $netaddr=inet_aton($ip);
4078: ($name)=gethostbyaddr($netaddr,AF_INET);
4079: }
4080: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4081: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
4082: #127.0.0.1
4083: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
4084: } else {
4085: #some.name.com
4086: if (!defined($name)) {
4087: use Socket;
4088: my $netaddr=inet_aton($ip);
4089: ($name)=gethostbyaddr($netaddr,AF_INET);
4090: }
4091: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
4092: }
4093: if ($allowed) { last; }
4094: }
4095: return $allowed;
4096: }
4097:
4098: ###############################################
4099:
4100: =pod
4101:
4102: =head1 Domain Template Functions
4103:
4104: =over 4
4105:
4106: =item * &determinedomain()
4107:
4108: Inputs: $domain (usually will be undef)
4109:
4110: Returns: Determines which domain should be used for designs
4111:
4112: =cut
4113:
4114: ###############################################
4115: sub determinedomain {
4116: my $domain=shift;
4117: if (! $domain) {
4118: # Determine domain if we have not been given one
4119: $domain = &Apache::lonnet::default_login_domain();
4120: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
4121: if ($env{'request.role.domain'}) {
4122: $domain=$env{'request.role.domain'};
4123: }
4124: }
4125: return $domain;
4126: }
4127: ###############################################
4128:
4129: sub devalidate_domconfig_cache {
4130: my ($udom)=@_;
4131: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
4132: }
4133:
4134: # ---------------------- Get domain configuration for a domain
4135: sub get_domainconf {
4136: my ($udom) = @_;
4137: my $cachetime=1800;
4138: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
4139: if (defined($cached)) { return %{$result}; }
4140:
4141: my %domconfig = &Apache::lonnet::get_dom('configuration',
4142: ['login','rolecolors'],$udom);
4143: my (%designhash,%legacy);
4144: if (keys(%domconfig) > 0) {
4145: if (ref($domconfig{'login'}) eq 'HASH') {
4146: if (keys(%{$domconfig{'login'}})) {
4147: foreach my $key (keys(%{$domconfig{'login'}})) {
4148: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
4149: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
4150: $designhash{$udom.'.login.'.$key.'_'.$img} =
4151: $domconfig{'login'}{$key}{$img};
4152: }
4153: } else {
4154: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
4155: }
4156: }
4157: } else {
4158: $legacy{'login'} = 1;
4159: }
4160: } else {
4161: $legacy{'login'} = 1;
4162: }
4163: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
4164: if (keys(%{$domconfig{'rolecolors'}})) {
4165: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
4166: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
4167: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
4168: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
4169: }
4170: }
4171: }
4172: } else {
4173: $legacy{'rolecolors'} = 1;
4174: }
4175: } else {
4176: $legacy{'rolecolors'} = 1;
4177: }
4178: if (keys(%legacy) > 0) {
4179: my %legacyhash = &get_legacy_domconf($udom);
4180: foreach my $item (keys(%legacyhash)) {
4181: if ($item =~ /^\Q$udom\E\.login/) {
4182: if ($legacy{'login'}) {
4183: $designhash{$item} = $legacyhash{$item};
4184: }
4185: } else {
4186: if ($legacy{'rolecolors'}) {
4187: $designhash{$item} = $legacyhash{$item};
4188: }
4189: }
4190: }
4191: }
4192: } else {
4193: %designhash = &get_legacy_domconf($udom);
4194: }
4195: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4196: $cachetime);
4197: return %designhash;
4198: }
4199:
4200: sub get_legacy_domconf {
4201: my ($udom) = @_;
4202: my %legacyhash;
4203: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4204: my $designfile = $designdir.'/'.$udom.'.tab';
4205: if (-e $designfile) {
4206: if ( open (my $fh,"<$designfile") ) {
4207: while (my $line = <$fh>) {
4208: next if ($line =~ /^\#/);
4209: chomp($line);
4210: my ($key,$val)=(split(/\=/,$line));
4211: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4212: }
4213: close($fh);
4214: }
4215: }
4216: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4217: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4218: }
4219: return %legacyhash;
4220: }
4221:
4222: =pod
4223:
4224: =item * &domainlogo()
4225:
4226: Inputs: $domain (usually will be undef)
4227:
4228: Returns: A link to a domain logo, if the domain logo exists.
4229: If the domain logo does not exist, a description of the domain.
4230:
4231: =cut
4232:
4233: ###############################################
4234: sub domainlogo {
4235: my $domain = &determinedomain(shift);
4236: my %designhash = &get_domainconf($domain);
4237: # See if there is a logo
4238: if ($designhash{$domain.'.login.domlogo'} ne '') {
4239: my $imgsrc = $designhash{$domain.'.login.domlogo'};
4240: if ($imgsrc =~ m{^/(adm|res)/}) {
4241: if ($imgsrc =~ m{^/res/}) {
4242: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4243: &Apache::lonnet::repcopy($local_name);
4244: }
4245: $imgsrc = &lonhttpdurl($imgsrc);
4246: }
4247: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
4248: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4249: return &Apache::lonnet::domain($domain,'description');
4250: } else {
4251: return '';
4252: }
4253: }
4254: ##############################################
4255:
4256: =pod
4257:
4258: =item * &designparm()
4259:
4260: Inputs: $which parameter; $domain (usually will be undef)
4261:
4262: Returns: value of designparamter $which
4263:
4264: =cut
4265:
4266:
4267: ##############################################
4268: sub designparm {
4269: my ($which,$domain)=@_;
4270: if (exists($env{'environment.color.'.$which})) {
4271: return $env{'environment.color.'.$which};
4272: }
4273: $domain=&determinedomain($domain);
4274: my %domdesign = &get_domainconf($domain);
4275: my $output;
4276: if ($domdesign{$domain.'.'.$which} ne '') {
4277: $output = $domdesign{$domain.'.'.$which};
4278: } else {
4279: $output = $defaultdesign{$which};
4280: }
4281: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
4282: ($which =~ /login\.(img|logo|domlogo|login)/)) {
4283: if ($output =~ m{^/(adm|res)/}) {
4284: if ($output =~ m{^/res/}) {
4285: my $local_name = &Apache::lonnet::filelocation('',$output);
4286: &Apache::lonnet::repcopy($local_name);
4287: }
4288: $output = &lonhttpdurl($output);
4289: }
4290: }
4291: return $output;
4292: }
4293:
4294: ##############################################
4295: =pod
4296:
4297: =item * &authorspace()
4298:
4299: Inputs: ./.
4300:
4301: Returns: Path to the Construction Space of the current user's
4302: accessed author space
4303: The author space will be that of the current user
4304: when accessing the own author space
4305: and that of the co-author/assistent co-author
4306: when accessing the co-author's/assistent co-author's
4307: space
4308:
4309: =cut
4310:
4311: sub authorspace {
4312: my $caname = '';
4313: if ($env{'request.role'} =~ /^ca|^aa/) {
4314: (undef,$caname) =
4315: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
4316: } else {
4317: $caname = $env{'user.name'};
4318: }
4319: return '/priv/'.$caname.'/';
4320: }
4321:
4322: ##############################################
4323: =pod
4324:
4325: =item * &head_subbox()
4326:
4327: Inputs: $content (contains HTML code with page functions, etc.)
4328:
4329: Returns: HTML div with $content
4330: To be included in page header
4331:
4332: =cut
4333:
4334: sub head_subbox {
4335: my ($content)=@_;
4336: my $output =
4337: '<div id="LC_head_subbox">'
4338: .$content
4339: .'</div>'
4340: }
4341:
4342: ##############################################
4343: =pod
4344:
4345: =item * &CSTR_pageheader()
4346:
4347: Inputs: ./.
4348:
4349: Returns: HTML div with CSTR path and recent box
4350: To be included on Construction Space pages
4351:
4352: =cut
4353:
4354: sub CSTR_pageheader {
4355: # this is for resources; directories have customtitle, and crumbs
4356: # and select recent are created in lonpubdir.pm
4357: my ($uname,$thisdisfn)=
4358: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
4359: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4360: $formaction=~s/\/+/\//g;
4361:
4362: my $parentpath = '';
4363: my $lastitem = '';
4364: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4365: $parentpath = $1;
4366: $lastitem = $2;
4367: } else {
4368: $lastitem = $thisdisfn;
4369: }
4370:
4371: my $output =
4372: '<div>'
4373: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
4374: .'<b>'.&mt('Construction Space:').'</b> '
4375: .'<form name="dirs" method="post" action="'.$formaction
4376: .'" target="_top">' #FIXME lonpubdir: target="_parent"
4377: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
4378:
4379: if ($lastitem) {
4380: $output .=
4381: '<span class="LC_filename">'
4382: .$lastitem
4383: .'</span>';
4384: }
4385: $output .=
4386: '<br />'
4387: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
4388: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4389: .'</form>'
4390: .&Apache::lonmenu::constspaceform()
4391: .'</div>';
4392:
4393: return $output;
4394: }
4395:
4396: ###############################################
4397: ###############################################
4398:
4399: =pod
4400:
4401: =back
4402:
4403: =head1 HTML Helpers
4404:
4405: =over 4
4406:
4407: =item * &bodytag()
4408:
4409: Returns a uniform header for LON-CAPA web pages.
4410:
4411: Inputs:
4412:
4413: =over 4
4414:
4415: =item * $title, A title to be displayed on the page.
4416:
4417: =item * $function, the current role (can be undef).
4418:
4419: =item * $addentries, extra parameters for the <body> tag.
4420:
4421: =item * $bodyonly, if defined, only return the <body> tag.
4422:
4423: =item * $domain, if defined, force a given domain.
4424:
4425: =item * $forcereg, if page should register as content page (relevant for
4426: text interface only)
4427:
4428: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
4429: navigational links
4430:
4431: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4432:
4433: =item * $no_inline_link, if true and in remote mode, don't show the
4434: 'Switch To Inline Menu' link
4435:
4436: =item * $args, optional argument valid values are
4437: no_auto_mt_title -> prevents &mt()ing the title arg
4438: inherit_jsmath -> when creating popup window in a page,
4439: should it have jsmath forced on by the
4440: current page
4441:
4442: =back
4443:
4444: Returns: A uniform header for LON-CAPA web pages.
4445: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4446: If $bodyonly is undef or zero, an html string containing a <body> tag and
4447: other decorations will be returned.
4448:
4449: =cut
4450:
4451: sub bodytag {
4452: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
4453: $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
4454:
4455: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
4456:
4457: $function = &get_users_function() if (!$function);
4458: my $img = &designparm($function.'.img',$domain);
4459: my $font = &designparm($function.'.font',$domain);
4460: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4461:
4462: my %design = ( 'style' => 'margin-top: 0',
4463: 'bgcolor' => $pgbg,
4464: 'text' => $font,
4465: 'alink' => &designparm($function.'.alink',$domain),
4466: 'vlink' => &designparm($function.'.vlink',$domain),
4467: 'link' => &designparm($function.'.link',$domain),);
4468: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
4469:
4470: my $custommenu;
4471: if ($env{'environment.remote'} eq 'off') {
4472: $custommenu = &needs_gci_custom();
4473: }
4474: # role and realm
4475: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4476: if ($role eq 'ca') {
4477: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
4478: $realm = &plainname($rname,$rdom);
4479: }
4480: # realm
4481: if ($env{'request.course.id'}) {
4482: if ($env{'request.role'} !~ /^cr/) {
4483: if (($custommenu) && ($role eq 'cm')) {
4484: undef($role);
4485: } else {
4486: $role = &Apache::lonnet::plaintext($role,&course_type());
4487: }
4488: }
4489: if ($env{'request.course.sec'}) {
4490: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
4491: }
4492: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
4493: } else {
4494: if (($custommenu) && ($role eq 'cm')) {
4495: undef($role);
4496: } else {
4497: $role = &Apache::lonnet::plaintext($role);
4498: }
4499: }
4500:
4501: if (!$realm) { $realm=' '; }
4502: # Set messages
4503: my $messages=&domainlogo($domain);
4504:
4505: my $extra_body_attr = &make_attr_string($forcereg,\%design);
4506:
4507: # construct main body tag
4508: my $bodytag = "<body $extra_body_attr>".
4509: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
4510:
4511: if ($bodyonly) {
4512: return $bodytag;
4513: }
4514:
4515: my $name = &plainname($env{'user.name'},$env{'user.domain'});
4516: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4517: undef($role);
4518: } else {
4519: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
4520: }
4521:
4522: my $titleinfo = '<h1>'.$title.'</h1>';
4523: #
4524: # Extra info if you are the DC
4525: my $dc_info = '';
4526: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4527: $env{'course.'.$env{'request.course.id'}.
4528: '.domain'}.'/'})) {
4529: my $cid = $env{'request.course.id'};
4530: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
4531: $dc_info =~ s/\s+$//;
4532: }
4533:
4534: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
4535: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
4536:
4537: if ($env{'environment.remote'} eq 'off') {
4538: # No Remote
4539: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') {
4540: return $bodytag;
4541: }
4542:
4543: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
4544:
4545: # if ($env{'request.state'} eq 'construct') {
4546: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
4547: # }
4548:
4549: my $role_selector;
4550: if (($custommenu) && ($env{'request.course.id'}) &&
4551: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq 'gcitest') &&
4552: ($env{'request.role'} !~ m{^st\./gcitest/$match_courseid})) {
4553: $role_selector = &Apache::lonmenu::roles_selector(
4554: $env{'course.' . $env{'request.course.id'} . '.domain'},
4555: $env{'course.' . $env{'request.course.id'} . '.num'} );
4556: if ($role_selector) {
4557: $role_selector = '<br />'.$role_selector;
4558: }
4559: }
4560:
4561: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
4562: if ($dc_info) {
4563: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
4564: }
4565: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
4566: <em>$realm</em> $dc_info</div>|;
4567: return $bodytag;
4568: }
4569:
4570: $bodytag .= qq|<div id="LC_nav_bar">$name $role $role_selector</div>|;
4571:
4572: $bodytag .= Apache::lonhtmlcommon::scripttag(
4573: Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
4574:
4575: $bodytag .= Apache::lonmenu::primary_menu();
4576:
4577: if ($dc_info) {
4578: $dc_info = &dc_courseid_toggle($dc_info);
4579: }
4580: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
4581:
4582: #don't show menus for public users
4583: if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
4584: if (($custommenu) &&
4585: ($env{'request.role'} !~ m{^st\./gcitest/$match_courseid})) {
4586: $bodytag .= &Apache::lonmenu::gci_secondary_menu();
4587: } else {
4588: $bodytag .= Apache::lonmenu::secondary_menu();
4589: }
4590: $bodytag .= Apache::lonmenu::serverform();
4591: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4592: if ($env{'request.state'} eq 'construct') {
4593: $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
4594: $args->{'bread_crumbs'});
4595: } elsif ($forcereg) {
4596: $bodytag .= &Apache::lonmenu::innerregister($forcereg);
4597: }
4598: }else{
4599: # this is to seperate menu from content when there's no secondary
4600: # menu. Especially needed for public accessible ressources.
4601: $bodytag .= '<hr style="clear:both" />';
4602: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
4603: }
4604:
4605: #SD testing
4606: #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
4607: return $bodytag;
4608: }
4609:
4610: #
4611: # Top frame rendering, Remote is up
4612: #
4613:
4614: my $imgsrc = $img;
4615: if ($img =~ /^\/adm/) {
4616: $imgsrc = &lonhttpdurl($img);
4617: }
4618: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
4619:
4620: # Explicit link to get inline menu
4621: my $menu= ($no_inline_link?''
4622: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
4623:
4624: if ($dc_info) {
4625: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
4626: }
4627:
4628: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
4629: <ol class="LC_primary_menu LC_right">
4630: <li>$menu</li>
4631: </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
4632: return(<<ENDBODY);
4633: $bodytag
4634: <table id="LC_title_bar" class="LC_with_remote">
4635: <tr><td>$upperleft</td>
4636: <td>$messages </td>
4637: </tr>
4638: <tr><td>$titleinfo $dc_info $menu</td>
4639: </tr>
4640: </table>
4641: ENDBODY
4642: }
4643:
4644: sub dc_courseid_toggle {
4645: my ($dc_info) = @_;
4646: return ' <span id="dccidtext" class="LC_cusr_subheading">'.
4647: '<a href="javascript:showCourseID();">'.
4648: &mt('(More ...)').'</a></span>'.
4649: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
4650: }
4651:
4652: sub make_attr_string {
4653: my ($register,$attr_ref) = @_;
4654:
4655: if ($attr_ref && !ref($attr_ref)) {
4656: die("addentries Must be a hash ref ".
4657: join(':',caller(1))." ".
4658: join(':',caller(0))." ");
4659: }
4660:
4661: if ($register) {
4662: my ($on_load,$on_unload);
4663: foreach my $key (keys(%{$attr_ref})) {
4664: if (lc($key) eq 'onload') {
4665: $on_load.=$attr_ref->{$key}.';';
4666: delete($attr_ref->{$key});
4667:
4668: } elsif (lc($key) eq 'onunload') {
4669: $on_unload.=$attr_ref->{$key}.';';
4670: delete($attr_ref->{$key});
4671: }
4672: }
4673: $attr_ref->{'onload'} =
4674: &Apache::lonmenu::loadevents(). $on_load;
4675: $attr_ref->{'onunload'}=
4676: &Apache::lonmenu::unloadevents().$on_unload;
4677: }
4678:
4679: # Accessibility font enhance
4680: if ($env{'browser.fontenhance'} eq 'on') {
4681: my $style;
4682: foreach my $key (keys(%{$attr_ref})) {
4683: if (lc($key) eq 'style') {
4684: $style.=$attr_ref->{$key}.';';
4685: delete($attr_ref->{$key});
4686: }
4687: }
4688: $attr_ref->{'style'}=$style.'; font-size: x-large;';
4689: }
4690:
4691: my $attr_string;
4692: foreach my $attr (keys(%$attr_ref)) {
4693: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4694: }
4695: return $attr_string;
4696: }
4697:
4698:
4699: ###############################################
4700: ###############################################
4701:
4702: =pod
4703:
4704: =item * &endbodytag()
4705:
4706: Returns a uniform footer for LON-CAPA web pages.
4707:
4708: Inputs: 1 - optional reference to an args hash
4709: If in the hash, key for noredirectlink has a value which evaluates to true,
4710: a 'Continue' link is not displayed if the page contains an
4711: internal redirect in the <head></head> section,
4712: i.e., $env{'internal.head.redirect'} exists
4713:
4714: =cut
4715:
4716: sub endbodytag {
4717: my ($args) = @_;
4718: my $endbodytag='</body>';
4719: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
4720: if ( exists( $env{'internal.head.redirect'} ) ) {
4721: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4722: $endbodytag=
4723: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4724: &mt('Continue').'</a>'.
4725: $endbodytag;
4726: }
4727: }
4728: return $endbodytag;
4729: }
4730:
4731: =pod
4732:
4733: =item * &standard_css()
4734:
4735: Returns a style sheet
4736:
4737: Inputs: (all optional)
4738: domain -> force to color decorate a page for a specific
4739: domain
4740: function -> force usage of a specific rolish color scheme
4741: bgcolor -> override the default page bgcolor
4742:
4743: =cut
4744:
4745: sub standard_css {
4746: my ($function,$domain,$bgcolor) = @_;
4747: $function = &get_users_function() if (!$function);
4748: my $img = &designparm($function.'.img', $domain);
4749: my $tabbg = &designparm($function.'.tabbg', $domain);
4750: my $font = &designparm($function.'.font', $domain);
4751: my $fontmenu = &designparm($function.'.fontmenu', $domain);
4752: #second colour for later usage
4753: my $sidebg = &designparm($function.'.sidebg',$domain);
4754: my $pgbg_or_bgcolor =
4755: $bgcolor ||
4756: &designparm($function.'.pgbg', $domain);
4757: my $pgbg = &designparm($function.'.pgbg', $domain);
4758: my $alink = &designparm($function.'.alink', $domain);
4759: my $vlink = &designparm($function.'.vlink', $domain);
4760: my $link = &designparm($function.'.link', $domain);
4761:
4762: my $loginbg = &designparm('login.sidebg',$domain);
4763: my $bgcol = &designparm('login.bgcol',$domain);
4764: my $textcol = &designparm('login.textcol',$domain);
4765:
4766: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
4767: my $mono = 'monospace';
4768: my $data_table_head = $sidebg;
4769: my $data_table_light = '#FAFAFA';
4770: my $data_table_dark = '#F0F0F0';
4771: my $data_table_darker = '#CCCCCC';
4772: my $data_table_highlight = '#FFFF00';
4773: my $mail_new = '#FFBB77';
4774: my $mail_new_hover = '#DD9955';
4775: my $mail_read = '#BBBB77';
4776: my $mail_read_hover = '#999944';
4777: my $mail_replied = '#AAAA88';
4778: my $mail_replied_hover = '#888855';
4779: my $mail_other = '#99BBBB';
4780: my $mail_other_hover = '#669999';
4781: my $table_header = '#DDDDDD';
4782: my $feedback_link_bg = '#BBBBBB';
4783: my $lg_border_color = '#C8C8C8';
4784:
4785: my $border = ($env{'browser.type'} eq 'explorer' ||
4786: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
4787: : '0 3px 0 4px';
4788:
4789:
4790: return <<END;
4791: body {
4792: font-family: $sans;
4793: line-height:130%;
4794: font-size:0.83em;
4795: color:$font;
4796: }
4797:
4798: a:focus {
4799: color: red;
4800: background: yellow;
4801: }
4802:
4803: form, .inline {
4804: display: inline;
4805: }
4806:
4807: .LC_right {
4808: text-align:right;
4809: }
4810:
4811: .LC_middle {
4812: vertical-align:middle;
4813: }
4814:
4815: /* just for tests */
4816: .LC_400Box {
4817: width:400px;
4818: }
4819: /* end */
4820:
4821: .LC_filename {
4822: font-family: $mono;
4823: white-space:pre;
4824: font-size: 120%;
4825: }
4826:
4827: .LC_fileicon {
4828: border: none;
4829: height: 1.3em;
4830: vertical-align: text-bottom;
4831: margin-right: 0.3em;
4832: text-decoration:none;
4833: }
4834:
4835: .LC_error {
4836: color: red;
4837: font-size: larger;
4838: }
4839:
4840: .LC_warning,
4841: .LC_diff_removed {
4842: color: red;
4843: }
4844:
4845: .LC_info,
4846: .LC_success,
4847: .LC_diff_added {
4848: color: green;
4849: }
4850:
4851: div.LC_confirm_box {
4852: background-color: #FAFAFA;
4853: border: 1px solid $lg_border_color;
4854: margin-right: 0;
4855: padding: 5px;
4856: }
4857:
4858: div.LC_confirm_box .LC_error img,
4859: div.LC_confirm_box .LC_success img {
4860: vertical-align: middle;
4861: }
4862:
4863: .LC_icon {
4864: border: none;
4865: vertical-align: middle;
4866: }
4867:
4868: .LC_docs_spacer {
4869: width: 25px;
4870: height: 1px;
4871: border: none;
4872: }
4873:
4874: .LC_internal_info {
4875: color: #999999;
4876: }
4877:
4878: .LC_discussion {
4879: background: $tabbg;
4880: border: 1px solid black;
4881: margin: 2px;
4882: }
4883:
4884: .LC_disc_action_links_bar {
4885: background: $tabbg;
4886: border: none;
4887: margin: 4px;
4888: }
4889:
4890: .LC_disc_action_left {
4891: text-align: left;
4892: }
4893:
4894: .LC_disc_action_right {
4895: text-align: right;
4896: }
4897:
4898: .LC_disc_new_item {
4899: background: white;
4900: border: 2px solid red;
4901: margin: 2px;
4902: }
4903:
4904: .LC_disc_old_item {
4905: background: white;
4906: border: 1px solid black;
4907: margin: 2px;
4908: }
4909:
4910: table.LC_pastsubmission {
4911: border: 1px solid black;
4912: margin: 2px;
4913: }
4914:
4915: table#LC_menubuttons {
4916: width: 100%;
4917: background: $pgbg;
4918: border: 2px;
4919: border-collapse: separate;
4920: padding: 0;
4921: }
4922:
4923: table#LC_title_bar a {
4924: color: $fontmenu;
4925: }
4926:
4927: table#LC_title_bar {
4928: clear: both;
4929: display: none;
4930: }
4931:
4932: table#LC_title_bar,
4933: table.LC_breadcrumbs,
4934: table#LC_title_bar.LC_with_remote {
4935: width: 100%;
4936: border-color: $pgbg;
4937: border-style: solid;
4938: border-width: $border;
4939: background: $pgbg;
4940: color: $fontmenu;
4941: border-collapse: collapse;
4942: padding: 0;
4943: margin: 0;
4944: }
4945:
4946: /* #SD START (work in progress)*/
4947:
4948: ul.LC_bct {
4949: margin: 0;
4950: padding: 0;
4951: }
4952: ul.LC_bct ol {
4953: display: inline;
4954: }
4955: ul.LC_bct ul {
4956: display: inline;
4957: padding: 0;
4958: }
4959: ul.LC_bct li {
4960: list-style-type: none;
4961: display: inline;
4962: }
4963:
4964:
4965: ul.LC_breadcrumb_tools {
4966: }
4967:
4968: li.LC_breadcrumb_tools {
4969: }
4970: li.LC_breadcrumb_tools img{
4971: vertical-align: middle;
4972: }
4973:
4974: .LC_breadcrumb_tools_A {
4975: margin: 0 0 0 1em;
4976: }
4977: .LC_breadcrumb_tools_B {
4978: float: right;
4979: margin-top: 0.4em;
4980: }
4981: .LC_breadcrumb_tools_C {
4982: margin: 0 1em 0 0;
4983: float: right;
4984: }
4985: /* #SD END */
4986:
4987: table#LC_title_bar td {
4988: background: $tabbg;
4989: }
4990:
4991: table#LC_menubuttons img {
4992: border: none;
4993: }
4994:
4995: .LC_breadcrumbs_component {
4996: float: right;
4997: margin: 0 1em;
4998: }
4999: .LC_breadcrumbs_component img {
5000: vertical-align: middle;
5001: }
5002:
5003: td.LC_table_cell_checkbox {
5004: text-align: center;
5005: }
5006:
5007: .LC_fontsize_small {
5008: font-size: 70%;
5009: }
5010:
5011: #LC_breadcrumbs {
5012: clear:both;
5013: background: $sidebg;
5014: border-bottom: 1px solid $lg_border_color;
5015: line-height: 2.5em;
5016: /* SD working here
5017: height: 2.5em;
5018: overflow: hidden; */
5019: margin: 0;
5020: padding: 0;
5021: }
5022:
5023: /* Preliminary fix to hide breadcrumbs inside remote control window */
5024: #LC_remote #LC_breadcrumbs {
5025: display:none;
5026: }
5027:
5028: #LC_head_subbox {
5029: clear:both;
5030: background: #F8F8F8; /* $sidebg; */
5031: border: 1px solid $sidebg;
5032: margin: 0 0 10px 0;
5033: }
5034:
5035: .LC_fontsize_medium {
5036: font-size: 85%;
5037: }
5038:
5039: .LC_fontsize_large {
5040: font-size: 120%;
5041: }
5042:
5043: .LC_menubuttons_inline_text {
5044: color: $font;
5045: font-size: 90%;
5046: padding-left:3px;
5047: }
5048:
5049: .LC_menubuttons_link {
5050: text-decoration: none;
5051: }
5052:
5053: .LC_menubuttons_category {
5054: color: $font;
5055: background: $pgbg;
5056: font-size: larger;
5057: font-weight: bold;
5058: }
5059:
5060: td.LC_menubuttons_text {
5061: color: $font;
5062: }
5063:
5064: .LC_current_location {
5065: background: $tabbg;
5066: }
5067:
5068: table.LC_data_table,
5069: table.LC_mail_list {
5070: border: 1px solid #000000;
5071: border-collapse: separate;
5072: border-spacing: 1px;
5073: background: $pgbg;
5074: }
5075:
5076: .LC_data_table_dense {
5077: font-size: small;
5078: }
5079:
5080: table.LC_nested_outer {
5081: border: 1px solid #000000;
5082: border-collapse: collapse;
5083: border-spacing: 0;
5084: width: 100%;
5085: }
5086:
5087: table.LC_innerpickbox,
5088: table.LC_nested {
5089: border: none;
5090: border-collapse: collapse;
5091: border-spacing: 0;
5092: width: 100%;
5093: }
5094:
5095: table.LC_data_table tr th,
5096: table.LC_calendar tr th,
5097: table.LC_mail_list tr th,
5098: table.LC_prior_tries tr th,
5099: table.LC_innerpickbox tr th {
5100: font-weight: bold;
5101: background-color: $data_table_head;
5102: color:$fontmenu;
5103: font-size:90%;
5104: }
5105:
5106: table.LC_innerpickbox tr th,
5107: table.LC_innerpickbox tr td {
5108: vertical-align: top;
5109: }
5110:
5111: table.LC_data_table tr.LC_info_row > td {
5112: background-color: #CCCCCC;
5113: font-weight: bold;
5114: text-align: left;
5115: }
5116:
5117: table.LC_data_table tr.LC_odd_row > td {
5118: background-color: $data_table_light;
5119: padding: 2px;
5120: vertical-align: top;
5121: }
5122:
5123: table.LC_pick_box tr > td.LC_odd_row {
5124: background-color: $data_table_light;
5125: vertical-align: top;
5126: }
5127:
5128: table.LC_data_table tr.LC_even_row > td {
5129: background-color: $data_table_dark;
5130: padding: 2px;
5131: vertical-align: top;
5132: }
5133:
5134: table.LC_pick_box tr > td.LC_even_row {
5135: background-color: $data_table_dark;
5136: vertical-align: top;
5137: }
5138:
5139: table.LC_data_table tr.LC_data_table_highlight td {
5140: background-color: $data_table_darker;
5141: }
5142:
5143: table.LC_data_table tr td.LC_leftcol_header {
5144: background-color: $data_table_head;
5145: font-weight: bold;
5146: }
5147:
5148: table.LC_data_table tr.LC_empty_row td,
5149: table.LC_nested tr.LC_empty_row td {
5150: background-color: #FFFFFF;
5151: font-weight: bold;
5152: font-style: italic;
5153: text-align: center;
5154: padding: 8px;
5155: }
5156:
5157: table.LC_caption {
5158: }
5159:
5160: table.LC_nested tr.LC_empty_row td {
5161: padding: 4ex
5162: }
5163:
5164: table.LC_nested_outer tr th {
5165: font-weight: bold;
5166: color:$fontmenu;
5167: background-color: $data_table_head;
5168: font-size: small;
5169: border-bottom: 1px solid #000000;
5170: }
5171:
5172: table.LC_nested_outer tr td.LC_subheader {
5173: background-color: $data_table_head;
5174: font-weight: bold;
5175: font-size: small;
5176: border-bottom: 1px solid #000000;
5177: text-align: right;
5178: }
5179:
5180: table.LC_nested tr.LC_info_row td {
5181: background-color: #CCCCCC;
5182: font-weight: bold;
5183: font-size: small;
5184: text-align: center;
5185: }
5186:
5187: table.LC_nested tr.LC_info_row td.LC_left_item,
5188: table.LC_nested_outer tr th.LC_left_item {
5189: text-align: left;
5190: }
5191:
5192: table.LC_nested td {
5193: background-color: #FFFFFF;
5194: font-size: small;
5195: }
5196:
5197: table.LC_nested_outer tr th.LC_right_item,
5198: table.LC_nested tr.LC_info_row td.LC_right_item,
5199: table.LC_nested tr.LC_odd_row td.LC_right_item,
5200: table.LC_nested tr td.LC_right_item {
5201: text-align: right;
5202: }
5203:
5204: table.LC_nested tr.LC_odd_row td {
5205: background-color: #EEEEEE;
5206: }
5207:
5208: table.LC_createuser {
5209: }
5210:
5211: table.LC_createuser tr.LC_section_row td {
5212: font-size: small;
5213: }
5214:
5215: table.LC_createuser tr.LC_info_row td {
5216: background-color: #CCCCCC;
5217: font-weight: bold;
5218: text-align: center;
5219: }
5220:
5221: table.LC_calendar {
5222: border: 1px solid #000000;
5223: border-collapse: collapse;
5224: width: 98%;
5225: }
5226:
5227: table.LC_calendar_pickdate {
5228: font-size: xx-small;
5229: }
5230:
5231: table.LC_calendar tr td {
5232: border: 1px solid #000000;
5233: vertical-align: top;
5234: width: 14%;
5235: }
5236:
5237: table.LC_calendar tr td.LC_calendar_day_empty {
5238: background-color: $data_table_dark;
5239: }
5240:
5241: table.LC_calendar tr td.LC_calendar_day_current {
5242: background-color: $data_table_highlight;
5243: }
5244:
5245: table.LC_mail_list tr.LC_mail_new {
5246: background-color: $mail_new;
5247: }
5248:
5249: table.LC_mail_list tr.LC_mail_new:hover {
5250: background-color: $mail_new_hover;
5251: }
5252:
5253: table.LC_mail_list tr.LC_mail_read {
5254: background-color: $mail_read;
5255: }
5256:
5257: table.LC_mail_list tr.LC_mail_read:hover {
5258: background-color: $mail_read_hover;
5259: }
5260:
5261: table.LC_mail_list tr.LC_mail_replied {
5262: background-color: $mail_replied;
5263: }
5264:
5265: table.LC_mail_list tr.LC_mail_replied:hover {
5266: background-color: $mail_replied_hover;
5267: }
5268:
5269: table.LC_mail_list tr.LC_mail_other {
5270: background-color: $mail_other;
5271: }
5272:
5273: table.LC_mail_list tr.LC_mail_other:hover {
5274: background-color: $mail_other_hover;
5275: }
5276:
5277: table.LC_data_table tr > td.LC_browser_file,
5278: table.LC_data_table tr > td.LC_browser_file_published {
5279: background: #AAEE77;
5280: }
5281:
5282: table.LC_data_table tr > td.LC_browser_file_locked,
5283: table.LC_data_table tr > td.LC_browser_file_unpublished {
5284: background: #FFAA99;
5285: }
5286:
5287: table.LC_data_table tr > td.LC_browser_file_obsolete {
5288: background: #888888;
5289: }
5290:
5291: table.LC_data_table tr > td.LC_browser_file_modified,
5292: table.LC_data_table tr > td.LC_browser_file_metamodified {
5293: background: #F8F866;
5294: }
5295:
5296: table.LC_data_table tr.LC_browser_folder > td {
5297: background: #E0E8FF;
5298: }
5299:
5300: table.LC_data_table tr > td.LC_roles_is {
5301: /* background: #77FF77; */
5302: }
5303:
5304: table.LC_data_table tr > td.LC_roles_future {
5305: background: #FFFF77;
5306: }
5307:
5308: table.LC_data_table tr > td.LC_roles_will {
5309: background: #FFAA77;
5310: }
5311:
5312: table.LC_data_table tr > td.LC_roles_expired {
5313: background: #FF7777;
5314: }
5315:
5316: table.LC_data_table tr > td.LC_roles_will_not {
5317: background: #AAFF77;
5318: }
5319:
5320: table.LC_data_table tr > td.LC_roles_selected {
5321: background: #11CC55;
5322: }
5323:
5324: span.LC_current_location {
5325: font-size:larger;
5326: background: $pgbg;
5327: }
5328:
5329: span.LC_parm_menu_item {
5330: font-size: larger;
5331: }
5332:
5333: span.LC_parm_scope_all {
5334: color: red;
5335: }
5336:
5337: span.LC_parm_scope_folder {
5338: color: green;
5339: }
5340:
5341: span.LC_parm_scope_resource {
5342: color: orange;
5343: }
5344:
5345: span.LC_parm_part {
5346: color: blue;
5347: }
5348:
5349: span.LC_parm_folder,
5350: span.LC_parm_symb {
5351: font-size: x-small;
5352: font-family: $mono;
5353: color: #AAAAAA;
5354: }
5355:
5356: td.LC_parm_overview_level_menu,
5357: td.LC_parm_overview_map_menu,
5358: td.LC_parm_overview_parm_selectors,
5359: td.LC_parm_overview_restrictions {
5360: border: 1px solid black;
5361: border-collapse: collapse;
5362: }
5363:
5364: table.LC_parm_overview_restrictions td {
5365: border-width: 1px 4px 1px 4px;
5366: border-style: solid;
5367: border-color: $pgbg;
5368: text-align: center;
5369: }
5370:
5371: table.LC_parm_overview_restrictions th {
5372: background: $tabbg;
5373: border-width: 1px 4px 1px 4px;
5374: border-style: solid;
5375: border-color: $pgbg;
5376: }
5377:
5378: table#LC_helpmenu {
5379: border: none;
5380: height: 55px;
5381: border-spacing: 0;
5382: }
5383:
5384: table#LC_helpmenu fieldset legend {
5385: font-size: larger;
5386: }
5387:
5388: table#LC_helpmenu_links {
5389: width: 100%;
5390: border: 1px solid black;
5391: background: $pgbg;
5392: padding: 0;
5393: border-spacing: 1px;
5394: }
5395:
5396: table#LC_helpmenu_links tr td {
5397: padding: 1px;
5398: background: $tabbg;
5399: text-align: center;
5400: font-weight: bold;
5401: }
5402:
5403: table#LC_helpmenu_links a:link,
5404: table#LC_helpmenu_links a:visited,
5405: table#LC_helpmenu_links a:active {
5406: text-decoration: none;
5407: color: $font;
5408: }
5409:
5410: table#LC_helpmenu_links a:hover {
5411: text-decoration: underline;
5412: color: $vlink;
5413: }
5414:
5415: .LC_chrt_popup_exists {
5416: border: 1px solid #339933;
5417: margin: -1px;
5418: }
5419:
5420: .LC_chrt_popup_up {
5421: border: 1px solid yellow;
5422: margin: -1px;
5423: }
5424:
5425: .LC_chrt_popup {
5426: border: 1px solid #8888FF;
5427: background: #CCCCFF;
5428: }
5429:
5430: table.LC_pick_box {
5431: border-collapse: separate;
5432: background: white;
5433: border: 1px solid black;
5434: border-spacing: 1px;
5435: }
5436:
5437: table.LC_pick_box td.LC_pick_box_title {
5438: background: $sidebg;
5439: font-weight: bold;
5440: text-align: left;
5441: vertical-align: top;
5442: width: 184px;
5443: padding: 8px;
5444: }
5445:
5446: table.LC_pick_box td.LC_pick_box_value {
5447: text-align: left;
5448: padding: 8px;
5449: }
5450:
5451: table.LC_pick_box td.LC_pick_box_select {
5452: text-align: left;
5453: padding: 8px;
5454: }
5455:
5456: table.LC_pick_box td.LC_pick_box_separator {
5457: padding: 0;
5458: height: 1px;
5459: background: black;
5460: }
5461:
5462: table.LC_pick_box td.LC_pick_box_submit {
5463: text-align: right;
5464: }
5465:
5466: table.LC_pick_box td.LC_evenrow_value {
5467: text-align: left;
5468: padding: 8px;
5469: background-color: $data_table_light;
5470: }
5471:
5472: table.LC_pick_box td.LC_oddrow_value {
5473: text-align: left;
5474: padding: 8px;
5475: background-color: $data_table_light;
5476: }
5477:
5478: span.LC_helpform_receipt_cat {
5479: font-weight: bold;
5480: }
5481:
5482: table.LC_group_priv_box {
5483: background: white;
5484: border: 1px solid black;
5485: border-spacing: 1px;
5486: }
5487:
5488: table.LC_group_priv_box td.LC_pick_box_title {
5489: background: $tabbg;
5490: font-weight: bold;
5491: text-align: right;
5492: width: 184px;
5493: }
5494:
5495: table.LC_group_priv_box td.LC_groups_fixed {
5496: background: $data_table_light;
5497: text-align: center;
5498: }
5499:
5500: table.LC_group_priv_box td.LC_groups_optional {
5501: background: $data_table_dark;
5502: text-align: center;
5503: }
5504:
5505: table.LC_group_priv_box td.LC_groups_functionality {
5506: background: $data_table_darker;
5507: text-align: center;
5508: font-weight: bold;
5509: }
5510:
5511: table.LC_group_priv td {
5512: text-align: left;
5513: padding: 0;
5514: }
5515:
5516: table.LC_notify_front_page {
5517: background: white;
5518: border: 1px solid black;
5519: padding: 8px;
5520: }
5521:
5522: table.LC_notify_front_page td {
5523: padding: 8px;
5524: }
5525:
5526: .LC_navbuttons {
5527: margin: 2ex 0ex 2ex 0ex;
5528: }
5529:
5530: .LC_topic_bar {
5531: font-weight: bold;
5532: background: $tabbg;
5533: margin: 1em 0em 1em 2em;
5534: padding: 3px;
5535: font-size: 1.2em;
5536: }
5537:
5538: .LC_topic_bar span {
5539: left: 0.5em;
5540: position: absolute;
5541: vertical-align: middle;
5542: font-size: 1.2em;
5543: }
5544:
5545: .LC_topic_bar img {
5546: vertical-align: bottom;
5547: }
5548:
5549: table.LC_course_group_status {
5550: margin: 20px;
5551: }
5552:
5553: table.LC_status_selector td {
5554: vertical-align: top;
5555: text-align: center;
5556: padding: 4px;
5557: }
5558:
5559: div.LC_feedback_link {
5560: clear: both;
5561: background: $sidebg;
5562: width: 100%;
5563: padding-bottom: 10px;
5564: border: 1px $tabbg solid;
5565: height: 22px;
5566: line-height: 22px;
5567: padding-top: 5px;
5568: }
5569:
5570: div.LC_feedback_link img {
5571: height: 22px;
5572: vertical-align:middle;
5573: }
5574:
5575: div.LC_feedback_link a {
5576: text-decoration: none;
5577: }
5578:
5579: div.LC_comblock {
5580: display:inline;
5581: color:$font;
5582: font-size:90%;
5583: }
5584:
5585: div.LC_feedback_link div.LC_comblock {
5586: padding-left:5px;
5587: }
5588:
5589: div.LC_feedback_link div.LC_comblock a {
5590: color:$font;
5591: }
5592:
5593: span.LC_feedback_link {
5594: /* background: $feedback_link_bg; */
5595: font-size: larger;
5596: }
5597:
5598: span.LC_message_link {
5599: /* background: $feedback_link_bg; */
5600: font-size: larger;
5601: position: absolute;
5602: right: 1em;
5603: }
5604:
5605: table.LC_prior_tries {
5606: border: 1px solid #000000;
5607: border-collapse: separate;
5608: border-spacing: 1px;
5609: }
5610:
5611: table.LC_prior_tries td {
5612: padding: 2px;
5613: }
5614:
5615: .LC_answer_correct {
5616: background: lightgreen;
5617: color: darkgreen;
5618: padding: 6px;
5619: }
5620:
5621: .LC_answer_charged_try {
5622: background: #FFAAAA;
5623: color: darkred;
5624: padding: 6px;
5625: }
5626:
5627: .LC_answer_not_charged_try,
5628: .LC_answer_no_grade,
5629: .LC_answer_late {
5630: background: lightyellow;
5631: color: black;
5632: padding: 6px;
5633: }
5634:
5635: .LC_answer_previous {
5636: background: lightblue;
5637: color: darkblue;
5638: padding: 6px;
5639: }
5640:
5641: .LC_answer_no_message {
5642: background: #FFFFFF;
5643: color: black;
5644: padding: 6px;
5645: }
5646:
5647: .LC_answer_unknown {
5648: background: orange;
5649: color: black;
5650: padding: 6px;
5651: }
5652:
5653: span.LC_prior_numerical,
5654: span.LC_prior_string,
5655: span.LC_prior_custom,
5656: span.LC_prior_reaction,
5657: span.LC_prior_math {
5658: font-family: $mono;
5659: white-space: pre;
5660: }
5661:
5662: span.LC_prior_string {
5663: font-family: $mono;
5664: white-space: pre;
5665: }
5666:
5667: table.LC_prior_option {
5668: width: 100%;
5669: border-collapse: collapse;
5670: }
5671:
5672: table.LC_prior_rank,
5673: table.LC_prior_match {
5674: border-collapse: collapse;
5675: }
5676:
5677: table.LC_prior_option tr td,
5678: table.LC_prior_rank tr td,
5679: table.LC_prior_match tr td {
5680: border: 1px solid #000000;
5681: }
5682:
5683: .LC_nobreak {
5684: white-space: nowrap;
5685: }
5686:
5687: span.LC_cusr_emph {
5688: font-style: italic;
5689: }
5690:
5691: span.LC_cusr_subheading {
5692: font-weight: normal;
5693: font-size: 85%;
5694: }
5695:
5696: div.LC_docs_entry_move {
5697: border: 1px solid #BBBBBB;
5698: background: #DDDDDD;
5699: width: 22px;
5700: padding: 1px;
5701: margin: 0;
5702: }
5703:
5704: table.LC_data_table tr > td.LC_docs_entry_commands,
5705: table.LC_data_table tr > td.LC_docs_entry_parameter {
5706: background: #DDDDDD;
5707: font-size: x-small;
5708: }
5709:
5710: .LC_docs_entry_parameter {
5711: white-space: nowrap;
5712: }
5713:
5714: .LC_docs_copy {
5715: color: #000099;
5716: }
5717:
5718: .LC_docs_cut {
5719: color: #550044;
5720: }
5721:
5722: .LC_docs_rename {
5723: color: #009900;
5724: }
5725:
5726: .LC_docs_remove {
5727: color: #990000;
5728: }
5729:
5730: .LC_docs_reinit_warn,
5731: .LC_docs_ext_edit {
5732: font-size: x-small;
5733: }
5734:
5735: table.LC_docs_adddocs td,
5736: table.LC_docs_adddocs th {
5737: border: 1px solid #BBBBBB;
5738: padding: 4px;
5739: background: #DDDDDD;
5740: }
5741:
5742: table.LC_sty_begin {
5743: background: #BBFFBB;
5744: }
5745:
5746: table.LC_sty_end {
5747: background: #FFBBBB;
5748: }
5749:
5750: table.LC_double_column {
5751: border-width: 0;
5752: border-collapse: collapse;
5753: width: 100%;
5754: padding: 2px;
5755: }
5756:
5757: table.LC_double_column tr td.LC_left_col {
5758: top: 2px;
5759: left: 2px;
5760: width: 47%;
5761: vertical-align: top;
5762: }
5763:
5764: table.LC_double_column tr td.LC_right_col {
5765: top: 2px;
5766: right: 2px;
5767: width: 47%;
5768: vertical-align: top;
5769: }
5770:
5771: div.LC_left_float {
5772: float: left;
5773: padding-right: 5%;
5774: padding-bottom: 4px;
5775: }
5776:
5777: div.LC_clear_float_header {
5778: padding-bottom: 2px;
5779: }
5780:
5781: div.LC_clear_float_footer {
5782: padding-top: 10px;
5783: clear: both;
5784: }
5785:
5786: div.LC_grade_show_user {
5787: margin-top: 20px;
5788: border: 1px solid black;
5789: }
5790:
5791: div.LC_grade_user_name {
5792: background: #DDDDEE;
5793: border-bottom: 1px solid black;
5794: font-weight: bold;
5795: font-size: large;
5796: }
5797:
5798: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5799: background: #DDEEDD;
5800: }
5801:
5802: div.LC_grade_show_problem,
5803: div.LC_grade_submissions,
5804: div.LC_grade_message_center,
5805: div.LC_grade_info_links,
5806: div.LC_grade_assign {
5807: margin: 5px;
5808: width: 99%;
5809: background: #FFFFFF;
5810: }
5811:
5812: div.LC_grade_show_problem_header,
5813: div.LC_grade_submissions_header,
5814: div.LC_grade_message_center_header,
5815: div.LC_grade_assign_header {
5816: font-weight: bold;
5817: font-size: large;
5818: }
5819:
5820: div.LC_grade_show_problem_problem,
5821: div.LC_grade_submissions_body,
5822: div.LC_grade_message_center_body,
5823: div.LC_grade_assign_body {
5824: border: 1px solid black;
5825: width: 99%;
5826: background: #FFFFFF;
5827: }
5828:
5829: span.LC_grade_check_note {
5830: font-weight: normal;
5831: font-size: medium;
5832: display: inline;
5833: position: absolute;
5834: right: 1em;
5835: }
5836:
5837: table.LC_scantron_action {
5838: width: 100%;
5839: }
5840:
5841: table.LC_scantron_action tr th {
5842: font-weight:bold;
5843: font-style:normal;
5844: }
5845:
5846: .LC_edit_problem_header,
5847: div.LC_edit_problem_footer {
5848: font-weight: normal;
5849: font-size: medium;
5850: margin: 2px;
5851: }
5852:
5853: div.LC_edit_problem_header,
5854: div.LC_edit_problem_header div,
5855: div.LC_edit_problem_footer,
5856: div.LC_edit_problem_footer div,
5857: div.LC_edit_problem_editxml_header,
5858: div.LC_edit_problem_editxml_header div {
5859: margin-top: 5px;
5860: }
5861:
5862: div.LC_edit_problem_header_title {
5863: font-weight: bold;
5864: font-size: larger;
5865: background: $tabbg;
5866: padding: 3px;
5867: }
5868:
5869: table.LC_edit_problem_header_title {
5870: font-size: larger;
5871: font-weight: bold;
5872: width: 100%;
5873: border-color: $pgbg;
5874: border-style: solid;
5875: border-width: $border;
5876: background: $tabbg;
5877: border-collapse: collapse;
5878: padding: 0;
5879: }
5880:
5881: div.LC_edit_problem_discards {
5882: float: left;
5883: padding-bottom: 5px;
5884: }
5885:
5886: div.LC_edit_problem_saves {
5887: float: right;
5888: padding-bottom: 5px;
5889: }
5890:
5891: img.stift {
5892: border-width: 0;
5893: vertical-align: middle;
5894: }
5895:
5896: table td.LC_mainmenu_col_fieldset {
5897: vertical-align: top;
5898: }
5899:
5900: div.LC_createcourse {
5901: margin: 10px 10px 10px 10px;
5902: }
5903:
5904: .LC_dccid {
5905: margin: 0.2em 0 0 0;
5906: padding: 0;
5907: font-size: 90%;
5908: display:none;
5909: }
5910:
5911: /* ---- Remove when done ----
5912: # The following styles is part of the redesign of LON-CAPA and are
5913: # subject to change during this project.
5914: # Don't rely on their current functionality as they might be
5915: # changed or removed.
5916: # --------------------------*/
5917:
5918: a:hover,
5919: ol.LC_primary_menu a:hover,
5920: ol#LC_MenuBreadcrumbs a:hover,
5921: ol#LC_PathBreadcrumbs a:hover,
5922: ul#LC_secondary_menu a:hover,
5923: .LC_FormSectionClearButton input:hover
5924: ul.LC_TabContent li:hover a {
5925: color:#BF2317;
5926: text-decoration:none;
5927: }
5928:
5929: h1 {
5930: padding: 0;
5931: line-height:130%;
5932: }
5933:
5934: h2,
5935: h3,
5936: h4,
5937: h5,
5938: h6 {
5939: margin: 5px 0 5px 0;
5940: padding: 0;
5941: line-height:130%;
5942: }
5943:
5944: .LC_hcell {
5945: padding:3px 15px 3px 15px;
5946: margin: 0;
5947: background-color:$tabbg;
5948: color:$fontmenu;
5949: border-bottom:solid 1px $lg_border_color;
5950: }
5951:
5952: .LC_Box > .LC_hcell {
5953: margin: 0 -10px 10px -10px;
5954: }
5955:
5956: .LC_noBorder {
5957: border: 0;
5958: }
5959:
5960: .LC_FormSectionClearButton input {
5961: background-color:transparent;
5962: border: none;
5963: cursor:pointer;
5964: text-decoration:underline;
5965: }
5966:
5967: .LC_help_open_topic {
5968: color: #FFFFFF;
5969: background-color: #EEEEFF;
5970: margin: 1px;
5971: padding: 4px;
5972: border: 1px solid #000033;
5973: white-space: nowrap;
5974: /* vertical-align: middle; */
5975: }
5976:
5977: dl,
5978: ul,
5979: div,
5980: fieldset {
5981: margin: 10px 10px 10px 0;
5982: /* overflow: hidden; */
5983: }
5984:
5985: fieldset > legend {
5986: font-weight: bold;
5987: padding: 0 5px 0 5px;
5988: }
5989:
5990: #LC_nav_bar {
5991: float: left;
5992: margin: 0.2em 0 0 0;
5993: }
5994:
5995: #LC_realm {
5996: margin: 0.2em 0 0 0;
5997: padding: 0;
5998: font-weight: bold;
5999: text-align: center;
6000: }
6001:
6002: #LC_nav_bar em {
6003: font-weight: bold;
6004: font-style: normal;
6005: }
6006:
6007: ol.LC_primary_menu {
6008: float: right;
6009: margin: 0.2em 0 0 0;
6010: }
6011:
6012: ol#LC_PathBreadcrumbs {
6013: margin: 0;
6014: }
6015:
6016: ol.LC_primary_menu li {
6017: display: inline;
6018: padding: 5px 5px 0 10px;
6019: vertical-align: top;
6020: }
6021:
6022: ol.LC_primary_menu li img {
6023: vertical-align: bottom;
6024: }
6025:
6026: ol.LC_primary_menu a {
6027: font-size: 90%;
6028: color: RGB(80, 80, 80);
6029: text-decoration: none;
6030: }
6031:
6032: ul#LC_secondary_menu {
6033: clear: both;
6034: color: $fontmenu;
6035: background: $tabbg;
6036: list-style: none;
6037: padding: 0;
6038: margin: 0;
6039: width: 100%;
6040: }
6041:
6042: ul#LC_secondary_menu li {
6043: font-weight: bold;
6044: line-height: 1.8em;
6045: padding: 0 0.8em;
6046: border-right: 1px solid black;
6047: display: inline;
6048: vertical-align: middle;
6049: }
6050:
6051: ul.LC_TabContent {
6052: display:block;
6053: background: $sidebg;
6054: border-bottom: solid 1px $lg_border_color;
6055: list-style:none;
6056: margin: 0 -10px;
6057: padding: 0;
6058: }
6059:
6060: ul.LC_TabContent li,
6061: ul.LC_TabContentBigger li {
6062: float:left;
6063: }
6064:
6065: ul#LC_secondary_menu li a {
6066: color: $fontmenu;
6067: text-decoration: none;
6068: }
6069:
6070: ul.LC_TabContent {
6071: min-height:1.5em;
6072: }
6073:
6074: ul.LC_TabContent li {
6075: vertical-align:middle;
6076: padding: 0 10px 0 10px;
6077: background-color:$tabbg;
6078: border-bottom:solid 1px $lg_border_color;
6079: }
6080:
6081: ul.LC_TabContent .right {
6082: float:right;
6083: }
6084:
6085: ul.LC_TabContent li a,
6086: ul.LC_TabContent li {
6087: color:rgb(47,47,47);
6088: text-decoration:none;
6089: font-size:95%;
6090: font-weight:bold;
6091: padding-right: 16px;
6092: }
6093:
6094: ul.LC_TabContent li:hover,
6095: ul.LC_TabContent li.active {
6096: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
6097: border-bottom:solid 2px #FFFFFF;
6098: padding-right: 16px;
6099: }
6100:
6101: #maincoursedoc {
6102: clear:both;
6103: }
6104:
6105: ul.LC_TabContentBigger {
6106: display:block;
6107: list-style:none;
6108: padding: 0;
6109: }
6110:
6111: ul.LC_TabContentBigger li {
6112: vertical-align:bottom;
6113: height: 30px;
6114: font-size:110%;
6115: font-weight:bold;
6116: color: #737373;
6117: }
6118:
6119:
6120: ul.LC_TabContentBigger li a {
6121: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
6122: height: 30px;
6123: line-height: 30px;
6124: text-align: center;
6125: display: block;
6126: text-decoration: none;
6127: }
6128:
6129: ul.LC_TabContentBigger li:hover a,
6130: ul.LC_TabContentBigger li.active a {
6131: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
6132: color:$font;
6133: text-decoration: underline;
6134: }
6135:
6136:
6137: ul.LC_TabContentBigger li b {
6138: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
6139: display: block;
6140: float: left;
6141: padding: 0 30px;
6142: }
6143:
6144: ul.LC_TabContentBigger li:hover b,
6145: ul.LC_TabContentBigger li.active b {
6146: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
6147: color:$font;
6148: border-bottom: 1px solid #FFFFFF;
6149: }
6150:
6151:
6152: ul.LC_CourseBreadcrumbs {
6153: background: $sidebg;
6154: line-height: 32px;
6155: padding-left: 10px;
6156: margin: 0 0 10px 0;
6157: list-style-position: inside;
6158:
6159: }
6160:
6161: ol#LC_MenuBreadcrumbs,
6162: ol#LC_PathBreadcrumbs {
6163: padding-left: 10px;
6164: margin: 0;
6165: list-style-position: inside;
6166: /* SD working here
6167: white-space: nowrap; */
6168: }
6169:
6170: ol#LC_MenuBreadcrumbs li,
6171: ol#LC_PathBreadcrumbs li,
6172: ul.LC_CourseBreadcrumbs li {
6173: display: inline;
6174: white-space: nowrap;
6175: /* SD working here
6176: white-space: normal; */
6177: }
6178:
6179: ol#LC_MenuBreadcrumbs li a,
6180: ul.LC_CourseBreadcrumbs li a {
6181: text-decoration: none;
6182: font-size:90%;
6183: }
6184:
6185: ol#LC_PathBreadcrumbs li a {
6186: text-decoration:none;
6187: font-size:100%;
6188: font-weight:bold;
6189: }
6190:
6191: .LC_Box {
6192: border: solid 1px $lg_border_color;
6193: padding: 0 10px 10px 10px;
6194: }
6195:
6196: .LC_AboutMe_Image {
6197: float:left;
6198: margin-right:10px;
6199: }
6200:
6201: .LC_Clear_AboutMe_Image {
6202: clear:left;
6203: }
6204:
6205: dl.LC_ListStyleClean dt {
6206: padding-right: 5px;
6207: display: table-header-group;
6208: }
6209:
6210: dl.LC_ListStyleClean dd {
6211: display: table-row;
6212: }
6213:
6214: .LC_ListStyleClean,
6215: .LC_ListStyleSimple,
6216: .LC_ListStyleNormal,
6217: .LC_ListStyleSpecial {
6218: /* display:block; */
6219: list-style-position: inside;
6220: list-style-type: none;
6221: overflow: hidden;
6222: padding: 0;
6223: }
6224:
6225: .LC_ListStyleSimple li,
6226: .LC_ListStyleSimple dd,
6227: .LC_ListStyleNormal li,
6228: .LC_ListStyleNormal dd,
6229: .LC_ListStyleSpecial li,
6230: .LC_ListStyleSpecial dd {
6231: margin: 0;
6232: padding: 5px 5px 5px 10px;
6233: clear: both;
6234: }
6235:
6236: .LC_ListStyleClean li,
6237: .LC_ListStyleClean dd {
6238: padding-top: 0;
6239: padding-bottom: 0;
6240: }
6241:
6242: .LC_ListStyleSimple dd,
6243: .LC_ListStyleSimple li {
6244: border-bottom: solid 1px $lg_border_color;
6245: }
6246:
6247: .LC_ListStyleSpecial li,
6248: .LC_ListStyleSpecial dd {
6249: list-style-type: none;
6250: background-color: RGB(220, 220, 220);
6251: margin-bottom: 4px;
6252: }
6253:
6254: table.LC_SimpleTable {
6255: margin:5px;
6256: border:solid 1px $lg_border_color;
6257: }
6258:
6259: table.LC_SimpleTable tr {
6260: padding: 0;
6261: border:solid 1px $lg_border_color;
6262: }
6263:
6264: table.LC_SimpleTable thead {
6265: background:rgb(220,220,220);
6266: }
6267:
6268: div.LC_columnSection {
6269: display: block;
6270: clear: both;
6271: overflow: hidden;
6272: margin: 0;
6273: }
6274:
6275: div.LC_columnSection>* {
6276: float: left;
6277: margin: 10px 20px 10px 0;
6278: overflow:hidden;
6279: }
6280:
6281: .LC_loginpage_container {
6282: text-align:left;
6283: margin : 0 auto;
6284: width:90%;
6285: padding: 10px;
6286: height: auto;
6287: background-color:#FFFFFF;
6288: border:1px solid #CCCCCC;
6289: }
6290:
6291:
6292: .LC_loginpage_loginContainer {
6293: float:left;
6294: width: 182px;
6295: padding: 2px;
6296: border:1px solid #CCCCCC;
6297: background-color:$loginbg;
6298: }
6299:
6300: .LC_loginpage_loginContainer h2 {
6301: margin-top: 0;
6302: display:block;
6303: background:$bgcol;
6304: color:$textcol;
6305: padding-left:5px;
6306: }
6307:
6308: .LC_loginpage_loginInfo {
6309: float:left;
6310: width:182px;
6311: border:1px solid #CCCCCC;
6312: padding:2px;
6313: }
6314:
6315: .LC_loginpage_space {
6316: clear: both;
6317: margin-bottom: 20px;
6318: border-bottom: 1px solid #CCCCCC;
6319: }
6320:
6321: .LC_loginpage_floatLeft {
6322: float: left;
6323: width: 200px;
6324: margin: 0;
6325: }
6326:
6327: table em {
6328: font-weight: bold;
6329: font-style: normal;
6330: }
6331:
6332: table.LC_tableBrowseRes,
6333: table.LC_tableOfContent {
6334: border:none;
6335: border-spacing: 1px;
6336: padding: 3px;
6337: background-color: #FFFFFF;
6338: font-size: 90%;
6339: }
6340:
6341: table.LC_tableOfContent {
6342: border-collapse: collapse;
6343: }
6344:
6345: table.LC_tableBrowseRes a,
6346: table.LC_tableOfContent a {
6347: background-color: transparent;
6348: text-decoration: none;
6349: }
6350:
6351: table.LC_tableOfContent img {
6352: border: none;
6353: height: 1.3em;
6354: vertical-align: text-bottom;
6355: margin-right: 0.3em;
6356: }
6357:
6358: a#LC_content_toolbar_firsthomework {
6359: background-image:url(/res/adm/pages/open-first-problem.gif);
6360: }
6361:
6362: a#LC_content_toolbar_launchnav {
6363: background-image:url(/res/adm/pages/start-navigation.gif);
6364: }
6365:
6366: a#LC_content_toolbar_closenav {
6367: background-image:url(/res/adm/pages/close-navigation.gif);
6368: }
6369:
6370: a#LC_content_toolbar_everything {
6371: background-image:url(/res/adm/pages/show-all.gif);
6372: }
6373:
6374: a#LC_content_toolbar_uncompleted {
6375: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
6376: }
6377:
6378: #LC_content_toolbar_clearbubbles {
6379: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
6380: }
6381:
6382: a#LC_content_toolbar_changefolder {
6383: background : url(/res/adm/pages/close-all-folders.gif) top center ;
6384: }
6385:
6386: a#LC_content_toolbar_changefolder_toggled {
6387: background-image:url(/res/adm/pages/open-all-folders.gif);
6388: }
6389:
6390: ul#LC_toolbar li a:hover {
6391: background-position: bottom center;
6392: }
6393:
6394: ul#LC_toolbar {
6395: padding: 0;
6396: margin: 2px;
6397: list-style:none;
6398: position:relative;
6399: background-color:white;
6400: }
6401:
6402: ul#LC_toolbar li {
6403: border:1px solid white;
6404: padding: 0;
6405: margin: 0;
6406: float: left;
6407: display:inline;
6408: vertical-align:middle;
6409: }
6410:
6411:
6412: a.LC_toolbarItem {
6413: display:block;
6414: padding: 0;
6415: margin: 0;
6416: height: 32px;
6417: width: 32px;
6418: color:white;
6419: border: none;
6420: background-repeat:no-repeat;
6421: background-color:transparent;
6422: }
6423:
6424: ul.LC_funclist {
6425: margin: 0;
6426: padding: 0.5em 1em 0.5em 0;
6427: }
6428:
6429: ul.LC_funclist + ul.LC_funclist {
6430: /*
6431: left border as a seperator if we have more than
6432: one list
6433: */
6434: border-left: 1px solid $sidebg;
6435: /*
6436: this hides the left border behind the border of the
6437: outer box if element is wrapped to the next 'line'
6438: */
6439: margin-left: -1px;
6440: }
6441:
6442: ul.LC_funclist li {
6443: display: inline;
6444: white-space: nowrap;
6445: margin: 0 0 0 25px;
6446: line-height: 150%;
6447: }
6448:
6449: #gciheader {
6450: float:left;
6451: width:100%;
6452: background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
6453: font-size:93%;
6454: line-height:normal;
6455: }
6456: #gciheader ul {
6457: margin:0;
6458: padding:10px 10px 0;
6459: list-style:none;
6460: }
6461: #gciheader li {
6462: float:left;
6463: background:url("/gcimenu_left.gif") no-repeat left top;
6464: margin:0;
6465: padding:0 0 0 9px;
6466: }
6467: #gciheader a {
6468: display:block;
6469: background:url("/gcimenu_right.gif") no-repeat right top;
6470: padding:5px 15px 4px 6px;
6471: }
6472: #gciheader #current {
6473: background-image:url("/gcimenu_left_on.gif");
6474: }
6475: #gciheader #current a {
6476: background-image:url("/gcimenu_right_on.gif");
6477: padding-bottom:5px;
6478: }
6479:
6480: END
6481: }
6482:
6483: =pod
6484:
6485: =item * &headtag()
6486:
6487: Returns a uniform footer for LON-CAPA web pages.
6488:
6489: Inputs: $title - optional title for the head
6490: $head_extra - optional extra HTML to put inside the <head>
6491: $args - optional arguments
6492: force_register - if is true call registerurl so the remote is
6493: informed
6494: redirect -> array ref of
6495: 1- seconds before redirect occurs
6496: 2- url to redirect to
6497: 3- whether the side effect should occur
6498: (side effect of setting
6499: $env{'internal.head.redirect'} to the url
6500: redirected too)
6501: domain -> force to color decorate a page for a specific
6502: domain
6503: function -> force usage of a specific rolish color scheme
6504: bgcolor -> override the default page bgcolor
6505: no_auto_mt_title
6506: -> prevent &mt()ing the title arg
6507:
6508: =cut
6509:
6510: sub headtag {
6511: my ($title,$head_extra,$args) = @_;
6512:
6513: my $function = $args->{'function'} || &get_users_function();
6514: my $domain = $args->{'domain'} || &determinedomain();
6515: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
6516: my $url = join(':',$env{'user.name'},$env{'user.domain'},
6517: $Apache::lonnet::perlvar{'lonVersion'},
6518: #time(),
6519: $env{'environment.color.timestamp'},
6520: $function,$domain,$bgcolor);
6521:
6522: $url = '/adm/css/'.&escape($url).'.css';
6523:
6524: my $result =
6525: '<head>'.
6526: &font_settings();
6527:
6528: if (!$args->{'frameset'}) {
6529: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6530: }
6531: if ($args->{'force_register'}) {
6532: $result .= &Apache::lonmenu::registerurl(1);
6533: }
6534: if (!$args->{'no_nav_bar'}
6535: && !$args->{'only_body'}
6536: && !$args->{'frameset'}) {
6537: $result .= &help_menu_js();
6538: }
6539:
6540: if (ref($args->{'redirect'})) {
6541: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
6542: $url = &Apache::lonenc::check_encrypt($url);
6543: if (!$inhibit_continue) {
6544: $env{'internal.head.redirect'} = $url;
6545: }
6546: $result.=<<ADDMETA
6547: <meta http-equiv="pragma" content="no-cache" />
6548: <meta http-equiv="Refresh" content="$time; url=$url" />
6549: ADDMETA
6550: }
6551: if (!defined($title)) {
6552: $title = 'The LearningOnline Network with CAPA';
6553: }
6554: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6555: $result .= '<title> LON-CAPA '.$title.'</title>'
6556: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6557: .$head_extra;
6558: return $result;
6559: }
6560:
6561: =pod
6562:
6563: =item * &font_settings()
6564:
6565: Returns neccessary <meta> to set the proper encoding
6566:
6567: Inputs: none
6568:
6569: =cut
6570:
6571: sub font_settings {
6572: my $headerstring='';
6573: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
6574: $headerstring.=
6575: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6576: }
6577: return $headerstring;
6578: }
6579:
6580: =pod
6581:
6582: =item * &xml_begin()
6583:
6584: Returns the needed doctype and <html>
6585:
6586: Inputs: none
6587:
6588: =cut
6589:
6590: sub xml_begin {
6591: my $output='';
6592:
6593: if ($env{'internal.start_page'}==1) {
6594: &Apache::lonhtmlcommon::init_htmlareafields();
6595: }
6596:
6597: if ($env{'browser.mathml'}) {
6598: $output='<?xml version="1.0"?>'
6599: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6600: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6601:
6602: # .'<!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">] >'
6603: .'<!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">'
6604: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6605: .'xmlns="http://www.w3.org/1999/xhtml">';
6606: } else {
6607: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
6608: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
6609: }
6610: return $output;
6611: }
6612:
6613: =pod
6614:
6615: =item * &endheadtag()
6616:
6617: Returns a uniform </head> for LON-CAPA web pages.
6618:
6619: Inputs: none
6620:
6621: =cut
6622:
6623: sub endheadtag {
6624: return '</head>';
6625: }
6626:
6627: =pod
6628:
6629: =item * &head()
6630:
6631: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6632:
6633: Inputs:
6634:
6635: =over 4
6636:
6637: $title - optional title for the page
6638:
6639: $head_extra - optional extra HTML to put inside the <head>
6640:
6641: =back
6642:
6643: =cut
6644:
6645: sub head {
6646: my ($title,$head_extra,$args) = @_;
6647: return &headtag($title,$head_extra,$args).&endheadtag();
6648: }
6649:
6650: =pod
6651:
6652: =item * &start_page()
6653:
6654: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6655:
6656: Inputs:
6657:
6658: =over 4
6659:
6660: $title - optional title for the page
6661:
6662: $head_extra - optional extra HTML to incude inside the <head>
6663:
6664: $args - additional optional args supported are:
6665:
6666: =over 8
6667:
6668: only_body -> is true will set &bodytag() onlybodytag
6669: arg on
6670: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
6671: add_entries -> additional attributes to add to the <body>
6672: domain -> force to color decorate a page for a
6673: specific domain
6674: function -> force usage of a specific rolish color
6675: scheme
6676: redirect -> see &headtag()
6677: bgcolor -> override the default page bg color
6678: js_ready -> return a string ready for being used in
6679: a javascript writeln
6680: html_encode -> return a string ready for being used in
6681: a html attribute
6682: force_register -> if is true will turn on the &bodytag()
6683: $forcereg arg
6684: frameset -> if true will start with a <frameset>
6685: rather than <body>
6686: skip_phases -> hash ref of
6687: head -> skip the <html><head> generation
6688: body -> skip all <body> generation
6689: no_inline_link -> if true and in remote mode, don't show the
6690: 'Switch To Inline Menu' link
6691: no_auto_mt_title -> prevent &mt()ing the title arg
6692: inherit_jsmath -> when creating popup window in a page,
6693: should it have jsmath forced on by the
6694: current page
6695: bread_crumbs -> Array containing breadcrumbs
6696: bread_crumbs_components -> if exists show it as headline else show only the breadcrumbs
6697:
6698: =back
6699:
6700: =back
6701:
6702: =cut
6703:
6704: sub start_page {
6705: my ($title,$head_extra,$args) = @_;
6706: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
6707: my %head_args;
6708: foreach my $arg ('redirect','force_register','domain','function',
6709: 'bgcolor','frameset','no_nav_bar','only_body',
6710: 'no_auto_mt_title') {
6711: if (defined($args->{$arg})) {
6712: $head_args{$arg} = $args->{$arg};
6713: }
6714: }
6715:
6716: $env{'internal.start_page'}++;
6717: my $result;
6718: if (! exists($args->{'skip_phases'}{'head'}) ) {
6719: $result.=
6720: &xml_begin().
6721: &headtag($title,$head_extra,\%head_args).&endheadtag();
6722: }
6723:
6724: if (! exists($args->{'skip_phases'}{'body'}) ) {
6725: if ($args->{'frameset'}) {
6726: my $attr_string = &make_attr_string($args->{'force_register'},
6727: $args->{'add_entries'});
6728: $result .= "\n<frameset $attr_string>\n";
6729: } else {
6730: $result .=
6731: &bodytag($title,
6732: $args->{'function'}, $args->{'add_entries'},
6733: $args->{'only_body'}, $args->{'domain'},
6734: $args->{'force_register'}, $args->{'no_nav_bar'},
6735: $args->{'bgcolor'}, $args->{'no_inline_link'},
6736: $args);
6737: }
6738: }
6739:
6740: if ($args->{'js_ready'}) {
6741: $result = &js_ready($result);
6742: }
6743: if ($args->{'html_encode'}) {
6744: $result = &html_encode($result);
6745: }
6746:
6747: # Preparation for new and consistent functionlist at top of screen
6748: # if ($args->{'functionlist'}) {
6749: # $result .= &build_functionlist();
6750: #}
6751:
6752: # Don't add anything more if only_body wanted
6753: return $result if $args->{'only_body'};
6754:
6755: #Breadcrumbs for Construction Space provided by &bodytag.
6756: if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
6757: return $result;
6758: }
6759:
6760: #Breadcrumbs
6761: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6762: &Apache::lonhtmlcommon::clear_breadcrumbs();
6763: #if any br links exists, add them to the breadcrumbs
6764: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6765: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6766: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6767: }
6768: }
6769:
6770: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6771: if(exists($args->{'bread_crumbs_component'})){
6772: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6773: }else{
6774: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6775: }
6776: }
6777: return $result;
6778: }
6779:
6780:
6781: =pod
6782:
6783: =item * &head()
6784:
6785: Returns a complete </body></html> section for LON-CAPA web pages.
6786:
6787: Inputs: $args - additional optional args supported are:
6788: js_ready -> return a string ready for being used in
6789: a javascript writeln
6790: html_encode -> return a string ready for being used in
6791: a html attribute
6792: frameset -> if true will start with a <frameset>
6793: rather than <body>
6794: dicsussion -> if true will get discussion from
6795: lonxml::xmlend
6796: (you can pass the target and parser arguments
6797: through optional 'target' and 'parser' args
6798: to this routine)
6799:
6800: =cut
6801:
6802: sub end_page {
6803: my ($args) = @_;
6804: $env{'internal.end_page'}++;
6805: my $result;
6806: if ($args->{'discussion'}) {
6807: my ($target,$parser);
6808: if (ref($args->{'discussion'})) {
6809: ($target,$parser) =($args->{'discussion'}{'target'},
6810: $args->{'discussion'}{'parser'});
6811: }
6812: $result .= &Apache::lonxml::xmlend($target,$parser);
6813: }
6814:
6815: if ($args->{'frameset'}) {
6816: $result .= '</frameset>';
6817: } else {
6818: $result .= &endbodytag($args);
6819: }
6820: $result .= "\n</html>";
6821:
6822: if ($args->{'js_ready'}) {
6823: $result = &js_ready($result);
6824: }
6825:
6826: if ($args->{'html_encode'}) {
6827: $result = &html_encode($result);
6828: }
6829:
6830: return $result;
6831: }
6832:
6833: sub html_encode {
6834: my ($result) = @_;
6835:
6836: $result = &HTML::Entities::encode($result,'<>&"');
6837:
6838: return $result;
6839: }
6840: sub js_ready {
6841: my ($result) = @_;
6842:
6843: $result =~ s/[\n\r]/ /xmsg;
6844: $result =~ s/\\/\\\\/xmsg;
6845: $result =~ s/'/\\'/xmsg;
6846: $result =~ s{</}{<\\/}xmsg;
6847:
6848: return $result;
6849: }
6850:
6851: sub validate_page {
6852: if ( exists($env{'internal.start_page'})
6853: && $env{'internal.start_page'} > 1) {
6854: &Apache::lonnet::logthis('start_page called multiple times '.
6855: $env{'internal.start_page'}.' '.
6856: $ENV{'request.filename'});
6857: }
6858: if ( exists($env{'internal.end_page'})
6859: && $env{'internal.end_page'} > 1) {
6860: &Apache::lonnet::logthis('end_page called multiple times '.
6861: $env{'internal.end_page'}.' '.
6862: $env{'request.filename'});
6863: }
6864: if ( exists($env{'internal.start_page'})
6865: && ! exists($env{'internal.end_page'})) {
6866: &Apache::lonnet::logthis('start_page called without end_page '.
6867: $env{'request.filename'});
6868: }
6869: if ( ! exists($env{'internal.start_page'})
6870: && exists($env{'internal.end_page'})) {
6871: &Apache::lonnet::logthis('end_page called without start_page'.
6872: $env{'request.filename'});
6873: }
6874: }
6875:
6876: sub simple_error_page {
6877: my ($r,$title,$msg) = @_;
6878: my $page =
6879: &Apache::loncommon::start_page($title).
6880: &mt($msg).
6881: &Apache::loncommon::end_page();
6882: if (ref($r)) {
6883: $r->print($page);
6884: return;
6885: }
6886: return $page;
6887: }
6888:
6889: {
6890: my @row_count;
6891: sub start_data_table {
6892: my ($add_class) = @_;
6893: my $css_class = (join(' ','LC_data_table',$add_class));
6894: unshift(@row_count,0);
6895: return '<table class="'.$css_class.'">'."\n";
6896: }
6897:
6898: sub end_data_table {
6899: shift(@row_count);
6900: return '</table>'."\n";;
6901: }
6902:
6903: sub start_data_table_row {
6904: my ($add_class) = @_;
6905: $row_count[0]++;
6906: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
6907: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
6908: return '<tr class="'.$css_class.'">'."\n";;
6909: }
6910:
6911: sub continue_data_table_row {
6912: my ($add_class) = @_;
6913: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
6914: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
6915: return '<tr class="'.$css_class.'">'."\n";;
6916: }
6917:
6918: sub end_data_table_row {
6919: return '</tr>'."\n";;
6920: }
6921:
6922: sub start_data_table_empty_row {
6923: # $row_count[0]++;
6924: return '<tr class="LC_empty_row" >'."\n";;
6925: }
6926:
6927: sub end_data_table_empty_row {
6928: return '</tr>'."\n";;
6929: }
6930:
6931: sub start_data_table_header_row {
6932: return '<tr class="LC_header_row">'."\n";;
6933: }
6934:
6935: sub end_data_table_header_row {
6936: return '</tr>'."\n";;
6937: }
6938:
6939: sub data_table_caption {
6940: my $caption = shift;
6941: return "<caption class=\"LC_caption\">$caption</caption>";
6942: }
6943: }
6944:
6945: =pod
6946:
6947: =item * &inhibit_menu_check($arg)
6948:
6949: Checks for a inhibitmenu state and generates output to preserve it
6950:
6951: Inputs: $arg - can be any of
6952: - undef - in which case the return value is a string
6953: to add into arguments list of a uri
6954: - 'input' - in which case the return value is a HTML
6955: <form> <input> field of type hidden to
6956: preserve the value
6957: - a url - in which case the return value is the url with
6958: the neccesary cgi args added to preserve the
6959: inhibitmenu state
6960: - a ref to a url - no return value, but the string is
6961: updated to include the neccessary cgi
6962: args to preserve the inhibitmenu state
6963:
6964: =cut
6965:
6966: sub inhibit_menu_check {
6967: my ($arg) = @_;
6968: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6969: if ($arg eq 'input') {
6970: if ($env{'form.inhibitmenu'}) {
6971: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6972: } else {
6973: return
6974: }
6975: }
6976: if ($env{'form.inhibitmenu'}) {
6977: if (ref($arg)) {
6978: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6979: } elsif ($arg eq '') {
6980: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6981: } else {
6982: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6983: }
6984: }
6985: if (!ref($arg)) {
6986: return $arg;
6987: }
6988: }
6989:
6990: ###############################################
6991:
6992: =pod
6993:
6994: =back
6995:
6996: =head1 User Information Routines
6997:
6998: =over 4
6999:
7000: =item * &get_users_function()
7001:
7002: Used by &bodytag to determine the current users primary role.
7003: Returns either 'student','coordinator','admin', or 'author'.
7004:
7005: =cut
7006:
7007: ###############################################
7008: sub get_users_function {
7009: my $function = 'norole';
7010: if ($env{'request.role'}=~/^(st)/) {
7011: $function='student';
7012: }
7013: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
7014: $function='coordinator';
7015: }
7016: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
7017: $function='admin';
7018: }
7019: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
7020: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
7021: $function='author';
7022: }
7023: return $function;
7024: }
7025:
7026: ###############################################
7027:
7028: =pod
7029:
7030: =item * &show_course()
7031:
7032: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
7033: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
7034:
7035: Inputs:
7036: None
7037:
7038: Outputs:
7039: Scalar: 1 if 'Course' to be used, 0 otherwise.
7040:
7041: =cut
7042:
7043: ###############################################
7044: sub show_course {
7045: my $course = !$env{'user.adv'};
7046: if (!$env{'user.adv'}) {
7047: foreach my $env (keys(%env)) {
7048: next if ($env !~ m/^user\.priv\./);
7049: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
7050: $course = 0;
7051: last;
7052: }
7053: }
7054: }
7055: return $course;
7056: }
7057:
7058: ###############################################
7059:
7060: =pod
7061:
7062: =item * &check_user_status()
7063:
7064: Determines current status of supplied role for a
7065: specific user. Roles can be active, previous or future.
7066:
7067: Inputs:
7068: user's domain, user's username, course's domain,
7069: course's number, optional section ID.
7070:
7071: Outputs:
7072: role status: active, previous or future.
7073:
7074: =cut
7075:
7076: sub check_user_status {
7077: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
7078: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
7079: my @uroles = keys %userinfo;
7080: my $srchstr;
7081: my $active_chk = 'none';
7082: my $now = time;
7083: if (@uroles > 0) {
7084: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
7085: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
7086: } else {
7087: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
7088: }
7089: if (grep/^\Q$srchstr\E$/,@uroles) {
7090: my $role_end = 0;
7091: my $role_start = 0;
7092: $active_chk = 'active';
7093: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
7094: $role_end = $1;
7095: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
7096: $role_start = $1;
7097: }
7098: }
7099: if ($role_start > 0) {
7100: if ($now < $role_start) {
7101: $active_chk = 'future';
7102: }
7103: }
7104: if ($role_end > 0) {
7105: if ($now > $role_end) {
7106: $active_chk = 'previous';
7107: }
7108: }
7109: }
7110: }
7111: return $active_chk;
7112: }
7113:
7114: ###############################################
7115:
7116: =pod
7117:
7118: =item * &get_sections()
7119:
7120: Determines all the sections for a course including
7121: sections with students and sections containing other roles.
7122: Incoming parameters:
7123:
7124: 1. domain
7125: 2. course number
7126: 3. reference to array containing roles for which sections should
7127: be gathered (optional).
7128: 4. reference to array containing status types for which sections
7129: should be gathered (optional).
7130:
7131: If the third argument is undefined, sections are gathered for any role.
7132: If the fourth argument is undefined, sections are gathered for any status.
7133: Permissible values are 'active' or 'future' or 'previous'.
7134:
7135: Returns section hash (keys are section IDs, values are
7136: number of users in each section), subject to the
7137: optional roles filter, optional status filter
7138:
7139: =cut
7140:
7141: ###############################################
7142: sub get_sections {
7143: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
7144: if (!defined($cdom) || !defined($cnum)) {
7145: my $cid = $env{'request.course.id'};
7146:
7147: return if (!defined($cid));
7148:
7149: $cdom = $env{'course.'.$cid.'.domain'};
7150: $cnum = $env{'course.'.$cid.'.num'};
7151: }
7152:
7153: my %sectioncount;
7154: my $now = time;
7155:
7156: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
7157: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
7158: my $sec_index = &Apache::loncoursedata::CL_SECTION();
7159: my $status_index = &Apache::loncoursedata::CL_STATUS();
7160: my $start_index = &Apache::loncoursedata::CL_START();
7161: my $end_index = &Apache::loncoursedata::CL_END();
7162: my $status;
7163: while (my ($student,$data) = each(%$classlist)) {
7164: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
7165: $data->[$status_index],
7166: $data->[$start_index],
7167: $data->[$end_index]);
7168: if ($stu_status eq 'Active') {
7169: $status = 'active';
7170: } elsif ($end < $now) {
7171: $status = 'previous';
7172: } elsif ($start > $now) {
7173: $status = 'future';
7174: }
7175: if ($section ne '-1' && $section !~ /^\s*$/) {
7176: if ((!defined($possible_status)) || (($status ne '') &&
7177: (grep/^\Q$status\E$/,@{$possible_status}))) {
7178: $sectioncount{$section}++;
7179: }
7180: }
7181: }
7182: }
7183: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7184: foreach my $user (sort(keys(%courseroles))) {
7185: if ($user !~ /^(\w{2})/) { next; }
7186: my ($role) = ($user =~ /^(\w{2})/);
7187: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
7188: my ($section,$status);
7189: if ($role eq 'cr' &&
7190: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
7191: $section=$1;
7192: }
7193: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
7194: if (!defined($section) || $section eq '-1') { next; }
7195: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
7196: if ($end == -1 && $start == -1) {
7197: next; #deleted role
7198: }
7199: if (!defined($possible_status)) {
7200: $sectioncount{$section}++;
7201: } else {
7202: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
7203: $status = 'active';
7204: } elsif ($end < $now) {
7205: $status = 'future';
7206: } elsif ($start > $now) {
7207: $status = 'previous';
7208: }
7209: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
7210: $sectioncount{$section}++;
7211: }
7212: }
7213: }
7214: return %sectioncount;
7215: }
7216:
7217: ###############################################
7218:
7219: =pod
7220:
7221: =item * &get_course_users()
7222:
7223: Retrieves usernames:domains for users in the specified course
7224: with specific role(s), and access status.
7225:
7226: Incoming parameters:
7227: 1. course domain
7228: 2. course number
7229: 3. access status: users must have - either active,
7230: previous, future, or all.
7231: 4. reference to array of permissible roles
7232: 5. reference to array of section restrictions (optional)
7233: 6. reference to results object (hash of hashes).
7234: 7. reference to optional userdata hash
7235: 8. reference to optional statushash
7236: 9. flag if privileged users (except those set to unhide in
7237: course settings) should be excluded
7238: Keys of top level results hash are roles.
7239: Keys of inner hashes are username:domain, with
7240: values set to access type.
7241: Optional userdata hash returns an array with arguments in the
7242: same order as loncoursedata::get_classlist() for student data.
7243:
7244: Optional statushash returns
7245:
7246: Entries for end, start, section and status are blank because
7247: of the possibility of multiple values for non-student roles.
7248:
7249: =cut
7250:
7251: ###############################################
7252:
7253: sub get_course_users {
7254: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
7255: my %idx = ();
7256: my %seclists;
7257:
7258: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
7259: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
7260: $idx{end} = &Apache::loncoursedata::CL_END();
7261: $idx{start} = &Apache::loncoursedata::CL_START();
7262: $idx{id} = &Apache::loncoursedata::CL_ID();
7263: $idx{section} = &Apache::loncoursedata::CL_SECTION();
7264: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
7265: $idx{status} = &Apache::loncoursedata::CL_STATUS();
7266:
7267: if (grep(/^st$/,@{$roles})) {
7268: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
7269: my $now = time;
7270: foreach my $student (keys(%{$classlist})) {
7271: my $match = 0;
7272: my $secmatch = 0;
7273: my $section = $$classlist{$student}[$idx{section}];
7274: my $status = $$classlist{$student}[$idx{status}];
7275: if ($section eq '') {
7276: $section = 'none';
7277: }
7278: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
7279: if (grep(/^all$/,@{$sections})) {
7280: $secmatch = 1;
7281: } elsif ($$classlist{$student}[$idx{section}] eq '') {
7282: if (grep(/^none$/,@{$sections})) {
7283: $secmatch = 1;
7284: }
7285: } else {
7286: if (grep(/^\Q$section\E$/,@{$sections})) {
7287: $secmatch = 1;
7288: }
7289: }
7290: if (!$secmatch) {
7291: next;
7292: }
7293: }
7294: if (defined($$types{'active'})) {
7295: if ($$classlist{$student}[$idx{status}] eq 'Active') {
7296: push(@{$$users{st}{$student}},'active');
7297: $match = 1;
7298: }
7299: }
7300: if (defined($$types{'previous'})) {
7301: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
7302: push(@{$$users{st}{$student}},'previous');
7303: $match = 1;
7304: }
7305: }
7306: if (defined($$types{'future'})) {
7307: if ($$classlist{$student}[$idx{status}] eq 'Future') {
7308: push(@{$$users{st}{$student}},'future');
7309: $match = 1;
7310: }
7311: }
7312: if ($match) {
7313: push(@{$seclists{$student}},$section);
7314: if (ref($userdata) eq 'HASH') {
7315: $$userdata{$student} = $$classlist{$student};
7316: }
7317: if (ref($statushash) eq 'HASH') {
7318: $statushash->{$student}{'st'}{$section} = $status;
7319: }
7320: }
7321: }
7322: }
7323: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
7324: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7325: my $now = time;
7326: my %displaystatus = ( previous => 'Expired',
7327: active => 'Active',
7328: future => 'Future',
7329: );
7330: my %nothide;
7331: if ($hidepriv) {
7332: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
7333: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
7334: if ($user !~ /:/) {
7335: $nothide{join(':',split(/[\@]/,$user))}=1;
7336: } else {
7337: $nothide{$user} = 1;
7338: }
7339: }
7340: }
7341: foreach my $person (sort(keys(%coursepersonnel))) {
7342: my $match = 0;
7343: my $secmatch = 0;
7344: my $status;
7345: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
7346: $user =~ s/:$//;
7347: my ($end,$start) = split(/:/,$coursepersonnel{$person});
7348: if ($end == -1 || $start == -1) {
7349: next;
7350: }
7351: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
7352: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
7353: my ($uname,$udom) = split(/:/,$user);
7354: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
7355: if (grep(/^all$/,@{$sections})) {
7356: $secmatch = 1;
7357: } elsif ($usec eq '') {
7358: if (grep(/^none$/,@{$sections})) {
7359: $secmatch = 1;
7360: }
7361: } else {
7362: if (grep(/^\Q$usec\E$/,@{$sections})) {
7363: $secmatch = 1;
7364: }
7365: }
7366: if (!$secmatch) {
7367: next;
7368: }
7369: }
7370: if ($usec eq '') {
7371: $usec = 'none';
7372: }
7373: if ($uname ne '' && $udom ne '') {
7374: if ($hidepriv) {
7375: if ((&Apache::lonnet::privileged($uname,$udom)) &&
7376: (!$nothide{$uname.':'.$udom})) {
7377: next;
7378: }
7379: }
7380: if ($end > 0 && $end < $now) {
7381: $status = 'previous';
7382: } elsif ($start > $now) {
7383: $status = 'future';
7384: } else {
7385: $status = 'active';
7386: }
7387: foreach my $type (keys(%{$types})) {
7388: if ($status eq $type) {
7389: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
7390: push(@{$$users{$role}{$user}},$type);
7391: }
7392: $match = 1;
7393: }
7394: }
7395: if (($match) && (ref($userdata) eq 'HASH')) {
7396: if (!exists($$userdata{$uname.':'.$udom})) {
7397: &get_user_info($udom,$uname,\%idx,$userdata);
7398: }
7399: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
7400: push(@{$seclists{$uname.':'.$udom}},$usec);
7401: }
7402: if (ref($statushash) eq 'HASH') {
7403: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
7404: }
7405: }
7406: }
7407: }
7408: }
7409: if (grep(/^ow$/,@{$roles})) {
7410: if ((defined($cdom)) && (defined($cnum))) {
7411: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
7412: if ( defined($csettings{'internal.courseowner'}) ) {
7413: my $owner = $csettings{'internal.courseowner'};
7414: next if ($owner eq '');
7415: my ($ownername,$ownerdom);
7416: if ($owner =~ /^([^:]+):([^:]+)$/) {
7417: $ownername = $1;
7418: $ownerdom = $2;
7419: } else {
7420: $ownername = $owner;
7421: $ownerdom = $cdom;
7422: $owner = $ownername.':'.$ownerdom;
7423: }
7424: @{$$users{'ow'}{$owner}} = 'any';
7425: if (defined($userdata) &&
7426: !exists($$userdata{$owner})) {
7427: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
7428: if (!grep(/^none$/,@{$seclists{$owner}})) {
7429: push(@{$seclists{$owner}},'none');
7430: }
7431: if (ref($statushash) eq 'HASH') {
7432: $statushash->{$owner}{'ow'}{'none'} = 'Any';
7433: }
7434: }
7435: }
7436: }
7437: }
7438: foreach my $user (keys(%seclists)) {
7439: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
7440: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
7441: }
7442: }
7443: return;
7444: }
7445:
7446: sub get_user_info {
7447: my ($udom,$uname,$idx,$userdata) = @_;
7448: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
7449: &plainname($uname,$udom,'lastname');
7450: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
7451: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
7452: my %idhash = &Apache::lonnet::idrget($udom,($uname));
7453: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
7454: return;
7455: }
7456:
7457: ###############################################
7458:
7459: =pod
7460:
7461: =item * &get_user_quota()
7462:
7463: Retrieves quota assigned for storage of portfolio files for a user
7464:
7465: Incoming parameters:
7466: 1. user's username
7467: 2. user's domain
7468:
7469: Returns:
7470: 1. Disk quota (in Mb) assigned to student.
7471: 2. (Optional) Type of setting: custom or default
7472: (individually assigned or default for user's
7473: institutional status).
7474: 3. (Optional) - User's institutional status (e.g., faculty, staff
7475: or student - types as defined in localenroll::inst_usertypes
7476: for user's domain, which determines default quota for user.
7477: 4. (Optional) - Default quota which would apply to the user.
7478:
7479: If a value has been stored in the user's environment,
7480: it will return that, otherwise it returns the maximal default
7481: defined for the user's instituional status(es) in the domain.
7482:
7483: =cut
7484:
7485: ###############################################
7486:
7487:
7488: sub get_user_quota {
7489: my ($uname,$udom) = @_;
7490: my ($quota,$quotatype,$settingstatus,$defquota);
7491: if (!defined($udom)) {
7492: $udom = $env{'user.domain'};
7493: }
7494: if (!defined($uname)) {
7495: $uname = $env{'user.name'};
7496: }
7497: if (($udom eq '' || $uname eq '') ||
7498: ($udom eq 'public') && ($uname eq 'public')) {
7499: $quota = 0;
7500: $quotatype = 'default';
7501: $defquota = 0;
7502: } else {
7503: my $inststatus;
7504: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
7505: $quota = $env{'environment.portfolioquota'};
7506: $inststatus = $env{'environment.inststatus'};
7507: } else {
7508: my %userenv =
7509: &Apache::lonnet::get('environment',['portfolioquota',
7510: 'inststatus'],$udom,$uname);
7511: my ($tmp) = keys(%userenv);
7512: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7513: $quota = $userenv{'portfolioquota'};
7514: $inststatus = $userenv{'inststatus'};
7515: } else {
7516: undef(%userenv);
7517: }
7518: }
7519: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
7520: if ($quota eq '') {
7521: $quota = $defquota;
7522: $quotatype = 'default';
7523: } else {
7524: $quotatype = 'custom';
7525: }
7526: }
7527: if (wantarray) {
7528: return ($quota,$quotatype,$settingstatus,$defquota);
7529: } else {
7530: return $quota;
7531: }
7532: }
7533:
7534: ###############################################
7535:
7536: =pod
7537:
7538: =item * &default_quota()
7539:
7540: Retrieves default quota assigned for storage of user portfolio files,
7541: given an (optional) user's institutional status.
7542:
7543: Incoming parameters:
7544: 1. domain
7545: 2. (Optional) institutional status(es). This is a : separated list of
7546: status types (e.g., faculty, staff, student etc.)
7547: which apply to the user for whom the default is being retrieved.
7548: If the institutional status string in undefined, the domain
7549: default quota will be returned.
7550:
7551: Returns:
7552: 1. Default disk quota (in Mb) for user portfolios in the domain.
7553: 2. (Optional) institutional type which determined the value of the
7554: default quota.
7555:
7556: If a value has been stored in the domain's configuration db,
7557: it will return that, otherwise it returns 20 (for backwards
7558: compatibility with domains which have not set up a configuration
7559: db file; the original statically defined portfolio quota was 20 Mb).
7560:
7561: If the user's status includes multiple types (e.g., staff and student),
7562: the largest default quota which applies to the user determines the
7563: default quota returned.
7564:
7565: =back
7566:
7567: =cut
7568:
7569: ###############################################
7570:
7571:
7572: sub default_quota {
7573: my ($udom,$inststatus) = @_;
7574: my ($defquota,$settingstatus);
7575: my %quotahash = &Apache::lonnet::get_dom('configuration',
7576: ['quotas'],$udom);
7577: if (ref($quotahash{'quotas'}) eq 'HASH') {
7578: if ($inststatus ne '') {
7579: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
7580: foreach my $item (@statuses) {
7581: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7582: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7583: if ($defquota eq '') {
7584: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7585: $settingstatus = $item;
7586: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7587: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7588: $settingstatus = $item;
7589: }
7590: }
7591: } else {
7592: if ($quotahash{'quotas'}{$item} ne '') {
7593: if ($defquota eq '') {
7594: $defquota = $quotahash{'quotas'}{$item};
7595: $settingstatus = $item;
7596: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7597: $defquota = $quotahash{'quotas'}{$item};
7598: $settingstatus = $item;
7599: }
7600: }
7601: }
7602: }
7603: }
7604: if ($defquota eq '') {
7605: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7606: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7607: } else {
7608: $defquota = $quotahash{'quotas'}{'default'};
7609: }
7610: $settingstatus = 'default';
7611: }
7612: } else {
7613: $settingstatus = 'default';
7614: $defquota = 20;
7615: }
7616: if (wantarray) {
7617: return ($defquota,$settingstatus);
7618: } else {
7619: return $defquota;
7620: }
7621: }
7622:
7623: sub get_secgrprole_info {
7624: my ($cdom,$cnum,$needroles,$type) = @_;
7625: my %sections_count = &get_sections($cdom,$cnum);
7626: my @sections = (sort {$a <=> $b} keys(%sections_count));
7627: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7628: my @groups = sort(keys(%curr_groups));
7629: my $allroles = [];
7630: my $rolehash;
7631: my $accesshash = {
7632: active => 'Currently has access',
7633: future => 'Will have future access',
7634: previous => 'Previously had access',
7635: };
7636: if ($needroles) {
7637: $rolehash = {'all' => 'all'};
7638: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7639: if (&Apache::lonnet::error(%user_roles)) {
7640: undef(%user_roles);
7641: }
7642: foreach my $item (keys(%user_roles)) {
7643: my ($role)=split(/\:/,$item,2);
7644: if ($role eq 'cr') { next; }
7645: if ($role =~ /^cr/) {
7646: $$rolehash{$role} = (split('/',$role))[3];
7647: } else {
7648: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7649: }
7650: }
7651: foreach my $key (sort(keys(%{$rolehash}))) {
7652: push(@{$allroles},$key);
7653: }
7654: push (@{$allroles},'st');
7655: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7656: }
7657: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7658: }
7659:
7660: sub user_picker {
7661: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
7662: my $currdom = $dom;
7663: my %curr_selected = (
7664: srchin => 'dom',
7665: srchby => 'lastname',
7666: );
7667: my $srchterm;
7668: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
7669: if ($srch->{'srchby'} ne '') {
7670: $curr_selected{'srchby'} = $srch->{'srchby'};
7671: }
7672: if ($srch->{'srchin'} ne '') {
7673: $curr_selected{'srchin'} = $srch->{'srchin'};
7674: }
7675: if ($srch->{'srchtype'} ne '') {
7676: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7677: }
7678: if ($srch->{'srchdomain'} ne '') {
7679: $currdom = $srch->{'srchdomain'};
7680: }
7681: $srchterm = $srch->{'srchterm'};
7682: }
7683: my %lt=&Apache::lonlocal::texthash(
7684: 'usr' => 'Search criteria',
7685: 'doma' => 'Domain/institution to search',
7686: 'uname' => 'username',
7687: 'lastname' => 'last name',
7688: 'lastfirst' => 'last name, first name',
7689: 'crs' => 'in this course',
7690: 'dom' => 'in selected LON-CAPA domain',
7691: 'alc' => 'all LON-CAPA',
7692: 'instd' => 'in institutional directory for selected domain',
7693: 'exact' => 'is',
7694: 'contains' => 'contains',
7695: 'begins' => 'begins with',
7696: 'youm' => "You must include some text to search for.",
7697: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7698: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7699: 'yomc' => "You must choose a domain when using an institutional directory search.",
7700: 'ymcd' => "You must choose a domain when using a domain search.",
7701: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7702: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7703: 'thfo' => "The following need to be corrected before the search can be run:",
7704: );
7705: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7706: my $srchinsel = ' <select name="srchin">';
7707:
7708: my @srchins = ('crs','dom','alc','instd');
7709:
7710: foreach my $option (@srchins) {
7711: # FIXME 'alc' option unavailable until
7712: # loncreateuser::print_user_query_page()
7713: # has been completed.
7714: next if ($option eq 'alc');
7715: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
7716: next if ($option eq 'crs' && !$env{'request.course.id'});
7717: if ($curr_selected{'srchin'} eq $option) {
7718: $srchinsel .= '
7719: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7720: } else {
7721: $srchinsel .= '
7722: <option value="'.$option.'">'.$lt{$option}.'</option>';
7723: }
7724: }
7725: $srchinsel .= "\n </select>\n";
7726:
7727: my $srchbysel = ' <select name="srchby">';
7728: foreach my $option ('lastname','lastfirst','uname') {
7729: if ($curr_selected{'srchby'} eq $option) {
7730: $srchbysel .= '
7731: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7732: } else {
7733: $srchbysel .= '
7734: <option value="'.$option.'">'.$lt{$option}.'</option>';
7735: }
7736: }
7737: $srchbysel .= "\n </select>\n";
7738:
7739: my $srchtypesel = ' <select name="srchtype">';
7740: foreach my $option ('begins','contains','exact') {
7741: if ($curr_selected{'srchtype'} eq $option) {
7742: $srchtypesel .= '
7743: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7744: } else {
7745: $srchtypesel .= '
7746: <option value="'.$option.'">'.$lt{$option}.'</option>';
7747: }
7748: }
7749: $srchtypesel .= "\n </select>\n";
7750:
7751: my ($newuserscript,$new_user_create);
7752:
7753: if ($forcenewuser) {
7754: if (ref($srch) eq 'HASH') {
7755: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
7756: if ($cancreate) {
7757: $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>';
7758: } else {
7759: my $helplink = 'javascript:helpMenu('."'display'".')';
7760: my %usertypetext = (
7761: official => 'institutional',
7762: unofficial => 'non-institutional',
7763: );
7764: $new_user_create = '<p class="LC_warning">'
7765: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
7766: .' '
7767: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
7768: ,'<a href="'.$helplink.'">','</a>')
7769: .'</p><br />';
7770: }
7771: }
7772: }
7773:
7774: $newuserscript = <<"ENDSCRIPT";
7775:
7776: function setSearch(createnew,callingForm) {
7777: if (createnew == 1) {
7778: for (var i=0; i<callingForm.srchby.length; i++) {
7779: if (callingForm.srchby.options[i].value == 'uname') {
7780: callingForm.srchby.selectedIndex = i;
7781: }
7782: }
7783: for (var i=0; i<callingForm.srchin.length; i++) {
7784: if ( callingForm.srchin.options[i].value == 'dom') {
7785: callingForm.srchin.selectedIndex = i;
7786: }
7787: }
7788: for (var i=0; i<callingForm.srchtype.length; i++) {
7789: if (callingForm.srchtype.options[i].value == 'exact') {
7790: callingForm.srchtype.selectedIndex = i;
7791: }
7792: }
7793: for (var i=0; i<callingForm.srchdomain.length; i++) {
7794: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7795: callingForm.srchdomain.selectedIndex = i;
7796: }
7797: }
7798: }
7799: }
7800: ENDSCRIPT
7801:
7802: }
7803:
7804: my $output = <<"END_BLOCK";
7805: <script type="text/javascript">
7806: // <![CDATA[
7807: function validateEntry(callingForm) {
7808:
7809: var checkok = 1;
7810: var srchin;
7811: for (var i=0; i<callingForm.srchin.length; i++) {
7812: if ( callingForm.srchin[i].checked ) {
7813: srchin = callingForm.srchin[i].value;
7814: }
7815: }
7816:
7817: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7818: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7819: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7820: var srchterm = callingForm.srchterm.value;
7821: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
7822: var msg = "";
7823:
7824: if (srchterm == "") {
7825: checkok = 0;
7826: msg += "$lt{'youm'}\\n";
7827: }
7828:
7829: if (srchtype== 'begins') {
7830: if (srchterm.length < 2) {
7831: checkok = 0;
7832: msg += "$lt{'thte'}\\n";
7833: }
7834: }
7835:
7836: if (srchtype== 'contains') {
7837: if (srchterm.length < 3) {
7838: checkok = 0;
7839: msg += "$lt{'thet'}\\n";
7840: }
7841: }
7842: if (srchin == 'instd') {
7843: if (srchdomain == '') {
7844: checkok = 0;
7845: msg += "$lt{'yomc'}\\n";
7846: }
7847: }
7848: if (srchin == 'dom') {
7849: if (srchdomain == '') {
7850: checkok = 0;
7851: msg += "$lt{'ymcd'}\\n";
7852: }
7853: }
7854: if (srchby == 'lastfirst') {
7855: if (srchterm.indexOf(",") == -1) {
7856: checkok = 0;
7857: msg += "$lt{'whus'}\\n";
7858: }
7859: if (srchterm.indexOf(",") == srchterm.length -1) {
7860: checkok = 0;
7861: msg += "$lt{'whse'}\\n";
7862: }
7863: }
7864: if (checkok == 0) {
7865: alert("$lt{'thfo'}\\n"+msg);
7866: return;
7867: }
7868: if (checkok == 1) {
7869: callingForm.submit();
7870: }
7871: }
7872:
7873: $newuserscript
7874:
7875: // ]]>
7876: </script>
7877:
7878: $new_user_create
7879:
7880: END_BLOCK
7881:
7882: $output .= &Apache::lonhtmlcommon::start_pick_box().
7883: &Apache::lonhtmlcommon::row_title($lt{'doma'}).
7884: $domform.
7885: &Apache::lonhtmlcommon::row_closure().
7886: &Apache::lonhtmlcommon::row_title($lt{'usr'}).
7887: $srchbysel.
7888: $srchtypesel.
7889: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
7890: $srchinsel.
7891: &Apache::lonhtmlcommon::row_closure(1).
7892: &Apache::lonhtmlcommon::end_pick_box().
7893: '<br />';
7894: return $output;
7895: }
7896:
7897: sub user_rule_check {
7898: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
7899: my $response;
7900: if (ref($usershash) eq 'HASH') {
7901: foreach my $user (keys(%{$usershash})) {
7902: my ($uname,$udom) = split(/:/,$user);
7903: next if ($udom eq '' || $uname eq '');
7904: my ($id,$newuser);
7905: if (ref($usershash->{$user}) eq 'HASH') {
7906: $newuser = $usershash->{$user}->{'newuser'};
7907: $id = $usershash->{$user}->{'id'};
7908: }
7909: my $inst_response;
7910: if (ref($checks) eq 'HASH') {
7911: if (defined($checks->{'username'})) {
7912: ($inst_response,%{$inst_results->{$user}}) =
7913: &Apache::lonnet::get_instuser($udom,$uname);
7914: } elsif (defined($checks->{'id'})) {
7915: ($inst_response,%{$inst_results->{$user}}) =
7916: &Apache::lonnet::get_instuser($udom,undef,$id);
7917: }
7918: } else {
7919: ($inst_response,%{$inst_results->{$user}}) =
7920: &Apache::lonnet::get_instuser($udom,$uname);
7921: return;
7922: }
7923: if (!$got_rules->{$udom}) {
7924: my %domconfig = &Apache::lonnet::get_dom('configuration',
7925: ['usercreation'],$udom);
7926: if (ref($domconfig{'usercreation'}) eq 'HASH') {
7927: foreach my $item ('username','id') {
7928: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7929: $$curr_rules{$udom}{$item} =
7930: $domconfig{'usercreation'}{$item.'_rule'};
7931: }
7932: }
7933: }
7934: $got_rules->{$udom} = 1;
7935: }
7936: foreach my $item (keys(%{$checks})) {
7937: if (ref($$curr_rules{$udom}) eq 'HASH') {
7938: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7939: if (@{$$curr_rules{$udom}{$item}} > 0) {
7940: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7941: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7942: if ($rule_check{$rule}) {
7943: $$rulematch{$user}{$item} = $rule;
7944: if ($inst_response eq 'ok') {
7945: if (ref($inst_results) eq 'HASH') {
7946: if (ref($inst_results->{$user}) eq 'HASH') {
7947: if (keys(%{$inst_results->{$user}}) == 0) {
7948: $$alerts{$item}{$udom}{$uname} = 1;
7949: }
7950: }
7951: }
7952: }
7953: last;
7954: }
7955: }
7956: }
7957: }
7958: }
7959: }
7960: }
7961: }
7962: return;
7963: }
7964:
7965: sub user_rule_formats {
7966: my ($domain,$domdesc,$curr_rules,$check) = @_;
7967: my %text = (
7968: 'username' => 'Usernames',
7969: 'id' => 'IDs',
7970: );
7971: my $output;
7972: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7973: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7974: if (@{$ruleorder} > 0) {
7975: $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>';
7976: foreach my $rule (@{$ruleorder}) {
7977: if (ref($curr_rules) eq 'ARRAY') {
7978: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7979: if (ref($rules->{$rule}) eq 'HASH') {
7980: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7981: $rules->{$rule}{'desc'}.'</li>';
7982: }
7983: }
7984: }
7985: }
7986: $output .= '</ul>';
7987: }
7988: }
7989: return $output;
7990: }
7991:
7992: sub instrule_disallow_msg {
7993: my ($checkitem,$domdesc,$count,$mode) = @_;
7994: my $response;
7995: my %text = (
7996: item => 'username',
7997: items => 'usernames',
7998: match => 'matches',
7999: do => 'does',
8000: action => 'a username',
8001: one => 'one',
8002: );
8003: if ($count > 1) {
8004: $text{'item'} = 'usernames';
8005: $text{'match'} ='match';
8006: $text{'do'} = 'do';
8007: $text{'action'} = 'usernames',
8008: $text{'one'} = 'ones';
8009: }
8010: if ($checkitem eq 'id') {
8011: $text{'items'} = 'IDs';
8012: $text{'item'} = 'ID';
8013: $text{'action'} = 'an ID';
8014: if ($count > 1) {
8015: $text{'item'} = 'IDs';
8016: $text{'action'} = 'IDs';
8017: }
8018: }
8019: $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 />';
8020: if ($mode eq 'upload') {
8021: if ($checkitem eq 'username') {
8022: $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'}.");
8023: } elsif ($checkitem eq 'id') {
8024: $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.");
8025: }
8026: } elsif ($mode eq 'selfcreate') {
8027: if ($checkitem eq 'id') {
8028: $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.");
8029: }
8030: } else {
8031: if ($checkitem eq 'username') {
8032: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
8033: } elsif ($checkitem eq 'id') {
8034: $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.");
8035: }
8036: }
8037: return $response;
8038: }
8039:
8040: sub personal_data_fieldtitles {
8041: my %fieldtitles = &Apache::lonlocal::texthash (
8042: id => 'Student/Employee ID',
8043: permanentemail => 'E-mail address',
8044: lastname => 'Last Name',
8045: firstname => 'First Name',
8046: middlename => 'Middle Name',
8047: generation => 'Generation',
8048: gen => 'Generation',
8049: inststatus => 'Affiliation',
8050: );
8051: return %fieldtitles;
8052: }
8053:
8054: sub sorted_inst_types {
8055: my ($dom) = @_;
8056: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
8057: my $othertitle = &mt('All users');
8058: if ($env{'request.course.id'}) {
8059: $othertitle = &mt('Any users');
8060: }
8061: my @types;
8062: if (ref($order) eq 'ARRAY') {
8063: @types = @{$order};
8064: }
8065: if (@types == 0) {
8066: if (ref($usertypes) eq 'HASH') {
8067: @types = sort(keys(%{$usertypes}));
8068: }
8069: }
8070: if (keys(%{$usertypes}) > 0) {
8071: $othertitle = &mt('Other users');
8072: }
8073: return ($othertitle,$usertypes,\@types);
8074: }
8075:
8076: sub get_institutional_codes {
8077: my ($settings,$allcourses,$LC_code) = @_;
8078: # Get complete list of course sections to update
8079: my @currsections = ();
8080: my @currxlists = ();
8081: my $coursecode = $$settings{'internal.coursecode'};
8082:
8083: if ($$settings{'internal.sectionnums'} ne '') {
8084: @currsections = split(/,/,$$settings{'internal.sectionnums'});
8085: }
8086:
8087: if ($$settings{'internal.crosslistings'} ne '') {
8088: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
8089: }
8090:
8091: if (@currxlists > 0) {
8092: foreach (@currxlists) {
8093: if (m/^([^:]+):(\w*)$/) {
8094: unless (grep/^$1$/,@{$allcourses}) {
8095: push @{$allcourses},$1;
8096: $$LC_code{$1} = $2;
8097: }
8098: }
8099: }
8100: }
8101:
8102: if (@currsections > 0) {
8103: foreach (@currsections) {
8104: if (m/^(\w+):(\w*)$/) {
8105: my $sec = $coursecode.$1;
8106: my $lc_sec = $2;
8107: unless (grep/^$sec$/,@{$allcourses}) {
8108: push @{$allcourses},$sec;
8109: $$LC_code{$sec} = $lc_sec;
8110: }
8111: }
8112: }
8113: }
8114: return;
8115: }
8116:
8117: =pod
8118:
8119: =head1 Slot Helpers
8120:
8121: =over 4
8122:
8123: =item * sorted_slots()
8124:
8125: Sorts an array of slot names in order of slot start time (earliest first).
8126:
8127: Inputs:
8128:
8129: =over 4
8130:
8131: slotsarr - Reference to array of unsorted slot names.
8132:
8133: slots - Reference to hash of hash, where outer hash keys are slot names.
8134:
8135: =back
8136:
8137: Returns:
8138:
8139: =over 4
8140:
8141: sorted - An array of slot names sorted by the start time of the slot.
8142:
8143: =back
8144:
8145: =back
8146:
8147: =cut
8148:
8149:
8150: sub sorted_slots {
8151: my ($slotsarr,$slots) = @_;
8152: my @sorted;
8153: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
8154: @sorted =
8155: sort {
8156: if (ref($slots->{$a}) && ref($slots->{$b})) {
8157: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
8158: }
8159: if (ref($slots->{$a})) { return -1;}
8160: if (ref($slots->{$b})) { return 1;}
8161: return 0;
8162: } @{$slotsarr};
8163: }
8164: return @sorted;
8165: }
8166:
8167:
8168: =pod
8169:
8170: =head1 HTTP Helpers
8171:
8172: =over 4
8173:
8174: =item * &get_unprocessed_cgi($query,$possible_names)
8175:
8176: Modify the %env hash to contain unprocessed CGI form parameters held in
8177: $query. The parameters listed in $possible_names (an array reference),
8178: will be set in $env{'form.name'} if they do not already exist.
8179:
8180: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
8181: $possible_names is an ref to an array of form element names. As an example:
8182: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
8183: will result in $env{'form.uname'} and $env{'form.udom'} being set.
8184:
8185: =cut
8186:
8187: sub get_unprocessed_cgi {
8188: my ($query,$possible_names)= @_;
8189: # $Apache::lonxml::debug=1;
8190: foreach my $pair (split(/&/,$query)) {
8191: my ($name, $value) = split(/=/,$pair);
8192: $name = &unescape($name);
8193: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
8194: $value =~ tr/+/ /;
8195: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
8196: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
8197: }
8198: }
8199: }
8200:
8201: =pod
8202:
8203: =item * &cacheheader()
8204:
8205: returns cache-controlling header code
8206:
8207: =cut
8208:
8209: sub cacheheader {
8210: unless ($env{'request.method'} eq 'GET') { return ''; }
8211: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
8212: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
8213: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
8214: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
8215: return $output;
8216: }
8217:
8218: =pod
8219:
8220: =item * &no_cache($r)
8221:
8222: specifies header code to not have cache
8223:
8224: =cut
8225:
8226: sub no_cache {
8227: my ($r) = @_;
8228: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
8229: $env{'request.method'} ne 'GET') { return ''; }
8230: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
8231: $r->no_cache(1);
8232: $r->header_out("Expires" => $date);
8233: $r->header_out("Pragma" => "no-cache");
8234: }
8235:
8236: sub content_type {
8237: my ($r,$type,$charset) = @_;
8238: if ($r) {
8239: # Note that printout.pl calls this with undef for $r.
8240: &no_cache($r);
8241: }
8242: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
8243: unless ($charset) {
8244: $charset=&Apache::lonlocal::current_encoding;
8245: }
8246: if ($charset) { $type.='; charset='.$charset; }
8247: if ($r) {
8248: $r->content_type($type);
8249: } else {
8250: print("Content-type: $type\n\n");
8251: }
8252: }
8253:
8254: =pod
8255:
8256: =item * &add_to_env($name,$value)
8257:
8258: adds $name to the %env hash with value
8259: $value, if $name already exists, the entry is converted to an array
8260: reference and $value is added to the array.
8261:
8262: =cut
8263:
8264: sub add_to_env {
8265: my ($name,$value)=@_;
8266: if (defined($env{$name})) {
8267: if (ref($env{$name})) {
8268: #already have multiple values
8269: push(@{ $env{$name} },$value);
8270: } else {
8271: #first time seeing multiple values, convert hash entry to an arrayref
8272: my $first=$env{$name};
8273: undef($env{$name});
8274: push(@{ $env{$name} },$first,$value);
8275: }
8276: } else {
8277: $env{$name}=$value;
8278: }
8279: }
8280:
8281: =pod
8282:
8283: =item * &get_env_multiple($name)
8284:
8285: gets $name from the %env hash, it seemlessly handles the cases where multiple
8286: values may be defined and end up as an array ref.
8287:
8288: returns an array of values
8289:
8290: =cut
8291:
8292: sub get_env_multiple {
8293: my ($name) = @_;
8294: my @values;
8295: if (defined($env{$name})) {
8296: # exists is it an array
8297: if (ref($env{$name})) {
8298: @values=@{ $env{$name} };
8299: } else {
8300: $values[0]=$env{$name};
8301: }
8302: }
8303: return(@values);
8304: }
8305:
8306: sub ask_for_embedded_content {
8307: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
8308: my $upload_output = '
8309: <form name="upload_embedded" action="'.$actionurl.'"
8310: method="post" enctype="multipart/form-data">';
8311: $upload_output .= $state;
8312: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
8313:
8314: my $num = 0;
8315: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
8316: $upload_output .= &start_data_table_row().
8317: '<td>'.$embed_file.'</td><td>';
8318: if ($args->{'ignore_remote_references'}
8319: && $embed_file =~ m{^\w+://}) {
8320: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
8321: } elsif ($args->{'error_on_invalid_names'}
8322: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
8323:
8324: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
8325:
8326: } else {
8327: $upload_output .='
8328: <input name="embedded_item_'.$num.'" type="file" value="" />
8329: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
8330: my $attrib = join(':',@{$$allfiles{$embed_file}});
8331: $upload_output .=
8332: "\n\t\t".
8333: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
8334: $attrib.'" />';
8335: if (exists($$codebase{$embed_file})) {
8336: $upload_output .=
8337: "\n\t\t".
8338: '<input name="codebase_'.$num.'" type="hidden" value="'.
8339: &escape($$codebase{$embed_file}).'" />';
8340: }
8341: }
8342: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
8343: $num++;
8344: }
8345: $upload_output .= &Apache::loncommon::end_data_table().'<br />
8346: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
8347: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
8348: '.&mt('(only files for which a location has been provided will be uploaded)').'
8349: </form>';
8350: return $upload_output;
8351: }
8352:
8353: sub upload_embedded {
8354: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
8355: $current_disk_usage) = @_;
8356: my $output;
8357: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
8358: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
8359: my $orig_uploaded_filename =
8360: $env{'form.embedded_item_'.$i.'.filename'};
8361:
8362: $env{'form.embedded_orig_'.$i} =
8363: &unescape($env{'form.embedded_orig_'.$i});
8364: my ($path,$fname) =
8365: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
8366: # no path, whole string is fname
8367: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
8368:
8369: $path = $env{'form.currentpath'}.$path;
8370: $fname = &Apache::lonnet::clean_filename($fname);
8371: # See if there is anything left
8372: next if ($fname eq '');
8373:
8374: # Check if file already exists as a file or directory.
8375: my ($state,$msg);
8376: if ($context eq 'portfolio') {
8377: my $port_path = $dirpath;
8378: if ($group ne '') {
8379: $port_path = "groups/$group/$port_path";
8380: }
8381: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
8382: $dir_root,$port_path,$disk_quota,
8383: $current_disk_usage,$uname,$udom);
8384: if ($state eq 'will_exceed_quota'
8385: || $state eq 'file_locked'
8386: || $state eq 'file_exists' ) {
8387: $output .= $msg;
8388: next;
8389: }
8390: } elsif (($context eq 'author') || ($context eq 'testbank')) {
8391: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
8392: if ($state eq 'exists') {
8393: $output .= $msg;
8394: next;
8395: }
8396: }
8397: # Check if extension is valid
8398: if (($fname =~ /\.(\w+)$/) &&
8399: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
8400: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
8401: next;
8402: } elsif (($fname =~ /\.(\w+)$/) &&
8403: (!defined(&Apache::loncommon::fileembstyle($1)))) {
8404: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
8405: next;
8406: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
8407: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
8408: next;
8409: }
8410:
8411: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
8412: if ($context eq 'portfolio') {
8413: my $result=
8414: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
8415: $dirpath.$path);
8416: if ($result !~ m|^/uploaded/|) {
8417: $output .= '<span class="LC_error">'
8418: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
8419: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
8420: .'</span><br />';
8421: next;
8422: } else {
8423: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
8424: $path.$fname.'</span>').'</p>';
8425: }
8426: } else {
8427: # Save the file
8428: my $target = $env{'form.embedded_item_'.$i};
8429: my $fullpath = $dir_root.$dirpath.'/'.$path;
8430: my $dest = $fullpath.$fname;
8431: my $url = $url_root.$dirpath.'/'.$path.$fname;
8432: my @parts=split(/\//,$fullpath);
8433: my $count;
8434: my $filepath = $dir_root;
8435: for ($count=4;$count<=$#parts;$count++) {
8436: $filepath .= "/$parts[$count]";
8437: if ((-e $filepath)!=1) {
8438: mkdir($filepath,0770);
8439: }
8440: }
8441: my $fh;
8442: if (!open($fh,'>'.$dest)) {
8443: &Apache::lonnet::logthis('Failed to create '.$dest);
8444: $output .= '<span class="LC_error">'.
8445: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8446: '</span><br />';
8447: } else {
8448: if (!print $fh $env{'form.embedded_item_'.$i}) {
8449: &Apache::lonnet::logthis('Failed to write to '.$dest);
8450: $output .= '<span class="LC_error">'.
8451: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
8452: '</span><br />';
8453: } else {
8454: if ($context eq 'testbank') {
8455: $output .= &mt('Embedded file uploaded successfully:').
8456: ' <a href="'.$url.'">'.
8457: $orig_uploaded_filename.'</a><br />';
8458: } else {
8459: $output .= '<span class=\"LC_fontsize_large\">'.
8460: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
8461: $orig_uploaded_filename.'</a>').'</span><br />';
8462: }
8463: }
8464: close($fh);
8465: }
8466: }
8467: }
8468: return $output;
8469: }
8470:
8471: sub check_for_existing {
8472: my ($path,$fname,$element) = @_;
8473: my ($state,$msg);
8474: if (-d $path.'/'.$fname) {
8475: $state = 'exists';
8476: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8477: } elsif (-e $path.'/'.$fname) {
8478: $state = 'exists';
8479: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
8480: }
8481: if ($state eq 'exists') {
8482: $msg = '<span class="LC_error">'.$msg.'</span><br />';
8483: }
8484: return ($state,$msg);
8485: }
8486:
8487: sub check_for_upload {
8488: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
8489: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
8490: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
8491: my $getpropath = 1;
8492: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
8493: $getpropath);
8494: my $found_file = 0;
8495: my $locked_file = 0;
8496: foreach my $line (@dir_list) {
8497: my ($file_name)=split(/\&/,$line,2);
8498: if ($file_name eq $fname){
8499: $file_name = $path.$file_name;
8500: if ($group ne '') {
8501: $file_name = $group.$file_name;
8502: }
8503: $found_file = 1;
8504: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
8505: $locked_file = 1;
8506: }
8507: }
8508: }
8509: if (($current_disk_usage + $filesize) > $disk_quota){
8510: my $msg = '<span class="LC_error">'.
8511: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
8512: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
8513: return ('will_exceed_quota',$msg);
8514: } elsif ($found_file) {
8515: if ($locked_file) {
8516: my $msg = '<span class="LC_error">';
8517: $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>');
8518: $msg .= '</span><br />';
8519: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
8520: return ('file_locked',$msg);
8521: } else {
8522: my $msg = '<span class="LC_error">';
8523: $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'});
8524: $msg .= '</span>';
8525: $msg .= '<br />';
8526: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8527: return ('file_exists',$msg);
8528: }
8529: }
8530: }
8531:
8532:
8533: =pod
8534:
8535: =back
8536:
8537: =head1 CSV Upload/Handling functions
8538:
8539: =over 4
8540:
8541: =item * &upfile_store($r)
8542:
8543: Store uploaded file, $r should be the HTTP Request object,
8544: needs $env{'form.upfile'}
8545: returns $datatoken to be put into hidden field
8546:
8547: =cut
8548:
8549: sub upfile_store {
8550: my $r=shift;
8551: $env{'form.upfile'}=~s/\r/\n/gs;
8552: $env{'form.upfile'}=~s/\f/\n/gs;
8553: $env{'form.upfile'}=~s/\n+/\n/gs;
8554: $env{'form.upfile'}=~s/\n+$//gs;
8555:
8556: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8557: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
8558: {
8559: my $datafile = $r->dir_config('lonDaemons').
8560: '/tmp/'.$datatoken.'.tmp';
8561: if ( open(my $fh,">$datafile") ) {
8562: print $fh $env{'form.upfile'};
8563: close($fh);
8564: }
8565: }
8566: return $datatoken;
8567: }
8568:
8569: =pod
8570:
8571: =item * &load_tmp_file($r)
8572:
8573: Load uploaded file from tmp, $r should be the HTTP Request object,
8574: needs $env{'form.datatoken'},
8575: sets $env{'form.upfile'} to the contents of the file
8576:
8577: =cut
8578:
8579: sub load_tmp_file {
8580: my $r=shift;
8581: my @studentdata=();
8582: {
8583: my $studentfile = $r->dir_config('lonDaemons').
8584: '/tmp/'.$env{'form.datatoken'}.'.tmp';
8585: if ( open(my $fh,"<$studentfile") ) {
8586: @studentdata=<$fh>;
8587: close($fh);
8588: }
8589: }
8590: $env{'form.upfile'}=join('',@studentdata);
8591: }
8592:
8593: =pod
8594:
8595: =item * &upfile_record_sep()
8596:
8597: Separate uploaded file into records
8598: returns array of records,
8599: needs $env{'form.upfile'} and $env{'form.upfiletype'}
8600:
8601: =cut
8602:
8603: sub upfile_record_sep {
8604: if ($env{'form.upfiletype'} eq 'xml') {
8605: } else {
8606: my @records;
8607: foreach my $line (split(/\n/,$env{'form.upfile'})) {
8608: if ($line=~/^\s*$/) { next; }
8609: push(@records,$line);
8610: }
8611: return @records;
8612: }
8613: }
8614:
8615: =pod
8616:
8617: =item * &record_sep($record)
8618:
8619: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
8620:
8621: =cut
8622:
8623: sub takeleft {
8624: my $index=shift;
8625: return substr('0000'.$index,-4,4);
8626: }
8627:
8628: sub record_sep {
8629: my $record=shift;
8630: my %components=();
8631: if ($env{'form.upfiletype'} eq 'xml') {
8632: } elsif ($env{'form.upfiletype'} eq 'space') {
8633: my $i=0;
8634: foreach my $field (split(/\s+/,$record)) {
8635: $field=~s/^(\"|\')//;
8636: $field=~s/(\"|\')$//;
8637: $components{&takeleft($i)}=$field;
8638: $i++;
8639: }
8640: } elsif ($env{'form.upfiletype'} eq 'tab') {
8641: my $i=0;
8642: foreach my $field (split(/\t/,$record)) {
8643: $field=~s/^(\"|\')//;
8644: $field=~s/(\"|\')$//;
8645: $components{&takeleft($i)}=$field;
8646: $i++;
8647: }
8648: } else {
8649: my $separator=',';
8650: if ($env{'form.upfiletype'} eq 'semisv') {
8651: $separator=';';
8652: }
8653: my $i=0;
8654: # the character we are looking for to indicate the end of a quote or a record
8655: my $looking_for=$separator;
8656: # do not add the characters to the fields
8657: my $ignore=0;
8658: # we just encountered a separator (or the beginning of the record)
8659: my $just_found_separator=1;
8660: # store the field we are working on here
8661: my $field='';
8662: # work our way through all characters in record
8663: foreach my $character ($record=~/(.)/g) {
8664: if ($character eq $looking_for) {
8665: if ($character ne $separator) {
8666: # Found the end of a quote, again looking for separator
8667: $looking_for=$separator;
8668: $ignore=1;
8669: } else {
8670: # Found a separator, store away what we got
8671: $components{&takeleft($i)}=$field;
8672: $i++;
8673: $just_found_separator=1;
8674: $ignore=0;
8675: $field='';
8676: }
8677: next;
8678: }
8679: # single or double quotation marks after a separator indicate beginning of a quote
8680: # we are now looking for the end of the quote and need to ignore separators
8681: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8682: $looking_for=$character;
8683: next;
8684: }
8685: # ignore would be true after we reached the end of a quote
8686: if ($ignore) { next; }
8687: if (($just_found_separator) && ($character=~/\s/)) { next; }
8688: $field.=$character;
8689: $just_found_separator=0;
8690: }
8691: # catch the very last entry, since we never encountered the separator
8692: $components{&takeleft($i)}=$field;
8693: }
8694: return %components;
8695: }
8696:
8697: ######################################################
8698: ######################################################
8699:
8700: =pod
8701:
8702: =item * &upfile_select_html()
8703:
8704: Return HTML code to select a file from the users machine and specify
8705: the file type.
8706:
8707: =cut
8708:
8709: ######################################################
8710: ######################################################
8711: sub upfile_select_html {
8712: my %Types = (
8713: csv => &mt('CSV (comma separated values, spreadsheet)'),
8714: semisv => &mt('Semicolon separated values'),
8715: space => &mt('Space separated'),
8716: tab => &mt('Tabulator separated'),
8717: # xml => &mt('HTML/XML'),
8718: );
8719: my $Str = '<input type="file" name="upfile" size="50" />'.
8720: '<br />'.&mt('Type').': <select name="upfiletype">';
8721: foreach my $type (sort(keys(%Types))) {
8722: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8723: }
8724: $Str .= "</select>\n";
8725: return $Str;
8726: }
8727:
8728: sub get_samples {
8729: my ($records,$toget) = @_;
8730: my @samples=({});
8731: my $got=0;
8732: foreach my $rec (@$records) {
8733: my %temp = &record_sep($rec);
8734: if (! grep(/\S/, values(%temp))) { next; }
8735: if (%temp) {
8736: $samples[$got]=\%temp;
8737: $got++;
8738: if ($got == $toget) { last; }
8739: }
8740: }
8741: return \@samples;
8742: }
8743:
8744: ######################################################
8745: ######################################################
8746:
8747: =pod
8748:
8749: =item * &csv_print_samples($r,$records)
8750:
8751: Prints a table of sample values from each column uploaded $r is an
8752: Apache Request ref, $records is an arrayref from
8753: &Apache::loncommon::upfile_record_sep
8754:
8755: =cut
8756:
8757: ######################################################
8758: ######################################################
8759: sub csv_print_samples {
8760: my ($r,$records) = @_;
8761: my $samples = &get_samples($records,5);
8762:
8763: $r->print(&mt('Samples').'<br />'.&start_data_table().
8764: &start_data_table_header_row());
8765: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8766: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
8767: $r->print(&end_data_table_header_row());
8768: foreach my $hash (@$samples) {
8769: $r->print(&start_data_table_row());
8770: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8771: $r->print('<td>');
8772: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
8773: $r->print('</td>');
8774: }
8775: $r->print(&end_data_table_row());
8776: }
8777: $r->print(&end_data_table().'<br />'."\n");
8778: }
8779:
8780: ######################################################
8781: ######################################################
8782:
8783: =pod
8784:
8785: =item * &csv_print_select_table($r,$records,$d)
8786:
8787: Prints a table to create associations between values and table columns.
8788:
8789: $r is an Apache Request ref,
8790: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8791: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
8792:
8793: =cut
8794:
8795: ######################################################
8796: ######################################################
8797: sub csv_print_select_table {
8798: my ($r,$records,$d) = @_;
8799: my $i=0;
8800: my $samples = &get_samples($records,1);
8801: $r->print(&mt('Associate columns with student attributes.')."\n".
8802: &start_data_table().&start_data_table_header_row().
8803: '<th>'.&mt('Attribute').'</th>'.
8804: '<th>'.&mt('Column').'</th>'.
8805: &end_data_table_header_row()."\n");
8806: foreach my $array_ref (@$d) {
8807: my ($value,$display,$defaultcol)=@{ $array_ref };
8808: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
8809:
8810: $r->print('<td><select name="f'.$i.'"'.
8811: ' onchange="javascript:flip(this.form,'.$i.');">');
8812: $r->print('<option value="none"></option>');
8813: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8814: $r->print('<option value="'.$sample.'"'.
8815: ($sample eq $defaultcol ? ' selected="selected" ' : '').
8816: '>'.&mt('Column [_1]',($sample+1)).'</option>');
8817: }
8818: $r->print('</select></td>'.&end_data_table_row()."\n");
8819: $i++;
8820: }
8821: $r->print(&end_data_table());
8822: $i--;
8823: return $i;
8824: }
8825:
8826: ######################################################
8827: ######################################################
8828:
8829: =pod
8830:
8831: =item * &csv_samples_select_table($r,$records,$d)
8832:
8833: Prints a table of sample values from the upload and can make associate samples to internal names.
8834:
8835: $r is an Apache Request ref,
8836: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8837: $d is an array of 2 element arrays (internal name, displayed name)
8838:
8839: =cut
8840:
8841: ######################################################
8842: ######################################################
8843: sub csv_samples_select_table {
8844: my ($r,$records,$d) = @_;
8845: my $i=0;
8846: #
8847: my $max_samples = 5;
8848: my $samples = &get_samples($records,$max_samples);
8849: $r->print(&start_data_table().
8850: &start_data_table_header_row().'<th>'.
8851: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8852: &end_data_table_header_row());
8853:
8854: foreach my $key (sort(keys(%{ $samples->[0] }))) {
8855: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
8856: ' onchange="javascript:flip(this.form,'.$i.');">');
8857: foreach my $option (@$d) {
8858: my ($value,$display,$defaultcol)=@{ $option };
8859: $r->print('<option value="'.$value.'"'.
8860: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
8861: $display.'</option>');
8862: }
8863: $r->print('</select></td><td>');
8864: foreach my $line (0..($max_samples-1)) {
8865: if (defined($samples->[$line]{$key})) {
8866: $r->print($samples->[$line]{$key}."<br />\n");
8867: }
8868: }
8869: $r->print('</td>'.&end_data_table_row());
8870: $i++;
8871: }
8872: $r->print(&end_data_table());
8873: $i--;
8874: return($i);
8875: }
8876:
8877: ######################################################
8878: ######################################################
8879:
8880: =pod
8881:
8882: =item * &clean_excel_name($name)
8883:
8884: Returns a replacement for $name which does not contain any illegal characters.
8885:
8886: =cut
8887:
8888: ######################################################
8889: ######################################################
8890: sub clean_excel_name {
8891: my ($name) = @_;
8892: $name =~ s/[:\*\?\/\\]//g;
8893: if (length($name) > 31) {
8894: $name = substr($name,0,31);
8895: }
8896: return $name;
8897: }
8898:
8899: =pod
8900:
8901: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
8902:
8903: Returns either 1 or undef
8904:
8905: 1 if the part is to be hidden, undef if it is to be shown
8906:
8907: Arguments are:
8908:
8909: $id the id of the part to be checked
8910: $symb, optional the symb of the resource to check
8911: $udom, optional the domain of the user to check for
8912: $uname, optional the username of the user to check for
8913:
8914: =cut
8915:
8916: sub check_if_partid_hidden {
8917: my ($id,$symb,$udom,$uname) = @_;
8918: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
8919: $symb,$udom,$uname);
8920: my $truth=1;
8921: #if the string starts with !, then the list is the list to show not hide
8922: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
8923: my @hiddenlist=split(/,/,$hiddenparts);
8924: foreach my $checkid (@hiddenlist) {
8925: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
8926: }
8927: return !$truth;
8928: }
8929:
8930:
8931: ############################################################
8932: ############################################################
8933:
8934: =pod
8935:
8936: =back
8937:
8938: =head1 cgi-bin script and graphing routines
8939:
8940: =over 4
8941:
8942: =item * &get_cgi_id()
8943:
8944: Inputs: none
8945:
8946: Returns an id which can be used to pass environment variables
8947: to various cgi-bin scripts. These environment variables will
8948: be removed from the users environment after a given time by
8949: the routine &Apache::lonnet::transfer_profile_to_env.
8950:
8951: =cut
8952:
8953: ############################################################
8954: ############################################################
8955: my $uniq=0;
8956: sub get_cgi_id {
8957: $uniq=($uniq+1)%100000;
8958: return (time.'_'.$$.'_'.$uniq);
8959: }
8960:
8961: ############################################################
8962: ############################################################
8963:
8964: =pod
8965:
8966: =item * &DrawBarGraph()
8967:
8968: Facilitates the plotting of data in a (stacked) bar graph.
8969: Puts plot definition data into the users environment in order for
8970: graph.png to plot it. Returns an <img> tag for the plot.
8971: The bars on the plot are labeled '1','2',...,'n'.
8972:
8973: Inputs:
8974:
8975: =over 4
8976:
8977: =item $Title: string, the title of the plot
8978:
8979: =item $xlabel: string, text describing the X-axis of the plot
8980:
8981: =item $ylabel: string, text describing the Y-axis of the plot
8982:
8983: =item $Max: scalar, the maximum Y value to use in the plot
8984: If $Max is < any data point, the graph will not be rendered.
8985:
8986: =item $colors: array ref holding the colors to be used for the data sets when
8987: they are plotted. If undefined, default values will be used.
8988:
8989: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8990:
8991: =item @Values: An array of array references. Each array reference holds data
8992: to be plotted in a stacked bar chart.
8993:
8994: =item If the final element of @Values is a hash reference the key/value
8995: pairs will be added to the graph definition.
8996:
8997: =back
8998:
8999: Returns:
9000:
9001: An <img> tag which references graph.png and the appropriate identifying
9002: information for the plot.
9003:
9004: =cut
9005:
9006: ############################################################
9007: ############################################################
9008: sub DrawBarGraph {
9009: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
9010: #
9011: if (! defined($colors)) {
9012: $colors = ['#33ff00',
9013: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
9014: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
9015: ];
9016: }
9017: my $extra_settings = {};
9018: if (ref($Values[-1]) eq 'HASH') {
9019: $extra_settings = pop(@Values);
9020: }
9021: #
9022: my $identifier = &get_cgi_id();
9023: my $id = 'cgi.'.$identifier;
9024: if (! @Values || ref($Values[0]) ne 'ARRAY') {
9025: return '';
9026: }
9027: #
9028: my @Labels;
9029: if (defined($labels)) {
9030: @Labels = @$labels;
9031: } else {
9032: for (my $i=0;$i<@{$Values[0]};$i++) {
9033: push (@Labels,$i+1);
9034: }
9035: }
9036: #
9037: my $NumBars = scalar(@{$Values[0]});
9038: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
9039: my %ValuesHash;
9040: my $NumSets=1;
9041: foreach my $array (@Values) {
9042: next if (! ref($array));
9043: $ValuesHash{$id.'.data.'.$NumSets++} =
9044: join(',',@$array);
9045: }
9046: #
9047: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
9048: if ($NumBars < 3) {
9049: $width = 120+$NumBars*32;
9050: $xskip = 1;
9051: $bar_width = 30;
9052: } elsif ($NumBars < 5) {
9053: $width = 120+$NumBars*20;
9054: $xskip = 1;
9055: $bar_width = 20;
9056: } elsif ($NumBars < 10) {
9057: $width = 120+$NumBars*15;
9058: $xskip = 1;
9059: $bar_width = 15;
9060: } elsif ($NumBars <= 25) {
9061: $width = 120+$NumBars*11;
9062: $xskip = 5;
9063: $bar_width = 8;
9064: } elsif ($NumBars <= 50) {
9065: $width = 120+$NumBars*8;
9066: $xskip = 5;
9067: $bar_width = 4;
9068: } else {
9069: $width = 120+$NumBars*8;
9070: $xskip = 5;
9071: $bar_width = 4;
9072: }
9073: #
9074: $Max = 1 if ($Max < 1);
9075: if ( int($Max) < $Max ) {
9076: $Max++;
9077: $Max = int($Max);
9078: }
9079: $Title = '' if (! defined($Title));
9080: $xlabel = '' if (! defined($xlabel));
9081: $ylabel = '' if (! defined($ylabel));
9082: $ValuesHash{$id.'.title'} = &escape($Title);
9083: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
9084: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
9085: $ValuesHash{$id.'.y_max_value'} = $Max;
9086: $ValuesHash{$id.'.NumBars'} = $NumBars;
9087: $ValuesHash{$id.'.NumSets'} = $NumSets;
9088: $ValuesHash{$id.'.PlotType'} = 'bar';
9089: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9090: $ValuesHash{$id.'.height'} = $height;
9091: $ValuesHash{$id.'.width'} = $width;
9092: $ValuesHash{$id.'.xskip'} = $xskip;
9093: $ValuesHash{$id.'.bar_width'} = $bar_width;
9094: $ValuesHash{$id.'.labels'} = join(',',@Labels);
9095: #
9096: # Deal with other parameters
9097: while (my ($key,$value) = each(%$extra_settings)) {
9098: $ValuesHash{$id.'.'.$key} = $value;
9099: }
9100: #
9101: &Apache::lonnet::appenv(\%ValuesHash);
9102: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9103: }
9104:
9105: ############################################################
9106: ############################################################
9107:
9108: =pod
9109:
9110: =item * &DrawXYGraph()
9111:
9112: Facilitates the plotting of data in an XY graph.
9113: Puts plot definition data into the users environment in order for
9114: graph.png to plot it. Returns an <img> tag for the plot.
9115:
9116: Inputs:
9117:
9118: =over 4
9119:
9120: =item $Title: string, the title of the plot
9121:
9122: =item $xlabel: string, text describing the X-axis of the plot
9123:
9124: =item $ylabel: string, text describing the Y-axis of the plot
9125:
9126: =item $Max: scalar, the maximum Y value to use in the plot
9127: If $Max is < any data point, the graph will not be rendered.
9128:
9129: =item $colors: Array ref containing the hex color codes for the data to be
9130: plotted in. If undefined, default values will be used.
9131:
9132: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9133:
9134: =item $Ydata: Array ref containing Array refs.
9135: Each of the contained arrays will be plotted as a separate curve.
9136:
9137: =item %Values: hash indicating or overriding any default values which are
9138: passed to graph.png.
9139: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9140:
9141: =back
9142:
9143: Returns:
9144:
9145: An <img> tag which references graph.png and the appropriate identifying
9146: information for the plot.
9147:
9148: =cut
9149:
9150: ############################################################
9151: ############################################################
9152: sub DrawXYGraph {
9153: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
9154: #
9155: # Create the identifier for the graph
9156: my $identifier = &get_cgi_id();
9157: my $id = 'cgi.'.$identifier;
9158: #
9159: $Title = '' if (! defined($Title));
9160: $xlabel = '' if (! defined($xlabel));
9161: $ylabel = '' if (! defined($ylabel));
9162: my %ValuesHash =
9163: (
9164: $id.'.title' => &escape($Title),
9165: $id.'.xlabel' => &escape($xlabel),
9166: $id.'.ylabel' => &escape($ylabel),
9167: $id.'.y_max_value'=> $Max,
9168: $id.'.labels' => join(',',@$Xlabels),
9169: $id.'.PlotType' => 'XY',
9170: );
9171: #
9172: if (defined($colors) && ref($colors) eq 'ARRAY') {
9173: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9174: }
9175: #
9176: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
9177: return '';
9178: }
9179: my $NumSets=1;
9180: foreach my $array (@{$Ydata}){
9181: next if (! ref($array));
9182: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9183: }
9184: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
9185: #
9186: # Deal with other parameters
9187: while (my ($key,$value) = each(%Values)) {
9188: $ValuesHash{$id.'.'.$key} = $value;
9189: }
9190: #
9191: &Apache::lonnet::appenv(\%ValuesHash);
9192: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9193: }
9194:
9195: ############################################################
9196: ############################################################
9197:
9198: =pod
9199:
9200: =item * &DrawXYYGraph()
9201:
9202: Facilitates the plotting of data in an XY graph with two Y axes.
9203: Puts plot definition data into the users environment in order for
9204: graph.png to plot it. Returns an <img> tag for the plot.
9205:
9206: Inputs:
9207:
9208: =over 4
9209:
9210: =item $Title: string, the title of the plot
9211:
9212: =item $xlabel: string, text describing the X-axis of the plot
9213:
9214: =item $ylabel: string, text describing the Y-axis of the plot
9215:
9216: =item $colors: Array ref containing the hex color codes for the data to be
9217: plotted in. If undefined, default values will be used.
9218:
9219: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
9220:
9221: =item $Ydata1: The first data set
9222:
9223: =item $Min1: The minimum value of the left Y-axis
9224:
9225: =item $Max1: The maximum value of the left Y-axis
9226:
9227: =item $Ydata2: The second data set
9228:
9229: =item $Min2: The minimum value of the right Y-axis
9230:
9231: =item $Max2: The maximum value of the left Y-axis
9232:
9233: =item %Values: hash indicating or overriding any default values which are
9234: passed to graph.png.
9235: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
9236:
9237: =back
9238:
9239: Returns:
9240:
9241: An <img> tag which references graph.png and the appropriate identifying
9242: information for the plot.
9243:
9244: =cut
9245:
9246: ############################################################
9247: ############################################################
9248: sub DrawXYYGraph {
9249: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
9250: $Ydata2,$Min2,$Max2,%Values)=@_;
9251: #
9252: # Create the identifier for the graph
9253: my $identifier = &get_cgi_id();
9254: my $id = 'cgi.'.$identifier;
9255: #
9256: $Title = '' if (! defined($Title));
9257: $xlabel = '' if (! defined($xlabel));
9258: $ylabel = '' if (! defined($ylabel));
9259: my %ValuesHash =
9260: (
9261: $id.'.title' => &escape($Title),
9262: $id.'.xlabel' => &escape($xlabel),
9263: $id.'.ylabel' => &escape($ylabel),
9264: $id.'.labels' => join(',',@$Xlabels),
9265: $id.'.PlotType' => 'XY',
9266: $id.'.NumSets' => 2,
9267: $id.'.two_axes' => 1,
9268: $id.'.y1_max_value' => $Max1,
9269: $id.'.y1_min_value' => $Min1,
9270: $id.'.y2_max_value' => $Max2,
9271: $id.'.y2_min_value' => $Min2,
9272: );
9273: #
9274: if (defined($colors) && ref($colors) eq 'ARRAY') {
9275: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
9276: }
9277: #
9278: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
9279: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
9280: return '';
9281: }
9282: my $NumSets=1;
9283: foreach my $array ($Ydata1,$Ydata2){
9284: next if (! ref($array));
9285: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
9286: }
9287: #
9288: # Deal with other parameters
9289: while (my ($key,$value) = each(%Values)) {
9290: $ValuesHash{$id.'.'.$key} = $value;
9291: }
9292: #
9293: &Apache::lonnet::appenv(\%ValuesHash);
9294: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
9295: }
9296:
9297: ############################################################
9298: ############################################################
9299:
9300: =pod
9301:
9302: =back
9303:
9304: =head1 Statistics helper routines?
9305:
9306: Bad place for them but what the hell.
9307:
9308: =over 4
9309:
9310: =item * &chartlink()
9311:
9312: Returns a link to the chart for a specific student.
9313:
9314: Inputs:
9315:
9316: =over 4
9317:
9318: =item $linktext: The text of the link
9319:
9320: =item $sname: The students username
9321:
9322: =item $sdomain: The students domain
9323:
9324: =back
9325:
9326: =back
9327:
9328: =cut
9329:
9330: ############################################################
9331: ############################################################
9332: sub chartlink {
9333: my ($linktext, $sname, $sdomain) = @_;
9334: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
9335: '&SelectedStudent='.&escape($sname.':'.$sdomain).
9336: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
9337: '">'.$linktext.'</a>';
9338: }
9339:
9340: #######################################################
9341: #######################################################
9342:
9343: =pod
9344:
9345: =head1 Course Environment Routines
9346:
9347: =over 4
9348:
9349: =item * &restore_course_settings()
9350:
9351: =item * &store_course_settings()
9352:
9353: Restores/Store indicated form parameters from the course environment.
9354: Will not overwrite existing values of the form parameters.
9355:
9356: Inputs:
9357: a scalar describing the data (e.g. 'chart', 'problem_analysis')
9358:
9359: a hash ref describing the data to be stored. For example:
9360:
9361: %Save_Parameters = ('Status' => 'scalar',
9362: 'chartoutputmode' => 'scalar',
9363: 'chartoutputdata' => 'scalar',
9364: 'Section' => 'array',
9365: 'Group' => 'array',
9366: 'StudentData' => 'array',
9367: 'Maps' => 'array');
9368:
9369: Returns: both routines return nothing
9370:
9371: =back
9372:
9373: =cut
9374:
9375: #######################################################
9376: #######################################################
9377: sub store_course_settings {
9378: return &store_settings($env{'request.course.id'},@_);
9379: }
9380:
9381: sub store_settings {
9382: # save to the environment
9383: # appenv the same items, just to be safe
9384: my $udom = $env{'user.domain'};
9385: my $uname = $env{'user.name'};
9386: my ($context,$prefix,$Settings) = @_;
9387: my %SaveHash;
9388: my %AppHash;
9389: while (my ($setting,$type) = each(%$Settings)) {
9390: my $basename = join('.','internal',$context,$prefix,$setting);
9391: my $envname = 'environment.'.$basename;
9392: if (exists($env{'form.'.$setting})) {
9393: # Save this value away
9394: if ($type eq 'scalar' &&
9395: (! exists($env{$envname}) ||
9396: $env{$envname} ne $env{'form.'.$setting})) {
9397: $SaveHash{$basename} = $env{'form.'.$setting};
9398: $AppHash{$envname} = $env{'form.'.$setting};
9399: } elsif ($type eq 'array') {
9400: my $stored_form;
9401: if (ref($env{'form.'.$setting})) {
9402: $stored_form = join(',',
9403: map {
9404: &escape($_);
9405: } sort(@{$env{'form.'.$setting}}));
9406: } else {
9407: $stored_form =
9408: &escape($env{'form.'.$setting});
9409: }
9410: # Determine if the array contents are the same.
9411: if ($stored_form ne $env{$envname}) {
9412: $SaveHash{$basename} = $stored_form;
9413: $AppHash{$envname} = $stored_form;
9414: }
9415: }
9416: }
9417: }
9418: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
9419: $udom,$uname);
9420: if ($put_result !~ /^(ok|delayed)/) {
9421: &Apache::lonnet::logthis('unable to save form parameters, '.
9422: 'got error:'.$put_result);
9423: }
9424: # Make sure these settings stick around in this session, too
9425: &Apache::lonnet::appenv(\%AppHash);
9426: return;
9427: }
9428:
9429: sub restore_course_settings {
9430: return &restore_settings($env{'request.course.id'},@_);
9431: }
9432:
9433: sub restore_settings {
9434: my ($context,$prefix,$Settings) = @_;
9435: while (my ($setting,$type) = each(%$Settings)) {
9436: next if (exists($env{'form.'.$setting}));
9437: my $envname = 'environment.internal.'.$context.'.'.$prefix.
9438: '.'.$setting;
9439: if (exists($env{$envname})) {
9440: if ($type eq 'scalar') {
9441: $env{'form.'.$setting} = $env{$envname};
9442: } elsif ($type eq 'array') {
9443: $env{'form.'.$setting} = [
9444: map {
9445: &unescape($_);
9446: } split(',',$env{$envname})
9447: ];
9448: }
9449: }
9450: }
9451: }
9452:
9453: #######################################################
9454: #######################################################
9455:
9456: =pod
9457:
9458: =head1 Domain E-mail Routines
9459:
9460: =over 4
9461:
9462: =item * &build_recipient_list()
9463:
9464: Build recipient lists for five types of e-mail:
9465: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
9466: (d) Help requests, (e) Course requests needing approval, generated by
9467: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
9468: loncoursequeueadmin.pm respectively.
9469:
9470: Inputs:
9471: defmail (scalar - email address of default recipient),
9472: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
9473: defdom (domain for which to retrieve configuration settings),
9474: origmail (scalar - email address of recipient from loncapa.conf,
9475: i.e., predates configuration by DC via domainprefs.pm
9476:
9477: Returns: comma separated list of addresses to which to send e-mail.
9478:
9479: =back
9480:
9481: =cut
9482:
9483: ############################################################
9484: ############################################################
9485: sub build_recipient_list {
9486: my ($defmail,$mailing,$defdom,$origmail) = @_;
9487: my @recipients;
9488: my $otheremails;
9489: my %domconfig =
9490: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
9491: if (ref($domconfig{'contacts'}) eq 'HASH') {
9492: if (exists($domconfig{'contacts'}{$mailing})) {
9493: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
9494: my @contacts = ('adminemail','supportemail');
9495: foreach my $item (@contacts) {
9496: if ($domconfig{'contacts'}{$mailing}{$item}) {
9497: my $addr = $domconfig{'contacts'}{$item};
9498: if (!grep(/^\Q$addr\E$/,@recipients)) {
9499: push(@recipients,$addr);
9500: }
9501: }
9502: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
9503: }
9504: }
9505: } elsif ($origmail ne '') {
9506: push(@recipients,$origmail);
9507: }
9508: } elsif ($origmail ne '') {
9509: push(@recipients,$origmail);
9510: }
9511: if (defined($defmail)) {
9512: if ($defmail ne '') {
9513: push(@recipients,$defmail);
9514: }
9515: }
9516: if ($otheremails) {
9517: my @others;
9518: if ($otheremails =~ /,/) {
9519: @others = split(/,/,$otheremails);
9520: } else {
9521: push(@others,$otheremails);
9522: }
9523: foreach my $addr (@others) {
9524: if (!grep(/^\Q$addr\E$/,@recipients)) {
9525: push(@recipients,$addr);
9526: }
9527: }
9528: }
9529: my $recipientlist = join(',',@recipients);
9530: return $recipientlist;
9531: }
9532:
9533: ############################################################
9534: ############################################################
9535:
9536: =pod
9537:
9538: =head1 Course Catalog Routines
9539:
9540: =over 4
9541:
9542: =item * &gather_categories()
9543:
9544: Converts category definitions - keys of categories hash stored in
9545: coursecategories in configuration.db on the primary library server in a
9546: domain - to an array. Also generates javascript and idx hash used to
9547: generate Domain Coordinator interface for editing Course Categories.
9548:
9549: Inputs:
9550:
9551: categories (reference to hash of category definitions).
9552:
9553: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9554: categories and subcategories).
9555:
9556: idx (reference to hash of counters used in Domain Coordinator interface for
9557: editing Course Categories).
9558:
9559: jsarray (reference to array of categories used to create Javascript arrays for
9560: Domain Coordinator interface for editing Course Categories).
9561:
9562: Returns: nothing
9563:
9564: Side effects: populates cats, idx and jsarray.
9565:
9566: =cut
9567:
9568: sub gather_categories {
9569: my ($categories,$cats,$idx,$jsarray) = @_;
9570: my %counters;
9571: my $num = 0;
9572: foreach my $item (keys(%{$categories})) {
9573: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9574: if ($container eq '' && $depth == 0) {
9575: $cats->[$depth][$categories->{$item}] = $cat;
9576: } else {
9577: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9578: }
9579: my ($escitem,$tail) = split(/:/,$item,2);
9580: if ($counters{$tail} eq '') {
9581: $counters{$tail} = $num;
9582: $num ++;
9583: }
9584: if (ref($idx) eq 'HASH') {
9585: $idx->{$item} = $counters{$tail};
9586: }
9587: if (ref($jsarray) eq 'ARRAY') {
9588: push(@{$jsarray->[$counters{$tail}]},$item);
9589: }
9590: }
9591: return;
9592: }
9593:
9594: =pod
9595:
9596: =item * &extract_categories()
9597:
9598: Used to generate breadcrumb trails for course categories.
9599:
9600: Inputs:
9601:
9602: categories (reference to hash of category definitions).
9603:
9604: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9605: categories and subcategories).
9606:
9607: trails (reference to array of breacrumb trails for each category).
9608:
9609: allitems (reference to hash - key is category key
9610: (format: escaped(name):escaped(parent category):depth in hierarchy).
9611:
9612: idx (reference to hash of counters used in Domain Coordinator interface for
9613: editing Course Categories).
9614:
9615: jsarray (reference to array of categories used to create Javascript arrays for
9616: Domain Coordinator interface for editing Course Categories).
9617:
9618: subcats (reference to hash of arrays containing all subcategories within each
9619: category, -recursive)
9620:
9621: Returns: nothing
9622:
9623: Side effects: populates trails and allitems hash references.
9624:
9625: =cut
9626:
9627: sub extract_categories {
9628: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
9629: if (ref($categories) eq 'HASH') {
9630: &gather_categories($categories,$cats,$idx,$jsarray);
9631: if (ref($cats->[0]) eq 'ARRAY') {
9632: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9633: my $name = $cats->[0][$i];
9634: my $item = &escape($name).'::0';
9635: my $trailstr;
9636: if ($name eq 'instcode') {
9637: $trailstr = &mt('Official courses (with institutional codes)');
9638: } elsif ($name eq 'communities') {
9639: $trailstr = &mt('Communities');
9640: } else {
9641: $trailstr = $name;
9642: }
9643: if ($allitems->{$item} eq '') {
9644: push(@{$trails},$trailstr);
9645: $allitems->{$item} = scalar(@{$trails})-1;
9646: }
9647: my @parents = ($name);
9648: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9649: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9650: my $category = $cats->[1]{$name}[$j];
9651: if (ref($subcats) eq 'HASH') {
9652: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9653: }
9654: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9655: }
9656: } else {
9657: if (ref($subcats) eq 'HASH') {
9658: $subcats->{$item} = [];
9659: }
9660: }
9661: }
9662: }
9663: }
9664: return;
9665: }
9666:
9667: =pod
9668:
9669: =item *&recurse_categories()
9670:
9671: Recursively used to generate breadcrumb trails for course categories.
9672:
9673: Inputs:
9674:
9675: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9676: categories and subcategories).
9677:
9678: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
9679:
9680: category (current course category, for which breadcrumb trail is being generated).
9681:
9682: trails (reference to array of breadcrumb trails for each category).
9683:
9684: allitems (reference to hash - key is category key
9685: (format: escaped(name):escaped(parent category):depth in hierarchy).
9686:
9687: parents (array containing containers directories for current category,
9688: back to top level).
9689:
9690: Returns: nothing
9691:
9692: Side effects: populates trails and allitems hash references
9693:
9694: =cut
9695:
9696: sub recurse_categories {
9697: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
9698: my $shallower = $depth - 1;
9699: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9700: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9701: my $name = $cats->[$depth]{$category}[$k];
9702: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9703: my $trailstr = join(' -> ',(@{$parents},$category));
9704: if ($allitems->{$item} eq '') {
9705: push(@{$trails},$trailstr);
9706: $allitems->{$item} = scalar(@{$trails})-1;
9707: }
9708: my $deeper = $depth+1;
9709: push(@{$parents},$category);
9710: if (ref($subcats) eq 'HASH') {
9711: my $subcat = &escape($name).':'.$category.':'.$depth;
9712: for (my $j=@{$parents}; $j>=0; $j--) {
9713: my $higher;
9714: if ($j > 0) {
9715: $higher = &escape($parents->[$j]).':'.
9716: &escape($parents->[$j-1]).':'.$j;
9717: } else {
9718: $higher = &escape($parents->[$j]).'::'.$j;
9719: }
9720: push(@{$subcats->{$higher}},$subcat);
9721: }
9722: }
9723: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9724: $subcats);
9725: pop(@{$parents});
9726: }
9727: } else {
9728: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9729: my $trailstr = join(' -> ',(@{$parents},$category));
9730: if ($allitems->{$item} eq '') {
9731: push(@{$trails},$trailstr);
9732: $allitems->{$item} = scalar(@{$trails})-1;
9733: }
9734: }
9735: return;
9736: }
9737:
9738: =pod
9739:
9740: =item *&assign_categories_table()
9741:
9742: Create a datatable for display of hierarchical categories in a domain,
9743: with checkboxes to allow a course to be categorized.
9744:
9745: Inputs:
9746:
9747: cathash - reference to hash of categories defined for the domain (from
9748: configuration.db)
9749:
9750: currcat - scalar with an & separated list of categories assigned to a course.
9751:
9752: type - scalar contains course type (Course or Community).
9753:
9754: Returns: $output (markup to be displayed)
9755:
9756: =cut
9757:
9758: sub assign_categories_table {
9759: my ($cathash,$currcat,$type) = @_;
9760: my $output;
9761: if (ref($cathash) eq 'HASH') {
9762: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9763: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9764: $maxdepth = scalar(@cats);
9765: if (@cats > 0) {
9766: my $itemcount = 0;
9767: if (ref($cats[0]) eq 'ARRAY') {
9768: my @currcategories;
9769: if ($currcat ne '') {
9770: @currcategories = split('&',$currcat);
9771: }
9772: my $table;
9773: for (my $i=0; $i<@{$cats[0]}; $i++) {
9774: my $parent = $cats[0][$i];
9775: next if ($parent eq 'instcode');
9776: if ($type eq 'Community') {
9777: next unless ($parent eq 'communities');
9778: } else {
9779: next if ($parent eq 'communities');
9780: }
9781: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9782: my $item = &escape($parent).'::0';
9783: my $checked = '';
9784: if (@currcategories > 0) {
9785: if (grep(/^\Q$item\E$/,@currcategories)) {
9786: $checked = ' checked="checked"';
9787: }
9788: }
9789: my $parent_title = $parent;
9790: if ($parent eq 'communities') {
9791: $parent_title = &mt('Communities');
9792: }
9793: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9794: '<input type="checkbox" name="usecategory" value="'.
9795: $item.'"'.$checked.' />'.$parent_title.'</span>'.
9796: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
9797: my $depth = 1;
9798: push(@path,$parent);
9799: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9800: pop(@path);
9801: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9802: $itemcount ++;
9803: }
9804: if ($itemcount) {
9805: $output = &Apache::loncommon::start_data_table().
9806: $table.
9807: &Apache::loncommon::end_data_table();
9808: }
9809: }
9810: }
9811: }
9812: return $output;
9813: }
9814:
9815: =pod
9816:
9817: =item *&assign_category_rows()
9818:
9819: Create a datatable row for display of nested categories in a domain,
9820: with checkboxes to allow a course to be categorized,called recursively.
9821:
9822: Inputs:
9823:
9824: itemcount - track row number for alternating colors
9825:
9826: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9827: categories and subcategories.
9828:
9829: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9830:
9831: parent - parent of current category item
9832:
9833: path - Array containing all categories back up through the hierarchy from the
9834: current category to the top level.
9835:
9836: currcategories - reference to array of current categories assigned to the course
9837:
9838: Returns: $output (markup to be displayed).
9839:
9840: =cut
9841:
9842: sub assign_category_rows {
9843: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9844: my ($text,$name,$item,$chgstr);
9845: if (ref($cats) eq 'ARRAY') {
9846: my $maxdepth = scalar(@{$cats});
9847: if (ref($cats->[$depth]) eq 'HASH') {
9848: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9849: my $numchildren = @{$cats->[$depth]{$parent}};
9850: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9851: $text .= '<td><table class="LC_datatable">';
9852: for (my $j=0; $j<$numchildren; $j++) {
9853: $name = $cats->[$depth]{$parent}[$j];
9854: $item = &escape($name).':'.&escape($parent).':'.$depth;
9855: my $deeper = $depth+1;
9856: my $checked = '';
9857: if (ref($currcategories) eq 'ARRAY') {
9858: if (@{$currcategories} > 0) {
9859: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9860: $checked = ' checked="checked"';
9861: }
9862: }
9863: }
9864: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9865: '<input type="checkbox" name="usecategory" value="'.
9866: $item.'"'.$checked.' />'.$name.'</label></span>'.
9867: '<input type="hidden" name="catname" value="'.$name.'" />'.
9868: '</td><td>';
9869: if (ref($path) eq 'ARRAY') {
9870: push(@{$path},$name);
9871: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9872: pop(@{$path});
9873: }
9874: $text .= '</td></tr>';
9875: }
9876: $text .= '</table></td>';
9877: }
9878: }
9879: }
9880: return $text;
9881: }
9882:
9883: ############################################################
9884: ############################################################
9885:
9886:
9887: sub commit_customrole {
9888: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
9889: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
9890: ($start?', '.&mt('starting').' '.localtime($start):'').
9891: ($end?', ending '.localtime($end):'').': <b>'.
9892: &Apache::lonnet::assigncustomrole(
9893: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
9894: '</b><br />';
9895: return $output;
9896: }
9897:
9898: sub commit_standardrole {
9899: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9900: my ($output,$logmsg,$linefeed);
9901: if ($context eq 'auto') {
9902: $linefeed = "\n";
9903: } else {
9904: $linefeed = "<br />\n";
9905: }
9906: if ($three eq 'st') {
9907: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9908: $one,$two,$sec,$context);
9909: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
9910: ($result eq 'unknown_course') || ($result eq 'refused')) {
9911: $output = $logmsg.' '.&mt('Error: ').$result."\n";
9912: } else {
9913: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
9914: ($start?', '.&mt('starting').' '.localtime($start):'').
9915: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9916: if ($context eq 'auto') {
9917: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9918: } else {
9919: $output .= '<b>'.$result.'</b>'.$linefeed.
9920: &mt('Add to classlist').': <b>ok</b>';
9921: }
9922: $output .= $linefeed;
9923: }
9924: } else {
9925: $output = &mt('Assigning').' '.$three.' in '.$url.
9926: ($start?', '.&mt('starting').' '.localtime($start):'').
9927: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9928: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
9929: if ($context eq 'auto') {
9930: $output .= $result.$linefeed;
9931: } else {
9932: $output .= '<b>'.$result.'</b>'.$linefeed;
9933: }
9934: }
9935: return $output;
9936: }
9937:
9938: sub commit_studentrole {
9939: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9940: my ($result,$linefeed,$oldsecurl,$newsecurl);
9941: if ($context eq 'auto') {
9942: $linefeed = "\n";
9943: } else {
9944: $linefeed = '<br />'."\n";
9945: }
9946: if (defined($one) && defined($two)) {
9947: my $cid=$one.'_'.$two;
9948: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9949: my $secchange = 0;
9950: my $expire_role_result;
9951: my $modify_section_result;
9952: if ($oldsec ne '-1') {
9953: if ($oldsec ne $sec) {
9954: $secchange = 1;
9955: my $now = time;
9956: my $uurl='/'.$cid;
9957: $uurl=~s/\_/\//g;
9958: if ($oldsec) {
9959: $uurl.='/'.$oldsec;
9960: }
9961: $oldsecurl = $uurl;
9962: $expire_role_result =
9963: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
9964: if ($env{'request.course.sec'} ne '') {
9965: if ($expire_role_result eq 'refused') {
9966: my @roles = ('st');
9967: my @statuses = ('previous');
9968: my @roledoms = ($one);
9969: my $withsec = 1;
9970: my %roleshash =
9971: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9972: \@statuses,\@roles,\@roledoms,$withsec);
9973: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9974: my ($oldstart,$oldend) =
9975: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9976: if ($oldend > 0 && $oldend <= $now) {
9977: $expire_role_result = 'ok';
9978: }
9979: }
9980: }
9981: }
9982: $result = $expire_role_result;
9983: }
9984: }
9985: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
9986: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
9987: if ($modify_section_result =~ /^ok/) {
9988: if ($secchange == 1) {
9989: if ($sec eq '') {
9990: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9991: } else {
9992: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9993: }
9994: } elsif ($oldsec eq '-1') {
9995: if ($sec eq '') {
9996: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9997: } else {
9998: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9999: }
10000: } else {
10001: if ($sec eq '') {
10002: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
10003: } else {
10004: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
10005: }
10006: }
10007: } else {
10008: if ($secchange) {
10009: $$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;
10010: } else {
10011: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
10012: }
10013: }
10014: $result = $modify_section_result;
10015: } elsif ($secchange == 1) {
10016: if ($oldsec eq '') {
10017: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
10018: } else {
10019: $$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;
10020: }
10021: if ($expire_role_result eq 'refused') {
10022: my $newsecurl = '/'.$cid;
10023: $newsecurl =~ s/\_/\//g;
10024: if ($sec ne '') {
10025: $newsecurl.='/'.$sec;
10026: }
10027: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
10028: if ($sec eq '') {
10029: $$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;
10030: } else {
10031: $$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;
10032: }
10033: }
10034: }
10035: }
10036: } else {
10037: $$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;
10038: $result = "error: incomplete course id\n";
10039: }
10040: return $result;
10041: }
10042:
10043: ############################################################
10044: ############################################################
10045:
10046: sub check_clone {
10047: my ($args,$linefeed) = @_;
10048: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
10049: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
10050: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
10051: my $clonemsg;
10052: my $can_clone = 0;
10053: my $lctype = lc($args->{'type'});
10054: if ($lctype ne 'community') {
10055: $lctype = 'course';
10056: }
10057: if ($clonehome eq 'no_host') {
10058: if ($args->{'type'} eq 'Community') {
10059: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
10060: } else {
10061: $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'});
10062: }
10063: } else {
10064: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
10065: if ($args->{'type'} eq 'Community') {
10066: if ($clonedesc{'type'} ne 'Community') {
10067: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
10068: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10069: }
10070: }
10071: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
10072: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
10073: $can_clone = 1;
10074: } else {
10075: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
10076: $args->{'clonedomain'},$args->{'clonecourse'});
10077: my @cloners = split(/,/,$clonehash{'cloners'});
10078: if (grep(/^\*$/,@cloners)) {
10079: $can_clone = 1;
10080: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
10081: $can_clone = 1;
10082: } else {
10083: my $ccrole = 'cc';
10084: if ($args->{'type'} eq 'Community') {
10085: $ccrole = 'co';
10086: }
10087: my %roleshash =
10088: &Apache::lonnet::get_my_roles($args->{'ccuname'},
10089: $args->{'ccdomain'},
10090: 'userroles',['active'],[$ccrole],
10091: [$args->{'clonedomain'}]);
10092: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
10093: $can_clone = 1;
10094: } else {
10095: if ($args->{'type'} eq 'Community') {
10096: $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
10097: } else {
10098: $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'});
10099: }
10100: }
10101: }
10102: }
10103: }
10104: return ($can_clone, $clonemsg, $cloneid, $clonehome);
10105: }
10106:
10107: sub construct_course {
10108: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
10109: my $outcome;
10110: my $linefeed = '<br />'."\n";
10111: if ($context eq 'auto') {
10112: $linefeed = "\n";
10113: }
10114:
10115: #
10116: # Are we cloning?
10117: #
10118: my ($can_clone, $clonemsg, $cloneid, $clonehome);
10119: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
10120: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
10121: if ($context ne 'auto') {
10122: if ($clonemsg ne '') {
10123: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
10124: }
10125: }
10126: $outcome .= $clonemsg.$linefeed;
10127:
10128: if (!$can_clone) {
10129: return (0,$outcome);
10130: }
10131: }
10132:
10133: #
10134: # Open course
10135: #
10136: my $crstype = lc($args->{'crstype'});
10137: my %cenv=();
10138: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
10139: $args->{'cdescr'},
10140: $args->{'curl'},
10141: $args->{'course_home'},
10142: $args->{'nonstandard'},
10143: $args->{'crscode'},
10144: $args->{'ccuname'}.':'.
10145: $args->{'ccdomain'},
10146: $args->{'crstype'},
10147: $cnum,$context,$category);
10148:
10149: # Note: The testing routines depend on this being output; see
10150: # Utils::Course. This needs to at least be output as a comment
10151: # if anyone ever decides to not show this, and Utils::Course::new
10152: # will need to be suitably modified.
10153: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
10154: #
10155: # Check if created correctly
10156: #
10157: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
10158: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
10159: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
10160:
10161: #
10162: # Do the cloning
10163: #
10164: if ($can_clone && $cloneid) {
10165: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
10166: if ($context ne 'auto') {
10167: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
10168: }
10169: $outcome .= $clonemsg.$linefeed;
10170: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
10171: # Copy all files
10172: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
10173: # Restore URL
10174: $cenv{'url'}=$oldcenv{'url'};
10175: # Restore title
10176: $cenv{'description'}=$oldcenv{'description'};
10177: # Mark as cloned
10178: $cenv{'clonedfrom'}=$cloneid;
10179: # Need to clone grading mode
10180: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
10181: $cenv{'grading'}=$newenv{'grading'};
10182: # Do not clone these environment entries
10183: &Apache::lonnet::del('environment',
10184: ['default_enrollment_start_date',
10185: 'default_enrollment_end_date',
10186: 'question.email',
10187: 'policy.email',
10188: 'comment.email',
10189: 'pch.users.denied',
10190: 'plc.users.denied',
10191: 'hidefromcat',
10192: 'categories'],
10193: $$crsudom,$$crsunum);
10194: }
10195:
10196: #
10197: # Set environment (will override cloned, if existing)
10198: #
10199: my @sections = ();
10200: my @xlists = ();
10201: if ($args->{'crstype'}) {
10202: $cenv{'type'}=$args->{'crstype'};
10203: }
10204: if ($args->{'crsid'}) {
10205: $cenv{'courseid'}=$args->{'crsid'};
10206: }
10207: if ($args->{'crscode'}) {
10208: $cenv{'internal.coursecode'}=$args->{'crscode'};
10209: }
10210: if ($args->{'crsquota'} ne '') {
10211: $cenv{'internal.coursequota'}=$args->{'crsquota'};
10212: } else {
10213: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10214: }
10215: if ($args->{'ccuname'}) {
10216: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10217: ':'.$args->{'ccdomain'};
10218: } else {
10219: $cenv{'internal.courseowner'} = $args->{'curruser'};
10220: }
10221: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10222: if ($args->{'crssections'}) {
10223: $cenv{'internal.sectionnums'} = '';
10224: if ($args->{'crssections'} =~ m/,/) {
10225: @sections = split/,/,$args->{'crssections'};
10226: } else {
10227: $sections[0] = $args->{'crssections'};
10228: }
10229: if (@sections > 0) {
10230: foreach my $item (@sections) {
10231: my ($sec,$gp) = split/:/,$item;
10232: my $class = $args->{'crscode'}.$sec;
10233: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10234: $cenv{'internal.sectionnums'} .= $item.',';
10235: unless ($addcheck eq 'ok') {
10236: push @badclasses, $class;
10237: }
10238: }
10239: $cenv{'internal.sectionnums'} =~ s/,$//;
10240: }
10241: }
10242: # do not hide course coordinator from staff listing,
10243: # even if privileged
10244: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10245: # add crosslistings
10246: if ($args->{'crsxlist'}) {
10247: $cenv{'internal.crosslistings'}='';
10248: if ($args->{'crsxlist'} =~ m/,/) {
10249: @xlists = split/,/,$args->{'crsxlist'};
10250: } else {
10251: $xlists[0] = $args->{'crsxlist'};
10252: }
10253: if (@xlists > 0) {
10254: foreach my $item (@xlists) {
10255: my ($xl,$gp) = split/:/,$item;
10256: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10257: $cenv{'internal.crosslistings'} .= $item.',';
10258: unless ($addcheck eq 'ok') {
10259: push @badclasses, $xl;
10260: }
10261: }
10262: $cenv{'internal.crosslistings'} =~ s/,$//;
10263: }
10264: }
10265: if ($args->{'autoadds'}) {
10266: $cenv{'internal.autoadds'}=$args->{'autoadds'};
10267: }
10268: if ($args->{'autodrops'}) {
10269: $cenv{'internal.autodrops'}=$args->{'autodrops'};
10270: }
10271: # check for notification of enrollment changes
10272: my @notified = ();
10273: if ($args->{'notify_owner'}) {
10274: if ($args->{'ccuname'} ne '') {
10275: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10276: }
10277: }
10278: if ($args->{'notify_dc'}) {
10279: if ($uname ne '') {
10280: push(@notified,$uname.':'.$udom);
10281: }
10282: }
10283: if (@notified > 0) {
10284: my $notifylist;
10285: if (@notified > 1) {
10286: $notifylist = join(',',@notified);
10287: } else {
10288: $notifylist = $notified[0];
10289: }
10290: $cenv{'internal.notifylist'} = $notifylist;
10291: }
10292: if (@badclasses > 0) {
10293: my %lt=&Apache::lonlocal::texthash(
10294: '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',
10295: 'dnhr' => 'does not have rights to access enrollment in these classes',
10296: 'adby' => 'as determined by the policies of your institution on access to official classlists'
10297: );
10298: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10299: ' ('.$lt{'adby'}.')';
10300: if ($context eq 'auto') {
10301: $outcome .= $badclass_msg.$linefeed;
10302: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
10303: foreach my $item (@badclasses) {
10304: if ($context eq 'auto') {
10305: $outcome .= " - $item\n";
10306: } else {
10307: $outcome .= "<li>$item</li>\n";
10308: }
10309: }
10310: if ($context eq 'auto') {
10311: $outcome .= $linefeed;
10312: } else {
10313: $outcome .= "</ul><br /><br /></div>\n";
10314: }
10315: }
10316: }
10317: if ($args->{'no_end_date'}) {
10318: $args->{'endaccess'} = 0;
10319: }
10320: $cenv{'internal.autostart'}=$args->{'enrollstart'};
10321: $cenv{'internal.autoend'}=$args->{'enrollend'};
10322: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10323: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10324: if ($args->{'showphotos'}) {
10325: $cenv{'internal.showphotos'}=$args->{'showphotos'};
10326: }
10327: $cenv{'internal.authtype'} = $args->{'authtype'};
10328: $cenv{'internal.autharg'} = $args->{'autharg'};
10329: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10330: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
10331: 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');
10332: if ($context eq 'auto') {
10333: $outcome .= $krb_msg;
10334: } else {
10335: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
10336: }
10337: $outcome .= $linefeed;
10338: }
10339: }
10340: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10341: if ($args->{'setpolicy'}) {
10342: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10343: }
10344: if ($args->{'setcontent'}) {
10345: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10346: }
10347: }
10348: if ($args->{'reshome'}) {
10349: $cenv{'reshome'}=$args->{'reshome'}.'/';
10350: $cenv{'reshome'}=~s/\/+$/\//;
10351: }
10352: #
10353: # course has keyed access
10354: #
10355: if ($args->{'setkeys'}) {
10356: $cenv{'keyaccess'}='yes';
10357: }
10358: # if specified, key authority is not course, but user
10359: # only active if keyaccess is yes
10360: if ($args->{'keyauth'}) {
10361: my ($user,$domain) = split(':',$args->{'keyauth'});
10362: $user = &LONCAPA::clean_username($user);
10363: $domain = &LONCAPA::clean_username($domain);
10364: if ($user ne '' && $domain ne '') {
10365: $cenv{'keyauth'}=$user.':'.$domain;
10366: }
10367: }
10368:
10369: if ($args->{'disresdis'}) {
10370: $cenv{'pch.roles.denied'}='st';
10371: }
10372: if ($args->{'disablechat'}) {
10373: $cenv{'plc.roles.denied'}='st';
10374: }
10375:
10376: # Record we've not yet viewed the Course Initialization Helper for this
10377: # course
10378: $cenv{'course.helper.not.run'} = 1;
10379: #
10380: # Use new Randomseed
10381: #
10382: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10383: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10384: #
10385: # The encryption code and receipt prefix for this course
10386: #
10387: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10388: $cenv{'internal.encpref'}=100+int(9*rand(99));
10389: #
10390: # By default, use standard grading
10391: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10392:
10393: $outcome .= $linefeed.&mt('Setting environment').': '.
10394: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
10395: #
10396: # Open all assignments
10397: #
10398: if ($args->{'openall'}) {
10399: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10400: my %storecontent = ($storeunder => time,
10401: $storeunder.'.type' => 'date_start');
10402:
10403: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
10404: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
10405: }
10406: #
10407: # Set first page
10408: #
10409: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10410: || ($cloneid)) {
10411: use LONCAPA::map;
10412: $outcome .= &mt('Setting first resource').': ';
10413:
10414: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10415: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10416:
10417: $outcome .= ($fatal?$errtext:'read ok').' - ';
10418: my $title; my $url;
10419: if ($args->{'firstres'} eq 'syl') {
10420: $title=&mt('Syllabus');
10421: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10422: } else {
10423: $title=&mt('Navigate Contents');
10424: $url='/adm/navmaps';
10425: }
10426:
10427: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10428: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10429:
10430: if ($errtext) { $fatal=2; }
10431: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
10432: }
10433:
10434: return (1,$outcome);
10435: }
10436:
10437: ############################################################
10438: ############################################################
10439:
10440: sub course_type {
10441: my ($cid) = @_;
10442: if (!defined($cid)) {
10443: $cid = $env{'request.course.id'};
10444: }
10445: if (defined($env{'course.'.$cid.'.type'})) {
10446: return $env{'course.'.$cid.'.type'};
10447: } else {
10448: return 'Course';
10449: }
10450: }
10451:
10452: sub group_term {
10453: my $crstype = &course_type();
10454: my %names = (
10455: 'Course' => 'group',
10456: 'Community' => 'group',
10457: );
10458: return $names{$crstype};
10459: }
10460:
10461: sub course_types {
10462: my @types = ('official','unofficial','community');
10463: my %typename = (
10464: official => 'Official course',
10465: unofficial => 'Unofficial course',
10466: community => 'Community',
10467: );
10468: return (\@types,\%typename);
10469: }
10470:
10471: sub icon {
10472: my ($file)=@_;
10473: my $curfext = lc((split(/\./,$file))[-1]);
10474: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
10475: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
10476: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10477: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10478: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10479: $curfext.".gif") {
10480: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10481: $curfext.".gif";
10482: }
10483: }
10484: return &lonhttpdurl($iconname);
10485: }
10486:
10487: sub lonhttpdurl {
10488: #
10489: # Had been used for "small fry" static images on separate port 8080.
10490: # Modify here if lightweight http functionality desired again.
10491: # Currently eliminated due to increasing firewall issues.
10492: #
10493: my ($url)=@_;
10494: return $url;
10495: }
10496:
10497: sub connection_aborted {
10498: my ($r)=@_;
10499: $r->print(" ");$r->rflush();
10500: my $c = $r->connection;
10501: return $c->aborted();
10502: }
10503:
10504: # Escapes strings that may have embedded 's that will be put into
10505: # strings as 'strings'.
10506: sub escape_single {
10507: my ($input) = @_;
10508: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
10509: $input =~ s/\'/\\\'/g; # Esacpe the 's....
10510: return $input;
10511: }
10512:
10513: # Same as escape_single, but escape's "'s This
10514: # can be used for "strings"
10515: sub escape_double {
10516: my ($input) = @_;
10517: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
10518: $input =~ s/\"/\\\"/g; # Esacpe the "s....
10519: return $input;
10520: }
10521:
10522: # Escapes the last element of a full URL.
10523: sub escape_url {
10524: my ($url) = @_;
10525: my @urlslices = split(/\//, $url,-1);
10526: my $lastitem = &escape(pop(@urlslices));
10527: return join('/',@urlslices).'/'.$lastitem;
10528: }
10529:
10530: sub compare_arrays {
10531: my ($arrayref1,$arrayref2) = @_;
10532: my (@difference,%count);
10533: @difference = ();
10534: %count = ();
10535: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10536: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10537: foreach my $element (keys(%count)) {
10538: if ($count{$element} == 1) {
10539: push(@difference,$element);
10540: }
10541: }
10542: }
10543: return @difference;
10544: }
10545:
10546: # -------------------------------------------------------- Initialize user login
10547: sub init_user_environment {
10548: my ($r, $username, $domain, $authhost, $form, $args) = @_;
10549: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10550:
10551: my $public=($username eq 'public' && $domain eq 'public');
10552:
10553: # See if old ID present, if so, remove
10554:
10555: my ($filename,$cookie,$userroles);
10556: my $now=time;
10557:
10558: if ($public) {
10559: my $max_public=100;
10560: my $oldest;
10561: my $oldest_time=0;
10562: for(my $next=1;$next<=$max_public;$next++) {
10563: if (-e $lonids."/publicuser_$next.id") {
10564: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10565: if ($mtime<$oldest_time || !$oldest_time) {
10566: $oldest_time=$mtime;
10567: $oldest=$next;
10568: }
10569: } else {
10570: $cookie="publicuser_$next";
10571: last;
10572: }
10573: }
10574: if (!$cookie) { $cookie="publicuser_$oldest"; }
10575: } else {
10576: # if this isn't a robot, kill any existing non-robot sessions
10577: if (!$args->{'robot'}) {
10578: opendir(DIR,$lonids);
10579: while ($filename=readdir(DIR)) {
10580: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10581: unlink($lonids.'/'.$filename);
10582: }
10583: }
10584: closedir(DIR);
10585: }
10586: # Give them a new cookie
10587: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
10588: : $now.$$.int(rand(10000)));
10589: $cookie="$username\_$id\_$domain\_$authhost";
10590:
10591: # Initialize roles
10592:
10593: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10594: }
10595: # ------------------------------------ Check browser type and MathML capability
10596:
10597: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10598: $clientunicode,$clientos) = &decode_user_agent($r);
10599:
10600: # ------------------------------------------------------------- Get environment
10601:
10602: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10603: my ($tmp) = keys(%userenv);
10604: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10605: # default remote control to off
10606: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10607: } else {
10608: undef(%userenv);
10609: }
10610: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10611: $form->{'interface'}=$userenv{'interface'};
10612: }
10613: $env{'environment.remote'}=$userenv{'remote'};
10614: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10615:
10616: # --------------- Do not trust query string to be put directly into environment
10617: foreach my $option ('interface','localpath','localres') {
10618: $form->{$option}=~s/[\n\r\=]//gs;
10619: }
10620: # --------------------------------------------------------- Write first profile
10621:
10622: {
10623: my %initial_env =
10624: ("user.name" => $username,
10625: "user.domain" => $domain,
10626: "user.home" => $authhost,
10627: "browser.type" => $clientbrowser,
10628: "browser.version" => $clientversion,
10629: "browser.mathml" => $clientmathml,
10630: "browser.unicode" => $clientunicode,
10631: "browser.os" => $clientos,
10632: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10633: "request.course.fn" => '',
10634: "request.course.uri" => '',
10635: "request.course.sec" => '',
10636: "request.role" => 'cm',
10637: "request.role.adv" => $env{'user.adv'},
10638: "request.host" => $ENV{'REMOTE_ADDR'},);
10639:
10640: if ($form->{'localpath'}) {
10641: $initial_env{"browser.localpath"} = $form->{'localpath'};
10642: $initial_env{"browser.localres"} = $form->{'localres'};
10643: }
10644:
10645: if ($public) {
10646: $initial_env{"environment.remote"} = "off";
10647: }
10648: if ($form->{'interface'}) {
10649: $form->{'interface'}=~s/\W//gs;
10650: $initial_env{"browser.interface"} = $form->{'interface'};
10651: $env{'browser.interface'}=$form->{'interface'};
10652: }
10653:
10654: foreach my $tool ('aboutme','blog','portfolio') {
10655: $userenv{'availabletools.'.$tool} =
10656: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10657: }
10658:
10659: foreach my $crstype ('official','unofficial','community') {
10660: $userenv{'canrequest.'.$crstype} =
10661: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10662: 'reload','requestcourses');
10663: }
10664:
10665: $env{'user.environment'} = "$lonids/$cookie.id";
10666:
10667: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10668: &GDBM_WRCREAT(),0640)) {
10669: &_add_to_env(\%disk_env,\%initial_env);
10670: &_add_to_env(\%disk_env,\%userenv,'environment.');
10671: &_add_to_env(\%disk_env,$userroles);
10672: if (ref($args->{'extra_env'})) {
10673: &_add_to_env(\%disk_env,$args->{'extra_env'});
10674: }
10675: untie(%disk_env);
10676: } else {
10677: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10678: 'Could not create environment storage in lonauth: '.$!.'</span>');
10679: return 'error: '.$!;
10680: }
10681: }
10682: $env{'request.role'}='cm';
10683: $env{'request.role.adv'}=$env{'user.adv'};
10684: $env{'browser.type'}=$clientbrowser;
10685:
10686: return $cookie;
10687:
10688: }
10689:
10690: sub _add_to_env {
10691: my ($idf,$env_data,$prefix) = @_;
10692: if (ref($env_data) eq 'HASH') {
10693: while (my ($key,$value) = each(%$env_data)) {
10694: $idf->{$prefix.$key} = $value;
10695: $env{$prefix.$key} = $value;
10696: }
10697: }
10698: }
10699:
10700: sub new_roles_update {
10701: my $rolecount = 0;
10702: foreach my $envkey (keys(%env)) {
10703: next unless ($envkey =~ /^user\.role\./);
10704: $rolecount ++;
10705: }
10706: my $newrolecount = 0;
10707: if (!$rolecount) {
10708: my %userenv;
10709: foreach my $crstype ('official','unofficial','community') {
10710: $userenv{'canrequest.'.$crstype} =
10711: &Apache::lonnet::usertools_access($env{'user.name'},
10712: $env{'user.domain'},$crstype,'reload','requestcourses');
10713: }
10714: my $then=$env{'user.login.time'};
10715: my $refresh=time;
10716: my (%userroles,%allroles,%allgroups,@newroles);
10717: my %roleshash =
10718: &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active','future','previous'],undef,undef,1);
10719: foreach my $item (keys(%roleshash)) {
10720: my ($uname,$udom,$role,$section) = split(':',$item);
10721: my $where = '/'.$udom.'/'.$uname;
10722: my ($tstart,$tend) = split(':',$roleshash{$item});
10723: if ($section ne '') {
10724: $where .= '/'.$section;
10725: }
10726: my $spec = $role.'.'.$where;
10727: &Apache::lonnet::set_arearole($role,$where,$tstart,$tend,
10728: $env{'user.domain'},$env{'user.name'});
10729: $userroles{'user.role.'.$spec} = $tstart.'.'.$tend;
10730: $newrolecount ++;
10731: unless (grep(/^\Q$role\E$/,@newroles)) {
10732: push(@newroles,$role);
10733: }
10734: my $status =
10735: &Apache::lonnet::curr_role_status($tstart,$tend,$refresh,$then);
10736: if ($status eq 'active') {
10737: &Apache::lonnet::gather_roleprivs(\%allroles,\%allgroups,\%userroles,
10738: $where,$role,$tstart,$tend);
10739: }
10740: }
10741: if (@newroles) {
10742: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles,
10743: \%allgroups);
10744: &Apache::lonnet::appenv(\%userroles,[@newroles,'cm']);
10745: $userenv{'user.adv'} = $adv;
10746: $userenv{'user.author'} = $author;
10747: $userenv{'user.refresh.time'} = $refresh;
10748: }
10749: &Apache::lonnet::appenv(\%userenv);
10750: }
10751: return $newrolecount;
10752: }
10753:
10754: # --- Get the symbolic name of a problem and the url
10755: sub get_symb {
10756: my ($request,$silent) = @_;
10757: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
10758: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10759: if ($symb eq '') {
10760: if (!$silent) {
10761: $request->print("Unable to handle ambiguous references:$url:.");
10762: return ();
10763: }
10764: }
10765: &Apache::lonenc::check_decrypt(\$symb);
10766: return ($symb);
10767: }
10768:
10769: # --------------------------------------------------------------Get annotation
10770:
10771: sub get_annotation {
10772: my ($symb,$enc) = @_;
10773:
10774: my $key = $symb;
10775: if (!$enc) {
10776: $key =
10777: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10778: }
10779: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10780: return $annotation{$key};
10781: }
10782:
10783: sub clean_symb {
10784: my ($symb,$delete_enc) = @_;
10785:
10786: &Apache::lonenc::check_decrypt(\$symb);
10787: my $enc = $env{'request.enc'};
10788: if ($delete_enc) {
10789: delete($env{'request.enc'});
10790: }
10791:
10792: return ($symb,$enc);
10793: }
10794:
10795: sub needs_gci_custom {
10796: my $custommenu;
10797: my $numdc = &check_for_gci_dc();
10798: unless ($numdc) {
10799: my $then=$env{'user.login.time'};
10800: my $now = time;
10801: my %cnums = (
10802: review => '9615072b469884921gcil1',
10803: submit => '1H96711d710194bfegcil1',
10804: );
10805: if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
10806: my ($start,$end) =
10807: split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
10808: if (((!$start) || ($start && $start <= $now)) &&
10809: ((!$end) || ($end > $now))) {
10810: $custommenu = 1;
10811: if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
10812: my ($ccstart,$ccend) =
10813: split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
10814: if (((!$start) || ($start && $start <= $now)) &&
10815: ((!$end) || ($end > $now))) {
10816: $custommenu = '';
10817: }
10818: }
10819: }
10820: }
10821: }
10822: return $custommenu;
10823: }
10824:
10825: sub check_for_gci_dc {
10826: my $then=$env{'user.login.time'};
10827: my $numdc = 0;
10828: foreach my $dom ('gci','gcitest') {
10829: if ($env{'user.role.dc./'.$dom.'/'}) {
10830: my $livedc = 1;
10831: my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
10832: if ($tstart && $tstart>$then) { $livedc = 0; }
10833: if ($tend && $tend <$then) { $livedc = 0; }
10834: if ($livedc) {
10835: $numdc++;
10836: }
10837: }
10838: }
10839: return $numdc;
10840: }
10841:
10842: sub existing_gcitest_courses {
10843: my ($role) = @_;
10844: my %courses;
10845: my $cdom = 'gcitest';
10846: my $now = time;
10847: foreach my $envkey (keys(%env)) {
10848: my $cnum;
10849: if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
10850: $cnum = $1;
10851: } else {
10852: next;
10853: }
10854: my ($tstart,$tend) = split('.',$env{$envkey});
10855: if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
10856: my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
10857: if ($descr ne '') {
10858: $courses{$cdom.'_'.$cnum}{'description'} = $descr;
10859: }
10860: }
10861: }
10862: return %courses;
10863: }
10864:
10865: =pod
10866:
10867: =back
10868:
10869: =cut
10870:
10871: 1;
10872: __END__;
10873:
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