loncom/interface/loncommon.pm - view

File: [LON-CAPA] / loncom / interface / loncommon.pm
Revision 1.80: download - view: text, annotated - select for diffs
Thu Feb 13 21:35:50 2003 UTC (21 years, 3 months ago) by albertel
Branches: MAIN
CVS tags: HEAD

- Mark Lucas' code to add a domain.tab file it controls
   - domain description,
   - default authentication type
   - default argument for that auth type

- I think this will break the install hopefully I'll get this jury rigged up to work today

1: # The LearningOnline Network with CAPA 2: # a pile of common routines 3: # 4: # $Id: loncommon.pm,v 1.80 2003/02/13 21:35:50 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: # YEAR=2001 29: # 2/13-12/7 Guy Albertelli 30: # 12/21 Gerd Kortemeyer 31: # 12/25,12/28 Gerd Kortemeyer 32: # YEAR=2002 33: # 1/4 Gerd Kortemeyer 34: # 6/24,7/2 H. K. Ng 35: 36: # Makes a table out of the previous attempts 37: # Inputs result_from_symbread, user, domain, course_id 38: # Reads in non-network-related .tab files 39: 40: # POD header: 41: 42: =pod 43: 44: =head1 NAME 45: 46: Apache::loncommon - pile of common routines 47: 48: =head1 SYNOPSIS 49: 50: Referenced by other mod_perl Apache modules. 51: 52: Invocation: 53: &Apache::loncommon::SUBROUTINENAME(ARGUMENTS); 54: 55: =head1 INTRODUCTION 56: 57: Common collection of used subroutines. This collection helps remove 58: redundancy from other modules and increase efficiency of memory usage. 59: 60: Current things done: 61: 62: Makes a table out of the previous homework attempts 63: Inputs result_from_symbread, user, domain, course_id 64: Reads in non-network-related .tab files 65: 66: This is part of the LearningOnline Network with CAPA project 67: described at http://www.lon-capa.org. 68: 69: =head2 General Subroutines 70: 71: =over 4 72: 73: =cut 74: 75: # End of POD header 76: package Apache::loncommon; 77: 78: use strict; 79: use Apache::lonnet(); 80: use GDBM_File; 81: use POSIX qw(strftime mktime); 82: use Apache::Constants qw(:common); 83: use Apache::lonmsg(); 84: my $readit; 85: 86: =pod 87: 88: =item Global Variables 89: 90: =over 4 91: 92: =cut 93: # ----------------------------------------------- Filetypes/Languages/Copyright 94: my %language; 95: my %cprtag; 96: my %fe; my %fd; 97: my %category_extensions; 98: 99: # ---------------------------------------------- Designs 100: 101: my %designhash; 102: 103: # ---------------------------------------------- Thesaurus variables 104: 105: =pod 106: 107: =item %Keywords 108: 109: A hash used by &keyword to determine if a word is considered a keyword. 110: 111: =item $thesaurus_db_file 112: 113: Scalar containing the full path to the thesaurus database. 114: 115: =cut 116: 117: my %Keywords; 118: my $thesaurus_db_file; 119: 120: 121: =pod 122: 123: =back 124: 125: =cut 126: 127: # ----------------------------------------------------------------------- BEGIN 128: 129: =pod 130: 131: =item BEGIN() 132: 133: Initialize values from language.tab, copyright.tab, filetypes.tab, 134: thesaurus.tab, and filecategories.tab. 135: 136: =cut 137: 138: # ----------------------------------------------------------------------- BEGIN 139: 140: BEGIN { 141: # Variable initialization 142: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db"; 143: # 144: unless ($readit) { 145: # ------------------------------------------------------------------- languages 146: { 147: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. 148: '/language.tab'); 149: if ($fh) { 150: while (<$fh>) { 151: next if /^\#/; 152: chomp; 153: my ($key,$val)=(split(/\s+/,$_,2)); 154: $language{$key}=$val; 155: } 156: } 157: } 158: # ------------------------------------------------------------------ copyrights 159: { 160: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonIncludes'}. 161: '/copyright.tab'); 162: if ($fh) { 163: while (<$fh>) { 164: next if /^\#/; 165: chomp; 166: my ($key,$val)=(split(/\s+/,$_,2)); 167: $cprtag{$key}=$val; 168: } 169: } 170: } 171: 172: # -------------------------------------------------------------- domain designs 173: 174: my $filename; 175: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors'; 176: opendir(DIR,$designdir); 177: while ($filename=readdir(DIR)) { 178: my ($domain)=($filename=~/^(\w+)\./); 179: { 180: my $fh=Apache::File->new($designdir.'/'.$filename); 181: if ($fh) { 182: while (<$fh>) { 183: next if /^\#/; 184: chomp; 185: my ($key,$val)=(split(/\=/,$_)); 186: if ($val) { $designhash{$domain.'.'.$key}=$val; } 187: } 188: } 189: } 190: 191: } 192: closedir(DIR); 193: 194: 195: # ------------------------------------------------------------- file categories 196: { 197: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. 198: '/filecategories.tab'); 199: if ($fh) { 200: while (<$fh>) { 201: next if /^\#/; 202: chomp; 203: my ($extension,$category)=(split(/\s+/,$_,2)); 204: push @{$category_extensions{lc($category)}},$extension; 205: } 206: } 207: } 208: # ------------------------------------------------------------------ file types 209: { 210: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. 211: '/filetypes.tab'); 212: if ($fh) { 213: while (<$fh>) { 214: next if (/^\#/); 215: chomp; 216: my ($ending,$emb,$descr)=split(/\s+/,$_,3); 217: if ($descr ne '') { 218: $fe{$ending}=lc($emb); 219: $fd{$ending}=$descr; 220: } 221: } 222: } 223: } 224: &Apache::lonnet::logthis( 225: "<font color=yellow>INFO: Read file types</font>"); 226: $readit=1; 227: } # end of unless($readit) 228: 229: } 230: # ============================================================= END BEGIN BLOCK 231: ############################################################### 232: ## HTML and Javascript Helper Functions ## 233: ############################################################### 234: 235: =pod 236: 237: =item browser_and_searcher_javascript 238: 239: Returns scalar containing javascript to open a browser window 240: or a searcher window. Also creates 241: 242: =over 4 243: 244: =item openbrowser(formname,elementname,only,omit) [javascript] 245: 246: inputs: formname, elementname, only, omit 247: 248: formname and elementname indicate the name of the html form and name of 249: the element that the results of the browsing selection are to be placed in. 250: 251: Specifying 'only' will restrict the browser to displaying only files 252: with the given extension. Can be a comma seperated list. 253: 254: Specifying 'omit' will restrict the browser to NOT displaying files 255: with the given extension. Can be a comma seperated list. 256: 257: =item opensearcher(formname, elementname) [javascript] 258: 259: Inputs: formname, elementname 260: 261: formname and elementname specify the name of the html form and the name 262: of the element the selection from the search results will be placed in. 263: 264: =back 265: 266: =cut 267: 268: ############################################################### 269: sub browser_and_searcher_javascript { 270: return <<END; 271: var editbrowser = null; 272: function openbrowser(formname,elementname,only,omit) { 273: var url = '/res/?'; 274: if (editbrowser == null) { 275: url += 'launch=1&'; 276: } 277: url += 'catalogmode=interactive&'; 278: url += 'mode=edit&'; 279: url += 'form=' + formname + '&'; 280: if (only != null) { 281: url += 'only=' + only + '&'; 282: } 283: if (omit != null) { 284: url += 'omit=' + omit + '&'; 285: } 286: url += 'element=' + elementname + ''; 287: var title = 'Browser'; 288: var options = 'scrollbars=1,resizable=1,menubar=0'; 289: options += ',width=700,height=600'; 290: editbrowser = open(url,title,options,'1'); 291: editbrowser.focus(); 292: } 293: var editsearcher; 294: function opensearcher(formname,elementname) { 295: var url = '/adm/searchcat?'; 296: if (editsearcher == null) { 297: url += 'launch=1&'; 298: } 299: url += 'catalogmode=interactive&'; 300: url += 'mode=edit&'; 301: url += 'form=' + formname + '&'; 302: url += 'element=' + elementname + ''; 303: var title = 'Search'; 304: var options = 'scrollbars=1,resizable=1,menubar=0'; 305: options += ',width=700,height=600'; 306: editsearcher = open(url,title,options,'1'); 307: editsearcher.focus(); 308: } 309: END 310: } 311: 312: sub studentbrowser_javascript { 313: unless ($ENV{'request.course.id'}) { return ''; } 314: unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { 315: return ''; 316: } 317: return (<<'ENDSTDBRW'); 318: <script type="text/javascript" language="Javascript" > 319: var stdeditbrowser; 320: function openstdbrowser(formname,uname,udom) { 321: var url = '/adm/pickstudent?'; 322: var filter; 323: eval('filter=document.'+formname+'.'+uname+'.value;'); 324: if (filter != null) { 325: if (filter != '') { 326: url += 'filter='+filter+'&'; 327: } 328: } 329: url += 'form=' + formname + '&unameelement='+uname+ 330: '&udomelement='+udom; 331: var title = 'Student Browser'; 332: var options = 'scrollbars=1,resizable=1,menubar=0'; 333: options += ',width=700,height=600'; 334: stdeditbrowser = open(url,title,options,'1'); 335: stdeditbrowser.focus(); 336: } 337: </script> 338: ENDSTDBRW 339: } 340: 341: sub selectstudent_link { 342: my ($form,$unameele,$udomele)=@_; 343: unless ($ENV{'request.course.id'}) { return ''; } 344: unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { 345: return ''; 346: } 347: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele. 348: '","'.$udomele.'");'."'>Select</a>"; 349: } 350: 351: ############################################################### 352: 353: =pod 354: 355: =item linked_select_forms(...) 356: 357: linked_select_forms returns a string containing a <script></script> block 358: and html for two <select> menus. The select menus will be linked in that 359: changing the value of the first menu will result in new values being placed 360: in the second menu. The values in the select menu will appear in alphabetical 361: order. 362: 363: linked_select_forms takes the following ordered inputs: 364: 365: =over 4 366: 367: =item $formname, the name of the <form> tag 368: 369: =item $middletext, the text which appears between the <select> tags 370: 371: =item $firstdefault, the default value for the first menu 372: 373: =item $firstselectname, the name of the first <select> tag 374: 375: =item $secondselectname, the name of the second <select> tag 376: 377: =item $hashref, a reference to a hash containing the data for the menus. 378: 379: =back 380: 381: Below is an example of such a hash. Only the 'text', 'default', and 382: 'select2' keys must appear as stated. keys(%menu) are the possible 383: values for the first select menu. The text that coincides with the 384: first menu value is given in $menu{$choice1}->{'text'}. The values 385: and text for the second menu are given in the hash pointed to by 386: $menu{$choice1}->{'select2'}. 387: 388: my %menu = ( A1 => { text =>"Choice A1" , 389: default => "B3", 390: select2 => { 391: B1 => "Choice B1", 392: B2 => "Choice B2", 393: B3 => "Choice B3", 394: B4 => "Choice B4" 395: } 396: }, 397: A2 => { text =>"Choice A2" , 398: default => "C2", 399: select2 => { 400: C1 => "Choice C1", 401: C2 => "Choice C2", 402: C3 => "Choice C3" 403: } 404: }, 405: A3 => { text =>"Choice A3" , 406: default => "D6", 407: select2 => { 408: D1 => "Choice D1", 409: D2 => "Choice D2", 410: D3 => "Choice D3", 411: D4 => "Choice D4", 412: D5 => "Choice D5", 413: D6 => "Choice D6", 414: D7 => "Choice D7" 415: } 416: } 417: ); 418: 419: =cut 420: 421: # ------------------------------------------------ 422: 423: sub linked_select_forms { 424: my ($formname, 425: $middletext, 426: $firstdefault, 427: $firstselectname, 428: $secondselectname, 429: $hashref 430: ) = @_; 431: my $second = "document.$formname.$secondselectname"; 432: my $first = "document.$formname.$firstselectname"; 433: # output the javascript to do the changing 434: my $result = ''; 435: $result.="<script>\n"; 436: $result.="var select2data = new Object();\n"; 437: $" = '","'; 438: my $debug = ''; 439: foreach my $s1 (sort(keys(%$hashref))) { 440: $result.="select2data.d_$s1 = new Object();\n"; 441: $result.="select2data.d_$s1.def = new String('". 442: $hashref->{$s1}->{'default'}."');\n"; 443: $result.="select2data.d_$s1.values = new Array("; 444: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } )); 445: $result.="\"@s2values\");\n"; 446: $result.="select2data.d_$s1.texts = new Array("; 447: my @s2texts; 448: foreach my $value (@s2values) { 449: push @s2texts, $hashref->{$s1}->{'select2'}->{$value}; 450: } 451: $result.="\"@s2texts\");\n"; 452: } 453: $"=' '; 454: $result.= <<"END"; 455: 456: function select1_changed() { 457: // Determine new choice 458: var newvalue = "d_" + $first.value; 459: // update select2 460: var values = select2data[newvalue].values; 461: var texts = select2data[newvalue].texts; 462: var select2def = select2data[newvalue].def; 463: var i; 464: // out with the old 465: for (i = 0; i < $second.options.length; i++) { 466: $second.options[i] = null; 467: } 468: // in with the nuclear 469: for (i=0;i<values.length; i++) { 470: $second.options[i] = new Option(values[i]); 471: $second.options[i].text = texts[i]; 472: if (values[i] == select2def) { 473: $second.options[i].selected = true; 474: } 475: } 476: } 477: </script> 478: END 479: # output the initial values for the selection lists 480: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n"; 481: foreach my $value (sort(keys(%$hashref))) { 482: $result.=" <option value=\"$value\" "; 483: $result.=" selected=\"true\" " if ($value eq $firstdefault); 484: $result.=">$hashref->{$value}->{'text'}</option>\n"; 485: } 486: $result .= "</select>\n"; 487: my %select2 = %{$hashref->{$firstdefault}->{'select2'}}; 488: $result .= $middletext; 489: $result .= "<select size=\"1\" name=\"$secondselectname\">\n"; 490: my $seconddefault = $hashref->{$firstdefault}->{'default'}; 491: foreach my $value (sort(keys(%select2))) { 492: $result.=" <option value=\"$value\" "; 493: $result.=" selected=\"true\" " if ($value eq $seconddefault); 494: $result.=">$select2{$value}</option>\n"; 495: } 496: $result .= "</select>\n"; 497: # return $debug; 498: return $result; 499: } # end of sub linked_select_forms { 500: 501: ############################################################### 502: 503: =pod 504: 505: =item help_open_topic($topic, $text, $stayOnPage, $width, $height) 506: 507: Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces. 508: 509: $text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string. 510: 511: $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.) 512: 513: $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included. 514: 515: =cut 516: 517: sub help_open_topic { 518: my ($topic, $text, $stayOnPage, $width, $height) = @_; 519: $text = "" if (not defined $text); 520: $stayOnPage = 0 if (not defined $stayOnPage); 521: if ($ENV{'browser.interface'} eq 'textual') { 522: $stayOnPage=1; 523: } 524: $width = 350 if (not defined $width); 525: $height = 400 if (not defined $height); 526: my $filename = $topic; 527: $filename =~ s/ /_/g; 528: 529: my $template = ""; 530: my $link; 531: 532: if (!$stayOnPage) 533: { 534: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))"; 535: } 536: else 537: { 538: $link = "/adm/help/${filename}.hlp"; 539: } 540: 541: # Add the text 542: if ($text ne "") 543: { 544: $template .= 545: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>". 546: "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>"; 547: } 548: 549: # Add the graphic 550: $template .= <<"ENDTEMPLATE"; 551: <a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)" /></a> 552: ENDTEMPLATE 553: if ($text ne '') { $template.='</td></tr></table>' }; 554: return $template; 555: 556: } 557: 558: =pod 559: 560: =item csv_translate($text) 561: 562: Translate $text to allow it to be output as a 'comma seperated values' 563: format. 564: 565: =cut 566: 567: sub csv_translate { 568: my $text = shift; 569: $text =~ s/\"/\"\"/g; 570: $text =~ s/\n//g; 571: return $text; 572: } 573: 574: ############################################################### 575: ## Home server <option> list generating code ## 576: ############################################################### 577: #------------------------------------------- 578: 579: =pod 580: 581: =item get_domains() 582: 583: Returns an array containing each of the domains listed in the hosts.tab 584: file. 585: 586: =cut 587: 588: #------------------------------------------- 589: sub get_domains { 590: # The code below was stolen from "The Perl Cookbook", p 102, 1st ed. 591: my @domains; 592: my %seen; 593: foreach (sort values(%Apache::lonnet::hostdom)) { 594: push (@domains,$_) unless $seen{$_}++; 595: } 596: return @domains; 597: } 598: 599: #------------------------------------------- 600: 601: =pod 602: 603: =item select_dom_form($defdom,$name) 604: 605: Returns a string containing a <select name='$name' size='1'> form to 606: allow a user to select the domain to preform an operation in. 607: See loncreateuser.pm for an example invocation and use. 608: 609: =cut 610: 611: #------------------------------------------- 612: sub select_dom_form { 613: my ($defdom,$name) = @_; 614: my @domains = get_domains(); 615: my $selectdomain = "<select name=\"$name\" size=\"1\">\n"; 616: foreach (@domains) { 617: $selectdomain.="<option value=\"$_\" ". 618: ($_ eq $defdom ? 'selected' : ''). 619: ">$_</option>\n"; 620: } 621: $selectdomain.="</select>"; 622: return $selectdomain; 623: } 624: 625: #------------------------------------------- 626: 627: =pod 628: 629: =item get_library_servers($domain) 630: 631: Returns a hash which contains keys like '103l3' and values like 632: 'kirk.lite.msu.edu'. All of the keys will be for machines in the 633: given $domain. 634: 635: =cut 636: 637: #------------------------------------------- 638: sub get_library_servers { 639: my $domain = shift; 640: my %library_servers; 641: foreach (keys(%Apache::lonnet::libserv)) { 642: if ($Apache::lonnet::hostdom{$_} eq $domain) { 643: $library_servers{$_} = $Apache::lonnet::hostname{$_}; 644: } 645: } 646: return %library_servers; 647: } 648: 649: #------------------------------------------- 650: 651: =pod 652: 653: =item home_server_option_list($domain) 654: 655: returns a string which contains an <option> list to be used in a 656: <select> form input. See loncreateuser.pm for an example. 657: 658: =cut 659: 660: #------------------------------------------- 661: sub home_server_option_list { 662: my $domain = shift; 663: my %servers = &get_library_servers($domain); 664: my $result = ''; 665: foreach (sort keys(%servers)) { 666: $result.= 667: '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n"; 668: } 669: return $result; 670: } 671: ############################################################### 672: ## End of home server <option> list generating code ## 673: ############################################################### 674: 675: ############################################################### 676: ## Authentication changing form generation subroutines ## 677: ############################################################### 678: ## 679: ## All of the authform_xxxxxxx subroutines take their inputs in a 680: ## hash, and have reasonable default values. 681: ## 682: ## formname = the name given in the <form> tag. 683: #------------------------------------------- 684: 685: =pod 686: 687: =item authform_xxxxxx 688: 689: The authform_xxxxxx subroutines provide javascript and html forms which 690: handle some of the conveniences required for authentication forms. 691: This is not an optimal method, but it works. 692: 693: See loncreateuser.pm for invocation and use examples. 694: 695: =over 4 696: 697: =item authform_header 698: 699: =item authform_authorwarning 700: 701: =item authform_nochange 702: 703: =item authform_kerberos 704: 705: =item authform_internal 706: 707: =item authform_filesystem 708: 709: =back 710: 711: =cut 712: 713: #------------------------------------------- 714: sub authform_header{ 715: my %in = ( 716: formname => 'cu', 717: kerb_def_dom => '', 718: @_, 719: ); 720: $in{'formname'} = 'document.' . $in{'formname'}; 721: my $result=''; 722: 723: #---------------------------------------------- Code for upper case translation 724: my $Javascript_toUpperCase; 725: unless ($in{kerb_def_dom}) { 726: $Javascript_toUpperCase =<<"END"; 727: switch (choice) { 728: case 'krb': currentform.elements[choicearg].value = 729: currentform.elements[choicearg].value.toUpperCase(); 730: break; 731: default: 732: } 733: END 734: } else { 735: $Javascript_toUpperCase = ""; 736: } 737: 738: $result.=<<"END"; 739: var current = new Object(); 740: current.radiovalue = 'nochange'; 741: current.argfield = null; 742: 743: function changed_radio(choice,currentform) { 744: var choicearg = choice + 'arg'; 745: // If a radio button in changed, we need to change the argfield 746: if (current.radiovalue != choice) { 747: current.radiovalue = choice; 748: if (current.argfield != null) { 749: currentform.elements[current.argfield].value = ''; 750: } 751: if (choice == 'nochange') { 752: current.argfield = null; 753: } else { 754: current.argfield = choicearg; 755: switch(choice) { 756: case 'krb': 757: currentform.elements[current.argfield].value = 758: "$in{'kerb_def_dom'}"; 759: break; 760: default: 761: break; 762: } 763: } 764: } 765: return; 766: } 767: 768: function changed_text(choice,currentform) { 769: var choicearg = choice + 'arg'; 770: if (currentform.elements[choicearg].value !='') { 771: $Javascript_toUpperCase 772: // clear old field 773: if ((current.argfield != choicearg) && (current.argfield != null)) { 774: currentform.elements[current.argfield].value = ''; 775: } 776: current.argfield = choicearg; 777: } 778: set_auth_radio_buttons(choice,currentform); 779: return; 780: } 781: 782: function set_auth_radio_buttons(newvalue,currentform) { 783: var i=0; 784: while (i < currentform.login.length) { 785: if (currentform.login[i].value == newvalue) { break; } 786: i++; 787: } 788: if (i == currentform.login.length) { 789: return; 790: } 791: current.radiovalue = newvalue; 792: currentform.login[i].checked = true; 793: return; 794: } 795: END 796: return $result; 797: } 798: 799: sub authform_authorwarning{ 800: my $result=''; 801: $result=<<"END"; 802: <i>As a general rule, only authors or co-authors should be filesystem 803: authenticated (which allows access to the server filesystem).</i> 804: END 805: return $result; 806: } 807: 808: sub authform_nochange{ 809: my %in = ( 810: formname => 'document.cu', 811: kerb_def_dom => 'MSU.EDU', 812: @_, 813: ); 814: my $result=''; 815: $result.=<<"END"; 816: <input type="radio" name="login" value="nochange" checked="checked" 817: onclick="javascript:changed_radio('nochange',$in{'formname'});" /> 818: Do not change login data 819: END 820: return $result; 821: } 822: 823: sub authform_kerberos{ 824: my %in = ( 825: formname => 'document.cu', 826: kerb_def_dom => 'MSU.EDU', 827: kerb_def_auth => 'krb4', 828: @_, 829: ); 830: my $result=''; 831: my $check4; 832: my $check5; 833: if ($in{'kerb_def_auth'} eq 'krb5') { 834: $check5 = " checked=\"on\""; 835: } else { 836: $check4 = " checked=\"on\""; 837: } 838: $result.=<<"END"; 839: <input type="radio" name="login" value="krb" 840: onclick="javascript:changed_radio('krb',$in{'formname'});" 841: onchange="javascript:changed_radio('krb',$in{'formname'});" /> 842: Kerberos authenticated with domain 843: <input type="text" size="10" name="krbarg" value="$in{'kerb_def_dom'}" 844: onchange="javascript:changed_text('krb',$in{'formname'});" /> 845: <input type="radio" name="krbver" value="4" $check4 />Version 4 846: <input type="radio" name="krbver" value="5" $check5 />Version 5 847: END 848: return $result; 849: } 850: 851: sub authform_internal{ 852: my %args = ( 853: formname => 'document.cu', 854: kerb_def_dom => 'MSU.EDU', 855: @_, 856: ); 857: my $result=''; 858: $result.=<<"END"; 859: <input type="radio" name="login" value="int" 860: onchange="javascript:changed_radio('int',$args{'formname'});" 861: onclick="javascript:changed_radio('int',$args{'formname'});" /> 862: Internally authenticated (with initial password 863: <input type="text" size="10" name="intarg" value="" 864: onchange="javascript:changed_text('int',$args{'formname'});" />) 865: END 866: return $result; 867: } 868: 869: sub authform_local{ 870: my %in = ( 871: formname => 'document.cu', 872: kerb_def_dom => 'MSU.EDU', 873: @_, 874: ); 875: my $result=''; 876: $result.=<<"END"; 877: <input type="radio" name="login" value="loc" 878: onchange="javascript:changed_radio('loc',$in{'formname'});" 879: onclick="javascript:changed_radio('loc',$in{'formname'});" /> 880: Local Authentication with argument 881: <input type="text" size="10" name="locarg" value="" 882: onchange="javascript:changed_text('loc',$in{'formname'});" /> 883: END 884: return $result; 885: } 886: 887: sub authform_filesystem{ 888: my %in = ( 889: formname => 'document.cu', 890: kerb_def_dom => 'MSU.EDU', 891: @_, 892: ); 893: my $result=''; 894: $result.=<<"END"; 895: <input type="radio" name="login" value="fsys" 896: onchange="javascript:changed_radio('fsys',$in{'formname'});" 897: onclick="javascript:changed_radio('fsys',$in{'formname'});" /> 898: Filesystem authenticated (with initial password 899: <input type="text" size="10" name="fsysarg" value="" 900: onchange="javascript:changed_text('fsys',$in{'formname'});">) 901: END 902: return $result; 903: } 904: 905: ############################################################### 906: ## End Authentication changing form generation functions ## 907: ############################################################### 908: 909: ############################################################### 910: ## Get Authentication Defaults for Domain ## 911: ############################################################### 912: ## 913: ## Returns default authentication type and an associated argument 914: ## as listed in file domain.tab 915: ## 916: #------------------------------------------- 917: 918: =pod 919: 920: =item get_auth_defaults 921: 922: get_auth_defaults($target_domain) returns the default authentication 923: type and an associated argument (initial password or a kerberos domain). 924: These values are stored in lonTabs/domain.tab 925: 926: ($def_auth, $def_arg) = &get_auth_defaults($target_domain); 927: 928: If target_domain is not found in domain.tab, returns nothing (''). 929: 930: =over 4 931: 932: =item get_auth_defaults 933: 934: =back 935: 936: =cut 937: 938: #------------------------------------------- 939: sub get_auth_defaults { 940: my $domain=shift; 941: return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain}); 942: } 943: ############################################################### 944: ## End Get Authentication Defaults for Domain ## 945: ############################################################### 946: 947: ############################################################### 948: ## Get Kerberos Defaults for Domain ## 949: ############################################################### 950: ## 951: ## Returns default kerberos version and an associated argument 952: ## as listed in file domain.tab. If not listed, provides 953: ## appropriate default domain and kerberos version. 954: ## 955: #------------------------------------------- 956: 957: =pod 958: 959: =item get_kerberos_defaults 960: 961: get_kerberos_defaults($target_domain) returns the default kerberos 962: version and domain. If not found in domain.tabs, it defaults to 963: version 4 and the domain of the server. 964: 965: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain); 966: 967: =over 4 968: 969: =item get_kerberos_defaults 970: 971: =back 972: 973: =cut 974: 975: #------------------------------------------- 976: sub get_kerberos_defaults { 977: my $domain=shift; 978: my ($krbdef,$krbdefdom) = 979: &Apache::loncommon::get_auth_defaults($domain); 980: unless ($krbdef =~/^krb/ && $krbdefdom) { 981: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; 982: my $krbdefdom=$1; 983: $krbdefdom=~tr/a-z/A-Z/; 984: $krbdef = "krb4"; 985: } 986: return ($krbdef,$krbdefdom); 987: } 988: ############################################################### 989: ## End Get Kerberos Defaults for Domain ## 990: ############################################################### 991: 992: ############################################################### 993: ## Thesaurus Functions ## 994: ############################################################### 995: 996: =pod 997: 998: =item initialize_keywords 999: 1000: Initializes the package variable %Keywords if it is empty. Uses the 1001: package variable $thesaurus_db_file. 1002: 1003: =cut 1004: 1005: ################################################### 1006: 1007: sub initialize_keywords { 1008: return 1 if (scalar keys(%Keywords)); 1009: # If we are here, %Keywords is empty, so fill it up 1010: # Make sure the file we need exists... 1011: if (! -e $thesaurus_db_file) { 1012: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file". 1013: " failed because it does not exist"); 1014: return 0; 1015: } 1016: # Set up the hash as a database 1017: my %thesaurus_db; 1018: if (! tie(%thesaurus_db,'GDBM_File', 1019: $thesaurus_db_file,&GDBM_READER(),0640)){ 1020: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ". 1021: $thesaurus_db_file); 1022: return 0; 1023: } 1024: # Get the average number of appearances of a word. 1025: my $avecount = $thesaurus_db{'average.count'}; 1026: # Put keywords (those that appear > average) into %Keywords 1027: while (my ($word,$data)=each (%thesaurus_db)) { 1028: my ($count,undef) = split /:/,$data; 1029: $Keywords{$word}++ if ($count > $avecount); 1030: } 1031: untie %thesaurus_db; 1032: # Remove special values from %Keywords. 1033: foreach ('total.count','average.count') { 1034: delete($Keywords{$_}) if (exists($Keywords{$_})); 1035: } 1036: return 1; 1037: } 1038: 1039: ################################################### 1040: 1041: =pod 1042: 1043: =item keyword($word) 1044: 1045: Returns true if $word is a keyword. A keyword is a word that appears more 1046: than the average number of times in the thesaurus database. Calls 1047: &initialize_keywords 1048: 1049: =cut 1050: 1051: ################################################### 1052: 1053: sub keyword { 1054: return if (!&initialize_keywords()); 1055: my $word=lc(shift()); 1056: $word=~s/\W//g; 1057: return exists($Keywords{$word}); 1058: } 1059: 1060: ############################################################### 1061: 1062: =pod 1063: 1064: =item get_related_words 1065: 1066: Look up a word in the thesaurus. Takes a scalar arguement and returns 1067: an array of words. If the keyword is not in the thesaurus, an empty array 1068: will be returned. The order of the words returned is determined by the 1069: database which holds them. 1070: 1071: Uses global $thesaurus_db_file. 1072: 1073: =cut 1074: 1075: ############################################################### 1076: sub get_related_words { 1077: my $keyword = shift; 1078: my %thesaurus_db; 1079: if (! -e $thesaurus_db_file) { 1080: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ". 1081: "failed because the file does not exist"); 1082: return (); 1083: } 1084: if (! tie(%thesaurus_db,'GDBM_File', 1085: $thesaurus_db_file,&GDBM_READER(),0640)){ 1086: return (); 1087: } 1088: my @Words=(); 1089: if (exists($thesaurus_db{$keyword})) { 1090: $_ = $thesaurus_db{$keyword}; 1091: (undef,@Words) = split/:/; # The first element is the number of times 1092: # the word appears. We do not need it now. 1093: for (my $i=0;$i<=$#Words;$i++) { 1094: ($Words[$i],undef)= split/\,/,$Words[$i]; 1095: } 1096: } 1097: untie %thesaurus_db; 1098: return @Words; 1099: } 1100: 1101: ############################################################### 1102: ## End Thesaurus Functions ## 1103: ############################################################### 1104: 1105: # -------------------------------------------------------------- Plaintext name 1106: 1107: sub plainname { 1108: my ($uname,$udom)=@_; 1109: my %names=&Apache::lonnet::get('environment', 1110: ['firstname','middlename','lastname','generation'], 1111: $udom,$uname); 1112: my $name=$names{'firstname'}.' '.$names{'middlename'}.' '. 1113: $names{'lastname'}.' '.$names{'generation'}; 1114: $name=~s/\s+$//; 1115: $name=~s/\s+/ /g; 1116: return $name; 1117: } 1118: 1119: # -------------------------------------------------------------------- Nickname 1120: 1121: 1122: sub nickname { 1123: my ($uname,$udom)=@_; 1124: my %names=&Apache::lonnet::get('environment', 1125: ['nickname','firstname','middlename','lastname','generation'],$udom,$uname); 1126: my $name=$names{'nickname'}; 1127: if ($name) { 1128: $name='"'.$name.'"'; 1129: } else { 1130: $name=$names{'firstname'}.' '.$names{'middlename'}.' '. 1131: $names{'lastname'}.' '.$names{'generation'}; 1132: $name=~s/\s+$//; 1133: $name=~s/\s+/ /g; 1134: } 1135: return $name; 1136: } 1137: 1138: 1139: # ------------------------------------------------------------------ Screenname 1140: 1141: sub screenname { 1142: my ($uname,$udom)=@_; 1143: my %names= 1144: &Apache::lonnet::get('environment',['screenname'],$udom,$uname); 1145: return $names{'screenname'}; 1146: } 1147: 1148: # ------------------------------------------------------------- Message Wrapper 1149: 1150: sub messagewrapper { 1151: my ($link,$un,$do)=@_; 1152: return 1153: "<a href='/adm/email?compose=individual&recname=$un&recdom=$do'>$link</a>"; 1154: } 1155: # --------------------------------------------------------------- Notes Wrapper 1156: 1157: sub noteswrapper { 1158: my ($link,$un,$do)=@_; 1159: return 1160: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>"; 1161: } 1162: # ------------------------------------------------------------- Aboutme Wrapper 1163: 1164: sub aboutmewrapper { 1165: my ($link,$username,$domain)=@_; 1166: return "<a href='/adm/$domain/$username/aboutme'>$link</a>"; 1167: } 1168: 1169: # ------------------------------------------------------------ Syllabus Wrapper 1170: 1171: 1172: sub syllabuswrapper { 1173: my ($link,$un,$do,$tf)=@_; 1174: if ($tf) { $link='<font color="'.$tf.'">'.$link.'</font>'; } 1175: return "<a href='/public/$do/$un/syllabus'>$link</a>"; 1176: } 1177: 1178: # ---------------------------------------------------------------- Language IDs 1179: sub languageids { 1180: return sort(keys(%language)); 1181: } 1182: 1183: # -------------------------------------------------------- Language Description 1184: sub languagedescription { 1185: return $language{shift(@_)}; 1186: } 1187: 1188: # --------------------------------------------------------------- Copyright IDs 1189: sub copyrightids { 1190: return sort(keys(%cprtag)); 1191: } 1192: 1193: # ------------------------------------------------------- Copyright Description 1194: sub copyrightdescription { 1195: return $cprtag{shift(@_)}; 1196: } 1197: 1198: # ------------------------------------------------------------- File Categories 1199: sub filecategories { 1200: return sort(keys(%category_extensions)); 1201: } 1202: 1203: # -------------------------------------- File Types within a specified category 1204: sub filecategorytypes { 1205: return @{$category_extensions{lc($_[0])}}; 1206: } 1207: 1208: # ------------------------------------------------------------------ File Types 1209: sub fileextensions { 1210: return sort(keys(%fe)); 1211: } 1212: 1213: # ------------------------------------------------------------- Embedding Style 1214: sub fileembstyle { 1215: return $fe{lc(shift(@_))}; 1216: } 1217: 1218: # ------------------------------------------------------------ Description Text 1219: sub filedescription { 1220: return $fd{lc(shift(@_))}; 1221: } 1222: 1223: # ------------------------------------------------------------ Description Text 1224: sub filedescriptionex { 1225: my $ex=shift; 1226: return '.'.$ex.' '.$fd{lc($ex)}; 1227: } 1228: 1229: # ---- Retrieve attempts by students 1230: # input 1231: # $symb - problem including path 1232: # $username,$domain - that of the student 1233: # $course - course name 1234: # $getattempt - leave blank if want all attempts, else put something. 1235: # $regexp - regular expression. If string matches regexp send to 1236: # $gradesub - routine that process the string if it matches regexp 1237: # 1238: # output 1239: # formatted as a table all the attempts, if any. 1240: # 1241: sub get_previous_attempt { 1242: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_; 1243: my $prevattempts=''; 1244: no strict 'refs'; 1245: if ($symb) { 1246: my (%returnhash)= 1247: &Apache::lonnet::restore($symb,$course,$domain,$username); 1248: if ($returnhash{'version'}) { 1249: my %lasthash=(); 1250: my $version; 1251: for ($version=1;$version<=$returnhash{'version'};$version++) { 1252: foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) { 1253: $lasthash{$_}=$returnhash{$version.':'.$_}; 1254: } 1255: } 1256: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">'; 1257: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>'; 1258: foreach (sort(keys %lasthash)) { 1259: my ($ign,@parts) = split(/\./,$_); 1260: if ($#parts > 0) { 1261: my $data=$parts[-1]; 1262: pop(@parts); 1263: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>'; 1264: } else { 1265: if ($#parts == 0) { 1266: $prevattempts.='<th>'.$parts[0].'</th>'; 1267: } else { 1268: $prevattempts.='<th>'.$ign.'</th>'; 1269: } 1270: } 1271: } 1272: if ($getattempt eq '') { 1273: for ($version=1;$version<=$returnhash{'version'};$version++) { 1274: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>'; 1275: foreach (sort(keys %lasthash)) { 1276: my $value; 1277: if ($_ =~ /timestamp/) { 1278: $value=scalar(localtime($returnhash{$version.':'.$_})); 1279: } else { 1280: $value=$returnhash{$version.':'.$_}; 1281: } 1282: $prevattempts.='<td>'.$value.' </td>'; 1283: } 1284: } 1285: } 1286: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>'; 1287: foreach (sort(keys %lasthash)) { 1288: my $value; 1289: if ($_ =~ /timestamp/) { 1290: $value=scalar(localtime($lasthash{$_})); 1291: } else { 1292: $value=$lasthash{$_}; 1293: } 1294: if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)} 1295: $prevattempts.='<td>'.$value.' </td>'; 1296: } 1297: $prevattempts.='</tr></table></td></tr></table>'; 1298: } else { 1299: $prevattempts='Nothing submitted - no attempts.'; 1300: } 1301: } else { 1302: $prevattempts='No data.'; 1303: } 1304: } 1305: 1306: sub get_student_view { 1307: my ($symb,$username,$domain,$courseid,$target) = @_; 1308: my ($map,$id,$feedurl) = split(/___/,$symb); 1309: my (%old,%moreenv); 1310: my @elements=('symb','courseid','domain','username'); 1311: foreach my $element (@elements) { 1312: $old{$element}=$ENV{'form.grade_'.$element}; 1313: $moreenv{'form.grade_'.$element}=eval '$'.$element #' 1314: } 1315: if ($target eq 'tex') {$moreenv{'form.grade_target'} = 'tex';} 1316: &Apache::lonnet::appenv(%moreenv); 1317: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl); 1318: &Apache::lonnet::delenv('form.grade_'); 1319: foreach my $element (@elements) { 1320: $ENV{'form.grade_'.$element}=$old{$element}; 1321: } 1322: $userview=~s/\<body[^\>]*\>//gi; 1323: $userview=~s/\<\/body\>//gi; 1324: $userview=~s/\<html\>//gi; 1325: $userview=~s/\<\/html\>//gi; 1326: $userview=~s/\<head\>//gi; 1327: $userview=~s/\<\/head\>//gi; 1328: $userview=~s/action\s*\=/would_be_action\=/gi; 1329: return $userview; 1330: } 1331: 1332: sub get_student_answers { 1333: my ($symb,$username,$domain,$courseid) = @_; 1334: my ($map,$id,$feedurl) = split(/___/,$symb); 1335: my (%old,%moreenv); 1336: my @elements=('symb','courseid','domain','username'); 1337: foreach my $element (@elements) { 1338: $old{$element}=$ENV{'form.grade_'.$element}; 1339: $moreenv{'form.grade_'.$element}=eval '$'.$element #' 1340: } 1341: $moreenv{'form.grade_target'}='answer'; 1342: &Apache::lonnet::appenv(%moreenv); 1343: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl); 1344: &Apache::lonnet::delenv('form.grade_'); 1345: foreach my $element (@elements) { 1346: $ENV{'form.grade_'.$element}=$old{$element}; 1347: } 1348: return $userview; 1349: } 1350: 1351: ############################################### 1352: 1353: 1354: sub timehash { 1355: my @ltime=localtime(shift); 1356: return ( 'seconds' => $ltime[0], 1357: 'minutes' => $ltime[1], 1358: 'hours' => $ltime[2], 1359: 'day' => $ltime[3], 1360: 'month' => $ltime[4]+1, 1361: 'year' => $ltime[5]+1900, 1362: 'weekday' => $ltime[6], 1363: 'dayyear' => $ltime[7]+1, 1364: 'dlsav' => $ltime[8] ); 1365: } 1366: 1367: sub maketime { 1368: my %th=@_; 1369: return POSIX::mktime( 1370: ($th{'seconds'},$th{'minutes'},$th{'hours'}, 1371: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,$th{'dlsav'})); 1372: } 1373: 1374: 1375: ######################################### 1376: # 1377: # Retro-fixing of un-backward-compatible time format 1378: 1379: sub unsqltime { 1380: my $timestamp=shift; 1381: if ($timestamp=~/^(\d+)\-(\d+)\-(\d+)\s+(\d+)\:(\d+)\:(\d+)$/) { 1382: $timestamp=&maketime( 1383: 'year'=>$1,'month'=>$2,'day'=>$3, 1384: 'hours'=>$4,'minutes'=>$5,'seconds'=>$6); 1385: } 1386: return $timestamp; 1387: } 1388: 1389: ######################################### 1390: 1391: sub findallcourses { 1392: my %courses=(); 1393: my $now=time; 1394: foreach (keys %ENV) { 1395: if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) { 1396: my ($starttime,$endtime)=$ENV{$_}; 1397: my $active=1; 1398: if ($starttime) { 1399: if ($now<$starttime) { $active=0; } 1400: } 1401: if ($endtime) { 1402: if ($now>$endtime) { $active=0; } 1403: } 1404: if ($active) { $courses{$1.'_'.$2}=1; } 1405: } 1406: } 1407: return keys %courses; 1408: } 1409: 1410: ############################################### 1411: ############################################### 1412: 1413: =pod 1414: 1415: =item &determinedomain() 1416: 1417: Inputs: $domain (usually will be undef) 1418: 1419: Returns: Determines which domain should be used for designs 1420: 1421: =cut 1422: 1423: ############################################### 1424: sub determinedomain { 1425: my $domain=shift; 1426: if (! $domain) { 1427: # Determine domain if we have not been given one 1428: $domain = $Apache::lonnet::perlvar{'lonDefDomain'}; 1429: if ($ENV{'user.domain'}) { $domain=$ENV{'user.domain'}; } 1430: if ($ENV{'request.role.domain'}) { 1431: $domain=$ENV{'request.role.domain'}; 1432: } 1433: } 1434: return $domain; 1435: } 1436: ############################################### 1437: =pod 1438: 1439: =item &domainlogo() 1440: 1441: Inputs: $domain (usually will be undef) 1442: 1443: Returns: A link to a domain logo, if the domain logo exists. 1444: If the domain logo does not exist, a description of the domain. 1445: 1446: =cut 1447: ############################################### 1448: sub domainlogo { 1449: my $domain = &determinedomain(shift); 1450: # See if there is a logo 1451: if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') { 1452: return '<img src="http://'.$ENV{'HTTP_HOST'}.':8080/adm/lonDomLogos/'. 1453: $domain.'.gif" />'; 1454: } elsif(exists($Apache::lonnet::domaindescription{$domain})) { 1455: return $Apache::lonnet::domaindescription{$domain}; 1456: } else { 1457: return ''; 1458: } 1459: } 1460: ############################################## 1461: 1462: =pod 1463: 1464: =item &designparm() 1465: 1466: Inputs: $which parameter; $domain (usually will be undef) 1467: 1468: Returns: value of designparamter $which 1469: 1470: =cut 1471: ############################################## 1472: sub designparm { 1473: my ($which,$domain)=@_; 1474: $domain=&determinedomain($domain); 1475: if ($designhash{$domain.'.'.$which}) { 1476: return $designhash{$domain.'.'.$which}; 1477: } else { 1478: return $designhash{'default.'.$which}; 1479: } 1480: } 1481: 1482: ############################################### 1483: ############################################### 1484: 1485: =pod 1486: 1487: =item &bodytag() 1488: 1489: Returns a uniform header for LON-CAPA web pages. 1490: 1491: Inputs: 1492: 1493: $title, A title to be displayed on the page. 1494: $function, the current role (can be undef). 1495: $addentries, extra parameters for the <body> tag. 1496: $bodyonly, if defined, only return the <body> tag. 1497: $domain, if defined, force a given domain. 1498: 1499: Returns: A uniform header for LON-CAPA web pages. 1500: If $bodyonly is nonzero, a string containing a <body> tag will be returned. 1501: If $bodyonly is undef or zero, an html string containing a <body> tag and 1502: other decorations will be returned. 1503: 1504: =cut 1505: 1506: ############################################### 1507: 1508: 1509: ############################################### 1510: sub bodytag { 1511: my ($title,$function,$addentries,$bodyonly,$domain)=@_; 1512: unless ($function) { 1513: $function='student'; 1514: if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) { 1515: $function='coordinator'; 1516: } 1517: if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) { 1518: $function='admin'; 1519: } 1520: if (($ENV{'request.role'}=~/^(au|ca)/) || 1521: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) { 1522: $function='author'; 1523: } 1524: } 1525: my $img=&designparm($function.'.img',$domain); 1526: my $pgbg=&designparm($function.'.pgbg',$domain); 1527: my $tabbg=&designparm($function.'.tabbg',$domain); 1528: my $font=&designparm($function.'.font',$domain); 1529: my $link=&designparm($function.'.link',$domain); 1530: my $alink=&designparm($function.'.alink',$domain); 1531: my $vlink=&designparm($function.'.vlink',$domain); 1532: my $sidebg=&designparm($function.'.sidebg',$domain); 1533: 1534: # role and realm 1535: my ($role,$realm) 1536: =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]); 1537: # realm 1538: if ($ENV{'request.course.id'}) { 1539: $realm= 1540: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; 1541: } 1542: unless ($realm) { $realm=' '; } 1543: # Set messages 1544: my $messages=&domainlogo($domain); 1545: # Output 1546: my $bodytag = <<END; 1547: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link" 1548: $addentries> 1549: END 1550: if ($bodyonly) { 1551: return $bodytag; 1552: } elsif ($ENV{'browser.interface'} eq 'textual') { 1553: return $bodytag.'<h1>LON-CAPA: '.$title. 1554: '</h1><a href="/adm/menu">Main Menu</a><hr />'; 1555: } else { 1556: return(<<ENDBODY); 1557: $bodytag 1558: <table width="100%" cellspacing="0" border="0" cellpadding="0"> 1559: <tr><td bgcolor="$font"> 1560: <img src="http://$ENV{'HTTP_HOST'}:8080/$img" /></td> 1561: <td bgcolor="$font"><font color='$sidebg'>$messages</font></td> 1562: </tr> 1563: <tr> 1564: <td rowspan="3" bgcolor="$tabbg"> 1565:  <font size="5"><b>$title</b></font> 1566: <td bgcolor="$tabbg" align="right"> 1567: <font size="2"> 1568: $ENV{'environment.firstname'} 1569: $ENV{'environment.middlename'} 1570: $ENV{'environment.lastname'} 1571: $ENV{'environment.generation'} 1572: </font>  1573: </td> 1574: </tr> 1575: <tr><td bgcolor="$tabbg" align="right"> 1576: <font size="2">$role</font>  1577: </td></tr> 1578: <tr> 1579: <td bgcolor="$tabbg" align="right"><font size="2">$realm</font> </td></tr> 1580: </table><br> 1581: ENDBODY 1582: } 1583: } 1584: ############################################### 1585: 1586: sub get_unprocessed_cgi { 1587: my ($query,$possible_names)= @_; 1588: # $Apache::lonxml::debug=1; 1589: foreach (split(/&/,$query)) { 1590: my ($name, $value) = split(/=/,$_); 1591: $name = &Apache::lonnet::unescape($name); 1592: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) { 1593: $value =~ tr/+/ /; 1594: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; 1595: &Apache::lonxml::debug("Seting :$name: to :$value:"); 1596: unless (defined($ENV{'form.'.$name})) { &add_to_env('form.'.$name,$value) }; 1597: } 1598: } 1599: } 1600: 1601: sub cacheheader { 1602: unless ($ENV{'request.method'} eq 'GET') { return ''; } 1603: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime); 1604: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" /> 1605: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" /> 1606: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />'; 1607: return $output; 1608: } 1609: 1610: sub no_cache { 1611: my ($r) = @_; 1612: unless ($ENV{'request.method'} eq 'GET') { return ''; } 1613: #my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime); 1614: $r->no_cache(1); 1615: $r->header_out("Pragma" => "no-cache"); 1616: #$r->header_out("Expires" => $date); 1617: } 1618: 1619: sub add_to_env { 1620: my ($name,$value)=@_; 1621: if (defined($ENV{$name})) { 1622: if (ref($ENV{$name})) { 1623: #already have multiple values 1624: push(@{ $ENV{$name} },$value); 1625: } else { 1626: #first time seeing multiple values, convert hash entry to an arrayref 1627: my $first=$ENV{$name}; 1628: undef($ENV{$name}); 1629: push(@{ $ENV{$name} },$first,$value); 1630: } 1631: } else { 1632: $ENV{$name}=$value; 1633: } 1634: } 1635: 1636: =pod 1637: 1638: =back 1639: 1640: =head2 CSV Upload/Handling functions 1641: 1642: =over 4 1643: 1644: =item upfile_store($r) 1645: 1646: Store uploaded file, $r should be the HTTP Request object, 1647: needs $ENV{'form.upfile'} 1648: returns $datatoken to be put into hidden field 1649: 1650: =cut 1651: 1652: sub upfile_store { 1653: my $r=shift; 1654: $ENV{'form.upfile'}=~s/\r/\n/gs; 1655: $ENV{'form.upfile'}=~s/\f/\n/gs; 1656: $ENV{'form.upfile'}=~s/\n+/\n/gs; 1657: $ENV{'form.upfile'}=~s/\n+$//gs; 1658: 1659: my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}. 1660: '_enroll_'.$ENV{'request.course.id'}.'_'.time.'_'.$$; 1661: { 1662: my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons'). 1663: '/tmp/'.$datatoken.'.tmp'); 1664: print $fh $ENV{'form.upfile'}; 1665: } 1666: return $datatoken; 1667: } 1668: 1669: =pod 1670: 1671: =item load_tmp_file($r) 1672: 1673: Load uploaded file from tmp, $r should be the HTTP Request object, 1674: needs $ENV{'form.datatoken'}, 1675: sets $ENV{'form.upfile'} to the contents of the file 1676: 1677: =cut 1678: 1679: sub load_tmp_file { 1680: my $r=shift; 1681: my @studentdata=(); 1682: { 1683: my $fh; 1684: if ($fh=Apache::File->new($r->dir_config('lonDaemons'). 1685: '/tmp/'.$ENV{'form.datatoken'}.'.tmp')) { 1686: @studentdata=<$fh>; 1687: } 1688: } 1689: $ENV{'form.upfile'}=join('',@studentdata); 1690: } 1691: 1692: =pod 1693: 1694: =item upfile_record_sep() 1695: 1696: Separate uploaded file into records 1697: returns array of records, 1698: needs $ENV{'form.upfile'} and $ENV{'form.upfiletype'} 1699: 1700: =cut 1701: 1702: sub upfile_record_sep { 1703: if ($ENV{'form.upfiletype'} eq 'xml') { 1704: } else { 1705: return split(/\n/,$ENV{'form.upfile'}); 1706: } 1707: } 1708: 1709: =pod 1710: 1711: =item record_sep($record) 1712: 1713: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'} 1714: 1715: =cut 1716: 1717: sub record_sep { 1718: my $record=shift; 1719: my %components=(); 1720: if ($ENV{'form.upfiletype'} eq 'xml') { 1721: } elsif ($ENV{'form.upfiletype'} eq 'space') { 1722: my $i=0; 1723: foreach (split(/\s+/,$record)) { 1724: my $field=$_; 1725: $field=~s/^(\"|\')//; 1726: $field=~s/(\"|\')$//; 1727: $components{$i}=$field; 1728: $i++; 1729: } 1730: } elsif ($ENV{'form.upfiletype'} eq 'tab') { 1731: my $i=0; 1732: foreach (split(/\t+/,$record)) { 1733: my $field=$_; 1734: $field=~s/^(\"|\')//; 1735: $field=~s/(\"|\')$//; 1736: $components{$i}=$field; 1737: $i++; 1738: } 1739: } else { 1740: my @allfields=split(/\,/,$record); 1741: my $i=0; 1742: my $j; 1743: for ($j=0;$j<=$#allfields;$j++) { 1744: my $field=$allfields[$j]; 1745: if ($field=~/^\s*(\"|\')/) { 1746: my $delimiter=$1; 1747: while (($field!~/$delimiter$/) && ($j<$#allfields)) { 1748: $j++; 1749: $field.=','.$allfields[$j]; 1750: } 1751: $field=~s/^\s*$delimiter//; 1752: $field=~s/$delimiter\s*$//; 1753: } 1754: $components{$i}=$field; 1755: $i++; 1756: } 1757: } 1758: return %components; 1759: } 1760: 1761: =pod 1762: 1763: =item upfile_select_html() 1764: 1765: return HTML code to select file and specify its type 1766: 1767: =cut 1768: 1769: sub upfile_select_html { 1770: return (<<'ENDUPFORM'); 1771: <input type="file" name="upfile" size="50" /> 1772: <br />Type: <select name="upfiletype"> 1773: <option value="csv">CSV (comma separated values, spreadsheet)</option> 1774: <option value="space">Space separated</option> 1775: <option value="tab">Tabulator separated</option> 1776: <option value="xml">HTML/XML</option> 1777: </select> 1778: ENDUPFORM 1779: } 1780: 1781: =pod 1782: 1783: =item csv_print_samples($r,$records) 1784: 1785: Prints a table of sample values from each column uploaded $r is an 1786: Apache Request ref, $records is an arrayref from 1787: &Apache::loncommon::upfile_record_sep 1788: 1789: =cut 1790: 1791: sub csv_print_samples { 1792: my ($r,$records) = @_; 1793: my (%sone,%stwo,%sthree); 1794: %sone=&record_sep($$records[0]); 1795: if (defined($$records[1])) {%stwo=&record_sep($$records[1]);} 1796: if (defined($$records[2])) {%sthree=&record_sep($$records[2]);} 1797: 1798: $r->print('Samples<br /><table border="2"><tr>'); 1799: foreach (sort({$a <=> $b} keys(%sone))) { $r->print('<th>Column '.($_+1).'</th>'); } 1800: $r->print('</tr>'); 1801: foreach my $hash (\%sone,\%stwo,\%sthree) { 1802: $r->print('<tr>'); 1803: foreach (sort({$a <=> $b} keys(%sone))) { 1804: $r->print('<td>'); 1805: if (defined($$hash{$_})) { $r->print($$hash{$_}); } 1806: $r->print('</td>'); 1807: } 1808: $r->print('</tr>'); 1809: } 1810: $r->print('</tr></table><br />'."\n"); 1811: } 1812: 1813: =pod 1814: 1815: =item csv_print_select_table($r,$records,$d) 1816: 1817: Prints a table to create associations between values and table columns. 1818: $r is an Apache Request ref, 1819: $records is an arrayref from &Apache::loncommon::upfile_record_sep, 1820: $d is an array of 2 element arrays (internal name, displayed name) 1821: 1822: =cut 1823: 1824: sub csv_print_select_table { 1825: my ($r,$records,$d) = @_; 1826: my $i=0;my %sone; 1827: %sone=&record_sep($$records[0]); 1828: $r->print('Associate columns with student attributes.'."\n". 1829: '<table border="2"><tr><th>Attribute</th><th>Column</th></tr>'."\n"); 1830: foreach (@$d) { 1831: my ($value,$display)=@{ $_ }; 1832: $r->print('<tr><td>'.$display.'</td>'); 1833: 1834: $r->print('<td><select name=f'.$i. 1835: ' onchange="javascript:flip(this.form,'.$i.');">'); 1836: $r->print('<option value="none"></option>'); 1837: foreach (sort({$a <=> $b} keys(%sone))) { 1838: $r->print('<option value="'.$_.'">Column '.($_+1).'</option>'); 1839: } 1840: $r->print('</select></td></tr>'."\n"); 1841: $i++; 1842: } 1843: $i--; 1844: return $i; 1845: } 1846: 1847: =pod 1848: 1849: =item csv_samples_select_table($r,$records,$d) 1850: 1851: Prints a table of sample values from the upload and can make associate samples to internal names. 1852: 1853: $r is an Apache Request ref, 1854: $records is an arrayref from &Apache::loncommon::upfile_record_sep, 1855: $d is an array of 2 element arrays (internal name, displayed name) 1856: 1857: =cut 1858: 1859: sub csv_samples_select_table { 1860: my ($r,$records,$d) = @_; 1861: my %sone; my %stwo; my %sthree; 1862: my $i=0; 1863: 1864: $r->print('<table border=2><tr><th>Field</th><th>Samples</th></tr>'); 1865: %sone=&record_sep($$records[0]); 1866: if (defined($$records[1])) {%stwo=&record_sep($$records[1]);} 1867: if (defined($$records[2])) {%sthree=&record_sep($$records[2]);} 1868: 1869: foreach (sort keys %sone) { 1870: $r->print('<tr><td><select name=f'.$i. 1871: ' onchange="javascript:flip(this.form,'.$i.');">'); 1872: foreach (@$d) { 1873: my ($value,$display)=@{ $_ }; 1874: $r->print('<option value='.$value.'>'.$display.'</option>'); 1875: } 1876: $r->print('</select></td><td>'); 1877: if (defined($sone{$_})) { $r->print($sone{$_}."</br>\n"); } 1878: if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); } 1879: if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); } 1880: $r->print('</td></tr>'); 1881: $i++; 1882: } 1883: $i--; 1884: return($i); 1885: } 1886: 1; 1887: __END__; 1888: 1889: =pod 1890: 1891: =back 1892: 1893: =head2 Access .tab File Data 1894: 1895: =over 4 1896: 1897: =item languageids() 1898: 1899: returns list of all language ids 1900: 1901: =item languagedescription() 1902: 1903: returns description of a specified language id 1904: 1905: =item copyrightids() 1906: 1907: returns list of all copyrights 1908: 1909: =item copyrightdescription() 1910: 1911: returns description of a specified copyright id 1912: 1913: =item filecategories() 1914: 1915: returns list of all file categories 1916: 1917: =item filecategorytypes() 1918: 1919: returns list of file types belonging to a given file 1920: category 1921: 1922: =item fileembstyle() 1923: 1924: returns embedding style for a specified file type 1925: 1926: =item filedescription() 1927: 1928: returns description for a specified file type 1929: 1930: =item filedescriptionex() 1931: 1932: returns description for a specified file type with 1933: extra formatting 1934: 1935: =back 1936: 1937: =head2 Alternate Problem Views 1938: 1939: =over 4 1940: 1941: =item get_previous_attempt() 1942: 1943: return string with previous attempt on problem 1944: 1945: =item get_student_view() 1946: 1947: show a snapshot of what student was looking at 1948: 1949: =item get_student_answers() 1950: 1951: show a snapshot of how student was answering problem 1952: 1953: =back 1954: 1955: =head2 HTTP Helper 1956: 1957: =over 4 1958: 1959: =item get_unprocessed_cgi($query,$possible_names) 1960: 1961: Modify the %ENV hash to contain unprocessed CGI form parameters held in 1962: $query. The parameters listed in $possible_names (an array reference), 1963: will be set in $ENV{'form.name'} if they do not already exist. 1964: 1965: Typically called with $ENV{'QUERY_STRING'} as the first parameter. 1966: $possible_names is an ref to an array of form element names. As an example: 1967: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']); 1968: will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set. 1969: 1970: =item cacheheader() 1971: 1972: returns cache-controlling header code 1973: 1974: =item no_cache($r) 1975: 1976: specifies header code to not have cache 1977: 1978: =item add_to_env($name,$value) 1979: 1980: adds $name to the %ENV hash with value 1981: $value, if $name already exists, the entry is converted to an array 1982: reference and $value is added to the array. 1983: 1984: =back 1985: 1986: =cut