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