loncom/interface/loncommon.pm - view

File: [LON-CAPA] / loncom / interface / loncommon.pm
Revision 1.541: download - view: text, annotated - select for diffs
Mon Jul 2 03:36:28 2007 UTC (16 years, 11 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- move clone authorization check from loncreatecourse.pm to loncommon.pm
- more information stored in autocreation log
- include context as argument in loncommon::commit_standardrole and commit_studentrole
  to set appropriate line feeds (with/without <br /> for web/auto context).
- more information displayed on screen after course creation from uploaded attributes file (XML)
- language handler for Autocreate.pl

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