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