loncom/interface/loncommon.pm - view

File: [LON-CAPA] / loncom / interface / loncommon.pm
Revision 1.501: download - view: text, annotated - select for diffs
Mon Jan 15 20:48:34 2007 UTC (17 years, 4 months ago) by banghart
Branches: MAIN
CVS tags: HEAD

	Make multiple_select_form act like select_form, allowing order
	of select options to be defined by 'select_form_order' key
	contents.

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